pax_global_header00006660000000000000000000000064150601355570014521gustar00rootroot0000000000000052 comment=260b076f7d78c5a74a73efe80e6779ef13a2f874 stripe-mock-0.196.0/000077500000000000000000000000001506013555700141335ustar00rootroot00000000000000stripe-mock-0.196.0/.dockerignore000066400000000000000000000000711506013555700166050ustar00rootroot00000000000000README.md LICENSE Makefile dist/ goreleaser.yml openapi/ stripe-mock-0.196.0/.editorconfig000066400000000000000000000003421506013555700166070ustar00rootroot00000000000000; http://editorconfig.org/ root = true [*] end_of_line = lf insert_final_newline = true charset = utf-8 trim_trailing_whitespace = true [*.go] indent_style = tab indent_size = 4 [*.md] indent_style = space indent_size = 2 stripe-mock-0.196.0/.gitattributes000066400000000000000000000001011506013555700170160ustar00rootroot00000000000000bindata.go linguist-generated spec/bindata.go linguist-generated stripe-mock-0.196.0/.github/000077500000000000000000000000001506013555700154735ustar00rootroot00000000000000stripe-mock-0.196.0/.github/workflows/000077500000000000000000000000001506013555700175305ustar00rootroot00000000000000stripe-mock-0.196.0/.github/workflows/ci.yml000066400000000000000000000010761506013555700206520ustar00rootroot00000000000000 on: [push, pull_request] name: CI jobs: test: name: Test runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 with: fetch-depth: 0 submodules: recursive - name: Set up Go uses: actions/setup-go@v2 with: go-version: 1.22.1 - name: test run: | go install golang.org/x/lint/golint@latest && go install github.com/go-bindata/go-bindata/...@latest && go install honnef.co/go/tools/cmd/staticcheck@latest && go generate && make stripe-mock-0.196.0/.github/workflows/release.yml000066400000000000000000000024341506013555700216760ustar00rootroot00000000000000on: push: tags: - "v*" jobs: goreleaser: runs-on: ubuntu-latest steps: - name: Code checkout uses: actions/checkout@v2 with: fetch-depth: 0 submodules: recursive - name: Docker Login env: DOCKER_USERNAME: ${{ secrets.DOCKER_USERNAME }} DOCKER_PASSWORD: ${{ secrets.DOCKER_PASSWORD }} run: | echo "${DOCKER_PASSWORD}" | docker login --username "${DOCKER_USERNAME}" --password-stdin - name: Set up Docker Buildx uses: docker/setup-buildx-action@v2 - name: Set up Go uses: actions/setup-go@v2 with: go-version: 1.22.1 # Fetch app token - uses: tibdex/github-app-token@v1.5.2 id: gh-api-token with: app_id: ${{ secrets.GH_APP_STRIPE_OPENAPI_APP_ID }} private_key: ${{ secrets.GH_APP_STRIPE_OPENAPI_PRIVATE_KEY }} - name: Run GoReleaser uses: goreleaser/goreleaser-action@v2 with: version: v1.7 args: release -f goreleaser.yml --rm-dist env: GITHUB_TOKEN: ${{ steps.gh-api-token.outputs.token }} - uses: stripe/openapi/actions/notify-release@master if: always() with: bot_token: ${{ secrets.SLACK_BOT_TOKEN }} stripe-mock-0.196.0/.github/workflows/tag.yml000066400000000000000000000035261506013555700210340ustar00rootroot00000000000000name: Create Tag and trigger release on: workflow_dispatch: inputs: tag: description: "Tag name, defaults to minor increment." required: false sha: description: "Commit SHA to tag. Defaults to latest." required: false jobs: publish: runs-on: ubuntu-latest steps: - name: Code checkout uses: actions/checkout@v2 with: fetch-depth: 0 - name: Set the commit SHA id: sha run: echo "commitSha=$(if [ -z "$SHA" ]; then echo $GITHUB_SHA; else echo $SHA; fi)" >> "$GITHUB_OUTPUT" env: SHA: ${{ github.event.inputs.sha }} - name: Set the tag id: tag run: | last_tag="$(git describe --tags --abbrev=0)" # Parse the version into parts, increment the minor version and reset the patch to 0 # Example: # v1.2.3 is parsed into $1 = "v1.", $2 = "2", $3 = ".3" # and concatenated back into v1.3.0 new_tag="$(echo "$last_tag" | perl -pe 's/^(v\d+\.)(\d+)(\.\d+)$/$1.($2+1).".0"/e')" echo "newTag=$(if [ -z "$TAG" ]; then echo $new_tag; else echo $TAG; fi)" >> "$GITHUB_OUTPUT" env: TAG: ${{ github.event.inputs.tag }} - uses: tibdex/github-app-token@v1.5.2 id: gh-api-token with: app_id: ${{ secrets.GH_APP_STRIPE_OPENAPI_APP_ID }} private_key: ${{ secrets.GH_APP_STRIPE_OPENAPI_PRIVATE_KEY }} - name: Create tag uses: actions/github-script@v5 with: github-token: ${{ steps.gh-api-token.outputs.token }} script: | github.rest.git.createRef({ owner: context.repo.owner, repo: context.repo.repo, ref: 'refs/tags/${{ steps.tag.outputs.newTag }}', sha: '${{ steps.sha.outputs.commitSha }}' }) stripe-mock-0.196.0/.gitignore000066400000000000000000000000711506013555700161210ustar00rootroot00000000000000.env .envrc .idea .DS_Store /TODO.md /stripe-mock /dist/ stripe-mock-0.196.0/.gitmodules000066400000000000000000000000001506013555700162760ustar00rootroot00000000000000stripe-mock-0.196.0/.vscode/000077500000000000000000000000001506013555700154745ustar00rootroot00000000000000stripe-mock-0.196.0/.vscode/extensions.json000066400000000000000000000003561506013555700205720ustar00rootroot00000000000000{ "recommendations": [ // Go Language plugins (~required) "ms-vscode.go", // Highly recommended "eamodio.gitlens", "ziyasal.vscode-open-in-github", "EditorConfig.editorconfig", ] } stripe-mock-0.196.0/.vscode/settings.json000066400000000000000000000003571506013555700202340ustar00rootroot00000000000000{ // Show the path in the top window bar. "window.title": "${rootName}${separator}${activeEditorMedium}", "editor.formatOnSave": false, "go.formatTool": "gofmt", "[go]": { "editor.formatOnSave": true }, } stripe-mock-0.196.0/Dockerfile000066400000000000000000000005231506013555700161250ustar00rootroot00000000000000# -*- mode: dockerfile -*- FROM golang:alpine as builder WORKDIR /app COPY . . RUN go build -mod=vendor -o stripe-mock FROM alpine:latest RUN apk --no-cache add ca-certificates COPY --from=builder /app/stripe-mock /bin/stripe-mock ENTRYPOINT ["/bin/stripe-mock", "-http-port", "12111", "-https-port", "12112"] EXPOSE 12111 EXPOSE 12112 stripe-mock-0.196.0/LICENSE000066400000000000000000000021151506013555700151370ustar00rootroot00000000000000The MIT License (MIT) Copyright (c) 2014- Stripe, Inc. (https://stripe.com) Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. stripe-mock-0.196.0/Makefile000066400000000000000000000016071506013555700155770ustar00rootroot00000000000000GIT_COMMITSHA = $(shell git rev-parse HEAD) IMAGE_NAME = "stripe/stripe-mock" OPENAPI_BRANCH ?= master all: test vet lint check-gofmt build build: go build -mod=vendor -o stripe-mock check-gofmt: scripts/check_gofmt.sh lint: staticcheck test: # -count=1 disables the cache go test ./... -count=1 vet: go vet ./... docker-build: docker build -t "$(IMAGE_NAME):latest" -t "$(IMAGE_NAME):$(GIT_COMMITSHA)" . .PHONY: docker-build docker-run: docker run --rm -it -p 12111-12112:12111-12112 "$(IMAGE_NAME):latest" .PHONY: docker-run update-openapi-spec: rm -f ./embedded/openapi/spec3.json rm -f ./embedded/openapi/fixtures3.json wget https://raw.githubusercontent.com/stripe/openapi/$(OPENAPI_BRANCH)/openapi/spec3.json -P ./embedded/openapi wget https://raw.githubusercontent.com/stripe/openapi/$(OPENAPI_BRANCH)/openapi/fixtures3.json -P ./embedded/openapi .PHONY: update-openapi-spec stripe-mock-0.196.0/README.md000066400000000000000000000146431506013555700154220ustar00rootroot00000000000000# stripe-mock [![Build Status](https://github.com/stripe/stripe-mock/actions/workflows/ci.yml/badge.svg)](https://github.com/stripe/stripe-mock/actions/workflows/ci.yml) stripe-mock is a mock HTTP server based on the real Stripe API. It accepts the same requests and parameters that the Stripe API accepts, and rejects requests whose parameters are not recognized or have incorrect types. Its responses resemble the responses of the real Stripe API in terms of data type; however, stripe-mock **does not attempt to reproduce the _behavior_ of the real Stripe API at all**. It cannot reject all invalid requests, and its responses are completely hardcoded. They will have a correct type, but they will not necessarily be realistic Stripe responses. stripe-mock is meant for basic sanity checks. We use it in the test suites of our server-side SDKs, like [stripe-ruby](https://github.com/stripe/stripe-ruby), [stripe-go](https://github.com/stripe/stripe-go), etc, to help validate that the SDK hits the right URL and sends the right parameters. If you have more sophisticated testing needs, you shouldn't use stripe-mock. Always test changes to your Stripe integration against [testmode](https://stripe.com/docs/keys#test-live-modes). For regression test suites, you should define your own mocks, or use a playback testing tool such as the [VCR gem](https://github.com/vcr/vcr). While stripe-mock is naïve, it is powered by [the Stripe OpenAPI specification][openapi] and is therefore kept up-to-date with the latest methods, resources, and fields. ## Features and limitations stripe-mock supports the following features: - It has a catalog of every API URL and their signatures. It responds to URLs that exist with a resource that it returns and 404s on URLs that don't exist. - JSON Schema is used to check the validity of the parameters of incoming requests. Validation is comprehensive, but far from exhaustive, so don't expect the full barrage of checks of the live API. - Responses are generated based off resource fixtures. They're also generated from within Stripe's API, and similar to the sample data available in Stripe's [API reference][apiref]. **They are hardcoded**, and will not necessarily represent realistic responses based on the parameters you input into the request. - It reflects the values of valid input parameters into responses where the naming and type are the same. So if a charge is created with `amount=123`, a charge will be returned with `"amount": 123`. - It will respond over HTTP or over HTTPS. HTTP/2 over HTTPS is available if the client supports it. Limitations: - stripe-mock is stateless. Data you send on a `POST` request will be validated, but it will be completely ignored beyond that. It will not be reflected on the response or on any future request -- unlike the real Stripe API, which stores the information you send it. - For polymorphic endpoints (say one that returns either a card or a bank account), only a single resource type is ever returned. There's no way to specify which one that is. - It's locked to the latest version of Stripe's API and doesn't support old versions. - [Testing for specific responses and errors](https://stripe.com/docs/testing#cards-responses) is currently not supported. It will return a success response instead of the desired error response. ## Future plans The scope we envision for stripe-mock has significantly narrowed since 2017 when we first released it. Back in 2017, our vision was for stripe-mock was to return responses that were _realistic_ as well as just having the expected types. This has changed. We are currently **not** planning to add statefulness or more sophisticated testing features to stripe-mock. stripe-mock will remain a tool for basic sanity checks. If you have more sophisticated needs, you should define your own mocks, use a playback testing tool like the [VCR gem](https://github.com/vcr/vcr), or find a community library you trust. Be careful, though. Always test changes to your Stripe integration against testmode. Mock implementations of Stripe can never behave exactly at the Stripe API does, and might differ in nuanced (and potentially dangerous) ways. ## Usage If you have Go installed, you can install the basic binary with: ```sh go install github.com/stripe/stripe-mock@latest ``` With no arguments, stripe-mock will listen with HTTP on its default port of `12111` and HTTPS on `12112`: ```sh stripe-mock ``` Ports can be specified explicitly with: ```sh stripe-mock -http-port 12111 -https-port 12112 ``` (Leave either `-http-port` or `-https-port` out to activate stripe-mock on only one protocol.) Have stripe-mock select a port automatically by passing `0`: ```sh stripe-mock -http-port 0 ``` It can also listen via Unix socket: ```sh stripe-mock -http-unix /tmp/stripe-mock.sock -https-unix /tmp/stripe-mock-secure.sock ``` ### Homebrew Get it from Homebrew or download it [from the releases page][releases]: ```sh brew install stripe/stripe-mock/stripe-mock # start a stripe-mock service at login brew services start stripe-mock # upgrade if you already have it brew upgrade stripe-mock # restart the service after upgrading brew services restart stripe-mock ``` The Homebrew service listens on port `12111` for HTTP and `12112` for HTTPS and HTTP/2. ### Docker ```sh docker run --rm -it -p 12111-12112:12111-12112 stripe/stripe-mock:latest ``` The default Docker `ENTRYPOINT` listens on port `12111` for HTTP and `12112` for HTTPS and HTTP/2. ### Sample request After you've started stripe-mock, you can try a sample request against it: ```sh curl -i http://localhost:12111/v1/charges -H "Authorization: Bearer sk_test_123" ``` ## Development ### Testing Run the test suite: ```sh go test ./... ``` ### Updating OpenAPI Update the OpenAPI spec by running `make update-openapi-spec` in the root of the repo. ```sh make update-openapi-spec ``` ## Dependencies Dependencies are managed using [go modules][gomod] and require Go 1.11+ with `GO111MODULE=on`. ## Release Releases are automatically published by Travis CI using [goreleaser] when a new tag is pushed: ```sh git pull origin --tags git tag v0.1.1 git push origin --tags ``` [apiref]: https://stripe.com/docs/api [go-bindata]: https://github.com/go-bindata/go-bindata [gomod]: https://golang.org/ref/mod [goreleaser]: https://github.com/goreleaser/goreleaser [openapi]: https://github.com/stripe/openapi [releases]: https://github.com/stripe/stripe-mock/releases stripe-mock-0.196.0/embedded/000077500000000000000000000000001506013555700156645ustar00rootroot00000000000000stripe-mock-0.196.0/embedded/cert/000077500000000000000000000000001506013555700166215ustar00rootroot00000000000000stripe-mock-0.196.0/embedded/cert/README.md000066400000000000000000000006551506013555700201060ustar00rootroot00000000000000# Cert This directory contains a self-signed certificate for localhost so that stripe-mock can run with HTTPS. You can generate a new one with this command: openssl req -x509 -newkey rsa:4096 -keyout cert/key.pem -out cert/cert.pem -days 3650 -nodes -subj '/CN=localhost' And because certificates are bundled with the executable, you'll need to put the new certificate into a `*.go` file with go-bindata: go generate stripe-mock-0.196.0/embedded/cert/cert.pem000066400000000000000000000032071506013555700202630ustar00rootroot00000000000000-----BEGIN CERTIFICATE----- MIIEpDCCAowCCQDtPflm0eRwCTANBgkqhkiG9w0BAQsFADAUMRIwEAYDVQQDDAls b2NhbGhvc3QwHhcNMTgwNzE3MjA0NzAzWhcNMjgwNzE0MjA0NzAzWjAUMRIwEAYD VQQDDAlsb2NhbGhvc3QwggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQDB XUN89XAuVYoui76SlFqIT4K5LIJrMsMFz3RU6kPWj2HSCB6P4wrmFhVwmziHkE0T KUbyuX9J4ImR3WBgLdXiBX/uo8B0aAlRQTrqFkFWTYuWJvLEGopLEQVyKpgyJtuC y0K6oM1h2SMqpphEpfY/x4GmSTkuSUwYcQsEorK6R0anjPtJBvRNm/17/dililW6 9ptaAoE71NVoaKnIwOqykfeeGX7sNQOaBOYlR1Lrg+mwgtXo0ig+5kkbkmtw1gvi JPJItmIlkaAdpyAMDmMAojAYXnE6nIos9wx/7wWQalyVvVnV6lF80frPvA39XWn7 BVodD6i1F9mOdU3xi55TqVEPMOzdpJMA3XQnjoiXJJde5lVim7giWhVzE56y1Onu Zg2Z/G4tC7ZulJXKRHKp2OxWwgrY5eBaoiP2Q3U1k1vZXi4Z1pWlM2EVApIZYKrk y5Q6UbsGqQDKUSg3lq7y7pCvJlRTLgDF8cdOfQpodJhxoiM3SFrmqpaQjAsLgiOR 7lgdlkjRfxPZ787/7cRPE9cfa8QwPv9w+Rs8F4M/JbRDmxtikTg1kJIBLpDrWrln Dm88HVATwP4JzuJ1HQHxXHtNLcjtZOOsXEwnGcBD/Q5fO42I6vmbumkynkMrSrNr 1g3ZQCr1zQPvf1i/xnDTvylnfyRwVAYQHpz1WCAnIQIDAQABMA0GCSqGSIb3DQEB CwUAA4ICAQCYPmrm2DjB4BrAhER5XgJvhdiR7c6JditejpImObhrtRaZLsErQMEF ypjrba1pfb5Yk+occpZh9r3sPN8G/vCooL1hZZ/WaPKybMzzkprXT3JSKIyOE7m0 G8asFv/mQQAkOfNK52QJTuqpDG/upXcwAguGO69yAC6RsmOjYEKMqXBIVJZJikQz iSXa8lQZCMSIjDcOXOK+unETDkLdNWMVboBNnogQ8MyJW+3NDS0YDtr+428vZ/Vg ixPx6lDkmdyyTLx8ebLHYI+A/Hu5DdO39SujxVdb5U2T/wvuFBRA1t5dDWyb41lG Xi/HBCxojYTr7IYBnED7X4RtC5g2HZXKgh76M+0DZdWK3U3st18mP5Z5JN6MSgp4 iD0iixQQZl3pOQBmjMSuQOzouB2QmCAEn0S373hoCG5nijQU7GJhHizKiuo00YG5 3n0JAWq6/k07aYxJdP1D+unMsIW5QPTYWnQ/SQwSPWdTIkwov5vdtbPd6rtLY6rY H4CceRQ2UYwfEjtWawVaq23WGGsv1/DApwtUr1+hQewNGWynVwkBiO5//N0q9EqL K7su3MbjDeaSdzyPbLKsEhPZvKCyoYZ/HjF38Zwe6kOb5f/ghPAkRossREURQyqr vRAj0swDekeWXxCrIucoS3031UY5pgNBeEUwENZ15w8+ZoS0HjB7Rw== -----END CERTIFICATE----- stripe-mock-0.196.0/embedded/cert/key.pem000066400000000000000000000063101506013555700201140ustar00rootroot00000000000000-----BEGIN PRIVATE KEY----- MIIJQwIBADANBgkqhkiG9w0BAQEFAASCCS0wggkpAgEAAoICAQDBXUN89XAuVYou i76SlFqIT4K5LIJrMsMFz3RU6kPWj2HSCB6P4wrmFhVwmziHkE0TKUbyuX9J4ImR 3WBgLdXiBX/uo8B0aAlRQTrqFkFWTYuWJvLEGopLEQVyKpgyJtuCy0K6oM1h2SMq pphEpfY/x4GmSTkuSUwYcQsEorK6R0anjPtJBvRNm/17/dililW69ptaAoE71NVo aKnIwOqykfeeGX7sNQOaBOYlR1Lrg+mwgtXo0ig+5kkbkmtw1gviJPJItmIlkaAd pyAMDmMAojAYXnE6nIos9wx/7wWQalyVvVnV6lF80frPvA39XWn7BVodD6i1F9mO dU3xi55TqVEPMOzdpJMA3XQnjoiXJJde5lVim7giWhVzE56y1OnuZg2Z/G4tC7Zu lJXKRHKp2OxWwgrY5eBaoiP2Q3U1k1vZXi4Z1pWlM2EVApIZYKrky5Q6UbsGqQDK USg3lq7y7pCvJlRTLgDF8cdOfQpodJhxoiM3SFrmqpaQjAsLgiOR7lgdlkjRfxPZ 787/7cRPE9cfa8QwPv9w+Rs8F4M/JbRDmxtikTg1kJIBLpDrWrlnDm88HVATwP4J zuJ1HQHxXHtNLcjtZOOsXEwnGcBD/Q5fO42I6vmbumkynkMrSrNr1g3ZQCr1zQPv f1i/xnDTvylnfyRwVAYQHpz1WCAnIQIDAQABAoICAQCYL0r6gkF0diZ3U8z9mH1Y YxvDmeBbdmw/mnM4kdgqelbG81T6cfsV87OUGNZ4+31t40LPrmccQfiEMPO1Pt3j MejqbT7/XxJWPTydGD78KbP+zVCsPycwxYi/vf5jGmoRmuA9+mkq5bbjzpJxFR2m POMxeNfkMhQN+Ipvb42zRn25SSBM7YhBvM/YUoW8ZA/tQkIqqWYFLRF5R0a5lfwh 5vg4GmDmjyLyiYCJPoVojz3RimfJAf5i4uQPK0IcYJqhtepqiADfCKo4LFzwoDIT QZMQ2uPK+YFWumnAFuMOMmgEAi8+SVkxICKCdMOd8XOD+UZfMP/a55Z2pKRfwz8r wwH3h2loE5rEUbEswrXPFcdwHV8E3F6wJvA0sLvrab4iXvJ2GXNqY4WaNEuS/e8J trQLVFjLp74+cgBwVuvPMTHIyUEPc0xLhfTaTTvXTzN3QffF8vSnIzPiFRSrPnjG tRMuDKUjSLecDUdcwdd34H0xWFjvjswZ5KPawlSmzCvQSH8GKYXht3/q1WDnoKoH 9axua/jfKv5aGyb87pEKybbwdj1Cwa3RG/ZUM1KsDeEfV0MfpD2GYAYEfJqETWN9 ex5lX1ww0rQSufYc2AiyRN7LjtKDYFgLaL8RU/HaPLnEI1dn64rVsM4l1oAw6FqY oktsUEeWnTnWqgRuZ0Vn8QKCAQEA4tm4lAdt+36omzdFrRBVmRG11aS+SY9n4tzS Tair1knGefxj8JbQlv90mg5BGr5jo8FuD6jbalVj7XXHCKVZ2fhvvQ3xQYP9FCUB /rwGNSrfCR/MrMSMoMwutqRGeikBL/RNeWLn0SZOyFCLcrm9LRhHDjuJtT84m36d S7TXCCJ9Miip3WvsXdrwCiWjgwq2DLpGl+p+llhKnKUqfLd7YhKTw+gDK/4hH5hU 1/nniQKHnWX4N86LW3L63PNQfCJS6pvMCd+o8Tc6IRY2FRomm7Lj+xGlGxxdETiV beDEQFCb1294fWTr4dGvGA9g5UyXL9KoDr01Vnx/Tfwq6WF+ZwKCAQEA2jYCsFjh xL1uIlPCohtvmu9i4c1ltWyzh3BlXpXSFDzK93Vh5rWSnoZE8+PLbHBSAulswTZL YbmWM2fLkpRtxnJP57ZmYcBJWqbcRVbgT+p65yrLktghphQkcXJKjUlEzISpdrCU uffDoUcQ0Sh/pLQckvDUoEq/RH0QEQfhct05j2vKebswYmP2Zdn5pGODeCHFHKI6 3HX4KBWfyBwaB7e2Z/AWSIl0761/bF+1YOzyBY/Ap1yDtChjXYpd0wrN1wr1oH+r knDXaQGx+a69Pvee1vTwwvZ/ony9GNzxLrJMWJzusVRL+GYsShzsaAXgf6zBpOn8 Sqml60ZcHOSpNwKCAQBB012dDr7aUHmKeLJuMqQ0A5CZCvHwlH1Xti4MPNqIFuZR 9Wvmn0yt1Di4j1RS91YgaXuPbbclltulRxzXJGv7NPzvhgEwuqUQWGDI0zSV7vfD RQf2Rh5sdnNDqk2NGyLuEFz+0TVlWlFYDQ853i3HzRipR5uBDXRWopnwIuyWvrNH f8cyqiNvZJ1sxFk7KDuFW/QqFvBengYgiEjY4cEaxzs7iLKK7HYeHezYsvp9pk9F 3BX306ZahfXHcY80Rh17WHQPlWgHfrgOa8yLuQfk/DbtXsRjJorW+W1a8fLgmsNt 8zmqYUOVRmwhdizuvJfOV7lOdZbpnryuG3M0P4cXAoIBAAdqPG8npgxcb4ilFgES M5mtNsv7gdBHcFZS4G71Yl0jr7X2/Cut0dynLWKoQ/pcWr0Ul4h9QtSATPVUOpux hYVvzv1Num7p7NQyxVtp11d/3UtLrf1AcOxG1PIx8wyYB8l3XJbW60bif3hUhOLG oIfFQw9PNbp4r8UxBsG9ZdDUaadQ/2FhlgRR50aQwKXwZ8BGTX9ql9tz+snJ6lMP eWb3vDAN/YPbf+jBGYpiOjSf+J1txBsrzqHpmW7NS+DnBhWfnrckf30LbpZ340db w7yHB5PAYQoO/ElWOcrFf0CZ+HQuaQIHnklDl4+xKeti/7z27uGevd7/os665lhp AMMCggEBALdtRkfI7Dt2Zh6rF6b8yBpP8nIqzd1i4hw2rPddHlJ38PdpVUwuukhu mPh5TgXjIub1syjIZ4fcaF/Xug3qzaIGmxyFe1mtZaIlUIEH3RgZELQMoM70h+lZ qzA6KoNn7woPYC4MoKCQCnUH89m3z0RS8Sn+x26yVBtKwRQQVPggxIzyWD6f/Qp+ ZgJJK7j2VJ/N8RBxXj2K8CtfWiYx8NH17Ce7KuLEIAYd3gDrv0E1npjt/hnni+uZ Im6GO3wa7eZ9vrE41CUTV2s29kSM5ESAUCsPbzUrWJJztVz4O0HkEV4U7klOOCUf pNup6c6DNzJiw9HN1eEUFBNtiVVIRrI= -----END PRIVATE KEY----- stripe-mock-0.196.0/embedded/embedded.go000066400000000000000000000006001506013555700177400ustar00rootroot00000000000000package embedded import ( _ "embed" ) //go:embed cert/key.pem var CertKey []byte //go:embed cert/cert.pem var CertCert []byte //go:embed openapi/fixtures3.json var OpenAPIFixtures []byte //go:embed openapi/spec3.json var OpenAPISpec []byte //go:embed openapi/fixtures3.beta.json var BetaOpenAPIFixtures []byte //go:embed openapi/spec3.beta.sdk.json var BetaOpenAPISpec []byte stripe-mock-0.196.0/embedded/openapi/000077500000000000000000000000001506013555700173175ustar00rootroot00000000000000stripe-mock-0.196.0/embedded/openapi/fixtures3.beta.json000077500000000000000000006062771506013555700231050ustar00rootroot00000000000000{ "resources": { "account": { "business_profile": { "mcc": null, "name": null, "product_description": null, "support_address": { "city": null, "country": null, "line1": null, "line2": null, "postal_code": null, "state": null }, "support_email": null, "support_phone": null, "support_url": null, "url": null, "minority_owned_business_designation": null }, "business_type": null, "capabilities": { "card_payments": "active", "transfers": "active" }, "charges_enabled": false, "controller": { "type": "account" }, "country": "US", "created": 1234567890, "default_currency": "usd", "details_submitted": false, "email": "site@stripe.com", "external_accounts": { "data": [], "has_more": false, "object": "list", "url": "/v1/accounts/acct_1MWlHDJITzLVzkSm/external_accounts" }, "future_requirements": { "alternatives": [], "current_deadline": null, "currently_due": [], "disabled_reason": null, "errors": [], "eventually_due": [], "past_due": [], "pending_verification": [] }, "id": "acct_1MWlHDJITzLVzkSm", "metadata": {}, "object": "account", "payouts_enabled": false, "requirements": { "alternatives": [], "current_deadline": null, "currently_due": [ "business_profile.product_description", "business_profile.support_phone", "business_profile.url", "external_account", "tos_acceptance.date", "tos_acceptance.ip" ], "disabled_reason": "requirements.past_due", "errors": [], "eventually_due": [ "business_profile.product_description", "business_profile.support_phone", "business_profile.url", "external_account", "tos_acceptance.date", "tos_acceptance.ip" ], "past_due": [], "pending_verification": [] }, "settings": { "bacs_debit_payments": { "display_name": null, "service_user_number": null }, "branding": { "icon": null, "logo": null, "primary_color": null, "secondary_color": null }, "card_issuing": { "tos_acceptance": { "date": null, "ip": null } }, "card_payments": { "decline_on": { "avs_failure": true, "cvc_failure": true }, "statement_descriptor_prefix": null, "statement_descriptor_prefix_kana": null, "statement_descriptor_prefix_kanji": null }, "dashboard": { "display_name": null, "timezone": "Etc/UTC" }, "payments": { "statement_descriptor": null, "statement_descriptor_kana": null, "statement_descriptor_kanji": null, "statement_descriptor_prefix_kana": null, "statement_descriptor_prefix_kanji": null }, "payouts": { "debit_negative_balances": true, "schedule": { "delay_days": 2, "interval": "daily" }, "statement_descriptor": null }, "sepa_debit_payments": {} }, "tos_acceptance": { "date": null, "ip": null, "user_agent": null }, "type": "standard" }, "account_link": { "created": 1234567890, "expires_at": 1234567890, "object": "account_link", "url": "https://rwashburne-manage-mydev.dev.stripe.me/setup/s/acct_1MWlHDJITzLVzkSm/Ep8ZlYAWJPc0" }, "apple_pay_domain": { "created": 1234567890, "domain_name": "example.com", "id": "apwc_1MlLi1JITzLVzkSma2iSMoVr", "livemode": true, "object": "apple_pay_domain" }, "application_fee": { "account": "acct_1MWlHDJITzLVzkSm", "amount": 100, "amount_refunded": 0, "application": "ca_NWOVPPSIVPD11hXgbABn38xeiYlTnzDZ", "balance_transaction": "txn_1MlLhiJITzLVzkSm0tDIM70A", "charge": "ch_1Mcd6UJITzLVzkSmp1XIBHoW", "created": 1234567890, "currency": "usd", "id": "fee_1MlLiCJITzLVzkSmRgPvDzIk", "livemode": false, "object": "application_fee", "originating_transaction": null, "refunded": false, "refunds": { "data": [], "has_more": false, "object": "list", "url": "/v1/application_fees/fee_1MlLiCJITzLVzkSmRgPvDzIk/refunds" }, "fee_source": { "type": "charge" } }, "apps.secret": { "created": 1234567890, "expires_at": 1234567890, "id": "appsecret_5110QzMIZ0005GiEH1m0419O8KAxCG", "livemode": false, "name": "test-secret", "object": "apps.secret", "scope": { "type": "account" } }, "balance": { "available": [ { "amount": 0, "currency": "usd", "source_types": { "card": 0 } } ], "connect_reserved": [ { "amount": 0, "currency": "usd" } ], "livemode": false, "object": "balance", "pending": [ { "amount": 0, "currency": "usd", "source_types": { "card": 0 } } ] }, "balance_transaction": { "amount": 100, "available_on": 1234567890, "created": 1234567890, "currency": "usd", "description": "My First Test Charge (created for API docs)", "exchange_rate": null, "fee": 0, "fee_details": [], "id": "txn_1MlLhiJITzLVzkSm0tDIM70A", "net": 100, "object": "balance_transaction", "reporting_category": "charge", "source": "ch_1Mcd6UJITzLVzkSmp1XIBHoW", "status": "available", "type": "charge" }, "bank_account": { "account_holder_name": "Jane Austen", "account_holder_type": "company", "account_type": null, "bank_name": "STRIPE TEST BANK", "country": "US", "currency": "usd", "customer": null, "fingerprint": "I1e2zttmxgyFZKaM", "id": "ba_1Mcd6nJITzLVzkSm2CZD1tkj", "last4": "3461", "metadata": {}, "object": "bank_account", "routing_number": "110000000", "status": "new" }, "billing_portal.configuration": { "active": true, "application": null, "business_profile": { "headline": null, "privacy_policy_url": "https://example.com/privacy", "terms_of_service_url": "https://example.com/terms" }, "created": 1234567890, "default_return_url": null, "features": { "customer_update": { "allowed_updates": [ "email", "tax_id" ], "enabled": true }, "invoice_history": { "enabled": true }, "payment_method_update": { "enabled": false }, "subscription_cancel": { "cancellation_reason": { "enabled": false, "options": [] }, "enabled": false, "mode": "at_period_end", "proration_behavior": "none" }, "subscription_update": { "default_allowed_updates": [], "enabled": false, "proration_behavior": "none", "schedule_at_period_end": { "conditions": [ { "type": "decreasing_item_amount" } ] }, "trial_update_behavior": "end_trial" } }, "id": "bpc_1MlLiHJITzLVzkSmmFpILKiF", "is_default": true, "livemode": true, "login_page": { "enabled": false, "url": null }, "metadata": null, "object": "billing_portal.configuration", "updated": 1234567890, "name": null }, "billing_portal.session": { "configuration": "bpc_1MlLiHJITzLVzkSmUYpn1kRA", "created": 1234567890, "customer": "cus_NNNslJKODLsLoG", "flow": { "after_completion": { "hosted_confirmation": { "custom_message": null }, "redirect": { "return_url": "return_url" }, "type": "hosted_confirmation" }, "subscription_cancel": { "retention": { "coupon_offer": { "coupon": "coupon" }, "type": "coupon_offer" }, "subscription": "subscription" }, "subscription_update": { "subscription": "subscription" }, "subscription_update_confirm": { "discounts": null, "items": [ { "id": null, "price": null } ], "subscription": "subscription" }, "type": "subscription_update" }, "id": "bps_1MlLiHJITzLVzkSm8ZH6SnN2", "livemode": true, "locale": null, "object": "billing_portal.session", "on_behalf_of": null, "return_url": "https://example.com/account", "url": "https://rwashburne-customer_portal-mydev.dev.stripe.me/session/{SESSION_SECRET}" }, "capability": { "account": "acct_1MWlHDJITzLVzkSm", "future_requirements": { "alternatives": [], "current_deadline": null, "currently_due": [], "disabled_reason": null, "errors": [], "eventually_due": [], "past_due": [], "pending_verification": [] }, "id": "card_payments", "object": "capability", "requested": true, "requested_at": 1234567890, "requirements": { "alternatives": [], "current_deadline": null, "currently_due": [], "disabled_reason": null, "errors": [], "eventually_due": [], "past_due": [], "pending_verification": [] }, "status": "inactive" }, "card": { "address_city": null, "address_country": null, "address_line1": null, "address_line1_check": null, "address_line2": null, "address_state": null, "address_zip": null, "address_zip_check": null, "brand": "Visa", "country": "US", "customer": null, "cvc_check": "pass", "dynamic_last4": null, "exp_month": 8, "exp_year": 2030, "fingerprint": "XFO13q66ulrWf0ou", "funding": "credit", "id": "card_1Mcd6SJITzLVzkSmqkE2eJHO", "last4": "4242", "metadata": {}, "name": "Jenny Rosen", "object": "card", "tokenization_method": null, "regulated_status": null }, "cash_balance": { "available": { "eur": 10000 }, "customer": "cus_NNNslJKODLsLoG", "livemode": false, "object": "cash_balance", "settings": { "reconciliation_mode": "automatic", "using_merchant_default": true } }, "charge": { "amount": 100, "amount_captured": 0, "amount_refunded": 0, "application": null, "application_fee": null, "application_fee_amount": null, "balance_transaction": "txn_1MlLhiJITzLVzkSm0tDIM70A", "billing_details": { "address": { "city": null, "country": null, "line1": null, "line2": null, "postal_code": null, "state": null }, "email": null, "name": "Jenny Rosen", "phone": null, "tax_id": null }, "calculated_statement_descriptor": null, "captured": false, "created": 1234567890, "currency": "usd", "customer": null, "description": "My First Test Charge (created for API docs)", "disputed": false, "failure_balance_transaction": null, "failure_code": null, "failure_message": null, "fraud_details": {}, "id": "ch_1Mcd6UJITzLVzkSmp1XIBHoW", "livemode": false, "metadata": {}, "object": "charge", "on_behalf_of": null, "outcome": { "advice_code": null, "network_advice_code": null, "network_decline_code": null, "network_status": null, "reason": null, "seller_message": null, "type": "type" }, "paid": true, "payment_intent": null, "payment_method": "card_1Mcd6SJITzLVzkSmqkE2eJHO", "payment_method_details": { "card": { "brand": "visa", "checks": { "address_line1_check": null, "address_postal_code_check": null, "cvc_check": "pass" }, "country": "US", "exp_month": 8, "exp_year": 2030, "fingerprint": "XFO13q66ulrWf0ou", "funding": "credit", "installments": { "plan": { "count": null, "interval": null, "type": "fixed_count" } }, "last4": "4242", "mandate": null, "network": "visa", "three_d_secure": { "authentication_flow": null, "electronic_commerce_indicator": null, "exemption_indicator": null, "result": null, "result_reason": null, "transaction_id": null, "version": null }, "wallet": { "dynamic_last4": null, "type": "link" }, "amount_authorized": null, "authorization_code": null, "network_transaction_id": null, "regulated_status": null }, "type": "card" }, "receipt_email": null, "receipt_number": null, "receipt_url": "https://rwashburne-manage-mydev.dev.stripe.me/receipts/payment/CAcaFwoVYWNjdF8xTVdsSERKSVR6TFZ6a1NtKNr-vqAGMga56OxYPmU6LCIJCzDVSp5Ad3U9fZNleQoPNZ-HObHtPnsz8U55_1KOofBmEmAK5jBlWIYZ", "refunded": false, "refunds": { "data": [], "has_more": false, "object": "list", "url": "/v1/charges/ch_1Mcd6UJITzLVzkSmp1XIBHoW/refunds" }, "review": null, "shipping": {}, "source_transfer": null, "statement_descriptor": null, "statement_descriptor_suffix": null, "status": "succeeded", "transfer_data": { "amount": null, "destination": { "id": "obj_123", "object": "account" } }, "transfer_group": null, "source": { "allow_redisplay": null, "amount": null, "client_secret": "client_secret", "created": 1028554472, "currency": null, "flow": "flow", "id": "obj_123", "livemode": true, "metadata": null, "object": "source", "owner": { "address": { "city": null, "country": null, "line1": null, "line2": null, "postal_code": null, "state": null }, "email": null, "name": null, "phone": null, "verified_address": { "city": null, "country": null, "line1": null, "line2": null, "postal_code": null, "state": null }, "verified_email": null, "verified_name": null, "verified_phone": null }, "statement_descriptor": null, "status": "status", "type": "ideal", "usage": null } }, "checkout.session": { "after_expiration": { "recovery": { "allow_promotion_codes": true, "enabled": true, "expires_at": null, "url": null } }, "allow_promotion_codes": null, "amount_subtotal": null, "amount_total": null, "automatic_tax": { "enabled": false, "status": null, "liability": { "type": "account" }, "provider": null }, "billing_address_collection": null, "cancel_url": "https://example.com/cancel", "client_reference_id": null, "consent": { "promotions": null, "terms_of_service": null }, "consent_collection": { "payment_method_reuse_agreement": { "position": "hidden" }, "promotions": null, "terms_of_service": null }, "created": 1234567890, "currency": null, "custom_fields": [], "custom_text": { "shipping_address": { "message": "message" }, "submit": { "message": "message" }, "after_submit": { "message": "message" }, "terms_of_service_acceptance": { "message": "message" } }, "customer": null, "customer_creation": null, "customer_details": { "address": { "city": null, "country": null, "line1": null, "line2": null, "postal_code": null, "state": null }, "email": "example@example.com", "name": null, "phone": null, "tax_exempt": "none", "tax_ids": null }, "customer_email": null, "expires_at": 1234567890, "id": "cs_test_a1P5YYluaNII2Sw4YvDcqWDVcCaEF88dgjX1R52zahnP5GOEowMj42pzSq", "invoice": null, "invoice_creation": { "enabled": true, "invoice_data": { "account_tax_ids": null, "custom_fields": null, "description": null, "footer": null, "issuer": { "type": "account" }, "metadata": null, "rendering_options": { "amount_tax_display": null, "template": null } } }, "livemode": false, "locale": null, "metadata": {}, "mode": "payment", "object": "checkout.session", "payment_intent": "pi_1Mcd6XJITzLVzkSmwOxqskee", "payment_link": null, "payment_method_collection": null, "payment_method_options": {}, "payment_method_types": [ "card" ], "payment_status": "unpaid", "phone_number_collection": { "enabled": false }, "recovered_from": null, "setup_intent": null, "shipping_address_collection": { "allowed_countries": [ "SC" ] }, "shipping_cost": { "amount_subtotal": 1555417355, "amount_tax": 1424534716, "amount_total": 1117121693, "shipping_rate": null }, "shipping_options": [], "status": "open", "submit_type": null, "subscription": null, "success_url": "https://example.com/success", "total_details": { "amount_discount": 406046392, "amount_shipping": null, "amount_tax": 1424534716 }, "url": "https://checkout.stripe.com/pay/c/cs_test_a1P5YYluaNII2Sw4YvDcqWDVcCaEF88dgjX1R52zahnP5GOEowMj42pzSq", "adaptive_pricing": { "enabled": true }, "client_secret": null, "collected_information": { "shipping_details": { "address": { "city": null, "country": null, "line1": null, "line2": null, "postal_code": null, "state": null }, "name": "name" } }, "currency_conversion": { "amount_subtotal": 1555417355, "amount_total": 1117121693, "fx_rate": "291452898", "source_currency": "source_currency" }, "discounts": null, "payment_method_configuration_details": { "id": "obj_123", "parent": null }, "permissions": { "update_shipping_details": null }, "saved_payment_method_options": { "allow_redisplay_filters": null, "payment_method_remove": null, "payment_method_save": null }, "ui_mode": null, "wallet_options": {}, "origin_context": null }, "country_spec": { "default_currency": "usd", "id": "US", "object": "country_spec", "supported_bank_account_currencies": { "usd": [ "US" ] }, "supported_payment_currencies": [ "...", "aed", "afn", "usd" ], "supported_payment_methods": [ "ach", "card", "stripe" ], "supported_transfer_countries": [ "AE", "AG", "AL", "AM", "AO", "AR", "AT", "AU", "AZ", "BA", "BD", "BE", "BG", "BH", "BJ", "BN", "BO", "BS", "BT", "BW", "CA", "CH", "CI", "CL", "CO", "CR", "CY", "CZ", "DE", "DK", "DO", "DZ", "EC", "EE", "EG", "ES", "ET", "FI", "FR", "GA", "GB", "GH", "GM", "GR", "GT", "GY", "HK", "HR", "HU", "ID", "IE", "IL", "IS", "IT", "JM", "JO", "JP", "KE", "KH", "KR", "KW", "LA", "LC", "LI", "LK", "LT", "LU", "LV", "MA", "MC", "MD", "MG", "MK", "MN", "MO", "MT", "MU", "MX", "MY", "MZ", "NA", "NE", "NG", "NL", "NO", "NZ", "OM", "PA", "PE", "PH", "PL", "PT", "PY", "QA", "RO", "RS", "RW", "SA", "SE", "SG", "SI", "SK", "SM", "SN", "SV", "TH", "TN", "TR", "TT", "TW", "TZ", "US", "UY", "UZ", "VN", "ZA" ], "verification_fields": { "company": { "additional": [], "minimum": [ "business_profile.mcc", "business_profile.url", "business_type", "company.address.city", "company.address.line1", "company.address.postal_code", "company.address.state", "company.name", "company.owners_provided", "company.phone", "company.tax_id", "external_account", "owners.address.city", "owners.address.line1", "owners.address.postal_code", "owners.address.state", "owners.dob.day", "owners.dob.month", "owners.dob.year", "owners.email", "owners.first_name", "owners.id_number", "owners.last_name", "owners.phone", "owners.ssn_last_4", "owners.verification.document", "representative.address.city", "representative.address.line1", "representative.address.postal_code", "representative.address.state", "representative.dob.day", "representative.dob.month", "representative.dob.year", "representative.email", "representative.first_name", "representative.id_number", "representative.last_name", "representative.phone", "representative.relationship.executive", "representative.relationship.title", "representative.ssn_last_4", "representative.verification.document", "tos_acceptance.date", "tos_acceptance.ip" ] }, "individual": { "additional": [], "minimum": [ "business_profile.mcc", "business_profile.url", "business_type", "external_account", "individual.address.city", "individual.address.line1", "individual.address.postal_code", "individual.address.state", "individual.dob.day", "individual.dob.month", "individual.dob.year", "individual.email", "individual.first_name", "individual.id_number", "individual.last_name", "individual.phone", "individual.ssn_last_4", "individual.verification.document", "tos_acceptance.date", "tos_acceptance.ip" ] } } }, "coupon": { "amount_off": null, "created": 1234567890, "currency": "usd", "duration": "repeating", "duration_in_months": 3, "id": "Z4OV52SU", "livemode": false, "max_redemptions": null, "metadata": {}, "name": "25.5% off", "object": "coupon", "percent_off": 25.5, "redeem_by": 1234567890, "times_redeemed": 0, "valid": true }, "credit_note": { "amount": 1690, "amount_shipping": 0, "created": 1234567890, "currency": "usd", "customer": "cus_NNNslJKODLsLoG", "customer_balance_transaction": null, "discount_amount": 0, "discount_amounts": [], "id": "cn_1MlLiIJITzLVzkSmnWRQrDBf", "invoice": "in_1MlLiHJITzLVzkSmDEv4Nqiq", "lines": { "data": [ { "amount": 1190, "description": "My First Invoice Item (created for API docs)", "discount_amount": 0, "discount_amounts": [], "id": "cnli_1MlLiIJITzLVzkSmHScfIjOc", "invoice_line_item": "il_1MlLiHJITzLVzkSmOrWAtod5", "livemode": false, "object": "credit_note_line_item", "quantity": 1, "tax_rates": [ { "active": true, "country": "DE", "created": 1678753657, "description": "VAT Germany", "display_name": "VAT", "id": "txr_1MlLiHJITzLVzkSm3d4Zc9NE", "inclusive": false, "jurisdiction": "DE", "livemode": false, "metadata": {}, "object": "tax_rate", "percentage": 19, "state": null, "tax_type": "vat", "effective_percentage": null, "flat_amount": { "amount": 1413853096, "currency": "currency" }, "jurisdiction_level": null, "rate_type": null } ], "type": "invoice_line_item", "unit_amount": null, "unit_amount_decimal": null, "pretax_credit_amounts": [ { "amount": 1413853096, "type": "credit_balance_transaction" } ], "taxes": null }, { "amount": 500, "description": "Service credit", "discount_amount": 0, "discount_amounts": [], "id": "cnli_1MlLiIJITzLVzkSm5LIWS0zP", "livemode": false, "object": "credit_note_line_item", "quantity": 1, "tax_rates": [], "type": "custom_line_item", "unit_amount": 500, "unit_amount_decimal": "500", "pretax_credit_amounts": [ { "amount": 1413853096, "type": "credit_balance_transaction" } ], "taxes": null } ], "has_more": false, "object": "list", "url": "/v1/credit_notes/cn_1MlLiIJITzLVzkSmnWRQrDBf/lines" }, "livemode": false, "memo": null, "metadata": {}, "number": "ABCD-1234-CN-01", "object": "credit_note", "out_of_band_amount": null, "pdf": "https://rwashburne-manage-mydev.dev.stripe.me/credit_notes/acct_1MWlHDJITzLVzkSm/cnst_123456789/pdf?s=ap", "shipping_cost": { "amount_subtotal": 1555417355, "amount_tax": 1424534716, "amount_total": 1117121693, "shipping_rate": null }, "status": "issued", "subtotal": 1690, "subtotal_excluding_tax": 1690, "total": 1690, "total_excluding_tax": null, "type": "pre_payment", "voided_at": 1234567890, "effective_at": null, "post_payment_amount": 1355257296, "pre_payment_amount": 251024947, "pretax_credit_amounts": [ { "amount": 1413853096, "type": "credit_balance_transaction" } ], "refunds": [ { "amount_refunded": 1387154914, "refund": { "amount": 1413853096, "balance_transaction": null, "charge": null, "created": 1028554472, "currency": "currency", "id": "obj_123", "metadata": null, "object": "refund", "payment_intent": null, "reason": null, "receipt_number": null, "source_transfer_reversal": null, "status": null, "transfer_reversal": null } } ], "total_taxes": null, "reason": null }, "credit_note_line_item": { "amount": 1000, "description": "My First Invoice Item (created for API docs)", "discount_amount": 0, "discount_amounts": [], "id": "cnli_1MlLiIJITzLVzkSmDwzjUkgF", "invoice_line_item": "il_1MlLiIJITzLVzkSm6Gg3zoV0", "livemode": false, "object": "credit_note_line_item", "quantity": 1, "tax_rates": [], "type": "invoice_line_item", "unit_amount": null, "unit_amount_decimal": null, "pretax_credit_amounts": [ { "amount": 1413853096, "type": "credit_balance_transaction" } ], "taxes": null }, "customer": { "address": { "city": null, "country": null, "line1": null, "line2": null, "postal_code": null, "state": null }, "balance": 0, "created": 1234567890, "currency": "usd", "default_source": null, "delinquent": false, "description": null, "discount": { "checkout_session": null, "coupon": { "amount_off": null, "created": 1028554472, "currency": null, "duration": "forever", "duration_in_months": null, "id": "obj_123", "livemode": true, "max_redemptions": null, "metadata": null, "name": null, "object": "coupon", "percent_off": null, "redeem_by": null, "times_redeemed": 990066668, "valid": true }, "customer": null, "end": null, "id": "obj_123", "invoice": null, "invoice_item": null, "object": "discount", "promotion_code": null, "start": 109757538, "subscription": null, "subscription_item": null }, "email": null, "id": "cus_NNNslJKODLsLoG", "invoice_prefix": "1A66DA4", "invoice_settings": { "custom_fields": null, "default_payment_method": null, "footer": null, "rendering_options": { "amount_tax_display": null, "template": null } }, "livemode": false, "metadata": {}, "name": null, "next_invoice_sequence": 1, "object": "customer", "phone": null, "preferred_locales": [], "shipping": {}, "tax_exempt": "none", "test_clock": null }, "customer_balance_transaction": { "amount": -500, "created": 1234567890, "credit_note": null, "currency": "usd", "customer": "cus_NNNslJKODLsLoG", "description": null, "ending_balance": -500, "id": "cbtxn_1MlLi6JITzLVzkSmTSG1zk0i", "invoice": null, "livemode": false, "metadata": null, "object": "customer_balance_transaction", "type": "adjustment", "checkout_session": null }, "customer_cash_balance_transaction": { "created": 1234567890, "currency": "eur", "customer": "cus_NNNslJKODLsLoG", "ending_balance": 10000, "funded": { "bank_transfer": { "eu_bank_transfer": { "bic": "BANKDEAAXXX", "iban_last4": "7089", "sender_name": "Sample Business GmbH" }, "reference": "Payment for Invoice 1A66DA4-155", "type": "eu_bank_transfer" } }, "id": "ccsbtxn_1MlLi6JITzLVzkSmVRcwxIo4", "livemode": false, "net_amount": 5000, "object": "customer_cash_balance_transaction", "type": "funded" }, "deleted_account": { "deleted": true, "id": "acct_1MWlHDJITzLVzkSm", "object": "account" }, "deleted_apple_pay_domain": { "deleted": true, "id": "apwc_1MlLi1JITzLVzkSma2iSMoVr", "object": "apple_pay_domain" }, "deleted_coupon": { "deleted": true, "id": "Z4OV52SU", "object": "coupon" }, "deleted_customer": { "deleted": true, "id": "cus_NNNslJKODLsLoG", "object": "customer" }, "deleted_discount": { "coupon": { "amount_off": null, "applies_to": { "products": [] }, "created": 0, "currency": null, "currency_options": {}, "duration": "forever", "duration_in_months": null, "id": "", "livemode": false, "max_redemptions": null, "metadata": null, "name": null, "object": "coupon", "percent_off": null, "redeem_by": null, "times_redeemed": 0, "valid": false }, "deleted": true, "id": "", "object": "discount", "start": 1234567890, "checkout_session": null, "customer": null, "invoice": null, "invoice_item": null, "promotion_code": null, "subscription": null, "subscription_item": null }, "deleted_external_account": { "deleted": true, "id": "ba_1Mcd6nJITzLVzkSm2CZD1tkj", "object": "bank_account" }, "deleted_invoice": { "deleted": true, "id": "in_1MlLhvJITzLVzkSmcKw0tIgl", "object": "invoice" }, "deleted_invoiceitem": { "deleted": true, "id": "ii_1MlLi6JITzLVzkSmDouPGUDT", "object": "invoiceitem" }, "deleted_payment_source": { "deleted": true, "id": "ba_1Mcd6nJITzLVzkSm2CZD1tkj", "object": "bank_account" }, "deleted_person": { "deleted": true, "id": "person_1MlLiHJITzLVzkSmB4pg1uK9", "object": "person" }, "deleted_plan": { "deleted": true, "id": "price_1Mcd6ZJITzLVzkSmwd29pdd3", "object": "plan" }, "deleted_product": { "deleted": true, "id": "prod_NNNsbcqAqCJrj2", "object": "product" }, "deleted_radar.value_list": { "deleted": true, "id": "rsl_1MlLiGJITzLVzkSmi6kJ5coN", "object": "radar.value_list" }, "deleted_radar.value_list_item": { "deleted": true, "id": "rsli_1MlLiGJITzLVzkSmBdrq4Qmw", "object": "radar.value_list_item" }, "deleted_subscription_item": { "deleted": true, "id": "si_NWOVMvXVc2SbwK", "object": "subscription_item" }, "deleted_tax_id": { "deleted": true, "id": "txi_1MlLiHJITzLVzkSmi1opmyET", "object": "tax_id" }, "deleted_terminal.configuration": { "deleted": true, "id": "tmc_ElVUAjF8xXG3hj", "object": "terminal.configuration" }, "deleted_terminal.location": { "deleted": true, "id": "tml_cKQQfm6UGarpNRJRxXpzca4i", "object": "terminal.location" }, "deleted_terminal.reader": { "deleted": true, "id": "tmr_cKxInTQKOxDTvasletECzYvQ", "object": "terminal.reader" }, "deleted_test_helpers.test_clock": { "deleted": true, "id": "clock_1MlLiAJITzLVzkSmVBT841xQ", "object": "test_helpers.test_clock" }, "deleted_webhook_endpoint": { "deleted": true, "id": "we_1MlLiDJITzLVzkSm0QU7AnxQ", "object": "webhook_endpoint" }, "discount": { "checkout_session": null, "coupon": { "amount_off": null, "created": 1678753650, "currency": "usd", "duration": "repeating", "duration_in_months": 3, "id": "Z4OV52SU", "livemode": false, "max_redemptions": null, "metadata": {}, "name": "25.5% off", "object": "coupon", "percent_off": 25.5, "redeem_by": null, "times_redeemed": 0, "valid": true }, "customer": "cus_NNNslJKODLsLoG", "end": 1234567890, "id": "di_1MlLiAJITzLVzkSmNzEFTVSb", "invoice": null, "invoice_item": null, "object": "discount", "promotion_code": null, "start": 1234567890, "subscription": null, "subscription_item": null }, "dispute": { "amount": 1000, "balance_transactions": [], "charge": "ch_1Mcd6UJITzLVzkSmp1XIBHoW", "created": 1234567890, "currency": "usd", "evidence": { "access_activity_log": null, "billing_address": null, "cancellation_policy": null, "cancellation_policy_disclosure": null, "cancellation_rebuttal": null, "customer_communication": null, "customer_email_address": null, "customer_name": null, "customer_purchase_ip": null, "customer_signature": null, "duplicate_charge_documentation": null, "duplicate_charge_explanation": null, "duplicate_charge_id": null, "product_description": null, "receipt": null, "refund_policy": null, "refund_policy_disclosure": null, "refund_refusal_explanation": null, "service_date": null, "service_documentation": null, "shipping_address": null, "shipping_carrier": null, "shipping_date": null, "shipping_documentation": null, "shipping_tracking_number": null, "uncategorized_file": null, "uncategorized_text": null, "enhanced_evidence": {} }, "evidence_details": { "due_by": 1680479999, "has_evidence": false, "past_due": false, "submission_count": 0, "enhanced_eligibility": {} }, "id": "dp_1MlLi1JITzLVzkSmdqrdx0Ir", "is_charge_refundable": true, "livemode": false, "metadata": {}, "object": "dispute", "payment_intent": null, "reason": "general", "status": "warning_needs_response", "enhanced_eligibility_types": [ "visa_compelling_evidence_3" ] }, "ephemeral_key": { "created": 1234567890, "expires": 1234567890, "id": "ephkey_1MlLiHJITzLVzkSmzwMnAzon", "livemode": false, "object": "ephemeral_key" }, "event": { "api_version": null, "created": 1234567890, "data": { "object": { "active": true, "aggregate_usage": null, "amount": 2000, "amount_decimal": "2000", "billing_scheme": "per_unit", "created": 1676675559, "currency": "usd", "id": "price_1Mcd6ZJITzLVzkSmwd29pdd3", "interval": "month", "interval_count": 1, "livemode": false, "metadata": {}, "nickname": null, "object": "plan", "product": "prod_NNNsbcqAqCJrj2", "tiers_mode": null, "transform_usage": null, "trial_period_days": null, "usage_type": "licensed" } }, "id": "evt_1MlLiDJITzLVzkSmHhzJOLbM", "livemode": false, "object": "event", "pending_webhooks": 0, "request": { "id": null, "idempotency_key": null }, "type": "plan.created" }, "exchange_rate": { "id": "rate_7573642d636164", "object": "exchange_rate", "rates": {} }, "external_account": { "account_holder_name": "Jane Austen", "account_holder_type": "company", "account_type": null, "bank_name": "STRIPE TEST BANK", "country": "US", "currency": "usd", "customer": null, "fingerprint": "I1e2zttmxgyFZKaM", "id": "ba_1Mcd6nJITzLVzkSm2CZD1tkj", "last4": "3461", "metadata": {}, "object": "bank_account", "routing_number": "110000000", "status": "new" }, "fee_refund": { "amount": 100, "balance_transaction": null, "created": 1234567890, "currency": "usd", "fee": "fee_1MlLiCJITzLVzkSmRgPvDzIk", "id": "fr_1MlLiCJITzLVzkSmdm0wxqhZ", "metadata": {}, "object": "fee_refund" }, "file": { "created": 1234567890, "expires_at": 1234567890, "filename": "file_1Mcd6lJITzLVzkSmBrhnMBIc", "id": "file_1Mcd6lJITzLVzkSmBrhnMBIc", "links": { "data": [ { "created": 1678313590, "expired": false, "expires_at": null, "file": "file_1Mcd6lJITzLVzkSmBrhnMBIc", "id": "link_1MjVEQJITzLVzkSmhoKUNvEL", "livemode": false, "metadata": {}, "object": "file_link", "url": "https://rwashburne-upload-mydev.dev.stripe.me/links/MDB8YWNjdF8xTVdsSERKSVR6TFZ6a1NtfGZsX3Rlc3RfNDNCMGlNbkN4OFg0UEtpcFI0ZlBkbzRw00eBTPZOMY" }, { "created": 1678130857, "expired": false, "expires_at": null, "file": "file_1Mcd6lJITzLVzkSmBrhnMBIc", "id": "link_1Mijh7JITzLVzkSmNfJLomIO", "livemode": false, "metadata": {}, "object": "file_link", "url": "https://rwashburne-upload-mydev.dev.stripe.me/links/MDB8YWNjdF8xTVdsSERKSVR6TFZ6a1NtfGZsX3Rlc3RfdFdmVmZRRVhsMFVpc3Z0eFJ5b1hZMDlx00WT2Wdgbp" }, { "created": 1677887967, "expired": false, "expires_at": null, "file": "file_1Mcd6lJITzLVzkSmBrhnMBIc", "id": "link_1MhiVXJITzLVzkSm6Dq9g1cr", "livemode": false, "metadata": {}, "object": "file_link", "url": "https://rwashburne-upload-mydev.dev.stripe.me/links/MDB8YWNjdF8xTVdsSERKSVR6TFZ6a1NtfGZsX3Rlc3RfdG5KUDJpQk52U3Y1bG90a3BnQUxqM3Vp00Yptx0n4x" }, { "created": 1677614580, "expired": false, "expires_at": null, "file": "file_1Mcd6lJITzLVzkSmBrhnMBIc", "id": "link_1MgZO4JITzLVzkSmYUHx9UWJ", "livemode": false, "metadata": {}, "object": "file_link", "url": "https://rwashburne-upload-mydev.dev.stripe.me/links/MDB8YWNjdF8xTVdsSERKSVR6TFZ6a1NtfGZsX3Rlc3RfZWZkVktQWHVUUjZZV25POE5iREZCVlZ500XpIZUgMV" }, { "created": 1677613823, "expired": false, "expires_at": null, "file": "file_1Mcd6lJITzLVzkSmBrhnMBIc", "id": "link_1MgZBrJITzLVzkSmkEgJTIGP", "livemode": false, "metadata": {}, "object": "file_link", "url": "https://rwashburne-upload-mydev.dev.stripe.me/links/MDB8YWNjdF8xTVdsSERKSVR6TFZ6a1NtfGZsX3Rlc3Rfb1ZCRnV1cHZPM29LYVJraFRYd2Z0OTVy00iOOL1TOk" }, { "created": 1677612663, "expired": false, "expires_at": null, "file": "file_1Mcd6lJITzLVzkSmBrhnMBIc", "id": "link_1MgYt9JITzLVzkSmeDM5uAU9", "livemode": false, "metadata": {}, "object": "file_link", "url": "https://rwashburne-upload-mydev.dev.stripe.me/links/MDB8YWNjdF8xTVdsSERKSVR6TFZ6a1NtfGZsX3Rlc3Rfa3BKREJaN1JGdGR2Z2hyMnptMzBjeEc000tIWhh2jh" }, { "created": 1677018025, "expired": false, "expires_at": null, "file": "file_1Mcd6lJITzLVzkSmBrhnMBIc", "id": "link_1Me4CDJITzLVzkSmG6l1wouM", "livemode": false, "metadata": {}, "object": "file_link", "url": "https://rwashburne-upload-mydev.dev.stripe.me/links/MDB8YWNjdF8xTVdsSERKSVR6TFZ6a1NtfGZsX3Rlc3RfeVh4b2NKaVdEa2NyN2lQbG5CbUh0dk8500MxdWafoC" }, { "created": 1676675571, "expired": false, "expires_at": null, "file": "file_1Mcd6lJITzLVzkSmBrhnMBIc", "id": "link_1Mcd6lJITzLVzkSmMdO1GZOy", "livemode": false, "metadata": {}, "object": "file_link", "url": "https://rwashburne-upload-mydev.dev.stripe.me/links/MDB8YWNjdF8xTVdsSERKSVR6TFZ6a1NtfGZsX3Rlc3RfaXpqN2phREpMZ3dIMlVJQUJ0ejRlNkxw00pNRDCFVW" } ], "has_more": false, "object": "list", "url": "/v1/file_links?file=file_1Mcd6lJITzLVzkSmBrhnMBIc" }, "object": "file", "purpose": "dispute_evidence", "size": 9863, "title": null, "type": "png", "url": "https://rwashburne-upload-mydev.dev.stripe.me/v1/files/file_1Mcd6lJITzLVzkSmBrhnMBIc/contents" }, "file_link": { "created": 1234567890, "expired": false, "expires_at": 1234567890, "file": "file_1Mcd6lJITzLVzkSmBrhnMBIc", "id": "link_1MlLiHJITzLVzkSmg933O2co", "livemode": false, "metadata": {}, "object": "file_link", "url": "https://rwashburne-upload-mydev.dev.stripe.me/links/MDB8YWNjdF8xTVdsSERKSVR6TFZ6a1NtfGZsX3Rlc3Rfb3dFdjR5dVFQelMwdzZ6NzFvYTRrVW5N00Jk7QguH6" }, "financial_connections.account": { "account_holder": { "customer": "cus_NNNslJKODLsLoG", "type": "customer" }, "balance": { "as_of": 93102340, "current": { "undefined": 1126940025 }, "type": "cash" }, "balance_refresh": { "last_attempted_at": 1981828143, "next_refresh_available_at": null, "status": "failed" }, "category": "cash", "created": 1234567890, "display_name": "Sample Checking Account", "id": "fca_1MlLiIJITzLVzkSmdzRadyct", "institution_name": "StripeBank", "last4": "6789", "livemode": false, "object": "financial_connections.account", "ownership": null, "ownership_refresh": { "last_attempted_at": 1981828143, "next_refresh_available_at": null, "status": "failed" }, "permissions": [], "status": "active", "subcategory": "checking", "supported_payment_method_types": [ "us_bank_account" ], "subscriptions": null, "transaction_refresh": { "id": "obj_123", "last_attempted_at": 1981828143, "next_refresh_available_at": null, "status": "failed" } }, "financial_connections.account_owner": { "email": "nobody+janesmith@stripe.com", "id": "fcaown_1MlLiIJITzLVzkSm3NJZ94Jt", "name": "Jane Smith", "object": "financial_connections.account_owner", "ownership": "fcaowns_1MlLiIJITzLVzkSmJHcKmwIL", "phone": "+1 555-555-5555", "raw_address": "123 Main Street, Everytown USA", "refreshed_at": 1234567890 }, "financial_connections.session": { "account_holder": { "customer": "cus_NNNslJKODLsLoG", "type": "customer" }, "accounts": { "data": [], "has_more": false, "object": "list", "url": "/v1/financial_connections/accounts" }, "client_secret": "fcsess_..._secret_...", "id": "fcsess_1MlLiIJITzLVzkSmGXQM2wtP", "livemode": false, "object": "financial_connections.session", "permissions": [ "balances", "payment_method" ], "prefetch": null }, "funding_instructions": { "bank_transfer": { "country": "DE", "financial_addresses": [ { "iban": { "account_holder_name": "Stripe Technology Europe Limited", "bic": "SXPYDEHH", "country": "DE", "iban": "DE00000000000000000001", "account_holder_address": { "city": null, "country": null, "line1": null, "line2": null, "postal_code": null, "state": null }, "bank_address": { "city": null, "country": null, "line1": null, "line2": null, "postal_code": null, "state": null } }, "supported_networks": [ "sepa" ], "type": "iban" } ], "type": "eu_bank_transfer" }, "currency": "eur", "funding_type": "bank_transfer", "livemode": false, "object": "funding_instructions" }, "identity.verification_report": { "created": 1234567890, "document": { "address": { "city": "San Francisco", "country": "US", "line1": "1234 Main St.", "state": "CA", "line2": null, "postal_code": null }, "error": { "code": null, "reason": null }, "expiration_date": { "day": 1, "month": 12, "year": 2025 }, "files": [ "file_NWOV2MoM5XTbveA96C1vboPt", "file_NWOVTpKqMOyf5KVCJkNKnnHn" ], "first_name": "Jenny", "issued_date": { "day": 1, "month": 12, "year": 2020 }, "issuing_country": "US", "last_name": "Rosen", "status": "verified", "type": "driving_license" }, "id": "vr_1MlLiIJITzLVzkSmXm2kbOyG", "livemode": false, "object": "identity.verification_report", "options": { "document": {} }, "type": "document", "verification_session": "vs_NWOV3nJBiY3XZahmfEbL86ED", "client_reference_id": null }, "identity.verification_session": { "client_secret": null, "created": 1234567890, "id": "vs_1MlLiIJITzLVzkSmXOIbTTQ7", "last_error": { "code": null, "reason": null }, "last_verification_report": "vr_NWOVVPm6heOhwu1lJmFFri3N", "livemode": false, "metadata": {}, "object": "identity.verification_session", "options": { "document": { "require_matching_selfie": true } }, "redaction": { "status": "processing" }, "status": "verified", "type": "document", "url": null, "client_reference_id": null, "related_customer": null }, "invoice": { "account_country": "US", "account_name": null, "account_tax_ids": null, "amount_due": 1000, "amount_paid": 0, "amount_remaining": 1000, "amount_shipping": 0, "application": null, "attempt_count": 0, "attempted": false, "auto_advance": true, "automatic_tax": { "enabled": false, "status": null, "disabled_reason": null, "liability": { "type": "account" }, "provider": null }, "billing_reason": "manual", "collection_method": "charge_automatically", "created": 1234567890, "currency": "usd", "custom_fields": null, "customer": "cus_NNNslJKODLsLoG", "customer_address": { "city": null, "country": null, "line1": null, "line2": null, "postal_code": null, "state": null }, "customer_email": null, "customer_name": null, "customer_phone": null, "customer_shipping": {}, "customer_tax_exempt": "none", "customer_tax_ids": [], "default_payment_method": null, "default_source": null, "default_tax_rates": [], "description": null, "discounts": [], "due_date": 1234567890, "ending_balance": null, "footer": null, "from_invoice": { "action": "action", "invoice": "invoice" }, "hosted_invoice_url": null, "id": "in_1MlLhvJITzLVzkSmcKw0tIgl", "invoice_pdf": null, "last_finalization_error": { "type": "idempotency_error" }, "latest_revision": null, "lines": { "data": [ { "amount": 1000, "currency": "usd", "description": "My First Invoice Item (created for API docs)", "discount_amounts": [], "discountable": true, "discounts": [], "id": "il_1MlLhmJITzLVzkSm90klW90i", "livemode": false, "metadata": {}, "object": "line_item", "period": { "end": 1678753626, "start": 1678753626 }, "quantity": 1, "subscription": null, "invoice": null, "parent": { "invoice_item_details": { "invoice_item": "invoice_item", "proration": true, "proration_details": { "credited_items": { "invoice": "invoice", "invoice_line_items": [ "invoice_line_items" ] } }, "subscription": null }, "subscription_item_details": { "invoice_item": null, "proration": true, "proration_details": { "credited_items": { "invoice": "invoice", "invoice_line_items": [ "invoice_line_items" ] } }, "subscription": null, "subscription_item": "subscription_item" }, "type": "invoice_item_details" }, "pretax_credit_amounts": null, "pricing": { "type": "price_details", "unit_amount_decimal": null }, "taxes": null } ], "has_more": false, "object": "list", "url": "/v1/invoices/in_1MlLhvJITzLVzkSmcKw0tIgl/lines" }, "livemode": false, "metadata": {}, "next_payment_attempt": 1234567890, "number": null, "object": "invoice", "on_behalf_of": null, "payment_settings": { "default_mandate": null, "payment_method_options": { "acss_debit": {}, "bancontact": { "preferred_language": "fr" }, "card": { "request_three_d_secure": null }, "customer_balance": { "funding_type": null }, "konbini": {}, "sepa_debit": {}, "us_bank_account": {} }, "payment_method_types": null }, "period_end": 1234567890, "period_start": 1234567890, "post_payment_credit_notes_amount": 0, "pre_payment_credit_notes_amount": 0, "receipt_number": null, "shipping_cost": { "amount_subtotal": 1555417355, "amount_tax": 1424534716, "amount_total": 1117121693, "shipping_rate": null }, "shipping_details": {}, "starting_balance": 0, "statement_descriptor": null, "status": "draft", "status_transitions": { "finalized_at": null, "marked_uncollectible_at": null, "paid_at": null, "voided_at": null }, "subscription": null, "subtotal": 1000, "subtotal_excluding_tax": 1000, "test_clock": null, "total": 1000, "total_discount_amounts": [], "total_excluding_tax": 1000, "webhooks_delivered_at": 1234567890, "amount_overpaid": 149300825, "automatically_finalizes_at": null, "effective_at": null, "issuer": { "type": "account" }, "parent": { "quote_details": { "quote": "quote" }, "subscription_details": { "metadata": null, "subscription": "subscription" }, "type": "quote_details" }, "rendering": { "amount_tax_display": null, "pdf": { "page_size": null }, "template": null, "template_version": null }, "total_pretax_credit_amounts": null, "total_taxes": null }, "invoiceitem": { "amount": 1000, "currency": "usd", "customer": "cus_NNNslJKODLsLoG", "date": 1234567890, "description": "My First Invoice Item (created for API docs)", "discountable": true, "discounts": [], "id": "ii_1MlLi6JITzLVzkSmDouPGUDT", "invoice": null, "livemode": false, "metadata": {}, "object": "invoiceitem", "period": { "end": 1678753646, "start": 1678753646 }, "proration": false, "quantity": 1, "tax_rates": [], "test_clock": null, "parent": { "subscription_details": { "subscription": "subscription" }, "type": "subscription_details" }, "pricing": { "type": "price_details", "unit_amount_decimal": null } }, "issuing.authorization": { "amount": 0, "amount_details": { "atm_fee": null, "cashback_amount": null }, "approved": true, "authorization_method": "keyed_in", "balance_transactions": [], "card": { "brand": "Visa", "cancellation_reason": null, "cardholder": { "billing": { "address": { "city": "Beverly Hills", "country": "US", "line1": "123 Fake St", "line2": "Apt 3", "postal_code": "90210", "state": "CA" } }, "company": { "tax_id_provided": true }, "created": 1676675570, "email": "jenny@example.com", "id": "ich_1Mcd6kJITzLVzkSmsPNd4Aor", "individual": { "dob": { "day": null, "month": null, "year": null }, "first_name": null, "last_name": null, "verification": { "document": { "back": null, "front": null } } }, "livemode": false, "metadata": {}, "name": "Jenny Rosen", "object": "issuing.cardholder", "phone_number": "+18008675309", "requirements": { "disabled_reason": null, "past_due": [] }, "spending_controls": { "allowed_categories": [], "blocked_categories": [], "spending_limits": [], "spending_limits_currency": null, "allowed_merchant_countries": null, "blocked_merchant_countries": null }, "status": "active", "type": "individual", "preferred_locales": null }, "created": 1678753656, "currency": "usd", "exp_month": 8, "exp_year": 2030, "id": "ic_1MlLiGJITzLVzkSmNmKqbF30", "last4": "4242", "livemode": false, "metadata": {}, "object": "issuing.card", "replaced_by": null, "replacement_for": null, "replacement_reason": null, "shipping": { "address": { "city": null, "country": null, "line1": null, "line2": null, "postal_code": null, "state": null }, "address_validation": { "mode": "normalization_only", "normalized_address": { "city": null, "country": null, "line1": null, "line2": null, "postal_code": null, "state": null }, "result": null }, "carrier": null, "customs": { "eori_number": null }, "eta": null, "name": "name", "phone_number": null, "require_signature": null, "service": "express", "status": null, "tracking_number": null, "tracking_url": null, "type": "bulk" }, "spending_controls": { "allowed_categories": null, "blocked_categories": null, "spending_limits": [], "spending_limits_currency": null, "allowed_merchant_countries": null, "blocked_merchant_countries": null }, "status": "active", "type": "physical", "wallets": { "apple_pay": { "eligible": true, "ineligible_reason": null }, "google_pay": { "eligible": true, "ineligible_reason": null }, "primary_account_identifier": null }, "personalization_design": null }, "cardholder": null, "created": 1234567890, "currency": "usd", "id": "iauth_1MlLiGJITzLVzkSmqSJmhz6r", "livemode": false, "merchant_amount": 0, "merchant_currency": "usd", "merchant_data": { "category": "taxicabs_limousines", "category_code": "4121", "city": "San Francisco", "country": "US", "name": "Rocket Rides", "network_id": "1234567890", "postal_code": "94107", "state": "CA", "tax_id": null, "terminal_id": null, "url": null }, "metadata": {}, "network_data": { "acquiring_institution_id": null, "system_trace_audit_number": null, "transaction_id": null }, "object": "issuing.authorization", "pending_request": { "amount": 700, "amount_details": { "atm_fee": null, "cashback_amount": null }, "currency": "usd", "is_amount_controllable": false, "merchant_amount": 700, "merchant_currency": "usd", "network_risk_score": null }, "request_history": [], "status": "pending", "transactions": [], "verification_data": { "address_line1_check": "not_provided", "address_postal_code_check": "match", "cvc_check": "match", "expiry_check": "match", "authentication_exemption": { "claimed_by": "issuer", "type": "low_value_transaction" }, "postal_code": null, "three_d_secure": { "result": "required" } }, "wallet": null, "fleet": { "cardholder_prompt_data": { "alphanumeric_id": null, "driver_id": null, "odometer": null, "unspecified_id": null, "user_id": null, "vehicle_number": null }, "purchase_type": null, "reported_breakdown": { "fuel": { "gross_amount_decimal": null }, "non_fuel": { "gross_amount_decimal": null }, "tax": { "local_amount_decimal": null, "national_amount_decimal": null } }, "service_type": null }, "fuel": { "industry_product_code": null, "quantity_decimal": null, "type": null, "unit": null, "unit_cost_decimal": null }, "verified_by_fraud_challenge": null }, "issuing.card": { "brand": "Visa", "cancellation_reason": null, "cardholder": { "billing": { "address": { "city": "Beverly Hills", "country": "US", "line1": "123 Fake St", "line2": "Apt 3", "postal_code": "90210", "state": "CA" } }, "company": { "tax_id_provided": true }, "created": 1676675570, "email": "jenny@example.com", "id": "ich_1Mcd6kJITzLVzkSmsPNd4Aor", "individual": { "dob": { "day": null, "month": null, "year": null }, "first_name": null, "last_name": null, "verification": { "document": { "back": null, "front": null } } }, "livemode": false, "metadata": {}, "name": "Jenny Rosen", "object": "issuing.cardholder", "phone_number": "+18008675309", "requirements": { "disabled_reason": null, "past_due": [] }, "spending_controls": { "allowed_categories": [], "blocked_categories": [], "spending_limits": [], "spending_limits_currency": null, "allowed_merchant_countries": null, "blocked_merchant_countries": null }, "status": "active", "type": "individual", "preferred_locales": null }, "created": 1234567890, "currency": "usd", "exp_month": 8, "exp_year": 2030, "id": "ic_1MlLiGJITzLVzkSm501c5IUl", "last4": "4242", "livemode": false, "metadata": {}, "object": "issuing.card", "replaced_by": null, "replacement_for": null, "replacement_reason": null, "shipping": { "address": { "city": null, "country": null, "line1": null, "line2": null, "postal_code": null, "state": null }, "address_validation": { "mode": "normalization_only", "normalized_address": { "city": null, "country": null, "line1": null, "line2": null, "postal_code": null, "state": null }, "result": null }, "carrier": null, "customs": { "eori_number": null }, "eta": null, "name": "name", "phone_number": null, "require_signature": null, "service": "express", "status": null, "tracking_number": null, "tracking_url": null, "type": "bulk" }, "spending_controls": { "allowed_categories": null, "blocked_categories": null, "spending_limits": [], "spending_limits_currency": null, "allowed_merchant_countries": null, "blocked_merchant_countries": null }, "status": "active", "type": "physical", "wallets": { "apple_pay": { "eligible": true, "ineligible_reason": null }, "google_pay": { "eligible": true, "ineligible_reason": null }, "primary_account_identifier": null }, "personalization_design": null }, "issuing.cardholder": { "billing": { "address": { "city": "Beverly Hills", "country": "US", "line1": "123 Fake St", "line2": "Apt 3", "postal_code": "90210", "state": "CA" } }, "company": { "tax_id_provided": true }, "created": 1234567890, "email": "jenny@example.com", "id": "ich_1Mcd6kJITzLVzkSmsPNd4Aor", "individual": { "dob": { "day": null, "month": null, "year": null }, "first_name": null, "last_name": null, "verification": { "document": { "back": null, "front": null } } }, "livemode": false, "metadata": {}, "name": "Jenny Rosen", "object": "issuing.cardholder", "phone_number": "+18008675309", "requirements": { "disabled_reason": null, "past_due": [] }, "spending_controls": { "allowed_categories": [], "blocked_categories": [], "spending_limits": [], "spending_limits_currency": null, "allowed_merchant_countries": null, "blocked_merchant_countries": null }, "status": "active", "type": "individual", "preferred_locales": null }, "issuing.dispute": { "amount": 100, "created": 1234567890, "currency": "usd", "evidence": { "fraudulent": { "additional_documentation": null, "explanation": "Fraud; card reported lost on 03/14/2023" }, "reason": "fraudulent" }, "id": "idp_1MlLiGJITzLVzkSmOI6HSEx8", "livemode": false, "metadata": {}, "object": "issuing.dispute", "status": "unsubmitted", "transaction": "ipi_1MlLiGJITzLVzkSmMG2YBUPd" }, "issuing.settlement": { "bin": "424242", "clearing_date": 1678753656, "created": 1234567890, "currency": "usd", "id": "ise_1MlLiGJITzLVzkSmPHGJsQ1Q", "interchange_fees": 44, "livemode": false, "metadata": {}, "net_total": 3575, "network": "visa", "network_fees": 37, "network_settlement_identifier": "1000633976", "object": "issuing.settlement", "settlement_service": "international", "transaction_count": 2, "transaction_volume": 3656, "interchange_fees_amount": 954995977, "net_total_amount": 1180960021, "network_fees_amount": 1785987431, "status": "complete", "transaction_amount": 979491623 }, "issuing.transaction": { "amount": -100, "amount_details": { "atm_fee": null, "cashback_amount": null }, "authorization": "iauth_1MlLiGJITzLVzkSmL75LlYZd", "balance_transaction": null, "card": "ic_1MlLiGJITzLVzkSmKEB9L4Rr", "cardholder": "ich_1Mcd6kJITzLVzkSmsPNd4Aor", "created": 1234567890, "currency": "usd", "dispute": null, "id": "ipi_1MlLiGJITzLVzkSm4D4lbwNj", "livemode": false, "merchant_amount": -100, "merchant_currency": "usd", "merchant_data": { "category": "taxicabs_limousines", "category_code": "4121", "city": "San Francisco", "country": "US", "name": "Rocket Rides", "network_id": "1234567890", "postal_code": "94107", "state": "CA", "tax_id": null, "terminal_id": null, "url": null }, "metadata": {}, "object": "issuing.transaction", "type": "capture", "wallet": "apple_pay", "network_data": { "authorization_code": null, "processing_date": null, "transaction_id": null } }, "item": { "amount_discount": 0, "amount_subtotal": 0, "amount_tax": 0, "amount_total": 0, "currency": "usd", "description": "T-shirt", "id": "li_1MlLiAJITzLVzkSmzUBld3x2", "object": "item", "price": { "active": true, "billing_scheme": "per_unit", "created": 1676675558, "currency": "usd", "custom_unit_amount": { "maximum": null, "minimum": null, "preset": null }, "id": "price_1Mcd6YJITzLVzkSmJJsJfga5", "livemode": false, "lookup_key": null, "metadata": {}, "nickname": null, "object": "price", "product": "prod_NNNsbcqAqCJrj2", "recurring": { "interval": "month", "interval_count": 797691627, "meter": null, "trial_period_days": null, "usage_type": "licensed" }, "tax_behavior": "unspecified", "tiers_mode": null, "transform_quantity": { "divide_by": 1592560163, "round": "down" }, "type": "one_time", "unit_amount": 1000, "unit_amount_decimal": "1000" }, "quantity": 1 }, "line_item": { "amount": 1000, "currency": "usd", "description": "My First Invoice Item (created for API docs)", "discount_amounts": [], "discountable": true, "discounts": [], "id": "il_tmp_1MlLi6JITzLVzkSmDouPGUDT", "livemode": false, "metadata": {}, "object": "line_item", "period": { "end": 1678753646, "start": 1678753646 }, "quantity": 1, "subscription": null, "invoice": null, "parent": { "invoice_item_details": { "invoice_item": "invoice_item", "proration": true, "proration_details": { "credited_items": { "invoice": "invoice", "invoice_line_items": [ "invoice_line_items" ] } }, "subscription": null }, "subscription_item_details": { "invoice_item": null, "proration": true, "proration_details": { "credited_items": { "invoice": "invoice", "invoice_line_items": [ "invoice_line_items" ] } }, "subscription": null, "subscription_item": "subscription_item" }, "type": "invoice_item_details" }, "pretax_credit_amounts": null, "pricing": { "type": "price_details", "unit_amount_decimal": null }, "taxes": null }, "login_link": { "created": 1234567890, "object": "login_link", "url": "https://rwashburne-manage-mydev.dev.stripe.me/express/ZiLE8RvPEZop" }, "mandate": { "customer_acceptance": { "accepted_at": 123456789, "online": { "ip_address": "127.0.0.0", "user_agent": "device" }, "type": "online" }, "id": "mandate_1MlLiFJITzLVzkSm2nP1Re56", "livemode": false, "multi_use": {}, "object": "mandate", "payment_method": "pm_123456789", "payment_method_details": { "sepa_debit": { "reference": "123456789", "url": "" }, "type": "sepa_debit" }, "status": "active", "type": "multi_use" }, "payment_intent": { "amount": 1099, "amount_capturable": 0, "amount_details": { "tip": {} }, "amount_received": 0, "application": null, "application_fee_amount": null, "automatic_payment_methods": { "enabled": true }, "canceled_at": 1234567890, "cancellation_reason": null, "capture_method": "automatic", "client_secret": "pi_1Mcd6XJITzLVzkSmwOxqskee_secret_JwlrslN96B4lvG68fs4kDmrmy", "confirmation_method": "automatic", "created": 1234567890, "currency": "usd", "customer": null, "description": null, "id": "pi_1Mcd6XJITzLVzkSmwOxqskee", "last_payment_error": { "type": "idempotency_error" }, "latest_charge": null, "livemode": false, "metadata": {}, "next_action": { "type": "type" }, "object": "payment_intent", "on_behalf_of": null, "payment_method": null, "payment_method_options": {}, "payment_method_types": [ "card" ], "processing": { "type": "card" }, "receipt_email": null, "review": null, "setup_future_usage": null, "shipping": {}, "statement_descriptor": null, "statement_descriptor_suffix": null, "status": "requires_payment_method", "transfer_data": { "destination": { "id": "obj_123", "object": "account" } }, "transfer_group": null, "payment_method_configuration_details": { "id": "obj_123", "parent": null }, "source": null, "excluded_payment_method_types": null }, "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": { "type": "account" } }, "billing_address_collection": "auto", "consent_collection": { "payment_method_reuse_agreement": { "position": "hidden" }, "promotions": null, "terms_of_service": null }, "currency": "usd", "custom_fields": [], "custom_text": { "shipping_address": { "message": "message" }, "submit": { "message": "message" }, "after_submit": { "message": "message" }, "terms_of_service_acceptance": { "message": "message" } }, "customer_creation": "always", "id": "plink_1MlLiGJITzLVzkSmYEeQa9ac", "invoice_creation": { "enabled": true, "invoice_data": { "account_tax_ids": null, "custom_fields": null, "description": null, "footer": null, "issuer": { "type": "account" }, "metadata": null, "rendering_options": { "amount_tax_display": null, "template": null } } }, "livemode": false, "metadata": {}, "object": "payment_link", "on_behalf_of": null, "payment_intent_data": { "capture_method": null, "description": null, "metadata": { "undefined": "metadata" }, "setup_future_usage": null, "statement_descriptor": null, "statement_descriptor_suffix": null, "transfer_group": null }, "payment_method_collection": "always", "payment_method_types": null, "phone_number_collection": { "enabled": false }, "shipping_address_collection": { "allowed_countries": [ "SC" ] }, "shipping_options": [], "submit_type": "auto", "subscription_data": { "description": null, "invoice_settings": { "issuer": { "type": "account" } }, "metadata": { "undefined": "metadata" }, "trial_period_days": null, "trial_settings": { "end_behavior": { "missing_payment_method": "cancel" } } }, "tax_id_collection": { "enabled": false, "required": "never" }, "transfer_data": { "amount": null, "destination": { "id": "obj_123", "object": "account" } }, "url": "https://rwashburne-payment_links_ingress-mydev.dev.stripe.me/test_14k9DmarJ5q07Nm7ss", "application": null, "inactive_message": null, "restrictions": { "completed_sessions": { "count": 94851343, "limit": 102976443 } } }, "payment_method": { "billing_details": { "address": { "city": "San Francisco", "country": "US", "line1": "1234 Fake Street", "line2": null, "postal_code": "94102", "state": "CA" }, "email": "jenny@example.com", "name": null, "phone": "+15555555555", "tax_id": null }, "card": { "brand": "visa", "checks": { "address_line1_check": null, "address_postal_code_check": null, "cvc_check": "pass" }, "country": "US", "exp_month": 8, "exp_year": 2030, "fingerprint": "XFO13q66ulrWf0ou", "funding": "credit", "generated_from": { "charge": null, "payment_method_details": { "type": "type" }, "setup_attempt": null }, "last4": "4242", "networks": { "available": [ "visa" ], "preferred": null }, "three_d_secure_usage": { "supported": true }, "wallet": { "dynamic_last4": null, "type": "link" }, "display_brand": null, "regulated_status": null }, "created": 1234567890, "customer": null, "id": "pm_1MlLi5JITzLVzkSmZEk8HwXY", "livemode": false, "metadata": { "order_id": "123456789" }, "object": "payment_method", "type": "card" }, "payment_source": { "business_profile": { "mcc": null, "name": null, "product_description": null, "support_address": { "city": null, "country": null, "line1": null, "line2": null, "postal_code": null, "state": null }, "support_email": null, "support_phone": null, "support_url": null, "url": null, "minority_owned_business_designation": null }, "business_type": null, "capabilities": { "card_payments": "active", "transfers": "active" }, "charges_enabled": false, "controller": { "type": "account" }, "country": "US", "created": 1675277004, "default_currency": "usd", "details_submitted": false, "email": "site@stripe.com", "external_accounts": { "data": [], "has_more": false, "object": "list", "url": "/v1/accounts/acct_1MWlHDJITzLVzkSm/external_accounts" }, "future_requirements": { "alternatives": [], "current_deadline": null, "currently_due": [], "disabled_reason": null, "errors": [], "eventually_due": [], "past_due": [], "pending_verification": [] }, "id": "acct_1MWlHDJITzLVzkSm", "metadata": {}, "object": "account", "payouts_enabled": false, "requirements": { "alternatives": [], "current_deadline": null, "currently_due": [ "business_profile.product_description", "business_profile.support_phone", "business_profile.url", "external_account", "tos_acceptance.date", "tos_acceptance.ip" ], "disabled_reason": "requirements.past_due", "errors": [], "eventually_due": [ "business_profile.product_description", "business_profile.support_phone", "business_profile.url", "external_account", "tos_acceptance.date", "tos_acceptance.ip" ], "past_due": [], "pending_verification": [] }, "settings": { "bacs_debit_payments": { "display_name": null, "service_user_number": null }, "branding": { "icon": null, "logo": null, "primary_color": null, "secondary_color": null }, "card_issuing": { "tos_acceptance": { "date": null, "ip": null } }, "card_payments": { "decline_on": { "avs_failure": true, "cvc_failure": true }, "statement_descriptor_prefix": null, "statement_descriptor_prefix_kana": null, "statement_descriptor_prefix_kanji": null }, "dashboard": { "display_name": null, "timezone": "Etc/UTC" }, "payments": { "statement_descriptor": null, "statement_descriptor_kana": null, "statement_descriptor_kanji": null, "statement_descriptor_prefix_kana": null, "statement_descriptor_prefix_kanji": null }, "payouts": { "debit_negative_balances": true, "schedule": { "delay_days": 2, "interval": "daily" }, "statement_descriptor": null }, "sepa_debit_payments": {} }, "tos_acceptance": { "date": null, "ip": null, "user_agent": null }, "type": "standard" }, "payout": { "amount": 1100, "arrival_date": 1234567890, "automatic": true, "balance_transaction": "txn_1MlLhiJITzLVzkSm0tDIM70A", "created": 1234567890, "currency": "usd", "description": "STRIPE PAYOUT", "destination": "ba_1MlLiCJITzLVzkSmzTHBeJt2", "failure_balance_transaction": null, "failure_code": null, "failure_message": null, "id": "po_1MlLiCJITzLVzkSmTO8DFctc", "livemode": false, "metadata": {}, "method": "standard", "object": "payout", "original_payout": null, "reconciliation_status": "not_applicable", "reversed_by": null, "source_type": "card", "statement_descriptor": null, "status": "in_transit", "type": "bank_account", "application_fee": null, "application_fee_amount": null, "trace_id": { "status": "status", "value": null }, "payout_method": null }, "person": { "account": "acct_1MWlHDJITzLVzkSm", "created": 1234567890, "dob": { "day": null, "month": null, "year": null }, "first_name": null, "future_requirements": { "alternatives": [], "currently_due": [], "errors": [], "eventually_due": [], "past_due": [], "pending_verification": [] }, "id": "person_1MlLiHJITzLVzkSmB4pg1uK9", "id_number_provided": false, "last_name": null, "metadata": {}, "object": "person", "relationship": { "director": false, "executive": false, "owner": false, "percent_ownership": null, "representative": false, "title": null, "authorizer": null, "legal_guardian": null }, "requirements": { "alternatives": [], "currently_due": [], "errors": [], "eventually_due": [], "past_due": [], "pending_verification": [] }, "ssn_last_4_provided": false, "verification": { "additional_document": { "back": null, "details": null, "details_code": null, "front": null }, "details": null, "details_code": null, "document": { "back": null, "details": null, "details_code": null, "front": null }, "status": "unverified" } }, "plan": { "active": true, "amount": 2000, "amount_decimal": "2000", "billing_scheme": "per_unit", "created": 1234567890, "currency": "usd", "id": "price_1Mcd6ZJITzLVzkSmwd29pdd3", "interval": "month", "interval_count": 1, "livemode": false, "metadata": {}, "nickname": null, "object": "plan", "product": "prod_NNNsbcqAqCJrj2", "tiers_mode": null, "transform_usage": { "divide_by": 1592560163, "round": "down" }, "trial_period_days": null, "usage_type": "licensed", "meter": null }, "price": { "active": true, "billing_scheme": "per_unit", "created": 1234567890, "currency": "usd", "custom_unit_amount": { "maximum": null, "minimum": null, "preset": null }, "id": "price_1Mcd6ZJITzLVzkSmwd29pdd3", "livemode": false, "lookup_key": null, "metadata": {}, "nickname": null, "object": "price", "product": "prod_NNNsbcqAqCJrj2", "recurring": { "interval": "month", "interval_count": 1, "usage_type": "licensed", "meter": null, "trial_period_days": null }, "tax_behavior": "unspecified", "tiers_mode": null, "transform_quantity": { "divide_by": 1592560163, "round": "down" }, "type": "recurring", "unit_amount": 2000, "unit_amount_decimal": "2000" }, "product": { "active": true, "created": 1234567890, "default_price": "price_1Mcd6YJITzLVzkSmsV8lHm33", "description": "Comfortable gray cotton t-shirt", "id": "prod_NNNsbcqAqCJrj2", "images": [], "livemode": false, "metadata": {}, "name": "T-shirt", "object": "product", "package_dimensions": { "height": 1221029593, "length": 1106363674, "weight": 791592328, "width": 113126854 }, "shippable": null, "statement_descriptor": null, "tax_code": null, "unit_label": null, "updated": 1234567890, "url": null, "marketing_features": [ {} ], "type": "good" }, "promotion_code": { "active": false, "code": "FALL20", "coupon": { "amount_off": null, "created": 1678753650, "currency": "usd", "duration": "repeating", "duration_in_months": 3, "id": "Z4OV52SU", "livemode": false, "max_redemptions": null, "metadata": {}, "name": "25.5% off", "object": "coupon", "percent_off": 25.5, "redeem_by": null, "times_redeemed": 0, "valid": true }, "created": 1234567890, "customer": null, "expires_at": 1234567890, "id": "promo_1MlLiAJITzLVzkSmAKV6tZ50", "livemode": false, "max_redemptions": null, "metadata": {}, "object": "promotion_code", "restrictions": { "first_time_transaction": false, "minimum_amount": null, "minimum_amount_currency": null }, "times_redeemed": 0 }, "quote": { "amount_subtotal": 0, "amount_total": 0, "application": null, "application_fee_amount": null, "application_fee_percent": null, "automatic_tax": { "enabled": false, "status": null, "liability": { "type": "account" }, "provider": null }, "collection_method": "charge_automatically", "computed": { "recurring": { "amount_subtotal": 1555417355, "amount_total": 1117121693, "interval": "month", "interval_count": 797691627, "total_details": { "amount_discount": 406046392, "amount_shipping": null, "amount_tax": 1424534716 } }, "upfront": { "amount_subtotal": 0, "amount_total": 0, "total_details": { "amount_discount": 0, "amount_shipping": 0, "amount_tax": 0 } } }, "created": 1234567890, "currency": "usd", "customer": "cus_NNNslJKODLsLoG", "default_tax_rates": [], "description": null, "discounts": [], "expires_at": 1234567890, "footer": null, "from_quote": { "is_revision": true, "quote": "quote" }, "header": null, "id": "qt_1MlLiAJITzLVzkSmgwkSkaNM", "invoice": null, "invoice_settings": { "days_until_due": null, "issuer": { "type": "account" } }, "livemode": false, "metadata": {}, "number": null, "object": "quote", "on_behalf_of": null, "status": "draft", "status_transitions": { "accepted_at": null, "canceled_at": null, "finalized_at": null }, "subscription": null, "subscription_data": { "description": null, "effective_date": null, "trial_period_days": null, "metadata": null, "billing_mode": { "type": "classic" } }, "subscription_schedule": null, "test_clock": null, "total_details": { "amount_discount": 0, "amount_shipping": 0, "amount_tax": 0 }, "transfer_data": { "amount": null, "amount_percent": null, "destination": { "id": "obj_123", "object": "account" } } }, "radar.early_fraud_warning": { "actionable": true, "charge": "ch_1234", "created": 1234567890, "fraud_type": "misc", "id": "issfr_1MlLiHJITzLVzkSmoMY1CPmo", "livemode": false, "object": "radar.early_fraud_warning" }, "radar.value_list": { "alias": "custom_ip_blocklist", "created": 1234567890, "created_by": "jenny@example.com", "id": "rsl_1MlLiGJITzLVzkSmi6kJ5coN", "item_type": "ip_address", "list_items": { "data": [], "has_more": false, "object": "list", "url": "/v1/radar/value_list_items?value_list=rsl_1MlLiGJITzLVzkSmi6kJ5coN" }, "livemode": false, "metadata": {}, "name": "Custom IP Blocklist", "object": "radar.value_list" }, "radar.value_list_item": { "created": 1234567890, "created_by": "jenny@example.com", "id": "rsli_1MlLiGJITzLVzkSmBdrq4Qmw", "livemode": false, "object": "radar.value_list_item", "value": "1.2.3.4", "value_list": "rsl_1MlLiGJITzLVzkSmBlAoqGLm" }, "refund": { "amount": 100, "balance_transaction": null, "charge": "ch_1Mcd6UJITzLVzkSmp1XIBHoW", "created": 1234567890, "currency": "usd", "id": "re_1MlLi1JITzLVzkSmYjN8VXsL", "metadata": {}, "object": "refund", "payment_intent": null, "reason": null, "receipt_number": null, "source_transfer_reversal": null, "status": "succeeded", "transfer_reversal": null }, "reporting.report_run": { "created": 1234567890, "error": null, "id": "frr_1MlLiHJITzLVzkSm0Praf3Po", "livemode": true, "object": "reporting.report_run", "parameters": { "interval_end": 1525132800, "interval_start": 1522540800 }, "report_type": "balance.summary.1", "result": { "created": 1676675571, "expires_at": 1708211571, "filename": "file_1Mcd6lJITzLVzkSm58IV6lDd", "id": "file_1Mcd6lJITzLVzkSm58IV6lDd", "links": { "data": [], "has_more": false, "object": "list", "url": "/v1/file_links?file=file_1Mcd6lJITzLVzkSm58IV6lDd" }, "object": "file", "purpose": "finance_report_run", "size": 16890, "title": null, "type": "csv", "url": "https://rwashburne-upload-mydev.dev.stripe.me/v1/files/file_1Mcd6lJITzLVzkSm58IV6lDd/contents" }, "status": "succeeded", "succeeded_at": 1234567890 }, "reporting.report_type": { "data_available_end": 1234567890, "data_available_start": 1234567890, "default_columns": [ "category", "currency", "description", "net_amount" ], "id": "balance.summary.1", "livemode": true, "name": "Balance summary", "object": "reporting.report_type", "updated": 1234567890, "version": 1 }, "review": { "billing_zip": null, "charge": "ch_1Mcd6UJITzLVzkSmp1XIBHoW", "created": 1234567890, "id": "prv_1MlLiHJITzLVzkSmWOL5pISl", "ip_address": null, "ip_address_location": { "city": null, "country": null, "latitude": null, "longitude": null, "region": null }, "livemode": false, "object": "review", "open": true, "opened_reason": "rule", "session": { "browser": null, "device": null, "platform": null, "version": null }, "closed_reason": null, "reason": "reason" }, "scheduled_query_run": { "created": 1234567890, "data_load_time": 1234567890, "file": { "created": 1676675571, "expires_at": null, "filename": "path", "id": "file_1Mcd6lJITzLVzkSm8nY5Nuq6", "links": { "data": [], "has_more": false, "object": "list", "url": "/v1/file_links?file=file_1Mcd6lJITzLVzkSm8nY5Nuq6" }, "object": "file", "purpose": "sigma_scheduled_query", "size": 500, "title": null, "type": "csv", "url": "https://rwashburne-upload-mydev.dev.stripe.me/v1/files/file_1Mcd6lJITzLVzkSm8nY5Nuq6/contents" }, "id": "sqr_1MlLiHJITzLVzkSmVs2VPecm", "livemode": false, "object": "scheduled_query_run", "result_available_until": 1234567890, "sql": "SELECT count(*) from charges", "status": "completed", "title": "Count all charges" }, "setup_attempt": { "application": null, "created": 1234567890, "customer": null, "flow_directions": null, "id": "setatt_123456789012345678901234", "livemode": false, "object": "setup_attempt", "on_behalf_of": null, "payment_method": "card_1Mcd6SJITzLVzkSmqkE2eJHO", "payment_method_details": { "card": { "three_d_secure": { "authentication_flow": null, "electronic_commerce_indicator": null, "result": null, "result_reason": null, "transaction_id": null, "version": null }, "brand": null, "checks": { "address_line1_check": null, "address_postal_code_check": null, "cvc_check": null }, "country": null, "exp_month": null, "exp_year": null, "funding": null, "last4": null, "network": null, "wallet": { "type": "apple_pay" } }, "type": "card" }, "setup_error": { "type": "idempotency_error" }, "setup_intent": "seti_1Mcd6kJITzLVzkSmqX6ZT84q", "status": "succeeded", "usage": "off_session" }, "setup_intent": { "application": null, "cancellation_reason": null, "client_secret": "seti_1Mcd6kJITzLVzkSmqX6ZT84q_secret_NNNsR9WdNTeUghIWEQ17mHkxAFqeEke", "created": 1234567890, "customer": null, "description": null, "flow_directions": null, "id": "seti_1Mcd6kJITzLVzkSmqX6ZT84q", "last_setup_error": { "type": "idempotency_error" }, "latest_attempt": null, "livemode": false, "mandate": null, "metadata": {}, "next_action": { "type": "type" }, "object": "setup_intent", "on_behalf_of": null, "payment_method": null, "payment_method_options": {}, "payment_method_types": [ "card" ], "single_use_mandate": null, "status": "requires_payment_method", "usage": "off_session", "automatic_payment_methods": { "enabled": null }, "payment_method_configuration_details": { "id": "obj_123", "parent": null } }, "shipping_rate": { "active": true, "created": 1234567890, "delivery_estimate": { "maximum": { "unit": "month", "value": 111972721 }, "minimum": { "unit": "month", "value": 111972721 } }, "display_name": "Ground shipping", "fixed_amount": { "amount": 500, "currency": "usd" }, "id": "shr_1MlLiGJITzLVzkSmXX5RcAAI", "livemode": false, "metadata": {}, "object": "shipping_rate", "tax_behavior": "unspecified", "tax_code": null, "type": "fixed_amount" }, "source": { "ach_credit_transfer": { "account_number": "test_52796e3294dc", "bank_name": "TEST BANK", "fingerprint": "ecpwEzmBOSMOqQTL", "routing_number": "110000000", "swift_code": "TSTEZ122" }, "amount": null, "client_secret": "src_client_secret_wYQdFOogqwPJBBlUrHljPe8E", "created": 1234567890, "currency": "usd", "flow": "receiver", "id": "src_1MlLiAJITzLVzkSm3n0rctNQ", "livemode": false, "metadata": {}, "object": "source", "owner": { "address": { "city": null, "country": null, "line1": null, "line2": null, "postal_code": null, "state": null }, "email": "jenny.rosen@example.com", "name": null, "phone": null, "verified_address": { "city": null, "country": null, "line1": null, "line2": null, "postal_code": null, "state": null }, "verified_email": null, "verified_name": null, "verified_phone": null }, "receiver": { "address": "121042882-38381234567890123", "amount_charged": 0, "amount_received": 0, "amount_returned": 0, "refund_attributes_method": "email", "refund_attributes_status": "missing" }, "statement_descriptor": null, "status": "pending", "type": "ach_credit_transfer", "usage": "reusable", "allow_redisplay": null }, "source_mandate_notification": { "amount": 2000, "created": 1234567890, "id": "srcmn_1MlLiFJITzLVzkSmoH4V7ORh", "livemode": false, "object": "source_mandate_notification", "reason": "debit_initiated", "sepa_debit": { "creditor_identifier": "TEST42ZZZ0000424242", "last4": "3000", "mandate_reference": "FFU45BAKH9LWLMM0" }, "source": { "ach_credit_transfer": { "account_number": "test_52796e3294dc", "bank_name": "TEST BANK", "fingerprint": "ecpwEzmBOSMOqQTL", "routing_number": "110000000", "swift_code": "TSTEZ122" }, "amount": null, "client_secret": "src_client_secret_CZxrS1NoKHckpwNE0qeS5cNM", "created": 1678753655, "currency": "usd", "flow": "receiver", "id": "src_1MlLiFJITzLVzkSmKqKS5h82", "livemode": false, "metadata": {}, "object": "source", "owner": { "address": { "city": null, "country": null, "line1": null, "line2": null, "postal_code": null, "state": null }, "email": "jenny.rosen@example.com", "name": null, "phone": null, "verified_address": { "city": null, "country": null, "line1": null, "line2": null, "postal_code": null, "state": null }, "verified_email": null, "verified_name": null, "verified_phone": null }, "receiver": { "address": "121042882-38381234567890123", "amount_charged": 0, "amount_received": 0, "amount_returned": 0, "refund_attributes_method": "email", "refund_attributes_status": "missing" }, "statement_descriptor": null, "status": "pending", "type": "ach_credit_transfer", "usage": "reusable", "allow_redisplay": null }, "status": "submitted", "type": "sepa_debit" }, "source_transaction": { "ach_credit_transfer": {}, "amount": 500, "created": 1234567890, "currency": "usd", "id": "srctxn_1MlLiFJITzLVzkSm2a0LNUxZ", "livemode": false, "object": "source_transaction", "source": "src_1MlLiAJITzLVzkSm3n0rctNQ", "status": "succeeded", "type": "ach_credit_transfer" }, "subscription": { "application": null, "application_fee_percent": null, "automatic_tax": { "enabled": false, "disabled_reason": null, "liability": { "type": "account" } }, "billing_cycle_anchor": 1234567890, "billing_thresholds": { "amount_gte": null, "reset_billing_cycle_anchor": null }, "cancel_at": 1234567890, "cancel_at_period_end": false, "canceled_at": 1234567890, "cancellation_details": { "comment": null, "feedback": null, "reason": null }, "collection_method": "charge_automatically", "created": 1234567890, "currency": "usd", "customer": "cus_NNNslJKODLsLoG", "days_until_due": null, "default_payment_method": null, "default_source": null, "default_tax_rates": [], "description": null, "ended_at": 1234567890, "id": "sub_1MlLi1JITzLVzkSmbGPN6d9R", "items": { "data": [ { "billing_thresholds": { "usage_gte": null }, "created": 1678753641, "id": "si_NWOVO8ZMEsRVpj", "metadata": {}, "object": "subscription_item", "price": { "active": true, "billing_scheme": "per_unit", "created": 1676675559, "currency": "usd", "custom_unit_amount": { "maximum": null, "minimum": null, "preset": null }, "id": "price_1Mcd6ZJITzLVzkSmwd29pdd3", "livemode": false, "lookup_key": null, "metadata": {}, "nickname": null, "object": "price", "product": "prod_NNNsbcqAqCJrj2", "recurring": { "interval": "month", "interval_count": 1, "usage_type": "licensed", "meter": null, "trial_period_days": null }, "tax_behavior": "unspecified", "tiers_mode": null, "transform_quantity": { "divide_by": 1592560163, "round": "down" }, "type": "recurring", "unit_amount": 2000, "unit_amount_decimal": "2000" }, "quantity": 1, "subscription": "sub_1MlLi1JITzLVzkSmbGPN6d9R", "tax_rates": [], "current_period_end": 976287773, "current_period_start": 1896570518, "discounts": [ { "checkout_session": null, "coupon": { "amount_off": null, "created": 1028554472, "currency": null, "duration": "forever", "duration_in_months": null, "id": "obj_123", "livemode": true, "max_redemptions": null, "metadata": null, "name": null, "object": "coupon", "percent_off": null, "redeem_by": null, "times_redeemed": 990066668, "valid": true }, "customer": null, "end": null, "id": "obj_123", "invoice": null, "invoice_item": null, "object": "discount", "promotion_code": null, "start": 109757538, "subscription": null, "subscription_item": null } ], "plan": { "active": true, "amount": null, "amount_decimal": null, "billing_scheme": "tiered", "created": 1028554472, "currency": "currency", "id": "obj_123", "interval": "month", "interval_count": 797691627, "livemode": true, "metadata": null, "meter": null, "nickname": null, "object": "plan", "product": null, "tiers_mode": null, "transform_usage": { "divide_by": 1592560163, "round": "down" }, "trial_period_days": null, "usage_type": "licensed" } } ], "has_more": false, "object": "list", "url": "/v1/subscription_items?subscription=sub_1MlLi1JITzLVzkSmbGPN6d9R" }, "latest_invoice": null, "livemode": false, "metadata": {}, "next_pending_invoice_item_invoice": 1234567890, "object": "subscription", "on_behalf_of": null, "pause_collection": { "behavior": "mark_uncollectible", "resumes_at": null }, "payment_settings": { "payment_method_options": { "acss_debit": {}, "bancontact": { "preferred_language": "fr" }, "card": { "network": null, "request_three_d_secure": null }, "customer_balance": { "funding_type": null }, "konbini": {}, "sepa_debit": {}, "us_bank_account": {} }, "payment_method_types": null, "save_default_payment_method": null }, "pending_invoice_item_interval": { "interval": "month", "interval_count": 797691627 }, "pending_setup_intent": null, "pending_update": { "billing_cycle_anchor": null, "expires_at": 833811170, "subscription_items": null, "trial_end": null, "trial_from_plan": null }, "schedule": null, "start_date": 1234567890, "status": "active", "test_clock": null, "transfer_data": { "amount_percent": null, "destination": { "id": "obj_123", "object": "account" } }, "trial_end": 1234567890, "trial_settings": { "end_behavior": { "missing_payment_method": "create_invoice" } }, "trial_start": 1234567890, "billing_cycle_anchor_config": { "day_of_month": 1361669285, "hour": null, "minute": null, "month": null, "second": null }, "discounts": [ { "checkout_session": null, "coupon": { "amount_off": null, "created": 1028554472, "currency": null, "duration": "forever", "duration_in_months": null, "id": "obj_123", "livemode": true, "max_redemptions": null, "metadata": null, "name": null, "object": "coupon", "percent_off": null, "redeem_by": null, "times_redeemed": 990066668, "valid": true }, "customer": null, "end": null, "id": "obj_123", "invoice": null, "invoice_item": null, "object": "discount", "promotion_code": null, "start": 109757538, "subscription": null, "subscription_item": null } ], "invoice_settings": { "account_tax_ids": null, "issuer": { "type": "account" } }, "billing_mode": { "type": "classic" } }, "subscription_item": { "billing_thresholds": { "usage_gte": null }, "created": 1678753647, "id": "si_NWOVMvXVc2SbwK", "metadata": {}, "object": "subscription_item", "price": { "active": true, "billing_scheme": "per_unit", "created": 1676675559, "currency": "usd", "custom_unit_amount": { "maximum": null, "minimum": null, "preset": null }, "id": "price_1Mcd6ZJITzLVzkSmwd29pdd3", "livemode": false, "lookup_key": null, "metadata": {}, "nickname": null, "object": "price", "product": "prod_NNNsbcqAqCJrj2", "recurring": { "interval": "month", "interval_count": 1, "usage_type": "licensed", "meter": null, "trial_period_days": null }, "tax_behavior": "unspecified", "tiers_mode": null, "transform_quantity": { "divide_by": 1592560163, "round": "down" }, "type": "recurring", "unit_amount": 2000, "unit_amount_decimal": "2000" }, "quantity": 1, "subscription": "sub_1MlLi6JITzLVzkSmHTXG5qr4", "tax_rates": [], "current_period_end": 976287773, "current_period_start": 1896570518, "discounts": [ { "checkout_session": null, "coupon": { "amount_off": null, "created": 1028554472, "currency": null, "duration": "forever", "duration_in_months": null, "id": "obj_123", "livemode": true, "max_redemptions": null, "metadata": null, "name": null, "object": "coupon", "percent_off": null, "redeem_by": null, "times_redeemed": 990066668, "valid": true }, "customer": null, "end": null, "id": "obj_123", "invoice": null, "invoice_item": null, "object": "discount", "promotion_code": null, "start": 109757538, "subscription": null, "subscription_item": null } ], "plan": { "active": true, "amount": null, "amount_decimal": null, "billing_scheme": "tiered", "created": 1028554472, "currency": "currency", "id": "obj_123", "interval": "month", "interval_count": 797691627, "livemode": true, "metadata": null, "meter": null, "nickname": null, "object": "plan", "product": null, "tiers_mode": null, "transform_usage": { "divide_by": 1592560163, "round": "down" }, "trial_period_days": null, "usage_type": "licensed" } }, "subscription_schedule": { "application": null, "canceled_at": 1234567890, "completed_at": 1234567890, "created": 1234567890, "current_phase": { "end_date": 1725067410, "start_date": 1573629589 }, "customer": "cus_NNNslJKODLsLoG", "default_settings": { "application_fee_percent": null, "automatic_tax": { "enabled": false, "disabled_reason": null, "liability": { "type": "account" } }, "billing_cycle_anchor": "automatic", "billing_thresholds": { "amount_gte": null, "reset_billing_cycle_anchor": null }, "collection_method": "charge_automatically", "default_payment_method": null, "description": null, "invoice_settings": { "account_tax_ids": null, "days_until_due": null, "issuer": { "type": "account" } }, "on_behalf_of": null, "transfer_data": { "amount_percent": null, "destination": { "id": "obj_123", "object": "account" } } }, "end_behavior": "release", "id": "sub_sched_1MlLi6JITzLVzkSmq8cd43lM", "livemode": false, "metadata": {}, "object": "subscription_schedule", "phases": [ { "add_invoice_items": [], "application_fee_percent": null, "billing_cycle_anchor": null, "billing_thresholds": { "amount_gte": null, "reset_billing_cycle_anchor": null }, "collection_method": null, "currency": "usd", "default_payment_method": null, "default_tax_rates": [], "description": null, "end_date": 1710808046, "invoice_settings": { "account_tax_ids": null, "days_until_due": null, "issuer": { "type": "account" } }, "items": [ { "billing_thresholds": { "usage_gte": null }, "metadata": {}, "price": "price_1Mcd6ZJITzLVzkSmwd29pdd3", "quantity": 1, "tax_rates": [], "discounts": [ { "coupon": null, "discount": null, "promotion_code": null } ], "plan": { "active": true, "amount": null, "amount_decimal": null, "billing_scheme": "tiered", "created": 1028554472, "currency": "currency", "id": "obj_123", "interval": "month", "interval_count": 797691627, "livemode": true, "metadata": null, "meter": null, "nickname": null, "object": "plan", "product": null, "tiers_mode": null, "transform_usage": { "divide_by": 1592560163, "round": "down" }, "trial_period_days": null, "usage_type": "licensed" } } ], "metadata": {}, "on_behalf_of": null, "proration_behavior": "create_prorations", "start_date": 1679358446, "transfer_data": { "amount_percent": null, "destination": { "id": "obj_123", "object": "account" } }, "trial_end": null, "discounts": [ { "coupon": null, "discount": null, "promotion_code": null } ] } ], "released_at": 1234567890, "released_subscription": null, "status": "not_started", "subscription": null, "test_clock": null, "billing_mode": { "type": "classic" } }, "tax_code": { "description": "Any tangible or physical good. For jurisdictions that impose a tax, the standard rate is applied.", "id": "txcd_99999999", "name": "General - Tangible Goods", "object": "tax_code" }, "tax_id": { "country": "DE", "created": 1234567890, "customer": "cus_NNNslJKODLsLoG", "id": "txi_1MlLiHJITzLVzkSmi1opmyET", "livemode": false, "object": "tax_id", "type": "eu_vat", "value": "DE123456789", "verification": { "status": "pending", "verified_address": null, "verified_name": null }, "owner": { "type": "customer" } }, "tax_rate": { "active": true, "country": "DE", "created": 1234567890, "description": "VAT Germany", "display_name": "VAT", "id": "txr_1MlLi6JITzLVzkSm1zvAk9SI", "inclusive": false, "jurisdiction": "DE", "livemode": false, "metadata": {}, "object": "tax_rate", "percentage": 19, "state": null, "tax_type": "vat", "effective_percentage": null, "flat_amount": { "amount": 1413853096, "currency": "currency" }, "jurisdiction_level": null, "rate_type": null }, "terminal.configuration": { "bbpos_wisepos_e": { "splashscreen": "file_1MlLiGJITzLVzkSmR2KjdTh9" }, "id": "tmc_ElVUAjF8xXG3hj", "is_account_default": false, "livemode": false, "object": "terminal.configuration", "name": null }, "terminal.connection_token": { "object": "terminal.connection_token", "secret": "pst_test_wfryJuBmDGBbWWHmwF3Btov" }, "terminal.location": { "address": { "city": "San Francisco", "country": "US", "line1": "1234 Fake Street", "line2": null, "postal_code": "94102", "state": "CA" }, "display_name": "My First Store", "id": "tml_cKQQfm6UGarpNRJRxXpzca4i", "livemode": false, "metadata": {}, "object": "terminal.location" }, "terminal.reader": { "action": { "failure_code": null, "failure_message": null, "status": "failed", "type": "process_payment_intent" }, "device_sw_version": null, "device_type": "bbpos_wisepos_e", "id": "tmr_cKxInTQKOxDTvasletECzYvQ", "ip_address": "192.168.2.2", "label": "Blue Rabbit", "livemode": false, "location": null, "metadata": {}, "object": "terminal.reader", "serial_number": "123-456-789", "status": "online" }, "test_helpers.test_clock": { "created": 1234567890, "deletes_after": 1234567890, "frozen_time": 1234567890, "id": "clock_1MlLiAJITzLVzkSmVBT841xQ", "livemode": false, "name": null, "object": "test_helpers.test_clock", "status": "ready", "status_details": {} }, "token": { "card": { "address_city": null, "address_country": null, "address_line1": null, "address_line1_check": null, "address_line2": null, "address_state": null, "address_zip": null, "address_zip_check": null, "brand": "Visa", "country": "US", "cvc_check": "pass", "dynamic_last4": null, "exp_month": 8, "exp_year": 2030, "fingerprint": "XFO13q66ulrWf0ou", "funding": "credit", "id": "card_1MlLi6JITzLVzkSmKK0xVnJV", "last4": "4242", "metadata": {}, "name": null, "object": "card", "tokenization_method": null, "regulated_status": null }, "client_ip": null, "created": 1234567890, "id": "tok_1MlLi6JITzLVzkSmkWbVmpka", "livemode": false, "object": "token", "type": "card", "used": false }, "topup": { "amount": 1000, "balance_transaction": null, "created": 1234567890, "currency": "usd", "description": "Top-up description", "expected_availability_date": 123456789, "failure_code": null, "failure_message": null, "id": "tu_1MlLiCJITzLVzkSm27UsrBQR", "livemode": false, "metadata": { "order_id": "12345678" }, "object": "topup", "source": { "ach_debit": { "bank_name": "STRIPE TEST BANK", "country": "US", "fingerprint": "5Wh4KBcfDrz5IOnx", "last4": "6789", "routing_number": "110000000", "type": "individual" }, "amount": null, "client_secret": "src_client_secret_c49ljuKNc9fQLJauoN4Tx4nv", "created": 1678753652, "currency": "usd", "flow": "code_verification", "id": "src_1MlLiCJITzLVzkSmr35MnAkA", "livemode": false, "metadata": {}, "object": "source", "owner": { "address": { "city": null, "country": null, "line1": null, "line2": null, "postal_code": null, "state": null }, "email": "jenny.rosen@example.com", "name": "Jenny Rosen", "phone": null, "verified_address": { "city": null, "country": null, "line1": null, "line2": null, "postal_code": null, "state": null }, "verified_email": null, "verified_name": null, "verified_phone": null }, "statement_descriptor": null, "status": "pending", "type": "ach_debit", "usage": "reusable", "allow_redisplay": null }, "statement_descriptor": null, "status": "pending", "transfer_group": null }, "transfer": { "amount": 1100, "amount_reversed": 0, "balance_transaction": "txn_1MlLhiJITzLVzkSm0tDIM70A", "created": 1234567890, "currency": "usd", "description": null, "destination": "acct_1MWlHDJITzLVzkSm", "destination_payment": "py_NWOVg9IZfr7zTN", "id": "tr_1MlLiCJITzLVzkSmn2LkBD3D", "livemode": false, "metadata": {}, "object": "transfer", "reversals": { "data": [], "has_more": false, "object": "list", "url": "/v1/transfers/tr_1MlLiCJITzLVzkSmn2LkBD3D/reversals" }, "reversed": false, "source_transaction": null, "source_type": "card", "transfer_group": null }, "transfer_reversal": { "amount": 1100, "balance_transaction": null, "created": 1234567890, "currency": "usd", "destination_payment_refund": null, "id": "trr_1MlLiCJITzLVzkSmHjIWDgJC", "metadata": {}, "object": "transfer_reversal", "source_refund": null, "transfer": "tr_1MlLiCJITzLVzkSmn2LkBD3D" }, "treasury.credit_reversal": { "amount": 1000, "created": 1234567890, "currency": "usd", "financial_account": "fa_1MlLiEJITzLVzkSmGTgLnr26", "hosted_regulatory_receipt_url": "https://rwashburne-agrippa-mydev.dev.stripe.me/regulatory-receipt/CBQaFwoVYWNjdF8xTVdsSERKSVR6TFZ6a1NtKPz-vqAGMgbmx6_xLNs6Nv21sYMAkhwf9fKBf4dwaXtcyYHI6RJvoy5ooR4wUlS6ng7vY3RPw4YARBwUrYqvSjsk5dtNmg", "id": "credrev_1MlLiKJITzLVzkSmvK3f86lv", "livemode": false, "metadata": {}, "network": "ach", "object": "treasury.credit_reversal", "received_credit": "rc_1MlLiKJITzLVzkSmZ2SULswc", "status": "processing", "status_transitions": { "posted_at": null }, "transaction": "trxn_1MlLiEJITzLVzkSmdtaIuDk3" }, "treasury.debit_reversal": { "amount": 1000, "created": 1234567890, "currency": "usd", "financial_account": "fa_1MlLiEJITzLVzkSmGTgLnr26", "hosted_regulatory_receipt_url": "https://rwashburne-agrippa-mydev.dev.stripe.me/regulatory-receipt/CBQaFwoVYWNjdF8xTVdsSERKSVR6TFZ6a1NtKPz-vqAGMgZDZ51a_hY6Nv3t9ulTyAOqM3QNvHoYNHX5LLObIyp4NkNyWufKUHd81tN6525dWjN13_QXOzOpG5dt_Zmp0w", "id": "debrev_1MlLiKJITzLVzkSm1lT04zxj", "linked_flows": { "issuing_dispute": null }, "livemode": false, "metadata": {}, "network": "ach", "object": "treasury.debit_reversal", "received_debit": "rd_1MlLiKJITzLVzkSmFInrmpBp", "status": "processing", "status_transitions": { "completed_at": null }, "transaction": "trxn_1MlLiEJITzLVzkSmdtaIuDk3" }, "treasury.financial_account": { "active_features": [ "financial_addresses.aba", "outbound_payments.ach", "outbound_payments.us_domestic_wire" ], "balance": { "cash": { "usd": 0 }, "inbound_pending": { "usd": 0 }, "outbound_pending": { "usd": 0 } }, "country": "US", "created": 1234567890, "financial_addresses": [ { "aba": { "account_holder_name": "Jenny Rosen", "account_number_last4": "7890", "bank_name": "STRIPE TEST BANK", "routing_number": "0000000001" }, "supported_networks": [ "ach", "us_domestic_wire" ], "type": "aba" } ], "id": "fa_1MlLiEJITzLVzkSmGTgLnr26", "livemode": true, "metadata": null, "object": "treasury.financial_account", "pending_features": [], "restricted_features": [], "status": "open", "status_details": { "closed": { "reasons": [ "closed_by_platform" ] } }, "supported_currencies": [ "usd" ] }, "treasury.financial_account_features": { "card_issuing": { "requested": true, "status": "active", "status_details": [] }, "deposit_insurance": { "requested": true, "status": "active", "status_details": [] }, "financial_addresses": { "aba": { "requested": true, "status": "active", "status_details": [] } }, "inbound_transfers": { "ach": { "requested": true, "status": "active", "status_details": [] } }, "intra_stripe_flows": { "requested": true, "status": "active", "status_details": [] }, "object": "treasury.financial_account_features", "outbound_payments": { "ach": { "requested": true, "status": "active", "status_details": [] }, "us_domestic_wire": { "requested": true, "status": "active", "status_details": [] } }, "outbound_transfers": { "ach": { "requested": true, "status": "active", "status_details": [] }, "us_domestic_wire": { "requested": true, "status": "active", "status_details": [] } } }, "treasury.inbound_transfer": { "amount": 10000, "cancelable": true, "created": 1234567890, "currency": "usd", "description": "InboundTransfer from my external bank account", "failure_details": { "code": "insufficient_funds" }, "financial_account": "fa_1MlLiEJITzLVzkSmGTgLnr26", "hosted_regulatory_receipt_url": "https://rwashburne-agrippa-mydev.dev.stripe.me/regulatory-receipt/CBQaFwoVYWNjdF8xTVdsSERKSVR6TFZ6a1NtKPz-vqAGMgbIrT0ncs86Nv1b7-dmn-4hJEGVoI-smtUdPWVGW3Wbb1nBwqZgkSqLMc-elq0lxXdm9u22M9atQXMAkvtiZg", "id": "ibt_1MlLiKJITzLVzkSmgCsDC5fT", "linked_flows": { "received_debit": null }, "livemode": false, "metadata": {}, "object": "treasury.inbound_transfer", "origin_payment_method": "pm_1MlLiIJITzLVzkSmLsWswemN", "origin_payment_method_details": { "billing_details": { "address": { "city": "San Francisco", "country": "US", "line1": "1234 Fake Street", "line2": null, "postal_code": "94102", "state": "CA" }, "email": null, "name": "Jane Austen" }, "type": "us_bank_account", "us_bank_account": { "account_holder_type": "company", "account_type": "checking", "bank_name": "STRIPE TEST BANK", "fingerprint": "I1e2zttmxgyFZKaM", "last4": "6789", "network": "ach", "routing_number": "110000000" } }, "returned": false, "statement_descriptor": "transfer", "status": "processing", "status_transitions": { "failed_at": null, "succeeded_at": null }, "transaction": "trxn_1MlLiEJITzLVzkSmdtaIuDk3" }, "treasury.outbound_payment": { "amount": 10000, "cancelable": false, "created": 1234567890, "currency": "usd", "customer": null, "description": "OutboundPayment to a 3rd party", "destination_payment_method": null, "destination_payment_method_details": { "type": "us_bank_account", "billing_details": { "address": { "city": null, "country": null, "line1": null, "line2": null, "postal_code": null, "state": null }, "email": null, "name": null } }, "end_user_details": { "ip_address": null, "present": false }, "expected_arrival_date": 1234567890, "financial_account": "fa_1MlLiEJITzLVzkSmGTgLnr26", "hosted_regulatory_receipt_url": "https://rwashburne-agrippa-mydev.dev.stripe.me/regulatory-receipt/CBQaFwoVYWNjdF8xTVdsSERKSVR6TFZ6a1NtKPv-vqAGMgYUJeztnyc6Nf30Bpr3LQPgh7WU2-eGiAEd9CYMPSVvIOsNUzlditRHhezcfqb2fdnmrvCWfLirtbhpDrKK", "id": "obp_1MlLiJJITzLVzkSmZhwYuWfP", "livemode": false, "metadata": {}, "object": "treasury.outbound_payment", "returned_details": { "code": "account_frozen", "transaction": { "amount": 1413853096, "balance_impact": { "cash": 3046195, "inbound_pending": 550878511, "outbound_pending": 786770760 }, "created": 1028554472, "currency": "currency", "description": "description", "financial_account": "financial_account", "flow": null, "flow_type": "credit_reversal", "id": "obj_123", "livemode": true, "object": "treasury.transaction", "status": "open", "status_transitions": { "posted_at": null, "void_at": null } } }, "statement_descriptor": "payment", "status": "processing", "status_transitions": { "canceled_at": null, "failed_at": null, "posted_at": null, "returned_at": null }, "transaction": "trxn_1MlLiEJITzLVzkSmdtaIuDk3", "tracking_details": { "type": "ach" } }, "treasury.outbound_transfer": { "amount": 10000, "cancelable": true, "created": 1234567890, "currency": "usd", "description": "OutboundTransfer to my external bank account", "destination_payment_method": "pm_1MlLiIJITzLVzkSmLsWswemN", "destination_payment_method_details": { "billing_details": { "address": { "city": "San Francisco", "country": "US", "line1": "1234 Fake Street", "line2": null, "postal_code": "94102", "state": "CA" }, "email": null, "name": "Jane Austen" }, "type": "us_bank_account", "us_bank_account": { "account_holder_type": "company", "account_type": "checking", "bank_name": "STRIPE TEST BANK", "fingerprint": "I1e2zttmxgyFZKaM", "last4": "6789", "network": "ach", "routing_number": "110000000" } }, "expected_arrival_date": 1234567890, "financial_account": "fa_1MlLiEJITzLVzkSmGTgLnr26", "hosted_regulatory_receipt_url": "https://rwashburne-agrippa-mydev.dev.stripe.me/regulatory-receipt/CBQaFwoVYWNjdF8xTVdsSERKSVR6TFZ6a1NtKPv-vqAGMgYDmHJoSRs6Nv2uwQRyji7_9RKpVOoWCULfLuUoR4z8xL9E2-Z6tDjt9Uw12lKiuUbWHM3_yHibMxcapsz3Mg", "id": "obt_1MlLiJJITzLVzkSmg0YIZnCT", "livemode": false, "metadata": {}, "object": "treasury.outbound_transfer", "returned_details": { "code": "account_frozen", "transaction": { "amount": 1413853096, "balance_impact": { "cash": 3046195, "inbound_pending": 550878511, "outbound_pending": 786770760 }, "created": 1028554472, "currency": "currency", "description": "description", "financial_account": "financial_account", "flow": null, "flow_type": "credit_reversal", "id": "obj_123", "livemode": true, "object": "treasury.transaction", "status": "open", "status_transitions": { "posted_at": null, "void_at": null } } }, "statement_descriptor": "transfer", "status": "processing", "status_transitions": { "canceled_at": null, "failed_at": null, "posted_at": null, "returned_at": null }, "transaction": "trxn_1MlLiEJITzLVzkSmdtaIuDk3", "tracking_details": { "type": "ach" } }, "treasury.received_credit": { "amount": 1234, "created": 1234567890, "currency": "usd", "description": "Stripe Test", "failure_code": null, "financial_account": "fa_1MlLiEJITzLVzkSmGTgLnr26", "hosted_regulatory_receipt_url": "https://rwashburne-agrippa-mydev.dev.stripe.me/regulatory-receipt/CBQaFwoVYWNjdF8xTVdsSERKSVR6TFZ6a1NtKPz-vqAGMgZSNzJixFM6Nv0VWV7T_8jVIE_W8EW1gG-kYdu-UFUHBy2LI3OWjO3q1yADNGGAkOiD4NFfT7SLUdflrTKryQ", "id": "rc_1MlLiKJITzLVzkSmZ2SULswc", "initiating_payment_method_details": { "billing_details": { "address": { "city": null, "country": null, "line1": null, "line2": null, "postal_code": null, "state": null }, "email": null, "name": "Jane Austen" }, "type": "us_bank_account", "us_bank_account": { "bank_name": "STRIPE TEST BANK", "last4": "6789", "routing_number": "110000000" } }, "linked_flows": { "credit_reversal": null, "issuing_authorization": null, "issuing_transaction": null, "source_flow": null, "source_flow_type": null }, "livemode": false, "network": "ach", "object": "treasury.received_credit", "reversal_details": { "deadline": 1678924800, "restricted_reason": null }, "status": "succeeded", "transaction": "trxn_1MlLiEJITzLVzkSmdtaIuDk3" }, "treasury.received_debit": { "amount": 54321, "created": 1234567890, "currency": "usd", "description": "Stripe Test", "failure_code": null, "financial_account": "fa_1MlLiEJITzLVzkSmGTgLnr26", "hosted_regulatory_receipt_url": "https://rwashburne-agrippa-mydev.dev.stripe.me/regulatory-receipt/CBQaFwoVYWNjdF8xTVdsSERKSVR6TFZ6a1NtKPz-vqAGMgazSl8IJE46Nv1__KcJIlLl4WQgGil-YjxJglsJH_clFXE6AB7pu_yOKPAulPlxP5DTAFscALMtldl5CrYmUA", "id": "rd_1MlLiKJITzLVzkSmjqj1yjA2", "initiating_payment_method_details": { "billing_details": { "address": { "city": null, "country": null, "line1": null, "line2": null, "postal_code": null, "state": null }, "email": null, "name": "Jane Austen" }, "type": "us_bank_account", "us_bank_account": { "bank_name": "STRIPE TEST BANK", "last4": "6789", "routing_number": "110000000" } }, "linked_flows": { "debit_reversal": null, "inbound_transfer": null, "issuing_authorization": null, "issuing_transaction": null, "payout": null }, "livemode": false, "network": "ach", "object": "treasury.received_debit", "reversal_details": { "deadline": 1678924800, "restricted_reason": null }, "status": "succeeded", "transaction": "trxn_1MlLiEJITzLVzkSmdtaIuDk3" }, "treasury.transaction": { "amount": -100, "balance_impact": { "cash": -100, "inbound_pending": 0, "outbound_pending": 100 }, "created": 1234567890, "currency": "usd", "description": "Jane Austen (6789) | Outbound transfer | transfer", "financial_account": "fa_1MlLiEJITzLVzkSmGTgLnr26", "flow": "obt_1MlLiJJITzLVzkSmg0YIZnCT", "flow_type": "outbound_transfer", "id": "trxn_1MlLiEJITzLVzkSmdtaIuDk3", "livemode": false, "object": "treasury.transaction", "status": "open", "status_transitions": { "posted_at": null, "void_at": null } }, "treasury.transaction_entry": { "balance_impact": { "cash": 0, "inbound_pending": 0, "outbound_pending": -1000 }, "created": 1234567890, "currency": "usd", "effective_at": 1234567890, "financial_account": "fa_1MlLiEJITzLVzkSmGTgLnr26", "flow": "obt_1MlLiJJITzLVzkSmg0YIZnCT", "flow_type": "outbound_transfer", "id": "trxne_1MlLiJJITzLVzkSm0HzmPEzZ", "livemode": false, "object": "treasury.transaction_entry", "transaction": "trxn_1MlLiEJITzLVzkSmdtaIuDk3", "type": "outbound_transfer" }, "webhook_endpoint": { "api_version": null, "application": null, "created": 1234567890, "description": "This is my webhook, I like it a lot", "enabled_events": [ "charge.failed", "charge.succeeded" ], "id": "we_1MlLiDJITzLVzkSm0QU7AnxQ", "livemode": false, "metadata": {}, "object": "webhook_endpoint", "status": "enabled", "url": "https://example.com/my/webhook/endpoint" }, "account_notice": { "created": 1028554472, "deadline": null, "email": { "plain_text": "plain_text", "recipient": "recipient", "subject": "subject" }, "id": "obj_123", "linked_objects": { "capability": null, "issuing_dispute": null }, "livemode": true, "metadata": null, "object": "account_notice", "reason": "issuing.account_closed_for_not_providing_business_model_clarification", "sent_at": null }, "account_session": { "account": "account", "client_secret": "client_secret", "components": { "account_management": { "enabled": true, "features": { "disable_stripe_user_authentication": true, "external_account_collection": true } }, "account_onboarding": { "enabled": true, "features": { "disable_stripe_user_authentication": true, "external_account_collection": true } }, "balances": { "enabled": true, "features": { "disable_stripe_user_authentication": true, "edit_payout_schedule": true, "external_account_collection": true, "instant_payouts": true, "standard_payouts": true } }, "disputes_list": { "enabled": true, "features": { "capture_payments": true, "destination_on_behalf_of_charge_management": true, "dispute_management": true, "refund_management": true } }, "documents": { "enabled": true, "features": {} }, "financial_account": { "enabled": true, "features": { "disable_stripe_user_authentication": true, "external_account_collection": true, "send_money": true, "transfer_balance": true } }, "financial_account_transactions": { "enabled": true, "features": { "card_spend_dispute_management": true } }, "issuing_card": { "enabled": true, "features": { "card_management": true, "card_spend_dispute_management": true, "cardholder_management": true, "spend_control_management": true } }, "issuing_cards_list": { "enabled": true, "features": { "card_management": true, "card_spend_dispute_management": true, "cardholder_management": true, "disable_stripe_user_authentication": true, "spend_control_management": true } }, "notification_banner": { "enabled": true, "features": { "disable_stripe_user_authentication": true, "external_account_collection": true } }, "payment_details": { "enabled": true, "features": { "capture_payments": true, "destination_on_behalf_of_charge_management": true, "dispute_management": true, "refund_management": true } }, "payment_disputes": { "enabled": true, "features": { "destination_on_behalf_of_charge_management": true, "dispute_management": true, "refund_management": true } }, "payments": { "enabled": true, "features": { "capture_payments": true, "destination_on_behalf_of_charge_management": true, "dispute_management": true, "refund_management": true } }, "payouts": { "enabled": true, "features": { "disable_stripe_user_authentication": true, "edit_payout_schedule": true, "external_account_collection": true, "instant_payouts": true, "standard_payouts": true } }, "payouts_list": { "enabled": true, "features": {} }, "tax_registrations": { "enabled": true, "features": {} }, "tax_settings": { "enabled": true, "features": {} }, "instant_payouts_promotion": { "enabled": true, "features": { "disable_stripe_user_authentication": true, "external_account_collection": true, "instant_payouts": true } }, "payout_details": { "enabled": true, "features": {} }, "balance_report": { "enabled": true, "features": {} }, "payout_reconciliation_report": { "enabled": true, "features": {} } }, "expires_at": 833811170, "livemode": true, "object": "account_session" }, "application": { "id": "obj_123", "name": null, "object": "application" }, "balance_settings": { "object": "balance_settings", "payments": { "debit_negative_balances": null, "payouts": { "schedule": { "interval": null }, "statement_descriptor": null, "status": "disabled", "minimum_balance_by_currency": null }, "settlement_timing": { "delay_days": 1647351405 } } }, "billing.alert": { "alert_type": "usage_threshold", "id": "obj_123", "livemode": true, "object": "billing.alert", "status": null, "title": "title", "usage_threshold": { "filters": null, "gte": 102680, "meter": { "created": 1028554472, "customer_mapping": { "event_payload_key": "event_payload_key", "type": "by_id" }, "default_aggregation": { "formula": "sum" }, "display_name": "display_name", "event_name": "event_name", "event_time_window": null, "id": "obj_123", "livemode": true, "object": "billing.meter", "status": "active", "status_transitions": { "deactivated_at": null }, "updated": 234430277, "value_settings": { "event_payload_key": "event_payload_key" } }, "recurrence": "one_time" } }, "billing.alert_triggered": { "alert": { "alert_type": "usage_threshold", "id": "obj_123", "livemode": true, "object": "billing.alert", "status": null, "title": "title", "usage_threshold": { "filters": null, "gte": 102680, "meter": { "created": 1028554472, "customer_mapping": { "event_payload_key": "event_payload_key", "type": "by_id" }, "default_aggregation": { "formula": "sum" }, "display_name": "display_name", "event_name": "event_name", "event_time_window": null, "id": "obj_123", "livemode": true, "object": "billing.meter", "status": "active", "status_transitions": { "deactivated_at": null }, "updated": 234430277, "value_settings": { "event_payload_key": "event_payload_key" } }, "recurrence": "one_time" } }, "created": 1028554472, "customer": "customer", "livemode": true, "object": "billing.alert_triggered", "value": "74648480.66666667" }, "billing.credit_balance_summary": { "balances": [ { "available_balance": { "monetary": { "currency": "currency", "value": 111972721 }, "type": "monetary" }, "ledger_balance": { "monetary": { "currency": "currency", "value": 111972721 }, "type": "monetary" } } ], "customer": { "created": 1028554472, "default_source": null, "description": null, "email": null, "id": "obj_123", "livemode": true, "object": "customer", "shipping": {} }, "livemode": true, "object": "billing.credit_balance_summary" }, "billing.credit_balance_transaction": { "created": 1028554472, "credit": { "amount": { "monetary": { "currency": "currency", "value": 111972721 }, "type": "monetary" }, "credits_application_invoice_voided": { "invoice": "invoice", "invoice_line_item": "invoice_line_item" }, "type": "credits_application_invoice_voided" }, "credit_grant": "credit_grant", "debit": { "amount": { "monetary": { "currency": "currency", "value": 111972721 }, "type": "monetary" }, "credits_applied": { "invoice": "invoice", "invoice_line_item": "invoice_line_item" }, "type": "credits_applied" }, "effective_at": 247108043, "id": "obj_123", "livemode": true, "object": "billing.credit_balance_transaction", "test_clock": null, "type": null }, "billing.credit_grant": { "amount": { "monetary": { "currency": "currency", "value": 111972721 }, "type": "monetary" }, "applicability_config": { "scope": {} }, "category": "paid", "created": 1028554472, "customer": { "created": 1028554472, "default_source": null, "description": null, "email": null, "id": "obj_123", "livemode": true, "object": "customer", "shipping": {} }, "effective_at": null, "expires_at": null, "id": "obj_123", "livemode": true, "metadata": { "undefined": "metadata" }, "name": null, "object": "billing.credit_grant", "test_clock": null, "updated": 234430277, "voided_at": null }, "billing.meter": { "created": 1028554472, "customer_mapping": { "event_payload_key": "event_payload_key", "type": "by_id" }, "default_aggregation": { "formula": "sum" }, "display_name": "display_name", "event_name": "event_name", "event_time_window": null, "id": "obj_123", "livemode": true, "object": "billing.meter", "status": "active", "status_transitions": { "deactivated_at": null }, "updated": 234430277, "value_settings": { "event_payload_key": "event_payload_key" } }, "billing.meter_event": { "created": 1028554472, "event_name": "event_name", "identifier": "identifier", "livemode": true, "object": "billing.meter_event", "payload": { "undefined": "payload" }, "timestamp": 55126294 }, "billing.meter_event_adjustment": { "cancel": { "identifier": null }, "event_name": "event_name", "livemode": true, "object": "billing.meter_event_adjustment", "status": "complete", "type": "cancel" }, "billing.meter_event_summary": { "aggregated_value": 1264519369, "end_time": 1725551537, "id": "obj_123", "livemode": true, "meter": "meter", "object": "billing.meter_event_summary", "start_time": 1573145462 }, "capital.financing_offer": { "account": "account", "created": 1028554472, "expires_after": 2021972241, "id": "obj_123", "livemode": true, "object": "capital.financing_offer", "status": "accepted" }, "capital.financing_summary": { "details": { "advance_amount": 1304981173, "advance_paid_out_at": null, "currency": "currency", "current_repayment_interval": { "due_at": 1320896930, "paid_amount": null, "remaining_amount": 1811538239 }, "fee_amount": 490987313, "paid_amount": 1695771947, "remaining_amount": 1811538239, "repayments_begin_at": null, "withhold_rate": 65076826 }, "financing_offer": null, "object": "capital.financing_summary", "status": null }, "capital.financing_transaction": { "account": "account", "created_at": 1369680106, "details": { "advance_amount": 1304981173, "currency": "currency", "fee_amount": 490987313, "total_amount": 185007539 }, "financing_offer": null, "id": "obj_123", "livemode": true, "object": "capital.financing_transaction", "type": "payment", "user_facing_description": null }, "climate.order": { "amount_fees": 1211316940, "amount_subtotal": 1555417355, "amount_total": 1117121693, "canceled_at": null, "cancellation_reason": null, "certificate": null, "confirmed_at": null, "created": 1028554472, "currency": "currency", "delayed_at": null, "delivered_at": null, "delivery_details": [ { "delivered_at": 663949774, "location": { "city": null, "country": "country", "latitude": null, "longitude": null, "region": null }, "metric_tons": "metric_tons", "registry_url": null, "supplier": { "id": "obj_123", "info_url": "info_url", "livemode": true, "locations": [ { "city": null, "country": "country", "latitude": null, "longitude": null, "region": null } ], "name": "name", "object": "climate.supplier", "removal_pathway": "enhanced_weathering" } } ], "expected_delivery_year": 584813471, "id": "obj_123", "livemode": true, "metadata": { "undefined": "metadata" }, "metric_tons": "1158273248.6666667", "object": "climate.order", "product": { "created": 1028554472, "current_prices_per_metric_ton": { "undefined": { "amount_fees": 1211316940, "amount_subtotal": 1555417355, "amount_total": 1117121693 } }, "delivery_year": null, "id": "obj_123", "livemode": true, "metric_tons_available": "1213139418", "name": "name", "object": "climate.product", "suppliers": [ { "id": "obj_123", "info_url": "info_url", "livemode": true, "locations": [ { "city": null, "country": "country", "latitude": null, "longitude": null, "region": null } ], "name": "name", "object": "climate.supplier", "removal_pathway": "enhanced_weathering" } ] }, "product_substituted_at": null, "status": "awaiting_funds" }, "climate.product": { "created": 1028554472, "current_prices_per_metric_ton": { "undefined": { "amount_fees": 1211316940, "amount_subtotal": 1555417355, "amount_total": 1117121693 } }, "delivery_year": null, "id": "obj_123", "livemode": true, "metric_tons_available": "1213139418", "name": "name", "object": "climate.product", "suppliers": [ { "id": "obj_123", "info_url": "info_url", "livemode": true, "locations": [ { "city": null, "country": "country", "latitude": null, "longitude": null, "region": null } ], "name": "name", "object": "climate.supplier", "removal_pathway": "enhanced_weathering" } ] }, "climate.supplier": { "id": "obj_123", "info_url": "info_url", "livemode": true, "locations": [ { "city": null, "country": "country", "latitude": null, "longitude": null, "region": null } ], "name": "name", "object": "climate.supplier", "removal_pathway": "enhanced_weathering" }, "confirmation_token": { "created": 1028554472, "expires_at": null, "id": "obj_123", "livemode": true, "object": "confirmation_token", "payment_intent": null, "payment_method_options": { "card": { "cvc_token": null } }, "payment_method_preview": { "billing_details": { "address": { "city": null, "country": null, "line1": null, "line2": null, "postal_code": null, "state": null }, "email": null, "name": null, "phone": null, "tax_id": null }, "customer": null, "type": "acss_debit" }, "return_url": null, "setup_future_usage": null, "setup_intent": null, "shipping": { "address": { "city": null, "country": null, "line1": null, "line2": null, "postal_code": null, "state": null }, "name": "name", "phone": null }, "use_stripe_sdk": true }, "customer_session": { "client_secret": "client_secret", "created": 1028554472, "customer": { "created": 1028554472, "default_source": null, "description": null, "email": null, "id": "obj_123", "livemode": true, "object": "customer", "shipping": {} }, "expires_at": 833811170, "livemode": true, "object": "customer_session" }, "deleted_application": { "deleted": true, "id": "obj_123", "name": null, "object": "application" }, "deleted_bank_account": { "deleted": true, "id": "obj_123", "object": "bank_account" }, "deleted_card": { "deleted": true, "id": "obj_123", "object": "card" }, "deleted_price": { "deleted": true, "id": "obj_123", "object": "price" }, "deleted_product_feature": { "deleted": true, "id": "obj_123", "object": "product_feature" }, "entitlements.active_entitlement": { "feature": { "active": true, "id": "obj_123", "livemode": true, "lookup_key": "lookup_key", "metadata": { "undefined": "metadata" }, "name": "name", "object": "entitlements.feature" }, "id": "obj_123", "livemode": true, "lookup_key": "lookup_key", "object": "entitlements.active_entitlement" }, "entitlements.active_entitlement_summary": { "customer": "customer", "entitlements": { "data": [ { "feature": { "active": true, "id": "obj_123", "livemode": true, "lookup_key": "lookup_key", "metadata": { "undefined": "metadata" }, "name": "name", "object": "entitlements.feature" }, "id": "obj_123", "livemode": true, "lookup_key": "lookup_key", "object": "entitlements.active_entitlement" } ], "has_more": true, "object": "list", "url": "url" }, "livemode": true, "object": "entitlements.active_entitlement_summary" }, "entitlements.feature": { "active": true, "id": "obj_123", "livemode": true, "lookup_key": "lookup_key", "metadata": { "undefined": "metadata" }, "name": "name", "object": "entitlements.feature" }, "financial_connections.account_inferred_balance": { "as_of": 93102340, "current": { "undefined": 1126940025 }, "id": "obj_123", "object": "financial_connections.account_inferred_balance" }, "financial_connections.account_ownership": { "created": 1028554472, "id": "obj_123", "object": "financial_connections.account_ownership", "owners": { "data": [ { "email": null, "id": "obj_123", "name": "name", "object": "financial_connections.account_owner", "ownership": "ownership", "phone": null, "raw_address": null, "refreshed_at": null } ], "has_more": true, "object": "list", "url": "url" } }, "financial_connections.institution": { "countries": [ "countries" ], "features": { "balances": { "supported": true }, "ownership": { "supported": true }, "payment_method": { "supported": true }, "transactions": { "supported": true } }, "id": "obj_123", "livemode": true, "name": "name", "object": "financial_connections.institution", "routing_numbers": [ "routing_numbers" ], "status": "active", "url": null }, "financial_connections.transaction": { "account": "account", "amount": 1413853096, "currency": "currency", "description": "description", "id": "obj_123", "livemode": true, "object": "financial_connections.transaction", "status": "pending", "status_transitions": { "posted_at": null, "void_at": null }, "transacted_at": 444205353, "transaction_refresh": "transaction_refresh", "updated": 234430277 }, "forwarding.request": { "created": 1028554472, "id": "obj_123", "livemode": true, "object": "forwarding.request", "payment_method": "payment_method", "replacements": [ "cardholder_name" ], "request_context": { "destination_duration": 2135692635, "destination_ip_address": "destination_ip_address" }, "request_details": { "body": "body", "headers": [ { "name": "name", "value": "value" } ], "http_method": "POST" }, "response_details": { "body": "body", "headers": [ { "name": "name", "value": "value" } ], "status": 892481550 }, "url": null }, "fx_quote": { "created": 1028554472, "id": "obj_123", "lock_duration": "day", "lock_expires_at": null, "lock_status": "active", "object": "fx_quote", "rates": { "undefined": { "exchange_rate": 1381553532, "rate_details": { "base_rate": 1816487538, "duration_premium": 875827540, "fx_fee_rate": 817353018, "reference_rate": null, "reference_rate_provider": null } } }, "to_currency": "to_currency", "usage": { "payment": { "destination": null, "on_behalf_of": null }, "transfer": { "destination": "destination" }, "type": "payment" } }, "invoice_payment": { "amount_paid": null, "amount_requested": 1112626247, "created": 1028554472, "currency": "currency", "id": "obj_123", "invoice": "invoice", "is_default": true, "livemode": true, "object": "invoice_payment", "payment": { "type": "charge" }, "status": "status", "status_transitions": { "canceled_at": null, "paid_at": null } }, "invoice_rendering_template": { "created": 1028554472, "id": "obj_123", "livemode": true, "metadata": null, "nickname": null, "object": "invoice_rendering_template", "status": "active", "version": 351608024 }, "issuing.credit_underwriting_record": { "application": { "application_method": "in_person", "purpose": "credit_limit_increase", "submitted_at": 2047729161 }, "created": 1028554472, "created_from": "proactive_review", "credit_user": { "email": "email", "name": "name" }, "decided_at": null, "decision": { "application_rejected": { "reason_other_explanation": null, "reasons": [ "prior_or_current_legal_action" ] }, "credit_limit_approved": { "amount": 1413853096, "currency": "currency" }, "credit_limit_decreased": { "amount": 1413853096, "currency": "currency", "reason_other_explanation": null, "reasons": [ "insufficient_margin_ratio" ] }, "credit_line_closed": { "reason_other_explanation": null, "reasons": [ "insufficient_margin_ratio" ] }, "type": "credit_limit_decreased" }, "decision_deadline": null, "id": "obj_123", "livemode": true, "metadata": null, "object": "issuing.credit_underwriting_record", "regulatory_reporting_file": null, "underwriting_exception": { "explanation": "explanation", "original_decision_type": "credit_line_closed" } }, "issuing.dispute_settlement_detail": { "amount": 1413853096, "card": "card", "created": 1028554472, "currency": "currency", "dispute": "dispute", "event_type": "win", "id": "obj_123", "livemode": true, "network": "visa", "network_data": { "processing_date": null }, "object": "issuing.dispute_settlement_detail", "settlement": null }, "issuing.fraud_liability_debit": { "amount": 1413853096, "balance_transaction": null, "created": 1028554472, "currency": "currency", "dispute": "dispute", "id": "obj_123", "livemode": true, "object": "issuing.fraud_liability_debit" }, "issuing.personalization_design": { "card_logo": null, "carrier_text": { "footer_body": null, "footer_title": null, "header_body": null, "header_title": null }, "created": 1028554472, "id": "obj_123", "livemode": true, "lookup_key": null, "metadata": { "undefined": "metadata" }, "name": null, "object": "issuing.personalization_design", "physical_bundle": { "features": { "card_logo": "unsupported", "carrier_text": "optional", "second_line": "optional" }, "id": "obj_123", "livemode": true, "name": "name", "object": "issuing.physical_bundle", "status": "active", "type": "custom" }, "preferences": { "is_default": true, "is_platform_default": null }, "rejection_reasons": { "card_logo": null, "carrier_text": null }, "status": "rejected" }, "issuing.physical_bundle": { "features": { "card_logo": "unsupported", "carrier_text": "optional", "second_line": "optional" }, "id": "obj_123", "livemode": true, "name": "name", "object": "issuing.physical_bundle", "status": "active", "type": "custom" }, "issuing.token": { "card": "card", "created": 1028554472, "device_fingerprint": null, "id": "obj_123", "livemode": true, "network": "mastercard", "network_updated_at": 791673624, "object": "issuing.token", "status": "requested" }, "margin": { "active": true, "created": 1028554472, "id": "obj_123", "livemode": true, "metadata": null, "name": null, "object": "margin", "percent_off": 1487902325, "updated": 234430277 }, "order": { "amount_subtotal": 1555417355, "amount_total": 1117121693, "application": null, "billing_details": { "address": { "city": null, "country": null, "line1": null, "line2": null, "postal_code": null, "state": null }, "email": null, "name": null, "phone": null }, "client_secret": null, "created": 1028554472, "currency": "currency", "customer": null, "description": null, "discounts": null, "id": "obj_123", "ip_address": null, "livemode": true, "metadata": null, "object": "order", "payment": { "payment_intent": null, "settings": { "application_fee_amount": null, "automatic_payment_methods": { "enabled": true }, "payment_method_options": {}, "payment_method_types": null, "return_url": null, "statement_descriptor": null, "statement_descriptor_suffix": null, "transfer_data": { "amount": null, "destination": { "id": "obj_123", "object": "account" } } }, "status": null }, "shipping_cost": { "amount_subtotal": 1555417355, "amount_tax": 1424534716, "amount_total": 1117121693, "shipping_rate": null }, "shipping_details": { "address": { "city": null, "country": null, "line1": null, "line2": null, "postal_code": null, "state": null }, "name": null, "phone": null }, "status": "canceled", "total_details": { "amount_discount": 406046392, "amount_shipping": null, "amount_tax": 1424534716 } }, "payment_attempt_record": { "amount_canceled": { "currency": "currency", "value": 111972721 }, "amount_failed": { "currency": "currency", "value": 111972721 }, "amount_guaranteed": { "currency": "currency", "value": 111972721 }, "amount_requested": { "currency": "currency", "value": 111972721 }, "created": 1028554472, "customer_details": { "customer": null, "email": null, "name": null, "phone": null }, "customer_presence": null, "description": null, "id": "obj_123", "livemode": true, "metadata": { "undefined": "metadata" }, "object": "payment_attempt_record", "payment_method_details": { "billing_details": { "address": { "city": null, "country": null, "line1": null, "line2": null, "postal_code": null, "state": null }, "email": null, "name": null, "phone": null }, "payment_method": null, "type": "type" }, "payment_record": null, "reported_by": "stripe", "shipping_details": { "address": { "city": null, "country": null, "line1": null, "line2": null, "postal_code": null, "state": null }, "name": null, "phone": null }, "amount": { "currency": "currency", "value": 111972721 }, "amount_authorized": { "currency": "currency", "value": 111972721 }, "amount_refunded": { "currency": "currency", "value": 111972721 }, "application": null, "processor_details": { "type": "custom" } }, "payment_intent_amount_details_line_item": { "discount_amount": null, "id": "obj_123", "object": "payment_intent_amount_details_line_item", "payment_method_options": {}, "product_code": null, "product_name": "product_name", "quantity": 1285004149, "tax": { "total_tax_amount": 1109208903 }, "unit_cost": 472784472, "unit_of_measure": null }, "payment_method_configuration": { "active": true, "application": null, "id": "obj_123", "is_default": true, "livemode": true, "name": "name", "object": "payment_method_configuration", "parent": null }, "payment_method_domain": { "amazon_pay": { "status": "active" }, "apple_pay": { "status": "active" }, "created": 1028554472, "domain_name": "domain_name", "enabled": true, "google_pay": { "status": "active" }, "id": "obj_123", "klarna": { "status": "active" }, "link": { "status": "active" }, "livemode": true, "object": "payment_method_domain", "paypal": { "status": "active" } }, "payment_record": { "amount_canceled": { "currency": "currency", "value": 111972721 }, "amount_failed": { "currency": "currency", "value": 111972721 }, "amount_guaranteed": { "currency": "currency", "value": 111972721 }, "amount_requested": { "currency": "currency", "value": 111972721 }, "created": 1028554472, "customer_details": { "customer": null, "email": null, "name": null, "phone": null }, "customer_presence": null, "description": null, "id": "obj_123", "latest_payment_attempt_record": null, "livemode": true, "metadata": { "undefined": "metadata" }, "object": "payment_record", "payment_method_details": { "billing_details": { "address": { "city": null, "country": null, "line1": null, "line2": null, "postal_code": null, "state": null }, "email": null, "name": null, "phone": null }, "payment_method": null, "type": "type" }, "shipping_details": { "address": { "city": null, "country": null, "line1": null, "line2": null, "postal_code": null, "state": null }, "name": null, "phone": null }, "amount": { "currency": "currency", "value": 111972721 }, "amount_authorized": { "currency": "currency", "value": 111972721 }, "amount_refunded": { "currency": "currency", "value": 111972721 }, "application": null, "processor_details": { "type": "custom" } }, "privacy.redaction_job": { "created": 1028554472, "id": "obj_123", "livemode": true, "object": "privacy.redaction_job", "status": "succeeded", "validation_behavior": null }, "privacy.redaction_job_validation_error": { "code": "invalid_file_purpose", "erroring_object": { "id": "obj_123", "object_type": "object_type" }, "id": "obj_123", "message": "message", "object": "privacy.redaction_job_validation_error" }, "product_feature": { "entitlement_feature": { "active": true, "id": "obj_123", "livemode": true, "lookup_key": "lookup_key", "metadata": { "undefined": "metadata" }, "name": "name", "object": "entitlements.feature" }, "id": "obj_123", "livemode": true, "object": "product_feature" }, "quote_line": { "applies_to": { "new_reference": null, "subscription_schedule": null, "type": "new_reference" }, "billing_cycle_anchor": null, "cancel_subscription_schedule": { "cancel_at": "line_starts_at", "invoice_now": null, "prorate": null }, "ends_at": { "computed": null, "duration": { "interval": "month", "interval_count": 797691627 }, "timestamp": null, "type": "quote_acceptance_date" }, "id": "obj_123", "object": "quote_line", "proration_behavior": null, "set_schedule_end": null, "starts_at": { "computed": null, "line_ends_at": { "id": "obj_123" }, "timestamp": null, "type": "quote_acceptance_date" } }, "quote_preview_invoice": { "account_country": null, "account_name": null, "account_tax_ids": null, "amount_due": 1424549491, "amount_overpaid": 149300825, "amount_paid": 1211022765, "amount_remaining": 1288530639, "amount_shipping": 1195466315, "application": null, "applies_to": { "new_reference": null, "subscription_schedule": null, "type": "new_reference" }, "attempt_count": 394495715, "attempted": true, "automatic_tax": { "disabled_reason": null, "enabled": true, "liability": { "type": "account" }, "provider": null, "status": null }, "automatically_finalizes_at": null, "billing_reason": null, "collection_method": "charge_automatically", "created": 1028554472, "currency": "currency", "custom_fields": null, "customer_address": { "city": null, "country": null, "line1": null, "line2": null, "postal_code": null, "state": null }, "customer_email": null, "customer_name": null, "customer_phone": null, "customer_shipping": {}, "customer_tax_exempt": null, "default_payment_method": null, "default_source": null, "default_tax_rates": [ { "active": true, "country": null, "created": 1028554472, "description": null, "display_name": "display_name", "effective_percentage": null, "flat_amount": { "amount": 1413853096, "currency": "currency" }, "id": "obj_123", "inclusive": true, "jurisdiction": null, "jurisdiction_level": null, "livemode": true, "metadata": null, "object": "tax_rate", "percentage": 921832806, "rate_type": null, "state": null, "tax_type": null } ], "description": null, "discounts": [ { "checkout_session": null, "coupon": { "amount_off": null, "created": 1028554472, "currency": null, "duration": "forever", "duration_in_months": null, "id": "obj_123", "livemode": true, "max_redemptions": null, "metadata": null, "name": null, "object": "coupon", "percent_off": null, "redeem_by": null, "times_redeemed": 990066668, "valid": true }, "customer": null, "end": null, "id": "obj_123", "invoice": null, "invoice_item": null, "object": "discount", "promotion_code": null, "start": 109757538, "subscription": null, "subscription_item": null } ], "due_date": null, "effective_at": null, "ending_balance": null, "footer": null, "from_invoice": { "action": "action", "invoice": "invoice" }, "id": "obj_123", "issuer": { "type": "account" }, "last_finalization_error": { "type": "idempotency_error" }, "latest_revision": null, "lines": { "data": [ { "amount": 1413853096, "currency": "currency", "description": null, "discount_amounts": null, "discountable": true, "discounts": [ { "checkout_session": null, "coupon": { "amount_off": null, "created": 1028554472, "currency": null, "duration": "forever", "duration_in_months": null, "id": "obj_123", "livemode": true, "max_redemptions": null, "metadata": null, "name": null, "object": "coupon", "percent_off": null, "redeem_by": null, "times_redeemed": 990066668, "valid": true }, "customer": null, "end": null, "id": "obj_123", "invoice": null, "invoice_item": null, "object": "discount", "promotion_code": null, "start": 109757538, "subscription": null, "subscription_item": null } ], "id": "obj_123", "invoice": null, "livemode": true, "metadata": { "undefined": "metadata" }, "object": "line_item", "parent": { "invoice_item_details": { "invoice_item": "invoice_item", "proration": true, "proration_details": { "credited_items": { "invoice": "invoice", "invoice_line_items": [ "invoice_line_items" ] } }, "subscription": null }, "subscription_item_details": { "invoice_item": null, "proration": true, "proration_details": { "credited_items": { "invoice": "invoice", "invoice_line_items": [ "invoice_line_items" ] } }, "subscription": null, "subscription_item": "subscription_item" }, "type": "invoice_item_details" }, "period": { "end": 100571, "start": 109757538 }, "pretax_credit_amounts": null, "pricing": { "type": "price_details", "unit_amount_decimal": null }, "quantity": null, "subscription": null, "taxes": null } ], "has_more": true, "object": "list", "url": "url" }, "livemode": true, "metadata": null, "next_payment_attempt": null, "number": null, "object": "quote_preview_invoice", "on_behalf_of": null, "parent": { "quote_details": { "quote": "quote" }, "subscription_details": { "metadata": null, "subscription": "subscription" }, "type": "quote_details" }, "payment_settings": { "default_mandate": null, "payment_method_options": { "acss_debit": {}, "bancontact": { "preferred_language": "fr" }, "card": { "request_three_d_secure": null }, "customer_balance": { "funding_type": null }, "konbini": {}, "sepa_debit": {}, "us_bank_account": {} }, "payment_method_types": null }, "period_end": 384656733, "period_start": 301041764, "post_payment_credit_notes_amount": 304272452, "pre_payment_credit_notes_amount": 630496199, "receipt_number": null, "rendering": { "amount_tax_display": null, "pdf": { "page_size": null }, "template": null, "template_version": null }, "shipping_cost": { "amount_subtotal": 1555417355, "amount_tax": 1424534716, "amount_total": 1117121693, "shipping_rate": null }, "shipping_details": {}, "starting_balance": 2098247133, "statement_descriptor": null, "status": null, "status_transitions": { "finalized_at": null, "marked_uncollectible_at": null, "paid_at": null, "voided_at": null }, "subscription": null, "subtotal": 2060319484, "subtotal_excluding_tax": null, "test_clock": null, "total": 110549828, "total_discount_amounts": null, "total_excluding_tax": null, "total_pretax_credit_amounts": null, "total_taxes": null, "webhooks_delivered_at": null }, "quote_preview_subscription_schedule": { "application": null, "applies_to": { "new_reference": null, "subscription_schedule": null, "type": "new_reference" }, "canceled_at": null, "completed_at": null, "created": 1028554472, "current_phase": { "end_date": 1725067410, "start_date": 1573629589 }, "customer": { "created": 1028554472, "default_source": null, "description": null, "email": null, "id": "obj_123", "livemode": true, "object": "customer", "shipping": {} }, "default_settings": { "application_fee_percent": null, "billing_cycle_anchor": "automatic", "billing_thresholds": { "amount_gte": null, "reset_billing_cycle_anchor": null }, "collection_method": null, "default_payment_method": null, "description": null, "invoice_settings": { "account_tax_ids": null, "days_until_due": null, "issuer": { "type": "account" } }, "on_behalf_of": null, "transfer_data": { "amount_percent": null, "destination": { "id": "obj_123", "object": "account" } } }, "end_behavior": "release", "id": "obj_123", "livemode": true, "metadata": null, "object": "quote_preview_subscription_schedule", "phases": [ { "add_invoice_items": [ { "discounts": [ { "coupon": null, "discount": null, "promotion_code": null } ], "price": "price", "quantity": null, "metadata": null, "period": { "end": { "type": "min_item_period_end" }, "start": { "type": "max_item_period_start" } } } ], "application_fee_percent": null, "billing_cycle_anchor": null, "billing_thresholds": { "amount_gte": null, "reset_billing_cycle_anchor": null }, "collection_method": null, "currency": "currency", "default_payment_method": null, "description": null, "discounts": [ { "coupon": null, "discount": null, "promotion_code": null } ], "end_date": 1725067410, "invoice_settings": { "account_tax_ids": null, "days_until_due": null, "issuer": { "type": "account" } }, "items": [ { "billing_thresholds": { "usage_gte": null }, "discounts": [ { "coupon": null, "discount": null, "promotion_code": null } ], "metadata": null, "plan": { "active": true, "amount": null, "amount_decimal": null, "billing_scheme": "tiered", "created": 1028554472, "currency": "currency", "id": "obj_123", "interval": "month", "interval_count": 797691627, "livemode": true, "metadata": null, "meter": null, "nickname": null, "object": "plan", "product": null, "tiers_mode": null, "transform_usage": { "divide_by": 1592560163, "round": "down" }, "trial_period_days": null, "usage_type": "licensed" }, "price": "price" } ], "metadata": null, "on_behalf_of": null, "proration_behavior": "create_prorations", "start_date": 1573629589, "transfer_data": { "amount_percent": null, "destination": { "id": "obj_123", "object": "account" } }, "trial_end": null } ], "released_at": null, "released_subscription": null, "status": "active", "subscription": null, "test_clock": null, "billing_mode": { "type": "classic" } }, "tax.association": { "calculation": "calculation", "id": "obj_123", "object": "tax.association", "payment_intent": "payment_intent" }, "tax.calculation": { "amount_total": 1117121693, "currency": "currency", "customer": null, "customer_details": { "address": { "city": null, "country": "country", "line1": null, "line2": null, "postal_code": null, "state": null }, "address_source": null, "ip_address": null, "tax_ids": [ { "type": "np_pan", "value": "value" } ], "taxability_override": "customer_exempt" }, "expires_at": null, "id": null, "livemode": true, "object": "tax.calculation", "ship_from_details": { "address": { "city": null, "country": "country", "line1": null, "line2": null, "postal_code": null, "state": null } }, "shipping_cost": { "amount": 1413853096, "amount_tax": 1424534716, "tax_behavior": "exclusive", "tax_code": "tax_code" }, "tax_amount_exclusive": 1942751627, "tax_amount_inclusive": 1240333095, "tax_breakdown": [ { "amount": 1413853096, "inclusive": true, "tax_rate_details": { "country": null, "flat_amount": { "amount": 1413853096, "currency": "currency" }, "percentage_decimal": "percentage_decimal", "rate_type": null, "state": null, "tax_type": null }, "taxability_reason": "taxable_basis_reduced", "taxable_amount": 403650130 } ], "tax_date": 277611582 }, "tax.calculation_line_item": { "amount": 1413853096, "amount_tax": 1424534716, "id": "obj_123", "livemode": true, "metadata": null, "object": "tax.calculation_line_item", "product": null, "quantity": 1285004149, "reference": "reference", "tax_behavior": "exclusive", "tax_code": "tax_code" }, "tax.form": { "corrected_by": null, "created": 1028554472, "filing_statuses": [ { "effective_at": 247108043, "jurisdiction": { "country": "country", "level": "country", "state": null }, "value": "filed" } ], "id": "obj_123", "livemode": true, "object": "tax.form", "payee": { "account": null, "external_reference": null, "type": "account" }, "type": "eu_dac7" }, "tax.registration": { "active_from": 1051736765, "country": "country", "country_options": {}, "created": 1028554472, "expires_at": null, "id": "obj_123", "livemode": true, "object": "tax.registration", "status": "active" }, "tax.settings": { "defaults": { "tax_behavior": null, "tax_code": null }, "head_office": { "address": { "city": null, "country": null, "line1": null, "line2": null, "postal_code": null, "state": null } }, "livemode": true, "object": "tax.settings", "status": "active", "status_details": {} }, "tax.transaction": { "created": 1028554472, "currency": "currency", "customer": null, "customer_details": { "address": { "city": null, "country": "country", "line1": null, "line2": null, "postal_code": null, "state": null }, "address_source": null, "ip_address": null, "tax_ids": [ { "type": "np_pan", "value": "value" } ], "taxability_override": "customer_exempt" }, "id": "obj_123", "livemode": true, "metadata": null, "object": "tax.transaction", "posted_at": 2008020787, "reference": "reference", "reversal": { "original_transaction": null }, "ship_from_details": { "address": { "city": null, "country": "country", "line1": null, "line2": null, "postal_code": null, "state": null } }, "shipping_cost": { "amount": 1413853096, "amount_tax": 1424534716, "tax_behavior": "exclusive", "tax_code": "tax_code" }, "tax_date": 277611582, "type": "reversal" }, "tax.transaction_line_item": { "amount": 1413853096, "amount_tax": 1424534716, "id": "obj_123", "livemode": true, "metadata": null, "object": "tax.transaction_line_item", "product": null, "quantity": 1285004149, "reference": "reference", "reversal": { "original_line_item": "original_line_item" }, "tax_behavior": "exclusive", "tax_code": "tax_code", "type": "reversal" }, "terminal.reader_collected_data": { "created": 1028554472, "id": "obj_123", "livemode": true, "magstripe": { "data": null }, "object": "terminal.reader_collected_data", "type": "magstripe" }, "terminal.onboarding_link": { "link_options": { "apple_terms_and_conditions": { "allow_relinking": null, "merchant_display_name": "merchant_display_name" } }, "link_type": "apple_terms_and_conditions", "object": "terminal.onboarding_link", "on_behalf_of": null, "redirect_url": "redirect_url" }, "billing.analytics.meter_usage": { "data": [ { "bucket_end_time": 267894170, "bucket_start_time": 1719055873, "bucket_value": 209364700, "dimensions": null, "id": "obj_123", "meter_id": null, "object": "billing.analytics.meter_usage_row" } ], "data_refreshed_at": 952047539, "livemode": true, "object": "billing.analytics.meter_usage" }, "billing.analytics.meter_usage_row": { "bucket_end_time": 267894170, "bucket_start_time": 1719055873, "bucket_value": 209364700, "dimensions": null, "id": "obj_123", "meter_id": null, "object": "billing.analytics.meter_usage_row" } } }stripe-mock-0.196.0/embedded/openapi/fixtures3.json000066400000000000000000005311371506013555700221600ustar00rootroot00000000000000{ "resources": { "account": { "business_profile": { "annual_revenue": { "amount": null, "currency": null, "fiscal_year_end": null }, "estimated_worker_count": null, "mcc": null, "name": null, "product_description": null, "support_address": { "city": null, "country": null, "line1": null, "line2": null, "postal_code": null, "state": null }, "support_email": null, "support_phone": null, "support_url": null, "url": null, "minority_owned_business_designation": null }, "business_type": null, "capabilities": { "card_payments": "active", "transfers": "active" }, "charges_enabled": false, "controller": { "type": "account" }, "country": "US", "created": 1234567890, "default_currency": "usd", "details_submitted": false, "email": "site@stripe.com", "external_accounts": { "data": [], "has_more": false, "object": "list", "url": "/v1/accounts/acct_1PgafTB7WZ01zgkW/external_accounts" }, "future_requirements": { "alternatives": [], "current_deadline": null, "currently_due": [], "disabled_reason": null, "errors": [], "eventually_due": [], "past_due": [], "pending_verification": [] }, "id": "acct_1PgafTB7WZ01zgkW", "metadata": {}, "object": "account", "payouts_enabled": false, "requirements": { "alternatives": [], "current_deadline": null, "currently_due": [ "business_profile.product_description", "business_profile.support_phone", "business_profile.url", "external_account", "tos_acceptance.date", "tos_acceptance.ip" ], "disabled_reason": "requirements.past_due", "errors": [], "eventually_due": [ "business_profile.product_description", "business_profile.support_phone", "business_profile.url", "external_account", "tos_acceptance.date", "tos_acceptance.ip" ], "past_due": [], "pending_verification": [] }, "settings": { "bacs_debit_payments": { "display_name": null, "service_user_number": null }, "branding": { "icon": null, "logo": null, "primary_color": null, "secondary_color": null }, "card_issuing": { "tos_acceptance": { "date": null, "ip": null } }, "card_payments": { "decline_on": { "avs_failure": true, "cvc_failure": true }, "statement_descriptor_prefix": null, "statement_descriptor_prefix_kana": null, "statement_descriptor_prefix_kanji": null }, "dashboard": { "display_name": null, "timezone": "Etc/UTC" }, "invoices": { "default_account_tax_ids": null, "hosted_payment_method_save": null }, "payments": { "statement_descriptor": null, "statement_descriptor_kana": null, "statement_descriptor_kanji": null, "statement_descriptor_prefix_kana": null, "statement_descriptor_prefix_kanji": null }, "payouts": { "debit_negative_balances": true, "schedule": { "delay_days": 2, "interval": "daily" }, "statement_descriptor": null }, "sepa_debit_payments": {} }, "tos_acceptance": { "date": null, "ip": null, "user_agent": null }, "type": "standard" }, "account_link": { "created": 1234567890, "expires_at": 1234567890, "object": "account_link", "url": "https://sangeekp-15t6ai--manage-mydev.dev.stripe.me/setup/s/acct_1PgafTB7WZ01zgkW/MerI6itPZo2K" }, "account_session": { "account": "acct_1Pgc7HKmsySxIypT", "client_secret": "accs_secret__QXhWgWIhGJ2Zl68tEmbZ29Gtc86adyWl6eEz2h6K7HtpnoB", "components": { "account_management": { "enabled": false, "features": { "external_account_collection": true, "disable_stripe_user_authentication": true } }, "account_onboarding": { "enabled": false, "features": { "external_account_collection": true, "disable_stripe_user_authentication": true } }, "balances": { "enabled": false, "features": { "edit_payout_schedule": false, "external_account_collection": true, "instant_payouts": false, "standard_payouts": false, "disable_stripe_user_authentication": true } }, "documents": { "enabled": false, "features": {} }, "notification_banner": { "enabled": false, "features": { "external_account_collection": true, "disable_stripe_user_authentication": true } }, "payment_details": { "enabled": false, "features": { "capture_payments": true, "destination_on_behalf_of_charge_management": false, "dispute_management": true, "refund_management": true } }, "payments": { "enabled": false, "features": { "capture_payments": true, "destination_on_behalf_of_charge_management": false, "dispute_management": true, "refund_management": true } }, "payouts": { "enabled": false, "features": { "edit_payout_schedule": false, "external_account_collection": true, "instant_payouts": false, "standard_payouts": false, "disable_stripe_user_authentication": true } }, "payouts_list": { "enabled": false, "features": {} }, "tax_registrations": { "enabled": false, "features": {} }, "tax_settings": { "enabled": false, "features": {} }, "financial_account": { "enabled": true, "features": { "disable_stripe_user_authentication": true, "external_account_collection": true, "send_money": true, "transfer_balance": true } }, "financial_account_transactions": { "enabled": true, "features": { "card_spend_dispute_management": true } }, "issuing_card": { "enabled": true, "features": { "card_management": true, "card_spend_dispute_management": true, "cardholder_management": true, "spend_control_management": true } }, "issuing_cards_list": { "enabled": true, "features": { "card_management": true, "card_spend_dispute_management": true, "cardholder_management": true, "disable_stripe_user_authentication": true, "spend_control_management": true } }, "disputes_list": { "enabled": true, "features": { "capture_payments": true, "destination_on_behalf_of_charge_management": true, "dispute_management": true, "refund_management": true } }, "payment_disputes": { "enabled": true, "features": { "destination_on_behalf_of_charge_management": true, "dispute_management": true, "refund_management": true } }, "instant_payouts_promotion": { "enabled": true, "features": { "disable_stripe_user_authentication": true, "external_account_collection": true, "instant_payouts": true } }, "payout_details": { "enabled": true, "features": {} }, "balance_report": { "enabled": true, "features": {} }, "payout_reconciliation_report": { "enabled": true, "features": {} } }, "expires_at": 1234567890, "livemode": false, "object": "account_session" }, "apple_pay_domain": { "created": 1234567890, "domain_name": "example.com", "id": "apwc_1Pgc6oB7WZ01zgkWHz71O4bz", "livemode": true, "object": "apple_pay_domain" }, "application_fee": { "account": "acct_1PgafTB7WZ01zgkW", "amount": 100, "amount_refunded": 0, "application": "ca_QXhWOVlWX7KFerjnWFSGuGR21sZjCeji", "balance_transaction": "txn_1PgaxNB7WZ01zgkWEV3TLf40", "charge": "ch_1PgafuB7WZ01zgkWXYmPNZs8", "created": 1234567890, "currency": "usd", "fee_source": { "charge": "ch_1PgafuB7WZ01zgkWXYmPNZs8", "type": "charge" }, "id": "fee_1Pgc6zB7WZ01zgkWOMh2at1m", "livemode": false, "object": "application_fee", "originating_transaction": null, "refunded": false, "refunds": { "data": [], "has_more": false, "object": "list", "url": "/v1/application_fees/fee_1Pgc6zB7WZ01zgkWOMh2at1m/refunds" } }, "apps.secret": { "created": 1234567890, "expires_at": 1234567890, "id": "appsecret_5110QzMIZ0005GiEH1m0419O8KAxCG", "livemode": false, "name": "test-secret", "object": "apps.secret", "scope": { "type": "account" } }, "balance": { "available": [ { "amount": 0, "currency": "usd", "source_types": { "card": 0 } } ], "connect_reserved": [ { "amount": 0, "currency": "usd" } ], "livemode": false, "object": "balance", "pending": [ { "amount": 0, "currency": "usd", "source_types": { "card": 0 } } ] }, "balance_transaction": { "amount": 100, "available_on": 1234567890, "created": 1234567890, "currency": "usd", "description": "My First Test Charge (created for API docs)", "exchange_rate": null, "fee": 0, "fee_details": [], "id": "txn_1PgaxNB7WZ01zgkWEV3TLf40", "net": 100, "object": "balance_transaction", "reporting_category": "charge", "source": "ch_1PgafuB7WZ01zgkWXYmPNZs8", "status": "available", "type": "charge", "balance_type": "payments" }, "bank_account": { "account_holder_name": "Jane Austen", "account_holder_type": "company", "account_type": null, "bank_name": "STRIPE TEST BANK", "country": "US", "currency": "usd", "customer": null, "fingerprint": "AuoSJ18zsVWV9SPc", "id": "ba_1PgagAB7WZ01zgkWr3DySp2Q", "last4": "6789", "metadata": {}, "object": "bank_account", "routing_number": "110000000", "status": "new" }, "billing.meter": { "created": 1234567890, "customer_mapping": { "event_payload_key": "customer", "type": "by_id" }, "default_aggregation": { "formula": "sum" }, "display_name": "test-meter", "event_name": "test-meter-event-name", "event_time_window": null, "id": "meter_123", "livemode": true, "object": "billing.meter", "status": "active", "status_transitions": { "deactivated_at": null }, "updated": 1234567890, "value_settings": { "event_payload_key": "value" } }, "billing.meter_event": { "created": 1234567890, "event_name": "api_request", "identifier": "1234-1234", "livemode": false, "object": "billing.meter_event", "payload": { "stripe_customer_id": "cus_123", "value": "25" }, "timestamp": 1234567890 }, "billing.meter_event_adjustment": { "cancel": { "identifier": "1234-1234" }, "event_name": "test-meter-event-name", "livemode": false, "object": "billing.meter_event_adjustment", "status": "complete", "type": "cancel" }, "billing.meter_event_summary": { "aggregated_value": 25, "end_time": 1234567890, "id": "mtrusg_123", "livemode": false, "meter": "mtr_test_61Q8nQMqIFK9fRQmr41CMAXJrFdZ5MnA", "object": "billing.meter_event_summary", "start_time": 1234567890 }, "billing_portal.configuration": { "active": true, "application": null, "business_profile": { "headline": null, "privacy_policy_url": "https://example.com/privacy", "terms_of_service_url": "https://example.com/terms" }, "created": 1234567890, "default_return_url": null, "features": { "customer_update": { "allowed_updates": [ "email", "tax_id" ], "enabled": true }, "invoice_history": { "enabled": true }, "payment_method_update": { "enabled": false }, "subscription_cancel": { "cancellation_reason": { "enabled": false, "options": [] }, "enabled": false, "mode": "at_period_end", "proration_behavior": "none" }, "subscription_update": { "default_allowed_updates": [], "enabled": false, "proration_behavior": "none", "schedule_at_period_end": { "conditions": [ { "type": "decreasing_item_amount" } ] } } }, "id": "bpc_1Pgc70B7WZ01zgkWSnFO04Vt", "is_default": true, "livemode": true, "login_page": { "enabled": false, "url": null }, "metadata": null, "object": "billing_portal.configuration", "updated": 1234567890, "name": null }, "billing_portal.session": { "configuration": "bpc_1Pgc7HB7WZ01zgkWxH2EPWRX", "created": 1234567890, "customer": "cus_QXg1o8vcGmoR32", "flow": { "after_completion": { "hosted_confirmation": { "custom_message": null }, "redirect": { "return_url": "return_url" }, "type": "hosted_confirmation" }, "subscription_cancel": { "retention": { "coupon_offer": { "coupon": "coupon" }, "type": "coupon_offer" }, "subscription": "subscription" }, "subscription_update": { "subscription": "subscription" }, "subscription_update_confirm": { "discounts": null, "items": [ { "id": null, "price": null } ], "subscription": "subscription" }, "type": "subscription_update" }, "id": "bps_1Pgc7HB7WZ01zgkWNs8s9Auh", "livemode": true, "locale": null, "object": "billing_portal.session", "on_behalf_of": null, "return_url": "https://example.com/account", "url": "https://sangeekp-15t6ai--customer_portal-mydev.dev.stripe.me/session/{SESSION_SECRET}" }, "capability": { "account": "acct_1PgafTB7WZ01zgkW", "future_requirements": { "alternatives": [], "current_deadline": null, "currently_due": [], "disabled_reason": null, "errors": [], "eventually_due": [], "past_due": [], "pending_verification": [] }, "id": "card_payments", "object": "capability", "requested": true, "requested_at": 1234567890, "requirements": { "alternatives": [], "current_deadline": null, "currently_due": [], "disabled_reason": null, "errors": [], "eventually_due": [], "past_due": [], "pending_verification": [] }, "status": "inactive" }, "card": { "address_city": null, "address_country": null, "address_line1": null, "address_line1_check": null, "address_line2": null, "address_state": null, "address_zip": null, "address_zip_check": null, "brand": "Visa", "country": "US", "customer": null, "cvc_check": "pass", "dynamic_last4": null, "exp_month": 8, "exp_year": 2025, "fingerprint": "AOB934RVNwzk6xtn", "funding": "credit", "id": "card_1PgaftB7WZ01zgkWm3waTcFp", "last4": "4242", "metadata": {}, "name": "Jenny Rosen", "object": "card", "tokenization_method": null, "regulated_status": null }, "cash_balance": { "available": { "eur": 10000 }, "customer": "cus_QXg1o8vcGmoR32", "livemode": false, "object": "cash_balance", "settings": { "reconciliation_mode": "automatic", "using_merchant_default": true } }, "charge": { "amount": 100, "amount_captured": 0, "amount_refunded": 0, "application": null, "application_fee": null, "application_fee_amount": null, "balance_transaction": "txn_1PgaxNB7WZ01zgkWEV3TLf40", "billing_details": { "address": { "city": null, "country": null, "line1": null, "line2": null, "postal_code": null, "state": null }, "email": null, "name": "Jenny Rosen", "phone": null, "tax_id": null }, "calculated_statement_descriptor": null, "captured": false, "created": 1234567890, "currency": "usd", "customer": null, "description": "My First Test Charge (created for API docs)", "disputed": false, "failure_balance_transaction": null, "failure_code": null, "failure_message": null, "fraud_details": {}, "id": "ch_1PgafuB7WZ01zgkWXYmPNZs8", "livemode": false, "metadata": {}, "object": "charge", "on_behalf_of": null, "outcome": { "advice_code": null, "network_advice_code": null, "network_decline_code": null, "network_status": null, "reason": null, "seller_message": null, "type": "type" }, "paid": true, "payment_intent": null, "payment_method": "card_1PgaftB7WZ01zgkWm3waTcFp", "payment_method_details": { "card": { "amount_authorized": null, "brand": "visa", "checks": { "address_line1_check": null, "address_postal_code_check": null, "cvc_check": "pass" }, "country": "US", "exp_month": 8, "exp_year": 2025, "extended_authorization": { "status": "disabled" }, "fingerprint": "AOB934RVNwzk6xtn", "funding": "credit", "incremental_authorization": { "status": "unavailable" }, "installments": { "plan": { "count": null, "interval": null, "type": "fixed_count" } }, "last4": "4242", "mandate": null, "multicapture": { "status": "unavailable" }, "network": "visa", "network_token": { "used": false }, "overcapture": { "maximum_amount_capturable": 100, "status": "unavailable" }, "three_d_secure": { "authentication_flow": null, "electronic_commerce_indicator": null, "exemption_indicator": null, "result": null, "result_reason": null, "transaction_id": null, "version": null }, "wallet": { "dynamic_last4": null, "type": "link" }, "authorization_code": null, "regulated_status": null, "network_transaction_id": null }, "type": "card" }, "receipt_email": null, "receipt_number": null, "receipt_url": "https://sangeekp-15t6ai--manage-mydev.dev.stripe.me/receipts/payment/CAcaFwoVYWNjdF8xUGdhZlRCN1daMDF6Z2tXKI_ei7UGMgZv2S_KfiY6LCJrxC7awazgQA9I88krZKw5uuCkZ5Nup2tomEtAbSpdfzjVZHO3ZYP5KFZP", "refunded": false, "refunds": { "data": [], "has_more": false, "object": "list", "url": "/v1/charges/ch_1PgafuB7WZ01zgkWXYmPNZs8/refunds" }, "review": null, "shipping": {}, "source_transfer": null, "statement_descriptor": null, "statement_descriptor_suffix": null, "status": "succeeded", "transfer_data": { "amount": null, "destination": { "id": "obj_123", "object": "account" } }, "transfer_group": null, "source": { "allow_redisplay": null, "amount": null, "client_secret": "client_secret", "created": 1028554472, "currency": null, "flow": "flow", "id": "obj_123", "livemode": true, "metadata": null, "object": "source", "owner": { "address": { "city": null, "country": null, "line1": null, "line2": null, "postal_code": null, "state": null }, "email": null, "name": null, "phone": null, "verified_address": { "city": null, "country": null, "line1": null, "line2": null, "postal_code": null, "state": null }, "verified_email": null, "verified_name": null, "verified_phone": null }, "statement_descriptor": null, "status": "status", "type": "ach_credit_transfer", "usage": null } }, "checkout.session": { "after_expiration": { "recovery": { "allow_promotion_codes": true, "enabled": true, "expires_at": null, "url": null } }, "allow_promotion_codes": null, "amount_subtotal": null, "amount_total": null, "automatic_tax": { "enabled": false, "liability": { "type": "account" }, "status": null, "provider": null }, "billing_address_collection": null, "cancel_url": "https://example.com/cancel", "client_reference_id": null, "client_secret": null, "consent": { "promotions": null, "terms_of_service": null }, "consent_collection": { "payment_method_reuse_agreement": { "position": "hidden" }, "promotions": null, "terms_of_service": null }, "created": 1234567890, "currency": null, "currency_conversion": { "amount_subtotal": 1555417355, "amount_total": 1117121693, "fx_rate": "291452898", "source_currency": "source_currency" }, "custom_fields": [], "custom_text": { "after_submit": { "message": "message" }, "shipping_address": { "message": "message" }, "submit": { "message": "message" }, "terms_of_service_acceptance": { "message": "message" } }, "customer": null, "customer_creation": null, "customer_details": { "address": { "city": null, "country": null, "line1": null, "line2": null, "postal_code": null, "state": null }, "email": "example@example.com", "name": null, "phone": null, "tax_exempt": "none", "tax_ids": null }, "customer_email": null, "expires_at": 1234567890, "id": "cs_test_a1YS1URlnyQCN5fUUduORoQ7Pw41PJqDWkIVQCpJPqkfIhd6tVY8XB1OLY", "invoice": null, "invoice_creation": { "enabled": true, "invoice_data": { "account_tax_ids": null, "custom_fields": null, "description": null, "footer": null, "issuer": { "type": "account" }, "metadata": null, "rendering_options": { "amount_tax_display": null, "template": null } } }, "livemode": false, "locale": null, "metadata": {}, "mode": "payment", "object": "checkout.session", "payment_intent": "pi_1PgafyB7WZ01zgkWSjxsAJo3", "payment_link": null, "payment_method_collection": null, "payment_method_configuration_details": { "id": "obj_123", "parent": null }, "payment_method_options": {}, "payment_method_types": [ "card" ], "payment_status": "unpaid", "phone_number_collection": { "enabled": false }, "recovered_from": null, "saved_payment_method_options": { "allow_redisplay_filters": null, "payment_method_remove": null, "payment_method_save": null }, "setup_intent": null, "shipping_address_collection": { "allowed_countries": [ "SC" ] }, "shipping_cost": { "amount_subtotal": 1555417355, "amount_tax": 1424534716, "amount_total": 1117121693, "shipping_rate": null }, "shipping_options": [], "status": "open", "submit_type": null, "subscription": null, "success_url": "https://example.com/success", "total_details": { "amount_discount": 406046392, "amount_shipping": null, "amount_tax": 1424534716 }, "ui_mode": "hosted", "url": "https://checkout.stripe.com/pay/c/cs_test_a1YS1URlnyQCN5fUUduORoQ7Pw41PJqDWkIVQCpJPqkfIhd6tVY8XB1OLY", "adaptive_pricing": { "enabled": true }, "discounts": null, "collected_information": { "shipping_details": { "address": { "city": null, "country": null, "line1": null, "line2": null, "postal_code": null, "state": null }, "name": "name" } }, "permissions": { "update_shipping_details": null }, "wallet_options": {}, "origin_context": null }, "climate.order": { "amount_fees": 300, "amount_subtotal": 10000, "amount_total": 10300, "beneficiary": { "public_name": "Frontier Climate" }, "canceled_at": 1234567890, "cancellation_reason": null, "certificate": null, "confirmed_at": 1234567890, "created": 1234567890, "currency": "usd", "delayed_at": 1234567890, "delivered_at": 1234567890, "delivery_details": [], "expected_delivery_year": 2027, "id": "climorder_1Pgc73B7WZ01zgkWaebIwEZ7", "livemode": false, "metadata": {}, "metric_tons": "10", "object": "climate.order", "product": "climsku_frontier_offtake_portfolio_2027", "product_substituted_at": 1234567890, "status": "open" }, "climate.product": { "created": 1234567890, "current_prices_per_metric_ton": { "usd": { "amount_fees": 1650, "amount_subtotal": 55000, "amount_total": 56650 } }, "delivery_year": 2027, "id": "climsku_frontier_offtake_portfolio_2027", "livemode": false, "metric_tons_available": "1000000", "name": "Frontier's 2027 offtake portfolio", "object": "climate.product", "suppliers": [ { "id": "climsup_charm_industrial", "info_url": "https://frontierclimate.com/portfolio/charm-industrial", "livemode": false, "locations": [ { "city": "San Francisco", "country": "US", "latitude": 37.7480408, "longitude": -122.4057404, "region": "CA" } ], "name": "Charm Industrial", "object": "climate.supplier", "removal_pathway": "biomass_carbon_removal_and_storage" }, { "id": "climsup_heirloom", "info_url": "https://frontierclimate.com/portfolio/heirloom", "livemode": false, "locations": [ { "city": "Brisbane", "country": "US", "latitude": 37.686, "longitude": -122.403, "region": "CA" } ], "name": "Heirloom", "object": "climate.supplier", "removal_pathway": "direct_air_capture" }, { "id": "climsup_lithos", "info_url": "https://frontierclimate.com/portfolio/lithos", "livemode": false, "locations": [ { "city": "San Francisco", "country": "US", "latitude": 37.7749, "longitude": -122.4194, "region": "CA" } ], "name": "Lithos", "object": "climate.supplier", "removal_pathway": "enhanced_weathering" }, { "id": "climsup_vaulted", "info_url": "https://frontierclimate.com/portfolio/vaulted", "livemode": false, "locations": [ { "city": "Houston", "country": "US", "latitude": 29.7604, "longitude": -95.3698, "region": "TX" } ], "name": "Vaulted Deep", "object": "climate.supplier", "removal_pathway": "biomass_carbon_removal_and_storage" }, { "id": "climsup_carbon_capture_inc", "info_url": "https://frontierclimate.com/portfolio/carboncapture-inc", "livemode": false, "locations": [ { "city": "Los Angeles", "country": "US", "latitude": 34.0399975, "longitude": -118.2342512, "region": "CA" } ], "name": "CarbonCapture Inc.", "object": "climate.supplier", "removal_pathway": "direct_air_capture" } ] }, "climate.supplier": { "id": "climsup_charm_industrial", "info_url": "https://frontierclimate.com/portfolio/charm-industrial", "livemode": false, "locations": [ { "city": "San Francisco", "country": "US", "latitude": 37.7480408, "longitude": -122.4057404, "region": "CA" } ], "name": "Charm Industrial", "object": "climate.supplier", "removal_pathway": "biomass_carbon_removal_and_storage" }, "confirmation_token": { "created": 1234567890, "expires_at": 1234567890, "id": "ctoken_1Pgc73B7WZ01zgkWgFXpfTtv", "livemode": true, "mandate_data": { "customer_acceptance": { "online": { "ip_address": null, "user_agent": null }, "type": "type" } }, "object": "confirmation_token", "payment_intent": null, "payment_method_options": { "card": { "cvc_token": null } }, "payment_method_preview": { "allow_redisplay": "unspecified", "billing_details": { "address": { "city": "San Francisco", "country": "US", "line1": "1234 Fake Street", "line2": null, "postal_code": "94102", "state": "CA" }, "email": null, "name": "Jane Austen", "phone": null, "tax_id": null }, "customer": null, "type": "us_bank_account", "us_bank_account": { "account_holder_type": "company", "account_type": "checking", "bank_name": "STRIPE TEST BANK", "financial_connections_account": null, "fingerprint": "AuoSJ18zsVWV9SPc", "last4": "6789", "networks": { "preferred": "ach", "supported": [ "ach" ] }, "routing_number": "110000000", "status_details": {} } }, "return_url": "https://example.com/return", "setup_future_usage": "off_session", "setup_intent": null, "shipping": { "address": { "city": "San Francisco", "country": "US", "line1": "1234 Fake Street", "line2": null, "postal_code": "94102", "state": "CA" }, "name": "Jenny Rosen", "phone": null }, "use_stripe_sdk": true }, "country_spec": { "default_currency": "usd", "id": "US", "object": "country_spec", "supported_bank_account_currencies": { "usd": [ "US" ] }, "supported_payment_currencies": [ "...", "aed", "afn", "usd" ], "supported_payment_methods": [ "ach", "card", "stripe" ], "supported_transfer_countries": [ "AE", "AG", "AL", "AM", "AO", "AR", "AT", "AU", "AZ", "BA", "BD", "BE", "BG", "BH", "BJ", "BN", "BO", "BS", "BT", "BW", "CA", "CH", "CI", "CL", "CO", "CR", "CY", "CZ", "DE", "DK", "DO", "DZ", "EC", "EE", "EG", "ES", "ET", "FI", "FR", "GA", "GB", "GH", "GM", "GR", "GT", "GY", "HK", "HR", "HU", "ID", "IE", "IL", "IS", "IT", "JM", "JO", "JP", "KE", "KH", "KR", "KW", "KZ", "LA", "LC", "LI", "LK", "LT", "LU", "LV", "MA", "MC", "MD", "MG", "MK", "MN", "MO", "MT", "MU", "MX", "MY", "MZ", "NA", "NE", "NG", "NL", "NO", "NZ", "OM", "PA", "PE", "PH", "PK", "PL", "PT", "PY", "QA", "RO", "RS", "RW", "SA", "SE", "SG", "SI", "SK", "SM", "SN", "SV", "TH", "TN", "TR", "TT", "TW", "TZ", "US", "UY", "UZ", "VN", "ZA" ], "verification_fields": { "company": { "additional": [], "minimum": [ "business_profile.mcc", "business_profile.name", "business_profile.product_description", "business_profile.url", "business_type", "company.address.city", "company.address.line1", "company.address.postal_code", "company.address.state", "company.name", "company.owners_provided", "company.phone", "company.tax_id", "external_account", "owners.address.city", "owners.address.line1", "owners.address.postal_code", "owners.address.state", "owners.dob.day", "owners.dob.month", "owners.dob.year", "owners.email", "owners.first_name", "owners.last_name", "owners.phone", "representative.address.city", "representative.address.line1", "representative.address.postal_code", "representative.address.state", "representative.dob.day", "representative.dob.month", "representative.dob.year", "representative.email", "representative.first_name", "representative.id_number", "representative.last_name", "representative.phone", "representative.relationship.title", "representative.ssn_last_4", "representative.verification.document", "settings.card_payments.statement_descriptor_prefix", "settings.payments.statement_descriptor", "tos_acceptance.date", "tos_acceptance.ip" ] }, "individual": { "additional": [], "minimum": [ "business_profile.mcc", "business_profile.name", "business_profile.product_description", "business_profile.url", "business_type", "external_account", "individual.address.city", "individual.address.line1", "individual.address.postal_code", "individual.address.state", "individual.dob.day", "individual.dob.month", "individual.dob.year", "individual.email", "individual.first_name", "individual.id_number", "individual.last_name", "individual.phone", "individual.ssn_last_4", "individual.verification.document", "settings.card_payments.statement_descriptor_prefix", "settings.payments.statement_descriptor", "tos_acceptance.date", "tos_acceptance.ip" ] } } }, "coupon": { "amount_off": null, "created": 1234567890, "currency": "usd", "duration": "forever", "duration_in_months": 3, "id": "Z4OV52SU", "livemode": false, "max_redemptions": null, "metadata": {}, "name": "25.5% off", "object": "coupon", "percent_off": 25.5, "redeem_by": 1234567890, "times_redeemed": 0, "valid": true }, "credit_note": { "amount": 1690, "amount_shipping": 0, "created": 1234567890, "currency": "usd", "customer": "cus_QXg1o8vcGmoR32", "customer_balance_transaction": null, "discount_amount": 0, "discount_amounts": [], "effective_at": 1234567890, "id": "cn_1Pgc75B7WZ01zgkWJMPt5riP", "invoice": "in_1Pgc75B7WZ01zgkWYv4iMwt7", "lines": { "data": [ { "amount": 1190, "description": "My First Invoice Item (created for API docs)", "discount_amount": 0, "discount_amounts": [], "id": "cnli_1Pgc75B7WZ01zgkWla6u0GdZ", "invoice_line_item": "il_1Pgc74B7WZ01zgkWWh45tUBA", "livemode": false, "object": "credit_note_line_item", "quantity": 1, "tax_rates": [ { "active": true, "country": "DE", "created": 1721954066, "description": "VAT Germany", "display_name": "VAT", "effective_percentage": null, "id": "txr_1Pgc74B7WZ01zgkW94BlEhHU", "inclusive": false, "jurisdiction": "DE", "jurisdiction_level": null, "livemode": false, "metadata": {}, "object": "tax_rate", "percentage": 19, "state": null, "tax_type": "vat", "flat_amount": { "amount": 1413853096, "currency": "currency" }, "rate_type": null } ], "type": "invoice_line_item", "unit_amount": null, "unit_amount_decimal": null, "pretax_credit_amounts": [ { "amount": 1413853096, "type": "credit_balance_transaction" } ], "taxes": null }, { "amount": 500, "description": "Service credit", "discount_amount": 0, "discount_amounts": [], "id": "cnli_1Pgc75B7WZ01zgkW9m0EaOVh", "livemode": false, "object": "credit_note_line_item", "quantity": 1, "tax_rates": [], "type": "custom_line_item", "unit_amount": 500, "unit_amount_decimal": "500", "pretax_credit_amounts": [ { "amount": 1413853096, "type": "credit_balance_transaction" } ], "taxes": null } ], "has_more": false, "object": "list", "url": "/v1/credit_notes/cn_1Pgc75B7WZ01zgkWJMPt5riP/lines" }, "livemode": false, "memo": null, "metadata": {}, "number": "ABCD-1234-CN-01", "object": "credit_note", "out_of_band_amount": null, "pdf": "https://sangeekp-15t6ai--manage-mydev.dev.stripe.me/credit_notes/acct_1PgafTB7WZ01zgkW/cnst_123456789/pdf?s=ap", "shipping_cost": { "amount_subtotal": 1555417355, "amount_tax": 1424534716, "amount_total": 1117121693, "shipping_rate": null }, "status": "issued", "subtotal": 1690, "subtotal_excluding_tax": 1690, "total": 1690, "total_excluding_tax": null, "type": "pre_payment", "voided_at": 1234567890, "pretax_credit_amounts": [ { "amount": 1413853096, "type": "credit_balance_transaction" } ], "total_taxes": null, "refunds": [ { "amount_refunded": 1387154914, "refund": { "amount": 1413853096, "balance_transaction": null, "charge": null, "created": 1028554472, "currency": "currency", "id": "obj_123", "metadata": null, "object": "refund", "payment_intent": null, "reason": null, "receipt_number": null, "source_transfer_reversal": null, "status": null, "transfer_reversal": null } } ], "post_payment_amount": 1355257296, "pre_payment_amount": 251024947, "reason": null }, "credit_note_line_item": { "amount": 1000, "description": "My First Invoice Item (created for API docs)", "discount_amount": 0, "discount_amounts": [], "id": "cnli_1Pgc75B7WZ01zgkWPb1sOn7l", "invoice_line_item": "il_1Pgc75B7WZ01zgkWOwaRplc5", "livemode": false, "object": "credit_note_line_item", "quantity": 1, "tax_rates": [], "type": "invoice_line_item", "unit_amount": null, "unit_amount_decimal": null, "pretax_credit_amounts": [ { "amount": 1413853096, "type": "credit_balance_transaction" } ], "taxes": null }, "customer": { "address": { "city": null, "country": null, "line1": null, "line2": null, "postal_code": null, "state": null }, "balance": 0, "created": 1234567890, "currency": "usd", "default_source": null, "delinquent": false, "description": null, "discount": { "checkout_session": null, "coupon": { "amount_off": null, "created": 1028554472, "currency": null, "duration": "forever", "duration_in_months": null, "id": "obj_123", "livemode": true, "max_redemptions": null, "metadata": null, "name": null, "object": "coupon", "percent_off": null, "redeem_by": null, "times_redeemed": 990066668, "valid": true }, "customer": null, "end": null, "id": "obj_123", "invoice": null, "invoice_item": null, "object": "discount", "promotion_code": null, "start": 109757538, "subscription": null, "subscription_item": null }, "email": null, "id": "cus_QXg1o8vcGmoR32", "invoice_prefix": "7FE1103", "invoice_settings": { "custom_fields": null, "default_payment_method": null, "footer": null, "rendering_options": { "amount_tax_display": null, "template": null } }, "livemode": false, "metadata": {}, "name": null, "next_invoice_sequence": 1, "object": "customer", "phone": null, "preferred_locales": [], "shipping": {}, "tax_exempt": "none", "test_clock": null }, "customer_balance_transaction": { "amount": -500, "created": 1234567890, "credit_note": null, "currency": "usd", "customer": "cus_QXg1o8vcGmoR32", "description": null, "ending_balance": -500, "id": "cbtxn_1Pgc75B7WZ01zgkWgM0DfYYl", "invoice": null, "livemode": false, "metadata": null, "object": "customer_balance_transaction", "type": "adjustment", "checkout_session": null }, "customer_cash_balance_transaction": { "created": 1234567890, "currency": "eur", "customer": "cus_QXg1o8vcGmoR32", "ending_balance": 10000, "funded": { "bank_transfer": { "eu_bank_transfer": { "bic": "BANKDEAAXXX", "iban_last4": "7089", "sender_name": "Sample Business GmbH" }, "reference": "Payment for Invoice 7FE1103-155", "type": "eu_bank_transfer" } }, "id": "ccsbtxn_1Pgc75B7WZ01zgkWzdJj4ufI", "livemode": false, "net_amount": 5000, "object": "customer_cash_balance_transaction", "type": "funded" }, "customer_session": { "client_secret": "cuss_secret_QXhWeUEtZoDV8FHnNbPiBHmAkXKnqYLGMGq7LLf8ODSQ8gL", "components": { "buy_button": { "enabled": false }, "payment_element": { "enabled": false, "features": { "payment_method_allow_redisplay_filters": [ "unspecified" ], "payment_method_redisplay": "disabled", "payment_method_redisplay_limit": null, "payment_method_remove": "enabled", "payment_method_save": "disabled", "payment_method_save_usage": null } }, "pricing_table": { "enabled": true } }, "created": 1234567890, "customer": "cus_QXg1o8vcGmoR32", "expires_at": 1234567890, "livemode": false, "object": "customer_session" }, "deleted_account": { "deleted": true, "id": "acct_1PgafTB7WZ01zgkW", "object": "account" }, "deleted_apple_pay_domain": { "deleted": true, "id": "apwc_1Pgc6oB7WZ01zgkWHz71O4bz", "object": "apple_pay_domain" }, "deleted_coupon": { "deleted": true, "id": "Z4OV52SU", "object": "coupon" }, "deleted_customer": { "deleted": true, "id": "cus_QXg1o8vcGmoR32", "object": "customer" }, "deleted_discount": { "coupon": { "amount_off": null, "applies_to": { "products": [] }, "created": 0, "currency": null, "currency_options": {}, "duration": "forever", "duration_in_months": null, "id": "", "livemode": false, "max_redemptions": null, "metadata": null, "name": null, "object": "coupon", "percent_off": null, "redeem_by": null, "times_redeemed": 0, "valid": false }, "deleted": true, "id": "", "object": "discount", "start": 1234567890, "checkout_session": null, "customer": null, "invoice": null, "invoice_item": null, "promotion_code": null, "subscription": null, "subscription_item": null }, "deleted_external_account": { "deleted": true, "id": "ba_1PgagAB7WZ01zgkWr3DySp2Q", "object": "bank_account" }, "deleted_invoice": { "deleted": true, "id": "in_1Pgc6tB7WZ01zgkWu9fdqL6I", "object": "invoice" }, "deleted_invoiceitem": { "deleted": true, "id": "ii_1Pgc6sB7WZ01zgkWrG16hkdl", "object": "invoiceitem" }, "deleted_payment_source": { "deleted": true, "id": "ba_1PgagAB7WZ01zgkWr3DySp2Q", "object": "bank_account" }, "deleted_person": { "deleted": true, "id": "person_1Pgc6oB7WZ01zgkWnmLL70wS", "object": "person" }, "deleted_plan": { "deleted": true, "id": "price_1PgafmB7WZ01zgkW6dKueIc5", "object": "plan" }, "deleted_product": { "deleted": true, "id": "prod_QXg1hqf4jFNsqG", "object": "product" }, "deleted_product_feature": { "deleted": true, "id": "prodft_BcMBZUWCIOEgEc", "object": "product_feature" }, "deleted_radar.value_list": { "deleted": true, "id": "rsl_1Pgc6xB7WZ01zgkWMAqpozsZ", "object": "radar.value_list" }, "deleted_radar.value_list_item": { "deleted": true, "id": "rsli_1Pgc6xB7WZ01zgkWS2KbiAtC", "object": "radar.value_list_item" }, "deleted_subscription_item": { "deleted": true, "id": "si_QXhVBoJ7NQdNXh", "object": "subscription_item" }, "deleted_tax_id": { "deleted": true, "id": "txi_1Pgc6sB7WZ01zgkWXkvC78jZ", "object": "tax_id" }, "deleted_terminal.configuration": { "deleted": true, "id": "tmc_ElVUAjF8xXG3hj", "object": "terminal.configuration" }, "deleted_terminal.location": { "deleted": true, "id": "tml_j3hPESSh1Tie4LPWyRy8VLVY", "object": "terminal.location" }, "deleted_terminal.reader": { "deleted": true, "id": "tmr_iGOgDOlmFAot3zIp2JzEqXYs", "object": "terminal.reader" }, "deleted_test_helpers.test_clock": { "deleted": true, "id": "clock_1Pgc6yB7WZ01zgkWVlemIOED", "object": "test_helpers.test_clock" }, "deleted_webhook_endpoint": { "deleted": true, "id": "we_1Pgc6yB7WZ01zgkWzAudq4eU", "object": "webhook_endpoint" }, "discount": { "checkout_session": null, "coupon": { "amount_off": null, "created": 1721954050, "currency": "usd", "duration": "forever", "duration_in_months": 3, "id": "Z4OV52SU", "livemode": false, "max_redemptions": null, "metadata": {}, "name": "25.5% off", "object": "coupon", "percent_off": 25.5, "redeem_by": null, "times_redeemed": 0, "valid": true }, "customer": "cus_QXg1o8vcGmoR32", "end": 1234567890, "id": "di_1Pgc6rB7WZ01zgkW7Al8Fal9", "invoice": null, "invoice_item": null, "object": "discount", "promotion_code": null, "start": 1234567890, "subscription": null, "subscription_item": null }, "dispute": { "amount": 1000, "balance_transactions": [], "charge": "ch_1PgafuB7WZ01zgkWXYmPNZs8", "created": 1234567890, "currency": "usd", "evidence": { "access_activity_log": null, "billing_address": null, "cancellation_policy": null, "cancellation_policy_disclosure": null, "cancellation_rebuttal": null, "customer_communication": null, "customer_email_address": null, "customer_name": null, "customer_purchase_ip": null, "customer_signature": null, "duplicate_charge_documentation": null, "duplicate_charge_explanation": null, "duplicate_charge_id": null, "product_description": null, "receipt": null, "refund_policy": null, "refund_policy_disclosure": null, "refund_refusal_explanation": null, "service_date": null, "service_documentation": null, "shipping_address": null, "shipping_carrier": null, "shipping_date": null, "shipping_documentation": null, "shipping_tracking_number": null, "uncategorized_file": null, "uncategorized_text": null, "enhanced_evidence": {} }, "evidence_details": { "due_by": 1723679999, "has_evidence": false, "past_due": false, "submission_count": 0, "enhanced_eligibility": {} }, "id": "dp_1Pgc71B7WZ01zgkWMevJiAUx", "is_charge_refundable": true, "livemode": false, "metadata": {}, "object": "dispute", "payment_intent": null, "payment_method_details": { "card": { "brand": "visa", "case_type": "inquiry", "network_reason_code": "10.4" }, "type": "card" }, "reason": "general", "status": "warning_needs_response", "enhanced_eligibility_types": [ "visa_compelling_evidence_3" ] }, "entitlements.active_entitlement": { "feature": "feat_test_61QGU1MWyFMSP9YBZ41ClCIKljWvsTgu", "id": "ent_test_61QG5x2cU1GluFTYs41JqiESbLiX8C8O", "livemode": false, "lookup_key": "something", "object": "entitlements.active_entitlement" }, "entitlements.feature": { "active": true, "id": "feat_test_61QGU1MWyFMSP9YBZ41ClCIKljWvsTgu", "livemode": false, "lookup_key": "something", "metadata": {}, "name": "My super awesome feature", "object": "entitlements.feature" }, "ephemeral_key": { "created": 1234567890, "expires": 1234567890, "id": "ephkey_1Pgc6sB7WZ01zgkWtBC5cOXH", "livemode": false, "object": "ephemeral_key" }, "event": { "api_version": null, "created": 1234567890, "data": { "object": { "active": true, "aggregate_usage": null, "amount": 2000, "amount_decimal": "2000", "billing_scheme": "per_unit", "created": 1721948530, "currency": "usd", "id": "price_1PgafmB7WZ01zgkW6dKueIc5", "interval": "month", "interval_count": 1, "livemode": false, "metadata": {}, "meter": null, "nickname": null, "object": "plan", "product": "prod_QXg1hqf4jFNsqG", "tiers_mode": null, "transform_usage": null, "trial_period_days": null, "usage_type": "licensed" } }, "id": "evt_1Pgc76B7WZ01zgkWwyRHS12y", "livemode": false, "object": "event", "pending_webhooks": 0, "request": { "id": null, "idempotency_key": null }, "type": "plan.created" }, "exchange_rate": { "id": "rate_7573642d636164", "object": "exchange_rate", "rates": {} }, "external_account": { "account_holder_name": "Jane Austen", "account_holder_type": "company", "account_type": null, "bank_name": "STRIPE TEST BANK", "country": "US", "currency": "usd", "customer": null, "fingerprint": "AuoSJ18zsVWV9SPc", "id": "ba_1PgagAB7WZ01zgkWr3DySp2Q", "last4": "6789", "metadata": {}, "object": "bank_account", "routing_number": "110000000", "status": "new" }, "fee_refund": { "amount": 100, "balance_transaction": null, "created": 1234567890, "currency": "usd", "fee": "fee_1Pgc6zB7WZ01zgkWOMh2at1m", "id": "fr_1Pgc70B7WZ01zgkWSr1ANtFu", "metadata": {}, "object": "fee_refund" }, "file": { "created": 1234567890, "expires_at": 1234567890, "filename": "file_1Pgag2B7WZ01zgkWITx3dIQc", "id": "file_1Pgag2B7WZ01zgkWITx3dIQc", "links": { "data": [ { "created": 1721954068, "expired": false, "expires_at": null, "file": "file_1Pgag2B7WZ01zgkWITx3dIQc", "id": "link_1Pgc76B7WZ01zgkWPhd77i13", "livemode": false, "metadata": {}, "object": "file_link", "url": "https://sangeekp-15t6ai--upload-mydev.dev.stripe.me/links/MDB8YWNjdF8xUGdhZlRCN1daMDF6Z2tXfGZsX3Rlc3Rfb0Jkam9sNHdEZUpXRHUzSGhXNTRkZDI500qGiHOxxv" }, { "created": 1721950452, "expired": false, "expires_at": null, "file": "file_1Pgag2B7WZ01zgkWITx3dIQc", "id": "link_1PgbAmB7WZ01zgkW3pu4fR4P", "livemode": false, "metadata": {}, "object": "file_link", "url": "https://sangeekp-15t6ai--upload-mydev.dev.stripe.me/links/MDB8YWNjdF8xUGdhZlRCN1daMDF6Z2tXfGZsX3Rlc3RfWm9xd1F0dDBtbXQ4Z1dKNzlONGh1eWpB00LxTveMUm" }, { "created": 1721950452, "expired": false, "expires_at": null, "file": "file_1Pgag2B7WZ01zgkWITx3dIQc", "id": "link_1PgbAmB7WZ01zgkWwbZvcvQ8", "livemode": false, "metadata": {}, "object": "file_link", "url": "https://sangeekp-15t6ai--upload-mydev.dev.stripe.me/links/MDB8YWNjdF8xUGdhZlRCN1daMDF6Z2tXfGZsX3Rlc3RfSG53SzROQjd1eW5CalpJNWZXVTNCWkJP00ezD17LP8" }, { "created": 1721949627, "expired": false, "expires_at": null, "file": "file_1Pgag2B7WZ01zgkWITx3dIQc", "id": "link_1PgaxTB7WZ01zgkWjUTJLaVH", "livemode": false, "metadata": {}, "object": "file_link", "url": "https://sangeekp-15t6ai--upload-mydev.dev.stripe.me/links/MDB8YWNjdF8xUGdhZlRCN1daMDF6Z2tXfGZsX3Rlc3RfbUJMZHhvRlhBUjJ5Sk44RnNZdU5pc3JW00dVoJx2Tt" }, { "created": 1721949626, "expired": false, "expires_at": null, "file": "file_1Pgag2B7WZ01zgkWITx3dIQc", "id": "link_1PgaxSB7WZ01zgkWTnPuQ3DJ", "livemode": false, "metadata": {}, "object": "file_link", "url": "https://sangeekp-15t6ai--upload-mydev.dev.stripe.me/links/MDB8YWNjdF8xUGdhZlRCN1daMDF6Z2tXfGZsX3Rlc3RfN1NDVWF0ZXB5bUQxZDVOOU00UWRjMEJW00s1CyRs6z" }, { "created": 1721948546, "expired": false, "expires_at": null, "file": "file_1Pgag2B7WZ01zgkWITx3dIQc", "id": "link_1Pgag2B7WZ01zgkWT1SijPEZ", "livemode": false, "metadata": {}, "object": "file_link", "url": "https://sangeekp-15t6ai--upload-mydev.dev.stripe.me/links/MDB8YWNjdF8xUGdhZlRCN1daMDF6Z2tXfGZsX3Rlc3RfWFc0dDAzZVB6eExGV3kzMWpwaUFqZDlW0041cNM6yo" } ], "has_more": false, "object": "list", "url": "/v1/file_links?file=file_1Pgag2B7WZ01zgkWITx3dIQc" }, "object": "file", "purpose": "dispute_evidence", "size": 9863, "title": null, "type": "png", "url": "https://sangeekp-15t6ai--upload-mydev.dev.stripe.me/v1/files/file_1Pgag2B7WZ01zgkWITx3dIQc/contents" }, "file_link": { "created": 1234567890, "expired": false, "expires_at": 1234567890, "file": "file_1Pgag2B7WZ01zgkWITx3dIQc", "id": "link_1Pgc76B7WZ01zgkWPhd77i13", "livemode": false, "metadata": {}, "object": "file_link", "url": "https://sangeekp-15t6ai--upload-mydev.dev.stripe.me/links/MDB8YWNjdF8xUGdhZlRCN1daMDF6Z2tXfGZsX3Rlc3Rfb0Jkam9sNHdEZUpXRHUzSGhXNTRkZDI500qGiHOxxv" }, "financial_connections.account": { "account_holder": { "customer": "cus_QXg1o8vcGmoR32", "type": "customer" }, "balance": { "as_of": 93102340, "current": { "undefined": 1126940025 }, "type": "cash" }, "balance_refresh": { "last_attempted_at": 1981828143, "next_refresh_available_at": null, "status": "failed" }, "category": "cash", "created": 1234567890, "display_name": "Sample Checking Account", "id": "fca_1Pgc76B7WZ01zgkWqlYVCIub", "institution_name": "StripeBank", "last4": "6789", "livemode": false, "object": "financial_connections.account", "ownership": null, "ownership_refresh": { "last_attempted_at": 1981828143, "next_refresh_available_at": null, "status": "failed" }, "permissions": [], "status": "active", "subcategory": "checking", "subscriptions": [], "supported_payment_method_types": [ "us_bank_account" ], "transaction_refresh": { "id": "obj_123", "last_attempted_at": 1981828143, "next_refresh_available_at": null, "status": "failed" } }, "financial_connections.account_owner": { "email": "nobody+janesmith@stripe.com", "id": "fcaown_1Pgc76B7WZ01zgkWIQ4dVcgH", "name": "Jane Smith", "object": "financial_connections.account_owner", "ownership": "fcaowns_1Pgc76B7WZ01zgkWuEXUc7bG", "phone": "+1 555-555-5555", "raw_address": "123 Main Street, Everytown USA", "refreshed_at": 1234567890 }, "financial_connections.session": { "account_holder": { "customer": "cus_QXg1o8vcGmoR32", "type": "customer" }, "accounts": { "data": [], "has_more": false, "object": "list", "url": "/v1/financial_connections/accounts" }, "client_secret": "fcsess_..._secret_...", "id": "fcsess_1Pgc76B7WZ01zgkWnYmFk7mZ", "livemode": false, "object": "financial_connections.session", "permissions": [ "balances", "payment_method" ], "prefetch": [] }, "financial_connections.transaction": { "account": "fca_1Pgc76B7WZ01zgkWc69S5C3k", "amount": 300, "currency": "usd", "description": "Rocket Rides", "id": "fctxn_1Pgc76B7WZ01zgkW30ATGSKp", "livemode": false, "object": "financial_connections.transaction", "status": "posted", "status_transitions": { "posted_at": 1721954068, "void_at": null }, "transacted_at": 1234567890, "transaction_refresh": "fctxnref_QXhWc2Trdr6epyWGrcV9Qajf", "updated": 1234567890 }, "forwarding.request": { "created": 1234567890, "id": "fwdreq_123", "livemode": false, "object": "forwarding.request", "payment_method": "pm_456", "replacements": [], "request_context": { "destination_duration": 234, "destination_ip_address": "" }, "request_details": { "body": "'{\"amount\":{\"value\":1000,\"currency\":\"usd\"},\"paymentMethod\":{\"cvc\": \"***\",\"expiryMonth\": \"03\",\"expiryYear\": \"2030\",\"holderName\": \"First Last\",\"number\": \"************4242\",\"type\": \"scheme\",},\"merchantAccount\":\"{{MERCHANT_ID}}\",\"reference\":\"{{REFERENCE_ID}}\"}'", "headers": [ { "name": "Idempotency-Key", "value": "{{UPSTREAM_IDEMPOTENCY_KEY}}" } ], "http_method": "POST" }, "response_details": { "body": "'{\"transactionId\":\"example1234\"}'", "headers": [ { "name": "Content-Type", "value": "application/json;charset=UTF-8" }, { "name": "Idempotency-Key", "value": "{{UPSTREAM_IDEMPOTENCY_KEY}}" } ], "status": 200 }, "url": "https://endpoint-url/v1/payments" }, "funding_instructions": { "bank_transfer": { "country": "US", "financial_addresses": [ { "supported_networks": [ "ach", "domestic_wire_us" ], "type": "aba" } ], "type": "eu_bank_transfer" }, "currency": "usd", "funding_type": "bank_transfer", "livemode": false, "object": "funding_instructions" }, "identity.verification_report": { "client_reference_id": null, "created": 1234567890, "document": { "address": { "city": "San Francisco", "country": "US", "line1": "1234 Main St.", "state": "CA", "line2": null, "postal_code": null }, "error": { "code": null, "reason": null }, "expiration_date": { "day": 1, "month": 12, "year": 2025 }, "files": [ "file_QXhWG300bR0L1WbLXBqG1wQc", "file_QXhWi7GgxZg2M3XqN2Y0P4Q2" ], "first_name": "Jenny", "issued_date": { "day": 1, "month": 12, "year": 2020 }, "issuing_country": "US", "last_name": "Rosen", "status": "verified", "type": "driving_license" }, "id": "vr_1Pgc76B7WZ01zgkWq9Rp33Dj", "livemode": false, "object": "identity.verification_report", "options": { "document": {}, "id_number": {} }, "type": "document", "verification_session": "vs_1Pgc76B7WZ01zgkW1uXbT3Y9" }, "identity.verification_session": { "client_reference_id": null, "client_secret": null, "created": 1234567890, "id": "vs_1Pgc76B7WZ01zgkWBdQi8PTU", "last_error": { "code": null, "reason": null }, "last_verification_report": "vr_QXhW13B2hsHOm43JtUgs0f0w", "livemode": false, "metadata": {}, "object": "identity.verification_session", "options": { "document": { "require_matching_selfie": true } }, "redaction": { "status": "processing" }, "status": "verified", "type": "document", "url": null, "related_customer": null }, "invoice": { "account_country": "US", "account_name": null, "account_tax_ids": null, "amount_due": 1000, "amount_paid": 0, "amount_remaining": 1000, "amount_shipping": 0, "application": null, "attempt_count": 0, "attempted": false, "auto_advance": false, "automatic_tax": { "enabled": false, "liability": { "type": "account" }, "status": null, "disabled_reason": null, "provider": null }, "billing_reason": "manual", "collection_method": "charge_automatically", "created": 1234567890, "currency": "usd", "custom_fields": null, "customer": "cus_QXg1o8vcGmoR32", "customer_address": { "city": null, "country": null, "line1": null, "line2": null, "postal_code": null, "state": null }, "customer_email": null, "customer_name": null, "customer_phone": null, "customer_shipping": {}, "customer_tax_exempt": "none", "customer_tax_ids": [], "default_payment_method": null, "default_source": null, "default_tax_rates": [], "description": null, "discounts": [], "due_date": 1234567890, "effective_at": 1234567890, "ending_balance": null, "footer": null, "from_invoice": { "action": "action", "invoice": "invoice" }, "hosted_invoice_url": null, "id": "in_1Pgc6tB7WZ01zgkWu9fdqL6I", "invoice_pdf": null, "issuer": { "type": "self" }, "last_finalization_error": { "type": "idempotency_error" }, "latest_revision": null, "lines": { "data": [ { "amount": 1000, "currency": "usd", "description": "My First Invoice Item (created for API docs)", "discount_amounts": [], "discountable": true, "discounts": [], "id": "il_1Pgc6sB7WZ01zgkWFnxLrLCq", "invoice": "in_1Pgc6tB7WZ01zgkWu9fdqL6I", "livemode": false, "metadata": {}, "object": "line_item", "period": { "end": 1721954054, "start": 1721954054 }, "quantity": 1, "subscription": null, "pretax_credit_amounts": null, "taxes": null, "parent": { "invoice_item_details": { "invoice_item": "invoice_item", "proration": true, "proration_details": { "credited_items": { "invoice": "invoice", "invoice_line_items": [ "invoice_line_items" ] } }, "subscription": null }, "subscription_item_details": { "invoice_item": null, "proration": true, "proration_details": { "credited_items": { "invoice": "invoice", "invoice_line_items": [ "invoice_line_items" ] } }, "subscription": "subscription", "subscription_item": "subscription_item" }, "type": "invoice_item_details" }, "pricing": { "type": "price_details", "unit_amount_decimal": null } } ], "has_more": false, "object": "list", "url": "/v1/invoices/in_1Pgc6tB7WZ01zgkWu9fdqL6I/lines" }, "livemode": false, "metadata": {}, "next_payment_attempt": 1234567890, "number": null, "object": "invoice", "on_behalf_of": null, "payment_settings": { "default_mandate": null, "payment_method_options": { "acss_debit": {}, "bancontact": { "preferred_language": "fr" }, "card": { "request_three_d_secure": null }, "customer_balance": { "funding_type": null }, "konbini": {}, "sepa_debit": {}, "us_bank_account": {} }, "payment_method_types": null }, "period_end": 1234567890, "period_start": 1234567890, "post_payment_credit_notes_amount": 0, "pre_payment_credit_notes_amount": 0, "receipt_number": null, "rendering": { "amount_tax_display": null, "pdf": { "page_size": null }, "template": null, "template_version": null }, "shipping_cost": { "amount_subtotal": 1555417355, "amount_tax": 1424534716, "amount_total": 1117121693, "shipping_rate": null }, "shipping_details": {}, "starting_balance": 0, "statement_descriptor": null, "status": "draft", "status_transitions": { "finalized_at": null, "marked_uncollectible_at": null, "paid_at": null, "voided_at": null }, "subscription": null, "subtotal": 1000, "subtotal_excluding_tax": 1000, "test_clock": null, "total": 1000, "total_discount_amounts": [], "total_excluding_tax": 1000, "webhooks_delivered_at": 1234567890, "automatically_finalizes_at": null, "total_pretax_credit_amounts": null, "total_taxes": null, "amount_overpaid": 149300825, "parent": { "quote_details": { "quote": "quote" }, "subscription_details": { "metadata": null, "subscription": "subscription" }, "type": "quote_details" } }, "invoiceitem": { "amount": 1000, "currency": "usd", "customer": "cus_QXg1o8vcGmoR32", "date": 1234567890, "description": "My First Invoice Item (created for API docs)", "discountable": true, "discounts": [], "id": "ii_1Pgc6sB7WZ01zgkWrG16hkdl", "invoice": null, "livemode": false, "metadata": {}, "object": "invoiceitem", "period": { "end": 1721954054, "start": 1721954054 }, "proration": false, "quantity": 1, "tax_rates": [], "test_clock": null, "parent": { "subscription_details": { "subscription": "subscription" }, "type": "subscription_details" }, "pricing": { "type": "price_details", "unit_amount_decimal": null } }, "issuing.authorization": { "amount": 0, "amount_details": { "atm_fee": null, "cashback_amount": null }, "approved": true, "authorization_method": "keyed_in", "balance_transactions": [], "card": { "brand": "Visa", "cancellation_reason": null, "cardholder": { "billing": { "address": { "city": "Beverly Hills", "country": "US", "line1": "123 Fake St", "line2": "Apt 3", "postal_code": "90210", "state": "CA" } }, "company": { "tax_id_provided": true }, "created": 1721948548, "email": "jenny@example.com", "id": "ich_1Pgag4B7WZ01zgkWdPVfBngi", "individual": { "dob": { "day": null, "month": null, "year": null }, "first_name": null, "last_name": null, "verification": { "document": { "back": null, "front": null } } }, "livemode": false, "metadata": {}, "name": "Jenny Rosen", "object": "issuing.cardholder", "phone_number": "+18008675309", "preferred_locales": [ "en" ], "requirements": { "disabled_reason": null, "past_due": [] }, "spending_controls": { "allowed_categories": [], "allowed_merchant_countries": [], "blocked_categories": [], "blocked_merchant_countries": [], "spending_limits": [], "spending_limits_currency": null }, "status": "active", "type": "individual" }, "created": 1721948549, "currency": "usd", "exp_month": 8, "exp_year": 2025, "id": "ic_1Pgag5B7WZ01zgkWephORn8N", "last4": "4242", "livemode": false, "metadata": {}, "object": "issuing.card", "personalization_design": null, "replaced_by": null, "replacement_for": null, "replacement_reason": null, "shipping": { "address": { "city": null, "country": null, "line1": null, "line2": null, "postal_code": null, "state": null }, "address_validation": { "mode": "normalization_only", "normalized_address": { "city": null, "country": null, "line1": null, "line2": null, "postal_code": null, "state": null }, "result": null }, "carrier": null, "customs": { "eori_number": null }, "eta": null, "name": "name", "phone_number": null, "require_signature": null, "service": "express", "status": null, "tracking_number": null, "tracking_url": null, "type": "bulk" }, "spending_controls": { "allowed_categories": null, "allowed_merchant_countries": null, "blocked_categories": null, "blocked_merchant_countries": null, "spending_limits": [], "spending_limits_currency": null }, "status": "active", "type": "physical", "wallets": { "apple_pay": { "eligible": true, "ineligible_reason": null }, "google_pay": { "eligible": false, "ineligible_reason": "missing_agreement" }, "primary_account_identifier": null } }, "cardholder": null, "created": 1234567890, "currency": "usd", "fleet": { "cardholder_prompt_data": { "alphanumeric_id": null, "driver_id": null, "odometer": null, "unspecified_id": null, "user_id": null, "vehicle_number": null }, "purchase_type": null, "reported_breakdown": { "fuel": { "gross_amount_decimal": null }, "non_fuel": { "gross_amount_decimal": null }, "tax": { "local_amount_decimal": null, "national_amount_decimal": null } }, "service_type": null }, "fuel": { "industry_product_code": null, "quantity_decimal": null, "type": null, "unit": null, "unit_cost_decimal": null }, "id": "iauth_1Pgc77B7WZ01zgkWn0SmtHBY", "livemode": false, "merchant_amount": 0, "merchant_currency": "usd", "merchant_data": { "category": "taxicabs_limousines", "category_code": "4121", "city": "San Francisco", "country": "US", "name": "Rocket Rides", "network_id": "1234567890", "postal_code": "94107", "state": "CA", "terminal_id": null, "url": null, "tax_id": null }, "metadata": {}, "network_data": { "acquiring_institution_id": null, "system_trace_audit_number": null, "transaction_id": null }, "object": "issuing.authorization", "pending_request": { "amount": 700, "amount_details": { "atm_fee": null, "cashback_amount": null }, "currency": "usd", "is_amount_controllable": false, "merchant_amount": 700, "merchant_currency": "usd", "network_risk_score": null }, "request_history": [], "status": "pending", "token": null, "transactions": [], "verification_data": { "address_line1_check": "not_provided", "address_postal_code_check": "match", "authentication_exemption": { "claimed_by": "issuer", "type": "low_value_transaction" }, "cvc_check": "match", "expiry_check": "match", "postal_code": null, "three_d_secure": { "result": "authenticated" } }, "wallet": null, "verified_by_fraud_challenge": null }, "issuing.card": { "brand": "Visa", "cancellation_reason": null, "cardholder": { "billing": { "address": { "city": "Beverly Hills", "country": "US", "line1": "123 Fake St", "line2": "Apt 3", "postal_code": "90210", "state": "CA" } }, "company": { "tax_id_provided": true }, "created": 1721948548, "email": "jenny@example.com", "id": "ich_1Pgag4B7WZ01zgkWdPVfBngi", "individual": { "dob": { "day": null, "month": null, "year": null }, "first_name": null, "last_name": null, "verification": { "document": { "back": null, "front": null } } }, "livemode": false, "metadata": {}, "name": "Jenny Rosen", "object": "issuing.cardholder", "phone_number": "+18008675309", "preferred_locales": [ "en" ], "requirements": { "disabled_reason": null, "past_due": [] }, "spending_controls": { "allowed_categories": [], "allowed_merchant_countries": [], "blocked_categories": [], "blocked_merchant_countries": [], "spending_limits": [], "spending_limits_currency": null }, "status": "active", "type": "individual" }, "created": 1234567890, "currency": "usd", "exp_month": 8, "exp_year": 2025, "id": "ic_1Pgag5B7WZ01zgkWephORn8N", "last4": "4242", "livemode": false, "metadata": {}, "object": "issuing.card", "personalization_design": null, "replaced_by": null, "replacement_for": null, "replacement_reason": null, "shipping": { "address": { "city": null, "country": null, "line1": null, "line2": null, "postal_code": null, "state": null }, "address_validation": { "mode": "normalization_only", "normalized_address": { "city": null, "country": null, "line1": null, "line2": null, "postal_code": null, "state": null }, "result": null }, "carrier": null, "customs": { "eori_number": null }, "eta": null, "name": "name", "phone_number": null, "require_signature": null, "service": "express", "status": null, "tracking_number": null, "tracking_url": null, "type": "bulk" }, "spending_controls": { "allowed_categories": null, "allowed_merchant_countries": null, "blocked_categories": null, "blocked_merchant_countries": null, "spending_limits": [], "spending_limits_currency": null }, "status": "active", "type": "physical", "wallets": { "apple_pay": { "eligible": true, "ineligible_reason": null }, "google_pay": { "eligible": false, "ineligible_reason": "missing_agreement" }, "primary_account_identifier": null } }, "issuing.cardholder": { "billing": { "address": { "city": "Beverly Hills", "country": "US", "line1": "123 Fake St", "line2": "Apt 3", "postal_code": "90210", "state": "CA" } }, "company": { "tax_id_provided": true }, "created": 1234567890, "email": "jenny@example.com", "id": "ich_1Pgag4B7WZ01zgkWdPVfBngi", "individual": { "dob": { "day": null, "month": null, "year": null }, "first_name": null, "last_name": null, "verification": { "document": { "back": null, "front": null } } }, "livemode": false, "metadata": {}, "name": "Jenny Rosen", "object": "issuing.cardholder", "phone_number": "+18008675309", "preferred_locales": [ "en" ], "requirements": { "disabled_reason": null, "past_due": [] }, "spending_controls": { "allowed_categories": [], "allowed_merchant_countries": [], "blocked_categories": [], "blocked_merchant_countries": [], "spending_limits": [], "spending_limits_currency": null }, "status": "active", "type": "individual" }, "issuing.dispute": { "amount": 100, "created": 1234567890, "currency": "usd", "evidence": { "fraudulent": { "additional_documentation": null, "explanation": "Fraud; card reported lost on 07/26/2024" }, "reason": "fraudulent" }, "id": "idp_1Pgc77B7WZ01zgkWutW1sr3D", "livemode": false, "metadata": {}, "object": "issuing.dispute", "status": "unsubmitted", "transaction": "ipi_1Pgc77B7WZ01zgkWUr0uYdLL" }, "issuing.personalization_design": { "card_logo": null, "carrier_text": { "footer_body": null, "footer_title": null, "header_body": null, "header_title": null }, "created": 1234567890, "id": "ipcd_QXhWDHrd50Fhhi", "livemode": false, "lookup_key": "my_card_design_lookup_key", "metadata": {}, "name": "My Card Design V1", "object": "issuing.personalization_design", "physical_bundle": "ics_Fiiwz3T83opOUd", "preferences": { "is_default": false, "is_platform_default": null }, "rejection_reasons": { "card_logo": [], "carrier_text": [] }, "status": "review" }, "issuing.physical_bundle": { "features": { "card_logo": "unsupported", "carrier_text": "unsupported", "second_line": "unsupported" }, "id": "ics_QXhWOcsVbvCqqa", "livemode": false, "name": "My Card Bundle V1", "object": "issuing.physical_bundle", "status": "active", "type": "custom" }, "issuing.settlement": { "bin": "424242", "clearing_date": 1721954070, "created": 1234567890, "currency": "usd", "id": "ise_1Pgc78B7WZ01zgkWDzAbEGQM", "interchange_fees_amount": 44, "livemode": false, "metadata": {}, "net_total_amount": 3575, "network": "visa", "network_fees_amount": 37, "network_settlement_identifier": "1000633976", "object": "issuing.settlement", "settlement_service": "international", "transaction_count": 2, "transaction_amount": 3656, "status": "complete" }, "issuing.token": { "card": "ic_1Pgag5B7WZ01zgkWephORn8N", "created": 1234567890, "device_fingerprint": null, "id": "intok_1Pgc78B7WZ01zgkW7VstwAxg", "last4": "2424", "livemode": false, "network": "visa", "network_updated_at": 1234567890, "object": "issuing.token", "status": "active", "wallet_provider": "apple_pay" }, "issuing.transaction": { "amount": -100, "amount_details": { "atm_fee": null, "cashback_amount": null }, "authorization": "iauth_1Pgc78B7WZ01zgkW9IPKCfII", "balance_transaction": null, "card": "ic_1Pgag5B7WZ01zgkWephORn8N", "cardholder": "ich_1Pgag4B7WZ01zgkWdPVfBngi", "created": 1234567890, "currency": "usd", "dispute": null, "id": "ipi_1Pgc78B7WZ01zgkWm0QxtFzQ", "livemode": false, "merchant_amount": -100, "merchant_currency": "usd", "merchant_data": { "category": "taxicabs_limousines", "category_code": "4121", "city": "San Francisco", "country": "US", "name": "Rocket Rides", "network_id": "1234567890", "postal_code": "94107", "state": "CA", "terminal_id": null, "url": null, "tax_id": null }, "metadata": {}, "network_data": { "authorization_code": null, "processing_date": "2024-07-26", "transaction_id": null }, "object": "issuing.transaction", "token": null, "type": "capture", "wallet": "apple_pay" }, "item": { "amount_discount": 0, "amount_subtotal": 0, "amount_tax": 0, "amount_total": 0, "currency": "usd", "description": "T-shirt", "id": "li_1Pgc73B7WZ01zgkWx8kcmZPK", "object": "item", "price": { "active": true, "billing_scheme": "per_unit", "created": 1721948530, "currency": "usd", "custom_unit_amount": { "maximum": null, "minimum": null, "preset": null }, "id": "price_1PgafmB7WZ01zgkW02Hf9z6c", "livemode": false, "lookup_key": null, "metadata": {}, "nickname": null, "object": "price", "product": "prod_QXg1hqf4jFNsqG", "recurring": { "interval": "month", "interval_count": 797691627, "meter": null, "trial_period_days": null, "usage_type": "licensed" }, "tax_behavior": "unspecified", "tiers_mode": null, "transform_quantity": { "divide_by": 1592560163, "round": "down" }, "type": "one_time", "unit_amount": 1000, "unit_amount_decimal": "1000" }, "quantity": 1 }, "line_item": { "amount": 1000, "currency": "usd", "description": "My First Invoice Item (created for API docs)", "discount_amounts": [], "discountable": true, "discounts": [], "id": "il_tmp_1Pgc6sB7WZ01zgkWrG16hkdl", "invoice": "in_1Pgc6tB7WZ01zgkWu9fdqL6I", "livemode": false, "metadata": {}, "object": "line_item", "period": { "end": 1721954054, "start": 1721954054 }, "quantity": 1, "subscription": null, "pretax_credit_amounts": null, "taxes": null, "parent": { "invoice_item_details": { "invoice_item": "invoice_item", "proration": true, "proration_details": { "credited_items": { "invoice": "invoice", "invoice_line_items": [ "invoice_line_items" ] } }, "subscription": null }, "subscription_item_details": { "invoice_item": null, "proration": true, "proration_details": { "credited_items": { "invoice": "invoice", "invoice_line_items": [ "invoice_line_items" ] } }, "subscription": "subscription", "subscription_item": "subscription_item" }, "type": "invoice_item_details" }, "pricing": { "type": "price_details", "unit_amount_decimal": null } }, "login_link": { "created": 1234567890, "object": "login_link", "url": "https://sangeekp-15t6ai--manage-mydev.dev.stripe.me/express/acct_1PgafTB7WZ01zgkW/ehJImT2clfHr" }, "mandate": { "customer_acceptance": { "accepted_at": 123456789, "online": { "ip_address": "127.0.0.0", "user_agent": "device" }, "type": "online" }, "id": "mandate_1Pgc78B7WZ01zgkW9EfgTVki", "livemode": false, "multi_use": {}, "object": "mandate", "payment_method": "pm_123456789", "payment_method_details": { "sepa_debit": { "reference": "123456789", "url": "" }, "type": "sepa_debit" }, "status": "active", "type": "multi_use" }, "payment_intent": { "amount": 1099, "amount_capturable": 0, "amount_details": { "tip": {} }, "amount_received": 0, "application": null, "application_fee_amount": null, "automatic_payment_methods": { "enabled": true }, "canceled_at": 1234567890, "cancellation_reason": null, "capture_method": "automatic", "client_secret": "pi_1PgafyB7WZ01zgkWSjxsAJo3_secret_Dm43xiq1k0ywrRRjDoi8y1gkM", "confirmation_method": "automatic", "created": 1234567890, "currency": "usd", "customer": null, "description": null, "id": "pi_1PgafyB7WZ01zgkWSjxsAJo3", "last_payment_error": { "type": "idempotency_error" }, "latest_charge": null, "livemode": false, "metadata": {}, "next_action": { "type": "type" }, "object": "payment_intent", "on_behalf_of": null, "payment_method": null, "payment_method_configuration_details": { "id": "obj_123", "parent": null }, "payment_method_options": {}, "payment_method_types": [ "card" ], "processing": { "type": "card" }, "receipt_email": null, "review": null, "setup_future_usage": null, "shipping": {}, "statement_descriptor": null, "statement_descriptor_suffix": null, "status": "requires_payment_method", "transfer_data": { "destination": { "id": "obj_123", "object": "account" } }, "transfer_group": null, "source": null, "excluded_payment_method_types": null }, "payment_link": { "active": true, "after_completion": { "hosted_confirmation": { "custom_message": null }, "type": "hosted_confirmation" }, "allow_promotion_codes": false, "application": null, "application_fee_amount": null, "application_fee_percent": null, "automatic_tax": { "enabled": false, "liability": { "type": "account" } }, "billing_address_collection": "auto", "consent_collection": { "payment_method_reuse_agreement": { "position": "hidden" }, "promotions": null, "terms_of_service": null }, "currency": "usd", "custom_fields": [], "custom_text": { "after_submit": { "message": "message" }, "shipping_address": { "message": "message" }, "submit": { "message": "message" }, "terms_of_service_acceptance": { "message": "message" } }, "customer_creation": "if_required", "id": "plink_1Pgc78B7WZ01zgkWC75kX0jg", "inactive_message": null, "invoice_creation": { "enabled": true, "invoice_data": { "account_tax_ids": null, "custom_fields": null, "description": null, "footer": null, "issuer": { "type": "account" }, "metadata": null, "rendering_options": { "amount_tax_display": null, "template": null } } }, "livemode": false, "metadata": {}, "object": "payment_link", "on_behalf_of": null, "payment_intent_data": { "capture_method": null, "description": null, "metadata": { "undefined": "metadata" }, "setup_future_usage": null, "statement_descriptor": null, "statement_descriptor_suffix": null, "transfer_group": null }, "payment_method_collection": "if_required", "payment_method_types": null, "phone_number_collection": { "enabled": false }, "restrictions": { "completed_sessions": { "count": 94851343, "limit": 102976443 } }, "shipping_address_collection": { "allowed_countries": [ "SC" ] }, "shipping_options": [], "submit_type": "auto", "subscription_data": { "description": null, "invoice_settings": { "issuer": { "type": "account" } }, "metadata": { "undefined": "metadata" }, "trial_period_days": null, "trial_settings": { "end_behavior": { "missing_payment_method": "cancel" } } }, "tax_id_collection": { "enabled": false, "required": "never" }, "transfer_data": { "amount": null, "destination": { "id": "obj_123", "object": "account" } }, "url": "https://sangeekp-15t6ai--payment_links_ingress-mydev.dev.stripe.me/test_eVa16Q1Vd7yU1Ne8ww" }, "payment_method": { "allow_redisplay": "unspecified", "billing_details": { "address": { "city": "San Francisco", "country": "US", "line1": "1234 Fake Street", "line2": null, "postal_code": "94102", "state": "CA" }, "email": "jenny@example.com", "name": null, "phone": "+15555555555", "tax_id": null }, "card": { "brand": "visa", "checks": { "address_line1_check": null, "address_postal_code_check": null, "cvc_check": "pass" }, "country": "US", "display_brand": "visa", "exp_month": 8, "exp_year": 2025, "fingerprint": "AOB934RVNwzk6xtn", "funding": "credit", "generated_from": { "charge": null, "payment_method_details": { "type": "type" }, "setup_attempt": null }, "last4": "4242", "networks": { "available": [ "visa" ], "preferred": null }, "three_d_secure_usage": { "supported": true }, "wallet": { "dynamic_last4": null, "type": "link" }, "regulated_status": null }, "created": 1234567890, "customer": null, "id": "pm_1Pgc75B7WZ01zgkWlHVgdEGJ", "livemode": false, "metadata": { "order_id": "123456789" }, "object": "payment_method", "type": "card" }, "payment_method_configuration": { "acss_debit": { "available": false, "display_preference": { "overridable": null, "preference": "off", "value": "off" } }, "active": true, "affirm": { "available": false, "display_preference": { "overridable": null, "preference": "off", "value": "off" } }, "afterpay_clearpay": { "available": false, "display_preference": { "overridable": null, "preference": "off", "value": "off" } }, "alipay": { "available": false, "display_preference": { "overridable": null, "preference": "off", "value": "off" } }, "amazon_pay": { "available": false, "display_preference": { "overridable": null, "preference": "off", "value": "off" } }, "apple_pay": { "available": true, "display_preference": { "overridable": null, "preference": "on", "value": "on" } }, "application": null, "bacs_debit": { "available": false, "display_preference": { "overridable": null, "preference": "off", "value": "off" } }, "bancontact": { "available": false, "display_preference": { "overridable": null, "preference": "off", "value": "off" } }, "blik": { "available": false, "display_preference": { "overridable": null, "preference": "off", "value": "off" } }, "card": { "available": true, "display_preference": { "overridable": null, "preference": "on", "value": "on" } }, "cartes_bancaires": { "available": false, "display_preference": { "overridable": null, "preference": "off", "value": "off" } }, "cashapp": { "available": false, "display_preference": { "overridable": null, "preference": "off", "value": "off" } }, "customer_balance": { "available": false, "display_preference": { "overridable": null, "preference": "off", "value": "off" } }, "eps": { "available": false, "display_preference": { "overridable": null, "preference": "off", "value": "off" } }, "giropay": { "available": false, "display_preference": { "overridable": null, "preference": "off", "value": "off" } }, "google_pay": { "available": false, "display_preference": { "overridable": null, "preference": "off", "value": "off" } }, "id": "pmc_1Pgc79B7WZ01zgkWe1iPon1Q", "ideal": { "available": false, "display_preference": { "overridable": null, "preference": "off", "value": "off" } }, "is_default": true, "klarna": { "available": false, "display_preference": { "overridable": null, "preference": "off", "value": "off" } }, "link": { "available": false, "display_preference": { "overridable": null, "preference": "off", "value": "off" } }, "livemode": false, "multibanco": { "available": false, "display_preference": { "overridable": null, "preference": "off", "value": "off" } }, "name": "Default", "object": "payment_method_configuration", "p24": { "available": false, "display_preference": { "overridable": null, "preference": "off", "value": "off" } }, "parent": null, "sepa_debit": { "available": false, "display_preference": { "overridable": null, "preference": "off", "value": "off" } }, "sofort": { "available": false, "display_preference": { "overridable": null, "preference": "off", "value": "off" } }, "us_bank_account": { "available": false, "display_preference": { "overridable": null, "preference": "off", "value": "off" } }, "wechat_pay": { "available": false, "display_preference": { "overridable": null, "preference": "off", "value": "off" } }, "zip": { "available": false, "display_preference": { "overridable": null, "preference": "off", "value": "off" } } }, "payment_method_domain": { "apple_pay": { "status": "active" }, "created": 1234567890, "domain_name": "example.com", "enabled": true, "google_pay": { "status": "active" }, "id": "pmd_1Pgc79B7WZ01zgkWHKCqwAQo", "link": { "status": "active" }, "livemode": false, "object": "payment_method_domain", "paypal": { "status": "active" }, "amazon_pay": { "status": "active" }, "klarna": { "status": "active" } }, "payment_source": { "business_profile": { "annual_revenue": { "amount": null, "currency": null, "fiscal_year_end": null }, "estimated_worker_count": null, "mcc": null, "name": null, "product_description": null, "support_address": { "city": null, "country": null, "line1": null, "line2": null, "postal_code": null, "state": null }, "support_email": null, "support_phone": null, "support_url": null, "url": null, "minority_owned_business_designation": null }, "business_type": null, "capabilities": { "card_payments": "active", "transfers": "active" }, "charges_enabled": false, "controller": { "type": "account" }, "country": "US", "created": 1721948512, "default_currency": "usd", "details_submitted": false, "email": "site@stripe.com", "external_accounts": { "data": [], "has_more": false, "object": "list", "url": "/v1/accounts/acct_1PgafTB7WZ01zgkW/external_accounts" }, "future_requirements": { "alternatives": [], "current_deadline": null, "currently_due": [], "disabled_reason": null, "errors": [], "eventually_due": [], "past_due": [], "pending_verification": [] }, "id": "acct_1PgafTB7WZ01zgkW", "metadata": {}, "object": "account", "payouts_enabled": false, "requirements": { "alternatives": [], "current_deadline": null, "currently_due": [ "business_profile.product_description", "business_profile.support_phone", "business_profile.url", "external_account", "tos_acceptance.date", "tos_acceptance.ip" ], "disabled_reason": "requirements.past_due", "errors": [], "eventually_due": [ "business_profile.product_description", "business_profile.support_phone", "business_profile.url", "external_account", "tos_acceptance.date", "tos_acceptance.ip" ], "past_due": [], "pending_verification": [] }, "settings": { "bacs_debit_payments": { "display_name": null, "service_user_number": null }, "branding": { "icon": null, "logo": null, "primary_color": null, "secondary_color": null }, "card_issuing": { "tos_acceptance": { "date": null, "ip": null } }, "card_payments": { "decline_on": { "avs_failure": true, "cvc_failure": true }, "statement_descriptor_prefix": null, "statement_descriptor_prefix_kana": null, "statement_descriptor_prefix_kanji": null }, "dashboard": { "display_name": null, "timezone": "Etc/UTC" }, "invoices": { "default_account_tax_ids": null, "hosted_payment_method_save": null }, "payments": { "statement_descriptor": null, "statement_descriptor_kana": null, "statement_descriptor_kanji": null, "statement_descriptor_prefix_kana": null, "statement_descriptor_prefix_kanji": null }, "payouts": { "debit_negative_balances": true, "schedule": { "delay_days": 2, "interval": "daily" }, "statement_descriptor": null }, "sepa_debit_payments": {} }, "tos_acceptance": { "date": null, "ip": null, "user_agent": null }, "type": "standard" }, "payout": { "amount": 1100, "application_fee": null, "application_fee_amount": null, "arrival_date": 1234567890, "automatic": true, "balance_transaction": "txn_1PgaxNB7WZ01zgkWEV3TLf40", "created": 1234567890, "currency": "usd", "description": "STRIPE PAYOUT", "destination": "ba_1Pgc79B7WZ01zgkWoU5vBiXt", "failure_balance_transaction": null, "failure_code": null, "failure_message": null, "id": "po_1Pgc79B7WZ01zgkWu1KToYf4", "livemode": false, "metadata": {}, "method": "standard", "object": "payout", "original_payout": null, "reconciliation_status": "completed", "reversed_by": null, "source_type": "card", "statement_descriptor": null, "status": "in_transit", "type": "bank_account", "trace_id": { "status": "status", "value": null }, "payout_method": null }, "person": { "account": "acct_1PgafTB7WZ01zgkW", "additional_tos_acceptances": { "account": { "date": null, "ip": null, "user_agent": null } }, "created": 1234567890, "dob": { "day": null, "month": null, "year": null }, "first_name": null, "future_requirements": { "alternatives": [], "currently_due": [], "errors": [], "eventually_due": [], "past_due": [], "pending_verification": [] }, "id": "person_1Pgc6oB7WZ01zgkWnmLL70wS", "id_number_provided": false, "last_name": null, "metadata": {}, "object": "person", "relationship": { "director": false, "executive": false, "legal_guardian": false, "owner": false, "percent_ownership": null, "representative": false, "title": null, "authorizer": null }, "requirements": { "alternatives": [], "currently_due": [], "errors": [], "eventually_due": [], "past_due": [], "pending_verification": [] }, "ssn_last_4_provided": false, "verification": { "additional_document": { "back": null, "details": null, "details_code": null, "front": null }, "details": null, "details_code": null, "document": { "back": null, "details": null, "details_code": null, "front": null }, "status": "unverified" } }, "plan": { "active": true, "amount": 2000, "amount_decimal": "2000", "billing_scheme": "per_unit", "created": 1234567890, "currency": "usd", "id": "price_1PgafmB7WZ01zgkW6dKueIc5", "interval": "month", "interval_count": 1, "livemode": false, "metadata": {}, "meter": null, "nickname": null, "object": "plan", "product": "prod_QXg1hqf4jFNsqG", "tiers_mode": null, "transform_usage": { "divide_by": 1592560163, "round": "down" }, "trial_period_days": null, "usage_type": "licensed" }, "price": { "active": true, "billing_scheme": "per_unit", "created": 1234567890, "currency": "usd", "custom_unit_amount": { "maximum": null, "minimum": null, "preset": null }, "id": "price_1PgafmB7WZ01zgkW6dKueIc5", "livemode": false, "lookup_key": null, "metadata": {}, "nickname": null, "object": "price", "product": "prod_QXg1hqf4jFNsqG", "recurring": { "interval": "month", "interval_count": 1, "meter": null, "usage_type": "licensed", "trial_period_days": null }, "tax_behavior": "unspecified", "tiers_mode": null, "transform_quantity": { "divide_by": 1592560163, "round": "down" }, "type": "recurring", "unit_amount": 2000, "unit_amount_decimal": "2000" }, "product": { "active": true, "created": 1234567890, "default_price": "price_1PgafmB7WZ01zgkW02Hf9z6c", "description": "Comfortable gray cotton t-shirt", "id": "prod_QXg1hqf4jFNsqG", "images": [], "livemode": false, "marketing_features": [], "metadata": {}, "name": "T-shirt", "object": "product", "package_dimensions": { "height": 1221029593, "length": 1106363674, "weight": 791592328, "width": 113126854 }, "shippable": null, "statement_descriptor": null, "tax_code": null, "unit_label": null, "updated": 1234567890, "url": null, "type": "good" }, "product_feature": { "entitlement_feature": { "active": false, "id": "", "livemode": false, "lookup_key": "", "metadata": {}, "name": "", "object": "entitlements.feature" }, "id": "", "livemode": false, "object": "product_feature" }, "promotion_code": { "active": false, "code": "FALL20", "coupon": { "amount_off": null, "created": 1721954050, "currency": "usd", "duration": "forever", "duration_in_months": 3, "id": "Z4OV52SU", "livemode": false, "max_redemptions": null, "metadata": {}, "name": "25.5% off", "object": "coupon", "percent_off": 25.5, "redeem_by": null, "times_redeemed": 0, "valid": true }, "created": 1234567890, "customer": null, "expires_at": 1234567890, "id": "promo_1Pgc79B7WZ01zgkWNy4mn5NX", "livemode": false, "max_redemptions": null, "metadata": {}, "object": "promotion_code", "restrictions": { "first_time_transaction": false, "minimum_amount": null, "minimum_amount_currency": null }, "times_redeemed": 0 }, "quote": { "amount_subtotal": 0, "amount_total": 0, "application": null, "application_fee_amount": null, "application_fee_percent": null, "automatic_tax": { "enabled": false, "liability": { "type": "account" }, "status": null, "provider": null }, "collection_method": "charge_automatically", "computed": { "recurring": { "amount_subtotal": 1555417355, "amount_total": 1117121693, "interval": "month", "interval_count": 797691627, "total_details": { "amount_discount": 406046392, "amount_shipping": null, "amount_tax": 1424534716 } }, "upfront": { "amount_subtotal": 0, "amount_total": 0, "total_details": { "amount_discount": 0, "amount_shipping": 0, "amount_tax": 0 } } }, "created": 1234567890, "currency": "usd", "customer": "cus_QXg1o8vcGmoR32", "default_tax_rates": [], "description": null, "discounts": [], "expires_at": 1234567890, "footer": null, "from_quote": { "is_revision": true, "quote": "quote" }, "header": null, "id": "qt_1Pgc79B7WZ01zgkWHyj9Adwl", "invoice": null, "invoice_settings": { "days_until_due": null, "issuer": { "type": "self" } }, "livemode": false, "metadata": {}, "number": null, "object": "quote", "on_behalf_of": null, "status": "draft", "status_transitions": { "accepted_at": null, "canceled_at": null, "finalized_at": null }, "subscription": null, "subscription_data": { "description": null, "effective_date": null, "metadata": null, "trial_period_days": null, "billing_mode": { "type": "classic" } }, "subscription_schedule": null, "test_clock": null, "total_details": { "amount_discount": 0, "amount_shipping": 0, "amount_tax": 0 }, "transfer_data": { "amount": null, "amount_percent": null, "destination": { "id": "obj_123", "object": "account" } } }, "radar.early_fraud_warning": { "actionable": true, "charge": "ch_1234", "created": 1234567890, "fraud_type": "misc", "id": "issfr_1Pgc79B7WZ01zgkWxwDzEIPX", "livemode": false, "object": "radar.early_fraud_warning" }, "radar.value_list": { "alias": "custom_ip_blocklist", "created": 1234567890, "created_by": "jenny@example.com", "id": "rsl_1Pgc6xB7WZ01zgkWMAqpozsZ", "item_type": "ip_address", "list_items": { "data": [], "has_more": false, "object": "list", "url": "/v1/radar/value_list_items?value_list=rsl_1Pgc6xB7WZ01zgkWMAqpozsZ" }, "livemode": false, "metadata": {}, "name": "Custom IP Blocklist", "object": "radar.value_list" }, "radar.value_list_item": { "created": 1234567890, "created_by": "jenny@example.com", "id": "rsli_1Pgc6xB7WZ01zgkWS2KbiAtC", "livemode": false, "object": "radar.value_list_item", "value": "1.2.3.4", "value_list": "rsl_1Pgc6xB7WZ01zgkWGZtYN8iP" }, "refund": { "amount": 100, "balance_transaction": null, "charge": "ch_1PgafuB7WZ01zgkWXYmPNZs8", "created": 1234567890, "currency": "usd", "destination_details": { "card": { "type": "reversal" }, "type": "card" }, "id": "re_1Pgc72B7WZ01zgkWqPvrRrPE", "metadata": {}, "object": "refund", "payment_intent": null, "reason": null, "receipt_number": null, "source_transfer_reversal": null, "status": "succeeded", "transfer_reversal": null }, "reporting.report_run": { "created": 1234567890, "error": null, "id": "frr_1Pgc79B7WZ01zgkWMmsefTsj", "livemode": true, "object": "reporting.report_run", "parameters": { "interval_end": 1525132800, "interval_start": 1522540800 }, "report_type": "balance.summary.1", "result": { "created": 1028554472, "expires_at": null, "filename": null, "id": "obj_123", "object": "file", "purpose": "dispute_evidence", "size": 3530753, "title": null, "type": null, "url": null }, "status": "succeeded", "succeeded_at": 1234567890 }, "reporting.report_type": { "data_available_end": 1234567890, "data_available_start": 1234567890, "default_columns": [ "category", "currency", "description", "net_amount" ], "id": "balance.summary.1", "livemode": true, "name": "Balance summary", "object": "reporting.report_type", "updated": 1234567890, "version": 1 }, "review": { "billing_zip": null, "charge": "ch_1PgafuB7WZ01zgkWXYmPNZs8", "created": 1234567890, "id": "prv_1Pgc79B7WZ01zgkWT6khp5C3", "ip_address": null, "ip_address_location": { "city": null, "country": null, "latitude": null, "longitude": null, "region": null }, "livemode": false, "object": "review", "open": true, "opened_reason": "rule", "session": { "browser": null, "device": null, "platform": null, "version": null }, "closed_reason": null, "reason": "reason" }, "scheduled_query_run": { "created": 1234567890, "data_load_time": 1234567890, "file": { "created": 1721948551, "expires_at": null, "filename": "path", "id": "file_1Pgag7B7WZ01zgkWJbdoNCXR", "links": { "data": [], "has_more": false, "object": "list", "url": "/v1/file_links?file=file_1Pgag7B7WZ01zgkWJbdoNCXR" }, "object": "file", "purpose": "sigma_scheduled_query", "size": 500, "title": null, "type": "csv", "url": "https://sangeekp-15t6ai--upload-mydev.dev.stripe.me/v1/files/file_1Pgag7B7WZ01zgkWJbdoNCXR/contents" }, "id": "sqr_1Pgc7AB7WZ01zgkWvpIic1Di", "livemode": false, "object": "scheduled_query_run", "result_available_until": 1234567890, "sql": "SELECT count(*) from charges", "status": "completed", "title": "Count all charges" }, "setup_attempt": { "application": null, "created": 1234567890, "customer": null, "flow_directions": null, "id": "setatt_123456789012345678901234", "livemode": false, "object": "setup_attempt", "on_behalf_of": null, "payment_method": "card_1PgaftB7WZ01zgkWm3waTcFp", "payment_method_details": { "card": { "brand": null, "checks": { "address_line1_check": null, "address_postal_code_check": null, "cvc_check": null }, "country": null, "exp_month": null, "exp_year": null, "fingerprint": null, "funding": null, "last4": null, "network": null, "three_d_secure": { "authentication_flow": null, "electronic_commerce_indicator": null, "result": null, "result_reason": null, "transaction_id": null, "version": null }, "wallet": { "type": "apple_pay" } }, "type": "card" }, "setup_error": { "type": "idempotency_error" }, "setup_intent": "seti_1Pgag7B7WZ01zgkWSgwGdb8Z", "status": "succeeded", "usage": "off_session" }, "setup_intent": { "application": null, "automatic_payment_methods": { "enabled": null }, "cancellation_reason": null, "client_secret": "seti_1Pgag7B7WZ01zgkWSgwGdb8Z_secret_QXg2AQLdBxJwtY51IkwvUaBVsnCqPSp", "created": 1234567890, "customer": null, "description": null, "flow_directions": null, "id": "seti_1Pgag7B7WZ01zgkWSgwGdb8Z", "last_setup_error": { "type": "idempotency_error" }, "latest_attempt": null, "livemode": false, "mandate": null, "metadata": {}, "next_action": { "type": "type" }, "object": "setup_intent", "on_behalf_of": null, "payment_method": null, "payment_method_configuration_details": { "id": "obj_123", "parent": null }, "payment_method_options": {}, "payment_method_types": [ "card" ], "single_use_mandate": null, "status": "requires_payment_method", "usage": "off_session" }, "shipping_rate": { "active": true, "created": 1234567890, "delivery_estimate": { "maximum": { "unit": "month", "value": 111972721 }, "minimum": { "unit": "month", "value": 111972721 } }, "display_name": "Ground shipping", "fixed_amount": { "amount": 500, "currency": "usd" }, "id": "shr_1Pgc7AB7WZ01zgkWVPt4WhMx", "livemode": false, "metadata": {}, "object": "shipping_rate", "tax_behavior": "unspecified", "tax_code": null, "type": "fixed_amount" }, "source": { "ach_credit_transfer": { "account_number": "test_52796e3294dc", "bank_name": "TEST BANK", "fingerprint": "ecpwEzmBOSMOqQTL", "routing_number": "110000000", "swift_code": "TSTEZ122" }, "amount": null, "client_secret": "src_client_secret_XDGV5PcFpAfh4klG76nYn6gH", "created": 1234567890, "currency": "usd", "flow": "receiver", "id": "src_1Pgc75B7WZ01zgkWn9ogkWOr", "livemode": false, "metadata": {}, "object": "source", "owner": { "address": { "city": null, "country": null, "line1": null, "line2": null, "postal_code": null, "state": null }, "email": "jenny.rosen@example.com", "name": null, "phone": null, "verified_address": { "city": null, "country": null, "line1": null, "line2": null, "postal_code": null, "state": null }, "verified_email": null, "verified_name": null, "verified_phone": null }, "receiver": { "address": "121042882-38381234567890123", "amount_charged": 0, "amount_received": 0, "amount_returned": 0, "refund_attributes_method": "email", "refund_attributes_status": "missing" }, "statement_descriptor": null, "status": "pending", "type": "ach_credit_transfer", "usage": "reusable", "allow_redisplay": null }, "source_mandate_notification": { "amount": 2000, "created": 1234567890, "id": "srcmn_1Pgc7AB7WZ01zgkWIEWL0NKr", "livemode": false, "object": "source_mandate_notification", "reason": "debit_initiated", "sepa_debit": { "creditor_identifier": "TEST42ZZZ0000424242", "last4": "3000", "mandate_reference": "FFU45BAKH9LWLMM0" }, "source": { "ach_credit_transfer": { "account_number": "test_52796e3294dc", "bank_name": "TEST BANK", "fingerprint": "ecpwEzmBOSMOqQTL", "routing_number": "110000000", "swift_code": "TSTEZ122" }, "amount": null, "client_secret": "src_client_secret_3BIouoWKhSribnapj676FM92", "created": 1721954072, "currency": "usd", "flow": "receiver", "id": "src_1Pgc7AB7WZ01zgkWsB6KK8DI", "livemode": false, "metadata": {}, "object": "source", "owner": { "address": { "city": null, "country": null, "line1": null, "line2": null, "postal_code": null, "state": null }, "email": "jenny.rosen@example.com", "name": null, "phone": null, "verified_address": { "city": null, "country": null, "line1": null, "line2": null, "postal_code": null, "state": null }, "verified_email": null, "verified_name": null, "verified_phone": null }, "receiver": { "address": "121042882-38381234567890123", "amount_charged": 0, "amount_received": 0, "amount_returned": 0, "refund_attributes_method": "email", "refund_attributes_status": "missing" }, "statement_descriptor": null, "status": "pending", "type": "ach_credit_transfer", "usage": "reusable", "allow_redisplay": null }, "status": "submitted", "type": "sepa_debit" }, "source_transaction": { "ach_credit_transfer": {}, "amount": 500, "created": 1234567890, "currency": "usd", "id": "srctxn_1Pgc7AB7WZ01zgkWGYBLSgYV", "livemode": false, "object": "source_transaction", "source": "src_1Pgc75B7WZ01zgkWn9ogkWOr", "status": "succeeded", "type": "ach_credit_transfer" }, "subscription": { "application": null, "application_fee_percent": null, "automatic_tax": { "enabled": false, "liability": { "type": "account" }, "disabled_reason": null }, "billing_cycle_anchor": 1234567890, "billing_cycle_anchor_config": { "day_of_month": 1361669285, "hour": null, "minute": null, "month": null, "second": null }, "cancel_at": 1234567890, "canceled_at": 1234567890, "cancellation_details": { "comment": null, "feedback": null, "reason": null }, "collection_method": "charge_automatically", "created": 1234567890, "currency": "usd", "customer": "cus_QXg1o8vcGmoR32", "days_until_due": null, "default_payment_method": null, "default_source": null, "default_tax_rates": [], "description": null, "discounts": [], "ended_at": 1234567890, "id": "sub_1Pgc6rB7WZ01zgkWNy0Cn5nw", "invoice_settings": { "account_tax_ids": null, "issuer": { "type": "self" } }, "items": { "data": [ { "created": 1721954054, "discounts": [], "id": "si_QXhVnC2h0Jczwc", "metadata": {}, "object": "subscription_item", "price": { "active": true, "billing_scheme": "per_unit", "created": 1721948530, "currency": "usd", "custom_unit_amount": { "maximum": null, "minimum": null, "preset": null }, "id": "price_1PgafmB7WZ01zgkW6dKueIc5", "livemode": false, "lookup_key": null, "metadata": {}, "nickname": null, "object": "price", "product": "prod_QXg1hqf4jFNsqG", "recurring": { "interval": "month", "interval_count": 1, "meter": null, "usage_type": "licensed", "trial_period_days": null }, "tax_behavior": "unspecified", "tiers_mode": null, "transform_quantity": { "divide_by": 1592560163, "round": "down" }, "type": "recurring", "unit_amount": 2000, "unit_amount_decimal": "2000" }, "quantity": 1, "subscription": "sub_1Pgc6rB7WZ01zgkWNy0Cn5nw", "tax_rates": [], "plan": { "active": true, "amount": null, "amount_decimal": null, "billing_scheme": "tiered", "created": 1028554472, "currency": "currency", "id": "obj_123", "interval": "month", "interval_count": 797691627, "livemode": true, "metadata": null, "meter": null, "nickname": null, "object": "plan", "product": null, "tiers_mode": null, "transform_usage": { "divide_by": 1592560163, "round": "down" }, "trial_period_days": null, "usage_type": "licensed" }, "current_period_end": 976287773, "current_period_start": 1896570518, "billing_thresholds": { "usage_gte": null } } ], "has_more": false, "object": "list", "url": "/v1/subscription_items?subscription=sub_1Pgc6rB7WZ01zgkWNy0Cn5nw" }, "latest_invoice": null, "livemode": false, "metadata": {}, "next_pending_invoice_item_invoice": 1234567890, "object": "subscription", "on_behalf_of": null, "pause_collection": { "behavior": "mark_uncollectible", "resumes_at": null }, "payment_settings": { "payment_method_options": { "acss_debit": {}, "bancontact": { "preferred_language": "fr" }, "card": { "network": null, "request_three_d_secure": null }, "customer_balance": { "funding_type": null }, "konbini": {}, "sepa_debit": {}, "us_bank_account": {} }, "payment_method_types": null, "save_default_payment_method": null }, "pending_invoice_item_interval": { "interval": "month", "interval_count": 797691627 }, "pending_setup_intent": null, "pending_update": { "billing_cycle_anchor": null, "expires_at": 833811170, "subscription_items": null, "trial_end": null, "trial_from_plan": null }, "schedule": null, "start_date": 1234567890, "status": "active", "test_clock": null, "transfer_data": { "amount_percent": null, "destination": { "id": "obj_123", "object": "account" } }, "trial_end": 1234567890, "trial_settings": { "end_behavior": { "missing_payment_method": "create_invoice" } }, "trial_start": 1234567890, "cancel_at_period_end": true, "billing_thresholds": { "amount_gte": null, "reset_billing_cycle_anchor": null }, "billing_mode": { "type": "classic" } }, "subscription_item": { "created": 1721954060, "discounts": [], "id": "si_QXhVBoJ7NQdNXh", "metadata": {}, "object": "subscription_item", "price": { "active": true, "billing_scheme": "per_unit", "created": 1721948530, "currency": "usd", "custom_unit_amount": { "maximum": null, "minimum": null, "preset": null }, "id": "price_1PgafmB7WZ01zgkW6dKueIc5", "livemode": false, "lookup_key": null, "metadata": {}, "nickname": null, "object": "price", "product": "prod_QXg1hqf4jFNsqG", "recurring": { "interval": "month", "interval_count": 1, "meter": null, "usage_type": "licensed", "trial_period_days": null }, "tax_behavior": "unspecified", "tiers_mode": null, "transform_quantity": { "divide_by": 1592560163, "round": "down" }, "type": "recurring", "unit_amount": 2000, "unit_amount_decimal": "2000" }, "quantity": 1, "subscription": "sub_1Pgc6xB7WZ01zgkWJMvZp5ja", "tax_rates": [], "plan": { "active": true, "amount": null, "amount_decimal": null, "billing_scheme": "tiered", "created": 1028554472, "currency": "currency", "id": "obj_123", "interval": "month", "interval_count": 797691627, "livemode": true, "metadata": null, "meter": null, "nickname": null, "object": "plan", "product": null, "tiers_mode": null, "transform_usage": { "divide_by": 1592560163, "round": "down" }, "trial_period_days": null, "usage_type": "licensed" }, "current_period_end": 976287773, "current_period_start": 1896570518, "billing_thresholds": { "usage_gte": null } }, "subscription_schedule": { "application": null, "canceled_at": 1234567890, "completed_at": 1234567890, "created": 1234567890, "current_phase": { "end_date": 1725067410, "start_date": 1573629589 }, "customer": "cus_QXg1o8vcGmoR32", "default_settings": { "application_fee_percent": null, "automatic_tax": { "enabled": false, "liability": { "type": "account" }, "disabled_reason": null }, "billing_cycle_anchor": "automatic", "collection_method": "charge_automatically", "default_payment_method": null, "description": null, "invoice_settings": { "account_tax_ids": null, "days_until_due": null, "issuer": { "type": "self" } }, "on_behalf_of": null, "transfer_data": { "amount_percent": null, "destination": { "id": "obj_123", "object": "account" } }, "billing_thresholds": { "amount_gte": null, "reset_billing_cycle_anchor": null } }, "end_behavior": "release", "id": "sub_sched_1Pgc7AB7WZ01zgkWaeHcsbnC", "livemode": false, "metadata": {}, "object": "subscription_schedule", "phases": [ { "add_invoice_items": [], "application_fee_percent": null, "billing_cycle_anchor": null, "collection_method": null, "currency": "usd", "default_payment_method": null, "default_tax_rates": [], "description": null, "discounts": [], "end_date": 1754008472, "invoice_settings": { "account_tax_ids": null, "days_until_due": null, "issuer": { "type": "account" } }, "items": [ { "discounts": [], "metadata": {}, "price": "price_1PgafmB7WZ01zgkW6dKueIc5", "quantity": 1, "tax_rates": [], "plan": { "active": true, "amount": null, "amount_decimal": null, "billing_scheme": "tiered", "created": 1028554472, "currency": "currency", "id": "obj_123", "interval": "month", "interval_count": 797691627, "livemode": true, "metadata": null, "meter": null, "nickname": null, "object": "plan", "product": null, "tiers_mode": null, "transform_usage": { "divide_by": 1592560163, "round": "down" }, "trial_period_days": null, "usage_type": "licensed" }, "billing_thresholds": { "usage_gte": null } } ], "metadata": {}, "on_behalf_of": null, "proration_behavior": "create_prorations", "start_date": 1722558872, "transfer_data": { "amount_percent": null, "destination": { "id": "obj_123", "object": "account" } }, "trial_end": null, "billing_thresholds": { "amount_gte": null, "reset_billing_cycle_anchor": null } } ], "released_at": 1234567890, "released_subscription": null, "status": "not_started", "subscription": null, "test_clock": null, "billing_mode": { "type": "classic" } }, "tax.calculation": { "amount_total": 1947, "currency": "usd", "customer": null, "customer_details": { "address": { "city": "South San Francisco", "country": "US", "line1": "354 Oyster Point Blvd", "line2": "", "postal_code": "94080", "state": "CA" }, "address_source": "shipping", "ip_address": null, "tax_ids": [], "taxability_override": "none" }, "expires_at": 1234567890, "id": "taxcalc_1Pgc7HB7WZ01zgkW0snEQbxy", "livemode": false, "object": "tax.calculation", "ship_from_details": { "address": { "city": null, "country": "US", "line1": null, "line2": null, "postal_code": "75001", "state": "TX" } }, "shipping_cost": { "amount": 300, "amount_tax": 0, "tax_behavior": "exclusive", "tax_code": "txcd_92010001" }, "tax_amount_exclusive": 148, "tax_amount_inclusive": 0, "tax_breakdown": [ { "amount": 148, "inclusive": false, "tax_rate_details": { "country": "US", "percentage_decimal": "9.875", "state": "CA", "tax_type": "sales_tax", "flat_amount": { "amount": 1413853096, "currency": "currency" }, "rate_type": null }, "taxability_reason": "standard_rated", "taxable_amount": 1499 }, { "amount": 0, "inclusive": false, "tax_rate_details": { "country": "US", "percentage_decimal": "0.0", "state": "CA", "tax_type": "sales_tax", "flat_amount": { "amount": 1413853096, "currency": "currency" }, "rate_type": null }, "taxability_reason": "product_exempt", "taxable_amount": 0 } ], "tax_date": 1234567890 }, "tax.calculation_line_item": { "amount": 1499, "amount_tax": 148, "id": "tax_li_QXhWXb3MbhgP1Q", "livemode": false, "object": "tax.calculation_line_item", "product": null, "quantity": 1, "reference": "Pepperoni Pizza", "tax_behavior": "exclusive", "tax_code": "txcd_40060003", "metadata": null }, "tax.registration": { "active_from": 1234567890, "country": "US", "country_options": { "us": { "state": "CA", "type": "state_sales_tax" } }, "created": 1234567890, "expires_at": 1234567890, "id": "taxreg_QXhWPxHxRGhVsh", "livemode": false, "object": "tax.registration", "status": "active" }, "tax.settings": { "defaults": { "tax_behavior": null, "tax_code": "txcd_10000000" }, "head_office": { "address": { "city": null, "country": "US", "line1": null, "line2": null, "postal_code": null, "state": "CA" } }, "livemode": false, "object": "tax.settings", "status": "active", "status_details": { "active": {} } }, "tax.transaction": { "created": 1234567890, "currency": "usd", "customer": null, "customer_details": { "address": { "city": "South San Francisco", "country": "US", "line1": "354 Oyster Point Blvd", "line2": "", "postal_code": "94080", "state": "CA" }, "address_source": "shipping", "ip_address": null, "tax_ids": [], "taxability_override": "none" }, "id": "tax_1Pgc7AB7WZ01zgkW5XONRnmb", "line_items": { "data": [ { "amount": 1499, "amount_tax": 148, "id": "tax_li_QXhWXb3MbhgP1Q", "livemode": false, "metadata": null, "object": "tax.transaction_line_item", "product": null, "quantity": 1, "reference": "Pepperoni Pizza", "reversal": { "original_line_item": "original_line_item" }, "tax_behavior": "exclusive", "tax_code": "txcd_40060003", "type": "transaction" } ], "has_more": false, "object": "list", "url": "/v1/tax/transactions/tax_1Pgc7AB7WZ01zgkW5XONRnmb/line_items" }, "livemode": false, "metadata": null, "object": "tax.transaction", "posted_at": 1234567890, "reference": "myOrder_123", "reversal": { "original_transaction": null }, "ship_from_details": { "address": { "city": null, "country": "US", "line1": null, "line2": null, "postal_code": "75001", "state": "TX" } }, "shipping_cost": { "amount": 300, "amount_tax": 0, "tax_behavior": "exclusive", "tax_code": "txcd_92010001" }, "tax_date": 1234567890, "type": "transaction" }, "tax.transaction_line_item": { "amount": 1499, "amount_tax": 148, "id": "tax_li_QXhWXb3MbhgP1Q", "livemode": false, "metadata": null, "object": "tax.transaction_line_item", "product": null, "quantity": 1, "reference": "Pepperoni Pizza", "reversal": { "original_line_item": "original_line_item" }, "tax_behavior": "exclusive", "tax_code": "txcd_40060003", "type": "transaction" }, "tax_code": { "description": "A physical good that can be moved or touched. Also known as tangible personal property.", "id": "txcd_99999999", "name": "General - Tangible Goods", "object": "tax_code" }, "tax_id": { "country": "DE", "created": 1234567890, "customer": "cus_QXg1o8vcGmoR32", "id": "txi_1Pgc6sB7WZ01zgkWXkvC78jZ", "livemode": false, "object": "tax_id", "owner": { "customer": "cus_QXg1o8vcGmoR32", "type": "customer" }, "type": "eu_vat", "value": "DE123456789", "verification": { "status": "pending", "verified_address": null, "verified_name": null } }, "tax_rate": { "active": true, "country": "DE", "created": 1234567890, "description": "VAT Germany", "display_name": "VAT", "effective_percentage": null, "id": "txr_1Pgc7BB7WZ01zgkW4Iwwvf6z", "inclusive": false, "jurisdiction": "DE", "jurisdiction_level": null, "livemode": false, "metadata": {}, "object": "tax_rate", "percentage": 19, "state": null, "tax_type": "vat", "flat_amount": { "amount": 1413853096, "currency": "currency" }, "rate_type": null }, "terminal.configuration": { "bbpos_wisepos_e": { "splashscreen": "file_1Pgc6yB7WZ01zgkWSsAMx1We" }, "id": "tmc_ElVUAjF8xXG3hj", "is_account_default": false, "livemode": false, "name": null, "object": "terminal.configuration" }, "terminal.connection_token": { "object": "terminal.connection_token", "secret": "pst_test_iPPfmBn7kZ0gIJ4xpehqTnC" }, "terminal.location": { "address": { "city": "San Francisco", "country": "US", "line1": "1234 Fake Street", "line2": null, "postal_code": "94102", "state": "CA" }, "display_name": "My First Store", "id": "tml_j3hPESSh1Tie4LPWyRy8VLVY", "livemode": false, "metadata": {}, "object": "terminal.location" }, "terminal.reader": { "action": { "failure_code": null, "failure_message": null, "status": "failed", "type": "refund_payment" }, "device_sw_version": null, "device_type": "bbpos_wisepos_e", "id": "tmr_iGOgDOlmFAot3zIp2JzEqXYs", "ip_address": "192.168.2.2", "label": "Blue Rabbit", "livemode": false, "location": null, "metadata": {}, "object": "terminal.reader", "serial_number": "123-456-789", "status": "online" }, "test_helpers.test_clock": { "created": 1234567890, "deletes_after": 1234567890, "frozen_time": 1234567890, "id": "clock_1Pgc6yB7WZ01zgkWVlemIOED", "livemode": false, "name": null, "object": "test_helpers.test_clock", "status": "ready", "status_details": {} }, "token": { "card": { "address_city": null, "address_country": null, "address_line1": null, "address_line1_check": null, "address_line2": null, "address_state": null, "address_zip": null, "address_zip_check": null, "brand": "Visa", "country": "US", "cvc_check": "pass", "dynamic_last4": null, "exp_month": 8, "exp_year": 2025, "fingerprint": "AOB934RVNwzk6xtn", "funding": "credit", "id": "card_1Pgc7BB7WZ01zgkWeZoy4YdD", "last4": "4242", "metadata": {}, "name": null, "networks": { "preferred": null }, "object": "card", "tokenization_method": null, "regulated_status": null }, "client_ip": null, "created": 1234567890, "id": "tok_1Pgc7BB7WZ01zgkWptnajzKJ", "livemode": false, "object": "token", "type": "card", "used": false }, "topup": { "amount": 1000, "balance_transaction": null, "created": 1234567890, "currency": "usd", "description": "Top-up description", "expected_availability_date": 123456789, "failure_code": null, "failure_message": null, "id": "tu_1Pgc7BB7WZ01zgkWwH7rkBgR", "livemode": false, "metadata": { "order_id": "12345678" }, "object": "topup", "source": { "ach_debit": { "bank_name": "STRIPE TEST BANK", "country": "US", "fingerprint": "5Wh4KBcfDrz5IOnx", "last4": "6789", "routing_number": "110000000", "type": "individual" }, "amount": null, "client_secret": "src_client_secret_9HxmifVKxP2LNNRRod7Q23HM", "created": 1721954073, "currency": "usd", "flow": "code_verification", "id": "src_1Pgc7BB7WZ01zgkWXWC57xAu", "livemode": false, "metadata": {}, "object": "source", "owner": { "address": { "city": null, "country": null, "line1": null, "line2": null, "postal_code": null, "state": null }, "email": "jenny.rosen@example.com", "name": "Jenny Rosen", "phone": null, "verified_address": { "city": null, "country": null, "line1": null, "line2": null, "postal_code": null, "state": null }, "verified_email": null, "verified_name": null, "verified_phone": null }, "statement_descriptor": null, "status": "pending", "type": "ach_debit", "usage": "reusable", "allow_redisplay": null }, "statement_descriptor": null, "status": "pending", "transfer_group": null }, "transfer": { "amount": 1100, "amount_reversed": 0, "balance_transaction": "txn_1PgaxNB7WZ01zgkWEV3TLf40", "created": 1234567890, "currency": "usd", "description": null, "destination": "acct_1PgafTB7WZ01zgkW", "destination_payment": "py_QXhWZR8SdWquhf", "id": "tr_1Pgc7BB7WZ01zgkWVJfE40RX", "livemode": false, "metadata": {}, "object": "transfer", "reversals": { "data": [], "has_more": false, "object": "list", "url": "/v1/transfers/tr_1Pgc7BB7WZ01zgkWVJfE40RX/reversals" }, "reversed": false, "source_transaction": null, "source_type": "card", "transfer_group": null }, "transfer_reversal": { "amount": 1100, "balance_transaction": null, "created": 1234567890, "currency": "usd", "destination_payment_refund": null, "id": "trr_1Pgc7BB7WZ01zgkWsU61ufNC", "metadata": {}, "object": "transfer_reversal", "source_refund": null, "transfer": "tr_1Pgc7BB7WZ01zgkWVJfE40RX" }, "treasury.credit_reversal": { "amount": 1000, "created": 1234567890, "currency": "usd", "financial_account": "fa_1Pgc7BB7WZ01zgkWxDkCj857", "hosted_regulatory_receipt_url": "https://sangeekp-15t6ai--agrippa-mydev.dev.stripe.me/regulatory-receipt/CBQaFwoVYWNjdF8xUGdhZlRCN1daMDF6Z2tXKJnei7UGMgYwtqAZ_Ls6Nv2A6Ab6poMV8ZkZIvCzfMd0j7YHx2Mw0wTBTLJdPImQtMqo7SGE_TS1iV6zNCiVftARe-0iFQ", "id": "credrev_1Pgc7BB7WZ01zgkWo52rqcbC", "livemode": false, "metadata": {}, "network": "ach", "object": "treasury.credit_reversal", "received_credit": "rc_1Pgc7BB7WZ01zgkWv2rpvGwQ", "status": "processing", "status_transitions": { "posted_at": null }, "transaction": "trxn_1Pgc7BB7WZ01zgkWvyFCYTAP" }, "treasury.debit_reversal": { "amount": 1000, "created": 1234567890, "currency": "usd", "financial_account": "fa_1Pgc7BB7WZ01zgkWxDkCj857", "hosted_regulatory_receipt_url": "https://sangeekp-15t6ai--agrippa-mydev.dev.stripe.me/regulatory-receipt/CBQaFwoVYWNjdF8xUGdhZlRCN1daMDF6Z2tXKJnei7UGMgZ3U4M-qIg6Nv3nRffl0eHDb937PJZYd2t6AXma3QzJSqHHIKA17nkwM6oG4egKu2JJvBr9Sm1wmKUWDdLmtA", "id": "debrev_1Pgc7BB7WZ01zgkWSyqFZLwW", "linked_flows": { "issuing_dispute": null }, "livemode": false, "metadata": {}, "network": "ach", "object": "treasury.debit_reversal", "received_debit": "rd_1Pgc7BB7WZ01zgkWh1oNnhpq", "status": "processing", "status_transitions": { "completed_at": null }, "transaction": "trxn_1Pgc7BB7WZ01zgkWvyFCYTAP" }, "treasury.financial_account": { "active_features": [ "financial_addresses.aba", "outbound_payments.ach", "outbound_payments.us_domestic_wire" ], "balance": { "cash": { "usd": 0 }, "inbound_pending": { "usd": 0 }, "outbound_pending": { "usd": 0 } }, "country": "US", "created": 1234567890, "financial_addresses": [ { "aba": { "account_holder_name": "Jenny Rosen", "account_number_last4": "7890", "bank_name": "STRIPE TEST BANK", "routing_number": "0000000001" }, "supported_networks": [ "ach", "us_domestic_wire" ], "type": "aba" } ], "id": "fa_1Pgc7BB7WZ01zgkWxDkCj857", "livemode": true, "metadata": null, "object": "treasury.financial_account", "pending_features": [], "restricted_features": [], "status": "open", "status_details": { "closed": { "reasons": [ "closed_by_platform" ] } }, "supported_currencies": [ "usd" ] }, "treasury.financial_account_features": { "card_issuing": { "requested": true, "status": "active", "status_details": [] }, "deposit_insurance": { "requested": true, "status": "active", "status_details": [] }, "financial_addresses": { "aba": { "requested": true, "status": "active", "status_details": [] } }, "inbound_transfers": { "ach": { "requested": true, "status": "active", "status_details": [] } }, "intra_stripe_flows": { "requested": true, "status": "active", "status_details": [] }, "object": "treasury.financial_account_features", "outbound_payments": { "ach": { "requested": true, "status": "active", "status_details": [] }, "us_domestic_wire": { "requested": true, "status": "active", "status_details": [] } }, "outbound_transfers": { "ach": { "requested": true, "status": "active", "status_details": [] }, "us_domestic_wire": { "requested": true, "status": "active", "status_details": [] } } }, "treasury.inbound_transfer": { "amount": 10000, "cancelable": true, "created": 1234567890, "currency": "usd", "description": "InboundTransfer from my external bank account", "failure_details": { "code": "insufficient_funds" }, "financial_account": "fa_1Pgc7BB7WZ01zgkWxDkCj857", "hosted_regulatory_receipt_url": "https://sangeekp-15t6ai--agrippa-mydev.dev.stripe.me/regulatory-receipt/CBQaFwoVYWNjdF8xUGdhZlRCN1daMDF6Z2tXKJ_ei7UGMgYKg2PTYkI6Nv0SjUVDsJYyegKhOMmAGzmg4wwaTYDnBu71ORJHkusIcWVsk-jhNAZH7A3P6dVmpXZBTZ6_jw", "id": "ibt_1Pgc7HB7WZ01zgkWPYpjGwmD", "linked_flows": { "received_debit": null }, "livemode": false, "metadata": {}, "object": "treasury.inbound_transfer", "origin_payment_method": "pm_1Pgc7BB7WZ01zgkWoKmZ8S4H", "origin_payment_method_details": { "billing_details": { "address": { "city": "San Francisco", "country": "US", "line1": "1234 Fake Street", "line2": null, "postal_code": "94102", "state": "CA" }, "email": null, "name": "Jane Austen" }, "type": "us_bank_account", "us_bank_account": { "account_holder_type": "company", "account_type": "checking", "bank_name": "STRIPE TEST BANK", "fingerprint": "AuoSJ18zsVWV9SPc", "last4": "6789", "network": "ach", "routing_number": "110000000" } }, "returned": false, "statement_descriptor": "transfer", "status": "processing", "status_transitions": { "failed_at": null, "succeeded_at": null }, "transaction": "trxn_1Pgc7BB7WZ01zgkWvyFCYTAP" }, "treasury.outbound_payment": { "amount": 10000, "cancelable": false, "created": 1234567890, "currency": "usd", "customer": null, "description": "OutboundPayment to a 3rd party", "destination_payment_method": null, "destination_payment_method_details": { "type": "us_bank_account", "billing_details": { "address": { "city": null, "country": null, "line1": null, "line2": null, "postal_code": null, "state": null }, "email": null, "name": null } }, "end_user_details": { "ip_address": null, "present": false }, "expected_arrival_date": 1234567890, "financial_account": "fa_1Pgc7BB7WZ01zgkWxDkCj857", "hosted_regulatory_receipt_url": "https://sangeekp-15t6ai--agrippa-mydev.dev.stripe.me/regulatory-receipt/CBQaFwoVYWNjdF8xUGdhZlRCN1daMDF6Z2tXKJ_ei7UGMgZb81SroEc6Nf0M0LOh7xetIdKMMltgDcTZmCTvH7ZnNosUOThGpwFftLBt-Jpykly0SuHShBnzVpepZnst", "id": "obp_1Pgc7HB7WZ01zgkW5S60LSav", "livemode": false, "metadata": {}, "object": "treasury.outbound_payment", "returned_details": { "code": "account_frozen", "transaction": { "amount": 1413853096, "balance_impact": { "cash": 3046195, "inbound_pending": 550878511, "outbound_pending": 786770760 }, "created": 1028554472, "currency": "currency", "description": "description", "financial_account": "financial_account", "flow": null, "flow_type": "credit_reversal", "id": "obj_123", "livemode": true, "object": "treasury.transaction", "status": "open", "status_transitions": { "posted_at": null, "void_at": null } } }, "statement_descriptor": "payment", "status": "processing", "status_transitions": { "canceled_at": null, "failed_at": null, "posted_at": null, "returned_at": null }, "tracking_details": { "type": "ach" }, "transaction": "trxn_1Pgc7BB7WZ01zgkWvyFCYTAP" }, "treasury.outbound_transfer": { "amount": 10000, "cancelable": true, "created": 1234567890, "currency": "usd", "description": "OutboundTransfer to my external bank account", "destination_payment_method": "pm_1Pgc7BB7WZ01zgkWoKmZ8S4H", "destination_payment_method_details": { "billing_details": { "address": { "city": "San Francisco", "country": "US", "line1": "1234 Fake Street", "line2": null, "postal_code": "94102", "state": "CA" }, "email": null, "name": "Jane Austen" }, "type": "us_bank_account", "us_bank_account": { "account_holder_type": "company", "account_type": "checking", "bank_name": "STRIPE TEST BANK", "fingerprint": "AuoSJ18zsVWV9SPc", "last4": "6789", "network": "ach", "routing_number": "110000000" } }, "expected_arrival_date": 1234567890, "financial_account": "fa_1Pgc7BB7WZ01zgkWxDkCj857", "hosted_regulatory_receipt_url": "https://sangeekp-15t6ai--agrippa-mydev.dev.stripe.me/regulatory-receipt/CBQaFwoVYWNjdF8xUGdhZlRCN1daMDF6Z2tXKJ_ei7UGMgYlxL2q_WI6Nv0EvxGhJTn6e6eNgpjYk9CdzEc4N899gPvZHXiyD6u24zAPv2nUwIgQ-exAUakJYBUxk8cq_A", "id": "obt_1Pgc7HB7WZ01zgkW6fB9s6sG", "livemode": false, "metadata": {}, "object": "treasury.outbound_transfer", "returned_details": { "code": "account_frozen", "transaction": { "amount": 1413853096, "balance_impact": { "cash": 3046195, "inbound_pending": 550878511, "outbound_pending": 786770760 }, "created": 1028554472, "currency": "currency", "description": "description", "financial_account": "financial_account", "flow": null, "flow_type": "credit_reversal", "id": "obj_123", "livemode": true, "object": "treasury.transaction", "status": "open", "status_transitions": { "posted_at": null, "void_at": null } } }, "statement_descriptor": "transfer", "status": "processing", "status_transitions": { "canceled_at": null, "failed_at": null, "posted_at": null, "returned_at": null }, "tracking_details": { "type": "ach" }, "transaction": "trxn_1Pgc7BB7WZ01zgkWvyFCYTAP" }, "treasury.received_credit": { "amount": 1234, "created": 1234567890, "currency": "usd", "description": "Stripe Test", "failure_code": null, "financial_account": "fa_1Pgc7BB7WZ01zgkWxDkCj857", "hosted_regulatory_receipt_url": "https://sangeekp-15t6ai--agrippa-mydev.dev.stripe.me/regulatory-receipt/CBQaFwoVYWNjdF8xUGdhZlRCN1daMDF6Z2tXKJ_ei7UGMgb_mDijM3s6Nv0vHJ2VidYTyMDTmingbhaK5i-GqSNEOdMrWczfnZxlxg6ji5RDUKaCLqNe34tGLL_ncyo92g", "id": "rc_1Pgc7BB7WZ01zgkWv2rpvGwQ", "initiating_payment_method_details": { "billing_details": { "address": { "city": null, "country": null, "line1": null, "line2": null, "postal_code": null, "state": null }, "email": null, "name": "Jane Austen" }, "type": "us_bank_account", "us_bank_account": { "bank_name": "STRIPE TEST BANK", "last4": "6789", "routing_number": "110000000" } }, "linked_flows": { "credit_reversal": null, "issuing_authorization": null, "issuing_transaction": null, "source_flow": null, "source_flow_type": null }, "livemode": false, "network": "ach", "object": "treasury.received_credit", "reversal_details": { "deadline": 1722297600, "restricted_reason": null }, "status": "succeeded", "transaction": "trxn_1Pgc7BB7WZ01zgkWvyFCYTAP" }, "treasury.received_debit": { "amount": 54321, "created": 1234567890, "currency": "usd", "description": "Stripe Test", "failure_code": null, "financial_account": "fa_1Pgc7BB7WZ01zgkWxDkCj857", "hosted_regulatory_receipt_url": "https://sangeekp-15t6ai--agrippa-mydev.dev.stripe.me/regulatory-receipt/CBQaFwoVYWNjdF8xUGdhZlRCN1daMDF6Z2tXKJ_ei7UGMgblHg8l-qY6Nv1bWhP07tHwOkxTo4kSCyk5cLYhmwXhReJLrYy2SlP6nyY3S80SSs29lSFiEvKBYHUw_ddK7A", "id": "rd_1Pgc7HB7WZ01zgkWlhCJ4BHN", "initiating_payment_method_details": { "billing_details": { "address": { "city": null, "country": null, "line1": null, "line2": null, "postal_code": null, "state": null }, "email": null, "name": "Jane Austen" }, "type": "us_bank_account", "us_bank_account": { "bank_name": "STRIPE TEST BANK", "last4": "6789", "routing_number": "110000000" } }, "linked_flows": { "debit_reversal": null, "inbound_transfer": null, "issuing_authorization": null, "issuing_transaction": null, "payout": null }, "livemode": false, "network": "ach", "object": "treasury.received_debit", "reversal_details": { "deadline": 1722297600, "restricted_reason": null }, "status": "succeeded", "transaction": "trxn_1Pgc7BB7WZ01zgkWvyFCYTAP" }, "treasury.transaction": { "amount": -100, "balance_impact": { "cash": -100, "inbound_pending": 0, "outbound_pending": 100 }, "created": 1234567890, "currency": "usd", "description": "Jane Austen (6789) | Outbound transfer | transfer", "financial_account": "fa_1Pgc7BB7WZ01zgkWxDkCj857", "flow": "obt_1Pgc7HB7WZ01zgkW6fB9s6sG", "flow_type": "outbound_transfer", "id": "trxn_1Pgc7BB7WZ01zgkWvyFCYTAP", "livemode": false, "object": "treasury.transaction", "status": "open", "status_transitions": { "posted_at": null, "void_at": null } }, "treasury.transaction_entry": { "balance_impact": { "cash": 0, "inbound_pending": 0, "outbound_pending": -1000 }, "created": 1234567890, "currency": "usd", "effective_at": 1234567890, "financial_account": "fa_1Pgc7BB7WZ01zgkWxDkCj857", "flow": "obt_1Pgc7HB7WZ01zgkW6fB9s6sG", "flow_type": "outbound_transfer", "id": "trxne_1Pgc7HB7WZ01zgkWRFO3VY47", "livemode": false, "object": "treasury.transaction_entry", "transaction": "trxn_1Pgc7BB7WZ01zgkWvyFCYTAP", "type": "outbound_transfer" }, "webhook_endpoint": { "api_version": null, "application": null, "created": 1234567890, "description": "This is my webhook, I like it a lot", "enabled_events": [ "charge.failed", "charge.succeeded" ], "id": "we_1Pgc6yB7WZ01zgkWzAudq4eU", "livemode": false, "metadata": {}, "object": "webhook_endpoint", "status": "enabled", "url": "https://example.com/my/webhook/endpoint" }, "application": { "id": "obj_123", "name": null, "object": "application" }, "deleted_application": { "deleted": true, "id": "obj_123", "name": null, "object": "application" }, "deleted_bank_account": { "deleted": true, "id": "obj_123", "object": "bank_account" }, "deleted_card": { "deleted": true, "id": "obj_123", "object": "card" }, "deleted_price": { "deleted": true, "id": "obj_123", "object": "price" }, "entitlements.active_entitlement_summary": { "customer": "customer", "entitlements": { "data": [ { "feature": { "active": true, "id": "obj_123", "livemode": true, "lookup_key": "lookup_key", "metadata": { "undefined": "metadata" }, "name": "name", "object": "entitlements.feature" }, "id": "obj_123", "livemode": true, "lookup_key": "lookup_key", "object": "entitlements.active_entitlement" } ], "has_more": true, "object": "list", "url": "url" }, "livemode": true, "object": "entitlements.active_entitlement_summary" }, "financial_connections.account_ownership": { "created": 1028554472, "id": "obj_123", "object": "financial_connections.account_ownership", "owners": { "data": [ { "email": null, "id": "obj_123", "name": "name", "object": "financial_connections.account_owner", "ownership": "ownership", "phone": null, "raw_address": null, "refreshed_at": null } ], "has_more": true, "object": "list", "url": "url" } }, "billing.alert": { "alert_type": "usage_threshold", "id": "obj_123", "livemode": true, "object": "billing.alert", "status": null, "title": "title", "usage_threshold": { "filters": null, "gte": 102680, "meter": { "created": 1028554472, "customer_mapping": { "event_payload_key": "event_payload_key", "type": "by_id" }, "default_aggregation": { "formula": "sum" }, "display_name": "display_name", "event_name": "event_name", "event_time_window": null, "id": "obj_123", "livemode": true, "object": "billing.meter", "status": "active", "status_transitions": { "deactivated_at": null }, "updated": 234430277, "value_settings": { "event_payload_key": "event_payload_key" } }, "recurrence": "one_time" } }, "billing.alert_triggered": { "alert": { "alert_type": "usage_threshold", "id": "obj_123", "livemode": true, "object": "billing.alert", "status": null, "title": "title", "usage_threshold": { "filters": null, "gte": 102680, "meter": { "created": 1028554472, "customer_mapping": { "event_payload_key": "event_payload_key", "type": "by_id" }, "default_aggregation": { "formula": "sum" }, "display_name": "display_name", "event_name": "event_name", "event_time_window": null, "id": "obj_123", "livemode": true, "object": "billing.meter", "status": "active", "status_transitions": { "deactivated_at": null }, "updated": 234430277, "value_settings": { "event_payload_key": "event_payload_key" } }, "recurrence": "one_time" } }, "created": 1028554472, "customer": "customer", "livemode": true, "object": "billing.alert_triggered", "value": 111972721 }, "invoice_rendering_template": { "created": 1028554472, "id": "obj_123", "livemode": true, "metadata": null, "nickname": null, "object": "invoice_rendering_template", "status": "active", "version": 351608024 }, "billing.credit_balance_summary": { "balances": [ { "available_balance": { "monetary": { "currency": "currency", "value": 111972721 }, "type": "monetary" }, "ledger_balance": { "monetary": { "currency": "currency", "value": 111972721 }, "type": "monetary" } } ], "customer": { "created": 1028554472, "default_source": null, "description": null, "email": null, "id": "obj_123", "livemode": true, "object": "customer", "shipping": {} }, "livemode": true, "object": "billing.credit_balance_summary" }, "billing.credit_balance_transaction": { "created": 1028554472, "credit": { "amount": { "monetary": { "currency": "currency", "value": 111972721 }, "type": "monetary" }, "credits_application_invoice_voided": { "invoice": "invoice", "invoice_line_item": "invoice_line_item" }, "type": "credits_application_invoice_voided" }, "credit_grant": "credit_grant", "debit": { "amount": { "monetary": { "currency": "currency", "value": 111972721 }, "type": "monetary" }, "credits_applied": { "invoice": "invoice", "invoice_line_item": "invoice_line_item" }, "type": "credits_applied" }, "effective_at": 247108043, "id": "obj_123", "livemode": true, "object": "billing.credit_balance_transaction", "test_clock": null, "type": null }, "billing.credit_grant": { "amount": { "monetary": { "currency": "currency", "value": 111972721 }, "type": "monetary" }, "applicability_config": { "scope": { "price_type": "metered" } }, "category": "paid", "created": 1028554472, "customer": { "created": 1028554472, "default_source": null, "description": null, "email": null, "id": "obj_123", "livemode": true, "object": "customer", "shipping": {} }, "effective_at": null, "expires_at": null, "id": "obj_123", "livemode": true, "metadata": { "undefined": "metadata" }, "name": null, "object": "billing.credit_grant", "test_clock": null, "updated": 234430277, "voided_at": null }, "invoice_payment": { "amount_paid": null, "amount_requested": 1112626247, "created": 1028554472, "currency": "currency", "id": "obj_123", "invoice": "invoice", "is_default": true, "livemode": true, "object": "invoice_payment", "payment": { "type": "payment_intent" }, "status": "status", "status_transitions": { "canceled_at": null, "paid_at": null } }, "sigma.sigma_api_query": { "object": "sigma.sigma_api_query", "id": "qry_abc123", "created": 1508284799, "livemode": false, "name": "balance transactions", "sql": "SELECT * FROM balance_transactions", "status": "pending", "created_via": "sigma_report_run_from_api", "result": {}, "error": [] } } }stripe-mock-0.196.0/embedded/openapi/spec3.beta.sdk.json000066400000000000000000531547371506013555700227520ustar00rootroot00000000000000{ "components": { "schemas": { "account": { "description": "This is an object representing a Stripe account. You can retrieve it to see\nproperties on the account like its current requirements or if the account is\nenabled to make live charges or receive payouts.\n\nFor accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection)\nis `application`, which includes Custom accounts, the properties below are always\nreturned.\n\nFor accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection)\nis `stripe`, which includes Standard and Express accounts, some properties are only returned\nuntil you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions)\nto start Connect Onboarding. Learn about the [differences between accounts](/connect/accounts).", "properties": { "business_profile": { "anyOf": [ { "$ref": "#/components/schemas/account_business_profile" } ], "description": "Business information about the account.", "nullable": true }, "business_type": { "description": "The business type.", "enum": [ "company", "government_entity", "individual", "non_profit" ], "nullable": true, "type": "string", "x-stripeBypassValidation": true }, "capabilities": { "$ref": "#/components/schemas/account_capabilities" }, "charges_enabled": { "description": "Whether the account can process charges.", "type": "boolean" }, "company": { "$ref": "#/components/schemas/legal_entity_company" }, "controller": { "$ref": "#/components/schemas/account_unification_account_controller" }, "country": { "description": "The account's country.", "maxLength": 5000, "type": "string" }, "created": { "description": "Time at which the account was connected. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "default_currency": { "description": "Three-letter ISO currency code representing the default currency for the account. This must be a currency that [Stripe supports in the account's country](https://stripe.com/docs/payouts).", "maxLength": 5000, "type": "string" }, "details_submitted": { "description": "Whether account details have been submitted. Accounts with Stripe Dashboard access, which includes Standard accounts, cannot receive payouts before this is true. Accounts where this is false should be directed to [an onboarding flow](/connect/onboarding) to finish submitting account details.", "type": "boolean" }, "email": { "description": "An email address associated with the account. It's not used for authentication and Stripe doesn't market to this field without explicit approval from the platform.", "maxLength": 5000, "nullable": true, "type": "string" }, "external_accounts": { "description": "External accounts (bank accounts and debit cards) currently attached to this account. External accounts are only returned for requests where `controller[is_controller]` is true.", "properties": { "data": { "description": "The list contains all external accounts that have been attached to the Stripe account. These may be bank accounts or cards.", "items": { "$ref": "#/components/schemas/external_account" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "ExternalAccountList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] }, "future_requirements": { "$ref": "#/components/schemas/account_future_requirements" }, "groups": { "anyOf": [ { "$ref": "#/components/schemas/account_group_membership" } ], "description": "The groups associated with the account.", "nullable": true }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "individual": { "$ref": "#/components/schemas/person" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "type": "object" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "account" ], "type": "string" }, "payouts_enabled": { "description": "Whether the funds in this account can be paid out.", "type": "boolean" }, "requirements": { "$ref": "#/components/schemas/account_requirements" }, "risk_controls": { "$ref": "#/components/schemas/connect_risk_account_risk_controls" }, "settings": { "anyOf": [ { "$ref": "#/components/schemas/account_settings" } ], "description": "Options for customizing how the account functions within Stripe.", "nullable": true }, "tos_acceptance": { "$ref": "#/components/schemas/account_tos_acceptance" }, "type": { "description": "The Stripe account type. Can be `standard`, `express`, `custom`, or `none`.", "enum": [ "custom", "express", "none", "standard" ], "type": "string" } }, "required": [ "id", "object" ], "title": "Account", "type": "object", "x-expandableFields": [ "business_profile", "capabilities", "company", "controller", "external_accounts", "future_requirements", "groups", "individual", "requirements", "risk_controls", "settings", "tos_acceptance" ], "x-resourceId": "account", "x-stripeMostCommon": [ "business_type", "capabilities", "company", "country", "email", "id", "individual", "metadata", "requirements", "tos_acceptance", "type" ], "x-stripeOperations": [ { "method_name": "delete", "method_on": "service", "method_type": "delete", "operation": "delete", "path": "/v1/accounts/{account}" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/account" }, { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/accounts" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/accounts/{account}" }, { "method_name": "capabilities", "method_on": "service", "method_type": "custom", "operation": "get", "path": "/v1/accounts/{account}/capabilities" }, { "method_name": "persons", "method_on": "service", "method_type": "custom", "operation": "get", "path": "/v1/accounts/{account}/persons" }, { "method_name": "create", "method_on": "service", "method_type": "create", "operation": "post", "path": "/v1/accounts" }, { "method_name": "update", "method_on": "service", "method_type": "update", "operation": "post", "path": "/v1/accounts/{account}" }, { "method_name": "reject", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/accounts/{account}/reject" } ], "x-stripeResource": { "class_name": "Account", "has_collection_class": true, "in_package": "", "polymorphic_groups": [ "deleted_payment_source", "payment_source" ] } }, "account.application.authorized": { "description": "Occurs whenever a user authorizes an application. Sent to the related application only.", "properties": { "object": { "$ref": "#/components/schemas/application" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "account.application.authorized" } }, "account.application.deauthorized": { "description": "Occurs whenever a user deauthorizes an application. Sent to the related application only.", "properties": { "object": { "$ref": "#/components/schemas/application" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "account.application.deauthorized" } }, "account.external_account.created": { "description": "Occurs whenever an external account is created.", "properties": { "object": { "anyOf": [ { "$ref": "#/components/schemas/bank_account" }, { "$ref": "#/components/schemas/card" }, { "$ref": "#/components/schemas/source" } ] } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "account.external_account.created" } }, "account.external_account.deleted": { "description": "Occurs whenever an external account is deleted.", "properties": { "object": { "anyOf": [ { "$ref": "#/components/schemas/bank_account" }, { "$ref": "#/components/schemas/card" }, { "$ref": "#/components/schemas/source" } ] } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "account.external_account.deleted" } }, "account.external_account.updated": { "description": "Occurs whenever an external account is updated.", "properties": { "object": { "anyOf": [ { "$ref": "#/components/schemas/bank_account" }, { "$ref": "#/components/schemas/card" }, { "$ref": "#/components/schemas/source" } ] } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "account.external_account.updated" } }, "account.updated": { "description": "Occurs whenever an account status or property has changed.", "properties": { "object": { "$ref": "#/components/schemas/account" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "account.updated" } }, "account_annual_revenue": { "description": "", "properties": { "amount": { "description": "A non-negative integer representing the amount in the [smallest currency unit](/currencies#zero-decimal).", "nullable": true, "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "nullable": true, "type": "string" }, "fiscal_year_end": { "description": "The close-out date of the preceding fiscal year in ISO 8601 format. E.g. 2023-12-31 for the 31st of December, 2023.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "amount", "currency", "fiscal_year_end" ], "title": "AccountAnnualRevenue", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "amount", "currency", "fiscal_year_end" ] }, "account_bacs_debit_payments_settings": { "description": "", "properties": { "display_name": { "description": "The Bacs Direct Debit display name for this account. For payments made with Bacs Direct Debit, this name appears on the mandate as the statement descriptor. Mobile banking apps display it as the name of the business. To use custom branding, set the Bacs Direct Debit Display Name during or right after creation. Custom branding incurs an additional monthly fee for the platform. The fee appears 5 business days after requesting Bacs. If you don't set the display name before requesting Bacs capability, it's automatically set as \"Stripe\" and the account is onboarded to Stripe branding, which is free.", "maxLength": 5000, "nullable": true, "type": "string" }, "service_user_number": { "description": "The Bacs Direct Debit Service user number for this account. For payments made with Bacs Direct Debit, this number is a unique identifier of the account with our banking partners.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "display_name", "service_user_number" ], "title": "AccountBacsDebitPaymentsSettings", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "display_name", "service_user_number" ] }, "account_bank_bca_onboarding_settings": { "description": "", "properties": { "account_holder_name": { "description": "Bank BCA business account holder name.", "maxLength": 5000, "type": "string" }, "business_account_number": { "description": "Bank BCA business account number.", "maxLength": 5000, "type": "string" } }, "title": "AccountBankBcaOnboardingSettings", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "account_holder_name", "business_account_number" ] }, "account_branding_settings": { "description": "", "properties": { "icon": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/file" } ], "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) An icon for the account. Must be square and at least 128px x 128px.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/file" } ] } }, "logo": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/file" } ], "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) A logo for the account that will be used in Checkout instead of the icon and without the account's name next to it if provided. Must be at least 128px x 128px.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/file" } ] } }, "primary_color": { "description": "A CSS hex color value representing the primary branding color for this account", "maxLength": 5000, "nullable": true, "type": "string" }, "secondary_color": { "description": "A CSS hex color value representing the secondary branding color for this account", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "icon", "logo", "primary_color", "secondary_color" ], "title": "AccountBrandingSettings", "type": "object", "x-expandableFields": [ "icon", "logo" ], "x-stripeMostCommon": [ "icon", "logo", "primary_color", "secondary_color" ] }, "account_business_profile": { "description": "", "properties": { "annual_revenue": { "anyOf": [ { "$ref": "#/components/schemas/account_annual_revenue" } ], "description": "The applicant's gross annual revenue for its preceding fiscal year.", "nullable": true }, "estimated_worker_count": { "description": "An estimated upper bound of employees, contractors, vendors, etc. currently working for the business.", "nullable": true, "type": "integer" }, "mcc": { "description": "[The merchant category code for the account](/connect/setting-mcc). MCCs are used to classify businesses based on the goods or services they provide.", "maxLength": 5000, "nullable": true, "type": "string" }, "minority_owned_business_designation": { "description": "Whether the business is a minority-owned, women-owned, and/or LGBTQI+ -owned business.", "items": { "enum": [ "lgbtqi_owned_business", "minority_owned_business", "none_of_these_apply", "prefer_not_to_answer", "women_owned_business" ], "type": "string" }, "nullable": true, "type": "array" }, "monthly_estimated_revenue": { "$ref": "#/components/schemas/account_monthly_estimated_revenue" }, "name": { "description": "The customer-facing business name.", "maxLength": 5000, "nullable": true, "type": "string" }, "product_description": { "description": "Internal-only description of the product sold or service provided by the business. It's used by Stripe for risk and underwriting purposes.", "maxLength": 40000, "nullable": true, "type": "string" }, "support_address": { "anyOf": [ { "$ref": "#/components/schemas/address" } ], "description": "A publicly available mailing address for sending support issues to.", "nullable": true }, "support_email": { "description": "A publicly available email address for sending support issues to.", "maxLength": 5000, "nullable": true, "type": "string" }, "support_phone": { "description": "A publicly available phone number to call with support issues.", "maxLength": 5000, "nullable": true, "type": "string" }, "support_url": { "description": "A publicly available website for handling support issues.", "maxLength": 5000, "nullable": true, "type": "string" }, "url": { "description": "The business's publicly available website.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "mcc", "minority_owned_business_designation", "name", "support_address", "support_email", "support_phone", "support_url", "url" ], "title": "AccountBusinessProfile", "type": "object", "x-expandableFields": [ "annual_revenue", "monthly_estimated_revenue", "support_address" ], "x-stripeMostCommon": [ "annual_revenue", "estimated_worker_count", "mcc", "minority_owned_business_designation", "monthly_estimated_revenue", "name", "product_description", "support_address", "support_email", "support_phone", "support_url", "url" ] }, "account_capabilities": { "description": "", "properties": { "acss_debit_payments": { "description": "The status of the Canadian pre-authorized debits payments capability of the account, or whether the account can directly process Canadian pre-authorized debits charges.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "affirm_payments": { "description": "The status of the Affirm capability of the account, or whether the account can directly process Affirm charges.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "afterpay_clearpay_payments": { "description": "The status of the Afterpay Clearpay capability of the account, or whether the account can directly process Afterpay Clearpay charges.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "alma_payments": { "description": "The status of the Alma capability of the account, or whether the account can directly process Alma payments.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "amazon_pay_payments": { "description": "The status of the AmazonPay capability of the account, or whether the account can directly process AmazonPay payments.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "au_becs_debit_payments": { "description": "The status of the BECS Direct Debit (AU) payments capability of the account, or whether the account can directly process BECS Direct Debit (AU) charges.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "automatic_indirect_tax": { "description": "The status of the automatic_indirect_tax capability of the account.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "bacs_debit_payments": { "description": "The status of the Bacs Direct Debits payments capability of the account, or whether the account can directly process Bacs Direct Debits charges.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "bancontact_payments": { "description": "The status of the Bancontact payments capability of the account, or whether the account can directly process Bancontact charges.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "bank_transfer_payments": { "description": "The status of the customer_balance payments capability of the account, or whether the account can directly process customer_balance charges.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "billie_payments": { "description": "The status of the Billie capability of the account, or whether the account can directly process Billie payments.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "blik_payments": { "description": "The status of the blik payments capability of the account, or whether the account can directly process blik charges.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "boleto_payments": { "description": "The status of the boleto payments capability of the account, or whether the account can directly process boleto charges.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "card_issuing": { "description": "The status of the card issuing capability of the account, or whether you can use Issuing to distribute funds on cards", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "card_payments": { "description": "The status of the card payments capability of the account, or whether the account can directly process credit and debit card charges.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "cartes_bancaires_payments": { "description": "The status of the Cartes Bancaires payments capability of the account, or whether the account can directly process Cartes Bancaires card charges in EUR currency.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "cashapp_payments": { "description": "The status of the Cash App Pay capability of the account, or whether the account can directly process Cash App Pay payments.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "crypto_payments": { "description": "The status of the Crypto capability of the account, or whether the account can directly process Crypto payments.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "eps_payments": { "description": "The status of the EPS payments capability of the account, or whether the account can directly process EPS charges.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "fpx_payments": { "description": "The status of the FPX payments capability of the account, or whether the account can directly process FPX charges.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "gb_bank_transfer_payments": { "description": "The status of the GB customer_balance payments (GBP currency) capability of the account, or whether the account can directly process GB customer_balance charges.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "giropay_payments": { "description": "The status of the giropay payments capability of the account, or whether the account can directly process giropay charges.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "gopay_payments": { "description": "The status of the Gopay capability of the account, or whether the account can directly process Gopay payments.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "grabpay_payments": { "description": "The status of the GrabPay payments capability of the account, or whether the account can directly process GrabPay charges.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "id_bank_transfer_payments": { "description": "The status of the Indonesia Bank Transfer payments capability of the account, or whether the account can directly process Indonesia Bank Transfer charges.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "id_bank_transfer_payments_bca": { "description": "The status of Bank BCA onboarding of the account.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "ideal_payments": { "description": "The status of the iDEAL payments capability of the account, or whether the account can directly process iDEAL charges.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "india_international_payments": { "description": "The status of the india_international_payments capability of the account, or whether the account can process international charges (non INR) in India.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "jcb_payments": { "description": "The status of the JCB payments capability of the account, or whether the account (Japan only) can directly process JCB credit card charges in JPY currency.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "jp_bank_transfer_payments": { "description": "The status of the Japanese customer_balance payments (JPY currency) capability of the account, or whether the account can directly process Japanese customer_balance charges.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "kakao_pay_payments": { "description": "The status of the KakaoPay capability of the account, or whether the account can directly process KakaoPay payments.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "klarna_payments": { "description": "The status of the Klarna payments capability of the account, or whether the account can directly process Klarna charges.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "konbini_payments": { "description": "The status of the konbini payments capability of the account, or whether the account can directly process konbini charges.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "kr_card_payments": { "description": "The status of the KrCard capability of the account, or whether the account can directly process KrCard payments.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "legacy_payments": { "description": "The status of the legacy payments capability of the account.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "link_payments": { "description": "The status of the link_payments capability of the account, or whether the account can directly process Link charges.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "mb_way_payments": { "description": "The status of the MB WAY payments capability of the account, or whether the account can directly process MB WAY charges.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "mobilepay_payments": { "description": "The status of the MobilePay capability of the account, or whether the account can directly process MobilePay charges.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "multibanco_payments": { "description": "The status of the Multibanco payments capability of the account, or whether the account can directly process Multibanco charges.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "mx_bank_transfer_payments": { "description": "The status of the Mexican customer_balance payments (MXN currency) capability of the account, or whether the account can directly process Mexican customer_balance charges.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "naver_pay_payments": { "description": "The status of the NaverPay capability of the account, or whether the account can directly process NaverPay payments.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "nz_bank_account_becs_debit_payments": { "description": "The status of the New Zealand BECS Direct Debit payments capability of the account, or whether the account can directly process New Zealand BECS Direct Debit charges.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "oxxo_payments": { "description": "The status of the OXXO payments capability of the account, or whether the account can directly process OXXO charges.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "p24_payments": { "description": "The status of the P24 payments capability of the account, or whether the account can directly process P24 charges.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "pay_by_bank_payments": { "description": "The status of the pay_by_bank payments capability of the account, or whether the account can directly process pay_by_bank charges.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "payco_payments": { "description": "The status of the Payco capability of the account, or whether the account can directly process Payco payments.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "paynow_payments": { "description": "The status of the paynow payments capability of the account, or whether the account can directly process paynow charges.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "paypal_payments": { "description": "The status of the PayPal payments capability of the account, or whether the account can directly process PayPal charges.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "paypay_payments": { "description": "The status of the Paypay capability of the account, or whether the account can directly process Paypay payments.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "payto_payments": { "description": "The status of the PayTo capability of the account, or whether the account can directly process PayTo charges.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "pix_payments": { "description": "The status of the pix payments capability of the account, or whether the account can directly process pix charges.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "promptpay_payments": { "description": "The status of the promptpay payments capability of the account, or whether the account can directly process promptpay charges.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "qris_payments": { "description": "The status of the Qris capability of the account, or whether the account can directly process Qris payments.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "rechnung_payments": { "description": "The status of the Rechnung capability of the account, or whether the account can directly process Rechnung payments.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "revolut_pay_payments": { "description": "The status of the RevolutPay capability of the account, or whether the account can directly process RevolutPay payments.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "samsung_pay_payments": { "description": "The status of the SamsungPay capability of the account, or whether the account can directly process SamsungPay payments.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "satispay_payments": { "description": "The status of the Satispay capability of the account, or whether the account can directly process Satispay payments.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "sepa_bank_transfer_payments": { "description": "The status of the SEPA customer_balance payments (EUR currency) capability of the account, or whether the account can directly process SEPA customer_balance charges.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "sepa_debit_payments": { "description": "The status of the SEPA Direct Debits payments capability of the account, or whether the account can directly process SEPA Direct Debits charges.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "shopeepay_payments": { "description": "The status of the ShopeePay capability of the account, or whether the account can directly process ShopeePay payments.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "sofort_payments": { "description": "The status of the Sofort payments capability of the account, or whether the account can directly process Sofort charges.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "stripe_balance_payments": { "description": "The status of the stripe_balance payments capability of the account, or whether the account can directly process stripe_balance charges.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "swish_payments": { "description": "The status of the Swish capability of the account, or whether the account can directly process Swish payments.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "tax_reporting_us_1099_k": { "description": "The status of the tax reporting 1099-K (US) capability of the account.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "tax_reporting_us_1099_misc": { "description": "The status of the tax reporting 1099-MISC (US) capability of the account.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "transfers": { "description": "The status of the transfers capability of the account, or whether your platform can transfer funds to the account.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "treasury": { "description": "The status of the banking capability, or whether the account can have bank accounts.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "treasury_evolve": { "description": "The status of the treasury_evolve capability of the account.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "treasury_fifth_third": { "description": "The status of the treasury_fifth_third capability of the account.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "treasury_goldman_sachs": { "description": "The status of the treasury_goldman_sachs capability of the account.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "twint_payments": { "description": "The status of the TWINT capability of the account, or whether the account can directly process TWINT charges.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "us_bank_account_ach_payments": { "description": "The status of the US bank account ACH payments capability of the account, or whether the account can directly process US bank account charges.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "us_bank_transfer_payments": { "description": "The status of the US customer_balance payments (USD currency) capability of the account, or whether the account can directly process US customer_balance charges.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "zip_payments": { "description": "The status of the Zip capability of the account, or whether the account can directly process Zip charges.", "enum": [ "active", "inactive", "pending" ], "type": "string" } }, "title": "AccountCapabilities", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "acss_debit_payments", "affirm_payments", "afterpay_clearpay_payments", "alma_payments", "amazon_pay_payments", "au_becs_debit_payments", "automatic_indirect_tax", "bacs_debit_payments", "bancontact_payments", "bank_transfer_payments", "billie_payments", "blik_payments", "boleto_payments", "card_issuing", "card_payments", "cartes_bancaires_payments", "cashapp_payments", "crypto_payments", "eps_payments", "fpx_payments", "gb_bank_transfer_payments", "giropay_payments", "gopay_payments", "grabpay_payments", "id_bank_transfer_payments", "id_bank_transfer_payments_bca", "ideal_payments", "india_international_payments", "jcb_payments", "jp_bank_transfer_payments", "kakao_pay_payments", "klarna_payments", "konbini_payments", "kr_card_payments", "legacy_payments", "link_payments", "mb_way_payments", "mobilepay_payments", "multibanco_payments", "mx_bank_transfer_payments", "naver_pay_payments", "nz_bank_account_becs_debit_payments", "oxxo_payments", "p24_payments", "pay_by_bank_payments", "payco_payments", "paynow_payments", "paypal_payments", "paypay_payments", "payto_payments", "pix_payments", "promptpay_payments", "qris_payments", "rechnung_payments", "revolut_pay_payments", "samsung_pay_payments", "satispay_payments", "sepa_bank_transfer_payments", "sepa_debit_payments", "shopeepay_payments", "sofort_payments", "stripe_balance_payments", "swish_payments", "tax_reporting_us_1099_k", "tax_reporting_us_1099_misc", "transfers", "treasury", "treasury_evolve", "treasury_fifth_third", "treasury_goldman_sachs", "twint_payments", "us_bank_account_ach_payments", "us_bank_transfer_payments", "zip_payments" ] }, "account_capability_future_requirements": { "description": "", "properties": { "alternatives": { "description": "Fields that are due and can be satisfied by providing the corresponding alternative fields instead.", "items": { "$ref": "#/components/schemas/account_requirements_alternative" }, "nullable": true, "type": "array" }, "current_deadline": { "description": "Date on which `future_requirements` becomes the main `requirements` hash and `future_requirements` becomes empty. After the transition, `currently_due` requirements may immediately become `past_due`, but the account may also be given a grace period depending on the capability's enablement state prior to transitioning.", "format": "unix-time", "nullable": true, "type": "integer" }, "currently_due": { "description": "Fields that need to be collected to keep the capability enabled. If not collected by `future_requirements[current_deadline]`, these fields will transition to the main `requirements` hash.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "disabled_reason": { "description": "This is typed as an enum for consistency with `requirements.disabled_reason`, but it safe to assume `future_requirements.disabled_reason` is null because fields in `future_requirements` will never disable the account.", "enum": [ "other", "paused.inactivity", "pending.onboarding", "pending.review", "platform_disabled", "platform_paused", "rejected.inactivity", "rejected.other", "rejected.unsupported_business", "requirements.fields_needed" ], "nullable": true, "type": "string" }, "errors": { "description": "Fields that are `currently_due` and need to be collected again because validation or verification failed.", "items": { "$ref": "#/components/schemas/account_requirements_error" }, "type": "array" }, "eventually_due": { "description": "Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "past_due": { "description": "Fields that weren't collected by `requirements.current_deadline`. These fields need to be collected to enable the capability on the account. New fields will never appear here; `future_requirements.past_due` will always be a subset of `requirements.past_due`.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "pending_verification": { "description": "Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due` or `currently_due`. Fields might appear in `eventually_due` or `currently_due` and in `pending_verification` if verification fails but another verification is still pending.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "required": [ "alternatives", "current_deadline", "currently_due", "disabled_reason", "errors", "eventually_due", "past_due", "pending_verification" ], "title": "AccountCapabilityFutureRequirements", "type": "object", "x-expandableFields": [ "alternatives", "errors" ], "x-stripeMostCommon": [ "alternatives", "current_deadline", "currently_due", "disabled_reason", "errors", "eventually_due", "past_due", "pending_verification" ] }, "account_capability_requirements": { "description": "", "properties": { "alternatives": { "description": "Fields that are due and can be satisfied by providing the corresponding alternative fields instead.", "items": { "$ref": "#/components/schemas/account_requirements_alternative" }, "nullable": true, "type": "array" }, "current_deadline": { "description": "The date by which all required account information must be both submitted and verified. This includes fields listed in `currently_due` as well as those in `pending_verification`. If any required information is missing or unverified by this date, the account may be disabled. Note that `current_deadline` may change if additional `currently_due` requirements are requested.", "format": "unix-time", "nullable": true, "type": "integer" }, "currently_due": { "description": "Fields that need to be collected to keep the capability enabled. If not collected by `current_deadline`, these fields appear in `past_due` as well, and the capability is disabled.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "disabled_reason": { "description": "Description of why the capability is disabled. [Learn more about handling verification issues](https://stripe.com/docs/connect/handling-api-verification).", "enum": [ "other", "paused.inactivity", "pending.onboarding", "pending.review", "platform_disabled", "platform_paused", "rejected.inactivity", "rejected.other", "rejected.unsupported_business", "requirements.fields_needed" ], "nullable": true, "type": "string" }, "errors": { "description": "Fields that are `currently_due` and need to be collected again because validation or verification failed.", "items": { "$ref": "#/components/schemas/account_requirements_error" }, "type": "array" }, "eventually_due": { "description": "Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well, and `current_deadline` becomes set.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "past_due": { "description": "Fields that weren't collected by `current_deadline`. These fields need to be collected to enable the capability on the account.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "pending_verification": { "description": "Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. Fields might appear in `eventually_due`, `currently_due`, or `past_due` and in `pending_verification` if verification fails but another verification is still pending.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "required": [ "alternatives", "current_deadline", "currently_due", "disabled_reason", "errors", "eventually_due", "past_due", "pending_verification" ], "title": "AccountCapabilityRequirements", "type": "object", "x-expandableFields": [ "alternatives", "errors" ], "x-stripeMostCommon": [ "alternatives", "current_deadline", "currently_due", "disabled_reason", "errors", "eventually_due", "past_due", "pending_verification" ] }, "account_capital_settings": { "description": "", "properties": { "payout_destination": { "additionalProperties": { "maxLength": 5000, "type": "string" }, "description": "Per-currency mapping of user-selected destination accounts used to pay out loans.", "type": "object" }, "payout_destination_selector": { "additionalProperties": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "description": "Per-currency mapping of all destination accounts eligible to receive loan payouts.", "type": "object" } }, "title": "AccountCapitalSettings", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "payout_destination", "payout_destination_selector" ] }, "account_card_issuing_settings": { "description": "", "properties": { "tos_acceptance": { "$ref": "#/components/schemas/card_issuing_account_terms_of_service" } }, "title": "AccountCardIssuingSettings", "type": "object", "x-expandableFields": [ "tos_acceptance" ], "x-stripeMostCommon": [ "tos_acceptance" ] }, "account_card_payments_settings": { "description": "", "properties": { "decline_on": { "$ref": "#/components/schemas/account_decline_charge_on" }, "statement_descriptor_prefix": { "description": "The default text that appears on credit card statements when a charge is made. This field prefixes any dynamic `statement_descriptor` specified on the charge. `statement_descriptor_prefix` is useful for maximizing descriptor space for the dynamic portion.", "maxLength": 5000, "nullable": true, "type": "string" }, "statement_descriptor_prefix_kana": { "description": "The Kana variation of the default text that appears on credit card statements when a charge is made (Japan only). This field prefixes any dynamic `statement_descriptor_suffix_kana` specified on the charge. `statement_descriptor_prefix_kana` is useful for maximizing descriptor space for the dynamic portion.", "maxLength": 5000, "nullable": true, "type": "string" }, "statement_descriptor_prefix_kanji": { "description": "The Kanji variation of the default text that appears on credit card statements when a charge is made (Japan only). This field prefixes any dynamic `statement_descriptor_suffix_kanji` specified on the charge. `statement_descriptor_prefix_kanji` is useful for maximizing descriptor space for the dynamic portion.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "statement_descriptor_prefix", "statement_descriptor_prefix_kana", "statement_descriptor_prefix_kanji" ], "title": "AccountCardPaymentsSettings", "type": "object", "x-expandableFields": [ "decline_on" ], "x-stripeMostCommon": [ "decline_on", "statement_descriptor_prefix", "statement_descriptor_prefix_kana", "statement_descriptor_prefix_kanji" ] }, "account_dashboard_settings": { "description": "", "properties": { "display_name": { "description": "The display name for this account. This is used on the Stripe Dashboard to differentiate between accounts.", "maxLength": 5000, "nullable": true, "type": "string" }, "timezone": { "description": "The timezone used in the Stripe Dashboard for this account. A list of possible time zone values is maintained at the [IANA Time Zone Database](http://www.iana.org/time-zones).", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "display_name", "timezone" ], "title": "AccountDashboardSettings", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "display_name", "timezone" ] }, "account_decline_charge_on": { "description": "", "properties": { "avs_failure": { "description": "Whether Stripe automatically declines charges with an incorrect ZIP or postal code. This setting only applies when a ZIP or postal code is provided and they fail bank verification.", "type": "boolean" }, "cvc_failure": { "description": "Whether Stripe automatically declines charges with an incorrect CVC. This setting only applies when a CVC is provided and it fails bank verification.", "type": "boolean" } }, "required": [ "avs_failure", "cvc_failure" ], "title": "AccountDeclineChargeOn", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "avs_failure", "cvc_failure" ] }, "account_future_requirements": { "description": "", "properties": { "alternatives": { "description": "Fields that are due and can be satisfied by providing the corresponding alternative fields instead.", "items": { "$ref": "#/components/schemas/account_requirements_alternative" }, "nullable": true, "type": "array" }, "current_deadline": { "description": "Date on which `future_requirements` becomes the main `requirements` hash and `future_requirements` becomes empty. After the transition, `currently_due` requirements may immediately become `past_due`, but the account may also be given a grace period depending on its enablement state prior to transitioning.", "format": "unix-time", "nullable": true, "type": "integer" }, "currently_due": { "description": "Fields that need to be collected to keep the account enabled. If not collected by `future_requirements[current_deadline]`, these fields will transition to the main `requirements` hash.", "items": { "maxLength": 5000, "type": "string" }, "nullable": true, "type": "array" }, "disabled_reason": { "description": "This is typed as an enum for consistency with `requirements.disabled_reason`.", "enum": [ "action_required.requested_capabilities", "listed", "other", "platform_paused", "rejected.fraud", "rejected.incomplete_verification", "rejected.listed", "rejected.other", "rejected.platform_fraud", "rejected.platform_other", "rejected.platform_terms_of_service", "rejected.terms_of_service", "requirements.past_due", "requirements.pending_verification", "under_review" ], "nullable": true, "type": "string" }, "errors": { "description": "Fields that are `currently_due` and need to be collected again because validation or verification failed.", "items": { "$ref": "#/components/schemas/account_requirements_error" }, "nullable": true, "type": "array" }, "eventually_due": { "description": "Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well.", "items": { "maxLength": 5000, "type": "string" }, "nullable": true, "type": "array" }, "past_due": { "description": "Fields that weren't collected by `requirements.current_deadline`. These fields need to be collected to enable the capability on the account. New fields will never appear here; `future_requirements.past_due` will always be a subset of `requirements.past_due`.", "items": { "maxLength": 5000, "type": "string" }, "nullable": true, "type": "array" }, "pending_verification": { "description": "Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due` or `currently_due`. Fields might appear in `eventually_due` or `currently_due` and in `pending_verification` if verification fails but another verification is still pending.", "items": { "maxLength": 5000, "type": "string" }, "nullable": true, "type": "array" } }, "required": [ "alternatives", "current_deadline", "currently_due", "disabled_reason", "errors", "eventually_due", "past_due", "pending_verification" ], "title": "AccountFutureRequirements", "type": "object", "x-expandableFields": [ "alternatives", "errors" ], "x-stripeMostCommon": [ "alternatives", "current_deadline", "currently_due", "disabled_reason", "errors", "eventually_due", "past_due", "pending_verification" ] }, "account_group_membership": { "description": "", "properties": { "payments_pricing": { "description": "The group the account is in to determine their payments pricing, and null if the account is on customized pricing. [See the Platform pricing tool documentation](https://stripe.com/docs/connect/platform-pricing-tools) for details.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "payments_pricing" ], "title": "AccountGroupMembership", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "payments_pricing" ] }, "account_invoices_settings": { "description": "", "properties": { "default_account_tax_ids": { "description": "The list of default Account Tax IDs to automatically include on invoices. Account Tax IDs get added when an invoice is finalized.", "items": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/tax_id" } ], "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/tax_id" } ] } }, "nullable": true, "type": "array" }, "hosted_payment_method_save": { "description": "Whether payment methods should be saved when a payment is completed for a one-time invoices on a hosted invoice page.", "enum": [ "always", "never", "offer" ], "nullable": true, "type": "string" } }, "required": [ "default_account_tax_ids", "hosted_payment_method_save" ], "title": "AccountInvoicesSettings", "type": "object", "x-expandableFields": [ "default_account_tax_ids" ], "x-stripeMostCommon": [ "default_account_tax_ids", "hosted_payment_method_save" ] }, "account_link": { "description": "Account Links are the means by which a Connect platform grants a connected account permission to access\nStripe-hosted applications, such as Connect Onboarding.\n\nRelated guide: [Connect Onboarding](https://stripe.com/docs/connect/custom/hosted-onboarding)", "properties": { "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "expires_at": { "description": "The timestamp at which this account link will expire.", "format": "unix-time", "type": "integer" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "account_link" ], "type": "string" }, "url": { "description": "The URL for the account link.", "maxLength": 5000, "type": "string" } }, "required": [ "created", "expires_at", "object", "url" ], "title": "AccountLink", "type": "object", "x-expandableFields": [], "x-resourceId": "account_link", "x-stripeMostCommon": [ "expires_at", "url" ], "x-stripeOperations": [ { "method_name": "create", "method_on": "service", "method_type": "create", "operation": "post", "path": "/v1/account_links" } ], "x-stripeResource": { "class_name": "AccountLink", "in_package": "" } }, "account_monthly_estimated_revenue": { "description": "", "properties": { "amount": { "description": "A non-negative integer representing how much to charge in the [smallest currency unit](/currencies#zero-decimal).", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" } }, "required": [ "amount", "currency" ], "title": "AccountMonthlyEstimatedRevenue", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "amount", "currency" ] }, "account_notice": { "description": "A notice to a Connected account. Notice can be sent by Stripe on your behalf or you can opt to send the notices yourself.\n\nSee the [guide to send notices](https://stripe.com/docs/issuing/compliance-us/issuing-regulated-customer-notices) to your connected accounts.", "properties": { "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "deadline": { "description": "When present, the deadline for sending the notice to meet the relevant regulations.", "format": "unix-time", "nullable": true, "type": "integer" }, "email": { "anyOf": [ { "$ref": "#/components/schemas/issuing_compliance_notice_email" } ], "description": "Information about the email when sent.", "nullable": true }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "linked_objects": { "anyOf": [ { "$ref": "#/components/schemas/issuing_compliance_notice_linked_objects" } ], "description": "Information about objects related to the notice.", "nullable": true }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "nullable": true, "type": "object" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "account_notice" ], "type": "string" }, "reason": { "description": "Reason the notice is being sent. The reason determines what copy the notice must contain. See the [regulated customer notices](https://stripe.com/docs/issuing/compliance-us/issuing-regulated-customer-notices) guide. All reasons might not apply to your integration, and Stripe might add new reasons in the future, so we recommend an internal warning when you receive an unknown reason.", "enum": [ "issuing.account_closed_for_inactivity", "issuing.account_closed_for_not_providing_business_model_clarification", "issuing.account_closed_for_not_providing_url_clarification", "issuing.account_closed_for_not_providing_use_case_clarification", "issuing.account_closed_for_terms_of_service_violation", "issuing.application_rejected_for_failure_to_verify", "issuing.credit_application_rejected", "issuing.credit_increase_application_rejected", "issuing.credit_limit_decreased", "issuing.credit_line_closed", "issuing.dispute_lost", "issuing.dispute_submitted", "issuing.dispute_won" ], "type": "string" }, "sent_at": { "description": "Date when the notice was sent. When absent, you must send the notice, update the content of the email and date when it was sent.", "format": "unix-time", "nullable": true, "type": "integer" } }, "required": [ "created", "deadline", "email", "id", "linked_objects", "livemode", "metadata", "object", "reason", "sent_at" ], "title": "IssuingComplianceNotice", "type": "object", "x-expandableFields": [ "email", "linked_objects" ], "x-resourceId": "account_notice", "x-stripeMostCommon": [ "deadline", "email", "id", "linked_objects", "metadata", "reason", "sent_at" ], "x-stripeOperations": [ { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/account_notices" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/account_notices/{account_notice}" }, { "method_name": "update", "method_on": "service", "method_type": "update", "operation": "post", "path": "/v1/account_notices/{account_notice}" } ], "x-stripeResource": { "class_name": "AccountNotice", "has_collection_class": true, "in_package": "" } }, "account_notice.created": { "description": "Occurs whenever an AccountNotice is created.", "properties": { "object": { "$ref": "#/components/schemas/account_notice" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "account_notice.created" } }, "account_notice.updated": { "description": "Occurs whenever an AccountNotice is updated.", "properties": { "object": { "$ref": "#/components/schemas/account_notice" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "account_notice.updated" } }, "account_payments_settings": { "description": "", "properties": { "statement_descriptor": { "description": "The default text that appears on credit card statements when a charge is made. This field prefixes any dynamic `statement_descriptor` specified on the charge.", "maxLength": 5000, "nullable": true, "type": "string" }, "statement_descriptor_kana": { "description": "The Kana variation of `statement_descriptor` used for charges in Japan. Japanese statement descriptors have [special requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors).", "maxLength": 5000, "nullable": true, "type": "string" }, "statement_descriptor_kanji": { "description": "The Kanji variation of `statement_descriptor` used for charges in Japan. Japanese statement descriptors have [special requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors).", "maxLength": 5000, "nullable": true, "type": "string" }, "statement_descriptor_prefix_kana": { "description": "The Kana variation of `statement_descriptor_prefix` used for card charges in Japan. Japanese statement descriptors have [special requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors).", "maxLength": 5000, "nullable": true, "type": "string" }, "statement_descriptor_prefix_kanji": { "description": "The Kanji variation of `statement_descriptor_prefix` used for card charges in Japan. Japanese statement descriptors have [special requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors).", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "statement_descriptor", "statement_descriptor_kana", "statement_descriptor_kanji", "statement_descriptor_prefix_kana", "statement_descriptor_prefix_kanji" ], "title": "AccountPaymentsSettings", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "statement_descriptor", "statement_descriptor_kana", "statement_descriptor_kanji", "statement_descriptor_prefix_kana", "statement_descriptor_prefix_kanji" ] }, "account_payout_settings": { "description": "", "properties": { "debit_negative_balances": { "description": "A Boolean indicating if Stripe should try to reclaim negative balances from an attached bank account. See [Understanding Connect account balances](/connect/account-balances) for details. The default value is `false` when [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts, otherwise `true`.", "type": "boolean" }, "schedule": { "$ref": "#/components/schemas/transfer_schedule" }, "statement_descriptor": { "description": "The text that appears on the bank account statement for payouts. If not set, this defaults to the platform's bank descriptor as set in the Dashboard.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "debit_negative_balances", "schedule", "statement_descriptor" ], "title": "AccountPayoutSettings", "type": "object", "x-expandableFields": [ "schedule" ], "x-stripeMostCommon": [ "debit_negative_balances", "schedule", "statement_descriptor" ] }, "account_requirements": { "description": "", "properties": { "alternatives": { "description": "Fields that are due and can be satisfied by providing the corresponding alternative fields instead.", "items": { "$ref": "#/components/schemas/account_requirements_alternative" }, "nullable": true, "type": "array" }, "current_deadline": { "description": "Date by which the fields in `currently_due` must be collected to keep the account enabled. These fields may disable the account sooner if the next threshold is reached before they are collected.", "format": "unix-time", "nullable": true, "type": "integer" }, "currently_due": { "description": "Fields that need to be collected to keep the account enabled. If not collected by `current_deadline`, these fields appear in `past_due` as well, and the account is disabled.", "items": { "maxLength": 5000, "type": "string" }, "nullable": true, "type": "array" }, "disabled_reason": { "description": "If the account is disabled, this enum describes why. [Learn more about handling verification issues](https://stripe.com/docs/connect/handling-api-verification).", "enum": [ "action_required.requested_capabilities", "listed", "other", "platform_paused", "rejected.fraud", "rejected.incomplete_verification", "rejected.listed", "rejected.other", "rejected.platform_fraud", "rejected.platform_other", "rejected.platform_terms_of_service", "rejected.terms_of_service", "requirements.past_due", "requirements.pending_verification", "under_review" ], "nullable": true, "type": "string" }, "errors": { "description": "Fields that are `currently_due` and need to be collected again because validation or verification failed.", "items": { "$ref": "#/components/schemas/account_requirements_error" }, "nullable": true, "type": "array" }, "eventually_due": { "description": "Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well, and `current_deadline` becomes set.", "items": { "maxLength": 5000, "type": "string" }, "nullable": true, "type": "array" }, "past_due": { "description": "Fields that weren't collected by `current_deadline`. These fields need to be collected to enable the account.", "items": { "maxLength": 5000, "type": "string" }, "nullable": true, "type": "array" }, "pending_verification": { "description": "Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. Fields might appear in `eventually_due`, `currently_due`, or `past_due` and in `pending_verification` if verification fails but another verification is still pending.", "items": { "maxLength": 5000, "type": "string" }, "nullable": true, "type": "array" } }, "required": [ "alternatives", "current_deadline", "currently_due", "disabled_reason", "errors", "eventually_due", "past_due", "pending_verification" ], "title": "AccountRequirements", "type": "object", "x-expandableFields": [ "alternatives", "errors" ], "x-stripeMostCommon": [ "alternatives", "current_deadline", "currently_due", "disabled_reason", "errors", "eventually_due", "past_due", "pending_verification" ] }, "account_requirements_alternative": { "description": "", "properties": { "alternative_fields_due": { "description": "Fields that can be provided to satisfy all fields in `original_fields_due`.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "original_fields_due": { "description": "Fields that are due and can be satisfied by providing all fields in `alternative_fields_due`.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "required": [ "alternative_fields_due", "original_fields_due" ], "title": "AccountRequirementsAlternative", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "alternative_fields_due", "original_fields_due" ] }, "account_requirements_error": { "description": "", "properties": { "code": { "description": "The code for the type of error.", "enum": [ "information_missing", "invalid_address_city_state_postal_code", "invalid_address_highway_contract_box", "invalid_address_private_mailbox", "invalid_business_profile_name", "invalid_business_profile_name_denylisted", "invalid_company_name_denylisted", "invalid_dob_age_over_maximum", "invalid_dob_age_under_18", "invalid_dob_age_under_minimum", "invalid_product_description_length", "invalid_product_description_url_match", "invalid_representative_country", "invalid_signator", "invalid_statement_descriptor_business_mismatch", "invalid_statement_descriptor_denylisted", "invalid_statement_descriptor_length", "invalid_statement_descriptor_prefix_denylisted", "invalid_statement_descriptor_prefix_mismatch", "invalid_street_address", "invalid_tax_id", "invalid_tax_id_format", "invalid_tos_acceptance", "invalid_url_denylisted", "invalid_url_format", "invalid_url_length", "invalid_url_web_presence_detected", "invalid_url_website_business_information_mismatch", "invalid_url_website_empty", "invalid_url_website_inaccessible", "invalid_url_website_inaccessible_geoblocked", "invalid_url_website_inaccessible_password_protected", "invalid_url_website_incomplete", "invalid_url_website_incomplete_cancellation_policy", "invalid_url_website_incomplete_customer_service_details", "invalid_url_website_incomplete_legal_restrictions", "invalid_url_website_incomplete_refund_policy", "invalid_url_website_incomplete_return_policy", "invalid_url_website_incomplete_terms_and_conditions", "invalid_url_website_incomplete_under_construction", "invalid_url_website_other", "invalid_value_other", "verification_directors_mismatch", "verification_document_address_mismatch", "verification_document_address_missing", "verification_document_corrupt", "verification_document_country_not_supported", "verification_document_directors_mismatch", "verification_document_dob_mismatch", "verification_document_duplicate_type", "verification_document_expired", "verification_document_failed_copy", "verification_document_failed_greyscale", "verification_document_failed_other", "verification_document_failed_test_mode", "verification_document_fraudulent", "verification_document_id_number_mismatch", "verification_document_id_number_missing", "verification_document_incomplete", "verification_document_invalid", "verification_document_issue_or_expiry_date_missing", "verification_document_manipulated", "verification_document_missing_back", "verification_document_missing_front", "verification_document_name_mismatch", "verification_document_name_missing", "verification_document_nationality_mismatch", "verification_document_not_readable", "verification_document_not_signed", "verification_document_not_uploaded", "verification_document_photo_mismatch", "verification_document_too_large", "verification_document_type_not_supported", "verification_extraneous_directors", "verification_failed_address_match", "verification_failed_authorizer_authority", "verification_failed_business_iec_number", "verification_failed_document_match", "verification_failed_id_number_match", "verification_failed_keyed_identity", "verification_failed_keyed_match", "verification_failed_name_match", "verification_failed_other", "verification_failed_representative_authority", "verification_failed_residential_address", "verification_failed_tax_id_match", "verification_failed_tax_id_not_issued", "verification_legal_entity_structure_mismatch", "verification_missing_directors", "verification_missing_executives", "verification_missing_owners", "verification_rejected_ownership_exemption_reason", "verification_requires_additional_memorandum_of_associations", "verification_requires_additional_proof_of_registration", "verification_supportability" ], "type": "string", "x-stripeBypassValidation": true }, "reason": { "description": "An informative message that indicates the error type and provides additional details about the error.", "maxLength": 5000, "type": "string" }, "requirement": { "description": "The specific user onboarding requirement field (in the requirements hash) that needs to be resolved.", "maxLength": 5000, "type": "string" } }, "required": [ "code", "reason", "requirement" ], "title": "AccountRequirementsError", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "code", "reason", "requirement" ] }, "account_sepa_debit_payments_settings": { "description": "", "properties": { "creditor_id": { "description": "SEPA creditor identifier that identifies the company making the payment.", "maxLength": 5000, "type": "string" } }, "title": "AccountSepaDebitPaymentsSettings", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "creditor_id" ] }, "account_session": { "description": "An AccountSession allows a Connect platform to grant access to a connected account in Connect embedded components.\n\nWe recommend that you create an AccountSession each time you need to display an embedded component\nto your user. Do not save AccountSessions to your database as they expire relatively\nquickly, and cannot be used more than once.\n\nRelated guide: [Connect embedded components](https://stripe.com/docs/connect/get-started-connect-embedded-components)", "properties": { "account": { "description": "The ID of the account the AccountSession was created for", "maxLength": 5000, "type": "string" }, "client_secret": { "description": "The client secret of this AccountSession. Used on the client to set up secure access to the given `account`.\n\nThe client secret can be used to provide access to `account` from your frontend. It should not be stored, logged, or exposed to anyone other than the connected account. Make sure that you have TLS enabled on any page that includes the client secret.\n\nRefer to our docs to [setup Connect embedded components](https://stripe.com/docs/connect/get-started-connect-embedded-components) and learn about how `client_secret` should be handled.", "maxLength": 5000, "type": "string" }, "components": { "$ref": "#/components/schemas/connect_embedded_account_session_create_components" }, "expires_at": { "description": "The timestamp at which this AccountSession will expire.", "format": "unix-time", "type": "integer" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "account_session" ], "type": "string" } }, "required": [ "account", "client_secret", "components", "expires_at", "livemode", "object" ], "title": "ConnectEmbeddedMethodAccountSessionCreateMethodAccountSession", "type": "object", "x-expandableFields": [ "components" ], "x-resourceId": "account_session", "x-stripeMostCommon": [ "account", "client_secret", "components", "expires_at" ], "x-stripeOperations": [ { "method_name": "create", "method_on": "service", "method_type": "create", "operation": "post", "path": "/v1/account_sessions" } ], "x-stripeResource": { "class_name": "AccountSession", "in_package": "" } }, "account_settings": { "description": "", "properties": { "bacs_debit_payments": { "$ref": "#/components/schemas/account_bacs_debit_payments_settings" }, "bank_bca_onboarding": { "$ref": "#/components/schemas/account_bank_bca_onboarding_settings" }, "branding": { "$ref": "#/components/schemas/account_branding_settings" }, "capital": { "$ref": "#/components/schemas/account_capital_settings" }, "card_issuing": { "$ref": "#/components/schemas/account_card_issuing_settings" }, "card_payments": { "$ref": "#/components/schemas/account_card_payments_settings" }, "dashboard": { "$ref": "#/components/schemas/account_dashboard_settings" }, "invoices": { "$ref": "#/components/schemas/account_invoices_settings" }, "payments": { "$ref": "#/components/schemas/account_payments_settings" }, "payouts": { "$ref": "#/components/schemas/account_payout_settings" }, "sepa_debit_payments": { "$ref": "#/components/schemas/account_sepa_debit_payments_settings" }, "tax_forms": { "$ref": "#/components/schemas/tax_reporting_account_settings_resource_tax_form_settings" }, "treasury": { "$ref": "#/components/schemas/account_treasury_settings" } }, "required": [ "branding", "card_payments", "dashboard", "payments" ], "title": "AccountSettings", "type": "object", "x-expandableFields": [ "bacs_debit_payments", "bank_bca_onboarding", "branding", "capital", "card_issuing", "card_payments", "dashboard", "invoices", "payments", "payouts", "sepa_debit_payments", "tax_forms", "treasury" ], "x-stripeMostCommon": [ "bacs_debit_payments", "bank_bca_onboarding", "branding", "capital", "card_issuing", "card_payments", "dashboard", "invoices", "payments", "payouts", "sepa_debit_payments", "tax_forms", "treasury" ] }, "account_terms_of_service": { "description": "", "properties": { "date": { "description": "The Unix timestamp marking when the account representative accepted the service agreement.", "nullable": true, "type": "integer" }, "ip": { "description": "The IP address from which the account representative accepted the service agreement.", "maxLength": 5000, "nullable": true, "type": "string" }, "user_agent": { "description": "The user agent of the browser from which the account representative accepted the service agreement.", "maxLength": 5000, "type": "string" } }, "required": [ "date", "ip" ], "title": "AccountTermsOfService", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "date", "ip", "user_agent" ] }, "account_tos_acceptance": { "description": "", "properties": { "date": { "description": "The Unix timestamp marking when the account representative accepted their service agreement", "format": "unix-time", "nullable": true, "type": "integer" }, "ip": { "description": "The IP address from which the account representative accepted their service agreement", "maxLength": 5000, "nullable": true, "type": "string" }, "service_agreement": { "description": "The user's service agreement type", "maxLength": 5000, "type": "string" }, "user_agent": { "description": "The user agent of the browser from which the account representative accepted their service agreement", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "AccountTOSAcceptance", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "date", "ip", "service_agreement", "user_agent" ] }, "account_treasury_settings": { "description": "", "properties": { "tos_acceptance": { "$ref": "#/components/schemas/account_terms_of_service" } }, "title": "AccountTreasurySettings", "type": "object", "x-expandableFields": [ "tos_acceptance" ], "x-stripeMostCommon": [ "tos_acceptance" ] }, "account_unification_account_controller": { "description": "", "properties": { "application": { "$ref": "#/components/schemas/account_unification_account_controller_application" }, "dashboard": { "$ref": "#/components/schemas/account_unification_account_controller_dashboard" }, "fees": { "$ref": "#/components/schemas/account_unification_account_controller_fees" }, "is_controller": { "description": "`true` if the Connect application retrieving the resource controls the account and can therefore exercise [platform controls](https://stripe.com/docs/connect/platform-controls-for-standard-accounts). Otherwise, this field is null.", "type": "boolean" }, "losses": { "$ref": "#/components/schemas/account_unification_account_controller_losses" }, "requirement_collection": { "description": "A value indicating responsibility for collecting requirements on this account. Only returned when the Connect application retrieving the resource controls the account.", "enum": [ "application", "stripe" ], "type": "string" }, "stripe_dashboard": { "$ref": "#/components/schemas/account_unification_account_controller_stripe_dashboard" }, "type": { "description": "The controller type. Can be `application`, if a Connect application controls the account, or `account`, if the account controls itself.", "enum": [ "account", "application" ], "type": "string" } }, "required": [ "type" ], "title": "AccountUnificationAccountController", "type": "object", "x-expandableFields": [ "application", "dashboard", "fees", "losses", "stripe_dashboard" ], "x-stripeMostCommon": [ "application", "dashboard", "fees", "is_controller", "losses", "requirement_collection", "stripe_dashboard", "type" ] }, "account_unification_account_controller_application": { "description": "", "properties": { "loss_liable": { "description": "`true` if the Connect application is responsible for negative balances and should manage credit and fraud risk on the account.", "type": "boolean" }, "onboarding_owner": { "description": "`true` if the Connect application is responsible for onboarding the account.", "type": "boolean" }, "pricing_controls": { "description": "`true` if the Connect application is responsible for paying Stripe fees on pricing-control eligible products.", "type": "boolean" } }, "required": [ "loss_liable", "onboarding_owner", "pricing_controls" ], "title": "AccountUnificationAccountControllerApplication", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "loss_liable", "onboarding_owner", "pricing_controls" ] }, "account_unification_account_controller_dashboard": { "description": "", "properties": { "type": { "description": "Whether this account has access to the full Stripe dashboard (`full`), to the Express dashboard (`express`), or to no dashboard (`none`).", "enum": [ "express", "full", "none" ], "type": "string" } }, "required": [ "type" ], "title": "AccountUnificationAccountControllerDashboard", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "type" ] }, "account_unification_account_controller_fees": { "description": "", "properties": { "payer": { "description": "A value indicating the responsible payer of a bundle of Stripe fees for pricing-control eligible products on this account. Learn more about [fee behavior on connected accounts](https://docs.stripe.com/connect/direct-charges-fee-payer-behavior).", "enum": [ "account", "application", "application_custom", "application_express", "application_unified_accounts_beta" ], "type": "string" } }, "required": [ "payer" ], "title": "AccountUnificationAccountControllerFees", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "payer" ] }, "account_unification_account_controller_losses": { "description": "", "properties": { "payments": { "description": "A value indicating who is liable when this account can't pay back negative balances from payments.", "enum": [ "application", "stripe" ], "type": "string" } }, "required": [ "payments" ], "title": "AccountUnificationAccountControllerLosses", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "payments" ] }, "account_unification_account_controller_stripe_dashboard": { "description": "", "properties": { "type": { "description": "A value indicating the Stripe dashboard this account has access to independent of the Connect application.", "enum": [ "express", "full", "none" ], "type": "string" } }, "required": [ "type" ], "title": "AccountUnificationAccountControllerStripeDashboard", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "type" ] }, "address": { "description": "", "properties": { "city": { "description": "City, district, suburb, town, or village.", "maxLength": 5000, "nullable": true, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "nullable": true, "type": "string" }, "line1": { "description": "Address line 1 (e.g., street, PO Box, or company name).", "maxLength": 5000, "nullable": true, "type": "string" }, "line2": { "description": "Address line 2 (e.g., apartment, suite, unit, or building).", "maxLength": 5000, "nullable": true, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "nullable": true, "type": "string" }, "state": { "description": "State, county, province, or region.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "city", "country", "line1", "line2", "postal_code", "state" ], "title": "Address", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state" ], "x-stripeResource": { "class_name": "Address", "in_package": "" } }, "alma_installments": { "description": "", "properties": { "count": { "description": "The number of installments.", "type": "integer" } }, "required": [ "count" ], "title": "alma_installments", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "count" ] }, "amazon_pay_underlying_payment_method_funding_details": { "description": "", "properties": { "card": { "$ref": "#/components/schemas/payment_method_details_passthrough_card" }, "type": { "description": "funding type of the underlying payment method.", "enum": [ "card" ], "nullable": true, "type": "string" } }, "required": [ "type" ], "title": "amazon_pay_underlying_payment_method_funding_details", "type": "object", "x-expandableFields": [ "card" ], "x-stripeMostCommon": [ "card", "type" ] }, "api_errors": { "description": "", "properties": { "advice_code": { "description": "For card errors resulting from a card issuer decline, a short string indicating [how to proceed with an error](https://stripe.com/docs/declines#retrying-issuer-declines) if they provide one.", "maxLength": 5000, "type": "string" }, "charge": { "description": "For card errors, the ID of the failed charge.", "maxLength": 5000, "type": "string" }, "code": { "description": "For some errors that could be handled programmatically, a short string indicating the [error code](https://stripe.com/docs/error-codes) reported.", "enum": [ "account_closed", "account_country_invalid_address", "account_error_country_change_requires_additional_steps", "account_information_mismatch", "account_invalid", "account_number_invalid", "acss_debit_session_incomplete", "alipay_upgrade_required", "amount_too_large", "amount_too_small", "api_key_expired", "application_fees_not_allowed", "authentication_required", "balance_insufficient", "balance_invalid_parameter", "bank_account_bad_routing_numbers", "bank_account_declined", "bank_account_exists", "bank_account_restricted", "bank_account_unusable", "bank_account_unverified", "bank_account_verification_failed", "billing_invalid_mandate", "bitcoin_upgrade_required", "capture_charge_authorization_expired", "capture_unauthorized_payment", "card_decline_rate_limit_exceeded", "card_declined", "cardholder_phone_number_required", "charge_already_captured", "charge_already_refunded", "charge_disputed", "charge_exceeds_source_limit", "charge_exceeds_transaction_limit", "charge_expired_for_capture", "charge_invalid_parameter", "charge_not_refundable", "clearing_code_unsupported", "country_code_invalid", "country_unsupported", "coupon_expired", "customer_max_payment_methods", "customer_max_subscriptions", "customer_session_expired", "customer_tax_location_invalid", "debit_not_authorized", "email_invalid", "expired_card", "financial_connections_account_inactive", "financial_connections_account_pending_account_numbers", "financial_connections_account_unavailable_account_numbers", "financial_connections_institution_unavailable", "financial_connections_no_successful_transaction_refresh", "forwarding_api_inactive", "forwarding_api_invalid_parameter", "forwarding_api_retryable_upstream_error", "forwarding_api_upstream_connection_error", "forwarding_api_upstream_connection_timeout", "forwarding_api_upstream_error", "idempotency_key_in_use", "incorrect_address", "incorrect_cvc", "incorrect_number", "incorrect_zip", "india_recurring_payment_mandate_canceled", "instant_payouts_config_disabled", "instant_payouts_currency_disabled", "instant_payouts_limit_exceeded", "instant_payouts_unsupported", "insufficient_funds", "intent_invalid_state", "intent_verification_method_missing", "invalid_card_type", "invalid_characters", "invalid_charge_amount", "invalid_cvc", "invalid_expiry_month", "invalid_expiry_year", "invalid_mandate_reference_prefix_format", "invalid_number", "invalid_source_usage", "invalid_tax_location", "invoice_no_customer_line_items", "invoice_no_payment_method_types", "invoice_no_subscription_line_items", "invoice_not_editable", "invoice_on_behalf_of_not_editable", "invoice_payment_intent_requires_action", "invoice_upcoming_none", "livemode_mismatch", "lock_timeout", "missing", "no_account", "not_allowed_on_standard_account", "out_of_inventory", "ownership_declaration_not_allowed", "parameter_invalid_empty", "parameter_invalid_integer", "parameter_invalid_string_blank", "parameter_invalid_string_empty", "parameter_missing", "parameter_unknown", "parameters_exclusive", "payment_intent_action_required", "payment_intent_authentication_failure", "payment_intent_incompatible_payment_method", "payment_intent_invalid_parameter", "payment_intent_konbini_rejected_confirmation_number", "payment_intent_mandate_invalid", "payment_intent_payment_attempt_expired", "payment_intent_payment_attempt_failed", "payment_intent_unexpected_state", "payment_method_bank_account_already_verified", "payment_method_bank_account_blocked", "payment_method_billing_details_address_missing", "payment_method_configuration_failures", "payment_method_currency_mismatch", "payment_method_customer_decline", "payment_method_invalid_parameter", "payment_method_invalid_parameter_testmode", "payment_method_microdeposit_failed", "payment_method_microdeposit_verification_amounts_invalid", "payment_method_microdeposit_verification_amounts_mismatch", "payment_method_microdeposit_verification_attempts_exceeded", "payment_method_microdeposit_verification_descriptor_code_mismatch", "payment_method_microdeposit_verification_timeout", "payment_method_not_available", "payment_method_provider_decline", "payment_method_provider_timeout", "payment_method_unactivated", "payment_method_unexpected_state", "payment_method_unsupported_type", "payout_reconciliation_not_ready", "payouts_limit_exceeded", "payouts_not_allowed", "platform_account_required", "platform_api_key_expired", "postal_code_invalid", "processing_error", "product_inactive", "progressive_onboarding_limit_exceeded", "rate_limit", "refer_to_customer", "refund_disputed_payment", "resource_already_exists", "resource_missing", "return_intent_already_processed", "routing_number_invalid", "secret_key_required", "sensitive_data_access_expired", "sepa_unsupported_account", "setup_attempt_failed", "setup_intent_authentication_failure", "setup_intent_invalid_parameter", "setup_intent_mandate_invalid", "setup_intent_mobile_wallet_unsupported", "setup_intent_setup_attempt_expired", "setup_intent_unexpected_state", "shipping_address_invalid", "shipping_calculation_failed", "sku_inactive", "state_unsupported", "status_transition_invalid", "stripe_tax_inactive", "tax_id_invalid", "tax_id_prohibited", "taxes_calculation_failed", "terminal_location_country_unsupported", "terminal_reader_busy", "terminal_reader_collected_data_invalid", "terminal_reader_hardware_fault", "terminal_reader_invalid_location_for_activation", "terminal_reader_invalid_location_for_payment", "terminal_reader_offline", "terminal_reader_timeout", "testmode_charges_only", "tls_version_unsupported", "token_already_used", "token_card_network_invalid", "token_in_use", "transfer_source_balance_parameters_mismatch", "transfers_not_allowed", "url_invalid", "v2_account_disconnection_unsupported", "v2_account_missing_configuration" ], "maxLength": 5000, "type": "string" }, "decline_code": { "description": "For card errors resulting from a card issuer decline, a short string indicating the [card issuer's reason for the decline](https://stripe.com/docs/declines#issuer-declines) if they provide one.", "maxLength": 5000, "type": "string" }, "doc_url": { "description": "A URL to more information about the [error code](https://stripe.com/docs/error-codes) reported.", "maxLength": 5000, "type": "string" }, "message": { "description": "A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.", "maxLength": 40000, "type": "string" }, "network_advice_code": { "description": "For card errors resulting from a card issuer decline, a 2 digit code which indicates the advice given to merchant by the card network on how to proceed with an error.", "maxLength": 5000, "type": "string" }, "network_decline_code": { "description": "For payments declined by the network, an alphanumeric code which indicates the reason the payment failed.", "maxLength": 5000, "type": "string" }, "param": { "description": "If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field.", "maxLength": 5000, "type": "string" }, "payment_intent": { "$ref": "#/components/schemas/payment_intent" }, "payment_method": { "$ref": "#/components/schemas/payment_method" }, "payment_method_type": { "description": "If the error is specific to the type of payment method, the payment method type that had a problem. This field is only populated for invoice-related errors.", "maxLength": 5000, "type": "string" }, "request_log_url": { "description": "A URL to the request log entry in your dashboard.", "maxLength": 5000, "type": "string" }, "setup_intent": { "$ref": "#/components/schemas/setup_intent" }, "source": { "$ref": "#/components/schemas/payment_source" }, "type": { "description": "The type of error returned. One of `api_error`, `card_error`, `idempotency_error`, or `invalid_request_error`", "enum": [ "api_error", "card_error", "idempotency_error", "invalid_request_error" ], "type": "string" } }, "required": [ "type" ], "title": "APIErrors", "type": "object", "x-expandableFields": [ "payment_intent", "payment_method", "setup_intent", "source" ], "x-stripeMostCommon": [ "code", "decline_code", "message", "param", "payment_intent", "type" ], "x-stripeResource": { "class_name": "StripeError", "in_package": "" } }, "apple_pay_domain": { "description": "", "properties": { "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "domain_name": { "maxLength": 5000, "type": "string" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "apple_pay_domain" ], "type": "string" } }, "required": [ "created", "domain_name", "id", "livemode", "object" ], "title": "ApplePayDomain", "type": "object", "x-expandableFields": [], "x-resourceId": "apple_pay_domain", "x-stripeMostCommon": [ "created", "domain_name", "id", "livemode", "object" ], "x-stripeOperations": [ { "method_name": "delete", "method_on": "service", "method_type": "delete", "operation": "delete", "path": "/v1/apple_pay/domains/{domain}" }, { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/apple_pay/domains" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/apple_pay/domains/{domain}" }, { "method_name": "create", "method_on": "service", "method_type": "create", "operation": "post", "path": "/v1/apple_pay/domains" } ], "x-stripeResource": { "class_name": "ApplePayDomain", "has_collection_class": true, "in_package": "" } }, "application": { "description": "", "properties": { "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "name": { "description": "The name of the application.", "maxLength": 5000, "nullable": true, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "application" ], "type": "string" } }, "required": [ "id", "name", "object" ], "title": "Application", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "id", "name", "object" ], "x-stripeResource": { "class_name": "Application", "in_package": "" } }, "application_fee": { "description": "", "properties": { "account": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/account" } ], "description": "ID of the Stripe account this fee was taken from.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/account" } ] } }, "amount": { "description": "Amount earned, in cents (or local equivalent).", "type": "integer" }, "amount_refunded": { "description": "Amount in cents (or local equivalent) refunded (can be less than the amount attribute on the fee if a partial refund was issued)", "type": "integer" }, "application": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/application" } ], "description": "ID of the Connect application that earned the fee.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/application" } ] } }, "balance_transaction": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/balance_transaction" } ], "description": "Balance transaction that describes the impact of this collected application fee on your account balance (not including refunds).", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/balance_transaction" } ] } }, "charge": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/charge" } ], "description": "ID of the charge that the application fee was taken from.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/charge" } ] } }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "fee_source": { "anyOf": [ { "$ref": "#/components/schemas/platform_earning_fee_source" } ], "description": "Polymorphic source of the application fee. Includes the ID of the object the application fee was created from.", "nullable": true }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "application_fee" ], "type": "string" }, "originating_transaction": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/charge" } ], "description": "ID of the corresponding charge on the platform account, if this fee was the result of a charge using the `destination` parameter.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/charge" } ] } }, "refunded": { "description": "Whether the fee has been fully refunded. If the fee is only partially refunded, this attribute will still be false.", "type": "boolean" }, "refunds": { "description": "A list of refunds that have been applied to the fee.", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/fee_refund" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "FeeRefundList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } }, "required": [ "account", "amount", "amount_refunded", "application", "balance_transaction", "charge", "created", "currency", "fee_source", "id", "livemode", "object", "originating_transaction", "refunded", "refunds" ], "title": "PlatformFee", "type": "object", "x-expandableFields": [ "account", "application", "balance_transaction", "charge", "fee_source", "originating_transaction", "refunds" ], "x-resourceId": "application_fee", "x-stripeMostCommon": [ "account", "amount", "amount_refunded", "application", "balance_transaction", "charge", "created", "currency", "fee_source", "id", "livemode", "object", "originating_transaction", "refunded", "refunds" ], "x-stripeOperations": [ { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/application_fees" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/application_fees/{id}" } ], "x-stripeResource": { "class_name": "ApplicationFee", "has_collection_class": true, "in_package": "", "polymorphic_groups": [ "balance_transaction_source" ] } }, "application_fee.created": { "description": "Occurs whenever an application fee is created on a charge.", "properties": { "object": { "$ref": "#/components/schemas/application_fee" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "application_fee.created" } }, "application_fee.refund.updated": { "description": "Occurs whenever an application fee refund is updated.", "properties": { "object": { "$ref": "#/components/schemas/fee_refund" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "application_fee.refund.updated" } }, "application_fee.refunded": { "description": "Occurs whenever an application fee is refunded, whether from refunding a charge or from [refunding the application fee directly](#fee_refunds). This includes partial refunds.", "properties": { "object": { "$ref": "#/components/schemas/application_fee" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "application_fee.refunded" } }, "apps.secret": { "description": "Secret Store is an API that allows Stripe Apps developers to securely persist secrets for use by UI Extensions and app backends.\n\nThe primary resource in Secret Store is a `secret`. Other apps can't view secrets created by an app. Additionally, secrets are scoped to provide further permission control.\n\nAll Dashboard users and the app backend share `account` scoped secrets. Use the `account` scope for secrets that don't change per-user, like a third-party API key.\n\nA `user` scoped secret is accessible by the app backend and one specific Dashboard user. Use the `user` scope for per-user secrets like per-user OAuth tokens, where different users might have different permissions.\n\nRelated guide: [Store data between page reloads](https://stripe.com/docs/stripe-apps/store-auth-data-custom-objects)", "properties": { "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "deleted": { "description": "If true, indicates that this secret has been deleted", "type": "boolean" }, "expires_at": { "description": "The Unix timestamp for the expiry time of the secret, after which the secret deletes.", "format": "unix-time", "nullable": true, "type": "integer" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "name": { "description": "A name for the secret that's unique within the scope.", "maxLength": 5000, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "apps.secret" ], "type": "string" }, "payload": { "description": "The plaintext secret value to be stored.", "maxLength": 5000, "nullable": true, "type": "string" }, "scope": { "$ref": "#/components/schemas/secret_service_resource_scope" } }, "required": [ "created", "expires_at", "id", "livemode", "name", "object", "scope" ], "title": "SecretServiceResourceSecret", "type": "object", "x-expandableFields": [ "scope" ], "x-resourceId": "apps.secret", "x-stripeMostCommon": [ "created", "deleted", "expires_at", "id", "livemode", "name", "object", "payload", "scope" ], "x-stripeOperations": [ { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/apps/secrets" }, { "method_name": "find", "method_on": "service", "method_type": "custom", "operation": "get", "path": "/v1/apps/secrets/find" }, { "method_name": "create", "method_on": "service", "method_type": "create", "operation": "post", "path": "/v1/apps/secrets" }, { "method_name": "delete_where", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/apps/secrets/delete" } ], "x-stripeResource": { "class_name": "Secret", "has_collection_class": true, "in_package": "Apps" } }, "automatic_tax": { "description": "", "properties": { "disabled_reason": { "description": "If Stripe disabled automatic tax, this enum describes why.", "enum": [ "finalization_requires_location_inputs", "finalization_system_error" ], "nullable": true, "type": "string" }, "enabled": { "description": "Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified [tax rates](https://stripe.com/docs/api/tax_rates), negative amounts, or `tax_behavior=unspecified`) cannot be added to automatic tax invoices.", "type": "boolean" }, "liability": { "anyOf": [ { "$ref": "#/components/schemas/connect_account_reference" } ], "description": "The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.", "nullable": true }, "provider": { "description": "The tax provider powering automatic tax.", "maxLength": 5000, "nullable": true, "type": "string" }, "status": { "description": "The status of the most recent automated tax calculation for this invoice.", "enum": [ "complete", "failed", "requires_location_inputs" ], "nullable": true, "type": "string" } }, "required": [ "disabled_reason", "enabled", "liability", "provider", "status" ], "title": "AutomaticTax", "type": "object", "x-expandableFields": [ "liability" ], "x-stripeMostCommon": [ "disabled_reason", "enabled", "liability", "provider", "status" ] }, "balance": { "description": "This is an object representing your Stripe balance. You can retrieve it to see\nthe balance currently on your Stripe account.\n\nThe top-level `available` and `pending` comprise your \"payments balance.\"\n\nRelated guide: [Balances and settlement time](https://stripe.com/docs/payments/balances), [Understanding Connect account balances](https://stripe.com/docs/connect/account-balances)", "properties": { "available": { "description": "Available funds that you can transfer or pay out automatically by Stripe or explicitly through the [Transfers API](https://stripe.com/docs/api#transfers) or [Payouts API](https://stripe.com/docs/api#payouts). You can find the available balance for each currency and payment type in the `source_types` property.", "items": { "$ref": "#/components/schemas/balance_amount" }, "type": "array" }, "connect_reserved": { "description": "Funds held due to negative balances on connected accounts where [account.controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. You can find the connect reserve balance for each currency and payment type in the `source_types` property.", "items": { "$ref": "#/components/schemas/balance_amount" }, "type": "array" }, "instant_available": { "description": "Funds that you can pay out using Instant Payouts.", "items": { "$ref": "#/components/schemas/balance_amount_net" }, "type": "array" }, "issuing": { "$ref": "#/components/schemas/balance_detail" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "balance" ], "type": "string" }, "pending": { "description": "Funds that aren't available in the balance yet. You can find the pending balance for each currency and each payment type in the `source_types` property.", "items": { "$ref": "#/components/schemas/balance_amount" }, "type": "array" }, "refund_and_dispute_prefunding": { "$ref": "#/components/schemas/balance_detail_ungated" } }, "required": [ "available", "livemode", "object", "pending" ], "title": "Balance", "type": "object", "x-expandableFields": [ "available", "connect_reserved", "instant_available", "issuing", "pending", "refund_and_dispute_prefunding" ], "x-resourceId": "balance", "x-stripeMostCommon": [ "available", "pending" ], "x-stripeOperations": [ { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/balance" } ], "x-stripeResource": { "class_name": "Balance", "in_package": "" } }, "balance.available": { "description": "Occurs whenever your Stripe balance has been updated (e.g., when a charge is available to be paid out). By default, Stripe automatically transfers funds in your balance to your bank account on a daily basis. This event is not fired for negative transactions.", "properties": { "object": { "$ref": "#/components/schemas/balance" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "balance.available" } }, "balance_amount": { "description": "", "properties": { "amount": { "description": "Balance amount.", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "source_types": { "$ref": "#/components/schemas/balance_amount_by_source_type" } }, "required": [ "amount", "currency" ], "title": "BalanceAmount", "type": "object", "x-expandableFields": [ "source_types" ], "x-stripeMostCommon": [ "amount", "currency", "source_types" ] }, "balance_amount_by_source_type": { "description": "", "properties": { "bank_account": { "description": "Amount coming from [legacy US ACH payments](https://docs.stripe.com/ach-deprecated).", "type": "integer" }, "card": { "description": "Amount coming from most payment methods, including cards as well as [non-legacy bank debits](https://docs.stripe.com/payments/bank-debits).", "type": "integer" }, "fpx": { "description": "Amount coming from [FPX](https://docs.stripe.com/payments/fpx), a Malaysian payment method.", "type": "integer" } }, "title": "BalanceAmountBySourceType", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "bank_account", "card", "fpx" ] }, "balance_amount_net": { "description": "", "properties": { "amount": { "description": "Balance amount.", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "net_available": { "description": "Breakdown of balance by destination.", "items": { "$ref": "#/components/schemas/balance_net_available" }, "type": "array" }, "source_types": { "$ref": "#/components/schemas/balance_amount_by_source_type" } }, "required": [ "amount", "currency" ], "title": "BalanceAmountNet", "type": "object", "x-expandableFields": [ "net_available", "source_types" ], "x-stripeMostCommon": [ "amount", "currency", "net_available", "source_types" ] }, "balance_detail": { "description": "", "properties": { "available": { "description": "Funds that are available for use.", "items": { "$ref": "#/components/schemas/balance_amount" }, "type": "array" } }, "required": [ "available" ], "title": "BalanceDetail", "type": "object", "x-expandableFields": [ "available" ], "x-stripeMostCommon": [ "available" ] }, "balance_detail_ungated": { "description": "", "properties": { "available": { "description": "Funds that are available for use.", "items": { "$ref": "#/components/schemas/balance_amount" }, "type": "array" }, "pending": { "description": "Funds that are pending", "items": { "$ref": "#/components/schemas/balance_amount" }, "type": "array" } }, "required": [ "available", "pending" ], "title": "BalanceDetailUngated", "type": "object", "x-expandableFields": [ "available", "pending" ], "x-stripeMostCommon": [ "available", "pending" ] }, "balance_net_available": { "description": "", "properties": { "amount": { "description": "Net balance amount, subtracting fees from platform-set pricing.", "type": "integer" }, "destination": { "description": "ID of the external account for this net balance (not expandable).", "maxLength": 5000, "type": "string" }, "source_types": { "$ref": "#/components/schemas/balance_amount_by_source_type" } }, "required": [ "amount", "destination" ], "title": "BalanceNetAvailable", "type": "object", "x-expandableFields": [ "source_types" ], "x-stripeMostCommon": [ "amount", "destination", "source_types" ] }, "balance_settings": { "description": "Options for customizing account balances and payout settings for a Stripe platform’s connected accounts.\n\nThis API is only available for users enrolled in the public preview for Accounts v2 on Stripe Connect.\nIf you are not in this preview, please use the [Accounts v1 API](https://docs.stripe.com/api/accounts?api-version=2025-03-31.basil)\nto manage your connected accounts’ balance settings instead.", "properties": { "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "balance_settings" ], "type": "string" }, "payments": { "$ref": "#/components/schemas/balance_settings_resource_payments" } }, "required": [ "object", "payments" ], "title": "BalanceSettingsResourceBalanceSettings", "type": "object", "x-expandableFields": [ "payments" ], "x-resourceId": "balance_settings", "x-stripeMostCommon": [ "object", "payments" ], "x-stripeOperations": [ { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/balance_settings" }, { "method_name": "update", "method_on": "service", "method_type": "update", "operation": "post", "path": "/v1/balance_settings" } ], "x-stripeResource": { "class_name": "BalanceSettings", "in_package": "" } }, "balance_settings.updated": { "description": "Occurs whenever a balance settings status or property has changed.", "properties": { "object": { "$ref": "#/components/schemas/balance_settings" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "balance_settings.updated" } }, "balance_settings_resource_payments": { "description": "", "properties": { "debit_negative_balances": { "description": "A Boolean indicating if Stripe should try to reclaim negative balances from an attached bank account. See [Understanding Connect account balances](/connect/account-balances) for details. The default value is `false` when [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts, otherwise `true`.", "nullable": true, "type": "boolean" }, "payouts": { "anyOf": [ { "$ref": "#/components/schemas/balance_settings_resource_payouts" } ], "description": "Settings specific to the account's payouts.", "nullable": true }, "settlement_timing": { "$ref": "#/components/schemas/balance_settings_resource_settlement_timing" } }, "required": [ "debit_negative_balances", "payouts", "settlement_timing" ], "title": "BalanceSettingsResourcePayments", "type": "object", "x-expandableFields": [ "payouts", "settlement_timing" ], "x-stripeMostCommon": [ "debit_negative_balances", "payouts", "settlement_timing" ] }, "balance_settings_resource_payout_schedule": { "description": "", "properties": { "interval": { "description": "How frequently funds will be paid out. One of `manual` (payouts only created via API call), `daily`, `weekly`, or `monthly`.", "enum": [ "daily", "manual", "monthly", "weekly" ], "nullable": true, "type": "string" }, "monthly_payout_days": { "description": "The day of the month funds will be paid out. Only shown if `interval` is monthly. Payouts scheduled between the 29th and 31st of the month are sent on the last day of shorter months.", "items": { "type": "integer" }, "type": "array" }, "weekly_payout_days": { "description": "The days of the week when available funds are paid out, specified as an array, for example, [`monday`, `tuesday`]. Only shown if `interval` is weekly.", "items": { "enum": [ "friday", "monday", "thursday", "tuesday", "wednesday" ], "type": "string", "x-stripeBypassValidation": true }, "type": "array" } }, "required": [ "interval" ], "title": "BalanceSettingsResourcePayoutSchedule", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "interval", "monthly_payout_days", "weekly_payout_days" ] }, "balance_settings_resource_payouts": { "description": "", "properties": { "minimum_balance_by_currency": { "additionalProperties": { "type": "integer" }, "description": "The minimum balance amount to retain per currency after automatic payouts. Only funds that exceed these amounts are paid out. Learn more about the [minimum balances for automatic payouts](/payouts/minimum-balances-for-automatic-payouts).", "nullable": true, "type": "object" }, "schedule": { "anyOf": [ { "$ref": "#/components/schemas/balance_settings_resource_payout_schedule" } ], "description": "Details on when funds from charges are available, and when they are paid out to an external account. See our [Setting Bank and Debit Card Payouts](https://stripe.com/docs/connect/bank-transfers#payout-information) documentation for details.", "nullable": true }, "statement_descriptor": { "description": "The text that appears on the bank account statement for payouts. If not set, this defaults to the platform's bank descriptor as set in the Dashboard.", "maxLength": 5000, "nullable": true, "type": "string" }, "status": { "description": "Whether the funds in this account can be paid out.", "enum": [ "disabled", "enabled" ], "type": "string" } }, "required": [ "minimum_balance_by_currency", "schedule", "statement_descriptor", "status" ], "title": "BalanceSettingsResourcePayouts", "type": "object", "x-expandableFields": [ "schedule" ], "x-stripeMostCommon": [ "minimum_balance_by_currency", "schedule", "statement_descriptor", "status" ] }, "balance_settings_resource_settlement_timing": { "description": "", "properties": { "delay_days": { "description": "The number of days charge funds are held before becoming available.", "type": "integer" } }, "required": [ "delay_days" ], "title": "BalanceSettingsResourceSettlementTiming", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "delay_days" ] }, "balance_transaction": { "description": "Balance transactions represent funds moving through your Stripe account.\nStripe creates them for every type of transaction that enters or leaves your Stripe account balance.\n\nRelated guide: [Balance transaction types](https://stripe.com/docs/reports/balance-transaction-types)", "properties": { "amount": { "description": "Gross amount of this transaction (in cents (or local equivalent)). A positive value represents funds charged to another party, and a negative value represents funds sent to another party.", "type": "integer" }, "available_on": { "description": "The date that the transaction's net funds become available in the Stripe balance.", "format": "unix-time", "type": "integer" }, "balance_type": { "description": "The balance that this transaction impacts.", "enum": [ "issuing", "payments", "refund_and_dispute_prefunding" ], "type": "string", "x-stripeBypassValidation": true }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users.", "maxLength": 5000, "nullable": true, "type": "string" }, "exchange_rate": { "description": "If applicable, this transaction uses an exchange rate. If money converts from currency A to currency B, then the `amount` in currency A, multipled by the `exchange_rate`, equals the `amount` in currency B. For example, if you charge a customer 10.00 EUR, the PaymentIntent's `amount` is `1000` and `currency` is `eur`. If this converts to 12.34 USD in your Stripe account, the BalanceTransaction's `amount` is `1234`, its `currency` is `usd`, and the `exchange_rate` is `1.234`.", "nullable": true, "type": "number" }, "fee": { "description": "Fees (in cents (or local equivalent)) paid for this transaction. Represented as a positive integer when assessed.", "type": "integer" }, "fee_details": { "description": "Detailed breakdown of fees (in cents (or local equivalent)) paid for this transaction.", "items": { "$ref": "#/components/schemas/fee" }, "type": "array" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "net": { "description": "Net impact to a Stripe balance (in cents (or local equivalent)). A positive value represents incrementing a Stripe balance, and a negative value decrementing a Stripe balance. You can calculate the net impact of a transaction on a balance by `amount` - `fee`", "type": "integer" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "balance_transaction" ], "type": "string" }, "reporting_category": { "description": "Learn more about how [reporting categories](https://stripe.com/docs/reports/reporting-categories) can help you understand balance transactions from an accounting perspective.", "maxLength": 5000, "type": "string" }, "source": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/balance_transaction_source" } ], "description": "This transaction relates to the Stripe object.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/balance_transaction_source" } ] } }, "status": { "description": "The transaction's net funds status in the Stripe balance, which are either `available` or `pending`.", "maxLength": 5000, "type": "string" }, "type": { "description": "Transaction type: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `climate_order_purchase`, `climate_order_refund`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_outbound`, `obligation_reversal_inbound`, `payment`, `payment_failure_refund`, `payment_network_reserve_hold`, `payment_network_reserve_release`, `payment_refund`, `payment_reversal`, `payment_unreconciled`, `payout`, `payout_cancel`, `payout_failure`, `payout_minimum_balance_hold`, `payout_minimum_balance_release`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `stripe_balance_payment_debit`, `stripe_balance_payment_debit_reversal`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`. Learn more about [balance transaction types and what they represent](https://stripe.com/docs/reports/balance-transaction-types). To classify transactions for accounting purposes, consider `reporting_category` instead.", "enum": [ "adjustment", "advance", "advance_funding", "anticipation_repayment", "application_fee", "application_fee_refund", "charge", "climate_order_purchase", "climate_order_refund", "connect_collection_transfer", "contribution", "issuing_authorization_hold", "issuing_authorization_release", "issuing_dispute", "issuing_transaction", "obligation_outbound", "obligation_reversal_inbound", "payment", "payment_failure_refund", "payment_network_reserve_hold", "payment_network_reserve_release", "payment_refund", "payment_reversal", "payment_unreconciled", "payout", "payout_cancel", "payout_failure", "payout_minimum_balance_hold", "payout_minimum_balance_release", "refund", "refund_failure", "reserve_transaction", "reserved_funds", "stripe_balance_payment_debit", "stripe_balance_payment_debit_reversal", "stripe_fee", "stripe_fx_fee", "tax_fee", "topup", "topup_reversal", "transfer", "transfer_cancel", "transfer_failure", "transfer_refund" ], "type": "string" } }, "required": [ "amount", "available_on", "created", "currency", "description", "exchange_rate", "fee", "fee_details", "id", "net", "object", "reporting_category", "source", "status", "type" ], "title": "BalanceTransaction", "type": "object", "x-expandableFields": [ "fee_details", "source" ], "x-resourceId": "balance_transaction", "x-stripeMostCommon": [ "amount", "currency", "description", "fee", "fee_details", "id", "net", "source", "status", "type" ], "x-stripeOperations": [ { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/balance_transactions" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/balance_transactions/{id}" } ], "x-stripeResource": { "class_name": "BalanceTransaction", "has_collection_class": true, "in_package": "" } }, "balance_transaction_source": { "anyOf": [ { "$ref": "#/components/schemas/application_fee" }, { "$ref": "#/components/schemas/charge" }, { "$ref": "#/components/schemas/connect_collection_transfer" }, { "$ref": "#/components/schemas/customer_cash_balance_transaction" }, { "$ref": "#/components/schemas/dispute" }, { "$ref": "#/components/schemas/fee_refund" }, { "$ref": "#/components/schemas/issuing.authorization" }, { "$ref": "#/components/schemas/issuing.dispute" }, { "$ref": "#/components/schemas/issuing.transaction" }, { "$ref": "#/components/schemas/payout" }, { "$ref": "#/components/schemas/refund" }, { "$ref": "#/components/schemas/reserve_transaction" }, { "$ref": "#/components/schemas/tax_deducted_at_source" }, { "$ref": "#/components/schemas/topup" }, { "$ref": "#/components/schemas/transfer" }, { "$ref": "#/components/schemas/transfer_reversal" } ], "title": "Polymorphic", "x-stripeBypassValidation": true, "x-stripeResource": { "class_name": "BalanceTransactionSource" } }, "bank_account": { "description": "These bank accounts are payment methods on `Customer` objects.\n\nOn the other hand [External Accounts](/api#external_accounts) are transfer\ndestinations on `Account` objects for connected accounts.\nThey can be bank accounts or debit cards as well, and are documented in the links above.\n\nRelated guide: [Bank debits and transfers](/payments/bank-debits-transfers)", "properties": { "account": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/account" } ], "description": "The account this bank account belongs to. Only applicable on Accounts (not customers or recipients) This property is only available when returned as an [External Account](/api/external_account_bank_accounts/object) where [controller.is_controller](/api/accounts/object#account_object-controller-is_controller) is `true`.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/account" } ] } }, "account_holder_name": { "description": "The name of the person or business that owns the bank account.", "maxLength": 5000, "nullable": true, "type": "string" }, "account_holder_type": { "description": "The type of entity that holds the account. This can be either `individual` or `company`.", "maxLength": 5000, "nullable": true, "type": "string" }, "account_type": { "description": "The bank account type. This can only be `checking` or `savings` in most countries. In Japan, this can only be `futsu` or `toza`.", "maxLength": 5000, "nullable": true, "type": "string" }, "available_payout_methods": { "description": "A set of available payout methods for this bank account. Only values from this set should be passed as the `method` when creating a payout.", "items": { "enum": [ "instant", "standard" ], "type": "string" }, "nullable": true, "type": "array" }, "bank_name": { "description": "Name of the bank associated with the routing number (e.g., `WELLS FARGO`).", "maxLength": 5000, "nullable": true, "type": "string" }, "country": { "description": "Two-letter ISO code representing the country the bank account is located in.", "maxLength": 5000, "type": "string" }, "currency": { "description": "Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account.", "format": "currency", "type": "string" }, "customer": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/customer" }, { "$ref": "#/components/schemas/deleted_customer" } ], "description": "The ID of the customer that the bank account is associated with.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/customer" }, { "$ref": "#/components/schemas/deleted_customer" } ] } }, "default_for_currency": { "description": "Whether this bank account is the default external account for its currency.", "nullable": true, "type": "boolean" }, "fingerprint": { "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.", "maxLength": 5000, "nullable": true, "type": "string" }, "future_requirements": { "anyOf": [ { "$ref": "#/components/schemas/external_account_requirements" } ], "description": "Information about the [upcoming new requirements for the bank account](https://stripe.com/docs/connect/custom-accounts/future-requirements), including what information needs to be collected, and by when.", "nullable": true }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "last4": { "description": "The last four digits of the bank account number.", "maxLength": 5000, "type": "string" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "nullable": true, "type": "object" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "bank_account" ], "type": "string" }, "requirements": { "anyOf": [ { "$ref": "#/components/schemas/external_account_requirements" } ], "description": "Information about the requirements for the bank account, including what information needs to be collected.", "nullable": true }, "routing_number": { "description": "The routing transit number for the bank account.", "maxLength": 5000, "nullable": true, "type": "string" }, "status": { "description": "For bank accounts, possible values are `new`, `validated`, `verified`, `verification_failed`, or `errored`. A bank account that hasn't had any activity or validation performed is `new`. If Stripe can determine that the bank account exists, its status will be `validated`. Note that there often isn’t enough information to know (e.g., for smaller credit unions), and the validation is not always run. If customer bank account verification has succeeded, the bank account status will be `verified`. If the verification failed for any reason, such as microdeposit failure, the status will be `verification_failed`. If a payout sent to this bank account fails, we'll set the status to `errored` and will not continue to send [scheduled payouts](https://stripe.com/docs/payouts#payout-schedule) until the bank details are updated.\n\nFor external accounts, possible values are `new`, `errored` and `verification_failed`. If a payout fails, the status is set to `errored` and scheduled payouts are stopped until account details are updated. In the US and India, if we can't [verify the owner of the bank account](https://support.stripe.com/questions/bank-account-ownership-verification), we'll set the status to `verification_failed`. Other validations aren't run against external accounts because they're only used for payouts. This means the other statuses don't apply.", "maxLength": 5000, "type": "string" } }, "required": [ "account_holder_name", "account_holder_type", "account_type", "bank_name", "country", "currency", "fingerprint", "id", "last4", "object", "routing_number", "status" ], "title": "BankAccount", "type": "object", "x-expandableFields": [ "account", "customer", "future_requirements", "requirements" ], "x-resourceId": "bank_account", "x-stripeMostCommon": [ "account_holder_name", "account_holder_type", "bank_name", "country", "currency", "customer", "fingerprint", "id", "last4", "metadata", "routing_number" ], "x-stripeOperations": [ { "method_name": "delete", "method_on": "service", "method_type": "delete", "operation": "delete", "path": "/v1/accounts/{account}/external_accounts/{id}" }, { "method_name": "delete", "method_on": "service", "method_type": "delete", "operation": "delete", "path": "/v1/customers/{customer}/sources/{id}" }, { "method_name": "update", "method_on": "service", "method_type": "update", "operation": "post", "path": "/v1/accounts/{account}/external_accounts/{id}" }, { "method_name": "update", "method_on": "service", "method_type": "update", "operation": "post", "path": "/v1/customers/{customer}/sources/{id}" }, { "method_name": "verify", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/customers/{customer}/sources/{id}/verify" } ], "x-stripeResource": { "class_name": "BankAccount", "in_package": "", "polymorphic_groups": [ "deleted_external_account", "deleted_payment_source", "external_account", "payment_source" ] } }, "bank_connections_resource_accountholder": { "description": "", "properties": { "account": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/account" } ], "description": "The ID of the Stripe account this account belongs to. Should only be present if `account_holder.type` is `account`.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/account" } ] } }, "customer": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/customer" } ], "description": "ID of the Stripe customer this account belongs to. Present if and only if `account_holder.type` is `customer`.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/customer" } ] } }, "customer_account": { "maxLength": 5000, "type": "string" }, "type": { "description": "Type of account holder that this account belongs to.", "enum": [ "account", "customer" ], "type": "string" } }, "required": [ "type" ], "title": "BankConnectionsResourceAccountholder", "type": "object", "x-expandableFields": [ "account", "customer" ], "x-stripeMostCommon": [ "account", "customer", "customer_account", "type" ] }, "bank_connections_resource_balance": { "description": "", "properties": { "as_of": { "description": "The time that the external institution calculated this balance. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "cash": { "$ref": "#/components/schemas/bank_connections_resource_balance_api_resource_cash_balance" }, "credit": { "$ref": "#/components/schemas/bank_connections_resource_balance_api_resource_credit_balance" }, "current": { "additionalProperties": { "type": "integer" }, "description": "The balances owed to (or by) the account holder, before subtracting any outbound pending transactions or adding any inbound pending transactions.\n\nEach key is a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.\n\nEach value is a integer amount. A positive amount indicates money owed to the account holder. A negative amount indicates money owed by the account holder.", "type": "object" }, "type": { "description": "The `type` of the balance. An additional hash is included on the balance with a name matching this value.", "enum": [ "cash", "credit" ], "type": "string" } }, "required": [ "as_of", "current", "type" ], "title": "BankConnectionsResourceBalance", "type": "object", "x-expandableFields": [ "cash", "credit" ], "x-stripeMostCommon": [ "as_of", "cash", "credit", "current", "type" ] }, "bank_connections_resource_balance_api_resource_cash_balance": { "description": "", "properties": { "available": { "additionalProperties": { "type": "integer" }, "description": "The funds available to the account holder. Typically this is the current balance after subtracting any outbound pending transactions and adding any inbound pending transactions.\n\nEach key is a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.\n\nEach value is a integer amount. A positive amount indicates money owed to the account holder. A negative amount indicates money owed by the account holder.", "nullable": true, "type": "object" } }, "required": [ "available" ], "title": "BankConnectionsResourceBalanceAPIResourceCashBalance", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "available" ] }, "bank_connections_resource_balance_api_resource_credit_balance": { "description": "", "properties": { "used": { "additionalProperties": { "type": "integer" }, "description": "The credit that has been used by the account holder.\n\nEach key is a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.\n\nEach value is a integer amount. A positive amount indicates money owed to the account holder. A negative amount indicates money owed by the account holder.", "nullable": true, "type": "object" } }, "required": [ "used" ], "title": "BankConnectionsResourceBalanceAPIResourceCreditBalance", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "used" ] }, "bank_connections_resource_balance_refresh": { "description": "", "properties": { "last_attempted_at": { "description": "The time at which the last refresh attempt was initiated. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "next_refresh_available_at": { "description": "Time at which the next balance refresh can be initiated. This value will be `null` when `status` is `pending`. Measured in seconds since the Unix epoch.", "format": "unix-time", "nullable": true, "type": "integer" }, "status": { "description": "The status of the last refresh attempt.", "enum": [ "failed", "pending", "succeeded" ], "type": "string" } }, "required": [ "last_attempted_at", "next_refresh_available_at", "status" ], "title": "BankConnectionsResourceBalanceRefresh", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "last_attempted_at", "next_refresh_available_at", "status" ] }, "bank_connections_resource_inferred_balances_refresh": { "description": "", "properties": { "last_attempted_at": { "description": "The time at which the last refresh attempt was initiated. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "next_refresh_available_at": { "description": "Time at which the next inferred balance refresh can be initiated. This value will be `null` when `status` is `pending`. Measured in seconds since the Unix epoch.", "format": "unix-time", "nullable": true, "type": "integer" }, "status": { "description": "The status of the last refresh attempt.", "enum": [ "failed", "pending", "succeeded" ], "type": "string" } }, "required": [ "last_attempted_at", "next_refresh_available_at", "status" ], "title": "BankConnectionsResourceInferredBalancesRefresh", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "last_attempted_at", "next_refresh_available_at", "status" ] }, "bank_connections_resource_institution_feature_support": { "description": "", "properties": { "balances": { "$ref": "#/components/schemas/bank_connections_resource_institution_supported_feature" }, "ownership": { "$ref": "#/components/schemas/bank_connections_resource_institution_supported_feature" }, "payment_method": { "$ref": "#/components/schemas/bank_connections_resource_institution_supported_feature" }, "transactions": { "$ref": "#/components/schemas/bank_connections_resource_institution_supported_feature" } }, "required": [ "balances", "ownership", "payment_method", "transactions" ], "title": "BankConnectionsResourceInstitutionFeatureSupport", "type": "object", "x-expandableFields": [ "balances", "ownership", "payment_method", "transactions" ], "x-stripeMostCommon": [ "balances", "ownership", "payment_method", "transactions" ] }, "bank_connections_resource_institution_supported_feature": { "description": "", "properties": { "supported": { "description": "Whether the given feature is supported by this institution.", "type": "boolean" } }, "required": [ "supported" ], "title": "BankConnectionsResourceInstitutionSupportedFeature", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "supported" ] }, "bank_connections_resource_link_account_session_filters": { "description": "", "properties": { "account_subcategories": { "description": "Restricts the Session to subcategories of accounts that can be linked. Valid subcategories are: `checking`, `savings`, `mortgage`, `line_of_credit`, `credit_card`.", "items": { "enum": [ "checking", "credit_card", "line_of_credit", "mortgage", "savings" ], "type": "string" }, "nullable": true, "type": "array" }, "countries": { "description": "List of countries from which to filter accounts.", "items": { "maxLength": 5000, "type": "string" }, "nullable": true, "type": "array" }, "institution": { "description": "Stripe ID of the institution with which the customer should be directed to log in.", "maxLength": 5000, "type": "string" } }, "required": [ "account_subcategories", "countries" ], "title": "BankConnectionsResourceLinkAccountSessionFilters", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "account_subcategories", "countries", "institution" ] }, "bank_connections_resource_link_account_session_limits": { "description": "", "properties": { "accounts": { "description": "The number of accounts that can be linked in this Session.", "type": "integer" } }, "required": [ "accounts" ], "title": "BankConnectionsResourceLinkAccountSessionLimits", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "accounts" ] }, "bank_connections_resource_link_account_session_manual_entry": { "description": "", "properties": {}, "title": "BankConnectionsResourceLinkAccountSessionManualEntry", "type": "object", "x-expandableFields": [] }, "bank_connections_resource_link_account_session_status_details": { "description": "", "properties": { "cancelled": { "$ref": "#/components/schemas/bank_connections_resource_link_account_session_status_details_resource_cancelled_status_details" } }, "title": "BankConnectionsResourceLinkAccountSessionStatusDetails", "type": "object", "x-expandableFields": [ "cancelled" ], "x-stripeMostCommon": [ "cancelled" ] }, "bank_connections_resource_link_account_session_status_details_resource_cancelled_status_details": { "description": "", "properties": { "reason": { "description": "The reason for the Session being cancelled.", "enum": [ "custom_manual_entry", "other" ], "type": "string" } }, "required": [ "reason" ], "title": "BankConnectionsResourceLinkAccountSessionStatusDetailsResourceCancelledStatusDetails", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "reason" ] }, "bank_connections_resource_ownership_refresh": { "description": "", "properties": { "last_attempted_at": { "description": "The time at which the last refresh attempt was initiated. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "next_refresh_available_at": { "description": "Time at which the next ownership refresh can be initiated. This value will be `null` when `status` is `pending`. Measured in seconds since the Unix epoch.", "format": "unix-time", "nullable": true, "type": "integer" }, "status": { "description": "The status of the last refresh attempt.", "enum": [ "failed", "pending", "succeeded" ], "type": "string" } }, "required": [ "last_attempted_at", "next_refresh_available_at", "status" ], "title": "BankConnectionsResourceOwnershipRefresh", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "last_attempted_at", "next_refresh_available_at", "status" ] }, "bank_connections_resource_transaction_refresh": { "description": "", "properties": { "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "last_attempted_at": { "description": "The time at which the last refresh attempt was initiated. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "next_refresh_available_at": { "description": "Time at which the next transaction refresh can be initiated. This value will be `null` when `status` is `pending`. Measured in seconds since the Unix epoch.", "format": "unix-time", "nullable": true, "type": "integer" }, "status": { "description": "The status of the last refresh attempt.", "enum": [ "failed", "pending", "succeeded" ], "type": "string" } }, "required": [ "id", "last_attempted_at", "next_refresh_available_at", "status" ], "title": "BankConnectionsResourceTransactionRefresh", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "id", "last_attempted_at", "next_refresh_available_at", "status" ] }, "bank_connections_resource_transaction_resource_status_transitions": { "description": "", "properties": { "posted_at": { "description": "Time at which this transaction posted. Measured in seconds since the Unix epoch.", "format": "unix-time", "nullable": true, "type": "integer" }, "void_at": { "description": "Time at which this transaction was voided. Measured in seconds since the Unix epoch.", "format": "unix-time", "nullable": true, "type": "integer" } }, "required": [ "posted_at", "void_at" ], "title": "BankConnectionsResourceTransactionResourceStatusTransitions", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "posted_at", "void_at" ] }, "billing.alert": { "description": "A billing alert is a resource that notifies you when a certain usage threshold on a meter is crossed. For example, you might create a billing alert to notify you when a certain user made 100 API requests.", "properties": { "alert_type": { "description": "Defines the type of the alert.", "enum": [ "usage_threshold" ], "type": "string", "x-stripeBypassValidation": true }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "billing.alert" ], "type": "string" }, "status": { "description": "Status of the alert. This can be active, inactive or archived.", "enum": [ "active", "archived", "inactive" ], "nullable": true, "type": "string" }, "title": { "description": "Title of the alert.", "maxLength": 5000, "type": "string" }, "usage_threshold": { "anyOf": [ { "$ref": "#/components/schemas/thresholds_resource_usage_threshold_config" } ], "description": "Encapsulates configuration of the alert to monitor usage on a specific [Billing Meter](https://stripe.com/docs/api/billing/meter).", "nullable": true } }, "required": [ "alert_type", "id", "livemode", "object", "status", "title", "usage_threshold" ], "title": "ThresholdsResourceAlert", "type": "object", "x-expandableFields": [ "usage_threshold" ], "x-resourceId": "billing.alert", "x-stripeMostCommon": [ "alert_type", "id", "livemode", "object", "status", "title", "usage_threshold" ], "x-stripeOperations": [ { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/billing/alerts" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/billing/alerts/{id}" }, { "method_name": "create", "method_on": "service", "method_type": "create", "operation": "post", "path": "/v1/billing/alerts" }, { "method_name": "activate", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/billing/alerts/{id}/activate" }, { "method_name": "archive", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/billing/alerts/{id}/archive" }, { "method_name": "deactivate", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/billing/alerts/{id}/deactivate" } ], "x-stripeResource": { "class_name": "Alert", "has_collection_class": true, "in_package": "Billing" } }, "billing.alert.triggered": { "description": "Occurs whenever your custom alert threshold is met.", "properties": { "object": { "$ref": "#/components/schemas/billing.alert_triggered" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "billing.alert.triggered" } }, "billing.alert_triggered": { "description": "", "properties": { "alert": { "$ref": "#/components/schemas/billing.alert" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "customer": { "description": "ID of customer for which the alert triggered", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "billing.alert_triggered" ], "type": "string" }, "value": { "description": "The value triggering the alert", "format": "decimal", "type": "string" } }, "required": [ "alert", "created", "customer", "livemode", "object", "value" ], "title": "ThresholdsResourceAlert", "type": "object", "x-expandableFields": [ "alert" ], "x-stripeMostCommon": [ "alert", "created", "customer", "livemode", "object", "value" ], "x-stripeResource": { "class_name": "AlertTriggered", "in_package": "Billing" } }, "billing.analytics.meter_usage": { "description": "A billing meter usage event represents an aggregated view of a customer’s billing meter events within a specified timeframe.", "properties": { "data": { "description": "The aggregated meter usage data for the specified customer and time range.", "items": { "$ref": "#/components/schemas/billing.analytics.meter_usage_row" }, "type": "array" }, "data_refreshed_at": { "description": "Timestamp indicating how fresh the data is. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "billing.analytics.meter_usage" ], "type": "string" } }, "required": [ "data", "data_refreshed_at", "livemode", "object" ], "title": "BillingOverviewResourcesBillingMeterUsage", "type": "object", "x-expandableFields": [ "data" ], "x-resourceId": "billing.analytics.meter_usage", "x-stripeMostCommon": [ "data", "data_refreshed_at", "livemode", "object" ], "x-stripeOperations": [ { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/billing/analytics/meter_usage" } ], "x-stripeResource": { "class_name": "MeterUsage", "in_package": "Billing.analytics" } }, "billing.analytics.meter_usage_row": { "description": "", "properties": { "bucket_end_time": { "description": "Timestamp indicating the end of the bucket. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "bucket_start_time": { "description": "Timestamp indicating the start of the bucket. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "bucket_value": { "description": "The aggregated meter usage value for the specified bucket.", "type": "number" }, "dimensions": { "additionalProperties": { "maxLength": 5000, "type": "string" }, "description": "A set of key-value pairs representing the dimensions of the meter usage.", "nullable": true, "type": "object" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "meter_id": { "description": "The unique identifier for the meter. Null if no meters were provided and usage was aggregated across all meters.", "maxLength": 5000, "nullable": true, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "billing.analytics.meter_usage_row" ], "type": "string" } }, "required": [ "bucket_end_time", "bucket_start_time", "bucket_value", "dimensions", "id", "meter_id", "object" ], "title": "BillingOverviewResourcesMeterUsageRow", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "bucket_end_time", "bucket_start_time", "bucket_value", "dimensions", "id", "meter_id", "object" ], "x-stripeResource": { "class_name": "MeterUsageRow", "in_package": "Billing.analytics" } }, "billing.credit_balance_summary": { "description": "Indicates the billing credit balance for billing credits granted to a customer.", "properties": { "balances": { "description": "The billing credit balances. One entry per credit grant currency. If a customer only has credit grants in a single currency, then this will have a single balance entry.", "items": { "$ref": "#/components/schemas/credit_balance" }, "type": "array" }, "customer": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/customer" }, { "$ref": "#/components/schemas/deleted_customer" } ], "description": "The customer the balance is for.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/customer" }, { "$ref": "#/components/schemas/deleted_customer" } ] } }, "customer_account": { "description": "The account the balance is for.", "maxLength": 5000, "nullable": true, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "billing.credit_balance_summary" ], "type": "string" } }, "required": [ "balances", "customer", "livemode", "object" ], "title": "CreditBalanceSummary", "type": "object", "x-expandableFields": [ "balances", "customer" ], "x-resourceId": "billing.credit_balance_summary", "x-stripeMostCommon": [ "balances", "customer", "customer_account", "livemode", "object" ], "x-stripeOperations": [ { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/billing/credit_balance_summary" } ], "x-stripeResource": { "class_name": "CreditBalanceSummary", "in_package": "Billing" } }, "billing.credit_balance_transaction": { "description": "A credit balance transaction is a resource representing a transaction (either a credit or a debit) against an existing credit grant.", "properties": { "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "credit": { "anyOf": [ { "$ref": "#/components/schemas/billing_credit_grants_resource_balance_credit" } ], "description": "Credit details for this credit balance transaction. Only present if type is `credit`.", "nullable": true }, "credit_grant": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/billing.credit_grant" } ], "description": "The credit grant associated with this credit balance transaction.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/billing.credit_grant" } ] } }, "debit": { "anyOf": [ { "$ref": "#/components/schemas/billing_credit_grants_resource_balance_debit" } ], "description": "Debit details for this credit balance transaction. Only present if type is `debit`.", "nullable": true }, "effective_at": { "description": "The effective time of this credit balance transaction.", "format": "unix-time", "type": "integer" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "billing.credit_balance_transaction" ], "type": "string" }, "test_clock": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/test_helpers.test_clock" } ], "description": "ID of the test clock this credit balance transaction belongs to.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/test_helpers.test_clock" } ] } }, "type": { "description": "The type of credit balance transaction (credit or debit).", "enum": [ "credit", "debit" ], "nullable": true, "type": "string" } }, "required": [ "created", "credit", "credit_grant", "debit", "effective_at", "id", "livemode", "object", "test_clock", "type" ], "title": "CreditBalanceTransaction", "type": "object", "x-expandableFields": [ "credit", "credit_grant", "debit", "test_clock" ], "x-resourceId": "billing.credit_balance_transaction", "x-stripeMostCommon": [ "created", "credit", "credit_grant", "debit", "effective_at", "id", "livemode", "object", "test_clock", "type" ], "x-stripeOperations": [ { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/billing/credit_balance_transactions" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/billing/credit_balance_transactions/{id}" } ], "x-stripeResource": { "class_name": "CreditBalanceTransaction", "has_collection_class": true, "in_package": "Billing" } }, "billing.credit_balance_transaction.created": { "description": "Occurs when a credit balance transaction is created", "properties": { "object": { "$ref": "#/components/schemas/billing.credit_balance_transaction" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "billing.credit_balance_transaction.created" } }, "billing.credit_grant": { "description": "A credit grant is an API resource that documents the allocation of some billing credits to a customer.\n\nRelated guide: [Billing credits](https://docs.stripe.com/billing/subscriptions/usage-based/billing-credits)", "properties": { "amount": { "$ref": "#/components/schemas/billing_credit_grants_resource_amount" }, "applicability_config": { "$ref": "#/components/schemas/billing_credit_grants_resource_applicability_config" }, "category": { "description": "The category of this credit grant. This is for tracking purposes and isn't displayed to the customer.", "enum": [ "paid", "promotional" ], "type": "string" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "customer": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/customer" }, { "$ref": "#/components/schemas/deleted_customer" } ], "description": "ID of the customer receiving the billing credits.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/customer" }, { "$ref": "#/components/schemas/deleted_customer" } ] } }, "customer_account": { "description": "ID of the account receiving the billing credits", "maxLength": 5000, "nullable": true, "type": "string" }, "effective_at": { "description": "The time when the billing credits become effective-when they're eligible for use.", "format": "unix-time", "nullable": true, "type": "integer" }, "expires_at": { "description": "The time when the billing credits expire. If not present, the billing credits don't expire.", "format": "unix-time", "nullable": true, "type": "integer" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "type": "object" }, "name": { "description": "A descriptive name shown in dashboard.", "maxLength": 5000, "nullable": true, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "billing.credit_grant" ], "type": "string" }, "priority": { "description": "The priority for applying this credit grant. The highest priority is 0 and the lowest is 100.", "nullable": true, "type": "integer" }, "test_clock": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/test_helpers.test_clock" } ], "description": "ID of the test clock this credit grant belongs to.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/test_helpers.test_clock" } ] } }, "updated": { "description": "Time at which the object was last updated. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "voided_at": { "description": "The time when this credit grant was voided. If not present, the credit grant hasn't been voided.", "format": "unix-time", "nullable": true, "type": "integer" } }, "required": [ "amount", "applicability_config", "category", "created", "customer", "effective_at", "expires_at", "id", "livemode", "metadata", "name", "object", "test_clock", "updated", "voided_at" ], "title": "CreditGrant", "type": "object", "x-expandableFields": [ "amount", "applicability_config", "customer", "test_clock" ], "x-resourceId": "billing.credit_grant", "x-stripeMostCommon": [ "amount", "applicability_config", "category", "created", "customer", "customer_account", "effective_at", "expires_at", "id", "livemode", "metadata", "name", "object", "priority", "test_clock", "updated", "voided_at" ], "x-stripeOperations": [ { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/billing/credit_grants" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/billing/credit_grants/{id}" }, { "method_name": "create", "method_on": "service", "method_type": "create", "operation": "post", "path": "/v1/billing/credit_grants" }, { "method_name": "update", "method_on": "service", "method_type": "update", "operation": "post", "path": "/v1/billing/credit_grants/{id}" }, { "method_name": "expire", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/billing/credit_grants/{id}/expire" }, { "method_name": "void_grant", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/billing/credit_grants/{id}/void" } ], "x-stripeResource": { "class_name": "CreditGrant", "has_collection_class": true, "in_package": "Billing" } }, "billing.credit_grant.created": { "description": "Occurs when a credit grant is created", "properties": { "object": { "$ref": "#/components/schemas/billing.credit_grant" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "billing.credit_grant.created" } }, "billing.credit_grant.updated": { "description": "Occurs when a credit grant is updated", "properties": { "object": { "$ref": "#/components/schemas/billing.credit_grant" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "billing.credit_grant.updated" } }, "billing.meter": { "description": "Meters specify how to aggregate meter events over a billing period. Meter events represent the actions that customers take in your system. Meters attach to prices and form the basis of the bill.\n\nRelated guide: [Usage based billing](https://docs.stripe.com/billing/subscriptions/usage-based)", "properties": { "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "customer_mapping": { "$ref": "#/components/schemas/billing_meter_resource_customer_mapping_settings" }, "default_aggregation": { "$ref": "#/components/schemas/billing_meter_resource_aggregation_settings" }, "display_name": { "description": "The meter's name.", "maxLength": 5000, "type": "string" }, "event_name": { "description": "The name of the meter event to record usage for. Corresponds with the `event_name` field on meter events.", "maxLength": 5000, "type": "string" }, "event_time_window": { "description": "The time window which meter events have been pre-aggregated for, if any.", "enum": [ "day", "hour" ], "nullable": true, "type": "string" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "billing.meter" ], "type": "string" }, "status": { "description": "The meter's status.", "enum": [ "active", "inactive" ], "type": "string" }, "status_transitions": { "$ref": "#/components/schemas/billing_meter_resource_billing_meter_status_transitions" }, "updated": { "description": "Time at which the object was last updated. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "value_settings": { "$ref": "#/components/schemas/billing_meter_resource_billing_meter_value" } }, "required": [ "created", "customer_mapping", "default_aggregation", "display_name", "event_name", "event_time_window", "id", "livemode", "object", "status", "status_transitions", "updated", "value_settings" ], "title": "BillingMeter", "type": "object", "x-expandableFields": [ "customer_mapping", "default_aggregation", "status_transitions", "value_settings" ], "x-resourceId": "billing.meter", "x-stripeMostCommon": [ "created", "customer_mapping", "default_aggregation", "display_name", "event_name", "event_time_window", "id", "livemode", "object", "status", "status_transitions", "updated", "value_settings" ], "x-stripeOperations": [ { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/billing/meters" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/billing/meters/{id}" }, { "method_name": "create", "method_on": "service", "method_type": "create", "operation": "post", "path": "/v1/billing/meters" }, { "method_name": "update", "method_on": "service", "method_type": "update", "operation": "post", "path": "/v1/billing/meters/{id}" }, { "method_name": "deactivate", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/billing/meters/{id}/deactivate" }, { "method_name": "reactivate", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/billing/meters/{id}/reactivate" } ], "x-stripeResource": { "class_name": "Meter", "has_collection_class": true, "in_package": "Billing" } }, "billing.meter.created": { "description": "Occurs when a meter is created", "properties": { "object": { "$ref": "#/components/schemas/billing.meter" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "billing.meter.created" } }, "billing.meter.deactivated": { "description": "Occurs when a meter is deactivated", "properties": { "object": { "$ref": "#/components/schemas/billing.meter" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "billing.meter.deactivated" } }, "billing.meter.reactivated": { "description": "Occurs when a meter is reactivated", "properties": { "object": { "$ref": "#/components/schemas/billing.meter" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "billing.meter.reactivated" } }, "billing.meter.updated": { "description": "Occurs when a meter is updated", "properties": { "object": { "$ref": "#/components/schemas/billing.meter" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "billing.meter.updated" } }, "billing.meter_event": { "description": "Meter events represent actions that customers take in your system. You can use meter events to bill a customer based on their usage. Meter events are associated with billing meters, which define both the contents of the event’s payload and how to aggregate those events.", "properties": { "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "event_name": { "description": "The name of the meter event. Corresponds with the `event_name` field on a meter.", "maxLength": 100, "type": "string" }, "identifier": { "description": "A unique identifier for the event.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "billing.meter_event" ], "type": "string" }, "payload": { "additionalProperties": { "maxLength": 100, "type": "string" }, "description": "The payload of the event. This contains the fields corresponding to a meter's `customer_mapping.event_payload_key` (default is `stripe_customer_id`) and `value_settings.event_payload_key` (default is `value`). Read more about the [payload](https://stripe.com/docs/billing/subscriptions/usage-based/recording-usage#payload-key-overrides).", "type": "object" }, "timestamp": { "description": "The timestamp passed in when creating the event. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" } }, "required": [ "created", "event_name", "identifier", "livemode", "object", "payload", "timestamp" ], "title": "BillingMeterEvent", "type": "object", "x-expandableFields": [], "x-resourceId": "billing.meter_event", "x-stripeMostCommon": [ "created", "event_name", "identifier", "livemode", "object", "payload", "timestamp" ], "x-stripeOperations": [ { "method_name": "create", "method_on": "service", "method_type": "create", "operation": "post", "path": "/v1/billing/meter_events" } ], "x-stripeResource": { "class_name": "MeterEvent", "in_package": "Billing" } }, "billing.meter_event_adjustment": { "description": "A billing meter event adjustment is a resource that allows you to cancel a meter event. For example, you might create a billing meter event adjustment to cancel a meter event that was created in error or attached to the wrong customer.", "properties": { "cancel": { "anyOf": [ { "$ref": "#/components/schemas/billing_meter_resource_billing_meter_event_adjustment_cancel" } ], "description": "Specifies which event to cancel.", "nullable": true }, "event_name": { "description": "The name of the meter event. Corresponds with the `event_name` field on a meter.", "maxLength": 100, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "billing.meter_event_adjustment" ], "type": "string" }, "status": { "description": "The meter event adjustment's status.", "enum": [ "complete", "pending" ], "type": "string" }, "type": { "description": "Specifies whether to cancel a single event or a range of events for a time period. Time period cancellation is not supported yet.", "enum": [ "cancel" ], "type": "string" } }, "required": [ "cancel", "event_name", "livemode", "object", "status", "type" ], "title": "BillingMeterEventAdjustment", "type": "object", "x-expandableFields": [ "cancel" ], "x-resourceId": "billing.meter_event_adjustment", "x-stripeMostCommon": [ "cancel", "event_name", "livemode", "object", "status", "type" ], "x-stripeOperations": [ { "method_name": "create", "method_on": "service", "method_type": "create", "operation": "post", "path": "/v1/billing/meter_event_adjustments" } ], "x-stripeResource": { "class_name": "MeterEventAdjustment", "in_package": "Billing" } }, "billing.meter_event_summary": { "description": "A billing meter event summary represents an aggregated view of a customer's billing meter events within a specified timeframe. It indicates how much\nusage was accrued by a customer for that period.\n\nNote: Meters events are aggregated asynchronously so the meter event summaries provide an eventually consistent view of the reported usage.", "properties": { "aggregated_value": { "description": "Aggregated value of all the events within `start_time` (inclusive) and `end_time` (inclusive). The aggregation strategy is defined on meter via `default_aggregation`.", "type": "number" }, "end_time": { "description": "End timestamp for this event summary (exclusive). Must be aligned with minute boundaries.", "format": "unix-time", "type": "integer" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "meter": { "description": "The meter associated with this event summary.", "maxLength": 5000, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "billing.meter_event_summary" ], "type": "string" }, "start_time": { "description": "Start timestamp for this event summary (inclusive). Must be aligned with minute boundaries.", "format": "unix-time", "type": "integer" } }, "required": [ "aggregated_value", "end_time", "id", "livemode", "meter", "object", "start_time" ], "title": "BillingMeterEventSummary", "type": "object", "x-expandableFields": [], "x-resourceId": "billing.meter_event_summary", "x-stripeMostCommon": [ "aggregated_value", "end_time", "id", "livemode", "meter", "object", "start_time" ], "x-stripeOperations": [ { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/billing/meters/{id}/event_summaries" } ], "x-stripeResource": { "class_name": "MeterEventSummary", "has_collection_class": true, "in_package": "Billing" } }, "billing_bill_resource_invoice_item_parents_invoice_item_parent": { "description": "", "properties": { "subscription_details": { "anyOf": [ { "$ref": "#/components/schemas/billing_bill_resource_invoice_item_parents_invoice_item_subscription_parent" } ], "description": "Details about the subscription that generated this invoice item", "nullable": true }, "type": { "description": "The type of parent that generated this invoice item", "enum": [ "subscription_details" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "subscription_details", "type" ], "title": "BillingBillResourceInvoiceItemParentsInvoiceItemParent", "type": "object", "x-expandableFields": [ "subscription_details" ], "x-stripeMostCommon": [ "subscription_details", "type" ] }, "billing_bill_resource_invoice_item_parents_invoice_item_subscription_parent": { "description": "", "properties": { "subscription": { "description": "The subscription that generated this invoice item", "maxLength": 5000, "type": "string" }, "subscription_item": { "description": "The subscription item that generated this invoice item", "maxLength": 5000, "type": "string" } }, "required": [ "subscription" ], "title": "BillingBillResourceInvoiceItemParentsInvoiceItemSubscriptionParent", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "subscription", "subscription_item" ] }, "billing_bill_resource_invoicing_common_invoice_pause_collection": { "description": "The Pause Collection settings determine how we will pause collection for this subscription and for how long the subscription\nshould be paused.", "properties": { "behavior": { "description": "The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.", "enum": [ "keep_as_draft", "mark_uncollectible", "void" ], "nullable": true, "type": "string" }, "resumes_at": { "description": "The time after which the subscription will resume collecting payments.", "format": "unix-time", "nullable": true, "type": "integer" } }, "required": [ "behavior", "resumes_at" ], "title": "BillingBillResourceInvoicingCommonInvoicePauseCollection", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "behavior", "resumes_at" ] }, "billing_bill_resource_invoicing_lines_common_credited_items": { "description": "", "properties": { "invoice": { "description": "Invoice containing the credited invoice line items", "maxLength": 5000, "type": "string" }, "invoice_line_items": { "description": "Credited invoice line items", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "required": [ "invoice", "invoice_line_items" ], "title": "BillingBillResourceInvoicingLinesCommonCreditedItems", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "invoice", "invoice_line_items" ] }, "billing_bill_resource_invoicing_lines_common_proration_details": { "description": "", "properties": { "credited_items": { "anyOf": [ { "$ref": "#/components/schemas/billing_bill_resource_invoicing_lines_common_credited_items" } ], "description": "For a credit proration `line_item`, the original debit line_items to which the credit proration applies.", "nullable": true } }, "required": [ "credited_items" ], "title": "BillingBillResourceInvoicingLinesCommonProrationDetails", "type": "object", "x-expandableFields": [ "credited_items" ], "x-stripeMostCommon": [ "credited_items" ] }, "billing_bill_resource_invoicing_lines_parents_invoice_line_item_invoice_item_parent": { "description": "", "properties": { "invoice_item": { "description": "The invoice item that generated this line item", "maxLength": 5000, "type": "string" }, "proration": { "description": "Whether this is a proration", "type": "boolean" }, "proration_details": { "anyOf": [ { "$ref": "#/components/schemas/billing_bill_resource_invoicing_lines_common_proration_details" } ], "description": "Additional details for proration line items", "nullable": true }, "subscription": { "description": "The subscription that the invoice item belongs to", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "invoice_item", "proration", "proration_details", "subscription" ], "title": "BillingBillResourceInvoicingLinesParentsInvoiceLineItemInvoiceItemParent", "type": "object", "x-expandableFields": [ "proration_details" ], "x-stripeMostCommon": [ "invoice_item", "proration", "proration_details", "subscription" ] }, "billing_bill_resource_invoicing_lines_parents_invoice_line_item_parent": { "description": "", "properties": { "invoice_item_details": { "anyOf": [ { "$ref": "#/components/schemas/billing_bill_resource_invoicing_lines_parents_invoice_line_item_invoice_item_parent" } ], "description": "Details about the invoice item that generated this line item", "nullable": true }, "subscription_item_details": { "anyOf": [ { "$ref": "#/components/schemas/billing_bill_resource_invoicing_lines_parents_invoice_line_item_subscription_item_parent" } ], "description": "Details about the subscription item that generated this line item", "nullable": true }, "type": { "description": "The type of parent that generated this line item", "enum": [ "invoice_item_details", "subscription_item_details" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "invoice_item_details", "subscription_item_details", "type" ], "title": "BillingBillResourceInvoicingLinesParentsInvoiceLineItemParent", "type": "object", "x-expandableFields": [ "invoice_item_details", "subscription_item_details" ], "x-stripeMostCommon": [ "invoice_item_details", "subscription_item_details", "type" ] }, "billing_bill_resource_invoicing_lines_parents_invoice_line_item_subscription_item_parent": { "description": "", "properties": { "invoice_item": { "description": "The invoice item that generated this line item", "maxLength": 5000, "nullable": true, "type": "string" }, "proration": { "description": "Whether this is a proration", "type": "boolean" }, "proration_details": { "anyOf": [ { "$ref": "#/components/schemas/billing_bill_resource_invoicing_lines_common_proration_details" } ], "description": "Additional details for proration line items", "nullable": true }, "subscription": { "description": "The subscription that the subscription item belongs to", "maxLength": 5000, "nullable": true, "type": "string" }, "subscription_item": { "description": "The subscription item that generated this line item", "maxLength": 5000, "type": "string" } }, "required": [ "invoice_item", "proration", "proration_details", "subscription", "subscription_item" ], "title": "BillingBillResourceInvoicingLinesParentsInvoiceLineItemSubscriptionItemParent", "type": "object", "x-expandableFields": [ "proration_details" ], "x-stripeMostCommon": [ "invoice_item", "proration", "proration_details", "subscription", "subscription_item" ] }, "billing_bill_resource_invoicing_parents_invoice_parent": { "description": "", "properties": { "quote_details": { "anyOf": [ { "$ref": "#/components/schemas/billing_bill_resource_invoicing_parents_invoice_quote_parent" } ], "description": "Details about the quote that generated this invoice", "nullable": true }, "subscription_details": { "anyOf": [ { "$ref": "#/components/schemas/billing_bill_resource_invoicing_parents_invoice_subscription_parent" } ], "description": "Details about the subscription that generated this invoice", "nullable": true }, "type": { "description": "The type of parent that generated this invoice", "enum": [ "quote_details", "subscription_details" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "quote_details", "subscription_details", "type" ], "title": "BillingBillResourceInvoicingParentsInvoiceParent", "type": "object", "x-expandableFields": [ "quote_details", "subscription_details" ], "x-stripeMostCommon": [ "quote_details", "subscription_details", "type" ] }, "billing_bill_resource_invoicing_parents_invoice_quote_parent": { "description": "", "properties": { "quote": { "description": "The quote that generated this invoice", "maxLength": 5000, "type": "string" } }, "required": [ "quote" ], "title": "BillingBillResourceInvoicingParentsInvoiceQuoteParent", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "quote" ] }, "billing_bill_resource_invoicing_parents_invoice_subscription_parent": { "description": "", "properties": { "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) defined as subscription metadata when an invoice is created. Becomes an immutable snapshot of the subscription metadata at the time of invoice finalization.\n *Note: This attribute is populated only for invoices created on or after June 29, 2023.*", "nullable": true, "type": "object" }, "pause_collection": { "anyOf": [ { "$ref": "#/components/schemas/billing_bill_resource_invoicing_common_invoice_pause_collection" } ], "description": "If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://stripe.com/docs/billing/subscriptions/pause-payment).", "nullable": true }, "subscription": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/subscription" } ], "description": "The subscription that generated this invoice", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/subscription" } ] } }, "subscription_proration_date": { "description": "Only set for upcoming invoices that preview prorations. The time used to calculate prorations.", "format": "unix-time", "type": "integer" } }, "required": [ "metadata", "subscription" ], "title": "BillingBillResourceInvoicingParentsInvoiceSubscriptionParent", "type": "object", "x-expandableFields": [ "pause_collection", "subscription" ], "x-stripeMostCommon": [ "metadata", "pause_collection", "subscription", "subscription_proration_date" ] }, "billing_bill_resource_invoicing_pricing_pricing": { "description": "", "properties": { "price_details": { "$ref": "#/components/schemas/billing_bill_resource_invoicing_pricing_pricing_price_details" }, "type": { "description": "The type of the pricing details.", "enum": [ "price_details" ], "type": "string", "x-stripeBypassValidation": true }, "unit_amount_decimal": { "description": "The unit amount (in the `currency` specified) of the item which contains a decimal value with at most 12 decimal places.", "format": "decimal", "nullable": true, "type": "string" } }, "required": [ "type", "unit_amount_decimal" ], "title": "BillingBillResourceInvoicingPricingPricing", "type": "object", "x-expandableFields": [ "price_details" ], "x-stripeMostCommon": [ "price_details", "type", "unit_amount_decimal" ] }, "billing_bill_resource_invoicing_pricing_pricing_price_details": { "description": "", "properties": { "price": { "description": "The ID of the price this item is associated with.", "maxLength": 5000, "type": "string" }, "product": { "description": "The ID of the product this item is associated with.", "maxLength": 5000, "type": "string" } }, "required": [ "price", "product" ], "title": "BillingBillResourceInvoicingPricingPricingPriceDetails", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "price", "product" ] }, "billing_bill_resource_invoicing_taxes_tax": { "description": "", "properties": { "amount": { "description": "The amount of the tax, in cents (or local equivalent).", "type": "integer" }, "tax_behavior": { "description": "Whether this tax is inclusive or exclusive.", "enum": [ "exclusive", "inclusive" ], "type": "string" }, "tax_rate_details": { "anyOf": [ { "$ref": "#/components/schemas/billing_bill_resource_invoicing_taxes_tax_rate_details" } ], "description": "Additional details about the tax rate. Only present when `type` is `tax_rate_details`.", "nullable": true }, "taxability_reason": { "description": "The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.", "enum": [ "customer_exempt", "not_available", "not_collecting", "not_subject_to_tax", "not_supported", "portion_product_exempt", "portion_reduced_rated", "portion_standard_rated", "product_exempt", "product_exempt_holiday", "proportionally_rated", "reduced_rated", "reverse_charge", "standard_rated", "taxable_basis_reduced", "zero_rated" ], "type": "string", "x-stripeBypassValidation": true }, "taxable_amount": { "description": "The amount on which tax is calculated, in cents (or local equivalent).", "nullable": true, "type": "integer" }, "type": { "description": "The type of tax information.", "enum": [ "tax_rate_details" ], "type": "string" } }, "required": [ "amount", "tax_behavior", "tax_rate_details", "taxability_reason", "taxable_amount", "type" ], "title": "BillingBillResourceInvoicingTaxesTax", "type": "object", "x-expandableFields": [ "tax_rate_details" ], "x-stripeMostCommon": [ "amount", "tax_behavior", "tax_rate_details", "taxability_reason", "taxable_amount", "type" ] }, "billing_bill_resource_invoicing_taxes_tax_rate_details": { "description": "", "properties": { "tax_rate": { "maxLength": 5000, "type": "string" } }, "required": [ "tax_rate" ], "title": "BillingBillResourceInvoicingTaxesTaxRateDetails", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "tax_rate" ] }, "billing_clocks_resource_status_details_advancing_status_details": { "description": "", "properties": { "target_frozen_time": { "description": "The `frozen_time` that the Test Clock is advancing towards.", "format": "unix-time", "type": "integer" } }, "required": [ "target_frozen_time" ], "title": "BillingClocksResourceStatusDetailsAdvancingStatusDetails", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "target_frozen_time" ] }, "billing_clocks_resource_status_details_status_details": { "description": "", "properties": { "advancing": { "$ref": "#/components/schemas/billing_clocks_resource_status_details_advancing_status_details" } }, "title": "BillingClocksResourceStatusDetailsStatusDetails", "type": "object", "x-expandableFields": [ "advancing" ], "x-stripeMostCommon": [ "advancing" ] }, "billing_credit_grants_resource_amount": { "description": "", "properties": { "monetary": { "anyOf": [ { "$ref": "#/components/schemas/billing_credit_grants_resource_monetary_amount" } ], "description": "The monetary amount.", "nullable": true }, "type": { "description": "The type of this amount. We currently only support `monetary` billing credits.", "enum": [ "monetary" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "monetary", "type" ], "title": "BillingCreditGrantsResourceAmount", "type": "object", "x-expandableFields": [ "monetary" ], "x-stripeMostCommon": [ "monetary", "type" ] }, "billing_credit_grants_resource_applicability_config": { "description": "", "properties": { "scope": { "$ref": "#/components/schemas/billing_credit_grants_resource_scope" } }, "required": [ "scope" ], "title": "BillingCreditGrantsResourceApplicabilityConfig", "type": "object", "x-expandableFields": [ "scope" ], "x-stripeMostCommon": [ "scope" ] }, "billing_credit_grants_resource_applicable_price": { "description": "", "properties": { "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "id" ], "title": "BillingCreditGrantsResourceApplicablePrice", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "id" ] }, "billing_credit_grants_resource_balance_credit": { "description": "", "properties": { "amount": { "$ref": "#/components/schemas/billing_credit_grants_resource_amount" }, "credits_application_invoice_voided": { "anyOf": [ { "$ref": "#/components/schemas/billing_credit_grants_resource_balance_credits_application_invoice_voided" } ], "description": "Details of the invoice to which the reinstated credits were originally applied. Only present if `type` is `credits_application_invoice_voided`.", "nullable": true }, "type": { "description": "The type of credit transaction.", "enum": [ "credits_application_invoice_voided", "credits_granted" ], "type": "string" } }, "required": [ "amount", "credits_application_invoice_voided", "type" ], "title": "BillingCreditGrantsResourceBalanceCredit", "type": "object", "x-expandableFields": [ "amount", "credits_application_invoice_voided" ], "x-stripeMostCommon": [ "amount", "credits_application_invoice_voided", "type" ] }, "billing_credit_grants_resource_balance_credits_application_invoice_voided": { "description": "", "properties": { "invoice": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/invoice" } ], "description": "The invoice to which the reinstated billing credits were originally applied.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/invoice" } ] } }, "invoice_line_item": { "description": "The invoice line item to which the reinstated billing credits were originally applied.", "maxLength": 5000, "type": "string" } }, "required": [ "invoice", "invoice_line_item" ], "title": "BillingCreditGrantsResourceBalanceCreditsApplicationInvoiceVoided", "type": "object", "x-expandableFields": [ "invoice" ], "x-stripeMostCommon": [ "invoice", "invoice_line_item" ] }, "billing_credit_grants_resource_balance_credits_applied": { "description": "", "properties": { "invoice": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/invoice" } ], "description": "The invoice to which the billing credits were applied.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/invoice" } ] } }, "invoice_line_item": { "description": "The invoice line item to which the billing credits were applied.", "maxLength": 5000, "type": "string" } }, "required": [ "invoice", "invoice_line_item" ], "title": "BillingCreditGrantsResourceBalanceCreditsApplied", "type": "object", "x-expandableFields": [ "invoice" ], "x-stripeMostCommon": [ "invoice", "invoice_line_item" ] }, "billing_credit_grants_resource_balance_debit": { "description": "", "properties": { "amount": { "$ref": "#/components/schemas/billing_credit_grants_resource_amount" }, "credits_applied": { "anyOf": [ { "$ref": "#/components/schemas/billing_credit_grants_resource_balance_credits_applied" } ], "description": "Details of how the billing credits were applied to an invoice. Only present if `type` is `credits_applied`.", "nullable": true }, "type": { "description": "The type of debit transaction.", "enum": [ "credits_applied", "credits_expired", "credits_voided" ], "type": "string" } }, "required": [ "amount", "credits_applied", "type" ], "title": "BillingCreditGrantsResourceBalanceDebit", "type": "object", "x-expandableFields": [ "amount", "credits_applied" ], "x-stripeMostCommon": [ "amount", "credits_applied", "type" ] }, "billing_credit_grants_resource_monetary_amount": { "description": "", "properties": { "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "maxLength": 5000, "type": "string" }, "value": { "description": "A positive integer representing the amount.", "type": "integer" } }, "required": [ "currency", "value" ], "title": "BillingCreditGrantsResourceMonetaryAmount", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "currency", "value" ] }, "billing_credit_grants_resource_scope": { "description": "", "properties": { "price_type": { "description": "The price type that credit grants can apply to. We currently only support the `metered` price type. This refers to prices that have a [Billing Meter](https://docs.stripe.com/api/billing/meter) attached to them. Cannot be used in combination with `prices`.", "enum": [ "metered" ], "type": "string" }, "prices": { "description": "The prices that credit grants can apply to. We currently only support `metered` prices. This refers to prices that have a [Billing Meter](https://docs.stripe.com/api/billing/meter) attached to them. Cannot be used in combination with `price_type`.", "items": { "$ref": "#/components/schemas/billing_credit_grants_resource_applicable_price" }, "type": "array" } }, "title": "BillingCreditGrantsResourceScope", "type": "object", "x-expandableFields": [ "prices" ], "x-stripeMostCommon": [ "price_type", "prices" ] }, "billing_details": { "description": "", "properties": { "address": { "anyOf": [ { "$ref": "#/components/schemas/address" } ], "description": "Billing address.", "nullable": true }, "email": { "description": "Email address.", "maxLength": 5000, "nullable": true, "type": "string" }, "name": { "description": "Full name.", "maxLength": 5000, "nullable": true, "type": "string" }, "phone": { "description": "Billing phone number (including extension).", "maxLength": 5000, "nullable": true, "type": "string" }, "tax_id": { "description": "Taxpayer identification number. Used only for transactions between LATAM buyers and non-LATAM sellers.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "address", "email", "name", "phone", "tax_id" ], "title": "billing_details", "type": "object", "x-expandableFields": [ "address" ], "x-stripeMostCommon": [ "address", "email", "name", "phone", "tax_id" ] }, "billing_meter_resource_aggregation_settings": { "description": "", "properties": { "formula": { "description": "Specifies how events are aggregated.", "enum": [ "count", "last", "sum" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "formula" ], "title": "BillingMeterResourceAggregationSettings", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "formula" ] }, "billing_meter_resource_billing_meter_event_adjustment_cancel": { "description": "", "properties": { "identifier": { "description": "Unique identifier for the event.", "maxLength": 100, "nullable": true, "type": "string" } }, "required": [ "identifier" ], "title": "BillingMeterResourceBillingMeterEventAdjustmentCancel", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "identifier" ] }, "billing_meter_resource_billing_meter_status_transitions": { "description": "", "properties": { "deactivated_at": { "description": "The time the meter was deactivated, if any. Measured in seconds since Unix epoch.", "format": "unix-time", "nullable": true, "type": "integer" } }, "required": [ "deactivated_at" ], "title": "BillingMeterResourceBillingMeterStatusTransitions", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "deactivated_at" ] }, "billing_meter_resource_billing_meter_value": { "description": "", "properties": { "event_payload_key": { "description": "The key in the meter event payload to use as the value for this meter.", "maxLength": 5000, "type": "string" } }, "required": [ "event_payload_key" ], "title": "BillingMeterResourceBillingMeterValue", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "event_payload_key" ] }, "billing_meter_resource_customer_mapping_settings": { "description": "", "properties": { "event_payload_key": { "description": "The key in the meter event payload to use for mapping the event to a customer.", "maxLength": 5000, "type": "string" }, "type": { "description": "The method for mapping a meter event to a customer.", "enum": [ "by_id" ], "type": "string" } }, "required": [ "event_payload_key", "type" ], "title": "BillingMeterResourceCustomerMappingSettings", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "event_payload_key", "type" ] }, "billing_portal.configuration": { "description": "A portal configuration describes the functionality and behavior of a portal session.", "properties": { "active": { "description": "Whether the configuration is active and can be used to create portal sessions.", "type": "boolean" }, "application": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/application" }, { "$ref": "#/components/schemas/deleted_application" } ], "description": "ID of the Connect Application that created the configuration.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/application" }, { "$ref": "#/components/schemas/deleted_application" } ] } }, "business_profile": { "$ref": "#/components/schemas/portal_business_profile" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "default_return_url": { "description": "The default URL to redirect customers to when they click on the portal's link to return to your website. This can be [overriden](https://stripe.com/docs/api/customer_portal/sessions/create#create_portal_session-return_url) when creating the session.", "maxLength": 5000, "nullable": true, "type": "string" }, "features": { "$ref": "#/components/schemas/portal_features" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "is_default": { "description": "Whether the configuration is the default. If `true`, this configuration can be managed in the Dashboard and portal sessions will use this configuration unless it is overriden when creating the session.", "type": "boolean" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "login_page": { "$ref": "#/components/schemas/portal_login_page" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "nullable": true, "type": "object" }, "name": { "description": "The name of the configuration.", "maxLength": 5000, "nullable": true, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "billing_portal.configuration" ], "type": "string" }, "updated": { "description": "Time at which the object was last updated. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" } }, "required": [ "active", "application", "business_profile", "created", "default_return_url", "features", "id", "is_default", "livemode", "login_page", "metadata", "name", "object", "updated" ], "title": "PortalConfiguration", "type": "object", "x-expandableFields": [ "application", "business_profile", "features", "login_page" ], "x-resourceId": "billing_portal.configuration", "x-stripeMostCommon": [ "active", "application", "business_profile", "created", "default_return_url", "features", "id", "is_default", "livemode", "login_page", "metadata", "name", "object", "updated" ], "x-stripeOperations": [ { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/billing_portal/configurations" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/billing_portal/configurations/{configuration}" }, { "method_name": "create", "method_on": "service", "method_type": "create", "operation": "post", "path": "/v1/billing_portal/configurations" }, { "method_name": "update", "method_on": "service", "method_type": "update", "operation": "post", "path": "/v1/billing_portal/configurations/{configuration}" } ], "x-stripeResource": { "class_name": "Configuration", "has_collection_class": true, "in_package": "BillingPortal" } }, "billing_portal.configuration.created": { "description": "Occurs whenever a portal configuration is created.", "properties": { "object": { "$ref": "#/components/schemas/billing_portal.configuration" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "billing_portal.configuration.created" } }, "billing_portal.configuration.updated": { "description": "Occurs whenever a portal configuration is updated.", "properties": { "object": { "$ref": "#/components/schemas/billing_portal.configuration" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "billing_portal.configuration.updated" } }, "billing_portal.session": { "description": "The Billing customer portal is a Stripe-hosted UI for subscription and\nbilling management.\n\nA portal configuration describes the functionality and features that you\nwant to provide to your customers through the portal.\n\nA portal session describes the instantiation of the customer portal for\na particular customer. By visiting the session's URL, the customer\ncan manage their subscriptions and billing details. For security reasons,\nsessions are short-lived and will expire if the customer does not visit the URL.\nCreate sessions on-demand when customers intend to manage their subscriptions\nand billing details.\n\nRelated guide: [Customer management](/customer-management)", "properties": { "configuration": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/billing_portal.configuration" } ], "description": "The configuration used by this session, describing the features available.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/billing_portal.configuration" } ] } }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "customer": { "description": "The ID of the customer for this session.", "maxLength": 5000, "type": "string" }, "customer_account": { "description": "The ID of the account for this session.", "maxLength": 5000, "nullable": true, "type": "string" }, "flow": { "anyOf": [ { "$ref": "#/components/schemas/portal_flows_flow" } ], "description": "Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows.", "nullable": true }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "locale": { "description": "The IETF language tag of the locale Customer Portal is displayed in. If blank or auto, the customer’s `preferred_locales` or browser’s locale is used.", "enum": [ "auto", "bg", "cs", "da", "de", "el", "en", "en-AU", "en-CA", "en-GB", "en-IE", "en-IN", "en-NZ", "en-SG", "es", "es-419", "et", "fi", "fil", "fr", "fr-CA", "hr", "hu", "id", "it", "ja", "ko", "lt", "lv", "ms", "mt", "nb", "nl", "pl", "pt", "pt-BR", "ro", "ru", "sk", "sl", "sv", "th", "tr", "vi", "zh", "zh-HK", "zh-TW" ], "nullable": true, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "billing_portal.session" ], "type": "string" }, "on_behalf_of": { "description": "The account for which the session was created on behalf of. When specified, only subscriptions and invoices with this `on_behalf_of` account appear in the portal. For more information, see the [docs](https://stripe.com/docs/connect/separate-charges-and-transfers#settlement-merchant). Use the [Accounts API](https://stripe.com/docs/api/accounts/object#account_object-settings-branding) to modify the `on_behalf_of` account's branding settings, which the portal displays.", "maxLength": 5000, "nullable": true, "type": "string" }, "return_url": { "description": "The URL to redirect customers to when they click on the portal's link to return to your website.", "maxLength": 5000, "nullable": true, "type": "string" }, "url": { "description": "The short-lived URL of the session that gives customers access to the customer portal.", "maxLength": 5000, "type": "string" } }, "required": [ "configuration", "created", "customer", "flow", "id", "livemode", "locale", "object", "on_behalf_of", "return_url", "url" ], "title": "PortalSession", "type": "object", "x-expandableFields": [ "configuration", "flow" ], "x-resourceId": "billing_portal.session", "x-stripeMostCommon": [ "configuration", "created", "customer", "customer_account", "flow", "id", "livemode", "locale", "object", "on_behalf_of", "return_url", "url" ], "x-stripeOperations": [ { "method_name": "create", "method_on": "service", "method_type": "create", "operation": "post", "path": "/v1/billing_portal/sessions" } ], "x-stripeResource": { "class_name": "Session", "in_package": "BillingPortal" } }, "billing_portal.session.created": { "description": "Occurs whenever a portal session is created.", "properties": { "object": { "$ref": "#/components/schemas/billing_portal.session" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "billing_portal.session.created" } }, "cancellation_details": { "description": "", "properties": { "comment": { "description": "Additional comments about why the user canceled the subscription, if the subscription was canceled explicitly by the user.", "maxLength": 5000, "nullable": true, "type": "string" }, "feedback": { "description": "The customer submitted reason for why they canceled, if the subscription was canceled explicitly by the user.", "enum": [ "customer_service", "low_quality", "missing_features", "other", "switched_service", "too_complex", "too_expensive", "unused" ], "nullable": true, "type": "string" }, "reason": { "description": "Why this subscription was canceled.", "enum": [ "cancellation_requested", "payment_disputed", "payment_failed" ], "nullable": true, "type": "string" } }, "required": [ "comment", "feedback", "reason" ], "title": "CancellationDetails", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "comment", "feedback", "reason" ] }, "capability": { "description": "This is an object representing a capability for a Stripe account.\n\nRelated guide: [Account capabilities](https://stripe.com/docs/connect/account-capabilities)", "properties": { "account": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/account" } ], "description": "The account for which the capability enables functionality.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/account" } ] } }, "future_requirements": { "$ref": "#/components/schemas/account_capability_future_requirements" }, "id": { "description": "The identifier for the capability.", "maxLength": 5000, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "capability" ], "type": "string" }, "requested": { "description": "Whether the capability has been requested.", "type": "boolean" }, "requested_at": { "description": "Time at which the capability was requested. Measured in seconds since the Unix epoch.", "format": "unix-time", "nullable": true, "type": "integer" }, "requirements": { "$ref": "#/components/schemas/account_capability_requirements" }, "status": { "description": "The status of the capability.", "enum": [ "active", "inactive", "pending", "unrequested" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "account", "id", "object", "requested", "requested_at", "status" ], "title": "AccountCapability", "type": "object", "x-expandableFields": [ "account", "future_requirements", "requirements" ], "x-resourceId": "capability", "x-stripeMostCommon": [ "account", "id", "requested", "requirements", "status" ], "x-stripeOperations": [ { "method_name": "list", "method_on": "collection", "method_type": "list", "operation": "get", "path": "/v1/accounts/{account}/capabilities" }, { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/accounts/{account}/capabilities" }, { "method_name": "retrieve", "method_on": "collection", "method_type": "retrieve", "operation": "get", "path": "/v1/accounts/{account}/capabilities/{capability}" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/accounts/{account}/capabilities/{capability}" }, { "method_name": "update", "method_on": "service", "method_type": "update", "operation": "post", "path": "/v1/accounts/{account}/capabilities/{capability}" } ], "x-stripeResource": { "class_name": "Capability", "has_collection_class": true, "in_package": "" } }, "capability.updated": { "description": "Occurs whenever a capability has new requirements or a new status.", "properties": { "object": { "$ref": "#/components/schemas/capability" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "capability.updated" } }, "capital.financing_offer": { "description": "This is an object representing an offer of financing from\nStripe Capital to a Connect subaccount.", "properties": { "accepted_terms": { "$ref": "#/components/schemas/capital_connect_connect_financing_accepted_terms" }, "account": { "description": "The ID of the merchant associated with this financing object.", "maxLength": 5000, "type": "string" }, "charged_off_at": { "description": "The time at which this financing offer was charged off, if applicable. Given in seconds since unix epoch.", "format": "unix-time", "type": "integer" }, "created": { "description": "Time at which the offer was created. Given in seconds since unix epoch.", "type": "integer" }, "expires_after": { "description": "Time at which the offer expires. Given in seconds since unix epoch.", "type": "number" }, "financing_type": { "description": "The type of financing being offered.", "enum": [ "cash_advance", "flex_loan" ], "type": "string", "x-stripeBypassValidation": true }, "id": { "description": "A unique identifier for the financing object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "type": "object" }, "object": { "description": "The object type: financing_offer.", "enum": [ "capital.financing_offer" ], "type": "string" }, "offered_terms": { "$ref": "#/components/schemas/capital_connect_connect_financing_offered_terms" }, "product_type": { "description": "Financing product identifier.", "enum": [ "refill", "standard" ], "type": "string" }, "replacement": { "description": "The ID of the financing offer that replaced this offer.", "maxLength": 5000, "type": "string" }, "replacement_for": { "description": "The ID of the financing offer that this offer is a replacement for.", "maxLength": 5000, "type": "string" }, "status": { "description": "The current status of the offer.", "enum": [ "accepted", "canceled", "completed", "delivered", "expired", "fully_repaid", "paid_out", "rejected", "replaced", "undelivered" ], "type": "string" }, "type": { "description": "See [financing_type](https://stripe.com/docs/api/capital/connect_financing_object#financing_offer_object-financing_type).", "enum": [ "cash_advance", "fixed_term_loan", "flex_loan" ], "type": "string" } }, "required": [ "account", "created", "expires_after", "id", "livemode", "object", "status" ], "title": "CapitalConnectConnectFinancing", "type": "object", "x-expandableFields": [ "accepted_terms", "offered_terms" ], "x-resourceId": "capital.financing_offer", "x-stripeMostCommon": [ "accepted_terms", "account", "charged_off_at", "created", "expires_after", "financing_type", "id", "livemode", "metadata", "object", "offered_terms", "product_type", "replacement", "replacement_for", "status", "type" ], "x-stripeOperations": [ { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/capital/financing_offers" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/capital/financing_offers/{financing_offer}" }, { "method_name": "mark_delivered", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/capital/financing_offers/{financing_offer}/mark_delivered" } ], "x-stripeResource": { "class_name": "FinancingOffer", "has_collection_class": true, "in_package": "Capital" } }, "capital.financing_offer.accepted": { "description": "Occurs whenever a connected account accepts a financing offer.", "properties": { "object": { "$ref": "#/components/schemas/capital.financing_offer" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "capital.financing_offer.accepted" } }, "capital.financing_offer.canceled": { "description": "Occurs whenever a financing offer is canceled.", "properties": { "object": { "$ref": "#/components/schemas/capital.financing_offer" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "capital.financing_offer.canceled" } }, "capital.financing_offer.created": { "description": "Occurs whenever a new financing offer is created for a connected account.", "properties": { "object": { "$ref": "#/components/schemas/capital.financing_offer" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "capital.financing_offer.created" } }, "capital.financing_offer.expired": { "description": "Occurs whenever a financing offer expires.", "properties": { "object": { "$ref": "#/components/schemas/capital.financing_offer" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "capital.financing_offer.expired" } }, "capital.financing_offer.fully_repaid": { "description": "Occurs whenever a financing offer is fully repaid.", "properties": { "object": { "$ref": "#/components/schemas/capital.financing_offer" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "capital.financing_offer.fully_repaid" } }, "capital.financing_offer.paid_out": { "description": "Occurs whenever a financing offer is paid out.", "properties": { "object": { "$ref": "#/components/schemas/capital.financing_offer" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "capital.financing_offer.paid_out" } }, "capital.financing_offer.rejected": { "description": "Occurs whenever a financing offer is rejected.", "properties": { "object": { "$ref": "#/components/schemas/capital.financing_offer" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "capital.financing_offer.rejected" } }, "capital.financing_offer.replacement_created": { "description": "Occurs whenever a replacement for a financing offer has been created. More details can be [found here](https://docs.stripe.com/capital/replacements).", "properties": { "object": { "$ref": "#/components/schemas/capital.financing_offer" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "capital.financing_offer.replacement_created" } }, "capital.financing_summary": { "description": "A financing object describes an account's current financing state. Used by Connect\nplatforms to read the state of Capital offered to their connected accounts.", "properties": { "details": { "anyOf": [ { "$ref": "#/components/schemas/capital_connect_financing_summary_details" } ], "description": "Additional information about the financing summary. Describes currency, advance amount,\nfee amount, withhold rate, remaining amount, paid amount, current repayment interval,\nrepayment start date, and advance payout date.", "nullable": true }, "financing_offer": { "description": "The Financing Offer ID this Financing Summary corresponds to", "maxLength": 5000, "nullable": true, "type": "string" }, "object": { "description": "The object type: financing_summary", "enum": [ "capital.financing_summary" ], "type": "string" }, "status": { "description": "Status of the Connected Account's financing. [/v1/capital/financing_summary](https://stripe.com/docs/api/capital/financing_summary) will only return `details` for `paid_out` financing.", "enum": [ "accepted", "delivered", "none" ], "nullable": true, "type": "string" } }, "required": [ "details", "financing_offer", "object", "status" ], "title": "CapitalConnectFinancingSummary", "type": "object", "x-expandableFields": [ "details" ], "x-resourceId": "capital.financing_summary", "x-stripeMostCommon": [ "details", "financing_offer", "object", "status" ], "x-stripeOperations": [ { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/capital/financing_summary" } ], "x-stripeResource": { "class_name": "FinancingSummary", "in_package": "Capital" } }, "capital.financing_transaction": { "description": "This is an object representing the details of a transaction on a Capital financing object.", "properties": { "account": { "description": "The ID of the merchant associated with this financing transaction.", "maxLength": 5000, "type": "string" }, "created_at": { "description": "Time at which the financing transaction was created. Given in seconds since unix epoch.", "format": "unix-time", "type": "integer" }, "details": { "$ref": "#/components/schemas/capital_connect_financing_transaction_details" }, "financing_offer": { "description": "The Capital financing offer for this financing transaction.", "maxLength": 5000, "nullable": true, "type": "string" }, "id": { "description": "A unique identifier for the financing transaction object.", "maxLength": 5000, "type": "string" }, "legacy_balance_transaction_source": { "description": "The Capital transaction object that predates the Financing Transactions API and\ncorresponds with the balance transaction that was created as a result of this\nfinancing transaction.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "object": { "description": "The object type: financing_transaction", "enum": [ "capital.financing_transaction" ], "type": "string" }, "type": { "description": "The type of the financing transaction.", "enum": [ "payment", "payout", "reversal" ], "type": "string" }, "user_facing_description": { "description": "A human-friendly description of the financing transaction.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "account", "created_at", "details", "financing_offer", "id", "livemode", "object", "type", "user_facing_description" ], "title": "CapitalConnectFinancingTransaction", "type": "object", "x-expandableFields": [ "details" ], "x-resourceId": "capital.financing_transaction", "x-stripeMostCommon": [ "account", "created_at", "details", "financing_offer", "id", "legacy_balance_transaction_source", "livemode", "object", "type", "user_facing_description" ], "x-stripeOperations": [ { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/capital/financing_transactions" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/capital/financing_transactions/{financing_transaction}" } ], "x-stripeResource": { "class_name": "FinancingTransaction", "has_collection_class": true, "in_package": "Capital" } }, "capital.financing_transaction.created": { "description": "Occurs whenever a financing transaction is created.", "properties": { "object": { "$ref": "#/components/schemas/capital.financing_transaction" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "capital.financing_transaction.created" } }, "capital_connect_connect_financing_accepted_terms": { "description": "This is an object representing the terms of an offer of financing from\nStripe Capital to a Connected account. This resource represents\nthe terms accepted by the Connected account, which may differ from those\noffered.", "properties": { "advance_amount": { "description": "Amount of financing offered, in minor units. For example, $1,000 USD will be represented as 100000.", "type": "integer" }, "currency": { "description": "Currency that the financing offer is transacted in. For example, `usd`.", "maxLength": 5000, "type": "string" }, "fee_amount": { "description": "Fixed fee amount, in minor units. For example, $100 USD will be represented as 10000.", "type": "integer" }, "previous_financing_fee_discount_amount": { "description": "Populated when the `product_type` of the `financingoffer` is `refill`.\nRepresents the discount amount on remaining premium for the existing loan at payout time.", "nullable": true, "type": "integer" }, "withhold_rate": { "description": "Per-transaction rate at which Stripe will withhold funds to repay the financing.", "type": "number" } }, "required": [ "advance_amount", "currency", "fee_amount", "previous_financing_fee_discount_amount", "withhold_rate" ], "title": "CapitalConnectConnectFinancingAcceptedTerms", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "advance_amount", "currency", "fee_amount", "previous_financing_fee_discount_amount", "withhold_rate" ] }, "capital_connect_connect_financing_offered_terms": { "description": "This is an object representing the terms of an offer of financing from\nStripe Capital to a Connected account. This resource represents\nboth the terms offered to the Connected account.", "properties": { "advance_amount": { "description": "Amount of financing offered, in minor units. For example, $1,000 USD will be represented as 100000.", "type": "integer" }, "campaign_type": { "description": "Describes the type of user the offer is being extended to.", "enum": [ "newly_eligible_user", "previously_eligible_user", "repeat_user" ], "type": "string" }, "currency": { "description": "Currency that the financing offer is transacted in. For example, `usd`.", "maxLength": 5000, "type": "string" }, "fee_amount": { "description": "Fixed fee amount, in minor units. For example, $100 USD will be represented as 10000.", "type": "integer" }, "previous_financing_fee_discount_rate": { "description": "Populated when the `product_type` of the `financingoffer` is `refill`.\nRepresents the discount rate percentage on remaining fee on the existing loan. When the `financing_offer`\nis paid out, the `previous_financing_fee_discount_amount` will be computed as the multiple of this rate\nand the remaining fee.", "nullable": true, "type": "number" }, "withhold_rate": { "description": "Per-transaction rate at which Stripe will withhold funds to repay the financing.", "type": "number" } }, "required": [ "advance_amount", "campaign_type", "currency", "fee_amount", "previous_financing_fee_discount_rate", "withhold_rate" ], "title": "CapitalConnectConnectFinancingOfferedTerms", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "advance_amount", "campaign_type", "currency", "fee_amount", "previous_financing_fee_discount_rate", "withhold_rate" ] }, "capital_connect_financing_summary_current_repayment_window": { "description": "The current repayment interval for the Connected account.", "properties": { "due_at": { "description": "The time at which the minimum payment amount will be due. If not met through withholding, the Connected account's linked bank account or account balance will be debited.\nGiven in seconds since unix epoch.", "type": "number" }, "paid_amount": { "description": "The amount that has already been paid in the current repayment interval, in minor units. For example, $100 USD will be represented as 10000.", "nullable": true, "type": "integer" }, "remaining_amount": { "description": "The amount that is yet to be paid in the current repayment interval, in minor units. For example, $100 USD will be represented as 10000.", "type": "integer" } }, "required": [ "due_at", "paid_amount", "remaining_amount" ], "title": "CapitalConnectFinancingSummaryCurrentRepaymentWindow", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "due_at", "paid_amount", "remaining_amount" ] }, "capital_connect_financing_summary_details": { "description": "", "properties": { "advance_amount": { "description": "Amount of financing offered, in minor units. For example, $1,000 USD will be represented as 100000.", "type": "integer" }, "advance_paid_out_at": { "description": "The time at which the funds were paid out to the connected account's Stripe balance. Given in milliseconds since unix epoch.", "nullable": true, "type": "number" }, "currency": { "description": "Currency that the financing offer is transacted in. For example, `usd`.", "maxLength": 5000, "type": "string" }, "current_repayment_interval": { "anyOf": [ { "$ref": "#/components/schemas/capital_connect_financing_summary_current_repayment_window" } ], "description": "The chronologically current repayment interval for the financing offer.", "nullable": true }, "fee_amount": { "description": "Fixed fee amount, in minor units. For example, $100 USD will be represented as 10000.", "type": "integer" }, "paid_amount": { "description": "The amount the Connected account has paid toward the financing debt so far, in minor units. For example, $1,000 USD will be represented as 100000.", "type": "integer" }, "remaining_amount": { "description": "The balance remaining to be paid on the financing, in minor units. For example, $1,000 USD will be represented as 100000.", "type": "integer" }, "repayments_begin_at": { "description": "The time at which Capital will begin withholding from payments. Given in seconds since unix epoch.", "nullable": true, "type": "number" }, "withhold_rate": { "description": "Per-transaction rate at which Stripe will withhold funds to repay the financing.", "type": "number" } }, "required": [ "advance_amount", "advance_paid_out_at", "currency", "current_repayment_interval", "fee_amount", "paid_amount", "remaining_amount", "repayments_begin_at", "withhold_rate" ], "title": "CapitalConnectFinancingSummaryDetails", "type": "object", "x-expandableFields": [ "current_repayment_interval" ], "x-stripeMostCommon": [ "advance_amount", "advance_paid_out_at", "currency", "current_repayment_interval", "fee_amount", "paid_amount", "remaining_amount", "repayments_begin_at", "withhold_rate" ] }, "capital_connect_financing_transaction_details": { "description": "This is an object representing a transaction on a Capital financing offer.", "properties": { "advance_amount": { "description": "The advance amount being repaid, paid out, or reversed in minor units.", "type": "integer" }, "currency": { "description": "The currency of the financing transaction.", "maxLength": 5000, "type": "string" }, "fee_amount": { "description": "The fee amount being repaid, paid out, or reversed in minor units.", "type": "integer" }, "linked_payment": { "description": "The linked payment for the transaction. This field only applies to financing transactions of type `paydown` and reason `automatic_withholding`.", "maxLength": 5000, "type": "string" }, "reason": { "description": "The reason for the financing transaction (if applicable).", "enum": [ "automatic_withholding", "automatic_withholding_refund", "collection", "collection_failure", "financing_cancellation", "refill", "requested_by_user", "user_initiated" ], "type": "string" }, "reversed_transaction": { "description": "The reversed transaction. This field only applies to financing\ntransactions of type `reversal`.", "maxLength": 5000, "type": "string" }, "total_amount": { "description": "The advance and fee amount being repaid, paid out, or reversed in minor units.", "type": "integer" }, "transaction": { "$ref": "#/components/schemas/capital_connect_financing_transaction_details_transaction" } }, "required": [ "advance_amount", "currency", "fee_amount", "total_amount" ], "title": "CapitalConnectFinancingTransactionDetails", "type": "object", "x-expandableFields": [ "transaction" ], "x-stripeMostCommon": [ "advance_amount", "currency", "fee_amount", "linked_payment", "reason", "reversed_transaction", "total_amount", "transaction" ] }, "capital_connect_financing_transaction_details_transaction": { "description": "This is an object representing a linked transaction on a Capital Financing Transaction.", "properties": { "charge": { "description": "The linked payment ID.", "maxLength": 5000, "type": "string" }, "treasury_transaction": { "description": "The linked Treasury Financing Transaction ID.", "maxLength": 5000, "type": "string" } }, "title": "CapitalConnectFinancingTransactionDetailsTransaction", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "charge", "treasury_transaction" ] }, "card": { "description": "You can store multiple cards on a customer in order to charge the customer\nlater. You can also store multiple debit cards on a recipient in order to\ntransfer to those cards later.\n\nRelated guide: [Card payments with Sources](https://stripe.com/docs/sources/cards)", "properties": { "account": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/account" } ], "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/account" } ] } }, "address_city": { "description": "City/District/Suburb/Town/Village.", "maxLength": 5000, "nullable": true, "type": "string" }, "address_country": { "description": "Billing address country, if provided when creating card.", "maxLength": 5000, "nullable": true, "type": "string" }, "address_line1": { "description": "Address line 1 (Street address/PO Box/Company name).", "maxLength": 5000, "nullable": true, "type": "string" }, "address_line1_check": { "description": "If `address_line1` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.", "maxLength": 5000, "nullable": true, "type": "string" }, "address_line2": { "description": "Address line 2 (Apartment/Suite/Unit/Building).", "maxLength": 5000, "nullable": true, "type": "string" }, "address_state": { "description": "State/County/Province/Region.", "maxLength": 5000, "nullable": true, "type": "string" }, "address_zip": { "description": "ZIP or postal code.", "maxLength": 5000, "nullable": true, "type": "string" }, "address_zip_check": { "description": "If `address_zip` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.", "maxLength": 5000, "nullable": true, "type": "string" }, "allow_redisplay": { "description": "This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to “unspecified”.", "enum": [ "always", "limited", "unspecified" ], "nullable": true, "type": "string" }, "available_payout_methods": { "description": "A set of available payout methods for this card. Only values from this set should be passed as the `method` when creating a payout.", "items": { "enum": [ "instant", "standard" ], "type": "string" }, "nullable": true, "type": "array" }, "brand": { "description": "Card brand. Can be `American Express`, `Cartes Bancaires`, `Diners Club`, `Discover`, `Eftpos Australia`, `Girocard`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`.", "maxLength": 5000, "type": "string" }, "brand_product": { "description": "The [product code](https://stripe.com/docs/card-product-codes) that identifies the specific program or product associated with a card. (For internal use only and not typically available in standard API requests.)", "maxLength": 5000, "nullable": true, "type": "string" }, "country": { "description": "Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.", "maxLength": 5000, "nullable": true, "type": "string" }, "currency": { "description": "Three-letter [ISO code for currency](https://www.iso.org/iso-4217-currency-codes.html) in lowercase. Must be a [supported currency](https://docs.stripe.com/currencies). Only applicable on accounts (not customers or recipients). The card can be used as a transfer destination for funds in this currency. This property is only available when returned as an [External Account](/api/external_account_cards/object) where [controller.is_controller](/api/accounts/object#account_object-controller-is_controller) is `true`.", "format": "currency", "nullable": true, "type": "string" }, "customer": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/customer" }, { "$ref": "#/components/schemas/deleted_customer" } ], "description": "The customer that this card belongs to. This attribute will not be in the card object if the card belongs to an account or recipient instead.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/customer" }, { "$ref": "#/components/schemas/deleted_customer" } ] } }, "cvc_check": { "description": "If a CVC was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`. A result of unchecked indicates that CVC was provided but hasn't been checked yet. Checks are typically performed when attaching a card to a Customer object, or when creating a charge. For more details, see [Check if a card is valid without a charge](https://support.stripe.com/questions/check-if-a-card-is-valid-without-a-charge).", "maxLength": 5000, "nullable": true, "type": "string" }, "default_for_currency": { "description": "Whether this card is the default external account for its currency. This property is only available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.", "nullable": true, "type": "boolean" }, "description": { "description": "A high-level description of the type of cards issued in this range. (For internal use only and not typically available in standard API requests.)", "maxLength": 5000, "type": "string" }, "dynamic_last4": { "description": "(For tokenized numbers only.) The last four digits of the device account number.", "maxLength": 5000, "nullable": true, "type": "string" }, "exp_month": { "description": "Two-digit number representing the card's expiration month.", "type": "integer" }, "exp_year": { "description": "Four-digit number representing the card's expiration year.", "type": "integer" }, "fingerprint": { "description": "Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.\n\n*As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*", "maxLength": 5000, "nullable": true, "type": "string" }, "funding": { "description": "Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.", "maxLength": 5000, "type": "string" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "iin": { "description": "Issuer identification number of the card. (For internal use only and not typically available in standard API requests.)", "maxLength": 5000, "type": "string" }, "issuer": { "description": "The name of the card's issuing bank. (For internal use only and not typically available in standard API requests.)", "maxLength": 5000, "type": "string" }, "last4": { "description": "The last four digits of the card.", "maxLength": 5000, "type": "string" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "nullable": true, "type": "object" }, "name": { "description": "Cardholder name.", "maxLength": 5000, "nullable": true, "type": "string" }, "networks": { "$ref": "#/components/schemas/token_card_networks" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "card" ], "type": "string" }, "regulated_status": { "description": "Status of a card based on the card issuer.", "enum": [ "regulated", "unregulated" ], "nullable": true, "type": "string" }, "status": { "description": "For external accounts that are cards, possible values are `new` and `errored`. If a payout fails, the status is set to `errored` and [scheduled payouts](https://stripe.com/docs/payouts#payout-schedule) are stopped until account details are updated.", "maxLength": 5000, "nullable": true, "type": "string" }, "tokenization_method": { "description": "If the card number is tokenized, this is the method that was used. Can be `android_pay` (includes Google Pay), `apple_pay`, `masterpass`, `visa_checkout`, or null.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "address_city", "address_country", "address_line1", "address_line1_check", "address_line2", "address_state", "address_zip", "address_zip_check", "brand", "country", "cvc_check", "dynamic_last4", "exp_month", "exp_year", "funding", "id", "last4", "metadata", "name", "object", "regulated_status", "tokenization_method" ], "title": "Card", "type": "object", "x-expandableFields": [ "account", "customer", "networks" ], "x-resourceId": "card", "x-stripeMostCommon": [ "address_city", "address_country", "address_line1", "address_line2", "address_state", "address_zip", "address_zip_check", "brand", "country", "customer", "cvc_check", "exp_month", "exp_year", "fingerprint", "funding", "id", "last4", "metadata", "name" ], "x-stripeOperations": [ { "method_name": "delete", "method_on": "service", "method_type": "delete", "operation": "delete", "path": "/v1/accounts/{account}/external_accounts/{id}" }, { "method_name": "delete", "method_on": "service", "method_type": "delete", "operation": "delete", "path": "/v1/customers/{customer}/sources/{id}" }, { "method_name": "update", "method_on": "service", "method_type": "update", "operation": "post", "path": "/v1/accounts/{account}/external_accounts/{id}" }, { "method_name": "update", "method_on": "service", "method_type": "update", "operation": "post", "path": "/v1/customers/{customer}/sources/{id}" } ], "x-stripeResource": { "class_name": "Card", "in_package": "", "polymorphic_groups": [ "deleted_external_account", "deleted_payment_source", "external_account", "payment_source" ] } }, "card_generated_from_payment_method_details": { "description": "", "properties": { "card_present": { "$ref": "#/components/schemas/payment_method_details_card_present" }, "type": { "description": "The type of payment method transaction-specific details from the transaction that generated this `card` payment method. Always `card_present`.", "maxLength": 5000, "type": "string" } }, "required": [ "type" ], "title": "card_generated_from_payment_method_details", "type": "object", "x-expandableFields": [ "card_present" ], "x-stripeMostCommon": [ "card_present", "type" ] }, "card_issuing_account_terms_of_service": { "description": "", "properties": { "date": { "description": "The Unix timestamp marking when the account representative accepted the service agreement.", "nullable": true, "type": "integer" }, "ip": { "description": "The IP address from which the account representative accepted the service agreement.", "maxLength": 5000, "nullable": true, "type": "string" }, "user_agent": { "description": "The user agent of the browser from which the account representative accepted the service agreement.", "maxLength": 5000, "type": "string" } }, "required": [ "date", "ip" ], "title": "CardIssuingAccountTermsOfService", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "date", "ip", "user_agent" ] }, "card_mandate_payment_method_details": { "description": "", "properties": {}, "title": "card_mandate_payment_method_details", "type": "object", "x-expandableFields": [] }, "cash_balance": { "description": "A customer's `Cash balance` represents real funds. Customers can add funds to their cash balance by sending a bank transfer. These funds can be used for payment and can eventually be paid out to your bank account.", "properties": { "available": { "additionalProperties": { "type": "integer" }, "description": "A hash of all cash balances available to this customer. You cannot delete a customer with any cash balances, even if the balance is 0. Amounts are represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", "nullable": true, "type": "object" }, "customer": { "description": "The ID of the customer whose cash balance this object represents.", "maxLength": 5000, "type": "string" }, "customer_account": { "description": "The ID of the account whose cash balance this object represents.", "maxLength": 5000, "nullable": true, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "cash_balance" ], "type": "string" }, "settings": { "$ref": "#/components/schemas/customer_balance_customer_balance_settings" } }, "required": [ "available", "customer", "livemode", "object", "settings" ], "title": "cash_balance", "type": "object", "x-expandableFields": [ "settings" ], "x-resourceId": "cash_balance", "x-stripeMostCommon": [ "available", "customer", "customer_account", "livemode", "object", "settings" ], "x-stripeOperations": [ { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/customers/{customer}/cash_balance" }, { "method_name": "update", "method_on": "service", "method_type": "update", "operation": "post", "path": "/v1/customers/{customer}/cash_balance" } ], "x-stripeResource": { "class_name": "CashBalance", "in_package": "" } }, "cash_balance.funds_available": { "description": "Occurs whenever there is a positive remaining cash balance after Stripe automatically reconciles new funds into the cash balance. If you enabled manual reconciliation, this webhook will fire whenever there are new funds into the cash balance.", "properties": { "object": { "$ref": "#/components/schemas/cash_balance" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "cash_balance.funds_available" } }, "charge": { "description": "The `Charge` object represents a single attempt to move money into your Stripe account.\nPaymentIntent confirmation is the most common way to create Charges, but [Account Debits](https://stripe.com/docs/connect/account-debits) may also create Charges.\nSome legacy payment flows create Charges directly, which is not recommended for new integrations.", "properties": { "amount": { "description": "Amount intended to be collected by this payment. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).", "type": "integer" }, "amount_captured": { "description": "Amount in cents (or local equivalent) captured (can be less than the amount attribute on the charge if a partial capture was made).", "type": "integer" }, "amount_refunded": { "description": "Amount in cents (or local equivalent) refunded (can be less than the amount attribute on the charge if a partial refund was issued).", "type": "integer" }, "application": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/application" } ], "description": "ID of the Connect application that created the charge.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/application" } ] } }, "application_fee": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/application_fee" } ], "description": "The application fee (if any) for the charge. [See the Connect documentation](https://stripe.com/docs/connect/direct-charges#collect-fees) for details.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/application_fee" } ] } }, "application_fee_amount": { "description": "The amount of the application fee (if any) requested for the charge. [See the Connect documentation](https://stripe.com/docs/connect/direct-charges#collect-fees) for details.", "nullable": true, "type": "integer" }, "authorization_code": { "description": "Authorization code on the charge.", "maxLength": 5000, "type": "string" }, "balance_transaction": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/balance_transaction" } ], "description": "ID of the balance transaction that describes the impact of this charge on your account balance (not including refunds or disputes).", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/balance_transaction" } ] } }, "billing_details": { "$ref": "#/components/schemas/billing_details" }, "calculated_statement_descriptor": { "description": "The full statement descriptor that is passed to card networks, and that is displayed on your customers' credit card and bank statements. Allows you to see what the statement descriptor looks like after the static and dynamic portions are combined. This value only exists for card payments.", "maxLength": 5000, "nullable": true, "type": "string" }, "captured": { "description": "If the charge was created without capturing, this Boolean represents whether it is still uncaptured or has since been captured.", "type": "boolean" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "customer": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/customer" }, { "$ref": "#/components/schemas/deleted_customer" } ], "description": "ID of the customer this charge is for if one exists.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/customer" }, { "$ref": "#/components/schemas/deleted_customer" } ] } }, "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users.", "maxLength": 40000, "nullable": true, "type": "string" }, "disputed": { "description": "Whether the charge has been disputed.", "type": "boolean" }, "failure_balance_transaction": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/balance_transaction" } ], "description": "ID of the balance transaction that describes the reversal of the balance on your account due to payment failure.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/balance_transaction" } ] } }, "failure_code": { "description": "Error code explaining reason for charge failure if available (see [the errors section](https://stripe.com/docs/error-codes) for a list of codes).", "maxLength": 5000, "nullable": true, "type": "string" }, "failure_message": { "description": "Message to user further explaining reason for charge failure if available.", "maxLength": 5000, "nullable": true, "type": "string" }, "fraud_details": { "anyOf": [ { "$ref": "#/components/schemas/charge_fraud_details" } ], "description": "Information on fraud assessments for the charge.", "nullable": true }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "level3": { "$ref": "#/components/schemas/level3" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "type": "object" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "charge" ], "type": "string" }, "on_behalf_of": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/account" } ], "description": "The account (if any) the charge was made on behalf of without triggering an automatic transfer. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers) for details.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/account" } ] } }, "outcome": { "anyOf": [ { "$ref": "#/components/schemas/charge_outcome" } ], "description": "Details about whether the payment was accepted, and why. See [understanding declines](https://stripe.com/docs/declines) for details.", "nullable": true }, "paid": { "description": "`true` if the charge succeeded, or was successfully authorized for later capture.", "type": "boolean" }, "payment_intent": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/payment_intent" } ], "description": "ID of the PaymentIntent associated with this charge, if one exists.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/payment_intent" } ] } }, "payment_method": { "description": "ID of the payment method used in this charge.", "maxLength": 5000, "nullable": true, "type": "string" }, "payment_method_details": { "anyOf": [ { "$ref": "#/components/schemas/payment_method_details" } ], "description": "Details about the payment method at the time of the transaction.", "nullable": true }, "presentment_details": { "$ref": "#/components/schemas/payment_flows_payment_intent_presentment_details" }, "radar_options": { "$ref": "#/components/schemas/radar_radar_options" }, "receipt_email": { "description": "This is the email address that the receipt for this charge was sent to.", "maxLength": 5000, "nullable": true, "type": "string" }, "receipt_number": { "description": "This is the transaction number that appears on email receipts sent for this charge. This attribute will be `null` until a receipt has been sent.", "maxLength": 5000, "nullable": true, "type": "string" }, "receipt_url": { "description": "This is the URL to view the receipt for this charge. The receipt is kept up-to-date to the latest state of the charge, including any refunds. If the charge is for an Invoice, the receipt will be stylized as an Invoice receipt.", "maxLength": 5000, "nullable": true, "type": "string" }, "refunded": { "description": "Whether the charge has been fully refunded. If the charge is only partially refunded, this attribute will still be false.", "type": "boolean" }, "refunds": { "description": "A list of refunds that have been applied to the charge.", "nullable": true, "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/refund" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "RefundList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] }, "review": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/review" } ], "description": "ID of the review associated with this charge if one exists.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/review" } ] } }, "shipping": { "anyOf": [ { "$ref": "#/components/schemas/shipping" } ], "description": "Shipping information for the charge.", "nullable": true }, "source": { "anyOf": [ { "$ref": "#/components/schemas/payment_source" } ], "description": "This is a legacy field that will be removed in the future. It contains the Source, Card, or BankAccount object used for the charge. For details about the payment method used for this charge, refer to `payment_method` or `payment_method_details` instead.", "nullable": true }, "source_transfer": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/transfer" } ], "description": "The transfer ID which created this charge. Only present if the charge came from another Stripe account. [See the Connect documentation](https://docs.stripe.com/connect/destination-charges) for details.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/transfer" } ] } }, "statement_descriptor": { "description": "For a non-card charge, text that appears on the customer's statement as the statement descriptor. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).\n\nFor a card charge, this value is ignored unless you don't specify a `statement_descriptor_suffix`, in which case this value is used as the suffix.", "maxLength": 5000, "nullable": true, "type": "string" }, "statement_descriptor_suffix": { "description": "Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement. If the account has no prefix value, the suffix is concatenated to the account's statement descriptor.", "maxLength": 5000, "nullable": true, "type": "string" }, "status": { "description": "The status of the payment is either `succeeded`, `pending`, or `failed`.", "enum": [ "failed", "pending", "succeeded" ], "type": "string" }, "transfer": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/transfer" } ], "description": "ID of the transfer to the `destination` account (only applicable if the charge was created using the `destination` parameter).", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/transfer" } ] } }, "transfer_data": { "anyOf": [ { "$ref": "#/components/schemas/charge_transfer_data" } ], "description": "An optional dictionary including the account to automatically transfer to as part of a destination charge. [See the Connect documentation](https://stripe.com/docs/connect/destination-charges) for details.", "nullable": true }, "transfer_group": { "description": "A string that identifies this transaction as part of a group. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) for details.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "amount", "amount_captured", "amount_refunded", "application", "application_fee", "application_fee_amount", "balance_transaction", "billing_details", "calculated_statement_descriptor", "captured", "created", "currency", "customer", "description", "disputed", "failure_balance_transaction", "failure_code", "failure_message", "fraud_details", "id", "livemode", "metadata", "object", "on_behalf_of", "outcome", "paid", "payment_intent", "payment_method", "payment_method_details", "receipt_email", "receipt_number", "receipt_url", "refunded", "review", "shipping", "source", "source_transfer", "statement_descriptor", "statement_descriptor_suffix", "status", "transfer_data", "transfer_group" ], "title": "Charge", "type": "object", "x-expandableFields": [ "application", "application_fee", "balance_transaction", "billing_details", "customer", "failure_balance_transaction", "fraud_details", "level3", "on_behalf_of", "outcome", "payment_intent", "payment_method_details", "presentment_details", "radar_options", "refunds", "review", "shipping", "source", "source_transfer", "transfer", "transfer_data" ], "x-resourceId": "charge", "x-stripeMostCommon": [ "amount", "balance_transaction", "billing_details", "currency", "customer", "description", "disputed", "id", "metadata", "payment_intent", "payment_method_details", "receipt_email", "refunded", "shipping", "statement_descriptor", "statement_descriptor_suffix", "status" ], "x-stripeOperations": [ { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/charges" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/charges/{charge}" }, { "method_name": "search", "method_on": "service", "method_type": "custom", "operation": "get", "path": "/v1/charges/search" }, { "method_name": "create", "method_on": "service", "method_type": "create", "operation": "post", "path": "/v1/charges" }, { "method_name": "update", "method_on": "service", "method_type": "update", "operation": "post", "path": "/v1/charges/{charge}" }, { "method_name": "capture", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/charges/{charge}/capture" } ], "x-stripeResource": { "class_name": "Charge", "has_collection_class": true, "has_search_result_class": true, "in_package": "", "polymorphic_groups": [ "balance_transaction_source" ] } }, "charge.captured": { "description": "Occurs whenever a previously uncaptured charge is captured.", "properties": { "object": { "$ref": "#/components/schemas/charge" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "charge.captured" } }, "charge.dispute.closed": { "description": "Occurs when a dispute is closed and the dispute status changes to `lost`, `warning_closed`, or `won`.", "properties": { "object": { "$ref": "#/components/schemas/dispute" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "charge.dispute.closed" } }, "charge.dispute.created": { "description": "Occurs whenever a customer disputes a charge with their bank.", "properties": { "object": { "$ref": "#/components/schemas/dispute" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "charge.dispute.created" } }, "charge.dispute.funds_reinstated": { "description": "Occurs when funds are reinstated to your account after a dispute is closed. This includes [partially refunded payments](https://docs.stripe.com/disputes#disputes-on-partially-refunded-payments).", "properties": { "object": { "$ref": "#/components/schemas/dispute" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "charge.dispute.funds_reinstated" } }, "charge.dispute.funds_withdrawn": { "description": "Occurs when funds are removed from your account due to a dispute.", "properties": { "object": { "$ref": "#/components/schemas/dispute" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "charge.dispute.funds_withdrawn" } }, "charge.dispute.updated": { "description": "Occurs when the dispute is updated (usually with evidence).", "properties": { "object": { "$ref": "#/components/schemas/dispute" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "charge.dispute.updated" } }, "charge.expired": { "description": "Occurs whenever an uncaptured charge expires.", "properties": { "object": { "$ref": "#/components/schemas/charge" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "charge.expired" } }, "charge.failed": { "description": "Occurs whenever a failed charge attempt occurs.", "properties": { "object": { "$ref": "#/components/schemas/charge" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "charge.failed" } }, "charge.pending": { "description": "Occurs whenever a pending charge is created.", "properties": { "object": { "$ref": "#/components/schemas/charge" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "charge.pending" } }, "charge.refund.updated": { "description": "Occurs whenever a refund is updated on selected payment methods. For updates on all refunds, listen to `refund.updated` instead.", "properties": { "object": { "$ref": "#/components/schemas/refund" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "charge.refund.updated" } }, "charge.refunded": { "description": "Occurs whenever a charge is refunded, including partial refunds. Listen to `refund.created` for information about the refund.", "properties": { "object": { "$ref": "#/components/schemas/charge" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "charge.refunded" } }, "charge.succeeded": { "description": "Occurs whenever a charge is successful.", "properties": { "object": { "$ref": "#/components/schemas/charge" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "charge.succeeded" } }, "charge.updated": { "description": "Occurs whenever a charge description or metadata is updated, or upon an asynchronous capture.", "properties": { "object": { "$ref": "#/components/schemas/charge" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "charge.updated" } }, "charge_fraud_details": { "description": "", "properties": { "stripe_report": { "description": "Assessments from Stripe. If set, the value is `fraudulent`.", "maxLength": 5000, "type": "string" }, "user_report": { "description": "Assessments reported by you. If set, possible values of are `safe` and `fraudulent`.", "maxLength": 5000, "type": "string" } }, "title": "ChargeFraudDetails", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "stripe_report", "user_report" ] }, "charge_outcome": { "description": "", "properties": { "advice_code": { "description": "An enumerated value providing a more detailed explanation on [how to proceed with an error](https://stripe.com/docs/declines#retrying-issuer-declines).", "enum": [ "confirm_card_data", "do_not_try_again", "try_again_later" ], "nullable": true, "type": "string" }, "network_advice_code": { "description": "For charges declined by the network, a 2 digit code which indicates the advice returned by the network on how to proceed with an error.", "maxLength": 5000, "nullable": true, "type": "string" }, "network_decline_code": { "description": "For charges declined by the network, an alphanumeric code which indicates the reason the charge failed.", "maxLength": 5000, "nullable": true, "type": "string" }, "network_status": { "description": "Possible values are `approved_by_network`, `declined_by_network`, `not_sent_to_network`, and `reversed_after_approval`. The value `reversed_after_approval` indicates the payment was [blocked by Stripe](https://stripe.com/docs/declines#blocked-payments) after bank authorization, and may temporarily appear as \"pending\" on a cardholder's statement.", "maxLength": 5000, "nullable": true, "type": "string" }, "reason": { "description": "An enumerated value providing a more detailed explanation of the outcome's `type`. Charges blocked by Radar's default block rule have the value `highest_risk_level`. Charges placed in review by Radar's default review rule have the value `elevated_risk_level`. Charges blocked because the payment is unlikely to be authorized have the value `low_probability_of_authorization`. Charges authorized, blocked, or placed in review by custom rules have the value `rule`. See [understanding declines](https://stripe.com/docs/declines) for more details.", "maxLength": 5000, "nullable": true, "type": "string" }, "risk_level": { "description": "Stripe Radar's evaluation of the riskiness of the payment. Possible values for evaluated payments are `normal`, `elevated`, `highest`. For non-card payments, and card-based payments predating the public assignment of risk levels, this field will have the value `not_assessed`. In the event of an error in the evaluation, this field will have the value `unknown`. This field is only available with Radar.", "maxLength": 5000, "type": "string" }, "risk_score": { "description": "Stripe Radar's evaluation of the riskiness of the payment. Possible values for evaluated payments are between 0 and 100. For non-card payments, card-based payments predating the public assignment of risk scores, or in the event of an error during evaluation, this field will not be present. This field is only available with Radar for Fraud Teams.", "type": "integer" }, "rule": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/rule" } ], "description": "The ID of the Radar rule that matched the payment, if applicable.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/rule" } ] } }, "seller_message": { "description": "A human-readable description of the outcome type and reason, designed for you (the recipient of the payment), not your customer.", "maxLength": 5000, "nullable": true, "type": "string" }, "type": { "description": "Possible values are `authorized`, `manual_review`, `issuer_declined`, `blocked`, and `invalid`. See [understanding declines](https://stripe.com/docs/declines) and [Radar reviews](https://stripe.com/docs/radar/reviews) for details.", "maxLength": 5000, "type": "string" } }, "required": [ "advice_code", "network_advice_code", "network_decline_code", "network_status", "reason", "seller_message", "type" ], "title": "ChargeOutcome", "type": "object", "x-expandableFields": [ "rule" ], "x-stripeMostCommon": [ "advice_code", "network_advice_code", "network_decline_code", "network_status", "reason", "risk_level", "risk_score", "rule", "seller_message", "type" ] }, "charge_transfer_data": { "description": "", "properties": { "amount": { "description": "The amount transferred to the destination account, if specified. By default, the entire charge amount is transferred to the destination account.", "nullable": true, "type": "integer" }, "destination": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/account" } ], "description": "ID of an existing, connected Stripe account to transfer funds to if `transfer_data` was specified in the charge request.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/account" } ] } } }, "required": [ "amount", "destination" ], "title": "ChargeTransferData", "type": "object", "x-expandableFields": [ "destination" ], "x-stripeMostCommon": [ "amount", "destination" ] }, "checkout.session": { "description": "A Checkout Session represents your customer's session as they pay for\none-time purchases or subscriptions through [Checkout](https://stripe.com/docs/payments/checkout)\nor [Payment Links](https://stripe.com/docs/payments/payment-links). We recommend creating a\nnew Session each time your customer attempts to pay.\n\nOnce payment is successful, the Checkout Session will contain a reference\nto the [Customer](https://stripe.com/docs/api/customers), and either the successful\n[PaymentIntent](https://stripe.com/docs/api/payment_intents) or an active\n[Subscription](https://stripe.com/docs/api/subscriptions).\n\nYou can create a Checkout Session on your server and redirect to its URL\nto begin Checkout.\n\nRelated guide: [Checkout quickstart](https://stripe.com/docs/checkout/quickstart)", "properties": { "adaptive_pricing": { "anyOf": [ { "$ref": "#/components/schemas/payment_pages_checkout_session_adaptive_pricing" } ], "description": "Settings for price localization with [Adaptive Pricing](https://docs.stripe.com/payments/checkout/adaptive-pricing).", "nullable": true }, "after_expiration": { "anyOf": [ { "$ref": "#/components/schemas/payment_pages_checkout_session_after_expiration" } ], "description": "When set, provides configuration for actions to take if this Checkout Session expires.", "nullable": true }, "allow_promotion_codes": { "description": "Enables user redeemable promotion codes.", "nullable": true, "type": "boolean" }, "amount_subtotal": { "description": "Total of all items before discounts or taxes are applied.", "nullable": true, "type": "integer" }, "amount_total": { "description": "Total of all items after discounts and taxes are applied.", "nullable": true, "type": "integer" }, "automatic_tax": { "$ref": "#/components/schemas/payment_pages_checkout_session_automatic_tax" }, "billing_address_collection": { "description": "Describes whether Checkout should collect the customer's billing address. Defaults to `auto`.", "enum": [ "auto", "required" ], "nullable": true, "type": "string" }, "cancel_url": { "description": "If set, Checkout displays a back button and customers will be directed to this URL if they decide to cancel payment and return to your website.", "maxLength": 5000, "nullable": true, "type": "string" }, "client_reference_id": { "description": "A unique string to reference the Checkout Session. This can be a\ncustomer ID, a cart ID, or similar, and can be used to reconcile the\nSession with your internal systems.", "maxLength": 5000, "nullable": true, "type": "string" }, "client_secret": { "description": "The client secret of your Checkout Session. Applies to Checkout Sessions with `ui_mode: embedded` or `ui_mode: custom`. For `ui_mode: embedded`, the client secret is to be used when initializing Stripe.js embedded checkout.\n For `ui_mode: custom`, use the client secret with [initCheckout](https://stripe.com/docs/js/custom_checkout/init) on your front end.", "maxLength": 5000, "nullable": true, "type": "string" }, "collected_information": { "anyOf": [ { "$ref": "#/components/schemas/payment_pages_checkout_session_collected_information" } ], "description": "Information about the customer collected within the Checkout Session.", "nullable": true }, "consent": { "anyOf": [ { "$ref": "#/components/schemas/payment_pages_checkout_session_consent" } ], "description": "Results of `consent_collection` for this session.", "nullable": true }, "consent_collection": { "anyOf": [ { "$ref": "#/components/schemas/payment_pages_checkout_session_consent_collection" } ], "description": "When set, provides configuration for the Checkout Session to gather active consent from customers.", "nullable": true }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "nullable": true, "type": "string" }, "currency_conversion": { "anyOf": [ { "$ref": "#/components/schemas/payment_pages_checkout_session_currency_conversion" } ], "description": "Currency conversion details for [Adaptive Pricing](https://docs.stripe.com/payments/checkout/adaptive-pricing) sessions created before 2025-03-31.", "nullable": true }, "custom_fields": { "description": "Collect additional information from your customer using custom fields. Up to 3 fields are supported.", "items": { "$ref": "#/components/schemas/payment_pages_checkout_session_custom_fields" }, "type": "array" }, "custom_text": { "$ref": "#/components/schemas/payment_pages_checkout_session_custom_text" }, "customer": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/customer" }, { "$ref": "#/components/schemas/deleted_customer" } ], "description": "The ID of the customer for this Session.\nFor Checkout Sessions in `subscription` mode or Checkout Sessions with `customer_creation` set as `always` in `payment` mode, Checkout\nwill create a new customer object based on information provided\nduring the payment flow unless an existing customer was provided when\nthe Session was created.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/customer" }, { "$ref": "#/components/schemas/deleted_customer" } ] } }, "customer_account": { "description": "The ID of the account for this Session.", "maxLength": 5000, "nullable": true, "type": "string" }, "customer_creation": { "description": "Configure whether a Checkout Session creates a Customer when the Checkout Session completes.", "enum": [ "always", "if_required" ], "nullable": true, "type": "string" }, "customer_details": { "anyOf": [ { "$ref": "#/components/schemas/payment_pages_checkout_session_customer_details" } ], "description": "The customer details including the customer's tax exempt status and the customer's tax IDs. Customer's address details are not present on Sessions in `setup` mode.", "nullable": true }, "customer_email": { "description": "If provided, this value will be used when the Customer object is created.\nIf not provided, customers will be asked to enter their email address.\nUse this parameter to prefill customer data if you already have an email\non file. To access information about the customer once the payment flow is\ncomplete, use the `customer` attribute.", "maxLength": 5000, "nullable": true, "type": "string" }, "discounts": { "description": "List of coupons and promotion codes attached to the Checkout Session.", "items": { "$ref": "#/components/schemas/payment_pages_checkout_session_discount" }, "nullable": true, "type": "array" }, "expires_at": { "description": "The timestamp at which the Checkout Session will expire.", "format": "unix-time", "type": "integer" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "invoice": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/invoice" } ], "description": "ID of the invoice created by the Checkout Session, if it exists.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/invoice" } ] } }, "invoice_creation": { "anyOf": [ { "$ref": "#/components/schemas/payment_pages_checkout_session_invoice_creation" } ], "description": "Details on the state of invoice creation for the Checkout Session.", "nullable": true }, "line_items": { "description": "The line items purchased by the customer.", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/item" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "PaymentPagesCheckoutSessionListLineItems", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "locale": { "description": "The IETF language tag of the locale Checkout is displayed in. If blank or `auto`, the browser's locale is used.", "enum": [ "auto", "bg", "cs", "da", "de", "el", "en", "en-GB", "es", "es-419", "et", "fi", "fil", "fr", "fr-CA", "hr", "hu", "id", "it", "ja", "ko", "lt", "lv", "ms", "mt", "nb", "nl", "pl", "pt", "pt-BR", "ro", "ru", "sk", "sl", "sv", "th", "tr", "vi", "zh", "zh-HK", "zh-TW" ], "nullable": true, "type": "string", "x-stripeBypassValidation": true }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "nullable": true, "type": "object" }, "mode": { "description": "The mode of the Checkout Session.", "enum": [ "payment", "setup", "subscription" ], "type": "string", "x-stripeBypassValidation": true }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "checkout.session" ], "type": "string" }, "optional_items": { "description": "The optional items presented to the customer at checkout.", "items": { "$ref": "#/components/schemas/payment_pages_checkout_session_optional_item" }, "nullable": true, "type": "array" }, "origin_context": { "description": "Where the user is coming from. This informs the optimizations that are applied to the session.", "enum": [ "mobile_app", "web" ], "nullable": true, "type": "string" }, "payment_intent": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/payment_intent" } ], "description": "The ID of the PaymentIntent for Checkout Sessions in `payment` mode. You can't confirm or cancel the PaymentIntent for a Checkout Session. To cancel, [expire the Checkout Session](https://stripe.com/docs/api/checkout/sessions/expire) instead.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/payment_intent" } ] } }, "payment_link": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/payment_link" } ], "description": "The ID of the Payment Link that created this Session.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/payment_link" } ] } }, "payment_method_collection": { "description": "Configure whether a Checkout Session should collect a payment method. Defaults to `always`.", "enum": [ "always", "if_required" ], "nullable": true, "type": "string" }, "payment_method_configuration_details": { "anyOf": [ { "$ref": "#/components/schemas/payment_method_config_biz_payment_method_configuration_details" } ], "description": "Information about the payment method configuration used for this Checkout session if using dynamic payment methods.", "nullable": true }, "payment_method_options": { "anyOf": [ { "$ref": "#/components/schemas/checkout_session_payment_method_options" } ], "description": "Payment-method-specific configuration for the PaymentIntent or SetupIntent of this CheckoutSession.", "nullable": true }, "payment_method_types": { "description": "A list of the types of payment methods (e.g. card) this Checkout\nSession is allowed to accept.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "payment_status": { "description": "The payment status of the Checkout Session, one of `paid`, `unpaid`, or `no_payment_required`.\nYou can use this value to decide when to fulfill your customer's order.", "enum": [ "no_payment_required", "paid", "unpaid" ], "type": "string" }, "permissions": { "anyOf": [ { "$ref": "#/components/schemas/payment_pages_checkout_session_permissions" } ], "description": "This property is used to set up permissions for various actions (e.g., update) on the CheckoutSession object.\n\nFor specific permissions, please refer to their dedicated subsections, such as `permissions.update_shipping_details`.", "nullable": true }, "phone_number_collection": { "$ref": "#/components/schemas/payment_pages_checkout_session_phone_number_collection" }, "presentment_details": { "$ref": "#/components/schemas/payment_flows_payment_intent_presentment_details" }, "recovered_from": { "description": "The ID of the original expired Checkout Session that triggered the recovery flow.", "maxLength": 5000, "nullable": true, "type": "string" }, "redirect_on_completion": { "description": "This parameter applies to `ui_mode: embedded`. Learn more about the [redirect behavior](https://stripe.com/docs/payments/checkout/custom-success-page?payment-ui=embedded-form) of embedded sessions. Defaults to `always`.", "enum": [ "always", "if_required", "never" ], "type": "string" }, "return_url": { "description": "Applies to Checkout Sessions with `ui_mode: embedded` or `ui_mode: custom`. The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site.", "maxLength": 5000, "type": "string" }, "saved_payment_method_options": { "anyOf": [ { "$ref": "#/components/schemas/payment_pages_checkout_session_saved_payment_method_options" } ], "description": "Controls saved payment method settings for the session. Only available in `payment` and `subscription` mode.", "nullable": true }, "setup_intent": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/setup_intent" } ], "description": "The ID of the SetupIntent for Checkout Sessions in `setup` mode. You can't confirm or cancel the SetupIntent for a Checkout Session. To cancel, [expire the Checkout Session](https://stripe.com/docs/api/checkout/sessions/expire) instead.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/setup_intent" } ] } }, "shipping_address_collection": { "anyOf": [ { "$ref": "#/components/schemas/payment_pages_checkout_session_shipping_address_collection" } ], "description": "When set, provides configuration for Checkout to collect a shipping address from a customer.", "nullable": true }, "shipping_cost": { "anyOf": [ { "$ref": "#/components/schemas/payment_pages_checkout_session_shipping_cost" } ], "description": "The details of the customer cost of shipping, including the customer chosen ShippingRate.", "nullable": true }, "shipping_options": { "description": "The shipping rate options applied to this Session.", "items": { "$ref": "#/components/schemas/payment_pages_checkout_session_shipping_option" }, "type": "array" }, "status": { "description": "The status of the Checkout Session, one of `open`, `complete`, or `expired`.", "enum": [ "complete", "expired", "open" ], "nullable": true, "type": "string" }, "submit_type": { "description": "Describes the type of transaction being performed by Checkout in order to customize\nrelevant text on the page, such as the submit button. `submit_type` can only be\nspecified on Checkout Sessions in `payment` mode. If blank or `auto`, `pay` is used.", "enum": [ "auto", "book", "donate", "pay", "subscribe" ], "nullable": true, "type": "string" }, "subscription": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/subscription" } ], "description": "The ID of the [Subscription](https://stripe.com/docs/api/subscriptions) for Checkout Sessions in `subscription` mode.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/subscription" } ] } }, "success_url": { "description": "The URL the customer will be directed to after the payment or\nsubscription creation is successful.", "maxLength": 5000, "nullable": true, "type": "string" }, "tax_id_collection": { "$ref": "#/components/schemas/payment_pages_checkout_session_tax_id_collection" }, "total_details": { "anyOf": [ { "$ref": "#/components/schemas/payment_pages_checkout_session_total_details" } ], "description": "Tax and discount details for the computed total amount.", "nullable": true }, "ui_mode": { "description": "The UI mode of the Session. Defaults to `hosted`.", "enum": [ "custom", "embedded", "hosted" ], "nullable": true, "type": "string" }, "url": { "description": "The URL to the Checkout Session. Applies to Checkout Sessions with `ui_mode: hosted`. Redirect customers to this URL to take them to Checkout. If you’re using [Custom Domains](https://stripe.com/docs/payments/checkout/custom-domains), the URL will use your subdomain. Otherwise, it’ll use `checkout.stripe.com.`\nThis value is only present when the session is active.", "maxLength": 5000, "nullable": true, "type": "string" }, "wallet_options": { "anyOf": [ { "$ref": "#/components/schemas/checkout_session_wallet_options" } ], "description": "Wallet-specific configuration for this Checkout Session.", "nullable": true } }, "required": [ "adaptive_pricing", "after_expiration", "allow_promotion_codes", "amount_subtotal", "amount_total", "automatic_tax", "billing_address_collection", "cancel_url", "client_reference_id", "client_secret", "collected_information", "consent", "consent_collection", "created", "currency", "currency_conversion", "custom_fields", "custom_text", "customer", "customer_creation", "customer_details", "customer_email", "discounts", "expires_at", "id", "invoice", "invoice_creation", "livemode", "locale", "metadata", "mode", "object", "origin_context", "payment_intent", "payment_link", "payment_method_collection", "payment_method_configuration_details", "payment_method_options", "payment_method_types", "payment_status", "permissions", "recovered_from", "saved_payment_method_options", "setup_intent", "shipping_address_collection", "shipping_cost", "shipping_options", "status", "submit_type", "subscription", "success_url", "total_details", "ui_mode", "url", "wallet_options" ], "title": "Session", "type": "object", "x-expandableFields": [ "adaptive_pricing", "after_expiration", "automatic_tax", "collected_information", "consent", "consent_collection", "currency_conversion", "custom_fields", "custom_text", "customer", "customer_details", "discounts", "invoice", "invoice_creation", "line_items", "optional_items", "payment_intent", "payment_link", "payment_method_configuration_details", "payment_method_options", "permissions", "phone_number_collection", "presentment_details", "saved_payment_method_options", "setup_intent", "shipping_address_collection", "shipping_cost", "shipping_options", "subscription", "tax_id_collection", "total_details", "wallet_options" ], "x-resourceId": "checkout.session", "x-stripeMostCommon": [ "automatic_tax", "client_reference_id", "currency", "customer", "customer_email", "id", "line_items", "metadata", "mode", "payment_intent", "payment_status", "return_url", "status", "success_url", "ui_mode", "url" ], "x-stripeOperations": [ { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/checkout/sessions" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/checkout/sessions/{session}" }, { "method_name": "list_line_items", "method_on": "service", "method_type": "custom", "operation": "get", "path": "/v1/checkout/sessions/{session}/line_items" }, { "method_name": "create", "method_on": "service", "method_type": "create", "operation": "post", "path": "/v1/checkout/sessions" }, { "method_name": "update", "method_on": "service", "method_type": "update", "operation": "post", "path": "/v1/checkout/sessions/{session}" }, { "method_name": "expire", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/checkout/sessions/{session}/expire" } ], "x-stripeResource": { "class_name": "Session", "has_collection_class": true, "in_package": "Checkout" } }, "checkout.session.async_payment_failed": { "description": "Occurs when a payment intent using a delayed payment method fails.", "properties": { "object": { "$ref": "#/components/schemas/checkout.session" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "checkout.session.async_payment_failed" } }, "checkout.session.async_payment_succeeded": { "description": "Occurs when a payment intent using a delayed payment method finally succeeds.", "properties": { "object": { "$ref": "#/components/schemas/checkout.session" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "checkout.session.async_payment_succeeded" } }, "checkout.session.completed": { "description": "Occurs when a Checkout Session has been successfully completed.", "properties": { "object": { "$ref": "#/components/schemas/checkout.session" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "checkout.session.completed" } }, "checkout.session.expired": { "description": "Occurs when a Checkout Session is expired.", "properties": { "object": { "$ref": "#/components/schemas/checkout.session" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "checkout.session.expired" } }, "checkout_acss_debit_mandate_options": { "description": "", "properties": { "custom_mandate_url": { "description": "A URL for custom mandate text", "maxLength": 5000, "type": "string" }, "default_for": { "description": "List of Stripe products where this mandate can be selected automatically. Returned when the Session is in `setup` mode.", "items": { "enum": [ "invoice", "subscription" ], "type": "string" }, "type": "array" }, "interval_description": { "description": "Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'.", "maxLength": 5000, "nullable": true, "type": "string" }, "payment_schedule": { "description": "Payment schedule for the mandate.", "enum": [ "combined", "interval", "sporadic" ], "nullable": true, "type": "string" }, "transaction_type": { "description": "Transaction type of the mandate.", "enum": [ "business", "personal" ], "nullable": true, "type": "string" } }, "required": [ "interval_description", "payment_schedule", "transaction_type" ], "title": "CheckoutAcssDebitMandateOptions", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "custom_mandate_url", "default_for", "interval_description", "payment_schedule", "transaction_type" ] }, "checkout_acss_debit_payment_method_options": { "description": "", "properties": { "currency": { "description": "Currency supported by the bank account. Returned when the Session is in `setup` mode.", "enum": [ "cad", "usd" ], "type": "string" }, "mandate_options": { "$ref": "#/components/schemas/checkout_acss_debit_mandate_options" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none", "off_session", "on_session" ], "type": "string" }, "target_date": { "description": "Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.", "maxLength": 5000, "type": "string" }, "verification_method": { "description": "Bank account verification method.", "enum": [ "automatic", "instant", "microdeposits" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "CheckoutAcssDebitPaymentMethodOptions", "type": "object", "x-expandableFields": [ "mandate_options" ], "x-stripeMostCommon": [ "currency", "mandate_options", "setup_future_usage", "target_date", "verification_method" ] }, "checkout_affirm_payment_method_options": { "description": "", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string" } }, "title": "CheckoutAffirmPaymentMethodOptions", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "setup_future_usage" ] }, "checkout_afterpay_clearpay_payment_method_options": { "description": "", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string" } }, "title": "CheckoutAfterpayClearpayPaymentMethodOptions", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "setup_future_usage" ], "x-stripeResource": { "class_name": "AfterpayClearpay", "in_package": "" } }, "checkout_alipay_payment_method_options": { "description": "", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string" } }, "title": "CheckoutAlipayPaymentMethodOptions", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "setup_future_usage" ] }, "checkout_amazon_pay_payment_method_options": { "description": "", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none", "off_session" ], "type": "string" } }, "title": "CheckoutAmazonPayPaymentMethodOptions", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "setup_future_usage" ] }, "checkout_au_becs_debit_payment_method_options": { "description": "", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string" }, "target_date": { "description": "Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.", "maxLength": 5000, "type": "string" } }, "title": "CheckoutAuBecsDebitPaymentMethodOptions", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "setup_future_usage", "target_date" ] }, "checkout_bacs_debit_payment_method_options": { "description": "", "properties": { "mandate_options": { "$ref": "#/components/schemas/checkout_payment_method_options_mandate_options_bacs_debit" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none", "off_session", "on_session" ], "type": "string" }, "target_date": { "description": "Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.", "maxLength": 5000, "type": "string" } }, "title": "CheckoutBacsDebitPaymentMethodOptions", "type": "object", "x-expandableFields": [ "mandate_options" ], "x-stripeMostCommon": [ "mandate_options", "setup_future_usage", "target_date" ] }, "checkout_bancontact_payment_method_options": { "description": "", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string" } }, "title": "CheckoutBancontactPaymentMethodOptions", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "setup_future_usage" ] }, "checkout_boleto_payment_method_options": { "description": "", "properties": { "expires_after_days": { "description": "The number of calendar days before a Boleto voucher expires. For example, if you create a Boleto voucher on Monday and you set expires_after_days to 2, the Boleto voucher will expire on Wednesday at 23:59 America/Sao_Paulo time.", "type": "integer" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none", "off_session", "on_session" ], "type": "string" } }, "required": [ "expires_after_days" ], "title": "CheckoutBoletoPaymentMethodOptions", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "expires_after_days", "setup_future_usage" ] }, "checkout_card_installments_options": { "description": "", "properties": { "enabled": { "description": "Indicates if installments are enabled", "type": "boolean" } }, "title": "CheckoutCardInstallmentsOptions", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "enabled" ] }, "checkout_card_payment_method_options": { "description": "", "properties": { "installments": { "$ref": "#/components/schemas/checkout_card_installments_options" }, "request_decremental_authorization": { "description": "Request ability to [capture beyond the standard authorization validity window](/payments/extended-authorization) for this CheckoutSession.", "enum": [ "if_available", "never" ], "type": "string" }, "request_extended_authorization": { "description": "Request ability to [capture beyond the standard authorization validity window](/payments/extended-authorization) for this CheckoutSession.", "enum": [ "if_available", "never" ], "type": "string" }, "request_incremental_authorization": { "description": "Request ability to [increment the authorization](/payments/incremental-authorization) for this CheckoutSession.", "enum": [ "if_available", "never" ], "type": "string" }, "request_multicapture": { "description": "Request ability to make [multiple captures](/payments/multicapture) for this CheckoutSession.", "enum": [ "if_available", "never" ], "type": "string" }, "request_overcapture": { "description": "Request ability to [overcapture](/payments/overcapture) for this CheckoutSession.", "enum": [ "if_available", "never" ], "type": "string" }, "request_three_d_secure": { "description": "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.", "enum": [ "any", "automatic", "challenge" ], "type": "string", "x-stripeBypassValidation": true }, "restrictions": { "$ref": "#/components/schemas/payment_pages_private_card_payment_method_options_resource_restrictions" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none", "off_session", "on_session" ], "type": "string" }, "statement_descriptor_suffix_kana": { "description": "Provides information about a card payment that customers see on their statements. Concatenated with the Kana prefix (shortened Kana descriptor) or Kana statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 22 characters.", "maxLength": 5000, "type": "string" }, "statement_descriptor_suffix_kanji": { "description": "Provides information about a card payment that customers see on their statements. Concatenated with the Kanji prefix (shortened Kanji descriptor) or Kanji statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 17 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 17 characters.", "maxLength": 5000, "type": "string" } }, "required": [ "request_three_d_secure" ], "title": "CheckoutCardPaymentMethodOptions", "type": "object", "x-expandableFields": [ "installments", "restrictions" ], "x-stripeMostCommon": [ "installments", "request_decremental_authorization", "request_extended_authorization", "request_incremental_authorization", "request_multicapture", "request_overcapture", "request_three_d_secure", "restrictions", "setup_future_usage", "statement_descriptor_suffix_kana", "statement_descriptor_suffix_kanji" ] }, "checkout_cashapp_payment_method_options": { "description": "", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string" } }, "title": "CheckoutCashappPaymentMethodOptions", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "setup_future_usage" ] }, "checkout_customer_balance_bank_transfer_payment_method_options": { "description": "", "properties": { "eu_bank_transfer": { "$ref": "#/components/schemas/payment_method_options_customer_balance_eu_bank_account" }, "requested_address_types": { "description": "List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.\n\nPermitted values include: `sort_code`, `zengin`, `iban`, or `spei`.", "items": { "enum": [ "aba", "iban", "sepa", "sort_code", "spei", "swift", "zengin" ], "type": "string", "x-stripeBypassValidation": true }, "type": "array" }, "type": { "description": "The bank transfer type that this PaymentIntent is allowed to use for funding Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.", "enum": [ "eu_bank_transfer", "gb_bank_transfer", "jp_bank_transfer", "mx_bank_transfer", "us_bank_transfer" ], "nullable": true, "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "CheckoutCustomerBalanceBankTransferPaymentMethodOptions", "type": "object", "x-expandableFields": [ "eu_bank_transfer" ], "x-stripeMostCommon": [ "eu_bank_transfer", "requested_address_types", "type" ] }, "checkout_customer_balance_payment_method_options": { "description": "", "properties": { "bank_transfer": { "$ref": "#/components/schemas/checkout_customer_balance_bank_transfer_payment_method_options" }, "funding_type": { "description": "The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.", "enum": [ "bank_transfer" ], "nullable": true, "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string" } }, "required": [ "funding_type" ], "title": "CheckoutCustomerBalancePaymentMethodOptions", "type": "object", "x-expandableFields": [ "bank_transfer" ], "x-stripeMostCommon": [ "bank_transfer", "funding_type", "setup_future_usage" ] }, "checkout_eps_payment_method_options": { "description": "", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string" } }, "title": "CheckoutEpsPaymentMethodOptions", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "setup_future_usage" ] }, "checkout_fpx_payment_method_options": { "description": "", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string" } }, "title": "CheckoutFpxPaymentMethodOptions", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "setup_future_usage" ] }, "checkout_giropay_payment_method_options": { "description": "", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string" } }, "title": "CheckoutGiropayPaymentMethodOptions", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "setup_future_usage" ] }, "checkout_grab_pay_payment_method_options": { "description": "", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string" } }, "title": "CheckoutGrabPayPaymentMethodOptions", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "setup_future_usage" ] }, "checkout_ideal_payment_method_options": { "description": "", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string" } }, "title": "CheckoutIdealPaymentMethodOptions", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "setup_future_usage" ] }, "checkout_kakao_pay_payment_method_options": { "description": "", "properties": { "capture_method": { "description": "Controls when the funds will be captured from the customer's account.", "enum": [ "manual" ], "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none", "off_session" ], "type": "string" } }, "title": "CheckoutKakaoPayPaymentMethodOptions", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "capture_method", "setup_future_usage" ] }, "checkout_klarna_payment_method_options": { "description": "", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none", "off_session", "on_session" ], "type": "string" } }, "title": "CheckoutKlarnaPaymentMethodOptions", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "setup_future_usage" ] }, "checkout_konbini_payment_method_options": { "description": "", "properties": { "expires_after_days": { "description": "The number of calendar days (between 1 and 60) after which Konbini payment instructions will expire. For example, if a PaymentIntent is confirmed with Konbini and `expires_after_days` set to 2 on Monday JST, the instructions will expire on Wednesday 23:59:59 JST.", "nullable": true, "type": "integer" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string" } }, "required": [ "expires_after_days" ], "title": "CheckoutKonbiniPaymentMethodOptions", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "expires_after_days", "setup_future_usage" ] }, "checkout_kr_card_payment_method_options": { "description": "", "properties": { "capture_method": { "description": "Controls when the funds will be captured from the customer's account.", "enum": [ "manual" ], "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none", "off_session" ], "type": "string" } }, "title": "CheckoutKrCardPaymentMethodOptions", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "capture_method", "setup_future_usage" ] }, "checkout_link_payment_method_options": { "description": "", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none", "off_session" ], "type": "string" } }, "title": "CheckoutLinkPaymentMethodOptions", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "setup_future_usage" ] }, "checkout_link_wallet_options": { "description": "", "properties": { "display": { "description": "Describes whether Checkout should display Link. Defaults to `auto`.", "enum": [ "auto", "never" ], "type": "string" } }, "title": "CheckoutLinkWalletOptions", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "display" ] }, "checkout_mobilepay_payment_method_options": { "description": "", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string" } }, "title": "CheckoutMobilepayPaymentMethodOptions", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "setup_future_usage" ] }, "checkout_multibanco_payment_method_options": { "description": "", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string" } }, "title": "CheckoutMultibancoPaymentMethodOptions", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "setup_future_usage" ] }, "checkout_naver_pay_payment_method_options": { "description": "", "properties": { "capture_method": { "description": "Controls when the funds will be captured from the customer's account.", "enum": [ "manual" ], "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none", "off_session" ], "type": "string" } }, "title": "CheckoutNaverPayPaymentMethodOptions", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "capture_method", "setup_future_usage" ] }, "checkout_oxxo_payment_method_options": { "description": "", "properties": { "expires_after_days": { "description": "The number of calendar days before an OXXO invoice expires. For example, if you create an OXXO invoice on Monday and you set expires_after_days to 2, the OXXO invoice will expire on Wednesday at 23:59 America/Mexico_City time.", "type": "integer" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string" } }, "required": [ "expires_after_days" ], "title": "CheckoutOxxoPaymentMethodOptions", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "expires_after_days", "setup_future_usage" ] }, "checkout_p24_payment_method_options": { "description": "", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string" } }, "title": "CheckoutP24PaymentMethodOptions", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "setup_future_usage" ] }, "checkout_payco_payment_method_options": { "description": "", "properties": { "capture_method": { "description": "Controls when the funds will be captured from the customer's account.", "enum": [ "manual" ], "type": "string" } }, "title": "CheckoutPaycoPaymentMethodOptions", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "capture_method" ] }, "checkout_payment_method_options_mandate_options_bacs_debit": { "description": "", "properties": { "reference_prefix": { "description": "Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'.", "maxLength": 5000, "type": "string" } }, "title": "checkout_payment_method_options_mandate_options_bacs_debit", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "reference_prefix" ], "x-stripeResource": { "class_name": "BacsDebitMandateOptions", "in_package": "" } }, "checkout_payment_method_options_mandate_options_sepa_debit": { "description": "", "properties": { "reference_prefix": { "description": "Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'.", "maxLength": 5000, "type": "string" } }, "title": "checkout_payment_method_options_mandate_options_sepa_debit", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "reference_prefix" ], "x-stripeResource": { "class_name": "SepaDebitMandateOptions", "in_package": "" } }, "checkout_paynow_payment_method_options": { "description": "", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string" } }, "title": "CheckoutPaynowPaymentMethodOptions", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "setup_future_usage" ] }, "checkout_paypal_payment_method_options": { "description": "", "properties": { "capture_method": { "description": "Controls when the funds will be captured from the customer's account.", "enum": [ "manual" ], "type": "string" }, "preferred_locale": { "description": "Preferred locale of the PayPal checkout page that the customer is redirected to.", "maxLength": 5000, "nullable": true, "type": "string" }, "reference": { "description": "A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID.", "maxLength": 5000, "nullable": true, "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none", "off_session" ], "type": "string" }, "subsellers": { "description": "The Stripe connected account IDs of the sellers on the platform for this transaction (optional). Only allowed when [separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers) are used.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "required": [ "preferred_locale", "reference" ], "title": "CheckoutPaypalPaymentMethodOptions", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "capture_method", "preferred_locale", "reference", "setup_future_usage", "subsellers" ] }, "checkout_payto_payment_method_options": { "description": "", "properties": { "mandate_options": { "$ref": "#/components/schemas/mandate_options_payto" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none", "off_session" ], "type": "string" } }, "title": "CheckoutPaytoPaymentMethodOptions", "type": "object", "x-expandableFields": [ "mandate_options" ], "x-stripeMostCommon": [ "mandate_options", "setup_future_usage" ] }, "checkout_pix_payment_method_options": { "description": "", "properties": { "amount_includes_iof": { "description": "Determines if the amount includes the IOF tax.", "enum": [ "always", "never" ], "type": "string" }, "expires_after_seconds": { "description": "The number of seconds after which Pix payment will expire.", "nullable": true, "type": "integer" }, "mandate_options": { "$ref": "#/components/schemas/payment_method_options_mandate_options_pix" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none", "off_session" ], "type": "string" } }, "required": [ "expires_after_seconds" ], "title": "CheckoutPixPaymentMethodOptions", "type": "object", "x-expandableFields": [ "mandate_options" ], "x-stripeMostCommon": [ "amount_includes_iof", "expires_after_seconds", "mandate_options", "setup_future_usage" ] }, "checkout_revolut_pay_payment_method_options": { "description": "", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none", "off_session" ], "type": "string" } }, "title": "CheckoutRevolutPayPaymentMethodOptions", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "setup_future_usage" ] }, "checkout_samsung_pay_payment_method_options": { "description": "", "properties": { "capture_method": { "description": "Controls when the funds will be captured from the customer's account.", "enum": [ "manual" ], "type": "string" } }, "title": "CheckoutSamsungPayPaymentMethodOptions", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "capture_method" ] }, "checkout_sepa_debit_payment_method_options": { "description": "", "properties": { "mandate_options": { "$ref": "#/components/schemas/checkout_payment_method_options_mandate_options_sepa_debit" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none", "off_session", "on_session" ], "type": "string" }, "target_date": { "description": "Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.", "maxLength": 5000, "type": "string" } }, "title": "CheckoutSepaDebitPaymentMethodOptions", "type": "object", "x-expandableFields": [ "mandate_options" ], "x-stripeMostCommon": [ "mandate_options", "setup_future_usage", "target_date" ] }, "checkout_session_payment_method_options": { "description": "", "properties": { "acss_debit": { "$ref": "#/components/schemas/checkout_acss_debit_payment_method_options" }, "affirm": { "$ref": "#/components/schemas/checkout_affirm_payment_method_options" }, "afterpay_clearpay": { "$ref": "#/components/schemas/checkout_afterpay_clearpay_payment_method_options" }, "alipay": { "$ref": "#/components/schemas/checkout_alipay_payment_method_options" }, "amazon_pay": { "$ref": "#/components/schemas/checkout_amazon_pay_payment_method_options" }, "au_becs_debit": { "$ref": "#/components/schemas/checkout_au_becs_debit_payment_method_options" }, "bacs_debit": { "$ref": "#/components/schemas/checkout_bacs_debit_payment_method_options" }, "bancontact": { "$ref": "#/components/schemas/checkout_bancontact_payment_method_options" }, "boleto": { "$ref": "#/components/schemas/checkout_boleto_payment_method_options" }, "card": { "$ref": "#/components/schemas/checkout_card_payment_method_options" }, "cashapp": { "$ref": "#/components/schemas/checkout_cashapp_payment_method_options" }, "customer_balance": { "$ref": "#/components/schemas/checkout_customer_balance_payment_method_options" }, "eps": { "$ref": "#/components/schemas/checkout_eps_payment_method_options" }, "fpx": { "$ref": "#/components/schemas/checkout_fpx_payment_method_options" }, "giropay": { "$ref": "#/components/schemas/checkout_giropay_payment_method_options" }, "grabpay": { "$ref": "#/components/schemas/checkout_grab_pay_payment_method_options" }, "ideal": { "$ref": "#/components/schemas/checkout_ideal_payment_method_options" }, "kakao_pay": { "$ref": "#/components/schemas/checkout_kakao_pay_payment_method_options" }, "klarna": { "$ref": "#/components/schemas/checkout_klarna_payment_method_options" }, "konbini": { "$ref": "#/components/schemas/checkout_konbini_payment_method_options" }, "kr_card": { "$ref": "#/components/schemas/checkout_kr_card_payment_method_options" }, "link": { "$ref": "#/components/schemas/checkout_link_payment_method_options" }, "mobilepay": { "$ref": "#/components/schemas/checkout_mobilepay_payment_method_options" }, "multibanco": { "$ref": "#/components/schemas/checkout_multibanco_payment_method_options" }, "naver_pay": { "$ref": "#/components/schemas/checkout_naver_pay_payment_method_options" }, "oxxo": { "$ref": "#/components/schemas/checkout_oxxo_payment_method_options" }, "p24": { "$ref": "#/components/schemas/checkout_p24_payment_method_options" }, "payco": { "$ref": "#/components/schemas/checkout_payco_payment_method_options" }, "paynow": { "$ref": "#/components/schemas/checkout_paynow_payment_method_options" }, "paypal": { "$ref": "#/components/schemas/checkout_paypal_payment_method_options" }, "payto": { "$ref": "#/components/schemas/checkout_payto_payment_method_options" }, "pix": { "$ref": "#/components/schemas/checkout_pix_payment_method_options" }, "revolut_pay": { "$ref": "#/components/schemas/checkout_revolut_pay_payment_method_options" }, "samsung_pay": { "$ref": "#/components/schemas/checkout_samsung_pay_payment_method_options" }, "sepa_debit": { "$ref": "#/components/schemas/checkout_sepa_debit_payment_method_options" }, "sofort": { "$ref": "#/components/schemas/checkout_sofort_payment_method_options" }, "swish": { "$ref": "#/components/schemas/checkout_swish_payment_method_options" }, "us_bank_account": { "$ref": "#/components/schemas/checkout_us_bank_account_payment_method_options" } }, "title": "CheckoutSessionPaymentMethodOptions", "type": "object", "x-expandableFields": [ "acss_debit", "affirm", "afterpay_clearpay", "alipay", "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", "boleto", "card", "cashapp", "customer_balance", "eps", "fpx", "giropay", "grabpay", "ideal", "kakao_pay", "klarna", "konbini", "kr_card", "link", "mobilepay", "multibanco", "naver_pay", "oxxo", "p24", "payco", "paynow", "paypal", "payto", "pix", "revolut_pay", "samsung_pay", "sepa_debit", "sofort", "swish", "us_bank_account" ], "x-stripeMostCommon": [ "acss_debit", "affirm", "afterpay_clearpay", "alipay", "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", "boleto", "card", "cashapp", "customer_balance", "eps", "fpx", "giropay", "grabpay", "ideal", "kakao_pay", "klarna", "konbini", "kr_card", "link", "mobilepay", "multibanco", "naver_pay", "oxxo", "p24", "payco", "paynow", "paypal", "payto", "pix", "revolut_pay", "samsung_pay", "sepa_debit", "sofort", "swish", "us_bank_account" ] }, "checkout_session_wallet_options": { "description": "", "properties": { "link": { "$ref": "#/components/schemas/checkout_link_wallet_options" } }, "title": "CheckoutSessionWalletOptions", "type": "object", "x-expandableFields": [ "link" ], "x-stripeMostCommon": [ "link" ] }, "checkout_sofort_payment_method_options": { "description": "", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string" } }, "title": "CheckoutSofortPaymentMethodOptions", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "setup_future_usage" ] }, "checkout_swish_payment_method_options": { "description": "", "properties": { "reference": { "description": "The order reference that will be displayed to customers in the Swish application. Defaults to the `id` of the Payment Intent.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "reference" ], "title": "CheckoutSwishPaymentMethodOptions", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "reference" ] }, "checkout_us_bank_account_payment_method_options": { "description": "", "properties": { "financial_connections": { "$ref": "#/components/schemas/linked_account_options_common" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none", "off_session", "on_session" ], "type": "string" }, "target_date": { "description": "Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.", "maxLength": 5000, "type": "string" }, "verification_method": { "description": "Bank account verification method.", "enum": [ "automatic", "instant" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "CheckoutUsBankAccountPaymentMethodOptions", "type": "object", "x-expandableFields": [ "financial_connections" ], "x-stripeMostCommon": [ "financial_connections", "setup_future_usage", "target_date", "verification_method" ] }, "climate.order": { "description": "Orders represent your intent to purchase a particular Climate product. When you create an order, the\npayment is deducted from your merchant balance.", "properties": { "amount_fees": { "description": "Total amount of [Frontier](https://frontierclimate.com/)'s service fees in the currency's smallest unit.", "type": "integer" }, "amount_subtotal": { "description": "Total amount of the carbon removal in the currency's smallest unit.", "type": "integer" }, "amount_total": { "description": "Total amount of the order including fees in the currency's smallest unit.", "type": "integer" }, "beneficiary": { "$ref": "#/components/schemas/climate_removals_beneficiary" }, "canceled_at": { "description": "Time at which the order was canceled. Measured in seconds since the Unix epoch.", "format": "unix-time", "nullable": true, "type": "integer" }, "cancellation_reason": { "description": "Reason for the cancellation of this order.", "enum": [ "expired", "product_unavailable", "requested" ], "nullable": true, "type": "string", "x-stripeBypassValidation": true }, "certificate": { "description": "For delivered orders, a URL to a delivery certificate for the order.", "maxLength": 5000, "nullable": true, "type": "string" }, "confirmed_at": { "description": "Time at which the order was confirmed. Measured in seconds since the Unix epoch.", "format": "unix-time", "nullable": true, "type": "integer" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase, representing the currency for this order.", "maxLength": 5000, "type": "string" }, "delayed_at": { "description": "Time at which the order's expected_delivery_year was delayed. Measured in seconds since the Unix epoch.", "format": "unix-time", "nullable": true, "type": "integer" }, "delivered_at": { "description": "Time at which the order was delivered. Measured in seconds since the Unix epoch.", "format": "unix-time", "nullable": true, "type": "integer" }, "delivery_details": { "description": "Details about the delivery of carbon removal for this order.", "items": { "$ref": "#/components/schemas/climate_removals_order_deliveries" }, "type": "array" }, "expected_delivery_year": { "description": "The year this order is expected to be delivered.", "type": "integer" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "type": "object" }, "metric_tons": { "description": "Quantity of carbon removal that is included in this order.", "format": "decimal", "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "climate.order" ], "type": "string" }, "product": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/climate.product" } ], "description": "Unique ID for the Climate `Product` this order is purchasing.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/climate.product" } ] } }, "product_substituted_at": { "description": "Time at which the order's product was substituted for a different product. Measured in seconds since the Unix epoch.", "format": "unix-time", "nullable": true, "type": "integer" }, "status": { "description": "The current status of this order.", "enum": [ "awaiting_funds", "canceled", "confirmed", "delivered", "open" ], "type": "string" } }, "required": [ "amount_fees", "amount_subtotal", "amount_total", "canceled_at", "cancellation_reason", "certificate", "confirmed_at", "created", "currency", "delayed_at", "delivered_at", "delivery_details", "expected_delivery_year", "id", "livemode", "metadata", "metric_tons", "object", "product", "product_substituted_at", "status" ], "title": "ClimateRemovalsOrders", "type": "object", "x-expandableFields": [ "beneficiary", "delivery_details", "product" ], "x-resourceId": "climate.order", "x-stripeMostCommon": [ "amount_fees", "amount_subtotal", "amount_total", "beneficiary", "canceled_at", "cancellation_reason", "certificate", "confirmed_at", "created", "currency", "delayed_at", "delivered_at", "delivery_details", "expected_delivery_year", "id", "livemode", "metadata", "metric_tons", "object", "product", "product_substituted_at", "status" ], "x-stripeOperations": [ { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/climate/orders" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/climate/orders/{order}" }, { "method_name": "create", "method_on": "service", "method_type": "create", "operation": "post", "path": "/v1/climate/orders" }, { "method_name": "update", "method_on": "service", "method_type": "update", "operation": "post", "path": "/v1/climate/orders/{order}" }, { "method_name": "cancel", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/climate/orders/{order}/cancel" } ], "x-stripeResource": { "class_name": "Order", "has_collection_class": true, "in_package": "Climate" } }, "climate.order.canceled": { "description": "Occurs when a Climate order is canceled.", "properties": { "object": { "$ref": "#/components/schemas/climate.order" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "climate.order.canceled" } }, "climate.order.created": { "description": "Occurs when a Climate order is created.", "properties": { "object": { "$ref": "#/components/schemas/climate.order" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "climate.order.created" } }, "climate.order.delayed": { "description": "Occurs when a Climate order is delayed.", "properties": { "object": { "$ref": "#/components/schemas/climate.order" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "climate.order.delayed" } }, "climate.order.delivered": { "description": "Occurs when a Climate order is delivered.", "properties": { "object": { "$ref": "#/components/schemas/climate.order" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "climate.order.delivered" } }, "climate.order.product_substituted": { "description": "Occurs when a Climate order's product is substituted for another.", "properties": { "object": { "$ref": "#/components/schemas/climate.order" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "climate.order.product_substituted" } }, "climate.product": { "description": "A Climate product represents a type of carbon removal unit available for reservation.\nYou can retrieve it to see the current price and availability.", "properties": { "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "current_prices_per_metric_ton": { "additionalProperties": { "$ref": "#/components/schemas/climate_removals_products_price" }, "description": "Current prices for a metric ton of carbon removal in a currency's smallest unit.", "type": "object" }, "delivery_year": { "description": "The year in which the carbon removal is expected to be delivered.", "nullable": true, "type": "integer" }, "id": { "description": "Unique identifier for the object. For convenience, Climate product IDs are human-readable strings\nthat start with `climsku_`. See [carbon removal inventory](https://stripe.com/docs/climate/orders/carbon-removal-inventory)\nfor a list of available carbon removal products.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "metric_tons_available": { "description": "The quantity of metric tons available for reservation.", "format": "decimal", "type": "string" }, "name": { "description": "The Climate product's name.", "maxLength": 5000, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "climate.product" ], "type": "string" }, "suppliers": { "description": "The carbon removal suppliers that fulfill orders for this Climate product.", "items": { "$ref": "#/components/schemas/climate.supplier" }, "type": "array" } }, "required": [ "created", "current_prices_per_metric_ton", "delivery_year", "id", "livemode", "metric_tons_available", "name", "object", "suppliers" ], "title": "ClimateRemovalsProducts", "type": "object", "x-expandableFields": [ "current_prices_per_metric_ton", "suppliers" ], "x-resourceId": "climate.product", "x-stripeMostCommon": [ "created", "current_prices_per_metric_ton", "delivery_year", "id", "livemode", "metric_tons_available", "name", "object", "suppliers" ], "x-stripeOperations": [ { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/climate/products" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/climate/products/{product}" } ], "x-stripeResource": { "class_name": "Product", "has_collection_class": true, "in_package": "Climate" } }, "climate.product.created": { "description": "Occurs when a Climate product is created.", "properties": { "object": { "$ref": "#/components/schemas/climate.product" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "climate.product.created" } }, "climate.product.pricing_updated": { "description": "Occurs when a Climate product is updated.", "properties": { "object": { "$ref": "#/components/schemas/climate.product" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "climate.product.pricing_updated" } }, "climate.supplier": { "description": "A supplier of carbon removal.", "properties": { "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "info_url": { "description": "Link to a webpage to learn more about the supplier.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "locations": { "description": "The locations in which this supplier operates.", "items": { "$ref": "#/components/schemas/climate_removals_location" }, "type": "array" }, "name": { "description": "Name of this carbon removal supplier.", "maxLength": 5000, "type": "string" }, "object": { "description": "String representing the object’s type. Objects of the same type share the same value.", "enum": [ "climate.supplier" ], "type": "string" }, "removal_pathway": { "description": "The scientific pathway used for carbon removal.", "enum": [ "biomass_carbon_removal_and_storage", "direct_air_capture", "enhanced_weathering" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "id", "info_url", "livemode", "locations", "name", "object", "removal_pathway" ], "title": "ClimateRemovalsSuppliers", "type": "object", "x-expandableFields": [ "locations" ], "x-resourceId": "climate.supplier", "x-stripeMostCommon": [ "id", "info_url", "livemode", "locations", "name", "object", "removal_pathway" ], "x-stripeOperations": [ { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/climate/suppliers" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/climate/suppliers/{supplier}" } ], "x-stripeResource": { "class_name": "Supplier", "has_collection_class": true, "in_package": "Climate" } }, "climate_removals_beneficiary": { "description": "", "properties": { "public_name": { "description": "Publicly displayable name for the end beneficiary of carbon removal.", "maxLength": 5000, "type": "string" } }, "required": [ "public_name" ], "title": "ClimateRemovalsBeneficiary", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "public_name" ] }, "climate_removals_location": { "description": "", "properties": { "city": { "description": "The city where the supplier is located.", "maxLength": 5000, "nullable": true, "type": "string" }, "country": { "description": "Two-letter ISO code representing the country where the supplier is located.", "maxLength": 5000, "type": "string" }, "latitude": { "description": "The geographic latitude where the supplier is located.", "nullable": true, "type": "number" }, "longitude": { "description": "The geographic longitude where the supplier is located.", "nullable": true, "type": "number" }, "region": { "description": "The state/county/province/region where the supplier is located.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "city", "country", "latitude", "longitude", "region" ], "title": "ClimateRemovalsLocation", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "city", "country", "latitude", "longitude", "region" ] }, "climate_removals_order_deliveries": { "description": "The delivery of a specified quantity of carbon for an order.", "properties": { "delivered_at": { "description": "Time at which the delivery occurred. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "location": { "anyOf": [ { "$ref": "#/components/schemas/climate_removals_location" } ], "description": "Specific location of this delivery.", "nullable": true }, "metric_tons": { "description": "Quantity of carbon removal supplied by this delivery.", "maxLength": 5000, "type": "string" }, "registry_url": { "description": "Once retired, a URL to the registry entry for the tons from this delivery.", "maxLength": 5000, "nullable": true, "type": "string" }, "supplier": { "$ref": "#/components/schemas/climate.supplier" } }, "required": [ "delivered_at", "location", "metric_tons", "registry_url", "supplier" ], "title": "ClimateRemovalsOrderDeliveries", "type": "object", "x-expandableFields": [ "location", "supplier" ], "x-stripeMostCommon": [ "delivered_at", "location", "metric_tons", "registry_url", "supplier" ] }, "climate_removals_products_price": { "description": "", "properties": { "amount_fees": { "description": "Fees for one metric ton of carbon removal in the currency's smallest unit.", "type": "integer" }, "amount_subtotal": { "description": "Subtotal for one metric ton of carbon removal (excluding fees) in the currency's smallest unit.", "type": "integer" }, "amount_total": { "description": "Total for one metric ton of carbon removal (including fees) in the currency's smallest unit.", "type": "integer" } }, "required": [ "amount_fees", "amount_subtotal", "amount_total" ], "title": "ClimateRemovalsProductsPrice", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "amount_fees", "amount_subtotal", "amount_total" ] }, "confirmation_token": { "description": "ConfirmationTokens help transport client side data collected by Stripe JS over\nto your server for confirming a PaymentIntent or SetupIntent. If the confirmation\nis successful, values present on the ConfirmationToken are written onto the Intent.\n\nTo learn more about how to use ConfirmationToken, visit the related guides:\n- [Finalize payments on the server](https://stripe.com/docs/payments/finalize-payments-on-the-server)\n- [Build two-step confirmation](https://stripe.com/docs/payments/build-a-two-step-confirmation).", "properties": { "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "expires_at": { "description": "Time at which this ConfirmationToken expires and can no longer be used to confirm a PaymentIntent or SetupIntent.", "format": "unix-time", "nullable": true, "type": "integer" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "mandate_data": { "anyOf": [ { "$ref": "#/components/schemas/confirmation_tokens_resource_mandate_data" } ], "description": "Data used for generating a Mandate.", "nullable": true }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "confirmation_token" ], "type": "string" }, "payment_intent": { "description": "ID of the PaymentIntent that this ConfirmationToken was used to confirm, or null if this ConfirmationToken has not yet been used.", "maxLength": 5000, "nullable": true, "type": "string" }, "payment_method_options": { "anyOf": [ { "$ref": "#/components/schemas/confirmation_tokens_resource_payment_method_options" } ], "description": "Payment-method-specific configuration for this ConfirmationToken.", "nullable": true }, "payment_method_preview": { "anyOf": [ { "$ref": "#/components/schemas/confirmation_tokens_resource_payment_method_preview" } ], "description": "Payment details collected by the Payment Element, used to create a PaymentMethod when a PaymentIntent or SetupIntent is confirmed with this ConfirmationToken.", "nullable": true }, "return_url": { "description": "Return URL used to confirm the Intent.", "maxLength": 5000, "nullable": true, "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this ConfirmationToken's payment method.\n\nThe presence of this property will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete.", "enum": [ "off_session", "on_session" ], "nullable": true, "type": "string" }, "setup_intent": { "description": "ID of the SetupIntent that this ConfirmationToken was used to confirm, or null if this ConfirmationToken has not yet been used.", "maxLength": 5000, "nullable": true, "type": "string" }, "shipping": { "anyOf": [ { "$ref": "#/components/schemas/confirmation_tokens_resource_shipping" } ], "description": "Shipping information collected on this ConfirmationToken.", "nullable": true }, "use_stripe_sdk": { "description": "Indicates whether the Stripe SDK is used to handle confirmation flow. Defaults to `true` on ConfirmationToken.", "type": "boolean" } }, "required": [ "created", "expires_at", "id", "livemode", "object", "payment_intent", "payment_method_options", "payment_method_preview", "return_url", "setup_future_usage", "setup_intent", "shipping", "use_stripe_sdk" ], "title": "ConfirmationTokensResourceConfirmationToken", "type": "object", "x-expandableFields": [ "mandate_data", "payment_method_options", "payment_method_preview", "shipping" ], "x-resourceId": "confirmation_token", "x-stripeMostCommon": [ "created", "expires_at", "id", "livemode", "mandate_data", "object", "payment_intent", "payment_method_options", "payment_method_preview", "return_url", "setup_future_usage", "setup_intent", "shipping", "use_stripe_sdk" ], "x-stripeOperations": [ { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/confirmation_tokens/{confirmation_token}" }, { "method_name": "create", "method_on": "service", "method_type": "create", "operation": "post", "path": "/v1/test_helpers/confirmation_tokens" } ], "x-stripeResource": { "class_name": "ConfirmationToken", "in_package": "" } }, "confirmation_tokens_resource_mandate_data": { "description": "Data used for generating a Mandate.", "properties": { "customer_acceptance": { "$ref": "#/components/schemas/confirmation_tokens_resource_mandate_data_resource_customer_acceptance" } }, "required": [ "customer_acceptance" ], "title": "ConfirmationTokensResourceMandateData", "type": "object", "x-expandableFields": [ "customer_acceptance" ], "x-stripeMostCommon": [ "customer_acceptance" ] }, "confirmation_tokens_resource_mandate_data_resource_customer_acceptance": { "description": "This hash contains details about the customer acceptance of the Mandate.", "properties": { "online": { "anyOf": [ { "$ref": "#/components/schemas/confirmation_tokens_resource_mandate_data_resource_customer_acceptance_resource_online" } ], "description": "If this is a Mandate accepted online, this hash contains details about the online acceptance.", "nullable": true }, "type": { "description": "The type of customer acceptance information included with the Mandate.", "maxLength": 5000, "type": "string" } }, "required": [ "online", "type" ], "title": "ConfirmationTokensResourceMandateDataResourceCustomerAcceptance", "type": "object", "x-expandableFields": [ "online" ], "x-stripeMostCommon": [ "online", "type" ] }, "confirmation_tokens_resource_mandate_data_resource_customer_acceptance_resource_online": { "description": "This hash contains details about the online acceptance.", "properties": { "ip_address": { "description": "The IP address from which the Mandate was accepted by the customer.", "maxLength": 5000, "nullable": true, "type": "string" }, "user_agent": { "description": "The user agent of the browser from which the Mandate was accepted by the customer.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "ip_address", "user_agent" ], "title": "ConfirmationTokensResourceMandateDataResourceCustomerAcceptanceResourceOnline", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "ip_address", "user_agent" ] }, "confirmation_tokens_resource_payment_method_options": { "description": "Payment-method-specific configuration", "properties": { "card": { "anyOf": [ { "$ref": "#/components/schemas/confirmation_tokens_resource_payment_method_options_resource_card" } ], "description": "This hash contains the card payment method options.", "nullable": true } }, "required": [ "card" ], "title": "ConfirmationTokensResourcePaymentMethodOptions", "type": "object", "x-expandableFields": [ "card" ], "x-stripeMostCommon": [ "card" ] }, "confirmation_tokens_resource_payment_method_options_resource_card": { "description": "This hash contains the card payment method options.", "properties": { "cvc_token": { "description": "The `cvc_update` Token collected from the Payment Element.", "maxLength": 5000, "nullable": true, "type": "string" }, "installments": { "$ref": "#/components/schemas/confirmation_tokens_resource_payment_method_options_resource_card_resource_installment" } }, "required": [ "cvc_token" ], "title": "ConfirmationTokensResourcePaymentMethodOptionsResourceCard", "type": "object", "x-expandableFields": [ "installments" ], "x-stripeMostCommon": [ "cvc_token", "installments" ] }, "confirmation_tokens_resource_payment_method_options_resource_card_resource_installment": { "description": "Installment configuration for payments.", "properties": { "plan": { "$ref": "#/components/schemas/payment_method_details_card_installments_plan" } }, "title": "ConfirmationTokensResourcePaymentMethodOptionsResourceCardResourceInstallment", "type": "object", "x-expandableFields": [ "plan" ], "x-stripeMostCommon": [ "plan" ] }, "confirmation_tokens_resource_payment_method_preview": { "description": "Details of the PaymentMethod collected by Payment Element", "properties": { "acss_debit": { "$ref": "#/components/schemas/payment_method_acss_debit" }, "affirm": { "$ref": "#/components/schemas/payment_method_affirm" }, "afterpay_clearpay": { "$ref": "#/components/schemas/payment_method_afterpay_clearpay" }, "alipay": { "$ref": "#/components/schemas/payment_flows_private_payment_methods_alipay" }, "allow_redisplay": { "description": "This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to “unspecified”.", "enum": [ "always", "limited", "unspecified" ], "type": "string" }, "alma": { "$ref": "#/components/schemas/payment_method_alma" }, "amazon_pay": { "$ref": "#/components/schemas/payment_method_amazon_pay" }, "au_becs_debit": { "$ref": "#/components/schemas/payment_method_au_becs_debit" }, "bacs_debit": { "$ref": "#/components/schemas/payment_method_bacs_debit" }, "bancontact": { "$ref": "#/components/schemas/payment_method_bancontact" }, "billie": { "$ref": "#/components/schemas/payment_method_billie" }, "billing_details": { "$ref": "#/components/schemas/billing_details" }, "blik": { "$ref": "#/components/schemas/payment_method_blik" }, "boleto": { "$ref": "#/components/schemas/payment_method_boleto" }, "card": { "$ref": "#/components/schemas/payment_method_card" }, "card_present": { "$ref": "#/components/schemas/payment_method_card_present" }, "cashapp": { "$ref": "#/components/schemas/payment_method_cashapp" }, "crypto": { "$ref": "#/components/schemas/payment_method_crypto" }, "customer": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/customer" } ], "description": "The ID of the Customer to which this PaymentMethod is saved. This will not be set when the PaymentMethod has not been saved to a Customer.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/customer" } ] } }, "customer_account": { "maxLength": 5000, "nullable": true, "type": "string" }, "customer_balance": { "$ref": "#/components/schemas/payment_method_customer_balance" }, "eps": { "$ref": "#/components/schemas/payment_method_eps" }, "fpx": { "$ref": "#/components/schemas/payment_method_fpx" }, "giropay": { "$ref": "#/components/schemas/payment_method_giropay" }, "gopay": { "$ref": "#/components/schemas/payment_method_gopay" }, "grabpay": { "$ref": "#/components/schemas/payment_method_grabpay" }, "id_bank_transfer": { "$ref": "#/components/schemas/payment_method_id_bank_transfer" }, "ideal": { "$ref": "#/components/schemas/payment_method_ideal" }, "interac_present": { "$ref": "#/components/schemas/payment_method_interac_present" }, "kakao_pay": { "$ref": "#/components/schemas/payment_method_kakao_pay" }, "klarna": { "$ref": "#/components/schemas/payment_method_klarna" }, "konbini": { "$ref": "#/components/schemas/payment_method_konbini" }, "kr_card": { "$ref": "#/components/schemas/payment_method_kr_card" }, "link": { "$ref": "#/components/schemas/payment_method_link" }, "mb_way": { "$ref": "#/components/schemas/payment_method_mb_way" }, "mobilepay": { "$ref": "#/components/schemas/payment_method_mobilepay" }, "multibanco": { "$ref": "#/components/schemas/payment_method_multibanco" }, "naver_pay": { "$ref": "#/components/schemas/payment_method_naver_pay" }, "nz_bank_account": { "$ref": "#/components/schemas/payment_method_nz_bank_account" }, "oxxo": { "$ref": "#/components/schemas/payment_method_oxxo" }, "p24": { "$ref": "#/components/schemas/payment_method_p24" }, "pay_by_bank": { "$ref": "#/components/schemas/payment_method_pay_by_bank" }, "payco": { "$ref": "#/components/schemas/payment_method_payco" }, "paynow": { "$ref": "#/components/schemas/payment_method_paynow" }, "paypal": { "$ref": "#/components/schemas/payment_method_paypal" }, "paypay": { "$ref": "#/components/schemas/payment_method_paypay" }, "payto": { "$ref": "#/components/schemas/payment_method_payto" }, "pix": { "$ref": "#/components/schemas/payment_method_pix" }, "promptpay": { "$ref": "#/components/schemas/payment_method_promptpay" }, "qris": { "$ref": "#/components/schemas/payment_method_qris" }, "rechnung": { "$ref": "#/components/schemas/payment_method_rechnung" }, "revolut_pay": { "$ref": "#/components/schemas/payment_method_revolut_pay" }, "samsung_pay": { "$ref": "#/components/schemas/payment_method_samsung_pay" }, "satispay": { "$ref": "#/components/schemas/payment_method_satispay" }, "sepa_debit": { "$ref": "#/components/schemas/payment_method_sepa_debit" }, "shopeepay": { "$ref": "#/components/schemas/payment_method_shopeepay" }, "sofort": { "$ref": "#/components/schemas/payment_method_sofort" }, "stripe_balance": { "$ref": "#/components/schemas/payment_method_stripe_balance" }, "swish": { "$ref": "#/components/schemas/payment_method_swish" }, "twint": { "$ref": "#/components/schemas/payment_method_twint" }, "type": { "description": "The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.", "enum": [ "acss_debit", "affirm", "afterpay_clearpay", "alipay", "alma", "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", "billie", "blik", "boleto", "card", "card_present", "cashapp", "crypto", "customer_balance", "eps", "fpx", "giropay", "gopay", "grabpay", "id_bank_transfer", "ideal", "interac_present", "kakao_pay", "klarna", "konbini", "kr_card", "link", "mb_way", "mobilepay", "multibanco", "naver_pay", "nz_bank_account", "oxxo", "p24", "pay_by_bank", "payco", "paynow", "paypal", "paypay", "payto", "pix", "promptpay", "qris", "rechnung", "revolut_pay", "samsung_pay", "satispay", "sepa_debit", "shopeepay", "sofort", "stripe_balance", "swish", "twint", "us_bank_account", "wechat_pay", "zip" ], "type": "string", "x-stripeBypassValidation": true }, "us_bank_account": { "$ref": "#/components/schemas/payment_method_us_bank_account" }, "wechat_pay": { "$ref": "#/components/schemas/payment_method_wechat_pay" }, "zip": { "$ref": "#/components/schemas/payment_method_zip" } }, "required": [ "billing_details", "customer", "type" ], "title": "ConfirmationTokensResourcePaymentMethodPreview", "type": "object", "x-expandableFields": [ "acss_debit", "affirm", "afterpay_clearpay", "alipay", "alma", "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", "billie", "billing_details", "blik", "boleto", "card", "card_present", "cashapp", "crypto", "customer", "customer_balance", "eps", "fpx", "giropay", "gopay", "grabpay", "id_bank_transfer", "ideal", "interac_present", "kakao_pay", "klarna", "konbini", "kr_card", "link", "mb_way", "mobilepay", "multibanco", "naver_pay", "nz_bank_account", "oxxo", "p24", "pay_by_bank", "payco", "paynow", "paypal", "paypay", "payto", "pix", "promptpay", "qris", "rechnung", "revolut_pay", "samsung_pay", "satispay", "sepa_debit", "shopeepay", "sofort", "stripe_balance", "swish", "twint", "us_bank_account", "wechat_pay", "zip" ], "x-stripeMostCommon": [ "billing_details", "customer", "type" ] }, "confirmation_tokens_resource_shipping": { "description": "", "properties": { "address": { "$ref": "#/components/schemas/address" }, "name": { "description": "Recipient name.", "maxLength": 5000, "type": "string" }, "phone": { "description": "Recipient phone (including extension).", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "address", "name", "phone" ], "title": "ConfirmationTokensResourceShipping", "type": "object", "x-expandableFields": [ "address" ], "x-stripeMostCommon": [ "address", "name", "phone" ] }, "connect_account_reference": { "description": "", "properties": { "account": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/account" } ], "description": "The connected account being referenced when `type` is `account`.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/account" } ] } }, "type": { "description": "Type of the account referenced.", "enum": [ "account", "self" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "ConnectAccountReference", "type": "object", "x-expandableFields": [ "account" ], "x-stripeMostCommon": [ "account", "type" ] }, "connect_collection_transfer": { "description": "", "properties": { "amount": { "description": "Amount transferred, in cents (or local equivalent).", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "destination": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/account" } ], "description": "ID of the account that funds are being collected for.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/account" } ] } }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "connect_collection_transfer" ], "type": "string" } }, "required": [ "amount", "currency", "destination", "id", "livemode", "object" ], "title": "ConnectCollectionTransfer", "type": "object", "x-expandableFields": [ "destination" ], "x-stripeMostCommon": [ "amount", "currency", "destination", "id", "livemode", "object" ], "x-stripeResource": { "class_name": "ConnectCollectionTransfer", "in_package": "", "polymorphic_groups": [ "balance_transaction_source" ] } }, "connect_embedded_account_config_claim": { "description": "", "properties": { "enabled": { "description": "Whether the embedded component is enabled.", "type": "boolean" }, "features": { "$ref": "#/components/schemas/connect_embedded_account_features_claim" } }, "required": [ "enabled", "features" ], "title": "ConnectEmbeddedAccountConfigClaim", "type": "object", "x-expandableFields": [ "features" ], "x-stripeMostCommon": [ "enabled", "features" ], "x-stripeResource": { "class_name": "AccountConfig", "in_package": "" } }, "connect_embedded_account_features_claim": { "description": "", "properties": { "disable_stripe_user_authentication": { "description": "Whether Stripe user authentication is disabled. This value can only be `true` for accounts where `controller.requirement_collection` is `application` for the account. The default value is the opposite of the `external_account_collection` value. For example, if you don't set `external_account_collection`, it defaults to `true` and `disable_stripe_user_authentication` defaults to `false`.", "type": "boolean" }, "external_account_collection": { "description": "Whether external account collection is enabled. This feature can only be `false` for accounts where you’re responsible for collecting updated information when requirements are due or change, like Custom accounts. The default value for this feature is `true`.", "type": "boolean" } }, "required": [ "disable_stripe_user_authentication", "external_account_collection" ], "title": "ConnectEmbeddedAccountFeaturesClaim", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "disable_stripe_user_authentication", "external_account_collection" ], "x-stripeResource": { "class_name": "AccountFeatures", "in_package": "" } }, "connect_embedded_account_session_create_components": { "description": "", "properties": { "account_management": { "$ref": "#/components/schemas/connect_embedded_account_config_claim" }, "account_onboarding": { "$ref": "#/components/schemas/connect_embedded_account_config_claim" }, "balance_report": { "$ref": "#/components/schemas/connect_embedded_base_config_claim" }, "balances": { "$ref": "#/components/schemas/connect_embedded_payouts_config" }, "capital_financing": { "anyOf": [ { "$ref": "#/components/schemas/connect_embedded_base_config" } ], "nullable": true }, "capital_financing_application": { "anyOf": [ { "$ref": "#/components/schemas/connect_embedded_base_config" } ], "nullable": true }, "capital_financing_promotion": { "anyOf": [ { "$ref": "#/components/schemas/connect_embedded_base_config" } ], "nullable": true }, "disputes_list": { "$ref": "#/components/schemas/connect_embedded_disputes_list_config" }, "documents": { "$ref": "#/components/schemas/connect_embedded_base_config_claim" }, "financial_account": { "$ref": "#/components/schemas/connect_embedded_financial_account_config_claim" }, "financial_account_transactions": { "$ref": "#/components/schemas/connect_embedded_financial_account_transactions_config_claim" }, "instant_payouts_promotion": { "$ref": "#/components/schemas/connect_embedded_instant_payouts_promotion_config" }, "issuing_card": { "$ref": "#/components/schemas/connect_embedded_issuing_card_config_claim" }, "issuing_cards_list": { "$ref": "#/components/schemas/connect_embedded_issuing_cards_list_config_claim" }, "notification_banner": { "$ref": "#/components/schemas/connect_embedded_account_config_claim" }, "payment_details": { "$ref": "#/components/schemas/connect_embedded_payments_config_claim" }, "payment_disputes": { "$ref": "#/components/schemas/connect_embedded_payment_disputes_config" }, "payments": { "$ref": "#/components/schemas/connect_embedded_payments_config_claim" }, "payout_details": { "$ref": "#/components/schemas/connect_embedded_base_config_claim" }, "payout_reconciliation_report": { "$ref": "#/components/schemas/connect_embedded_base_config_claim" }, "payouts": { "$ref": "#/components/schemas/connect_embedded_payouts_config" }, "payouts_list": { "$ref": "#/components/schemas/connect_embedded_base_config_claim" }, "tax_registrations": { "$ref": "#/components/schemas/connect_embedded_base_config_claim" }, "tax_settings": { "$ref": "#/components/schemas/connect_embedded_base_config_claim" } }, "required": [ "account_management", "account_onboarding", "balance_report", "balances", "disputes_list", "documents", "financial_account", "financial_account_transactions", "instant_payouts_promotion", "issuing_card", "issuing_cards_list", "notification_banner", "payment_details", "payment_disputes", "payments", "payout_details", "payout_reconciliation_report", "payouts", "payouts_list", "tax_registrations", "tax_settings" ], "title": "ConnectEmbeddedAccountSessionCreateComponents", "type": "object", "x-expandableFields": [ "account_management", "account_onboarding", "balance_report", "balances", "capital_financing", "capital_financing_application", "capital_financing_promotion", "disputes_list", "documents", "financial_account", "financial_account_transactions", "instant_payouts_promotion", "issuing_card", "issuing_cards_list", "notification_banner", "payment_details", "payment_disputes", "payments", "payout_details", "payout_reconciliation_report", "payouts", "payouts_list", "tax_registrations", "tax_settings" ], "x-stripeMostCommon": [ "account_management", "account_onboarding", "balance_report", "balances", "capital_financing", "capital_financing_application", "capital_financing_promotion", "disputes_list", "documents", "financial_account", "financial_account_transactions", "instant_payouts_promotion", "issuing_card", "issuing_cards_list", "notification_banner", "payment_details", "payment_disputes", "payments", "payout_details", "payout_reconciliation_report", "payouts", "payouts_list", "tax_registrations", "tax_settings" ], "x-stripeResource": { "class_name": "Components", "in_package": "" } }, "connect_embedded_base_config": { "description": "", "properties": { "enabled": { "description": "Whether the embedded component is enabled.", "type": "boolean" }, "features": { "$ref": "#/components/schemas/connect_embedded_base_features" } }, "required": [ "enabled", "features" ], "title": "ConnectEmbeddedBaseConfig", "type": "object", "x-expandableFields": [ "features" ], "x-stripeMostCommon": [ "enabled", "features" ], "x-stripeResource": { "class_name": "BaseConfig", "in_package": "" } }, "connect_embedded_base_config_claim": { "description": "", "properties": { "enabled": { "description": "Whether the embedded component is enabled.", "type": "boolean" }, "features": { "$ref": "#/components/schemas/connect_embedded_base_features" } }, "required": [ "enabled", "features" ], "title": "ConnectEmbeddedBaseConfigClaim", "type": "object", "x-expandableFields": [ "features" ], "x-stripeMostCommon": [ "enabled", "features" ], "x-stripeResource": { "class_name": "BaseConfig", "in_package": "" } }, "connect_embedded_base_features": { "description": "", "properties": {}, "title": "ConnectEmbeddedBaseFeatures", "type": "object", "x-expandableFields": [], "x-stripeResource": { "class_name": "BaseFeatures", "in_package": "" } }, "connect_embedded_disputes_list_config": { "description": "", "properties": { "enabled": { "description": "Whether the embedded component is enabled.", "type": "boolean" }, "features": { "$ref": "#/components/schemas/connect_embedded_disputes_list_features" } }, "required": [ "enabled", "features" ], "title": "ConnectEmbeddedDisputesListConfig", "type": "object", "x-expandableFields": [ "features" ], "x-stripeMostCommon": [ "enabled", "features" ], "x-stripeResource": { "class_name": "DisputesListConfig", "in_package": "" } }, "connect_embedded_disputes_list_features": { "description": "", "properties": { "capture_payments": { "description": "Whether to allow capturing and cancelling payment intents. This is `true` by default.", "type": "boolean" }, "destination_on_behalf_of_charge_management": { "description": "Whether connected accounts can manage destination charges that are created on behalf of them. This is `false` by default.", "type": "boolean" }, "dispute_management": { "description": "Whether responding to disputes is enabled, including submitting evidence and accepting disputes. This is `true` by default.", "type": "boolean" }, "refund_management": { "description": "Whether sending refunds is enabled. This is `true` by default.", "type": "boolean" } }, "required": [ "capture_payments", "destination_on_behalf_of_charge_management", "dispute_management", "refund_management" ], "title": "ConnectEmbeddedDisputesListFeatures", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "capture_payments", "destination_on_behalf_of_charge_management", "dispute_management", "refund_management" ], "x-stripeResource": { "class_name": "DisputesListFeatures", "in_package": "" } }, "connect_embedded_financial_account_config_claim": { "description": "", "properties": { "enabled": { "description": "Whether the embedded component is enabled.", "type": "boolean" }, "features": { "$ref": "#/components/schemas/connect_embedded_financial_account_features" } }, "required": [ "enabled", "features" ], "title": "ConnectEmbeddedFinancialAccountConfigClaim", "type": "object", "x-expandableFields": [ "features" ], "x-stripeMostCommon": [ "enabled", "features" ], "x-stripeResource": { "class_name": "FinancialAccountConfig", "in_package": "" } }, "connect_embedded_financial_account_features": { "description": "", "properties": { "disable_stripe_user_authentication": { "description": "Whether Stripe user authentication is disabled. This value can only be `true` for accounts where `controller.requirement_collection` is `application` for the account. The default value is the opposite of the `external_account_collection` value. For example, if you don't set `external_account_collection`, it defaults to `true` and `disable_stripe_user_authentication` defaults to `false`.", "type": "boolean" }, "external_account_collection": { "description": "Whether external account collection is enabled. This feature can only be `false` for accounts where you’re responsible for collecting updated information when requirements are due or change, like Custom accounts. The default value for this feature is `true`.", "type": "boolean" }, "send_money": { "description": "Whether to allow sending money.", "type": "boolean" }, "transfer_balance": { "description": "Whether to allow transferring balance.", "type": "boolean" } }, "required": [ "disable_stripe_user_authentication", "external_account_collection", "send_money", "transfer_balance" ], "title": "ConnectEmbeddedFinancialAccountFeatures", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "disable_stripe_user_authentication", "external_account_collection", "send_money", "transfer_balance" ], "x-stripeResource": { "class_name": "FinancialAccountFeatures", "in_package": "" } }, "connect_embedded_financial_account_transactions_config_claim": { "description": "", "properties": { "enabled": { "description": "Whether the embedded component is enabled.", "type": "boolean" }, "features": { "$ref": "#/components/schemas/connect_embedded_financial_account_transactions_features" } }, "required": [ "enabled", "features" ], "title": "ConnectEmbeddedFinancialAccountTransactionsConfigClaim", "type": "object", "x-expandableFields": [ "features" ], "x-stripeMostCommon": [ "enabled", "features" ], "x-stripeResource": { "class_name": "FinancialAccountTransactionsConfig", "in_package": "" } }, "connect_embedded_financial_account_transactions_features": { "description": "", "properties": { "card_spend_dispute_management": { "description": "Whether to allow card spend dispute management features.", "type": "boolean" } }, "required": [ "card_spend_dispute_management" ], "title": "ConnectEmbeddedFinancialAccountTransactionsFeatures", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "card_spend_dispute_management" ], "x-stripeResource": { "class_name": "FinancialAccountTransactionsFeatures", "in_package": "" } }, "connect_embedded_instant_payouts_promotion_config": { "description": "", "properties": { "enabled": { "description": "Whether the embedded component is enabled.", "type": "boolean" }, "features": { "$ref": "#/components/schemas/connect_embedded_instant_payouts_promotion_features" } }, "required": [ "enabled", "features" ], "title": "ConnectEmbeddedInstantPayoutsPromotionConfig", "type": "object", "x-expandableFields": [ "features" ], "x-stripeMostCommon": [ "enabled", "features" ], "x-stripeResource": { "class_name": "InstantPayoutsPromotionConfig", "in_package": "" } }, "connect_embedded_instant_payouts_promotion_features": { "description": "", "properties": { "disable_stripe_user_authentication": { "description": "Whether Stripe user authentication is disabled. This value can only be `true` for accounts where `controller.requirement_collection` is `application` for the account. The default value is the opposite of the `external_account_collection` value. For example, if you don't set `external_account_collection`, it defaults to `true` and `disable_stripe_user_authentication` defaults to `false`.", "type": "boolean" }, "external_account_collection": { "description": "Whether external account collection is enabled. This feature can only be `false` for accounts where you’re responsible for collecting updated information when requirements are due or change, like Custom accounts. The default value for this feature is `true`.", "type": "boolean" }, "instant_payouts": { "description": "Whether to allow creation of instant payouts. Defaults to `true` when `controller.losses.payments` is set to `stripe` for the account, otherwise `false`.", "type": "boolean" } }, "required": [ "disable_stripe_user_authentication", "external_account_collection", "instant_payouts" ], "title": "ConnectEmbeddedInstantPayoutsPromotionFeatures", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "disable_stripe_user_authentication", "external_account_collection", "instant_payouts" ], "x-stripeResource": { "class_name": "InstantPayoutsPromotionFeatures", "in_package": "" } }, "connect_embedded_issuing_card_config_claim": { "description": "", "properties": { "enabled": { "description": "Whether the embedded component is enabled.", "type": "boolean" }, "features": { "$ref": "#/components/schemas/connect_embedded_issuing_card_features" } }, "required": [ "enabled", "features" ], "title": "ConnectEmbeddedIssuingCardConfigClaim", "type": "object", "x-expandableFields": [ "features" ], "x-stripeMostCommon": [ "enabled", "features" ], "x-stripeResource": { "class_name": "IssuingCardConfig", "in_package": "" } }, "connect_embedded_issuing_card_features": { "description": "", "properties": { "card_management": { "description": "Whether to allow card management features.", "type": "boolean" }, "card_spend_dispute_management": { "description": "Whether to allow card spend dispute management features.", "type": "boolean" }, "cardholder_management": { "description": "Whether to allow cardholder management features.", "type": "boolean" }, "spend_control_management": { "description": "Whether to allow spend control management features.", "type": "boolean" } }, "required": [ "card_management", "card_spend_dispute_management", "cardholder_management", "spend_control_management" ], "title": "ConnectEmbeddedIssuingCardFeatures", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "card_management", "card_spend_dispute_management", "cardholder_management", "spend_control_management" ], "x-stripeResource": { "class_name": "IssuingCardFeatures", "in_package": "" } }, "connect_embedded_issuing_cards_list_config_claim": { "description": "", "properties": { "enabled": { "description": "Whether the embedded component is enabled.", "type": "boolean" }, "features": { "$ref": "#/components/schemas/connect_embedded_issuing_cards_list_features" } }, "required": [ "enabled", "features" ], "title": "ConnectEmbeddedIssuingCardsListConfigClaim", "type": "object", "x-expandableFields": [ "features" ], "x-stripeMostCommon": [ "enabled", "features" ], "x-stripeResource": { "class_name": "IssuingCardsListConfig", "in_package": "" } }, "connect_embedded_issuing_cards_list_features": { "description": "", "properties": { "card_management": { "description": "Whether to allow card management features.", "type": "boolean" }, "card_spend_dispute_management": { "description": "Whether to allow card spend dispute management features.", "type": "boolean" }, "cardholder_management": { "description": "Whether to allow cardholder management features.", "type": "boolean" }, "disable_stripe_user_authentication": { "description": "Whether Stripe user authentication is disabled. This value can only be `true` for accounts where `controller.requirement_collection` is `application` for the account. The default value is the opposite of the `external_account_collection` value. For example, if you don't set `external_account_collection`, it defaults to `true` and `disable_stripe_user_authentication` defaults to `false`.", "type": "boolean" }, "spend_control_management": { "description": "Whether to allow spend control management features.", "type": "boolean" } }, "required": [ "card_management", "card_spend_dispute_management", "cardholder_management", "disable_stripe_user_authentication", "spend_control_management" ], "title": "ConnectEmbeddedIssuingCardsListFeatures", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "card_management", "card_spend_dispute_management", "cardholder_management", "disable_stripe_user_authentication", "spend_control_management" ], "x-stripeResource": { "class_name": "IssuingCardsListFeatures", "in_package": "" } }, "connect_embedded_payment_disputes_config": { "description": "", "properties": { "enabled": { "description": "Whether the embedded component is enabled.", "type": "boolean" }, "features": { "$ref": "#/components/schemas/connect_embedded_payment_disputes_features" } }, "required": [ "enabled", "features" ], "title": "ConnectEmbeddedPaymentDisputesConfig", "type": "object", "x-expandableFields": [ "features" ], "x-stripeMostCommon": [ "enabled", "features" ], "x-stripeResource": { "class_name": "PaymentDisputesConfig", "in_package": "" } }, "connect_embedded_payment_disputes_features": { "description": "", "properties": { "destination_on_behalf_of_charge_management": { "description": "Whether connected accounts can manage destination charges that are created on behalf of them. This is `false` by default.", "type": "boolean" }, "dispute_management": { "description": "Whether responding to disputes is enabled, including submitting evidence and accepting disputes. This is `true` by default.", "type": "boolean" }, "refund_management": { "description": "Whether sending refunds is enabled. This is `true` by default.", "type": "boolean" } }, "required": [ "destination_on_behalf_of_charge_management", "dispute_management", "refund_management" ], "title": "ConnectEmbeddedPaymentDisputesFeatures", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "destination_on_behalf_of_charge_management", "dispute_management", "refund_management" ], "x-stripeResource": { "class_name": "PaymentDisputesFeatures", "in_package": "" } }, "connect_embedded_payments_config_claim": { "description": "", "properties": { "enabled": { "description": "Whether the embedded component is enabled.", "type": "boolean" }, "features": { "$ref": "#/components/schemas/connect_embedded_payments_features" } }, "required": [ "enabled", "features" ], "title": "ConnectEmbeddedPaymentsConfigClaim", "type": "object", "x-expandableFields": [ "features" ], "x-stripeMostCommon": [ "enabled", "features" ], "x-stripeResource": { "class_name": "PaymentsConfig", "in_package": "" } }, "connect_embedded_payments_features": { "description": "", "properties": { "capture_payments": { "description": "Whether to allow capturing and cancelling payment intents. This is `true` by default.", "type": "boolean" }, "destination_on_behalf_of_charge_management": { "description": "Whether connected accounts can manage destination charges that are created on behalf of them. This is `false` by default.", "type": "boolean" }, "dispute_management": { "description": "Whether responding to disputes is enabled, including submitting evidence and accepting disputes. This is `true` by default.", "type": "boolean" }, "refund_management": { "description": "Whether sending refunds is enabled. This is `true` by default.", "type": "boolean" } }, "required": [ "capture_payments", "destination_on_behalf_of_charge_management", "dispute_management", "refund_management" ], "title": "ConnectEmbeddedPaymentsFeatures", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "capture_payments", "destination_on_behalf_of_charge_management", "dispute_management", "refund_management" ], "x-stripeResource": { "class_name": "PaymentsFeatures", "in_package": "" } }, "connect_embedded_payouts_config": { "description": "", "properties": { "enabled": { "description": "Whether the embedded component is enabled.", "type": "boolean" }, "features": { "$ref": "#/components/schemas/connect_embedded_payouts_features" } }, "required": [ "enabled", "features" ], "title": "ConnectEmbeddedPayoutsConfig", "type": "object", "x-expandableFields": [ "features" ], "x-stripeMostCommon": [ "enabled", "features" ], "x-stripeResource": { "class_name": "PayoutsConfig", "in_package": "" } }, "connect_embedded_payouts_features": { "description": "", "properties": { "disable_stripe_user_authentication": { "description": "Whether Stripe user authentication is disabled. This value can only be `true` for accounts where `controller.requirement_collection` is `application` for the account. The default value is the opposite of the `external_account_collection` value. For example, if you don't set `external_account_collection`, it defaults to `true` and `disable_stripe_user_authentication` defaults to `false`.", "type": "boolean" }, "edit_payout_schedule": { "description": "Whether to allow payout schedule to be changed. Defaults to `true` when `controller.losses.payments` is set to `stripe` for the account, otherwise `false`.", "type": "boolean" }, "external_account_collection": { "description": "Whether external account collection is enabled. This feature can only be `false` for accounts where you’re responsible for collecting updated information when requirements are due or change, like Custom accounts. The default value for this feature is `true`.", "type": "boolean" }, "instant_payouts": { "description": "Whether to allow creation of instant payouts. Defaults to `true` when `controller.losses.payments` is set to `stripe` for the account, otherwise `false`.", "type": "boolean" }, "standard_payouts": { "description": "Whether to allow creation of standard payouts. Defaults to `true` when `controller.losses.payments` is set to `stripe` for the account, otherwise `false`.", "type": "boolean" } }, "required": [ "disable_stripe_user_authentication", "edit_payout_schedule", "external_account_collection", "instant_payouts", "standard_payouts" ], "title": "ConnectEmbeddedPayoutsFeatures", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "disable_stripe_user_authentication", "edit_payout_schedule", "external_account_collection", "instant_payouts", "standard_payouts" ], "x-stripeResource": { "class_name": "PayoutsFeatures", "in_package": "" } }, "connect_risk_account_risk_control": { "description": "", "properties": { "pause_requested": { "description": "Whether a pause of the risk control has been requested.", "type": "boolean" } }, "required": [ "pause_requested" ], "title": "ConnectRiskAccountRiskControl", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "pause_requested" ] }, "connect_risk_account_risk_controls": { "description": "", "properties": { "charges": { "$ref": "#/components/schemas/connect_risk_account_risk_control" }, "payouts": { "$ref": "#/components/schemas/connect_risk_account_risk_control" }, "rejected_reason": { "description": "Represents the rejected reason of the account. Empty if account is not rejected, or rejected by Stripe. Please see [this page for more details](https://stripe.com/docs/connect/)", "enum": [ "credit", "fraud", "fraud_no_intent_to_fulfill", "fraud_other", "fraud_payment_method_casher", "fraud_payment_method_tester", "other", "terms_of_service" ], "nullable": true, "type": "string" } }, "required": [ "charges", "payouts" ], "title": "ConnectRiskAccountRiskControls", "type": "object", "x-expandableFields": [ "charges", "payouts" ], "x-stripeMostCommon": [ "charges", "payouts", "rejected_reason" ] }, "country_spec": { "description": "Stripe needs to collect certain pieces of information about each account\ncreated. These requirements can differ depending on the account's country. The\nCountry Specs API makes these rules available to your integration.\n\nYou can also view the information from this API call as [an online\nguide](/docs/connect/required-verification-information).", "properties": { "default_currency": { "description": "The default currency for this country. This applies to both payment methods and bank accounts.", "maxLength": 5000, "type": "string" }, "id": { "description": "Unique identifier for the object. Represented as the ISO country code for this country.", "maxLength": 5000, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "country_spec" ], "type": "string" }, "supported_bank_account_currencies": { "additionalProperties": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "description": "Currencies that can be accepted in the specific country (for transfers).", "type": "object" }, "supported_payment_currencies": { "description": "Currencies that can be accepted in the specified country (for payments).", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "supported_payment_methods": { "description": "Payment methods available in the specified country. You may need to enable some payment methods (e.g., [ACH](https://stripe.com/docs/ach)) on your account before they appear in this list. The `stripe` payment method refers to [charging through your platform](https://stripe.com/docs/connect/destination-charges).", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "supported_transfer_countries": { "description": "Countries that can accept transfers from the specified country.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "verification_fields": { "$ref": "#/components/schemas/country_spec_verification_fields" } }, "required": [ "default_currency", "id", "object", "supported_bank_account_currencies", "supported_payment_currencies", "supported_payment_methods", "supported_transfer_countries", "verification_fields" ], "title": "CountrySpec", "type": "object", "x-expandableFields": [ "verification_fields" ], "x-resourceId": "country_spec", "x-stripeMostCommon": [ "default_currency", "id", "supported_bank_account_currencies", "supported_payment_currencies", "supported_payment_methods", "supported_transfer_countries" ], "x-stripeOperations": [ { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/country_specs" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/country_specs/{country}" } ], "x-stripeResource": { "class_name": "CountrySpec", "has_collection_class": true, "in_package": "" } }, "country_spec_verification_field_details": { "description": "", "properties": { "additional": { "description": "Additional fields which are only required for some users.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "minimum": { "description": "Fields which every account must eventually provide.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "required": [ "additional", "minimum" ], "title": "CountrySpecVerificationFieldDetails", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "additional", "minimum" ] }, "country_spec_verification_fields": { "description": "", "properties": { "company": { "$ref": "#/components/schemas/country_spec_verification_field_details" }, "individual": { "$ref": "#/components/schemas/country_spec_verification_field_details" } }, "required": [ "company", "individual" ], "title": "CountrySpecVerificationFields", "type": "object", "x-expandableFields": [ "company", "individual" ], "x-stripeMostCommon": [ "company", "individual" ] }, "coupon": { "description": "A coupon contains information about a percent-off or amount-off discount you\nmight want to apply to a customer. Coupons may be applied to [subscriptions](https://stripe.com/docs/api#subscriptions), [invoices](https://stripe.com/docs/api#invoices),\n[checkout sessions](https://stripe.com/docs/api/checkout/sessions), [quotes](https://stripe.com/docs/api#quotes), and more. Coupons do not work with conventional one-off [charges](https://stripe.com/docs/api#create_charge) or [payment intents](https://stripe.com/docs/api/payment_intents).", "properties": { "amount_off": { "description": "Amount (in the `currency` specified) that will be taken off the subtotal of any invoices for this customer.", "nullable": true, "type": "integer" }, "applies_to": { "$ref": "#/components/schemas/coupon_applies_to" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "currency": { "description": "If `amount_off` has been set, the three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the amount to take off.", "format": "currency", "nullable": true, "type": "string" }, "currency_options": { "additionalProperties": { "$ref": "#/components/schemas/coupon_currency_option" }, "description": "Coupons defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).", "type": "object" }, "duration": { "description": "One of `forever`, `once`, or `repeating`. Describes how long a customer who applies this coupon will get the discount.", "enum": [ "forever", "once", "repeating" ], "type": "string", "x-stripeBypassValidation": true }, "duration_in_months": { "description": "If `duration` is `repeating`, the number of months the coupon applies. Null if coupon `duration` is `forever` or `once`.", "nullable": true, "type": "integer" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "max_redemptions": { "description": "Maximum number of times this coupon can be redeemed, in total, across all customers, before it is no longer valid.", "nullable": true, "type": "integer" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "nullable": true, "type": "object" }, "name": { "description": "Name of the coupon displayed to customers on for instance invoices or receipts.", "maxLength": 5000, "nullable": true, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "coupon" ], "type": "string" }, "percent_off": { "description": "Percent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon. For example, a coupon with percent_off of 50 will make a $ (or local equivalent)100 invoice $ (or local equivalent)50 instead.", "nullable": true, "type": "number" }, "redeem_by": { "description": "Date after which the coupon can no longer be redeemed.", "format": "unix-time", "nullable": true, "type": "integer" }, "script": { "anyOf": [ { "$ref": "#/components/schemas/script" } ], "description": "Configuration of the [script](https://docs.stripe.com/billing/subscriptions/script-coupons) used to calculate the discount.", "nullable": true }, "times_redeemed": { "description": "Number of times this coupon has been applied to a customer.", "type": "integer" }, "type": { "description": "One of `amount_off`, `percent_off`, or `script`. Describes the type of coupon logic used to calculate the discount.", "enum": [ "amount_off", "percent_off", "script" ], "nullable": true, "type": "string" }, "valid": { "description": "Taking account of the above properties, whether this coupon can still be applied to a customer.", "type": "boolean" } }, "required": [ "amount_off", "created", "currency", "duration", "duration_in_months", "id", "livemode", "max_redemptions", "metadata", "name", "object", "percent_off", "redeem_by", "times_redeemed", "valid" ], "title": "Coupon", "type": "object", "x-expandableFields": [ "applies_to", "currency_options", "script" ], "x-resourceId": "coupon", "x-stripeMostCommon": [ "amount_off", "currency", "duration", "id", "metadata", "name", "percent_off" ], "x-stripeOperations": [ { "method_name": "delete", "method_on": "service", "method_type": "delete", "operation": "delete", "path": "/v1/coupons/{coupon}" }, { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/coupons" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/coupons/{coupon}" }, { "method_name": "create", "method_on": "service", "method_type": "create", "operation": "post", "path": "/v1/coupons" }, { "method_name": "update", "method_on": "service", "method_type": "update", "operation": "post", "path": "/v1/coupons/{coupon}" } ], "x-stripeResource": { "class_name": "Coupon", "has_collection_class": true, "in_package": "" } }, "coupon.created": { "description": "Occurs whenever a coupon is created.", "properties": { "object": { "$ref": "#/components/schemas/coupon" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "coupon.created" } }, "coupon.deleted": { "description": "Occurs whenever a coupon is deleted.", "properties": { "object": { "$ref": "#/components/schemas/coupon" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "coupon.deleted" } }, "coupon.updated": { "description": "Occurs whenever a coupon is updated.", "properties": { "object": { "$ref": "#/components/schemas/coupon" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "coupon.updated" } }, "coupon_applies_to": { "description": "", "properties": { "products": { "description": "A list of product IDs this coupon applies to", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "required": [ "products" ], "title": "CouponAppliesTo", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "products" ] }, "coupon_currency_option": { "description": "", "properties": { "amount_off": { "description": "Amount (in the `currency` specified) that will be taken off the subtotal of any invoices for this customer.", "type": "integer" } }, "required": [ "amount_off" ], "title": "CouponCurrencyOption", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "amount_off" ] }, "credit_balance": { "description": "", "properties": { "available_balance": { "$ref": "#/components/schemas/billing_credit_grants_resource_amount" }, "ledger_balance": { "$ref": "#/components/schemas/billing_credit_grants_resource_amount" } }, "required": [ "available_balance", "ledger_balance" ], "title": "CreditBalance", "type": "object", "x-expandableFields": [ "available_balance", "ledger_balance" ], "x-stripeMostCommon": [ "available_balance", "ledger_balance" ], "x-stripeResource": { "class_name": "CreditBalance", "in_package": "Billing" } }, "credit_note": { "description": "Issue a credit note to adjust an invoice's amount after the invoice is finalized.\n\nRelated guide: [Credit notes](https://stripe.com/docs/billing/invoices/credit-notes)", "properties": { "amount": { "description": "The integer amount in cents (or local equivalent) representing the total amount of the credit note, including tax.", "type": "integer" }, "amount_shipping": { "description": "This is the sum of all the shipping amounts.", "type": "integer" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "customer": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/customer" }, { "$ref": "#/components/schemas/deleted_customer" } ], "description": "ID of the customer.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/customer" }, { "$ref": "#/components/schemas/deleted_customer" } ] } }, "customer_account": { "description": "ID of the account.", "maxLength": 5000, "nullable": true, "type": "string" }, "customer_balance_transaction": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/customer_balance_transaction" } ], "description": "Customer balance transaction related to this credit note.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/customer_balance_transaction" } ] } }, "discount_amount": { "description": "The integer amount in cents (or local equivalent) representing the total amount of discount that was credited.", "type": "integer" }, "discount_amounts": { "description": "The aggregate amounts calculated per discount for all line items.", "items": { "$ref": "#/components/schemas/discounts_resource_discount_amount" }, "type": "array" }, "effective_at": { "description": "The date when this credit note is in effect. Same as `created` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the credit note PDF.", "format": "unix-time", "nullable": true, "type": "integer" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "invoice": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/invoice" } ], "description": "ID of the invoice.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/invoice" } ] } }, "lines": { "description": "Line items that make up the credit note", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/credit_note_line_item" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "CreditNoteLinesList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "memo": { "description": "Customer-facing text that appears on the credit note PDF.", "maxLength": 5000, "nullable": true, "type": "string" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "nullable": true, "type": "object" }, "number": { "description": "A unique number that identifies this particular credit note and appears on the PDF of the credit note and its associated invoice.", "maxLength": 5000, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "credit_note" ], "type": "string" }, "out_of_band_amount": { "description": "Amount that was credited outside of Stripe.", "nullable": true, "type": "integer" }, "pdf": { "description": "The link to download the PDF of the credit note.", "maxLength": 5000, "type": "string" }, "post_payment_amount": { "description": "The amount of the credit note that was refunded to the customer, credited to the customer's balance, credited outside of Stripe, or any combination thereof.", "type": "integer" }, "pre_payment_amount": { "description": "The amount of the credit note by which the invoice's `amount_remaining` and `amount_due` were reduced.", "type": "integer" }, "pretax_credit_amounts": { "description": "The pretax credit amounts (ex: discount, credit grants, etc) for all line items.", "items": { "$ref": "#/components/schemas/credit_notes_pretax_credit_amount" }, "type": "array" }, "reason": { "description": "Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory`", "enum": [ "duplicate", "fraudulent", "order_change", "product_unsatisfactory" ], "nullable": true, "type": "string" }, "refunds": { "description": "Refunds related to this credit note.", "items": { "$ref": "#/components/schemas/credit_note_refund" }, "type": "array" }, "shipping_cost": { "anyOf": [ { "$ref": "#/components/schemas/invoices_resource_shipping_cost" } ], "description": "The details of the cost of shipping, including the ShippingRate applied to the invoice.", "nullable": true }, "status": { "description": "Status of this credit note, one of `issued` or `void`. Learn more about [voiding credit notes](https://stripe.com/docs/billing/invoices/credit-notes#voiding).", "enum": [ "issued", "void" ], "type": "string", "x-stripeBypassValidation": true }, "subtotal": { "description": "The integer amount in cents (or local equivalent) representing the amount of the credit note, excluding exclusive tax and invoice level discounts.", "type": "integer" }, "subtotal_excluding_tax": { "description": "The integer amount in cents (or local equivalent) representing the amount of the credit note, excluding all tax and invoice level discounts.", "nullable": true, "type": "integer" }, "total": { "description": "The integer amount in cents (or local equivalent) representing the total amount of the credit note, including tax and all discount.", "type": "integer" }, "total_excluding_tax": { "description": "The integer amount in cents (or local equivalent) representing the total amount of the credit note, excluding tax, but including discounts.", "nullable": true, "type": "integer" }, "total_taxes": { "description": "The aggregate tax information for all line items.", "items": { "$ref": "#/components/schemas/billing_bill_resource_invoicing_taxes_tax" }, "nullable": true, "type": "array" }, "type": { "description": "Type of this credit note, one of `pre_payment` or `post_payment`. A `pre_payment` credit note means it was issued when the invoice was open. A `post_payment` credit note means it was issued when the invoice was paid.", "enum": [ "mixed", "post_payment", "pre_payment" ], "type": "string" }, "voided_at": { "description": "The time that the credit note was voided.", "format": "unix-time", "nullable": true, "type": "integer" } }, "required": [ "amount", "amount_shipping", "created", "currency", "customer", "customer_balance_transaction", "discount_amount", "discount_amounts", "effective_at", "id", "invoice", "lines", "livemode", "memo", "metadata", "number", "object", "out_of_band_amount", "pdf", "post_payment_amount", "pre_payment_amount", "pretax_credit_amounts", "reason", "refunds", "shipping_cost", "status", "subtotal", "subtotal_excluding_tax", "total", "total_excluding_tax", "total_taxes", "type", "voided_at" ], "title": "CreditNote", "type": "object", "x-expandableFields": [ "customer", "customer_balance_transaction", "discount_amounts", "invoice", "lines", "pretax_credit_amounts", "refunds", "shipping_cost", "total_taxes" ], "x-resourceId": "credit_note", "x-stripeMostCommon": [ "currency", "id", "invoice", "lines", "memo", "metadata", "reason", "status", "subtotal", "total" ], "x-stripeOperations": [ { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/credit_notes" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/credit_notes/{id}" }, { "method_name": "preview", "method_on": "service", "method_type": "custom", "operation": "get", "path": "/v1/credit_notes/preview" }, { "method_name": "preview_lines", "method_on": "service", "method_type": "custom", "operation": "get", "path": "/v1/credit_notes/preview/lines" }, { "method_name": "create", "method_on": "service", "method_type": "create", "operation": "post", "path": "/v1/credit_notes" }, { "method_name": "update", "method_on": "service", "method_type": "update", "operation": "post", "path": "/v1/credit_notes/{id}" }, { "method_name": "void_credit_note", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/credit_notes/{id}/void" } ], "x-stripeResource": { "class_name": "CreditNote", "has_collection_class": true, "in_package": "" } }, "credit_note.created": { "description": "Occurs whenever a credit note is created.", "properties": { "object": { "$ref": "#/components/schemas/credit_note" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "credit_note.created" } }, "credit_note.updated": { "description": "Occurs whenever a credit note is updated.", "properties": { "object": { "$ref": "#/components/schemas/credit_note" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "credit_note.updated" } }, "credit_note.voided": { "description": "Occurs whenever a credit note is voided.", "properties": { "object": { "$ref": "#/components/schemas/credit_note" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "credit_note.voided" } }, "credit_note_line_item": { "description": "The credit note line item object", "properties": { "amount": { "description": "The integer amount in cents (or local equivalent) representing the gross amount being credited for this line item, excluding (exclusive) tax and discounts.", "type": "integer" }, "description": { "description": "Description of the item being credited.", "maxLength": 5000, "nullable": true, "type": "string" }, "discount_amount": { "description": "The integer amount in cents (or local equivalent) representing the discount being credited for this line item.", "type": "integer" }, "discount_amounts": { "description": "The amount of discount calculated per discount for this line item", "items": { "$ref": "#/components/schemas/discounts_resource_discount_amount" }, "type": "array" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "invoice_line_item": { "description": "ID of the invoice line item being credited", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "credit_note_line_item" ], "type": "string" }, "pretax_credit_amounts": { "description": "The pretax credit amounts (ex: discount, credit grants, etc) for this line item.", "items": { "$ref": "#/components/schemas/credit_notes_pretax_credit_amount" }, "type": "array" }, "quantity": { "description": "The number of units of product being credited.", "nullable": true, "type": "integer" }, "tax_calculation_reference": { "anyOf": [ { "$ref": "#/components/schemas/tax_product_integration_resource_tax_calculation_reference" } ], "description": "The tax calculation identifiers of the line item.", "nullable": true }, "tax_rates": { "description": "The tax rates which apply to the line item.", "items": { "$ref": "#/components/schemas/tax_rate" }, "type": "array" }, "taxes": { "description": "The tax information of the line item.", "items": { "$ref": "#/components/schemas/billing_bill_resource_invoicing_taxes_tax" }, "nullable": true, "type": "array" }, "type": { "description": "The type of the credit note line item, one of `invoice_line_item` or `custom_line_item`. When the type is `invoice_line_item` there is an additional `invoice_line_item` property on the resource the value of which is the id of the credited line item on the invoice.", "enum": [ "custom_line_item", "invoice_line_item" ], "type": "string" }, "unit_amount": { "description": "The cost of each unit of product being credited.", "nullable": true, "type": "integer" }, "unit_amount_decimal": { "description": "Same as `unit_amount`, but contains a decimal value with at most 12 decimal places.", "format": "decimal", "nullable": true, "type": "string" } }, "required": [ "amount", "description", "discount_amount", "discount_amounts", "id", "livemode", "object", "pretax_credit_amounts", "quantity", "tax_rates", "taxes", "type", "unit_amount", "unit_amount_decimal" ], "title": "CreditNoteLineItem", "type": "object", "x-expandableFields": [ "discount_amounts", "pretax_credit_amounts", "tax_calculation_reference", "tax_rates", "taxes" ], "x-resourceId": "credit_note_line_item", "x-stripeMostCommon": [ "amount", "description", "discount_amount", "discount_amounts", "id", "invoice_line_item", "livemode", "object", "pretax_credit_amounts", "quantity", "tax_calculation_reference", "tax_rates", "taxes", "type", "unit_amount", "unit_amount_decimal" ], "x-stripeOperations": [ { "method_name": "list", "method_on": "collection", "method_type": "list", "operation": "get", "path": "/v1/credit_notes/{credit_note}/lines" }, { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/credit_notes/{credit_note}/lines" } ], "x-stripeResource": { "class_name": "CreditNoteLineItem", "has_collection_class": true, "in_package": "" } }, "credit_note_refund": { "description": "", "properties": { "amount_refunded": { "description": "Amount of the refund that applies to this credit note, in cents (or local equivalent).", "type": "integer" }, "refund": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/refund" } ], "description": "ID of the refund.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/refund" } ] } } }, "required": [ "amount_refunded", "refund" ], "title": "CreditNoteRefund", "type": "object", "x-expandableFields": [ "refund" ], "x-stripeMostCommon": [ "amount_refunded", "refund" ] }, "credit_notes_pretax_credit_amount": { "description": "", "properties": { "amount": { "description": "The amount, in cents (or local equivalent), of the pretax credit amount.", "type": "integer" }, "credit_balance_transaction": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/billing.credit_balance_transaction" } ], "description": "The credit balance transaction that was applied to get this pretax credit amount.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/billing.credit_balance_transaction" } ] } }, "discount": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/discount" }, { "$ref": "#/components/schemas/deleted_discount" } ], "description": "The discount that was applied to get this pretax credit amount.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/discount" }, { "$ref": "#/components/schemas/deleted_discount" } ] } }, "type": { "description": "Type of the pretax credit amount referenced.", "enum": [ "credit_balance_transaction", "discount" ], "type": "string" } }, "required": [ "amount", "type" ], "title": "CreditNotesPretaxCreditAmount", "type": "object", "x-expandableFields": [ "credit_balance_transaction", "discount" ], "x-stripeMostCommon": [ "amount", "credit_balance_transaction", "discount", "type" ] }, "currency_option": { "description": "", "properties": { "custom_unit_amount": { "anyOf": [ { "$ref": "#/components/schemas/custom_unit_amount" } ], "description": "When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.", "nullable": true }, "tax_behavior": { "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.", "enum": [ "exclusive", "inclusive", "unspecified" ], "nullable": true, "type": "string" }, "tiers": { "description": "Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.", "items": { "$ref": "#/components/schemas/price_tier" }, "type": "array" }, "unit_amount": { "description": "The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`.", "nullable": true, "type": "integer" }, "unit_amount_decimal": { "description": "The unit amount in cents (or local equivalent) to be charged, represented as a decimal string with at most 12 decimal places. Only set if `billing_scheme=per_unit`.", "format": "decimal", "nullable": true, "type": "string" } }, "required": [ "custom_unit_amount", "tax_behavior", "unit_amount", "unit_amount_decimal" ], "title": "CurrencyOption", "type": "object", "x-expandableFields": [ "custom_unit_amount", "tiers" ], "x-stripeMostCommon": [ "unit_amount" ] }, "custom_unit_amount": { "description": "", "properties": { "maximum": { "description": "The maximum unit amount the customer can specify for this item.", "nullable": true, "type": "integer" }, "minimum": { "description": "The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.", "nullable": true, "type": "integer" }, "preset": { "description": "The starting unit amount which can be updated by the customer.", "nullable": true, "type": "integer" } }, "required": [ "maximum", "minimum", "preset" ], "title": "CustomUnitAmount", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "maximum", "minimum", "preset" ] }, "customer": { "description": "This object represents a customer of your business. Use it to [create recurring charges](https://stripe.com/docs/invoicing/customer), [save payment](https://stripe.com/docs/payments/save-during-payment) and contact information,\nand track payments that belong to the same customer.", "properties": { "address": { "anyOf": [ { "$ref": "#/components/schemas/address" } ], "description": "The customer's address.", "nullable": true }, "balance": { "description": "The current balance, if any, that's stored on the customer in their default currency. If negative, the customer has credit to apply to their next invoice. If positive, the customer has an amount owed that's added to their next invoice. The balance only considers amounts that Stripe hasn't successfully applied to any invoice. It doesn't reflect unpaid invoices. This balance is only taken into account after invoices finalize. For multi-currency balances, see [invoice_credit_balance](https://stripe.com/docs/api/customers/object#customer_object-invoice_credit_balance).", "type": "integer" }, "cash_balance": { "anyOf": [ { "$ref": "#/components/schemas/cash_balance" } ], "description": "The current funds being held by Stripe on behalf of the customer. You can apply these funds towards payment intents when the source is \"cash_balance\". The `settings[reconciliation_mode]` field describes if these funds apply to these payment intents manually or automatically.", "nullable": true }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "currency": { "description": "Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) the customer can be charged in for recurring billing purposes.", "maxLength": 5000, "nullable": true, "type": "string" }, "customer_account": { "maxLength": 5000, "nullable": true, "type": "string" }, "default_source": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/payment_source" } ], "description": "ID of the default payment source for the customer.\n\nIf you use payment methods created through the PaymentMethods API, see the [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) field instead.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/payment_source" } ] } }, "delinquent": { "description": "Tracks the most recent state change on any invoice belonging to the customer. Paying an invoice or marking it uncollectible via the API will set this field to false. An automatic payment failure or passing the `invoice.due_date` will set this field to `true`.\n\nIf an invoice becomes uncollectible by [dunning](https://stripe.com/docs/billing/automatic-collection), `delinquent` doesn't reset to `false`.\n\nIf you care whether the customer has paid their most recent subscription invoice, use `subscription.status` instead. Paying or marking uncollectible any customer invoice regardless of whether it is the latest invoice for a subscription will always set this field to `false`.", "nullable": true, "type": "boolean" }, "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users.", "maxLength": 5000, "nullable": true, "type": "string" }, "discount": { "anyOf": [ { "$ref": "#/components/schemas/discount" } ], "description": "Describes the current discount active on the customer, if there is one.", "nullable": true }, "email": { "description": "The customer's email address.", "maxLength": 5000, "nullable": true, "type": "string" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "invoice_credit_balance": { "additionalProperties": { "type": "integer" }, "description": "The current multi-currency balances, if any, that's stored on the customer. If positive in a currency, the customer has a credit to apply to their next invoice denominated in that currency. If negative, the customer has an amount owed that's added to their next invoice denominated in that currency. These balances don't apply to unpaid invoices. They solely track amounts that Stripe hasn't successfully applied to any invoice. Stripe only applies a balance in a specific currency to an invoice after that invoice (which is in the same currency) finalizes.", "type": "object" }, "invoice_prefix": { "description": "The prefix for the customer used to generate unique invoice numbers.", "maxLength": 5000, "nullable": true, "type": "string" }, "invoice_settings": { "$ref": "#/components/schemas/invoice_setting_customer_setting" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "type": "object" }, "name": { "description": "The customer's full name or business name.", "maxLength": 5000, "nullable": true, "type": "string" }, "next_invoice_sequence": { "description": "The suffix of the customer's next invoice number (for example, 0001). When the account uses account level sequencing, this parameter is ignored in API requests and the field omitted in API responses.", "type": "integer" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "customer" ], "type": "string" }, "phone": { "description": "The customer's phone number.", "maxLength": 5000, "nullable": true, "type": "string" }, "preferred_locales": { "description": "The customer's preferred locales (languages), ordered by preference.", "items": { "maxLength": 5000, "type": "string" }, "nullable": true, "type": "array" }, "shipping": { "anyOf": [ { "$ref": "#/components/schemas/shipping" } ], "description": "Mailing and shipping address for the customer. Appears on invoices emailed to this customer.", "nullable": true }, "sources": { "description": "The customer's payment sources, if any.", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/payment_source" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "ApmsSourcesSourceList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] }, "subscriptions": { "description": "The customer's current subscriptions, if any.", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/subscription" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "SubscriptionList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] }, "tax": { "$ref": "#/components/schemas/customer_tax" }, "tax_exempt": { "description": "Describes the customer's tax exemption status, which is `none`, `exempt`, or `reverse`. When set to `reverse`, invoice and receipt PDFs include the following text: **\"Reverse charge\"**.", "enum": [ "exempt", "none", "reverse" ], "nullable": true, "type": "string" }, "tax_ids": { "description": "The customer's tax IDs.", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/tax_id" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "TaxIDsList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] }, "test_clock": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/test_helpers.test_clock" } ], "description": "ID of the test clock that this customer belongs to.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/test_helpers.test_clock" } ] } } }, "required": [ "created", "default_source", "description", "email", "id", "livemode", "object", "shipping" ], "title": "Customer", "type": "object", "x-expandableFields": [ "address", "cash_balance", "default_source", "discount", "invoice_settings", "shipping", "sources", "subscriptions", "tax", "tax_ids", "test_clock" ], "x-resourceId": "customer", "x-stripeMostCommon": [ "address", "description", "email", "id", "metadata", "name", "phone", "shipping", "tax" ], "x-stripeOperations": [ { "method_name": "delete", "method_on": "service", "method_type": "delete", "operation": "delete", "path": "/v1/customers/{customer}" }, { "method_name": "delete_discount", "method_on": "service", "method_type": "custom", "operation": "delete", "path": "/v1/customers/{customer}/discount" }, { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/customers" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/customers/{customer}" }, { "method_name": "balance_transactions", "method_on": "service", "method_type": "custom", "operation": "get", "path": "/v1/customers/{customer}/balance_transactions" }, { "method_name": "list_payment_methods", "method_on": "service", "method_type": "custom", "operation": "get", "path": "/v1/customers/{customer}/payment_methods" }, { "method_name": "retrieve_payment_method", "method_on": "service", "method_type": "custom", "operation": "get", "path": "/v1/customers/{customer}/payment_methods/{payment_method}" }, { "method_name": "search", "method_on": "service", "method_type": "custom", "operation": "get", "path": "/v1/customers/search" }, { "method_name": "create", "method_on": "service", "method_type": "create", "operation": "post", "path": "/v1/customers" }, { "method_name": "update", "method_on": "service", "method_type": "update", "operation": "post", "path": "/v1/customers/{customer}" }, { "method_name": "create_funding_instructions", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/customers/{customer}/funding_instructions" }, { "method_name": "fund_cash_balance", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/test_helpers/customers/{customer}/fund_cash_balance" } ], "x-stripeResource": { "class_name": "Customer", "has_collection_class": true, "has_search_result_class": true, "in_package": "" } }, "customer.created": { "description": "Occurs whenever a new customer is created.", "properties": { "object": { "$ref": "#/components/schemas/customer" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "customer.created" } }, "customer.deleted": { "description": "Occurs whenever a customer is deleted.", "properties": { "object": { "$ref": "#/components/schemas/customer" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "customer.deleted" } }, "customer.discount.created": { "description": "Occurs whenever a coupon is attached to a customer.", "properties": { "object": { "$ref": "#/components/schemas/discount" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "customer.discount.created" } }, "customer.discount.deleted": { "description": "Occurs whenever a coupon is removed from a customer.", "properties": { "object": { "$ref": "#/components/schemas/discount" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "customer.discount.deleted" } }, "customer.discount.updated": { "description": "Occurs whenever a customer is switched from one coupon to another.", "properties": { "object": { "$ref": "#/components/schemas/discount" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "customer.discount.updated" } }, "customer.source.created": { "description": "Occurs whenever a new source is created for a customer.", "properties": { "object": { "anyOf": [ { "$ref": "#/components/schemas/bank_account" }, { "$ref": "#/components/schemas/card" }, { "$ref": "#/components/schemas/source" } ] } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "customer.source.created" } }, "customer.source.deleted": { "description": "Occurs whenever a source is removed from a customer.", "properties": { "object": { "anyOf": [ { "$ref": "#/components/schemas/bank_account" }, { "$ref": "#/components/schemas/card" }, { "$ref": "#/components/schemas/source" } ] } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "customer.source.deleted" } }, "customer.source.expiring": { "description": "Occurs whenever a card or source will expire at the end of the month. This event only works with legacy integrations using Card or Source objects. If you use the PaymentMethod API, this event won't occur.", "properties": { "object": { "anyOf": [ { "$ref": "#/components/schemas/card" }, { "$ref": "#/components/schemas/source" } ] } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "customer.source.expiring" } }, "customer.source.updated": { "description": "Occurs whenever a source's details are changed.", "properties": { "object": { "anyOf": [ { "$ref": "#/components/schemas/bank_account" }, { "$ref": "#/components/schemas/card" }, { "$ref": "#/components/schemas/source" } ] } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "customer.source.updated" } }, "customer.subscription.collection_paused": { "description": "Occurs whenever collection is paused on a customer's subscription. Only applies when [payment collection](https://docs.stripe.com/billing/subscriptions/pause) is paused, not when subscriptions enter `status=paused`.", "properties": { "object": { "$ref": "#/components/schemas/subscription" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "customer.subscription.collection_paused" } }, "customer.subscription.collection_resumed": { "description": "Occurs whenever collection is resumed on a customer's subscription that is currently paused. Only applies when [payment collection](https://docs.stripe.com/billing/subscriptions/pause) is resumed, not when subscriptions exit `status=paused`.", "properties": { "object": { "$ref": "#/components/schemas/subscription" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "customer.subscription.collection_resumed" } }, "customer.subscription.created": { "description": "Occurs whenever a customer is signed up for a new plan.", "properties": { "object": { "$ref": "#/components/schemas/subscription" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "customer.subscription.created" } }, "customer.subscription.custom_event": { "description": "An ad-hoc custom event that is sent based on user configured [Automation](https://docs.stripe.com/billing/automations#send-custom-webhook-event-action).", "properties": { "object": { "$ref": "#/components/schemas/subscription" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "customer.subscription.custom_event" } }, "customer.subscription.deleted": { "description": "Occurs whenever a customer's subscription ends.", "properties": { "object": { "$ref": "#/components/schemas/subscription" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "customer.subscription.deleted" } }, "customer.subscription.paused": { "description": "Occurs whenever a customer's subscription is paused. Only applies when subscriptions enter `status=paused`, not when [payment collection](https://docs.stripe.com/billing/subscriptions/pause) is paused.", "properties": { "object": { "$ref": "#/components/schemas/subscription" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "customer.subscription.paused" } }, "customer.subscription.pending_update_applied": { "description": "Occurs whenever a customer's subscription's pending update is applied, and the subscription is updated.", "properties": { "object": { "$ref": "#/components/schemas/subscription" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "customer.subscription.pending_update_applied" } }, "customer.subscription.pending_update_expired": { "description": "Occurs whenever a customer's subscription's pending update expires before the related invoice is paid.", "properties": { "object": { "$ref": "#/components/schemas/subscription" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "customer.subscription.pending_update_expired" } }, "customer.subscription.price_migration_failed": { "description": "Occurs whenever a price migration failed to transition prices on a subscription.", "properties": { "object": { "$ref": "#/components/schemas/subscription" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "customer.subscription.price_migration_failed" } }, "customer.subscription.resumed": { "description": "Occurs whenever a customer's subscription is no longer paused. Only applies when a `status=paused` subscription is [resumed](https://docs.stripe.com/api/subscriptions/resume), not when [payment collection](https://docs.stripe.com/billing/subscriptions/pause) is resumed.", "properties": { "object": { "$ref": "#/components/schemas/subscription" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "customer.subscription.resumed" } }, "customer.subscription.trial_will_end": { "description": "Occurs three days before a subscription's trial period is scheduled to end, or when a trial is ended immediately (using `trial_end=now`).", "properties": { "object": { "$ref": "#/components/schemas/subscription" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "customer.subscription.trial_will_end" } }, "customer.subscription.updated": { "description": "Occurs whenever a subscription changes (e.g., switching from one plan to another, or changing the status from trial to active).", "properties": { "object": { "$ref": "#/components/schemas/subscription" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "customer.subscription.updated" } }, "customer.tax_id.created": { "description": "Occurs whenever a tax ID is created for a customer.", "properties": { "object": { "$ref": "#/components/schemas/tax_id" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "customer.tax_id.created" } }, "customer.tax_id.deleted": { "description": "Occurs whenever a tax ID is deleted from a customer.", "properties": { "object": { "$ref": "#/components/schemas/tax_id" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "customer.tax_id.deleted" } }, "customer.tax_id.updated": { "description": "Occurs whenever a customer's tax ID is updated.", "properties": { "object": { "$ref": "#/components/schemas/tax_id" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "customer.tax_id.updated" } }, "customer.updated": { "description": "Occurs whenever any property of a customer changes.", "properties": { "object": { "$ref": "#/components/schemas/customer" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "customer.updated" } }, "customer_acceptance": { "description": "", "properties": { "accepted_at": { "description": "The time that the customer accepts the mandate.", "format": "unix-time", "nullable": true, "type": "integer" }, "offline": { "$ref": "#/components/schemas/offline_acceptance" }, "online": { "$ref": "#/components/schemas/online_acceptance" }, "type": { "description": "The mandate includes the type of customer acceptance information, such as: `online` or `offline`.", "enum": [ "offline", "online" ], "type": "string" } }, "required": [ "accepted_at", "type" ], "title": "customer_acceptance", "type": "object", "x-expandableFields": [ "offline", "online" ], "x-stripeMostCommon": [ "accepted_at", "offline", "online", "type" ] }, "customer_balance_customer_balance_settings": { "description": "", "properties": { "reconciliation_mode": { "description": "The configuration for how funds that land in the customer cash balance are reconciled.", "enum": [ "automatic", "manual" ], "type": "string" }, "using_merchant_default": { "description": "A flag to indicate if reconciliation mode returned is the user's default or is specific to this customer cash balance", "type": "boolean" } }, "required": [ "reconciliation_mode", "using_merchant_default" ], "title": "CustomerBalanceCustomerBalanceSettings", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "reconciliation_mode", "using_merchant_default" ] }, "customer_balance_resource_cash_balance_transaction_resource_adjusted_for_overdraft": { "description": "", "properties": { "balance_transaction": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/balance_transaction" } ], "description": "The [Balance Transaction](https://stripe.com/docs/api/balance_transactions/object) that corresponds to funds taken out of your Stripe balance.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/balance_transaction" } ] } }, "linked_transaction": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/customer_cash_balance_transaction" } ], "description": "The [Cash Balance Transaction](https://stripe.com/docs/api/cash_balance_transactions/object) that brought the customer balance negative, triggering the clawback of funds.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/customer_cash_balance_transaction" } ] } } }, "required": [ "balance_transaction", "linked_transaction" ], "title": "CustomerBalanceResourceCashBalanceTransactionResourceAdjustedForOverdraft", "type": "object", "x-expandableFields": [ "balance_transaction", "linked_transaction" ], "x-stripeMostCommon": [ "balance_transaction", "linked_transaction" ], "x-stripeResource": { "class_name": "AdjustedForOverdraft", "in_package": "" } }, "customer_balance_resource_cash_balance_transaction_resource_applied_to_payment_transaction": { "description": "", "properties": { "payment_intent": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/payment_intent" } ], "description": "The [Payment Intent](https://stripe.com/docs/api/payment_intents/object) that funds were applied to.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/payment_intent" } ] } } }, "required": [ "payment_intent" ], "title": "CustomerBalanceResourceCashBalanceTransactionResourceAppliedToPaymentTransaction", "type": "object", "x-expandableFields": [ "payment_intent" ], "x-stripeMostCommon": [ "payment_intent" ] }, "customer_balance_resource_cash_balance_transaction_resource_funded_transaction": { "description": "", "properties": { "bank_transfer": { "$ref": "#/components/schemas/customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer" } }, "required": [ "bank_transfer" ], "title": "CustomerBalanceResourceCashBalanceTransactionResourceFundedTransaction", "type": "object", "x-expandableFields": [ "bank_transfer" ], "x-stripeMostCommon": [ "bank_transfer" ] }, "customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer": { "description": "", "properties": { "eu_bank_transfer": { "$ref": "#/components/schemas/customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_eu_bank_transfer" }, "gb_bank_transfer": { "$ref": "#/components/schemas/customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_gb_bank_transfer" }, "jp_bank_transfer": { "$ref": "#/components/schemas/customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_jp_bank_transfer" }, "reference": { "description": "The user-supplied reference field on the bank transfer.", "maxLength": 5000, "nullable": true, "type": "string" }, "type": { "description": "The funding method type used to fund the customer balance. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.", "enum": [ "eu_bank_transfer", "gb_bank_transfer", "jp_bank_transfer", "mx_bank_transfer", "us_bank_transfer" ], "type": "string", "x-stripeBypassValidation": true }, "us_bank_transfer": { "$ref": "#/components/schemas/customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_us_bank_transfer" } }, "required": [ "reference", "type" ], "title": "CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransfer", "type": "object", "x-expandableFields": [ "eu_bank_transfer", "gb_bank_transfer", "jp_bank_transfer", "us_bank_transfer" ], "x-stripeMostCommon": [ "eu_bank_transfer", "gb_bank_transfer", "jp_bank_transfer", "reference", "type", "us_bank_transfer" ] }, "customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_eu_bank_transfer": { "description": "", "properties": { "bic": { "description": "The BIC of the bank of the sender of the funding.", "maxLength": 5000, "nullable": true, "type": "string" }, "iban_last4": { "description": "The last 4 digits of the IBAN of the sender of the funding.", "maxLength": 5000, "nullable": true, "type": "string" }, "sender_name": { "description": "The full name of the sender, as supplied by the sending bank.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "bic", "iban_last4", "sender_name" ], "title": "CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransferResourceEuBankTransfer", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "bic", "iban_last4", "sender_name" ] }, "customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_gb_bank_transfer": { "description": "", "properties": { "account_number_last4": { "description": "The last 4 digits of the account number of the sender of the funding.", "maxLength": 5000, "nullable": true, "type": "string" }, "sender_name": { "description": "The full name of the sender, as supplied by the sending bank.", "maxLength": 5000, "nullable": true, "type": "string" }, "sort_code": { "description": "The sort code of the bank of the sender of the funding", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "account_number_last4", "sender_name", "sort_code" ], "title": "CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransferResourceGbBankTransfer", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "account_number_last4", "sender_name", "sort_code" ] }, "customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_jp_bank_transfer": { "description": "", "properties": { "sender_bank": { "description": "The name of the bank of the sender of the funding.", "maxLength": 5000, "nullable": true, "type": "string" }, "sender_branch": { "description": "The name of the bank branch of the sender of the funding.", "maxLength": 5000, "nullable": true, "type": "string" }, "sender_name": { "description": "The full name of the sender, as supplied by the sending bank.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "sender_bank", "sender_branch", "sender_name" ], "title": "CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransferResourceJpBankTransfer", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "sender_bank", "sender_branch", "sender_name" ] }, "customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_us_bank_transfer": { "description": "", "properties": { "network": { "description": "The banking network used for this funding.", "enum": [ "ach", "domestic_wire_us", "swift" ], "type": "string" }, "sender_name": { "description": "The full name of the sender, as supplied by the sending bank.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "sender_name" ], "title": "CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransferResourceUsBankTransfer", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "network", "sender_name" ] }, "customer_balance_resource_cash_balance_transaction_resource_refunded_from_payment_transaction": { "description": "", "properties": { "refund": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/refund" } ], "description": "The [Refund](https://stripe.com/docs/api/refunds/object) that moved these funds into the customer's cash balance.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/refund" } ] } } }, "required": [ "refund" ], "title": "CustomerBalanceResourceCashBalanceTransactionResourceRefundedFromPaymentTransaction", "type": "object", "x-expandableFields": [ "refund" ], "x-stripeMostCommon": [ "refund" ], "x-stripeResource": { "class_name": "RefundedFromPayment", "in_package": "" } }, "customer_balance_resource_cash_balance_transaction_resource_transferred_to_balance": { "description": "", "properties": { "balance_transaction": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/balance_transaction" } ], "description": "The [Balance Transaction](https://stripe.com/docs/api/balance_transactions/object) that corresponds to funds transferred to your Stripe balance.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/balance_transaction" } ] } } }, "required": [ "balance_transaction" ], "title": "CustomerBalanceResourceCashBalanceTransactionResourceTransferredToBalance", "type": "object", "x-expandableFields": [ "balance_transaction" ], "x-stripeMostCommon": [ "balance_transaction" ], "x-stripeResource": { "class_name": "TransferredToBalance", "in_package": "" } }, "customer_balance_resource_cash_balance_transaction_resource_unapplied_from_payment_transaction": { "description": "", "properties": { "payment_intent": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/payment_intent" } ], "description": "The [Payment Intent](https://stripe.com/docs/api/payment_intents/object) that funds were unapplied from.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/payment_intent" } ] } } }, "required": [ "payment_intent" ], "title": "CustomerBalanceResourceCashBalanceTransactionResourceUnappliedFromPaymentTransaction", "type": "object", "x-expandableFields": [ "payment_intent" ], "x-stripeMostCommon": [ "payment_intent" ], "x-stripeResource": { "class_name": "UnappliedFromPayment", "in_package": "" } }, "customer_balance_transaction": { "description": "Each customer has a [Balance](https://stripe.com/docs/api/customers/object#customer_object-balance) value,\nwhich denotes a debit or credit that's automatically applied to their next invoice upon finalization.\nYou may modify the value directly by using the [update customer API](https://stripe.com/docs/api/customers/update),\nor by creating a Customer Balance Transaction, which increments or decrements the customer's `balance` by the specified `amount`.\n\nRelated guide: [Customer balance](https://stripe.com/docs/billing/customer/balance)", "properties": { "amount": { "description": "The amount of the transaction. A negative value is a credit for the customer's balance, and a positive value is a debit to the customer's `balance`.", "type": "integer" }, "checkout_session": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/checkout.session" } ], "description": "The ID of the checkout session (if any) that created the transaction.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/checkout.session" } ] } }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "credit_note": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/credit_note" } ], "description": "The ID of the credit note (if any) related to the transaction.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/credit_note" } ] } }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "customer": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/customer" } ], "description": "The ID of the customer the transaction belongs to.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/customer" } ] } }, "customer_account": { "maxLength": 5000, "nullable": true, "type": "string" }, "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users.", "maxLength": 5000, "nullable": true, "type": "string" }, "ending_balance": { "description": "The customer's `balance` after the transaction was applied. A negative value decreases the amount due on the customer's next invoice. A positive value increases the amount due on the customer's next invoice.", "type": "integer" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "invoice": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/invoice" } ], "description": "The ID of the invoice (if any) related to the transaction.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/invoice" } ] } }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "nullable": true, "type": "object" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "customer_balance_transaction" ], "type": "string" }, "type": { "description": "Transaction type: `adjustment`, `applied_to_invoice`, `credit_note`, `initial`, `invoice_overpaid`, `invoice_too_large`, `invoice_too_small`, `unspent_receiver_credit`, `unapplied_from_invoice`, `checkout_session_subscription_payment`, or `checkout_session_subscription_payment_canceled`. See the [Customer Balance page](https://stripe.com/docs/billing/customer/balance#types) to learn more about transaction types.", "enum": [ "adjustment", "applied_to_invoice", "checkout_session_subscription_payment", "checkout_session_subscription_payment_canceled", "credit_note", "initial", "invoice_overpaid", "invoice_too_large", "invoice_too_small", "migration", "unapplied_from_invoice", "unspent_receiver_credit" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "amount", "checkout_session", "created", "credit_note", "currency", "customer", "description", "ending_balance", "id", "invoice", "livemode", "metadata", "object", "type" ], "title": "CustomerBalanceTransaction", "type": "object", "x-expandableFields": [ "checkout_session", "credit_note", "customer", "invoice" ], "x-resourceId": "customer_balance_transaction", "x-stripeMostCommon": [ "amount", "currency", "customer", "description", "ending_balance", "id", "metadata", "type" ], "x-stripeOperations": [ { "method_name": "list", "method_on": "collection", "method_type": "list", "operation": "get", "path": "/v1/customers/{customer}/balance_transactions" }, { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/customers/{customer}/balance_transactions" }, { "method_name": "retrieve", "method_on": "collection", "method_type": "retrieve", "operation": "get", "path": "/v1/customers/{customer}/balance_transactions/{transaction}" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/customers/{customer}/balance_transactions/{transaction}" }, { "method_name": "create", "method_on": "collection", "method_type": "create", "operation": "post", "path": "/v1/customers/{customer}/balance_transactions" }, { "method_name": "create", "method_on": "service", "method_type": "create", "operation": "post", "path": "/v1/customers/{customer}/balance_transactions" }, { "method_name": "update", "method_on": "service", "method_type": "update", "operation": "post", "path": "/v1/customers/{customer}/balance_transactions/{transaction}" } ], "x-stripeResource": { "class_name": "CustomerBalanceTransaction", "has_collection_class": true, "in_package": "" } }, "customer_cash_balance_transaction": { "description": "Customers with certain payments enabled have a cash balance, representing funds that were paid\nby the customer to a merchant, but have not yet been allocated to a payment. Cash Balance Transactions\nrepresent when funds are moved into or out of this balance. This includes funding by the customer, allocation\nto payments, and refunds to the customer.", "properties": { "adjusted_for_overdraft": { "$ref": "#/components/schemas/customer_balance_resource_cash_balance_transaction_resource_adjusted_for_overdraft" }, "applied_to_payment": { "$ref": "#/components/schemas/customer_balance_resource_cash_balance_transaction_resource_applied_to_payment_transaction" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "maxLength": 5000, "type": "string" }, "customer": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/customer" } ], "description": "The customer whose available cash balance changed as a result of this transaction.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/customer" } ] } }, "customer_account": { "maxLength": 5000, "nullable": true, "type": "string" }, "ending_balance": { "description": "The total available cash balance for the specified currency after this transaction was applied. Represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", "type": "integer" }, "funded": { "$ref": "#/components/schemas/customer_balance_resource_cash_balance_transaction_resource_funded_transaction" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "net_amount": { "description": "The amount by which the cash balance changed, represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). A positive value represents funds being added to the cash balance, a negative value represents funds being removed from the cash balance.", "type": "integer" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "customer_cash_balance_transaction" ], "type": "string" }, "refunded_from_payment": { "$ref": "#/components/schemas/customer_balance_resource_cash_balance_transaction_resource_refunded_from_payment_transaction" }, "transferred_to_balance": { "$ref": "#/components/schemas/customer_balance_resource_cash_balance_transaction_resource_transferred_to_balance" }, "type": { "description": "The type of the cash balance transaction. New types may be added in future. See [Customer Balance](https://stripe.com/docs/payments/customer-balance#types) to learn more about these types.", "enum": [ "adjusted_for_overdraft", "applied_to_payment", "funded", "funding_reversed", "refunded_from_payment", "return_canceled", "return_initiated", "transferred_to_balance", "unapplied_from_payment" ], "type": "string" }, "unapplied_from_payment": { "$ref": "#/components/schemas/customer_balance_resource_cash_balance_transaction_resource_unapplied_from_payment_transaction" } }, "required": [ "created", "currency", "customer", "ending_balance", "id", "livemode", "net_amount", "object", "type" ], "title": "CustomerCashBalanceTransaction", "type": "object", "x-expandableFields": [ "adjusted_for_overdraft", "applied_to_payment", "customer", "funded", "refunded_from_payment", "transferred_to_balance", "unapplied_from_payment" ], "x-resourceId": "customer_cash_balance_transaction", "x-stripeMostCommon": [ "adjusted_for_overdraft", "applied_to_payment", "created", "currency", "customer", "customer_account", "ending_balance", "funded", "id", "livemode", "net_amount", "object", "refunded_from_payment", "transferred_to_balance", "type", "unapplied_from_payment" ], "x-stripeOperations": [ { "method_name": "list", "method_on": "collection", "method_type": "list", "operation": "get", "path": "/v1/customers/{customer}/cash_balance_transactions" }, { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/customers/{customer}/cash_balance_transactions" }, { "method_name": "retrieve", "method_on": "collection", "method_type": "retrieve", "operation": "get", "path": "/v1/customers/{customer}/cash_balance_transactions/{transaction}" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/customers/{customer}/cash_balance_transactions/{transaction}" } ], "x-stripeResource": { "class_name": "CustomerCashBalanceTransaction", "has_collection_class": true, "in_package": "", "parent": "customer", "polymorphic_groups": [ "balance_transaction_source" ] } }, "customer_cash_balance_transaction.created": { "description": "Occurs whenever a new customer cash balance transactions is created.", "properties": { "object": { "$ref": "#/components/schemas/customer_cash_balance_transaction" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "customer_cash_balance_transaction.created" } }, "customer_session": { "description": "A Customer Session allows you to grant Stripe's frontend SDKs (like Stripe.js) client-side access\ncontrol over a Customer.\n\nRelated guides: [Customer Session with the Payment Element](/payments/accept-a-payment-deferred?platform=web&type=payment#save-payment-methods),\n[Customer Session with the Pricing Table](/payments/checkout/pricing-table#customer-session),\n[Customer Session with the Buy Button](/payment-links/buy-button#pass-an-existing-customer).", "properties": { "client_secret": { "description": "The client secret of this Customer Session. Used on the client to set up secure access to the given `customer`.\n\nThe client secret can be used to provide access to `customer` from your frontend. It should not be stored, logged, or exposed to anyone other than the relevant customer. Make sure that you have TLS enabled on any page that includes the client secret.", "maxLength": 5000, "type": "string" }, "components": { "$ref": "#/components/schemas/customer_session_resource_components" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "customer": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/customer" } ], "description": "The Customer the Customer Session was created for.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/customer" } ] } }, "customer_account": { "description": "The Account that the Customer Session was created for.", "maxLength": 5000, "nullable": true, "type": "string" }, "expires_at": { "description": "The timestamp at which this Customer Session will expire.", "format": "unix-time", "type": "integer" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "customer_session" ], "type": "string" } }, "required": [ "client_secret", "created", "customer", "expires_at", "livemode", "object" ], "title": "CustomerSessionResourceCustomerSession", "type": "object", "x-expandableFields": [ "components", "customer" ], "x-resourceId": "customer_session", "x-stripeMostCommon": [ "client_secret", "components", "customer", "expires_at" ], "x-stripeOperations": [ { "method_name": "create", "method_on": "service", "method_type": "create", "operation": "post", "path": "/v1/customer_sessions" } ], "x-stripeResource": { "class_name": "CustomerSession", "in_package": "" } }, "customer_session_resource_components": { "description": "Configuration for the components supported by this Customer Session.", "properties": { "buy_button": { "$ref": "#/components/schemas/customer_session_resource_components_resource_buy_button" }, "payment_element": { "$ref": "#/components/schemas/customer_session_resource_components_resource_payment_element" }, "pricing_table": { "$ref": "#/components/schemas/customer_session_resource_components_resource_pricing_table" } }, "required": [ "buy_button", "payment_element", "pricing_table" ], "title": "CustomerSessionResourceComponents", "type": "object", "x-expandableFields": [ "buy_button", "payment_element", "pricing_table" ], "x-stripeMostCommon": [ "buy_button", "payment_element", "pricing_table" ] }, "customer_session_resource_components_resource_buy_button": { "description": "This hash contains whether the buy button is enabled.", "properties": { "enabled": { "description": "Whether the buy button is enabled.", "type": "boolean" } }, "required": [ "enabled" ], "title": "CustomerSessionResourceComponentsResourceBuyButton", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "enabled" ] }, "customer_session_resource_components_resource_payment_element": { "description": "This hash contains whether the Payment Element is enabled and the features it supports.", "properties": { "enabled": { "description": "Whether the Payment Element is enabled.", "type": "boolean" }, "features": { "anyOf": [ { "$ref": "#/components/schemas/customer_session_resource_components_resource_payment_element_resource_features" } ], "description": "This hash defines whether the Payment Element supports certain features.", "nullable": true } }, "required": [ "enabled", "features" ], "title": "CustomerSessionResourceComponentsResourcePaymentElement", "type": "object", "x-expandableFields": [ "features" ], "x-stripeMostCommon": [ "enabled", "features" ] }, "customer_session_resource_components_resource_payment_element_resource_features": { "description": "This hash contains the features the Payment Element supports.", "properties": { "payment_method_allow_redisplay_filters": { "description": "A list of [`allow_redisplay`](https://docs.stripe.com/api/payment_methods/object#payment_method_object-allow_redisplay) values that controls which saved payment methods the Payment Element displays by filtering to only show payment methods with an `allow_redisplay` value that is present in this list.\n\nIf not specified, defaults to [\"always\"]. In order to display all saved payment methods, specify [\"always\", \"limited\", \"unspecified\"].", "items": { "enum": [ "always", "limited", "unspecified" ], "type": "string" }, "type": "array" }, "payment_method_redisplay": { "description": "Controls whether or not the Payment Element shows saved payment methods. This parameter defaults to `disabled`.", "enum": [ "disabled", "enabled" ], "type": "string", "x-stripeBypassValidation": true }, "payment_method_redisplay_limit": { "description": "Determines the max number of saved payment methods for the Payment Element to display. This parameter defaults to `3`. The maximum redisplay limit is `10`.", "nullable": true, "type": "integer" }, "payment_method_remove": { "description": "Controls whether the Payment Element displays the option to remove a saved payment method. This parameter defaults to `disabled`.\n\nAllowing buyers to remove their saved payment methods impacts subscriptions that depend on that payment method. Removing the payment method detaches the [`customer` object](https://docs.stripe.com/api/payment_methods/object#payment_method_object-customer) from that [PaymentMethod](https://docs.stripe.com/api/payment_methods).", "enum": [ "disabled", "enabled" ], "type": "string", "x-stripeBypassValidation": true }, "payment_method_save": { "description": "Controls whether the Payment Element displays a checkbox offering to save a new payment method. This parameter defaults to `disabled`.\n\nIf a customer checks the box, the [`allow_redisplay`](https://docs.stripe.com/api/payment_methods/object#payment_method_object-allow_redisplay) value on the PaymentMethod is set to `'always'` at confirmation time. For PaymentIntents, the [`setup_future_usage`](https://docs.stripe.com/api/payment_intents/object#payment_intent_object-setup_future_usage) value is also set to the value defined in `payment_method_save_usage`.", "enum": [ "disabled", "enabled" ], "type": "string", "x-stripeBypassValidation": true }, "payment_method_save_usage": { "description": "When using PaymentIntents and the customer checks the save checkbox, this field determines the [`setup_future_usage`](https://docs.stripe.com/api/payment_intents/object#payment_intent_object-setup_future_usage) value used to confirm the PaymentIntent.\n\nWhen using SetupIntents, directly configure the [`usage`](https://docs.stripe.com/api/setup_intents/object#setup_intent_object-usage) value on SetupIntent creation.", "enum": [ "off_session", "on_session" ], "nullable": true, "type": "string" } }, "required": [ "payment_method_allow_redisplay_filters", "payment_method_redisplay", "payment_method_redisplay_limit", "payment_method_remove", "payment_method_save", "payment_method_save_usage" ], "title": "CustomerSessionResourceComponentsResourcePaymentElementResourceFeatures", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "payment_method_allow_redisplay_filters", "payment_method_redisplay", "payment_method_redisplay_limit", "payment_method_remove", "payment_method_save", "payment_method_save_usage" ] }, "customer_session_resource_components_resource_pricing_table": { "description": "This hash contains whether the pricing table is enabled.", "properties": { "enabled": { "description": "Whether the pricing table is enabled.", "type": "boolean" } }, "required": [ "enabled" ], "title": "CustomerSessionResourceComponentsResourcePricingTable", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "enabled" ] }, "customer_tax": { "description": "", "properties": { "automatic_tax": { "description": "Surfaces if automatic tax computation is possible given the current customer location information.", "enum": [ "failed", "not_collecting", "supported", "unrecognized_location" ], "type": "string" }, "ip_address": { "description": "A recent IP address of the customer used for tax reporting and tax location inference.", "maxLength": 5000, "nullable": true, "type": "string" }, "location": { "anyOf": [ { "$ref": "#/components/schemas/customer_tax_location" } ], "description": "The identified tax location of the customer.", "nullable": true } }, "required": [ "automatic_tax", "ip_address", "location" ], "title": "CustomerTax", "type": "object", "x-expandableFields": [ "location" ], "x-stripeMostCommon": [ "automatic_tax", "ip_address", "location" ] }, "customer_tax_location": { "description": "", "properties": { "country": { "description": "The identified tax country of the customer.", "maxLength": 5000, "type": "string" }, "source": { "description": "The data source used to infer the customer's location.", "enum": [ "billing_address", "ip_address", "payment_method", "shipping_destination" ], "type": "string" }, "state": { "description": "The identified tax state, county, province, or region of the customer.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "country", "source", "state" ], "title": "CustomerTaxLocation", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "country", "source", "state" ] }, "deleted_account": { "description": "", "properties": { "deleted": { "description": "Always true for a deleted object", "enum": [ true ], "type": "boolean" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "account" ], "type": "string" } }, "required": [ "deleted", "id", "object" ], "title": "DeletedAccount", "type": "object", "x-expandableFields": [], "x-resourceId": "deleted_account", "x-stripeMostCommon": [ "deleted", "id", "object" ], "x-stripeResource": { "class_name": "DeletedAccount", "in_package": "" } }, "deleted_apple_pay_domain": { "description": "", "properties": { "deleted": { "description": "Always true for a deleted object", "enum": [ true ], "type": "boolean" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "apple_pay_domain" ], "type": "string" } }, "required": [ "deleted", "id", "object" ], "title": "DeletedApplePayDomain", "type": "object", "x-expandableFields": [], "x-resourceId": "deleted_apple_pay_domain", "x-stripeMostCommon": [ "deleted", "id", "object" ], "x-stripeResource": { "class_name": "DeletedApplePayDomain", "in_package": "" } }, "deleted_application": { "description": "", "properties": { "deleted": { "description": "Always true for a deleted object", "enum": [ true ], "type": "boolean" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "name": { "description": "The name of the application.", "maxLength": 5000, "nullable": true, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "application" ], "type": "string" } }, "required": [ "deleted", "id", "name", "object" ], "title": "DeletedApplication", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "deleted", "id", "name", "object" ], "x-stripeResource": { "class_name": "DeletedApplication", "in_package": "" } }, "deleted_bank_account": { "description": "", "properties": { "currency": { "description": "Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account.", "maxLength": 5000, "nullable": true, "type": "string" }, "deleted": { "description": "Always true for a deleted object", "enum": [ true ], "type": "boolean" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "bank_account" ], "type": "string" } }, "required": [ "deleted", "id", "object" ], "title": "DeletedBankAccount", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "currency", "deleted", "id", "object" ], "x-stripeResource": { "class_name": "DeletedBankAccount", "in_package": "" } }, "deleted_card": { "description": "", "properties": { "currency": { "description": "Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account.", "maxLength": 5000, "nullable": true, "type": "string" }, "deleted": { "description": "Always true for a deleted object", "enum": [ true ], "type": "boolean" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "card" ], "type": "string" } }, "required": [ "deleted", "id", "object" ], "title": "DeletedCard", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "currency", "deleted", "id", "object" ], "x-stripeResource": { "class_name": "DeletedCard", "in_package": "" } }, "deleted_coupon": { "description": "", "properties": { "deleted": { "description": "Always true for a deleted object", "enum": [ true ], "type": "boolean" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "coupon" ], "type": "string" } }, "required": [ "deleted", "id", "object" ], "title": "DeletedCoupon", "type": "object", "x-expandableFields": [], "x-resourceId": "deleted_coupon", "x-stripeMostCommon": [ "deleted", "id", "object" ], "x-stripeResource": { "class_name": "DeletedCoupon", "in_package": "" } }, "deleted_customer": { "description": "", "properties": { "deleted": { "description": "Always true for a deleted object", "enum": [ true ], "type": "boolean" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "customer" ], "type": "string" } }, "required": [ "deleted", "id", "object" ], "title": "DeletedCustomer", "type": "object", "x-expandableFields": [], "x-resourceId": "deleted_customer", "x-stripeMostCommon": [ "deleted", "id", "object" ], "x-stripeResource": { "class_name": "DeletedCustomer", "in_package": "" } }, "deleted_discount": { "description": "", "properties": { "checkout_session": { "description": "The Checkout session that this coupon is applied to, if it is applied to a particular session in payment mode. Will not be present for subscription mode.", "maxLength": 5000, "nullable": true, "type": "string" }, "coupon": { "$ref": "#/components/schemas/coupon" }, "customer": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/customer" }, { "$ref": "#/components/schemas/deleted_customer" } ], "description": "The ID of the customer associated with this discount.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/customer" }, { "$ref": "#/components/schemas/deleted_customer" } ] } }, "customer_account": { "description": "The ID of the account associated with this discount.", "maxLength": 5000, "nullable": true, "type": "string" }, "deleted": { "description": "Always true for a deleted object", "enum": [ true ], "type": "boolean" }, "id": { "description": "The ID of the discount object. Discounts cannot be fetched by ID. Use `expand[]=discounts` in API calls to expand discount IDs in an array.", "maxLength": 5000, "type": "string" }, "invoice": { "description": "The invoice that the discount's coupon was applied to, if it was applied directly to a particular invoice.", "maxLength": 5000, "nullable": true, "type": "string" }, "invoice_item": { "description": "The invoice item `id` (or invoice line item `id` for invoice line items of type='subscription') that the discount's coupon was applied to, if it was applied directly to a particular invoice item or invoice line item.", "maxLength": 5000, "nullable": true, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "discount" ], "type": "string" }, "promotion_code": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/promotion_code" } ], "description": "The promotion code applied to create this discount.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/promotion_code" } ] } }, "start": { "description": "Date that the coupon was applied.", "format": "unix-time", "type": "integer" }, "subscription": { "description": "The subscription that this coupon is applied to, if it is applied to a particular subscription.", "maxLength": 5000, "nullable": true, "type": "string" }, "subscription_item": { "description": "The subscription item that this coupon is applied to, if it is applied to a particular subscription item.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "checkout_session", "coupon", "customer", "deleted", "id", "invoice", "invoice_item", "object", "promotion_code", "start", "subscription", "subscription_item" ], "title": "DeletedDiscount", "type": "object", "x-expandableFields": [ "coupon", "customer", "promotion_code" ], "x-resourceId": "deleted_discount", "x-stripeMostCommon": [ "coupon", "customer", "deleted", "id", "start", "subscription" ], "x-stripeResource": { "class_name": "DeletedDiscount", "in_package": "" } }, "deleted_external_account": { "anyOf": [ { "$ref": "#/components/schemas/deleted_bank_account" }, { "$ref": "#/components/schemas/deleted_card" } ], "title": "Polymorphic", "x-resourceId": "deleted_external_account", "x-stripeBypassValidation": true, "x-stripeResource": { "class_name": "DeletedExternalAccount" } }, "deleted_invoice": { "description": "", "properties": { "deleted": { "description": "Always true for a deleted object", "enum": [ true ], "type": "boolean" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "invoice" ], "type": "string" } }, "required": [ "deleted", "id", "object" ], "title": "DeletedInvoice", "type": "object", "x-expandableFields": [], "x-resourceId": "deleted_invoice", "x-stripeMostCommon": [ "deleted", "id", "object" ], "x-stripeResource": { "class_name": "DeletedInvoice", "in_package": "" } }, "deleted_invoiceitem": { "description": "", "properties": { "deleted": { "description": "Always true for a deleted object", "enum": [ true ], "type": "boolean" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "invoiceitem" ], "type": "string" } }, "required": [ "deleted", "id", "object" ], "title": "DeletedInvoiceItem", "type": "object", "x-expandableFields": [], "x-resourceId": "deleted_invoiceitem", "x-stripeMostCommon": [ "deleted", "id", "object" ], "x-stripeResource": { "class_name": "DeletedInvoiceItem", "in_package": "" } }, "deleted_payment_source": { "anyOf": [ { "$ref": "#/components/schemas/deleted_bank_account" }, { "$ref": "#/components/schemas/deleted_card" } ], "title": "Polymorphic", "x-resourceId": "deleted_payment_source", "x-stripeBypassValidation": true, "x-stripeResource": { "class_name": "DeletedPaymentSource" } }, "deleted_person": { "description": "", "properties": { "deleted": { "description": "Always true for a deleted object", "enum": [ true ], "type": "boolean" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "person" ], "type": "string" } }, "required": [ "deleted", "id", "object" ], "title": "DeletedPerson", "type": "object", "x-expandableFields": [], "x-resourceId": "deleted_person", "x-stripeMostCommon": [ "deleted", "id", "object" ], "x-stripeResource": { "class_name": "DeletedPerson", "in_package": "" } }, "deleted_plan": { "description": "", "properties": { "deleted": { "description": "Always true for a deleted object", "enum": [ true ], "type": "boolean" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "plan" ], "type": "string" } }, "required": [ "deleted", "id", "object" ], "title": "DeletedPlan", "type": "object", "x-expandableFields": [], "x-resourceId": "deleted_plan", "x-stripeMostCommon": [ "deleted", "id", "object" ], "x-stripeResource": { "class_name": "DeletedPlan", "in_package": "" } }, "deleted_price": { "description": "", "properties": { "deleted": { "description": "Always true for a deleted object", "enum": [ true ], "type": "boolean" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "price" ], "type": "string" } }, "required": [ "deleted", "id", "object" ], "title": "DeletedPrice", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "deleted", "id", "object" ], "x-stripeResource": { "class_name": "DeletedPrice", "in_package": "" } }, "deleted_product": { "description": "", "properties": { "deleted": { "description": "Always true for a deleted object", "enum": [ true ], "type": "boolean" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "product" ], "type": "string" } }, "required": [ "deleted", "id", "object" ], "title": "DeletedProduct", "type": "object", "x-expandableFields": [], "x-resourceId": "deleted_product", "x-stripeMostCommon": [ "deleted", "id", "object" ], "x-stripeResource": { "class_name": "DeletedProduct", "in_package": "" } }, "deleted_product_feature": { "description": "", "properties": { "deleted": { "description": "Always true for a deleted object", "enum": [ true ], "type": "boolean" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "product_feature" ], "type": "string" } }, "required": [ "deleted", "id", "object" ], "title": "DeletedProductFeature", "type": "object", "x-expandableFields": [], "x-resourceId": "deleted_product_feature", "x-stripeMostCommon": [ "deleted", "id", "object" ], "x-stripeResource": { "class_name": "DeletedProductFeature", "in_package": "" } }, "deleted_radar.value_list": { "description": "", "properties": { "deleted": { "description": "Always true for a deleted object", "enum": [ true ], "type": "boolean" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "radar.value_list" ], "type": "string" } }, "required": [ "deleted", "id", "object" ], "title": "RadarListDeletedList", "type": "object", "x-expandableFields": [], "x-resourceId": "deleted_radar.value_list", "x-stripeMostCommon": [ "deleted", "id", "object" ], "x-stripeResource": { "class_name": "DeletedValueList", "in_package": "Radar" } }, "deleted_radar.value_list_item": { "description": "", "properties": { "deleted": { "description": "Always true for a deleted object", "enum": [ true ], "type": "boolean" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "radar.value_list_item" ], "type": "string" } }, "required": [ "deleted", "id", "object" ], "title": "RadarListDeletedListItem", "type": "object", "x-expandableFields": [], "x-resourceId": "deleted_radar.value_list_item", "x-stripeMostCommon": [ "deleted", "id", "object" ], "x-stripeResource": { "class_name": "DeletedValueListItem", "in_package": "Radar" } }, "deleted_subscription_item": { "description": "", "properties": { "deleted": { "description": "Always true for a deleted object", "enum": [ true ], "type": "boolean" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "subscription_item" ], "type": "string" } }, "required": [ "deleted", "id", "object" ], "title": "DeletedSubscriptionItem", "type": "object", "x-expandableFields": [], "x-resourceId": "deleted_subscription_item", "x-stripeMostCommon": [ "deleted", "id", "object" ], "x-stripeResource": { "class_name": "DeletedSubscriptionItem", "in_package": "" } }, "deleted_tax_id": { "description": "", "properties": { "deleted": { "description": "Always true for a deleted object", "enum": [ true ], "type": "boolean" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "tax_id" ], "type": "string" } }, "required": [ "deleted", "id", "object" ], "title": "deleted_tax_id", "type": "object", "x-expandableFields": [], "x-resourceId": "deleted_tax_id", "x-stripeMostCommon": [ "deleted", "id", "object" ], "x-stripeResource": { "class_name": "DeletedTaxId", "in_package": "" } }, "deleted_terminal.configuration": { "description": "", "properties": { "deleted": { "description": "Always true for a deleted object", "enum": [ true ], "type": "boolean" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "terminal.configuration" ], "type": "string" } }, "required": [ "deleted", "id", "object" ], "title": "TerminalConfigurationDeletedConfiguration", "type": "object", "x-expandableFields": [], "x-resourceId": "deleted_terminal.configuration", "x-stripeMostCommon": [ "deleted", "id", "object" ], "x-stripeResource": { "class_name": "DeletedConfiguration", "in_package": "Terminal" } }, "deleted_terminal.location": { "description": "", "properties": { "deleted": { "description": "Always true for a deleted object", "enum": [ true ], "type": "boolean" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "terminal.location" ], "type": "string" } }, "required": [ "deleted", "id", "object" ], "title": "TerminalLocationDeletedLocation", "type": "object", "x-expandableFields": [], "x-resourceId": "deleted_terminal.location", "x-stripeMostCommon": [ "deleted", "id", "object" ], "x-stripeResource": { "class_name": "DeletedLocation", "in_package": "Terminal" } }, "deleted_terminal.reader": { "description": "", "properties": { "deleted": { "description": "Always true for a deleted object", "enum": [ true ], "type": "boolean" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "terminal.reader" ], "type": "string" } }, "required": [ "deleted", "id", "object" ], "title": "TerminalReaderDeletedReader", "type": "object", "x-expandableFields": [], "x-resourceId": "deleted_terminal.reader", "x-stripeMostCommon": [ "deleted", "id", "object" ], "x-stripeResource": { "class_name": "DeletedReader", "in_package": "Terminal" } }, "deleted_test_helpers.test_clock": { "description": "", "properties": { "deleted": { "description": "Always true for a deleted object", "enum": [ true ], "type": "boolean" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "test_helpers.test_clock" ], "type": "string" } }, "required": [ "deleted", "id", "object" ], "title": "DeletedTestClock", "type": "object", "x-expandableFields": [], "x-resourceId": "deleted_test_helpers.test_clock", "x-stripeMostCommon": [ "deleted", "id", "object" ], "x-stripeResource": { "class_name": "DeletedTestClock", "in_package": "TestHelpers" } }, "deleted_webhook_endpoint": { "description": "", "properties": { "deleted": { "description": "Always true for a deleted object", "enum": [ true ], "type": "boolean" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "webhook_endpoint" ], "type": "string" } }, "required": [ "deleted", "id", "object" ], "title": "NotificationWebhookEndpointDeleted", "type": "object", "x-expandableFields": [], "x-resourceId": "deleted_webhook_endpoint", "x-stripeMostCommon": [ "deleted", "id", "object" ], "x-stripeResource": { "class_name": "DeletedWebhookEndpoint", "in_package": "" } }, "destination_details_unimplemented": { "description": "", "properties": {}, "title": "destination_details_unimplemented", "type": "object", "x-expandableFields": [] }, "discount": { "description": "A discount represents the actual application of a [coupon](https://stripe.com/docs/api#coupons) or [promotion code](https://stripe.com/docs/api#promotion_codes).\nIt contains information about when the discount began, when it will end, and what it is applied to.\n\nRelated guide: [Applying discounts to subscriptions](https://stripe.com/docs/billing/subscriptions/discounts)", "properties": { "checkout_session": { "description": "The Checkout session that this coupon is applied to, if it is applied to a particular session in payment mode. Will not be present for subscription mode.", "maxLength": 5000, "nullable": true, "type": "string" }, "coupon": { "$ref": "#/components/schemas/coupon" }, "customer": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/customer" }, { "$ref": "#/components/schemas/deleted_customer" } ], "description": "The ID of the customer associated with this discount.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/customer" }, { "$ref": "#/components/schemas/deleted_customer" } ] } }, "customer_account": { "description": "The ID of the account associated with this discount.", "maxLength": 5000, "nullable": true, "type": "string" }, "end": { "description": "If the coupon has a duration of `repeating`, the date that this discount will end. If the coupon has a duration of `once` or `forever`, this attribute will be null.", "format": "unix-time", "nullable": true, "type": "integer" }, "id": { "description": "The ID of the discount object. Discounts cannot be fetched by ID. Use `expand[]=discounts` in API calls to expand discount IDs in an array.", "maxLength": 5000, "type": "string" }, "invoice": { "description": "The invoice that the discount's coupon was applied to, if it was applied directly to a particular invoice.", "maxLength": 5000, "nullable": true, "type": "string" }, "invoice_item": { "description": "The invoice item `id` (or invoice line item `id` for invoice line items of type='subscription') that the discount's coupon was applied to, if it was applied directly to a particular invoice item or invoice line item.", "maxLength": 5000, "nullable": true, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "discount" ], "type": "string" }, "promotion_code": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/promotion_code" } ], "description": "The promotion code applied to create this discount.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/promotion_code" } ] } }, "start": { "description": "Date that the coupon was applied.", "format": "unix-time", "type": "integer" }, "subscription": { "description": "The subscription that this coupon is applied to, if it is applied to a particular subscription.", "maxLength": 5000, "nullable": true, "type": "string" }, "subscription_item": { "description": "The subscription item that this coupon is applied to, if it is applied to a particular subscription item.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "checkout_session", "coupon", "customer", "end", "id", "invoice", "invoice_item", "object", "promotion_code", "start", "subscription", "subscription_item" ], "title": "Discount", "type": "object", "x-expandableFields": [ "coupon", "customer", "promotion_code" ], "x-stripeMostCommon": [ "coupon", "customer", "end", "id", "start", "subscription" ], "x-stripeResource": { "class_name": "Discount", "in_package": "" } }, "discount_end": { "description": "", "properties": { "timestamp": { "description": "The discount end timestamp.", "format": "unix-time", "nullable": true, "type": "integer" }, "type": { "description": "The discount end type.", "enum": [ "timestamp" ], "type": "string" } }, "required": [ "timestamp", "type" ], "title": "DiscountEnd", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "timestamp", "type" ] }, "discounts_resource_discount_amount": { "description": "", "properties": { "amount": { "description": "The amount, in cents (or local equivalent), of the discount.", "type": "integer" }, "discount": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/discount" }, { "$ref": "#/components/schemas/deleted_discount" } ], "description": "The discount that was applied to get this discount amount.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/discount" }, { "$ref": "#/components/schemas/deleted_discount" } ] } } }, "required": [ "amount", "discount" ], "title": "DiscountsResourceDiscountAmount", "type": "object", "x-expandableFields": [ "discount" ], "x-stripeMostCommon": [ "amount", "discount" ] }, "discounts_resource_stackable_discount": { "description": "", "properties": { "coupon": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/coupon" } ], "description": "ID of the coupon to create a new discount for.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/coupon" } ] } }, "discount": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/discount" } ], "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/discount" } ] } }, "discount_end": { "anyOf": [ { "$ref": "#/components/schemas/discount_end" } ], "description": "Details to determine how long the discount should be applied for.", "nullable": true }, "promotion_code": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/promotion_code" } ], "description": "ID of the promotion code to create a new discount for.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/promotion_code" } ] } } }, "required": [ "coupon", "discount", "promotion_code" ], "title": "DiscountsResourceStackableDiscount", "type": "object", "x-expandableFields": [ "coupon", "discount", "discount_end", "promotion_code" ], "x-stripeMostCommon": [ "coupon", "discount", "promotion_code" ] }, "dispute": { "description": "A dispute occurs when a customer questions your charge with their card issuer.\nWhen this happens, you have the opportunity to respond to the dispute with\nevidence that shows that the charge is legitimate.\n\nRelated guide: [Disputes and fraud](https://stripe.com/docs/disputes)", "properties": { "amount": { "description": "Disputed amount. Usually the amount of the charge, but it can differ (usually because of currency fluctuation or because only part of the order is disputed).", "type": "integer" }, "balance_transactions": { "description": "List of zero, one, or two balance transactions that show funds withdrawn and reinstated to your Stripe account as a result of this dispute.", "items": { "$ref": "#/components/schemas/balance_transaction" }, "type": "array" }, "charge": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/charge" } ], "description": "ID of the charge that's disputed.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/charge" } ] } }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "enhanced_eligibility_types": { "description": "List of eligibility types that are included in `enhanced_evidence`.", "items": { "enum": [ "visa_compelling_evidence_3", "visa_compliance" ], "type": "string" }, "type": "array" }, "evidence": { "$ref": "#/components/schemas/dispute_evidence" }, "evidence_details": { "$ref": "#/components/schemas/dispute_evidence_details" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "is_charge_refundable": { "description": "If true, it's still possible to refund the disputed payment. After the payment has been fully refunded, no further funds are withdrawn from your Stripe account as a result of this dispute.", "type": "boolean" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "type": "object" }, "network_reason_code": { "description": "Network-dependent reason code for the dispute.", "maxLength": 5000, "nullable": true, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "dispute" ], "type": "string" }, "payment_intent": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/payment_intent" } ], "description": "ID of the PaymentIntent that's disputed.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/payment_intent" } ] } }, "payment_method_details": { "$ref": "#/components/schemas/dispute_payment_method_details" }, "reason": { "description": "Reason given by cardholder for dispute. Possible values are `bank_cannot_process`, `check_returned`, `credit_not_processed`, `customer_initiated`, `debit_not_authorized`, `duplicate`, `fraudulent`, `general`, `incorrect_account_details`, `insufficient_funds`, `noncompliant`, `product_not_received`, `product_unacceptable`, `subscription_canceled`, or `unrecognized`. Learn more about [dispute reasons](https://stripe.com/docs/disputes/categories).", "maxLength": 5000, "type": "string" }, "smart_disputes": { "$ref": "#/components/schemas/dispute_smart_disputes" }, "status": { "description": "The current status of a dispute. Possible values include:`warning_needs_response`, `warning_under_review`, `warning_closed`, `needs_response`, `under_review`, `won`, `lost`, or `prevented`.", "enum": [ "lost", "needs_response", "under_review", "warning_closed", "warning_needs_response", "warning_under_review", "won" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "amount", "balance_transactions", "charge", "created", "currency", "enhanced_eligibility_types", "evidence", "evidence_details", "id", "is_charge_refundable", "livemode", "metadata", "object", "payment_intent", "reason", "status" ], "title": "Dispute", "type": "object", "x-expandableFields": [ "balance_transactions", "charge", "evidence", "evidence_details", "payment_intent", "payment_method_details", "smart_disputes" ], "x-resourceId": "dispute", "x-stripeMostCommon": [ "amount", "charge", "currency", "evidence", "id", "metadata", "payment_intent", "reason", "status" ], "x-stripeOperations": [ { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/disputes" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/disputes/{dispute}" }, { "method_name": "update", "method_on": "service", "method_type": "update", "operation": "post", "path": "/v1/disputes/{dispute}" }, { "method_name": "close", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/disputes/{dispute}/close" } ], "x-stripeResource": { "class_name": "Dispute", "has_collection_class": true, "in_package": "", "polymorphic_groups": [ "balance_transaction_source" ] } }, "dispute_enhanced_eligibility": { "description": "", "properties": { "visa_compelling_evidence_3": { "$ref": "#/components/schemas/dispute_enhanced_eligibility_visa_compelling_evidence3" }, "visa_compliance": { "$ref": "#/components/schemas/dispute_enhanced_eligibility_visa_compliance" } }, "title": "DisputeEnhancedEligibility", "type": "object", "x-expandableFields": [ "visa_compelling_evidence_3", "visa_compliance" ], "x-stripeMostCommon": [ "visa_compelling_evidence_3", "visa_compliance" ] }, "dispute_enhanced_eligibility_visa_compelling_evidence3": { "description": "", "properties": { "required_actions": { "description": "List of actions required to qualify dispute for Visa Compelling Evidence 3.0 evidence submission.", "items": { "enum": [ "missing_customer_identifiers", "missing_disputed_transaction_description", "missing_merchandise_or_services", "missing_prior_undisputed_transaction_description", "missing_prior_undisputed_transactions" ], "type": "string" }, "type": "array" }, "status": { "description": "Visa Compelling Evidence 3.0 eligibility status.", "enum": [ "not_qualified", "qualified", "requires_action" ], "type": "string" } }, "required": [ "required_actions", "status" ], "title": "DisputeEnhancedEligibilityVisaCompellingEvidence3", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "required_actions", "status" ] }, "dispute_enhanced_eligibility_visa_compliance": { "description": "", "properties": { "status": { "description": "Visa compliance eligibility status.", "enum": [ "fee_acknowledged", "requires_fee_acknowledgement" ], "type": "string" } }, "required": [ "status" ], "title": "DisputeEnhancedEligibilityVisaCompliance", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "status" ] }, "dispute_enhanced_evidence": { "description": "", "properties": { "visa_compelling_evidence_3": { "$ref": "#/components/schemas/dispute_enhanced_evidence_visa_compelling_evidence3" }, "visa_compliance": { "$ref": "#/components/schemas/dispute_enhanced_evidence_visa_compliance" } }, "title": "DisputeEnhancedEvidence", "type": "object", "x-expandableFields": [ "visa_compelling_evidence_3", "visa_compliance" ], "x-stripeMostCommon": [ "visa_compelling_evidence_3", "visa_compliance" ] }, "dispute_enhanced_evidence_visa_compelling_evidence3": { "description": "", "properties": { "disputed_transaction": { "anyOf": [ { "$ref": "#/components/schemas/dispute_visa_compelling_evidence3_disputed_transaction" } ], "description": "Disputed transaction details for Visa Compelling Evidence 3.0 evidence submission.", "nullable": true }, "prior_undisputed_transactions": { "description": "List of exactly two prior undisputed transaction objects for Visa Compelling Evidence 3.0 evidence submission.", "items": { "$ref": "#/components/schemas/dispute_visa_compelling_evidence3_prior_undisputed_transaction" }, "type": "array" } }, "required": [ "disputed_transaction", "prior_undisputed_transactions" ], "title": "DisputeEnhancedEvidenceVisaCompellingEvidence3", "type": "object", "x-expandableFields": [ "disputed_transaction", "prior_undisputed_transactions" ], "x-stripeMostCommon": [ "disputed_transaction", "prior_undisputed_transactions" ] }, "dispute_enhanced_evidence_visa_compliance": { "description": "", "properties": { "fee_acknowledged": { "description": "A field acknowledging the fee incurred when countering a Visa compliance dispute. If this field is set to true, evidence can be submitted for the compliance dispute. Stripe collects a 500 USD (or local equivalent) amount to cover the network costs associated with resolving compliance disputes. Stripe refunds the 500 USD network fee if you win the dispute.", "type": "boolean" } }, "required": [ "fee_acknowledged" ], "title": "DisputeEnhancedEvidenceVisaCompliance", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "fee_acknowledged" ] }, "dispute_evidence": { "description": "", "properties": { "access_activity_log": { "description": "Any server or activity logs showing proof that the customer accessed or downloaded the purchased digital product. This information should include IP addresses, corresponding timestamps, and any detailed recorded activity.", "maxLength": 150000, "nullable": true, "type": "string" }, "billing_address": { "description": "The billing address provided by the customer.", "maxLength": 5000, "nullable": true, "type": "string" }, "cancellation_policy": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/file" } ], "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Your subscription cancellation policy, as shown to the customer.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/file" } ] } }, "cancellation_policy_disclosure": { "description": "An explanation of how and when the customer was shown your refund policy prior to purchase.", "maxLength": 150000, "nullable": true, "type": "string" }, "cancellation_rebuttal": { "description": "A justification for why the customer's subscription was not canceled.", "maxLength": 150000, "nullable": true, "type": "string" }, "customer_communication": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/file" } ], "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any communication with the customer that you feel is relevant to your case. Examples include emails proving that the customer received the product or service, or demonstrating their use of or satisfaction with the product or service.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/file" } ] } }, "customer_email_address": { "description": "The email address of the customer.", "maxLength": 5000, "nullable": true, "type": "string" }, "customer_name": { "description": "The name of the customer.", "maxLength": 5000, "nullable": true, "type": "string" }, "customer_purchase_ip": { "description": "The IP address that the customer used when making the purchase.", "maxLength": 5000, "nullable": true, "type": "string" }, "customer_signature": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/file" } ], "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) A relevant document or contract showing the customer's signature.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/file" } ] } }, "duplicate_charge_documentation": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/file" } ], "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Documentation for the prior charge that can uniquely identify the charge, such as a receipt, shipping label, work order, etc. This document should be paired with a similar document from the disputed payment that proves the two payments are separate.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/file" } ] } }, "duplicate_charge_explanation": { "description": "An explanation of the difference between the disputed charge versus the prior charge that appears to be a duplicate.", "maxLength": 150000, "nullable": true, "type": "string" }, "duplicate_charge_id": { "description": "The Stripe ID for the prior charge which appears to be a duplicate of the disputed charge.", "maxLength": 5000, "nullable": true, "type": "string" }, "enhanced_evidence": { "$ref": "#/components/schemas/dispute_enhanced_evidence" }, "product_description": { "description": "A description of the product or service that was sold.", "maxLength": 150000, "nullable": true, "type": "string" }, "receipt": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/file" } ], "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any receipt or message sent to the customer notifying them of the charge.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/file" } ] } }, "refund_policy": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/file" } ], "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Your refund policy, as shown to the customer.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/file" } ] } }, "refund_policy_disclosure": { "description": "Documentation demonstrating that the customer was shown your refund policy prior to purchase.", "maxLength": 150000, "nullable": true, "type": "string" }, "refund_refusal_explanation": { "description": "A justification for why the customer is not entitled to a refund.", "maxLength": 150000, "nullable": true, "type": "string" }, "service_date": { "description": "The date on which the customer received or began receiving the purchased service, in a clear human-readable format.", "maxLength": 5000, "nullable": true, "type": "string" }, "service_documentation": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/file" } ], "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Documentation showing proof that a service was provided to the customer. This could include a copy of a signed contract, work order, or other form of written agreement.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/file" } ] } }, "shipping_address": { "description": "The address to which a physical product was shipped. You should try to include as complete address information as possible.", "maxLength": 5000, "nullable": true, "type": "string" }, "shipping_carrier": { "description": "The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc. If multiple carriers were used for this purchase, please separate them with commas.", "maxLength": 5000, "nullable": true, "type": "string" }, "shipping_date": { "description": "The date on which a physical product began its route to the shipping address, in a clear human-readable format.", "maxLength": 5000, "nullable": true, "type": "string" }, "shipping_documentation": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/file" } ], "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Documentation showing proof that a product was shipped to the customer at the same address the customer provided to you. This could include a copy of the shipment receipt, shipping label, etc. It should show the customer's full shipping address, if possible.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/file" } ] } }, "shipping_tracking_number": { "description": "The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.", "maxLength": 5000, "nullable": true, "type": "string" }, "uncategorized_file": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/file" } ], "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any additional evidence or statements.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/file" } ] } }, "uncategorized_text": { "description": "Any additional evidence or statements.", "maxLength": 150000, "nullable": true, "type": "string" } }, "required": [ "access_activity_log", "billing_address", "cancellation_policy", "cancellation_policy_disclosure", "cancellation_rebuttal", "customer_communication", "customer_email_address", "customer_name", "customer_purchase_ip", "customer_signature", "duplicate_charge_documentation", "duplicate_charge_explanation", "duplicate_charge_id", "enhanced_evidence", "product_description", "receipt", "refund_policy", "refund_policy_disclosure", "refund_refusal_explanation", "service_date", "service_documentation", "shipping_address", "shipping_carrier", "shipping_date", "shipping_documentation", "shipping_tracking_number", "uncategorized_file", "uncategorized_text" ], "title": "DisputeEvidence", "type": "object", "x-expandableFields": [ "cancellation_policy", "customer_communication", "customer_signature", "duplicate_charge_documentation", "enhanced_evidence", "receipt", "refund_policy", "service_documentation", "shipping_documentation", "uncategorized_file" ], "x-stripeMostCommon": [ "access_activity_log", "billing_address", "cancellation_policy", "cancellation_policy_disclosure", "cancellation_rebuttal", "customer_communication", "customer_email_address", "customer_name", "customer_purchase_ip", "customer_signature", "duplicate_charge_documentation", "duplicate_charge_explanation", "duplicate_charge_id", "enhanced_evidence", "product_description", "receipt", "refund_policy", "refund_policy_disclosure", "refund_refusal_explanation", "service_date", "service_documentation", "shipping_address", "shipping_carrier", "shipping_date", "shipping_documentation", "shipping_tracking_number", "uncategorized_file", "uncategorized_text" ] }, "dispute_evidence_details": { "description": "", "properties": { "due_by": { "description": "Date by which evidence must be submitted in order to successfully challenge dispute. Will be 0 if the customer's bank or credit card company doesn't allow a response for this particular dispute.", "format": "unix-time", "nullable": true, "type": "integer" }, "enhanced_eligibility": { "$ref": "#/components/schemas/dispute_enhanced_eligibility" }, "has_evidence": { "description": "Whether evidence has been staged for this dispute.", "type": "boolean" }, "past_due": { "description": "Whether the last evidence submission was submitted past the due date. Defaults to `false` if no evidence submissions have occurred. If `true`, then delivery of the latest evidence is *not* guaranteed.", "type": "boolean" }, "submission_count": { "description": "The number of times evidence has been submitted. Typically, you may only submit evidence once.", "type": "integer" }, "submission_method": { "description": "Whether the dispute was submitted manually, with Smart Disputes, or not submitted.", "enum": [ "manual", "not_submitted", "smart_disputes" ], "type": "string" } }, "required": [ "due_by", "enhanced_eligibility", "has_evidence", "past_due", "submission_count" ], "title": "DisputeEvidenceDetails", "type": "object", "x-expandableFields": [ "enhanced_eligibility" ], "x-stripeMostCommon": [ "due_by", "enhanced_eligibility", "has_evidence", "past_due", "submission_count", "submission_method" ] }, "dispute_payment_method_details": { "description": "", "properties": { "amazon_pay": { "$ref": "#/components/schemas/dispute_payment_method_details_amazon_pay" }, "card": { "$ref": "#/components/schemas/dispute_payment_method_details_card" }, "klarna": { "$ref": "#/components/schemas/dispute_payment_method_details_klarna" }, "paypal": { "$ref": "#/components/schemas/dispute_payment_method_details_paypal" }, "type": { "description": "Payment method type.", "enum": [ "amazon_pay", "card", "klarna", "paypal" ], "type": "string" } }, "required": [ "type" ], "title": "DisputePaymentMethodDetails", "type": "object", "x-expandableFields": [ "amazon_pay", "card", "klarna", "paypal" ], "x-stripeMostCommon": [ "amazon_pay", "card", "klarna", "paypal", "type" ] }, "dispute_payment_method_details_amazon_pay": { "description": "", "properties": { "dispute_type": { "description": "The AmazonPay dispute type, chargeback or claim", "enum": [ "chargeback", "claim" ], "nullable": true, "type": "string" } }, "required": [ "dispute_type" ], "title": "DisputePaymentMethodDetailsAmazonPay", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "dispute_type" ] }, "dispute_payment_method_details_card": { "description": "", "properties": { "brand": { "description": "Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`.", "maxLength": 5000, "type": "string" }, "case_type": { "description": "The type of dispute opened. Different case types may have varying fees and financial impact.", "enum": [ "block", "chargeback", "compliance", "inquiry", "resolution" ], "type": "string" }, "network_reason_code": { "description": "The card network's specific dispute reason code, which maps to one of Stripe's primary dispute categories to simplify response guidance. The [Network code map](https://stripe.com/docs/disputes/categories#network-code-map) lists all available dispute reason codes by network.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "brand", "case_type", "network_reason_code" ], "title": "DisputePaymentMethodDetailsCard", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "brand", "case_type", "network_reason_code" ] }, "dispute_payment_method_details_klarna": { "description": "", "properties": { "chargeback_loss_reason_code": { "description": "Chargeback loss reason mapped by Stripe from Klarna's chargeback loss reason", "maxLength": 5000, "type": "string" }, "reason_code": { "description": "The reason for the dispute as defined by Klarna", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "reason_code" ], "title": "DisputePaymentMethodDetailsKlarna", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "chargeback_loss_reason_code", "reason_code" ] }, "dispute_payment_method_details_paypal": { "description": "", "properties": { "case_id": { "description": "The ID of the dispute in PayPal.", "maxLength": 5000, "nullable": true, "type": "string" }, "reason_code": { "description": "The reason for the dispute as defined by PayPal", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "case_id", "reason_code" ], "title": "DisputePaymentMethodDetailsPaypal", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "case_id", "reason_code" ] }, "dispute_smart_disputes": { "description": "", "properties": { "recommended_evidence": { "description": "Evidence that could be provided to improve the SmartDisputes packet", "items": { "maxLength": 5000, "type": "string" }, "nullable": true, "type": "array" }, "status": { "description": "Smart Disputes auto representment packet availability status.", "enum": [ "available", "processing", "requires_evidence", "unavailable" ], "type": "string" } }, "required": [ "recommended_evidence", "status" ], "title": "DisputeSmartDisputes", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "recommended_evidence", "status" ] }, "dispute_transaction_shipping_address": { "description": "", "properties": { "city": { "description": "City, district, suburb, town, or village.", "maxLength": 5000, "nullable": true, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "nullable": true, "type": "string" }, "line1": { "description": "Address line 1 (e.g., street, PO Box, or company name).", "maxLength": 5000, "nullable": true, "type": "string" }, "line2": { "description": "Address line 2 (e.g., apartment, suite, unit, or building).", "maxLength": 5000, "nullable": true, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "nullable": true, "type": "string" }, "state": { "description": "State, county, province, or region.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "city", "country", "line1", "line2", "postal_code", "state" ], "title": "DisputeTransactionShippingAddress", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state" ] }, "dispute_visa_compelling_evidence3_disputed_transaction": { "description": "", "properties": { "customer_account_id": { "description": "User Account ID used to log into business platform. Must be recognizable by the user.", "maxLength": 5000, "nullable": true, "type": "string" }, "customer_device_fingerprint": { "description": "Unique identifier of the cardholder’s device derived from a combination of at least two hardware and software attributes. Must be at least 20 characters.", "maxLength": 5000, "nullable": true, "type": "string" }, "customer_device_id": { "description": "Unique identifier of the cardholder’s device such as a device serial number (e.g., International Mobile Equipment Identity [IMEI]). Must be at least 15 characters.", "maxLength": 5000, "nullable": true, "type": "string" }, "customer_email_address": { "description": "The email address of the customer.", "maxLength": 5000, "nullable": true, "type": "string" }, "customer_purchase_ip": { "description": "The IP address that the customer used when making the purchase.", "maxLength": 5000, "nullable": true, "type": "string" }, "merchandise_or_services": { "description": "Categorization of disputed payment.", "enum": [ "merchandise", "services" ], "nullable": true, "type": "string" }, "product_description": { "description": "A description of the product or service that was sold.", "maxLength": 150000, "nullable": true, "type": "string" }, "shipping_address": { "anyOf": [ { "$ref": "#/components/schemas/dispute_transaction_shipping_address" } ], "description": "The address to which a physical product was shipped. All fields are required for Visa Compelling Evidence 3.0 evidence submission.", "nullable": true } }, "required": [ "customer_account_id", "customer_device_fingerprint", "customer_device_id", "customer_email_address", "customer_purchase_ip", "merchandise_or_services", "product_description", "shipping_address" ], "title": "DisputeVisaCompellingEvidence3DisputedTransaction", "type": "object", "x-expandableFields": [ "shipping_address" ], "x-stripeMostCommon": [ "customer_account_id", "customer_device_fingerprint", "customer_device_id", "customer_email_address", "customer_purchase_ip", "merchandise_or_services", "product_description", "shipping_address" ] }, "dispute_visa_compelling_evidence3_prior_undisputed_transaction": { "description": "", "properties": { "charge": { "description": "Stripe charge ID for the Visa Compelling Evidence 3.0 eligible prior charge.", "maxLength": 5000, "type": "string" }, "customer_account_id": { "description": "User Account ID used to log into business platform. Must be recognizable by the user.", "maxLength": 5000, "nullable": true, "type": "string" }, "customer_device_fingerprint": { "description": "Unique identifier of the cardholder’s device derived from a combination of at least two hardware and software attributes. Must be at least 20 characters.", "maxLength": 5000, "nullable": true, "type": "string" }, "customer_device_id": { "description": "Unique identifier of the cardholder’s device such as a device serial number (e.g., International Mobile Equipment Identity [IMEI]). Must be at least 15 characters.", "maxLength": 5000, "nullable": true, "type": "string" }, "customer_email_address": { "description": "The email address of the customer.", "maxLength": 5000, "nullable": true, "type": "string" }, "customer_purchase_ip": { "description": "The IP address that the customer used when making the purchase.", "maxLength": 5000, "nullable": true, "type": "string" }, "product_description": { "description": "A description of the product or service that was sold.", "maxLength": 150000, "nullable": true, "type": "string" }, "shipping_address": { "anyOf": [ { "$ref": "#/components/schemas/dispute_transaction_shipping_address" } ], "description": "The address to which a physical product was shipped. All fields are required for Visa Compelling Evidence 3.0 evidence submission.", "nullable": true } }, "required": [ "charge", "customer_account_id", "customer_device_fingerprint", "customer_device_id", "customer_email_address", "customer_purchase_ip", "product_description", "shipping_address" ], "title": "DisputeVisaCompellingEvidence3PriorUndisputedTransaction", "type": "object", "x-expandableFields": [ "shipping_address" ], "x-stripeMostCommon": [ "charge", "customer_account_id", "customer_device_fingerprint", "customer_device_id", "customer_email_address", "customer_purchase_ip", "product_description", "shipping_address" ] }, "email_sent": { "description": "", "properties": { "email_sent_at": { "description": "The timestamp when the email was sent.", "format": "unix-time", "type": "integer" }, "email_sent_to": { "description": "The recipient's email address.", "maxLength": 5000, "type": "string" } }, "required": [ "email_sent_at", "email_sent_to" ], "title": "EmailSent", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "email_sent_at", "email_sent_to" ] }, "entitlements.active_entitlement": { "description": "An active entitlement describes access to a feature for a customer.", "properties": { "feature": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/entitlements.feature" } ], "description": "The [Feature](https://stripe.com/docs/api/entitlements/feature) that the customer is entitled to.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/entitlements.feature" } ] } }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "lookup_key": { "description": "A unique key you provide as your own system identifier. This may be up to 80 characters.", "maxLength": 5000, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "entitlements.active_entitlement" ], "type": "string" } }, "required": [ "feature", "id", "livemode", "lookup_key", "object" ], "title": "ActiveEntitlement", "type": "object", "x-expandableFields": [ "feature" ], "x-resourceId": "entitlements.active_entitlement", "x-stripeMostCommon": [ "feature", "id", "lookup_key" ], "x-stripeOperations": [ { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/entitlements/active_entitlements" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/entitlements/active_entitlements/{id}" } ], "x-stripeResource": { "class_name": "ActiveEntitlement", "has_collection_class": true, "in_package": "Entitlements" } }, "entitlements.active_entitlement_summary": { "description": "A summary of a customer's active entitlements.", "properties": { "customer": { "description": "The customer that is entitled to this feature.", "maxLength": 5000, "type": "string" }, "entitlements": { "description": "The list of entitlements this customer has.", "properties": { "data": { "items": { "$ref": "#/components/schemas/entitlements.active_entitlement" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "EntitlementsResourceCustomerEntitlementList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "entitlements.active_entitlement_summary" ], "type": "string" } }, "required": [ "customer", "entitlements", "livemode", "object" ], "title": "ActiveEntitlementSummary", "type": "object", "x-expandableFields": [ "entitlements" ], "x-stripeMostCommon": [ "customer", "entitlements" ], "x-stripeResource": { "class_name": "ActiveEntitlementSummary", "in_package": "Entitlements" } }, "entitlements.active_entitlement_summary.updated": { "description": "Occurs whenever a customer's entitlements change.", "properties": { "object": { "$ref": "#/components/schemas/entitlements.active_entitlement_summary" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "entitlements.active_entitlement_summary.updated" } }, "entitlements.feature": { "description": "A feature represents a monetizable ability or functionality in your system.\nFeatures can be assigned to products, and when those products are purchased, Stripe will create an entitlement to the feature for the purchasing customer.", "properties": { "active": { "description": "Inactive features cannot be attached to new products and will not be returned from the features list endpoint.", "type": "boolean" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "lookup_key": { "description": "A unique key you provide as your own system identifier. This may be up to 80 characters.", "maxLength": 5000, "type": "string" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "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.", "type": "object" }, "name": { "description": "The feature's name, for your own purpose, not meant to be displayable to the customer.", "maxLength": 80, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "entitlements.feature" ], "type": "string" } }, "required": [ "active", "id", "livemode", "lookup_key", "metadata", "name", "object" ], "title": "Feature", "type": "object", "x-expandableFields": [], "x-resourceId": "entitlements.feature", "x-stripeMostCommon": [ "id", "lookup_key", "metadata", "name" ], "x-stripeOperations": [ { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/entitlements/features" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/entitlements/features/{id}" }, { "method_name": "create", "method_on": "service", "method_type": "create", "operation": "post", "path": "/v1/entitlements/features" }, { "method_name": "update", "method_on": "service", "method_type": "update", "operation": "post", "path": "/v1/entitlements/features/{id}" } ], "x-stripeResource": { "class_name": "Feature", "has_collection_class": true, "in_package": "Entitlements" } }, "ephemeral_key": { "description": "", "properties": { "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "expires": { "description": "Time at which the key will expire. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "ephemeral_key" ], "type": "string" }, "secret": { "description": "The key's secret. You can use this value to make authorized requests to the Stripe API.", "maxLength": 5000, "type": "string" } }, "required": [ "created", "expires", "id", "livemode", "object" ], "title": "EphemeralKey", "type": "object", "x-expandableFields": [], "x-resourceId": "ephemeral_key", "x-stripeMostCommon": [ "created", "expires", "id", "livemode", "object" ], "x-stripeOperations": [ { "method_name": "delete", "method_on": "service", "method_type": "delete", "operation": "delete", "path": "/v1/ephemeral_keys/{key}" }, { "method_name": "create", "method_on": "service", "method_type": "create", "operation": "post", "path": "/v1/ephemeral_keys" } ], "x-stripeResource": { "class_name": "EphemeralKey", "in_package": "" } }, "error": { "description": "An error response from the Stripe API", "properties": { "error": { "$ref": "#/components/schemas/api_errors" } }, "required": [ "error" ], "type": "object", "x-stripeResource": { "class_name": "StripeErrorResponse", "in_package": "" } }, "event": { "description": "Snapshot events allow you to track and react to activity in your Stripe integration. When\nthe state of another API resource changes, Stripe creates an `Event` object that contains\nall the relevant information associated with that action, including the affected API\nresource. For example, a successful payment triggers a `charge.succeeded` event, which\ncontains the `Charge` in the event's data property. Some actions trigger multiple events.\nFor example, if you create a new subscription for a customer, it triggers both a\n`customer.subscription.created` event and a `charge.succeeded` event.\n\nConfigure an event destination in your account to listen for events that represent actions\nyour integration needs to respond to. Additionally, you can retrieve an individual event or\na list of events from the API.\n\n[Connect](https://docs.stripe.com/connect) platforms can also receive event notifications\nthat occur in their connected accounts. These events include an account attribute that\nidentifies the relevant connected account.\n\nYou can access events through the [Retrieve Event API](https://docs.stripe.com/api/events#retrieve_event)\nfor 30 days.", "properties": { "account": { "description": "The connected account that originates the event.", "maxLength": 5000, "type": "string" }, "api_version": { "description": "The Stripe API version used to render `data` when the event was created. The contents of `data` never change, so this value remains static regardless of the API version currently in use. This property is populated only for events created on or after October 31, 2014.", "maxLength": 5000, "nullable": true, "type": "string" }, "context": { "description": "Authentication context needed to fetch the event or related object.", "maxLength": 5000, "type": "string" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "data": { "$ref": "#/components/schemas/notification_event_data" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "event" ], "type": "string" }, "pending_webhooks": { "description": "Number of webhooks that haven't been successfully delivered (for example, to return a 20x response) to the URLs you specify.", "type": "integer" }, "reason": { "anyOf": [ { "$ref": "#/components/schemas/notification_event_reason" } ], "description": "Information about the action that causes the event. Only present when the event is triggered by an API request or an [Automation](https://docs.stripe.com/billing/automations) action.", "nullable": true }, "request": { "anyOf": [ { "$ref": "#/components/schemas/notification_event_request" } ], "description": "Information on the API request that triggers the event.", "nullable": true }, "type": { "description": "Description of the event (for example, `invoice.created` or `charge.refunded`).", "enum": [ "account.application.authorized", "account.application.deauthorized", "account.external_account.created", "account.external_account.deleted", "account.external_account.updated", "account.updated", "account_notice.created", "account_notice.updated", "application_fee.created", "application_fee.refund.updated", "application_fee.refunded", "balance.available", "balance_settings.updated", "billing.alert.triggered", "billing_portal.configuration.created", "billing_portal.configuration.updated", "billing_portal.session.created", "capability.updated", "capital.financing_offer.accepted", "capital.financing_offer.canceled", "capital.financing_offer.created", "capital.financing_offer.expired", "capital.financing_offer.fully_repaid", "capital.financing_offer.paid_out", "capital.financing_offer.rejected", "capital.financing_offer.replacement_created", "capital.financing_transaction.created", "cash_balance.funds_available", "charge.captured", "charge.dispute.closed", "charge.dispute.created", "charge.dispute.funds_reinstated", "charge.dispute.funds_withdrawn", "charge.dispute.updated", "charge.expired", "charge.failed", "charge.pending", "charge.refund.updated", "charge.refunded", "charge.succeeded", "charge.updated", "checkout.session.async_payment_failed", "checkout.session.async_payment_succeeded", "checkout.session.completed", "checkout.session.expired", "climate.order.canceled", "climate.order.created", "climate.order.delayed", "climate.order.delivered", "climate.order.product_substituted", "climate.product.created", "climate.product.pricing_updated", "coupon.created", "coupon.deleted", "coupon.updated", "credit_note.created", "credit_note.updated", "credit_note.voided", "customer.created", "customer.deleted", "customer.discount.created", "customer.discount.deleted", "customer.discount.updated", "customer.source.created", "customer.source.deleted", "customer.source.expiring", "customer.source.updated", "customer.subscription.collection_paused", "customer.subscription.collection_resumed", "customer.subscription.created", "customer.subscription.custom_event", "customer.subscription.deleted", "customer.subscription.paused", "customer.subscription.pending_update_applied", "customer.subscription.pending_update_expired", "customer.subscription.price_migration_failed", "customer.subscription.resumed", "customer.subscription.trial_will_end", "customer.subscription.updated", "customer.tax_id.created", "customer.tax_id.deleted", "customer.tax_id.updated", "customer.updated", "customer_cash_balance_transaction.created", "entitlements.active_entitlement_summary.updated", "file.created", "financial_connections.account.created", "financial_connections.account.deactivated", "financial_connections.account.disconnected", "financial_connections.account.reactivated", "financial_connections.account.refreshed_balance", "financial_connections.account.refreshed_inferred_balances", "financial_connections.account.refreshed_ownership", "financial_connections.account.refreshed_transactions", "financial_connections.session.updated", "fx_quote.expired", "identity.verification_session.canceled", "identity.verification_session.created", "identity.verification_session.processing", "identity.verification_session.redacted", "identity.verification_session.requires_input", "identity.verification_session.verified", "invoice.created", "invoice.deleted", "invoice.finalization_failed", "invoice.finalized", "invoice.marked_uncollectible", "invoice.overdue", "invoice.overpaid", "invoice.paid", "invoice.payment.overpaid", "invoice.payment_action_required", "invoice.payment_attempt_required", "invoice.payment_failed", "invoice.payment_succeeded", "invoice.sent", "invoice.upcoming", "invoice.updated", "invoice.voided", "invoice.will_be_due", "invoice_payment.paid", "invoiceitem.created", "invoiceitem.deleted", "issuing_authorization.created", "issuing_authorization.request", "issuing_authorization.updated", "issuing_card.created", "issuing_card.updated", "issuing_cardholder.created", "issuing_cardholder.updated", "issuing_dispute.closed", "issuing_dispute.created", "issuing_dispute.funds_reinstated", "issuing_dispute.funds_rescinded", "issuing_dispute.submitted", "issuing_dispute.updated", "issuing_dispute_settlement_detail.created", "issuing_dispute_settlement_detail.updated", "issuing_fraud_liability_debit.created", "issuing_personalization_design.activated", "issuing_personalization_design.deactivated", "issuing_personalization_design.rejected", "issuing_personalization_design.updated", "issuing_settlement.created", "issuing_settlement.updated", "issuing_token.created", "issuing_token.updated", "issuing_transaction.created", "issuing_transaction.purchase_details_receipt_updated", "issuing_transaction.updated", "mandate.updated", "payment_intent.amount_capturable_updated", "payment_intent.canceled", "payment_intent.created", "payment_intent.partially_funded", "payment_intent.payment_failed", "payment_intent.processing", "payment_intent.requires_action", "payment_intent.succeeded", "payment_link.created", "payment_link.updated", "payment_method.attached", "payment_method.automatically_updated", "payment_method.detached", "payment_method.updated", "payout.canceled", "payout.created", "payout.failed", "payout.paid", "payout.reconciliation_completed", "payout.updated", "person.created", "person.deleted", "person.updated", "plan.created", "plan.deleted", "plan.updated", "price.created", "price.deleted", "price.updated", "privacy.redaction_job.canceled", "privacy.redaction_job.created", "privacy.redaction_job.ready", "privacy.redaction_job.succeeded", "privacy.redaction_job.validation_error", "product.created", "product.deleted", "product.updated", "promotion_code.created", "promotion_code.updated", "quote.accept_failed", "quote.accepted", "quote.accepting", "quote.canceled", "quote.created", "quote.draft", "quote.finalized", "quote.reestimate_failed", "quote.reestimated", "quote.stale", "radar.early_fraud_warning.created", "radar.early_fraud_warning.updated", "refund.created", "refund.failed", "refund.updated", "reporting.report_run.failed", "reporting.report_run.succeeded", "reporting.report_type.updated", "review.closed", "review.opened", "setup_intent.canceled", "setup_intent.created", "setup_intent.requires_action", "setup_intent.setup_failed", "setup_intent.succeeded", "sigma.scheduled_query_run.created", "source.canceled", "source.chargeable", "source.failed", "source.mandate_notification", "source.refund_attributes_required", "source.transaction.created", "source.transaction.updated", "subscription_schedule.aborted", "subscription_schedule.canceled", "subscription_schedule.completed", "subscription_schedule.created", "subscription_schedule.expiring", "subscription_schedule.price_migration_failed", "subscription_schedule.released", "subscription_schedule.updated", "tax.form.updated", "tax.settings.updated", "tax_rate.created", "tax_rate.updated", "terminal.reader.action_failed", "terminal.reader.action_succeeded", "terminal.reader.action_updated", "test_helpers.test_clock.advancing", "test_helpers.test_clock.created", "test_helpers.test_clock.deleted", "test_helpers.test_clock.internal_failure", "test_helpers.test_clock.ready", "topup.canceled", "topup.created", "topup.failed", "topup.reversed", "topup.succeeded", "transfer.created", "transfer.reversed", "transfer.updated", "treasury.credit_reversal.created", "treasury.credit_reversal.posted", "treasury.debit_reversal.completed", "treasury.debit_reversal.created", "treasury.debit_reversal.initial_credit_granted", "treasury.financial_account.closed", "treasury.financial_account.created", "treasury.financial_account.features_status_updated", "treasury.inbound_transfer.canceled", "treasury.inbound_transfer.created", "treasury.inbound_transfer.failed", "treasury.inbound_transfer.succeeded", "treasury.outbound_payment.canceled", "treasury.outbound_payment.created", "treasury.outbound_payment.expected_arrival_date_updated", "treasury.outbound_payment.failed", "treasury.outbound_payment.posted", "treasury.outbound_payment.returned", "treasury.outbound_payment.tracking_details_updated", "treasury.outbound_transfer.canceled", "treasury.outbound_transfer.created", "treasury.outbound_transfer.expected_arrival_date_updated", "treasury.outbound_transfer.failed", "treasury.outbound_transfer.posted", "treasury.outbound_transfer.returned", "treasury.outbound_transfer.tracking_details_updated", "treasury.received_credit.created", "treasury.received_credit.failed", "treasury.received_credit.succeeded", "treasury.received_debit.created" ], "maxLength": 5000, "type": "string" } }, "required": [ "api_version", "created", "data", "id", "livemode", "object", "pending_webhooks", "request", "type" ], "title": "NotificationEvent", "type": "object", "x-expandableFields": [ "data", "reason", "request" ], "x-resourceId": "event", "x-stripeMostCommon": [ "api_version", "data", "id", "request", "type" ], "x-stripeOperations": [ { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/events" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/events/{id}" } ], "x-stripeResource": { "class_name": "Event", "has_collection_class": true, "in_package": "" } }, "exchange_rate": { "description": "`ExchangeRate` objects allow you to determine the rates that Stripe is currently\nusing to convert from one currency to another. Since this number is variable\nthroughout the day, there are various reasons why you might want to know the current\nrate (for example, to dynamically price an item for a user with a default\npayment in a foreign currency).\n\nPlease refer to our [Exchange Rates API](https://stripe.com/docs/fx-rates) guide for more details.\n\n*[Note: this integration path is supported but no longer recommended]* Additionally,\nyou can guarantee that a charge is made with an exchange rate that you expect is\ncurrent. To do so, you must pass in the exchange_rate to charges endpoints. If the\nvalue is no longer up to date, the charge won't go through. Please refer to our\n[Using with charges](https://stripe.com/docs/exchange-rates) guide for more details.\n\n-----\n\n \n\n*This Exchange Rates API is a Beta Service and is subject to Stripe's terms of service. You may use the API solely for the purpose of transacting on Stripe. For example, the API may be queried in order to:*\n\n- *localize prices for processing payments on Stripe*\n- *reconcile Stripe transactions*\n- *determine how much money to send to a connected account*\n- *determine app fees to charge a connected account*\n\n*Using this Exchange Rates API beta for any purpose other than to transact on Stripe is strictly prohibited and constitutes a violation of Stripe's terms of service.*", "properties": { "id": { "description": "Unique identifier for the object. Represented as the three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) in lowercase.", "maxLength": 5000, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "exchange_rate" ], "type": "string" }, "rates": { "additionalProperties": { "type": "number" }, "description": "Hash where the keys are supported currencies and the values are the exchange rate at which the base id currency converts to the key currency.", "type": "object" } }, "required": [ "id", "object", "rates" ], "title": "ExchangeRate", "type": "object", "x-expandableFields": [], "x-resourceId": "exchange_rate", "x-stripeMostCommon": [ "id", "rates" ], "x-stripeOperations": [ { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/exchange_rates" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/exchange_rates/{rate_id}" } ], "x-stripeResource": { "class_name": "ExchangeRate", "has_collection_class": true, "in_package": "" } }, "external_account": { "anyOf": [ { "$ref": "#/components/schemas/bank_account" }, { "$ref": "#/components/schemas/card" } ], "title": "Polymorphic", "x-resourceId": "external_account", "x-stripeBypassValidation": true, "x-stripeOperations": [ { "method_name": "delete", "method_on": "service", "method_type": "delete", "operation": "delete", "path": "/v1/accounts/{account}/external_accounts/{id}" }, { "method_name": "delete", "method_on": "service", "method_type": "delete", "operation": "delete", "path": "/v1/external_accounts/{id}" }, { "method_name": "list", "method_on": "collection", "method_type": "list", "operation": "get", "path": "/v1/accounts/{account}/external_accounts" }, { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/accounts/{account}/external_accounts" }, { "method_name": "retrieve", "method_on": "collection", "method_type": "retrieve", "operation": "get", "path": "/v1/accounts/{account}/external_accounts/{id}" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/accounts/{account}/external_accounts/{id}" }, { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/external_accounts" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/external_accounts/{id}" }, { "method_name": "create", "method_on": "collection", "method_type": "create", "operation": "post", "path": "/v1/accounts/{account}/external_accounts" }, { "method_name": "create", "method_on": "service", "method_type": "create", "operation": "post", "path": "/v1/accounts/{account}/external_accounts" }, { "method_name": "update", "method_on": "service", "method_type": "update", "operation": "post", "path": "/v1/accounts/{account}/external_accounts/{id}" }, { "method_name": "create", "method_on": "service", "method_type": "create", "operation": "post", "path": "/v1/external_accounts" }, { "method_name": "update", "method_on": "service", "method_type": "update", "operation": "post", "path": "/v1/external_accounts/{id}" } ], "x-stripeResource": { "class_name": "ExternalAccount", "has_collection_class": true } }, "external_account_requirements": { "description": "", "properties": { "currently_due": { "description": "Fields that need to be collected to keep the external account enabled. If not collected by `current_deadline`, these fields appear in `past_due` as well, and the account is disabled.", "items": { "maxLength": 5000, "type": "string" }, "nullable": true, "type": "array" }, "errors": { "description": "Fields that are `currently_due` and need to be collected again because validation or verification failed.", "items": { "$ref": "#/components/schemas/account_requirements_error" }, "nullable": true, "type": "array" }, "past_due": { "description": "Fields that weren't collected by `current_deadline`. These fields need to be collected to enable the external account.", "items": { "maxLength": 5000, "type": "string" }, "nullable": true, "type": "array" }, "pending_verification": { "description": "Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. Fields might appear in `eventually_due`, `currently_due`, or `past_due` and in `pending_verification` if verification fails but another verification is still pending.", "items": { "maxLength": 5000, "type": "string" }, "nullable": true, "type": "array" } }, "required": [ "currently_due", "errors", "past_due", "pending_verification" ], "title": "ExternalAccountRequirements", "type": "object", "x-expandableFields": [ "errors" ], "x-stripeMostCommon": [ "currently_due", "errors", "past_due", "pending_verification" ] }, "fee": { "description": "", "properties": { "amount": { "description": "Amount of the fee, in cents.", "type": "integer" }, "application": { "description": "ID of the Connect application that earned the fee.", "maxLength": 5000, "nullable": true, "type": "string" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users.", "maxLength": 5000, "nullable": true, "type": "string" }, "type": { "description": "Type of the fee, one of: `application_fee`, `payment_method_passthrough_fee`, `stripe_fee` or `tax`.", "maxLength": 5000, "type": "string" } }, "required": [ "amount", "application", "currency", "description", "type" ], "title": "Fee", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "amount", "application", "currency", "description", "type" ] }, "fee_refund": { "description": "`Application Fee Refund` objects allow you to refund an application fee that\nhas previously been created but not yet refunded. Funds will be refunded to\nthe Stripe account from which the fee was originally collected.\n\nRelated guide: [Refunding application fees](https://stripe.com/docs/connect/destination-charges#refunding-app-fee)", "properties": { "amount": { "description": "Amount, in cents (or local equivalent).", "type": "integer" }, "balance_transaction": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/balance_transaction" } ], "description": "Balance transaction that describes the impact on your account balance.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/balance_transaction" } ] } }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "fee": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/application_fee" } ], "description": "ID of the application fee that was refunded.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/application_fee" } ] } }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "nullable": true, "type": "object" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "fee_refund" ], "type": "string" } }, "required": [ "amount", "balance_transaction", "created", "currency", "fee", "id", "metadata", "object" ], "title": "FeeRefund", "type": "object", "x-expandableFields": [ "balance_transaction", "fee" ], "x-resourceId": "fee_refund", "x-stripeMostCommon": [ "amount", "currency", "fee", "id", "metadata" ], "x-stripeOperations": [ { "method_name": "retrieve", "method_on": "collection", "method_type": "retrieve", "operation": "get", "path": "/v1/application_fees/{fee}/refunds/{id}" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/application_fees/{fee}/refunds/{id}" }, { "method_name": "list", "method_on": "collection", "method_type": "list", "operation": "get", "path": "/v1/application_fees/{id}/refunds" }, { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/application_fees/{id}/refunds" }, { "method_name": "update", "method_on": "service", "method_type": "update", "operation": "post", "path": "/v1/application_fees/{fee}/refunds/{id}" }, { "method_name": "create", "method_on": "collection", "method_type": "create", "operation": "post", "path": "/v1/application_fees/{id}/refunds" }, { "method_name": "create", "method_on": "service", "method_type": "create", "operation": "post", "path": "/v1/application_fees/{id}/refunds" } ], "x-stripeResource": { "class_name": "FeeRefund", "has_collection_class": true, "in_package": "", "polymorphic_groups": [ "balance_transaction_source" ] } }, "file": { "description": "This object represents files hosted on Stripe's servers. You can upload\nfiles with the [create file](https://stripe.com/docs/api#create_file) request\n(for example, when uploading dispute evidence). Stripe also\ncreates files independently (for example, the results of a [Sigma scheduled\nquery](#scheduled_queries)).\n\nRelated guide: [File upload guide](https://stripe.com/docs/file-upload)", "properties": { "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "expires_at": { "description": "The file expires and isn't available at this time in epoch seconds.", "format": "unix-time", "nullable": true, "type": "integer" }, "filename": { "description": "The suitable name for saving the file to a filesystem.", "maxLength": 5000, "nullable": true, "type": "string" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "links": { "description": "A list of [file links](https://stripe.com/docs/api#file_links) that point at this file.", "nullable": true, "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/file_link" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/file_links", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "FileResourceFileLinkList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "file" ], "type": "string" }, "purpose": { "description": "The [purpose](https://stripe.com/docs/file-upload#uploading-a-file) of the uploaded file.", "enum": [ "account_requirement", "additional_verification", "business_icon", "business_logo", "customer_signature", "dispute_evidence", "document_provider_identity_document", "finance_report_run", "financial_account_statement", "identity_document", "identity_document_downloadable", "issuing_regulatory_reporting", "pci_document", "selfie", "sigma_scheduled_query", "tax_document_user_upload", "terminal_android_apk", "terminal_reader_splashscreen" ], "type": "string", "x-stripeBypassValidation": true }, "size": { "description": "The size of the file object in bytes.", "type": "integer" }, "title": { "description": "A suitable title for the document.", "maxLength": 5000, "nullable": true, "type": "string" }, "type": { "description": "The returned file type (for example, `csv`, `pdf`, `jpg`, or `png`).", "maxLength": 5000, "nullable": true, "type": "string" }, "url": { "description": "Use your live secret API key to download the file from this URL.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "created", "expires_at", "filename", "id", "object", "purpose", "size", "title", "type", "url" ], "title": "File", "type": "object", "x-expandableFields": [ "links" ], "x-resourceId": "file", "x-stripeMostCommon": [ "id", "purpose", "type" ], "x-stripeOperations": [ { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/files" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/files/{file}" }, { "method_name": "create", "method_on": "service", "method_type": "create", "operation": "post", "path": "/v1/files" } ], "x-stripeResource": { "class_name": "File", "has_collection_class": true, "in_package": "" } }, "file.created": { "description": "Occurs whenever a new Stripe-generated file is available for your account.", "properties": { "object": { "$ref": "#/components/schemas/file" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "file.created" } }, "file_link": { "description": "To share the contents of a `File` object with non-Stripe users, you can\ncreate a `FileLink`. `FileLink`s contain a URL that you can use to\nretrieve the contents of the file without authentication.", "properties": { "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "expired": { "description": "Returns if the link is already expired.", "type": "boolean" }, "expires_at": { "description": "Time that the link expires.", "format": "unix-time", "nullable": true, "type": "integer" }, "file": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/file" } ], "description": "The file object this link points to.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/file" } ] } }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "type": "object" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "file_link" ], "type": "string" }, "url": { "description": "The publicly accessible URL to download the file.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "created", "expired", "expires_at", "file", "id", "livemode", "metadata", "object", "url" ], "title": "FileLink", "type": "object", "x-expandableFields": [ "file" ], "x-resourceId": "file_link", "x-stripeMostCommon": [ "expires_at", "file", "id", "metadata", "url" ], "x-stripeOperations": [ { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/file_links" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/file_links/{link}" }, { "method_name": "create", "method_on": "service", "method_type": "create", "operation": "post", "path": "/v1/file_links" }, { "method_name": "update", "method_on": "service", "method_type": "update", "operation": "post", "path": "/v1/file_links/{link}" } ], "x-stripeResource": { "class_name": "FileLink", "has_collection_class": true, "in_package": "" } }, "financial_connections.account": { "description": "A Financial Connections Account represents an account that exists outside of Stripe, to which you have been granted some degree of access.", "properties": { "account_holder": { "anyOf": [ { "$ref": "#/components/schemas/bank_connections_resource_accountholder" } ], "description": "The account holder that this account belongs to.", "nullable": true }, "balance": { "anyOf": [ { "$ref": "#/components/schemas/bank_connections_resource_balance" } ], "description": "The most recent information about the account's balance.", "nullable": true }, "balance_refresh": { "anyOf": [ { "$ref": "#/components/schemas/bank_connections_resource_balance_refresh" } ], "description": "The state of the most recent attempt to refresh the account balance.", "nullable": true }, "category": { "description": "The type of the account. Account category is further divided in `subcategory`.", "enum": [ "cash", "credit", "investment", "other" ], "type": "string" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "display_name": { "description": "A human-readable name that has been assigned to this account, either by the account holder or by the institution.", "maxLength": 5000, "nullable": true, "type": "string" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "inferred_balances_refresh": { "anyOf": [ { "$ref": "#/components/schemas/bank_connections_resource_inferred_balances_refresh" } ], "description": "The state of the most recent attempt to refresh the account's inferred balance history.", "nullable": true }, "institution": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/financial_connections.institution" } ], "description": "The ID of the Financial Connections Institution this account belongs to. Note that this relationship may sometimes change in rare circumstances (e.g. institution mergers).", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/financial_connections.institution" } ] } }, "institution_name": { "description": "The name of the institution that holds this account.", "maxLength": 5000, "type": "string" }, "last4": { "description": "The last 4 digits of the account number. If present, this will be 4 numeric characters.", "maxLength": 5000, "nullable": true, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "financial_connections.account" ], "type": "string" }, "ownership": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/financial_connections.account_ownership" } ], "description": "The most recent information about the account's owners.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/financial_connections.account_ownership" } ] } }, "ownership_refresh": { "anyOf": [ { "$ref": "#/components/schemas/bank_connections_resource_ownership_refresh" } ], "description": "The state of the most recent attempt to refresh the account owners.", "nullable": true }, "permissions": { "description": "The list of permissions granted by this account.", "items": { "enum": [ "balances", "ownership", "payment_method", "transactions" ], "type": "string" }, "nullable": true, "type": "array" }, "status": { "description": "The status of the link to the account.", "enum": [ "active", "disconnected", "inactive" ], "type": "string" }, "subcategory": { "description": "If `category` is `cash`, one of:\n\n - `checking`\n - `savings`\n - `other`\n\nIf `category` is `credit`, one of:\n\n - `mortgage`\n - `line_of_credit`\n - `credit_card`\n - `other`\n\nIf `category` is `investment` or `other`, this will be `other`.", "enum": [ "checking", "credit_card", "line_of_credit", "mortgage", "other", "savings" ], "type": "string" }, "subscriptions": { "description": "The list of data refresh subscriptions requested on this account.", "items": { "enum": [ "balance", "inferred_balances", "transactions" ], "type": "string", "x-stripeBypassValidation": true }, "nullable": true, "type": "array" }, "supported_payment_method_types": { "description": "The [PaymentMethod type](https://stripe.com/docs/api/payment_methods/object#payment_method_object-type)(s) that can be created from this account.", "items": { "enum": [ "link", "us_bank_account" ], "type": "string", "x-stripeBypassValidation": true }, "type": "array" }, "transaction_refresh": { "anyOf": [ { "$ref": "#/components/schemas/bank_connections_resource_transaction_refresh" } ], "description": "The state of the most recent attempt to refresh the account transactions.", "nullable": true } }, "required": [ "account_holder", "balance", "balance_refresh", "category", "created", "display_name", "id", "institution_name", "last4", "livemode", "object", "ownership", "ownership_refresh", "permissions", "status", "subcategory", "subscriptions", "supported_payment_method_types", "transaction_refresh" ], "title": "BankConnectionsResourceLinkedAccount", "type": "object", "x-expandableFields": [ "account_holder", "balance", "balance_refresh", "inferred_balances_refresh", "institution", "ownership", "ownership_refresh", "transaction_refresh" ], "x-resourceId": "financial_connections.account", "x-stripeMostCommon": [ "account_holder", "balance", "balance_refresh", "category", "created", "display_name", "id", "inferred_balances_refresh", "institution", "institution_name", "last4", "livemode", "object", "ownership", "ownership_refresh", "permissions", "status", "subcategory", "subscriptions", "supported_payment_method_types", "transaction_refresh" ], "x-stripeOperations": [ { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/financial_connections/accounts" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/financial_connections/accounts/{account}" }, { "method_name": "list_owners", "method_on": "service", "method_type": "custom", "operation": "get", "path": "/v1/financial_connections/accounts/{account}/owners" }, { "method_name": "disconnect", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/financial_connections/accounts/{account}/disconnect" }, { "method_name": "refresh", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/financial_connections/accounts/{account}/refresh" }, { "method_name": "subscribe", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/financial_connections/accounts/{account}/subscribe" }, { "method_name": "unsubscribe", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/financial_connections/accounts/{account}/unsubscribe" } ], "x-stripeResource": { "class_name": "Account", "has_collection_class": true, "in_package": "FinancialConnections" } }, "financial_connections.account.created": { "description": "Occurs when a new Financial Connections account is created.", "properties": { "object": { "$ref": "#/components/schemas/financial_connections.account" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "financial_connections.account.created" } }, "financial_connections.account.deactivated": { "description": "Occurs when a Financial Connections account's status is updated from `active` to `inactive`.", "properties": { "object": { "$ref": "#/components/schemas/financial_connections.account" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "financial_connections.account.deactivated" } }, "financial_connections.account.disconnected": { "description": "Occurs when a Financial Connections account is disconnected.", "properties": { "object": { "$ref": "#/components/schemas/financial_connections.account" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "financial_connections.account.disconnected" } }, "financial_connections.account.reactivated": { "description": "Occurs when a Financial Connections account's status is updated from `inactive` to `active`.", "properties": { "object": { "$ref": "#/components/schemas/financial_connections.account" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "financial_connections.account.reactivated" } }, "financial_connections.account.refreshed_balance": { "description": "Occurs when an Account’s `balance_refresh` status transitions from `pending` to either `succeeded` or `failed`.", "properties": { "object": { "$ref": "#/components/schemas/financial_connections.account" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "financial_connections.account.refreshed_balance" } }, "financial_connections.account.refreshed_inferred_balances": { "description": "Occurs when an Account’s `inferred_balances_refresh` status transitions from `pending` to either `succeeded` or `failed`.", "properties": { "object": { "$ref": "#/components/schemas/financial_connections.account" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "financial_connections.account.refreshed_inferred_balances" } }, "financial_connections.account.refreshed_ownership": { "description": "Occurs when an Account’s `ownership_refresh` status transitions from `pending` to either `succeeded` or `failed`.", "properties": { "object": { "$ref": "#/components/schemas/financial_connections.account" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "financial_connections.account.refreshed_ownership" } }, "financial_connections.account.refreshed_transactions": { "description": "Occurs when an Account’s `transaction_refresh` status transitions from `pending` to either `succeeded` or `failed`.", "properties": { "object": { "$ref": "#/components/schemas/financial_connections.account" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "financial_connections.account.refreshed_transactions" } }, "financial_connections.account_inferred_balance": { "description": "A historical balance for the account on a particular day. It may be sourced from a balance snapshot provided by a financial institution, or inferred using transactions data.", "properties": { "as_of": { "description": "The time for which this balance was calculated, measured in seconds since the Unix epoch. If the balance was computed by Stripe and not provided directly by a financial institution, it will always be 23:59:59 UTC.", "format": "unix-time", "type": "integer" }, "current": { "additionalProperties": { "type": "integer" }, "description": "The balances owed to (or by) the account holder, before subtracting any outbound pending transactions or adding any inbound pending transactions.\n\nEach key is a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.\n\nEach value is a integer amount. A positive amount indicates money owed to the account holder. A negative amount indicates money owed by the account holder.", "type": "object" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "financial_connections.account_inferred_balance" ], "type": "string" } }, "required": [ "as_of", "current", "id", "object" ], "title": "BankConnectionsExternalResourcesInferredBalance", "type": "object", "x-expandableFields": [], "x-resourceId": "financial_connections.account_inferred_balance", "x-stripeMostCommon": [ "as_of", "current", "id" ], "x-stripeOperations": [ { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/financial_connections/accounts/{account}/inferred_balances" } ], "x-stripeResource": { "class_name": "AccountInferredBalance", "has_collection_class": true, "in_package": "FinancialConnections" } }, "financial_connections.account_owner": { "description": "Describes an owner of an account.", "properties": { "email": { "description": "The email address of the owner.", "maxLength": 5000, "nullable": true, "type": "string" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "name": { "description": "The full name of the owner.", "maxLength": 5000, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "financial_connections.account_owner" ], "type": "string" }, "ownership": { "description": "The ownership object that this owner belongs to.", "maxLength": 5000, "type": "string" }, "phone": { "description": "The raw phone number of the owner.", "maxLength": 5000, "nullable": true, "type": "string" }, "raw_address": { "description": "The raw physical address of the owner.", "maxLength": 5000, "nullable": true, "type": "string" }, "refreshed_at": { "description": "The timestamp of the refresh that updated this owner.", "format": "unix-time", "nullable": true, "type": "integer" } }, "required": [ "email", "id", "name", "object", "ownership", "phone", "raw_address", "refreshed_at" ], "title": "BankConnectionsResourceOwner", "type": "object", "x-expandableFields": [], "x-resourceId": "financial_connections.account_owner", "x-stripeMostCommon": [ "email", "id", "name", "object", "ownership", "phone", "raw_address", "refreshed_at" ], "x-stripeResource": { "class_name": "AccountOwner", "has_collection_class": true, "in_package": "FinancialConnections" } }, "financial_connections.account_ownership": { "description": "Describes a snapshot of the owners of an account at a particular point in time.", "properties": { "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "financial_connections.account_ownership" ], "type": "string" }, "owners": { "description": "A paginated list of owners for this account.", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/financial_connections.account_owner" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "BankConnectionsResourceOwnerList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } }, "required": [ "created", "id", "object", "owners" ], "title": "BankConnectionsResourceOwnership", "type": "object", "x-expandableFields": [ "owners" ], "x-stripeMostCommon": [ "created", "id", "object", "owners" ], "x-stripeResource": { "class_name": "AccountOwnership", "in_package": "FinancialConnections" } }, "financial_connections.institution": { "description": "An institution represents a financial institution to which an end user can connect using the Financial Connections authentication flow.", "properties": { "countries": { "description": "The list of countries supported by this institution, formatted as ISO country codes.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "features": { "$ref": "#/components/schemas/bank_connections_resource_institution_feature_support" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "name": { "description": "The name of this institution.", "maxLength": 5000, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "financial_connections.institution" ], "type": "string" }, "routing_numbers": { "description": "A list of routing numbers which are known to correspond to this institution. Due to the many to many relationship between institutions and routing numbers, this list may not be comprehensive and routing numbers may also be shared between institutions.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "status": { "description": "The status of this institution in the Financial Connections authentication flow.", "enum": [ "active", "degraded", "inactive" ], "type": "string" }, "url": { "description": "A URL corresponding to this institution. This URL is also displayed in the authentication flow to help end users confirm that they are authenticating with the right institution.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "countries", "features", "id", "livemode", "name", "object", "routing_numbers", "status", "url" ], "title": "BankConnectionsResourceExternalInstitution", "type": "object", "x-expandableFields": [ "features" ], "x-resourceId": "financial_connections.institution", "x-stripeMostCommon": [ "countries", "features", "id", "livemode", "name", "object", "routing_numbers", "status", "url" ], "x-stripeOperations": [ { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/financial_connections/institutions" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/financial_connections/institutions/{institution}" } ], "x-stripeResource": { "class_name": "Institution", "has_collection_class": true, "in_package": "FinancialConnections" } }, "financial_connections.session": { "description": "A Financial Connections Session is the secure way to programmatically launch the client-side Stripe.js modal that lets your users link their accounts.", "properties": { "account_holder": { "anyOf": [ { "$ref": "#/components/schemas/bank_connections_resource_accountholder" } ], "description": "The account holder for whom accounts are collected in this session.", "nullable": true }, "accounts": { "description": "The accounts that were collected as part of this Session.", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/financial_connections.account" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/financial_connections/accounts", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "BankConnectionsResourceLinkedAccountList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] }, "client_secret": { "description": "A value that will be passed to the client to launch the authentication flow.", "maxLength": 5000, "type": "string" }, "filters": { "$ref": "#/components/schemas/bank_connections_resource_link_account_session_filters" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "limits": { "$ref": "#/components/schemas/bank_connections_resource_link_account_session_limits" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "manual_entry": { "$ref": "#/components/schemas/bank_connections_resource_link_account_session_manual_entry" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "financial_connections.session" ], "type": "string" }, "permissions": { "description": "Permissions requested for accounts collected during this session.", "items": { "enum": [ "balances", "ownership", "payment_method", "transactions" ], "type": "string", "x-stripeBypassValidation": true }, "type": "array" }, "prefetch": { "description": "Data features requested to be retrieved upon account creation.", "items": { "enum": [ "balances", "inferred_balances", "ownership", "transactions" ], "type": "string", "x-stripeBypassValidation": true }, "nullable": true, "type": "array" }, "return_url": { "description": "For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.", "maxLength": 5000, "type": "string" }, "status": { "description": "The current state of the session.", "enum": [ "cancelled", "failed", "pending", "succeeded" ], "type": "string" }, "status_details": { "$ref": "#/components/schemas/bank_connections_resource_link_account_session_status_details" } }, "required": [ "account_holder", "accounts", "client_secret", "id", "livemode", "object", "permissions", "prefetch" ], "title": "BankConnectionsResourceLinkAccountSession", "type": "object", "x-expandableFields": [ "account_holder", "accounts", "filters", "limits", "manual_entry", "status_details" ], "x-resourceId": "financial_connections.session", "x-stripeMostCommon": [ "account_holder", "accounts", "client_secret", "filters", "id", "limits", "livemode", "manual_entry", "object", "permissions", "prefetch", "return_url", "status", "status_details" ], "x-stripeOperations": [ { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/financial_connections/sessions/{session}" }, { "method_name": "create", "method_on": "service", "method_type": "create", "operation": "post", "path": "/v1/financial_connections/sessions" } ], "x-stripeResource": { "class_name": "Session", "in_package": "FinancialConnections" } }, "financial_connections.session.updated": { "description": "Occurs when a Financial Connections Session `status` transitions from `pending` to `failed`, `cancelled`, or `completed`.", "properties": { "object": { "$ref": "#/components/schemas/financial_connections.session" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "financial_connections.session.updated" } }, "financial_connections.transaction": { "description": "A Transaction represents a real transaction that affects a Financial Connections Account balance.", "properties": { "account": { "description": "The ID of the Financial Connections Account this transaction belongs to.", "maxLength": 5000, "type": "string" }, "amount": { "description": "The amount of this transaction, in cents (or local equivalent).", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "maxLength": 5000, "type": "string" }, "description": { "description": "The description of this transaction.", "maxLength": 5000, "type": "string" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "financial_connections.transaction" ], "type": "string" }, "status": { "description": "The status of the transaction.", "enum": [ "pending", "posted", "void" ], "type": "string" }, "status_transitions": { "$ref": "#/components/schemas/bank_connections_resource_transaction_resource_status_transitions" }, "transacted_at": { "description": "Time at which the transaction was transacted. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "transaction_refresh": { "description": "The token of the transaction refresh that last updated or created this transaction.", "maxLength": 5000, "type": "string" }, "updated": { "description": "Time at which the object was last updated. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" } }, "required": [ "account", "amount", "currency", "description", "id", "livemode", "object", "status", "status_transitions", "transacted_at", "transaction_refresh", "updated" ], "title": "BankConnectionsResourceTransaction", "type": "object", "x-expandableFields": [ "status_transitions" ], "x-resourceId": "financial_connections.transaction", "x-stripeMostCommon": [ "account", "amount", "currency", "description", "id", "livemode", "object", "status", "status_transitions", "transacted_at", "transaction_refresh", "updated" ], "x-stripeOperations": [ { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/financial_connections/transactions" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/financial_connections/transactions/{transaction}" } ], "x-stripeResource": { "class_name": "Transaction", "has_collection_class": true, "in_package": "FinancialConnections" } }, "financial_reporting_finance_report_run_run_parameters": { "description": "", "properties": { "columns": { "description": "The set of output columns requested for inclusion in the report run.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "connected_account": { "description": "Connected account ID by which to filter the report run.", "maxLength": 5000, "type": "string" }, "currency": { "description": "Currency of objects to be included in the report run.", "format": "currency", "type": "string" }, "interval_end": { "description": "Ending timestamp of data to be included in the report run. Can be any UTC timestamp between 1 second after the user specified `interval_start` and 1 second before this report's last `data_available_end` value.", "format": "unix-time", "type": "integer" }, "interval_start": { "description": "Starting timestamp of data to be included in the report run. Can be any UTC timestamp between 1 second after this report's `data_available_start` and 1 second before the user specified `interval_end` value.", "format": "unix-time", "type": "integer" }, "payout": { "description": "Payout ID by which to filter the report run.", "maxLength": 5000, "type": "string" }, "reporting_category": { "description": "Category of balance transactions to be included in the report run.", "maxLength": 5000, "type": "string" }, "timezone": { "description": "Defaults to `Etc/UTC`. The output timezone for all timestamps in the report. A list of possible time zone values is maintained at the [IANA Time Zone Database](http://www.iana.org/time-zones). Has no effect on `interval_start` or `interval_end`.", "maxLength": 5000, "type": "string" } }, "title": "FinancialReportingFinanceReportRunRunParameters", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "columns", "connected_account", "currency", "interval_end", "interval_start", "payout", "reporting_category", "timezone" ] }, "forwarded_request_context": { "description": "Metadata about the forwarded request.", "properties": { "destination_duration": { "description": "The time it took in milliseconds for the destination endpoint to respond.", "type": "integer" }, "destination_ip_address": { "description": "The IP address of the destination.", "maxLength": 5000, "type": "string" } }, "required": [ "destination_duration", "destination_ip_address" ], "title": "ForwardedRequestContext", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "destination_duration", "destination_ip_address" ] }, "forwarded_request_details": { "description": "Details about the request forwarded to the destination endpoint.", "properties": { "body": { "description": "The body payload to send to the destination endpoint.", "maxLength": 5000, "type": "string" }, "headers": { "description": "The headers to include in the forwarded request. Can be omitted if no additional headers (excluding Stripe-generated ones such as the Content-Type header) should be included.", "items": { "$ref": "#/components/schemas/forwarded_request_header" }, "type": "array" }, "http_method": { "description": "The HTTP method used to call the destination endpoint.", "enum": [ "POST" ], "type": "string" } }, "required": [ "body", "headers", "http_method" ], "title": "ForwardedRequestDetails", "type": "object", "x-expandableFields": [ "headers" ], "x-stripeMostCommon": [ "body", "headers", "http_method" ] }, "forwarded_request_header": { "description": "Header data.", "properties": { "name": { "description": "The header name.", "maxLength": 5000, "type": "string" }, "value": { "description": "The header value.", "maxLength": 5000, "type": "string" } }, "required": [ "name", "value" ], "title": "ForwardedRequestHeader", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "name", "value" ] }, "forwarded_response_details": { "description": "Details about the response from the destination endpoint.", "properties": { "body": { "description": "The response body from the destination endpoint to Stripe.", "maxLength": 5000, "type": "string" }, "headers": { "description": "HTTP headers that the destination endpoint returned.", "items": { "$ref": "#/components/schemas/forwarded_request_header" }, "type": "array" }, "status": { "description": "The HTTP status code that the destination endpoint returned.", "type": "integer" } }, "required": [ "body", "headers", "status" ], "title": "ForwardedResponseDetails", "type": "object", "x-expandableFields": [ "headers" ], "x-stripeMostCommon": [ "body", "headers", "status" ] }, "forwarding.request": { "description": "Instructs Stripe to make a request on your behalf using the destination URL. The destination URL\nis activated by Stripe at the time of onboarding. Stripe verifies requests with your credentials\nprovided during onboarding, and injects card details from the payment_method into the request.\n\nStripe redacts all sensitive fields and headers, including authentication credentials and card numbers,\nbefore storing the request and response data in the forwarding Request object, which are subject to a\n30-day retention period.\n\nYou can provide a Stripe idempotency key to make sure that requests with the same key result in only one\noutbound request. The Stripe idempotency key provided should be unique and different from any idempotency\nkeys provided on the underlying third-party request.\n\nForwarding Requests are synchronous requests that return a response or time out according to\nStripe’s limits.\n\nRelated guide: [Forward card details to third-party API endpoints](https://docs.stripe.com/payments/forwarding).", "properties": { "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "nullable": true, "type": "object" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "forwarding.request" ], "type": "string" }, "payment_method": { "description": "The PaymentMethod to insert into the forwarded request. Forwarding previously consumed PaymentMethods is allowed.", "maxLength": 5000, "type": "string" }, "replacements": { "description": "The field kinds to be replaced in the forwarded request.", "items": { "enum": [ "card_cvc", "card_expiry", "card_number", "cardholder_name", "request_signature" ], "type": "string", "x-stripeBypassValidation": true }, "type": "array" }, "request_context": { "anyOf": [ { "$ref": "#/components/schemas/forwarded_request_context" } ], "description": "Context about the request from Stripe's servers to the destination endpoint.", "nullable": true }, "request_details": { "anyOf": [ { "$ref": "#/components/schemas/forwarded_request_details" } ], "description": "The request that was sent to the destination endpoint. We redact any sensitive fields.", "nullable": true }, "response_details": { "anyOf": [ { "$ref": "#/components/schemas/forwarded_response_details" } ], "description": "The response that the destination endpoint returned to us. We redact any sensitive fields.", "nullable": true }, "url": { "description": "The destination URL for the forwarded request. Must be supported by the config.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "created", "id", "livemode", "object", "payment_method", "replacements", "request_context", "request_details", "response_details", "url" ], "title": "ForwardingRequest", "type": "object", "x-expandableFields": [ "request_context", "request_details", "response_details" ], "x-resourceId": "forwarding.request", "x-stripeMostCommon": [ "created", "id", "livemode", "metadata", "object", "payment_method", "replacements", "request_context", "request_details", "response_details", "url" ], "x-stripeOperations": [ { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/forwarding/requests" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/forwarding/requests/{id}" }, { "method_name": "create", "method_on": "service", "method_type": "create", "operation": "post", "path": "/v1/forwarding/requests" } ], "x-stripeResource": { "class_name": "Request", "has_collection_class": true, "in_package": "Forwarding" } }, "funding_instructions": { "description": "Each customer has a [`balance`](https://stripe.com/docs/api/customers/object#customer_object-balance) that is\nautomatically applied to future invoices and payments using the `customer_balance` payment method.\nCustomers can fund this balance by initiating a bank transfer to any account in the\n`financial_addresses` field.\nRelated guide: [Customer balance funding instructions](https://stripe.com/docs/payments/customer-balance/funding-instructions)", "properties": { "bank_transfer": { "$ref": "#/components/schemas/funding_instructions_bank_transfer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "maxLength": 5000, "type": "string" }, "funding_type": { "description": "The `funding_type` of the returned instructions", "enum": [ "bank_transfer" ], "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "funding_instructions" ], "type": "string" } }, "required": [ "bank_transfer", "currency", "funding_type", "livemode", "object" ], "title": "CustomerBalanceFundingInstructionsCustomerBalanceFundingInstructions", "type": "object", "x-expandableFields": [ "bank_transfer" ], "x-resourceId": "funding_instructions", "x-stripeMostCommon": [ "bank_transfer", "currency", "funding_type" ], "x-stripeResource": { "class_name": "FundingInstructions", "in_package": "" } }, "funding_instructions_bank_transfer": { "description": "", "properties": { "country": { "description": "The country of the bank account to fund", "maxLength": 5000, "type": "string" }, "financial_addresses": { "description": "A list of financial addresses that can be used to fund a particular balance", "items": { "$ref": "#/components/schemas/funding_instructions_bank_transfer_financial_address" }, "type": "array" }, "type": { "description": "The bank_transfer type", "enum": [ "eu_bank_transfer", "jp_bank_transfer" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "country", "financial_addresses", "type" ], "title": "FundingInstructionsBankTransfer", "type": "object", "x-expandableFields": [ "financial_addresses" ], "x-stripeMostCommon": [ "country", "financial_addresses", "type" ], "x-stripeResource": { "class_name": "BankTransfer", "in_package": "" } }, "funding_instructions_bank_transfer_aba_record": { "description": "ABA Records contain U.S. bank account details per the ABA format.", "properties": { "account_holder_address": { "$ref": "#/components/schemas/address" }, "account_holder_name": { "description": "The account holder name", "maxLength": 5000, "type": "string" }, "account_number": { "description": "The ABA account number", "maxLength": 5000, "type": "string" }, "account_type": { "description": "The account type", "maxLength": 5000, "type": "string" }, "bank_address": { "$ref": "#/components/schemas/address" }, "bank_name": { "description": "The bank name", "maxLength": 5000, "type": "string" }, "routing_number": { "description": "The ABA routing number", "maxLength": 5000, "type": "string" } }, "required": [ "account_holder_address", "account_holder_name", "account_number", "account_type", "bank_address", "bank_name", "routing_number" ], "title": "FundingInstructionsBankTransferABARecord", "type": "object", "x-expandableFields": [ "account_holder_address", "bank_address" ], "x-stripeMostCommon": [ "account_holder_address", "account_holder_name", "account_number", "account_type", "bank_address", "bank_name", "routing_number" ], "x-stripeResource": { "class_name": "Aba", "in_package": "" } }, "funding_instructions_bank_transfer_financial_address": { "description": "FinancialAddresses contain identifying information that resolves to a FinancialAccount.", "properties": { "aba": { "$ref": "#/components/schemas/funding_instructions_bank_transfer_aba_record" }, "iban": { "$ref": "#/components/schemas/funding_instructions_bank_transfer_iban_record" }, "sort_code": { "$ref": "#/components/schemas/funding_instructions_bank_transfer_sort_code_record" }, "spei": { "$ref": "#/components/schemas/funding_instructions_bank_transfer_spei_record" }, "supported_networks": { "description": "The payment networks supported by this FinancialAddress", "items": { "enum": [ "ach", "bacs", "domestic_wire_us", "fps", "sepa", "spei", "swift", "zengin" ], "type": "string", "x-stripeBypassValidation": true }, "type": "array" }, "swift": { "$ref": "#/components/schemas/funding_instructions_bank_transfer_swift_record" }, "type": { "description": "The type of financial address", "enum": [ "aba", "iban", "sort_code", "spei", "swift", "zengin" ], "type": "string", "x-stripeBypassValidation": true }, "zengin": { "$ref": "#/components/schemas/funding_instructions_bank_transfer_zengin_record" } }, "required": [ "type" ], "title": "FundingInstructionsBankTransferFinancialAddress", "type": "object", "x-expandableFields": [ "aba", "iban", "sort_code", "spei", "swift", "zengin" ], "x-stripeMostCommon": [ "aba", "iban", "sort_code", "spei", "supported_networks", "swift", "type", "zengin" ] }, "funding_instructions_bank_transfer_iban_record": { "description": "Iban Records contain E.U. bank account details per the SEPA format.", "properties": { "account_holder_address": { "$ref": "#/components/schemas/address" }, "account_holder_name": { "description": "The name of the person or business that owns the bank account", "maxLength": 5000, "type": "string" }, "bank_address": { "$ref": "#/components/schemas/address" }, "bic": { "description": "The BIC/SWIFT code of the account.", "maxLength": 5000, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "iban": { "description": "The IBAN of the account.", "maxLength": 5000, "type": "string" } }, "required": [ "account_holder_address", "account_holder_name", "bank_address", "bic", "country", "iban" ], "title": "FundingInstructionsBankTransferIbanRecord", "type": "object", "x-expandableFields": [ "account_holder_address", "bank_address" ], "x-stripeMostCommon": [ "account_holder_address", "account_holder_name", "bank_address", "bic", "country", "iban" ] }, "funding_instructions_bank_transfer_sort_code_record": { "description": "Sort Code Records contain U.K. bank account details per the sort code format.", "properties": { "account_holder_address": { "$ref": "#/components/schemas/address" }, "account_holder_name": { "description": "The name of the person or business that owns the bank account", "maxLength": 5000, "type": "string" }, "account_number": { "description": "The account number", "maxLength": 5000, "type": "string" }, "bank_address": { "$ref": "#/components/schemas/address" }, "sort_code": { "description": "The six-digit sort code", "maxLength": 5000, "type": "string" } }, "required": [ "account_holder_address", "account_holder_name", "account_number", "bank_address", "sort_code" ], "title": "FundingInstructionsBankTransferSortCodeRecord", "type": "object", "x-expandableFields": [ "account_holder_address", "bank_address" ], "x-stripeMostCommon": [ "account_holder_address", "account_holder_name", "account_number", "bank_address", "sort_code" ], "x-stripeResource": { "class_name": "SortCodeRecords", "in_package": "" } }, "funding_instructions_bank_transfer_spei_record": { "description": "SPEI Records contain Mexico bank account details per the SPEI format.", "properties": { "account_holder_address": { "$ref": "#/components/schemas/address" }, "account_holder_name": { "description": "The account holder name", "maxLength": 5000, "type": "string" }, "bank_address": { "$ref": "#/components/schemas/address" }, "bank_code": { "description": "The three-digit bank code", "maxLength": 5000, "type": "string" }, "bank_name": { "description": "The short banking institution name", "maxLength": 5000, "type": "string" }, "clabe": { "description": "The CLABE number", "maxLength": 5000, "type": "string" } }, "required": [ "account_holder_address", "account_holder_name", "bank_address", "bank_code", "bank_name", "clabe" ], "title": "FundingInstructionsBankTransferSpeiRecord", "type": "object", "x-expandableFields": [ "account_holder_address", "bank_address" ], "x-stripeMostCommon": [ "account_holder_address", "account_holder_name", "bank_address", "bank_code", "bank_name", "clabe" ] }, "funding_instructions_bank_transfer_swift_record": { "description": "SWIFT Records contain U.S. bank account details per the SWIFT format.", "properties": { "account_holder_address": { "$ref": "#/components/schemas/address" }, "account_holder_name": { "description": "The account holder name", "maxLength": 5000, "type": "string" }, "account_number": { "description": "The account number", "maxLength": 5000, "type": "string" }, "account_type": { "description": "The account type", "maxLength": 5000, "type": "string" }, "bank_address": { "$ref": "#/components/schemas/address" }, "bank_name": { "description": "The bank name", "maxLength": 5000, "type": "string" }, "swift_code": { "description": "The SWIFT code", "maxLength": 5000, "type": "string" } }, "required": [ "account_holder_address", "account_holder_name", "account_number", "account_type", "bank_address", "bank_name", "swift_code" ], "title": "FundingInstructionsBankTransferSwiftRecord", "type": "object", "x-expandableFields": [ "account_holder_address", "bank_address" ], "x-stripeMostCommon": [ "account_holder_address", "account_holder_name", "account_number", "account_type", "bank_address", "bank_name", "swift_code" ] }, "funding_instructions_bank_transfer_zengin_record": { "description": "Zengin Records contain Japan bank account details per the Zengin format.", "properties": { "account_holder_address": { "$ref": "#/components/schemas/address" }, "account_holder_name": { "description": "The account holder name", "maxLength": 5000, "nullable": true, "type": "string" }, "account_number": { "description": "The account number", "maxLength": 5000, "nullable": true, "type": "string" }, "account_type": { "description": "The bank account type. In Japan, this can only be `futsu` or `toza`.", "maxLength": 5000, "nullable": true, "type": "string" }, "bank_address": { "$ref": "#/components/schemas/address" }, "bank_code": { "description": "The bank code of the account", "maxLength": 5000, "nullable": true, "type": "string" }, "bank_name": { "description": "The bank name of the account", "maxLength": 5000, "nullable": true, "type": "string" }, "branch_code": { "description": "The branch code of the account", "maxLength": 5000, "nullable": true, "type": "string" }, "branch_name": { "description": "The branch name of the account", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "account_holder_address", "account_holder_name", "account_number", "account_type", "bank_address", "bank_code", "bank_name", "branch_code", "branch_name" ], "title": "FundingInstructionsBankTransferZenginRecord", "type": "object", "x-expandableFields": [ "account_holder_address", "bank_address" ], "x-stripeMostCommon": [ "account_holder_address", "account_holder_name", "account_number", "account_type", "bank_address", "bank_code", "bank_name", "branch_code", "branch_name" ] }, "fx_quote": { "description": "The FX Quotes API provides three functions:\n- View Stripe's current exchange rate for any given currency pair.\n- Extend quoted rates for a 1-hour period or a 24-hour period, minimizing uncertainty from FX fluctuations.\n- Preview the FX fees Stripe will charge on your FX transaction, allowing you to anticipate specific settlement amounts before payment costs.\n\n[View the docs](/payments/currencies/localize-prices/fx-quotes-api)", "properties": { "created": { "description": "Time at which the quote was created, measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "lock_duration": { "description": "The duration the exchange rate quote remains valid from creation time. Allowed values are none, hour, and day. Note that for the test mode API available in alpha, you can request an extended quote, but it won't be usable for any transactions.", "enum": [ "day", "five_minutes", "hour", "none" ], "type": "string" }, "lock_expires_at": { "description": "Time at which the quote will expire, measured in seconds since the Unix epoch.\n\nIf lock_duration is set to ‘none’ this field will be set to null.", "format": "unix-time", "nullable": true, "type": "integer" }, "lock_status": { "description": "Lock status of the quote. Transitions from active to expired once past the lock_expires_at timestamp.\n\nCan return value none, active, or expired.", "enum": [ "active", "expired", "none" ], "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "fx_quote" ], "type": "string" }, "rates": { "additionalProperties": { "$ref": "#/components/schemas/fx_quote_rate" }, "description": "Information about the rates.", "type": "object" }, "to_currency": { "description": "The currency to convert into, typically this is the currency that you want to settle to your Stripe balance. Three-letter ISO currency code, in lowercase. Must be a supported currency.", "maxLength": 5000, "type": "string" }, "usage": { "$ref": "#/components/schemas/fx_quote_usage" } }, "required": [ "created", "id", "lock_duration", "lock_expires_at", "lock_status", "object", "rates", "to_currency", "usage" ], "title": "MerchantFXQuote", "type": "object", "x-expandableFields": [ "rates", "usage" ], "x-resourceId": "fx_quote", "x-stripeMostCommon": [ "id", "lock_duration", "rates", "to_currency" ], "x-stripeOperations": [ { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/fx_quotes" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/fx_quotes/{id}" }, { "method_name": "create", "method_on": "service", "method_type": "create", "operation": "post", "path": "/v1/fx_quotes" } ], "x-stripeResource": { "class_name": "FxQuote", "has_collection_class": true, "in_package": "" } }, "fx_quote.expired": { "description": "Occurs when FX Quote's lock_status field transitions to 'Expired'.", "properties": { "object": { "$ref": "#/components/schemas/fx_quote" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "fx_quote.expired" } }, "fx_quote_rate": { "description": "", "properties": { "exchange_rate": { "description": "The rate that includes the FX fee rate.", "type": "number" }, "rate_details": { "$ref": "#/components/schemas/fx_quote_rate_details" } }, "required": [ "exchange_rate", "rate_details" ], "title": "FXQuoteRate", "type": "object", "x-expandableFields": [ "rate_details" ], "x-stripeMostCommon": [ "exchange_rate", "rate_details" ] }, "fx_quote_rate_details": { "description": "", "properties": { "base_rate": { "description": "The rate for the currency pair.", "type": "number" }, "duration_premium": { "description": "The fee for locking the conversion rates.", "type": "number" }, "fx_fee_rate": { "description": "The FX fee for the currency pair.", "type": "number" }, "reference_rate": { "description": "A reference rate for the currency pair provided by the reference rate provider.", "nullable": true, "type": "number" }, "reference_rate_provider": { "description": "The reference rate provider.", "enum": [ "ecb" ], "nullable": true, "type": "string" } }, "required": [ "base_rate", "duration_premium", "fx_fee_rate", "reference_rate", "reference_rate_provider" ], "title": "FXQuoteRateDetails", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "base_rate", "duration_premium", "fx_fee_rate", "reference_rate", "reference_rate_provider" ] }, "fx_quote_usage": { "description": "", "properties": { "payment": { "anyOf": [ { "$ref": "#/components/schemas/fx_quote_usage_payment" } ], "description": "The details required to use an FX Quote for a payment", "nullable": true }, "transfer": { "anyOf": [ { "$ref": "#/components/schemas/fx_quote_usage_transfer" } ], "description": "The details required to use an FX Quote for a transfer", "nullable": true }, "type": { "description": "The transaction type for which the FX Quote will be used.\n\nCan be 'payment' or 'transfer'.", "enum": [ "payment", "transfer" ], "type": "string" } }, "required": [ "payment", "transfer", "type" ], "title": "FXQuoteUsage", "type": "object", "x-expandableFields": [ "payment", "transfer" ], "x-stripeMostCommon": [ "payment", "transfer", "type" ] }, "fx_quote_usage_payment": { "description": "", "properties": { "destination": { "description": "The Stripe account ID that the funds will be transferred to.\n\nThis field should match the account ID that would be used in the PaymentIntent’s transfer_data[destination] field.", "maxLength": 5000, "nullable": true, "type": "string" }, "on_behalf_of": { "description": "The Stripe account ID that these funds are intended for.\n\nThis field must match the account ID that would be used in the PaymentIntent’s on_behalf_of field.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "destination", "on_behalf_of" ], "title": "FXQuoteUsagePayment", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "destination", "on_behalf_of" ] }, "fx_quote_usage_transfer": { "description": "", "properties": { "destination": { "description": "The Stripe account ID that the funds will be transferred to.\n\nThis field should match the account ID that would be used in the Transfer’s destination field.", "maxLength": 5000, "type": "string" } }, "required": [ "destination" ], "title": "FXQuoteUsageTransfer", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "destination" ] }, "gelato_data_document_report_date_of_birth": { "description": "Point in Time", "properties": { "day": { "description": "Numerical day between 1 and 31.", "nullable": true, "type": "integer" }, "month": { "description": "Numerical month between 1 and 12.", "nullable": true, "type": "integer" }, "year": { "description": "The four-digit year.", "nullable": true, "type": "integer" } }, "required": [ "day", "month", "year" ], "title": "GelatoDataDocumentReportDateOfBirth", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "day", "month", "year" ] }, "gelato_data_document_report_expiration_date": { "description": "Point in Time", "properties": { "day": { "description": "Numerical day between 1 and 31.", "nullable": true, "type": "integer" }, "month": { "description": "Numerical month between 1 and 12.", "nullable": true, "type": "integer" }, "year": { "description": "The four-digit year.", "nullable": true, "type": "integer" } }, "required": [ "day", "month", "year" ], "title": "GelatoDataDocumentReportExpirationDate", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "day", "month", "year" ] }, "gelato_data_document_report_issued_date": { "description": "Point in Time", "properties": { "day": { "description": "Numerical day between 1 and 31.", "nullable": true, "type": "integer" }, "month": { "description": "Numerical month between 1 and 12.", "nullable": true, "type": "integer" }, "year": { "description": "The four-digit year.", "nullable": true, "type": "integer" } }, "required": [ "day", "month", "year" ], "title": "GelatoDataDocumentReportIssuedDate", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "day", "month", "year" ] }, "gelato_data_id_number_report_date": { "description": "Point in Time", "properties": { "day": { "description": "Numerical day between 1 and 31.", "nullable": true, "type": "integer" }, "month": { "description": "Numerical month between 1 and 12.", "nullable": true, "type": "integer" }, "year": { "description": "The four-digit year.", "nullable": true, "type": "integer" } }, "required": [ "day", "month", "year" ], "title": "GelatoDataIdNumberReportDate", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "day", "month", "year" ] }, "gelato_data_verified_outputs_date": { "description": "Point in Time", "properties": { "day": { "description": "Numerical day between 1 and 31.", "nullable": true, "type": "integer" }, "month": { "description": "Numerical month between 1 and 12.", "nullable": true, "type": "integer" }, "year": { "description": "The four-digit year.", "nullable": true, "type": "integer" } }, "required": [ "day", "month", "year" ], "title": "GelatoDataVerifiedOutputsDate", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "day", "month", "year" ] }, "gelato_document_report": { "description": "Result from a document check", "properties": { "address": { "anyOf": [ { "$ref": "#/components/schemas/address" } ], "description": "Address as it appears in the document.", "nullable": true }, "dob": { "anyOf": [ { "$ref": "#/components/schemas/gelato_data_document_report_date_of_birth" } ], "description": "Date of birth as it appears in the document.", "nullable": true }, "error": { "anyOf": [ { "$ref": "#/components/schemas/gelato_document_report_error" } ], "description": "Details on the verification error. Present when status is `unverified`.", "nullable": true }, "expiration_date": { "anyOf": [ { "$ref": "#/components/schemas/gelato_data_document_report_expiration_date" } ], "description": "Expiration date of the document.", "nullable": true }, "files": { "description": "Array of [File](https://stripe.com/docs/api/files) ids containing images for this document.", "items": { "maxLength": 5000, "type": "string" }, "nullable": true, "type": "array" }, "first_name": { "description": "First name as it appears in the document.", "maxLength": 5000, "nullable": true, "type": "string" }, "issued_date": { "anyOf": [ { "$ref": "#/components/schemas/gelato_data_document_report_issued_date" } ], "description": "Issued date of the document.", "nullable": true }, "issuing_country": { "description": "Issuing country of the document.", "maxLength": 5000, "nullable": true, "type": "string" }, "last_name": { "description": "Last name as it appears in the document.", "maxLength": 5000, "nullable": true, "type": "string" }, "number": { "description": "Document ID number.", "maxLength": 5000, "nullable": true, "type": "string" }, "sex": { "description": "Sex of the person in the document.", "enum": [ "[redacted]", "female", "male", "unknown" ], "nullable": true, "type": "string" }, "status": { "description": "Status of this `document` check.", "enum": [ "unverified", "verified" ], "type": "string", "x-stripeBypassValidation": true }, "type": { "description": "Type of the document.", "enum": [ "driving_license", "id_card", "passport" ], "nullable": true, "type": "string" }, "unparsed_place_of_birth": { "description": "Place of birth as it appears in the document.", "maxLength": 5000, "nullable": true, "type": "string" }, "unparsed_sex": { "description": "Sex as it appears in the document.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "address", "error", "files", "first_name", "issued_date", "issuing_country", "last_name", "status", "type" ], "title": "GelatoDocumentReport", "type": "object", "x-expandableFields": [ "address", "dob", "error", "expiration_date", "issued_date" ], "x-stripeMostCommon": [ "address", "dob", "error", "expiration_date", "files", "first_name", "issued_date", "issuing_country", "last_name", "number", "sex", "status", "type", "unparsed_place_of_birth", "unparsed_sex" ] }, "gelato_document_report_error": { "description": "", "properties": { "code": { "description": "A short machine-readable string giving the reason for the verification failure.", "enum": [ "document_expired", "document_type_not_supported", "document_unverified_other" ], "nullable": true, "type": "string", "x-stripeBypassValidation": true }, "reason": { "description": "A human-readable message giving the reason for the failure. These messages can be shown to your users.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "code", "reason" ], "title": "GelatoDocumentReportError", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "code", "reason" ] }, "gelato_email_report": { "description": "Result from a email check", "properties": { "email": { "description": "Email to be verified.", "maxLength": 5000, "nullable": true, "type": "string" }, "error": { "anyOf": [ { "$ref": "#/components/schemas/gelato_email_report_error" } ], "description": "Details on the verification error. Present when status is `unverified`.", "nullable": true }, "status": { "description": "Status of this `email` check.", "enum": [ "unverified", "verified" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "email", "error", "status" ], "title": "GelatoEmailReport", "type": "object", "x-expandableFields": [ "error" ], "x-stripeMostCommon": [ "email", "error", "status" ] }, "gelato_email_report_error": { "description": "", "properties": { "code": { "description": "A short machine-readable string giving the reason for the verification failure.", "enum": [ "email_unverified_other", "email_verification_declined" ], "nullable": true, "type": "string" }, "reason": { "description": "A human-readable message giving the reason for the failure. These messages can be shown to your users.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "code", "reason" ], "title": "GelatoEmailReportError", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "code", "reason" ] }, "gelato_id_number_report": { "description": "Result from an id_number check", "properties": { "dob": { "anyOf": [ { "$ref": "#/components/schemas/gelato_data_id_number_report_date" } ], "description": "Date of birth.", "nullable": true }, "error": { "anyOf": [ { "$ref": "#/components/schemas/gelato_id_number_report_error" } ], "description": "Details on the verification error. Present when status is `unverified`.", "nullable": true }, "first_name": { "description": "First name.", "maxLength": 5000, "nullable": true, "type": "string" }, "id_number": { "description": "ID number. When `id_number_type` is `us_ssn`, only the last 4 digits are present.", "maxLength": 5000, "nullable": true, "type": "string" }, "id_number_type": { "description": "Type of ID number.", "enum": [ "br_cpf", "sg_nric", "us_ssn" ], "nullable": true, "type": "string" }, "last_name": { "description": "Last name.", "maxLength": 5000, "nullable": true, "type": "string" }, "status": { "description": "Status of this `id_number` check.", "enum": [ "unverified", "verified" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "error", "first_name", "id_number_type", "last_name", "status" ], "title": "GelatoIdNumberReport", "type": "object", "x-expandableFields": [ "dob", "error" ], "x-stripeMostCommon": [ "dob", "error", "first_name", "id_number", "id_number_type", "last_name", "status" ] }, "gelato_id_number_report_error": { "description": "", "properties": { "code": { "description": "A short machine-readable string giving the reason for the verification failure.", "enum": [ "id_number_insufficient_document_data", "id_number_mismatch", "id_number_unverified_other" ], "nullable": true, "type": "string" }, "reason": { "description": "A human-readable message giving the reason for the failure. These messages can be shown to your users.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "code", "reason" ], "title": "GelatoIdNumberReportError", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "code", "reason" ] }, "gelato_phone_report": { "description": "Result from a phone check", "properties": { "error": { "anyOf": [ { "$ref": "#/components/schemas/gelato_phone_report_error" } ], "description": "Details on the verification error. Present when status is `unverified`.", "nullable": true }, "phone": { "description": "Phone to be verified.", "maxLength": 5000, "nullable": true, "type": "string" }, "status": { "description": "Status of this `phone` check.", "enum": [ "unverified", "verified" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "error", "phone", "status" ], "title": "GelatoPhoneReport", "type": "object", "x-expandableFields": [ "error" ], "x-stripeMostCommon": [ "error", "phone", "status" ] }, "gelato_phone_report_error": { "description": "", "properties": { "code": { "description": "A short machine-readable string giving the reason for the verification failure.", "enum": [ "phone_unverified_other", "phone_verification_declined" ], "nullable": true, "type": "string" }, "reason": { "description": "A human-readable message giving the reason for the failure. These messages can be shown to your users.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "code", "reason" ], "title": "GelatoPhoneReportError", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "code", "reason" ] }, "gelato_provided_details": { "description": "", "properties": { "email": { "description": "Email of user being verified", "maxLength": 5000, "type": "string" }, "phone": { "description": "Phone number of user being verified", "maxLength": 5000, "type": "string" } }, "title": "GelatoProvidedDetails", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "email", "phone" ] }, "gelato_related_person": { "description": "", "properties": { "account": { "description": "Token referencing the associated Account of the related Person resource.", "maxLength": 5000, "type": "string" }, "person": { "description": "Token referencing the related Person resource.", "maxLength": 5000, "type": "string" } }, "required": [ "account", "person" ], "title": "GelatoRelatedPerson", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "account", "person" ] }, "gelato_report_document_options": { "description": "", "properties": { "allowed_types": { "description": "Array of strings of allowed identity document types. If the provided identity document isn’t one of the allowed types, the verification check will fail with a document_type_not_allowed error code.", "items": { "enum": [ "driving_license", "id_card", "passport" ], "type": "string" }, "type": "array" }, "require_id_number": { "description": "Collect an ID number and perform an [ID number check](https://stripe.com/docs/identity/verification-checks?type=id-number) with the document’s extracted name and date of birth.", "type": "boolean" }, "require_live_capture": { "description": "Disable image uploads, identity document images have to be captured using the device’s camera.", "type": "boolean" }, "require_matching_selfie": { "description": "Capture a face image and perform a [selfie check](https://stripe.com/docs/identity/verification-checks?type=selfie) comparing a photo ID and a picture of your user’s face. [Learn more](https://stripe.com/docs/identity/selfie).", "type": "boolean" } }, "title": "GelatoReportDocumentOptions", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "allowed_types", "require_id_number", "require_live_capture", "require_matching_selfie" ] }, "gelato_report_id_number_options": { "description": "", "properties": {}, "title": "GelatoReportIdNumberOptions", "type": "object", "x-expandableFields": [] }, "gelato_selfie_report": { "description": "Result from a selfie check", "properties": { "document": { "description": "ID of the [File](https://stripe.com/docs/api/files) holding the image of the identity document used in this check.", "maxLength": 5000, "nullable": true, "type": "string" }, "error": { "anyOf": [ { "$ref": "#/components/schemas/gelato_selfie_report_error" } ], "description": "Details on the verification error. Present when status is `unverified`.", "nullable": true }, "selfie": { "description": "ID of the [File](https://stripe.com/docs/api/files) holding the image of the selfie used in this check.", "maxLength": 5000, "nullable": true, "type": "string" }, "status": { "description": "Status of this `selfie` check.", "enum": [ "unverified", "verified" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "document", "error", "selfie", "status" ], "title": "GelatoSelfieReport", "type": "object", "x-expandableFields": [ "error" ], "x-stripeMostCommon": [ "document", "error", "selfie", "status" ] }, "gelato_selfie_report_error": { "description": "", "properties": { "code": { "description": "A short machine-readable string giving the reason for the verification failure.", "enum": [ "selfie_document_missing_photo", "selfie_face_mismatch", "selfie_manipulated", "selfie_unverified_other" ], "nullable": true, "type": "string" }, "reason": { "description": "A human-readable message giving the reason for the failure. These messages can be shown to your users.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "code", "reason" ], "title": "GelatoSelfieReportError", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "code", "reason" ] }, "gelato_session_document_options": { "description": "", "properties": { "allowed_types": { "description": "Array of strings of allowed identity document types. If the provided identity document isn’t one of the allowed types, the verification check will fail with a document_type_not_allowed error code.", "items": { "enum": [ "driving_license", "id_card", "passport" ], "type": "string" }, "type": "array" }, "require_id_number": { "description": "Collect an ID number and perform an [ID number check](https://stripe.com/docs/identity/verification-checks?type=id-number) with the document’s extracted name and date of birth.", "type": "boolean" }, "require_live_capture": { "description": "Disable image uploads, identity document images have to be captured using the device’s camera.", "type": "boolean" }, "require_matching_selfie": { "description": "Capture a face image and perform a [selfie check](https://stripe.com/docs/identity/verification-checks?type=selfie) comparing a photo ID and a picture of your user’s face. [Learn more](https://stripe.com/docs/identity/selfie).", "type": "boolean" } }, "title": "GelatoSessionDocumentOptions", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "allowed_types", "require_id_number", "require_live_capture", "require_matching_selfie" ] }, "gelato_session_email_options": { "description": "", "properties": { "require_verification": { "description": "Request one time password verification of `provided_details.email`.", "type": "boolean" } }, "title": "GelatoSessionEmailOptions", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "require_verification" ] }, "gelato_session_id_number_options": { "description": "", "properties": {}, "title": "GelatoSessionIdNumberOptions", "type": "object", "x-expandableFields": [] }, "gelato_session_last_error": { "description": "Shows last VerificationSession error", "properties": { "code": { "description": "A short machine-readable string giving the reason for the verification or user-session failure.", "enum": [ "abandoned", "consent_declined", "country_not_supported", "device_not_supported", "document_expired", "document_type_not_supported", "document_unverified_other", "email_unverified_other", "email_verification_declined", "id_number_insufficient_document_data", "id_number_mismatch", "id_number_unverified_other", "phone_unverified_other", "phone_verification_declined", "selfie_document_missing_photo", "selfie_face_mismatch", "selfie_manipulated", "selfie_unverified_other", "under_supported_age" ], "nullable": true, "type": "string", "x-stripeBypassValidation": true }, "reason": { "description": "A message that explains the reason for verification or user-session failure.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "code", "reason" ], "title": "GelatoSessionLastError", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "code", "reason" ] }, "gelato_session_matching_options": { "description": "", "properties": { "dob": { "description": "Strictness of the DOB matching policy to apply.", "enum": [ "none", "similar" ], "type": "string" }, "name": { "description": "Strictness of the name matching policy to apply.", "enum": [ "none", "similar" ], "type": "string" } }, "title": "GelatoSessionMatchingOptions", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "dob", "name" ] }, "gelato_session_phone_options": { "description": "", "properties": { "require_verification": { "description": "Request one time password verification of `provided_details.phone`.", "type": "boolean" } }, "title": "GelatoSessionPhoneOptions", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "require_verification" ] }, "gelato_verification_report_options": { "description": "", "properties": { "document": { "$ref": "#/components/schemas/gelato_report_document_options" }, "id_number": { "$ref": "#/components/schemas/gelato_report_id_number_options" } }, "title": "GelatoVerificationReportOptions", "type": "object", "x-expandableFields": [ "document", "id_number" ], "x-stripeMostCommon": [ "document", "id_number" ] }, "gelato_verification_session_options": { "description": "", "properties": { "document": { "$ref": "#/components/schemas/gelato_session_document_options" }, "email": { "$ref": "#/components/schemas/gelato_session_email_options" }, "id_number": { "$ref": "#/components/schemas/gelato_session_id_number_options" }, "matching": { "$ref": "#/components/schemas/gelato_session_matching_options" }, "phone": { "$ref": "#/components/schemas/gelato_session_phone_options" } }, "title": "GelatoVerificationSessionOptions", "type": "object", "x-expandableFields": [ "document", "email", "id_number", "matching", "phone" ], "x-stripeMostCommon": [ "document", "email", "id_number", "matching", "phone" ] }, "gelato_verified_outputs": { "description": "", "properties": { "address": { "anyOf": [ { "$ref": "#/components/schemas/address" } ], "description": "The user's verified address.", "nullable": true }, "dob": { "anyOf": [ { "$ref": "#/components/schemas/gelato_data_verified_outputs_date" } ], "description": "The user’s verified date of birth.", "nullable": true }, "email": { "description": "The user's verified email address", "maxLength": 5000, "nullable": true, "type": "string" }, "first_name": { "description": "The user's verified first name.", "maxLength": 5000, "nullable": true, "type": "string" }, "id_number": { "description": "The user's verified id number.", "maxLength": 5000, "nullable": true, "type": "string" }, "id_number_type": { "description": "The user's verified id number type.", "enum": [ "br_cpf", "sg_nric", "us_ssn" ], "nullable": true, "type": "string" }, "last_name": { "description": "The user's verified last name.", "maxLength": 5000, "nullable": true, "type": "string" }, "phone": { "description": "The user's verified phone number", "maxLength": 5000, "nullable": true, "type": "string" }, "sex": { "description": "The user's verified sex.", "enum": [ "[redacted]", "female", "male", "unknown" ], "nullable": true, "type": "string" }, "unparsed_place_of_birth": { "description": "The user's verified place of birth as it appears in the document.", "maxLength": 5000, "nullable": true, "type": "string" }, "unparsed_sex": { "description": "The user's verified sex as it appears in the document.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "address", "email", "first_name", "id_number_type", "last_name", "phone" ], "title": "GelatoVerifiedOutputs", "type": "object", "x-expandableFields": [ "address", "dob" ], "x-stripeMostCommon": [ "address", "dob", "email", "first_name", "id_number", "id_number_type", "last_name", "phone", "sex", "unparsed_place_of_birth", "unparsed_sex" ] }, "identity.verification_report": { "description": "A VerificationReport is the result of an attempt to collect and verify data from a user.\nThe collection of verification checks performed is determined from the `type` and `options`\nparameters used. You can find the result of each verification check performed in the\nappropriate sub-resource: `document`, `id_number`, `selfie`.\n\nEach VerificationReport contains a copy of any data collected by the user as well as\nreference IDs which can be used to access collected images through the [FileUpload](https://stripe.com/docs/api/files)\nAPI. To configure and create VerificationReports, use the\n[VerificationSession](https://stripe.com/docs/api/identity/verification_sessions) API.\n\nRelated guide: [Accessing verification results](https://stripe.com/docs/identity/verification-sessions#results).", "properties": { "client_reference_id": { "description": "A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems.", "maxLength": 5000, "nullable": true, "type": "string" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "document": { "$ref": "#/components/schemas/gelato_document_report" }, "email": { "$ref": "#/components/schemas/gelato_email_report" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "id_number": { "$ref": "#/components/schemas/gelato_id_number_report" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "identity.verification_report" ], "type": "string" }, "options": { "$ref": "#/components/schemas/gelato_verification_report_options" }, "phone": { "$ref": "#/components/schemas/gelato_phone_report" }, "selfie": { "$ref": "#/components/schemas/gelato_selfie_report" }, "type": { "description": "Type of report.", "enum": [ "document", "id_number", "verification_flow" ], "type": "string", "x-stripeBypassValidation": true }, "verification_flow": { "description": "The configuration token of a verification flow from the dashboard.", "maxLength": 5000, "type": "string" }, "verification_session": { "description": "ID of the VerificationSession that created this report.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "client_reference_id", "created", "id", "livemode", "object", "type", "verification_session" ], "title": "GelatoVerificationReport", "type": "object", "x-expandableFields": [ "document", "email", "id_number", "options", "phone", "selfie" ], "x-resourceId": "identity.verification_report", "x-stripeMostCommon": [ "client_reference_id", "created", "document", "email", "id", "id_number", "livemode", "object", "options", "phone", "selfie", "type", "verification_flow", "verification_session" ], "x-stripeOperations": [ { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/identity/verification_reports" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/identity/verification_reports/{report}" } ], "x-stripeResource": { "class_name": "VerificationReport", "has_collection_class": true, "in_package": "Identity" } }, "identity.verification_session": { "description": "A VerificationSession guides you through the process of collecting and verifying the identities\nof your users. It contains details about the type of verification, such as what [verification\ncheck](/docs/identity/verification-checks) to perform. Only create one VerificationSession for\neach verification in your system.\n\nA VerificationSession transitions through [multiple\nstatuses](/docs/identity/how-sessions-work) throughout its lifetime as it progresses through\nthe verification flow. The VerificationSession contains the user's verified data after\nverification checks are complete.\n\nRelated guide: [The Verification Sessions API](https://stripe.com/docs/identity/verification-sessions)", "properties": { "client_reference_id": { "description": "A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems.", "maxLength": 5000, "nullable": true, "type": "string" }, "client_secret": { "description": "The short-lived client secret used by Stripe.js to [show a verification modal](https://stripe.com/docs/js/identity/modal) inside your app. This client secret expires after 24 hours and can only be used once. Don’t store it, log it, embed it in a URL, or expose it to anyone other than the user. Make sure that you have TLS enabled on any page that includes the client secret. Refer to our docs on [passing the client secret to the frontend](https://stripe.com/docs/identity/verification-sessions#client-secret) to learn more.", "maxLength": 5000, "nullable": true, "type": "string" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "last_error": { "anyOf": [ { "$ref": "#/components/schemas/gelato_session_last_error" } ], "description": "If present, this property tells you the last error encountered when processing the verification.", "nullable": true }, "last_verification_report": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/identity.verification_report" } ], "description": "ID of the most recent VerificationReport. [Learn more about accessing detailed verification results.](https://stripe.com/docs/identity/verification-sessions#results)", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/identity.verification_report" } ] } }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "type": "object" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "identity.verification_session" ], "type": "string" }, "options": { "anyOf": [ { "$ref": "#/components/schemas/gelato_verification_session_options" } ], "description": "A set of options for the session’s verification checks.", "nullable": true }, "provided_details": { "anyOf": [ { "$ref": "#/components/schemas/gelato_provided_details" } ], "description": "Details provided about the user being verified. These details may be shown to the user.", "nullable": true }, "redaction": { "anyOf": [ { "$ref": "#/components/schemas/verification_session_redaction" } ], "description": "Redaction status of this VerificationSession. If the VerificationSession is not redacted, this field will be null.", "nullable": true }, "related_customer": { "description": "Customer ID", "maxLength": 5000, "nullable": true, "type": "string" }, "related_customer_account": { "description": "Token referencing a Customer Account resource.", "maxLength": 5000, "nullable": true, "type": "string" }, "related_person": { "$ref": "#/components/schemas/gelato_related_person" }, "status": { "description": "Status of this VerificationSession. [Learn more about the lifecycle of sessions](https://stripe.com/docs/identity/how-sessions-work).", "enum": [ "canceled", "processing", "requires_input", "verified" ], "type": "string" }, "type": { "description": "The type of [verification check](https://stripe.com/docs/identity/verification-checks) to be performed.", "enum": [ "document", "id_number", "verification_flow" ], "type": "string", "x-stripeBypassValidation": true }, "url": { "description": "The short-lived URL that you use to redirect a user to Stripe to submit their identity information. This URL expires after 48 hours and can only be used once. Don’t store it, log it, send it in emails or expose it to anyone other than the user. Refer to our docs on [verifying identity documents](https://stripe.com/docs/identity/verify-identity-documents?platform=web&type=redirect) to learn how to redirect users to Stripe.", "maxLength": 5000, "nullable": true, "type": "string" }, "verification_flow": { "description": "The configuration token of a verification flow from the dashboard.", "maxLength": 5000, "type": "string" }, "verified_outputs": { "anyOf": [ { "$ref": "#/components/schemas/gelato_verified_outputs" } ], "description": "The user’s verified data.", "nullable": true } }, "required": [ "client_reference_id", "client_secret", "created", "id", "last_error", "last_verification_report", "livemode", "metadata", "object", "options", "redaction", "related_customer", "status", "type", "url" ], "title": "GelatoVerificationSession", "type": "object", "x-expandableFields": [ "last_error", "last_verification_report", "options", "provided_details", "redaction", "related_person", "verified_outputs" ], "x-resourceId": "identity.verification_session", "x-stripeMostCommon": [ "client_reference_id", "client_secret", "created", "id", "last_error", "last_verification_report", "livemode", "metadata", "object", "options", "provided_details", "redaction", "related_customer", "related_customer_account", "related_person", "status", "type", "url", "verification_flow", "verified_outputs" ], "x-stripeOperations": [ { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/identity/verification_sessions" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/identity/verification_sessions/{session}" }, { "method_name": "create", "method_on": "service", "method_type": "create", "operation": "post", "path": "/v1/identity/verification_sessions" }, { "method_name": "update", "method_on": "service", "method_type": "update", "operation": "post", "path": "/v1/identity/verification_sessions/{session}" }, { "method_name": "cancel", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/identity/verification_sessions/{session}/cancel" }, { "method_name": "redact", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/identity/verification_sessions/{session}/redact" } ], "x-stripeResource": { "class_name": "VerificationSession", "has_collection_class": true, "in_package": "Identity" } }, "identity.verification_session.canceled": { "description": "Occurs whenever a VerificationSession is canceled", "properties": { "object": { "$ref": "#/components/schemas/identity.verification_session" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "identity.verification_session.canceled" } }, "identity.verification_session.created": { "description": "Occurs whenever a VerificationSession is created", "properties": { "object": { "$ref": "#/components/schemas/identity.verification_session" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "identity.verification_session.created" } }, "identity.verification_session.processing": { "description": "Occurs whenever a VerificationSession transitions to processing", "properties": { "object": { "$ref": "#/components/schemas/identity.verification_session" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "identity.verification_session.processing" } }, "identity.verification_session.redacted": { "description": "Occurs whenever a VerificationSession is redacted.", "properties": { "object": { "$ref": "#/components/schemas/identity.verification_session" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "identity.verification_session.redacted" } }, "identity.verification_session.requires_input": { "description": "Occurs whenever a VerificationSession transitions to require user input", "properties": { "object": { "$ref": "#/components/schemas/identity.verification_session" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "identity.verification_session.requires_input" } }, "identity.verification_session.verified": { "description": "Occurs whenever a VerificationSession transitions to verified", "properties": { "object": { "$ref": "#/components/schemas/identity.verification_session" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "identity.verification_session.verified" } }, "inbound_transfers": { "description": "", "properties": { "billing_details": { "$ref": "#/components/schemas/treasury_shared_resource_billing_details" }, "type": { "description": "The type of the payment method used in the InboundTransfer.", "enum": [ "us_bank_account" ], "type": "string", "x-stripeBypassValidation": true }, "us_bank_account": { "$ref": "#/components/schemas/inbound_transfers_payment_method_details_us_bank_account" } }, "required": [ "billing_details", "type" ], "title": "InboundTransfers", "type": "object", "x-expandableFields": [ "billing_details", "us_bank_account" ], "x-stripeMostCommon": [ "billing_details", "type", "us_bank_account" ] }, "inbound_transfers_payment_method_details_us_bank_account": { "description": "", "properties": { "account_holder_type": { "description": "Account holder type: individual or company.", "enum": [ "company", "individual" ], "nullable": true, "type": "string" }, "account_type": { "description": "Account type: checkings or savings. Defaults to checking if omitted.", "enum": [ "checking", "savings" ], "nullable": true, "type": "string" }, "bank_name": { "description": "Name of the bank associated with the bank account.", "maxLength": 5000, "nullable": true, "type": "string" }, "fingerprint": { "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.", "maxLength": 5000, "nullable": true, "type": "string" }, "last4": { "description": "Last four digits of the bank account number.", "maxLength": 5000, "nullable": true, "type": "string" }, "mandate": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/mandate" } ], "description": "ID of the mandate used to make this payment.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/mandate" } ] } }, "network": { "description": "The network rails used. See the [docs](https://stripe.com/docs/treasury/money-movement/timelines) to learn more about money movement timelines for each network type.", "enum": [ "ach" ], "type": "string" }, "routing_number": { "description": "Routing number of the bank account.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "account_holder_type", "account_type", "bank_name", "fingerprint", "last4", "network", "routing_number" ], "title": "inbound_transfers_payment_method_details_us_bank_account", "type": "object", "x-expandableFields": [ "mandate" ], "x-stripeMostCommon": [ "account_holder_type", "account_type", "bank_name", "fingerprint", "last4", "mandate", "network", "routing_number" ], "x-stripeResource": { "class_name": "UsBankAccount", "in_package": "" } }, "internal_card": { "description": "", "properties": { "brand": { "description": "Brand of the card used in the transaction", "maxLength": 5000, "nullable": true, "type": "string" }, "country": { "description": "Two-letter ISO code representing the country of the card", "maxLength": 5000, "nullable": true, "type": "string" }, "exp_month": { "description": "Two digit number representing the card's expiration month", "nullable": true, "type": "integer" }, "exp_year": { "description": "Two digit number representing the card's expiration year", "nullable": true, "type": "integer" }, "last4": { "description": "The last 4 digits of the card", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "brand", "country", "exp_month", "exp_year", "last4" ], "title": "internal_card", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "brand", "country", "exp_month", "exp_year", "last4" ] }, "invoice": { "description": "Invoices are statements of amounts owed by a customer, and are either\ngenerated one-off, or generated periodically from a subscription.\n\nThey contain [invoice items](https://stripe.com/docs/api#invoiceitems), and proration adjustments\nthat may be caused by subscription upgrades/downgrades (if necessary).\n\nIf your invoice is configured to be billed through automatic charges,\nStripe automatically finalizes your invoice and attempts payment. Note\nthat finalizing the invoice,\n[when automatic](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection), does\nnot happen immediately as the invoice is created. Stripe waits\nuntil one hour after the last webhook was successfully sent (or the last\nwebhook timed out after failing). If you (and the platforms you may have\nconnected to) have no webhooks configured, Stripe waits one hour after\ncreation to finalize the invoice.\n\nIf your invoice is configured to be billed by sending an email, then based on your\n[email settings](https://dashboard.stripe.com/account/billing/automatic),\nStripe will email the invoice to your customer and await payment. These\nemails can contain a link to a hosted page to pay the invoice.\n\nStripe applies any customer credit on the account before determining the\namount due for the invoice (i.e., the amount that will be actually\ncharged). If the amount due for the invoice is less than Stripe's [minimum allowed charge\nper currency](/docs/currencies#minimum-and-maximum-charge-amounts), the\ninvoice is automatically marked paid, and we add the amount due to the\ncustomer's credit balance which is applied to the next invoice.\n\nMore details on the customer's credit balance are\n[here](https://stripe.com/docs/billing/customer/balance).\n\nRelated guide: [Send invoices to customers](https://stripe.com/docs/billing/invoices/sending)", "properties": { "account_country": { "description": "The country of the business associated with this invoice, most often the business creating the invoice.", "maxLength": 5000, "nullable": true, "type": "string" }, "account_name": { "description": "The public name of the business associated with this invoice, most often the business creating the invoice.", "maxLength": 5000, "nullable": true, "type": "string" }, "account_tax_ids": { "description": "The account tax IDs associated with the invoice. Only editable when the invoice is a draft.", "items": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/tax_id" }, { "$ref": "#/components/schemas/deleted_tax_id" } ], "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/tax_id" }, { "$ref": "#/components/schemas/deleted_tax_id" } ] } }, "nullable": true, "type": "array" }, "amount_due": { "description": "Final amount due at this time for this invoice. If the invoice's total is smaller than the minimum charge amount, for example, or if there is account credit that can be applied to the invoice, the `amount_due` may be 0. If there is a positive `starting_balance` for the invoice (the customer owes money), the `amount_due` will also take that into account. The charge that gets generated for the invoice will be for the amount specified in `amount_due`.", "type": "integer" }, "amount_overpaid": { "description": "Amount that was overpaid on the invoice. The amount overpaid is credited to the customer's credit balance.", "type": "integer" }, "amount_paid": { "description": "The amount, in cents (or local equivalent), that was paid.", "type": "integer" }, "amount_remaining": { "description": "The difference between amount_due and amount_paid, in cents (or local equivalent).", "type": "integer" }, "amount_shipping": { "description": "This is the sum of all the shipping amounts.", "type": "integer" }, "amounts_due": { "description": "List of expected payments and corresponding due dates. This value will be null for invoices where collection_method=charge_automatically.", "items": { "$ref": "#/components/schemas/payment_plan_amount" }, "nullable": true, "type": "array" }, "application": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/application" }, { "$ref": "#/components/schemas/deleted_application" } ], "description": "ID of the Connect Application that created the invoice.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/application" }, { "$ref": "#/components/schemas/deleted_application" } ] } }, "attempt_count": { "description": "Number of payment attempts made for this invoice, from the perspective of the payment retry schedule. Any payment attempt counts as the first attempt, and subsequently only automatic retries increment the attempt count. In other words, manual payment attempts after the first attempt do not affect the retry schedule. If a failure is returned with a non-retryable return code, the invoice can no longer be retried unless a new payment method is obtained. Retries will continue to be scheduled, and attempt_count will continue to increment, but retries will only be executed if a new payment method is obtained.", "type": "integer" }, "attempted": { "description": "Whether an attempt has been made to pay the invoice. An invoice is not attempted until 1 hour after the `invoice.created` webhook, for example, so you might not want to display that invoice as unpaid to your users.", "type": "boolean" }, "auto_advance": { "description": "Controls whether Stripe performs [automatic collection](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection) of the invoice. If `false`, the invoice's state doesn't automatically advance without an explicit action.", "type": "boolean" }, "automatic_tax": { "$ref": "#/components/schemas/automatic_tax" }, "automatically_finalizes_at": { "description": "The time when this invoice is currently scheduled to be automatically finalized. The field will be `null` if the invoice is not scheduled to finalize in the future. If the invoice is not in the draft state, this field will always be `null` - see `finalized_at` for the time when an already-finalized invoice was finalized.", "format": "unix-time", "nullable": true, "type": "integer" }, "billing_reason": { "description": "Indicates the reason why the invoice was created.\n\n* `manual`: Unrelated to a subscription, for example, created via the invoice editor.\n* `subscription`: No longer in use. Applies to subscriptions from before May 2018 where no distinction was made between updates, cycles, and thresholds.\n* `subscription_create`: A new subscription was created.\n* `subscription_cycle`: A subscription advanced into a new period.\n* `subscription_threshold`: A subscription reached a billing threshold.\n* `subscription_update`: A subscription was updated.\n* `upcoming`: Reserved for simulated invoices, per the upcoming invoice endpoint.", "enum": [ "automatic_pending_invoice_item_invoice", "manual", "quote_accept", "subscription", "subscription_create", "subscription_cycle", "subscription_threshold", "subscription_update", "upcoming" ], "nullable": true, "type": "string" }, "collection_method": { "description": "Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this invoice using the default source attached to the customer. When sending an invoice, Stripe will email this invoice to the customer with payment instructions.", "enum": [ "charge_automatically", "send_invoice" ], "type": "string" }, "confirmation_secret": { "anyOf": [ { "$ref": "#/components/schemas/invoices_resource_confirmation_secret" } ], "description": "The confirmation secret associated with this invoice. Currently, this contains the client_secret of the PaymentIntent that Stripe creates during invoice finalization.", "nullable": true }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "custom_fields": { "description": "Custom fields displayed on the invoice.", "items": { "$ref": "#/components/schemas/invoice_setting_custom_field" }, "nullable": true, "type": "array" }, "customer": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/customer" }, { "$ref": "#/components/schemas/deleted_customer" } ], "description": "The ID of the customer who will be billed.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/customer" }, { "$ref": "#/components/schemas/deleted_customer" } ] } }, "customer_account": { "description": "The ID of the account who will be billed.", "maxLength": 5000, "nullable": true, "type": "string" }, "customer_address": { "anyOf": [ { "$ref": "#/components/schemas/address" } ], "description": "The customer's address. Until the invoice is finalized, this field will equal `customer.address`. Once the invoice is finalized, this field will no longer be updated.", "nullable": true }, "customer_email": { "description": "The customer's email. Until the invoice is finalized, this field will equal `customer.email`. Once the invoice is finalized, this field will no longer be updated.", "maxLength": 5000, "nullable": true, "type": "string" }, "customer_name": { "description": "The customer's name. Until the invoice is finalized, this field will equal `customer.name`. Once the invoice is finalized, this field will no longer be updated.", "maxLength": 5000, "nullable": true, "type": "string" }, "customer_phone": { "description": "The customer's phone number. Until the invoice is finalized, this field will equal `customer.phone`. Once the invoice is finalized, this field will no longer be updated.", "maxLength": 5000, "nullable": true, "type": "string" }, "customer_shipping": { "anyOf": [ { "$ref": "#/components/schemas/shipping" } ], "description": "The customer's shipping information. Until the invoice is finalized, this field will equal `customer.shipping`. Once the invoice is finalized, this field will no longer be updated.", "nullable": true }, "customer_tax_exempt": { "description": "The customer's tax exempt status. Until the invoice is finalized, this field will equal `customer.tax_exempt`. Once the invoice is finalized, this field will no longer be updated.", "enum": [ "exempt", "none", "reverse" ], "nullable": true, "type": "string" }, "customer_tax_ids": { "description": "The customer's tax IDs. Until the invoice is finalized, this field will contain the same tax IDs as `customer.tax_ids`. Once the invoice is finalized, this field will no longer be updated.", "items": { "$ref": "#/components/schemas/invoices_resource_invoice_tax_id" }, "nullable": true, "type": "array" }, "default_margins": { "description": "The margins applied to the invoice. Can be overridden by line item `margins`. Use `expand[]=default_margins` to expand each margin.", "items": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/margin" } ], "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/margin" } ] } }, "nullable": true, "type": "array" }, "default_payment_method": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/payment_method" } ], "description": "ID of the default payment method for the invoice. It must belong to the customer associated with the invoice. If not set, defaults to the subscription's default payment method, if any, or to the default payment method in the customer's invoice settings.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/payment_method" } ] } }, "default_source": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/payment_source" } ], "description": "ID of the default payment source for the invoice. It must belong to the customer associated with the invoice and be in a chargeable state. If not set, defaults to the subscription's default source, if any, or to the customer's default source.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/payment_source" } ] } }, "default_tax_rates": { "description": "The tax rates applied to this invoice, if any.", "items": { "$ref": "#/components/schemas/tax_rate" }, "type": "array" }, "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard.", "maxLength": 5000, "nullable": true, "type": "string" }, "discounts": { "description": "The discounts applied to the invoice. Line item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount.", "items": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/discount" }, { "$ref": "#/components/schemas/deleted_discount" } ], "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/discount" }, { "$ref": "#/components/schemas/deleted_discount" } ] } }, "type": "array" }, "due_date": { "description": "The date on which payment for this invoice is due. This value will be `null` for invoices where `collection_method=charge_automatically`.", "format": "unix-time", "nullable": true, "type": "integer" }, "effective_at": { "description": "The date when this invoice is in effect. Same as `finalized_at` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the invoice PDF and receipt.", "format": "unix-time", "nullable": true, "type": "integer" }, "ending_balance": { "description": "Ending customer balance after the invoice is finalized. Invoices are finalized approximately an hour after successful webhook delivery or when payment collection is attempted for the invoice. If the invoice has not been finalized yet, this will be null.", "nullable": true, "type": "integer" }, "footer": { "description": "Footer displayed on the invoice.", "maxLength": 5000, "nullable": true, "type": "string" }, "from_invoice": { "anyOf": [ { "$ref": "#/components/schemas/invoices_resource_from_invoice" } ], "description": "Details of the invoice that was cloned. See the [revision documentation](https://stripe.com/docs/invoicing/invoice-revisions) for more details.", "nullable": true }, "hosted_invoice_url": { "description": "The URL for the hosted invoice page, which allows customers to view and pay an invoice. If the invoice has not been finalized yet, this will be null.", "maxLength": 5000, "nullable": true, "type": "string" }, "id": { "description": "Unique identifier for the object. For preview invoices created using the [create preview](https://stripe.com/docs/api/invoices/create_preview) endpoint, this id will be prefixed with `upcoming_in`.", "maxLength": 5000, "type": "string" }, "invoice_pdf": { "description": "The link to download the PDF for the invoice. If the invoice has not been finalized yet, this will be null.", "maxLength": 5000, "nullable": true, "type": "string" }, "issuer": { "$ref": "#/components/schemas/connect_account_reference" }, "last_finalization_error": { "anyOf": [ { "$ref": "#/components/schemas/api_errors" } ], "description": "The error encountered during the previous attempt to finalize the invoice. This field is cleared when the invoice is successfully finalized.", "nullable": true }, "latest_revision": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/invoice" } ], "description": "The ID of the most recent non-draft revision of this invoice", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/invoice" } ] } }, "lines": { "description": "The individual line items that make up the invoice. `lines` is sorted as follows: (1) pending invoice items (including prorations) in reverse chronological order, (2) subscription items in reverse chronological order, and (3) invoice items added after invoice creation in chronological order.", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/line_item" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "InvoiceLinesList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "nullable": true, "type": "object" }, "next_payment_attempt": { "description": "The time at which payment will next be attempted. This value will be `null` for invoices where `collection_method=send_invoice`.", "format": "unix-time", "nullable": true, "type": "integer" }, "number": { "description": "A unique, identifying string that appears on emails sent to the customer for this invoice. This starts with the customer's unique invoice_prefix if it is specified.", "maxLength": 5000, "nullable": true, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "invoice" ], "type": "string" }, "on_behalf_of": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/account" } ], "description": "The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://stripe.com/docs/billing/invoices/connect) documentation for details.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/account" } ] } }, "parent": { "anyOf": [ { "$ref": "#/components/schemas/billing_bill_resource_invoicing_parents_invoice_parent" } ], "description": "The parent that generated this invoice", "nullable": true }, "payment_settings": { "$ref": "#/components/schemas/invoices_payment_settings" }, "payments": { "description": "Payments for this invoice", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/invoice_payment" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "InvoicesPaymentsListInvoicePayments", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] }, "period_end": { "description": "End of the usage period during which invoice items were added to this invoice. This looks back one period for a subscription invoice. Use the [line item period](/api/invoices/line_item#invoice_line_item_object-period) to get the service period for each price.", "format": "unix-time", "type": "integer" }, "period_start": { "description": "Start of the usage period during which invoice items were added to this invoice. This looks back one period for a subscription invoice. Use the [line item period](/api/invoices/line_item#invoice_line_item_object-period) to get the service period for each price.", "format": "unix-time", "type": "integer" }, "post_payment_credit_notes_amount": { "description": "Total amount of all post-payment credit notes issued for this invoice.", "type": "integer" }, "pre_payment_credit_notes_amount": { "description": "Total amount of all pre-payment credit notes issued for this invoice.", "type": "integer" }, "receipt_number": { "description": "This is the transaction number that appears on email receipts sent for this invoice.", "maxLength": 5000, "nullable": true, "type": "string" }, "rendering": { "anyOf": [ { "$ref": "#/components/schemas/invoices_resource_invoice_rendering" } ], "description": "The rendering-related settings that control how the invoice is displayed on customer-facing surfaces such as PDF and Hosted Invoice Page.", "nullable": true }, "shipping_cost": { "anyOf": [ { "$ref": "#/components/schemas/invoices_resource_shipping_cost" } ], "description": "The details of the cost of shipping, including the ShippingRate applied on the invoice.", "nullable": true }, "shipping_details": { "anyOf": [ { "$ref": "#/components/schemas/shipping" } ], "description": "Shipping details for the invoice. The Invoice PDF will use the `shipping_details` value if it is set, otherwise the PDF will render the shipping address from the customer.", "nullable": true }, "starting_balance": { "description": "Starting customer balance before the invoice is finalized. If the invoice has not been finalized yet, this will be the current customer balance. For revision invoices, this also includes any customer balance that was applied to the original invoice.", "type": "integer" }, "statement_descriptor": { "description": "Extra information about an invoice for the customer's credit card statement.", "maxLength": 5000, "nullable": true, "type": "string" }, "status": { "description": "The status of the invoice, one of `draft`, `open`, `paid`, `uncollectible`, or `void`. [Learn more](https://stripe.com/docs/billing/invoices/workflow#workflow-overview)", "enum": [ "draft", "open", "paid", "uncollectible", "void" ], "nullable": true, "type": "string", "x-stripeBypassValidation": true }, "status_transitions": { "$ref": "#/components/schemas/invoices_resource_status_transitions" }, "subscription": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/subscription" } ], "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/subscription" } ] } }, "subtotal": { "description": "Total of all subscriptions, invoice items, and prorations on the invoice before any invoice level discount or exclusive tax is applied. Item discounts are already incorporated", "type": "integer" }, "subtotal_excluding_tax": { "description": "The integer amount in cents (or local equivalent) representing the subtotal of the invoice before any invoice level discount or tax is applied. Item discounts are already incorporated", "nullable": true, "type": "integer" }, "test_clock": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/test_helpers.test_clock" } ], "description": "ID of the test clock this invoice belongs to.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/test_helpers.test_clock" } ] } }, "threshold_reason": { "$ref": "#/components/schemas/invoice_threshold_reason" }, "total": { "description": "Total after discounts and taxes.", "type": "integer" }, "total_discount_amounts": { "description": "The aggregate amounts calculated per discount across all line items.", "items": { "$ref": "#/components/schemas/discounts_resource_discount_amount" }, "nullable": true, "type": "array" }, "total_excluding_tax": { "description": "The integer amount in cents (or local equivalent) representing the total amount of the invoice including all discounts but excluding all tax.", "nullable": true, "type": "integer" }, "total_margin_amounts": { "description": "The aggregate amounts calculated per margin across all line items.", "items": { "$ref": "#/components/schemas/margins_resource_margin_amount" }, "nullable": true, "type": "array" }, "total_pretax_credit_amounts": { "description": "Contains pretax credit amounts (ex: discount, credit grants, etc) that apply to this invoice. This is a combined list of total_pretax_credit_amounts across all invoice line items.", "items": { "$ref": "#/components/schemas/invoices_resource_pretax_credit_amount" }, "nullable": true, "type": "array" }, "total_taxes": { "description": "The aggregate tax information of all line items.", "items": { "$ref": "#/components/schemas/billing_bill_resource_invoicing_taxes_tax" }, "nullable": true, "type": "array" }, "webhooks_delivered_at": { "description": "Invoices are automatically paid or sent 1 hour after webhooks are delivered, or until all webhook delivery attempts have [been exhausted](https://stripe.com/docs/billing/webhooks#understand). This field tracks the time when webhooks for this invoice were successfully delivered. If the invoice had no webhooks to deliver, this will be set while the invoice is being created.", "format": "unix-time", "nullable": true, "type": "integer" } }, "required": [ "account_country", "account_name", "account_tax_ids", "amount_due", "amount_overpaid", "amount_paid", "amount_remaining", "amount_shipping", "application", "attempt_count", "attempted", "automatic_tax", "automatically_finalizes_at", "billing_reason", "collection_method", "created", "currency", "custom_fields", "customer", "customer_address", "customer_email", "customer_name", "customer_phone", "customer_shipping", "customer_tax_exempt", "default_payment_method", "default_source", "default_tax_rates", "description", "discounts", "due_date", "effective_at", "ending_balance", "footer", "from_invoice", "issuer", "last_finalization_error", "latest_revision", "lines", "livemode", "metadata", "next_payment_attempt", "number", "object", "on_behalf_of", "parent", "payment_settings", "period_end", "period_start", "post_payment_credit_notes_amount", "pre_payment_credit_notes_amount", "receipt_number", "rendering", "shipping_cost", "shipping_details", "starting_balance", "statement_descriptor", "status", "status_transitions", "subtotal", "subtotal_excluding_tax", "test_clock", "total", "total_discount_amounts", "total_excluding_tax", "total_pretax_credit_amounts", "total_taxes", "webhooks_delivered_at" ], "title": "Invoice", "type": "object", "x-expandableFields": [ "account_tax_ids", "amounts_due", "application", "automatic_tax", "confirmation_secret", "custom_fields", "customer", "customer_address", "customer_shipping", "customer_tax_ids", "default_margins", "default_payment_method", "default_source", "default_tax_rates", "discounts", "from_invoice", "issuer", "last_finalization_error", "latest_revision", "lines", "on_behalf_of", "parent", "payment_settings", "payments", "rendering", "shipping_cost", "shipping_details", "status_transitions", "subscription", "test_clock", "threshold_reason", "total_discount_amounts", "total_margin_amounts", "total_pretax_credit_amounts", "total_taxes" ], "x-resourceId": "invoice", "x-stripeMostCommon": [ "auto_advance", "automatic_tax", "collection_method", "confirmation_secret", "currency", "customer", "description", "hosted_invoice_url", "id", "lines", "metadata", "parent", "period_end", "period_start", "status", "total" ], "x-stripeOperations": [ { "method_name": "delete", "method_on": "service", "method_type": "delete", "operation": "delete", "path": "/v1/invoices/{invoice}" }, { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/invoices" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/invoices/{invoice}" }, { "method_name": "search", "method_on": "service", "method_type": "custom", "operation": "get", "path": "/v1/invoices/search" }, { "method_name": "create", "method_on": "service", "method_type": "create", "operation": "post", "path": "/v1/invoices" }, { "method_name": "update", "method_on": "service", "method_type": "update", "operation": "post", "path": "/v1/invoices/{invoice}" }, { "method_name": "add_lines", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/invoices/{invoice}/add_lines" }, { "method_name": "attach_payment", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/invoices/{invoice}/attach_payment" }, { "method_name": "finalize_invoice", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/invoices/{invoice}/finalize" }, { "method_name": "mark_uncollectible", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/invoices/{invoice}/mark_uncollectible" }, { "method_name": "pay", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/invoices/{invoice}/pay" }, { "method_name": "remove_lines", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/invoices/{invoice}/remove_lines" }, { "method_name": "send_invoice", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/invoices/{invoice}/send" }, { "method_name": "update_lines", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/invoices/{invoice}/update_lines" }, { "method_name": "void_invoice", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/invoices/{invoice}/void" }, { "method_name": "create_preview", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/invoices/create_preview" } ], "x-stripeResource": { "class_name": "Invoice", "has_collection_class": true, "has_search_result_class": true, "in_package": "" } }, "invoice.created": { "description": "Occurs whenever a new invoice is created. To learn how webhooks can be used with this event, and how they can affect it, see [Using Webhooks with Subscriptions](https://docs.stripe.com/subscriptions/webhooks).", "properties": { "object": { "$ref": "#/components/schemas/invoice" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "invoice.created" } }, "invoice.deleted": { "description": "Occurs whenever a draft invoice is deleted. Note: This event is not sent for [invoice previews](https://docs.stripe.com/api/invoices/create_preview).", "properties": { "object": { "$ref": "#/components/schemas/invoice" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "invoice.deleted" } }, "invoice.finalization_failed": { "description": "Occurs whenever a draft invoice cannot be finalized. See the invoice’s [last finalization error](https://docs.stripe.com/api/invoices/object#invoice_object-last_finalization_error) for details.", "properties": { "object": { "$ref": "#/components/schemas/invoice" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "invoice.finalization_failed" } }, "invoice.finalized": { "description": "Occurs whenever a draft invoice is finalized and updated to be an open invoice.", "properties": { "object": { "$ref": "#/components/schemas/invoice" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "invoice.finalized" } }, "invoice.marked_uncollectible": { "description": "Occurs whenever an invoice is marked uncollectible.", "properties": { "object": { "$ref": "#/components/schemas/invoice" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "invoice.marked_uncollectible" } }, "invoice.overdue": { "description": "Occurs X number of days after an invoice becomes due—where X is determined by Automations", "properties": { "object": { "$ref": "#/components/schemas/invoice" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "invoice.overdue" } }, "invoice.overpaid": { "description": "Occurs when an invoice transitions to paid with a non-zero amount_overpaid.", "properties": { "object": { "$ref": "#/components/schemas/invoice" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "invoice.overpaid" } }, "invoice.paid": { "description": "Occurs whenever an invoice payment attempt succeeds or an invoice is marked as paid out-of-band.", "properties": { "object": { "$ref": "#/components/schemas/invoice" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "invoice.paid" } }, "invoice.payment.overpaid": { "description": "Occurs when an InvoicePayment transitions to paid with a non-zero amount_overpaid.", "properties": { "object": { "$ref": "#/components/schemas/invoice_payment" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "invoice.payment.overpaid" } }, "invoice.payment_action_required": { "description": "Occurs whenever an invoice payment attempt requires further user action to complete.", "properties": { "object": { "$ref": "#/components/schemas/invoice" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "invoice.payment_action_required" } }, "invoice.payment_attempt_required": { "description": "Occurs when an invoice requires a payment using a payment method that cannot be processed by Stripe.", "properties": { "object": { "$ref": "#/components/schemas/invoice" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "invoice.payment_attempt_required" } }, "invoice.payment_failed": { "description": "Occurs whenever an invoice payment attempt fails, due to either a declined payment, including soft decline, or to the lack of a stored payment method.", "properties": { "object": { "$ref": "#/components/schemas/invoice" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "invoice.payment_failed" } }, "invoice.payment_succeeded": { "description": "Occurs whenever an invoice payment attempt succeeds.", "properties": { "object": { "$ref": "#/components/schemas/invoice" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "invoice.payment_succeeded" } }, "invoice.sent": { "description": "Occurs whenever an invoice email is sent out.", "properties": { "object": { "$ref": "#/components/schemas/invoice" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "invoice.sent" } }, "invoice.upcoming": { "description": "Occurs X number of days before a subscription is scheduled to create an invoice that is automatically charged—where X is determined by your [subscriptions settings](https://dashboard.stripe.com/account/billing/automatic). Note: The received `Invoice` object will not have an invoice ID.", "properties": { "object": { "$ref": "#/components/schemas/invoice" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "invoice.upcoming" } }, "invoice.updated": { "description": "Occurs whenever an invoice changes (e.g., the invoice amount).", "properties": { "object": { "$ref": "#/components/schemas/invoice" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "invoice.updated" } }, "invoice.voided": { "description": "Occurs whenever an invoice is voided.", "properties": { "object": { "$ref": "#/components/schemas/invoice" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "invoice.voided" } }, "invoice.will_be_due": { "description": "Occurs X number of days before an invoice becomes due—where X is determined by Automations", "properties": { "object": { "$ref": "#/components/schemas/invoice" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "invoice.will_be_due" } }, "invoice_installments_card": { "description": "", "properties": { "enabled": { "description": "Whether Installments are enabled for this Invoice.", "nullable": true, "type": "boolean" } }, "required": [ "enabled" ], "title": "invoice_installments_card", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "enabled" ] }, "invoice_item_threshold_reason": { "description": "", "properties": { "line_item_ids": { "description": "The IDs of the line items that triggered the threshold invoice.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "usage_gte": { "description": "The quantity threshold boundary that applied to the given line item.", "type": "integer" } }, "required": [ "line_item_ids", "usage_gte" ], "title": "InvoiceItemThresholdReason", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "line_item_ids", "usage_gte" ] }, "invoice_line_item_period": { "description": "", "properties": { "end": { "description": "The end of the period, which must be greater than or equal to the start. This value is inclusive.", "format": "unix-time", "type": "integer" }, "start": { "description": "The start of the period. This value is inclusive.", "format": "unix-time", "type": "integer" } }, "required": [ "end", "start" ], "title": "InvoiceLineItemPeriod", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "end", "start" ] }, "invoice_mandate_options_card": { "description": "", "properties": { "amount": { "description": "Amount to be charged for future payments.", "nullable": true, "type": "integer" }, "amount_type": { "description": "One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.", "enum": [ "fixed", "maximum" ], "nullable": true, "type": "string" }, "description": { "description": "A description of the mandate or subscription that is meant to be displayed to the customer.", "maxLength": 200, "nullable": true, "type": "string" } }, "required": [ "amount", "amount_type", "description" ], "title": "invoice_mandate_options_card", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "amount", "amount_type", "description" ] }, "invoice_payment": { "description": "Invoice Payments represent payments made against invoices. Invoice Payments can\nbe accessed in two ways:\n1. By expanding the `payments` field on the [Invoice](https://stripe.com/docs/api#invoice) resource.\n2. By using the Invoice Payment retrieve and list endpoints.\n\nInvoice Payments include the mapping between payment objects, such as Payment Intent, and Invoices.\nThis resource and its endpoints allows you to easily track if a payment is associated with a specific invoice and\nmonitor the allocation details of the payments.", "properties": { "amount_paid": { "description": "Amount that was actually paid for this invoice, in cents (or local equivalent). This field is null until the payment is `paid`. This amount can be less than the `amount_requested` if the PaymentIntent’s `amount_received` is not sufficient to pay all of the invoices that it is attached to.", "nullable": true, "type": "integer" }, "amount_requested": { "description": "Amount intended to be paid toward this invoice, in cents (or local equivalent)", "type": "integer" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "maxLength": 5000, "type": "string" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "invoice": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/invoice" }, { "$ref": "#/components/schemas/deleted_invoice" } ], "description": "The invoice that was paid.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/invoice" }, { "$ref": "#/components/schemas/deleted_invoice" } ] } }, "is_default": { "description": "Stripe automatically creates a default InvoicePayment when the invoice is finalized, and keeps it synchronized with the invoice’s `amount_remaining`. The PaymentIntent associated with the default payment can’t be edited or canceled directly.", "type": "boolean" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "invoice_payment" ], "type": "string" }, "payment": { "$ref": "#/components/schemas/invoices_payments_invoice_payment_associated_payment" }, "status": { "description": "The status of the payment, one of `open`, `paid`, or `canceled`.", "maxLength": 5000, "type": "string" }, "status_transitions": { "$ref": "#/components/schemas/invoices_payments_invoice_payment_status_transitions" } }, "required": [ "amount_paid", "amount_requested", "created", "currency", "id", "invoice", "is_default", "livemode", "object", "payment", "status", "status_transitions" ], "title": "InvoicesInvoicePayment", "type": "object", "x-expandableFields": [ "invoice", "payment", "status_transitions" ], "x-resourceId": "invoice_payment", "x-stripeMostCommon": [ "amount_paid", "amount_requested", "id", "invoice", "is_default", "payment", "status" ], "x-stripeOperations": [ { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/invoice_payments" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/invoice_payments/{invoice_payment}" } ], "x-stripeResource": { "class_name": "InvoicePayment", "has_collection_class": true, "in_package": "" } }, "invoice_payment.paid": { "description": "Occurs when an InvoicePayment is successfully paid.", "properties": { "object": { "$ref": "#/components/schemas/invoice_payment" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "invoice_payment.paid" } }, "invoice_payment_method_options_acss_debit": { "description": "", "properties": { "mandate_options": { "$ref": "#/components/schemas/invoice_payment_method_options_acss_debit_mandate_options" }, "verification_method": { "description": "Bank account verification method.", "enum": [ "automatic", "instant", "microdeposits" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "invoice_payment_method_options_acss_debit", "type": "object", "x-expandableFields": [ "mandate_options" ], "x-stripeMostCommon": [ "mandate_options", "verification_method" ] }, "invoice_payment_method_options_acss_debit_mandate_options": { "description": "", "properties": { "transaction_type": { "description": "Transaction type of the mandate.", "enum": [ "business", "personal" ], "nullable": true, "type": "string" } }, "required": [ "transaction_type" ], "title": "invoice_payment_method_options_acss_debit_mandate_options", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "transaction_type" ] }, "invoice_payment_method_options_bancontact": { "description": "", "properties": { "preferred_language": { "description": "Preferred language of the Bancontact authorization page that the customer is redirected to.", "enum": [ "de", "en", "fr", "nl" ], "type": "string" } }, "required": [ "preferred_language" ], "title": "invoice_payment_method_options_bancontact", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "preferred_language" ] }, "invoice_payment_method_options_card": { "description": "", "properties": { "installments": { "$ref": "#/components/schemas/invoice_installments_card" }, "request_three_d_secure": { "description": "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.", "enum": [ "any", "automatic", "challenge" ], "nullable": true, "type": "string" } }, "required": [ "request_three_d_secure" ], "title": "invoice_payment_method_options_card", "type": "object", "x-expandableFields": [ "installments" ], "x-stripeMostCommon": [ "installments", "request_three_d_secure" ] }, "invoice_payment_method_options_customer_balance": { "description": "", "properties": { "bank_transfer": { "$ref": "#/components/schemas/invoice_payment_method_options_customer_balance_bank_transfer" }, "funding_type": { "description": "The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.", "enum": [ "bank_transfer" ], "nullable": true, "type": "string" } }, "required": [ "funding_type" ], "title": "invoice_payment_method_options_customer_balance", "type": "object", "x-expandableFields": [ "bank_transfer" ], "x-stripeMostCommon": [ "bank_transfer", "funding_type" ] }, "invoice_payment_method_options_customer_balance_bank_transfer": { "description": "", "properties": { "eu_bank_transfer": { "$ref": "#/components/schemas/invoice_payment_method_options_customer_balance_bank_transfer_eu_bank_transfer" }, "type": { "description": "The bank transfer type that can be used for funding. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.", "nullable": true, "type": "string" } }, "required": [ "type" ], "title": "invoice_payment_method_options_customer_balance_bank_transfer", "type": "object", "x-expandableFields": [ "eu_bank_transfer" ], "x-stripeMostCommon": [ "eu_bank_transfer", "type" ] }, "invoice_payment_method_options_customer_balance_bank_transfer_eu_bank_transfer": { "description": "", "properties": { "country": { "description": "The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`.", "enum": [ "BE", "DE", "ES", "FR", "IE", "NL" ], "type": "string" } }, "required": [ "country" ], "title": "invoice_payment_method_options_customer_balance_bank_transfer_eu_bank_transfer", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "country" ] }, "invoice_payment_method_options_id_bank_transfer": { "description": "", "properties": {}, "title": "invoice_payment_method_options_id_bank_transfer", "type": "object", "x-expandableFields": [] }, "invoice_payment_method_options_konbini": { "description": "", "properties": {}, "title": "invoice_payment_method_options_konbini", "type": "object", "x-expandableFields": [] }, "invoice_payment_method_options_mandate_options_upi": { "description": "", "properties": { "amount": { "description": "Amount to be charged for future payments.", "nullable": true, "type": "integer" }, "amount_type": { "description": "One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.", "enum": [ "fixed", "maximum" ], "nullable": true, "type": "string" }, "description": { "description": "A description of the mandate or subscription that is meant to be displayed to the customer.", "maxLength": 20, "nullable": true, "type": "string" }, "end_date": { "description": "End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.", "format": "unix-time", "nullable": true, "type": "integer" } }, "required": [ "amount", "amount_type", "description", "end_date" ], "title": "invoice_payment_method_options_mandate_options_upi", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "amount", "amount_type", "description", "end_date" ] }, "invoice_payment_method_options_pix": { "description": "", "properties": { "amount_includes_iof": { "description": "Determines if the amount includes the IOF tax.", "enum": [ "always", "never" ], "nullable": true, "type": "string" } }, "required": [ "amount_includes_iof" ], "title": "invoice_payment_method_options_pix", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "amount_includes_iof" ] }, "invoice_payment_method_options_sepa_debit": { "description": "", "properties": {}, "title": "invoice_payment_method_options_sepa_debit", "type": "object", "x-expandableFields": [] }, "invoice_payment_method_options_upi": { "description": "", "properties": { "mandate_options": { "$ref": "#/components/schemas/invoice_payment_method_options_mandate_options_upi" } }, "title": "invoice_payment_method_options_upi", "type": "object", "x-expandableFields": [ "mandate_options" ], "x-stripeMostCommon": [ "mandate_options" ] }, "invoice_payment_method_options_us_bank_account": { "description": "", "properties": { "financial_connections": { "$ref": "#/components/schemas/invoice_payment_method_options_us_bank_account_linked_account_options" }, "verification_method": { "description": "Bank account verification method.", "enum": [ "automatic", "instant", "microdeposits" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "invoice_payment_method_options_us_bank_account", "type": "object", "x-expandableFields": [ "financial_connections" ], "x-stripeMostCommon": [ "financial_connections", "verification_method" ] }, "invoice_payment_method_options_us_bank_account_linked_account_options": { "description": "", "properties": { "filters": { "$ref": "#/components/schemas/invoice_payment_method_options_us_bank_account_linked_account_options_filters" }, "permissions": { "description": "The list of permissions to request. The `payment_method` permission must be included.", "items": { "enum": [ "balances", "ownership", "payment_method", "transactions" ], "type": "string" }, "type": "array" }, "prefetch": { "description": "Data features requested to be retrieved upon account creation.", "items": { "enum": [ "balances", "inferred_balances", "ownership", "transactions" ], "type": "string", "x-stripeBypassValidation": true }, "nullable": true, "type": "array" } }, "required": [ "prefetch" ], "title": "invoice_payment_method_options_us_bank_account_linked_account_options", "type": "object", "x-expandableFields": [ "filters" ], "x-stripeMostCommon": [ "filters", "permissions", "prefetch" ] }, "invoice_payment_method_options_us_bank_account_linked_account_options_filters": { "description": "", "properties": { "account_subcategories": { "description": "The account subcategories to use to filter for possible accounts to link. Valid subcategories are `checking` and `savings`.", "items": { "enum": [ "checking", "savings" ], "type": "string" }, "type": "array" }, "institution": { "description": "The institution to use to filter for possible accounts to link.", "maxLength": 5000, "type": "string" } }, "title": "invoice_payment_method_options_us_bank_account_linked_account_options_filters", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "account_subcategories", "institution" ] }, "invoice_rendering_pdf": { "description": "", "properties": { "page_size": { "description": "Page size of invoice pdf. Options include a4, letter, and auto. If set to auto, page size will be switched to a4 or letter based on customer locale.", "enum": [ "a4", "auto", "letter" ], "nullable": true, "type": "string" } }, "required": [ "page_size" ], "title": "InvoiceRenderingPdf", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "page_size" ] }, "invoice_rendering_template": { "description": "Invoice Rendering Templates are used to configure how invoices are rendered on surfaces like the PDF. Invoice Rendering Templates\ncan be created from within the Dashboard, and they can be used over the API when creating invoices.", "properties": { "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "nullable": true, "type": "object" }, "nickname": { "description": "A brief description of the template, hidden from customers", "maxLength": 5000, "nullable": true, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "invoice_rendering_template" ], "type": "string" }, "status": { "description": "The status of the template, one of `active` or `archived`.", "enum": [ "active", "archived" ], "type": "string" }, "version": { "description": "Version of this template; version increases by one when an update on the template changes any field that controls invoice rendering", "type": "integer" } }, "required": [ "created", "id", "livemode", "metadata", "nickname", "object", "status", "version" ], "title": "InvoiceRenderingTemplate", "type": "object", "x-expandableFields": [], "x-resourceId": "invoice_rendering_template", "x-stripeMostCommon": [ "created", "id", "livemode", "metadata", "nickname", "object", "status", "version" ], "x-stripeOperations": [ { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/invoice_rendering_templates" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/invoice_rendering_templates/{template}" }, { "method_name": "archive", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/invoice_rendering_templates/{template}/archive" }, { "method_name": "unarchive", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/invoice_rendering_templates/{template}/unarchive" } ], "x-stripeResource": { "class_name": "InvoiceRenderingTemplate", "has_collection_class": true, "in_package": "" } }, "invoice_setting_checkout_rendering_options": { "description": "", "properties": { "amount_tax_display": { "description": "How line-item prices and amounts will be displayed with respect to tax on invoice PDFs.", "maxLength": 5000, "nullable": true, "type": "string" }, "template": { "description": "ID of the invoice rendering template to be used for the generated invoice.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "amount_tax_display", "template" ], "title": "invoice_setting_checkout_rendering_options", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "amount_tax_display", "template" ] }, "invoice_setting_custom_field": { "description": "", "properties": { "name": { "description": "The name of the custom field.", "maxLength": 5000, "type": "string" }, "value": { "description": "The value of the custom field.", "maxLength": 5000, "type": "string" } }, "required": [ "name", "value" ], "title": "InvoiceSettingCustomField", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "name", "value" ] }, "invoice_setting_customer_rendering_options": { "description": "", "properties": { "amount_tax_display": { "description": "How line-item prices and amounts will be displayed with respect to tax on invoice PDFs.", "maxLength": 5000, "nullable": true, "type": "string" }, "template": { "description": "ID of the invoice rendering template to be used for this customer's invoices. If set, the template will be used on all invoices for this customer unless a template is set directly on the invoice.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "amount_tax_display", "template" ], "title": "InvoiceSettingCustomerRenderingOptions", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "amount_tax_display", "template" ] }, "invoice_setting_customer_setting": { "description": "", "properties": { "custom_fields": { "description": "Default custom fields to be displayed on invoices for this customer.", "items": { "$ref": "#/components/schemas/invoice_setting_custom_field" }, "nullable": true, "type": "array" }, "default_payment_method": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/payment_method" } ], "description": "ID of a payment method that's attached to the customer, to be used as the customer's default payment method for subscriptions and invoices.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/payment_method" } ] } }, "footer": { "description": "Default footer to be displayed on invoices for this customer.", "maxLength": 5000, "nullable": true, "type": "string" }, "rendering_options": { "anyOf": [ { "$ref": "#/components/schemas/invoice_setting_customer_rendering_options" } ], "description": "Default options for invoice PDF rendering for this customer.", "nullable": true } }, "required": [ "custom_fields", "default_payment_method", "footer", "rendering_options" ], "title": "InvoiceSettingCustomerSetting", "type": "object", "x-expandableFields": [ "custom_fields", "default_payment_method", "rendering_options" ], "x-stripeMostCommon": [ "custom_fields", "default_payment_method", "footer", "rendering_options" ] }, "invoice_setting_quote_setting": { "description": "", "properties": { "days_until_due": { "description": "Number of days within which a customer must pay invoices generated by this quote. This value will be `null` for quotes where `collection_method=charge_automatically`.", "nullable": true, "type": "integer" }, "issuer": { "$ref": "#/components/schemas/connect_account_reference" } }, "required": [ "days_until_due", "issuer" ], "title": "InvoiceSettingQuoteSetting", "type": "object", "x-expandableFields": [ "issuer" ], "x-stripeMostCommon": [ "days_until_due", "issuer" ] }, "invoice_setting_subscription_schedule_phase_setting": { "description": "", "properties": { "account_tax_ids": { "description": "The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule.", "items": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/tax_id" }, { "$ref": "#/components/schemas/deleted_tax_id" } ], "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/tax_id" }, { "$ref": "#/components/schemas/deleted_tax_id" } ] } }, "nullable": true, "type": "array" }, "days_until_due": { "description": "Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`.", "nullable": true, "type": "integer" }, "issuer": { "anyOf": [ { "$ref": "#/components/schemas/connect_account_reference" } ], "description": "The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.", "nullable": true } }, "required": [ "account_tax_ids", "days_until_due", "issuer" ], "title": "InvoiceSettingSubscriptionSchedulePhaseSetting", "type": "object", "x-expandableFields": [ "account_tax_ids", "issuer" ], "x-stripeMostCommon": [ "account_tax_ids", "days_until_due", "issuer" ] }, "invoice_setting_subscription_schedule_setting": { "description": "", "properties": { "account_tax_ids": { "description": "The account tax IDs associated with the subscription schedule. Will be set on invoices generated by the subscription schedule.", "items": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/tax_id" }, { "$ref": "#/components/schemas/deleted_tax_id" } ], "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/tax_id" }, { "$ref": "#/components/schemas/deleted_tax_id" } ] } }, "nullable": true, "type": "array" }, "days_until_due": { "description": "Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`.", "nullable": true, "type": "integer" }, "issuer": { "$ref": "#/components/schemas/connect_account_reference" } }, "required": [ "account_tax_ids", "days_until_due", "issuer" ], "title": "InvoiceSettingSubscriptionScheduleSetting", "type": "object", "x-expandableFields": [ "account_tax_ids", "issuer" ], "x-stripeMostCommon": [ "account_tax_ids", "days_until_due", "issuer" ] }, "invoice_threshold_reason": { "description": "", "properties": { "amount_gte": { "description": "The total invoice amount threshold boundary if it triggered the threshold invoice.", "nullable": true, "type": "integer" }, "item_reasons": { "description": "Indicates which line items triggered a threshold invoice.", "items": { "$ref": "#/components/schemas/invoice_item_threshold_reason" }, "type": "array" } }, "required": [ "amount_gte", "item_reasons" ], "title": "InvoiceThresholdReason", "type": "object", "x-expandableFields": [ "item_reasons" ], "x-stripeMostCommon": [ "amount_gte", "item_reasons" ] }, "invoiceitem": { "description": "Invoice Items represent the component lines of an [invoice](https://stripe.com/docs/api/invoices). When you create an invoice item with an `invoice` field, it is attached to the specified invoice and included as [an invoice line item](https://stripe.com/docs/api/invoices/line_item) within [invoice.lines](https://stripe.com/docs/api/invoices/object#invoice_object-lines).\n\nInvoice Items can be created before you are ready to actually send the invoice. This can be particularly useful when combined\nwith a [subscription](https://stripe.com/docs/api/subscriptions). Sometimes you want to add a charge or credit to a customer, but actually charge\nor credit the customer's card only at the end of a regular billing cycle. This is useful for combining several charges\n(to minimize per-transaction fees), or for having Stripe tabulate your usage-based billing totals.\n\nRelated guides: [Integrate with the Invoicing API](https://stripe.com/docs/invoicing/integration), [Subscription Invoices](https://stripe.com/docs/billing/invoices/subscription#adding-upcoming-invoice-items).", "properties": { "amount": { "description": "Amount (in the `currency` specified) of the invoice item. This should always be equal to `unit_amount * quantity`.", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "customer": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/customer" }, { "$ref": "#/components/schemas/deleted_customer" } ], "description": "The ID of the customer who will be billed when this invoice item is billed.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/customer" }, { "$ref": "#/components/schemas/deleted_customer" } ] } }, "customer_account": { "description": "The ID of the account who will be billed when this invoice item is billed.", "maxLength": 5000, "nullable": true, "type": "string" }, "date": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users.", "maxLength": 5000, "nullable": true, "type": "string" }, "discountable": { "description": "If true, discounts will apply to this invoice item. Always false for prorations.", "type": "boolean" }, "discounts": { "description": "The discounts which apply to the invoice item. Item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount.", "items": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/discount" } ], "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/discount" } ] } }, "nullable": true, "type": "array" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "invoice": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/invoice" } ], "description": "The ID of the invoice this invoice item belongs to.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/invoice" } ] } }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "margins": { "description": "The margins which apply to the invoice item. When set, the `default_margins` on the invoice do not apply to this invoice item.", "items": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/margin" } ], "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/margin" } ] } }, "nullable": true, "type": "array" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "nullable": true, "type": "object" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "invoiceitem" ], "type": "string" }, "parent": { "anyOf": [ { "$ref": "#/components/schemas/billing_bill_resource_invoice_item_parents_invoice_item_parent" } ], "description": "The parent that generated this invoice item.", "nullable": true }, "period": { "$ref": "#/components/schemas/invoice_line_item_period" }, "pricing": { "anyOf": [ { "$ref": "#/components/schemas/billing_bill_resource_invoicing_pricing_pricing" } ], "description": "The pricing information of the invoice item.", "nullable": true }, "proration": { "description": "Whether the invoice item was created automatically as a proration adjustment when the customer switched plans.", "type": "boolean" }, "quantity": { "description": "Quantity of units for the invoice item. If the invoice item is a proration, the quantity of the subscription that the proration was computed for.", "type": "integer" }, "tax_rates": { "description": "The tax rates which apply to the invoice item. When set, the `default_tax_rates` on the invoice do not apply to this invoice item.", "items": { "$ref": "#/components/schemas/tax_rate" }, "nullable": true, "type": "array" }, "test_clock": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/test_helpers.test_clock" } ], "description": "ID of the test clock this invoice item belongs to.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/test_helpers.test_clock" } ] } } }, "required": [ "amount", "currency", "customer", "date", "description", "discountable", "discounts", "id", "invoice", "livemode", "metadata", "object", "parent", "period", "pricing", "proration", "quantity", "tax_rates", "test_clock" ], "title": "InvoiceItem", "type": "object", "x-expandableFields": [ "customer", "discounts", "invoice", "margins", "parent", "period", "pricing", "tax_rates", "test_clock" ], "x-resourceId": "invoiceitem", "x-stripeMostCommon": [ "amount", "currency", "customer", "description", "id", "metadata", "parent", "period", "pricing", "proration" ], "x-stripeOperations": [ { "method_name": "delete", "method_on": "service", "method_type": "delete", "operation": "delete", "path": "/v1/invoiceitems/{invoiceitem}" }, { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/invoiceitems" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/invoiceitems/{invoiceitem}" }, { "method_name": "create", "method_on": "service", "method_type": "create", "operation": "post", "path": "/v1/invoiceitems" }, { "method_name": "update", "method_on": "service", "method_type": "update", "operation": "post", "path": "/v1/invoiceitems/{invoiceitem}" } ], "x-stripeResource": { "class_name": "InvoiceItem", "has_collection_class": true, "in_package": "" } }, "invoiceitem.created": { "description": "Occurs whenever an invoice item is created.", "properties": { "object": { "$ref": "#/components/schemas/invoiceitem" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "invoiceitem.created" } }, "invoiceitem.deleted": { "description": "Occurs whenever an invoice item is deleted.", "properties": { "object": { "$ref": "#/components/schemas/invoiceitem" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "invoiceitem.deleted" } }, "invoices_payment_method_options": { "description": "", "properties": { "acss_debit": { "anyOf": [ { "$ref": "#/components/schemas/invoice_payment_method_options_acss_debit" } ], "description": "If paying by `acss_debit`, this sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to the invoice’s PaymentIntent.", "nullable": true }, "bancontact": { "anyOf": [ { "$ref": "#/components/schemas/invoice_payment_method_options_bancontact" } ], "description": "If paying by `bancontact`, this sub-hash contains details about the Bancontact payment method options to pass to the invoice’s PaymentIntent.", "nullable": true }, "card": { "anyOf": [ { "$ref": "#/components/schemas/invoice_payment_method_options_card" } ], "description": "If paying by `card`, this sub-hash contains details about the Card payment method options to pass to the invoice’s PaymentIntent.", "nullable": true }, "customer_balance": { "anyOf": [ { "$ref": "#/components/schemas/invoice_payment_method_options_customer_balance" } ], "description": "If paying by `customer_balance`, this sub-hash contains details about the Bank transfer payment method options to pass to the invoice’s PaymentIntent.", "nullable": true }, "id_bank_transfer": { "anyOf": [ { "$ref": "#/components/schemas/invoice_payment_method_options_id_bank_transfer" } ], "description": "If paying by `id_bank_transfer`, this sub-hash contains details about the Indonesia bank transfer payment method options to pass to the invoice’s PaymentIntent.", "nullable": true }, "konbini": { "anyOf": [ { "$ref": "#/components/schemas/invoice_payment_method_options_konbini" } ], "description": "If paying by `konbini`, this sub-hash contains details about the Konbini payment method options to pass to the invoice’s PaymentIntent.", "nullable": true }, "pix": { "anyOf": [ { "$ref": "#/components/schemas/invoice_payment_method_options_pix" } ], "description": "If paying by `pix`, this sub-hash contains details about the Pix payment method options to pass to the invoice’s PaymentIntent.", "nullable": true }, "sepa_debit": { "anyOf": [ { "$ref": "#/components/schemas/invoice_payment_method_options_sepa_debit" } ], "description": "If paying by `sepa_debit`, this sub-hash contains details about the SEPA Direct Debit payment method options to pass to the invoice’s PaymentIntent.", "nullable": true }, "upi": { "anyOf": [ { "$ref": "#/components/schemas/invoice_payment_method_options_upi" } ], "description": "If paying by `upi`, this sub-hash contains details about the UPI payment method options to pass to the invoice’s PaymentIntent.", "nullable": true }, "us_bank_account": { "anyOf": [ { "$ref": "#/components/schemas/invoice_payment_method_options_us_bank_account" } ], "description": "If paying by `us_bank_account`, this sub-hash contains details about the ACH direct debit payment method options to pass to the invoice’s PaymentIntent.", "nullable": true } }, "required": [ "acss_debit", "bancontact", "card", "customer_balance", "konbini", "sepa_debit", "us_bank_account" ], "title": "InvoicesPaymentMethodOptions", "type": "object", "x-expandableFields": [ "acss_debit", "bancontact", "card", "customer_balance", "id_bank_transfer", "konbini", "pix", "sepa_debit", "upi", "us_bank_account" ], "x-stripeMostCommon": [ "acss_debit", "bancontact", "card", "customer_balance", "id_bank_transfer", "konbini", "pix", "sepa_debit", "upi", "us_bank_account" ] }, "invoices_payment_settings": { "description": "", "properties": { "default_mandate": { "description": "ID of the mandate to be used for this invoice. It must correspond to the payment method used to pay the invoice, including the invoice's default_payment_method or default_source, if set.", "maxLength": 5000, "nullable": true, "type": "string" }, "payment_method_options": { "anyOf": [ { "$ref": "#/components/schemas/invoices_payment_method_options" } ], "description": "Payment-method-specific configuration to provide to the invoice’s PaymentIntent.", "nullable": true }, "payment_method_types": { "description": "The list of payment method types (e.g. card) to provide to the invoice’s PaymentIntent. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your [invoice template settings](https://dashboard.stripe.com/settings/billing/invoice).", "items": { "enum": [ "ach_credit_transfer", "ach_debit", "acss_debit", "affirm", "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", "boleto", "card", "cashapp", "crypto", "custom", "customer_balance", "eps", "fpx", "giropay", "grabpay", "id_bank_transfer", "ideal", "jp_credit_transfer", "kakao_pay", "klarna", "konbini", "kr_card", "link", "multibanco", "naver_pay", "nz_bank_account", "p24", "payco", "paynow", "paypal", "pix", "promptpay", "revolut_pay", "sepa_credit_transfer", "sepa_debit", "sofort", "stripe_balance", "swish", "upi", "us_bank_account", "wechat_pay" ], "type": "string", "x-stripeBypassValidation": true }, "nullable": true, "type": "array" } }, "required": [ "default_mandate", "payment_method_options", "payment_method_types" ], "title": "InvoicesPaymentSettings", "type": "object", "x-expandableFields": [ "payment_method_options" ], "x-stripeMostCommon": [ "default_mandate", "payment_method_options", "payment_method_types" ] }, "invoices_payments_invoice_payment_associated_payment": { "description": "", "properties": { "charge": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/charge" } ], "description": "ID of the successful charge for this payment when `type` is `charge`.Note: charge is only surfaced if the charge object is not associated with a payment intent. If the charge object does have a payment intent, the Invoice Payment surfaces the payment intent instead.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/charge" } ] } }, "payment_intent": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/payment_intent" } ], "description": "ID of the PaymentIntent associated with this payment when `type` is `payment_intent`. Note: This property is only populated for invoices finalized on or after March 15th, 2019.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/payment_intent" } ] } }, "payment_record": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/payment_record" } ], "description": "ID of the PaymentRecord associated with this payment when `type` is `payment_record`.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/payment_record" } ] } }, "type": { "description": "Type of payment object associated with this invoice payment.", "enum": [ "charge", "payment_intent" ], "type": "string" } }, "required": [ "type" ], "title": "InvoicesPaymentsInvoicePaymentAssociatedPayment", "type": "object", "x-expandableFields": [ "charge", "payment_intent", "payment_record" ], "x-stripeMostCommon": [ "payment_intent", "payment_record", "type" ] }, "invoices_payments_invoice_payment_status_transitions": { "description": "", "properties": { "canceled_at": { "description": "The time that the payment was canceled.", "format": "unix-time", "nullable": true, "type": "integer" }, "paid_at": { "description": "The time that the payment succeeded.", "format": "unix-time", "nullable": true, "type": "integer" } }, "required": [ "canceled_at", "paid_at" ], "title": "InvoicesPaymentsInvoicePaymentStatusTransitions", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "canceled_at", "paid_at" ] }, "invoices_resource_confirmation_secret": { "description": "", "properties": { "client_secret": { "description": "The client_secret of the payment that Stripe creates for the invoice after finalization.", "maxLength": 5000, "type": "string" }, "type": { "description": "The type of client_secret. Currently this is always payment_intent, referencing the default payment_intent that Stripe creates during invoice finalization", "maxLength": 5000, "type": "string" } }, "required": [ "client_secret", "type" ], "title": "InvoicesResourceConfirmationSecret", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "client_secret", "type" ] }, "invoices_resource_from_invoice": { "description": "", "properties": { "action": { "description": "The relation between this invoice and the cloned invoice", "maxLength": 5000, "type": "string" }, "invoice": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/invoice" } ], "description": "The invoice that was cloned.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/invoice" } ] } } }, "required": [ "action", "invoice" ], "title": "InvoicesResourceFromInvoice", "type": "object", "x-expandableFields": [ "invoice" ], "x-stripeMostCommon": [ "action", "invoice" ] }, "invoices_resource_invoice_rendering": { "description": "", "properties": { "amount_tax_display": { "description": "How line-item prices and amounts will be displayed with respect to tax on invoice PDFs.", "maxLength": 5000, "nullable": true, "type": "string" }, "pdf": { "anyOf": [ { "$ref": "#/components/schemas/invoice_rendering_pdf" } ], "description": "Invoice pdf rendering options", "nullable": true }, "template": { "description": "ID of the rendering template that the invoice is formatted by.", "maxLength": 5000, "nullable": true, "type": "string" }, "template_version": { "description": "Version of the rendering template that the invoice is using.", "nullable": true, "type": "integer" } }, "required": [ "amount_tax_display", "pdf", "template", "template_version" ], "title": "InvoicesResourceInvoiceRendering", "type": "object", "x-expandableFields": [ "pdf" ], "x-stripeMostCommon": [ "amount_tax_display", "pdf", "template", "template_version" ] }, "invoices_resource_invoice_tax_id": { "description": "", "properties": { "type": { "description": "The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `al_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, `aw_tin`, `az_tin`, `bd_bin`, `bj_ifu`, `et_tin`, `kg_tin`, `la_tin`, `cm_niu`, `cv_nif`, `bf_ifu`, or `unknown`", "enum": [ "ad_nrt", "ae_trn", "al_tin", "am_tin", "ao_tin", "ar_cuit", "au_abn", "au_arn", "aw_tin", "az_tin", "ba_tin", "bb_tin", "bd_bin", "bf_ifu", "bg_uic", "bh_vat", "bj_ifu", "bo_tin", "br_cnpj", "br_cpf", "bs_tin", "by_tin", "ca_bn", "ca_gst_hst", "ca_pst_bc", "ca_pst_mb", "ca_pst_sk", "ca_qst", "cd_nif", "ch_uid", "ch_vat", "cl_tin", "cm_niu", "cn_tin", "co_nit", "cr_tin", "cv_nif", "de_stn", "do_rcn", "ec_ruc", "eg_tin", "es_cif", "et_tin", "eu_oss_vat", "eu_vat", "gb_vat", "ge_vat", "gn_nif", "hk_br", "hr_oib", "hu_tin", "id_npwp", "il_vat", "in_gst", "is_vat", "jp_cn", "jp_rn", "jp_trn", "ke_pin", "kg_tin", "kh_tin", "kr_brn", "kz_bin", "la_tin", "li_uid", "li_vat", "ma_vat", "md_vat", "me_pib", "mk_vat", "mr_nif", "mx_rfc", "my_frp", "my_itn", "my_sst", "ng_tin", "no_vat", "no_voec", "np_pan", "nz_gst", "om_vat", "pe_ruc", "ph_tin", "ro_tin", "rs_pib", "ru_inn", "ru_kpp", "sa_vat", "sg_gst", "sg_uen", "si_tin", "sn_ninea", "sr_fin", "sv_nit", "th_vat", "tj_tin", "tr_tin", "tw_vat", "tz_vat", "ua_vat", "ug_tin", "unknown", "us_ein", "uy_ruc", "uz_tin", "uz_vat", "ve_rif", "vn_tin", "za_vat", "zm_tin", "zw_tin" ], "type": "string" }, "value": { "description": "The value of the tax ID.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "type", "value" ], "title": "InvoicesResourceInvoiceTaxID", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "type", "value" ] }, "invoices_resource_pretax_credit_amount": { "description": "", "properties": { "amount": { "description": "The amount, in cents (or local equivalent), of the pretax credit amount.", "type": "integer" }, "credit_balance_transaction": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/billing.credit_balance_transaction" } ], "description": "The credit balance transaction that was applied to get this pretax credit amount.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/billing.credit_balance_transaction" } ] } }, "discount": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/discount" }, { "$ref": "#/components/schemas/deleted_discount" } ], "description": "The discount that was applied to get this pretax credit amount.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/discount" }, { "$ref": "#/components/schemas/deleted_discount" } ] } }, "margin": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/margin" } ], "description": "The margin that was applied to get this pretax credit amount.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/margin" } ] } }, "type": { "description": "Type of the pretax credit amount referenced.", "enum": [ "credit_balance_transaction", "discount", "margin" ], "type": "string" } }, "required": [ "amount", "type" ], "title": "InvoicesResourcePretaxCreditAmount", "type": "object", "x-expandableFields": [ "credit_balance_transaction", "discount", "margin" ], "x-stripeMostCommon": [ "amount", "credit_balance_transaction", "discount", "margin", "type" ] }, "invoices_resource_shipping_cost": { "description": "", "properties": { "amount_subtotal": { "description": "Total shipping cost before any taxes are applied.", "type": "integer" }, "amount_tax": { "description": "Total tax amount applied due to shipping costs. If no tax was applied, defaults to 0.", "type": "integer" }, "amount_total": { "description": "Total shipping cost after taxes are applied.", "type": "integer" }, "shipping_rate": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/shipping_rate" } ], "description": "The ID of the ShippingRate for this invoice.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/shipping_rate" } ] } }, "taxes": { "description": "The taxes applied to the shipping rate.", "items": { "$ref": "#/components/schemas/line_items_tax_amount" }, "type": "array" } }, "required": [ "amount_subtotal", "amount_tax", "amount_total", "shipping_rate" ], "title": "InvoicesResourceShippingCost", "type": "object", "x-expandableFields": [ "shipping_rate", "taxes" ], "x-stripeMostCommon": [ "amount_subtotal", "amount_tax", "amount_total", "shipping_rate", "taxes" ] }, "invoices_resource_status_transitions": { "description": "", "properties": { "finalized_at": { "description": "The time that the invoice draft was finalized.", "format": "unix-time", "nullable": true, "type": "integer" }, "marked_uncollectible_at": { "description": "The time that the invoice was marked uncollectible.", "format": "unix-time", "nullable": true, "type": "integer" }, "paid_at": { "description": "The time that the invoice was paid.", "format": "unix-time", "nullable": true, "type": "integer" }, "voided_at": { "description": "The time that the invoice was voided.", "format": "unix-time", "nullable": true, "type": "integer" } }, "required": [ "finalized_at", "marked_uncollectible_at", "paid_at", "voided_at" ], "title": "InvoicesResourceStatusTransitions", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "finalized_at", "marked_uncollectible_at", "paid_at", "voided_at" ] }, "issuing.authorization": { "description": "When an [issued card](https://stripe.com/docs/issuing) is used to make a purchase, an Issuing `Authorization`\nobject is created. [Authorizations](https://stripe.com/docs/issuing/purchases/authorizations) must be approved for the\npurchase to be completed successfully.\n\nRelated guide: [Issued card authorizations](https://stripe.com/docs/issuing/purchases/authorizations)", "properties": { "amount": { "description": "The total amount that was authorized or rejected. This amount is in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). `amount` should be the same as `merchant_amount`, unless `currency` and `merchant_currency` are different.", "type": "integer" }, "amount_details": { "anyOf": [ { "$ref": "#/components/schemas/issuing_authorization_amount_details" } ], "description": "Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", "nullable": true }, "approved": { "description": "Whether the authorization has been approved.", "type": "boolean" }, "authorization_method": { "description": "How the card details were provided.", "enum": [ "chip", "contactless", "keyed_in", "online", "swipe" ], "type": "string" }, "balance_transactions": { "description": "List of balance transactions associated with this authorization.", "items": { "$ref": "#/components/schemas/balance_transaction" }, "type": "array" }, "card": { "$ref": "#/components/schemas/issuing.card" }, "cardholder": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/issuing.cardholder" } ], "description": "The cardholder to whom this authorization belongs.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/issuing.cardholder" } ] } }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "currency": { "description": "The currency of the cardholder. This currency can be different from the currency presented at authorization and the `merchant_currency` field on this authorization. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "fleet": { "anyOf": [ { "$ref": "#/components/schemas/issuing_authorization_fleet_data" } ], "description": "Fleet-specific information for authorizations using Fleet cards.", "nullable": true }, "fraud_challenges": { "description": "Fraud challenges sent to the cardholder, if this authorization was declined for fraud risk reasons.", "items": { "$ref": "#/components/schemas/issuing_authorization_fraud_challenge" }, "nullable": true, "type": "array" }, "fuel": { "anyOf": [ { "$ref": "#/components/schemas/issuing_authorization_fuel_data" } ], "description": "Information about fuel that was purchased with this transaction. Typically this information is received from the merchant after the authorization has been approved and the fuel dispensed.", "nullable": true }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "merchant_amount": { "description": "The total amount that was authorized or rejected. This amount is in the `merchant_currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). `merchant_amount` should be the same as `amount`, unless `merchant_currency` and `currency` are different.", "type": "integer" }, "merchant_currency": { "description": "The local currency that was presented to the cardholder for the authorization. This currency can be different from the cardholder currency and the `currency` field on this authorization. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "merchant_data": { "$ref": "#/components/schemas/issuing_authorization_merchant_data" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "type": "object" }, "network_data": { "anyOf": [ { "$ref": "#/components/schemas/issuing_authorization_network_data" } ], "description": "Details about the authorization, such as identifiers, set by the card network.", "nullable": true }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "issuing.authorization" ], "type": "string" }, "pending_request": { "anyOf": [ { "$ref": "#/components/schemas/issuing_authorization_pending_request" } ], "description": "The pending authorization request. This field will only be non-null during an `issuing_authorization.request` webhook.", "nullable": true }, "request_history": { "description": "History of every time a `pending_request` authorization was approved/declined, either by you directly or by Stripe (e.g. based on your spending_controls). If the merchant changes the authorization by performing an incremental authorization, you can look at this field to see the previous requests for the authorization. This field can be helpful in determining why a given authorization was approved/declined.", "items": { "$ref": "#/components/schemas/issuing_authorization_request" }, "type": "array" }, "status": { "description": "The current status of the authorization in its lifecycle.", "enum": [ "closed", "expired", "pending", "reversed" ], "type": "string" }, "token": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/issuing.token" } ], "description": "[Token](https://stripe.com/docs/api/issuing/tokens/object) object used for this authorization. If a network token was not used for this authorization, this field will be null.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/issuing.token" } ] } }, "transactions": { "description": "List of [transactions](https://stripe.com/docs/api/issuing/transactions) associated with this authorization.", "items": { "$ref": "#/components/schemas/issuing.transaction" }, "type": "array" }, "treasury": { "anyOf": [ { "$ref": "#/components/schemas/issuing_authorization_treasury" } ], "description": "[Treasury](https://stripe.com/docs/api/treasury) details related to this authorization if it was created on a [FinancialAccount](https://stripe.com/docs/api/treasury/financial_accounts).", "nullable": true }, "verification_data": { "$ref": "#/components/schemas/issuing_authorization_verification_data" }, "verified_by_fraud_challenge": { "description": "Whether the authorization bypassed fraud risk checks because the cardholder has previously completed a fraud challenge on a similar high-risk authorization from the same merchant.", "nullable": true, "type": "boolean" }, "wallet": { "description": "The digital wallet used for this transaction. One of `apple_pay`, `google_pay`, or `samsung_pay`. Will populate as `null` when no digital wallet was utilized.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "amount", "amount_details", "approved", "authorization_method", "balance_transactions", "card", "cardholder", "created", "currency", "fleet", "fuel", "id", "livemode", "merchant_amount", "merchant_currency", "merchant_data", "metadata", "network_data", "object", "pending_request", "request_history", "status", "transactions", "verification_data", "verified_by_fraud_challenge", "wallet" ], "title": "IssuingAuthorization", "type": "object", "x-expandableFields": [ "amount_details", "balance_transactions", "card", "cardholder", "fleet", "fraud_challenges", "fuel", "merchant_data", "network_data", "pending_request", "request_history", "token", "transactions", "treasury", "verification_data" ], "x-resourceId": "issuing.authorization", "x-stripeMostCommon": [ "amount", "approved", "card", "cardholder", "currency", "id", "metadata", "status" ], "x-stripeOperations": [ { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/issuing/authorizations" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/issuing/authorizations/{authorization}" }, { "method_name": "update", "method_on": "service", "method_type": "update", "operation": "post", "path": "/v1/issuing/authorizations/{authorization}" }, { "method_name": "approve", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/issuing/authorizations/{authorization}/approve" }, { "method_name": "decline", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/issuing/authorizations/{authorization}/decline" }, { "method_name": "create", "method_on": "service", "method_type": "create", "operation": "post", "path": "/v1/test_helpers/issuing/authorizations" }, { "method_name": "capture", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/test_helpers/issuing/authorizations/{authorization}/capture" }, { "method_name": "expire", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/test_helpers/issuing/authorizations/{authorization}/expire" }, { "method_name": "finalize_amount", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/test_helpers/issuing/authorizations/{authorization}/finalize_amount" }, { "method_name": "respond", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/test_helpers/issuing/authorizations/{authorization}/fraud_challenges/respond" }, { "method_name": "increment", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/test_helpers/issuing/authorizations/{authorization}/increment" }, { "method_name": "reverse", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/test_helpers/issuing/authorizations/{authorization}/reverse" } ], "x-stripeResource": { "class_name": "Authorization", "has_collection_class": true, "in_package": "Issuing", "polymorphic_groups": [ "balance_transaction_source" ] } }, "issuing.card": { "description": "You can [create physical or virtual cards](https://stripe.com/docs/issuing) that are issued to cardholders.", "properties": { "brand": { "description": "The brand of the card.", "maxLength": 5000, "type": "string" }, "cancellation_reason": { "description": "The reason why the card was canceled.", "enum": [ "design_rejected", "lost", "stolen" ], "nullable": true, "type": "string", "x-stripeBypassValidation": true }, "cardholder": { "$ref": "#/components/schemas/issuing.cardholder" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Supported currencies are `usd` in the US, `eur` in the EU, and `gbp` in the UK.", "format": "currency", "type": "string" }, "cvc": { "description": "The card's CVC. For security reasons, this is only available for virtual cards, and will be omitted unless you explicitly request it with [the `expand` parameter](https://stripe.com/docs/api/expanding_objects). Additionally, it's only available via the [\"Retrieve a card\" endpoint](https://stripe.com/docs/api/issuing/cards/retrieve), not via \"List all cards\" or any other endpoint.", "maxLength": 5000, "type": "string" }, "exp_month": { "description": "The expiration month of the card.", "type": "integer" }, "exp_year": { "description": "The expiration year of the card.", "type": "integer" }, "financial_account": { "description": "The financial account this card is attached to.", "maxLength": 5000, "nullable": true, "type": "string" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "last4": { "description": "The last 4 digits of the card number.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "type": "object" }, "number": { "description": "The full unredacted card number. For security reasons, this is only available for virtual cards, and will be omitted unless you explicitly request it with [the `expand` parameter](https://stripe.com/docs/api/expanding_objects). Additionally, it's only available via the [\"Retrieve a card\" endpoint](https://stripe.com/docs/api/issuing/cards/retrieve), not via \"List all cards\" or any other endpoint.", "maxLength": 5000, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "issuing.card" ], "type": "string" }, "personalization_design": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/issuing.personalization_design" } ], "description": "The personalization design object belonging to this card.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/issuing.personalization_design" } ] } }, "replaced_by": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/issuing.card" } ], "description": "The latest card that replaces this card, if any.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/issuing.card" } ] } }, "replacement_for": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/issuing.card" } ], "description": "The card this card replaces, if any.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/issuing.card" } ] } }, "replacement_reason": { "description": "The reason why the previous card needed to be replaced.", "enum": [ "damaged", "expired", "lost", "stolen" ], "nullable": true, "type": "string", "x-stripeBypassValidation": true }, "shipping": { "anyOf": [ { "$ref": "#/components/schemas/issuing_card_shipping" } ], "description": "Where and how the card will be shipped.", "nullable": true }, "spending_controls": { "$ref": "#/components/schemas/issuing_card_authorization_controls" }, "status": { "description": "Whether authorizations can be approved on this card. May be blocked from activating cards depending on past-due Cardholder requirements. Defaults to `inactive`.", "enum": [ "active", "canceled", "inactive" ], "type": "string", "x-stripeBypassValidation": true }, "type": { "description": "The type of the card.", "enum": [ "physical", "virtual" ], "type": "string" }, "wallets": { "anyOf": [ { "$ref": "#/components/schemas/issuing_card_wallets" } ], "description": "Information relating to digital wallets (like Apple Pay and Google Pay).", "nullable": true } }, "required": [ "brand", "cancellation_reason", "cardholder", "created", "currency", "exp_month", "exp_year", "id", "last4", "livemode", "metadata", "object", "personalization_design", "replaced_by", "replacement_for", "replacement_reason", "shipping", "spending_controls", "status", "type", "wallets" ], "title": "IssuingCard", "type": "object", "x-expandableFields": [ "cardholder", "personalization_design", "replaced_by", "replacement_for", "shipping", "spending_controls", "wallets" ], "x-resourceId": "issuing.card", "x-stripeMostCommon": [ "cancellation_reason", "cardholder", "currency", "exp_month", "exp_year", "id", "last4", "metadata", "status", "type" ], "x-stripeOperations": [ { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/issuing/cards" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/issuing/cards/{card}" }, { "method_name": "create", "method_on": "service", "method_type": "create", "operation": "post", "path": "/v1/issuing/cards" }, { "method_name": "update", "method_on": "service", "method_type": "update", "operation": "post", "path": "/v1/issuing/cards/{card}" }, { "method_name": "deliver_card", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/test_helpers/issuing/cards/{card}/shipping/deliver" }, { "method_name": "fail_card", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/test_helpers/issuing/cards/{card}/shipping/fail" }, { "method_name": "return_card", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/test_helpers/issuing/cards/{card}/shipping/return" }, { "method_name": "ship_card", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/test_helpers/issuing/cards/{card}/shipping/ship" }, { "method_name": "submit_card", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/test_helpers/issuing/cards/{card}/shipping/submit" } ], "x-stripeResource": { "class_name": "Card", "has_collection_class": true, "in_package": "Issuing" } }, "issuing.cardholder": { "description": "An Issuing `Cardholder` object represents an individual or business entity who is [issued](https://stripe.com/docs/issuing) cards.\n\nRelated guide: [How to create a cardholder](https://stripe.com/docs/issuing/cards/virtual/issue-cards#create-cardholder)", "properties": { "billing": { "$ref": "#/components/schemas/issuing_cardholder_address" }, "company": { "anyOf": [ { "$ref": "#/components/schemas/issuing_cardholder_company" } ], "description": "Additional information about a `company` cardholder.", "nullable": true }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "email": { "description": "The cardholder's email address.", "maxLength": 5000, "nullable": true, "type": "string" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "individual": { "anyOf": [ { "$ref": "#/components/schemas/issuing_cardholder_individual" } ], "description": "Additional information about an `individual` cardholder.", "nullable": true }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "type": "object" }, "name": { "description": "The cardholder's name. This will be printed on cards issued to them.", "maxLength": 5000, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "issuing.cardholder" ], "type": "string" }, "phone_number": { "description": "The cardholder's phone number. This is required for all cardholders who will be creating EU cards. See the [3D Secure documentation](https://stripe.com/docs/issuing/3d-secure#when-is-3d-secure-applied) for more details.", "maxLength": 5000, "nullable": true, "type": "string" }, "preferred_locales": { "description": "The cardholder’s preferred locales (languages), ordered by preference. Locales can be `de`, `en`, `es`, `fr`, or `it`.\n This changes the language of the [3D Secure flow](https://stripe.com/docs/issuing/3d-secure) and one-time password messages sent to the cardholder.", "items": { "enum": [ "de", "en", "es", "fr", "it" ], "type": "string" }, "nullable": true, "type": "array" }, "requirements": { "$ref": "#/components/schemas/issuing_cardholder_requirements" }, "spending_controls": { "anyOf": [ { "$ref": "#/components/schemas/issuing_cardholder_authorization_controls" } ], "description": "Rules that control spending across this cardholder's cards. Refer to our [documentation](https://stripe.com/docs/issuing/controls/spending-controls) for more details.", "nullable": true }, "status": { "description": "Specifies whether to permit authorizations on this cardholder's cards.", "enum": [ "active", "blocked", "inactive" ], "type": "string" }, "type": { "description": "One of `individual` or `company`. See [Choose a cardholder type](https://stripe.com/docs/issuing/other/choose-cardholder) for more details.", "enum": [ "company", "individual" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "billing", "company", "created", "email", "id", "individual", "livemode", "metadata", "name", "object", "phone_number", "preferred_locales", "requirements", "spending_controls", "status", "type" ], "title": "IssuingCardholder", "type": "object", "x-expandableFields": [ "billing", "company", "individual", "requirements", "spending_controls" ], "x-resourceId": "issuing.cardholder", "x-stripeMostCommon": [ "billing", "email", "id", "metadata", "name", "phone_number" ], "x-stripeOperations": [ { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/issuing/cardholders" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/issuing/cardholders/{cardholder}" }, { "method_name": "create", "method_on": "service", "method_type": "create", "operation": "post", "path": "/v1/issuing/cardholders" }, { "method_name": "update", "method_on": "service", "method_type": "update", "operation": "post", "path": "/v1/issuing/cardholders/{cardholder}" } ], "x-stripeResource": { "class_name": "Cardholder", "has_collection_class": true, "in_package": "Issuing" } }, "issuing.credit_underwriting_record": { "description": "Every time an applicant submits an application for a Charge Card product your platform offers, or every time your platform takes a proactive credit decision on an existing account, you must record the decision by creating a new `CreditUnderwritingRecord` object on a connected account.\n\n[Follow the guide](https://stripe.com/docs/issuing/credit/report-credit-decisions-and-manage-aans) to learn about your requirements as a platform.", "properties": { "application": { "anyOf": [ { "$ref": "#/components/schemas/issuing_compliance_credit_underwriting_record_application" } ], "description": "For decisions triggered by an application, details about the submission.", "nullable": true }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "created_from": { "description": "The event that triggered the underwriting.", "enum": [ "application", "proactive_review" ], "type": "string" }, "credit_user": { "$ref": "#/components/schemas/issuing_compliance_credit_underwriting_record_credit_user" }, "decided_at": { "description": "Date when a decision was made.", "format": "unix-time", "nullable": true, "type": "integer" }, "decision": { "anyOf": [ { "$ref": "#/components/schemas/issuing_compliance_credit_underwriting_record_decision" } ], "description": "Details about the decision.", "nullable": true }, "decision_deadline": { "description": "For underwriting initiated by an application, a decision must be taken 30 days after the submission.", "format": "unix-time", "nullable": true, "type": "integer" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "nullable": true, "type": "object" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "issuing.credit_underwriting_record" ], "type": "string" }, "regulatory_reporting_file": { "description": "File containing regulatory reporting data for the decision. Required if you are subject to this [reporting requirement](https://stripe.com/docs/issuing/credit/report-required-regulatory-data-for-credit-decisions).", "maxLength": 5000, "nullable": true, "type": "string" }, "underwriting_exception": { "anyOf": [ { "$ref": "#/components/schemas/issuing_compliance_credit_underwriting_record_underwriting_exception" } ], "description": "If an exception to the usual underwriting criteria was made for this application, details about the exception must be provided. Exceptions should only be granted in rare circumstances, in consultation with Stripe Compliance.", "nullable": true } }, "required": [ "application", "created", "created_from", "credit_user", "decided_at", "decision", "decision_deadline", "id", "livemode", "metadata", "object", "regulatory_reporting_file", "underwriting_exception" ], "title": "IssuingComplianceCreditUnderwritingRecord", "type": "object", "x-expandableFields": [ "application", "credit_user", "decision", "underwriting_exception" ], "x-resourceId": "issuing.credit_underwriting_record", "x-stripeMostCommon": [ "application", "credit_user", "decided_at", "decision", "decision_deadline", "id", "metadata" ], "x-stripeOperations": [ { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/issuing/credit_underwriting_records" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/issuing/credit_underwriting_records/{credit_underwriting_record}" }, { "method_name": "correct", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/issuing/credit_underwriting_records/{credit_underwriting_record}/correct" }, { "method_name": "report_decision", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/issuing/credit_underwriting_records/{credit_underwriting_record}/report_decision" }, { "method_name": "create_from_application", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/issuing/credit_underwriting_records/create_from_application" }, { "method_name": "create_from_proactive_review", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/issuing/credit_underwriting_records/create_from_proactive_review" } ], "x-stripeResource": { "class_name": "CreditUnderwritingRecord", "has_collection_class": true, "in_package": "Issuing" } }, "issuing.dispute": { "description": "As a [card issuer](https://stripe.com/docs/issuing), you can dispute transactions that the cardholder does not recognize, suspects to be fraudulent, or has other issues with.\n\nRelated guide: [Issuing disputes](https://stripe.com/docs/issuing/purchases/disputes)", "properties": { "amount": { "description": "Disputed amount in the card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Usually the amount of the `transaction`, but can differ (usually because of currency fluctuation).", "type": "integer" }, "balance_transactions": { "description": "List of balance transactions associated with the dispute.", "items": { "$ref": "#/components/schemas/balance_transaction" }, "nullable": true, "type": "array" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "currency": { "description": "The currency the `transaction` was made in.", "format": "currency", "type": "string" }, "evidence": { "$ref": "#/components/schemas/issuing_dispute_evidence" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "loss_reason": { "description": "The enum that describes the dispute loss outcome. If the dispute is not lost, this field will be absent. New enum values may be added in the future, so be sure to handle unknown values.", "enum": [ "cardholder_authentication_issuer_liability", "eci5_token_transaction_with_tavv", "excess_disputes_in_timeframe", "has_not_met_the_minimum_dispute_amount_requirements", "invalid_duplicate_dispute", "invalid_incorrect_amount_dispute", "invalid_no_authorization", "invalid_use_of_disputes", "merchandise_delivered_or_shipped", "merchandise_or_service_as_described", "not_cancelled", "other", "refund_issued", "submitted_beyond_allowable_time_limit", "transaction_3ds_required", "transaction_approved_after_prior_fraud_dispute", "transaction_authorized", "transaction_electronically_read", "transaction_qualifies_for_visa_easy_payment_service", "transaction_unattended" ], "type": "string" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "type": "object" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "issuing.dispute" ], "type": "string" }, "status": { "description": "Current status of the dispute.", "enum": [ "expired", "lost", "submitted", "unsubmitted", "won" ], "type": "string" }, "transaction": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/issuing.transaction" } ], "description": "The transaction being disputed.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/issuing.transaction" } ] } }, "treasury": { "anyOf": [ { "$ref": "#/components/schemas/issuing_dispute_treasury" } ], "description": "[Treasury](https://stripe.com/docs/api/treasury) details related to this dispute if it was created on a [FinancialAccount](/docs/api/treasury/financial_accounts", "nullable": true } }, "required": [ "amount", "created", "currency", "evidence", "id", "livemode", "metadata", "object", "status", "transaction" ], "title": "IssuingDispute", "type": "object", "x-expandableFields": [ "balance_transactions", "evidence", "transaction", "treasury" ], "x-resourceId": "issuing.dispute", "x-stripeMostCommon": [ "amount", "balance_transactions", "currency", "evidence", "id", "metadata", "status", "transaction" ], "x-stripeOperations": [ { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/issuing/disputes" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/issuing/disputes/{dispute}" }, { "method_name": "create", "method_on": "service", "method_type": "create", "operation": "post", "path": "/v1/issuing/disputes" }, { "method_name": "update", "method_on": "service", "method_type": "update", "operation": "post", "path": "/v1/issuing/disputes/{dispute}" }, { "method_name": "submit", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/issuing/disputes/{dispute}/submit" } ], "x-stripeResource": { "class_name": "Dispute", "has_collection_class": true, "in_package": "Issuing", "polymorphic_groups": [ "balance_transaction_source" ] } }, "issuing.dispute_settlement_detail": { "description": "Represents a record from the card network of a money movement or change in state for an Issuing dispute. These records are included in the settlement reports that we receive from networks and expose to users as Settlement objects.", "properties": { "amount": { "description": "Disputed amount in the card’s currency and in the smallest currency unit. Usually the amount of the transaction, but can differ (usually because of currency fluctuation).", "type": "integer" }, "card": { "description": "The card used to make the original transaction.", "maxLength": 5000, "type": "string" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "currency": { "description": "The currency the original transaction was made in. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "dispute": { "description": "The ID of the linked dispute.", "maxLength": 5000, "type": "string" }, "event_type": { "description": "The type of event corresponding to this dispute settlement detail, representing the stage in the dispute network lifecycle.", "enum": [ "filing", "loss", "representment", "win" ], "type": "string" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "network": { "description": "The card network for this dispute settlement detail. One of [\"visa\", \"mastercard\", \"maestro\"]", "enum": [ "maestro", "mastercard", "visa" ], "type": "string" }, "network_data": { "anyOf": [ { "$ref": "#/components/schemas/issuing_dispute_settlement_detail_network_data" } ], "description": "Details about the transaction, such as processing dates, set by the card network.", "nullable": true }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "issuing.dispute_settlement_detail" ], "type": "string" }, "settlement": { "description": "The ID of the linked card network settlement.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "amount", "card", "created", "currency", "dispute", "event_type", "id", "livemode", "network", "network_data", "object", "settlement" ], "title": "IssuingDisputeSettlementDetail", "type": "object", "x-expandableFields": [ "network_data" ], "x-resourceId": "issuing.dispute_settlement_detail", "x-stripeMostCommon": [ "dispute", "event_type", "id", "settlement" ], "x-stripeOperations": [ { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/issuing/dispute_settlement_details" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/issuing/dispute_settlement_details/{dispute_settlement_detail}" } ], "x-stripeResource": { "class_name": "DisputeSettlementDetail", "has_collection_class": true, "in_package": "Issuing" } }, "issuing.fraud_liability_debit": { "description": "A fraud liability debit occurs when Stripe debits a platform's account for fraud losses on Issuing transactions.", "properties": { "amount": { "description": "Debited amount. This is equal to the disputed amount and is given in the card’s currency and in the smallest currency unit.", "type": "integer" }, "balance_transaction": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/balance_transaction" } ], "description": "ID of the [balance transaction](https://stripe.com/docs/api/balance_transactions) associated with this debit.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/balance_transaction" } ] } }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "currency": { "description": "The currency of the debit. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "dispute": { "description": "The ID of the linked dispute.", "maxLength": 5000, "type": "string" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "issuing.fraud_liability_debit" ], "type": "string" } }, "required": [ "amount", "balance_transaction", "created", "currency", "dispute", "id", "livemode", "object" ], "title": "IssuingFraudLiabilityDebit", "type": "object", "x-expandableFields": [ "balance_transaction" ], "x-resourceId": "issuing.fraud_liability_debit", "x-stripeMostCommon": [ "amount", "currency", "dispute", "id" ], "x-stripeOperations": [ { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/issuing/fraud_liability_debits" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/issuing/fraud_liability_debits/{fraud_liability_debit}" } ], "x-stripeResource": { "class_name": "FraudLiabilityDebit", "has_collection_class": true, "in_package": "Issuing" } }, "issuing.personalization_design": { "description": "A Personalization Design is a logical grouping of a Physical Bundle, card logo, and carrier text that represents a product line.", "properties": { "card_logo": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/file" } ], "description": "The file for the card logo to use with physical bundles that support card logos. Must have a `purpose` value of `issuing_logo`.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/file" } ] } }, "carrier_text": { "anyOf": [ { "$ref": "#/components/schemas/issuing_personalization_design_carrier_text" } ], "description": "Hash containing carrier text, for use with physical bundles that support carrier text.", "nullable": true }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "lookup_key": { "description": "A lookup key used to retrieve personalization designs dynamically from a static string. This may be up to 200 characters.", "maxLength": 5000, "nullable": true, "type": "string" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "type": "object" }, "name": { "description": "Friendly display name.", "maxLength": 5000, "nullable": true, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "issuing.personalization_design" ], "type": "string" }, "physical_bundle": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/issuing.physical_bundle" } ], "description": "The physical bundle object belonging to this personalization design.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/issuing.physical_bundle" } ] } }, "preferences": { "$ref": "#/components/schemas/issuing_personalization_design_preferences" }, "rejection_reasons": { "$ref": "#/components/schemas/issuing_personalization_design_rejection_reasons" }, "status": { "description": "Whether this personalization design can be used to create cards.", "enum": [ "active", "inactive", "rejected", "review" ], "type": "string" } }, "required": [ "card_logo", "carrier_text", "created", "id", "livemode", "lookup_key", "metadata", "name", "object", "physical_bundle", "preferences", "rejection_reasons", "status" ], "title": "IssuingPersonalizationDesign", "type": "object", "x-expandableFields": [ "card_logo", "carrier_text", "physical_bundle", "preferences", "rejection_reasons" ], "x-resourceId": "issuing.personalization_design", "x-stripeMostCommon": [ "card_logo", "carrier_text", "created", "id", "livemode", "lookup_key", "metadata", "name", "object", "physical_bundle", "preferences", "rejection_reasons", "status" ], "x-stripeOperations": [ { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/issuing/personalization_designs" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/issuing/personalization_designs/{personalization_design}" }, { "method_name": "create", "method_on": "service", "method_type": "create", "operation": "post", "path": "/v1/issuing/personalization_designs" }, { "method_name": "update", "method_on": "service", "method_type": "update", "operation": "post", "path": "/v1/issuing/personalization_designs/{personalization_design}" }, { "method_name": "activate", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/test_helpers/issuing/personalization_designs/{personalization_design}/activate" }, { "method_name": "deactivate", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/test_helpers/issuing/personalization_designs/{personalization_design}/deactivate" }, { "method_name": "reject", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/test_helpers/issuing/personalization_designs/{personalization_design}/reject" } ], "x-stripeResource": { "class_name": "PersonalizationDesign", "has_collection_class": true, "in_package": "Issuing" } }, "issuing.physical_bundle": { "description": "A Physical Bundle represents the bundle of physical items - card stock, carrier letter, and envelope - that is shipped to a cardholder when you create a physical card.", "properties": { "features": { "$ref": "#/components/schemas/issuing_physical_bundle_features" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "name": { "description": "Friendly display name.", "maxLength": 5000, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "issuing.physical_bundle" ], "type": "string" }, "status": { "description": "Whether this physical bundle can be used to create cards.", "enum": [ "active", "inactive", "review" ], "type": "string" }, "type": { "description": "Whether this physical bundle is a standard Stripe offering or custom-made for you.", "enum": [ "custom", "standard" ], "type": "string" } }, "required": [ "features", "id", "livemode", "name", "object", "status", "type" ], "title": "IssuingPhysicalBundle", "type": "object", "x-expandableFields": [ "features" ], "x-resourceId": "issuing.physical_bundle", "x-stripeMostCommon": [ "features", "id", "livemode", "name", "object", "status", "type" ], "x-stripeOperations": [ { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/issuing/physical_bundles" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/issuing/physical_bundles/{physical_bundle}" } ], "x-stripeResource": { "class_name": "PhysicalBundle", "has_collection_class": true, "in_package": "Issuing" } }, "issuing.settlement": { "description": "When a non-stripe BIN is used, any use of an [issued card](https://stripe.com/docs/issuing) must be settled directly with the card network. The net amount owed is represented by an Issuing `Settlement` object.", "properties": { "bin": { "description": "The Bank Identification Number reflecting this settlement record.", "maxLength": 5000, "type": "string" }, "clearing_date": { "description": "The date that the transactions are cleared and posted to user's accounts.", "format": "unix-time", "type": "integer" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "interchange_fees_amount": { "description": "The total interchange received as reimbursement for the transactions.", "type": "integer" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "type": "object" }, "net_total_amount": { "description": "The total net amount required to settle with the network.", "type": "integer" }, "network": { "description": "The card network for this settlement report. One of [\"visa\", \"maestro\"]", "enum": [ "maestro", "visa" ], "type": "string" }, "network_fees_amount": { "description": "The total amount of fees owed to the network.", "type": "integer" }, "network_settlement_identifier": { "description": "The Settlement Identification Number assigned by the network.", "maxLength": 5000, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "issuing.settlement" ], "type": "string" }, "other_fees_amount": { "description": "The total amount of any additional fees assessed by the card network.", "type": "integer" }, "other_fees_count": { "description": "The total number of additional fees assessed by the card network.", "type": "integer" }, "settlement_service": { "description": "One of `international` or `uk_national_net`.", "maxLength": 5000, "type": "string" }, "status": { "description": "The current processing status of this settlement.", "enum": [ "complete", "pending" ], "type": "string" }, "transaction_amount": { "description": "The total transaction amount reflected in this settlement.", "type": "integer" }, "transaction_count": { "description": "The total number of transactions reflected in this settlement.", "type": "integer" } }, "required": [ "bin", "clearing_date", "created", "currency", "id", "interchange_fees_amount", "livemode", "metadata", "net_total_amount", "network", "network_fees_amount", "network_settlement_identifier", "object", "settlement_service", "status", "transaction_amount", "transaction_count" ], "title": "IssuingSettlement", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "bin", "clearing_date", "currency", "id", "metadata", "net_total_amount" ], "x-stripeResource": { "class_name": "Settlement", "in_package": "Issuing" } }, "issuing.token": { "description": "An issuing token object is created when an issued card is added to a digital wallet. As a [card issuer](https://stripe.com/docs/issuing), you can [view and manage these tokens](https://stripe.com/docs/issuing/controls/token-management) through Stripe.", "properties": { "card": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/issuing.card" } ], "description": "Card associated with this token.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/issuing.card" } ] } }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "device_fingerprint": { "description": "The hashed ID derived from the device ID from the card network associated with the token.", "maxLength": 5000, "nullable": true, "type": "string" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "last4": { "description": "The last four digits of the token.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "network": { "description": "The token service provider / card network associated with the token.", "enum": [ "mastercard", "visa" ], "type": "string" }, "network_data": { "$ref": "#/components/schemas/issuing_network_token_network_data" }, "network_updated_at": { "description": "Time at which the token was last updated by the card network. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "issuing.token" ], "type": "string" }, "status": { "description": "The usage state of the token.", "enum": [ "active", "deleted", "requested", "suspended" ], "type": "string" }, "wallet_provider": { "description": "The digital wallet for this token, if one was used.", "enum": [ "apple_pay", "google_pay", "samsung_pay" ], "type": "string" } }, "required": [ "card", "created", "device_fingerprint", "id", "livemode", "network", "network_updated_at", "object", "status" ], "title": "IssuingNetworkToken", "type": "object", "x-expandableFields": [ "card", "network_data" ], "x-resourceId": "issuing.token", "x-stripeMostCommon": [ "card", "created", "device_fingerprint", "id", "last4", "livemode", "network", "network_data", "network_updated_at", "object", "status", "wallet_provider" ], "x-stripeOperations": [ { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/issuing/tokens" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/issuing/tokens/{token}" }, { "method_name": "update", "method_on": "service", "method_type": "update", "operation": "post", "path": "/v1/issuing/tokens/{token}" } ], "x-stripeResource": { "class_name": "Token", "has_collection_class": true, "in_package": "Issuing" } }, "issuing.transaction": { "description": "Any use of an [issued card](https://stripe.com/docs/issuing) that results in funds entering or leaving\nyour Stripe account, such as a completed purchase or refund, is represented by an Issuing\n`Transaction` object.\n\nRelated guide: [Issued card transactions](https://stripe.com/docs/issuing/purchases/transactions)", "properties": { "amount": { "description": "The transaction amount, which will be reflected in your balance. This amount is in your currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", "type": "integer" }, "amount_details": { "anyOf": [ { "$ref": "#/components/schemas/issuing_transaction_amount_details" } ], "description": "Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", "nullable": true }, "authorization": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/issuing.authorization" } ], "description": "The `Authorization` object that led to this transaction.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/issuing.authorization" } ] } }, "balance_transaction": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/balance_transaction" } ], "description": "ID of the [balance transaction](https://stripe.com/docs/api/balance_transactions) associated with this transaction.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/balance_transaction" } ] } }, "card": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/issuing.card" } ], "description": "The card used to make this transaction.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/issuing.card" } ] } }, "cardholder": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/issuing.cardholder" } ], "description": "The cardholder to whom this transaction belongs.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/issuing.cardholder" } ] } }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "dispute": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/issuing.dispute" } ], "description": "If you've disputed the transaction, the ID of the dispute.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/issuing.dispute" } ] } }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "merchant_amount": { "description": "The amount that the merchant will receive, denominated in `merchant_currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). It will be different from `amount` if the merchant is taking payment in a different currency.", "type": "integer" }, "merchant_currency": { "description": "The currency with which the merchant is taking payment.", "format": "currency", "type": "string" }, "merchant_data": { "$ref": "#/components/schemas/issuing_authorization_merchant_data" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "type": "object" }, "network_data": { "anyOf": [ { "$ref": "#/components/schemas/issuing_transaction_network_data" } ], "description": "Details about the transaction, such as processing dates, set by the card network.", "nullable": true }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "issuing.transaction" ], "type": "string" }, "purchase_details": { "anyOf": [ { "$ref": "#/components/schemas/issuing_transaction_purchase_details" } ], "description": "Additional purchase information that is optionally provided by the merchant.", "nullable": true }, "settlement": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/issuing.settlement" } ], "description": "The ID of the [settlement](https://stripe.com/docs/api/issuing/settlements) to which this transaction belongs.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/issuing.settlement" } ] } }, "token": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/issuing.token" } ], "description": "[Token](https://stripe.com/docs/api/issuing/tokens/object) object used for this transaction. If a network token was not used for this transaction, this field will be null.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/issuing.token" } ] } }, "treasury": { "anyOf": [ { "$ref": "#/components/schemas/issuing_transaction_treasury" } ], "description": "[Treasury](https://stripe.com/docs/api/treasury) details related to this transaction if it was created on a [FinancialAccount](/docs/api/treasury/financial_accounts", "nullable": true }, "type": { "description": "The nature of the transaction.", "enum": [ "capture", "refund" ], "type": "string", "x-stripeBypassValidation": true }, "wallet": { "description": "The digital wallet used for this transaction. One of `apple_pay`, `google_pay`, or `samsung_pay`.", "enum": [ "apple_pay", "google_pay", "samsung_pay" ], "nullable": true, "type": "string" } }, "required": [ "amount", "amount_details", "authorization", "balance_transaction", "card", "cardholder", "created", "currency", "dispute", "id", "livemode", "merchant_amount", "merchant_currency", "merchant_data", "metadata", "network_data", "object", "type", "wallet" ], "title": "IssuingTransaction", "type": "object", "x-expandableFields": [ "amount_details", "authorization", "balance_transaction", "card", "cardholder", "dispute", "merchant_data", "network_data", "purchase_details", "settlement", "token", "treasury" ], "x-resourceId": "issuing.transaction", "x-stripeMostCommon": [ "amount", "authorization", "card", "cardholder", "currency", "id", "metadata", "type" ], "x-stripeOperations": [ { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/issuing/transactions" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/issuing/transactions/{transaction}" }, { "method_name": "update", "method_on": "service", "method_type": "update", "operation": "post", "path": "/v1/issuing/transactions/{transaction}" }, { "method_name": "refund", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/test_helpers/issuing/transactions/{transaction}/refund" }, { "method_name": "create_force_capture", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/test_helpers/issuing/transactions/create_force_capture" }, { "method_name": "create_unlinked_refund", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/test_helpers/issuing/transactions/create_unlinked_refund" } ], "x-stripeResource": { "class_name": "Transaction", "has_collection_class": true, "in_package": "Issuing", "polymorphic_groups": [ "balance_transaction_source" ] } }, "issuing_authorization.created": { "description": "Occurs whenever an authorization is created.", "properties": { "object": { "$ref": "#/components/schemas/issuing.authorization" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "issuing_authorization.created" } }, "issuing_authorization.request": { "description": "Represents a synchronous request for authorization, see [Using your integration to handle authorization requests](https://docs.stripe.com/issuing/purchases/authorizations#authorization-handling).", "properties": { "object": { "$ref": "#/components/schemas/issuing.authorization" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "issuing_authorization.request" } }, "issuing_authorization.updated": { "description": "Occurs whenever an authorization is updated.", "properties": { "object": { "$ref": "#/components/schemas/issuing.authorization" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "issuing_authorization.updated" } }, "issuing_authorization_amount_details": { "description": "", "properties": { "atm_fee": { "description": "The fee charged by the ATM for the cash withdrawal.", "nullable": true, "type": "integer" }, "cashback_amount": { "description": "The amount of cash requested by the cardholder.", "nullable": true, "type": "integer" } }, "required": [ "atm_fee", "cashback_amount" ], "title": "IssuingAuthorizationAmountDetails", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "atm_fee", "cashback_amount" ] }, "issuing_authorization_authentication_exemption": { "description": "", "properties": { "claimed_by": { "description": "The entity that requested the exemption, either the acquiring merchant or the Issuing user.", "enum": [ "acquirer", "issuer" ], "type": "string" }, "type": { "description": "The specific exemption claimed for this authorization.", "enum": [ "low_value_transaction", "transaction_risk_analysis", "unknown" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "claimed_by", "type" ], "title": "IssuingAuthorizationAuthenticationExemption", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "claimed_by", "type" ] }, "issuing_authorization_fleet_cardholder_prompt_data": { "description": "", "properties": { "alphanumeric_id": { "description": "[Deprecated] An alphanumeric ID, though typical point of sales only support numeric entry. The card program can be configured to prompt for a vehicle ID, driver ID, or generic ID.", "maxLength": 5000, "nullable": true, "type": "string" }, "driver_id": { "description": "Driver ID.", "maxLength": 5000, "nullable": true, "type": "string" }, "odometer": { "description": "Odometer reading.", "nullable": true, "type": "integer" }, "unspecified_id": { "description": "An alphanumeric ID. This field is used when a vehicle ID, driver ID, or generic ID is entered by the cardholder, but the merchant or card network did not specify the prompt type.", "maxLength": 5000, "nullable": true, "type": "string" }, "user_id": { "description": "User ID.", "maxLength": 5000, "nullable": true, "type": "string" }, "vehicle_number": { "description": "Vehicle number.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "alphanumeric_id", "driver_id", "odometer", "unspecified_id", "user_id", "vehicle_number" ], "title": "IssuingAuthorizationFleetCardholderPromptData", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "alphanumeric_id", "driver_id", "odometer", "unspecified_id", "user_id", "vehicle_number" ] }, "issuing_authorization_fleet_data": { "description": "", "properties": { "cardholder_prompt_data": { "anyOf": [ { "$ref": "#/components/schemas/issuing_authorization_fleet_cardholder_prompt_data" } ], "description": "Answers to prompts presented to the cardholder at the point of sale. Prompted fields vary depending on the configuration of your physical fleet cards. Typical points of sale support only numeric entry.", "nullable": true }, "purchase_type": { "description": "The type of purchase.", "enum": [ "fuel_and_non_fuel_purchase", "fuel_purchase", "non_fuel_purchase" ], "nullable": true, "type": "string" }, "reported_breakdown": { "anyOf": [ { "$ref": "#/components/schemas/issuing_authorization_fleet_reported_breakdown" } ], "description": "More information about the total amount. Typically this information is received from the merchant after the authorization has been approved and the fuel dispensed. This information is not guaranteed to be accurate as some merchants may provide unreliable data.", "nullable": true }, "service_type": { "description": "The type of fuel service.", "enum": [ "full_service", "non_fuel_transaction", "self_service" ], "nullable": true, "type": "string" } }, "required": [ "cardholder_prompt_data", "purchase_type", "reported_breakdown", "service_type" ], "title": "IssuingAuthorizationFleetData", "type": "object", "x-expandableFields": [ "cardholder_prompt_data", "reported_breakdown" ], "x-stripeMostCommon": [ "cardholder_prompt_data", "purchase_type", "reported_breakdown", "service_type" ] }, "issuing_authorization_fleet_fuel_price_data": { "description": "", "properties": { "gross_amount_decimal": { "description": "Gross fuel amount that should equal Fuel Quantity multiplied by Fuel Unit Cost, inclusive of taxes.", "format": "decimal", "nullable": true, "type": "string" } }, "required": [ "gross_amount_decimal" ], "title": "IssuingAuthorizationFleetFuelPriceData", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "gross_amount_decimal" ] }, "issuing_authorization_fleet_non_fuel_price_data": { "description": "", "properties": { "gross_amount_decimal": { "description": "Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes.", "format": "decimal", "nullable": true, "type": "string" } }, "required": [ "gross_amount_decimal" ], "title": "IssuingAuthorizationFleetNonFuelPriceData", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "gross_amount_decimal" ] }, "issuing_authorization_fleet_reported_breakdown": { "description": "", "properties": { "fuel": { "anyOf": [ { "$ref": "#/components/schemas/issuing_authorization_fleet_fuel_price_data" } ], "description": "Breakdown of fuel portion of the purchase.", "nullable": true }, "non_fuel": { "anyOf": [ { "$ref": "#/components/schemas/issuing_authorization_fleet_non_fuel_price_data" } ], "description": "Breakdown of non-fuel portion of the purchase.", "nullable": true }, "tax": { "anyOf": [ { "$ref": "#/components/schemas/issuing_authorization_fleet_tax_data" } ], "description": "Information about tax included in this transaction.", "nullable": true } }, "required": [ "fuel", "non_fuel", "tax" ], "title": "IssuingAuthorizationFleetReportedBreakdown", "type": "object", "x-expandableFields": [ "fuel", "non_fuel", "tax" ], "x-stripeMostCommon": [ "fuel", "non_fuel", "tax" ] }, "issuing_authorization_fleet_tax_data": { "description": "", "properties": { "local_amount_decimal": { "description": "Amount of state or provincial Sales Tax included in the transaction amount. `null` if not reported by merchant or not subject to tax.", "format": "decimal", "nullable": true, "type": "string" }, "national_amount_decimal": { "description": "Amount of national Sales Tax or VAT included in the transaction amount. `null` if not reported by merchant or not subject to tax.", "format": "decimal", "nullable": true, "type": "string" } }, "required": [ "local_amount_decimal", "national_amount_decimal" ], "title": "IssuingAuthorizationFleetTaxData", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "local_amount_decimal", "national_amount_decimal" ] }, "issuing_authorization_fraud_challenge": { "description": "", "properties": { "channel": { "description": "The method by which the fraud challenge was delivered to the cardholder.", "enum": [ "sms" ], "type": "string" }, "status": { "description": "The status of the fraud challenge.", "enum": [ "expired", "pending", "rejected", "undeliverable", "verified" ], "type": "string" }, "undeliverable_reason": { "description": "If the challenge is not deliverable, the reason why.", "enum": [ "no_phone_number", "unsupported_phone_number" ], "nullable": true, "type": "string" } }, "required": [ "channel", "status", "undeliverable_reason" ], "title": "IssuingAuthorizationFraudChallenge", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "channel", "status", "undeliverable_reason" ] }, "issuing_authorization_fuel_data": { "description": "", "properties": { "industry_product_code": { "description": "[Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased.", "maxLength": 5000, "nullable": true, "type": "string" }, "quantity_decimal": { "description": "The quantity of `unit`s of fuel that was dispensed, represented as a decimal string with at most 12 decimal places.", "format": "decimal", "nullable": true, "type": "string" }, "type": { "description": "The type of fuel that was purchased.", "enum": [ "diesel", "other", "unleaded_plus", "unleaded_regular", "unleaded_super" ], "nullable": true, "type": "string" }, "unit": { "description": "The units for `quantity_decimal`.", "enum": [ "charging_minute", "imperial_gallon", "kilogram", "kilowatt_hour", "liter", "other", "pound", "us_gallon" ], "nullable": true, "type": "string" }, "unit_cost_decimal": { "description": "The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places.", "format": "decimal", "nullable": true, "type": "string" } }, "required": [ "industry_product_code", "quantity_decimal", "type", "unit", "unit_cost_decimal" ], "title": "IssuingAuthorizationFuelData", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "industry_product_code", "quantity_decimal", "type", "unit", "unit_cost_decimal" ] }, "issuing_authorization_merchant_data": { "description": "", "properties": { "category": { "description": "A categorization of the seller's type of business. See our [merchant categories guide](https://stripe.com/docs/issuing/merchant-categories) for a list of possible values.", "maxLength": 5000, "type": "string" }, "category_code": { "description": "The merchant category code for the seller’s business", "maxLength": 5000, "type": "string" }, "city": { "description": "City where the seller is located", "maxLength": 5000, "nullable": true, "type": "string" }, "country": { "description": "Country where the seller is located", "maxLength": 5000, "nullable": true, "type": "string" }, "name": { "description": "Name of the seller", "maxLength": 5000, "nullable": true, "type": "string" }, "network_id": { "description": "Identifier assigned to the seller by the card network. Different card networks may assign different network_id fields to the same merchant.", "maxLength": 5000, "type": "string" }, "postal_code": { "description": "Postal code where the seller is located", "maxLength": 5000, "nullable": true, "type": "string" }, "state": { "description": "State where the seller is located", "maxLength": 5000, "nullable": true, "type": "string" }, "tax_id": { "description": "The seller's tax identification number. Currently populated for French merchants only.", "maxLength": 5000, "nullable": true, "type": "string" }, "terminal_id": { "description": "An ID assigned by the seller to the location of the sale.", "maxLength": 5000, "nullable": true, "type": "string" }, "url": { "description": "URL provided by the merchant on a 3DS request", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "category", "category_code", "city", "country", "name", "network_id", "postal_code", "state", "tax_id", "terminal_id", "url" ], "title": "IssuingAuthorizationMerchantData", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "category", "category_code", "city", "country", "name", "network_id", "postal_code", "state", "tax_id", "terminal_id", "url" ] }, "issuing_authorization_network_data": { "description": "", "properties": { "acquiring_institution_id": { "description": "Identifier assigned to the acquirer by the card network. Sometimes this value is not provided by the network; in this case, the value will be `null`.", "maxLength": 5000, "nullable": true, "type": "string" }, "system_trace_audit_number": { "description": "The System Trace Audit Number (STAN) is a 6-digit identifier assigned by the acquirer. Prefer `network_data.transaction_id` if present, unless you have special requirements.", "maxLength": 5000, "nullable": true, "type": "string" }, "transaction_id": { "description": "Unique identifier for the authorization assigned by the card network used to match subsequent messages, disputes, and transactions.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "acquiring_institution_id", "system_trace_audit_number", "transaction_id" ], "title": "IssuingAuthorizationNetworkData", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "acquiring_institution_id", "system_trace_audit_number", "transaction_id" ] }, "issuing_authorization_pending_request": { "description": "", "properties": { "amount": { "description": "The additional amount Stripe will hold if the authorization is approved, in the card's [currency](https://stripe.com/docs/api#issuing_authorization_object-pending-request-currency) and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", "type": "integer" }, "amount_details": { "anyOf": [ { "$ref": "#/components/schemas/issuing_authorization_amount_details" } ], "description": "Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", "nullable": true }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "is_amount_controllable": { "description": "If set `true`, you may provide [amount](https://stripe.com/docs/api/issuing/authorizations/approve#approve_issuing_authorization-amount) to control how much to hold for the authorization.", "type": "boolean" }, "merchant_amount": { "description": "The amount the merchant is requesting to be authorized in the `merchant_currency`. The amount is in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", "type": "integer" }, "merchant_currency": { "description": "The local currency the merchant is requesting to authorize.", "format": "currency", "type": "string" }, "network_risk_score": { "description": "The card network's estimate of the likelihood that an authorization is fraudulent. Takes on values between 1 and 99.", "nullable": true, "type": "integer" } }, "required": [ "amount", "amount_details", "currency", "is_amount_controllable", "merchant_amount", "merchant_currency", "network_risk_score" ], "title": "IssuingAuthorizationPendingRequest", "type": "object", "x-expandableFields": [ "amount_details" ], "x-stripeMostCommon": [ "amount", "amount_details", "currency", "is_amount_controllable", "merchant_amount", "merchant_currency", "network_risk_score" ] }, "issuing_authorization_request": { "description": "", "properties": { "amount": { "description": "The `pending_request.amount` at the time of the request, presented in your card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Stripe held this amount from your account to fund the authorization if the request was approved.", "type": "integer" }, "amount_details": { "anyOf": [ { "$ref": "#/components/schemas/issuing_authorization_amount_details" } ], "description": "Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", "nullable": true }, "approved": { "description": "Whether this request was approved.", "type": "boolean" }, "authorization_code": { "description": "A code created by Stripe which is shared with the merchant to validate the authorization. This field will be populated if the authorization message was approved. The code typically starts with the letter \"S\", followed by a six-digit number. For example, \"S498162\". Please note that the code is not guaranteed to be unique across authorizations.", "maxLength": 5000, "nullable": true, "type": "string" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "maxLength": 5000, "type": "string" }, "merchant_amount": { "description": "The `pending_request.merchant_amount` at the time of the request, presented in the `merchant_currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", "type": "integer" }, "merchant_currency": { "description": "The currency that was collected by the merchant and presented to the cardholder for the authorization. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "maxLength": 5000, "type": "string" }, "network_risk_score": { "description": "The card network's estimate of the likelihood that an authorization is fraudulent. Takes on values between 1 and 99.", "nullable": true, "type": "integer" }, "reason": { "description": "When an authorization is approved or declined by you or by Stripe, this field provides additional detail on the reason for the outcome.", "enum": [ "account_disabled", "card_active", "card_canceled", "card_expired", "card_inactive", "cardholder_blocked", "cardholder_inactive", "cardholder_verification_required", "insecure_authorization_method", "insufficient_funds", "network_fallback", "not_allowed", "pin_blocked", "spending_controls", "suspected_fraud", "verification_failed", "webhook_approved", "webhook_declined", "webhook_error", "webhook_timeout" ], "type": "string", "x-stripeBypassValidation": true }, "reason_message": { "description": "If the `request_history.reason` is `webhook_error` because the direct webhook response is invalid (for example, parsing errors or missing parameters), we surface a more detailed error message via this field.", "maxLength": 5000, "nullable": true, "type": "string" }, "requested_at": { "description": "Time when the card network received an authorization request from the acquirer in UTC. Referred to by networks as transmission time.", "format": "unix-time", "nullable": true, "type": "integer" } }, "required": [ "amount", "amount_details", "approved", "authorization_code", "created", "currency", "merchant_amount", "merchant_currency", "network_risk_score", "reason", "reason_message", "requested_at" ], "title": "IssuingAuthorizationRequest", "type": "object", "x-expandableFields": [ "amount_details" ], "x-stripeMostCommon": [ "amount", "amount_details", "approved", "authorization_code", "created", "currency", "merchant_amount", "merchant_currency", "network_risk_score", "reason", "reason_message", "requested_at" ] }, "issuing_authorization_three_d_secure": { "description": "", "properties": { "result": { "description": "The outcome of the 3D Secure authentication request.", "enum": [ "attempt_acknowledged", "authenticated", "failed", "required" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "result" ], "title": "IssuingAuthorizationThreeDSecure", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "result" ] }, "issuing_authorization_treasury": { "description": "", "properties": { "received_credits": { "description": "The array of [ReceivedCredits](https://stripe.com/docs/api/treasury/received_credits) associated with this authorization", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "received_debits": { "description": "The array of [ReceivedDebits](https://stripe.com/docs/api/treasury/received_debits) associated with this authorization", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "transaction": { "description": "The Treasury [Transaction](https://stripe.com/docs/api/treasury/transactions) associated with this authorization", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "received_credits", "received_debits", "transaction" ], "title": "IssuingAuthorizationTreasury", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "received_credits", "received_debits", "transaction" ] }, "issuing_authorization_verification_data": { "description": "", "properties": { "address_line1_check": { "description": "Whether the cardholder provided an address first line and if it matched the cardholder’s `billing.address.line1`.", "enum": [ "match", "mismatch", "not_provided" ], "type": "string" }, "address_postal_code_check": { "description": "Whether the cardholder provided a postal code and if it matched the cardholder’s `billing.address.postal_code`.", "enum": [ "match", "mismatch", "not_provided" ], "type": "string" }, "authentication_exemption": { "anyOf": [ { "$ref": "#/components/schemas/issuing_authorization_authentication_exemption" } ], "description": "The exemption applied to this authorization.", "nullable": true }, "cvc_check": { "description": "Whether the cardholder provided a CVC and if it matched Stripe’s record.", "enum": [ "match", "mismatch", "not_provided" ], "type": "string" }, "expiry_check": { "description": "Whether the cardholder provided an expiry date and if it matched Stripe’s record.", "enum": [ "match", "mismatch", "not_provided" ], "type": "string" }, "postal_code": { "description": "The postal code submitted as part of the authorization used for postal code verification.", "maxLength": 5000, "nullable": true, "type": "string" }, "three_d_secure": { "anyOf": [ { "$ref": "#/components/schemas/issuing_authorization_three_d_secure" } ], "description": "3D Secure details.", "nullable": true } }, "required": [ "address_line1_check", "address_postal_code_check", "authentication_exemption", "cvc_check", "expiry_check", "postal_code", "three_d_secure" ], "title": "IssuingAuthorizationVerificationData", "type": "object", "x-expandableFields": [ "authentication_exemption", "three_d_secure" ], "x-stripeMostCommon": [ "address_line1_check", "address_postal_code_check", "authentication_exemption", "cvc_check", "expiry_check", "postal_code", "three_d_secure" ] }, "issuing_card.created": { "description": "Occurs whenever a card is created.", "properties": { "object": { "$ref": "#/components/schemas/issuing.card" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "issuing_card.created" } }, "issuing_card.updated": { "description": "Occurs whenever a card is updated.", "properties": { "object": { "$ref": "#/components/schemas/issuing.card" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "issuing_card.updated" } }, "issuing_card_apple_pay": { "description": "", "properties": { "eligible": { "description": "Apple Pay Eligibility", "type": "boolean" }, "ineligible_reason": { "description": "Reason the card is ineligible for Apple Pay", "enum": [ "missing_agreement", "missing_cardholder_contact", "unsupported_region" ], "nullable": true, "type": "string" } }, "required": [ "eligible", "ineligible_reason" ], "title": "IssuingCardApplePay", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "eligible", "ineligible_reason" ] }, "issuing_card_authorization_controls": { "description": "", "properties": { "allowed_categories": { "description": "Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to allow. All other categories will be blocked. Cannot be set with `blocked_categories`.", "items": { "enum": [ "ac_refrigeration_repair", "accounting_bookkeeping_services", "advertising_services", "agricultural_cooperative", "airlines_air_carriers", "airports_flying_fields", "ambulance_services", "amusement_parks_carnivals", "antique_reproductions", "antique_shops", "aquariums", "architectural_surveying_services", "art_dealers_and_galleries", "artists_supply_and_craft_shops", "auto_and_home_supply_stores", "auto_body_repair_shops", "auto_paint_shops", "auto_service_shops", "automated_cash_disburse", "automated_fuel_dispensers", "automobile_associations", "automotive_parts_and_accessories_stores", "automotive_tire_stores", "bail_and_bond_payments", "bakeries", "bands_orchestras", "barber_and_beauty_shops", "betting_casino_gambling", "bicycle_shops", "billiard_pool_establishments", "boat_dealers", "boat_rentals_and_leases", "book_stores", "books_periodicals_and_newspapers", "bowling_alleys", "bus_lines", "business_secretarial_schools", "buying_shopping_services", "cable_satellite_and_other_pay_television_and_radio", "camera_and_photographic_supply_stores", "candy_nut_and_confectionery_stores", "car_and_truck_dealers_new_used", "car_and_truck_dealers_used_only", "car_rental_agencies", "car_washes", "carpentry_services", "carpet_upholstery_cleaning", "caterers", "charitable_and_social_service_organizations_fundraising", "chemicals_and_allied_products", "child_care_services", "childrens_and_infants_wear_stores", "chiropodists_podiatrists", "chiropractors", "cigar_stores_and_stands", "civic_social_fraternal_associations", "cleaning_and_maintenance", "clothing_rental", "colleges_universities", "commercial_equipment", "commercial_footwear", "commercial_photography_art_and_graphics", "commuter_transport_and_ferries", "computer_network_services", "computer_programming", "computer_repair", "computer_software_stores", "computers_peripherals_and_software", "concrete_work_services", "construction_materials", "consulting_public_relations", "correspondence_schools", "cosmetic_stores", "counseling_services", "country_clubs", "courier_services", "court_costs", "credit_reporting_agencies", "cruise_lines", "dairy_products_stores", "dance_hall_studios_schools", "dating_escort_services", "dentists_orthodontists", "department_stores", "detective_agencies", "digital_goods_applications", "digital_goods_games", "digital_goods_large_volume", "digital_goods_media", "direct_marketing_catalog_merchant", "direct_marketing_combination_catalog_and_retail_merchant", "direct_marketing_inbound_telemarketing", "direct_marketing_insurance_services", "direct_marketing_other", "direct_marketing_outbound_telemarketing", "direct_marketing_subscription", "direct_marketing_travel", "discount_stores", "doctors", "door_to_door_sales", "drapery_window_covering_and_upholstery_stores", "drinking_places", "drug_stores_and_pharmacies", "drugs_drug_proprietaries_and_druggist_sundries", "dry_cleaners", "durable_goods", "duty_free_stores", "eating_places_restaurants", "educational_services", "electric_razor_stores", "electric_vehicle_charging", "electrical_parts_and_equipment", "electrical_services", "electronics_repair_shops", "electronics_stores", "elementary_secondary_schools", "emergency_services_gcas_visa_use_only", "employment_temp_agencies", "equipment_rental", "exterminating_services", "family_clothing_stores", "fast_food_restaurants", "financial_institutions", "fines_government_administrative_entities", "fireplace_fireplace_screens_and_accessories_stores", "floor_covering_stores", "florists", "florists_supplies_nursery_stock_and_flowers", "freezer_and_locker_meat_provisioners", "fuel_dealers_non_automotive", "funeral_services_crematories", "furniture_home_furnishings_and_equipment_stores_except_appliances", "furniture_repair_refinishing", "furriers_and_fur_shops", "general_services", "gift_card_novelty_and_souvenir_shops", "glass_paint_and_wallpaper_stores", "glassware_crystal_stores", "golf_courses_public", "government_licensed_horse_dog_racing_us_region_only", "government_licensed_online_casions_online_gambling_us_region_only", "government_owned_lotteries_non_us_region", "government_owned_lotteries_us_region_only", "government_services", "grocery_stores_supermarkets", "hardware_equipment_and_supplies", "hardware_stores", "health_and_beauty_spas", "hearing_aids_sales_and_supplies", "heating_plumbing_a_c", "hobby_toy_and_game_shops", "home_supply_warehouse_stores", "hospitals", "hotels_motels_and_resorts", "household_appliance_stores", "industrial_supplies", "information_retrieval_services", "insurance_default", "insurance_underwriting_premiums", "intra_company_purchases", "jewelry_stores_watches_clocks_and_silverware_stores", "landscaping_services", "laundries", "laundry_cleaning_services", "legal_services_attorneys", "luggage_and_leather_goods_stores", "lumber_building_materials_stores", "manual_cash_disburse", "marinas_service_and_supplies", "marketplaces", "masonry_stonework_and_plaster", "massage_parlors", "medical_and_dental_labs", "medical_dental_ophthalmic_and_hospital_equipment_and_supplies", "medical_services", "membership_organizations", "mens_and_boys_clothing_and_accessories_stores", "mens_womens_clothing_stores", "metal_service_centers", "miscellaneous", "miscellaneous_apparel_and_accessory_shops", "miscellaneous_auto_dealers", "miscellaneous_business_services", "miscellaneous_food_stores", "miscellaneous_general_merchandise", "miscellaneous_general_services", "miscellaneous_home_furnishing_specialty_stores", "miscellaneous_publishing_and_printing", "miscellaneous_recreation_services", "miscellaneous_repair_shops", "miscellaneous_specialty_retail", "mobile_home_dealers", "motion_picture_theaters", "motor_freight_carriers_and_trucking", "motor_homes_dealers", "motor_vehicle_supplies_and_new_parts", "motorcycle_shops_and_dealers", "motorcycle_shops_dealers", "music_stores_musical_instruments_pianos_and_sheet_music", "news_dealers_and_newsstands", "non_fi_money_orders", "non_fi_stored_value_card_purchase_load", "nondurable_goods", "nurseries_lawn_and_garden_supply_stores", "nursing_personal_care", "office_and_commercial_furniture", "opticians_eyeglasses", "optometrists_ophthalmologist", "orthopedic_goods_prosthetic_devices", "osteopaths", "package_stores_beer_wine_and_liquor", "paints_varnishes_and_supplies", "parking_lots_garages", "passenger_railways", "pawn_shops", "pet_shops_pet_food_and_supplies", "petroleum_and_petroleum_products", "photo_developing", "photographic_photocopy_microfilm_equipment_and_supplies", "photographic_studios", "picture_video_production", "piece_goods_notions_and_other_dry_goods", "plumbing_heating_equipment_and_supplies", "political_organizations", "postal_services_government_only", "precious_stones_and_metals_watches_and_jewelry", "professional_services", "public_warehousing_and_storage", "quick_copy_repro_and_blueprint", "railroads", "real_estate_agents_and_managers_rentals", "record_stores", "recreational_vehicle_rentals", "religious_goods_stores", "religious_organizations", "roofing_siding_sheet_metal", "secretarial_support_services", "security_brokers_dealers", "service_stations", "sewing_needlework_fabric_and_piece_goods_stores", "shoe_repair_hat_cleaning", "shoe_stores", "small_appliance_repair", "snowmobile_dealers", "special_trade_services", "specialty_cleaning", "sporting_goods_stores", "sporting_recreation_camps", "sports_and_riding_apparel_stores", "sports_clubs_fields", "stamp_and_coin_stores", "stationary_office_supplies_printing_and_writing_paper", "stationery_stores_office_and_school_supply_stores", "swimming_pools_sales", "t_ui_travel_germany", "tailors_alterations", "tax_payments_government_agencies", "tax_preparation_services", "taxicabs_limousines", "telecommunication_equipment_and_telephone_sales", "telecommunication_services", "telegraph_services", "tent_and_awning_shops", "testing_laboratories", "theatrical_ticket_agencies", "timeshares", "tire_retreading_and_repair", "tolls_bridge_fees", "tourist_attractions_and_exhibits", "towing_services", "trailer_parks_campgrounds", "transportation_services", "travel_agencies_tour_operators", "truck_stop_iteration", "truck_utility_trailer_rentals", "typesetting_plate_making_and_related_services", "typewriter_stores", "u_s_federal_government_agencies_or_departments", "uniforms_commercial_clothing", "used_merchandise_and_secondhand_stores", "utilities", "variety_stores", "veterinary_services", "video_amusement_game_supplies", "video_game_arcades", "video_tape_rental_stores", "vocational_trade_schools", "watch_jewelry_repair", "welding_repair", "wholesale_clubs", "wig_and_toupee_stores", "wires_money_orders", "womens_accessory_and_specialty_shops", "womens_ready_to_wear_stores", "wrecking_and_salvage_yards" ], "type": "string" }, "nullable": true, "type": "array" }, "allowed_merchant_countries": { "description": "Array of strings containing representing countries from which authorizations will be allowed. Authorizations from merchants in all other countries will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `blocked_merchant_countries`. Provide an empty value to unset this control.", "items": { "maxLength": 5000, "type": "string" }, "nullable": true, "type": "array" }, "blocked_categories": { "description": "Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to decline. All other categories will be allowed. Cannot be set with `allowed_categories`.", "items": { "enum": [ "ac_refrigeration_repair", "accounting_bookkeeping_services", "advertising_services", "agricultural_cooperative", "airlines_air_carriers", "airports_flying_fields", "ambulance_services", "amusement_parks_carnivals", "antique_reproductions", "antique_shops", "aquariums", "architectural_surveying_services", "art_dealers_and_galleries", "artists_supply_and_craft_shops", "auto_and_home_supply_stores", "auto_body_repair_shops", "auto_paint_shops", "auto_service_shops", "automated_cash_disburse", "automated_fuel_dispensers", "automobile_associations", "automotive_parts_and_accessories_stores", "automotive_tire_stores", "bail_and_bond_payments", "bakeries", "bands_orchestras", "barber_and_beauty_shops", "betting_casino_gambling", "bicycle_shops", "billiard_pool_establishments", "boat_dealers", "boat_rentals_and_leases", "book_stores", "books_periodicals_and_newspapers", "bowling_alleys", "bus_lines", "business_secretarial_schools", "buying_shopping_services", "cable_satellite_and_other_pay_television_and_radio", "camera_and_photographic_supply_stores", "candy_nut_and_confectionery_stores", "car_and_truck_dealers_new_used", "car_and_truck_dealers_used_only", "car_rental_agencies", "car_washes", "carpentry_services", "carpet_upholstery_cleaning", "caterers", "charitable_and_social_service_organizations_fundraising", "chemicals_and_allied_products", "child_care_services", "childrens_and_infants_wear_stores", "chiropodists_podiatrists", "chiropractors", "cigar_stores_and_stands", "civic_social_fraternal_associations", "cleaning_and_maintenance", "clothing_rental", "colleges_universities", "commercial_equipment", "commercial_footwear", "commercial_photography_art_and_graphics", "commuter_transport_and_ferries", "computer_network_services", "computer_programming", "computer_repair", "computer_software_stores", "computers_peripherals_and_software", "concrete_work_services", "construction_materials", "consulting_public_relations", "correspondence_schools", "cosmetic_stores", "counseling_services", "country_clubs", "courier_services", "court_costs", "credit_reporting_agencies", "cruise_lines", "dairy_products_stores", "dance_hall_studios_schools", "dating_escort_services", "dentists_orthodontists", "department_stores", "detective_agencies", "digital_goods_applications", "digital_goods_games", "digital_goods_large_volume", "digital_goods_media", "direct_marketing_catalog_merchant", "direct_marketing_combination_catalog_and_retail_merchant", "direct_marketing_inbound_telemarketing", "direct_marketing_insurance_services", "direct_marketing_other", "direct_marketing_outbound_telemarketing", "direct_marketing_subscription", "direct_marketing_travel", "discount_stores", "doctors", "door_to_door_sales", "drapery_window_covering_and_upholstery_stores", "drinking_places", "drug_stores_and_pharmacies", "drugs_drug_proprietaries_and_druggist_sundries", "dry_cleaners", "durable_goods", "duty_free_stores", "eating_places_restaurants", "educational_services", "electric_razor_stores", "electric_vehicle_charging", "electrical_parts_and_equipment", "electrical_services", "electronics_repair_shops", "electronics_stores", "elementary_secondary_schools", "emergency_services_gcas_visa_use_only", "employment_temp_agencies", "equipment_rental", "exterminating_services", "family_clothing_stores", "fast_food_restaurants", "financial_institutions", "fines_government_administrative_entities", "fireplace_fireplace_screens_and_accessories_stores", "floor_covering_stores", "florists", "florists_supplies_nursery_stock_and_flowers", "freezer_and_locker_meat_provisioners", "fuel_dealers_non_automotive", "funeral_services_crematories", "furniture_home_furnishings_and_equipment_stores_except_appliances", "furniture_repair_refinishing", "furriers_and_fur_shops", "general_services", "gift_card_novelty_and_souvenir_shops", "glass_paint_and_wallpaper_stores", "glassware_crystal_stores", "golf_courses_public", "government_licensed_horse_dog_racing_us_region_only", "government_licensed_online_casions_online_gambling_us_region_only", "government_owned_lotteries_non_us_region", "government_owned_lotteries_us_region_only", "government_services", "grocery_stores_supermarkets", "hardware_equipment_and_supplies", "hardware_stores", "health_and_beauty_spas", "hearing_aids_sales_and_supplies", "heating_plumbing_a_c", "hobby_toy_and_game_shops", "home_supply_warehouse_stores", "hospitals", "hotels_motels_and_resorts", "household_appliance_stores", "industrial_supplies", "information_retrieval_services", "insurance_default", "insurance_underwriting_premiums", "intra_company_purchases", "jewelry_stores_watches_clocks_and_silverware_stores", "landscaping_services", "laundries", "laundry_cleaning_services", "legal_services_attorneys", "luggage_and_leather_goods_stores", "lumber_building_materials_stores", "manual_cash_disburse", "marinas_service_and_supplies", "marketplaces", "masonry_stonework_and_plaster", "massage_parlors", "medical_and_dental_labs", "medical_dental_ophthalmic_and_hospital_equipment_and_supplies", "medical_services", "membership_organizations", "mens_and_boys_clothing_and_accessories_stores", "mens_womens_clothing_stores", "metal_service_centers", "miscellaneous", "miscellaneous_apparel_and_accessory_shops", "miscellaneous_auto_dealers", "miscellaneous_business_services", "miscellaneous_food_stores", "miscellaneous_general_merchandise", "miscellaneous_general_services", "miscellaneous_home_furnishing_specialty_stores", "miscellaneous_publishing_and_printing", "miscellaneous_recreation_services", "miscellaneous_repair_shops", "miscellaneous_specialty_retail", "mobile_home_dealers", "motion_picture_theaters", "motor_freight_carriers_and_trucking", "motor_homes_dealers", "motor_vehicle_supplies_and_new_parts", "motorcycle_shops_and_dealers", "motorcycle_shops_dealers", "music_stores_musical_instruments_pianos_and_sheet_music", "news_dealers_and_newsstands", "non_fi_money_orders", "non_fi_stored_value_card_purchase_load", "nondurable_goods", "nurseries_lawn_and_garden_supply_stores", "nursing_personal_care", "office_and_commercial_furniture", "opticians_eyeglasses", "optometrists_ophthalmologist", "orthopedic_goods_prosthetic_devices", "osteopaths", "package_stores_beer_wine_and_liquor", "paints_varnishes_and_supplies", "parking_lots_garages", "passenger_railways", "pawn_shops", "pet_shops_pet_food_and_supplies", "petroleum_and_petroleum_products", "photo_developing", "photographic_photocopy_microfilm_equipment_and_supplies", "photographic_studios", "picture_video_production", "piece_goods_notions_and_other_dry_goods", "plumbing_heating_equipment_and_supplies", "political_organizations", "postal_services_government_only", "precious_stones_and_metals_watches_and_jewelry", "professional_services", "public_warehousing_and_storage", "quick_copy_repro_and_blueprint", "railroads", "real_estate_agents_and_managers_rentals", "record_stores", "recreational_vehicle_rentals", "religious_goods_stores", "religious_organizations", "roofing_siding_sheet_metal", "secretarial_support_services", "security_brokers_dealers", "service_stations", "sewing_needlework_fabric_and_piece_goods_stores", "shoe_repair_hat_cleaning", "shoe_stores", "small_appliance_repair", "snowmobile_dealers", "special_trade_services", "specialty_cleaning", "sporting_goods_stores", "sporting_recreation_camps", "sports_and_riding_apparel_stores", "sports_clubs_fields", "stamp_and_coin_stores", "stationary_office_supplies_printing_and_writing_paper", "stationery_stores_office_and_school_supply_stores", "swimming_pools_sales", "t_ui_travel_germany", "tailors_alterations", "tax_payments_government_agencies", "tax_preparation_services", "taxicabs_limousines", "telecommunication_equipment_and_telephone_sales", "telecommunication_services", "telegraph_services", "tent_and_awning_shops", "testing_laboratories", "theatrical_ticket_agencies", "timeshares", "tire_retreading_and_repair", "tolls_bridge_fees", "tourist_attractions_and_exhibits", "towing_services", "trailer_parks_campgrounds", "transportation_services", "travel_agencies_tour_operators", "truck_stop_iteration", "truck_utility_trailer_rentals", "typesetting_plate_making_and_related_services", "typewriter_stores", "u_s_federal_government_agencies_or_departments", "uniforms_commercial_clothing", "used_merchandise_and_secondhand_stores", "utilities", "variety_stores", "veterinary_services", "video_amusement_game_supplies", "video_game_arcades", "video_tape_rental_stores", "vocational_trade_schools", "watch_jewelry_repair", "welding_repair", "wholesale_clubs", "wig_and_toupee_stores", "wires_money_orders", "womens_accessory_and_specialty_shops", "womens_ready_to_wear_stores", "wrecking_and_salvage_yards" ], "type": "string" }, "nullable": true, "type": "array" }, "blocked_merchant_countries": { "description": "Array of strings containing representing countries from which authorizations will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `allowed_merchant_countries`. Provide an empty value to unset this control.", "items": { "maxLength": 5000, "type": "string" }, "nullable": true, "type": "array" }, "spending_limits": { "description": "Limit spending with amount-based rules that apply across any cards this card replaced (i.e., its `replacement_for` card and _that_ card's `replacement_for` card, up the chain).", "items": { "$ref": "#/components/schemas/issuing_card_spending_limit" }, "nullable": true, "type": "array" }, "spending_limits_currency": { "description": "Currency of the amounts within `spending_limits`. Always the same as the currency of the card.", "format": "currency", "nullable": true, "type": "string" } }, "required": [ "allowed_categories", "allowed_merchant_countries", "blocked_categories", "blocked_merchant_countries", "spending_limits", "spending_limits_currency" ], "title": "IssuingCardAuthorizationControls", "type": "object", "x-expandableFields": [ "spending_limits" ], "x-stripeMostCommon": [ "allowed_categories", "allowed_merchant_countries", "blocked_categories", "blocked_merchant_countries", "spending_limits", "spending_limits_currency" ] }, "issuing_card_google_pay": { "description": "", "properties": { "eligible": { "description": "Google Pay Eligibility", "type": "boolean" }, "ineligible_reason": { "description": "Reason the card is ineligible for Google Pay", "enum": [ "missing_agreement", "missing_cardholder_contact", "unsupported_region" ], "nullable": true, "type": "string" } }, "required": [ "eligible", "ineligible_reason" ], "title": "IssuingCardGooglePay", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "eligible", "ineligible_reason" ] }, "issuing_card_shipping": { "description": "", "properties": { "address": { "$ref": "#/components/schemas/address" }, "address_validation": { "anyOf": [ { "$ref": "#/components/schemas/issuing_card_shipping_address_validation" } ], "description": "Address validation details for the shipment.", "nullable": true }, "carrier": { "description": "The delivery company that shipped a card.", "enum": [ "dhl", "fedex", "royal_mail", "usps" ], "nullable": true, "type": "string" }, "customs": { "anyOf": [ { "$ref": "#/components/schemas/issuing_card_shipping_customs" } ], "description": "Additional information that may be required for clearing customs.", "nullable": true }, "eta": { "description": "A unix timestamp representing a best estimate of when the card will be delivered.", "format": "unix-time", "nullable": true, "type": "integer" }, "name": { "description": "Recipient name.", "maxLength": 5000, "type": "string" }, "phone_number": { "description": "The phone number of the receiver of the shipment. Our courier partners will use this number to contact you in the event of card delivery issues. For individual shipments to the EU/UK, if this field is empty, we will provide them with the phone number provided when the cardholder was initially created.", "maxLength": 5000, "nullable": true, "type": "string" }, "require_signature": { "description": "Whether a signature is required for card delivery. This feature is only supported for US users. Standard shipping service does not support signature on delivery. The default value for standard shipping service is false and for express and priority services is true.", "nullable": true, "type": "boolean" }, "service": { "description": "Shipment service, such as `standard` or `express`.", "enum": [ "express", "priority", "standard" ], "type": "string", "x-stripeBypassValidation": true }, "status": { "description": "The delivery status of the card.", "enum": [ "canceled", "delivered", "failure", "pending", "returned", "shipped", "submitted" ], "nullable": true, "type": "string" }, "tracking_number": { "description": "A tracking number for a card shipment.", "maxLength": 5000, "nullable": true, "type": "string" }, "tracking_url": { "description": "A link to the shipping carrier's site where you can view detailed information about a card shipment.", "maxLength": 5000, "nullable": true, "type": "string" }, "type": { "description": "Packaging options.", "enum": [ "bulk", "individual" ], "type": "string" } }, "required": [ "address", "address_validation", "carrier", "customs", "eta", "name", "phone_number", "require_signature", "service", "status", "tracking_number", "tracking_url", "type" ], "title": "IssuingCardShipping", "type": "object", "x-expandableFields": [ "address", "address_validation", "customs" ], "x-stripeMostCommon": [ "address", "address_validation", "carrier", "customs", "eta", "name", "phone_number", "require_signature", "service", "status", "tracking_number", "tracking_url", "type" ] }, "issuing_card_shipping_address_validation": { "description": "", "properties": { "mode": { "description": "The address validation capabilities to use.", "enum": [ "disabled", "normalization_only", "validation_and_normalization" ], "type": "string" }, "normalized_address": { "anyOf": [ { "$ref": "#/components/schemas/address" } ], "description": "The normalized shipping address.", "nullable": true }, "result": { "description": "The validation result for the shipping address.", "enum": [ "indeterminate", "likely_deliverable", "likely_undeliverable" ], "nullable": true, "type": "string" } }, "required": [ "mode", "normalized_address", "result" ], "title": "IssuingCardShippingAddressValidation", "type": "object", "x-expandableFields": [ "normalized_address" ], "x-stripeMostCommon": [ "mode", "normalized_address", "result" ] }, "issuing_card_shipping_customs": { "description": "", "properties": { "eori_number": { "description": "A registration number used for customs in Europe. See [https://www.gov.uk/eori](https://www.gov.uk/eori) for the UK and [https://ec.europa.eu/taxation_customs/business/customs-procedures-import-and-export/customs-procedures/economic-operators-registration-and-identification-number-eori_en](https://ec.europa.eu/taxation_customs/business/customs-procedures-import-and-export/customs-procedures/economic-operators-registration-and-identification-number-eori_en) for the EU.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "eori_number" ], "title": "IssuingCardShippingCustoms", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "eori_number" ] }, "issuing_card_spending_limit": { "description": "", "properties": { "amount": { "description": "Maximum amount allowed to spend per interval. This amount is in the card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", "type": "integer" }, "categories": { "description": "Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) this limit applies to. Omitting this field will apply the limit to all categories.", "items": { "enum": [ "ac_refrigeration_repair", "accounting_bookkeeping_services", "advertising_services", "agricultural_cooperative", "airlines_air_carriers", "airports_flying_fields", "ambulance_services", "amusement_parks_carnivals", "antique_reproductions", "antique_shops", "aquariums", "architectural_surveying_services", "art_dealers_and_galleries", "artists_supply_and_craft_shops", "auto_and_home_supply_stores", "auto_body_repair_shops", "auto_paint_shops", "auto_service_shops", "automated_cash_disburse", "automated_fuel_dispensers", "automobile_associations", "automotive_parts_and_accessories_stores", "automotive_tire_stores", "bail_and_bond_payments", "bakeries", "bands_orchestras", "barber_and_beauty_shops", "betting_casino_gambling", "bicycle_shops", "billiard_pool_establishments", "boat_dealers", "boat_rentals_and_leases", "book_stores", "books_periodicals_and_newspapers", "bowling_alleys", "bus_lines", "business_secretarial_schools", "buying_shopping_services", "cable_satellite_and_other_pay_television_and_radio", "camera_and_photographic_supply_stores", "candy_nut_and_confectionery_stores", "car_and_truck_dealers_new_used", "car_and_truck_dealers_used_only", "car_rental_agencies", "car_washes", "carpentry_services", "carpet_upholstery_cleaning", "caterers", "charitable_and_social_service_organizations_fundraising", "chemicals_and_allied_products", "child_care_services", "childrens_and_infants_wear_stores", "chiropodists_podiatrists", "chiropractors", "cigar_stores_and_stands", "civic_social_fraternal_associations", "cleaning_and_maintenance", "clothing_rental", "colleges_universities", "commercial_equipment", "commercial_footwear", "commercial_photography_art_and_graphics", "commuter_transport_and_ferries", "computer_network_services", "computer_programming", "computer_repair", "computer_software_stores", "computers_peripherals_and_software", "concrete_work_services", "construction_materials", "consulting_public_relations", "correspondence_schools", "cosmetic_stores", "counseling_services", "country_clubs", "courier_services", "court_costs", "credit_reporting_agencies", "cruise_lines", "dairy_products_stores", "dance_hall_studios_schools", "dating_escort_services", "dentists_orthodontists", "department_stores", "detective_agencies", "digital_goods_applications", "digital_goods_games", "digital_goods_large_volume", "digital_goods_media", "direct_marketing_catalog_merchant", "direct_marketing_combination_catalog_and_retail_merchant", "direct_marketing_inbound_telemarketing", "direct_marketing_insurance_services", "direct_marketing_other", "direct_marketing_outbound_telemarketing", "direct_marketing_subscription", "direct_marketing_travel", "discount_stores", "doctors", "door_to_door_sales", "drapery_window_covering_and_upholstery_stores", "drinking_places", "drug_stores_and_pharmacies", "drugs_drug_proprietaries_and_druggist_sundries", "dry_cleaners", "durable_goods", "duty_free_stores", "eating_places_restaurants", "educational_services", "electric_razor_stores", "electric_vehicle_charging", "electrical_parts_and_equipment", "electrical_services", "electronics_repair_shops", "electronics_stores", "elementary_secondary_schools", "emergency_services_gcas_visa_use_only", "employment_temp_agencies", "equipment_rental", "exterminating_services", "family_clothing_stores", "fast_food_restaurants", "financial_institutions", "fines_government_administrative_entities", "fireplace_fireplace_screens_and_accessories_stores", "floor_covering_stores", "florists", "florists_supplies_nursery_stock_and_flowers", "freezer_and_locker_meat_provisioners", "fuel_dealers_non_automotive", "funeral_services_crematories", "furniture_home_furnishings_and_equipment_stores_except_appliances", "furniture_repair_refinishing", "furriers_and_fur_shops", "general_services", "gift_card_novelty_and_souvenir_shops", "glass_paint_and_wallpaper_stores", "glassware_crystal_stores", "golf_courses_public", "government_licensed_horse_dog_racing_us_region_only", "government_licensed_online_casions_online_gambling_us_region_only", "government_owned_lotteries_non_us_region", "government_owned_lotteries_us_region_only", "government_services", "grocery_stores_supermarkets", "hardware_equipment_and_supplies", "hardware_stores", "health_and_beauty_spas", "hearing_aids_sales_and_supplies", "heating_plumbing_a_c", "hobby_toy_and_game_shops", "home_supply_warehouse_stores", "hospitals", "hotels_motels_and_resorts", "household_appliance_stores", "industrial_supplies", "information_retrieval_services", "insurance_default", "insurance_underwriting_premiums", "intra_company_purchases", "jewelry_stores_watches_clocks_and_silverware_stores", "landscaping_services", "laundries", "laundry_cleaning_services", "legal_services_attorneys", "luggage_and_leather_goods_stores", "lumber_building_materials_stores", "manual_cash_disburse", "marinas_service_and_supplies", "marketplaces", "masonry_stonework_and_plaster", "massage_parlors", "medical_and_dental_labs", "medical_dental_ophthalmic_and_hospital_equipment_and_supplies", "medical_services", "membership_organizations", "mens_and_boys_clothing_and_accessories_stores", "mens_womens_clothing_stores", "metal_service_centers", "miscellaneous", "miscellaneous_apparel_and_accessory_shops", "miscellaneous_auto_dealers", "miscellaneous_business_services", "miscellaneous_food_stores", "miscellaneous_general_merchandise", "miscellaneous_general_services", "miscellaneous_home_furnishing_specialty_stores", "miscellaneous_publishing_and_printing", "miscellaneous_recreation_services", "miscellaneous_repair_shops", "miscellaneous_specialty_retail", "mobile_home_dealers", "motion_picture_theaters", "motor_freight_carriers_and_trucking", "motor_homes_dealers", "motor_vehicle_supplies_and_new_parts", "motorcycle_shops_and_dealers", "motorcycle_shops_dealers", "music_stores_musical_instruments_pianos_and_sheet_music", "news_dealers_and_newsstands", "non_fi_money_orders", "non_fi_stored_value_card_purchase_load", "nondurable_goods", "nurseries_lawn_and_garden_supply_stores", "nursing_personal_care", "office_and_commercial_furniture", "opticians_eyeglasses", "optometrists_ophthalmologist", "orthopedic_goods_prosthetic_devices", "osteopaths", "package_stores_beer_wine_and_liquor", "paints_varnishes_and_supplies", "parking_lots_garages", "passenger_railways", "pawn_shops", "pet_shops_pet_food_and_supplies", "petroleum_and_petroleum_products", "photo_developing", "photographic_photocopy_microfilm_equipment_and_supplies", "photographic_studios", "picture_video_production", "piece_goods_notions_and_other_dry_goods", "plumbing_heating_equipment_and_supplies", "political_organizations", "postal_services_government_only", "precious_stones_and_metals_watches_and_jewelry", "professional_services", "public_warehousing_and_storage", "quick_copy_repro_and_blueprint", "railroads", "real_estate_agents_and_managers_rentals", "record_stores", "recreational_vehicle_rentals", "religious_goods_stores", "religious_organizations", "roofing_siding_sheet_metal", "secretarial_support_services", "security_brokers_dealers", "service_stations", "sewing_needlework_fabric_and_piece_goods_stores", "shoe_repair_hat_cleaning", "shoe_stores", "small_appliance_repair", "snowmobile_dealers", "special_trade_services", "specialty_cleaning", "sporting_goods_stores", "sporting_recreation_camps", "sports_and_riding_apparel_stores", "sports_clubs_fields", "stamp_and_coin_stores", "stationary_office_supplies_printing_and_writing_paper", "stationery_stores_office_and_school_supply_stores", "swimming_pools_sales", "t_ui_travel_germany", "tailors_alterations", "tax_payments_government_agencies", "tax_preparation_services", "taxicabs_limousines", "telecommunication_equipment_and_telephone_sales", "telecommunication_services", "telegraph_services", "tent_and_awning_shops", "testing_laboratories", "theatrical_ticket_agencies", "timeshares", "tire_retreading_and_repair", "tolls_bridge_fees", "tourist_attractions_and_exhibits", "towing_services", "trailer_parks_campgrounds", "transportation_services", "travel_agencies_tour_operators", "truck_stop_iteration", "truck_utility_trailer_rentals", "typesetting_plate_making_and_related_services", "typewriter_stores", "u_s_federal_government_agencies_or_departments", "uniforms_commercial_clothing", "used_merchandise_and_secondhand_stores", "utilities", "variety_stores", "veterinary_services", "video_amusement_game_supplies", "video_game_arcades", "video_tape_rental_stores", "vocational_trade_schools", "watch_jewelry_repair", "welding_repair", "wholesale_clubs", "wig_and_toupee_stores", "wires_money_orders", "womens_accessory_and_specialty_shops", "womens_ready_to_wear_stores", "wrecking_and_salvage_yards" ], "type": "string" }, "nullable": true, "type": "array" }, "interval": { "description": "Interval (or event) to which the amount applies.", "enum": [ "all_time", "daily", "monthly", "per_authorization", "weekly", "yearly" ], "type": "string" } }, "required": [ "amount", "categories", "interval" ], "title": "IssuingCardSpendingLimit", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "amount", "categories", "interval" ] }, "issuing_card_wallets": { "description": "", "properties": { "apple_pay": { "$ref": "#/components/schemas/issuing_card_apple_pay" }, "google_pay": { "$ref": "#/components/schemas/issuing_card_google_pay" }, "primary_account_identifier": { "description": "Unique identifier for a card used with digital wallets", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "apple_pay", "google_pay", "primary_account_identifier" ], "title": "IssuingCardWallets", "type": "object", "x-expandableFields": [ "apple_pay", "google_pay" ], "x-stripeMostCommon": [ "apple_pay", "google_pay", "primary_account_identifier" ] }, "issuing_cardholder.created": { "description": "Occurs whenever a cardholder is created.", "properties": { "object": { "$ref": "#/components/schemas/issuing.cardholder" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "issuing_cardholder.created" } }, "issuing_cardholder.updated": { "description": "Occurs whenever a cardholder is updated.", "properties": { "object": { "$ref": "#/components/schemas/issuing.cardholder" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "issuing_cardholder.updated" } }, "issuing_cardholder_address": { "description": "", "properties": { "address": { "$ref": "#/components/schemas/address" } }, "required": [ "address" ], "title": "IssuingCardholderAddress", "type": "object", "x-expandableFields": [ "address" ], "x-stripeMostCommon": [ "address" ] }, "issuing_cardholder_authorization_controls": { "description": "", "properties": { "allowed_categories": { "description": "Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to allow. All other categories will be blocked. Cannot be set with `blocked_categories`.", "items": { "enum": [ "ac_refrigeration_repair", "accounting_bookkeeping_services", "advertising_services", "agricultural_cooperative", "airlines_air_carriers", "airports_flying_fields", "ambulance_services", "amusement_parks_carnivals", "antique_reproductions", "antique_shops", "aquariums", "architectural_surveying_services", "art_dealers_and_galleries", "artists_supply_and_craft_shops", "auto_and_home_supply_stores", "auto_body_repair_shops", "auto_paint_shops", "auto_service_shops", "automated_cash_disburse", "automated_fuel_dispensers", "automobile_associations", "automotive_parts_and_accessories_stores", "automotive_tire_stores", "bail_and_bond_payments", "bakeries", "bands_orchestras", "barber_and_beauty_shops", "betting_casino_gambling", "bicycle_shops", "billiard_pool_establishments", "boat_dealers", "boat_rentals_and_leases", "book_stores", "books_periodicals_and_newspapers", "bowling_alleys", "bus_lines", "business_secretarial_schools", "buying_shopping_services", "cable_satellite_and_other_pay_television_and_radio", "camera_and_photographic_supply_stores", "candy_nut_and_confectionery_stores", "car_and_truck_dealers_new_used", "car_and_truck_dealers_used_only", "car_rental_agencies", "car_washes", "carpentry_services", "carpet_upholstery_cleaning", "caterers", "charitable_and_social_service_organizations_fundraising", "chemicals_and_allied_products", "child_care_services", "childrens_and_infants_wear_stores", "chiropodists_podiatrists", "chiropractors", "cigar_stores_and_stands", "civic_social_fraternal_associations", "cleaning_and_maintenance", "clothing_rental", "colleges_universities", "commercial_equipment", "commercial_footwear", "commercial_photography_art_and_graphics", "commuter_transport_and_ferries", "computer_network_services", "computer_programming", "computer_repair", "computer_software_stores", "computers_peripherals_and_software", "concrete_work_services", "construction_materials", "consulting_public_relations", "correspondence_schools", "cosmetic_stores", "counseling_services", "country_clubs", "courier_services", "court_costs", "credit_reporting_agencies", "cruise_lines", "dairy_products_stores", "dance_hall_studios_schools", "dating_escort_services", "dentists_orthodontists", "department_stores", "detective_agencies", "digital_goods_applications", "digital_goods_games", "digital_goods_large_volume", "digital_goods_media", "direct_marketing_catalog_merchant", "direct_marketing_combination_catalog_and_retail_merchant", "direct_marketing_inbound_telemarketing", "direct_marketing_insurance_services", "direct_marketing_other", "direct_marketing_outbound_telemarketing", "direct_marketing_subscription", "direct_marketing_travel", "discount_stores", "doctors", "door_to_door_sales", "drapery_window_covering_and_upholstery_stores", "drinking_places", "drug_stores_and_pharmacies", "drugs_drug_proprietaries_and_druggist_sundries", "dry_cleaners", "durable_goods", "duty_free_stores", "eating_places_restaurants", "educational_services", "electric_razor_stores", "electric_vehicle_charging", "electrical_parts_and_equipment", "electrical_services", "electronics_repair_shops", "electronics_stores", "elementary_secondary_schools", "emergency_services_gcas_visa_use_only", "employment_temp_agencies", "equipment_rental", "exterminating_services", "family_clothing_stores", "fast_food_restaurants", "financial_institutions", "fines_government_administrative_entities", "fireplace_fireplace_screens_and_accessories_stores", "floor_covering_stores", "florists", "florists_supplies_nursery_stock_and_flowers", "freezer_and_locker_meat_provisioners", "fuel_dealers_non_automotive", "funeral_services_crematories", "furniture_home_furnishings_and_equipment_stores_except_appliances", "furniture_repair_refinishing", "furriers_and_fur_shops", "general_services", "gift_card_novelty_and_souvenir_shops", "glass_paint_and_wallpaper_stores", "glassware_crystal_stores", "golf_courses_public", "government_licensed_horse_dog_racing_us_region_only", "government_licensed_online_casions_online_gambling_us_region_only", "government_owned_lotteries_non_us_region", "government_owned_lotteries_us_region_only", "government_services", "grocery_stores_supermarkets", "hardware_equipment_and_supplies", "hardware_stores", "health_and_beauty_spas", "hearing_aids_sales_and_supplies", "heating_plumbing_a_c", "hobby_toy_and_game_shops", "home_supply_warehouse_stores", "hospitals", "hotels_motels_and_resorts", "household_appliance_stores", "industrial_supplies", "information_retrieval_services", "insurance_default", "insurance_underwriting_premiums", "intra_company_purchases", "jewelry_stores_watches_clocks_and_silverware_stores", "landscaping_services", "laundries", "laundry_cleaning_services", "legal_services_attorneys", "luggage_and_leather_goods_stores", "lumber_building_materials_stores", "manual_cash_disburse", "marinas_service_and_supplies", "marketplaces", "masonry_stonework_and_plaster", "massage_parlors", "medical_and_dental_labs", "medical_dental_ophthalmic_and_hospital_equipment_and_supplies", "medical_services", "membership_organizations", "mens_and_boys_clothing_and_accessories_stores", "mens_womens_clothing_stores", "metal_service_centers", "miscellaneous", "miscellaneous_apparel_and_accessory_shops", "miscellaneous_auto_dealers", "miscellaneous_business_services", "miscellaneous_food_stores", "miscellaneous_general_merchandise", "miscellaneous_general_services", "miscellaneous_home_furnishing_specialty_stores", "miscellaneous_publishing_and_printing", "miscellaneous_recreation_services", "miscellaneous_repair_shops", "miscellaneous_specialty_retail", "mobile_home_dealers", "motion_picture_theaters", "motor_freight_carriers_and_trucking", "motor_homes_dealers", "motor_vehicle_supplies_and_new_parts", "motorcycle_shops_and_dealers", "motorcycle_shops_dealers", "music_stores_musical_instruments_pianos_and_sheet_music", "news_dealers_and_newsstands", "non_fi_money_orders", "non_fi_stored_value_card_purchase_load", "nondurable_goods", "nurseries_lawn_and_garden_supply_stores", "nursing_personal_care", "office_and_commercial_furniture", "opticians_eyeglasses", "optometrists_ophthalmologist", "orthopedic_goods_prosthetic_devices", "osteopaths", "package_stores_beer_wine_and_liquor", "paints_varnishes_and_supplies", "parking_lots_garages", "passenger_railways", "pawn_shops", "pet_shops_pet_food_and_supplies", "petroleum_and_petroleum_products", "photo_developing", "photographic_photocopy_microfilm_equipment_and_supplies", "photographic_studios", "picture_video_production", "piece_goods_notions_and_other_dry_goods", "plumbing_heating_equipment_and_supplies", "political_organizations", "postal_services_government_only", "precious_stones_and_metals_watches_and_jewelry", "professional_services", "public_warehousing_and_storage", "quick_copy_repro_and_blueprint", "railroads", "real_estate_agents_and_managers_rentals", "record_stores", "recreational_vehicle_rentals", "religious_goods_stores", "religious_organizations", "roofing_siding_sheet_metal", "secretarial_support_services", "security_brokers_dealers", "service_stations", "sewing_needlework_fabric_and_piece_goods_stores", "shoe_repair_hat_cleaning", "shoe_stores", "small_appliance_repair", "snowmobile_dealers", "special_trade_services", "specialty_cleaning", "sporting_goods_stores", "sporting_recreation_camps", "sports_and_riding_apparel_stores", "sports_clubs_fields", "stamp_and_coin_stores", "stationary_office_supplies_printing_and_writing_paper", "stationery_stores_office_and_school_supply_stores", "swimming_pools_sales", "t_ui_travel_germany", "tailors_alterations", "tax_payments_government_agencies", "tax_preparation_services", "taxicabs_limousines", "telecommunication_equipment_and_telephone_sales", "telecommunication_services", "telegraph_services", "tent_and_awning_shops", "testing_laboratories", "theatrical_ticket_agencies", "timeshares", "tire_retreading_and_repair", "tolls_bridge_fees", "tourist_attractions_and_exhibits", "towing_services", "trailer_parks_campgrounds", "transportation_services", "travel_agencies_tour_operators", "truck_stop_iteration", "truck_utility_trailer_rentals", "typesetting_plate_making_and_related_services", "typewriter_stores", "u_s_federal_government_agencies_or_departments", "uniforms_commercial_clothing", "used_merchandise_and_secondhand_stores", "utilities", "variety_stores", "veterinary_services", "video_amusement_game_supplies", "video_game_arcades", "video_tape_rental_stores", "vocational_trade_schools", "watch_jewelry_repair", "welding_repair", "wholesale_clubs", "wig_and_toupee_stores", "wires_money_orders", "womens_accessory_and_specialty_shops", "womens_ready_to_wear_stores", "wrecking_and_salvage_yards" ], "type": "string" }, "nullable": true, "type": "array" }, "allowed_merchant_countries": { "description": "Array of strings containing representing countries from which authorizations will be allowed. Authorizations from merchants in all other countries will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `blocked_merchant_countries`. Provide an empty value to unset this control.", "items": { "maxLength": 5000, "type": "string" }, "nullable": true, "type": "array" }, "blocked_categories": { "description": "Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to decline. All other categories will be allowed. Cannot be set with `allowed_categories`.", "items": { "enum": [ "ac_refrigeration_repair", "accounting_bookkeeping_services", "advertising_services", "agricultural_cooperative", "airlines_air_carriers", "airports_flying_fields", "ambulance_services", "amusement_parks_carnivals", "antique_reproductions", "antique_shops", "aquariums", "architectural_surveying_services", "art_dealers_and_galleries", "artists_supply_and_craft_shops", "auto_and_home_supply_stores", "auto_body_repair_shops", "auto_paint_shops", "auto_service_shops", "automated_cash_disburse", "automated_fuel_dispensers", "automobile_associations", "automotive_parts_and_accessories_stores", "automotive_tire_stores", "bail_and_bond_payments", "bakeries", "bands_orchestras", "barber_and_beauty_shops", "betting_casino_gambling", "bicycle_shops", "billiard_pool_establishments", "boat_dealers", "boat_rentals_and_leases", "book_stores", "books_periodicals_and_newspapers", "bowling_alleys", "bus_lines", "business_secretarial_schools", "buying_shopping_services", "cable_satellite_and_other_pay_television_and_radio", "camera_and_photographic_supply_stores", "candy_nut_and_confectionery_stores", "car_and_truck_dealers_new_used", "car_and_truck_dealers_used_only", "car_rental_agencies", "car_washes", "carpentry_services", "carpet_upholstery_cleaning", "caterers", "charitable_and_social_service_organizations_fundraising", "chemicals_and_allied_products", "child_care_services", "childrens_and_infants_wear_stores", "chiropodists_podiatrists", "chiropractors", "cigar_stores_and_stands", "civic_social_fraternal_associations", "cleaning_and_maintenance", "clothing_rental", "colleges_universities", "commercial_equipment", "commercial_footwear", "commercial_photography_art_and_graphics", "commuter_transport_and_ferries", "computer_network_services", "computer_programming", "computer_repair", "computer_software_stores", "computers_peripherals_and_software", "concrete_work_services", "construction_materials", "consulting_public_relations", "correspondence_schools", "cosmetic_stores", "counseling_services", "country_clubs", "courier_services", "court_costs", "credit_reporting_agencies", "cruise_lines", "dairy_products_stores", "dance_hall_studios_schools", "dating_escort_services", "dentists_orthodontists", "department_stores", "detective_agencies", "digital_goods_applications", "digital_goods_games", "digital_goods_large_volume", "digital_goods_media", "direct_marketing_catalog_merchant", "direct_marketing_combination_catalog_and_retail_merchant", "direct_marketing_inbound_telemarketing", "direct_marketing_insurance_services", "direct_marketing_other", "direct_marketing_outbound_telemarketing", "direct_marketing_subscription", "direct_marketing_travel", "discount_stores", "doctors", "door_to_door_sales", "drapery_window_covering_and_upholstery_stores", "drinking_places", "drug_stores_and_pharmacies", "drugs_drug_proprietaries_and_druggist_sundries", "dry_cleaners", "durable_goods", "duty_free_stores", "eating_places_restaurants", "educational_services", "electric_razor_stores", "electric_vehicle_charging", "electrical_parts_and_equipment", "electrical_services", "electronics_repair_shops", "electronics_stores", "elementary_secondary_schools", "emergency_services_gcas_visa_use_only", "employment_temp_agencies", "equipment_rental", "exterminating_services", "family_clothing_stores", "fast_food_restaurants", "financial_institutions", "fines_government_administrative_entities", "fireplace_fireplace_screens_and_accessories_stores", "floor_covering_stores", "florists", "florists_supplies_nursery_stock_and_flowers", "freezer_and_locker_meat_provisioners", "fuel_dealers_non_automotive", "funeral_services_crematories", "furniture_home_furnishings_and_equipment_stores_except_appliances", "furniture_repair_refinishing", "furriers_and_fur_shops", "general_services", "gift_card_novelty_and_souvenir_shops", "glass_paint_and_wallpaper_stores", "glassware_crystal_stores", "golf_courses_public", "government_licensed_horse_dog_racing_us_region_only", "government_licensed_online_casions_online_gambling_us_region_only", "government_owned_lotteries_non_us_region", "government_owned_lotteries_us_region_only", "government_services", "grocery_stores_supermarkets", "hardware_equipment_and_supplies", "hardware_stores", "health_and_beauty_spas", "hearing_aids_sales_and_supplies", "heating_plumbing_a_c", "hobby_toy_and_game_shops", "home_supply_warehouse_stores", "hospitals", "hotels_motels_and_resorts", "household_appliance_stores", "industrial_supplies", "information_retrieval_services", "insurance_default", "insurance_underwriting_premiums", "intra_company_purchases", "jewelry_stores_watches_clocks_and_silverware_stores", "landscaping_services", "laundries", "laundry_cleaning_services", "legal_services_attorneys", "luggage_and_leather_goods_stores", "lumber_building_materials_stores", "manual_cash_disburse", "marinas_service_and_supplies", "marketplaces", "masonry_stonework_and_plaster", "massage_parlors", "medical_and_dental_labs", "medical_dental_ophthalmic_and_hospital_equipment_and_supplies", "medical_services", "membership_organizations", "mens_and_boys_clothing_and_accessories_stores", "mens_womens_clothing_stores", "metal_service_centers", "miscellaneous", "miscellaneous_apparel_and_accessory_shops", "miscellaneous_auto_dealers", "miscellaneous_business_services", "miscellaneous_food_stores", "miscellaneous_general_merchandise", "miscellaneous_general_services", "miscellaneous_home_furnishing_specialty_stores", "miscellaneous_publishing_and_printing", "miscellaneous_recreation_services", "miscellaneous_repair_shops", "miscellaneous_specialty_retail", "mobile_home_dealers", "motion_picture_theaters", "motor_freight_carriers_and_trucking", "motor_homes_dealers", "motor_vehicle_supplies_and_new_parts", "motorcycle_shops_and_dealers", "motorcycle_shops_dealers", "music_stores_musical_instruments_pianos_and_sheet_music", "news_dealers_and_newsstands", "non_fi_money_orders", "non_fi_stored_value_card_purchase_load", "nondurable_goods", "nurseries_lawn_and_garden_supply_stores", "nursing_personal_care", "office_and_commercial_furniture", "opticians_eyeglasses", "optometrists_ophthalmologist", "orthopedic_goods_prosthetic_devices", "osteopaths", "package_stores_beer_wine_and_liquor", "paints_varnishes_and_supplies", "parking_lots_garages", "passenger_railways", "pawn_shops", "pet_shops_pet_food_and_supplies", "petroleum_and_petroleum_products", "photo_developing", "photographic_photocopy_microfilm_equipment_and_supplies", "photographic_studios", "picture_video_production", "piece_goods_notions_and_other_dry_goods", "plumbing_heating_equipment_and_supplies", "political_organizations", "postal_services_government_only", "precious_stones_and_metals_watches_and_jewelry", "professional_services", "public_warehousing_and_storage", "quick_copy_repro_and_blueprint", "railroads", "real_estate_agents_and_managers_rentals", "record_stores", "recreational_vehicle_rentals", "religious_goods_stores", "religious_organizations", "roofing_siding_sheet_metal", "secretarial_support_services", "security_brokers_dealers", "service_stations", "sewing_needlework_fabric_and_piece_goods_stores", "shoe_repair_hat_cleaning", "shoe_stores", "small_appliance_repair", "snowmobile_dealers", "special_trade_services", "specialty_cleaning", "sporting_goods_stores", "sporting_recreation_camps", "sports_and_riding_apparel_stores", "sports_clubs_fields", "stamp_and_coin_stores", "stationary_office_supplies_printing_and_writing_paper", "stationery_stores_office_and_school_supply_stores", "swimming_pools_sales", "t_ui_travel_germany", "tailors_alterations", "tax_payments_government_agencies", "tax_preparation_services", "taxicabs_limousines", "telecommunication_equipment_and_telephone_sales", "telecommunication_services", "telegraph_services", "tent_and_awning_shops", "testing_laboratories", "theatrical_ticket_agencies", "timeshares", "tire_retreading_and_repair", "tolls_bridge_fees", "tourist_attractions_and_exhibits", "towing_services", "trailer_parks_campgrounds", "transportation_services", "travel_agencies_tour_operators", "truck_stop_iteration", "truck_utility_trailer_rentals", "typesetting_plate_making_and_related_services", "typewriter_stores", "u_s_federal_government_agencies_or_departments", "uniforms_commercial_clothing", "used_merchandise_and_secondhand_stores", "utilities", "variety_stores", "veterinary_services", "video_amusement_game_supplies", "video_game_arcades", "video_tape_rental_stores", "vocational_trade_schools", "watch_jewelry_repair", "welding_repair", "wholesale_clubs", "wig_and_toupee_stores", "wires_money_orders", "womens_accessory_and_specialty_shops", "womens_ready_to_wear_stores", "wrecking_and_salvage_yards" ], "type": "string" }, "nullable": true, "type": "array" }, "blocked_merchant_countries": { "description": "Array of strings containing representing countries from which authorizations will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `allowed_merchant_countries`. Provide an empty value to unset this control.", "items": { "maxLength": 5000, "type": "string" }, "nullable": true, "type": "array" }, "spending_limits": { "description": "Limit spending with amount-based rules that apply across this cardholder's cards.", "items": { "$ref": "#/components/schemas/issuing_cardholder_spending_limit" }, "nullable": true, "type": "array" }, "spending_limits_currency": { "description": "Currency of the amounts within `spending_limits`.", "format": "currency", "nullable": true, "type": "string" } }, "required": [ "allowed_categories", "allowed_merchant_countries", "blocked_categories", "blocked_merchant_countries", "spending_limits", "spending_limits_currency" ], "title": "IssuingCardholderAuthorizationControls", "type": "object", "x-expandableFields": [ "spending_limits" ], "x-stripeMostCommon": [ "allowed_categories", "allowed_merchant_countries", "blocked_categories", "blocked_merchant_countries", "spending_limits", "spending_limits_currency" ] }, "issuing_cardholder_card_issuing": { "description": "", "properties": { "user_terms_acceptance": { "anyOf": [ { "$ref": "#/components/schemas/issuing_cardholder_user_terms_acceptance" } ], "description": "Information about cardholder acceptance of Celtic [Authorized User Terms](https://stripe.com/docs/issuing/cards#accept-authorized-user-terms). Required for cards backed by a Celtic program.", "nullable": true } }, "required": [ "user_terms_acceptance" ], "title": "IssuingCardholderCardIssuing", "type": "object", "x-expandableFields": [ "user_terms_acceptance" ], "x-stripeMostCommon": [ "user_terms_acceptance" ] }, "issuing_cardholder_company": { "description": "", "properties": { "tax_id_provided": { "description": "Whether the company's business ID number was provided.", "type": "boolean" } }, "required": [ "tax_id_provided" ], "title": "IssuingCardholderCompany", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "tax_id_provided" ] }, "issuing_cardholder_id_document": { "description": "", "properties": { "back": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/file" } ], "description": "The back of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/file" } ] } }, "front": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/file" } ], "description": "The front of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/file" } ] } } }, "required": [ "back", "front" ], "title": "IssuingCardholderIdDocument", "type": "object", "x-expandableFields": [ "back", "front" ], "x-stripeMostCommon": [ "back", "front" ] }, "issuing_cardholder_individual": { "description": "", "properties": { "card_issuing": { "anyOf": [ { "$ref": "#/components/schemas/issuing_cardholder_card_issuing" } ], "description": "Information related to the card_issuing program for this cardholder.", "nullable": true }, "dob": { "anyOf": [ { "$ref": "#/components/schemas/issuing_cardholder_individual_dob" } ], "description": "The date of birth of this cardholder.", "nullable": true }, "first_name": { "description": "The first name of this cardholder. Required before activating Cards. This field cannot contain any numbers, special characters (except periods, commas, hyphens, spaces and apostrophes) or non-latin letters.", "maxLength": 5000, "nullable": true, "type": "string" }, "last_name": { "description": "The last name of this cardholder. Required before activating Cards. This field cannot contain any numbers, special characters (except periods, commas, hyphens, spaces and apostrophes) or non-latin letters.", "maxLength": 5000, "nullable": true, "type": "string" }, "verification": { "anyOf": [ { "$ref": "#/components/schemas/issuing_cardholder_verification" } ], "description": "Government-issued ID document for this cardholder.", "nullable": true } }, "required": [ "dob", "first_name", "last_name", "verification" ], "title": "IssuingCardholderIndividual", "type": "object", "x-expandableFields": [ "card_issuing", "dob", "verification" ], "x-stripeMostCommon": [ "card_issuing", "dob", "first_name", "last_name", "verification" ] }, "issuing_cardholder_individual_dob": { "description": "", "properties": { "day": { "description": "The day of birth, between 1 and 31.", "nullable": true, "type": "integer" }, "month": { "description": "The month of birth, between 1 and 12.", "nullable": true, "type": "integer" }, "year": { "description": "The four-digit year of birth.", "nullable": true, "type": "integer" } }, "required": [ "day", "month", "year" ], "title": "IssuingCardholderIndividualDOB", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "day", "month", "year" ] }, "issuing_cardholder_requirements": { "description": "", "properties": { "disabled_reason": { "description": "If `disabled_reason` is present, all cards will decline authorizations with `cardholder_verification_required` reason.", "enum": [ "listed", "rejected.listed", "requirements.past_due", "under_review" ], "nullable": true, "type": "string" }, "past_due": { "description": "Array of fields that need to be collected in order to verify and re-enable the cardholder.", "items": { "enum": [ "company.tax_id", "individual.card_issuing.user_terms_acceptance.date", "individual.card_issuing.user_terms_acceptance.ip", "individual.dob.day", "individual.dob.month", "individual.dob.year", "individual.first_name", "individual.last_name", "individual.verification.document" ], "type": "string", "x-stripeBypassValidation": true }, "nullable": true, "type": "array" } }, "required": [ "disabled_reason", "past_due" ], "title": "IssuingCardholderRequirements", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "disabled_reason", "past_due" ] }, "issuing_cardholder_spending_limit": { "description": "", "properties": { "amount": { "description": "Maximum amount allowed to spend per interval. This amount is in the card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", "type": "integer" }, "categories": { "description": "Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) this limit applies to. Omitting this field will apply the limit to all categories.", "items": { "enum": [ "ac_refrigeration_repair", "accounting_bookkeeping_services", "advertising_services", "agricultural_cooperative", "airlines_air_carriers", "airports_flying_fields", "ambulance_services", "amusement_parks_carnivals", "antique_reproductions", "antique_shops", "aquariums", "architectural_surveying_services", "art_dealers_and_galleries", "artists_supply_and_craft_shops", "auto_and_home_supply_stores", "auto_body_repair_shops", "auto_paint_shops", "auto_service_shops", "automated_cash_disburse", "automated_fuel_dispensers", "automobile_associations", "automotive_parts_and_accessories_stores", "automotive_tire_stores", "bail_and_bond_payments", "bakeries", "bands_orchestras", "barber_and_beauty_shops", "betting_casino_gambling", "bicycle_shops", "billiard_pool_establishments", "boat_dealers", "boat_rentals_and_leases", "book_stores", "books_periodicals_and_newspapers", "bowling_alleys", "bus_lines", "business_secretarial_schools", "buying_shopping_services", "cable_satellite_and_other_pay_television_and_radio", "camera_and_photographic_supply_stores", "candy_nut_and_confectionery_stores", "car_and_truck_dealers_new_used", "car_and_truck_dealers_used_only", "car_rental_agencies", "car_washes", "carpentry_services", "carpet_upholstery_cleaning", "caterers", "charitable_and_social_service_organizations_fundraising", "chemicals_and_allied_products", "child_care_services", "childrens_and_infants_wear_stores", "chiropodists_podiatrists", "chiropractors", "cigar_stores_and_stands", "civic_social_fraternal_associations", "cleaning_and_maintenance", "clothing_rental", "colleges_universities", "commercial_equipment", "commercial_footwear", "commercial_photography_art_and_graphics", "commuter_transport_and_ferries", "computer_network_services", "computer_programming", "computer_repair", "computer_software_stores", "computers_peripherals_and_software", "concrete_work_services", "construction_materials", "consulting_public_relations", "correspondence_schools", "cosmetic_stores", "counseling_services", "country_clubs", "courier_services", "court_costs", "credit_reporting_agencies", "cruise_lines", "dairy_products_stores", "dance_hall_studios_schools", "dating_escort_services", "dentists_orthodontists", "department_stores", "detective_agencies", "digital_goods_applications", "digital_goods_games", "digital_goods_large_volume", "digital_goods_media", "direct_marketing_catalog_merchant", "direct_marketing_combination_catalog_and_retail_merchant", "direct_marketing_inbound_telemarketing", "direct_marketing_insurance_services", "direct_marketing_other", "direct_marketing_outbound_telemarketing", "direct_marketing_subscription", "direct_marketing_travel", "discount_stores", "doctors", "door_to_door_sales", "drapery_window_covering_and_upholstery_stores", "drinking_places", "drug_stores_and_pharmacies", "drugs_drug_proprietaries_and_druggist_sundries", "dry_cleaners", "durable_goods", "duty_free_stores", "eating_places_restaurants", "educational_services", "electric_razor_stores", "electric_vehicle_charging", "electrical_parts_and_equipment", "electrical_services", "electronics_repair_shops", "electronics_stores", "elementary_secondary_schools", "emergency_services_gcas_visa_use_only", "employment_temp_agencies", "equipment_rental", "exterminating_services", "family_clothing_stores", "fast_food_restaurants", "financial_institutions", "fines_government_administrative_entities", "fireplace_fireplace_screens_and_accessories_stores", "floor_covering_stores", "florists", "florists_supplies_nursery_stock_and_flowers", "freezer_and_locker_meat_provisioners", "fuel_dealers_non_automotive", "funeral_services_crematories", "furniture_home_furnishings_and_equipment_stores_except_appliances", "furniture_repair_refinishing", "furriers_and_fur_shops", "general_services", "gift_card_novelty_and_souvenir_shops", "glass_paint_and_wallpaper_stores", "glassware_crystal_stores", "golf_courses_public", "government_licensed_horse_dog_racing_us_region_only", "government_licensed_online_casions_online_gambling_us_region_only", "government_owned_lotteries_non_us_region", "government_owned_lotteries_us_region_only", "government_services", "grocery_stores_supermarkets", "hardware_equipment_and_supplies", "hardware_stores", "health_and_beauty_spas", "hearing_aids_sales_and_supplies", "heating_plumbing_a_c", "hobby_toy_and_game_shops", "home_supply_warehouse_stores", "hospitals", "hotels_motels_and_resorts", "household_appliance_stores", "industrial_supplies", "information_retrieval_services", "insurance_default", "insurance_underwriting_premiums", "intra_company_purchases", "jewelry_stores_watches_clocks_and_silverware_stores", "landscaping_services", "laundries", "laundry_cleaning_services", "legal_services_attorneys", "luggage_and_leather_goods_stores", "lumber_building_materials_stores", "manual_cash_disburse", "marinas_service_and_supplies", "marketplaces", "masonry_stonework_and_plaster", "massage_parlors", "medical_and_dental_labs", "medical_dental_ophthalmic_and_hospital_equipment_and_supplies", "medical_services", "membership_organizations", "mens_and_boys_clothing_and_accessories_stores", "mens_womens_clothing_stores", "metal_service_centers", "miscellaneous", "miscellaneous_apparel_and_accessory_shops", "miscellaneous_auto_dealers", "miscellaneous_business_services", "miscellaneous_food_stores", "miscellaneous_general_merchandise", "miscellaneous_general_services", "miscellaneous_home_furnishing_specialty_stores", "miscellaneous_publishing_and_printing", "miscellaneous_recreation_services", "miscellaneous_repair_shops", "miscellaneous_specialty_retail", "mobile_home_dealers", "motion_picture_theaters", "motor_freight_carriers_and_trucking", "motor_homes_dealers", "motor_vehicle_supplies_and_new_parts", "motorcycle_shops_and_dealers", "motorcycle_shops_dealers", "music_stores_musical_instruments_pianos_and_sheet_music", "news_dealers_and_newsstands", "non_fi_money_orders", "non_fi_stored_value_card_purchase_load", "nondurable_goods", "nurseries_lawn_and_garden_supply_stores", "nursing_personal_care", "office_and_commercial_furniture", "opticians_eyeglasses", "optometrists_ophthalmologist", "orthopedic_goods_prosthetic_devices", "osteopaths", "package_stores_beer_wine_and_liquor", "paints_varnishes_and_supplies", "parking_lots_garages", "passenger_railways", "pawn_shops", "pet_shops_pet_food_and_supplies", "petroleum_and_petroleum_products", "photo_developing", "photographic_photocopy_microfilm_equipment_and_supplies", "photographic_studios", "picture_video_production", "piece_goods_notions_and_other_dry_goods", "plumbing_heating_equipment_and_supplies", "political_organizations", "postal_services_government_only", "precious_stones_and_metals_watches_and_jewelry", "professional_services", "public_warehousing_and_storage", "quick_copy_repro_and_blueprint", "railroads", "real_estate_agents_and_managers_rentals", "record_stores", "recreational_vehicle_rentals", "religious_goods_stores", "religious_organizations", "roofing_siding_sheet_metal", "secretarial_support_services", "security_brokers_dealers", "service_stations", "sewing_needlework_fabric_and_piece_goods_stores", "shoe_repair_hat_cleaning", "shoe_stores", "small_appliance_repair", "snowmobile_dealers", "special_trade_services", "specialty_cleaning", "sporting_goods_stores", "sporting_recreation_camps", "sports_and_riding_apparel_stores", "sports_clubs_fields", "stamp_and_coin_stores", "stationary_office_supplies_printing_and_writing_paper", "stationery_stores_office_and_school_supply_stores", "swimming_pools_sales", "t_ui_travel_germany", "tailors_alterations", "tax_payments_government_agencies", "tax_preparation_services", "taxicabs_limousines", "telecommunication_equipment_and_telephone_sales", "telecommunication_services", "telegraph_services", "tent_and_awning_shops", "testing_laboratories", "theatrical_ticket_agencies", "timeshares", "tire_retreading_and_repair", "tolls_bridge_fees", "tourist_attractions_and_exhibits", "towing_services", "trailer_parks_campgrounds", "transportation_services", "travel_agencies_tour_operators", "truck_stop_iteration", "truck_utility_trailer_rentals", "typesetting_plate_making_and_related_services", "typewriter_stores", "u_s_federal_government_agencies_or_departments", "uniforms_commercial_clothing", "used_merchandise_and_secondhand_stores", "utilities", "variety_stores", "veterinary_services", "video_amusement_game_supplies", "video_game_arcades", "video_tape_rental_stores", "vocational_trade_schools", "watch_jewelry_repair", "welding_repair", "wholesale_clubs", "wig_and_toupee_stores", "wires_money_orders", "womens_accessory_and_specialty_shops", "womens_ready_to_wear_stores", "wrecking_and_salvage_yards" ], "type": "string" }, "nullable": true, "type": "array" }, "interval": { "description": "Interval (or event) to which the amount applies.", "enum": [ "all_time", "daily", "monthly", "per_authorization", "weekly", "yearly" ], "type": "string" } }, "required": [ "amount", "categories", "interval" ], "title": "IssuingCardholderSpendingLimit", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "amount", "categories", "interval" ] }, "issuing_cardholder_user_terms_acceptance": { "description": "", "properties": { "date": { "description": "The Unix timestamp marking when the cardholder accepted the Authorized User Terms.", "format": "unix-time", "nullable": true, "type": "integer" }, "ip": { "description": "The IP address from which the cardholder accepted the Authorized User Terms.", "maxLength": 5000, "nullable": true, "type": "string" }, "user_agent": { "description": "The user agent of the browser from which the cardholder accepted the Authorized User Terms.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "date", "ip", "user_agent" ], "title": "IssuingCardholderUserTermsAcceptance", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "date", "ip", "user_agent" ] }, "issuing_cardholder_verification": { "description": "", "properties": { "document": { "anyOf": [ { "$ref": "#/components/schemas/issuing_cardholder_id_document" } ], "description": "An identifying document, either a passport or local ID card.", "nullable": true } }, "required": [ "document" ], "title": "IssuingCardholderVerification", "type": "object", "x-expandableFields": [ "document" ], "x-stripeMostCommon": [ "document" ] }, "issuing_compliance_credit_underwriting_record_application": { "description": "", "properties": { "application_method": { "description": "The channel through which the applicant has submitted their application.", "enum": [ "in_person", "mail", "online", "phone" ], "type": "string" }, "purpose": { "description": "Scope of demand made by the applicant.", "enum": [ "credit_limit_increase", "credit_line_opening" ], "type": "string", "x-stripeBypassValidation": true }, "submitted_at": { "description": "Date when the applicant submitted their application.", "format": "unix-time", "type": "integer" } }, "required": [ "application_method", "purpose", "submitted_at" ], "title": "IssuingComplianceCreditUnderwritingRecordApplication", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "purpose", "submitted_at" ] }, "issuing_compliance_credit_underwriting_record_credit_user": { "description": "", "properties": { "email": { "description": "Email of the applicant or accountholder.", "maxLength": 5000, "type": "string" }, "name": { "description": "Full name of the company or person.", "maxLength": 5000, "type": "string" } }, "required": [ "email", "name" ], "title": "IssuingComplianceCreditUnderwritingRecordCreditUser", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "email", "name" ] }, "issuing_compliance_credit_underwriting_record_decision": { "description": "", "properties": { "application_rejected": { "anyOf": [ { "$ref": "#/components/schemas/issuing_compliance_credit_underwriting_record_decision_type_application_rejected" } ], "description": "Details about a decision application_rejected.", "nullable": true }, "credit_limit_approved": { "anyOf": [ { "$ref": "#/components/schemas/issuing_compliance_credit_underwriting_record_decision_type_credit_limit_approved" } ], "description": "Details about a decision credit_limit_approved.", "nullable": true }, "credit_limit_decreased": { "anyOf": [ { "$ref": "#/components/schemas/issuing_compliance_credit_underwriting_record_decision_type_credit_limit_decreased" } ], "description": "Details about a decision credit_limit_decreased.", "nullable": true }, "credit_line_closed": { "anyOf": [ { "$ref": "#/components/schemas/issuing_compliance_credit_underwriting_record_decision_type_credit_line_closed" } ], "description": "Details about a decision credit_line_closed.", "nullable": true }, "type": { "description": "Outcome of the decision.", "enum": [ "additional_information_requested", "application_rejected", "credit_limit_approved", "credit_limit_decreased", "credit_line_closed", "no_changes", "withdrawn_by_applicant" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "application_rejected", "credit_limit_approved", "credit_limit_decreased", "credit_line_closed", "type" ], "title": "IssuingComplianceCreditUnderwritingRecordDecision", "type": "object", "x-expandableFields": [ "application_rejected", "credit_limit_approved", "credit_limit_decreased", "credit_line_closed" ], "x-stripeMostCommon": [ "application_rejected", "credit_limit_approved", "credit_limit_decreased", "credit_line_closed", "type" ] }, "issuing_compliance_credit_underwriting_record_decision_type_application_rejected": { "description": "", "properties": { "reason_other_explanation": { "description": "Details about the `reasons.other` when present.", "maxLength": 5000, "nullable": true, "type": "string" }, "reasons": { "description": "List of reasons why the application was rejected up to 4 reasons, in order of importance.", "items": { "enum": [ "applicant_is_not_beneficial_owner", "applicant_too_young", "application_is_not_beneficial_owner", "bankruptcy", "business_size_too_small", "current_account_tier_ineligible", "customer_already_exists", "customer_requested_account_closure", "debt_to_cash_balance_ratio_too_high", "debt_to_equity_ratio_too_high", "delinquent_credit_obligations", "dispute_rate_too_high", "duration_of_residence", "excessive_income_or_revenue_obligations", "expenses_to_cash_balance_ratio_too_high", "foreclosure_or_repossession", "frozen_file_at_credit_bureau", "garnishment_or_attachment", "government_loan_program_criteria", "high_concentration_of_clients", "high_risk_industry", "incomplete_application", "inconsistent_monthly_revenues", "insufficient_account_history_with_platform", "insufficient_bank_account_history", "insufficient_cash_balance", "insufficient_cash_flow", "insufficient_collateral", "insufficient_credit_experience", "insufficient_deposits", "insufficient_income", "insufficient_margin_ratio", "insufficient_operating_profit", "insufficient_period_in_operation", "insufficient_reserves", "insufficient_revenue", "insufficient_social_media_performance", "insufficient_time_in_network", "insufficient_trade_credit_insurance", "invalid_business_license", "lacking_cash_account", "late_payment_history_reported_to_bureau", "lien_collection_action_or_judgement", "negative_public_information", "no_credit_file", "other", "outside_supported_country", "outside_supported_state", "poor_payment_history_with_platform", "prior_or_current_legal_action", "prohibited_industry", "rate_of_cash_balance_fluctuation_too_high", "recent_inquiries_on_business_credit_report", "removal_of_bank_account_connection", "revenue_discrepancy", "runway_too_short", "suspected_fraud", "too_many_non_sufficient_funds_or_overdrafts", "unable_to_verify_address", "unable_to_verify_identity", "unable_to_verify_income_or_revenue", "unprofitable", "unsupportable_business_type" ], "type": "string" }, "type": "array" } }, "required": [ "reason_other_explanation", "reasons" ], "title": "IssuingComplianceCreditUnderwritingRecordDecisionTypeApplicationRejected", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "reason_other_explanation", "reasons" ] }, "issuing_compliance_credit_underwriting_record_decision_type_credit_limit_approved": { "description": "", "properties": { "amount": { "description": "Credit amount approved. An approved credit limit is required before you can set a amount in the [CreditPolicy API](https://stripe.com/docs/api/issuing/credit_policy).", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" } }, "required": [ "amount", "currency" ], "title": "IssuingComplianceCreditUnderwritingRecordDecisionTypeCreditLimitApproved", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "amount", "currency" ] }, "issuing_compliance_credit_underwriting_record_decision_type_credit_limit_decreased": { "description": "", "properties": { "amount": { "description": "Credit amount approved after decrease. An approved credit limit is required before you can set a amount in the [CreditPolicy API](https://stripe.com/docs/api/issuing/credit_policy).", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "reason_other_explanation": { "description": "Details about the `reasons.other` when present.", "maxLength": 5000, "nullable": true, "type": "string" }, "reasons": { "description": "List of reasons why the existing credit was decreased, up to 4 reasons, in order of importance.", "items": { "enum": [ "applicant_is_not_beneficial_owner", "applicant_too_young", "application_is_not_beneficial_owner", "bankruptcy", "business_size_too_small", "change_in_financial_state", "change_in_utilization_of_credit_line", "current_account_tier_ineligible", "customer_already_exists", "customer_requested_account_closure", "debt_to_cash_balance_ratio_too_high", "debt_to_equity_ratio_too_high", "decrease_in_income_to_expense_ratio", "decrease_in_social_media_performance", "delinquent_credit_obligations", "dispute_rate_too_high", "duration_of_residence", "exceeds_acceptable_platform_exposure", "excessive_income_or_revenue_obligations", "expenses_to_cash_balance_ratio_too_high", "foreclosure_or_repossession", "frozen_file_at_credit_bureau", "garnishment_or_attachment", "government_loan_program_criteria", "has_recent_credit_limit_increase", "high_concentration_of_clients", "high_risk_industry", "incomplete_application", "inconsistent_monthly_revenues", "insufficient_account_history_with_platform", "insufficient_bank_account_history", "insufficient_cash_balance", "insufficient_cash_flow", "insufficient_collateral", "insufficient_credit_experience", "insufficient_credit_utilization", "insufficient_deposits", "insufficient_income", "insufficient_margin_ratio", "insufficient_operating_profit", "insufficient_period_in_operation", "insufficient_reserves", "insufficient_revenue", "insufficient_social_media_performance", "insufficient_time_in_network", "insufficient_trade_credit_insurance", "insufficient_usage_as_qualified_expenses", "invalid_business_license", "lacking_cash_account", "late_payment_history_reported_to_bureau", "lien_collection_action_or_judgement", "negative_public_information", "no_credit_file", "other", "outside_supported_country", "outside_supported_state", "poor_payment_history_with_platform", "prior_or_current_legal_action", "prohibited_industry", "rate_of_cash_balance_fluctuation_too_high", "recent_inquiries_on_business_credit_report", "removal_of_bank_account_connection", "revenue_discrepancy", "runway_too_short", "suspected_fraud", "too_many_non_sufficient_funds_or_overdrafts", "unable_to_verify_address", "unable_to_verify_identity", "unable_to_verify_income_or_revenue", "unprofitable", "unsupportable_business_type" ], "type": "string" }, "type": "array" } }, "required": [ "amount", "currency", "reason_other_explanation", "reasons" ], "title": "IssuingComplianceCreditUnderwritingRecordDecisionTypeCreditLimitDecreased", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "amount", "currency", "reason_other_explanation", "reasons" ] }, "issuing_compliance_credit_underwriting_record_decision_type_credit_line_closed": { "description": "", "properties": { "reason_other_explanation": { "description": "Details about the `reasons.other` when present.", "maxLength": 5000, "nullable": true, "type": "string" }, "reasons": { "description": "List of reasons why the existing account was closed, up to 4 reasons, in order of importance.", "items": { "enum": [ "applicant_is_not_beneficial_owner", "applicant_too_young", "application_is_not_beneficial_owner", "bankruptcy", "business_size_too_small", "change_in_financial_state", "change_in_utilization_of_credit_line", "current_account_tier_ineligible", "customer_already_exists", "customer_requested_account_closure", "debt_to_cash_balance_ratio_too_high", "debt_to_equity_ratio_too_high", "decrease_in_income_to_expense_ratio", "decrease_in_social_media_performance", "delinquent_credit_obligations", "dispute_rate_too_high", "duration_of_residence", "exceeds_acceptable_platform_exposure", "excessive_income_or_revenue_obligations", "expenses_to_cash_balance_ratio_too_high", "foreclosure_or_repossession", "frozen_file_at_credit_bureau", "garnishment_or_attachment", "government_loan_program_criteria", "has_recent_credit_limit_increase", "high_concentration_of_clients", "high_risk_industry", "incomplete_application", "inconsistent_monthly_revenues", "insufficient_account_history_with_platform", "insufficient_bank_account_history", "insufficient_cash_balance", "insufficient_cash_flow", "insufficient_collateral", "insufficient_credit_experience", "insufficient_credit_utilization", "insufficient_deposits", "insufficient_income", "insufficient_margin_ratio", "insufficient_operating_profit", "insufficient_period_in_operation", "insufficient_reserves", "insufficient_revenue", "insufficient_social_media_performance", "insufficient_time_in_network", "insufficient_trade_credit_insurance", "insufficient_usage_as_qualified_expenses", "invalid_business_license", "lacking_cash_account", "late_payment_history_reported_to_bureau", "lien_collection_action_or_judgement", "negative_public_information", "no_credit_file", "other", "outside_supported_country", "outside_supported_state", "poor_payment_history_with_platform", "prior_or_current_legal_action", "prohibited_industry", "rate_of_cash_balance_fluctuation_too_high", "recent_inquiries_on_business_credit_report", "removal_of_bank_account_connection", "revenue_discrepancy", "runway_too_short", "suspected_fraud", "too_many_non_sufficient_funds_or_overdrafts", "unable_to_verify_address", "unable_to_verify_identity", "unable_to_verify_income_or_revenue", "unprofitable", "unsupportable_business_type" ], "type": "string", "x-stripeBypassValidation": true }, "type": "array" } }, "required": [ "reason_other_explanation", "reasons" ], "title": "IssuingComplianceCreditUnderwritingRecordDecisionTypeCreditLineClosed", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "reason_other_explanation", "reasons" ] }, "issuing_compliance_credit_underwriting_record_underwriting_exception": { "description": "", "properties": { "explanation": { "description": "Written explanation for the exception.", "maxLength": 5000, "type": "string" }, "original_decision_type": { "description": "The decision before the exception was applied.", "enum": [ "additional_information_requested", "application_rejected", "credit_limit_approved", "credit_limit_decreased", "credit_line_closed", "no_changes", "withdrawn_by_applicant" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "explanation", "original_decision_type" ], "title": "IssuingComplianceCreditUnderwritingRecordUnderwritingException", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "explanation", "original_decision_type" ] }, "issuing_compliance_notice_email": { "description": "", "properties": { "plain_text": { "description": "Content of the email in plain text. The copy must match exactly the language that Stripe Compliance has approved for use.", "maxLength": 10000, "type": "string" }, "recipient": { "description": "Email address of the recipient.", "maxLength": 5000, "type": "string" }, "subject": { "description": "Subject of the email.", "maxLength": 5000, "type": "string" } }, "required": [ "plain_text", "recipient", "subject" ], "title": "IssuingComplianceNoticeEmail", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "plain_text", "recipient", "subject" ] }, "issuing_compliance_notice_linked_objects": { "description": "", "properties": { "capability": { "description": "Associated [Capability](https://stripe.com/docs/api/capabilities)", "maxLength": 5000, "nullable": true, "type": "string" }, "issuing_credit_underwriting_record": { "description": "Associated [Credit Underwriting Record](https://stripe.com/docs/api/issuing/credit_underwriting_record)", "maxLength": 5000, "nullable": true, "type": "string" }, "issuing_dispute": { "description": "Associated [Issuing Dispute](https://stripe.com/docs/api/issuing/disputes)", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "capability", "issuing_dispute" ], "title": "IssuingComplianceNoticeLinkedObjects", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "capability", "issuing_credit_underwriting_record", "issuing_dispute" ] }, "issuing_dispute.closed": { "description": "Occurs whenever a dispute is won, lost or expired.", "properties": { "object": { "$ref": "#/components/schemas/issuing.dispute" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "issuing_dispute.closed" } }, "issuing_dispute.created": { "description": "Occurs whenever a dispute is created.", "properties": { "object": { "$ref": "#/components/schemas/issuing.dispute" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "issuing_dispute.created" } }, "issuing_dispute.funds_reinstated": { "description": "Occurs whenever funds are reinstated to your account for an Issuing dispute.", "properties": { "object": { "$ref": "#/components/schemas/issuing.dispute" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "issuing_dispute.funds_reinstated" } }, "issuing_dispute.funds_rescinded": { "description": "Occurs whenever funds are deducted from your account for an Issuing dispute.", "properties": { "object": { "$ref": "#/components/schemas/issuing.dispute" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "issuing_dispute.funds_rescinded" } }, "issuing_dispute.submitted": { "description": "Occurs whenever a dispute is submitted.", "properties": { "object": { "$ref": "#/components/schemas/issuing.dispute" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "issuing_dispute.submitted" } }, "issuing_dispute.updated": { "description": "Occurs whenever a dispute is updated.", "properties": { "object": { "$ref": "#/components/schemas/issuing.dispute" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "issuing_dispute.updated" } }, "issuing_dispute_canceled_evidence": { "description": "", "properties": { "additional_documentation": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/file" } ], "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/file" } ] } }, "canceled_at": { "description": "Date when order was canceled.", "format": "unix-time", "nullable": true, "type": "integer" }, "cancellation_policy_provided": { "description": "Whether the cardholder was provided with a cancellation policy.", "nullable": true, "type": "boolean" }, "cancellation_reason": { "description": "Reason for canceling the order.", "maxLength": 5000, "nullable": true, "type": "string" }, "expected_at": { "description": "Date when the cardholder expected to receive the product.", "format": "unix-time", "nullable": true, "type": "integer" }, "explanation": { "description": "Explanation of why the cardholder is disputing this transaction.", "maxLength": 5000, "nullable": true, "type": "string" }, "product_description": { "description": "Description of the merchandise or service that was purchased.", "maxLength": 5000, "nullable": true, "type": "string" }, "product_type": { "description": "Whether the product was a merchandise or service.", "enum": [ "merchandise", "service" ], "nullable": true, "type": "string" }, "return_status": { "description": "Result of cardholder's attempt to return the product.", "enum": [ "merchant_rejected", "successful" ], "nullable": true, "type": "string" }, "returned_at": { "description": "Date when the product was returned or attempted to be returned.", "format": "unix-time", "nullable": true, "type": "integer" } }, "required": [ "additional_documentation", "canceled_at", "cancellation_policy_provided", "cancellation_reason", "expected_at", "explanation", "product_description", "product_type", "return_status", "returned_at" ], "title": "IssuingDisputeCanceledEvidence", "type": "object", "x-expandableFields": [ "additional_documentation" ], "x-stripeMostCommon": [ "additional_documentation", "canceled_at", "cancellation_policy_provided", "cancellation_reason", "expected_at", "explanation", "product_description", "product_type", "return_status", "returned_at" ] }, "issuing_dispute_duplicate_evidence": { "description": "", "properties": { "additional_documentation": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/file" } ], "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/file" } ] } }, "card_statement": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/file" } ], "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Copy of the card statement showing that the product had already been paid for.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/file" } ] } }, "cash_receipt": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/file" } ], "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Copy of the receipt showing that the product had been paid for in cash.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/file" } ] } }, "check_image": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/file" } ], "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Image of the front and back of the check that was used to pay for the product.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/file" } ] } }, "explanation": { "description": "Explanation of why the cardholder is disputing this transaction.", "maxLength": 5000, "nullable": true, "type": "string" }, "original_transaction": { "description": "Transaction (e.g., ipi_...) that the disputed transaction is a duplicate of. Of the two or more transactions that are copies of each other, this is original undisputed one.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "additional_documentation", "card_statement", "cash_receipt", "check_image", "explanation", "original_transaction" ], "title": "IssuingDisputeDuplicateEvidence", "type": "object", "x-expandableFields": [ "additional_documentation", "card_statement", "cash_receipt", "check_image" ], "x-stripeMostCommon": [ "additional_documentation", "card_statement", "cash_receipt", "check_image", "explanation", "original_transaction" ] }, "issuing_dispute_evidence": { "description": "", "properties": { "canceled": { "$ref": "#/components/schemas/issuing_dispute_canceled_evidence" }, "duplicate": { "$ref": "#/components/schemas/issuing_dispute_duplicate_evidence" }, "fraudulent": { "$ref": "#/components/schemas/issuing_dispute_fraudulent_evidence" }, "merchandise_not_as_described": { "$ref": "#/components/schemas/issuing_dispute_merchandise_not_as_described_evidence" }, "no_valid_authorization": { "$ref": "#/components/schemas/issuing_dispute_no_valid_authorization_evidence" }, "not_received": { "$ref": "#/components/schemas/issuing_dispute_not_received_evidence" }, "other": { "$ref": "#/components/schemas/issuing_dispute_other_evidence" }, "reason": { "description": "The reason for filing the dispute. Its value will match the field containing the evidence.", "enum": [ "canceled", "duplicate", "fraudulent", "merchandise_not_as_described", "no_valid_authorization", "not_received", "other", "service_not_as_described" ], "type": "string", "x-stripeBypassValidation": true }, "service_not_as_described": { "$ref": "#/components/schemas/issuing_dispute_service_not_as_described_evidence" } }, "required": [ "reason" ], "title": "IssuingDisputeEvidence", "type": "object", "x-expandableFields": [ "canceled", "duplicate", "fraudulent", "merchandise_not_as_described", "no_valid_authorization", "not_received", "other", "service_not_as_described" ], "x-stripeMostCommon": [ "canceled", "duplicate", "fraudulent", "merchandise_not_as_described", "no_valid_authorization", "not_received", "other", "reason", "service_not_as_described" ] }, "issuing_dispute_fraudulent_evidence": { "description": "", "properties": { "additional_documentation": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/file" } ], "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/file" } ] } }, "explanation": { "description": "Explanation of why the cardholder is disputing this transaction.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "additional_documentation", "explanation" ], "title": "IssuingDisputeFraudulentEvidence", "type": "object", "x-expandableFields": [ "additional_documentation" ], "x-stripeMostCommon": [ "additional_documentation", "explanation" ] }, "issuing_dispute_merchandise_not_as_described_evidence": { "description": "", "properties": { "additional_documentation": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/file" } ], "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/file" } ] } }, "explanation": { "description": "Explanation of why the cardholder is disputing this transaction.", "maxLength": 5000, "nullable": true, "type": "string" }, "received_at": { "description": "Date when the product was received.", "format": "unix-time", "nullable": true, "type": "integer" }, "return_description": { "description": "Description of the cardholder's attempt to return the product.", "maxLength": 5000, "nullable": true, "type": "string" }, "return_status": { "description": "Result of cardholder's attempt to return the product.", "enum": [ "merchant_rejected", "successful" ], "nullable": true, "type": "string" }, "returned_at": { "description": "Date when the product was returned or attempted to be returned.", "format": "unix-time", "nullable": true, "type": "integer" } }, "required": [ "additional_documentation", "explanation", "received_at", "return_description", "return_status", "returned_at" ], "title": "IssuingDisputeMerchandiseNotAsDescribedEvidence", "type": "object", "x-expandableFields": [ "additional_documentation" ], "x-stripeMostCommon": [ "additional_documentation", "explanation", "received_at", "return_description", "return_status", "returned_at" ] }, "issuing_dispute_no_valid_authorization_evidence": { "description": "", "properties": { "additional_documentation": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/file" } ], "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/file" } ] } }, "explanation": { "description": "Explanation of why the cardholder is disputing this transaction.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "additional_documentation", "explanation" ], "title": "IssuingDisputeNoValidAuthorizationEvidence", "type": "object", "x-expandableFields": [ "additional_documentation" ], "x-stripeMostCommon": [ "additional_documentation", "explanation" ] }, "issuing_dispute_not_received_evidence": { "description": "", "properties": { "additional_documentation": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/file" } ], "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/file" } ] } }, "expected_at": { "description": "Date when the cardholder expected to receive the product.", "format": "unix-time", "nullable": true, "type": "integer" }, "explanation": { "description": "Explanation of why the cardholder is disputing this transaction.", "maxLength": 5000, "nullable": true, "type": "string" }, "product_description": { "description": "Description of the merchandise or service that was purchased.", "maxLength": 5000, "nullable": true, "type": "string" }, "product_type": { "description": "Whether the product was a merchandise or service.", "enum": [ "merchandise", "service" ], "nullable": true, "type": "string" } }, "required": [ "additional_documentation", "expected_at", "explanation", "product_description", "product_type" ], "title": "IssuingDisputeNotReceivedEvidence", "type": "object", "x-expandableFields": [ "additional_documentation" ], "x-stripeMostCommon": [ "additional_documentation", "expected_at", "explanation", "product_description", "product_type" ] }, "issuing_dispute_other_evidence": { "description": "", "properties": { "additional_documentation": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/file" } ], "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/file" } ] } }, "explanation": { "description": "Explanation of why the cardholder is disputing this transaction.", "maxLength": 5000, "nullable": true, "type": "string" }, "product_description": { "description": "Description of the merchandise or service that was purchased.", "maxLength": 5000, "nullable": true, "type": "string" }, "product_type": { "description": "Whether the product was a merchandise or service.", "enum": [ "merchandise", "service" ], "nullable": true, "type": "string" } }, "required": [ "additional_documentation", "explanation", "product_description", "product_type" ], "title": "IssuingDisputeOtherEvidence", "type": "object", "x-expandableFields": [ "additional_documentation" ], "x-stripeMostCommon": [ "additional_documentation", "explanation", "product_description", "product_type" ] }, "issuing_dispute_service_not_as_described_evidence": { "description": "", "properties": { "additional_documentation": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/file" } ], "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/file" } ] } }, "canceled_at": { "description": "Date when order was canceled.", "format": "unix-time", "nullable": true, "type": "integer" }, "cancellation_reason": { "description": "Reason for canceling the order.", "maxLength": 5000, "nullable": true, "type": "string" }, "explanation": { "description": "Explanation of why the cardholder is disputing this transaction.", "maxLength": 5000, "nullable": true, "type": "string" }, "received_at": { "description": "Date when the product was received.", "format": "unix-time", "nullable": true, "type": "integer" } }, "required": [ "additional_documentation", "canceled_at", "cancellation_reason", "explanation", "received_at" ], "title": "IssuingDisputeServiceNotAsDescribedEvidence", "type": "object", "x-expandableFields": [ "additional_documentation" ], "x-stripeMostCommon": [ "additional_documentation", "canceled_at", "cancellation_reason", "explanation", "received_at" ] }, "issuing_dispute_settlement_detail.created": { "description": "Emitted when the DisputeSettlementDetail object is created", "properties": { "object": { "$ref": "#/components/schemas/issuing.dispute_settlement_detail" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "issuing_dispute_settlement_detail.created" } }, "issuing_dispute_settlement_detail.updated": { "description": "Emitted when the DisputeSettlementDetail object is updated", "properties": { "object": { "$ref": "#/components/schemas/issuing.dispute_settlement_detail" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "issuing_dispute_settlement_detail.updated" } }, "issuing_dispute_settlement_detail_network_data": { "description": "", "properties": { "processing_date": { "description": "The date the transaction was processed by the card network. This can be different from the date the seller recorded the transaction depending on when the acquirer submits the transaction to the network.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "processing_date" ], "title": "IssuingDisputeSettlementDetailNetworkData", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "processing_date" ] }, "issuing_dispute_treasury": { "description": "", "properties": { "debit_reversal": { "description": "The Treasury [DebitReversal](https://stripe.com/docs/api/treasury/debit_reversals) representing this Issuing dispute", "maxLength": 5000, "nullable": true, "type": "string" }, "received_debit": { "description": "The Treasury [ReceivedDebit](https://stripe.com/docs/api/treasury/received_debits) that is being disputed.", "maxLength": 5000, "type": "string" } }, "required": [ "debit_reversal", "received_debit" ], "title": "IssuingDisputeTreasury", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "debit_reversal", "received_debit" ] }, "issuing_fraud_liability_debit.created": { "description": "Occurs whenever funds are deducted from your account for fraud dispute loss liability.", "properties": { "object": { "$ref": "#/components/schemas/issuing.fraud_liability_debit" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "issuing_fraud_liability_debit.created" } }, "issuing_network_token_address": { "description": "", "properties": { "line1": { "description": "The street address of the cardholder tokenizing the card.", "maxLength": 5000, "type": "string" }, "postal_code": { "description": "The postal code of the cardholder tokenizing the card.", "maxLength": 5000, "type": "string" } }, "required": [ "line1", "postal_code" ], "title": "IssuingNetworkTokenAddress", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "line1", "postal_code" ] }, "issuing_network_token_device": { "description": "", "properties": { "device_fingerprint": { "description": "An obfuscated ID derived from the device ID.", "maxLength": 5000, "type": "string" }, "ip_address": { "description": "The IP address of the device at provisioning time.", "maxLength": 5000, "type": "string" }, "location": { "description": "The geographic latitude/longitude coordinates of the device at provisioning time. The format is [+-]decimal/[+-]decimal.", "maxLength": 5000, "type": "string" }, "name": { "description": "The name of the device used for tokenization.", "maxLength": 5000, "type": "string" }, "phone_number": { "description": "The phone number of the device used for tokenization.", "maxLength": 5000, "type": "string" }, "type": { "description": "The type of device used for tokenization.", "enum": [ "other", "phone", "watch" ], "type": "string" } }, "title": "IssuingNetworkTokenDevice", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "device_fingerprint", "ip_address", "location", "name", "phone_number", "type" ] }, "issuing_network_token_mastercard": { "description": "", "properties": { "card_reference_id": { "description": "A unique reference ID from MasterCard to represent the card account number.", "maxLength": 5000, "type": "string" }, "token_reference_id": { "description": "The network-unique identifier for the token.", "maxLength": 5000, "type": "string" }, "token_requestor_id": { "description": "The ID of the entity requesting tokenization, specific to MasterCard.", "maxLength": 5000, "type": "string" }, "token_requestor_name": { "description": "The name of the entity requesting tokenization, if known. This is directly provided from MasterCard.", "maxLength": 5000, "type": "string" } }, "required": [ "token_reference_id", "token_requestor_id" ], "title": "IssuingNetworkTokenMastercard", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "card_reference_id", "token_reference_id", "token_requestor_id", "token_requestor_name" ] }, "issuing_network_token_network_data": { "description": "", "properties": { "device": { "$ref": "#/components/schemas/issuing_network_token_device" }, "mastercard": { "$ref": "#/components/schemas/issuing_network_token_mastercard" }, "type": { "description": "The network that the token is associated with. An additional hash is included with a name matching this value, containing tokenization data specific to the card network.", "enum": [ "mastercard", "visa" ], "type": "string" }, "visa": { "$ref": "#/components/schemas/issuing_network_token_visa" }, "wallet_provider": { "$ref": "#/components/schemas/issuing_network_token_wallet_provider" } }, "required": [ "type" ], "title": "IssuingNetworkTokenNetworkData", "type": "object", "x-expandableFields": [ "device", "mastercard", "visa", "wallet_provider" ], "x-stripeMostCommon": [ "device", "mastercard", "type", "visa", "wallet_provider" ] }, "issuing_network_token_visa": { "description": "", "properties": { "card_reference_id": { "description": "A unique reference ID from Visa to represent the card account number.", "maxLength": 5000, "type": "string" }, "token_reference_id": { "description": "The network-unique identifier for the token.", "maxLength": 5000, "type": "string" }, "token_requestor_id": { "description": "The ID of the entity requesting tokenization, specific to Visa.", "maxLength": 5000, "type": "string" }, "token_risk_score": { "description": "Degree of risk associated with the token between `01` and `99`, with higher number indicating higher risk. A `00` value indicates the token was not scored by Visa.", "maxLength": 5000, "type": "string" } }, "required": [ "card_reference_id", "token_reference_id", "token_requestor_id" ], "title": "IssuingNetworkTokenVisa", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "card_reference_id", "token_reference_id", "token_requestor_id", "token_risk_score" ] }, "issuing_network_token_wallet_provider": { "description": "", "properties": { "account_id": { "description": "The wallet provider-given account ID of the digital wallet the token belongs to.", "maxLength": 5000, "type": "string" }, "account_trust_score": { "description": "An evaluation on the trustworthiness of the wallet account between 1 and 5. A higher score indicates more trustworthy.", "type": "integer" }, "card_number_source": { "description": "The method used for tokenizing a card.", "enum": [ "app", "manual", "on_file", "other" ], "type": "string" }, "cardholder_address": { "$ref": "#/components/schemas/issuing_network_token_address" }, "cardholder_name": { "description": "The name of the cardholder tokenizing the card.", "maxLength": 5000, "type": "string" }, "device_trust_score": { "description": "An evaluation on the trustworthiness of the device. A higher score indicates more trustworthy.", "type": "integer" }, "hashed_account_email_address": { "description": "The hashed email address of the cardholder's account with the wallet provider.", "maxLength": 5000, "type": "string" }, "reason_codes": { "description": "The reasons for suggested tokenization given by the card network.", "items": { "enum": [ "account_card_too_new", "account_recently_changed", "account_too_new", "account_too_new_since_launch", "additional_device", "data_expired", "defer_id_v_decision", "device_recently_lost", "good_activity_history", "has_suspended_tokens", "high_risk", "inactive_account", "long_account_tenure", "low_account_score", "low_device_score", "low_phone_number_score", "network_service_error", "outside_home_territory", "provisioning_cardholder_mismatch", "provisioning_device_and_cardholder_mismatch", "provisioning_device_mismatch", "same_device_no_prior_authentication", "same_device_successful_prior_authentication", "software_update", "suspicious_activity", "too_many_different_cardholders", "too_many_recent_attempts", "too_many_recent_tokens" ], "type": "string" }, "type": "array" }, "suggested_decision": { "description": "The recommendation on responding to the tokenization request.", "enum": [ "approve", "decline", "require_auth" ], "type": "string" }, "suggested_decision_version": { "description": "The version of the standard for mapping reason codes followed by the wallet provider.", "maxLength": 5000, "type": "string" } }, "title": "IssuingNetworkTokenWalletProvider", "type": "object", "x-expandableFields": [ "cardholder_address" ], "x-stripeMostCommon": [ "account_id", "account_trust_score", "card_number_source", "cardholder_address", "cardholder_name", "device_trust_score", "hashed_account_email_address", "reason_codes", "suggested_decision", "suggested_decision_version" ] }, "issuing_personalization_design.activated": { "description": "Occurs whenever a personalization design is activated following the activation of the physical bundle that belongs to it.", "properties": { "object": { "$ref": "#/components/schemas/issuing.personalization_design" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "issuing_personalization_design.activated" } }, "issuing_personalization_design.deactivated": { "description": "Occurs whenever a personalization design is deactivated following the deactivation of the physical bundle that belongs to it.", "properties": { "object": { "$ref": "#/components/schemas/issuing.personalization_design" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "issuing_personalization_design.deactivated" } }, "issuing_personalization_design.rejected": { "description": "Occurs whenever a personalization design is rejected by design review.", "properties": { "object": { "$ref": "#/components/schemas/issuing.personalization_design" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "issuing_personalization_design.rejected" } }, "issuing_personalization_design.updated": { "description": "Occurs whenever a personalization design is updated.", "properties": { "object": { "$ref": "#/components/schemas/issuing.personalization_design" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "issuing_personalization_design.updated" } }, "issuing_personalization_design_carrier_text": { "description": "", "properties": { "footer_body": { "description": "The footer body text of the carrier letter.", "maxLength": 5000, "nullable": true, "type": "string" }, "footer_title": { "description": "The footer title text of the carrier letter.", "maxLength": 5000, "nullable": true, "type": "string" }, "header_body": { "description": "The header body text of the carrier letter.", "maxLength": 5000, "nullable": true, "type": "string" }, "header_title": { "description": "The header title text of the carrier letter.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "footer_body", "footer_title", "header_body", "header_title" ], "title": "IssuingPersonalizationDesignCarrierText", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "footer_body", "footer_title", "header_body", "header_title" ] }, "issuing_personalization_design_preferences": { "description": "", "properties": { "is_default": { "description": "Whether we use this personalization design to create cards when one isn't specified. A connected account uses the Connect platform's default design if no personalization design is set as the default design.", "type": "boolean" }, "is_platform_default": { "description": "Whether this personalization design is used to create cards when one is not specified and a default for this connected account does not exist.", "nullable": true, "type": "boolean" } }, "required": [ "is_default", "is_platform_default" ], "title": "IssuingPersonalizationDesignPreferences", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "is_default", "is_platform_default" ] }, "issuing_personalization_design_rejection_reasons": { "description": "", "properties": { "card_logo": { "description": "The reason(s) the card logo was rejected.", "items": { "enum": [ "geographic_location", "inappropriate", "network_name", "non_binary_image", "non_fiat_currency", "other", "other_entity", "promotional_material" ], "type": "string" }, "nullable": true, "type": "array" }, "carrier_text": { "description": "The reason(s) the carrier text was rejected.", "items": { "enum": [ "geographic_location", "inappropriate", "network_name", "non_fiat_currency", "other", "other_entity", "promotional_material" ], "type": "string" }, "nullable": true, "type": "array" } }, "required": [ "card_logo", "carrier_text" ], "title": "IssuingPersonalizationDesignRejectionReasons", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "card_logo", "carrier_text" ] }, "issuing_physical_bundle_features": { "description": "", "properties": { "card_logo": { "description": "The policy for how to use card logo images in a card design with this physical bundle.", "enum": [ "optional", "required", "unsupported" ], "type": "string" }, "carrier_text": { "description": "The policy for how to use carrier letter text in a card design with this physical bundle.", "enum": [ "optional", "required", "unsupported" ], "type": "string" }, "second_line": { "description": "The policy for how to use a second line on a card with this physical bundle.", "enum": [ "optional", "required", "unsupported" ], "type": "string" } }, "required": [ "card_logo", "carrier_text", "second_line" ], "title": "IssuingPhysicalBundleFeatures", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "card_logo", "carrier_text", "second_line" ] }, "issuing_settlement.created": { "description": "Occurs whenever an issuing settlement is created.", "properties": { "object": { "$ref": "#/components/schemas/issuing.settlement" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "issuing_settlement.created" } }, "issuing_settlement.updated": { "description": "Occurs whenever an issuing settlement is updated.", "properties": { "object": { "$ref": "#/components/schemas/issuing.settlement" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "issuing_settlement.updated" } }, "issuing_token.created": { "description": "Occurs whenever an issuing digital wallet token is created.", "properties": { "object": { "$ref": "#/components/schemas/issuing.token" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "issuing_token.created" } }, "issuing_token.updated": { "description": "Occurs whenever an issuing digital wallet token is updated.", "properties": { "object": { "$ref": "#/components/schemas/issuing.token" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "issuing_token.updated" } }, "issuing_transaction.created": { "description": "Occurs whenever an issuing transaction is created.", "properties": { "object": { "$ref": "#/components/schemas/issuing.transaction" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "issuing_transaction.created" } }, "issuing_transaction.purchase_details_receipt_updated": { "description": "Occurs whenever an issuing transaction is updated with receipt data.", "properties": { "object": { "$ref": "#/components/schemas/issuing.transaction" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "issuing_transaction.purchase_details_receipt_updated" } }, "issuing_transaction.updated": { "description": "Occurs whenever an issuing transaction is updated.", "properties": { "object": { "$ref": "#/components/schemas/issuing.transaction" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "issuing_transaction.updated" } }, "issuing_transaction_amount_details": { "description": "", "properties": { "atm_fee": { "description": "The fee charged by the ATM for the cash withdrawal.", "nullable": true, "type": "integer" }, "cashback_amount": { "description": "The amount of cash requested by the cardholder.", "nullable": true, "type": "integer" } }, "required": [ "atm_fee", "cashback_amount" ], "title": "IssuingTransactionAmountDetails", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "atm_fee", "cashback_amount" ] }, "issuing_transaction_fleet_cardholder_prompt_data": { "description": "", "properties": { "driver_id": { "description": "Driver ID.", "maxLength": 5000, "nullable": true, "type": "string" }, "odometer": { "description": "Odometer reading.", "nullable": true, "type": "integer" }, "unspecified_id": { "description": "An alphanumeric ID. This field is used when a vehicle ID, driver ID, or generic ID is entered by the cardholder, but the merchant or card network did not specify the prompt type.", "maxLength": 5000, "nullable": true, "type": "string" }, "user_id": { "description": "User ID.", "maxLength": 5000, "nullable": true, "type": "string" }, "vehicle_number": { "description": "Vehicle number.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "driver_id", "odometer", "unspecified_id", "user_id", "vehicle_number" ], "title": "IssuingTransactionFleetCardholderPromptData", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "driver_id", "odometer", "unspecified_id", "user_id", "vehicle_number" ] }, "issuing_transaction_fleet_data": { "description": "", "properties": { "cardholder_prompt_data": { "anyOf": [ { "$ref": "#/components/schemas/issuing_transaction_fleet_cardholder_prompt_data" } ], "description": "Answers to prompts presented to cardholder at point of sale.", "nullable": true }, "purchase_type": { "description": "The type of purchase. One of `fuel_purchase`, `non_fuel_purchase`, or `fuel_and_non_fuel_purchase`.", "maxLength": 5000, "nullable": true, "type": "string" }, "reported_breakdown": { "anyOf": [ { "$ref": "#/components/schemas/issuing_transaction_fleet_reported_breakdown" } ], "description": "More information about the total amount. This information is not guaranteed to be accurate as some merchants may provide unreliable data.", "nullable": true }, "service_type": { "description": "The type of fuel service. One of `non_fuel_transaction`, `full_service`, or `self_service`.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "cardholder_prompt_data", "purchase_type", "reported_breakdown", "service_type" ], "title": "IssuingTransactionFleetData", "type": "object", "x-expandableFields": [ "cardholder_prompt_data", "reported_breakdown" ], "x-stripeMostCommon": [ "cardholder_prompt_data", "purchase_type", "reported_breakdown", "service_type" ] }, "issuing_transaction_fleet_fuel_price_data": { "description": "", "properties": { "gross_amount_decimal": { "description": "Gross fuel amount that should equal Fuel Volume multipled by Fuel Unit Cost, inclusive of taxes.", "format": "decimal", "nullable": true, "type": "string" } }, "required": [ "gross_amount_decimal" ], "title": "IssuingTransactionFleetFuelPriceData", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "gross_amount_decimal" ] }, "issuing_transaction_fleet_non_fuel_price_data": { "description": "", "properties": { "gross_amount_decimal": { "description": "Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes.", "format": "decimal", "nullable": true, "type": "string" } }, "required": [ "gross_amount_decimal" ], "title": "IssuingTransactionFleetNonFuelPriceData", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "gross_amount_decimal" ] }, "issuing_transaction_fleet_reported_breakdown": { "description": "", "properties": { "fuel": { "anyOf": [ { "$ref": "#/components/schemas/issuing_transaction_fleet_fuel_price_data" } ], "description": "Breakdown of fuel portion of the purchase.", "nullable": true }, "non_fuel": { "anyOf": [ { "$ref": "#/components/schemas/issuing_transaction_fleet_non_fuel_price_data" } ], "description": "Breakdown of non-fuel portion of the purchase.", "nullable": true }, "tax": { "anyOf": [ { "$ref": "#/components/schemas/issuing_transaction_fleet_tax_data" } ], "description": "Information about tax included in this transaction.", "nullable": true } }, "required": [ "fuel", "non_fuel", "tax" ], "title": "IssuingTransactionFleetReportedBreakdown", "type": "object", "x-expandableFields": [ "fuel", "non_fuel", "tax" ], "x-stripeMostCommon": [ "fuel", "non_fuel", "tax" ] }, "issuing_transaction_fleet_tax_data": { "description": "", "properties": { "local_amount_decimal": { "description": "Amount of state or provincial Sales Tax included in the transaction amount. Null if not reported by merchant or not subject to tax.", "format": "decimal", "nullable": true, "type": "string" }, "national_amount_decimal": { "description": "Amount of national Sales Tax or VAT included in the transaction amount. Null if not reported by merchant or not subject to tax.", "format": "decimal", "nullable": true, "type": "string" } }, "required": [ "local_amount_decimal", "national_amount_decimal" ], "title": "IssuingTransactionFleetTaxData", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "local_amount_decimal", "national_amount_decimal" ] }, "issuing_transaction_flight_data": { "description": "", "properties": { "departure_at": { "description": "The time that the flight departed.", "nullable": true, "type": "integer" }, "passenger_name": { "description": "The name of the passenger.", "maxLength": 5000, "nullable": true, "type": "string" }, "refundable": { "description": "Whether the ticket is refundable.", "nullable": true, "type": "boolean" }, "segments": { "description": "The legs of the trip.", "items": { "$ref": "#/components/schemas/issuing_transaction_flight_data_leg" }, "nullable": true, "type": "array" }, "travel_agency": { "description": "The travel agency that issued the ticket.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "departure_at", "passenger_name", "refundable", "segments", "travel_agency" ], "title": "IssuingTransactionFlightData", "type": "object", "x-expandableFields": [ "segments" ], "x-stripeMostCommon": [ "departure_at", "passenger_name", "refundable", "segments", "travel_agency" ] }, "issuing_transaction_flight_data_leg": { "description": "", "properties": { "arrival_airport_code": { "description": "The three-letter IATA airport code of the flight's destination.", "maxLength": 5000, "nullable": true, "type": "string" }, "carrier": { "description": "The airline carrier code.", "maxLength": 5000, "nullable": true, "type": "string" }, "departure_airport_code": { "description": "The three-letter IATA airport code that the flight departed from.", "maxLength": 5000, "nullable": true, "type": "string" }, "flight_number": { "description": "The flight number.", "maxLength": 5000, "nullable": true, "type": "string" }, "service_class": { "description": "The flight's service class.", "maxLength": 5000, "nullable": true, "type": "string" }, "stopover_allowed": { "description": "Whether a stopover is allowed on this flight.", "nullable": true, "type": "boolean" } }, "required": [ "arrival_airport_code", "carrier", "departure_airport_code", "flight_number", "service_class", "stopover_allowed" ], "title": "IssuingTransactionFlightDataLeg", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "arrival_airport_code", "carrier", "departure_airport_code", "flight_number", "service_class", "stopover_allowed" ] }, "issuing_transaction_fuel_data": { "description": "", "properties": { "industry_product_code": { "description": "[Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased.", "maxLength": 5000, "nullable": true, "type": "string" }, "quantity_decimal": { "description": "The quantity of `unit`s of fuel that was dispensed, represented as a decimal string with at most 12 decimal places.", "format": "decimal", "nullable": true, "type": "string" }, "type": { "description": "The type of fuel that was purchased. One of `diesel`, `unleaded_plus`, `unleaded_regular`, `unleaded_super`, or `other`.", "maxLength": 5000, "type": "string" }, "unit": { "description": "The units for `quantity_decimal`. One of `charging_minute`, `imperial_gallon`, `kilogram`, `kilowatt_hour`, `liter`, `pound`, `us_gallon`, or `other`.", "maxLength": 5000, "type": "string" }, "unit_cost_decimal": { "description": "The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places.", "format": "decimal", "type": "string" } }, "required": [ "industry_product_code", "quantity_decimal", "type", "unit", "unit_cost_decimal" ], "title": "IssuingTransactionFuelData", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "industry_product_code", "quantity_decimal", "type", "unit", "unit_cost_decimal" ] }, "issuing_transaction_lodging_data": { "description": "", "properties": { "check_in_at": { "description": "The time of checking into the lodging.", "nullable": true, "type": "integer" }, "nights": { "description": "The number of nights stayed at the lodging.", "nullable": true, "type": "integer" } }, "required": [ "check_in_at", "nights" ], "title": "IssuingTransactionLodgingData", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "check_in_at", "nights" ] }, "issuing_transaction_network_data": { "description": "", "properties": { "authorization_code": { "description": "A code created by Stripe which is shared with the merchant to validate the authorization. This field will be populated if the authorization message was approved. The code typically starts with the letter \"S\", followed by a six-digit number. For example, \"S498162\". Please note that the code is not guaranteed to be unique across authorizations.", "maxLength": 5000, "nullable": true, "type": "string" }, "processing_date": { "description": "The date the transaction was processed by the card network. This can be different from the date the seller recorded the transaction depending on when the acquirer submits the transaction to the network.", "maxLength": 5000, "nullable": true, "type": "string" }, "transaction_id": { "description": "Unique identifier for the authorization assigned by the card network used to match subsequent messages, disputes, and transactions.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "authorization_code", "processing_date", "transaction_id" ], "title": "IssuingTransactionNetworkData", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "authorization_code", "processing_date", "transaction_id" ] }, "issuing_transaction_purchase_details": { "description": "", "properties": { "fleet": { "anyOf": [ { "$ref": "#/components/schemas/issuing_transaction_fleet_data" } ], "description": "Fleet-specific information for transactions using Fleet cards.", "nullable": true }, "flight": { "anyOf": [ { "$ref": "#/components/schemas/issuing_transaction_flight_data" } ], "description": "Information about the flight that was purchased with this transaction.", "nullable": true }, "fuel": { "anyOf": [ { "$ref": "#/components/schemas/issuing_transaction_fuel_data" } ], "description": "Information about fuel that was purchased with this transaction.", "nullable": true }, "lodging": { "anyOf": [ { "$ref": "#/components/schemas/issuing_transaction_lodging_data" } ], "description": "Information about lodging that was purchased with this transaction.", "nullable": true }, "receipt": { "description": "The line items in the purchase.", "items": { "$ref": "#/components/schemas/issuing_transaction_receipt_data" }, "nullable": true, "type": "array" }, "reference": { "description": "A merchant-specific order number.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "fleet", "flight", "fuel", "lodging", "receipt", "reference" ], "title": "IssuingTransactionPurchaseDetails", "type": "object", "x-expandableFields": [ "fleet", "flight", "fuel", "lodging", "receipt" ], "x-stripeMostCommon": [ "fleet", "flight", "fuel", "lodging", "receipt", "reference" ] }, "issuing_transaction_receipt_data": { "description": "", "properties": { "description": { "description": "The description of the item. The maximum length of this field is 26 characters.", "maxLength": 5000, "nullable": true, "type": "string" }, "quantity": { "description": "The quantity of the item.", "nullable": true, "type": "number" }, "total": { "description": "The total for this line item in cents.", "nullable": true, "type": "integer" }, "unit_cost": { "description": "The unit cost of the item in cents.", "nullable": true, "type": "integer" } }, "required": [ "description", "quantity", "total", "unit_cost" ], "title": "IssuingTransactionReceiptData", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "description", "quantity", "total", "unit_cost" ] }, "issuing_transaction_treasury": { "description": "", "properties": { "received_credit": { "description": "The Treasury [ReceivedCredit](https://stripe.com/docs/api/treasury/received_credits) representing this Issuing transaction if it is a refund", "maxLength": 5000, "nullable": true, "type": "string" }, "received_debit": { "description": "The Treasury [ReceivedDebit](https://stripe.com/docs/api/treasury/received_debits) representing this Issuing transaction if it is a capture", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "received_credit", "received_debit" ], "title": "IssuingTransactionTreasury", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "received_credit", "received_debit" ] }, "item": { "description": "A line item.", "properties": { "adjustable_quantity": { "anyOf": [ { "$ref": "#/components/schemas/line_items_adjustable_quantity" } ], "nullable": true }, "amount_discount": { "description": "Total discount amount applied. If no discounts were applied, defaults to 0.", "type": "integer" }, "amount_subtotal": { "description": "Total before any discounts or taxes are applied.", "type": "integer" }, "amount_tax": { "description": "Total tax amount applied. If no tax was applied, defaults to 0.", "type": "integer" }, "amount_total": { "description": "Total after discounts and taxes.", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users. Defaults to product name.", "maxLength": 5000, "nullable": true, "type": "string" }, "discounts": { "description": "The discounts applied to the line item.", "items": { "$ref": "#/components/schemas/line_items_discount_amount" }, "type": "array" }, "display": { "$ref": "#/components/schemas/line_items_display" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "nullable": true, "type": "object" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "item" ], "type": "string" }, "price": { "anyOf": [ { "$ref": "#/components/schemas/price" } ], "description": "The price used to generate the line item.", "nullable": true }, "product": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/product" }, { "$ref": "#/components/schemas/deleted_product" } ], "description": "The ID of the product for this line item.\n\nThis will always be the same as `price.product`.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/product" }, { "$ref": "#/components/schemas/deleted_product" } ] } }, "quantity": { "description": "The quantity of products being purchased.", "nullable": true, "type": "integer" }, "tax_calculation_reference": { "anyOf": [ { "$ref": "#/components/schemas/tax_product_integration_resource_tax_calculation_reference" } ], "description": "The tax calculation identifiers of the line item.", "nullable": true }, "taxes": { "description": "The taxes applied to the line item.", "items": { "$ref": "#/components/schemas/line_items_tax_amount" }, "type": "array" } }, "required": [ "amount_discount", "amount_subtotal", "amount_tax", "amount_total", "currency", "description", "id", "object", "price", "quantity" ], "title": "LineItem", "type": "object", "x-expandableFields": [ "adjustable_quantity", "discounts", "display", "price", "product", "tax_calculation_reference", "taxes" ], "x-resourceId": "item", "x-stripeMostCommon": [ "adjustable_quantity", "amount_discount", "amount_subtotal", "amount_tax", "amount_total", "currency", "description", "discounts", "display", "id", "metadata", "object", "price", "quantity", "tax_calculation_reference", "taxes" ], "x-stripeResource": { "class_name": "LineItem", "has_collection_class": true, "in_package": "" } }, "klarna_address": { "description": "", "properties": { "country": { "description": "The payer address country", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "country" ], "title": "klarna_address", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "country" ] }, "klarna_payer_details": { "description": "", "properties": { "address": { "anyOf": [ { "$ref": "#/components/schemas/klarna_address" } ], "description": "The payer's address", "nullable": true } }, "required": [ "address" ], "title": "klarna_payer_details", "type": "object", "x-expandableFields": [ "address" ], "x-stripeMostCommon": [ "address" ] }, "legal_entity_company": { "description": "", "properties": { "address": { "$ref": "#/components/schemas/address" }, "address_kana": { "anyOf": [ { "$ref": "#/components/schemas/legal_entity_japan_address" } ], "description": "The Kana variation of the company's primary address (Japan only).", "nullable": true }, "address_kanji": { "anyOf": [ { "$ref": "#/components/schemas/legal_entity_japan_address" } ], "description": "The Kanji variation of the company's primary address (Japan only).", "nullable": true }, "directors_provided": { "description": "Whether the company's directors have been provided. This Boolean will be `true` if you've manually indicated that all directors are provided via [the `directors_provided` parameter](https://stripe.com/docs/api/accounts/update#update_account-company-directors_provided).", "type": "boolean" }, "directorship_declaration": { "anyOf": [ { "$ref": "#/components/schemas/legal_entity_directorship_declaration" } ], "description": "This hash is used to attest that the director information provided to Stripe is both current and correct.", "nullable": true }, "executives_provided": { "description": "Whether the company's executives have been provided. This Boolean will be `true` if you've manually indicated that all executives are provided via [the `executives_provided` parameter](https://stripe.com/docs/api/accounts/update#update_account-company-executives_provided), or if Stripe determined that sufficient executives were provided.", "type": "boolean" }, "export_license_id": { "description": "The export license ID number of the company, also referred as Import Export Code (India only).", "maxLength": 5000, "type": "string" }, "export_purpose_code": { "description": "The purpose code to use for export transactions (India only).", "maxLength": 5000, "type": "string" }, "name": { "description": "The company's legal name. Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.", "maxLength": 5000, "nullable": true, "type": "string" }, "name_kana": { "description": "The Kana variation of the company's legal name (Japan only). Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.", "maxLength": 5000, "nullable": true, "type": "string" }, "name_kanji": { "description": "The Kanji variation of the company's legal name (Japan only). Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.", "maxLength": 5000, "nullable": true, "type": "string" }, "owners_provided": { "description": "Whether the company's owners have been provided. This Boolean will be `true` if you've manually indicated that all owners are provided via [the `owners_provided` parameter](https://stripe.com/docs/api/accounts/update#update_account-company-owners_provided), or if Stripe determined that sufficient owners were provided. Stripe determines ownership requirements using both the number of owners provided and their total percent ownership (calculated by adding the `percent_ownership` of each owner together).", "type": "boolean" }, "ownership_declaration": { "anyOf": [ { "$ref": "#/components/schemas/legal_entity_ubo_declaration" } ], "description": "This hash is used to attest that the beneficial owner information provided to Stripe is both current and correct.", "nullable": true }, "ownership_exemption_reason": { "description": "This value is used to determine if a business is exempt from providing ultimate beneficial owners. See [this support article](https://support.stripe.com/questions/exemption-from-providing-ownership-details) and [changelog](https://docs.stripe.com/changelog/acacia/2025-01-27/ownership-exemption-reason-accounts-api) for more details.", "enum": [ "qualified_entity_exceeds_ownership_threshold", "qualifies_as_financial_institution" ], "type": "string" }, "phone": { "description": "The company's phone number (used for verification).", "maxLength": 5000, "nullable": true, "type": "string" }, "registration_date": { "$ref": "#/components/schemas/legal_entity_registration_date" }, "structure": { "description": "The category identifying the legal structure of the company or legal entity. Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`. See [Business structure](https://stripe.com/docs/connect/identity-verification#business-structure) for more details.", "enum": [ "free_zone_establishment", "free_zone_llc", "government_instrumentality", "governmental_unit", "incorporated_non_profit", "incorporated_partnership", "limited_liability_partnership", "llc", "multi_member_llc", "private_company", "private_corporation", "private_partnership", "public_company", "public_corporation", "public_partnership", "registered_charity", "single_member_llc", "sole_establishment", "sole_proprietorship", "tax_exempt_government_instrumentality", "unincorporated_association", "unincorporated_non_profit", "unincorporated_partnership" ], "type": "string", "x-stripeBypassValidation": true }, "tax_id_provided": { "description": "Whether the company's business ID number was provided.", "type": "boolean" }, "tax_id_registrar": { "description": "The jurisdiction in which the `tax_id` is registered (Germany-based companies only).", "maxLength": 5000, "type": "string" }, "vat_id_provided": { "description": "Whether the company's business VAT number was provided.", "type": "boolean" }, "verification": { "anyOf": [ { "$ref": "#/components/schemas/legal_entity_company_verification" } ], "description": "Information on the verification state of the company.", "nullable": true } }, "title": "LegalEntityCompany", "type": "object", "x-expandableFields": [ "address", "address_kana", "address_kanji", "directorship_declaration", "ownership_declaration", "registration_date", "verification" ], "x-stripeMostCommon": [ "address", "address_kana", "address_kanji", "directors_provided", "directorship_declaration", "executives_provided", "export_license_id", "export_purpose_code", "name", "name_kana", "name_kanji", "owners_provided", "ownership_declaration", "ownership_exemption_reason", "phone", "registration_date", "structure", "tax_id_provided", "tax_id_registrar", "vat_id_provided", "verification" ] }, "legal_entity_company_verification": { "description": "", "properties": { "document": { "$ref": "#/components/schemas/legal_entity_company_verification_document" } }, "required": [ "document" ], "title": "LegalEntityCompanyVerification", "type": "object", "x-expandableFields": [ "document" ], "x-stripeMostCommon": [ "document" ] }, "legal_entity_company_verification_document": { "description": "", "properties": { "back": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/file" } ], "description": "The back of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `additional_verification`. Note that `additional_verification` files are [not downloadable](/file-upload#uploading-a-file).", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/file" } ] } }, "details": { "description": "A user-displayable string describing the verification state of this document.", "maxLength": 5000, "nullable": true, "type": "string" }, "details_code": { "description": "One of `document_corrupt`, `document_expired`, `document_failed_copy`, `document_failed_greyscale`, `document_failed_other`, `document_failed_test_mode`, `document_fraudulent`, `document_incomplete`, `document_invalid`, `document_manipulated`, `document_not_readable`, `document_not_uploaded`, `document_type_not_supported`, or `document_too_large`. A machine-readable code specifying the verification state for this document.", "maxLength": 5000, "nullable": true, "type": "string" }, "front": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/file" } ], "description": "The front of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `additional_verification`. Note that `additional_verification` files are [not downloadable](/file-upload#uploading-a-file).", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/file" } ] } } }, "required": [ "back", "details", "details_code", "front" ], "title": "LegalEntityCompanyVerificationDocument", "type": "object", "x-expandableFields": [ "back", "front" ], "x-stripeMostCommon": [ "back", "details", "details_code", "front" ] }, "legal_entity_directorship_declaration": { "description": "", "properties": { "date": { "description": "The Unix timestamp marking when the directorship declaration attestation was made.", "format": "unix-time", "nullable": true, "type": "integer" }, "ip": { "description": "The IP address from which the directorship declaration attestation was made.", "maxLength": 5000, "nullable": true, "type": "string" }, "user_agent": { "description": "The user-agent string from the browser where the directorship declaration attestation was made.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "date", "ip", "user_agent" ], "title": "LegalEntityDirectorshipDeclaration", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "date", "ip", "user_agent" ] }, "legal_entity_dob": { "description": "", "properties": { "day": { "description": "The day of birth, between 1 and 31.", "nullable": true, "type": "integer" }, "month": { "description": "The month of birth, between 1 and 12.", "nullable": true, "type": "integer" }, "year": { "description": "The four-digit year of birth.", "nullable": true, "type": "integer" } }, "required": [ "day", "month", "year" ], "title": "LegalEntityDOB", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "day", "month", "year" ] }, "legal_entity_japan_address": { "description": "", "properties": { "city": { "description": "City/Ward.", "maxLength": 5000, "nullable": true, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "nullable": true, "type": "string" }, "line1": { "description": "Block/Building number.", "maxLength": 5000, "nullable": true, "type": "string" }, "line2": { "description": "Building details.", "maxLength": 5000, "nullable": true, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "nullable": true, "type": "string" }, "state": { "description": "Prefecture.", "maxLength": 5000, "nullable": true, "type": "string" }, "town": { "description": "Town/cho-me.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "city", "country", "line1", "line2", "postal_code", "state", "town" ], "title": "LegalEntityJapanAddress", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state", "town" ] }, "legal_entity_person_verification": { "description": "", "properties": { "additional_document": { "anyOf": [ { "$ref": "#/components/schemas/legal_entity_person_verification_document" } ], "description": "A document showing address, either a passport, local ID card, or utility bill from a well-known utility company.", "nullable": true }, "details": { "description": "A user-displayable string describing the verification state for the person. For example, this may say \"Provided identity information could not be verified\".", "maxLength": 5000, "nullable": true, "type": "string" }, "details_code": { "description": "One of `document_address_mismatch`, `document_dob_mismatch`, `document_duplicate_type`, `document_id_number_mismatch`, `document_name_mismatch`, `document_nationality_mismatch`, `failed_keyed_identity`, or `failed_other`. A machine-readable code specifying the verification state for the person.", "maxLength": 5000, "nullable": true, "type": "string" }, "document": { "$ref": "#/components/schemas/legal_entity_person_verification_document" }, "status": { "description": "The state of verification for the person. Possible values are `unverified`, `pending`, or `verified`. Please refer [guide](https://stripe.com/docs/connect/handling-api-verification) to handle verification updates.", "maxLength": 5000, "type": "string" } }, "required": [ "status" ], "title": "LegalEntityPersonVerification", "type": "object", "x-expandableFields": [ "additional_document", "document" ], "x-stripeMostCommon": [ "additional_document", "details", "details_code", "document", "status" ] }, "legal_entity_person_verification_document": { "description": "", "properties": { "back": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/file" } ], "description": "The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/file" } ] } }, "details": { "description": "A user-displayable string describing the verification state of this document. For example, if a document is uploaded and the picture is too fuzzy, this may say \"Identity document is too unclear to read\".", "maxLength": 5000, "nullable": true, "type": "string" }, "details_code": { "description": "One of `document_corrupt`, `document_country_not_supported`, `document_expired`, `document_failed_copy`, `document_failed_other`, `document_failed_test_mode`, `document_fraudulent`, `document_failed_greyscale`, `document_incomplete`, `document_invalid`, `document_manipulated`, `document_missing_back`, `document_missing_front`, `document_not_readable`, `document_not_uploaded`, `document_photo_mismatch`, `document_too_large`, or `document_type_not_supported`. A machine-readable code specifying the verification state for this document.", "maxLength": 5000, "nullable": true, "type": "string" }, "front": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/file" } ], "description": "The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/file" } ] } } }, "required": [ "back", "details", "details_code", "front" ], "title": "LegalEntityPersonVerificationDocument", "type": "object", "x-expandableFields": [ "back", "front" ], "x-stripeMostCommon": [ "back", "details", "details_code", "front" ] }, "legal_entity_registration_date": { "description": "", "properties": { "day": { "description": "The day of registration, between 1 and 31.", "nullable": true, "type": "integer" }, "month": { "description": "The month of registration, between 1 and 12.", "nullable": true, "type": "integer" }, "year": { "description": "The four-digit year of registration.", "nullable": true, "type": "integer" } }, "required": [ "day", "month", "year" ], "title": "LegalEntityRegistrationDate", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "day", "month", "year" ] }, "legal_entity_ubo_declaration": { "description": "", "properties": { "date": { "description": "The Unix timestamp marking when the beneficial owner attestation was made.", "format": "unix-time", "nullable": true, "type": "integer" }, "ip": { "description": "The IP address from which the beneficial owner attestation was made.", "maxLength": 5000, "nullable": true, "type": "string" }, "user_agent": { "description": "The user-agent string from the browser where the beneficial owner attestation was made.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "date", "ip", "user_agent" ], "title": "LegalEntityUBODeclaration", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "date", "ip", "user_agent" ] }, "level3": { "description": "", "properties": { "customer_reference": { "maxLength": 5000, "type": "string" }, "line_items": { "items": { "$ref": "#/components/schemas/level3_line_items" }, "type": "array" }, "merchant_reference": { "maxLength": 5000, "type": "string" }, "shipping_address_zip": { "maxLength": 5000, "type": "string" }, "shipping_amount": { "type": "integer" }, "shipping_from_zip": { "maxLength": 5000, "type": "string" } }, "required": [ "line_items", "merchant_reference" ], "title": "Level3", "type": "object", "x-expandableFields": [ "line_items" ], "x-stripeMostCommon": [ "customer_reference", "line_items", "merchant_reference", "shipping_address_zip", "shipping_amount", "shipping_from_zip" ] }, "level3_line_items": { "description": "", "properties": { "discount_amount": { "nullable": true, "type": "integer" }, "product_code": { "maxLength": 5000, "type": "string" }, "product_description": { "maxLength": 5000, "type": "string" }, "quantity": { "nullable": true, "type": "integer" }, "tax_amount": { "nullable": true, "type": "integer" }, "unit_cost": { "nullable": true, "type": "integer" } }, "required": [ "discount_amount", "product_code", "product_description", "quantity", "tax_amount", "unit_cost" ], "title": "Level3LineItems", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "discount_amount", "product_code", "product_description", "quantity", "tax_amount", "unit_cost" ] }, "line_item": { "description": "Invoice Line Items represent the individual lines within an [invoice](https://stripe.com/docs/api/invoices) and only exist within the context of an invoice.\n\nEach line item is backed by either an [invoice item](https://stripe.com/docs/api/invoiceitems) or a [subscription item](https://stripe.com/docs/api/subscription_items).", "properties": { "amount": { "description": "The amount, in cents (or local equivalent).", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users.", "maxLength": 5000, "nullable": true, "type": "string" }, "discount_amounts": { "description": "The amount of discount calculated per discount for this line item.", "items": { "$ref": "#/components/schemas/discounts_resource_discount_amount" }, "nullable": true, "type": "array" }, "discountable": { "description": "If true, discounts will apply to this line item. Always false for prorations.", "type": "boolean" }, "discounts": { "description": "The discounts applied to the invoice line item. Line item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount.", "items": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/discount" } ], "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/discount" } ] } }, "type": "array" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "invoice": { "description": "The ID of the invoice that contains this line item.", "maxLength": 5000, "nullable": true, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "margin_amounts": { "description": "The amount of margin calculated per margin for this line item.", "items": { "$ref": "#/components/schemas/margins_resource_margin_amount" }, "nullable": true, "type": "array" }, "margins": { "description": "The margins applied to the line item. When set, the `default_margins` on the invoice do not apply to the line item. Use `expand[]=margins` to expand each margin.", "items": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/margin" } ], "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/margin" } ] } }, "nullable": true, "type": "array" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Note that for line items with `type=subscription`, `metadata` reflects the current metadata from the subscription associated with the line item, unless the invoice line was directly updated with different metadata after creation.", "type": "object" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "line_item" ], "type": "string" }, "parent": { "anyOf": [ { "$ref": "#/components/schemas/billing_bill_resource_invoicing_lines_parents_invoice_line_item_parent" } ], "description": "The parent that generated this line item.", "nullable": true }, "period": { "$ref": "#/components/schemas/invoice_line_item_period" }, "pretax_credit_amounts": { "description": "Contains pretax credit amounts (ex: discount, credit grants, etc) that apply to this line item.", "items": { "$ref": "#/components/schemas/invoices_resource_pretax_credit_amount" }, "nullable": true, "type": "array" }, "pricing": { "anyOf": [ { "$ref": "#/components/schemas/billing_bill_resource_invoicing_pricing_pricing" } ], "description": "The pricing information of the line item.", "nullable": true }, "quantity": { "description": "The quantity of the subscription, if the line item is a subscription or a proration.", "nullable": true, "type": "integer" }, "subscription": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/subscription" } ], "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/subscription" } ] } }, "tax_calculation_reference": { "anyOf": [ { "$ref": "#/components/schemas/tax_product_integration_resource_tax_calculation_reference" } ], "description": "The tax calculation identifiers of the line item.", "nullable": true }, "taxes": { "description": "The tax information of the line item.", "items": { "$ref": "#/components/schemas/billing_bill_resource_invoicing_taxes_tax" }, "nullable": true, "type": "array" } }, "required": [ "amount", "currency", "description", "discount_amounts", "discountable", "discounts", "id", "invoice", "livemode", "metadata", "object", "parent", "period", "pretax_credit_amounts", "pricing", "quantity", "subscription", "taxes" ], "title": "InvoiceLineItem", "type": "object", "x-expandableFields": [ "discount_amounts", "discounts", "margin_amounts", "margins", "parent", "period", "pretax_credit_amounts", "pricing", "subscription", "tax_calculation_reference", "taxes" ], "x-resourceId": "line_item", "x-stripeMostCommon": [ "amount", "currency", "description", "id", "invoice", "metadata", "parent", "period", "pricing", "quantity" ], "x-stripeOperations": [ { "method_name": "list", "method_on": "collection", "method_type": "list", "operation": "get", "path": "/v1/invoices/{invoice}/lines" }, { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/invoices/{invoice}/lines" }, { "method_name": "update", "method_on": "service", "method_type": "update", "operation": "post", "path": "/v1/invoices/{invoice}/lines/{line_item_id}" } ], "x-stripeResource": { "class_name": "InvoiceLineItem", "has_collection_class": true, "in_package": "" } }, "line_item_paypal": { "description": "", "properties": { "category": { "description": "Type of the line item.", "enum": [ "digital_goods", "donation", "physical_goods" ], "type": "string" }, "description": { "description": "Description of the line item.", "maxLength": 5000, "type": "string" }, "name": { "description": "Descriptive name of the line item.", "maxLength": 5000, "type": "string" }, "quantity": { "description": "Quantity of the line item. Cannot be a negative number.", "type": "integer" }, "sku": { "description": "Client facing stock keeping unit, article number or similar.", "maxLength": 5000, "type": "string" }, "sold_by": { "description": "The Stripe account ID of the connected account that sells the item. This is only needed when using [Separate Charges and Transfers](https://docs.stripe.com/connect/separate-charges-and-transfers).", "maxLength": 5000, "type": "string" }, "tax": { "$ref": "#/components/schemas/payment_flows_private_payment_methods_paypal_line_item_resource_tax" }, "unit_amount": { "description": "Price for a single unit of the line item in minor units. Cannot be a negative number.", "type": "integer" } }, "required": [ "name", "quantity", "unit_amount" ], "title": "line_item_paypal", "type": "object", "x-expandableFields": [ "tax" ], "x-stripeMostCommon": [ "category", "description", "name", "quantity", "sku", "sold_by", "tax", "unit_amount" ] }, "line_items_adjustable_quantity": { "description": "", "properties": { "enabled": { "type": "boolean" }, "maximum": { "nullable": true, "type": "integer" }, "minimum": { "nullable": true, "type": "integer" } }, "required": [ "enabled", "maximum", "minimum" ], "title": "LineItemsAdjustableQuantity", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "enabled", "maximum", "minimum" ] }, "line_items_discount_amount": { "description": "", "properties": { "amount": { "description": "The amount discounted.", "type": "integer" }, "discount": { "$ref": "#/components/schemas/discount" } }, "required": [ "amount", "discount" ], "title": "LineItemsDiscountAmount", "type": "object", "x-expandableFields": [ "discount" ], "x-stripeMostCommon": [ "amount", "discount" ] }, "line_items_display": { "description": "", "properties": { "description": { "maxLength": 5000, "nullable": true, "type": "string" }, "images": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "name": { "maxLength": 5000, "type": "string" } }, "required": [ "description", "images", "name" ], "title": "LineItemsDisplay", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "description", "images", "name" ] }, "line_items_tax_amount": { "description": "", "properties": { "amount": { "description": "Amount of tax applied for this rate.", "type": "integer" }, "rate": { "$ref": "#/components/schemas/tax_rate" }, "taxability_reason": { "description": "The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.", "enum": [ "customer_exempt", "not_collecting", "not_subject_to_tax", "not_supported", "portion_product_exempt", "portion_reduced_rated", "portion_standard_rated", "product_exempt", "product_exempt_holiday", "proportionally_rated", "reduced_rated", "reverse_charge", "standard_rated", "taxable_basis_reduced", "zero_rated" ], "nullable": true, "type": "string", "x-stripeBypassValidation": true }, "taxable_amount": { "description": "The amount on which tax is calculated, in cents (or local equivalent).", "nullable": true, "type": "integer" } }, "required": [ "amount", "rate", "taxability_reason", "taxable_amount" ], "title": "LineItemsTaxAmount", "type": "object", "x-expandableFields": [ "rate" ], "x-stripeMostCommon": [ "amount", "rate", "taxability_reason", "taxable_amount" ] }, "linked_account_options_common": { "description": "", "properties": { "filters": { "$ref": "#/components/schemas/payment_flows_private_payment_methods_financial_connections_common_linked_account_options_filters" }, "manual_entry": { "$ref": "#/components/schemas/payment_flows_private_payment_methods_financial_connections_common_linked_account_options_manual_entry" }, "permissions": { "description": "The list of permissions to request. The `payment_method` permission must be included.", "items": { "enum": [ "balances", "ownership", "payment_method", "transactions" ], "type": "string" }, "type": "array" }, "prefetch": { "description": "Data features requested to be retrieved upon account creation.", "items": { "enum": [ "balances", "inferred_balances", "ownership", "transactions" ], "type": "string", "x-stripeBypassValidation": true }, "nullable": true, "type": "array" }, "return_url": { "description": "For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.", "maxLength": 5000, "type": "string" } }, "required": [ "prefetch" ], "title": "linked_account_options_common", "type": "object", "x-expandableFields": [ "filters", "manual_entry" ], "x-stripeMostCommon": [ "filters", "manual_entry", "permissions", "prefetch", "return_url" ] }, "login_link": { "description": "Login Links are single-use URLs that takes an Express account to the login page for their Stripe dashboard.\nA Login Link differs from an [Account Link](https://stripe.com/docs/api/account_links) in that it takes the user directly to their [Express dashboard for the specified account](https://stripe.com/docs/connect/integrate-express-dashboard#create-login-link)", "properties": { "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "login_link" ], "type": "string" }, "url": { "description": "The URL for the login link.", "maxLength": 5000, "type": "string" } }, "required": [ "created", "object", "url" ], "title": "LoginLink", "type": "object", "x-expandableFields": [], "x-resourceId": "login_link", "x-stripeMostCommon": [ "url" ], "x-stripeOperations": [ { "method_name": "create", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/accounts/{account}/login_links" } ], "x-stripeResource": { "class_name": "LoginLink", "in_package": "" } }, "mandate": { "description": "A Mandate is a record of the permission that your customer gives you to debit their payment method.", "properties": { "customer_acceptance": { "$ref": "#/components/schemas/customer_acceptance" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "multi_use": { "$ref": "#/components/schemas/mandate_multi_use" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "mandate" ], "type": "string" }, "on_behalf_of": { "description": "The account (if any) that the mandate is intended for.", "maxLength": 5000, "type": "string" }, "payment_method": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/payment_method" } ], "description": "ID of the payment method associated with this mandate.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/payment_method" } ] } }, "payment_method_details": { "$ref": "#/components/schemas/mandate_payment_method_details" }, "single_use": { "$ref": "#/components/schemas/mandate_single_use" }, "status": { "description": "The mandate status indicates whether or not you can use it to initiate a payment.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "type": { "description": "The type of the mandate.", "enum": [ "multi_use", "single_use" ], "type": "string" } }, "required": [ "customer_acceptance", "id", "livemode", "object", "payment_method", "payment_method_details", "status", "type" ], "title": "Mandate", "type": "object", "x-expandableFields": [ "customer_acceptance", "multi_use", "payment_method", "payment_method_details", "single_use" ], "x-resourceId": "mandate", "x-stripeMostCommon": [ "customer_acceptance", "id", "payment_method", "payment_method_details", "status", "type" ], "x-stripeOperations": [ { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/mandates" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/mandates/{mandate}" } ], "x-stripeResource": { "class_name": "Mandate", "has_collection_class": true, "in_package": "" } }, "mandate.updated": { "description": "Occurs whenever a Mandate is updated.", "properties": { "object": { "$ref": "#/components/schemas/mandate" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "mandate.updated" } }, "mandate_acss_debit": { "description": "", "properties": { "default_for": { "description": "List of Stripe products where this mandate can be selected automatically.", "items": { "enum": [ "invoice", "subscription" ], "type": "string" }, "type": "array" }, "interval_description": { "description": "Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'.", "maxLength": 5000, "nullable": true, "type": "string" }, "payment_schedule": { "description": "Payment schedule for the mandate.", "enum": [ "combined", "interval", "sporadic" ], "type": "string" }, "transaction_type": { "description": "Transaction type of the mandate.", "enum": [ "business", "personal" ], "type": "string" } }, "required": [ "interval_description", "payment_schedule", "transaction_type" ], "title": "mandate_acss_debit", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "default_for", "interval_description", "payment_schedule", "transaction_type" ], "x-stripeResource": { "class_name": "AcssDebit", "in_package": "" } }, "mandate_amazon_pay": { "description": "", "properties": {}, "title": "mandate_amazon_pay", "type": "object", "x-expandableFields": [], "x-stripeResource": { "class_name": "AmazonPay", "in_package": "" } }, "mandate_au_becs_debit": { "description": "", "properties": { "url": { "description": "The URL of the mandate. This URL generally contains sensitive information about the customer and should be shared with them exclusively.", "maxLength": 5000, "type": "string" } }, "required": [ "url" ], "title": "mandate_au_becs_debit", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "url" ] }, "mandate_bacs_debit": { "description": "", "properties": { "network_status": { "description": "The status of the mandate on the Bacs network. Can be one of `pending`, `revoked`, `refused`, or `accepted`.", "enum": [ "accepted", "pending", "refused", "revoked" ], "type": "string" }, "reference": { "description": "The unique reference identifying the mandate on the Bacs network.", "maxLength": 5000, "type": "string" }, "revocation_reason": { "description": "When the mandate is revoked on the Bacs network this field displays the reason for the revocation.", "enum": [ "account_closed", "bank_account_restricted", "bank_ownership_changed", "could_not_process", "debit_not_authorized" ], "nullable": true, "type": "string" }, "url": { "description": "The URL that will contain the mandate that the customer has signed.", "maxLength": 5000, "type": "string" } }, "required": [ "network_status", "reference", "revocation_reason", "url" ], "title": "mandate_bacs_debit", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "network_status", "reference", "revocation_reason", "url" ] }, "mandate_cashapp": { "description": "", "properties": {}, "title": "mandate_cashapp", "type": "object", "x-expandableFields": [], "x-stripeResource": { "class_name": "Cashapp", "in_package": "" } }, "mandate_kakao_pay": { "description": "", "properties": {}, "title": "mandate_kakao_pay", "type": "object", "x-expandableFields": [], "x-stripeResource": { "class_name": "KakaoPay", "in_package": "" } }, "mandate_klarna": { "description": "", "properties": {}, "title": "mandate_klarna", "type": "object", "x-expandableFields": [] }, "mandate_kr_card": { "description": "", "properties": {}, "title": "mandate_kr_card", "type": "object", "x-expandableFields": [], "x-stripeResource": { "class_name": "KrCard", "in_package": "" } }, "mandate_link": { "description": "", "properties": {}, "title": "mandate_link", "type": "object", "x-expandableFields": [] }, "mandate_multi_use": { "description": "", "properties": { "amount": { "description": "The amount of the payment on a multi use mandate.", "type": "integer" }, "currency": { "description": "The currency of the payment on a multi use mandate.", "format": "currency", "type": "string" } }, "title": "mandate_multi_use", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "amount", "currency" ] }, "mandate_naver_pay": { "description": "", "properties": {}, "title": "mandate_naver_pay", "type": "object", "x-expandableFields": [] }, "mandate_nz_bank_account": { "description": "", "properties": {}, "title": "mandate_nz_bank_account", "type": "object", "x-expandableFields": [], "x-stripeResource": { "class_name": "NzBankAccount", "in_package": "" } }, "mandate_options_payto": { "description": "", "properties": { "amount": { "description": "Amount that will be collected. It is required when `amount_type` is `fixed`.", "nullable": true, "type": "integer" }, "amount_type": { "description": "The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively.", "enum": [ "fixed", "maximum" ], "nullable": true, "type": "string" }, "end_date": { "description": "Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.", "maxLength": 5000, "nullable": true, "type": "string" }, "payment_schedule": { "description": "The periodicity at which payments will be collected.", "enum": [ "adhoc", "annual", "daily", "fortnightly", "monthly", "quarterly", "semi_annual", "weekly" ], "nullable": true, "type": "string" }, "payments_per_period": { "description": "The number of payments that will be made during a payment period. Defaults to 1 except for when `payment_schedule` is `adhoc`. In that case, it defaults to no limit.", "nullable": true, "type": "integer" }, "purpose": { "description": "The purpose for which payments are made. Defaults to retail.", "enum": [ "dependant_support", "government", "loan", "mortgage", "other", "pension", "personal", "retail", "salary", "tax", "utility" ], "nullable": true, "type": "string" }, "start_date": { "description": "Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "amount", "amount_type", "end_date", "payment_schedule", "payments_per_period", "purpose", "start_date" ], "title": "mandate_options_payto", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "amount", "amount_type", "end_date", "payment_schedule", "payments_per_period", "purpose", "start_date" ], "x-stripeResource": { "class_name": "Payto", "in_package": "" } }, "mandate_payment_method_details": { "description": "", "properties": { "acss_debit": { "$ref": "#/components/schemas/mandate_acss_debit" }, "amazon_pay": { "$ref": "#/components/schemas/mandate_amazon_pay" }, "au_becs_debit": { "$ref": "#/components/schemas/mandate_au_becs_debit" }, "bacs_debit": { "$ref": "#/components/schemas/mandate_bacs_debit" }, "card": { "$ref": "#/components/schemas/card_mandate_payment_method_details" }, "cashapp": { "$ref": "#/components/schemas/mandate_cashapp" }, "kakao_pay": { "$ref": "#/components/schemas/mandate_kakao_pay" }, "klarna": { "$ref": "#/components/schemas/mandate_klarna" }, "kr_card": { "$ref": "#/components/schemas/mandate_kr_card" }, "link": { "$ref": "#/components/schemas/mandate_link" }, "naver_pay": { "$ref": "#/components/schemas/mandate_naver_pay" }, "nz_bank_account": { "$ref": "#/components/schemas/mandate_nz_bank_account" }, "paypal": { "$ref": "#/components/schemas/mandate_paypal" }, "payto": { "$ref": "#/components/schemas/mandate_payto" }, "pix": { "$ref": "#/components/schemas/mandate_pix" }, "revolut_pay": { "$ref": "#/components/schemas/mandate_revolut_pay" }, "sepa_debit": { "$ref": "#/components/schemas/mandate_sepa_debit" }, "type": { "description": "This mandate corresponds with a specific payment method type. The `payment_method_details` includes an additional hash with the same name and contains mandate information that's specific to that payment method.", "maxLength": 5000, "type": "string" }, "us_bank_account": { "$ref": "#/components/schemas/mandate_us_bank_account" } }, "required": [ "type" ], "title": "mandate_payment_method_details", "type": "object", "x-expandableFields": [ "acss_debit", "amazon_pay", "au_becs_debit", "bacs_debit", "card", "cashapp", "kakao_pay", "klarna", "kr_card", "link", "naver_pay", "nz_bank_account", "paypal", "payto", "pix", "revolut_pay", "sepa_debit", "us_bank_account" ], "x-stripeMostCommon": [ "acss_debit", "amazon_pay", "au_becs_debit", "bacs_debit", "card", "cashapp", "kakao_pay", "klarna", "kr_card", "link", "naver_pay", "nz_bank_account", "paypal", "payto", "pix", "revolut_pay", "sepa_debit", "type", "us_bank_account" ] }, "mandate_paypal": { "description": "", "properties": { "billing_agreement_id": { "description": "The PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer.", "maxLength": 5000, "nullable": true, "type": "string" }, "fingerprint": { "description": "Uniquely identifies this particular PayPal account. You can use this attribute to check whether two PayPal accounts are the same.", "maxLength": 5000, "nullable": true, "type": "string" }, "payer_id": { "description": "PayPal account PayerID. This identifier uniquely identifies the PayPal customer.", "maxLength": 5000, "nullable": true, "type": "string" }, "verified_email": { "description": "Owner's verified email. Values are verified or provided by PayPal directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "billing_agreement_id", "payer_id" ], "title": "mandate_paypal", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "billing_agreement_id", "fingerprint", "payer_id", "verified_email" ] }, "mandate_payto": { "description": "", "properties": { "amount": { "description": "Amount that will be collected. It is required when `amount_type` is `fixed`.", "nullable": true, "type": "integer" }, "amount_type": { "description": "The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively.", "enum": [ "fixed", "maximum" ], "type": "string" }, "end_date": { "description": "Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.", "maxLength": 5000, "nullable": true, "type": "string" }, "payment_schedule": { "description": "The periodicity at which payments will be collected.", "enum": [ "adhoc", "annual", "daily", "fortnightly", "monthly", "quarterly", "semi_annual", "weekly" ], "type": "string" }, "payments_per_period": { "description": "The number of payments that will be made during a payment period. Defaults to 1 except for when `payment_schedule` is `adhoc`. In that case, it defaults to no limit.", "nullable": true, "type": "integer" }, "purpose": { "description": "The purpose for which payments are made. Defaults to retail.", "enum": [ "dependant_support", "government", "loan", "mortgage", "other", "pension", "personal", "retail", "salary", "tax", "utility" ], "nullable": true, "type": "string" }, "start_date": { "description": "Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "amount", "amount_type", "end_date", "payment_schedule", "payments_per_period", "purpose", "start_date" ], "title": "mandate_payto", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "amount", "amount_type", "end_date", "payment_schedule", "payments_per_period", "purpose", "start_date" ], "x-stripeResource": { "class_name": "Payto", "in_package": "" } }, "mandate_pix": { "description": "", "properties": { "amount_includes_iof": { "description": "Determines if the amount includes the IOF tax.", "enum": [ "always", "never" ], "type": "string" }, "amount_type": { "description": "Type of amount.", "enum": [ "fixed", "maximum" ], "type": "string" }, "end_date": { "description": "Date when the mandate expires and no further payments will be charged, in `YYYY-MM-DD`.", "maxLength": 5000, "type": "string" }, "payment_schedule": { "description": "Schedule at which the future payments will be charged.", "enum": [ "halfyearly", "monthly", "quarterly", "weekly", "yearly" ], "type": "string" }, "reference": { "description": "Subscription name displayed to buyers in their bank app.", "maxLength": 5000, "type": "string" }, "start_date": { "description": "Start date of the mandate, in `YYYY-MM-DD`.", "maxLength": 5000, "type": "string" } }, "title": "mandate_pix", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "amount_includes_iof", "amount_type", "end_date", "payment_schedule", "reference", "start_date" ] }, "mandate_revolut_pay": { "description": "", "properties": {}, "title": "mandate_revolut_pay", "type": "object", "x-expandableFields": [], "x-stripeResource": { "class_name": "RevolutPay", "in_package": "" } }, "mandate_sepa_debit": { "description": "", "properties": { "reference": { "description": "The unique reference of the mandate.", "maxLength": 5000, "type": "string" }, "url": { "description": "The URL of the mandate. This URL generally contains sensitive information about the customer and should be shared with them exclusively.", "maxLength": 5000, "type": "string" } }, "required": [ "reference", "url" ], "title": "mandate_sepa_debit", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "reference", "url" ], "x-stripeResource": { "class_name": "SepaDebit", "in_package": "" } }, "mandate_single_use": { "description": "", "properties": { "amount": { "description": "The amount of the payment on a single use mandate.", "type": "integer" }, "currency": { "description": "The currency of the payment on a single use mandate.", "format": "currency", "type": "string" } }, "required": [ "amount", "currency" ], "title": "mandate_single_use", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "amount", "currency" ] }, "mandate_us_bank_account": { "description": "", "properties": { "collection_method": { "description": "Mandate collection method", "enum": [ "paper" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "mandate_us_bank_account", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "collection_method" ], "x-stripeResource": { "class_name": "UsBankAccount", "in_package": "" } }, "margin": { "description": "A (partner) margin represents a specific discount distributed in partner reseller programs to business partners who\nresell products and services and earn a discount (margin) for doing so.", "properties": { "active": { "description": "Whether the margin can be applied to invoices, invoice items, or invoice line items. Defaults to `true`.", "type": "boolean" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "nullable": true, "type": "object" }, "name": { "description": "Name of the margin that's displayed on, for example, invoices.", "maxLength": 5000, "nullable": true, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "margin" ], "type": "string" }, "percent_off": { "description": "Percent that will be taken off the subtotal before tax (after all other discounts and promotions) of any invoice to which the margin is applied.", "type": "number" }, "updated": { "description": "Time at which the object was last updated. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" } }, "required": [ "active", "created", "id", "livemode", "metadata", "name", "object", "percent_off", "updated" ], "title": "Margin", "type": "object", "x-expandableFields": [], "x-resourceId": "margin", "x-stripeMostCommon": [ "active", "created", "id", "livemode", "metadata", "name", "object", "percent_off", "updated" ], "x-stripeOperations": [ { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/billing/margins" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/billing/margins/{margin}" }, { "method_name": "create", "method_on": "service", "method_type": "create", "operation": "post", "path": "/v1/billing/margins" }, { "method_name": "update", "method_on": "service", "method_type": "update", "operation": "post", "path": "/v1/billing/margins/{margin}" } ], "x-stripeResource": { "class_name": "Margin", "has_collection_class": true, "in_package": "" } }, "margins_resource_margin_amount": { "description": "", "properties": { "amount": { "description": "The amount, in cents (or local equivalent), of the reduction in line item amount.", "type": "integer" }, "margin": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/margin" } ], "description": "The margin that was applied to get this margin amount.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/margin" } ] } } }, "required": [ "amount", "margin" ], "title": "MarginsResourceMarginAmount", "type": "object", "x-expandableFields": [ "margin" ], "x-stripeMostCommon": [ "amount", "margin" ] }, "migrate_to": { "description": "", "properties": { "behavior": { "description": "The behavior controlling at what point in the subscription lifecycle to migrate the price", "enum": [ "at_cycle_end" ], "type": "string" }, "effective_after": { "description": "The unix timestamp after at which subscriptions will start to migrate to the new price.", "format": "unix-time", "type": "integer" }, "price": { "description": "The id of the price being migrated to", "maxLength": 5000, "type": "string" } }, "required": [ "behavior", "effective_after", "price" ], "title": "MigrateTo", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "behavior", "effective_after", "price" ] }, "networks": { "description": "", "properties": { "available": { "description": "All networks available for selection via [payment_method_options.card.network](/api/payment_intents/confirm#confirm_payment_intent-payment_method_options-card-network).", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "preferred": { "description": "The preferred network for co-branded cards. Can be `cartes_bancaires`, `mastercard`, `visa` or `invalid_preference` if requested network is not valid for the card.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "available", "preferred" ], "title": "networks", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "available", "preferred" ] }, "notification_event_automation_action": { "description": "", "properties": { "stripe_send_webhook_custom_event": { "$ref": "#/components/schemas/notification_event_automation_action_resource_send_webhook_custom_event" }, "trigger": { "description": "The trigger name of the automation that triggered this action.\n Please visit [Revenue and retention automations](https://docs.stripe.com/billing/automations#choose-a-trigger) for all possible trigger names.", "maxLength": 5000, "type": "string" }, "type": { "description": "The type of the `automation_action`.", "enum": [ "stripe_send_webhook_custom_event" ], "type": "string" } }, "required": [ "trigger", "type" ], "title": "NotificationEventAutomationAction", "type": "object", "x-expandableFields": [ "stripe_send_webhook_custom_event" ], "x-stripeMostCommon": [ "stripe_send_webhook_custom_event", "trigger", "type" ] }, "notification_event_automation_action_resource_send_webhook_custom_event": { "description": "", "properties": { "custom_data": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of key-value pairs attached to the action when creating an Automation.", "nullable": true, "type": "object" } }, "required": [ "custom_data" ], "title": "NotificationEventAutomationActionResourceSendWebhookCustomEvent", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "custom_data" ] }, "notification_event_data": { "description": "", "properties": { "object": { "description": "Object containing the API resource relevant to the event. For example, an `invoice.created` event will have a full [invoice object](https://stripe.com/docs/api#invoice_object) as the value of the object key.", "type": "object" }, "previous_attributes": { "description": "Object containing the names of the updated attributes and their values prior to the event (only included in events of type `*.updated`). If an array attribute has any updated elements, this object contains the entire array. In Stripe API versions 2017-04-06 or earlier, an updated array attribute in this object includes only the updated array elements.", "type": "object" } }, "required": [ "object" ], "title": "NotificationEventData", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "object", "previous_attributes" ], "x-stripeResource": { "class_name": "EventData", "in_package": "" } }, "notification_event_reason": { "description": "", "properties": { "automation_action": { "$ref": "#/components/schemas/notification_event_automation_action" }, "request": { "$ref": "#/components/schemas/notification_event_request" }, "type": { "description": "The type of the reason for the event.", "enum": [ "automation_action", "request" ], "type": "string" } }, "required": [ "type" ], "title": "NotificationEventReason", "type": "object", "x-expandableFields": [ "automation_action", "request" ], "x-stripeMostCommon": [ "automation_action", "request", "type" ] }, "notification_event_request": { "description": "", "properties": { "id": { "description": "ID of the API request that caused the event. If null, the event was automatic (e.g., Stripe's automatic subscription handling). Request logs are available in the [dashboard](https://dashboard.stripe.com/logs), but currently not in the API.", "maxLength": 5000, "nullable": true, "type": "string" }, "idempotency_key": { "description": "The idempotency key transmitted during the request, if any. *Note: This property is populated only for events on or after May 23, 2017*.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "id", "idempotency_key" ], "title": "NotificationEventRequest", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "id", "idempotency_key" ] }, "offline_acceptance": { "description": "", "properties": {}, "title": "offline_acceptance", "type": "object", "x-expandableFields": [] }, "online_acceptance": { "description": "", "properties": { "ip_address": { "description": "The customer accepts the mandate from this IP address.", "maxLength": 5000, "nullable": true, "type": "string" }, "user_agent": { "description": "The customer accepts the mandate using the user agent of the browser.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "ip_address", "user_agent" ], "title": "online_acceptance", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "ip_address", "user_agent" ] }, "order": { "description": "An Order describes a purchase being made by a customer, including the\nproducts & quantities being purchased, the order status, the payment information,\nand the billing/shipping details.\n\nRelated guide: [Orders overview](https://stripe.com/docs/orders)", "properties": { "amount_subtotal": { "description": "Order cost before any discounts or taxes are applied. A positive integer representing the subtotal of the order in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency).", "type": "integer" }, "amount_total": { "description": "Total order cost after discounts and taxes are applied. A positive integer representing the cost of the order in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). To submit an order, the total must be either 0 or at least $0.50 USD or [equivalent in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts).", "type": "integer" }, "application": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/application" } ], "description": "ID of the Connect application that created the Order, if any.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/application" } ] } }, "automatic_tax": { "$ref": "#/components/schemas/orders_v2_resource_automatic_tax" }, "billing_details": { "anyOf": [ { "$ref": "#/components/schemas/orders_v2_resource_billing_details" } ], "description": "Customer billing details associated with the order.", "nullable": true }, "client_secret": { "description": "The client secret of this Order. Used for client-side retrieval using a publishable key. \n\nThe client secret can be used to complete a payment for an Order from your frontend. It should not be stored, logged, embedded in URLs, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret. \n\nRefer to our docs for [creating and processing an order](https://stripe.com/docs/orders-beta/create-and-process) to learn about how client_secret should be handled.", "maxLength": 5000, "nullable": true, "type": "string" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "customer": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/customer" }, { "$ref": "#/components/schemas/deleted_customer" } ], "description": "The customer which this orders belongs to.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/customer" }, { "$ref": "#/components/schemas/deleted_customer" } ] } }, "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users.", "maxLength": 5000, "nullable": true, "type": "string" }, "discounts": { "description": "The discounts applied to the order. Use `expand[]=discounts` to expand each discount.", "items": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/discount" } ], "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/discount" } ] } }, "nullable": true, "type": "array" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "ip_address": { "description": "A recent IP address of the purchaser used for tax reporting and tax location inference.", "maxLength": 5000, "nullable": true, "type": "string" }, "line_items": { "description": "A list of line items the customer is ordering. Each line item includes information about the product, the quantity, and the resulting cost. There is a maximum of 100 line items.", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/item" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "OrdersV2ResourceLineItemList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "nullable": true, "type": "object" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "order" ], "type": "string" }, "payment": { "$ref": "#/components/schemas/orders_v2_resource_payment" }, "shipping_cost": { "anyOf": [ { "$ref": "#/components/schemas/orders_v2_resource_shipping_cost" } ], "description": "The details of the customer cost of shipping, including the customer chosen ShippingRate.", "nullable": true }, "shipping_details": { "anyOf": [ { "$ref": "#/components/schemas/orders_v2_resource_shipping_details" } ], "description": "Customer shipping information associated with the order.", "nullable": true }, "status": { "description": "The overall status of the order.", "enum": [ "canceled", "complete", "open", "processing", "submitted" ], "type": "string" }, "tax_details": { "$ref": "#/components/schemas/orders_v2_resource_tax_details" }, "total_details": { "$ref": "#/components/schemas/orders_v2_resource_total_details" } }, "required": [ "amount_subtotal", "amount_total", "application", "billing_details", "client_secret", "created", "currency", "customer", "description", "discounts", "id", "ip_address", "livemode", "metadata", "object", "payment", "shipping_cost", "shipping_details", "status", "total_details" ], "title": "OrdersV2ResourceOrder", "type": "object", "x-expandableFields": [ "application", "automatic_tax", "billing_details", "customer", "discounts", "line_items", "payment", "shipping_cost", "shipping_details", "tax_details", "total_details" ], "x-resourceId": "order", "x-stripeMostCommon": [ "amount_total", "client_secret", "currency", "customer", "description", "id", "line_items", "metadata", "payment", "status" ], "x-stripeOperations": [ { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/orders" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/orders/{id}" }, { "method_name": "list_line_items", "method_on": "service", "method_type": "custom", "operation": "get", "path": "/v1/orders/{id}/line_items" }, { "method_name": "create", "method_on": "service", "method_type": "create", "operation": "post", "path": "/v1/orders" }, { "method_name": "update", "method_on": "service", "method_type": "update", "operation": "post", "path": "/v1/orders/{id}" }, { "method_name": "cancel", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/orders/{id}/cancel" }, { "method_name": "reopen", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/orders/{id}/reopen" }, { "method_name": "submit", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/orders/{id}/submit" } ], "x-stripeResource": { "class_name": "Order", "has_collection_class": true, "in_package": "" } }, "orders_payment_method_options_afterpay_clearpay": { "description": "", "properties": { "capture_method": { "description": "Controls when the funds will be captured from the customer's account.", "enum": [ "automatic", "automatic_async", "manual" ], "type": "string" }, "reference": { "description": "Order identifier shown to the user in Afterpay's online portal. We recommend using a value that helps you answer any questions a customer might have about the payment. The identifier is limited to 128 characters and may contain only letters, digits, underscores, backslashes and dashes.", "maxLength": 5000, "nullable": true, "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with the payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the order's Customer, if present, after the order's PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.", "enum": [ "none" ], "type": "string" } }, "required": [ "reference" ], "title": "orders_payment_method_options_afterpay_clearpay", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "capture_method", "reference", "setup_future_usage" ] }, "orders_v2_resource_automatic_payment_methods": { "description": "", "properties": { "enabled": { "description": "Whether this Order has been opted into managing payment method types via the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods).", "type": "boolean" } }, "required": [ "enabled" ], "title": "OrdersV2ResourceAutomaticPaymentMethods", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "enabled" ] }, "orders_v2_resource_automatic_tax": { "description": "", "properties": { "enabled": { "description": "Whether Stripe automatically computes tax on this Order.", "type": "boolean" }, "status": { "description": "The status of the most recent automated tax calculation for this Order.", "enum": [ "complete", "failed", "requires_location_inputs" ], "nullable": true, "type": "string" } }, "required": [ "enabled", "status" ], "title": "OrdersV2ResourceAutomaticTax", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "enabled", "status" ] }, "orders_v2_resource_billing_details": { "description": "", "properties": { "address": { "anyOf": [ { "$ref": "#/components/schemas/address" } ], "description": "Billing address for the order.", "nullable": true }, "email": { "description": "Email address for the order.", "maxLength": 5000, "nullable": true, "type": "string" }, "name": { "description": "Full name for the order.", "maxLength": 5000, "nullable": true, "type": "string" }, "phone": { "description": "Billing phone number for the order (including extension).", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "address", "email", "name", "phone" ], "title": "OrdersV2ResourceBillingDetails", "type": "object", "x-expandableFields": [ "address" ], "x-stripeMostCommon": [ "address", "email", "name", "phone" ] }, "orders_v2_resource_card_payment_method_options": { "description": "", "properties": { "capture_method": { "description": "Controls when the funds will be captured from the customer's account.", "enum": [ "automatic", "automatic_async", "manual" ], "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with the payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the order's Customer, if present, after the order's PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.", "enum": [ "none", "off_session", "on_session" ], "type": "string" } }, "required": [ "capture_method" ], "title": "OrdersV2ResourceCardPaymentMethodOptions", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "capture_method", "setup_future_usage" ] }, "orders_v2_resource_payment": { "description": "", "properties": { "payment_intent": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/payment_intent" } ], "description": "ID of the payment intent associated with this order. Null when the order is `open`.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/payment_intent" } ] } }, "settings": { "anyOf": [ { "$ref": "#/components/schemas/orders_v2_resource_payment_settings" } ], "description": "Settings describing how the order should configure generated PaymentIntents.", "nullable": true }, "status": { "description": "The status of the underlying payment associated with this order, if any. Null when the order is `open`.", "enum": [ "canceled", "complete", "not_required", "processing", "requires_action", "requires_capture", "requires_confirmation", "requires_payment_method" ], "nullable": true, "type": "string" } }, "required": [ "payment_intent", "settings", "status" ], "title": "OrdersV2ResourcePayment", "type": "object", "x-expandableFields": [ "payment_intent", "settings" ], "x-stripeMostCommon": [ "payment_intent", "settings", "status" ] }, "orders_v2_resource_payment_method_options": { "description": "", "properties": { "acss_debit": { "$ref": "#/components/schemas/payment_intent_payment_method_options_acss_debit" }, "afterpay_clearpay": { "$ref": "#/components/schemas/orders_payment_method_options_afterpay_clearpay" }, "alipay": { "$ref": "#/components/schemas/payment_method_options_alipay" }, "bancontact": { "$ref": "#/components/schemas/payment_method_options_bancontact" }, "card": { "$ref": "#/components/schemas/orders_v2_resource_card_payment_method_options" }, "customer_balance": { "$ref": "#/components/schemas/payment_method_options_customer_balance" }, "ideal": { "$ref": "#/components/schemas/payment_method_options_ideal" }, "klarna": { "$ref": "#/components/schemas/payment_method_options_klarna" }, "link": { "$ref": "#/components/schemas/payment_intent_payment_method_options_link" }, "oxxo": { "$ref": "#/components/schemas/payment_method_options_oxxo" }, "p24": { "$ref": "#/components/schemas/payment_method_options_p24" }, "paypal": { "$ref": "#/components/schemas/payment_method_options_paypal" }, "sepa_debit": { "$ref": "#/components/schemas/payment_intent_payment_method_options_sepa_debit" }, "sofort": { "$ref": "#/components/schemas/payment_method_options_sofort" }, "wechat_pay": { "$ref": "#/components/schemas/payment_method_options_wechat_pay" } }, "title": "OrdersV2ResourcePaymentMethodOptions", "type": "object", "x-expandableFields": [ "acss_debit", "afterpay_clearpay", "alipay", "bancontact", "card", "customer_balance", "ideal", "klarna", "link", "oxxo", "p24", "paypal", "sepa_debit", "sofort", "wechat_pay" ], "x-stripeMostCommon": [ "acss_debit", "afterpay_clearpay", "alipay", "bancontact", "card", "customer_balance", "ideal", "klarna", "link", "oxxo", "p24", "paypal", "sepa_debit", "sofort", "wechat_pay" ] }, "orders_v2_resource_payment_settings": { "description": "", "properties": { "application_fee_amount": { "description": "The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account.", "nullable": true, "type": "integer" }, "automatic_payment_methods": { "anyOf": [ { "$ref": "#/components/schemas/orders_v2_resource_automatic_payment_methods" } ], "description": "Indicates whether order has been opted into using [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods) to manage payment method types.", "nullable": true }, "payment_method_options": { "anyOf": [ { "$ref": "#/components/schemas/orders_v2_resource_payment_method_options" } ], "description": "PaymentMethod-specific configuration to provide to the order's PaymentIntent.", "nullable": true }, "payment_method_types": { "description": "The list of [payment method types](https://stripe.com/docs/payments/payment-methods/overview) to provide to the order's PaymentIntent. Do not include this attribute if you prefer to manage your payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods).", "items": { "enum": [ "acss_debit", "afterpay_clearpay", "alipay", "au_becs_debit", "bacs_debit", "bancontact", "card", "customer_balance", "eps", "fpx", "giropay", "grabpay", "ideal", "klarna", "link", "oxxo", "p24", "paypal", "sepa_debit", "sofort", "wechat_pay" ], "type": "string" }, "nullable": true, "type": "array" }, "return_url": { "description": "The URL to redirect the customer to after they authenticate their payment.", "maxLength": 5000, "nullable": true, "type": "string" }, "statement_descriptor": { "description": "For non-card charges, you can use this value as the complete description that appears on your customers' statements. Must contain at least one letter, maximum 22 characters.", "maxLength": 5000, "nullable": true, "type": "string" }, "statement_descriptor_suffix": { "description": "Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor.", "maxLength": 5000, "nullable": true, "type": "string" }, "transfer_data": { "anyOf": [ { "$ref": "#/components/schemas/orders_v2_resource_transfer_data" } ], "description": "Provides configuration for completing a transfer for the order after it is paid.", "nullable": true } }, "required": [ "application_fee_amount", "automatic_payment_methods", "payment_method_options", "payment_method_types", "return_url", "statement_descriptor", "statement_descriptor_suffix", "transfer_data" ], "title": "OrdersV2ResourcePaymentSettings", "type": "object", "x-expandableFields": [ "automatic_payment_methods", "payment_method_options", "transfer_data" ], "x-stripeMostCommon": [ "application_fee_amount", "automatic_payment_methods", "payment_method_options", "payment_method_types", "return_url", "statement_descriptor", "statement_descriptor_suffix", "transfer_data" ] }, "orders_v2_resource_shipping_cost": { "description": "", "properties": { "amount_subtotal": { "description": "Total shipping cost before any discounts or taxes are applied.", "type": "integer" }, "amount_tax": { "description": "Total tax amount applied due to shipping costs. If no tax was applied, defaults to 0.", "type": "integer" }, "amount_total": { "description": "Total shipping cost after discounts and taxes are applied.", "type": "integer" }, "shipping_rate": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/shipping_rate" } ], "description": "The ID of the ShippingRate for this order.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/shipping_rate" } ] } }, "taxes": { "description": "The taxes applied to the shipping rate.", "items": { "$ref": "#/components/schemas/line_items_tax_amount" }, "type": "array" } }, "required": [ "amount_subtotal", "amount_tax", "amount_total", "shipping_rate" ], "title": "OrdersV2ResourceShippingCost", "type": "object", "x-expandableFields": [ "shipping_rate", "taxes" ], "x-stripeMostCommon": [ "amount_subtotal", "amount_tax", "amount_total", "shipping_rate", "taxes" ] }, "orders_v2_resource_shipping_details": { "description": "", "properties": { "address": { "anyOf": [ { "$ref": "#/components/schemas/address" } ], "description": "Recipient shipping address. Required if the order includes products that are shippable.", "nullable": true }, "name": { "description": "Recipient name.", "maxLength": 5000, "nullable": true, "type": "string" }, "phone": { "description": "Recipient phone (including extension).", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "address", "name", "phone" ], "title": "OrdersV2ResourceShippingDetails", "type": "object", "x-expandableFields": [ "address" ], "x-stripeMostCommon": [ "address", "name", "phone" ], "x-stripeResource": { "class_name": "ShippingDetails", "in_package": "" } }, "orders_v2_resource_tax_details": { "description": "", "properties": { "tax_exempt": { "description": "Describes the purchaser's tax exemption status. One of `none`, `exempt`, or `reverse`.", "enum": [ "exempt", "none", "reverse" ], "type": "string" }, "tax_ids": { "description": "The purchaser's tax IDs to be used in calculation of tax for this Order.", "items": { "$ref": "#/components/schemas/orders_v2_resource_tax_details_resource_tax_id" }, "type": "array" } }, "required": [ "tax_exempt", "tax_ids" ], "title": "OrdersV2ResourceTaxDetails", "type": "object", "x-expandableFields": [ "tax_ids" ], "x-stripeMostCommon": [ "tax_exempt", "tax_ids" ] }, "orders_v2_resource_tax_details_resource_tax_id": { "description": "", "properties": { "type": { "description": "The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `al_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, `aw_tin`, `az_tin`, `bd_bin`, `bj_ifu`, `et_tin`, `kg_tin`, `la_tin`, `cm_niu`, `cv_nif`, `bf_ifu`, or `unknown`", "enum": [ "ad_nrt", "ae_trn", "al_tin", "am_tin", "ao_tin", "ar_cuit", "au_abn", "au_arn", "aw_tin", "az_tin", "ba_tin", "bb_tin", "bd_bin", "bf_ifu", "bg_uic", "bh_vat", "bj_ifu", "bo_tin", "br_cnpj", "br_cpf", "bs_tin", "by_tin", "ca_bn", "ca_gst_hst", "ca_pst_bc", "ca_pst_mb", "ca_pst_sk", "ca_qst", "cd_nif", "ch_uid", "ch_vat", "cl_tin", "cm_niu", "cn_tin", "co_nit", "cr_tin", "cv_nif", "de_stn", "do_rcn", "ec_ruc", "eg_tin", "es_cif", "et_tin", "eu_oss_vat", "eu_vat", "gb_vat", "ge_vat", "gn_nif", "hk_br", "hr_oib", "hu_tin", "id_npwp", "il_vat", "in_gst", "is_vat", "jp_cn", "jp_rn", "jp_trn", "ke_pin", "kg_tin", "kh_tin", "kr_brn", "kz_bin", "la_tin", "li_uid", "li_vat", "ma_vat", "md_vat", "me_pib", "mk_vat", "mr_nif", "mx_rfc", "my_frp", "my_itn", "my_sst", "ng_tin", "no_vat", "no_voec", "np_pan", "nz_gst", "om_vat", "pe_ruc", "ph_tin", "ro_tin", "rs_pib", "ru_inn", "ru_kpp", "sa_vat", "sg_gst", "sg_uen", "si_tin", "sn_ninea", "sr_fin", "sv_nit", "th_vat", "tj_tin", "tr_tin", "tw_vat", "tz_vat", "ua_vat", "ug_tin", "unknown", "us_ein", "uy_ruc", "uz_tin", "uz_vat", "ve_rif", "vn_tin", "za_vat", "zm_tin", "zw_tin" ], "type": "string" }, "value": { "description": "The value of the tax ID.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "type", "value" ], "title": "OrdersV2ResourceTaxDetailsResourceTaxID", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "type", "value" ] }, "orders_v2_resource_total_details": { "description": "", "properties": { "amount_discount": { "description": "This is the sum of all the discounts.", "type": "integer" }, "amount_shipping": { "description": "This is the sum of all the shipping amounts.", "nullable": true, "type": "integer" }, "amount_tax": { "description": "This is the sum of all the tax amounts.", "type": "integer" }, "breakdown": { "$ref": "#/components/schemas/orders_v2_resource_total_details_api_resource_breakdown" } }, "required": [ "amount_discount", "amount_shipping", "amount_tax" ], "title": "OrdersV2ResourceTotalDetails", "type": "object", "x-expandableFields": [ "breakdown" ], "x-stripeMostCommon": [ "amount_discount", "amount_shipping", "amount_tax", "breakdown" ] }, "orders_v2_resource_total_details_api_resource_breakdown": { "description": "", "properties": { "discounts": { "description": "The aggregated discounts.", "items": { "$ref": "#/components/schemas/line_items_discount_amount" }, "type": "array" }, "taxes": { "description": "The aggregated tax amounts by rate.", "items": { "$ref": "#/components/schemas/line_items_tax_amount" }, "type": "array" } }, "required": [ "discounts", "taxes" ], "title": "OrdersV2ResourceTotalDetailsAPIResourceBreakdown", "type": "object", "x-expandableFields": [ "discounts", "taxes" ], "x-stripeMostCommon": [ "discounts", "taxes" ] }, "orders_v2_resource_transfer_data": { "description": "", "properties": { "amount": { "description": "The amount that will be transferred automatically when the order is paid. If no amount is set, the full amount is transferred. There cannot be any line items with recurring prices when using this field.", "nullable": true, "type": "integer" }, "destination": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/account" } ], "description": "ID of the Connected account receiving the transfer.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/account" } ] } } }, "required": [ "amount", "destination" ], "title": "OrdersV2ResourceTransferData", "type": "object", "x-expandableFields": [ "destination" ], "x-stripeMostCommon": [ "amount", "destination" ] }, "outbound_payments_payment_method_details": { "description": "", "properties": { "billing_details": { "$ref": "#/components/schemas/treasury_shared_resource_billing_details" }, "financial_account": { "$ref": "#/components/schemas/outbound_payments_payment_method_details_financial_account" }, "type": { "description": "The type of the payment method used in the OutboundPayment.", "enum": [ "financial_account", "us_bank_account" ], "type": "string", "x-stripeBypassValidation": true }, "us_bank_account": { "$ref": "#/components/schemas/outbound_payments_payment_method_details_us_bank_account" } }, "required": [ "billing_details", "type" ], "title": "OutboundPaymentsPaymentMethodDetails", "type": "object", "x-expandableFields": [ "billing_details", "financial_account", "us_bank_account" ], "x-stripeMostCommon": [ "billing_details", "financial_account", "type", "us_bank_account" ] }, "outbound_payments_payment_method_details_financial_account": { "description": "", "properties": { "id": { "description": "Token of the FinancialAccount.", "maxLength": 5000, "type": "string" }, "network": { "description": "The rails used to send funds.", "enum": [ "stripe" ], "type": "string" } }, "required": [ "id", "network" ], "title": "outbound_payments_payment_method_details_financial_account", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "id", "network" ], "x-stripeResource": { "class_name": "FinancialAccount", "in_package": "" } }, "outbound_payments_payment_method_details_us_bank_account": { "description": "", "properties": { "account_holder_type": { "description": "Account holder type: individual or company.", "enum": [ "company", "individual" ], "nullable": true, "type": "string" }, "account_type": { "description": "Account type: checkings or savings. Defaults to checking if omitted.", "enum": [ "checking", "savings" ], "nullable": true, "type": "string" }, "bank_name": { "description": "Name of the bank associated with the bank account.", "maxLength": 5000, "nullable": true, "type": "string" }, "fingerprint": { "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.", "maxLength": 5000, "nullable": true, "type": "string" }, "last4": { "description": "Last four digits of the bank account number.", "maxLength": 5000, "nullable": true, "type": "string" }, "mandate": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/mandate" } ], "description": "ID of the mandate used to make this payment.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/mandate" } ] } }, "network": { "description": "The network rails used. See the [docs](https://stripe.com/docs/treasury/money-movement/timelines) to learn more about money movement timelines for each network type.", "enum": [ "ach", "us_domestic_wire" ], "type": "string" }, "routing_number": { "description": "Routing number of the bank account.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "account_holder_type", "account_type", "bank_name", "fingerprint", "last4", "network", "routing_number" ], "title": "outbound_payments_payment_method_details_us_bank_account", "type": "object", "x-expandableFields": [ "mandate" ], "x-stripeMostCommon": [ "account_holder_type", "account_type", "bank_name", "fingerprint", "last4", "mandate", "network", "routing_number" ], "x-stripeResource": { "class_name": "UsBankAccount", "in_package": "" } }, "outbound_transfers_payment_method_details": { "description": "", "properties": { "billing_details": { "$ref": "#/components/schemas/treasury_shared_resource_billing_details" }, "financial_account": { "$ref": "#/components/schemas/outbound_transfers_payment_method_details_financial_account" }, "type": { "description": "The type of the payment method used in the OutboundTransfer.", "enum": [ "financial_account", "us_bank_account" ], "type": "string" }, "us_bank_account": { "$ref": "#/components/schemas/outbound_transfers_payment_method_details_us_bank_account" } }, "required": [ "billing_details", "type" ], "title": "OutboundTransfersPaymentMethodDetails", "type": "object", "x-expandableFields": [ "billing_details", "financial_account", "us_bank_account" ], "x-stripeMostCommon": [ "billing_details", "financial_account", "type", "us_bank_account" ], "x-stripeResource": { "class_name": "DestinationPaymentMethodDetails", "in_package": "" } }, "outbound_transfers_payment_method_details_financial_account": { "description": "", "properties": { "id": { "description": "Token of the FinancialAccount.", "maxLength": 5000, "type": "string" }, "network": { "description": "The rails used to send funds.", "enum": [ "stripe" ], "type": "string" } }, "required": [ "id", "network" ], "title": "outbound_transfers_payment_method_details_financial_account", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "id", "network" ], "x-stripeResource": { "class_name": "FinancialAccount", "in_package": "" } }, "outbound_transfers_payment_method_details_us_bank_account": { "description": "", "properties": { "account_holder_type": { "description": "Account holder type: individual or company.", "enum": [ "company", "individual" ], "nullable": true, "type": "string" }, "account_type": { "description": "Account type: checkings or savings. Defaults to checking if omitted.", "enum": [ "checking", "savings" ], "nullable": true, "type": "string" }, "bank_name": { "description": "Name of the bank associated with the bank account.", "maxLength": 5000, "nullable": true, "type": "string" }, "fingerprint": { "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.", "maxLength": 5000, "nullable": true, "type": "string" }, "last4": { "description": "Last four digits of the bank account number.", "maxLength": 5000, "nullable": true, "type": "string" }, "mandate": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/mandate" } ], "description": "ID of the mandate used to make this payment.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/mandate" } ] } }, "network": { "description": "The network rails used. See the [docs](https://stripe.com/docs/treasury/money-movement/timelines) to learn more about money movement timelines for each network type.", "enum": [ "ach", "us_domestic_wire" ], "type": "string" }, "routing_number": { "description": "Routing number of the bank account.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "account_holder_type", "account_type", "bank_name", "fingerprint", "last4", "network", "routing_number" ], "title": "outbound_transfers_payment_method_details_us_bank_account", "type": "object", "x-expandableFields": [ "mandate" ], "x-stripeMostCommon": [ "account_holder_type", "account_type", "bank_name", "fingerprint", "last4", "mandate", "network", "routing_number" ], "x-stripeResource": { "class_name": "UsBankAccount", "in_package": "" } }, "package_dimensions": { "description": "", "properties": { "height": { "description": "Height, in inches.", "type": "number" }, "length": { "description": "Length, in inches.", "type": "number" }, "weight": { "description": "Weight, in ounces.", "type": "number" }, "width": { "description": "Width, in inches.", "type": "number" } }, "required": [ "height", "length", "weight", "width" ], "title": "PackageDimensions", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "height", "length", "weight", "width" ] }, "payment_attempt_record": { "description": "A Payment Attempt Record represents an individual attempt at making a payment, on or off Stripe.\nEach payment attempt tries to collect a fixed amount of money from a fixed customer and payment\nmethod. Payment Attempt Records are attached to Payment Records. Only one attempt per Payment Record\ncan have guaranteed funds.", "properties": { "amount": { "$ref": "#/components/schemas/payments_primitives_payment_records_resource_amount" }, "amount_authorized": { "$ref": "#/components/schemas/payments_primitives_payment_records_resource_amount" }, "amount_canceled": { "$ref": "#/components/schemas/payments_primitives_payment_records_resource_amount" }, "amount_failed": { "$ref": "#/components/schemas/payments_primitives_payment_records_resource_amount" }, "amount_guaranteed": { "$ref": "#/components/schemas/payments_primitives_payment_records_resource_amount" }, "amount_refunded": { "$ref": "#/components/schemas/payments_primitives_payment_records_resource_amount" }, "amount_requested": { "$ref": "#/components/schemas/payments_primitives_payment_records_resource_amount" }, "application": { "description": "ID of the Connect application that created the PaymentAttemptRecord.", "maxLength": 5000, "nullable": true, "type": "string" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "customer_details": { "anyOf": [ { "$ref": "#/components/schemas/payments_primitives_payment_records_resource_customer_details" } ], "description": "Customer information for this payment.", "nullable": true }, "customer_presence": { "description": "Indicates whether the customer was present in your checkout flow during this payment.", "enum": [ "off_session", "on_session" ], "nullable": true, "type": "string" }, "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users.", "maxLength": 5000, "nullable": true, "type": "string" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "type": "object" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "payment_attempt_record" ], "type": "string" }, "payment_method_details": { "anyOf": [ { "$ref": "#/components/schemas/payments_primitives_payment_records_resource_payment_method_details" } ], "description": "Information about the Payment Method debited for this payment.", "nullable": true }, "payment_record": { "description": "ID of the Payment Record this Payment Attempt Record belongs to.", "maxLength": 5000, "nullable": true, "type": "string" }, "processor_details": { "$ref": "#/components/schemas/payments_primitives_payment_records_resource_processor_details" }, "reported_by": { "description": "Indicates who reported the payment.", "enum": [ "self", "stripe" ], "type": "string" }, "shipping_details": { "anyOf": [ { "$ref": "#/components/schemas/payments_primitives_payment_records_resource_shipping_details" } ], "description": "Shipping information for this payment.", "nullable": true } }, "required": [ "amount", "amount_authorized", "amount_canceled", "amount_failed", "amount_guaranteed", "amount_refunded", "amount_requested", "application", "created", "customer_details", "customer_presence", "description", "id", "livemode", "metadata", "object", "payment_method_details", "payment_record", "processor_details", "reported_by", "shipping_details" ], "title": "PaymentAttemptRecord", "type": "object", "x-expandableFields": [ "amount", "amount_authorized", "amount_canceled", "amount_failed", "amount_guaranteed", "amount_refunded", "amount_requested", "customer_details", "payment_method_details", "processor_details", "shipping_details" ], "x-resourceId": "payment_attempt_record", "x-stripeMostCommon": [ "amount", "amount_authorized", "amount_canceled", "amount_failed", "amount_guaranteed", "amount_refunded", "amount_requested", "customer_details", "description", "id", "metadata", "payment_method_details", "processor_details", "shipping_details" ], "x-stripeOperations": [ { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/payment_attempt_records" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/payment_attempt_records/{id}" } ], "x-stripeResource": { "class_name": "PaymentAttemptRecord", "has_collection_class": true, "in_package": "" } }, "payment_flows_amount_details": { "description": "", "properties": { "discount_amount": { "description": "The amount an item was discounted for.", "type": "integer" }, "line_items": { "description": "A list of line items, each containing information about a product in the PaymentIntent. There is a maximum of 100 line items.", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/payment_intent_amount_details_line_item" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "PaymentFlowsAmountDetailsResourceLineItemsList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] }, "shipping": { "$ref": "#/components/schemas/payment_flows_amount_details_resource_shipping" }, "tax": { "$ref": "#/components/schemas/payment_flows_amount_details_resource_tax" }, "tip": { "$ref": "#/components/schemas/payment_flows_amount_details_client_resource_tip" } }, "title": "PaymentFlowsAmountDetails", "type": "object", "x-expandableFields": [ "line_items", "shipping", "tax", "tip" ], "x-stripeMostCommon": [ "discount_amount", "line_items", "shipping", "tax", "tip" ] }, "payment_flows_amount_details_client": { "description": "", "properties": { "tip": { "$ref": "#/components/schemas/payment_flows_amount_details_client_resource_tip" } }, "title": "PaymentFlowsAmountDetailsClient", "type": "object", "x-expandableFields": [ "tip" ], "x-stripeMostCommon": [ "tip" ] }, "payment_flows_amount_details_client_resource_tip": { "description": "", "properties": { "amount": { "description": "Portion of the amount that corresponds to a tip.", "type": "integer" } }, "title": "PaymentFlowsAmountDetailsClientResourceTip", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "amount" ] }, "payment_flows_amount_details_resource_line_items_list_resource_line_item_resource_payment_method_options": { "description": "", "properties": { "card": { "$ref": "#/components/schemas/payment_flows_private_payment_methods_card_payment_intent_amount_details_line_item_payment_method_options" }, "card_present": { "$ref": "#/components/schemas/payment_flows_private_payment_methods_card_present_amount_details_line_item_payment_method_options" }, "klarna": { "$ref": "#/components/schemas/payment_flows_private_payment_methods_klarna_payment_intent_amount_details_line_item_payment_method_options" }, "paypal": { "$ref": "#/components/schemas/payment_flows_private_payment_methods_paypal_amount_details_line_item_payment_method_options" } }, "title": "PaymentFlowsAmountDetailsResourceLineItemsListResourceLineItemResourcePaymentMethodOptions", "type": "object", "x-expandableFields": [ "card", "card_present", "klarna", "paypal" ], "x-stripeMostCommon": [ "card", "card_present", "klarna", "paypal" ] }, "payment_flows_amount_details_resource_line_items_list_resource_line_item_resource_tax": { "description": "", "properties": { "total_tax_amount": { "description": "Total portion of the amount that is for tax.", "type": "integer" } }, "required": [ "total_tax_amount" ], "title": "PaymentFlowsAmountDetailsResourceLineItemsListResourceLineItemResourceTax", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "total_tax_amount" ] }, "payment_flows_amount_details_resource_shipping": { "description": "", "properties": { "amount": { "description": "Portion of the amount that is for shipping.", "nullable": true, "type": "integer" }, "from_postal_code": { "description": "The postal code that represents the shipping source.", "maxLength": 5000, "nullable": true, "type": "string" }, "to_postal_code": { "description": "The postal code that represents the shipping destination.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "amount", "from_postal_code", "to_postal_code" ], "title": "PaymentFlowsAmountDetailsResourceShipping", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "amount", "from_postal_code", "to_postal_code" ] }, "payment_flows_amount_details_resource_tax": { "description": "", "properties": { "total_tax_amount": { "description": "Total portion of the amount that is for tax.", "nullable": true, "type": "integer" } }, "required": [ "total_tax_amount" ], "title": "PaymentFlowsAmountDetailsResourceTax", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "total_tax_amount" ] }, "payment_flows_automatic_payment_methods_payment_intent": { "description": "", "properties": { "allow_redirects": { "description": "Controls whether this PaymentIntent will accept redirect-based payment methods.\n\nRedirect-based payment methods may require your customer to be redirected to a payment method's app or site for authentication or additional steps. To [confirm](https://stripe.com/docs/api/payment_intents/confirm) this PaymentIntent, you may be required to provide a `return_url` to redirect customers back to your site after they authenticate or complete the payment.", "enum": [ "always", "never" ], "type": "string" }, "enabled": { "description": "Automatically calculates compatible payment methods", "type": "boolean" } }, "required": [ "enabled" ], "title": "PaymentFlowsAutomaticPaymentMethodsPaymentIntent", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "allow_redirects", "enabled" ] }, "payment_flows_automatic_payment_methods_setup_intent": { "description": "", "properties": { "allow_redirects": { "description": "Controls whether this SetupIntent will accept redirect-based payment methods.\n\nRedirect-based payment methods may require your customer to be redirected to a payment method's app or site for authentication or additional steps. To [confirm](https://stripe.com/docs/api/setup_intents/confirm) this SetupIntent, you may be required to provide a `return_url` to redirect customers back to your site after they authenticate or complete the setup.", "enum": [ "always", "never" ], "type": "string" }, "enabled": { "description": "Automatically calculates compatible payment methods", "nullable": true, "type": "boolean" } }, "required": [ "enabled" ], "title": "PaymentFlowsAutomaticPaymentMethodsSetupIntent", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "allow_redirects", "enabled" ] }, "payment_flows_installment_options": { "description": "", "properties": { "enabled": { "type": "boolean" }, "plan": { "$ref": "#/components/schemas/payment_method_details_card_installments_plan" } }, "required": [ "enabled" ], "title": "PaymentFlowsInstallmentOptions", "type": "object", "x-expandableFields": [ "plan" ], "x-stripeMostCommon": [ "enabled", "plan" ], "x-stripeResource": { "class_name": "Installments", "in_package": "" } }, "payment_flows_payment_details": { "description": "", "properties": { "car_rental": { "$ref": "#/components/schemas/payment_flows_payment_details_resource_car_rental" }, "customer_reference": { "description": "Some customers might be required by their company or organization to provide this information. If so, provide this value. Otherwise you can ignore this field.", "maxLength": 5000, "nullable": true, "type": "string" }, "event_details": { "$ref": "#/components/schemas/payment_flows_payment_details_resource_event" }, "order_reference": { "description": "A unique value assigned by the business to identify the transaction.", "maxLength": 5000, "nullable": true, "type": "string" }, "subscription": { "$ref": "#/components/schemas/payment_flows_payment_details_resource_subscription" } }, "title": "PaymentFlowsPaymentDetails", "type": "object", "x-expandableFields": [ "car_rental", "event_details", "subscription" ], "x-stripeMostCommon": [ "car_rental", "customer_reference", "event_details", "order_reference", "subscription" ] }, "payment_flows_payment_details_resource_affiliate": { "description": "", "properties": { "name": { "description": "The name of the affiliate that originated the purchase.", "maxLength": 5000, "type": "string" } }, "title": "PaymentFlowsPaymentDetailsResourceAffiliate", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "name" ] }, "payment_flows_payment_details_resource_billing_interval": { "description": "", "properties": { "count": { "description": "The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.", "type": "integer" }, "interval": { "description": "Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.", "enum": [ "day", "month", "week", "year" ], "type": "string" } }, "title": "PaymentFlowsPaymentDetailsResourceBillingInterval", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "count", "interval" ] }, "payment_flows_payment_details_resource_car_rental": { "description": "", "properties": { "affiliate": { "$ref": "#/components/schemas/payment_flows_payment_details_resource_affiliate" }, "booking_number": { "description": "The booking number associated with the car rental.", "maxLength": 100, "type": "string" }, "car_class_code": { "description": "Class code of the car.", "maxLength": 4, "type": "string" }, "car_make": { "description": "Make of the car.", "maxLength": 10, "type": "string" }, "car_model": { "description": "Model of the car.", "maxLength": 10, "type": "string" }, "company": { "description": "The name of the rental car company.", "maxLength": 26, "type": "string" }, "customer_service_phone_number": { "description": "The customer service phone number of the car rental company.", "maxLength": 16, "type": "string" }, "days_rented": { "description": "Number of days the car is being rented.", "type": "integer" }, "delivery": { "$ref": "#/components/schemas/payment_flows_payment_details_resource_delivery" }, "distance": { "$ref": "#/components/schemas/payment_flows_payment_details_resource_car_rental_distance" }, "drivers": { "description": "The details of the drivers associated with the trip.", "items": { "$ref": "#/components/schemas/payment_flows_payment_details_resource_car_rental_driver" }, "type": "array" }, "extra_charges": { "description": "List of additional charges being billed.", "items": { "enum": [ "extra_mileage", "gas", "late_return", "one_way_service", "parking_violation" ], "type": "string" }, "type": "array" }, "no_show": { "description": "Indicates if the customer did not keep nor cancel their booking.", "type": "boolean" }, "pickup_address": { "$ref": "#/components/schemas/address" }, "pickup_at": { "description": "Car pick-up time. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "pickup_location_name": { "description": "Name of the pickup location.", "maxLength": 38, "type": "string" }, "rate_amount": { "description": "Rental rate.", "type": "integer" }, "rate_interval": { "description": "The frequency at which the rate amount is applied. One of `day`, `week` or `month`", "enum": [ "day", "month", "week" ], "type": "string" }, "renter_name": { "description": "The full name of the person or entity renting the car.", "maxLength": 100, "type": "string" }, "return_address": { "$ref": "#/components/schemas/address" }, "return_at": { "description": "Car return time. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "return_location_name": { "description": "Name of the return location.", "maxLength": 38, "type": "string" }, "tax_exempt": { "description": "Indicates whether the goods or services are tax-exempt or tax is not collected.", "type": "boolean" }, "vehicle_identification_number": { "description": "The vehicle identification number of the car.", "maxLength": 20, "type": "string" } }, "required": [ "booking_number", "days_rented", "pickup_at", "return_at" ], "title": "PaymentFlowsPaymentDetailsResourceCarRental", "type": "object", "x-expandableFields": [ "affiliate", "delivery", "distance", "drivers", "pickup_address", "return_address" ], "x-stripeMostCommon": [ "affiliate", "booking_number", "car_class_code", "car_make", "car_model", "company", "customer_service_phone_number", "days_rented", "delivery", "distance", "drivers", "extra_charges", "no_show", "pickup_address", "pickup_at", "pickup_location_name", "rate_amount", "rate_interval", "renter_name", "return_address", "return_at", "return_location_name", "tax_exempt", "vehicle_identification_number" ] }, "payment_flows_payment_details_resource_car_rental_distance": { "description": "", "properties": { "amount": { "description": "Distance traveled.", "type": "integer" }, "unit": { "description": "Unit of measurement for the distance traveled. One of `miles` or `kilometers`", "maxLength": 5000, "type": "string" } }, "title": "PaymentFlowsPaymentDetailsResourceCarRentalDistance", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "amount", "unit" ] }, "payment_flows_payment_details_resource_car_rental_driver": { "description": "", "properties": { "driver_identification_number": { "description": "Driver's identification number.", "maxLength": 5000, "type": "string" }, "driver_tax_number": { "description": "Driver's tax number.", "maxLength": 5000, "type": "string" }, "name": { "description": "Full name of the driver on the reservation.", "maxLength": 5000, "type": "string" } }, "title": "PaymentFlowsPaymentDetailsResourceCarRentalDriver", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "driver_identification_number", "driver_tax_number", "name" ] }, "payment_flows_payment_details_resource_delivery": { "description": "", "properties": { "mode": { "description": "The delivery method for the payment", "enum": [ "email", "phone", "pickup", "post" ], "type": "string" }, "recipient": { "$ref": "#/components/schemas/payment_flows_payment_details_resource_delivery_recipient" } }, "title": "PaymentFlowsPaymentDetailsResourceDelivery", "type": "object", "x-expandableFields": [ "recipient" ], "x-stripeMostCommon": [ "mode", "recipient" ] }, "payment_flows_payment_details_resource_delivery_recipient": { "description": "", "properties": { "email": { "description": "The email of the recipient the ticket is delivered to.", "maxLength": 5000, "type": "string" }, "name": { "description": "The name of the recipient the ticket is delivered to.", "maxLength": 5000, "type": "string" }, "phone": { "description": "The phone number of the recipient the ticket is delivered to.", "maxLength": 5000, "type": "string" } }, "title": "PaymentFlowsPaymentDetailsResourceDeliveryRecipient", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "email", "name", "phone" ] }, "payment_flows_payment_details_resource_event": { "description": "", "properties": { "access_controlled_venue": { "description": "Indicates if the tickets are digitally checked when entering the venue.", "type": "boolean" }, "address": { "$ref": "#/components/schemas/address" }, "affiliate": { "$ref": "#/components/schemas/payment_flows_payment_details_resource_affiliate" }, "company": { "description": "The name of the company", "maxLength": 5000, "type": "string" }, "delivery": { "$ref": "#/components/schemas/payment_flows_payment_details_resource_delivery" }, "ends_at": { "description": "Event end time. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "genre": { "description": "Type of the event entertainment (concert, sports event etc)", "maxLength": 5000, "type": "string" }, "name": { "description": "The name of the event.", "maxLength": 5000, "type": "string" }, "starts_at": { "description": "Event start time. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" } }, "title": "PaymentFlowsPaymentDetailsResourceEvent", "type": "object", "x-expandableFields": [ "address", "affiliate", "delivery" ], "x-stripeMostCommon": [ "access_controlled_venue", "address", "affiliate", "company", "delivery", "ends_at", "genre", "name", "starts_at" ] }, "payment_flows_payment_details_resource_subscription": { "description": "", "properties": { "affiliate": { "$ref": "#/components/schemas/payment_flows_payment_details_resource_affiliate" }, "auto_renewal": { "description": "Info whether the subscription will be auto renewed upon expiry.", "type": "boolean" }, "billing_interval": { "$ref": "#/components/schemas/payment_flows_payment_details_resource_billing_interval" }, "ends_at": { "description": "Subscription end time. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "name": { "description": "Name of the product on subscription. e.g. Apple Music Subscription.", "maxLength": 5000, "type": "string" }, "starts_at": { "description": "Subscription start time. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" } }, "title": "PaymentFlowsPaymentDetailsResourceSubscription", "type": "object", "x-expandableFields": [ "affiliate", "billing_interval" ], "x-stripeMostCommon": [ "affiliate", "auto_renewal", "billing_interval", "ends_at", "name", "starts_at" ] }, "payment_flows_payment_intent_async_workflows": { "description": "", "properties": { "inputs": { "$ref": "#/components/schemas/payment_flows_payment_intent_async_workflows_resource_inputs" } }, "title": "PaymentFlowsPaymentIntentAsyncWorkflows", "type": "object", "x-expandableFields": [ "inputs" ], "x-stripeMostCommon": [ "inputs" ] }, "payment_flows_payment_intent_async_workflows_resource_inputs": { "description": "", "properties": { "tax": { "$ref": "#/components/schemas/payment_flows_payment_intent_async_workflows_resource_inputs_resource_tax" } }, "title": "PaymentFlowsPaymentIntentAsyncWorkflowsResourceInputs", "type": "object", "x-expandableFields": [ "tax" ], "x-stripeMostCommon": [ "tax" ] }, "payment_flows_payment_intent_async_workflows_resource_inputs_resource_tax": { "description": "", "properties": { "calculation": { "description": "The [TaxCalculation](https://stripe.com/docs/api/tax/calculations) id", "maxLength": 5000, "type": "string" } }, "required": [ "calculation" ], "title": "PaymentFlowsPaymentIntentAsyncWorkflowsResourceInputsResourceTax", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "calculation" ] }, "payment_flows_payment_intent_presentment_details": { "description": "", "properties": { "presentment_amount": { "description": "Amount intended to be collected by this payment, denominated in `presentment_currency`.", "type": "integer" }, "presentment_currency": { "description": "Currency presented to the customer during payment.", "maxLength": 5000, "type": "string" } }, "required": [ "presentment_amount", "presentment_currency" ], "title": "PaymentFlowsPaymentIntentPresentmentDetails", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "presentment_amount", "presentment_currency" ] }, "payment_flows_private_payment_methods_alipay": { "description": "", "properties": {}, "title": "PaymentFlowsPrivatePaymentMethodsAlipay", "type": "object", "x-expandableFields": [] }, "payment_flows_private_payment_methods_alipay_details": { "description": "", "properties": { "buyer_id": { "description": "Uniquely identifies this particular Alipay account. You can use this attribute to check whether two Alipay accounts are the same.", "maxLength": 5000, "type": "string" }, "fingerprint": { "description": "Uniquely identifies this particular Alipay account. You can use this attribute to check whether two Alipay accounts are the same.", "maxLength": 5000, "nullable": true, "type": "string" }, "transaction_id": { "description": "Transaction ID of this particular Alipay transaction.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "fingerprint", "transaction_id" ], "title": "PaymentFlowsPrivatePaymentMethodsAlipayDetails", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "buyer_id", "fingerprint", "transaction_id" ] }, "payment_flows_private_payment_methods_card_details_api_resource_enterprise_features_decremental_authorization_decremental_authorization": { "description": "", "properties": { "status": { "description": "Indicates whether or not the decremental authorization feature is supported.", "enum": [ "available", "unavailable" ], "type": "string" } }, "required": [ "status" ], "title": "PaymentFlowsPrivatePaymentMethodsCardDetailsAPIResourceEnterpriseFeaturesDecrementalAuthorizationDecrementalAuthorization", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "status" ], "x-stripeResource": { "class_name": "DecrementalAuthorizationRequest", "in_package": "" } }, "payment_flows_private_payment_methods_card_details_api_resource_enterprise_features_extended_authorization_extended_authorization": { "description": "", "properties": { "status": { "description": "Indicates whether or not the capture window is extended beyond the standard authorization.", "enum": [ "disabled", "enabled" ], "type": "string" } }, "required": [ "status" ], "title": "PaymentFlowsPrivatePaymentMethodsCardDetailsAPIResourceEnterpriseFeaturesExtendedAuthorizationExtendedAuthorization", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "status" ] }, "payment_flows_private_payment_methods_card_details_api_resource_enterprise_features_incremental_authorization_incremental_authorization": { "description": "", "properties": { "status": { "description": "Indicates whether or not the incremental authorization feature is supported.", "enum": [ "available", "unavailable" ], "type": "string" } }, "required": [ "status" ], "title": "PaymentFlowsPrivatePaymentMethodsCardDetailsAPIResourceEnterpriseFeaturesIncrementalAuthorizationIncrementalAuthorization", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "status" ] }, "payment_flows_private_payment_methods_card_details_api_resource_enterprise_features_overcapture_overcapture": { "description": "", "properties": { "maximum_amount_capturable": { "description": "The maximum amount that can be captured.", "type": "integer" }, "status": { "description": "Indicates whether or not the authorized amount can be over-captured.", "enum": [ "available", "unavailable" ], "type": "string" } }, "required": [ "maximum_amount_capturable", "status" ], "title": "PaymentFlowsPrivatePaymentMethodsCardDetailsAPIResourceEnterpriseFeaturesOvercaptureOvercapture", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "maximum_amount_capturable", "status" ] }, "payment_flows_private_payment_methods_card_details_api_resource_enterprise_features_partial_authorization_partial_authorization": { "description": "", "properties": { "status": { "description": "Indicates whether the transaction requested for partial authorization feature and the authorization outcome.", "enum": [ "declined", "fully_authorized", "not_requested", "partially_authorized" ], "type": "string" } }, "required": [ "status" ], "title": "PaymentFlowsPrivatePaymentMethodsCardDetailsAPIResourceEnterpriseFeaturesPartialAuthorizationPartialAuthorization", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "status" ] }, "payment_flows_private_payment_methods_card_details_api_resource_multicapture": { "description": "", "properties": { "status": { "description": "Indicates whether or not multiple captures are supported.", "enum": [ "available", "unavailable" ], "type": "string" } }, "required": [ "status" ], "title": "PaymentFlowsPrivatePaymentMethodsCardDetailsAPIResourceMulticapture", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "status" ] }, "payment_flows_private_payment_methods_card_options_statement_details": { "description": "", "properties": { "address": { "$ref": "#/components/schemas/payment_flows_private_payment_methods_card_options_statement_details_resource_address" }, "phone": { "description": "Phone number", "maxLength": 5000, "type": "string" } }, "title": "PaymentFlowsPrivatePaymentMethodsCardOptionsStatementDetails", "type": "object", "x-expandableFields": [ "address" ], "x-stripeMostCommon": [ "address", "phone" ] }, "payment_flows_private_payment_methods_card_options_statement_details_resource_address": { "description": "", "properties": { "city": { "description": "City, district, suburb, town, or village.", "maxLength": 5000, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Address line 1 (e.g., street, PO Box, or company name).", "maxLength": 5000, "type": "string" }, "line2": { "description": "Address line 2 (e.g., apartment, suite, unit, or building).", "maxLength": 5000, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "State, county, province, or region.", "maxLength": 5000, "type": "string" } }, "title": "PaymentFlowsPrivatePaymentMethodsCardOptionsStatementDetailsResourceAddress", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state" ], "x-stripeResource": { "class_name": "StatementDetailsAddress", "in_package": "" } }, "payment_flows_private_payment_methods_card_payment_intent_amount_details_line_item_payment_method_options": { "description": "", "properties": { "commodity_code": { "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "commodity_code" ], "title": "PaymentFlowsPrivatePaymentMethodsCardPaymentIntentAmountDetailsLineItemPaymentMethodOptions", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "commodity_code" ] }, "payment_flows_private_payment_methods_card_present_amount_details_line_item_payment_method_options": { "description": "", "properties": { "commodity_code": { "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "commodity_code" ], "title": "PaymentFlowsPrivatePaymentMethodsCardPresentAmountDetailsLineItemPaymentMethodOptions", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "commodity_code" ] }, "payment_flows_private_payment_methods_card_present_common_wallet": { "description": "", "properties": { "type": { "description": "The type of mobile wallet, one of `apple_pay`, `google_pay`, `samsung_pay`, or `unknown`.", "enum": [ "apple_pay", "google_pay", "samsung_pay", "unknown" ], "type": "string" } }, "required": [ "type" ], "title": "PaymentFlowsPrivatePaymentMethodsCardPresentCommonWallet", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "type" ] }, "payment_flows_private_payment_methods_financial_connections_common_linked_account_options_filters": { "description": "", "properties": { "account_subcategories": { "description": "The account subcategories to use to filter for possible accounts to link. Valid subcategories are `checking` and `savings`.", "items": { "enum": [ "checking", "savings" ], "type": "string" }, "type": "array" }, "institution": { "description": "The institution to use to filter for possible accounts to link.", "maxLength": 5000, "type": "string" } }, "title": "PaymentFlowsPrivatePaymentMethodsFinancialConnectionsCommonLinkedAccountOptionsFilters", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "account_subcategories", "institution" ] }, "payment_flows_private_payment_methods_financial_connections_common_linked_account_options_manual_entry": { "description": "", "properties": { "mode": { "description": "Settings for configuring manual entry of account details.", "enum": [ "automatic", "custom" ], "type": "string" } }, "title": "PaymentFlowsPrivatePaymentMethodsFinancialConnectionsCommonLinkedAccountOptionsManualEntry", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "mode" ] }, "payment_flows_private_payment_methods_kakao_pay_payment_method_options": { "description": "", "properties": { "capture_method": { "description": "Controls when the funds will be captured from the customer's account.", "enum": [ "manual" ], "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none", "off_session" ], "type": "string" } }, "title": "PaymentFlowsPrivatePaymentMethodsKakaoPayPaymentMethodOptions", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "capture_method", "setup_future_usage" ] }, "payment_flows_private_payment_methods_klarna_dob": { "description": "", "properties": { "day": { "description": "The day of birth, between 1 and 31.", "nullable": true, "type": "integer" }, "month": { "description": "The month of birth, between 1 and 12.", "nullable": true, "type": "integer" }, "year": { "description": "The four-digit year of birth.", "nullable": true, "type": "integer" } }, "required": [ "day", "month", "year" ], "title": "PaymentFlowsPrivatePaymentMethodsKlarnaDOB", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "day", "month", "year" ] }, "payment_flows_private_payment_methods_klarna_payment_intent_amount_details_line_item_payment_method_options": { "description": "", "properties": { "image_url": { "maxLength": 2048, "nullable": true, "type": "string" }, "product_url": { "maxLength": 2048, "nullable": true, "type": "string" } }, "required": [ "image_url", "product_url" ], "title": "PaymentFlowsPrivatePaymentMethodsKlarnaPaymentIntentAmountDetailsLineItemPaymentMethodOptions", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "image_url", "product_url" ] }, "payment_flows_private_payment_methods_naver_pay_payment_method_options": { "description": "", "properties": { "capture_method": { "description": "Controls when the funds will be captured from the customer's account.", "enum": [ "manual" ], "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none", "off_session" ], "type": "string" } }, "title": "PaymentFlowsPrivatePaymentMethodsNaverPayPaymentMethodOptions", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "capture_method", "setup_future_usage" ] }, "payment_flows_private_payment_methods_payco_payment_method_options": { "description": "", "properties": { "capture_method": { "description": "Controls when the funds will be captured from the customer's account.", "enum": [ "manual" ], "type": "string" } }, "title": "PaymentFlowsPrivatePaymentMethodsPaycoPaymentMethodOptions", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "capture_method" ] }, "payment_flows_private_payment_methods_paypal_amount_details_line_item_payment_method_options": { "description": "", "properties": { "category": { "description": "Type of the line item.", "enum": [ "digital_goods", "donation", "physical_goods" ], "type": "string" }, "description": { "description": "Description of the line item.", "maxLength": 5000, "type": "string" }, "sold_by": { "description": "The Stripe account ID of the connected account that sells the item. This is only needed when using [Separate Charges and Transfers](https://docs.stripe.com/connect/separate-charges-and-transfers).", "maxLength": 5000, "type": "string" } }, "title": "PaymentFlowsPrivatePaymentMethodsPaypalAmountDetailsLineItemPaymentMethodOptions", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "category", "description", "sold_by" ] }, "payment_flows_private_payment_methods_paypal_line_item_resource_tax": { "description": "", "properties": { "amount": { "description": "The tax for a single unit of the line item in minor units. Cannot be a negative number.", "type": "integer" }, "behavior": { "description": "The tax behavior for the line item.", "enum": [ "exclusive", "inclusive" ], "type": "string" } }, "required": [ "amount", "behavior" ], "title": "PaymentFlowsPrivatePaymentMethodsPaypalLineItemResourceTax", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "amount", "behavior" ] }, "payment_flows_private_payment_methods_rechnung_dob": { "description": "", "properties": { "day": { "description": "The day of birth, between 1 and 31.", "type": "integer" }, "month": { "description": "The month of birth, between 1 and 12.", "type": "integer" }, "year": { "description": "The four-digit year of birth.", "type": "integer" } }, "required": [ "day", "month", "year" ], "title": "PaymentFlowsPrivatePaymentMethodsRechnungDOB", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "day", "month", "year" ] }, "payment_flows_private_payment_methods_samsung_pay_payment_method_options": { "description": "", "properties": { "capture_method": { "description": "Controls when the funds will be captured from the customer's account.", "enum": [ "manual" ], "type": "string" } }, "title": "PaymentFlowsPrivatePaymentMethodsSamsungPayPaymentMethodOptions", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "capture_method" ] }, "payment_intent": { "description": "A PaymentIntent guides you through the process of collecting a payment from your customer.\nWe recommend that you create exactly one PaymentIntent for each order or\ncustomer session in your system. You can reference the PaymentIntent later to\nsee the history of payment attempts for a particular session.\n\nA PaymentIntent transitions through\n[multiple statuses](https://stripe.com/docs/payments/intents#intent-statuses)\nthroughout its lifetime as it interfaces with Stripe.js to perform\nauthentication flows and ultimately creates at most one successful charge.\n\nRelated guide: [Payment Intents API](https://stripe.com/docs/payments/payment-intents)", "properties": { "amount": { "description": "Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).", "type": "integer" }, "amount_capturable": { "description": "Amount that can be captured from this PaymentIntent.", "type": "integer" }, "amount_details": { "$ref": "#/components/schemas/payment_flows_amount_details" }, "amount_received": { "description": "Amount that this PaymentIntent collects.", "type": "integer" }, "application": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/application" } ], "description": "ID of the Connect application that created the PaymentIntent.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/application" } ] } }, "application_fee_amount": { "description": "The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total amount captured. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).", "nullable": true, "type": "integer" }, "automatic_payment_methods": { "anyOf": [ { "$ref": "#/components/schemas/payment_flows_automatic_payment_methods_payment_intent" } ], "description": "Settings to configure compatible payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods)", "nullable": true }, "canceled_at": { "description": "Populated when `status` is `canceled`, this is the time at which the PaymentIntent was canceled. Measured in seconds since the Unix epoch.", "format": "unix-time", "nullable": true, "type": "integer" }, "cancellation_reason": { "description": "Reason for cancellation of this PaymentIntent, either user-provided (`duplicate`, `fraudulent`, `requested_by_customer`, or `abandoned`) or generated by Stripe internally (`failed_invoice`, `void_invoice`, `automatic`, or `expired`).", "enum": [ "abandoned", "automatic", "duplicate", "expired", "failed_invoice", "fraudulent", "requested_by_customer", "void_invoice" ], "nullable": true, "type": "string" }, "capture_method": { "description": "Controls when the funds will be captured from the customer's account.", "enum": [ "automatic", "automatic_async", "manual" ], "type": "string" }, "client_secret": { "description": "The client secret of this PaymentIntent. Used for client-side retrieval using a publishable key. \n\nThe client secret can be used to complete a payment from your frontend. It should not be stored, logged, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret.\n\nRefer to our docs to [accept a payment](https://stripe.com/docs/payments/accept-a-payment?ui=elements) and learn about how `client_secret` should be handled.", "maxLength": 5000, "nullable": true, "type": "string" }, "confirmation_method": { "description": "Describes whether we can confirm this PaymentIntent automatically, or if it requires customer action to confirm the payment.", "enum": [ "automatic", "manual" ], "type": "string" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "customer": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/customer" }, { "$ref": "#/components/schemas/deleted_customer" } ], "description": "ID of the Customer this PaymentIntent belongs to, if one exists.\n\nPayment methods attached to other Customers cannot be used with this PaymentIntent.\n\nIf [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/customer" }, { "$ref": "#/components/schemas/deleted_customer" } ] } }, "customer_account": { "description": "ID of the Account this PaymentIntent belongs to, if one exists.\n\nPayment methods attached to other Accounts cannot be used with this PaymentIntent.\n\nIf [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Account after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Account instead.", "maxLength": 5000, "nullable": true, "type": "string" }, "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users.", "maxLength": 5000, "nullable": true, "type": "string" }, "excluded_payment_method_types": { "description": "The list of payment method types to exclude from use with this payment.", "items": { "enum": [ "acss_debit", "affirm", "afterpay_clearpay", "alipay", "alma", "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", "billie", "blik", "boleto", "card", "cashapp", "crypto", "customer_balance", "eps", "fpx", "giropay", "gopay", "grabpay", "id_bank_transfer", "ideal", "kakao_pay", "klarna", "konbini", "kr_card", "mb_way", "mobilepay", "multibanco", "naver_pay", "nz_bank_account", "oxxo", "p24", "pay_by_bank", "payco", "paynow", "paypal", "paypay", "payto", "pix", "promptpay", "qris", "rechnung", "revolut_pay", "samsung_pay", "satispay", "sepa_debit", "shopeepay", "sofort", "stripe_balance", "swish", "twint", "us_bank_account", "wechat_pay", "zip" ], "type": "string", "x-stripeBypassValidation": true }, "nullable": true, "type": "array" }, "fx_quote": { "description": "The FX Quote used for the PaymentIntent.", "maxLength": 5000, "nullable": true, "type": "string" }, "hooks": { "$ref": "#/components/schemas/payment_flows_payment_intent_async_workflows" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "last_payment_error": { "anyOf": [ { "$ref": "#/components/schemas/api_errors" } ], "description": "The payment error encountered in the previous PaymentIntent confirmation. It will be cleared if the PaymentIntent is later updated for any reason.", "nullable": true }, "latest_charge": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/charge" } ], "description": "ID of the latest [Charge object](https://stripe.com/docs/api/charges) created by this PaymentIntent. This property is `null` until PaymentIntent confirmation is attempted.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/charge" } ] } }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Learn more about [storing information in metadata](https://stripe.com/docs/payments/payment-intents/creating-payment-intents#storing-information-in-metadata).", "type": "object" }, "next_action": { "anyOf": [ { "$ref": "#/components/schemas/payment_intent_next_action" } ], "description": "If present, this property tells you what actions you need to take in order for your customer to fulfill a payment using the provided source.", "nullable": true }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "payment_intent" ], "type": "string" }, "on_behalf_of": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/account" } ], "description": "The account (if any) for which the funds of the PaymentIntent are intended. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts) for details.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/account" } ] } }, "payment_details": { "$ref": "#/components/schemas/payment_flows_payment_details" }, "payment_method": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/payment_method" } ], "description": "ID of the payment method used in this PaymentIntent.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/payment_method" } ] } }, "payment_method_configuration_details": { "anyOf": [ { "$ref": "#/components/schemas/payment_method_config_biz_payment_method_configuration_details" } ], "description": "Information about the [payment method configuration](https://stripe.com/docs/api/payment_method_configurations) used for this PaymentIntent.", "nullable": true }, "payment_method_options": { "anyOf": [ { "$ref": "#/components/schemas/payment_intent_payment_method_options" } ], "description": "Payment-method-specific configuration for this PaymentIntent.", "nullable": true }, "payment_method_types": { "description": "The list of payment method types (e.g. card) that this PaymentIntent is allowed to use. A comprehensive list of valid payment method types can be found [here](https://docs.stripe.com/api/payment_methods/object#payment_method_object-type).", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "presentment_details": { "$ref": "#/components/schemas/payment_flows_payment_intent_presentment_details" }, "processing": { "anyOf": [ { "$ref": "#/components/schemas/payment_intent_processing" } ], "description": "If present, this property tells you about the processing state of the payment.", "nullable": true }, "receipt_email": { "description": "Email address that the receipt for the resulting payment will be sent to. If `receipt_email` is specified for a payment in live mode, a receipt will be sent regardless of your [email settings](https://dashboard.stripe.com/account/emails).", "maxLength": 5000, "nullable": true, "type": "string" }, "review": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/review" } ], "description": "ID of the review associated with this PaymentIntent, if any.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/review" } ] } }, "secret_key_confirmation": { "description": "Indicates whether confirmation for this PaymentIntent using a secret key is `required` or `optional`.", "enum": [ "optional", "required" ], "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "off_session", "on_session" ], "nullable": true, "type": "string" }, "shipping": { "anyOf": [ { "$ref": "#/components/schemas/shipping" } ], "description": "Shipping information for this PaymentIntent.", "nullable": true }, "source": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/payment_source" }, { "$ref": "#/components/schemas/deleted_payment_source" } ], "description": "This is a legacy field that will be removed in the future. It is the ID of the Source object that is associated with this PaymentIntent, if one was supplied.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/payment_source" }, { "$ref": "#/components/schemas/deleted_payment_source" } ] } }, "statement_descriptor": { "description": "Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).\n\nSetting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead.", "maxLength": 5000, "nullable": true, "type": "string" }, "statement_descriptor_suffix": { "description": "Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement.", "maxLength": 5000, "nullable": true, "type": "string" }, "status": { "description": "Status of this PaymentIntent, one of `requires_payment_method`, `requires_confirmation`, `requires_action`, `processing`, `requires_capture`, `canceled`, or `succeeded`. Read more about each PaymentIntent [status](https://stripe.com/docs/payments/intents#intent-statuses).", "enum": [ "canceled", "processing", "requires_action", "requires_capture", "requires_confirmation", "requires_payment_method", "succeeded" ], "type": "string" }, "transfer_data": { "anyOf": [ { "$ref": "#/components/schemas/transfer_data" } ], "description": "The data that automatically creates a Transfer after the payment finalizes. Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).", "nullable": true }, "transfer_group": { "description": "A string that identifies the resulting payment as part of a group. Learn more about the [use case for connected accounts](https://stripe.com/docs/connect/separate-charges-and-transfers).", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "amount", "amount_capturable", "amount_received", "application", "application_fee_amount", "automatic_payment_methods", "canceled_at", "cancellation_reason", "capture_method", "client_secret", "confirmation_method", "created", "currency", "customer", "description", "excluded_payment_method_types", "id", "last_payment_error", "latest_charge", "livemode", "metadata", "next_action", "object", "on_behalf_of", "payment_method", "payment_method_configuration_details", "payment_method_options", "payment_method_types", "processing", "receipt_email", "review", "setup_future_usage", "shipping", "source", "statement_descriptor", "statement_descriptor_suffix", "status", "transfer_data", "transfer_group" ], "title": "PaymentIntent", "type": "object", "x-expandableFields": [ "amount_details", "application", "automatic_payment_methods", "customer", "hooks", "last_payment_error", "latest_charge", "next_action", "on_behalf_of", "payment_details", "payment_method", "payment_method_configuration_details", "payment_method_options", "presentment_details", "processing", "review", "shipping", "source", "transfer_data" ], "x-resourceId": "payment_intent", "x-stripeMostCommon": [ "amount", "automatic_payment_methods", "client_secret", "currency", "customer", "description", "id", "last_payment_error", "latest_charge", "metadata", "next_action", "payment_method", "receipt_email", "setup_future_usage", "shipping", "statement_descriptor", "statement_descriptor_suffix", "status" ], "x-stripeOperations": [ { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/payment_intents" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/payment_intents/{intent}" }, { "method_name": "search", "method_on": "service", "method_type": "custom", "operation": "get", "path": "/v1/payment_intents/search" }, { "method_name": "create", "method_on": "service", "method_type": "create", "operation": "post", "path": "/v1/payment_intents" }, { "method_name": "update", "method_on": "service", "method_type": "update", "operation": "post", "path": "/v1/payment_intents/{intent}" }, { "method_name": "apply_customer_balance", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/payment_intents/{intent}/apply_customer_balance" }, { "method_name": "cancel", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/payment_intents/{intent}/cancel" }, { "method_name": "capture", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/payment_intents/{intent}/capture" }, { "method_name": "confirm", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/payment_intents/{intent}/confirm" }, { "method_name": "decrement_authorization", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/payment_intents/{intent}/decrement_authorization" }, { "method_name": "increment_authorization", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/payment_intents/{intent}/increment_authorization" }, { "method_name": "verify_microdeposits", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/payment_intents/{intent}/verify_microdeposits" }, { "method_name": "trigger_action", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/test/payment_intents/{intent}/trigger_action" } ], "x-stripeResource": { "class_name": "PaymentIntent", "has_collection_class": true, "has_search_result_class": true, "in_package": "" } }, "payment_intent.amount_capturable_updated": { "description": "Occurs when a PaymentIntent has funds to be captured. Check the `amount_capturable` property on the PaymentIntent to determine the amount that can be captured. You may capture the PaymentIntent with an `amount_to_capture` value up to the specified amount. [Learn more about capturing PaymentIntents.](https://docs.stripe.com/api/payment_intents/capture)", "properties": { "object": { "$ref": "#/components/schemas/payment_intent" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "payment_intent.amount_capturable_updated" } }, "payment_intent.canceled": { "description": "Occurs when a PaymentIntent is canceled.", "properties": { "object": { "$ref": "#/components/schemas/payment_intent" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "payment_intent.canceled" } }, "payment_intent.created": { "description": "Occurs when a new PaymentIntent is created.", "properties": { "object": { "$ref": "#/components/schemas/payment_intent" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "payment_intent.created" } }, "payment_intent.partially_funded": { "description": "Occurs when funds are applied to a customer_balance PaymentIntent and the 'amount_remaining' changes.", "properties": { "object": { "$ref": "#/components/schemas/payment_intent" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "payment_intent.partially_funded" } }, "payment_intent.payment_failed": { "description": "Occurs when a PaymentIntent has failed the attempt to create a payment method or a payment.", "properties": { "object": { "$ref": "#/components/schemas/payment_intent" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "payment_intent.payment_failed" } }, "payment_intent.processing": { "description": "Occurs when a PaymentIntent has started processing.", "properties": { "object": { "$ref": "#/components/schemas/payment_intent" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "payment_intent.processing" } }, "payment_intent.requires_action": { "description": "Occurs when a PaymentIntent transitions to requires_action state", "properties": { "object": { "$ref": "#/components/schemas/payment_intent" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "payment_intent.requires_action" } }, "payment_intent.succeeded": { "description": "Occurs when a PaymentIntent has successfully completed payment.", "properties": { "object": { "$ref": "#/components/schemas/payment_intent" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "payment_intent.succeeded" } }, "payment_intent_amount_details_line_item": { "description": "", "properties": { "discount_amount": { "description": "The amount an item was discounted for. Positive integer.", "nullable": true, "type": "integer" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "payment_intent_amount_details_line_item" ], "type": "string" }, "payment_method_options": { "anyOf": [ { "$ref": "#/components/schemas/payment_flows_amount_details_resource_line_items_list_resource_line_item_resource_payment_method_options" } ], "description": "Payment method-specific information for line items.", "nullable": true }, "product_code": { "description": "Unique identifier of the product. At most 12 characters long.", "maxLength": 5000, "nullable": true, "type": "string" }, "product_name": { "description": "Name of the product. At most 100 characters long.", "maxLength": 5000, "type": "string" }, "quantity": { "description": "Number of items of the product. Positive integer.", "type": "integer" }, "tax": { "anyOf": [ { "$ref": "#/components/schemas/payment_flows_amount_details_resource_line_items_list_resource_line_item_resource_tax" } ], "description": "Contains information about the tax on the item.", "nullable": true }, "unit_cost": { "description": "Cost of the product. Non-negative integer.", "type": "integer" }, "unit_of_measure": { "description": "A unit of measure for the line item, such as gallons, feet, meters, etc.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "discount_amount", "id", "object", "payment_method_options", "product_code", "product_name", "quantity", "tax", "unit_cost", "unit_of_measure" ], "title": "PaymentFlowsAmountDetailsResourceLineItemsListResourceLineItem", "type": "object", "x-expandableFields": [ "payment_method_options", "tax" ], "x-resourceId": "payment_intent_amount_details_line_item", "x-stripeMostCommon": [ "discount_amount", "id", "object", "payment_method_options", "product_code", "product_name", "quantity", "tax", "unit_cost", "unit_of_measure" ], "x-stripeOperations": [ { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/payment_intents/{intent}/amount_details_line_items", "shared_version_of": "payment_intent_amount_details_line_item" } ], "x-stripeResource": { "class_name": "PaymentIntentAmountDetailsLineItem", "has_collection_class": true, "in_package": "" } }, "payment_intent_card_processing": { "description": "", "properties": { "customer_notification": { "$ref": "#/components/schemas/payment_intent_processing_customer_notification" } }, "title": "PaymentIntentCardProcessing", "type": "object", "x-expandableFields": [ "customer_notification" ], "x-stripeMostCommon": [ "customer_notification" ], "x-stripeResource": { "class_name": "Card", "in_package": "" } }, "payment_intent_next_action": { "description": "", "properties": { "alipay_handle_redirect": { "$ref": "#/components/schemas/payment_intent_next_action_alipay_handle_redirect" }, "boleto_display_details": { "$ref": "#/components/schemas/payment_intent_next_action_boleto" }, "card_await_notification": { "$ref": "#/components/schemas/payment_intent_next_action_card_await_notification" }, "cashapp_handle_redirect_or_display_qr_code": { "$ref": "#/components/schemas/payment_intent_next_action_cashapp_handle_redirect_or_display_qr_code" }, "display_bank_transfer_instructions": { "$ref": "#/components/schemas/payment_intent_next_action_display_bank_transfer_instructions" }, "konbini_display_details": { "$ref": "#/components/schemas/payment_intent_next_action_konbini" }, "multibanco_display_details": { "$ref": "#/components/schemas/payment_intent_next_action_display_multibanco_details" }, "oxxo_display_details": { "$ref": "#/components/schemas/payment_intent_next_action_display_oxxo_details" }, "paynow_display_qr_code": { "$ref": "#/components/schemas/payment_intent_next_action_paynow_display_qr_code" }, "pix_display_qr_code": { "$ref": "#/components/schemas/payment_intent_next_action_pix_display_qr_code" }, "promptpay_display_qr_code": { "$ref": "#/components/schemas/payment_intent_next_action_promptpay_display_qr_code" }, "redirect_to_url": { "$ref": "#/components/schemas/payment_intent_next_action_redirect_to_url" }, "swish_handle_redirect_or_display_qr_code": { "$ref": "#/components/schemas/payment_intent_next_action_swish_handle_redirect_or_display_qr_code" }, "type": { "description": "Type of the next action to perform. Refer to the other child attributes under `next_action` for available values. Examples include: `redirect_to_url`, `use_stripe_sdk`, `alipay_handle_redirect`, `oxxo_display_details`, or `verify_with_microdeposits`.", "maxLength": 5000, "type": "string" }, "use_stripe_sdk": { "description": "When confirming a PaymentIntent with Stripe.js, Stripe.js depends on the contents of this dictionary to invoke authentication flows. The shape of the contents is subject to change and is only intended to be used by Stripe.js.", "type": "object" }, "verify_with_microdeposits": { "$ref": "#/components/schemas/payment_intent_next_action_verify_with_microdeposits" }, "wechat_pay_display_qr_code": { "$ref": "#/components/schemas/payment_intent_next_action_wechat_pay_display_qr_code" }, "wechat_pay_redirect_to_android_app": { "$ref": "#/components/schemas/payment_intent_next_action_wechat_pay_redirect_to_android_app" }, "wechat_pay_redirect_to_ios_app": { "$ref": "#/components/schemas/payment_intent_next_action_wechat_pay_redirect_to_ios_app" } }, "required": [ "type" ], "title": "PaymentIntentNextAction", "type": "object", "x-expandableFields": [ "alipay_handle_redirect", "boleto_display_details", "card_await_notification", "cashapp_handle_redirect_or_display_qr_code", "display_bank_transfer_instructions", "konbini_display_details", "multibanco_display_details", "oxxo_display_details", "paynow_display_qr_code", "pix_display_qr_code", "promptpay_display_qr_code", "redirect_to_url", "swish_handle_redirect_or_display_qr_code", "verify_with_microdeposits", "wechat_pay_display_qr_code", "wechat_pay_redirect_to_android_app", "wechat_pay_redirect_to_ios_app" ], "x-stripeMostCommon": [ "alipay_handle_redirect", "boleto_display_details", "card_await_notification", "cashapp_handle_redirect_or_display_qr_code", "display_bank_transfer_instructions", "konbini_display_details", "multibanco_display_details", "oxxo_display_details", "paynow_display_qr_code", "pix_display_qr_code", "promptpay_display_qr_code", "redirect_to_url", "swish_handle_redirect_or_display_qr_code", "type", "use_stripe_sdk", "verify_with_microdeposits", "wechat_pay_display_qr_code", "wechat_pay_redirect_to_android_app", "wechat_pay_redirect_to_ios_app" ] }, "payment_intent_next_action_alipay_handle_redirect": { "description": "", "properties": { "native_data": { "description": "The native data to be used with Alipay SDK you must redirect your customer to in order to authenticate the payment in an Android App.", "maxLength": 5000, "nullable": true, "type": "string" }, "native_url": { "description": "The native URL you must redirect your customer to in order to authenticate the payment in an iOS App.", "maxLength": 5000, "nullable": true, "type": "string" }, "return_url": { "description": "If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion.", "maxLength": 5000, "nullable": true, "type": "string" }, "url": { "description": "The URL you must redirect your customer to in order to authenticate the payment.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "native_data", "native_url", "return_url", "url" ], "title": "PaymentIntentNextActionAlipayHandleRedirect", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "native_data", "native_url", "return_url", "url" ], "x-stripeResource": { "class_name": "NextActionAlipayHandleRedirect", "in_package": "" } }, "payment_intent_next_action_boleto": { "description": "", "properties": { "expires_at": { "description": "The timestamp after which the boleto expires.", "format": "unix-time", "nullable": true, "type": "integer" }, "hosted_voucher_url": { "description": "The URL to the hosted boleto voucher page, which allows customers to view the boleto voucher.", "maxLength": 5000, "nullable": true, "type": "string" }, "number": { "description": "The boleto number.", "maxLength": 5000, "nullable": true, "type": "string" }, "pdf": { "description": "The URL to the downloadable boleto voucher PDF.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "expires_at", "hosted_voucher_url", "number", "pdf" ], "title": "payment_intent_next_action_boleto", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "expires_at", "hosted_voucher_url", "number", "pdf" ], "x-stripeResource": { "class_name": "NextActionDisplayBoletoDetails", "in_package": "" } }, "payment_intent_next_action_card_await_notification": { "description": "", "properties": { "charge_attempt_at": { "description": "The time that payment will be attempted. If customer approval is required, they need to provide approval before this time.", "format": "unix-time", "nullable": true, "type": "integer" }, "customer_approval_required": { "description": "For payments greater than INR 15000, the customer must provide explicit approval of the payment with their bank. For payments of lower amount, no customer action is required.", "nullable": true, "type": "boolean" } }, "required": [ "charge_attempt_at", "customer_approval_required" ], "title": "PaymentIntentNextActionCardAwaitNotification", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "charge_attempt_at", "customer_approval_required" ], "x-stripeResource": { "class_name": "NextActionCardAwaitNotification", "in_package": "" } }, "payment_intent_next_action_cashapp_handle_redirect_or_display_qr_code": { "description": "", "properties": { "hosted_instructions_url": { "description": "The URL to the hosted Cash App Pay instructions page, which allows customers to view the QR code, and supports QR code refreshing on expiration.", "maxLength": 5000, "type": "string" }, "mobile_auth_url": { "description": "The url for mobile redirect based auth", "maxLength": 5000, "type": "string" }, "qr_code": { "$ref": "#/components/schemas/payment_intent_next_action_cashapp_qr_code" } }, "required": [ "hosted_instructions_url", "mobile_auth_url", "qr_code" ], "title": "PaymentIntentNextActionCashappHandleRedirectOrDisplayQrCode", "type": "object", "x-expandableFields": [ "qr_code" ], "x-stripeMostCommon": [ "hosted_instructions_url", "mobile_auth_url", "qr_code" ], "x-stripeResource": { "class_name": "CashappHandleRedirectOrDisplayQrCode", "in_package": "" } }, "payment_intent_next_action_cashapp_qr_code": { "description": "", "properties": { "expires_at": { "description": "The date (unix timestamp) when the QR code expires.", "format": "unix-time", "type": "integer" }, "image_url_png": { "description": "The image_url_png string used to render QR code", "maxLength": 5000, "type": "string" }, "image_url_svg": { "description": "The image_url_svg string used to render QR code", "maxLength": 5000, "type": "string" } }, "required": [ "expires_at", "image_url_png", "image_url_svg" ], "title": "PaymentIntentNextActionCashappQRCode", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "expires_at", "image_url_png", "image_url_svg" ], "x-stripeResource": { "class_name": "CashappQrCode", "in_package": "" } }, "payment_intent_next_action_display_bank_transfer_instructions": { "description": "", "properties": { "amount_remaining": { "description": "The remaining amount that needs to be transferred to complete the payment.", "nullable": true, "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "nullable": true, "type": "string" }, "financial_addresses": { "description": "A list of financial addresses that can be used to fund the customer balance", "items": { "$ref": "#/components/schemas/funding_instructions_bank_transfer_financial_address" }, "type": "array" }, "hosted_instructions_url": { "description": "A link to a hosted page that guides your customer through completing the transfer.", "maxLength": 5000, "nullable": true, "type": "string" }, "reference": { "description": "A string identifying this payment. Instruct your customer to include this code in the reference or memo field of their bank transfer.", "maxLength": 5000, "nullable": true, "type": "string" }, "type": { "description": "Type of bank transfer", "enum": [ "eu_bank_transfer", "gb_bank_transfer", "jp_bank_transfer", "mx_bank_transfer", "us_bank_transfer" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "amount_remaining", "currency", "hosted_instructions_url", "reference", "type" ], "title": "PaymentIntentNextActionDisplayBankTransferInstructions", "type": "object", "x-expandableFields": [ "financial_addresses" ], "x-stripeMostCommon": [ "amount_remaining", "currency", "financial_addresses", "hosted_instructions_url", "reference", "type" ], "x-stripeResource": { "class_name": "NextActionDisplayBankTransferInstructions", "in_package": "" } }, "payment_intent_next_action_display_multibanco_details": { "description": "", "properties": { "entity": { "description": "Entity number associated with this Multibanco payment.", "maxLength": 5000, "nullable": true, "type": "string" }, "expires_at": { "description": "The timestamp at which the Multibanco voucher expires.", "format": "unix-time", "nullable": true, "type": "integer" }, "hosted_voucher_url": { "description": "The URL for the hosted Multibanco voucher page, which allows customers to view a Multibanco voucher.", "maxLength": 5000, "nullable": true, "type": "string" }, "reference": { "description": "Reference number associated with this Multibanco payment.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "entity", "expires_at", "hosted_voucher_url", "reference" ], "title": "PaymentIntentNextActionDisplayMultibancoDetails", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "entity", "expires_at", "hosted_voucher_url", "reference" ], "x-stripeResource": { "class_name": "NextActionMultibancoDisplayDetails", "in_package": "" } }, "payment_intent_next_action_display_oxxo_details": { "description": "", "properties": { "expires_after": { "description": "The timestamp after which the OXXO voucher expires.", "format": "unix-time", "nullable": true, "type": "integer" }, "hosted_voucher_url": { "description": "The URL for the hosted OXXO voucher page, which allows customers to view and print an OXXO voucher.", "maxLength": 5000, "nullable": true, "type": "string" }, "number": { "description": "OXXO reference number.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "expires_after", "hosted_voucher_url", "number" ], "title": "PaymentIntentNextActionDisplayOxxoDetails", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "expires_after", "hosted_voucher_url", "number" ], "x-stripeResource": { "class_name": "NextActionOxxoDisplayDetails", "in_package": "" } }, "payment_intent_next_action_konbini": { "description": "", "properties": { "expires_at": { "description": "The timestamp at which the pending Konbini payment expires.", "format": "unix-time", "type": "integer" }, "hosted_voucher_url": { "description": "The URL for the Konbini payment instructions page, which allows customers to view and print a Konbini voucher.", "maxLength": 5000, "nullable": true, "type": "string" }, "stores": { "$ref": "#/components/schemas/payment_intent_next_action_konbini_stores" } }, "required": [ "expires_at", "hosted_voucher_url", "stores" ], "title": "payment_intent_next_action_konbini", "type": "object", "x-expandableFields": [ "stores" ], "x-stripeMostCommon": [ "expires_at", "hosted_voucher_url", "stores" ], "x-stripeResource": { "class_name": "NextActionKonbiniDisplayDetails", "in_package": "" } }, "payment_intent_next_action_konbini_familymart": { "description": "", "properties": { "confirmation_number": { "description": "The confirmation number.", "maxLength": 5000, "type": "string" }, "payment_code": { "description": "The payment code.", "maxLength": 5000, "type": "string" } }, "required": [ "payment_code" ], "title": "payment_intent_next_action_konbini_familymart", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "confirmation_number", "payment_code" ], "x-stripeResource": { "class_name": "Familymart", "in_package": "" } }, "payment_intent_next_action_konbini_lawson": { "description": "", "properties": { "confirmation_number": { "description": "The confirmation number.", "maxLength": 5000, "type": "string" }, "payment_code": { "description": "The payment code.", "maxLength": 5000, "type": "string" } }, "required": [ "payment_code" ], "title": "payment_intent_next_action_konbini_lawson", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "confirmation_number", "payment_code" ], "x-stripeResource": { "class_name": "Lawson", "in_package": "" } }, "payment_intent_next_action_konbini_ministop": { "description": "", "properties": { "confirmation_number": { "description": "The confirmation number.", "maxLength": 5000, "type": "string" }, "payment_code": { "description": "The payment code.", "maxLength": 5000, "type": "string" } }, "required": [ "payment_code" ], "title": "payment_intent_next_action_konbini_ministop", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "confirmation_number", "payment_code" ], "x-stripeResource": { "class_name": "Ministop", "in_package": "" } }, "payment_intent_next_action_konbini_seicomart": { "description": "", "properties": { "confirmation_number": { "description": "The confirmation number.", "maxLength": 5000, "type": "string" }, "payment_code": { "description": "The payment code.", "maxLength": 5000, "type": "string" } }, "required": [ "payment_code" ], "title": "payment_intent_next_action_konbini_seicomart", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "confirmation_number", "payment_code" ], "x-stripeResource": { "class_name": "Seicomart", "in_package": "" } }, "payment_intent_next_action_konbini_stores": { "description": "", "properties": { "familymart": { "anyOf": [ { "$ref": "#/components/schemas/payment_intent_next_action_konbini_familymart" } ], "description": "FamilyMart instruction details.", "nullable": true }, "lawson": { "anyOf": [ { "$ref": "#/components/schemas/payment_intent_next_action_konbini_lawson" } ], "description": "Lawson instruction details.", "nullable": true }, "ministop": { "anyOf": [ { "$ref": "#/components/schemas/payment_intent_next_action_konbini_ministop" } ], "description": "Ministop instruction details.", "nullable": true }, "seicomart": { "anyOf": [ { "$ref": "#/components/schemas/payment_intent_next_action_konbini_seicomart" } ], "description": "Seicomart instruction details.", "nullable": true } }, "required": [ "familymart", "lawson", "ministop", "seicomart" ], "title": "payment_intent_next_action_konbini_stores", "type": "object", "x-expandableFields": [ "familymart", "lawson", "ministop", "seicomart" ], "x-stripeMostCommon": [ "familymart", "lawson", "ministop", "seicomart" ], "x-stripeResource": { "class_name": "Stores", "in_package": "" } }, "payment_intent_next_action_paynow_display_qr_code": { "description": "", "properties": { "data": { "description": "The raw data string used to generate QR code, it should be used together with QR code library.", "maxLength": 5000, "type": "string" }, "hosted_instructions_url": { "description": "The URL to the hosted PayNow instructions page, which allows customers to view the PayNow QR code.", "maxLength": 5000, "nullable": true, "type": "string" }, "image_url_png": { "description": "The image_url_png string used to render QR code", "maxLength": 5000, "type": "string" }, "image_url_svg": { "description": "The image_url_svg string used to render QR code", "maxLength": 5000, "type": "string" } }, "required": [ "data", "hosted_instructions_url", "image_url_png", "image_url_svg" ], "title": "PaymentIntentNextActionPaynowDisplayQrCode", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "data", "hosted_instructions_url", "image_url_png", "image_url_svg" ], "x-stripeResource": { "class_name": "PaynowDisplayQrCode", "in_package": "" } }, "payment_intent_next_action_pix_display_qr_code": { "description": "", "properties": { "data": { "description": "The raw data string used to generate QR code, it should be used together with QR code library.", "maxLength": 5000, "type": "string" }, "expires_at": { "description": "The date (unix timestamp) when the PIX expires.", "type": "integer" }, "hosted_instructions_url": { "description": "The URL to the hosted pix instructions page, which allows customers to view the pix QR code.", "maxLength": 5000, "type": "string" }, "image_url_png": { "description": "The image_url_png string used to render png QR code", "maxLength": 5000, "type": "string" }, "image_url_svg": { "description": "The image_url_svg string used to render svg QR code", "maxLength": 5000, "type": "string" } }, "title": "PaymentIntentNextActionPixDisplayQrCode", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "data", "expires_at", "hosted_instructions_url", "image_url_png", "image_url_svg" ], "x-stripeResource": { "class_name": "PixDisplayQrCode", "in_package": "" } }, "payment_intent_next_action_promptpay_display_qr_code": { "description": "", "properties": { "data": { "description": "The raw data string used to generate QR code, it should be used together with QR code library.", "maxLength": 5000, "type": "string" }, "hosted_instructions_url": { "description": "The URL to the hosted PromptPay instructions page, which allows customers to view the PromptPay QR code.", "maxLength": 5000, "type": "string" }, "image_url_png": { "description": "The PNG path used to render the QR code, can be used as the source in an HTML img tag", "maxLength": 5000, "type": "string" }, "image_url_svg": { "description": "The SVG path used to render the QR code, can be used as the source in an HTML img tag", "maxLength": 5000, "type": "string" } }, "required": [ "data", "hosted_instructions_url", "image_url_png", "image_url_svg" ], "title": "PaymentIntentNextActionPromptpayDisplayQrCode", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "data", "hosted_instructions_url", "image_url_png", "image_url_svg" ], "x-stripeResource": { "class_name": "PromptpayDisplayQrCode", "in_package": "" } }, "payment_intent_next_action_redirect_to_url": { "description": "", "properties": { "return_url": { "description": "If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion.", "maxLength": 5000, "nullable": true, "type": "string" }, "url": { "description": "The URL you must redirect your customer to in order to authenticate the payment.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "return_url", "url" ], "title": "PaymentIntentNextActionRedirectToUrl", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "return_url", "url" ], "x-stripeResource": { "class_name": "NextActionRedirectToUrl", "in_package": "" } }, "payment_intent_next_action_swish_handle_redirect_or_display_qr_code": { "description": "", "properties": { "hosted_instructions_url": { "description": "The URL to the hosted Swish instructions page, which allows customers to view the QR code.", "maxLength": 5000, "type": "string" }, "mobile_auth_url": { "description": "The url for mobile redirect based auth (for internal use only and not typically available in standard API requests).", "maxLength": 5000, "type": "string" }, "qr_code": { "$ref": "#/components/schemas/payment_intent_next_action_swish_qr_code" } }, "required": [ "hosted_instructions_url", "mobile_auth_url", "qr_code" ], "title": "PaymentIntentNextActionSwishHandleRedirectOrDisplayQrCode", "type": "object", "x-expandableFields": [ "qr_code" ], "x-stripeMostCommon": [ "hosted_instructions_url", "mobile_auth_url", "qr_code" ], "x-stripeResource": { "class_name": "SwishHandleRedirectOrDisplayQrCode", "in_package": "" } }, "payment_intent_next_action_swish_qr_code": { "description": "", "properties": { "data": { "description": "The raw data string used to generate QR code, it should be used together with QR code library.", "maxLength": 5000, "type": "string" }, "image_url_png": { "description": "The image_url_png string used to render QR code", "maxLength": 5000, "type": "string" }, "image_url_svg": { "description": "The image_url_svg string used to render QR code", "maxLength": 5000, "type": "string" } }, "required": [ "data", "image_url_png", "image_url_svg" ], "title": "PaymentIntentNextActionSwishQRCode", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "data", "image_url_png", "image_url_svg" ], "x-stripeResource": { "class_name": "SwishQrCode", "in_package": "" } }, "payment_intent_next_action_verify_with_microdeposits": { "description": "", "properties": { "arrival_date": { "description": "The timestamp when the microdeposits are expected to land.", "format": "unix-time", "type": "integer" }, "hosted_verification_url": { "description": "The URL for the hosted verification page, which allows customers to verify their bank account.", "maxLength": 5000, "type": "string" }, "microdeposit_type": { "description": "The type of the microdeposit sent to the customer. Used to distinguish between different verification methods.", "enum": [ "amounts", "descriptor_code" ], "nullable": true, "type": "string" } }, "required": [ "arrival_date", "hosted_verification_url", "microdeposit_type" ], "title": "PaymentIntentNextActionVerifyWithMicrodeposits", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "arrival_date", "hosted_verification_url", "microdeposit_type" ] }, "payment_intent_next_action_wechat_pay_display_qr_code": { "description": "", "properties": { "data": { "description": "The data being used to generate QR code", "maxLength": 5000, "type": "string" }, "hosted_instructions_url": { "description": "The URL to the hosted WeChat Pay instructions page, which allows customers to view the WeChat Pay QR code.", "maxLength": 5000, "type": "string" }, "image_data_url": { "description": "The base64 image data for a pre-generated QR code", "maxLength": 5000, "type": "string" }, "image_url_png": { "description": "The image_url_png string used to render QR code", "maxLength": 5000, "type": "string" }, "image_url_svg": { "description": "The image_url_svg string used to render QR code", "maxLength": 5000, "type": "string" } }, "required": [ "data", "hosted_instructions_url", "image_data_url", "image_url_png", "image_url_svg" ], "title": "PaymentIntentNextActionWechatPayDisplayQrCode", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "data", "hosted_instructions_url", "image_data_url", "image_url_png", "image_url_svg" ], "x-stripeResource": { "class_name": "WechatPayDisplayQrCode", "in_package": "" } }, "payment_intent_next_action_wechat_pay_redirect_to_android_app": { "description": "", "properties": { "app_id": { "description": "app_id is the APP ID registered on WeChat open platform", "maxLength": 5000, "type": "string" }, "nonce_str": { "description": "nonce_str is a random string", "maxLength": 5000, "type": "string" }, "package": { "description": "package is static value", "maxLength": 5000, "type": "string" }, "partner_id": { "description": "an unique merchant ID assigned by WeChat Pay", "maxLength": 5000, "type": "string" }, "prepay_id": { "description": "an unique trading ID assigned by WeChat Pay", "maxLength": 5000, "type": "string" }, "sign": { "description": "A signature", "maxLength": 5000, "type": "string" }, "timestamp": { "description": "Specifies the current time in epoch format", "maxLength": 5000, "type": "string" } }, "required": [ "app_id", "nonce_str", "package", "partner_id", "prepay_id", "sign", "timestamp" ], "title": "PaymentIntentNextActionWechatPayRedirectToAndroidApp", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "app_id", "nonce_str", "package", "partner_id", "prepay_id", "sign", "timestamp" ], "x-stripeResource": { "class_name": "WechatPayRedirectToAndroidApp", "in_package": "" } }, "payment_intent_next_action_wechat_pay_redirect_to_ios_app": { "description": "", "properties": { "native_url": { "description": "An universal link that redirect to WeChat Pay app", "maxLength": 5000, "type": "string" } }, "required": [ "native_url" ], "title": "PaymentIntentNextActionWechatPayRedirectToIOSApp", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "native_url" ], "x-stripeResource": { "class_name": "WechatPayRedirectToIosApp", "in_package": "" } }, "payment_intent_payment_method_options": { "description": "", "properties": { "acss_debit": { "$ref": "#/components/schemas/payment_intent_payment_method_options_acss_debit" }, "affirm": { "$ref": "#/components/schemas/payment_method_options_affirm" }, "afterpay_clearpay": { "$ref": "#/components/schemas/payment_method_options_afterpay_clearpay" }, "alipay": { "$ref": "#/components/schemas/payment_method_options_alipay" }, "alma": { "$ref": "#/components/schemas/payment_method_options_alma" }, "amazon_pay": { "$ref": "#/components/schemas/payment_method_options_amazon_pay" }, "au_becs_debit": { "$ref": "#/components/schemas/payment_intent_payment_method_options_au_becs_debit" }, "bacs_debit": { "$ref": "#/components/schemas/payment_intent_payment_method_options_bacs_debit" }, "bancontact": { "$ref": "#/components/schemas/payment_method_options_bancontact" }, "billie": { "$ref": "#/components/schemas/payment_method_options_billie" }, "blik": { "$ref": "#/components/schemas/payment_intent_payment_method_options_blik" }, "boleto": { "$ref": "#/components/schemas/payment_method_options_boleto" }, "card": { "$ref": "#/components/schemas/payment_intent_payment_method_options_card" }, "card_present": { "$ref": "#/components/schemas/payment_method_options_card_present" }, "cashapp": { "$ref": "#/components/schemas/payment_method_options_cashapp" }, "crypto": { "$ref": "#/components/schemas/payment_method_options_crypto" }, "customer_balance": { "$ref": "#/components/schemas/payment_method_options_customer_balance" }, "eps": { "$ref": "#/components/schemas/payment_intent_payment_method_options_eps" }, "fpx": { "$ref": "#/components/schemas/payment_method_options_fpx" }, "giropay": { "$ref": "#/components/schemas/payment_method_options_giropay" }, "gopay": { "$ref": "#/components/schemas/payment_method_options_gopay" }, "grabpay": { "$ref": "#/components/schemas/payment_method_options_grabpay" }, "id_bank_transfer": { "$ref": "#/components/schemas/payment_method_options_id_bank_transfer" }, "ideal": { "$ref": "#/components/schemas/payment_method_options_ideal" }, "interac_present": { "$ref": "#/components/schemas/payment_method_options_interac_present" }, "kakao_pay": { "$ref": "#/components/schemas/payment_flows_private_payment_methods_kakao_pay_payment_method_options" }, "klarna": { "$ref": "#/components/schemas/payment_method_options_klarna" }, "konbini": { "$ref": "#/components/schemas/payment_method_options_konbini" }, "kr_card": { "$ref": "#/components/schemas/payment_method_options_kr_card" }, "link": { "$ref": "#/components/schemas/payment_intent_payment_method_options_link" }, "mb_way": { "$ref": "#/components/schemas/payment_method_options_mb_way" }, "mobilepay": { "$ref": "#/components/schemas/payment_intent_payment_method_options_mobilepay" }, "multibanco": { "$ref": "#/components/schemas/payment_method_options_multibanco" }, "naver_pay": { "$ref": "#/components/schemas/payment_flows_private_payment_methods_naver_pay_payment_method_options" }, "nz_bank_account": { "$ref": "#/components/schemas/payment_intent_payment_method_options_nz_bank_account" }, "oxxo": { "$ref": "#/components/schemas/payment_method_options_oxxo" }, "p24": { "$ref": "#/components/schemas/payment_method_options_p24" }, "pay_by_bank": { "$ref": "#/components/schemas/payment_method_options_pay_by_bank" }, "payco": { "$ref": "#/components/schemas/payment_flows_private_payment_methods_payco_payment_method_options" }, "paynow": { "$ref": "#/components/schemas/payment_method_options_paynow" }, "paypal": { "$ref": "#/components/schemas/payment_method_options_paypal" }, "paypay": { "$ref": "#/components/schemas/payment_method_options_paypay" }, "payto": { "$ref": "#/components/schemas/payment_intent_payment_method_options_payto" }, "pix": { "$ref": "#/components/schemas/payment_method_options_pix" }, "promptpay": { "$ref": "#/components/schemas/payment_method_options_promptpay" }, "qris": { "$ref": "#/components/schemas/payment_method_options_qris" }, "rechnung": { "$ref": "#/components/schemas/payment_intent_payment_method_options_rechnung" }, "revolut_pay": { "$ref": "#/components/schemas/payment_method_options_revolut_pay" }, "samsung_pay": { "$ref": "#/components/schemas/payment_flows_private_payment_methods_samsung_pay_payment_method_options" }, "satispay": { "$ref": "#/components/schemas/payment_method_options_satispay" }, "sepa_debit": { "$ref": "#/components/schemas/payment_intent_payment_method_options_sepa_debit" }, "shopeepay": { "$ref": "#/components/schemas/payment_method_options_shopeepay" }, "sofort": { "$ref": "#/components/schemas/payment_method_options_sofort" }, "stripe_balance": { "$ref": "#/components/schemas/payment_intent_payment_method_options_stripe_balance" }, "swish": { "$ref": "#/components/schemas/payment_intent_payment_method_options_swish" }, "twint": { "$ref": "#/components/schemas/payment_method_options_twint" }, "us_bank_account": { "$ref": "#/components/schemas/payment_intent_payment_method_options_us_bank_account" }, "wechat_pay": { "$ref": "#/components/schemas/payment_method_options_wechat_pay" }, "zip": { "$ref": "#/components/schemas/payment_method_options_zip" } }, "title": "PaymentIntentPaymentMethodOptions", "type": "object", "x-expandableFields": [ "acss_debit", "affirm", "afterpay_clearpay", "alipay", "alma", "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", "billie", "blik", "boleto", "card", "card_present", "cashapp", "crypto", "customer_balance", "eps", "fpx", "giropay", "gopay", "grabpay", "id_bank_transfer", "ideal", "interac_present", "kakao_pay", "klarna", "konbini", "kr_card", "link", "mb_way", "mobilepay", "multibanco", "naver_pay", "nz_bank_account", "oxxo", "p24", "pay_by_bank", "payco", "paynow", "paypal", "paypay", "payto", "pix", "promptpay", "qris", "rechnung", "revolut_pay", "samsung_pay", "satispay", "sepa_debit", "shopeepay", "sofort", "stripe_balance", "swish", "twint", "us_bank_account", "wechat_pay", "zip" ], "x-stripeMostCommon": [ "acss_debit", "affirm", "afterpay_clearpay", "alipay", "alma", "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", "billie", "blik", "boleto", "card", "card_present", "cashapp", "crypto", "customer_balance", "eps", "fpx", "giropay", "gopay", "grabpay", "id_bank_transfer", "ideal", "interac_present", "kakao_pay", "klarna", "konbini", "kr_card", "link", "mb_way", "mobilepay", "multibanco", "naver_pay", "nz_bank_account", "oxxo", "p24", "pay_by_bank", "payco", "paynow", "paypal", "paypay", "payto", "pix", "promptpay", "qris", "rechnung", "revolut_pay", "samsung_pay", "satispay", "sepa_debit", "shopeepay", "sofort", "stripe_balance", "swish", "twint", "us_bank_account", "wechat_pay", "zip" ] }, "payment_intent_payment_method_options_acss_debit": { "description": "", "properties": { "mandate_options": { "$ref": "#/components/schemas/payment_intent_payment_method_options_mandate_options_acss_debit" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none", "off_session", "on_session" ], "type": "string" }, "target_date": { "description": "Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.", "maxLength": 5000, "type": "string" }, "verification_method": { "description": "Bank account verification method.", "enum": [ "automatic", "instant", "microdeposits" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "payment_intent_payment_method_options_acss_debit", "type": "object", "x-expandableFields": [ "mandate_options" ], "x-stripeMostCommon": [ "mandate_options", "setup_future_usage", "target_date", "verification_method" ] }, "payment_intent_payment_method_options_au_becs_debit": { "description": "", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none", "off_session", "on_session" ], "type": "string" }, "target_date": { "description": "Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.", "maxLength": 5000, "type": "string" } }, "title": "payment_intent_payment_method_options_au_becs_debit", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "setup_future_usage", "target_date" ] }, "payment_intent_payment_method_options_bacs_debit": { "description": "", "properties": { "mandate_options": { "$ref": "#/components/schemas/payment_intent_payment_method_options_mandate_options_bacs_debit" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none", "off_session", "on_session" ], "type": "string" }, "target_date": { "description": "Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.", "maxLength": 5000, "type": "string" } }, "title": "payment_intent_payment_method_options_bacs_debit", "type": "object", "x-expandableFields": [ "mandate_options" ], "x-stripeMostCommon": [ "mandate_options", "setup_future_usage", "target_date" ] }, "payment_intent_payment_method_options_blik": { "description": "", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "payment_intent_payment_method_options_blik", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "setup_future_usage" ] }, "payment_intent_payment_method_options_card": { "description": "", "properties": { "capture_method": { "description": "Controls when the funds will be captured from the customer's account.", "enum": [ "manual" ], "type": "string", "x-stripeBypassValidation": true }, "installments": { "anyOf": [ { "$ref": "#/components/schemas/payment_method_options_card_installments" } ], "description": "Installment details for this payment.\n\nFor more information, see the [installments integration guide](https://stripe.com/docs/payments/installments).", "nullable": true }, "mandate_options": { "anyOf": [ { "$ref": "#/components/schemas/payment_method_options_card_mandate_options" } ], "description": "Configuration options for setting up an eMandate for cards issued in India.", "nullable": true }, "network": { "description": "Selected network to process this payment intent on. Depends on the available networks of the card attached to the payment intent. Can be only set confirm-time.", "enum": [ "amex", "cartes_bancaires", "diners", "discover", "eftpos_au", "girocard", "interac", "jcb", "link", "mastercard", "unionpay", "unknown", "visa" ], "nullable": true, "type": "string" }, "request_decremental_authorization": { "description": "Request ability to [decrement the authorization](https://stripe.com/docs/payments/decremental-authorization) for this PaymentIntent.", "enum": [ "if_available", "never" ], "type": "string" }, "request_extended_authorization": { "description": "Request ability to [capture beyond the standard authorization validity window](https://stripe.com/docs/payments/extended-authorization) for this PaymentIntent.", "enum": [ "if_available", "never" ], "type": "string" }, "request_incremental_authorization": { "description": "Request ability to [increment the authorization](https://stripe.com/docs/payments/incremental-authorization) for this PaymentIntent.", "enum": [ "if_available", "never" ], "type": "string" }, "request_multicapture": { "description": "Request ability to make [multiple captures](https://stripe.com/docs/payments/multicapture) for this PaymentIntent.", "enum": [ "if_available", "never" ], "type": "string" }, "request_overcapture": { "description": "Request ability to [overcapture](https://stripe.com/docs/payments/overcapture) for this PaymentIntent.", "enum": [ "if_available", "never" ], "type": "string" }, "request_partial_authorization": { "description": "Request partial authorization on this PaymentIntent.", "enum": [ "if_available", "never" ], "type": "string" }, "request_three_d_secure": { "description": "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.", "enum": [ "any", "automatic", "challenge" ], "nullable": true, "type": "string", "x-stripeBypassValidation": true }, "require_cvc_recollection": { "description": "When enabled, using a card that is attached to a customer will require the CVC to be provided again (i.e. using the cvc_token parameter).", "type": "boolean" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none", "off_session", "on_session" ], "type": "string" }, "statement_descriptor_suffix_kana": { "description": "Provides information about a card payment that customers see on their statements. Concatenated with the Kana prefix (shortened Kana descriptor) or Kana statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 22 characters.", "maxLength": 5000, "type": "string" }, "statement_descriptor_suffix_kanji": { "description": "Provides information about a card payment that customers see on their statements. Concatenated with the Kanji prefix (shortened Kanji descriptor) or Kanji statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 17 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 17 characters.", "maxLength": 5000, "type": "string" }, "statement_details": { "$ref": "#/components/schemas/payment_flows_private_payment_methods_card_options_statement_details" } }, "required": [ "installments", "mandate_options", "network", "request_three_d_secure" ], "title": "payment_intent_payment_method_options_card", "type": "object", "x-expandableFields": [ "installments", "mandate_options", "statement_details" ], "x-stripeMostCommon": [ "capture_method", "installments", "mandate_options", "network", "request_decremental_authorization", "request_extended_authorization", "request_incremental_authorization", "request_multicapture", "request_overcapture", "request_partial_authorization", "request_three_d_secure", "require_cvc_recollection", "setup_future_usage", "statement_descriptor_suffix_kana", "statement_descriptor_suffix_kanji", "statement_details" ] }, "payment_intent_payment_method_options_eps": { "description": "", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string" } }, "title": "payment_intent_payment_method_options_eps", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "setup_future_usage" ] }, "payment_intent_payment_method_options_link": { "description": "", "properties": { "capture_method": { "description": "Controls when the funds will be captured from the customer's account.", "enum": [ "manual" ], "type": "string" }, "persistent_token": { "description": "[Deprecated] This is a legacy parameter that no longer has any function.", "maxLength": 5000, "nullable": true, "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none", "off_session" ], "type": "string" } }, "required": [ "persistent_token" ], "title": "payment_intent_payment_method_options_link", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "capture_method", "persistent_token", "setup_future_usage" ] }, "payment_intent_payment_method_options_mandate_options_acss_debit": { "description": "", "properties": { "custom_mandate_url": { "description": "A URL for custom mandate text", "maxLength": 5000, "type": "string" }, "interval_description": { "description": "Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'.", "maxLength": 5000, "nullable": true, "type": "string" }, "payment_schedule": { "description": "Payment schedule for the mandate.", "enum": [ "combined", "interval", "sporadic" ], "nullable": true, "type": "string" }, "transaction_type": { "description": "Transaction type of the mandate.", "enum": [ "business", "personal" ], "nullable": true, "type": "string" } }, "required": [ "interval_description", "payment_schedule", "transaction_type" ], "title": "payment_intent_payment_method_options_mandate_options_acss_debit", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "custom_mandate_url", "interval_description", "payment_schedule", "transaction_type" ] }, "payment_intent_payment_method_options_mandate_options_bacs_debit": { "description": "", "properties": { "reference_prefix": { "description": "Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'.", "maxLength": 5000, "type": "string" } }, "title": "payment_intent_payment_method_options_mandate_options_bacs_debit", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "reference_prefix" ], "x-stripeResource": { "class_name": "BacsDebitMandateOptions", "in_package": "" } }, "payment_intent_payment_method_options_mandate_options_payto": { "description": "", "properties": { "amount": { "description": "Amount that will be collected. It is required when `amount_type` is `fixed`.", "nullable": true, "type": "integer" }, "amount_type": { "description": "The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively.", "enum": [ "fixed", "maximum" ], "nullable": true, "type": "string" }, "end_date": { "description": "Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.", "maxLength": 5000, "nullable": true, "type": "string" }, "payment_schedule": { "description": "The periodicity at which payments will be collected.", "enum": [ "adhoc", "annual", "daily", "fortnightly", "monthly", "quarterly", "semi_annual", "weekly" ], "nullable": true, "type": "string" }, "payments_per_period": { "description": "The number of payments that will be made during a payment period. Defaults to 1 except for when `payment_schedule` is `adhoc`. In that case, it defaults to no limit.", "nullable": true, "type": "integer" }, "purpose": { "description": "The purpose for which payments are made. Defaults to retail.", "enum": [ "dependant_support", "government", "loan", "mortgage", "other", "pension", "personal", "retail", "salary", "tax", "utility" ], "nullable": true, "type": "string" } }, "required": [ "amount", "amount_type", "end_date", "payment_schedule", "payments_per_period", "purpose" ], "title": "payment_intent_payment_method_options_mandate_options_payto", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "amount", "amount_type", "end_date", "payment_schedule", "payments_per_period", "purpose" ] }, "payment_intent_payment_method_options_mandate_options_sepa_debit": { "description": "", "properties": { "reference_prefix": { "description": "Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'.", "maxLength": 5000, "type": "string" } }, "title": "payment_intent_payment_method_options_mandate_options_sepa_debit", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "reference_prefix" ], "x-stripeResource": { "class_name": "SepaDebitMandateOptions", "in_package": "" } }, "payment_intent_payment_method_options_mobilepay": { "description": "", "properties": { "capture_method": { "description": "Controls when the funds will be captured from the customer's account.", "enum": [ "manual" ], "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string" } }, "title": "payment_intent_payment_method_options_mobilepay", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "capture_method", "setup_future_usage" ] }, "payment_intent_payment_method_options_nz_bank_account": { "description": "", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none", "off_session", "on_session" ], "type": "string" }, "target_date": { "description": "Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.", "maxLength": 5000, "type": "string" } }, "title": "payment_intent_payment_method_options_nz_bank_account", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "setup_future_usage", "target_date" ] }, "payment_intent_payment_method_options_payto": { "description": "", "properties": { "mandate_options": { "$ref": "#/components/schemas/payment_intent_payment_method_options_mandate_options_payto" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none", "off_session" ], "type": "string" } }, "title": "payment_intent_payment_method_options_payto", "type": "object", "x-expandableFields": [ "mandate_options" ], "x-stripeMostCommon": [ "mandate_options", "setup_future_usage" ] }, "payment_intent_payment_method_options_rechnung": { "description": "", "properties": {}, "title": "payment_intent_payment_method_options_rechnung", "type": "object", "x-expandableFields": [] }, "payment_intent_payment_method_options_sepa_debit": { "description": "", "properties": { "mandate_options": { "$ref": "#/components/schemas/payment_intent_payment_method_options_mandate_options_sepa_debit" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none", "off_session", "on_session" ], "type": "string" }, "target_date": { "description": "Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.", "maxLength": 5000, "type": "string" } }, "title": "payment_intent_payment_method_options_sepa_debit", "type": "object", "x-expandableFields": [ "mandate_options" ], "x-stripeMostCommon": [ "mandate_options", "setup_future_usage", "target_date" ] }, "payment_intent_payment_method_options_stripe_balance": { "description": "", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none", "off_session" ], "type": "string" } }, "title": "payment_intent_payment_method_options_stripe_balance", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "setup_future_usage" ] }, "payment_intent_payment_method_options_swish": { "description": "", "properties": { "reference": { "description": "A reference for this payment to be displayed in the Swish app.", "maxLength": 35, "nullable": true, "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string" } }, "required": [ "reference" ], "title": "payment_intent_payment_method_options_swish", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "reference", "setup_future_usage" ] }, "payment_intent_payment_method_options_us_bank_account": { "description": "", "properties": { "financial_connections": { "$ref": "#/components/schemas/linked_account_options_common" }, "mandate_options": { "$ref": "#/components/schemas/payment_method_options_us_bank_account_mandate_options" }, "preferred_settlement_speed": { "description": "Preferred transaction settlement speed", "enum": [ "fastest", "standard" ], "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none", "off_session", "on_session" ], "type": "string" }, "target_date": { "description": "Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.", "maxLength": 5000, "type": "string" }, "verification_method": { "description": "Bank account verification method.", "enum": [ "automatic", "instant", "microdeposits" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "payment_intent_payment_method_options_us_bank_account", "type": "object", "x-expandableFields": [ "financial_connections", "mandate_options" ], "x-stripeMostCommon": [ "financial_connections", "mandate_options", "preferred_settlement_speed", "setup_future_usage", "target_date", "verification_method" ] }, "payment_intent_processing": { "description": "", "properties": { "card": { "$ref": "#/components/schemas/payment_intent_card_processing" }, "type": { "description": "Type of the payment method for which payment is in `processing` state, one of `card`.", "enum": [ "card" ], "type": "string" } }, "required": [ "type" ], "title": "PaymentIntentProcessing", "type": "object", "x-expandableFields": [ "card" ], "x-stripeMostCommon": [ "card", "type" ] }, "payment_intent_processing_customer_notification": { "description": "", "properties": { "approval_requested": { "description": "Whether customer approval has been requested for this payment. For payments greater than INR 15000 or mandate amount, the customer must provide explicit approval of the payment with their bank.", "nullable": true, "type": "boolean" }, "completes_at": { "description": "If customer approval is required, they need to provide approval before this time.", "format": "unix-time", "nullable": true, "type": "integer" } }, "required": [ "approval_requested", "completes_at" ], "title": "PaymentIntentProcessingCustomerNotification", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "approval_requested", "completes_at" ], "x-stripeResource": { "class_name": "CustomerNotification", "in_package": "" } }, "payment_intent_type_specific_payment_method_options_client": { "description": "", "properties": { "capture_method": { "description": "Controls when the funds will be captured from the customer's account.", "enum": [ "manual", "manual_preferred" ], "type": "string" }, "installments": { "$ref": "#/components/schemas/payment_flows_installment_options" }, "request_incremental_authorization_support": { "description": "Request ability to [increment](https://stripe.com/docs/terminal/features/incremental-authorizations) this PaymentIntent if the combination of MCC and card brand is eligible. Check [incremental_authorization_supported](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported) in the [Confirm](https://stripe.com/docs/api/payment_intents/confirm) response to verify support.", "type": "boolean" }, "require_cvc_recollection": { "description": "When enabled, using a card that is attached to a customer will require the CVC to be provided again (i.e. using the cvc_token parameter).", "type": "boolean" }, "routing": { "$ref": "#/components/schemas/payment_method_options_card_present_routing" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none", "off_session", "on_session" ], "type": "string" }, "verification_method": { "description": "Bank account verification method.", "enum": [ "automatic", "instant", "microdeposits" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "PaymentIntentTypeSpecificPaymentMethodOptionsClient", "type": "object", "x-expandableFields": [ "installments", "routing" ], "x-stripeMostCommon": [ "capture_method", "installments", "request_incremental_authorization_support", "require_cvc_recollection", "routing", "setup_future_usage", "verification_method" ] }, "payment_link": { "description": "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.\n\nWhen a customer opens a payment link it will open a new [checkout session](https://stripe.com/docs/api/checkout/sessions) to render the payment page. You can use [checkout session events](https://stripe.com/docs/api/events/types#event_types-checkout.session.completed) to track payments through payment links.\n\nRelated guide: [Payment Links API](https://stripe.com/docs/payment-links)", "properties": { "active": { "description": "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.", "type": "boolean" }, "after_completion": { "$ref": "#/components/schemas/payment_links_resource_after_completion" }, "allow_promotion_codes": { "description": "Whether user redeemable promotion codes are enabled.", "type": "boolean" }, "application": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/application" }, { "$ref": "#/components/schemas/deleted_application" } ], "description": "The ID of the Connect application that created the Payment Link.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/application" }, { "$ref": "#/components/schemas/deleted_application" } ] } }, "application_fee_amount": { "description": "The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account.", "nullable": true, "type": "integer" }, "application_fee_percent": { "description": "This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account.", "nullable": true, "type": "number" }, "automatic_tax": { "$ref": "#/components/schemas/payment_links_resource_automatic_tax" }, "billing_address_collection": { "description": "Configuration for collecting the customer's billing address. Defaults to `auto`.", "enum": [ "auto", "required" ], "type": "string" }, "consent_collection": { "anyOf": [ { "$ref": "#/components/schemas/payment_links_resource_consent_collection" } ], "description": "When set, provides configuration to gather active consent from customers.", "nullable": true }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "custom_fields": { "description": "Collect additional information from your customer using custom fields. Up to 3 fields are supported.", "items": { "$ref": "#/components/schemas/payment_links_resource_custom_fields" }, "type": "array" }, "custom_text": { "$ref": "#/components/schemas/payment_links_resource_custom_text" }, "customer_creation": { "description": "Configuration for Customer creation during checkout.", "enum": [ "always", "if_required" ], "type": "string" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "inactive_message": { "description": "The custom message to be displayed to a customer when a payment link is no longer active.", "maxLength": 5000, "nullable": true, "type": "string" }, "invoice_creation": { "anyOf": [ { "$ref": "#/components/schemas/payment_links_resource_invoice_creation" } ], "description": "Configuration for creating invoice for payment mode payment links.", "nullable": true }, "line_items": { "description": "The line items representing what is being sold.", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/item" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "PaymentLinksResourceListLineItems", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "type": "object" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "payment_link" ], "type": "string" }, "on_behalf_of": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/account" } ], "description": "The account on behalf of which to charge. See the [Connect documentation](https://support.stripe.com/questions/sending-invoices-on-behalf-of-connected-accounts) for details.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/account" } ] } }, "optional_items": { "description": "The optional items presented to the customer at checkout.", "items": { "$ref": "#/components/schemas/payment_links_resource_optional_item" }, "nullable": true, "type": "array" }, "payment_intent_data": { "anyOf": [ { "$ref": "#/components/schemas/payment_links_resource_payment_intent_data" } ], "description": "Indicates the parameters to be passed to PaymentIntent creation during checkout.", "nullable": true }, "payment_method_collection": { "description": "Configuration for collecting a payment method during checkout. Defaults to `always`.", "enum": [ "always", "if_required" ], "type": "string" }, "payment_method_types": { "description": "The list of payment method types that customers can use. When `null`, Stripe will dynamically show relevant payment methods you've enabled in your [payment method settings](https://dashboard.stripe.com/settings/payment_methods).", "items": { "enum": [ "affirm", "afterpay_clearpay", "alipay", "alma", "au_becs_debit", "bacs_debit", "bancontact", "billie", "blik", "boleto", "card", "cashapp", "eps", "fpx", "giropay", "gopay", "grabpay", "ideal", "klarna", "konbini", "link", "mb_way", "mobilepay", "multibanco", "oxxo", "p24", "pay_by_bank", "paynow", "paypal", "paypay", "payto", "pix", "promptpay", "qris", "rechnung", "satispay", "sepa_debit", "shopeepay", "sofort", "swish", "twint", "us_bank_account", "wechat_pay", "zip" ], "type": "string", "x-stripeBypassValidation": true }, "nullable": true, "type": "array" }, "phone_number_collection": { "$ref": "#/components/schemas/payment_links_resource_phone_number_collection" }, "restrictions": { "anyOf": [ { "$ref": "#/components/schemas/payment_links_resource_restrictions" } ], "description": "Settings that restrict the usage of a payment link.", "nullable": true }, "shipping_address_collection": { "anyOf": [ { "$ref": "#/components/schemas/payment_links_resource_shipping_address_collection" } ], "description": "Configuration for collecting the customer's shipping address.", "nullable": true }, "shipping_options": { "description": "The shipping rate options applied to the session.", "items": { "$ref": "#/components/schemas/payment_links_resource_shipping_option" }, "type": "array" }, "submit_type": { "description": "Indicates the type of transaction being performed which customizes relevant text on the page, such as the submit button.", "enum": [ "auto", "book", "donate", "pay", "subscribe" ], "type": "string" }, "subscription_data": { "anyOf": [ { "$ref": "#/components/schemas/payment_links_resource_subscription_data" } ], "description": "When creating a subscription, the specified configuration data will be used. There must be at least one line item with a recurring price to use `subscription_data`.", "nullable": true }, "tax_id_collection": { "$ref": "#/components/schemas/payment_links_resource_tax_id_collection" }, "transfer_data": { "anyOf": [ { "$ref": "#/components/schemas/payment_links_resource_transfer_data" } ], "description": "The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to.", "nullable": true }, "url": { "description": "The public URL that can be shared with customers.", "maxLength": 5000, "type": "string" } }, "required": [ "active", "after_completion", "allow_promotion_codes", "application", "application_fee_amount", "application_fee_percent", "automatic_tax", "billing_address_collection", "consent_collection", "currency", "custom_fields", "custom_text", "customer_creation", "id", "inactive_message", "invoice_creation", "livemode", "metadata", "object", "on_behalf_of", "payment_intent_data", "payment_method_collection", "payment_method_types", "phone_number_collection", "restrictions", "shipping_address_collection", "shipping_options", "submit_type", "subscription_data", "tax_id_collection", "transfer_data", "url" ], "title": "PaymentLink", "type": "object", "x-expandableFields": [ "after_completion", "application", "automatic_tax", "consent_collection", "custom_fields", "custom_text", "invoice_creation", "line_items", "on_behalf_of", "optional_items", "payment_intent_data", "phone_number_collection", "restrictions", "shipping_address_collection", "shipping_options", "subscription_data", "tax_id_collection", "transfer_data" ], "x-resourceId": "payment_link", "x-stripeMostCommon": [ "active", "id", "line_items", "metadata", "url" ], "x-stripeOperations": [ { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/payment_links" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/payment_links/{payment_link}" }, { "method_name": "list_line_items", "method_on": "service", "method_type": "custom", "operation": "get", "path": "/v1/payment_links/{payment_link}/line_items" }, { "method_name": "create", "method_on": "service", "method_type": "create", "operation": "post", "path": "/v1/payment_links" }, { "method_name": "update", "method_on": "service", "method_type": "update", "operation": "post", "path": "/v1/payment_links/{payment_link}" } ], "x-stripeResource": { "class_name": "PaymentLink", "has_collection_class": true, "in_package": "" } }, "payment_link.created": { "description": "Occurs when a payment link is created.", "properties": { "object": { "$ref": "#/components/schemas/payment_link" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "payment_link.created" } }, "payment_link.updated": { "description": "Occurs when a payment link is updated.", "properties": { "object": { "$ref": "#/components/schemas/payment_link" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "payment_link.updated" } }, "payment_links_resource_after_completion": { "description": "", "properties": { "hosted_confirmation": { "$ref": "#/components/schemas/payment_links_resource_completion_behavior_confirmation_page" }, "redirect": { "$ref": "#/components/schemas/payment_links_resource_completion_behavior_redirect" }, "type": { "description": "The specified behavior after the purchase is complete.", "enum": [ "hosted_confirmation", "redirect" ], "type": "string" } }, "required": [ "type" ], "title": "PaymentLinksResourceAfterCompletion", "type": "object", "x-expandableFields": [ "hosted_confirmation", "redirect" ], "x-stripeMostCommon": [ "hosted_confirmation", "redirect", "type" ] }, "payment_links_resource_automatic_tax": { "description": "", "properties": { "enabled": { "description": "If `true`, tax will be calculated automatically using the customer's location.", "type": "boolean" }, "liability": { "anyOf": [ { "$ref": "#/components/schemas/connect_account_reference" } ], "description": "The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.", "nullable": true } }, "required": [ "enabled", "liability" ], "title": "PaymentLinksResourceAutomaticTax", "type": "object", "x-expandableFields": [ "liability" ], "x-stripeMostCommon": [ "enabled", "liability" ] }, "payment_links_resource_completed_sessions": { "description": "", "properties": { "count": { "description": "The current number of checkout sessions that have been completed on the payment link which count towards the `completed_sessions` restriction to be met.", "type": "integer" }, "limit": { "description": "The maximum number of checkout sessions that can be completed for the `completed_sessions` restriction to be met.", "type": "integer" } }, "required": [ "count", "limit" ], "title": "PaymentLinksResourceCompletedSessions", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "count", "limit" ] }, "payment_links_resource_completion_behavior_confirmation_page": { "description": "", "properties": { "custom_message": { "description": "The custom message that is displayed to the customer after the purchase is complete.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "custom_message" ], "title": "PaymentLinksResourceCompletionBehaviorConfirmationPage", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "custom_message" ] }, "payment_links_resource_completion_behavior_redirect": { "description": "", "properties": { "url": { "description": "The URL the customer will be redirected to after the purchase is complete.", "maxLength": 5000, "type": "string" } }, "required": [ "url" ], "title": "PaymentLinksResourceCompletionBehaviorRedirect", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "url" ] }, "payment_links_resource_consent_collection": { "description": "", "properties": { "payment_method_reuse_agreement": { "anyOf": [ { "$ref": "#/components/schemas/payment_links_resource_payment_method_reuse_agreement" } ], "description": "Settings related to the payment method reuse text shown in the Checkout UI.", "nullable": true }, "promotions": { "description": "If set to `auto`, enables the collection of customer consent for promotional communications.", "enum": [ "auto", "none" ], "nullable": true, "type": "string" }, "terms_of_service": { "description": "If set to `required`, it requires cutomers to accept the terms of service before being able to pay. If set to `none`, customers won't be shown a checkbox to accept the terms of service.", "enum": [ "none", "required" ], "nullable": true, "type": "string" } }, "required": [ "payment_method_reuse_agreement", "promotions", "terms_of_service" ], "title": "PaymentLinksResourceConsentCollection", "type": "object", "x-expandableFields": [ "payment_method_reuse_agreement" ], "x-stripeMostCommon": [ "payment_method_reuse_agreement", "promotions", "terms_of_service" ] }, "payment_links_resource_custom_fields": { "description": "", "properties": { "dropdown": { "$ref": "#/components/schemas/payment_links_resource_custom_fields_dropdown" }, "key": { "description": "String of your choice that your integration can use to reconcile this field. Must be unique to this field, alphanumeric, and up to 200 characters.", "maxLength": 5000, "type": "string" }, "label": { "$ref": "#/components/schemas/payment_links_resource_custom_fields_label" }, "numeric": { "$ref": "#/components/schemas/payment_links_resource_custom_fields_numeric" }, "optional": { "description": "Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`.", "type": "boolean" }, "text": { "$ref": "#/components/schemas/payment_links_resource_custom_fields_text" }, "type": { "description": "The type of the field.", "enum": [ "dropdown", "numeric", "text" ], "type": "string" } }, "required": [ "key", "label", "optional", "type" ], "title": "PaymentLinksResourceCustomFields", "type": "object", "x-expandableFields": [ "dropdown", "label", "numeric", "text" ], "x-stripeMostCommon": [ "dropdown", "key", "label", "numeric", "optional", "text", "type" ] }, "payment_links_resource_custom_fields_dropdown": { "description": "", "properties": { "default_value": { "description": "The value that will pre-fill on the payment page.", "maxLength": 5000, "nullable": true, "type": "string" }, "options": { "description": "The options available for the customer to select. Up to 200 options allowed.", "items": { "$ref": "#/components/schemas/payment_links_resource_custom_fields_dropdown_option" }, "type": "array" } }, "required": [ "default_value", "options" ], "title": "PaymentLinksResourceCustomFieldsDropdown", "type": "object", "x-expandableFields": [ "options" ], "x-stripeMostCommon": [ "default_value", "options" ] }, "payment_links_resource_custom_fields_dropdown_option": { "description": "", "properties": { "label": { "description": "The label for the option, displayed to the customer. Up to 100 characters.", "maxLength": 5000, "type": "string" }, "value": { "description": "The value for this option, not displayed to the customer, used by your integration to reconcile the option selected by the customer. Must be unique to this option, alphanumeric, and up to 100 characters.", "maxLength": 5000, "type": "string" } }, "required": [ "label", "value" ], "title": "PaymentLinksResourceCustomFieldsDropdownOption", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "label", "value" ], "x-stripeResource": { "class_name": "CustomFieldDropdownOption", "in_package": "" } }, "payment_links_resource_custom_fields_label": { "description": "", "properties": { "custom": { "description": "Custom text for the label, displayed to the customer. Up to 50 characters.", "maxLength": 5000, "nullable": true, "type": "string" }, "type": { "description": "The type of the label.", "enum": [ "custom" ], "type": "string" } }, "required": [ "custom", "type" ], "title": "PaymentLinksResourceCustomFieldsLabel", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "custom", "type" ] }, "payment_links_resource_custom_fields_numeric": { "description": "", "properties": { "default_value": { "description": "The value that will pre-fill the field on the payment page.", "maxLength": 5000, "nullable": true, "type": "string" }, "maximum_length": { "description": "The maximum character length constraint for the customer's input.", "nullable": true, "type": "integer" }, "minimum_length": { "description": "The minimum character length requirement for the customer's input.", "nullable": true, "type": "integer" } }, "required": [ "default_value", "maximum_length", "minimum_length" ], "title": "PaymentLinksResourceCustomFieldsNumeric", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "default_value", "maximum_length", "minimum_length" ] }, "payment_links_resource_custom_fields_text": { "description": "", "properties": { "default_value": { "description": "The value that will pre-fill the field on the payment page.", "maxLength": 5000, "nullable": true, "type": "string" }, "maximum_length": { "description": "The maximum character length constraint for the customer's input.", "nullable": true, "type": "integer" }, "minimum_length": { "description": "The minimum character length requirement for the customer's input.", "nullable": true, "type": "integer" } }, "required": [ "default_value", "maximum_length", "minimum_length" ], "title": "PaymentLinksResourceCustomFieldsText", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "default_value", "maximum_length", "minimum_length" ] }, "payment_links_resource_custom_text": { "description": "", "properties": { "after_submit": { "anyOf": [ { "$ref": "#/components/schemas/payment_links_resource_custom_text_position" } ], "description": "Custom text that should be displayed after the payment confirmation button.", "nullable": true }, "shipping_address": { "anyOf": [ { "$ref": "#/components/schemas/payment_links_resource_custom_text_position" } ], "description": "Custom text that should be displayed alongside shipping address collection.", "nullable": true }, "submit": { "anyOf": [ { "$ref": "#/components/schemas/payment_links_resource_custom_text_position" } ], "description": "Custom text that should be displayed alongside the payment confirmation button.", "nullable": true }, "terms_of_service_acceptance": { "anyOf": [ { "$ref": "#/components/schemas/payment_links_resource_custom_text_position" } ], "description": "Custom text that should be displayed in place of the default terms of service agreement text.", "nullable": true } }, "required": [ "after_submit", "shipping_address", "submit", "terms_of_service_acceptance" ], "title": "PaymentLinksResourceCustomText", "type": "object", "x-expandableFields": [ "after_submit", "shipping_address", "submit", "terms_of_service_acceptance" ], "x-stripeMostCommon": [ "after_submit", "shipping_address", "submit", "terms_of_service_acceptance" ] }, "payment_links_resource_custom_text_position": { "description": "", "properties": { "message": { "description": "Text may be up to 1200 characters in length.", "maxLength": 500, "type": "string" } }, "required": [ "message" ], "title": "PaymentLinksResourceCustomTextPosition", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "message" ] }, "payment_links_resource_invoice_creation": { "description": "", "properties": { "enabled": { "description": "Enable creating an invoice on successful payment.", "type": "boolean" }, "invoice_data": { "anyOf": [ { "$ref": "#/components/schemas/payment_links_resource_invoice_settings" } ], "description": "Configuration for the invoice. Default invoice values will be used if unspecified.", "nullable": true } }, "required": [ "enabled", "invoice_data" ], "title": "PaymentLinksResourceInvoiceCreation", "type": "object", "x-expandableFields": [ "invoice_data" ], "x-stripeMostCommon": [ "enabled", "invoice_data" ] }, "payment_links_resource_invoice_settings": { "description": "", "properties": { "account_tax_ids": { "description": "The account tax IDs associated with the invoice.", "items": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/tax_id" }, { "$ref": "#/components/schemas/deleted_tax_id" } ], "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/tax_id" }, { "$ref": "#/components/schemas/deleted_tax_id" } ] } }, "nullable": true, "type": "array" }, "custom_fields": { "description": "A list of up to 4 custom fields to be displayed on the invoice.", "items": { "$ref": "#/components/schemas/invoice_setting_custom_field" }, "nullable": true, "type": "array" }, "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users.", "maxLength": 5000, "nullable": true, "type": "string" }, "footer": { "description": "Footer to be displayed on the invoice.", "maxLength": 5000, "nullable": true, "type": "string" }, "issuer": { "anyOf": [ { "$ref": "#/components/schemas/connect_account_reference" } ], "description": "The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.", "nullable": true }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "nullable": true, "type": "object" }, "rendering_options": { "anyOf": [ { "$ref": "#/components/schemas/invoice_setting_checkout_rendering_options" } ], "description": "Options for invoice PDF rendering.", "nullable": true } }, "required": [ "account_tax_ids", "custom_fields", "description", "footer", "issuer", "metadata", "rendering_options" ], "title": "PaymentLinksResourceInvoiceSettings", "type": "object", "x-expandableFields": [ "account_tax_ids", "custom_fields", "issuer", "rendering_options" ], "x-stripeMostCommon": [ "account_tax_ids", "custom_fields", "description", "footer", "issuer", "metadata", "rendering_options" ] }, "payment_links_resource_optional_item": { "description": "", "properties": { "adjustable_quantity": { "anyOf": [ { "$ref": "#/components/schemas/payment_links_resource_optional_item_adjustable_quantity" } ], "nullable": true }, "price": { "maxLength": 5000, "type": "string" }, "quantity": { "type": "integer" } }, "required": [ "adjustable_quantity", "price", "quantity" ], "title": "PaymentLinksResourceOptionalItem", "type": "object", "x-expandableFields": [ "adjustable_quantity" ], "x-stripeMostCommon": [ "adjustable_quantity", "price", "quantity" ] }, "payment_links_resource_optional_item_adjustable_quantity": { "description": "", "properties": { "enabled": { "description": "Set to true if the quantity can be adjusted to any non-negative integer.", "type": "boolean" }, "maximum": { "description": "The maximum quantity of this item the customer can purchase. By default this value is 99.", "nullable": true, "type": "integer" }, "minimum": { "description": "The minimum quantity of this item the customer must purchase, if they choose to purchase it. Because this item is optional, the customer will always be able to remove it from their order, even if the `minimum` configured here is greater than 0. By default this value is 0.", "nullable": true, "type": "integer" } }, "required": [ "enabled", "maximum", "minimum" ], "title": "PaymentLinksResourceOptionalItemAdjustableQuantity", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "enabled", "maximum", "minimum" ] }, "payment_links_resource_payment_intent_data": { "description": "", "properties": { "capture_method": { "description": "Indicates when the funds will be captured from the customer's account.", "enum": [ "automatic", "automatic_async", "manual" ], "nullable": true, "type": "string" }, "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users.", "maxLength": 5000, "nullable": true, "type": "string" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will set metadata on [Payment Intents](https://stripe.com/docs/api/payment_intents) generated from this payment link.", "type": "object" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with the payment method collected during checkout.", "enum": [ "off_session", "on_session" ], "nullable": true, "type": "string" }, "statement_descriptor": { "description": "For a non-card payment, information about the charge that appears on the customer's statement when this payment succeeds in creating a charge.", "maxLength": 5000, "nullable": true, "type": "string" }, "statement_descriptor_suffix": { "description": "For a card payment, information about the charge that appears on the customer's statement when this payment succeeds in creating a charge. Concatenated with the account's statement descriptor prefix to form the complete statement descriptor.", "maxLength": 5000, "nullable": true, "type": "string" }, "transfer_group": { "description": "A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/connect/separate-charges-and-transfers) for details.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "capture_method", "description", "metadata", "setup_future_usage", "statement_descriptor", "statement_descriptor_suffix", "transfer_group" ], "title": "PaymentLinksResourcePaymentIntentData", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "capture_method", "description", "metadata", "setup_future_usage", "statement_descriptor", "statement_descriptor_suffix", "transfer_group" ] }, "payment_links_resource_payment_method_reuse_agreement": { "description": "", "properties": { "position": { "description": "Determines the position and visibility of the payment method reuse agreement in the UI. When set to `auto`, Stripe's defaults will be used.\n\nWhen set to `hidden`, the payment method reuse agreement text will always be hidden in the UI.", "enum": [ "auto", "hidden" ], "type": "string" } }, "required": [ "position" ], "title": "PaymentLinksResourcePaymentMethodReuseAgreement", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "position" ] }, "payment_links_resource_phone_number_collection": { "description": "", "properties": { "enabled": { "description": "If `true`, a phone number will be collected during checkout.", "type": "boolean" } }, "required": [ "enabled" ], "title": "PaymentLinksResourcePhoneNumberCollection", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "enabled" ] }, "payment_links_resource_restrictions": { "description": "", "properties": { "completed_sessions": { "$ref": "#/components/schemas/payment_links_resource_completed_sessions" } }, "required": [ "completed_sessions" ], "title": "PaymentLinksResourceRestrictions", "type": "object", "x-expandableFields": [ "completed_sessions" ], "x-stripeMostCommon": [ "completed_sessions" ] }, "payment_links_resource_shipping_address_collection": { "description": "", "properties": { "allowed_countries": { "description": "An array of two-letter ISO country codes representing which countries Checkout should provide as options for shipping locations. Unsupported country codes: `AS, CX, CC, CU, HM, IR, KP, MH, FM, NF, MP, PW, SD, SY, UM, VI`.", "items": { "enum": [ "AC", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CV", "CW", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MK", "ML", "MM", "MN", "MO", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SZ", "TA", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VN", "VU", "WF", "WS", "XK", "YE", "YT", "ZA", "ZM", "ZW", "ZZ" ], "type": "string" }, "type": "array" } }, "required": [ "allowed_countries" ], "title": "PaymentLinksResourceShippingAddressCollection", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "allowed_countries" ] }, "payment_links_resource_shipping_option": { "description": "", "properties": { "shipping_amount": { "description": "A non-negative integer in cents representing how much to charge.", "type": "integer" }, "shipping_rate": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/shipping_rate" } ], "description": "The ID of the Shipping Rate to use for this shipping option.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/shipping_rate" } ] } } }, "required": [ "shipping_amount", "shipping_rate" ], "title": "PaymentLinksResourceShippingOption", "type": "object", "x-expandableFields": [ "shipping_rate" ], "x-stripeMostCommon": [ "shipping_amount", "shipping_rate" ] }, "payment_links_resource_subscription_data": { "description": "", "properties": { "description": { "description": "The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.", "maxLength": 5000, "nullable": true, "type": "string" }, "invoice_settings": { "$ref": "#/components/schemas/payment_links_resource_subscription_data_invoice_settings" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will set metadata on [Subscriptions](https://stripe.com/docs/api/subscriptions) generated from this payment link.", "type": "object" }, "trial_period_days": { "description": "Integer representing the number of trial period days before the customer is charged for the first time.", "nullable": true, "type": "integer" }, "trial_settings": { "anyOf": [ { "$ref": "#/components/schemas/subscriptions_trials_resource_trial_settings" } ], "description": "Settings related to subscription trials.", "nullable": true } }, "required": [ "description", "invoice_settings", "metadata", "trial_period_days", "trial_settings" ], "title": "PaymentLinksResourceSubscriptionData", "type": "object", "x-expandableFields": [ "invoice_settings", "trial_settings" ], "x-stripeMostCommon": [ "description", "invoice_settings", "metadata", "trial_period_days", "trial_settings" ] }, "payment_links_resource_subscription_data_invoice_settings": { "description": "", "properties": { "issuer": { "$ref": "#/components/schemas/connect_account_reference" } }, "required": [ "issuer" ], "title": "PaymentLinksResourceSubscriptionDataInvoiceSettings", "type": "object", "x-expandableFields": [ "issuer" ], "x-stripeMostCommon": [ "issuer" ] }, "payment_links_resource_tax_id_collection": { "description": "", "properties": { "enabled": { "description": "Indicates whether tax ID collection is enabled for the session.", "type": "boolean" }, "required": { "enum": [ "if_supported", "never" ], "type": "string" } }, "required": [ "enabled", "required" ], "title": "PaymentLinksResourceTaxIdCollection", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "enabled", "required" ] }, "payment_links_resource_transfer_data": { "description": "", "properties": { "amount": { "description": "The amount in cents (or local equivalent) that will be transferred to the destination account. By default, the entire amount is transferred to the destination.", "nullable": true, "type": "integer" }, "destination": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/account" } ], "description": "The connected account receiving the transfer.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/account" } ] } } }, "required": [ "amount", "destination" ], "title": "PaymentLinksResourceTransferData", "type": "object", "x-expandableFields": [ "destination" ], "x-stripeMostCommon": [ "amount", "destination" ] }, "payment_method": { "description": "PaymentMethod objects represent your customer's payment instruments.\nYou can use them with [PaymentIntents](https://stripe.com/docs/payments/payment-intents) to collect payments or save them to\nCustomer objects to store instrument details for future payments.\n\nRelated guides: [Payment Methods](https://stripe.com/docs/payments/payment-methods) and [More Payment Scenarios](https://stripe.com/docs/payments/more-payment-scenarios).", "properties": { "acss_debit": { "$ref": "#/components/schemas/payment_method_acss_debit" }, "affirm": { "$ref": "#/components/schemas/payment_method_affirm" }, "afterpay_clearpay": { "$ref": "#/components/schemas/payment_method_afterpay_clearpay" }, "alipay": { "$ref": "#/components/schemas/payment_flows_private_payment_methods_alipay" }, "allow_redisplay": { "description": "This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to “unspecified”.", "enum": [ "always", "limited", "unspecified" ], "type": "string" }, "alma": { "$ref": "#/components/schemas/payment_method_alma" }, "amazon_pay": { "$ref": "#/components/schemas/payment_method_amazon_pay" }, "au_becs_debit": { "$ref": "#/components/schemas/payment_method_au_becs_debit" }, "bacs_debit": { "$ref": "#/components/schemas/payment_method_bacs_debit" }, "bancontact": { "$ref": "#/components/schemas/payment_method_bancontact" }, "billie": { "$ref": "#/components/schemas/payment_method_billie" }, "billing_details": { "$ref": "#/components/schemas/billing_details" }, "blik": { "$ref": "#/components/schemas/payment_method_blik" }, "boleto": { "$ref": "#/components/schemas/payment_method_boleto" }, "card": { "$ref": "#/components/schemas/payment_method_card" }, "card_present": { "$ref": "#/components/schemas/payment_method_card_present" }, "cashapp": { "$ref": "#/components/schemas/payment_method_cashapp" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "crypto": { "$ref": "#/components/schemas/payment_method_crypto" }, "customer": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/customer" } ], "description": "The ID of the Customer to which this PaymentMethod is saved. This will not be set when the PaymentMethod has not been saved to a Customer.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/customer" } ] } }, "customer_account": { "maxLength": 5000, "nullable": true, "type": "string" }, "customer_balance": { "$ref": "#/components/schemas/payment_method_customer_balance" }, "eps": { "$ref": "#/components/schemas/payment_method_eps" }, "fpx": { "$ref": "#/components/schemas/payment_method_fpx" }, "giropay": { "$ref": "#/components/schemas/payment_method_giropay" }, "gopay": { "$ref": "#/components/schemas/payment_method_gopay" }, "grabpay": { "$ref": "#/components/schemas/payment_method_grabpay" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "id_bank_transfer": { "$ref": "#/components/schemas/payment_method_id_bank_transfer" }, "ideal": { "$ref": "#/components/schemas/payment_method_ideal" }, "interac_present": { "$ref": "#/components/schemas/payment_method_interac_present" }, "kakao_pay": { "$ref": "#/components/schemas/payment_method_kakao_pay" }, "klarna": { "$ref": "#/components/schemas/payment_method_klarna" }, "konbini": { "$ref": "#/components/schemas/payment_method_konbini" }, "kr_card": { "$ref": "#/components/schemas/payment_method_kr_card" }, "latest_active_mandate": { "anyOf": [ { "$ref": "#/components/schemas/mandate" } ], "description": "The Mandate object of the most recently created Mandate associated with this payment method", "nullable": true }, "link": { "$ref": "#/components/schemas/payment_method_link" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "mb_way": { "$ref": "#/components/schemas/payment_method_mb_way" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "nullable": true, "type": "object" }, "mobilepay": { "$ref": "#/components/schemas/payment_method_mobilepay" }, "multibanco": { "$ref": "#/components/schemas/payment_method_multibanco" }, "naver_pay": { "$ref": "#/components/schemas/payment_method_naver_pay" }, "nz_bank_account": { "$ref": "#/components/schemas/payment_method_nz_bank_account" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "payment_method" ], "type": "string" }, "oxxo": { "$ref": "#/components/schemas/payment_method_oxxo" }, "p24": { "$ref": "#/components/schemas/payment_method_p24" }, "pay_by_bank": { "$ref": "#/components/schemas/payment_method_pay_by_bank" }, "payco": { "$ref": "#/components/schemas/payment_method_payco" }, "paynow": { "$ref": "#/components/schemas/payment_method_paynow" }, "paypal": { "$ref": "#/components/schemas/payment_method_paypal" }, "paypay": { "$ref": "#/components/schemas/payment_method_paypay" }, "payto": { "$ref": "#/components/schemas/payment_method_payto" }, "pix": { "$ref": "#/components/schemas/payment_method_pix" }, "promptpay": { "$ref": "#/components/schemas/payment_method_promptpay" }, "qris": { "$ref": "#/components/schemas/payment_method_qris" }, "radar_options": { "$ref": "#/components/schemas/radar_radar_options" }, "rechnung": { "$ref": "#/components/schemas/payment_method_rechnung" }, "revolut_pay": { "$ref": "#/components/schemas/payment_method_revolut_pay" }, "samsung_pay": { "$ref": "#/components/schemas/payment_method_samsung_pay" }, "satispay": { "$ref": "#/components/schemas/payment_method_satispay" }, "sepa_debit": { "$ref": "#/components/schemas/payment_method_sepa_debit" }, "shopeepay": { "$ref": "#/components/schemas/payment_method_shopeepay" }, "sofort": { "$ref": "#/components/schemas/payment_method_sofort" }, "stripe_balance": { "$ref": "#/components/schemas/payment_method_stripe_balance" }, "swish": { "$ref": "#/components/schemas/payment_method_swish" }, "twint": { "$ref": "#/components/schemas/payment_method_twint" }, "type": { "description": "The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.", "enum": [ "acss_debit", "affirm", "afterpay_clearpay", "alipay", "alma", "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", "billie", "blik", "boleto", "card", "card_present", "cashapp", "crypto", "customer_balance", "eps", "fpx", "giropay", "gopay", "grabpay", "id_bank_transfer", "ideal", "interac_present", "kakao_pay", "klarna", "konbini", "kr_card", "link", "mb_way", "mobilepay", "multibanco", "naver_pay", "nz_bank_account", "oxxo", "p24", "pay_by_bank", "payco", "paynow", "paypal", "paypay", "payto", "pix", "promptpay", "qris", "rechnung", "revolut_pay", "samsung_pay", "satispay", "sepa_debit", "shopeepay", "sofort", "stripe_balance", "swish", "twint", "us_bank_account", "wechat_pay", "zip" ], "type": "string", "x-stripeBypassValidation": true }, "us_bank_account": { "$ref": "#/components/schemas/payment_method_us_bank_account" }, "wechat_pay": { "$ref": "#/components/schemas/payment_method_wechat_pay" }, "zip": { "$ref": "#/components/schemas/payment_method_zip" } }, "required": [ "billing_details", "created", "customer", "id", "livemode", "metadata", "object", "type" ], "title": "PaymentMethod", "type": "object", "x-expandableFields": [ "acss_debit", "affirm", "afterpay_clearpay", "alipay", "alma", "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", "billie", "billing_details", "blik", "boleto", "card", "card_present", "cashapp", "crypto", "customer", "customer_balance", "eps", "fpx", "giropay", "gopay", "grabpay", "id_bank_transfer", "ideal", "interac_present", "kakao_pay", "klarna", "konbini", "kr_card", "latest_active_mandate", "link", "mb_way", "mobilepay", "multibanco", "naver_pay", "nz_bank_account", "oxxo", "p24", "pay_by_bank", "payco", "paynow", "paypal", "paypay", "payto", "pix", "promptpay", "qris", "radar_options", "rechnung", "revolut_pay", "samsung_pay", "satispay", "sepa_debit", "shopeepay", "sofort", "stripe_balance", "swish", "twint", "us_bank_account", "wechat_pay", "zip" ], "x-resourceId": "payment_method", "x-stripeMostCommon": [ "billing_details", "customer", "id", "metadata", "type" ], "x-stripeOperations": [ { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/payment_methods" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/payment_methods/{payment_method}" }, { "method_name": "create", "method_on": "service", "method_type": "create", "operation": "post", "path": "/v1/payment_methods" }, { "method_name": "update", "method_on": "service", "method_type": "update", "operation": "post", "path": "/v1/payment_methods/{payment_method}" }, { "method_name": "attach", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/payment_methods/{payment_method}/attach" }, { "method_name": "detach", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/payment_methods/{payment_method}/detach" } ], "x-stripeResource": { "class_name": "PaymentMethod", "has_collection_class": true, "in_package": "" } }, "payment_method.attached": { "description": "Occurs whenever a new payment method is attached to a customer.", "properties": { "object": { "$ref": "#/components/schemas/payment_method" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "payment_method.attached" } }, "payment_method.automatically_updated": { "description": "Occurs whenever a payment method's details are automatically updated by the network.", "properties": { "object": { "$ref": "#/components/schemas/payment_method" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "payment_method.automatically_updated" } }, "payment_method.detached": { "description": "Occurs whenever a payment method is detached from a customer.", "properties": { "object": { "$ref": "#/components/schemas/payment_method" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "payment_method.detached" } }, "payment_method.updated": { "description": "Occurs whenever a payment method is updated via the [PaymentMethod update API](https://docs.stripe.com/api/payment_methods/update).", "properties": { "object": { "$ref": "#/components/schemas/payment_method" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "payment_method.updated" } }, "payment_method_acss_debit": { "description": "", "properties": { "account_number": { "description": "Account number of the bank account.", "maxLength": 5000, "nullable": true, "type": "string" }, "bank_name": { "description": "Name of the bank associated with the bank account.", "maxLength": 5000, "nullable": true, "type": "string" }, "fingerprint": { "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.", "maxLength": 5000, "nullable": true, "type": "string" }, "institution_number": { "description": "Institution number of the bank account.", "maxLength": 5000, "nullable": true, "type": "string" }, "last4": { "description": "Last four digits of the bank account number.", "maxLength": 5000, "nullable": true, "type": "string" }, "transit_number": { "description": "Transit number of the bank account.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "bank_name", "fingerprint", "institution_number", "last4", "transit_number" ], "title": "payment_method_acss_debit", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "bank_name", "fingerprint", "institution_number", "last4", "transit_number" ] }, "payment_method_affirm": { "description": "", "properties": {}, "title": "payment_method_affirm", "type": "object", "x-expandableFields": [] }, "payment_method_afterpay_clearpay": { "description": "", "properties": {}, "title": "payment_method_afterpay_clearpay", "type": "object", "x-expandableFields": [] }, "payment_method_alma": { "description": "", "properties": {}, "title": "payment_method_alma", "type": "object", "x-expandableFields": [] }, "payment_method_amazon_pay": { "description": "", "properties": {}, "title": "payment_method_amazon_pay", "type": "object", "x-expandableFields": [] }, "payment_method_au_becs_debit": { "description": "", "properties": { "bsb_number": { "description": "Six-digit number identifying bank and branch associated with this bank account.", "maxLength": 5000, "nullable": true, "type": "string" }, "fingerprint": { "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.", "maxLength": 5000, "nullable": true, "type": "string" }, "last4": { "description": "Last four digits of the bank account number.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "bsb_number", "fingerprint", "last4" ], "title": "payment_method_au_becs_debit", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "bsb_number", "fingerprint", "last4" ] }, "payment_method_bacs_debit": { "description": "", "properties": { "fingerprint": { "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.", "maxLength": 5000, "nullable": true, "type": "string" }, "last4": { "description": "Last four digits of the bank account number.", "maxLength": 5000, "nullable": true, "type": "string" }, "sort_code": { "description": "Sort code of the bank account. (e.g., `10-20-30`)", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "fingerprint", "last4", "sort_code" ], "title": "payment_method_bacs_debit", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "fingerprint", "last4", "sort_code" ] }, "payment_method_bancontact": { "description": "", "properties": {}, "title": "payment_method_bancontact", "type": "object", "x-expandableFields": [] }, "payment_method_billie": { "description": "", "properties": {}, "title": "payment_method_billie", "type": "object", "x-expandableFields": [] }, "payment_method_blik": { "description": "", "properties": {}, "title": "payment_method_blik", "type": "object", "x-expandableFields": [] }, "payment_method_boleto": { "description": "", "properties": { "tax_id": { "description": "Uniquely identifies the customer tax id (CNPJ or CPF)", "maxLength": 5000, "type": "string" } }, "required": [ "tax_id" ], "title": "payment_method_boleto", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "tax_id" ] }, "payment_method_card": { "description": "", "properties": { "brand": { "description": "Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`.", "maxLength": 5000, "type": "string" }, "checks": { "anyOf": [ { "$ref": "#/components/schemas/payment_method_card_checks" } ], "description": "Checks on Card address and CVC if provided.", "nullable": true }, "country": { "description": "Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.", "maxLength": 5000, "nullable": true, "type": "string" }, "description": { "description": "A high-level description of the type of cards issued in this range. (For internal use only and not typically available in standard API requests.)", "maxLength": 5000, "nullable": true, "type": "string" }, "display_brand": { "description": "The brand to use when displaying the card, this accounts for customer's brand choice on dual-branded cards. Can be `american_express`, `cartes_bancaires`, `diners_club`, `discover`, `eftpos_australia`, `interac`, `jcb`, `mastercard`, `union_pay`, `visa`, or `other` and may contain more values in the future.", "maxLength": 5000, "nullable": true, "type": "string" }, "exp_month": { "description": "Two-digit number representing the card's expiration month.", "type": "integer" }, "exp_year": { "description": "Four-digit number representing the card's expiration year.", "type": "integer" }, "fingerprint": { "description": "Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.\n\n*As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*", "maxLength": 5000, "nullable": true, "type": "string" }, "funding": { "description": "Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.", "maxLength": 5000, "type": "string" }, "generated_from": { "anyOf": [ { "$ref": "#/components/schemas/payment_method_card_generated_card" } ], "description": "Details of the original PaymentMethod that created this object.", "nullable": true }, "iin": { "description": "Issuer identification number of the card. (For internal use only and not typically available in standard API requests.)", "maxLength": 5000, "nullable": true, "type": "string" }, "issuer": { "description": "The name of the card's issuing bank. (For internal use only and not typically available in standard API requests.)", "maxLength": 5000, "nullable": true, "type": "string" }, "last4": { "description": "The last four digits of the card.", "maxLength": 5000, "type": "string" }, "networks": { "anyOf": [ { "$ref": "#/components/schemas/networks" } ], "description": "Contains information about card networks that can be used to process the payment.", "nullable": true }, "regulated_status": { "description": "Status of a card based on the card issuer.", "enum": [ "regulated", "unregulated" ], "nullable": true, "type": "string" }, "three_d_secure_usage": { "anyOf": [ { "$ref": "#/components/schemas/three_d_secure_usage" } ], "description": "Contains details on how this Card may be used for 3D Secure authentication.", "nullable": true }, "wallet": { "anyOf": [ { "$ref": "#/components/schemas/payment_method_card_wallet" } ], "description": "If this Card is part of a card wallet, this contains the details of the card wallet.", "nullable": true } }, "required": [ "brand", "checks", "country", "display_brand", "exp_month", "exp_year", "funding", "generated_from", "last4", "networks", "regulated_status", "three_d_secure_usage", "wallet" ], "title": "payment_method_card", "type": "object", "x-expandableFields": [ "checks", "generated_from", "networks", "three_d_secure_usage", "wallet" ], "x-stripeMostCommon": [ "brand", "checks", "country", "description", "display_brand", "exp_month", "exp_year", "fingerprint", "funding", "generated_from", "iin", "issuer", "last4", "networks", "regulated_status", "three_d_secure_usage", "wallet" ] }, "payment_method_card_checks": { "description": "", "properties": { "address_line1_check": { "description": "If a address line1 was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.", "maxLength": 5000, "nullable": true, "type": "string" }, "address_postal_code_check": { "description": "If a address postal code was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.", "maxLength": 5000, "nullable": true, "type": "string" }, "cvc_check": { "description": "If a CVC was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "address_line1_check", "address_postal_code_check", "cvc_check" ], "title": "payment_method_card_checks", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "address_line1_check", "address_postal_code_check", "cvc_check" ] }, "payment_method_card_generated_card": { "description": "", "properties": { "charge": { "description": "The charge that created this object.", "maxLength": 5000, "nullable": true, "type": "string" }, "payment_method_details": { "anyOf": [ { "$ref": "#/components/schemas/card_generated_from_payment_method_details" } ], "description": "Transaction-specific details of the payment method used in the payment.", "nullable": true }, "setup_attempt": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/setup_attempt" } ], "description": "The ID of the SetupAttempt that generated this PaymentMethod, if any.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/setup_attempt" } ] } } }, "required": [ "charge", "payment_method_details", "setup_attempt" ], "title": "payment_method_card_generated_card", "type": "object", "x-expandableFields": [ "payment_method_details", "setup_attempt" ], "x-stripeMostCommon": [ "charge", "payment_method_details", "setup_attempt" ] }, "payment_method_card_present": { "description": "", "properties": { "brand": { "description": "Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`.", "maxLength": 5000, "nullable": true, "type": "string" }, "brand_product": { "description": "The [product code](https://stripe.com/docs/card-product-codes) that identifies the specific program or product associated with a card.", "maxLength": 5000, "nullable": true, "type": "string" }, "cardholder_name": { "description": "The cardholder name as read from the card, in [ISO 7813](https://en.wikipedia.org/wiki/ISO/IEC_7813) format. May include alphanumeric characters, special characters and first/last name separator (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay.", "maxLength": 5000, "nullable": true, "type": "string" }, "country": { "description": "Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.", "maxLength": 5000, "nullable": true, "type": "string" }, "description": { "description": "A high-level description of the type of cards issued in this range. (For internal use only and not typically available in standard API requests.)", "maxLength": 5000, "nullable": true, "type": "string" }, "exp_month": { "description": "Two-digit number representing the card's expiration month.", "type": "integer" }, "exp_year": { "description": "Four-digit number representing the card's expiration year.", "type": "integer" }, "fingerprint": { "description": "Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.\n\n*As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*", "maxLength": 5000, "nullable": true, "type": "string" }, "funding": { "description": "Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.", "maxLength": 5000, "nullable": true, "type": "string" }, "iin": { "description": "Issuer identification number of the card. (For internal use only and not typically available in standard API requests.)", "maxLength": 5000, "nullable": true, "type": "string" }, "issuer": { "description": "The name of the card's issuing bank. (For internal use only and not typically available in standard API requests.)", "maxLength": 5000, "nullable": true, "type": "string" }, "last4": { "description": "The last four digits of the card.", "maxLength": 5000, "nullable": true, "type": "string" }, "networks": { "anyOf": [ { "$ref": "#/components/schemas/payment_method_card_present_networks" } ], "description": "Contains information about card networks that can be used to process the payment.", "nullable": true }, "offline": { "anyOf": [ { "$ref": "#/components/schemas/payment_method_details_card_present_offline" } ], "description": "Details about payment methods collected offline.", "nullable": true }, "preferred_locales": { "description": "The languages that the issuing bank recommends using for localizing any customer-facing text, as read from the card. Referenced from EMV tag 5F2D, data encoded on the card's chip.", "items": { "maxLength": 5000, "type": "string" }, "nullable": true, "type": "array" }, "read_method": { "description": "How card details were read in this transaction.", "enum": [ "contact_emv", "contactless_emv", "contactless_magstripe_mode", "magnetic_stripe_fallback", "magnetic_stripe_track2" ], "nullable": true, "type": "string" }, "wallet": { "$ref": "#/components/schemas/payment_flows_private_payment_methods_card_present_common_wallet" } }, "required": [ "brand", "brand_product", "cardholder_name", "country", "exp_month", "exp_year", "fingerprint", "funding", "last4", "networks", "offline", "preferred_locales", "read_method" ], "title": "payment_method_card_present", "type": "object", "x-expandableFields": [ "networks", "offline", "wallet" ], "x-stripeMostCommon": [ "brand", "brand_product", "cardholder_name", "country", "description", "exp_month", "exp_year", "fingerprint", "funding", "iin", "issuer", "last4", "networks", "offline", "preferred_locales", "read_method", "wallet" ] }, "payment_method_card_present_networks": { "description": "", "properties": { "available": { "description": "All networks available for selection via [payment_method_options.card.network](/api/payment_intents/confirm#confirm_payment_intent-payment_method_options-card-network).", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "preferred": { "description": "The preferred network for the card.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "available", "preferred" ], "title": "payment_method_card_present_networks", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "available", "preferred" ] }, "payment_method_card_wallet": { "description": "", "properties": { "amex_express_checkout": { "$ref": "#/components/schemas/payment_method_card_wallet_amex_express_checkout" }, "apple_pay": { "$ref": "#/components/schemas/payment_method_card_wallet_apple_pay" }, "dynamic_last4": { "description": "(For tokenized numbers only.) The last four digits of the device account number.", "maxLength": 5000, "nullable": true, "type": "string" }, "google_pay": { "$ref": "#/components/schemas/payment_method_card_wallet_google_pay" }, "link": { "$ref": "#/components/schemas/payment_method_card_wallet_link" }, "masterpass": { "$ref": "#/components/schemas/payment_method_card_wallet_masterpass" }, "samsung_pay": { "$ref": "#/components/schemas/payment_method_card_wallet_samsung_pay" }, "type": { "description": "The type of the card wallet, one of `amex_express_checkout`, `apple_pay`, `google_pay`, `masterpass`, `samsung_pay`, `visa_checkout`, or `link`. An additional hash is included on the Wallet subhash with a name matching this value. It contains additional information specific to the card wallet type.", "enum": [ "amex_express_checkout", "apple_pay", "google_pay", "link", "masterpass", "samsung_pay", "visa_checkout" ], "type": "string" }, "visa_checkout": { "$ref": "#/components/schemas/payment_method_card_wallet_visa_checkout" } }, "required": [ "dynamic_last4", "type" ], "title": "payment_method_card_wallet", "type": "object", "x-expandableFields": [ "amex_express_checkout", "apple_pay", "google_pay", "link", "masterpass", "samsung_pay", "visa_checkout" ], "x-stripeMostCommon": [ "amex_express_checkout", "apple_pay", "dynamic_last4", "google_pay", "link", "masterpass", "samsung_pay", "type", "visa_checkout" ] }, "payment_method_card_wallet_amex_express_checkout": { "description": "", "properties": {}, "title": "payment_method_card_wallet_amex_express_checkout", "type": "object", "x-expandableFields": [] }, "payment_method_card_wallet_apple_pay": { "description": "", "properties": {}, "title": "payment_method_card_wallet_apple_pay", "type": "object", "x-expandableFields": [] }, "payment_method_card_wallet_google_pay": { "description": "", "properties": {}, "title": "payment_method_card_wallet_google_pay", "type": "object", "x-expandableFields": [] }, "payment_method_card_wallet_link": { "description": "", "properties": {}, "title": "payment_method_card_wallet_link", "type": "object", "x-expandableFields": [] }, "payment_method_card_wallet_masterpass": { "description": "", "properties": { "billing_address": { "anyOf": [ { "$ref": "#/components/schemas/address" } ], "description": "Owner's verified billing address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.", "nullable": true }, "email": { "description": "Owner's verified email. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.", "maxLength": 5000, "nullable": true, "type": "string" }, "name": { "description": "Owner's verified full name. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.", "maxLength": 5000, "nullable": true, "type": "string" }, "shipping_address": { "anyOf": [ { "$ref": "#/components/schemas/address" } ], "description": "Owner's verified shipping address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.", "nullable": true } }, "required": [ "billing_address", "email", "name", "shipping_address" ], "title": "payment_method_card_wallet_masterpass", "type": "object", "x-expandableFields": [ "billing_address", "shipping_address" ], "x-stripeMostCommon": [ "billing_address", "email", "name", "shipping_address" ] }, "payment_method_card_wallet_samsung_pay": { "description": "", "properties": {}, "title": "payment_method_card_wallet_samsung_pay", "type": "object", "x-expandableFields": [] }, "payment_method_card_wallet_visa_checkout": { "description": "", "properties": { "billing_address": { "anyOf": [ { "$ref": "#/components/schemas/address" } ], "description": "Owner's verified billing address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.", "nullable": true }, "email": { "description": "Owner's verified email. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.", "maxLength": 5000, "nullable": true, "type": "string" }, "name": { "description": "Owner's verified full name. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.", "maxLength": 5000, "nullable": true, "type": "string" }, "shipping_address": { "anyOf": [ { "$ref": "#/components/schemas/address" } ], "description": "Owner's verified shipping address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.", "nullable": true } }, "required": [ "billing_address", "email", "name", "shipping_address" ], "title": "payment_method_card_wallet_visa_checkout", "type": "object", "x-expandableFields": [ "billing_address", "shipping_address" ], "x-stripeMostCommon": [ "billing_address", "email", "name", "shipping_address" ] }, "payment_method_cashapp": { "description": "", "properties": { "buyer_id": { "description": "A unique and immutable identifier assigned by Cash App to every buyer.", "maxLength": 5000, "nullable": true, "type": "string" }, "cashtag": { "description": "A public identifier for buyers using Cash App.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "buyer_id", "cashtag" ], "title": "payment_method_cashapp", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "buyer_id", "cashtag" ] }, "payment_method_config_biz_payment_method_configuration_details": { "description": "", "properties": { "id": { "description": "ID of the payment method configuration used.", "maxLength": 5000, "type": "string" }, "parent": { "description": "ID of the parent payment method configuration used.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "id", "parent" ], "title": "PaymentMethodConfigBizPaymentMethodConfigurationDetails", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "id", "parent" ] }, "payment_method_config_resource_display_preference": { "description": "", "properties": { "overridable": { "description": "For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used.", "nullable": true, "type": "boolean" }, "preference": { "description": "The account's display preference.", "enum": [ "none", "off", "on" ], "type": "string" }, "value": { "description": "The effective display preference value.", "enum": [ "off", "on" ], "type": "string" } }, "required": [ "overridable", "preference", "value" ], "title": "PaymentMethodConfigResourceDisplayPreference", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "overridable", "preference", "value" ] }, "payment_method_config_resource_payment_method_properties": { "description": "", "properties": { "available": { "description": "Whether this payment method may be offered at checkout. True if `display_preference` is `on` and the payment method's capability is active.", "type": "boolean" }, "display_preference": { "$ref": "#/components/schemas/payment_method_config_resource_display_preference" } }, "required": [ "available", "display_preference" ], "title": "PaymentMethodConfigResourcePaymentMethodProperties", "type": "object", "x-expandableFields": [ "display_preference" ], "x-stripeMostCommon": [ "available", "display_preference" ] }, "payment_method_configuration": { "description": "PaymentMethodConfigurations control which payment methods are displayed to your customers when you don't explicitly specify payment method types. You can have multiple configurations with different sets of payment methods for different scenarios.\n\nThere are two types of PaymentMethodConfigurations. Which is used depends on the [charge type](https://stripe.com/docs/connect/charges):\n\n**Direct** configurations apply to payments created on your account, including Connect destination charges, Connect separate charges and transfers, and payments not involving Connect.\n\n**Child** configurations apply to payments created on your connected accounts using direct charges, and charges with the on_behalf_of parameter.\n\nChild configurations have a `parent` that sets default values and controls which settings connected accounts may override. You can specify a parent ID at payment time, and Stripe will automatically resolve the connected account’s associated child configuration. Parent configurations are [managed in the dashboard](https://dashboard.stripe.com/settings/payment_methods/connected_accounts) and are not available in this API.\n\nRelated guides:\n- [Payment Method Configurations API](https://stripe.com/docs/connect/payment-method-configurations)\n- [Multiple configurations on dynamic payment methods](https://stripe.com/docs/payments/multiple-payment-method-configs)\n- [Multiple configurations for your Connect accounts](https://stripe.com/docs/connect/multiple-payment-method-configurations)", "properties": { "acss_debit": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "active": { "description": "Whether the configuration can be used for new payments.", "type": "boolean" }, "affirm": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "afterpay_clearpay": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "alipay": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "alma": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "amazon_pay": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "apple_pay": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "application": { "description": "For child configs, the Connect application associated with the configuration.", "maxLength": 5000, "nullable": true, "type": "string" }, "au_becs_debit": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "bacs_debit": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "bancontact": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "billie": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "blik": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "boleto": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "card": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "cartes_bancaires": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "cashapp": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "customer_balance": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "eps": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "fpx": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "fr_meal_voucher_conecs": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "giropay": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "google_pay": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "gopay": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "grabpay": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "id_bank_transfer": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "ideal": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "is_default": { "description": "The default configuration is used whenever a payment method configuration is not specified.", "type": "boolean" }, "jcb": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "kakao_pay": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "klarna": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "konbini": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "kr_card": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "link": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "mobilepay": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "multibanco": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "name": { "description": "The configuration's name.", "maxLength": 5000, "type": "string" }, "naver_pay": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "nz_bank_account": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "payment_method_configuration" ], "type": "string" }, "oxxo": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "p24": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "parent": { "description": "For child configs, the configuration's parent configuration.", "maxLength": 5000, "nullable": true, "type": "string" }, "pay_by_bank": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "payco": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "paynow": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "paypal": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "paypay": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "payto": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "pix": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "promptpay": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "qris": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "revolut_pay": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "samsung_pay": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "satispay": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "sepa_debit": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "shopeepay": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "sofort": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "swish": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "twint": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "us_bank_account": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "wechat_pay": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "zip": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" } }, "required": [ "active", "application", "id", "is_default", "livemode", "name", "object", "parent" ], "title": "PaymentMethodConfigResourcePaymentMethodConfiguration", "type": "object", "x-expandableFields": [ "acss_debit", "affirm", "afterpay_clearpay", "alipay", "alma", "amazon_pay", "apple_pay", "au_becs_debit", "bacs_debit", "bancontact", "billie", "blik", "boleto", "card", "cartes_bancaires", "cashapp", "customer_balance", "eps", "fpx", "fr_meal_voucher_conecs", "giropay", "google_pay", "gopay", "grabpay", "id_bank_transfer", "ideal", "jcb", "kakao_pay", "klarna", "konbini", "kr_card", "link", "mobilepay", "multibanco", "naver_pay", "nz_bank_account", "oxxo", "p24", "pay_by_bank", "payco", "paynow", "paypal", "paypay", "payto", "pix", "promptpay", "qris", "revolut_pay", "samsung_pay", "satispay", "sepa_debit", "shopeepay", "sofort", "swish", "twint", "us_bank_account", "wechat_pay", "zip" ], "x-resourceId": "payment_method_configuration", "x-stripeMostCommon": [ "active", "application", "id", "is_default", "name", "object", "parent" ], "x-stripeOperations": [ { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/payment_method_configurations" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/payment_method_configurations/{configuration}" }, { "method_name": "create", "method_on": "service", "method_type": "create", "operation": "post", "path": "/v1/payment_method_configurations" }, { "method_name": "update", "method_on": "service", "method_type": "update", "operation": "post", "path": "/v1/payment_method_configurations/{configuration}" } ], "x-stripeResource": { "class_name": "PaymentMethodConfiguration", "has_collection_class": true, "in_package": "" } }, "payment_method_crypto": { "description": "", "properties": {}, "title": "payment_method_crypto", "type": "object", "x-expandableFields": [], "x-stripeResource": { "class_name": "Crypto", "in_package": "" } }, "payment_method_customer_balance": { "description": "", "properties": {}, "title": "payment_method_customer_balance", "type": "object", "x-expandableFields": [] }, "payment_method_details": { "description": "", "properties": { "ach_credit_transfer": { "$ref": "#/components/schemas/payment_method_details_ach_credit_transfer" }, "ach_debit": { "$ref": "#/components/schemas/payment_method_details_ach_debit" }, "acss_debit": { "$ref": "#/components/schemas/payment_method_details_acss_debit" }, "affirm": { "$ref": "#/components/schemas/payment_method_details_affirm" }, "afterpay_clearpay": { "$ref": "#/components/schemas/payment_method_details_afterpay_clearpay" }, "alipay": { "$ref": "#/components/schemas/payment_flows_private_payment_methods_alipay_details" }, "alma": { "$ref": "#/components/schemas/payment_method_details_alma" }, "amazon_pay": { "$ref": "#/components/schemas/payment_method_details_amazon_pay" }, "au_becs_debit": { "$ref": "#/components/schemas/payment_method_details_au_becs_debit" }, "bacs_debit": { "$ref": "#/components/schemas/payment_method_details_bacs_debit" }, "bancontact": { "$ref": "#/components/schemas/payment_method_details_bancontact" }, "billie": { "$ref": "#/components/schemas/payment_method_details_billie" }, "blik": { "$ref": "#/components/schemas/payment_method_details_blik" }, "boleto": { "$ref": "#/components/schemas/payment_method_details_boleto" }, "card": { "$ref": "#/components/schemas/payment_method_details_card" }, "card_present": { "$ref": "#/components/schemas/payment_method_details_card_present" }, "cashapp": { "$ref": "#/components/schemas/payment_method_details_cashapp" }, "crypto": { "$ref": "#/components/schemas/payment_method_details_crypto" }, "customer_balance": { "$ref": "#/components/schemas/payment_method_details_customer_balance" }, "eps": { "$ref": "#/components/schemas/payment_method_details_eps" }, "fpx": { "$ref": "#/components/schemas/payment_method_details_fpx" }, "giropay": { "$ref": "#/components/schemas/payment_method_details_giropay" }, "gopay": { "$ref": "#/components/schemas/payment_method_details_gopay" }, "grabpay": { "$ref": "#/components/schemas/payment_method_details_grabpay" }, "id_bank_transfer": { "$ref": "#/components/schemas/payment_method_details_id_bank_transfer" }, "ideal": { "$ref": "#/components/schemas/payment_method_details_ideal" }, "interac_present": { "$ref": "#/components/schemas/payment_method_details_interac_present" }, "kakao_pay": { "$ref": "#/components/schemas/payment_method_details_kakao_pay" }, "klarna": { "$ref": "#/components/schemas/payment_method_details_klarna" }, "konbini": { "$ref": "#/components/schemas/payment_method_details_konbini" }, "kr_card": { "$ref": "#/components/schemas/payment_method_details_kr_card" }, "link": { "$ref": "#/components/schemas/payment_method_details_link" }, "mb_way": { "$ref": "#/components/schemas/payment_method_details_mb_way" }, "mobilepay": { "$ref": "#/components/schemas/payment_method_details_mobilepay" }, "multibanco": { "$ref": "#/components/schemas/payment_method_details_multibanco" }, "naver_pay": { "$ref": "#/components/schemas/payment_method_details_naver_pay" }, "nz_bank_account": { "$ref": "#/components/schemas/payment_method_details_nz_bank_account" }, "oxxo": { "$ref": "#/components/schemas/payment_method_details_oxxo" }, "p24": { "$ref": "#/components/schemas/payment_method_details_p24" }, "pay_by_bank": { "$ref": "#/components/schemas/payment_method_details_pay_by_bank" }, "payco": { "$ref": "#/components/schemas/payment_method_details_payco" }, "paynow": { "$ref": "#/components/schemas/payment_method_details_paynow" }, "paypal": { "$ref": "#/components/schemas/payment_method_details_paypal" }, "paypay": { "$ref": "#/components/schemas/payment_method_details_paypay" }, "payto": { "$ref": "#/components/schemas/payment_method_details_payto" }, "pix": { "$ref": "#/components/schemas/payment_method_details_pix" }, "promptpay": { "$ref": "#/components/schemas/payment_method_details_promptpay" }, "qris": { "$ref": "#/components/schemas/payment_method_details_qris" }, "rechnung": { "$ref": "#/components/schemas/payment_method_details_rechnung" }, "revolut_pay": { "$ref": "#/components/schemas/payment_method_details_revolut_pay" }, "samsung_pay": { "$ref": "#/components/schemas/payment_method_details_samsung_pay" }, "satispay": { "$ref": "#/components/schemas/payment_method_details_satispay" }, "sepa_credit_transfer": { "$ref": "#/components/schemas/payment_method_details_sepa_credit_transfer" }, "sepa_debit": { "$ref": "#/components/schemas/payment_method_details_sepa_debit" }, "shopeepay": { "$ref": "#/components/schemas/payment_method_details_shopeepay" }, "sofort": { "$ref": "#/components/schemas/payment_method_details_sofort" }, "stripe_account": { "$ref": "#/components/schemas/payment_method_details_stripe_account" }, "stripe_balance": { "$ref": "#/components/schemas/payment_method_details_stripe_balance" }, "swish": { "$ref": "#/components/schemas/payment_method_details_swish" }, "twint": { "$ref": "#/components/schemas/payment_method_details_twint" }, "type": { "description": "The type of transaction-specific details of the payment method used in the payment. See [PaymentMethod.type](https://stripe.com/docs/api/payment_methods/object#payment_method_object-type) for the full list of possible types.\nAn additional hash is included on `payment_method_details` with a name matching this value.\nIt contains information specific to the payment method.", "maxLength": 5000, "type": "string" }, "us_bank_account": { "$ref": "#/components/schemas/payment_method_details_us_bank_account" }, "wechat": { "$ref": "#/components/schemas/payment_method_details_wechat" }, "wechat_pay": { "$ref": "#/components/schemas/payment_method_details_wechat_pay" }, "zip": { "$ref": "#/components/schemas/payment_method_details_zip" } }, "required": [ "type" ], "title": "payment_method_details", "type": "object", "x-expandableFields": [ "ach_credit_transfer", "ach_debit", "acss_debit", "affirm", "afterpay_clearpay", "alipay", "alma", "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", "billie", "blik", "boleto", "card", "card_present", "cashapp", "crypto", "customer_balance", "eps", "fpx", "giropay", "gopay", "grabpay", "id_bank_transfer", "ideal", "interac_present", "kakao_pay", "klarna", "konbini", "kr_card", "link", "mb_way", "mobilepay", "multibanco", "naver_pay", "nz_bank_account", "oxxo", "p24", "pay_by_bank", "payco", "paynow", "paypal", "paypay", "payto", "pix", "promptpay", "qris", "rechnung", "revolut_pay", "samsung_pay", "satispay", "sepa_credit_transfer", "sepa_debit", "shopeepay", "sofort", "stripe_account", "stripe_balance", "swish", "twint", "us_bank_account", "wechat", "wechat_pay", "zip" ], "x-stripeMostCommon": [ "ach_credit_transfer", "ach_debit", "acss_debit", "affirm", "afterpay_clearpay", "alipay", "alma", "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", "billie", "blik", "boleto", "card", "card_present", "cashapp", "crypto", "customer_balance", "eps", "fpx", "giropay", "gopay", "grabpay", "id_bank_transfer", "ideal", "interac_present", "kakao_pay", "klarna", "konbini", "kr_card", "link", "mb_way", "mobilepay", "multibanco", "naver_pay", "nz_bank_account", "oxxo", "p24", "pay_by_bank", "payco", "paynow", "paypal", "paypay", "payto", "pix", "promptpay", "qris", "rechnung", "revolut_pay", "samsung_pay", "satispay", "sepa_credit_transfer", "sepa_debit", "shopeepay", "sofort", "stripe_account", "stripe_balance", "swish", "twint", "type", "us_bank_account", "wechat", "wechat_pay", "zip" ] }, "payment_method_details_ach_credit_transfer": { "description": "", "properties": { "account_number": { "description": "Account number to transfer funds to.", "maxLength": 5000, "nullable": true, "type": "string" }, "bank_name": { "description": "Name of the bank associated with the routing number.", "maxLength": 5000, "nullable": true, "type": "string" }, "routing_number": { "description": "Routing transit number for the bank account to transfer funds to.", "maxLength": 5000, "nullable": true, "type": "string" }, "swift_code": { "description": "SWIFT code of the bank associated with the routing number.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "account_number", "bank_name", "routing_number", "swift_code" ], "title": "payment_method_details_ach_credit_transfer", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "account_number", "bank_name", "routing_number", "swift_code" ] }, "payment_method_details_ach_debit": { "description": "", "properties": { "account_holder_type": { "description": "Type of entity that holds the account. This can be either `individual` or `company`.", "enum": [ "company", "individual" ], "nullable": true, "type": "string" }, "bank_name": { "description": "Name of the bank associated with the bank account.", "maxLength": 5000, "nullable": true, "type": "string" }, "country": { "description": "Two-letter ISO code representing the country the bank account is located in.", "maxLength": 5000, "nullable": true, "type": "string" }, "fingerprint": { "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.", "maxLength": 5000, "nullable": true, "type": "string" }, "last4": { "description": "Last four digits of the bank account number.", "maxLength": 5000, "nullable": true, "type": "string" }, "routing_number": { "description": "Routing transit number of the bank account.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "account_holder_type", "bank_name", "country", "fingerprint", "last4", "routing_number" ], "title": "payment_method_details_ach_debit", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "account_holder_type", "bank_name", "country", "fingerprint", "last4", "routing_number" ] }, "payment_method_details_acss_debit": { "description": "", "properties": { "bank_name": { "description": "Name of the bank associated with the bank account.", "maxLength": 5000, "nullable": true, "type": "string" }, "fingerprint": { "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.", "maxLength": 5000, "nullable": true, "type": "string" }, "institution_number": { "description": "Institution number of the bank account", "maxLength": 5000, "nullable": true, "type": "string" }, "last4": { "description": "Last four digits of the bank account number.", "maxLength": 5000, "nullable": true, "type": "string" }, "mandate": { "description": "ID of the mandate used to make this payment.", "maxLength": 5000, "type": "string" }, "transit_number": { "description": "Transit number of the bank account.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "bank_name", "fingerprint", "institution_number", "last4", "transit_number" ], "title": "payment_method_details_acss_debit", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "bank_name", "fingerprint", "institution_number", "last4", "mandate", "transit_number" ] }, "payment_method_details_affirm": { "description": "", "properties": { "location": { "description": "ID of the [location](https://stripe.com/docs/api/terminal/locations) that this transaction's reader is assigned to.", "maxLength": 5000, "type": "string" }, "reader": { "description": "ID of the [reader](https://stripe.com/docs/api/terminal/readers) this transaction was made on.", "maxLength": 5000, "type": "string" }, "transaction_id": { "description": "The Affirm transaction ID associated with this payment.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "transaction_id" ], "title": "payment_method_details_affirm", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "location", "reader", "transaction_id" ] }, "payment_method_details_afterpay_clearpay": { "description": "", "properties": { "order_id": { "description": "The Afterpay order ID associated with this payment intent.", "maxLength": 5000, "nullable": true, "type": "string" }, "reference": { "description": "Order identifier shown to the merchant in Afterpay’s online portal.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "order_id", "reference" ], "title": "payment_method_details_afterpay_clearpay", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "order_id", "reference" ] }, "payment_method_details_alma": { "description": "", "properties": { "installments": { "$ref": "#/components/schemas/alma_installments" }, "transaction_id": { "description": "The Alma transaction ID associated with this payment.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "transaction_id" ], "title": "payment_method_details_alma", "type": "object", "x-expandableFields": [ "installments" ], "x-stripeMostCommon": [ "installments", "transaction_id" ] }, "payment_method_details_amazon_pay": { "description": "", "properties": { "funding": { "$ref": "#/components/schemas/amazon_pay_underlying_payment_method_funding_details" }, "transaction_id": { "description": "The Amazon Pay transaction ID associated with this payment.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "transaction_id" ], "title": "payment_method_details_amazon_pay", "type": "object", "x-expandableFields": [ "funding" ], "x-stripeMostCommon": [ "funding", "transaction_id" ] }, "payment_method_details_au_becs_debit": { "description": "", "properties": { "bsb_number": { "description": "Bank-State-Branch number of the bank account.", "maxLength": 5000, "nullable": true, "type": "string" }, "fingerprint": { "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.", "maxLength": 5000, "nullable": true, "type": "string" }, "last4": { "description": "Last four digits of the bank account number.", "maxLength": 5000, "nullable": true, "type": "string" }, "mandate": { "description": "ID of the mandate used to make this payment.", "maxLength": 5000, "type": "string" } }, "required": [ "bsb_number", "fingerprint", "last4" ], "title": "payment_method_details_au_becs_debit", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "bsb_number", "fingerprint", "last4", "mandate" ] }, "payment_method_details_bacs_debit": { "description": "", "properties": { "fingerprint": { "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.", "maxLength": 5000, "nullable": true, "type": "string" }, "last4": { "description": "Last four digits of the bank account number.", "maxLength": 5000, "nullable": true, "type": "string" }, "mandate": { "description": "ID of the mandate used to make this payment.", "maxLength": 5000, "nullable": true, "type": "string" }, "sort_code": { "description": "Sort code of the bank account. (e.g., `10-20-30`)", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "fingerprint", "last4", "mandate", "sort_code" ], "title": "payment_method_details_bacs_debit", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "fingerprint", "last4", "mandate", "sort_code" ] }, "payment_method_details_bancontact": { "description": "", "properties": { "bank_code": { "description": "Bank code of bank associated with the bank account.", "maxLength": 5000, "nullable": true, "type": "string" }, "bank_name": { "description": "Name of the bank associated with the bank account.", "maxLength": 5000, "nullable": true, "type": "string" }, "bic": { "description": "Bank Identifier Code of the bank associated with the bank account.", "maxLength": 5000, "nullable": true, "type": "string" }, "generated_sepa_debit": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/payment_method" } ], "description": "The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/payment_method" } ] } }, "generated_sepa_debit_mandate": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/mandate" } ], "description": "The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/mandate" } ] } }, "iban_last4": { "description": "Last four characters of the IBAN.", "maxLength": 5000, "nullable": true, "type": "string" }, "preferred_language": { "description": "Preferred language of the Bancontact authorization page that the customer is redirected to.\nCan be one of `en`, `de`, `fr`, or `nl`", "enum": [ "de", "en", "fr", "nl" ], "nullable": true, "type": "string" }, "verified_name": { "description": "Owner's verified full name. Values are verified or provided by Bancontact directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "bank_code", "bank_name", "bic", "generated_sepa_debit", "generated_sepa_debit_mandate", "iban_last4", "preferred_language", "verified_name" ], "title": "payment_method_details_bancontact", "type": "object", "x-expandableFields": [ "generated_sepa_debit", "generated_sepa_debit_mandate" ], "x-stripeMostCommon": [ "bank_code", "bank_name", "bic", "generated_sepa_debit", "generated_sepa_debit_mandate", "iban_last4", "preferred_language", "verified_name" ] }, "payment_method_details_billie": { "description": "", "properties": { "transaction_id": { "description": "The Billie transaction ID associated with this payment.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "transaction_id" ], "title": "payment_method_details_billie", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "transaction_id" ] }, "payment_method_details_blik": { "description": "", "properties": { "buyer_id": { "description": "A unique and immutable identifier assigned by BLIK to every buyer.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "buyer_id" ], "title": "payment_method_details_blik", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "buyer_id" ] }, "payment_method_details_boleto": { "description": "", "properties": { "tax_id": { "description": "The tax ID of the customer (CPF for individuals consumers or CNPJ for businesses consumers)", "maxLength": 5000, "type": "string" } }, "required": [ "tax_id" ], "title": "payment_method_details_boleto", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "tax_id" ] }, "payment_method_details_card": { "description": "", "properties": { "amount_authorized": { "description": "The authorized amount.", "nullable": true, "type": "integer" }, "amount_requested": { "description": "The latest amount intended to be authorized by this charge.", "nullable": true, "type": "integer" }, "authorization_code": { "description": "Authorization code on the charge.", "maxLength": 5000, "nullable": true, "type": "string" }, "brand": { "description": "Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`.", "maxLength": 5000, "nullable": true, "type": "string" }, "capture_before": { "description": "When using manual capture, a future timestamp at which the charge will be automatically refunded if uncaptured.", "format": "unix-time", "type": "integer" }, "checks": { "anyOf": [ { "$ref": "#/components/schemas/payment_method_details_card_checks" } ], "description": "Check results by Card networks on Card address and CVC at time of payment.", "nullable": true }, "country": { "description": "Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.", "maxLength": 5000, "nullable": true, "type": "string" }, "decremental_authorization": { "$ref": "#/components/schemas/payment_flows_private_payment_methods_card_details_api_resource_enterprise_features_decremental_authorization_decremental_authorization" }, "description": { "description": "A high-level description of the type of cards issued in this range. (For internal use only and not typically available in standard API requests.)", "maxLength": 5000, "nullable": true, "type": "string" }, "exp_month": { "description": "Two-digit number representing the card's expiration month.", "type": "integer" }, "exp_year": { "description": "Four-digit number representing the card's expiration year.", "type": "integer" }, "extended_authorization": { "$ref": "#/components/schemas/payment_flows_private_payment_methods_card_details_api_resource_enterprise_features_extended_authorization_extended_authorization" }, "fingerprint": { "description": "Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.\n\n*As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*", "maxLength": 5000, "nullable": true, "type": "string" }, "funding": { "description": "Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.", "maxLength": 5000, "nullable": true, "type": "string" }, "iin": { "description": "Issuer identification number of the card. (For internal use only and not typically available in standard API requests.)", "maxLength": 5000, "nullable": true, "type": "string" }, "incremental_authorization": { "$ref": "#/components/schemas/payment_flows_private_payment_methods_card_details_api_resource_enterprise_features_incremental_authorization_incremental_authorization" }, "installments": { "anyOf": [ { "$ref": "#/components/schemas/payment_method_details_card_installments" } ], "description": "Installment details for this payment.\n\nFor more information, see the [installments integration guide](https://stripe.com/docs/payments/installments).", "nullable": true }, "issuer": { "description": "The name of the card's issuing bank. (For internal use only and not typically available in standard API requests.)", "maxLength": 5000, "nullable": true, "type": "string" }, "last4": { "description": "The last four digits of the card.", "maxLength": 5000, "nullable": true, "type": "string" }, "mandate": { "description": "ID of the mandate used to make this payment or created by it.", "maxLength": 5000, "nullable": true, "type": "string" }, "moto": { "description": "True if this payment was marked as MOTO and out of scope for SCA.", "nullable": true, "type": "boolean" }, "multicapture": { "$ref": "#/components/schemas/payment_flows_private_payment_methods_card_details_api_resource_multicapture" }, "network": { "description": "Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.", "maxLength": 5000, "nullable": true, "type": "string" }, "network_token": { "anyOf": [ { "$ref": "#/components/schemas/payment_method_details_card_network_token" } ], "description": "If this card has network token credentials, this contains the details of the network token credentials.", "nullable": true }, "network_transaction_id": { "description": "This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. This value will be present if it is returned by the financial network in the authorization response, and null otherwise.", "maxLength": 5000, "nullable": true, "type": "string" }, "overcapture": { "$ref": "#/components/schemas/payment_flows_private_payment_methods_card_details_api_resource_enterprise_features_overcapture_overcapture" }, "partial_authorization": { "$ref": "#/components/schemas/payment_flows_private_payment_methods_card_details_api_resource_enterprise_features_partial_authorization_partial_authorization" }, "regulated_status": { "description": "Status of a card based on the card issuer.", "enum": [ "regulated", "unregulated" ], "nullable": true, "type": "string" }, "three_d_secure": { "anyOf": [ { "$ref": "#/components/schemas/three_d_secure_details_charge" } ], "description": "Populated if this transaction used 3D Secure authentication.", "nullable": true }, "wallet": { "anyOf": [ { "$ref": "#/components/schemas/payment_method_details_card_wallet" } ], "description": "If this Card is part of a card wallet, this contains the details of the card wallet.", "nullable": true } }, "required": [ "amount_authorized", "authorization_code", "brand", "checks", "country", "exp_month", "exp_year", "funding", "installments", "last4", "mandate", "network", "network_transaction_id", "regulated_status", "three_d_secure", "wallet" ], "title": "payment_method_details_card", "type": "object", "x-expandableFields": [ "checks", "decremental_authorization", "extended_authorization", "incremental_authorization", "installments", "multicapture", "network_token", "overcapture", "partial_authorization", "three_d_secure", "wallet" ], "x-stripeMostCommon": [ "amount_authorized", "amount_requested", "authorization_code", "brand", "capture_before", "checks", "country", "decremental_authorization", "description", "exp_month", "exp_year", "extended_authorization", "fingerprint", "funding", "iin", "incremental_authorization", "installments", "issuer", "last4", "mandate", "moto", "multicapture", "network", "network_token", "network_transaction_id", "overcapture", "partial_authorization", "regulated_status", "three_d_secure", "wallet" ] }, "payment_method_details_card_checks": { "description": "", "properties": { "address_line1_check": { "description": "If a address line1 was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.", "maxLength": 5000, "nullable": true, "type": "string" }, "address_postal_code_check": { "description": "If a address postal code was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.", "maxLength": 5000, "nullable": true, "type": "string" }, "cvc_check": { "description": "If a CVC was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "address_line1_check", "address_postal_code_check", "cvc_check" ], "title": "payment_method_details_card_checks", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "address_line1_check", "address_postal_code_check", "cvc_check" ] }, "payment_method_details_card_installments": { "description": "", "properties": { "plan": { "anyOf": [ { "$ref": "#/components/schemas/payment_method_details_card_installments_plan" } ], "description": "Installment plan selected for the payment.", "nullable": true } }, "required": [ "plan" ], "title": "payment_method_details_card_installments", "type": "object", "x-expandableFields": [ "plan" ], "x-stripeMostCommon": [ "plan" ] }, "payment_method_details_card_installments_plan": { "description": "", "properties": { "count": { "description": "For `fixed_count` installment plans, this is the number of installment payments your customer will make to their credit card.", "nullable": true, "type": "integer" }, "interval": { "description": "For `fixed_count` installment plans, this is the interval between installment payments your customer will make to their credit card.\nOne of `month`.", "enum": [ "month" ], "nullable": true, "type": "string" }, "type": { "description": "Type of installment plan, one of `fixed_count`, `bonus`, or `revolving`.", "enum": [ "bonus", "fixed_count", "revolving" ], "type": "string" } }, "required": [ "count", "interval", "type" ], "title": "payment_method_details_card_installments_plan", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "count", "interval", "type" ] }, "payment_method_details_card_network_token": { "description": "", "properties": { "used": { "description": "Indicates if Stripe used a network token, either user provided or Stripe managed when processing the transaction.", "type": "boolean" } }, "required": [ "used" ], "title": "payment_method_details_card_network_token", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "used" ] }, "payment_method_details_card_present": { "description": "", "properties": { "amount_authorized": { "description": "The authorized amount", "nullable": true, "type": "integer" }, "brand": { "description": "Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`.", "maxLength": 5000, "nullable": true, "type": "string" }, "brand_product": { "description": "The [product code](https://stripe.com/docs/card-product-codes) that identifies the specific program or product associated with a card.", "maxLength": 5000, "nullable": true, "type": "string" }, "capture_before": { "description": "When using manual capture, a future timestamp after which the charge will be automatically refunded if uncaptured.", "format": "unix-time", "type": "integer" }, "cardholder_name": { "description": "The cardholder name as read from the card, in [ISO 7813](https://en.wikipedia.org/wiki/ISO/IEC_7813) format. May include alphanumeric characters, special characters and first/last name separator (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay.", "maxLength": 5000, "nullable": true, "type": "string" }, "country": { "description": "Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.", "maxLength": 5000, "nullable": true, "type": "string" }, "description": { "description": "A high-level description of the type of cards issued in this range. (For internal use only and not typically available in standard API requests.)", "maxLength": 5000, "nullable": true, "type": "string" }, "emv_auth_data": { "description": "Authorization response cryptogram.", "maxLength": 5000, "nullable": true, "type": "string" }, "exp_month": { "description": "Two-digit number representing the card's expiration month.", "type": "integer" }, "exp_year": { "description": "Four-digit number representing the card's expiration year.", "type": "integer" }, "fingerprint": { "description": "Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.\n\n*As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*", "maxLength": 5000, "nullable": true, "type": "string" }, "funding": { "description": "Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.", "maxLength": 5000, "nullable": true, "type": "string" }, "generated_card": { "description": "ID of a card PaymentMethod generated from the card_present PaymentMethod that may be attached to a Customer for future transactions. Only present if it was possible to generate a card PaymentMethod.", "maxLength": 5000, "nullable": true, "type": "string" }, "iin": { "description": "Issuer identification number of the card. (For internal use only and not typically available in standard API requests.)", "maxLength": 5000, "nullable": true, "type": "string" }, "incremental_authorization_supported": { "description": "Whether this [PaymentIntent](https://stripe.com/docs/api/payment_intents) is eligible for incremental authorizations. Request support using [request_incremental_authorization_support](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-payment_method_options-card_present-request_incremental_authorization_support).", "type": "boolean" }, "issuer": { "description": "The name of the card's issuing bank. (For internal use only and not typically available in standard API requests.)", "maxLength": 5000, "nullable": true, "type": "string" }, "last4": { "description": "The last four digits of the card.", "maxLength": 5000, "nullable": true, "type": "string" }, "network": { "description": "Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.", "maxLength": 5000, "nullable": true, "type": "string" }, "network_transaction_id": { "description": "This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. This value will be present if it is returned by the financial network in the authorization response, and null otherwise.", "maxLength": 5000, "nullable": true, "type": "string" }, "offline": { "anyOf": [ { "$ref": "#/components/schemas/payment_method_details_card_present_offline" } ], "description": "Details about payments collected offline.", "nullable": true }, "overcapture_supported": { "description": "Defines whether the authorized amount can be over-captured or not", "type": "boolean" }, "preferred_locales": { "description": "The languages that the issuing bank recommends using for localizing any customer-facing text, as read from the card. Referenced from EMV tag 5F2D, data encoded on the card's chip.", "items": { "maxLength": 5000, "type": "string" }, "nullable": true, "type": "array" }, "read_method": { "description": "How card details were read in this transaction.", "enum": [ "contact_emv", "contactless_emv", "contactless_magstripe_mode", "magnetic_stripe_fallback", "magnetic_stripe_track2" ], "nullable": true, "type": "string" }, "receipt": { "anyOf": [ { "$ref": "#/components/schemas/payment_method_details_card_present_receipt" } ], "description": "A collection of fields required to be displayed on receipts. Only required for EMV transactions.", "nullable": true }, "wallet": { "$ref": "#/components/schemas/payment_flows_private_payment_methods_card_present_common_wallet" } }, "required": [ "amount_authorized", "brand", "brand_product", "cardholder_name", "country", "emv_auth_data", "exp_month", "exp_year", "fingerprint", "funding", "generated_card", "incremental_authorization_supported", "last4", "network", "network_transaction_id", "offline", "overcapture_supported", "preferred_locales", "read_method", "receipt" ], "title": "payment_method_details_card_present", "type": "object", "x-expandableFields": [ "offline", "receipt", "wallet" ], "x-stripeMostCommon": [ "amount_authorized", "brand", "brand_product", "capture_before", "cardholder_name", "country", "description", "emv_auth_data", "exp_month", "exp_year", "fingerprint", "funding", "generated_card", "iin", "incremental_authorization_supported", "issuer", "last4", "network", "network_transaction_id", "offline", "overcapture_supported", "preferred_locales", "read_method", "receipt", "wallet" ] }, "payment_method_details_card_present_offline": { "description": "", "properties": { "stored_at": { "description": "Time at which the payment was collected while offline", "format": "unix-time", "nullable": true, "type": "integer" }, "type": { "description": "The method used to process this payment method offline. Only deferred is allowed.", "enum": [ "deferred" ], "nullable": true, "type": "string" } }, "required": [ "stored_at", "type" ], "title": "payment_method_details_card_present_offline", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "stored_at", "type" ], "x-stripeResource": { "class_name": "Offline", "in_package": "" } }, "payment_method_details_card_present_receipt": { "description": "", "properties": { "account_type": { "description": "The type of account being debited or credited", "enum": [ "checking", "credit", "prepaid", "unknown" ], "type": "string", "x-stripeBypassValidation": true }, "application_cryptogram": { "description": "The Application Cryptogram, a unique value generated by the card to authenticate the transaction with issuers.", "maxLength": 5000, "nullable": true, "type": "string" }, "application_preferred_name": { "description": "The Application Identifier (AID) on the card used to determine which networks are eligible to process the transaction. Referenced from EMV tag 9F12, data encoded on the card's chip.", "maxLength": 5000, "nullable": true, "type": "string" }, "authorization_code": { "description": "Identifier for this transaction.", "maxLength": 5000, "nullable": true, "type": "string" }, "authorization_response_code": { "description": "EMV tag 8A. A code returned by the card issuer.", "maxLength": 5000, "nullable": true, "type": "string" }, "cardholder_verification_method": { "description": "Describes the method used by the cardholder to verify ownership of the card. One of the following: `approval`, `failure`, `none`, `offline_pin`, `offline_pin_and_signature`, `online_pin`, or `signature`.", "maxLength": 5000, "nullable": true, "type": "string" }, "dedicated_file_name": { "description": "Similar to the application_preferred_name, identifying the applications (AIDs) available on the card. Referenced from EMV tag 84.", "maxLength": 5000, "nullable": true, "type": "string" }, "terminal_verification_results": { "description": "A 5-byte string that records the checks and validations that occur between the card and the terminal. These checks determine how the terminal processes the transaction and what risk tolerance is acceptable. Referenced from EMV Tag 95.", "maxLength": 5000, "nullable": true, "type": "string" }, "transaction_status_information": { "description": "An indication of which steps were completed during the card read process. Referenced from EMV Tag 9B.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "application_cryptogram", "application_preferred_name", "authorization_code", "authorization_response_code", "cardholder_verification_method", "dedicated_file_name", "terminal_verification_results", "transaction_status_information" ], "title": "payment_method_details_card_present_receipt", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "account_type", "application_cryptogram", "application_preferred_name", "authorization_code", "authorization_response_code", "cardholder_verification_method", "dedicated_file_name", "terminal_verification_results", "transaction_status_information" ] }, "payment_method_details_card_wallet": { "description": "", "properties": { "amex_express_checkout": { "$ref": "#/components/schemas/payment_method_details_card_wallet_amex_express_checkout" }, "apple_pay": { "$ref": "#/components/schemas/payment_method_details_card_wallet_apple_pay" }, "dynamic_last4": { "description": "(For tokenized numbers only.) The last four digits of the device account number.", "maxLength": 5000, "nullable": true, "type": "string" }, "google_pay": { "$ref": "#/components/schemas/payment_method_details_card_wallet_google_pay" }, "link": { "$ref": "#/components/schemas/payment_method_details_card_wallet_link" }, "masterpass": { "$ref": "#/components/schemas/payment_method_details_card_wallet_masterpass" }, "samsung_pay": { "$ref": "#/components/schemas/payment_method_details_card_wallet_samsung_pay" }, "type": { "description": "The type of the card wallet, one of `amex_express_checkout`, `apple_pay`, `google_pay`, `masterpass`, `samsung_pay`, `visa_checkout`, or `link`. An additional hash is included on the Wallet subhash with a name matching this value. It contains additional information specific to the card wallet type.", "enum": [ "amex_express_checkout", "apple_pay", "google_pay", "link", "masterpass", "samsung_pay", "visa_checkout" ], "type": "string" }, "visa_checkout": { "$ref": "#/components/schemas/payment_method_details_card_wallet_visa_checkout" } }, "required": [ "dynamic_last4", "type" ], "title": "payment_method_details_card_wallet", "type": "object", "x-expandableFields": [ "amex_express_checkout", "apple_pay", "google_pay", "link", "masterpass", "samsung_pay", "visa_checkout" ], "x-stripeMostCommon": [ "amex_express_checkout", "apple_pay", "dynamic_last4", "google_pay", "link", "masterpass", "samsung_pay", "type", "visa_checkout" ] }, "payment_method_details_card_wallet_amex_express_checkout": { "description": "", "properties": {}, "title": "payment_method_details_card_wallet_amex_express_checkout", "type": "object", "x-expandableFields": [] }, "payment_method_details_card_wallet_apple_pay": { "description": "", "properties": {}, "title": "payment_method_details_card_wallet_apple_pay", "type": "object", "x-expandableFields": [] }, "payment_method_details_card_wallet_google_pay": { "description": "", "properties": {}, "title": "payment_method_details_card_wallet_google_pay", "type": "object", "x-expandableFields": [] }, "payment_method_details_card_wallet_link": { "description": "", "properties": {}, "title": "payment_method_details_card_wallet_link", "type": "object", "x-expandableFields": [] }, "payment_method_details_card_wallet_masterpass": { "description": "", "properties": { "billing_address": { "anyOf": [ { "$ref": "#/components/schemas/address" } ], "description": "Owner's verified billing address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.", "nullable": true }, "email": { "description": "Owner's verified email. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.", "maxLength": 5000, "nullable": true, "type": "string" }, "name": { "description": "Owner's verified full name. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.", "maxLength": 5000, "nullable": true, "type": "string" }, "shipping_address": { "anyOf": [ { "$ref": "#/components/schemas/address" } ], "description": "Owner's verified shipping address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.", "nullable": true } }, "required": [ "billing_address", "email", "name", "shipping_address" ], "title": "payment_method_details_card_wallet_masterpass", "type": "object", "x-expandableFields": [ "billing_address", "shipping_address" ], "x-stripeMostCommon": [ "billing_address", "email", "name", "shipping_address" ] }, "payment_method_details_card_wallet_samsung_pay": { "description": "", "properties": {}, "title": "payment_method_details_card_wallet_samsung_pay", "type": "object", "x-expandableFields": [] }, "payment_method_details_card_wallet_visa_checkout": { "description": "", "properties": { "billing_address": { "anyOf": [ { "$ref": "#/components/schemas/address" } ], "description": "Owner's verified billing address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.", "nullable": true }, "email": { "description": "Owner's verified email. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.", "maxLength": 5000, "nullable": true, "type": "string" }, "name": { "description": "Owner's verified full name. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.", "maxLength": 5000, "nullable": true, "type": "string" }, "shipping_address": { "anyOf": [ { "$ref": "#/components/schemas/address" } ], "description": "Owner's verified shipping address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.", "nullable": true } }, "required": [ "billing_address", "email", "name", "shipping_address" ], "title": "payment_method_details_card_wallet_visa_checkout", "type": "object", "x-expandableFields": [ "billing_address", "shipping_address" ], "x-stripeMostCommon": [ "billing_address", "email", "name", "shipping_address" ] }, "payment_method_details_cashapp": { "description": "", "properties": { "buyer_id": { "description": "A unique and immutable identifier assigned by Cash App to every buyer.", "maxLength": 5000, "nullable": true, "type": "string" }, "cashtag": { "description": "A public identifier for buyers using Cash App.", "maxLength": 5000, "nullable": true, "type": "string" }, "transaction_id": { "description": "A unique and immutable identifier of payments assigned by Cash App", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "buyer_id", "cashtag", "transaction_id" ], "title": "payment_method_details_cashapp", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "buyer_id", "cashtag", "transaction_id" ] }, "payment_method_details_crypto": { "description": "", "properties": { "buyer_address": { "description": "The wallet address of the customer.", "maxLength": 5000, "type": "string" }, "network": { "description": "The blockchain network that the transaction was sent on.", "enum": [ "base", "ethereum", "polygon" ], "type": "string" }, "token_currency": { "description": "The token currency that the transaction was sent with.", "enum": [ "usdc", "usdg", "usdp" ], "type": "string" }, "transaction_hash": { "description": "The blockchain transaction hash of the crypto payment.", "maxLength": 5000, "type": "string" } }, "title": "payment_method_details_crypto", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "buyer_address", "network", "token_currency", "transaction_hash" ], "x-stripeResource": { "class_name": "Crypto", "in_package": "" } }, "payment_method_details_customer_balance": { "description": "", "properties": {}, "title": "payment_method_details_customer_balance", "type": "object", "x-expandableFields": [] }, "payment_method_details_eps": { "description": "", "properties": { "bank": { "description": "The customer's bank. Should be one of `arzte_und_apotheker_bank`, `austrian_anadi_bank_ag`, `bank_austria`, `bankhaus_carl_spangler`, `bankhaus_schelhammer_und_schattera_ag`, `bawag_psk_ag`, `bks_bank_ag`, `brull_kallmus_bank_ag`, `btv_vier_lander_bank`, `capital_bank_grawe_gruppe_ag`, `deutsche_bank_ag`, `dolomitenbank`, `easybank_ag`, `erste_bank_und_sparkassen`, `hypo_alpeadriabank_international_ag`, `hypo_noe_lb_fur_niederosterreich_u_wien`, `hypo_oberosterreich_salzburg_steiermark`, `hypo_tirol_bank_ag`, `hypo_vorarlberg_bank_ag`, `hypo_bank_burgenland_aktiengesellschaft`, `marchfelder_bank`, `oberbank_ag`, `raiffeisen_bankengruppe_osterreich`, `schoellerbank_ag`, `sparda_bank_wien`, `volksbank_gruppe`, `volkskreditbank_ag`, or `vr_bank_braunau`.", "enum": [ "arzte_und_apotheker_bank", "austrian_anadi_bank_ag", "bank_austria", "bankhaus_carl_spangler", "bankhaus_schelhammer_und_schattera_ag", "bawag_psk_ag", "bks_bank_ag", "brull_kallmus_bank_ag", "btv_vier_lander_bank", "capital_bank_grawe_gruppe_ag", "deutsche_bank_ag", "dolomitenbank", "easybank_ag", "erste_bank_und_sparkassen", "hypo_alpeadriabank_international_ag", "hypo_bank_burgenland_aktiengesellschaft", "hypo_noe_lb_fur_niederosterreich_u_wien", "hypo_oberosterreich_salzburg_steiermark", "hypo_tirol_bank_ag", "hypo_vorarlberg_bank_ag", "marchfelder_bank", "oberbank_ag", "raiffeisen_bankengruppe_osterreich", "schoellerbank_ag", "sparda_bank_wien", "volksbank_gruppe", "volkskreditbank_ag", "vr_bank_braunau" ], "nullable": true, "type": "string" }, "verified_name": { "description": "Owner's verified full name. Values are verified or provided by EPS directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated.\nEPS rarely provides this information so the attribute is usually empty.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "bank", "verified_name" ], "title": "payment_method_details_eps", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "bank", "verified_name" ] }, "payment_method_details_fpx": { "description": "", "properties": { "account_holder_type": { "description": "Account holder type, if provided. Can be one of `individual` or `company`.", "enum": [ "company", "individual" ], "nullable": true, "type": "string" }, "bank": { "description": "The customer's bank. Can be one of `affin_bank`, `agrobank`, `alliance_bank`, `ambank`, `bank_islam`, `bank_muamalat`, `bank_rakyat`, `bsn`, `cimb`, `hong_leong_bank`, `hsbc`, `kfh`, `maybank2u`, `ocbc`, `public_bank`, `rhb`, `standard_chartered`, `uob`, `deutsche_bank`, `maybank2e`, `pb_enterprise`, or `bank_of_china`.", "enum": [ "affin_bank", "agrobank", "alliance_bank", "ambank", "bank_islam", "bank_muamalat", "bank_of_china", "bank_rakyat", "bsn", "cimb", "deutsche_bank", "hong_leong_bank", "hsbc", "kfh", "maybank2e", "maybank2u", "ocbc", "pb_enterprise", "public_bank", "rhb", "standard_chartered", "uob" ], "type": "string" }, "transaction_id": { "description": "Unique transaction id generated by FPX for every request from the merchant", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "account_holder_type", "bank", "transaction_id" ], "title": "payment_method_details_fpx", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "account_holder_type", "bank", "transaction_id" ] }, "payment_method_details_giropay": { "description": "", "properties": { "bank_code": { "description": "Bank code of bank associated with the bank account.", "maxLength": 5000, "nullable": true, "type": "string" }, "bank_name": { "description": "Name of the bank associated with the bank account.", "maxLength": 5000, "nullable": true, "type": "string" }, "bic": { "description": "Bank Identifier Code of the bank associated with the bank account.", "maxLength": 5000, "nullable": true, "type": "string" }, "verified_name": { "description": "Owner's verified full name. Values are verified or provided by Giropay directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated.\nGiropay rarely provides this information so the attribute is usually empty.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "bank_code", "bank_name", "bic", "verified_name" ], "title": "payment_method_details_giropay", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "bank_code", "bank_name", "bic", "verified_name" ] }, "payment_method_details_gopay": { "description": "", "properties": {}, "title": "payment_method_details_gopay", "type": "object", "x-expandableFields": [], "x-stripeResource": { "class_name": "Gopay", "in_package": "" } }, "payment_method_details_grabpay": { "description": "", "properties": { "transaction_id": { "description": "Unique transaction id generated by GrabPay", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "transaction_id" ], "title": "payment_method_details_grabpay", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "transaction_id" ] }, "payment_method_details_id_bank_transfer": { "description": "", "properties": { "account_number": { "description": "Account number of the bank account to transfer funds to.", "maxLength": 5000, "type": "string" }, "bank": { "description": "Bank where the account is located.", "enum": [ "bca", "bni", "bri", "cimb", "permata" ], "type": "string", "x-stripeBypassValidation": true }, "bank_code": { "description": "Local bank code of the bank.", "maxLength": 5000, "type": "string" }, "bank_name": { "description": "Name of the bank associated with the bank account.", "maxLength": 5000, "type": "string" }, "display_name": { "description": "Merchant name and billing details name, for the customer to check for the correct merchant when performing the bank transfer.", "maxLength": 5000, "type": "string" } }, "required": [ "account_number", "bank" ], "title": "payment_method_details_id_bank_transfer", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "account_number", "bank", "bank_code", "bank_name", "display_name" ] }, "payment_method_details_ideal": { "description": "", "properties": { "bank": { "description": "The customer's bank. Can be one of `abn_amro`, `asn_bank`, `bunq`, `buut`, `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`.", "enum": [ "abn_amro", "asn_bank", "bunq", "buut", "handelsbanken", "ing", "knab", "moneyou", "n26", "nn", "rabobank", "regiobank", "revolut", "sns_bank", "triodos_bank", "van_lanschot", "yoursafe" ], "nullable": true, "type": "string" }, "bic": { "description": "The Bank Identifier Code of the customer's bank.", "enum": [ "ABNANL2A", "ASNBNL21", "BITSNL2A", "BUNQNL2A", "BUUTNL2A", "FVLBNL22", "HANDNL2A", "INGBNL2A", "KNABNL2H", "MOYONL21", "NNBANL2G", "NTSBDEB1", "RABONL2U", "RBRBNL21", "REVOIE23", "REVOLT21", "SNSBNL2A", "TRIONL2U" ], "nullable": true, "type": "string" }, "generated_sepa_debit": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/payment_method" } ], "description": "The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/payment_method" } ] } }, "generated_sepa_debit_mandate": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/mandate" } ], "description": "The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/mandate" } ] } }, "iban_last4": { "description": "Last four characters of the IBAN.", "maxLength": 5000, "nullable": true, "type": "string" }, "verified_name": { "description": "Owner's verified full name. Values are verified or provided by iDEAL directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "bank", "bic", "generated_sepa_debit", "generated_sepa_debit_mandate", "iban_last4", "verified_name" ], "title": "payment_method_details_ideal", "type": "object", "x-expandableFields": [ "generated_sepa_debit", "generated_sepa_debit_mandate" ], "x-stripeMostCommon": [ "bank", "bic", "generated_sepa_debit", "generated_sepa_debit_mandate", "iban_last4", "verified_name" ] }, "payment_method_details_interac_present": { "description": "", "properties": { "brand": { "description": "Card brand. Can be `interac`, `mastercard` or `visa`.", "maxLength": 5000, "nullable": true, "type": "string" }, "cardholder_name": { "description": "The cardholder name as read from the card, in [ISO 7813](https://en.wikipedia.org/wiki/ISO/IEC_7813) format. May include alphanumeric characters, special characters and first/last name separator (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay.", "maxLength": 5000, "nullable": true, "type": "string" }, "country": { "description": "Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.", "maxLength": 5000, "nullable": true, "type": "string" }, "description": { "description": "A high-level description of the type of cards issued in this range. (For internal use only and not typically available in standard API requests.)", "maxLength": 5000, "nullable": true, "type": "string" }, "emv_auth_data": { "description": "Authorization response cryptogram.", "maxLength": 5000, "nullable": true, "type": "string" }, "exp_month": { "description": "Two-digit number representing the card's expiration month.", "type": "integer" }, "exp_year": { "description": "Four-digit number representing the card's expiration year.", "type": "integer" }, "fingerprint": { "description": "Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.\n\n*As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*", "maxLength": 5000, "nullable": true, "type": "string" }, "funding": { "description": "Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.", "maxLength": 5000, "nullable": true, "type": "string" }, "generated_card": { "description": "ID of a card PaymentMethod generated from the card_present PaymentMethod that may be attached to a Customer for future transactions. Only present if it was possible to generate a card PaymentMethod.", "maxLength": 5000, "nullable": true, "type": "string" }, "iin": { "description": "Issuer identification number of the card. (For internal use only and not typically available in standard API requests.)", "maxLength": 5000, "nullable": true, "type": "string" }, "issuer": { "description": "The name of the card's issuing bank. (For internal use only and not typically available in standard API requests.)", "maxLength": 5000, "nullable": true, "type": "string" }, "last4": { "description": "The last four digits of the card.", "maxLength": 5000, "nullable": true, "type": "string" }, "network": { "description": "Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.", "maxLength": 5000, "nullable": true, "type": "string" }, "network_transaction_id": { "description": "This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. This value will be present if it is returned by the financial network in the authorization response, and null otherwise.", "maxLength": 5000, "nullable": true, "type": "string" }, "preferred_locales": { "description": "The languages that the issuing bank recommends using for localizing any customer-facing text, as read from the card. Referenced from EMV tag 5F2D, data encoded on the card's chip.", "items": { "maxLength": 5000, "type": "string" }, "nullable": true, "type": "array" }, "read_method": { "description": "How card details were read in this transaction.", "enum": [ "contact_emv", "contactless_emv", "contactless_magstripe_mode", "magnetic_stripe_fallback", "magnetic_stripe_track2" ], "nullable": true, "type": "string" }, "receipt": { "anyOf": [ { "$ref": "#/components/schemas/payment_method_details_interac_present_receipt" } ], "description": "A collection of fields required to be displayed on receipts. Only required for EMV transactions.", "nullable": true } }, "required": [ "brand", "cardholder_name", "country", "emv_auth_data", "exp_month", "exp_year", "fingerprint", "funding", "generated_card", "last4", "network", "network_transaction_id", "preferred_locales", "read_method", "receipt" ], "title": "payment_method_details_interac_present", "type": "object", "x-expandableFields": [ "receipt" ], "x-stripeMostCommon": [ "brand", "cardholder_name", "country", "description", "emv_auth_data", "exp_month", "exp_year", "fingerprint", "funding", "generated_card", "iin", "issuer", "last4", "network", "network_transaction_id", "preferred_locales", "read_method", "receipt" ] }, "payment_method_details_interac_present_receipt": { "description": "", "properties": { "account_type": { "description": "The type of account being debited or credited", "enum": [ "checking", "savings", "unknown" ], "type": "string", "x-stripeBypassValidation": true }, "application_cryptogram": { "description": "The Application Cryptogram, a unique value generated by the card to authenticate the transaction with issuers.", "maxLength": 5000, "nullable": true, "type": "string" }, "application_preferred_name": { "description": "The Application Identifier (AID) on the card used to determine which networks are eligible to process the transaction. Referenced from EMV tag 9F12, data encoded on the card's chip.", "maxLength": 5000, "nullable": true, "type": "string" }, "authorization_code": { "description": "Identifier for this transaction.", "maxLength": 5000, "nullable": true, "type": "string" }, "authorization_response_code": { "description": "EMV tag 8A. A code returned by the card issuer.", "maxLength": 5000, "nullable": true, "type": "string" }, "cardholder_verification_method": { "description": "Describes the method used by the cardholder to verify ownership of the card. One of the following: `approval`, `failure`, `none`, `offline_pin`, `offline_pin_and_signature`, `online_pin`, or `signature`.", "maxLength": 5000, "nullable": true, "type": "string" }, "dedicated_file_name": { "description": "Similar to the application_preferred_name, identifying the applications (AIDs) available on the card. Referenced from EMV tag 84.", "maxLength": 5000, "nullable": true, "type": "string" }, "terminal_verification_results": { "description": "A 5-byte string that records the checks and validations that occur between the card and the terminal. These checks determine how the terminal processes the transaction and what risk tolerance is acceptable. Referenced from EMV Tag 95.", "maxLength": 5000, "nullable": true, "type": "string" }, "transaction_status_information": { "description": "An indication of which steps were completed during the card read process. Referenced from EMV Tag 9B.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "application_cryptogram", "application_preferred_name", "authorization_code", "authorization_response_code", "cardholder_verification_method", "dedicated_file_name", "terminal_verification_results", "transaction_status_information" ], "title": "payment_method_details_interac_present_receipt", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "account_type", "application_cryptogram", "application_preferred_name", "authorization_code", "authorization_response_code", "cardholder_verification_method", "dedicated_file_name", "terminal_verification_results", "transaction_status_information" ], "x-stripeResource": { "class_name": "Receipt", "in_package": "" } }, "payment_method_details_kakao_pay": { "description": "", "properties": { "buyer_id": { "description": "A unique identifier for the buyer as determined by the local payment processor.", "maxLength": 5000, "nullable": true, "type": "string" }, "transaction_id": { "description": "The Kakao Pay transaction ID associated with this payment.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "buyer_id", "transaction_id" ], "title": "payment_method_details_kakao_pay", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "buyer_id", "transaction_id" ], "x-stripeResource": { "class_name": "KakaoPay", "in_package": "" } }, "payment_method_details_klarna": { "description": "", "properties": { "payer_details": { "anyOf": [ { "$ref": "#/components/schemas/klarna_payer_details" } ], "description": "The payer details for this transaction.", "nullable": true }, "payment_method_category": { "description": "The Klarna payment method used for this transaction.\nCan be one of `pay_later`, `pay_now`, `pay_with_financing`, or `pay_in_installments`", "maxLength": 5000, "nullable": true, "type": "string" }, "preferred_locale": { "description": "Preferred language of the Klarna authorization page that the customer is redirected to.\nCan be one of `de-AT`, `en-AT`, `nl-BE`, `fr-BE`, `en-BE`, `de-DE`, `en-DE`, `da-DK`, `en-DK`, `es-ES`, `en-ES`, `fi-FI`, `sv-FI`, `en-FI`, `en-GB`, `en-IE`, `it-IT`, `en-IT`, `nl-NL`, `en-NL`, `nb-NO`, `en-NO`, `sv-SE`, `en-SE`, `en-US`, `es-US`, `fr-FR`, `en-FR`, `cs-CZ`, `en-CZ`, `ro-RO`, `en-RO`, `el-GR`, `en-GR`, `en-AU`, `en-NZ`, `en-CA`, `fr-CA`, `pl-PL`, `en-PL`, `pt-PT`, `en-PT`, `de-CH`, `fr-CH`, `it-CH`, or `en-CH`", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "payer_details", "payment_method_category", "preferred_locale" ], "title": "payment_method_details_klarna", "type": "object", "x-expandableFields": [ "payer_details" ], "x-stripeMostCommon": [ "payer_details", "payment_method_category", "preferred_locale" ] }, "payment_method_details_konbini": { "description": "", "properties": { "store": { "anyOf": [ { "$ref": "#/components/schemas/payment_method_details_konbini_store" } ], "description": "If the payment succeeded, this contains the details of the convenience store where the payment was completed.", "nullable": true } }, "required": [ "store" ], "title": "payment_method_details_konbini", "type": "object", "x-expandableFields": [ "store" ], "x-stripeMostCommon": [ "store" ] }, "payment_method_details_konbini_store": { "description": "", "properties": { "chain": { "description": "The name of the convenience store chain where the payment was completed.", "enum": [ "familymart", "lawson", "ministop", "seicomart" ], "nullable": true, "type": "string" } }, "required": [ "chain" ], "title": "payment_method_details_konbini_store", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "chain" ] }, "payment_method_details_kr_card": { "description": "", "properties": { "brand": { "description": "The local credit or debit card brand.", "enum": [ "bc", "citi", "hana", "hyundai", "jeju", "jeonbuk", "kakaobank", "kbank", "kdbbank", "kookmin", "kwangju", "lotte", "mg", "nh", "post", "samsung", "savingsbank", "shinhan", "shinhyup", "suhyup", "tossbank", "woori" ], "nullable": true, "type": "string" }, "buyer_id": { "description": "A unique identifier for the buyer as determined by the local payment processor.", "maxLength": 5000, "nullable": true, "type": "string" }, "last4": { "description": "The last four digits of the card. This may not be present for American Express cards.", "maxLength": 4, "nullable": true, "type": "string" }, "transaction_id": { "description": "The Korean Card transaction ID associated with this payment.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "brand", "buyer_id", "last4", "transaction_id" ], "title": "payment_method_details_kr_card", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "brand", "buyer_id", "last4", "transaction_id" ], "x-stripeResource": { "class_name": "KrCard", "in_package": "" } }, "payment_method_details_link": { "description": "", "properties": { "country": { "description": "Two-letter ISO code representing the funding source country beneath the Link payment.\nYou could use this attribute to get a sense of international fees.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "country" ], "title": "payment_method_details_link", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "country" ] }, "payment_method_details_mb_way": { "description": "", "properties": {}, "title": "payment_method_details_mb_way", "type": "object", "x-expandableFields": [], "x-stripeResource": { "class_name": "MbWay", "in_package": "" } }, "payment_method_details_mobilepay": { "description": "", "properties": { "card": { "anyOf": [ { "$ref": "#/components/schemas/internal_card" } ], "description": "Internal card details", "nullable": true } }, "required": [ "card" ], "title": "payment_method_details_mobilepay", "type": "object", "x-expandableFields": [ "card" ], "x-stripeMostCommon": [ "card" ] }, "payment_method_details_multibanco": { "description": "", "properties": { "entity": { "description": "Entity number associated with this Multibanco payment.", "maxLength": 5000, "nullable": true, "type": "string" }, "reference": { "description": "Reference number associated with this Multibanco payment.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "entity", "reference" ], "title": "payment_method_details_multibanco", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "entity", "reference" ] }, "payment_method_details_naver_pay": { "description": "", "properties": { "buyer_id": { "description": "A unique identifier for the buyer as determined by the local payment processor.", "maxLength": 5000, "nullable": true, "type": "string" }, "transaction_id": { "description": "The Naver Pay transaction ID associated with this payment.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "buyer_id", "transaction_id" ], "title": "payment_method_details_naver_pay", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "buyer_id", "transaction_id" ], "x-stripeResource": { "class_name": "NaverPay", "in_package": "" } }, "payment_method_details_nz_bank_account": { "description": "", "properties": { "account_holder_name": { "description": "The name on the bank account. Only present if the account holder name is different from the name of the authorized signatory collected in the PaymentMethod’s billing details.", "maxLength": 5000, "nullable": true, "type": "string" }, "bank_code": { "description": "The numeric code for the bank account's bank.", "maxLength": 5000, "type": "string" }, "bank_name": { "description": "The name of the bank.", "maxLength": 5000, "type": "string" }, "branch_code": { "description": "The numeric code for the bank account's bank branch.", "maxLength": 5000, "type": "string" }, "last4": { "description": "Last four digits of the bank account number.", "maxLength": 5000, "type": "string" }, "suffix": { "description": "The suffix of the bank account number.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "account_holder_name", "bank_code", "bank_name", "branch_code", "last4", "suffix" ], "title": "payment_method_details_nz_bank_account", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "account_holder_name", "bank_code", "bank_name", "branch_code", "last4", "suffix" ] }, "payment_method_details_oxxo": { "description": "", "properties": { "number": { "description": "OXXO reference number", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "number" ], "title": "payment_method_details_oxxo", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "number" ] }, "payment_method_details_p24": { "description": "", "properties": { "bank": { "description": "The customer's bank. Can be one of `ing`, `citi_handlowy`, `tmobile_usbugi_bankowe`, `plus_bank`, `etransfer_pocztowy24`, `banki_spbdzielcze`, `bank_nowy_bfg_sa`, `getin_bank`, `velobank`, `blik`, `noble_pay`, `ideabank`, `envelobank`, `santander_przelew24`, `nest_przelew`, `mbank_mtransfer`, `inteligo`, `pbac_z_ipko`, `bnp_paribas`, `credit_agricole`, `toyota_bank`, `bank_pekao_sa`, `volkswagen_bank`, `bank_millennium`, `alior_bank`, or `boz`.", "enum": [ "alior_bank", "bank_millennium", "bank_nowy_bfg_sa", "bank_pekao_sa", "banki_spbdzielcze", "blik", "bnp_paribas", "boz", "citi_handlowy", "credit_agricole", "envelobank", "etransfer_pocztowy24", "getin_bank", "ideabank", "ing", "inteligo", "mbank_mtransfer", "nest_przelew", "noble_pay", "pbac_z_ipko", "plus_bank", "santander_przelew24", "tmobile_usbugi_bankowe", "toyota_bank", "velobank", "volkswagen_bank" ], "nullable": true, "type": "string" }, "reference": { "description": "Unique reference for this Przelewy24 payment.", "maxLength": 5000, "nullable": true, "type": "string" }, "verified_name": { "description": "Owner's verified full name. Values are verified or provided by Przelewy24 directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated.\nPrzelewy24 rarely provides this information so the attribute is usually empty.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "bank", "reference", "verified_name" ], "title": "payment_method_details_p24", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "bank", "reference", "verified_name" ] }, "payment_method_details_passthrough_card": { "description": "", "properties": { "brand": { "description": "Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`.", "maxLength": 5000, "nullable": true, "type": "string" }, "brand_product": { "description": "The [product code](https://stripe.com/docs/card-product-codes) that identifies the specific program or product associated with a card. (For internal use only and not typically available in standard API requests.)", "maxLength": 5000, "nullable": true, "type": "string" }, "country": { "description": "Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.", "maxLength": 5000, "nullable": true, "type": "string" }, "exp_month": { "description": "Two-digit number representing the card's expiration month.", "nullable": true, "type": "integer" }, "exp_year": { "description": "Four-digit number representing the card's expiration year.", "nullable": true, "type": "integer" }, "funding": { "description": "Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.", "maxLength": 5000, "nullable": true, "type": "string" }, "last4": { "description": "The last four digits of the card.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "brand", "country", "exp_month", "exp_year", "funding", "last4" ], "title": "payment_method_details_passthrough_card", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "brand", "brand_product", "country", "exp_month", "exp_year", "funding", "last4" ] }, "payment_method_details_pay_by_bank": { "description": "", "properties": {}, "title": "payment_method_details_pay_by_bank", "type": "object", "x-expandableFields": [] }, "payment_method_details_payco": { "description": "", "properties": { "buyer_id": { "description": "A unique identifier for the buyer as determined by the local payment processor.", "maxLength": 5000, "nullable": true, "type": "string" }, "transaction_id": { "description": "The Payco transaction ID associated with this payment.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "buyer_id", "transaction_id" ], "title": "payment_method_details_payco", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "buyer_id", "transaction_id" ], "x-stripeResource": { "class_name": "Payco", "in_package": "" } }, "payment_method_details_paynow": { "description": "", "properties": { "location": { "description": "ID of the [location](https://stripe.com/docs/api/terminal/locations) that this transaction's reader is assigned to.", "maxLength": 5000, "type": "string" }, "reader": { "description": "ID of the [reader](https://stripe.com/docs/api/terminal/readers) this transaction was made on.", "maxLength": 5000, "type": "string" }, "reference": { "description": "Reference number associated with this PayNow payment", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "reference" ], "title": "payment_method_details_paynow", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "location", "reader", "reference" ] }, "payment_method_details_paypal": { "description": "", "properties": { "country": { "description": "Two-letter ISO code representing the buyer's country. Values are provided by PayPal directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.", "maxLength": 5000, "nullable": true, "type": "string" }, "payer_email": { "description": "Owner's email. Values are provided by PayPal directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated.", "maxLength": 5000, "nullable": true, "type": "string" }, "payer_id": { "description": "PayPal account PayerID. This identifier uniquely identifies the PayPal customer.", "maxLength": 5000, "nullable": true, "type": "string" }, "payer_name": { "description": "Owner's full name. Values provided by PayPal directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated.", "maxLength": 5000, "nullable": true, "type": "string" }, "seller_protection": { "anyOf": [ { "$ref": "#/components/schemas/paypal_seller_protection" } ], "description": "The level of protection offered as defined by PayPal Seller Protection for Merchants, for this transaction.", "nullable": true }, "shipping": { "anyOf": [ { "$ref": "#/components/schemas/address" } ], "description": "The shipping address for the customer, as supplied by the merchant at the point of payment\nexecution. This shipping address will not be updated if the merchant updates the shipping\naddress on the PaymentIntent after the PaymentIntent was successfully confirmed.", "nullable": true }, "transaction_id": { "description": "A unique ID generated by PayPal for this transaction.", "maxLength": 5000, "nullable": true, "type": "string" }, "verified_address": { "anyOf": [ { "$ref": "#/components/schemas/address" } ], "description": "The shipping address for the customer, as supplied by the merchant at the point of payment\nexecution. This shipping address will not be updated if the merchant updates the shipping\naddress on the PaymentIntent after the PaymentIntent was successfully confirmed.", "nullable": true }, "verified_email": { "description": "Owner's verified email. Values are verified or provided by PayPal directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated.", "maxLength": 5000, "nullable": true, "type": "string" }, "verified_name": { "description": "Owner's verified full name. Values are verified or provided by PayPal directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "country", "payer_email", "payer_id", "payer_name", "seller_protection", "transaction_id" ], "title": "payment_method_details_paypal", "type": "object", "x-expandableFields": [ "seller_protection", "shipping", "verified_address" ], "x-stripeMostCommon": [ "country", "payer_email", "payer_id", "payer_name", "seller_protection", "shipping", "transaction_id", "verified_address", "verified_email", "verified_name" ] }, "payment_method_details_paypay": { "description": "", "properties": {}, "title": "payment_method_details_paypay", "type": "object", "x-expandableFields": [] }, "payment_method_details_payto": { "description": "", "properties": { "bsb_number": { "description": "Bank-State-Branch number of the bank account.", "maxLength": 5000, "nullable": true, "type": "string" }, "last4": { "description": "Last four digits of the bank account number.", "maxLength": 5000, "nullable": true, "type": "string" }, "mandate": { "description": "ID of the mandate used to make this payment.", "maxLength": 5000, "type": "string" }, "pay_id": { "description": "The PayID alias for the bank account.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "bsb_number", "last4", "pay_id" ], "title": "payment_method_details_payto", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "bsb_number", "last4", "mandate", "pay_id" ] }, "payment_method_details_pix": { "description": "", "properties": { "bank_transaction_id": { "description": "Unique transaction id generated by BCB", "maxLength": 5000, "nullable": true, "type": "string" }, "mandate": { "description": "ID of the multi use Mandate generated by the PaymentIntent", "maxLength": 5000, "type": "string" } }, "title": "payment_method_details_pix", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "bank_transaction_id", "mandate" ] }, "payment_method_details_promptpay": { "description": "", "properties": { "reference": { "description": "Bill reference generated by PromptPay", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "reference" ], "title": "payment_method_details_promptpay", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "reference" ] }, "payment_method_details_qris": { "description": "", "properties": {}, "title": "payment_method_details_qris", "type": "object", "x-expandableFields": [] }, "payment_method_details_rechnung": { "description": "", "properties": {}, "title": "payment_method_details_rechnung", "type": "object", "x-expandableFields": [], "x-stripeResource": { "class_name": "Rechnung", "in_package": "" } }, "payment_method_details_revolut_pay": { "description": "", "properties": { "funding": { "$ref": "#/components/schemas/revolut_pay_underlying_payment_method_funding_details" }, "transaction_id": { "description": "The Revolut Pay transaction ID associated with this payment.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "transaction_id" ], "title": "payment_method_details_revolut_pay", "type": "object", "x-expandableFields": [ "funding" ], "x-stripeMostCommon": [ "funding", "transaction_id" ] }, "payment_method_details_samsung_pay": { "description": "", "properties": { "buyer_id": { "description": "A unique identifier for the buyer as determined by the local payment processor.", "maxLength": 5000, "nullable": true, "type": "string" }, "transaction_id": { "description": "The Samsung Pay transaction ID associated with this payment.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "buyer_id", "transaction_id" ], "title": "payment_method_details_samsung_pay", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "buyer_id", "transaction_id" ], "x-stripeResource": { "class_name": "SamsungPay", "in_package": "" } }, "payment_method_details_satispay": { "description": "", "properties": { "transaction_id": { "description": "The Satispay transaction ID associated with this payment.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "transaction_id" ], "title": "payment_method_details_satispay", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "transaction_id" ] }, "payment_method_details_sepa_credit_transfer": { "description": "", "properties": { "bank_name": { "description": "Name of the bank associated with the bank account.", "maxLength": 5000, "nullable": true, "type": "string" }, "bic": { "description": "Bank Identifier Code of the bank associated with the bank account.", "maxLength": 5000, "nullable": true, "type": "string" }, "iban": { "description": "IBAN of the bank account to transfer funds to.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "bank_name", "bic", "iban" ], "title": "payment_method_details_sepa_credit_transfer", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "bank_name", "bic", "iban" ] }, "payment_method_details_sepa_debit": { "description": "", "properties": { "bank_code": { "description": "Bank code of bank associated with the bank account.", "maxLength": 5000, "nullable": true, "type": "string" }, "branch_code": { "description": "Branch code of bank associated with the bank account.", "maxLength": 5000, "nullable": true, "type": "string" }, "country": { "description": "Two-letter ISO code representing the country the bank account is located in.", "maxLength": 5000, "nullable": true, "type": "string" }, "fingerprint": { "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.", "maxLength": 5000, "nullable": true, "type": "string" }, "last4": { "description": "Last four characters of the IBAN.", "maxLength": 5000, "nullable": true, "type": "string" }, "mandate": { "description": "Find the ID of the mandate used for this payment under the [payment_method_details.sepa_debit.mandate](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-sepa_debit-mandate) property on the Charge. Use this mandate ID to [retrieve the Mandate](https://stripe.com/docs/api/mandates/retrieve).", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "bank_code", "branch_code", "country", "fingerprint", "last4", "mandate" ], "title": "payment_method_details_sepa_debit", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "bank_code", "branch_code", "country", "fingerprint", "last4", "mandate" ] }, "payment_method_details_shopeepay": { "description": "", "properties": {}, "title": "payment_method_details_shopeepay", "type": "object", "x-expandableFields": [], "x-stripeResource": { "class_name": "Shopeepay", "in_package": "" } }, "payment_method_details_sofort": { "description": "", "properties": { "bank_code": { "description": "Bank code of bank associated with the bank account.", "maxLength": 5000, "nullable": true, "type": "string" }, "bank_name": { "description": "Name of the bank associated with the bank account.", "maxLength": 5000, "nullable": true, "type": "string" }, "bic": { "description": "Bank Identifier Code of the bank associated with the bank account.", "maxLength": 5000, "nullable": true, "type": "string" }, "country": { "description": "Two-letter ISO code representing the country the bank account is located in.", "maxLength": 5000, "nullable": true, "type": "string" }, "generated_sepa_debit": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/payment_method" } ], "description": "The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/payment_method" } ] } }, "generated_sepa_debit_mandate": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/mandate" } ], "description": "The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/mandate" } ] } }, "iban_last4": { "description": "Last four characters of the IBAN.", "maxLength": 5000, "nullable": true, "type": "string" }, "preferred_language": { "description": "Preferred language of the SOFORT authorization page that the customer is redirected to.\nCan be one of `de`, `en`, `es`, `fr`, `it`, `nl`, or `pl`", "enum": [ "de", "en", "es", "fr", "it", "nl", "pl" ], "nullable": true, "type": "string" }, "verified_name": { "description": "Owner's verified full name. Values are verified or provided by SOFORT directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "bank_code", "bank_name", "bic", "country", "generated_sepa_debit", "generated_sepa_debit_mandate", "iban_last4", "preferred_language", "verified_name" ], "title": "payment_method_details_sofort", "type": "object", "x-expandableFields": [ "generated_sepa_debit", "generated_sepa_debit_mandate" ], "x-stripeMostCommon": [ "bank_code", "bank_name", "bic", "country", "generated_sepa_debit", "generated_sepa_debit_mandate", "iban_last4", "preferred_language", "verified_name" ] }, "payment_method_details_stripe_account": { "description": "", "properties": {}, "title": "payment_method_details_stripe_account", "type": "object", "x-expandableFields": [] }, "payment_method_details_stripe_balance": { "description": "", "properties": { "account": { "description": "The connected account ID whose Stripe balance to use as the source of payment", "maxLength": 5000, "nullable": true, "type": "string" }, "source_type": { "description": "The [source_type](https://docs.stripe.com/api/balance/balance_object#balance_object-available-source_types) of the balance", "enum": [ "bank_account", "card", "fpx" ], "type": "string" } }, "required": [ "source_type" ], "title": "payment_method_details_stripe_balance", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "account", "source_type" ], "x-stripeResource": { "class_name": "StripeBalance", "in_package": "" } }, "payment_method_details_swish": { "description": "", "properties": { "fingerprint": { "description": "Uniquely identifies the payer's Swish account. You can use this attribute to check whether two Swish transactions were paid for by the same payer", "maxLength": 5000, "nullable": true, "type": "string" }, "payment_reference": { "description": "Payer bank reference number for the payment", "maxLength": 5000, "nullable": true, "type": "string" }, "verified_phone_last4": { "description": "The last four digits of the Swish account phone number", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "fingerprint", "payment_reference", "verified_phone_last4" ], "title": "payment_method_details_swish", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "fingerprint", "payment_reference", "verified_phone_last4" ] }, "payment_method_details_twint": { "description": "", "properties": {}, "title": "payment_method_details_twint", "type": "object", "x-expandableFields": [] }, "payment_method_details_us_bank_account": { "description": "", "properties": { "account_holder_type": { "description": "Account holder type: individual or company.", "enum": [ "company", "individual" ], "nullable": true, "type": "string" }, "account_type": { "description": "Account type: checkings or savings. Defaults to checking if omitted.", "enum": [ "checking", "savings" ], "nullable": true, "type": "string" }, "bank_name": { "description": "Name of the bank associated with the bank account.", "maxLength": 5000, "nullable": true, "type": "string" }, "fingerprint": { "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.", "maxLength": 5000, "nullable": true, "type": "string" }, "last4": { "description": "Last four digits of the bank account number.", "maxLength": 5000, "nullable": true, "type": "string" }, "mandate": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/mandate" } ], "description": "ID of the mandate used to make this payment.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/mandate" } ] } }, "payment_reference": { "description": "Reference number to locate ACH payments with customer's bank.", "maxLength": 5000, "nullable": true, "type": "string" }, "routing_number": { "description": "Routing number of the bank account.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "account_holder_type", "account_type", "bank_name", "fingerprint", "last4", "payment_reference", "routing_number" ], "title": "payment_method_details_us_bank_account", "type": "object", "x-expandableFields": [ "mandate" ], "x-stripeMostCommon": [ "account_holder_type", "account_type", "bank_name", "fingerprint", "last4", "mandate", "payment_reference", "routing_number" ] }, "payment_method_details_wechat": { "description": "", "properties": {}, "title": "payment_method_details_wechat", "type": "object", "x-expandableFields": [] }, "payment_method_details_wechat_pay": { "description": "", "properties": { "fingerprint": { "description": "Uniquely identifies this particular WeChat Pay account. You can use this attribute to check whether two WeChat accounts are the same.", "maxLength": 5000, "nullable": true, "type": "string" }, "location": { "description": "ID of the [location](https://stripe.com/docs/api/terminal/locations) that this transaction's reader is assigned to.", "maxLength": 5000, "type": "string" }, "reader": { "description": "ID of the [reader](https://stripe.com/docs/api/terminal/readers) this transaction was made on.", "maxLength": 5000, "type": "string" }, "transaction_id": { "description": "Transaction ID of this particular WeChat Pay transaction.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "fingerprint", "transaction_id" ], "title": "payment_method_details_wechat_pay", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "fingerprint", "location", "reader", "transaction_id" ] }, "payment_method_details_zip": { "description": "", "properties": {}, "title": "payment_method_details_zip", "type": "object", "x-expandableFields": [] }, "payment_method_domain": { "description": "A payment method domain represents a web domain that you have registered with Stripe.\nStripe Elements use registered payment method domains to control where certain payment methods are shown.\n\nRelated guide: [Payment method domains](https://stripe.com/docs/payments/payment-methods/pmd-registration).", "properties": { "amazon_pay": { "$ref": "#/components/schemas/payment_method_domain_resource_payment_method_status" }, "apple_pay": { "$ref": "#/components/schemas/payment_method_domain_resource_payment_method_status" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "domain_name": { "description": "The domain name that this payment method domain object represents.", "maxLength": 5000, "type": "string" }, "enabled": { "description": "Whether this payment method domain is enabled. If the domain is not enabled, payment methods that require a payment method domain will not appear in Elements.", "type": "boolean" }, "google_pay": { "$ref": "#/components/schemas/payment_method_domain_resource_payment_method_status" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "klarna": { "$ref": "#/components/schemas/payment_method_domain_resource_payment_method_status" }, "link": { "$ref": "#/components/schemas/payment_method_domain_resource_payment_method_status" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "payment_method_domain" ], "type": "string" }, "paypal": { "$ref": "#/components/schemas/payment_method_domain_resource_payment_method_status" } }, "required": [ "amazon_pay", "apple_pay", "created", "domain_name", "enabled", "google_pay", "id", "klarna", "link", "livemode", "object", "paypal" ], "title": "PaymentMethodDomainResourcePaymentMethodDomain", "type": "object", "x-expandableFields": [ "amazon_pay", "apple_pay", "google_pay", "klarna", "link", "paypal" ], "x-resourceId": "payment_method_domain", "x-stripeMostCommon": [ "domain_name", "enabled", "id" ], "x-stripeOperations": [ { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/payment_method_domains" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/payment_method_domains/{payment_method_domain}" }, { "method_name": "create", "method_on": "service", "method_type": "create", "operation": "post", "path": "/v1/payment_method_domains" }, { "method_name": "update", "method_on": "service", "method_type": "update", "operation": "post", "path": "/v1/payment_method_domains/{payment_method_domain}" }, { "method_name": "validate", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/payment_method_domains/{payment_method_domain}/validate" } ], "x-stripeResource": { "class_name": "PaymentMethodDomain", "has_collection_class": true, "in_package": "" } }, "payment_method_domain_resource_payment_method_status": { "description": "Indicates the status of a specific payment method on a payment method domain.", "properties": { "status": { "description": "The status of the payment method on the domain.", "enum": [ "active", "inactive" ], "type": "string" }, "status_details": { "$ref": "#/components/schemas/payment_method_domain_resource_payment_method_status_details" } }, "required": [ "status" ], "title": "PaymentMethodDomainResourcePaymentMethodStatus", "type": "object", "x-expandableFields": [ "status_details" ], "x-stripeMostCommon": [ "status" ] }, "payment_method_domain_resource_payment_method_status_details": { "description": "Contains additional details about the status of a payment method for a specific payment method domain.", "properties": { "error_message": { "description": "The error message associated with the status of the payment method on the domain.", "maxLength": 5000, "type": "string" } }, "required": [ "error_message" ], "title": "PaymentMethodDomainResourcePaymentMethodStatusDetails", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "error_message" ] }, "payment_method_eps": { "description": "", "properties": { "bank": { "description": "The customer's bank. Should be one of `arzte_und_apotheker_bank`, `austrian_anadi_bank_ag`, `bank_austria`, `bankhaus_carl_spangler`, `bankhaus_schelhammer_und_schattera_ag`, `bawag_psk_ag`, `bks_bank_ag`, `brull_kallmus_bank_ag`, `btv_vier_lander_bank`, `capital_bank_grawe_gruppe_ag`, `deutsche_bank_ag`, `dolomitenbank`, `easybank_ag`, `erste_bank_und_sparkassen`, `hypo_alpeadriabank_international_ag`, `hypo_noe_lb_fur_niederosterreich_u_wien`, `hypo_oberosterreich_salzburg_steiermark`, `hypo_tirol_bank_ag`, `hypo_vorarlberg_bank_ag`, `hypo_bank_burgenland_aktiengesellschaft`, `marchfelder_bank`, `oberbank_ag`, `raiffeisen_bankengruppe_osterreich`, `schoellerbank_ag`, `sparda_bank_wien`, `volksbank_gruppe`, `volkskreditbank_ag`, or `vr_bank_braunau`.", "enum": [ "arzte_und_apotheker_bank", "austrian_anadi_bank_ag", "bank_austria", "bankhaus_carl_spangler", "bankhaus_schelhammer_und_schattera_ag", "bawag_psk_ag", "bks_bank_ag", "brull_kallmus_bank_ag", "btv_vier_lander_bank", "capital_bank_grawe_gruppe_ag", "deutsche_bank_ag", "dolomitenbank", "easybank_ag", "erste_bank_und_sparkassen", "hypo_alpeadriabank_international_ag", "hypo_bank_burgenland_aktiengesellschaft", "hypo_noe_lb_fur_niederosterreich_u_wien", "hypo_oberosterreich_salzburg_steiermark", "hypo_tirol_bank_ag", "hypo_vorarlberg_bank_ag", "marchfelder_bank", "oberbank_ag", "raiffeisen_bankengruppe_osterreich", "schoellerbank_ag", "sparda_bank_wien", "volksbank_gruppe", "volkskreditbank_ag", "vr_bank_braunau" ], "nullable": true, "type": "string" } }, "required": [ "bank" ], "title": "payment_method_eps", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "bank" ] }, "payment_method_fpx": { "description": "", "properties": { "account_holder_type": { "description": "Account holder type, if provided. Can be one of `individual` or `company`.", "enum": [ "company", "individual" ], "nullable": true, "type": "string" }, "bank": { "description": "The customer's bank, if provided. Can be one of `affin_bank`, `agrobank`, `alliance_bank`, `ambank`, `bank_islam`, `bank_muamalat`, `bank_rakyat`, `bsn`, `cimb`, `hong_leong_bank`, `hsbc`, `kfh`, `maybank2u`, `ocbc`, `public_bank`, `rhb`, `standard_chartered`, `uob`, `deutsche_bank`, `maybank2e`, `pb_enterprise`, or `bank_of_china`.", "enum": [ "affin_bank", "agrobank", "alliance_bank", "ambank", "bank_islam", "bank_muamalat", "bank_of_china", "bank_rakyat", "bsn", "cimb", "deutsche_bank", "hong_leong_bank", "hsbc", "kfh", "maybank2e", "maybank2u", "ocbc", "pb_enterprise", "public_bank", "rhb", "standard_chartered", "uob" ], "type": "string" } }, "required": [ "account_holder_type", "bank" ], "title": "payment_method_fpx", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "account_holder_type", "bank" ] }, "payment_method_giropay": { "description": "", "properties": {}, "title": "payment_method_giropay", "type": "object", "x-expandableFields": [] }, "payment_method_gopay": { "description": "", "properties": {}, "title": "payment_method_gopay", "type": "object", "x-expandableFields": [], "x-stripeResource": { "class_name": "Gopay", "in_package": "" } }, "payment_method_grabpay": { "description": "", "properties": {}, "title": "payment_method_grabpay", "type": "object", "x-expandableFields": [] }, "payment_method_id_bank_transfer": { "description": "", "properties": { "bank": { "enum": [ "bca", "bni", "bri", "cimb", "permata" ], "nullable": true, "type": "string", "x-stripeBypassValidation": true }, "bank_code": { "maxLength": 5000, "nullable": true, "type": "string" }, "bank_name": { "maxLength": 5000, "nullable": true, "type": "string" }, "display_name": { "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "bank", "bank_code", "bank_name", "display_name" ], "title": "payment_method_id_bank_transfer", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "bank", "bank_code", "bank_name", "display_name" ] }, "payment_method_ideal": { "description": "", "properties": { "bank": { "description": "The customer's bank, if provided. Can be one of `abn_amro`, `asn_bank`, `bunq`, `buut`, `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`.", "enum": [ "abn_amro", "asn_bank", "bunq", "buut", "handelsbanken", "ing", "knab", "moneyou", "n26", "nn", "rabobank", "regiobank", "revolut", "sns_bank", "triodos_bank", "van_lanschot", "yoursafe" ], "nullable": true, "type": "string" }, "bic": { "description": "The Bank Identifier Code of the customer's bank, if the bank was provided.", "enum": [ "ABNANL2A", "ASNBNL21", "BITSNL2A", "BUNQNL2A", "BUUTNL2A", "FVLBNL22", "HANDNL2A", "INGBNL2A", "KNABNL2H", "MOYONL21", "NNBANL2G", "NTSBDEB1", "RABONL2U", "RBRBNL21", "REVOIE23", "REVOLT21", "SNSBNL2A", "TRIONL2U" ], "nullable": true, "type": "string" } }, "required": [ "bank", "bic" ], "title": "payment_method_ideal", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "bank", "bic" ] }, "payment_method_interac_present": { "description": "", "properties": { "brand": { "description": "Card brand. Can be `interac`, `mastercard` or `visa`.", "maxLength": 5000, "nullable": true, "type": "string" }, "cardholder_name": { "description": "The cardholder name as read from the card, in [ISO 7813](https://en.wikipedia.org/wiki/ISO/IEC_7813) format. May include alphanumeric characters, special characters and first/last name separator (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay.", "maxLength": 5000, "nullable": true, "type": "string" }, "country": { "description": "Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.", "maxLength": 5000, "nullable": true, "type": "string" }, "description": { "description": "A high-level description of the type of cards issued in this range. (For internal use only and not typically available in standard API requests.)", "maxLength": 5000, "nullable": true, "type": "string" }, "exp_month": { "description": "Two-digit number representing the card's expiration month.", "type": "integer" }, "exp_year": { "description": "Four-digit number representing the card's expiration year.", "type": "integer" }, "fingerprint": { "description": "Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.\n\n*As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*", "maxLength": 5000, "nullable": true, "type": "string" }, "funding": { "description": "Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.", "maxLength": 5000, "nullable": true, "type": "string" }, "iin": { "description": "Issuer identification number of the card. (For internal use only and not typically available in standard API requests.)", "maxLength": 5000, "nullable": true, "type": "string" }, "issuer": { "description": "The name of the card's issuing bank. (For internal use only and not typically available in standard API requests.)", "maxLength": 5000, "nullable": true, "type": "string" }, "last4": { "description": "The last four digits of the card.", "maxLength": 5000, "nullable": true, "type": "string" }, "networks": { "anyOf": [ { "$ref": "#/components/schemas/payment_method_card_present_networks" } ], "description": "Contains information about card networks that can be used to process the payment.", "nullable": true }, "preferred_locales": { "description": "The languages that the issuing bank recommends using for localizing any customer-facing text, as read from the card. Referenced from EMV tag 5F2D, data encoded on the card's chip.", "items": { "maxLength": 5000, "type": "string" }, "nullable": true, "type": "array" }, "read_method": { "description": "How card details were read in this transaction.", "enum": [ "contact_emv", "contactless_emv", "contactless_magstripe_mode", "magnetic_stripe_fallback", "magnetic_stripe_track2" ], "nullable": true, "type": "string" } }, "required": [ "brand", "cardholder_name", "country", "exp_month", "exp_year", "fingerprint", "funding", "last4", "networks", "preferred_locales", "read_method" ], "title": "payment_method_interac_present", "type": "object", "x-expandableFields": [ "networks" ], "x-stripeMostCommon": [ "brand", "cardholder_name", "country", "description", "exp_month", "exp_year", "fingerprint", "funding", "iin", "issuer", "last4", "networks", "preferred_locales", "read_method" ] }, "payment_method_kakao_pay": { "description": "", "properties": {}, "title": "payment_method_kakao_pay", "type": "object", "x-expandableFields": [], "x-stripeResource": { "class_name": "KakaoPay", "in_package": "" } }, "payment_method_klarna": { "description": "", "properties": { "dob": { "anyOf": [ { "$ref": "#/components/schemas/payment_flows_private_payment_methods_klarna_dob" } ], "description": "The customer's date of birth, if provided.", "nullable": true } }, "title": "payment_method_klarna", "type": "object", "x-expandableFields": [ "dob" ], "x-stripeMostCommon": [ "dob" ] }, "payment_method_konbini": { "description": "", "properties": {}, "title": "payment_method_konbini", "type": "object", "x-expandableFields": [] }, "payment_method_kr_card": { "description": "", "properties": { "brand": { "description": "The local credit or debit card brand.", "enum": [ "bc", "citi", "hana", "hyundai", "jeju", "jeonbuk", "kakaobank", "kbank", "kdbbank", "kookmin", "kwangju", "lotte", "mg", "nh", "post", "samsung", "savingsbank", "shinhan", "shinhyup", "suhyup", "tossbank", "woori" ], "nullable": true, "type": "string" }, "last4": { "description": "The last four digits of the card. This may not be present for American Express cards.", "maxLength": 4, "nullable": true, "type": "string" } }, "required": [ "brand", "last4" ], "title": "payment_method_kr_card", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "brand", "last4" ], "x-stripeResource": { "class_name": "KrCard", "in_package": "" } }, "payment_method_link": { "description": "", "properties": { "email": { "description": "Account owner's email address.", "maxLength": 5000, "nullable": true, "type": "string" }, "persistent_token": { "description": "[Deprecated] This is a legacy parameter that no longer has any function.", "maxLength": 5000, "type": "string" } }, "required": [ "email" ], "title": "payment_method_link", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "email", "persistent_token" ] }, "payment_method_mb_way": { "description": "", "properties": {}, "title": "payment_method_mb_way", "type": "object", "x-expandableFields": [], "x-stripeResource": { "class_name": "MbWay", "in_package": "" } }, "payment_method_mobilepay": { "description": "", "properties": {}, "title": "payment_method_mobilepay", "type": "object", "x-expandableFields": [] }, "payment_method_multibanco": { "description": "", "properties": {}, "title": "payment_method_multibanco", "type": "object", "x-expandableFields": [] }, "payment_method_naver_pay": { "description": "", "properties": { "buyer_id": { "description": "Uniquely identifies this particular Naver Pay account. You can use this attribute to check whether two Naver Pay accounts are the same.", "maxLength": 5000, "nullable": true, "type": "string" }, "funding": { "description": "Whether to fund this transaction with Naver Pay points or a card.", "enum": [ "card", "points" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "buyer_id", "funding" ], "title": "payment_method_naver_pay", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "buyer_id", "funding" ], "x-stripeResource": { "class_name": "NaverPay", "in_package": "" } }, "payment_method_nz_bank_account": { "description": "", "properties": { "account_holder_name": { "description": "The name on the bank account. Only present if the account holder name is different from the name of the authorized signatory collected in the PaymentMethod’s billing details.", "maxLength": 5000, "nullable": true, "type": "string" }, "bank_code": { "description": "The numeric code for the bank account's bank.", "maxLength": 5000, "type": "string" }, "bank_name": { "description": "The name of the bank.", "maxLength": 5000, "type": "string" }, "branch_code": { "description": "The numeric code for the bank account's bank branch.", "maxLength": 5000, "type": "string" }, "last4": { "description": "Last four digits of the bank account number.", "maxLength": 5000, "type": "string" }, "suffix": { "description": "The suffix of the bank account number.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "account_holder_name", "bank_code", "bank_name", "branch_code", "last4", "suffix" ], "title": "payment_method_nz_bank_account", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "account_holder_name", "bank_code", "bank_name", "branch_code", "last4", "suffix" ] }, "payment_method_options_affirm": { "description": "", "properties": { "capture_method": { "description": "Controls when the funds will be captured from the customer's account.", "enum": [ "manual" ], "type": "string" }, "preferred_locale": { "description": "Preferred language of the Affirm authorization page that the customer is redirected to.", "maxLength": 30, "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_affirm", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "capture_method", "preferred_locale", "setup_future_usage" ] }, "payment_method_options_afterpay_clearpay": { "description": "", "properties": { "capture_method": { "description": "Controls when the funds will be captured from the customer's account.", "enum": [ "manual" ], "type": "string" }, "reference": { "description": "An internal identifier or reference that this payment corresponds to. You must limit the identifier to 128 characters, and it can only contain letters, numbers, underscores, backslashes, and dashes.\nThis field differs from the statement descriptor and item name.", "maxLength": 5000, "nullable": true, "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "reference" ], "title": "payment_method_options_afterpay_clearpay", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "capture_method", "reference", "setup_future_usage" ] }, "payment_method_options_alipay": { "description": "", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none", "off_session" ], "type": "string" } }, "title": "payment_method_options_alipay", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "setup_future_usage" ] }, "payment_method_options_alma": { "description": "", "properties": { "capture_method": { "description": "Controls when the funds will be captured from the customer's account.", "enum": [ "manual" ], "type": "string" } }, "title": "payment_method_options_alma", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "capture_method" ] }, "payment_method_options_amazon_pay": { "description": "", "properties": { "capture_method": { "description": "Controls when the funds will be captured from the customer's account.", "enum": [ "manual" ], "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none", "off_session" ], "type": "string" } }, "title": "payment_method_options_amazon_pay", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "capture_method", "setup_future_usage" ] }, "payment_method_options_bancontact": { "description": "", "properties": { "preferred_language": { "description": "Preferred language of the Bancontact authorization page that the customer is redirected to.", "enum": [ "de", "en", "fr", "nl" ], "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none", "off_session" ], "type": "string" } }, "required": [ "preferred_language" ], "title": "payment_method_options_bancontact", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "preferred_language", "setup_future_usage" ] }, "payment_method_options_billie": { "description": "", "properties": { "capture_method": { "description": "Controls when the funds will be captured from the customer's account.", "enum": [ "manual" ], "type": "string" } }, "title": "payment_method_options_billie", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "capture_method" ] }, "payment_method_options_boleto": { "description": "", "properties": { "expires_after_days": { "description": "The number of calendar days before a Boleto voucher expires. For example, if you create a Boleto voucher on Monday and you set expires_after_days to 2, the Boleto voucher will expire on Wednesday at 23:59 America/Sao_Paulo time.", "type": "integer" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none", "off_session", "on_session" ], "type": "string" } }, "required": [ "expires_after_days" ], "title": "payment_method_options_boleto", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "expires_after_days", "setup_future_usage" ] }, "payment_method_options_card_installments": { "description": "", "properties": { "available_plans": { "description": "Installment plans that may be selected for this PaymentIntent.", "items": { "$ref": "#/components/schemas/payment_method_details_card_installments_plan" }, "nullable": true, "type": "array" }, "enabled": { "description": "Whether Installments are enabled for this PaymentIntent.", "type": "boolean" }, "plan": { "anyOf": [ { "$ref": "#/components/schemas/payment_method_details_card_installments_plan" } ], "description": "Installment plan selected for this PaymentIntent.", "nullable": true } }, "required": [ "available_plans", "enabled", "plan" ], "title": "payment_method_options_card_installments", "type": "object", "x-expandableFields": [ "available_plans", "plan" ], "x-stripeMostCommon": [ "available_plans", "enabled", "plan" ] }, "payment_method_options_card_mandate_options": { "description": "", "properties": { "amount": { "description": "Amount to be charged for future payments.", "type": "integer" }, "amount_type": { "description": "One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.", "enum": [ "fixed", "maximum" ], "type": "string" }, "description": { "description": "A description of the mandate or subscription that is meant to be displayed to the customer.", "maxLength": 200, "nullable": true, "type": "string" }, "end_date": { "description": "End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.", "format": "unix-time", "nullable": true, "type": "integer" }, "interval": { "description": "Specifies payment frequency. One of `day`, `week`, `month`, `year`, or `sporadic`.", "enum": [ "day", "month", "sporadic", "week", "year" ], "type": "string" }, "interval_count": { "description": "The number of intervals between payments. For example, `interval=month` and `interval_count=3` indicates one payment every three months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). This parameter is optional when `interval=sporadic`.", "nullable": true, "type": "integer" }, "reference": { "description": "Unique identifier for the mandate or subscription.", "maxLength": 80, "type": "string" }, "start_date": { "description": "Start date of the mandate or subscription. Start date should not be lesser than yesterday.", "format": "unix-time", "type": "integer" }, "supported_types": { "description": "Specifies the type of mandates supported. Possible values are `india`.", "items": { "enum": [ "india" ], "type": "string" }, "nullable": true, "type": "array" } }, "required": [ "amount", "amount_type", "description", "end_date", "interval", "interval_count", "reference", "start_date", "supported_types" ], "title": "payment_method_options_card_mandate_options", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "amount", "amount_type", "description", "end_date", "interval", "interval_count", "reference", "start_date", "supported_types" ], "x-stripeResource": { "class_name": "MandateOptions", "in_package": "" } }, "payment_method_options_card_present": { "description": "", "properties": { "request_extended_authorization": { "description": "Request ability to capture this payment beyond the standard [authorization validity window](https://stripe.com/docs/terminal/features/extended-authorizations#authorization-validity)", "nullable": true, "type": "boolean" }, "request_incremental_authorization_support": { "description": "Request ability to [increment](https://stripe.com/docs/terminal/features/incremental-authorizations) this PaymentIntent if the combination of MCC and card brand is eligible. Check [incremental_authorization_supported](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported) in the [Confirm](https://stripe.com/docs/api/payment_intents/confirm) response to verify support.", "nullable": true, "type": "boolean" }, "routing": { "$ref": "#/components/schemas/payment_method_options_card_present_routing" } }, "required": [ "request_extended_authorization", "request_incremental_authorization_support" ], "title": "payment_method_options_card_present", "type": "object", "x-expandableFields": [ "routing" ], "x-stripeMostCommon": [ "request_extended_authorization", "request_incremental_authorization_support", "routing" ] }, "payment_method_options_card_present_routing": { "description": "", "properties": { "requested_priority": { "description": "Requested routing priority", "enum": [ "domestic", "international" ], "nullable": true, "type": "string" } }, "required": [ "requested_priority" ], "title": "payment_method_options_card_present_routing", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "requested_priority" ], "x-stripeResource": { "class_name": "Routing", "in_package": "" } }, "payment_method_options_cashapp": { "description": "", "properties": { "capture_method": { "description": "Controls when the funds will be captured from the customer's account.", "enum": [ "manual" ], "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none", "off_session", "on_session" ], "type": "string" } }, "title": "payment_method_options_cashapp", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "capture_method", "setup_future_usage" ] }, "payment_method_options_crypto": { "description": "", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "payment_method_options_crypto", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "setup_future_usage" ] }, "payment_method_options_customer_balance": { "description": "", "properties": { "bank_transfer": { "$ref": "#/components/schemas/payment_method_options_customer_balance_bank_transfer" }, "funding_type": { "description": "The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.", "enum": [ "bank_transfer" ], "nullable": true, "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string" } }, "required": [ "funding_type" ], "title": "payment_method_options_customer_balance", "type": "object", "x-expandableFields": [ "bank_transfer" ], "x-stripeMostCommon": [ "bank_transfer", "funding_type", "setup_future_usage" ] }, "payment_method_options_customer_balance_bank_transfer": { "description": "", "properties": { "eu_bank_transfer": { "$ref": "#/components/schemas/payment_method_options_customer_balance_eu_bank_account" }, "requested_address_types": { "description": "List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.\n\nPermitted values include: `sort_code`, `zengin`, `iban`, or `spei`.", "items": { "enum": [ "aba", "iban", "sepa", "sort_code", "spei", "swift", "zengin" ], "type": "string", "x-stripeBypassValidation": true }, "type": "array" }, "type": { "description": "The bank transfer type that this PaymentIntent is allowed to use for funding Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.", "enum": [ "eu_bank_transfer", "gb_bank_transfer", "jp_bank_transfer", "mx_bank_transfer", "us_bank_transfer" ], "nullable": true, "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "payment_method_options_customer_balance_bank_transfer", "type": "object", "x-expandableFields": [ "eu_bank_transfer" ], "x-stripeMostCommon": [ "eu_bank_transfer", "requested_address_types", "type" ] }, "payment_method_options_customer_balance_eu_bank_account": { "description": "", "properties": { "country": { "description": "The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`.", "enum": [ "BE", "DE", "ES", "FR", "IE", "NL" ], "type": "string" } }, "required": [ "country" ], "title": "payment_method_options_customer_balance_eu_bank_account", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "country" ] }, "payment_method_options_fpx": { "description": "", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_fpx", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "setup_future_usage" ] }, "payment_method_options_giropay": { "description": "", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_giropay", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "setup_future_usage" ] }, "payment_method_options_gopay": { "description": "", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none", "off_session" ], "type": "string" } }, "title": "payment_method_options_gopay", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "setup_future_usage" ] }, "payment_method_options_grabpay": { "description": "", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_grabpay", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "setup_future_usage" ] }, "payment_method_options_id_bank_transfer": { "description": "", "properties": { "expires_after": { "description": "The UNIX timestamp until which the virtual bank account is valid. Permitted range is from now till 2678400 seconds (31 days) from now.", "nullable": true, "type": "integer" }, "expires_at": { "description": "The UNIX timestamp until which the virtual bank account is valid. Permitted range is from now until 30 days from now. If unset, it defaults to 1 days from now.", "format": "unix-time", "nullable": true, "type": "integer" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string" } }, "required": [ "expires_at" ], "title": "payment_method_options_id_bank_transfer", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "expires_after", "expires_at", "setup_future_usage" ] }, "payment_method_options_ideal": { "description": "", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none", "off_session" ], "type": "string" } }, "title": "payment_method_options_ideal", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "setup_future_usage" ] }, "payment_method_options_interac_present": { "description": "", "properties": {}, "title": "payment_method_options_interac_present", "type": "object", "x-expandableFields": [] }, "payment_method_options_klarna": { "description": "", "properties": { "capture_method": { "description": "Controls when the funds will be captured from the customer's account.", "enum": [ "manual" ], "type": "string" }, "preferred_locale": { "description": "Preferred locale of the Klarna checkout page that the customer is redirected to.", "maxLength": 5000, "nullable": true, "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none", "off_session", "on_session" ], "type": "string" } }, "required": [ "preferred_locale" ], "title": "payment_method_options_klarna", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "capture_method", "preferred_locale", "setup_future_usage" ] }, "payment_method_options_konbini": { "description": "", "properties": { "confirmation_number": { "description": "An optional 10 to 11 digit numeric-only string determining the confirmation code at applicable convenience stores.", "maxLength": 5000, "nullable": true, "type": "string" }, "expires_after_days": { "description": "The number of calendar days (between 1 and 60) after which Konbini payment instructions will expire. For example, if a PaymentIntent is confirmed with Konbini and `expires_after_days` set to 2 on Monday JST, the instructions will expire on Wednesday 23:59:59 JST.", "nullable": true, "type": "integer" }, "expires_at": { "description": "The timestamp at which the Konbini payment instructions will expire. Only one of `expires_after_days` or `expires_at` may be set.", "format": "unix-time", "nullable": true, "type": "integer" }, "product_description": { "description": "A product descriptor of up to 22 characters, which will appear to customers at the convenience store.", "maxLength": 5000, "nullable": true, "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string" } }, "required": [ "confirmation_number", "expires_after_days", "expires_at", "product_description" ], "title": "payment_method_options_konbini", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "confirmation_number", "expires_after_days", "expires_at", "product_description", "setup_future_usage" ] }, "payment_method_options_kr_card": { "description": "", "properties": { "capture_method": { "description": "Controls when the funds will be captured from the customer's account.", "enum": [ "manual" ], "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none", "off_session" ], "type": "string" } }, "title": "payment_method_options_kr_card", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "capture_method", "setup_future_usage" ] }, "payment_method_options_mandate_options_pix": { "description": "", "properties": { "amount": { "description": "Amount to be charged for future payments.", "type": "integer" }, "amount_includes_iof": { "description": "Determines if the amount includes the IOF tax.", "enum": [ "always", "never" ], "type": "string" }, "amount_type": { "description": "Type of amount.", "enum": [ "fixed", "maximum" ], "type": "string" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.", "format": "currency", "type": "string" }, "end_date": { "description": "Date when the mandate expires and no further payments will be charged, in `YYYY-MM-DD`.", "maxLength": 5000, "type": "string" }, "payment_schedule": { "description": "Schedule at which the future payments will be charged.", "enum": [ "halfyearly", "monthly", "quarterly", "weekly", "yearly" ], "type": "string" }, "reference": { "description": "Subscription name displayed to buyers in their bank app.", "maxLength": 5000, "type": "string" }, "start_date": { "description": "Start date of the mandate, in `YYYY-MM-DD`.", "maxLength": 5000, "type": "string" } }, "title": "payment_method_options_mandate_options_pix", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "amount", "amount_includes_iof", "amount_type", "currency", "end_date", "payment_schedule", "reference", "start_date" ] }, "payment_method_options_mb_way": { "description": "", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_mb_way", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "setup_future_usage" ] }, "payment_method_options_multibanco": { "description": "", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_multibanco", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "setup_future_usage" ] }, "payment_method_options_oxxo": { "description": "", "properties": { "expires_after_days": { "description": "The number of calendar days before an OXXO invoice expires. For example, if you create an OXXO invoice on Monday and you set expires_after_days to 2, the OXXO invoice will expire on Wednesday at 23:59 America/Mexico_City time.", "type": "integer" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string" } }, "required": [ "expires_after_days" ], "title": "payment_method_options_oxxo", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "expires_after_days", "setup_future_usage" ] }, "payment_method_options_p24": { "description": "", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_p24", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "setup_future_usage" ] }, "payment_method_options_pay_by_bank": { "description": "", "properties": {}, "title": "payment_method_options_pay_by_bank", "type": "object", "x-expandableFields": [] }, "payment_method_options_paynow": { "description": "", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_paynow", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "setup_future_usage" ] }, "payment_method_options_paypal": { "description": "", "properties": { "capture_method": { "description": "Controls when the funds will be captured from the customer's account.", "enum": [ "manual" ], "type": "string" }, "line_items": { "description": "The line items purchased by the customer.", "items": { "$ref": "#/components/schemas/line_item_paypal" }, "type": "array" }, "preferred_locale": { "description": "Preferred locale of the PayPal checkout page that the customer is redirected to.", "maxLength": 5000, "nullable": true, "type": "string" }, "reference": { "description": "A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID.", "maxLength": 5000, "nullable": true, "type": "string" }, "reference_id": { "description": "A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID.", "maxLength": 5000, "nullable": true, "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none", "off_session" ], "type": "string" }, "subsellers": { "description": "The Stripe connected account IDs of the sellers on the platform for this transaction (optional). Only allowed when [separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers) are used.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "required": [ "preferred_locale", "reference" ], "title": "payment_method_options_paypal", "type": "object", "x-expandableFields": [ "line_items" ], "x-stripeMostCommon": [ "capture_method", "line_items", "preferred_locale", "reference", "reference_id", "setup_future_usage", "subsellers" ] }, "payment_method_options_paypay": { "description": "", "properties": {}, "title": "payment_method_options_paypay", "type": "object", "x-expandableFields": [] }, "payment_method_options_pix": { "description": "", "properties": { "amount_includes_iof": { "description": "Determines if the amount includes the IOF tax.", "enum": [ "always", "never" ], "type": "string" }, "expires_after_seconds": { "description": "The number of seconds (between 10 and 1209600) after which Pix payment will expire.", "nullable": true, "type": "integer" }, "expires_at": { "description": "The timestamp at which the Pix expires.", "nullable": true, "type": "integer" }, "mandate_options": { "$ref": "#/components/schemas/payment_method_options_mandate_options_pix" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none", "off_session" ], "type": "string" } }, "required": [ "expires_after_seconds", "expires_at" ], "title": "payment_method_options_pix", "type": "object", "x-expandableFields": [ "mandate_options" ], "x-stripeMostCommon": [ "amount_includes_iof", "expires_after_seconds", "expires_at", "mandate_options", "setup_future_usage" ] }, "payment_method_options_promptpay": { "description": "", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_promptpay", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "setup_future_usage" ] }, "payment_method_options_qris": { "description": "", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_qris", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "setup_future_usage" ] }, "payment_method_options_revolut_pay": { "description": "", "properties": { "capture_method": { "description": "Controls when the funds will be captured from the customer's account.", "enum": [ "manual" ], "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none", "off_session" ], "type": "string" } }, "title": "payment_method_options_revolut_pay", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "capture_method", "setup_future_usage" ] }, "payment_method_options_satispay": { "description": "", "properties": { "capture_method": { "description": "Controls when the funds will be captured from the customer's account.", "enum": [ "manual" ], "type": "string" } }, "title": "payment_method_options_satispay", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "capture_method" ] }, "payment_method_options_shopeepay": { "description": "", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_shopeepay", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "setup_future_usage" ] }, "payment_method_options_sofort": { "description": "", "properties": { "preferred_language": { "description": "Preferred language of the SOFORT authorization page that the customer is redirected to.", "enum": [ "de", "en", "es", "fr", "it", "nl", "pl" ], "nullable": true, "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none", "off_session" ], "type": "string" } }, "required": [ "preferred_language" ], "title": "payment_method_options_sofort", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "preferred_language", "setup_future_usage" ] }, "payment_method_options_twint": { "description": "", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_twint", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "setup_future_usage" ] }, "payment_method_options_us_bank_account_mandate_options": { "description": "", "properties": { "collection_method": { "description": "Mandate collection method", "enum": [ "paper" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "payment_method_options_us_bank_account_mandate_options", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "collection_method" ] }, "payment_method_options_wechat_pay": { "description": "", "properties": { "app_id": { "description": "The app ID registered with WeChat Pay. Only required when client is ios or android.", "maxLength": 5000, "nullable": true, "type": "string" }, "client": { "description": "The client type that the end customer will pay from", "enum": [ "android", "ios", "web" ], "nullable": true, "type": "string", "x-stripeBypassValidation": true }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string" } }, "required": [ "app_id", "client" ], "title": "payment_method_options_wechat_pay", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "app_id", "client", "setup_future_usage" ] }, "payment_method_options_zip": { "description": "", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_zip", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "setup_future_usage" ] }, "payment_method_oxxo": { "description": "", "properties": {}, "title": "payment_method_oxxo", "type": "object", "x-expandableFields": [] }, "payment_method_p24": { "description": "", "properties": { "bank": { "description": "The customer's bank, if provided.", "enum": [ "alior_bank", "bank_millennium", "bank_nowy_bfg_sa", "bank_pekao_sa", "banki_spbdzielcze", "blik", "bnp_paribas", "boz", "citi_handlowy", "credit_agricole", "envelobank", "etransfer_pocztowy24", "getin_bank", "ideabank", "ing", "inteligo", "mbank_mtransfer", "nest_przelew", "noble_pay", "pbac_z_ipko", "plus_bank", "santander_przelew24", "tmobile_usbugi_bankowe", "toyota_bank", "velobank", "volkswagen_bank" ], "nullable": true, "type": "string", "x-stripeBypassValidation": true } }, "required": [ "bank" ], "title": "payment_method_p24", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "bank" ] }, "payment_method_pay_by_bank": { "description": "", "properties": {}, "title": "payment_method_pay_by_bank", "type": "object", "x-expandableFields": [] }, "payment_method_payco": { "description": "", "properties": {}, "title": "payment_method_payco", "type": "object", "x-expandableFields": [], "x-stripeResource": { "class_name": "Payco", "in_package": "" } }, "payment_method_paynow": { "description": "", "properties": {}, "title": "payment_method_paynow", "type": "object", "x-expandableFields": [] }, "payment_method_paypal": { "description": "", "properties": { "country": { "description": "Two-letter ISO code representing the buyer's country. Values are provided by PayPal directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.", "maxLength": 5000, "nullable": true, "type": "string" }, "fingerprint": { "description": "Uniquely identifies this particular PayPal account. You can use this attribute to check whether two PayPal accounts are the same.", "maxLength": 5000, "nullable": true, "type": "string" }, "payer_email": { "description": "Owner's email. Values are provided by PayPal directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated.", "maxLength": 5000, "nullable": true, "type": "string" }, "payer_id": { "description": "PayPal account PayerID. This identifier uniquely identifies the PayPal customer.", "maxLength": 5000, "nullable": true, "type": "string" }, "verified_email": { "description": "Owner's verified email. Values are verified or provided by PayPal directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "country", "payer_email", "payer_id" ], "title": "payment_method_paypal", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "country", "fingerprint", "payer_email", "payer_id", "verified_email" ] }, "payment_method_paypay": { "description": "", "properties": {}, "title": "payment_method_paypay", "type": "object", "x-expandableFields": [] }, "payment_method_payto": { "description": "", "properties": { "bsb_number": { "description": "Bank-State-Branch number of the bank account.", "maxLength": 5000, "nullable": true, "type": "string" }, "last4": { "description": "Last four digits of the bank account number.", "maxLength": 5000, "nullable": true, "type": "string" }, "pay_id": { "description": "The PayID alias for the bank account.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "bsb_number", "last4", "pay_id" ], "title": "payment_method_payto", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "bsb_number", "last4", "pay_id" ] }, "payment_method_pix": { "description": "", "properties": {}, "title": "payment_method_pix", "type": "object", "x-expandableFields": [] }, "payment_method_promptpay": { "description": "", "properties": {}, "title": "payment_method_promptpay", "type": "object", "x-expandableFields": [] }, "payment_method_qris": { "description": "", "properties": {}, "title": "payment_method_qris", "type": "object", "x-expandableFields": [] }, "payment_method_rechnung": { "description": "", "properties": { "dob": { "$ref": "#/components/schemas/payment_flows_private_payment_methods_rechnung_dob" } }, "title": "payment_method_rechnung", "type": "object", "x-expandableFields": [ "dob" ], "x-stripeMostCommon": [ "dob" ], "x-stripeResource": { "class_name": "Rechnung", "in_package": "" } }, "payment_method_revolut_pay": { "description": "", "properties": {}, "title": "payment_method_revolut_pay", "type": "object", "x-expandableFields": [] }, "payment_method_samsung_pay": { "description": "", "properties": {}, "title": "payment_method_samsung_pay", "type": "object", "x-expandableFields": [], "x-stripeResource": { "class_name": "SamsungPay", "in_package": "" } }, "payment_method_satispay": { "description": "", "properties": {}, "title": "payment_method_satispay", "type": "object", "x-expandableFields": [] }, "payment_method_sepa_debit": { "description": "", "properties": { "bank_code": { "description": "Bank code of bank associated with the bank account.", "maxLength": 5000, "nullable": true, "type": "string" }, "branch_code": { "description": "Branch code of bank associated with the bank account.", "maxLength": 5000, "nullable": true, "type": "string" }, "country": { "description": "Two-letter ISO code representing the country the bank account is located in.", "maxLength": 5000, "nullable": true, "type": "string" }, "fingerprint": { "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.", "maxLength": 5000, "nullable": true, "type": "string" }, "generated_from": { "anyOf": [ { "$ref": "#/components/schemas/sepa_debit_generated_from" } ], "description": "Information about the object that generated this PaymentMethod.", "nullable": true }, "last4": { "description": "Last four characters of the IBAN.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "bank_code", "branch_code", "country", "fingerprint", "generated_from", "last4" ], "title": "payment_method_sepa_debit", "type": "object", "x-expandableFields": [ "generated_from" ], "x-stripeMostCommon": [ "bank_code", "branch_code", "country", "fingerprint", "generated_from", "last4" ] }, "payment_method_shopeepay": { "description": "", "properties": {}, "title": "payment_method_shopeepay", "type": "object", "x-expandableFields": [], "x-stripeResource": { "class_name": "Shopeepay", "in_package": "" } }, "payment_method_sofort": { "description": "", "properties": { "country": { "description": "Two-letter ISO code representing the country the bank account is located in.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "country" ], "title": "payment_method_sofort", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "country" ] }, "payment_method_stripe_balance": { "description": "", "properties": { "account": { "description": "The connected account ID whose Stripe balance to use as the source of payment", "maxLength": 5000, "nullable": true, "type": "string" }, "source_type": { "description": "The [source_type](https://docs.stripe.com/api/balance/balance_object#balance_object-available-source_types) of the balance", "enum": [ "bank_account", "card", "fpx" ], "type": "string" } }, "required": [ "source_type" ], "title": "payment_method_stripe_balance", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "account", "source_type" ], "x-stripeResource": { "class_name": "StripeBalance", "in_package": "" } }, "payment_method_swish": { "description": "", "properties": {}, "title": "payment_method_swish", "type": "object", "x-expandableFields": [] }, "payment_method_twint": { "description": "", "properties": {}, "title": "payment_method_twint", "type": "object", "x-expandableFields": [] }, "payment_method_us_bank_account": { "description": "", "properties": { "account_holder_type": { "description": "Account holder type: individual or company.", "enum": [ "company", "individual" ], "nullable": true, "type": "string" }, "account_number": { "description": "Account number of the bank account.", "maxLength": 5000, "nullable": true, "type": "string" }, "account_type": { "description": "Account type: checkings or savings. Defaults to checking if omitted.", "enum": [ "checking", "savings" ], "nullable": true, "type": "string" }, "bank_name": { "description": "The name of the bank.", "maxLength": 5000, "nullable": true, "type": "string" }, "financial_connections_account": { "description": "The ID of the Financial Connections Account used to create the payment method.", "maxLength": 5000, "nullable": true, "type": "string" }, "fingerprint": { "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.", "maxLength": 5000, "nullable": true, "type": "string" }, "last4": { "description": "Last four digits of the bank account number.", "maxLength": 5000, "nullable": true, "type": "string" }, "networks": { "anyOf": [ { "$ref": "#/components/schemas/us_bank_account_networks" } ], "description": "Contains information about US bank account networks that can be used.", "nullable": true }, "routing_number": { "description": "Routing number of the bank account.", "maxLength": 5000, "nullable": true, "type": "string" }, "status_details": { "anyOf": [ { "$ref": "#/components/schemas/payment_method_us_bank_account_status_details" } ], "description": "Contains information about the future reusability of this PaymentMethod.", "nullable": true } }, "required": [ "account_holder_type", "account_type", "bank_name", "financial_connections_account", "fingerprint", "last4", "networks", "routing_number", "status_details" ], "title": "payment_method_us_bank_account", "type": "object", "x-expandableFields": [ "networks", "status_details" ], "x-stripeMostCommon": [ "account_holder_type", "account_type", "bank_name", "financial_connections_account", "fingerprint", "last4", "networks", "routing_number", "status_details" ] }, "payment_method_us_bank_account_blocked": { "description": "", "properties": { "network_code": { "description": "The ACH network code that resulted in this block.", "enum": [ "R02", "R03", "R04", "R05", "R07", "R08", "R10", "R11", "R16", "R20", "R29", "R31" ], "nullable": true, "type": "string" }, "reason": { "description": "The reason why this PaymentMethod's fingerprint has been blocked", "enum": [ "bank_account_closed", "bank_account_frozen", "bank_account_invalid_details", "bank_account_restricted", "bank_account_unusable", "debit_not_authorized" ], "nullable": true, "type": "string" } }, "required": [ "network_code", "reason" ], "title": "payment_method_us_bank_account_blocked", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "network_code", "reason" ] }, "payment_method_us_bank_account_status_details": { "description": "", "properties": { "blocked": { "$ref": "#/components/schemas/payment_method_us_bank_account_blocked" } }, "title": "payment_method_us_bank_account_status_details", "type": "object", "x-expandableFields": [ "blocked" ], "x-stripeMostCommon": [ "blocked" ] }, "payment_method_wechat_pay": { "description": "", "properties": {}, "title": "payment_method_wechat_pay", "type": "object", "x-expandableFields": [] }, "payment_method_zip": { "description": "", "properties": {}, "title": "payment_method_zip", "type": "object", "x-expandableFields": [] }, "payment_pages_checkout_session_adaptive_pricing": { "description": "", "properties": { "enabled": { "description": "If enabled, Adaptive Pricing is available on [eligible sessions](https://docs.stripe.com/payments/currencies/localize-prices/adaptive-pricing?payment-ui=stripe-hosted#restrictions).", "type": "boolean" } }, "required": [ "enabled" ], "title": "PaymentPagesCheckoutSessionAdaptivePricing", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "enabled" ] }, "payment_pages_checkout_session_after_expiration": { "description": "", "properties": { "recovery": { "anyOf": [ { "$ref": "#/components/schemas/payment_pages_checkout_session_after_expiration_recovery" } ], "description": "When set, configuration used to recover the Checkout Session on expiry.", "nullable": true } }, "required": [ "recovery" ], "title": "PaymentPagesCheckoutSessionAfterExpiration", "type": "object", "x-expandableFields": [ "recovery" ], "x-stripeMostCommon": [ "recovery" ] }, "payment_pages_checkout_session_after_expiration_recovery": { "description": "", "properties": { "allow_promotion_codes": { "description": "Enables user redeemable promotion codes on the recovered Checkout Sessions. Defaults to `false`", "type": "boolean" }, "enabled": { "description": "If `true`, a recovery url will be generated to recover this Checkout Session if it\nexpires before a transaction is completed. It will be attached to the\nCheckout Session object upon expiration.", "type": "boolean" }, "expires_at": { "description": "The timestamp at which the recovery URL will expire.", "format": "unix-time", "nullable": true, "type": "integer" }, "url": { "description": "URL that creates a new Checkout Session when clicked that is a copy of this expired Checkout Session", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "allow_promotion_codes", "enabled", "expires_at", "url" ], "title": "PaymentPagesCheckoutSessionAfterExpirationRecovery", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "allow_promotion_codes", "enabled", "expires_at", "url" ] }, "payment_pages_checkout_session_automatic_tax": { "description": "", "properties": { "enabled": { "description": "Indicates whether automatic tax is enabled for the session", "type": "boolean" }, "liability": { "anyOf": [ { "$ref": "#/components/schemas/connect_account_reference" } ], "description": "The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.", "nullable": true }, "provider": { "description": "The tax provider powering automatic tax.", "maxLength": 5000, "nullable": true, "type": "string" }, "status": { "description": "The status of the most recent automated tax calculation for this session.", "enum": [ "complete", "failed", "requires_location_inputs" ], "nullable": true, "type": "string" } }, "required": [ "enabled", "liability", "provider", "status" ], "title": "PaymentPagesCheckoutSessionAutomaticTax", "type": "object", "x-expandableFields": [ "liability" ], "x-stripeMostCommon": [ "enabled", "liability", "provider", "status" ] }, "payment_pages_checkout_session_checkout_address_details": { "description": "", "properties": { "address": { "$ref": "#/components/schemas/address" }, "name": { "description": "Customer name.", "maxLength": 5000, "type": "string" } }, "required": [ "address", "name" ], "title": "PaymentPagesCheckoutSessionCheckoutAddressDetails", "type": "object", "x-expandableFields": [ "address" ], "x-stripeMostCommon": [ "address", "name" ] }, "payment_pages_checkout_session_collected_information": { "description": "", "properties": { "business_name": { "description": "Customer’s business name for this Checkout Session", "maxLength": 5000, "nullable": true, "type": "string" }, "email": { "description": "Customer’s email for this Checkout Session", "maxLength": 5000, "nullable": true, "type": "string" }, "phone": { "description": "Customer’s phone number for this Checkout Session", "maxLength": 5000, "nullable": true, "type": "string" }, "shipping_details": { "anyOf": [ { "$ref": "#/components/schemas/payment_pages_checkout_session_checkout_address_details" } ], "description": "Shipping information for this Checkout Session.", "nullable": true }, "tax_ids": { "description": "Customer’s tax ids for this Checkout Session.", "items": { "$ref": "#/components/schemas/payment_pages_checkout_session_tax_id" }, "nullable": true, "type": "array" } }, "required": [ "shipping_details" ], "title": "PaymentPagesCheckoutSessionCollectedInformation", "type": "object", "x-expandableFields": [ "shipping_details", "tax_ids" ], "x-stripeMostCommon": [ "business_name", "email", "phone", "shipping_details", "tax_ids" ] }, "payment_pages_checkout_session_consent": { "description": "", "properties": { "promotions": { "description": "If `opt_in`, the customer consents to receiving promotional communications\nfrom the merchant about this Checkout Session.", "enum": [ "opt_in", "opt_out" ], "nullable": true, "type": "string" }, "terms_of_service": { "description": "If `accepted`, the customer in this Checkout Session has agreed to the merchant's terms of service.", "enum": [ "accepted" ], "nullable": true, "type": "string", "x-stripeBypassValidation": true } }, "required": [ "promotions", "terms_of_service" ], "title": "PaymentPagesCheckoutSessionConsent", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "promotions", "terms_of_service" ] }, "payment_pages_checkout_session_consent_collection": { "description": "", "properties": { "payment_method_reuse_agreement": { "anyOf": [ { "$ref": "#/components/schemas/payment_pages_checkout_session_payment_method_reuse_agreement" } ], "description": "If set to `hidden`, it will hide legal text related to the reuse of a payment method.", "nullable": true }, "promotions": { "description": "If set to `auto`, enables the collection of customer consent for promotional communications. The Checkout\nSession will determine whether to display an option to opt into promotional communication\nfrom the merchant depending on the customer's locale. Only available to US merchants.", "enum": [ "auto", "none" ], "nullable": true, "type": "string" }, "terms_of_service": { "description": "If set to `required`, it requires customers to accept the terms of service before being able to pay.", "enum": [ "none", "required" ], "nullable": true, "type": "string" } }, "required": [ "payment_method_reuse_agreement", "promotions", "terms_of_service" ], "title": "PaymentPagesCheckoutSessionConsentCollection", "type": "object", "x-expandableFields": [ "payment_method_reuse_agreement" ], "x-stripeMostCommon": [ "payment_method_reuse_agreement", "promotions", "terms_of_service" ] }, "payment_pages_checkout_session_currency_conversion": { "description": "", "properties": { "amount_subtotal": { "description": "Total of all items in source currency before discounts or taxes are applied.", "type": "integer" }, "amount_total": { "description": "Total of all items in source currency after discounts and taxes are applied.", "type": "integer" }, "fx_rate": { "description": "Exchange rate used to convert source currency amounts to customer currency amounts", "format": "decimal", "type": "string" }, "source_currency": { "description": "Creation currency of the CheckoutSession before localization", "maxLength": 5000, "type": "string" } }, "required": [ "amount_subtotal", "amount_total", "fx_rate", "source_currency" ], "title": "PaymentPagesCheckoutSessionCurrencyConversion", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "amount_subtotal", "amount_total", "fx_rate", "source_currency" ] }, "payment_pages_checkout_session_custom_fields": { "description": "", "properties": { "dropdown": { "$ref": "#/components/schemas/payment_pages_checkout_session_custom_fields_dropdown" }, "key": { "description": "String of your choice that your integration can use to reconcile this field. Must be unique to this field, alphanumeric, and up to 200 characters.", "maxLength": 5000, "type": "string" }, "label": { "$ref": "#/components/schemas/payment_pages_checkout_session_custom_fields_label" }, "numeric": { "$ref": "#/components/schemas/payment_pages_checkout_session_custom_fields_numeric" }, "optional": { "description": "Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`.", "type": "boolean" }, "text": { "$ref": "#/components/schemas/payment_pages_checkout_session_custom_fields_text" }, "type": { "description": "The type of the field.", "enum": [ "dropdown", "numeric", "text" ], "type": "string" } }, "required": [ "key", "label", "optional", "type" ], "title": "PaymentPagesCheckoutSessionCustomFields", "type": "object", "x-expandableFields": [ "dropdown", "label", "numeric", "text" ], "x-stripeMostCommon": [ "dropdown", "key", "label", "numeric", "optional", "text", "type" ] }, "payment_pages_checkout_session_custom_fields_dropdown": { "description": "", "properties": { "default_value": { "description": "The value that will pre-fill on the payment page.", "maxLength": 5000, "nullable": true, "type": "string" }, "options": { "description": "The options available for the customer to select. Up to 200 options allowed.", "items": { "$ref": "#/components/schemas/payment_pages_checkout_session_custom_fields_option" }, "type": "array" }, "value": { "description": "The option selected by the customer. This will be the `value` for the option.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "default_value", "options", "value" ], "title": "PaymentPagesCheckoutSessionCustomFieldsDropdown", "type": "object", "x-expandableFields": [ "options" ], "x-stripeMostCommon": [ "default_value", "options", "value" ], "x-stripeResource": { "class_name": "CustomFieldDropdown", "in_package": "" } }, "payment_pages_checkout_session_custom_fields_label": { "description": "", "properties": { "custom": { "description": "Custom text for the label, displayed to the customer. Up to 50 characters.", "maxLength": 5000, "nullable": true, "type": "string" }, "type": { "description": "The type of the label.", "enum": [ "custom" ], "type": "string" } }, "required": [ "custom", "type" ], "title": "PaymentPagesCheckoutSessionCustomFieldsLabel", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "custom", "type" ] }, "payment_pages_checkout_session_custom_fields_numeric": { "description": "", "properties": { "default_value": { "description": "The value that will pre-fill the field on the payment page.", "maxLength": 5000, "nullable": true, "type": "string" }, "maximum_length": { "description": "The maximum character length constraint for the customer's input.", "nullable": true, "type": "integer" }, "minimum_length": { "description": "The minimum character length requirement for the customer's input.", "nullable": true, "type": "integer" }, "value": { "description": "The value entered by the customer, containing only digits.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "default_value", "maximum_length", "minimum_length", "value" ], "title": "PaymentPagesCheckoutSessionCustomFieldsNumeric", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "default_value", "maximum_length", "minimum_length", "value" ], "x-stripeResource": { "class_name": "CustomFieldNumeric", "in_package": "" } }, "payment_pages_checkout_session_custom_fields_option": { "description": "", "properties": { "label": { "description": "The label for the option, displayed to the customer. Up to 100 characters.", "maxLength": 5000, "type": "string" }, "value": { "description": "The value for this option, not displayed to the customer, used by your integration to reconcile the option selected by the customer. Must be unique to this option, alphanumeric, and up to 100 characters.", "maxLength": 5000, "type": "string" } }, "required": [ "label", "value" ], "title": "PaymentPagesCheckoutSessionCustomFieldsOption", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "label", "value" ], "x-stripeResource": { "class_name": "CustomFieldDropdownOption", "in_package": "" } }, "payment_pages_checkout_session_custom_fields_text": { "description": "", "properties": { "default_value": { "description": "The value that will pre-fill the field on the payment page.", "maxLength": 5000, "nullable": true, "type": "string" }, "maximum_length": { "description": "The maximum character length constraint for the customer's input.", "nullable": true, "type": "integer" }, "minimum_length": { "description": "The minimum character length requirement for the customer's input.", "nullable": true, "type": "integer" }, "value": { "description": "The value entered by the customer.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "default_value", "maximum_length", "minimum_length", "value" ], "title": "PaymentPagesCheckoutSessionCustomFieldsText", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "default_value", "maximum_length", "minimum_length", "value" ] }, "payment_pages_checkout_session_custom_text": { "description": "", "properties": { "after_submit": { "anyOf": [ { "$ref": "#/components/schemas/payment_pages_checkout_session_custom_text_position" } ], "description": "Custom text that should be displayed after the payment confirmation button.", "nullable": true }, "shipping_address": { "anyOf": [ { "$ref": "#/components/schemas/payment_pages_checkout_session_custom_text_position" } ], "description": "Custom text that should be displayed alongside shipping address collection.", "nullable": true }, "submit": { "anyOf": [ { "$ref": "#/components/schemas/payment_pages_checkout_session_custom_text_position" } ], "description": "Custom text that should be displayed alongside the payment confirmation button.", "nullable": true }, "terms_of_service_acceptance": { "anyOf": [ { "$ref": "#/components/schemas/payment_pages_checkout_session_custom_text_position" } ], "description": "Custom text that should be displayed in place of the default terms of service agreement text.", "nullable": true } }, "required": [ "after_submit", "shipping_address", "submit", "terms_of_service_acceptance" ], "title": "PaymentPagesCheckoutSessionCustomText", "type": "object", "x-expandableFields": [ "after_submit", "shipping_address", "submit", "terms_of_service_acceptance" ], "x-stripeMostCommon": [ "after_submit", "shipping_address", "submit", "terms_of_service_acceptance" ] }, "payment_pages_checkout_session_custom_text_position": { "description": "", "properties": { "message": { "description": "Text may be up to 1200 characters in length.", "maxLength": 500, "type": "string" } }, "required": [ "message" ], "title": "PaymentPagesCheckoutSessionCustomTextPosition", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "message" ] }, "payment_pages_checkout_session_customer_details": { "description": "", "properties": { "address": { "anyOf": [ { "$ref": "#/components/schemas/address" } ], "description": "The customer's address after a completed Checkout Session. Note: This property is populated only for sessions on or after March 30, 2022.", "nullable": true }, "email": { "description": "The email associated with the Customer, if one exists, on the Checkout Session after a completed Checkout Session or at time of session expiry.\nOtherwise, if the customer has consented to promotional content, this value is the most recent valid email provided by the customer on the Checkout form.", "maxLength": 5000, "nullable": true, "type": "string" }, "name": { "description": "The customer's name after a completed Checkout Session. Note: This property is populated only for sessions on or after March 30, 2022.", "maxLength": 5000, "nullable": true, "type": "string" }, "phone": { "description": "The customer's phone number after a completed Checkout Session.", "maxLength": 5000, "nullable": true, "type": "string" }, "tax_exempt": { "description": "The customer’s tax exempt status after a completed Checkout Session.", "enum": [ "exempt", "none", "reverse" ], "nullable": true, "type": "string" }, "tax_ids": { "description": "The customer’s tax IDs after a completed Checkout Session.", "items": { "$ref": "#/components/schemas/payment_pages_checkout_session_tax_id" }, "nullable": true, "type": "array" } }, "required": [ "address", "email", "name", "phone", "tax_exempt", "tax_ids" ], "title": "PaymentPagesCheckoutSessionCustomerDetails", "type": "object", "x-expandableFields": [ "address", "tax_ids" ], "x-stripeMostCommon": [ "address", "email", "name", "phone", "tax_exempt", "tax_ids" ] }, "payment_pages_checkout_session_discount": { "description": "", "properties": { "coupon": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/coupon" } ], "description": "Coupon attached to the Checkout Session.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/coupon" } ] } }, "promotion_code": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/promotion_code" } ], "description": "Promotion code attached to the Checkout Session.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/promotion_code" } ] } } }, "required": [ "coupon", "promotion_code" ], "title": "PaymentPagesCheckoutSessionDiscount", "type": "object", "x-expandableFields": [ "coupon", "promotion_code" ], "x-stripeMostCommon": [ "coupon", "promotion_code" ] }, "payment_pages_checkout_session_invoice_creation": { "description": "", "properties": { "enabled": { "description": "Indicates whether invoice creation is enabled for the Checkout Session.", "type": "boolean" }, "invoice_data": { "$ref": "#/components/schemas/payment_pages_checkout_session_invoice_settings" } }, "required": [ "enabled", "invoice_data" ], "title": "PaymentPagesCheckoutSessionInvoiceCreation", "type": "object", "x-expandableFields": [ "invoice_data" ], "x-stripeMostCommon": [ "enabled", "invoice_data" ] }, "payment_pages_checkout_session_invoice_settings": { "description": "", "properties": { "account_tax_ids": { "description": "The account tax IDs associated with the invoice.", "items": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/tax_id" }, { "$ref": "#/components/schemas/deleted_tax_id" } ], "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/tax_id" }, { "$ref": "#/components/schemas/deleted_tax_id" } ] } }, "nullable": true, "type": "array" }, "custom_fields": { "description": "Custom fields displayed on the invoice.", "items": { "$ref": "#/components/schemas/invoice_setting_custom_field" }, "nullable": true, "type": "array" }, "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users.", "maxLength": 5000, "nullable": true, "type": "string" }, "footer": { "description": "Footer displayed on the invoice.", "maxLength": 5000, "nullable": true, "type": "string" }, "issuer": { "anyOf": [ { "$ref": "#/components/schemas/connect_account_reference" } ], "description": "The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.", "nullable": true }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "nullable": true, "type": "object" }, "rendering_options": { "anyOf": [ { "$ref": "#/components/schemas/invoice_setting_checkout_rendering_options" } ], "description": "Options for invoice PDF rendering.", "nullable": true } }, "required": [ "account_tax_ids", "custom_fields", "description", "footer", "issuer", "metadata", "rendering_options" ], "title": "PaymentPagesCheckoutSessionInvoiceSettings", "type": "object", "x-expandableFields": [ "account_tax_ids", "custom_fields", "issuer", "rendering_options" ], "x-stripeMostCommon": [ "account_tax_ids", "custom_fields", "description", "footer", "issuer", "metadata", "rendering_options" ] }, "payment_pages_checkout_session_optional_item": { "description": "", "properties": { "adjustable_quantity": { "anyOf": [ { "$ref": "#/components/schemas/payment_pages_checkout_session_optional_item_adjustable_quantity" } ], "nullable": true }, "price": { "maxLength": 5000, "type": "string" }, "quantity": { "type": "integer" } }, "required": [ "adjustable_quantity", "price", "quantity" ], "title": "PaymentPagesCheckoutSessionOptionalItem", "type": "object", "x-expandableFields": [ "adjustable_quantity" ], "x-stripeMostCommon": [ "adjustable_quantity", "price", "quantity" ] }, "payment_pages_checkout_session_optional_item_adjustable_quantity": { "description": "", "properties": { "enabled": { "description": "Set to true if the quantity can be adjusted to any non-negative integer.", "type": "boolean" }, "maximum": { "description": "The maximum quantity of this item the customer can purchase. By default this value is 99. You can specify a value up to 999999.", "nullable": true, "type": "integer" }, "minimum": { "description": "The minimum quantity of this item the customer must purchase, if they choose to purchase it. Because this item is optional, the customer will always be able to remove it from their order, even if the `minimum` configured here is greater than 0. By default this value is 0.", "nullable": true, "type": "integer" } }, "required": [ "enabled", "maximum", "minimum" ], "title": "PaymentPagesCheckoutSessionOptionalItemAdjustableQuantity", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "enabled", "maximum", "minimum" ] }, "payment_pages_checkout_session_payment_method_reuse_agreement": { "description": "", "properties": { "position": { "description": "Determines the position and visibility of the payment method reuse agreement in the UI. When set to `auto`, Stripe's defaults will be used.\n\nWhen set to `hidden`, the payment method reuse agreement text will always be hidden in the UI.", "enum": [ "auto", "hidden" ], "type": "string" } }, "required": [ "position" ], "title": "PaymentPagesCheckoutSessionPaymentMethodReuseAgreement", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "position" ] }, "payment_pages_checkout_session_permissions": { "description": "", "properties": { "update": { "anyOf": [ { "$ref": "#/components/schemas/payment_pages_checkout_session_update_permission" } ], "description": "Permissions for updating the Checkout Session.", "nullable": true }, "update_line_items": { "description": "Determines which entity is allowed to update the line items.\n\nDefault is `client_only`. Stripe Checkout client will automatically update the line items. If set to `server_only`, only your server is allowed to update the line items.\n\nWhen set to `server_only`, you must add the onLineItemsChange event handler when initializing the Stripe Checkout client and manually update the line items from your server using the Stripe API.", "enum": [ "client_only", "server_only" ], "nullable": true, "type": "string" }, "update_shipping_details": { "description": "Determines which entity is allowed to update the shipping details.\n\nDefault is `client_only`. Stripe Checkout client will automatically update the shipping details. If set to `server_only`, only your server is allowed to update the shipping details.\n\nWhen set to `server_only`, you must add the onShippingDetailsChange event handler when initializing the Stripe Checkout client and manually update the shipping details from your server using the Stripe API.", "enum": [ "client_only", "server_only" ], "nullable": true, "type": "string" } }, "required": [ "update_shipping_details" ], "title": "PaymentPagesCheckoutSessionPermissions", "type": "object", "x-expandableFields": [ "update" ], "x-stripeMostCommon": [ "update", "update_line_items", "update_shipping_details" ], "x-stripeResource": { "class_name": "Permissions", "in_package": "" } }, "payment_pages_checkout_session_phone_number_collection": { "description": "", "properties": { "enabled": { "description": "Indicates whether phone number collection is enabled for the session", "type": "boolean" } }, "required": [ "enabled" ], "title": "PaymentPagesCheckoutSessionPhoneNumberCollection", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "enabled" ] }, "payment_pages_checkout_session_saved_payment_method_options": { "description": "", "properties": { "allow_redisplay_filters": { "description": "Uses the `allow_redisplay` value of each saved payment method to filter the set presented to a returning customer. By default, only saved payment methods with ’allow_redisplay: ‘always’ are shown in Checkout.", "items": { "enum": [ "always", "limited", "unspecified" ], "type": "string" }, "nullable": true, "type": "array" }, "payment_method_remove": { "description": "Enable customers to choose if they wish to remove their saved payment methods. Disabled by default.", "enum": [ "disabled", "enabled" ], "nullable": true, "type": "string" }, "payment_method_save": { "description": "Enable customers to choose if they wish to save their payment method for future use. Disabled by default.", "enum": [ "disabled", "enabled" ], "nullable": true, "type": "string" } }, "required": [ "allow_redisplay_filters", "payment_method_remove", "payment_method_save" ], "title": "PaymentPagesCheckoutSessionSavedPaymentMethodOptions", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "allow_redisplay_filters", "payment_method_remove", "payment_method_save" ] }, "payment_pages_checkout_session_shipping_address_collection": { "description": "", "properties": { "allowed_countries": { "description": "An array of two-letter ISO country codes representing which countries Checkout should provide as options for\nshipping locations. Unsupported country codes: `AS, CX, CC, CU, HM, IR, KP, MH, FM, NF, MP, PW, SY, UM, VI`.", "items": { "enum": [ "AC", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CV", "CW", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MK", "ML", "MM", "MN", "MO", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SZ", "TA", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VN", "VU", "WF", "WS", "XK", "YE", "YT", "ZA", "ZM", "ZW", "ZZ" ], "type": "string" }, "type": "array" } }, "required": [ "allowed_countries" ], "title": "PaymentPagesCheckoutSessionShippingAddressCollection", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "allowed_countries" ], "x-stripeResource": { "class_name": "ShippingAddressCollection", "in_package": "" } }, "payment_pages_checkout_session_shipping_cost": { "description": "", "properties": { "amount_subtotal": { "description": "Total shipping cost before any discounts or taxes are applied.", "type": "integer" }, "amount_tax": { "description": "Total tax amount applied due to shipping costs. If no tax was applied, defaults to 0.", "type": "integer" }, "amount_total": { "description": "Total shipping cost after discounts and taxes are applied.", "type": "integer" }, "shipping_rate": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/shipping_rate" } ], "description": "The ID of the ShippingRate for this order.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/shipping_rate" } ] } }, "taxes": { "description": "The taxes applied to the shipping rate.", "items": { "$ref": "#/components/schemas/line_items_tax_amount" }, "type": "array" } }, "required": [ "amount_subtotal", "amount_tax", "amount_total", "shipping_rate" ], "title": "PaymentPagesCheckoutSessionShippingCost", "type": "object", "x-expandableFields": [ "shipping_rate", "taxes" ], "x-stripeMostCommon": [ "amount_subtotal", "amount_tax", "amount_total", "shipping_rate", "taxes" ] }, "payment_pages_checkout_session_shipping_option": { "description": "", "properties": { "shipping_amount": { "description": "A non-negative integer in cents representing how much to charge.", "type": "integer" }, "shipping_rate": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/shipping_rate" } ], "description": "The shipping rate.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/shipping_rate" } ] } } }, "required": [ "shipping_amount", "shipping_rate" ], "title": "PaymentPagesCheckoutSessionShippingOption", "type": "object", "x-expandableFields": [ "shipping_rate" ], "x-stripeMostCommon": [ "shipping_amount", "shipping_rate" ] }, "payment_pages_checkout_session_tax_id": { "description": "", "properties": { "type": { "description": "The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `al_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, `aw_tin`, `az_tin`, `bd_bin`, `bj_ifu`, `et_tin`, `kg_tin`, `la_tin`, `cm_niu`, `cv_nif`, `bf_ifu`, or `unknown`", "enum": [ "ad_nrt", "ae_trn", "al_tin", "am_tin", "ao_tin", "ar_cuit", "au_abn", "au_arn", "aw_tin", "az_tin", "ba_tin", "bb_tin", "bd_bin", "bf_ifu", "bg_uic", "bh_vat", "bj_ifu", "bo_tin", "br_cnpj", "br_cpf", "bs_tin", "by_tin", "ca_bn", "ca_gst_hst", "ca_pst_bc", "ca_pst_mb", "ca_pst_sk", "ca_qst", "cd_nif", "ch_uid", "ch_vat", "cl_tin", "cm_niu", "cn_tin", "co_nit", "cr_tin", "cv_nif", "de_stn", "do_rcn", "ec_ruc", "eg_tin", "es_cif", "et_tin", "eu_oss_vat", "eu_vat", "gb_vat", "ge_vat", "gn_nif", "hk_br", "hr_oib", "hu_tin", "id_npwp", "il_vat", "in_gst", "is_vat", "jp_cn", "jp_rn", "jp_trn", "ke_pin", "kg_tin", "kh_tin", "kr_brn", "kz_bin", "la_tin", "li_uid", "li_vat", "ma_vat", "md_vat", "me_pib", "mk_vat", "mr_nif", "mx_rfc", "my_frp", "my_itn", "my_sst", "ng_tin", "no_vat", "no_voec", "np_pan", "nz_gst", "om_vat", "pe_ruc", "ph_tin", "ro_tin", "rs_pib", "ru_inn", "ru_kpp", "sa_vat", "sg_gst", "sg_uen", "si_tin", "sn_ninea", "sr_fin", "sv_nit", "th_vat", "tj_tin", "tr_tin", "tw_vat", "tz_vat", "ua_vat", "ug_tin", "unknown", "us_ein", "uy_ruc", "uz_tin", "uz_vat", "ve_rif", "vn_tin", "za_vat", "zm_tin", "zw_tin" ], "type": "string" }, "value": { "description": "The value of the tax ID.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "type", "value" ], "title": "PaymentPagesCheckoutSessionTaxID", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "type", "value" ] }, "payment_pages_checkout_session_tax_id_collection": { "description": "", "properties": { "enabled": { "description": "Indicates whether tax ID collection is enabled for the session", "type": "boolean" }, "required": { "description": "Indicates whether a tax ID is required on the payment page", "enum": [ "if_supported", "never" ], "type": "string" } }, "required": [ "enabled", "required" ], "title": "PaymentPagesCheckoutSessionTaxIDCollection", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "enabled", "required" ] }, "payment_pages_checkout_session_total_details": { "description": "", "properties": { "amount_discount": { "description": "This is the sum of all the discounts.", "type": "integer" }, "amount_shipping": { "description": "This is the sum of all the shipping amounts.", "nullable": true, "type": "integer" }, "amount_tax": { "description": "This is the sum of all the tax amounts.", "type": "integer" }, "breakdown": { "$ref": "#/components/schemas/payment_pages_checkout_session_total_details_resource_breakdown" } }, "required": [ "amount_discount", "amount_shipping", "amount_tax" ], "title": "PaymentPagesCheckoutSessionTotalDetails", "type": "object", "x-expandableFields": [ "breakdown" ], "x-stripeMostCommon": [ "amount_discount", "amount_shipping", "amount_tax", "breakdown" ] }, "payment_pages_checkout_session_total_details_resource_breakdown": { "description": "", "properties": { "discounts": { "description": "The aggregated discounts.", "items": { "$ref": "#/components/schemas/line_items_discount_amount" }, "type": "array" }, "taxes": { "description": "The aggregated tax amounts by rate.", "items": { "$ref": "#/components/schemas/line_items_tax_amount" }, "type": "array" } }, "required": [ "discounts", "taxes" ], "title": "PaymentPagesCheckoutSessionTotalDetailsResourceBreakdown", "type": "object", "x-expandableFields": [ "discounts", "taxes" ], "x-stripeMostCommon": [ "discounts", "taxes" ] }, "payment_pages_checkout_session_update_permission": { "description": "", "properties": { "line_items": { "description": "Determines which entity is allowed to update the line items.\n\nDefault is `client_only`. Stripe Checkout client will automatically update the line items. If set to `server_only`, only your server is allowed to update the line items.\n\nWhen set to `server_only`, you must add the onLineItemsChange event handler when initializing the Stripe Checkout client and manually update the line items from your server using the Stripe API.", "enum": [ "client_only", "server_only" ], "nullable": true, "type": "string" }, "shipping_details": { "description": "Determines which entity is allowed to update the shipping details.\n\nDefault is `client_only`. Stripe Checkout client will automatically update the shipping details. If set to `server_only`, only your server is allowed to update the shipping details.\n\nWhen set to `server_only`, you must add the onShippingDetailsChange event handler when initializing the Stripe Checkout client and manually update the shipping details from your server using the Stripe API.", "enum": [ "client_only", "server_only" ], "nullable": true, "type": "string" } }, "required": [ "shipping_details" ], "title": "PaymentPagesCheckoutSessionUpdatePermission", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "line_items", "shipping_details" ], "x-stripeResource": { "class_name": "UpdatePermission", "in_package": "" } }, "payment_pages_private_card_payment_method_options_resource_restrictions": { "description": "", "properties": { "brands_blocked": { "description": "Specify the card brands to block in the Checkout Session. If a customer enters or selects a card belonging to a blocked brand, they can't complete the Session.", "items": { "enum": [ "american_express", "discover_global_network", "mastercard", "visa" ], "type": "string" }, "type": "array" } }, "title": "PaymentPagesPrivateCardPaymentMethodOptionsResourceRestrictions", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "brands_blocked" ], "x-stripeResource": { "class_name": "CheckoutCardRestrictions", "in_package": "" } }, "payment_plan_amount": { "description": "", "properties": { "amount": { "description": "Incremental amount due for this payment in cents (or local equivalent).", "type": "integer" }, "amount_paid": { "description": "The amount in cents (or local equivalent) that was paid for this payment.", "type": "integer" }, "amount_remaining": { "description": "The difference between the payment’s amount and amount_paid, in cents (or local equivalent).", "type": "integer" }, "days_until_due": { "description": "Number of days from when invoice is finalized until the payment is due.", "nullable": true, "type": "integer" }, "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users.", "maxLength": 5000, "nullable": true, "type": "string" }, "due_date": { "description": "Date on which a payment plan’s payment is due.", "format": "unix-time", "nullable": true, "type": "integer" }, "paid_at": { "description": "Timestamp when the payment was paid.", "format": "unix-time", "nullable": true, "type": "integer" }, "status": { "description": "The status of the payment, one of `open`, `paid`, or `past_due`", "enum": [ "open", "paid", "past_due" ], "type": "string" } }, "required": [ "amount", "amount_paid", "amount_remaining", "days_until_due", "description", "due_date", "paid_at", "status" ], "title": "PaymentPlanAmount", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "amount", "amount_paid", "amount_remaining", "days_until_due", "description", "due_date", "paid_at", "status" ] }, "payment_record": { "description": "A Payment Record is a resource that allows you to represent payments that occur on- or off-Stripe.\nFor example, you can create a Payment Record to model a payment made on a different payment processor,\nin order to mark an Invoice as paid and a Subscription as active. Payment Records consist of one or\nmore Payment Attempt Records, which represent individual attempts made on a payment network.", "properties": { "amount": { "$ref": "#/components/schemas/payments_primitives_payment_records_resource_amount" }, "amount_authorized": { "$ref": "#/components/schemas/payments_primitives_payment_records_resource_amount" }, "amount_canceled": { "$ref": "#/components/schemas/payments_primitives_payment_records_resource_amount" }, "amount_failed": { "$ref": "#/components/schemas/payments_primitives_payment_records_resource_amount" }, "amount_guaranteed": { "$ref": "#/components/schemas/payments_primitives_payment_records_resource_amount" }, "amount_refunded": { "$ref": "#/components/schemas/payments_primitives_payment_records_resource_amount" }, "amount_requested": { "$ref": "#/components/schemas/payments_primitives_payment_records_resource_amount" }, "application": { "description": "ID of the Connect application that created the PaymentRecord.", "maxLength": 5000, "nullable": true, "type": "string" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "customer_details": { "anyOf": [ { "$ref": "#/components/schemas/payments_primitives_payment_records_resource_customer_details" } ], "description": "Customer information for this payment.", "nullable": true }, "customer_presence": { "description": "Indicates whether the customer was present in your checkout flow during this payment.", "enum": [ "off_session", "on_session" ], "nullable": true, "type": "string" }, "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users.", "maxLength": 5000, "nullable": true, "type": "string" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "latest_payment_attempt_record": { "description": "ID of the latest Payment Attempt Record attached to this Payment Record.", "maxLength": 5000, "nullable": true, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "type": "object" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "payment_record" ], "type": "string" }, "payment_method_details": { "anyOf": [ { "$ref": "#/components/schemas/payments_primitives_payment_records_resource_payment_method_details" } ], "description": "Information about the Payment Method debited for this payment.", "nullable": true }, "processor_details": { "$ref": "#/components/schemas/payments_primitives_payment_records_resource_processor_details" }, "shipping_details": { "anyOf": [ { "$ref": "#/components/schemas/payments_primitives_payment_records_resource_shipping_details" } ], "description": "Shipping information for this payment.", "nullable": true } }, "required": [ "amount", "amount_authorized", "amount_canceled", "amount_failed", "amount_guaranteed", "amount_refunded", "amount_requested", "application", "created", "customer_details", "customer_presence", "description", "id", "latest_payment_attempt_record", "livemode", "metadata", "object", "payment_method_details", "processor_details", "shipping_details" ], "title": "PaymentRecord", "type": "object", "x-expandableFields": [ "amount", "amount_authorized", "amount_canceled", "amount_failed", "amount_guaranteed", "amount_refunded", "amount_requested", "customer_details", "payment_method_details", "processor_details", "shipping_details" ], "x-resourceId": "payment_record", "x-stripeMostCommon": [ "amount", "amount_authorized", "amount_canceled", "amount_failed", "amount_guaranteed", "amount_refunded", "amount_requested", "customer_details", "customer_presence", "description", "id", "metadata", "payment_method_details", "processor_details", "shipping_details" ], "x-stripeOperations": [ { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/payment_records/{id}" }, { "method_name": "report_payment_attempt", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/payment_records/{id}/report_payment_attempt" }, { "method_name": "report_payment_attempt_canceled", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/payment_records/{id}/report_payment_attempt_canceled" }, { "method_name": "report_payment_attempt_failed", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/payment_records/{id}/report_payment_attempt_failed" }, { "method_name": "report_payment_attempt_guaranteed", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/payment_records/{id}/report_payment_attempt_guaranteed" }, { "method_name": "report_payment", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/payment_records/report_payment" } ], "x-stripeResource": { "class_name": "PaymentRecord", "in_package": "" } }, "payment_source": { "anyOf": [ { "$ref": "#/components/schemas/account" }, { "$ref": "#/components/schemas/bank_account" }, { "$ref": "#/components/schemas/card" }, { "$ref": "#/components/schemas/source" } ], "title": "Polymorphic", "x-resourceId": "payment_source", "x-stripeBypassValidation": true, "x-stripeOperations": [ { "method_name": "list", "method_on": "collection", "method_type": "list", "operation": "get", "path": "/v1/customers/{customer}/sources" }, { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/customers/{customer}/sources" }, { "method_name": "retrieve", "method_on": "collection", "method_type": "retrieve", "operation": "get", "path": "/v1/customers/{customer}/sources/{id}" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/customers/{customer}/sources/{id}" }, { "method_name": "create", "method_on": "collection", "method_type": "create", "operation": "post", "path": "/v1/customers/{customer}/sources" }, { "method_name": "create", "method_on": "service", "method_type": "create", "operation": "post", "path": "/v1/customers/{customer}/sources" } ], "x-stripeResource": { "class_name": "PaymentSource", "has_collection_class": true } }, "payments_primitives_payment_records_resource_address": { "description": "A representation of a physical address.", "properties": { "city": { "description": "City, district, suburb, town, or village.", "maxLength": 5000, "nullable": true, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "nullable": true, "type": "string" }, "line1": { "description": "Address line 1 (e.g., street, PO Box, or company name).", "maxLength": 5000, "nullable": true, "type": "string" }, "line2": { "description": "Address line 2 (e.g., apartment, suite, unit, or building).", "maxLength": 5000, "nullable": true, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "nullable": true, "type": "string" }, "state": { "description": "State, county, province, or region.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "city", "country", "line1", "line2", "postal_code", "state" ], "title": "PaymentsPrimitivesPaymentRecordsResourceAddress", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state" ] }, "payments_primitives_payment_records_resource_amount": { "description": "A representation of an amount of money, consisting of an amount and a currency.", "properties": { "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "value": { "description": "A positive integer representing the amount in the currency's [minor unit](https://stripe.com/docs/currencies#zero-decimal). For example, `100` can represent 1 USD or 100 JPY.", "type": "integer" } }, "required": [ "currency", "value" ], "title": "PaymentsPrimitivesPaymentRecordsResourceAmount", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "currency", "value" ] }, "payments_primitives_payment_records_resource_billing_details": { "description": "Billing details used by the customer for this payment.", "properties": { "address": { "$ref": "#/components/schemas/payments_primitives_payment_records_resource_address" }, "email": { "description": "The billing email associated with the method of payment.", "maxLength": 5000, "nullable": true, "type": "string" }, "name": { "description": "The billing name associated with the method of payment.", "maxLength": 5000, "nullable": true, "type": "string" }, "phone": { "description": "The billing phone number associated with the method of payment.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "address", "email", "name", "phone" ], "title": "PaymentsPrimitivesPaymentRecordsResourceBillingDetails", "type": "object", "x-expandableFields": [ "address" ], "x-stripeMostCommon": [ "address", "email", "name", "phone" ] }, "payments_primitives_payment_records_resource_customer_details": { "description": "Information about the customer for this payment.", "properties": { "customer": { "description": "ID of the Stripe Customer associated with this payment.", "maxLength": 5000, "nullable": true, "type": "string" }, "email": { "description": "The customer's email address.", "maxLength": 5000, "nullable": true, "type": "string" }, "name": { "description": "The customer's name.", "maxLength": 5000, "nullable": true, "type": "string" }, "phone": { "description": "The customer's phone number.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "customer", "email", "name", "phone" ], "title": "PaymentsPrimitivesPaymentRecordsResourceCustomerDetails", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "customer", "email", "name", "phone" ] }, "payments_primitives_payment_records_resource_payment_method_card_details": { "description": "Details of the card used for this payment attempt.", "properties": { "brand": { "description": "Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`.", "enum": [ "amex", "cartes_bancaires", "diners", "discover", "eftpos_au", "interac", "jcb", "link", "mastercard", "unionpay", "unknown", "visa" ], "type": "string" }, "capture_before": { "description": "When using manual capture, a future timestamp at which the charge will be automatically refunded if uncaptured.", "format": "unix-time", "type": "integer" }, "checks": { "anyOf": [ { "$ref": "#/components/schemas/payments_primitives_payment_records_resource_payment_method_card_details_resource_checks" } ], "description": "Check results by Card networks on Card address and CVC at time of payment.", "nullable": true }, "country": { "description": "Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.", "maxLength": 5000, "nullable": true, "type": "string" }, "exp_month": { "description": "Two-digit number representing the card's expiration month.", "type": "integer" }, "exp_year": { "description": "Four-digit number representing the card's expiration year.", "type": "integer" }, "fingerprint": { "description": "Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.\n\n*As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*", "maxLength": 5000, "nullable": true, "type": "string" }, "funding": { "description": "Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.", "enum": [ "credit", "debit", "prepaid", "unknown" ], "type": "string" }, "last4": { "description": "The last four digits of the card.", "maxLength": 5000, "type": "string" }, "moto": { "description": "True if this payment was marked as MOTO and out of scope for SCA.", "type": "boolean" }, "network": { "description": "Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.", "enum": [ "amex", "cartes_bancaires", "diners", "discover", "eftpos_au", "interac", "jcb", "link", "mastercard", "unionpay", "unknown", "visa" ], "nullable": true, "type": "string" }, "network_token": { "anyOf": [ { "$ref": "#/components/schemas/payments_primitives_payment_records_resource_payment_method_card_details_resource_network_token" } ], "description": "If this card has network token credentials, this contains the details of the network token credentials.", "nullable": true }, "network_transaction_id": { "description": "This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. This value will be present if it is returned by the financial network in the authorization response, and null otherwise.", "maxLength": 5000, "nullable": true, "type": "string" }, "three_d_secure": { "anyOf": [ { "$ref": "#/components/schemas/payments_primitives_payment_records_resource_payment_method_card_details_resource_three_d_secure" } ], "description": "Populated if this transaction used 3D Secure authentication.", "nullable": true }, "wallet": { "anyOf": [ { "$ref": "#/components/schemas/payments_primitives_payment_records_resource_payment_method_card_details_resource_wallet" } ], "description": "If this Card is part of a card wallet, this contains the details of the card wallet.", "nullable": true } }, "required": [ "brand", "checks", "country", "exp_month", "exp_year", "funding", "last4", "network", "network_transaction_id", "three_d_secure", "wallet" ], "title": "PaymentsPrimitivesPaymentRecordsResourcePaymentMethodCardDetails", "type": "object", "x-expandableFields": [ "checks", "network_token", "three_d_secure", "wallet" ], "x-stripeMostCommon": [ "brand", "capture_before", "checks", "country", "exp_month", "exp_year", "fingerprint", "funding", "last4", "moto", "network", "network_token", "network_transaction_id", "three_d_secure", "wallet" ] }, "payments_primitives_payment_records_resource_payment_method_card_details_resource_checks": { "description": "", "properties": { "address_line1_check": { "enum": [ "fail", "pass", "unavailable", "unchecked" ], "nullable": true, "type": "string" }, "address_postal_code_check": { "enum": [ "fail", "pass", "unavailable", "unchecked" ], "nullable": true, "type": "string" }, "cvc_check": { "enum": [ "fail", "pass", "unavailable", "unchecked" ], "nullable": true, "type": "string" } }, "required": [ "address_line1_check", "address_postal_code_check", "cvc_check" ], "title": "PaymentsPrimitivesPaymentRecordsResourcePaymentMethodCardDetailsResourceChecks", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "address_line1_check", "address_postal_code_check", "cvc_check" ] }, "payments_primitives_payment_records_resource_payment_method_card_details_resource_network_token": { "description": "", "properties": { "used": { "type": "boolean" } }, "required": [ "used" ], "title": "PaymentsPrimitivesPaymentRecordsResourcePaymentMethodCardDetailsResourceNetworkToken", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "used" ] }, "payments_primitives_payment_records_resource_payment_method_card_details_resource_three_d_secure": { "description": "", "properties": { "authentication_flow": { "enum": [ "challenge", "frictionless" ], "nullable": true, "type": "string" }, "result": { "enum": [ "attempt_acknowledged", "authenticated", "exempted", "failed", "not_supported", "processing_error" ], "nullable": true, "type": "string" }, "result_reason": { "enum": [ "abandoned", "bypassed", "canceled", "card_not_enrolled", "network_not_supported", "protocol_error", "rejected" ], "nullable": true, "type": "string" }, "version": { "enum": [ "1.0.2", "2.1.0", "2.2.0" ], "nullable": true, "type": "string" } }, "required": [ "authentication_flow", "result", "result_reason", "version" ], "title": "PaymentsPrimitivesPaymentRecordsResourcePaymentMethodCardDetailsResourceThreeDSecure", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "authentication_flow", "result", "result_reason", "version" ] }, "payments_primitives_payment_records_resource_payment_method_card_details_resource_wallet": { "description": "", "properties": { "apple_pay": { "$ref": "#/components/schemas/payments_primitives_payment_records_resource_payment_method_card_details_resource_wallet_resource_apple_pay" }, "dynamic_last4": { "description": "(For tokenized numbers only.) The last four digits of the device account number.", "maxLength": 5000, "type": "string" }, "google_pay": { "$ref": "#/components/schemas/payments_primitives_payment_records_resource_payment_method_card_details_resource_wallet_resource_google_pay" }, "type": { "description": "The type of the card wallet, one of `apple_pay` or `google_pay`. An additional hash is included on the Wallet subhash with a name matching this value. It contains additional information specific to the card wallet type.", "maxLength": 5000, "type": "string" } }, "required": [ "type" ], "title": "PaymentsPrimitivesPaymentRecordsResourcePaymentMethodCardDetailsResourceWallet", "type": "object", "x-expandableFields": [ "apple_pay", "google_pay" ], "x-stripeMostCommon": [ "apple_pay", "dynamic_last4", "google_pay", "type" ] }, "payments_primitives_payment_records_resource_payment_method_card_details_resource_wallet_resource_apple_pay": { "description": "", "properties": { "type": { "description": "Type of the apple_pay transaction, one of `apple_pay` or `apple_pay_later`.", "maxLength": 5000, "type": "string" } }, "required": [ "type" ], "title": "PaymentsPrimitivesPaymentRecordsResourcePaymentMethodCardDetailsResourceWalletResourceApplePay", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "type" ] }, "payments_primitives_payment_records_resource_payment_method_card_details_resource_wallet_resource_google_pay": { "description": "", "properties": {}, "title": "PaymentsPrimitivesPaymentRecordsResourcePaymentMethodCardDetailsResourceWalletResourceGooglePay", "type": "object", "x-expandableFields": [] }, "payments_primitives_payment_records_resource_payment_method_custom_details": { "description": "Custom Payment Methods represent Payment Method types not modeled directly in\nthe Stripe API. This resource consists of details about the custom payment method\nused for this payment attempt.", "properties": { "display_name": { "description": "Display name for the custom (user-defined) payment method type used to make this payment.", "maxLength": 5000, "type": "string" }, "type": { "description": "The custom payment method type associated with this payment.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "display_name", "type" ], "title": "PaymentsPrimitivesPaymentRecordsResourcePaymentMethodCustomDetails", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "display_name", "type" ] }, "payments_primitives_payment_records_resource_payment_method_details": { "description": "Details about the Payment Method used in this payment attempt.", "properties": { "ach_credit_transfer": { "$ref": "#/components/schemas/payment_method_details_ach_credit_transfer" }, "ach_debit": { "$ref": "#/components/schemas/payment_method_details_ach_debit" }, "acss_debit": { "$ref": "#/components/schemas/payment_method_details_acss_debit" }, "affirm": { "$ref": "#/components/schemas/payment_method_details_affirm" }, "afterpay_clearpay": { "$ref": "#/components/schemas/payment_method_details_afterpay_clearpay" }, "alipay": { "$ref": "#/components/schemas/payment_flows_private_payment_methods_alipay_details" }, "alma": { "$ref": "#/components/schemas/payment_method_details_alma" }, "amazon_pay": { "$ref": "#/components/schemas/payment_method_details_amazon_pay" }, "au_becs_debit": { "$ref": "#/components/schemas/payment_method_details_au_becs_debit" }, "bacs_debit": { "$ref": "#/components/schemas/payment_method_details_bacs_debit" }, "bancontact": { "$ref": "#/components/schemas/payment_method_details_bancontact" }, "billie": { "$ref": "#/components/schemas/payment_method_details_billie" }, "billing_details": { "anyOf": [ { "$ref": "#/components/schemas/payments_primitives_payment_records_resource_billing_details" } ], "description": "The billing details associated with the method of payment.", "nullable": true }, "blik": { "$ref": "#/components/schemas/payment_method_details_blik" }, "boleto": { "$ref": "#/components/schemas/payment_method_details_boleto" }, "card": { "$ref": "#/components/schemas/payments_primitives_payment_records_resource_payment_method_card_details" }, "card_present": { "$ref": "#/components/schemas/payment_method_details_card_present" }, "cashapp": { "$ref": "#/components/schemas/payment_method_details_cashapp" }, "crypto": { "$ref": "#/components/schemas/payment_method_details_crypto" }, "custom": { "$ref": "#/components/schemas/payments_primitives_payment_records_resource_payment_method_custom_details" }, "customer_balance": { "$ref": "#/components/schemas/payment_method_details_customer_balance" }, "eps": { "$ref": "#/components/schemas/payment_method_details_eps" }, "fpx": { "$ref": "#/components/schemas/payment_method_details_fpx" }, "giropay": { "$ref": "#/components/schemas/payment_method_details_giropay" }, "gopay": { "$ref": "#/components/schemas/payment_method_details_gopay" }, "grabpay": { "$ref": "#/components/schemas/payment_method_details_grabpay" }, "id_bank_transfer": { "$ref": "#/components/schemas/payment_method_details_id_bank_transfer" }, "ideal": { "$ref": "#/components/schemas/payment_method_details_ideal" }, "interac_present": { "$ref": "#/components/schemas/payment_method_details_interac_present" }, "kakao_pay": { "$ref": "#/components/schemas/payment_method_details_kakao_pay" }, "klarna": { "$ref": "#/components/schemas/payment_method_details_klarna" }, "konbini": { "$ref": "#/components/schemas/payment_method_details_konbini" }, "kr_card": { "$ref": "#/components/schemas/payment_method_details_kr_card" }, "link": { "$ref": "#/components/schemas/payment_method_details_link" }, "mb_way": { "$ref": "#/components/schemas/payment_method_details_mb_way" }, "mobilepay": { "$ref": "#/components/schemas/payment_method_details_mobilepay" }, "multibanco": { "$ref": "#/components/schemas/payment_method_details_multibanco" }, "naver_pay": { "$ref": "#/components/schemas/payment_method_details_naver_pay" }, "nz_bank_account": { "$ref": "#/components/schemas/payment_method_details_nz_bank_account" }, "oxxo": { "$ref": "#/components/schemas/payment_method_details_oxxo" }, "p24": { "$ref": "#/components/schemas/payment_method_details_p24" }, "pay_by_bank": { "$ref": "#/components/schemas/payment_method_details_pay_by_bank" }, "payco": { "$ref": "#/components/schemas/payment_method_details_payco" }, "payment_method": { "description": "ID of the Stripe PaymentMethod used to make this payment.", "maxLength": 5000, "nullable": true, "type": "string" }, "paynow": { "$ref": "#/components/schemas/payment_method_details_paynow" }, "paypal": { "$ref": "#/components/schemas/payment_method_details_paypal" }, "paypay": { "$ref": "#/components/schemas/payment_method_details_paypay" }, "payto": { "$ref": "#/components/schemas/payment_method_details_payto" }, "pix": { "$ref": "#/components/schemas/payment_method_details_pix" }, "promptpay": { "$ref": "#/components/schemas/payment_method_details_promptpay" }, "qris": { "$ref": "#/components/schemas/payment_method_details_qris" }, "rechnung": { "$ref": "#/components/schemas/payment_method_details_rechnung" }, "revolut_pay": { "$ref": "#/components/schemas/payment_method_details_revolut_pay" }, "samsung_pay": { "$ref": "#/components/schemas/payment_method_details_samsung_pay" }, "satispay": { "$ref": "#/components/schemas/payment_method_details_satispay" }, "sepa_credit_transfer": { "$ref": "#/components/schemas/payment_method_details_sepa_credit_transfer" }, "sepa_debit": { "$ref": "#/components/schemas/payment_method_details_sepa_debit" }, "shopeepay": { "$ref": "#/components/schemas/payment_method_details_shopeepay" }, "sofort": { "$ref": "#/components/schemas/payment_method_details_sofort" }, "stripe_account": { "$ref": "#/components/schemas/payment_method_details_stripe_account" }, "stripe_balance": { "$ref": "#/components/schemas/payment_method_details_stripe_balance" }, "swish": { "$ref": "#/components/schemas/payment_method_details_swish" }, "twint": { "$ref": "#/components/schemas/payment_method_details_twint" }, "type": { "description": "The type of transaction-specific details of the payment method used in the payment. See [PaymentMethod.type](https://stripe.com/docs/api/payment_methods/object#payment_method_object-type) for the full list of possible types.\nAn additional hash is included on `payment_method_details` with a name matching this value.\nIt contains information specific to the payment method.", "maxLength": 5000, "type": "string" }, "us_bank_account": { "$ref": "#/components/schemas/payments_primitives_payment_records_resource_payment_method_us_bank_account_details" }, "wechat": { "$ref": "#/components/schemas/payment_method_details_wechat" }, "wechat_pay": { "$ref": "#/components/schemas/payment_method_details_wechat_pay" }, "zip": { "$ref": "#/components/schemas/payment_method_details_zip" } }, "required": [ "billing_details", "payment_method", "type" ], "title": "PaymentsPrimitivesPaymentRecordsResourcePaymentMethodDetails", "type": "object", "x-expandableFields": [ "ach_credit_transfer", "ach_debit", "acss_debit", "affirm", "afterpay_clearpay", "alipay", "alma", "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", "billie", "billing_details", "blik", "boleto", "card", "card_present", "cashapp", "crypto", "custom", "customer_balance", "eps", "fpx", "giropay", "gopay", "grabpay", "id_bank_transfer", "ideal", "interac_present", "kakao_pay", "klarna", "konbini", "kr_card", "link", "mb_way", "mobilepay", "multibanco", "naver_pay", "nz_bank_account", "oxxo", "p24", "pay_by_bank", "payco", "paynow", "paypal", "paypay", "payto", "pix", "promptpay", "qris", "rechnung", "revolut_pay", "samsung_pay", "satispay", "sepa_credit_transfer", "sepa_debit", "shopeepay", "sofort", "stripe_account", "stripe_balance", "swish", "twint", "us_bank_account", "wechat", "wechat_pay", "zip" ], "x-stripeMostCommon": [ "ach_credit_transfer", "ach_debit", "acss_debit", "affirm", "afterpay_clearpay", "alipay", "alma", "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", "billie", "billing_details", "blik", "boleto", "card", "card_present", "cashapp", "crypto", "custom", "customer_balance", "eps", "fpx", "giropay", "gopay", "grabpay", "id_bank_transfer", "ideal", "interac_present", "kakao_pay", "klarna", "konbini", "kr_card", "link", "mb_way", "mobilepay", "multibanco", "naver_pay", "nz_bank_account", "oxxo", "p24", "pay_by_bank", "payco", "payment_method", "paynow", "paypal", "paypay", "payto", "pix", "promptpay", "qris", "rechnung", "revolut_pay", "samsung_pay", "satispay", "sepa_credit_transfer", "sepa_debit", "shopeepay", "sofort", "stripe_account", "stripe_balance", "swish", "twint", "type", "us_bank_account", "wechat", "wechat_pay", "zip" ] }, "payments_primitives_payment_records_resource_payment_method_us_bank_account_details": { "description": "Details of the US Bank Account used for this payment attempt.", "properties": { "account_holder_type": { "enum": [ "company", "individual" ], "nullable": true, "type": "string" }, "account_type": { "enum": [ "checking", "savings" ], "nullable": true, "type": "string" }, "bank_name": { "description": "Name of the bank associated with the bank account.", "maxLength": 5000, "nullable": true, "type": "string" }, "fingerprint": { "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.", "maxLength": 5000, "nullable": true, "type": "string" }, "last4": { "description": "Last four digits of the bank account number.", "maxLength": 5000, "nullable": true, "type": "string" }, "mandate": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/mandate" } ], "description": "ID of the mandate used to make this payment.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/mandate" } ] } }, "payment_reference": { "description": "Reference number to locate ACH payments with customer’s bank.", "maxLength": 5000, "nullable": true, "type": "string" }, "routing_number": { "description": "Routing number of the bank account.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "account_holder_type", "account_type", "bank_name", "fingerprint", "last4", "payment_reference", "routing_number" ], "title": "PaymentsPrimitivesPaymentRecordsResourcePaymentMethodUsBankAccountDetails", "type": "object", "x-expandableFields": [ "mandate" ], "x-stripeMostCommon": [ "account_holder_type", "account_type", "bank_name", "fingerprint", "last4", "mandate", "payment_reference", "routing_number" ] }, "payments_primitives_payment_records_resource_processor_details": { "description": "Processor information associated with this payment.", "properties": { "custom": { "$ref": "#/components/schemas/payments_primitives_payment_records_resource_processor_details_resource_custom_details" }, "type": { "description": "The processor used for this payment attempt.", "enum": [ "custom" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "PaymentsPrimitivesPaymentRecordsResourceProcessorDetails", "type": "object", "x-expandableFields": [ "custom" ], "x-stripeMostCommon": [ "custom", "type" ] }, "payments_primitives_payment_records_resource_processor_details_resource_custom_details": { "description": "Custom processors represent payment processors not modeled directly in\nthe Stripe API. This resource consists of details about the custom processor\nused for this payment attempt.", "properties": { "payment_reference": { "description": "An opaque string for manual reconciliation of this payment, for example a check number or a payment processor ID.", "maxLength": 5000, "type": "string" } }, "required": [ "payment_reference" ], "title": "PaymentsPrimitivesPaymentRecordsResourceProcessorDetailsResourceCustomDetails", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "payment_reference" ] }, "payments_primitives_payment_records_resource_shipping_details": { "description": "The customer's shipping information associated with this payment.", "properties": { "address": { "$ref": "#/components/schemas/payments_primitives_payment_records_resource_address" }, "name": { "description": "The shipping recipient's name.", "maxLength": 5000, "nullable": true, "type": "string" }, "phone": { "description": "The shipping recipient's phone number.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "address", "name", "phone" ], "title": "PaymentsPrimitivesPaymentRecordsResourceShippingDetails", "type": "object", "x-expandableFields": [ "address" ], "x-stripeMostCommon": [ "address", "name", "phone" ] }, "payout": { "description": "A `Payout` object is created when you receive funds from Stripe, or when you\ninitiate a payout to either a bank account or debit card of a [connected\nStripe account](/docs/connect/bank-debit-card-payouts). You can retrieve individual payouts,\nand list all payouts. Payouts are made on [varying\nschedules](/docs/connect/manage-payout-schedule), depending on your country and\nindustry.\n\nRelated guide: [Receiving payouts](https://stripe.com/docs/payouts)", "properties": { "amount": { "description": "The amount (in cents (or local equivalent)) that transfers to your bank account or debit card.", "type": "integer" }, "application_fee": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/application_fee" } ], "description": "The application fee (if any) for the payout. [See the Connect documentation](https://stripe.com/docs/connect/instant-payouts#monetization-and-fees) for details.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/application_fee" } ] } }, "application_fee_amount": { "description": "The amount of the application fee (if any) requested for the payout. [See the Connect documentation](https://stripe.com/docs/connect/instant-payouts#monetization-and-fees) for details.", "nullable": true, "type": "integer" }, "arrival_date": { "description": "Date that you can expect the payout to arrive in the bank. This factors in delays to account for weekends or bank holidays.", "format": "unix-time", "type": "integer" }, "automatic": { "description": "Returns `true` if the payout is created by an [automated payout schedule](https://stripe.com/docs/payouts#payout-schedule) and `false` if it's [requested manually](https://stripe.com/docs/payouts#manual-payouts).", "type": "boolean" }, "balance_transaction": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/balance_transaction" } ], "description": "ID of the balance transaction that describes the impact of this payout on your account balance.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/balance_transaction" } ] } }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users.", "maxLength": 5000, "nullable": true, "type": "string" }, "destination": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/external_account" }, { "$ref": "#/components/schemas/deleted_external_account" } ], "description": "ID of the bank account or card the payout is sent to.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/external_account" }, { "$ref": "#/components/schemas/deleted_external_account" } ] } }, "failure_balance_transaction": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/balance_transaction" } ], "description": "If the payout fails or cancels, this is the ID of the balance transaction that reverses the initial balance transaction and returns the funds from the failed payout back in your balance.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/balance_transaction" } ] } }, "failure_code": { "description": "Error code that provides a reason for a payout failure, if available. View our [list of failure codes](https://stripe.com/docs/api#payout_failures).", "maxLength": 5000, "nullable": true, "type": "string" }, "failure_message": { "description": "Message that provides the reason for a payout failure, if available.", "maxLength": 5000, "nullable": true, "type": "string" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "nullable": true, "type": "object" }, "method": { "description": "The method used to send this payout, which can be `standard` or `instant`. `instant` is supported for payouts to debit cards and bank accounts in certain countries. Learn more about [bank support for Instant Payouts](https://stripe.com/docs/payouts/instant-payouts-banks).", "maxLength": 5000, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "payout" ], "type": "string" }, "original_payout": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/payout" } ], "description": "If the payout reverses another, this is the ID of the original payout.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/payout" } ] } }, "payout_method": { "description": "ID of the v2 FinancialAccount the funds are sent to.", "maxLength": 5000, "nullable": true, "type": "string" }, "reconciliation_status": { "description": "If `completed`, you can use the [Balance Transactions API](https://stripe.com/docs/api/balance_transactions/list#balance_transaction_list-payout) to list all balance transactions that are paid out in this payout.", "enum": [ "completed", "in_progress", "not_applicable" ], "type": "string" }, "reversed_by": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/payout" } ], "description": "If the payout reverses, this is the ID of the payout that reverses this payout.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/payout" } ] } }, "source_type": { "description": "The source balance this payout came from, which can be one of the following: `card`, `fpx`, or `bank_account`.", "maxLength": 5000, "type": "string" }, "statement_descriptor": { "description": "Extra information about a payout that displays on the user's bank statement.", "maxLength": 5000, "nullable": true, "type": "string" }, "status": { "description": "Current status of the payout: `paid`, `pending`, `in_transit`, `canceled` or `failed`. A payout is `pending` until it's submitted to the bank, when it becomes `in_transit`. The status changes to `paid` if the transaction succeeds, or to `failed` or `canceled` (within 5 business days). Some payouts that fail might initially show as `paid`, then change to `failed`.", "maxLength": 5000, "type": "string" }, "trace_id": { "anyOf": [ { "$ref": "#/components/schemas/payouts_trace_id" } ], "description": "A value that generates from the beneficiary's bank that allows users to track payouts with their bank. Banks might call this a \"reference number\" or something similar.", "nullable": true }, "type": { "description": "Can be `bank_account` or `card`.", "enum": [ "bank_account", "card" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "amount", "application_fee", "application_fee_amount", "arrival_date", "automatic", "balance_transaction", "created", "currency", "description", "destination", "failure_balance_transaction", "failure_code", "failure_message", "id", "livemode", "metadata", "method", "object", "original_payout", "payout_method", "reconciliation_status", "reversed_by", "source_type", "statement_descriptor", "status", "trace_id", "type" ], "title": "Payout", "type": "object", "x-expandableFields": [ "application_fee", "balance_transaction", "destination", "failure_balance_transaction", "original_payout", "reversed_by", "trace_id" ], "x-resourceId": "payout", "x-stripeMostCommon": [ "amount", "arrival_date", "currency", "description", "id", "metadata", "statement_descriptor", "status" ], "x-stripeOperations": [ { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/payouts" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/payouts/{payout}" }, { "method_name": "create", "method_on": "service", "method_type": "create", "operation": "post", "path": "/v1/payouts" }, { "method_name": "update", "method_on": "service", "method_type": "update", "operation": "post", "path": "/v1/payouts/{payout}" }, { "method_name": "cancel", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/payouts/{payout}/cancel" }, { "method_name": "reverse", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/payouts/{payout}/reverse" } ], "x-stripeResource": { "class_name": "Payout", "has_collection_class": true, "in_package": "", "polymorphic_groups": [ "balance_transaction_source" ] } }, "payout.canceled": { "description": "Occurs whenever a payout is canceled.", "properties": { "object": { "$ref": "#/components/schemas/payout" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "payout.canceled" } }, "payout.created": { "description": "Occurs whenever a payout is created.", "properties": { "object": { "$ref": "#/components/schemas/payout" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "payout.created" } }, "payout.failed": { "description": "Occurs whenever a payout attempt fails.", "properties": { "object": { "$ref": "#/components/schemas/payout" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "payout.failed" } }, "payout.paid": { "description": "Occurs whenever a payout is *expected* to be available in the destination account. If the payout fails, a `payout.failed` notification is also sent, at a later time.", "properties": { "object": { "$ref": "#/components/schemas/payout" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "payout.paid" } }, "payout.reconciliation_completed": { "description": "Occurs whenever balance transactions paid out in an automatic payout can be queried.", "properties": { "object": { "$ref": "#/components/schemas/payout" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "payout.reconciliation_completed" } }, "payout.updated": { "description": "Occurs whenever a payout is updated.", "properties": { "object": { "$ref": "#/components/schemas/payout" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "payout.updated" } }, "payouts_trace_id": { "description": "", "properties": { "status": { "description": "Possible values are `pending`, `supported`, and `unsupported`. When `payout.status` is `pending` or `in_transit`, this will be `pending`. When the payout transitions to `paid`, `failed`, or `canceled`, this status will become `supported` or `unsupported` shortly after in most cases. In some cases, this may appear as `pending` for up to 10 days after `arrival_date` until transitioning to `supported` or `unsupported`.", "maxLength": 5000, "type": "string" }, "value": { "description": "The trace ID value if `trace_id.status` is `supported`, otherwise `nil`.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "status", "value" ], "title": "PayoutsTraceID", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "status", "value" ] }, "paypal_seller_protection": { "description": "", "properties": { "dispute_categories": { "description": "An array of conditions that are covered for the transaction, if applicable.", "items": { "enum": [ "fraudulent", "product_not_received" ], "type": "string", "x-stripeBypassValidation": true }, "nullable": true, "type": "array" }, "status": { "description": "Indicates whether the transaction is eligible for PayPal's seller protection.", "enum": [ "eligible", "not_eligible", "partially_eligible" ], "type": "string" } }, "required": [ "dispute_categories", "status" ], "title": "paypal_seller_protection", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "dispute_categories", "status" ] }, "person": { "description": "This is an object representing a person associated with a Stripe account.\n\nA platform can only access a subset of data in a person for an account where [account.controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`, which includes Standard and Express accounts, after creating an Account Link or Account Session to start Connect onboarding.\n\nSee the [Standard onboarding](/connect/standard-accounts) or [Express onboarding](/connect/express-accounts) documentation for information about prefilling information and account onboarding steps. Learn more about [handling identity verification with the API](/connect/handling-api-verification#person-information).", "properties": { "account": { "description": "The account the person is associated with.", "maxLength": 5000, "type": "string" }, "additional_tos_acceptances": { "$ref": "#/components/schemas/person_additional_tos_acceptances" }, "address": { "$ref": "#/components/schemas/address" }, "address_kana": { "anyOf": [ { "$ref": "#/components/schemas/legal_entity_japan_address" } ], "description": "The Kana variation of the person's address (Japan only).", "nullable": true }, "address_kanji": { "anyOf": [ { "$ref": "#/components/schemas/legal_entity_japan_address" } ], "description": "The Kanji variation of the person's address (Japan only).", "nullable": true }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "dob": { "$ref": "#/components/schemas/legal_entity_dob" }, "email": { "description": "The person's email address. Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.", "maxLength": 5000, "nullable": true, "type": "string" }, "first_name": { "description": "The person's first name. Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.", "maxLength": 5000, "nullable": true, "type": "string" }, "first_name_kana": { "description": "The Kana variation of the person's first name (Japan only). Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.", "maxLength": 5000, "nullable": true, "type": "string" }, "first_name_kanji": { "description": "The Kanji variation of the person's first name (Japan only). Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.", "maxLength": 5000, "nullable": true, "type": "string" }, "full_name_aliases": { "description": "A list of alternate names or aliases that the person is known by. Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "future_requirements": { "anyOf": [ { "$ref": "#/components/schemas/person_future_requirements" } ], "description": "Information about the [upcoming new requirements for this person](https://stripe.com/docs/connect/custom-accounts/future-requirements), including what information needs to be collected, and by when.", "nullable": true }, "gender": { "description": "The person's gender.", "nullable": true, "type": "string" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "id_number_provided": { "description": "Whether the person's `id_number` was provided. True if either the full ID number was provided or if only the required part of the ID number was provided (ex. last four of an individual's SSN for the US indicated by `ssn_last_4_provided`).", "type": "boolean" }, "id_number_secondary_provided": { "description": "Whether the person's `id_number_secondary` was provided.", "type": "boolean" }, "last_name": { "description": "The person's last name. Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.", "maxLength": 5000, "nullable": true, "type": "string" }, "last_name_kana": { "description": "The Kana variation of the person's last name (Japan only). Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.", "maxLength": 5000, "nullable": true, "type": "string" }, "last_name_kanji": { "description": "The Kanji variation of the person's last name (Japan only). Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.", "maxLength": 5000, "nullable": true, "type": "string" }, "maiden_name": { "description": "The person's maiden name.", "maxLength": 5000, "nullable": true, "type": "string" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "type": "object" }, "nationality": { "description": "The country where the person is a national.", "maxLength": 5000, "nullable": true, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "person" ], "type": "string" }, "phone": { "description": "The person's phone number.", "maxLength": 5000, "nullable": true, "type": "string" }, "political_exposure": { "description": "Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction.", "enum": [ "existing", "none" ], "type": "string" }, "registered_address": { "$ref": "#/components/schemas/address" }, "relationship": { "$ref": "#/components/schemas/person_relationship" }, "requirements": { "anyOf": [ { "$ref": "#/components/schemas/person_requirements" } ], "description": "Information about the requirements for this person, including what information needs to be collected, and by when.", "nullable": true }, "ssn_last_4_provided": { "description": "Whether the last four digits of the person's Social Security number have been provided (U.S. only).", "type": "boolean" }, "us_cfpb_data": { "anyOf": [ { "$ref": "#/components/schemas/person_us_cfpb_data" } ], "description": "Demographic data related to the person.", "nullable": true }, "verification": { "$ref": "#/components/schemas/legal_entity_person_verification" } }, "required": [ "created", "id", "object" ], "title": "Person", "type": "object", "x-expandableFields": [ "additional_tos_acceptances", "address", "address_kana", "address_kanji", "dob", "future_requirements", "registered_address", "relationship", "requirements", "us_cfpb_data", "verification" ], "x-resourceId": "person", "x-stripeMostCommon": [ "account", "address", "dob", "email", "first_name", "id", "last_name", "metadata", "phone", "relationship", "requirements" ], "x-stripeOperations": [ { "method_name": "delete", "method_on": "service", "method_type": "delete", "operation": "delete", "path": "/v1/accounts/{account}/persons/{person}" }, { "method_name": "list", "method_on": "collection", "method_type": "list", "operation": "get", "path": "/v1/accounts/{account}/persons" }, { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/accounts/{account}/persons" }, { "method_name": "retrieve", "method_on": "collection", "method_type": "retrieve", "operation": "get", "path": "/v1/accounts/{account}/persons/{person}" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/accounts/{account}/persons/{person}" }, { "method_name": "create", "method_on": "collection", "method_type": "create", "operation": "post", "path": "/v1/accounts/{account}/persons" }, { "method_name": "create", "method_on": "service", "method_type": "create", "operation": "post", "path": "/v1/accounts/{account}/persons" }, { "method_name": "update", "method_on": "service", "method_type": "update", "operation": "post", "path": "/v1/accounts/{account}/persons/{person}" } ], "x-stripeResource": { "class_name": "Person", "has_collection_class": true, "in_package": "" } }, "person.created": { "description": "Occurs whenever a person associated with an account is created.", "properties": { "object": { "$ref": "#/components/schemas/person" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "person.created" } }, "person.deleted": { "description": "Occurs whenever a person associated with an account is deleted.", "properties": { "object": { "$ref": "#/components/schemas/person" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "person.deleted" } }, "person.updated": { "description": "Occurs whenever a person associated with an account is updated.", "properties": { "object": { "$ref": "#/components/schemas/person" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "person.updated" } }, "person_additional_tos_acceptance": { "description": "", "properties": { "date": { "description": "The Unix timestamp marking when the legal guardian accepted the service agreement.", "format": "unix-time", "nullable": true, "type": "integer" }, "ip": { "description": "The IP address from which the legal guardian accepted the service agreement.", "maxLength": 5000, "nullable": true, "type": "string" }, "user_agent": { "description": "The user agent of the browser from which the legal guardian accepted the service agreement.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "date", "ip", "user_agent" ], "title": "PersonAdditionalTOSAcceptance", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "date", "ip", "user_agent" ] }, "person_additional_tos_acceptances": { "description": "", "properties": { "account": { "anyOf": [ { "$ref": "#/components/schemas/person_additional_tos_acceptance" } ], "description": "Details on the legal guardian's acceptance of the main Stripe service agreement.", "nullable": true } }, "required": [ "account" ], "title": "PersonAdditionalTOSAcceptances", "type": "object", "x-expandableFields": [ "account" ], "x-stripeMostCommon": [ "account" ] }, "person_ethnicity_details": { "description": "", "properties": { "ethnicity": { "description": "The persons ethnicity", "items": { "enum": [ "cuban", "hispanic_or_latino", "mexican", "not_hispanic_or_latino", "other_hispanic_or_latino", "prefer_not_to_answer", "puerto_rican" ], "type": "string" }, "nullable": true, "type": "array" }, "ethnicity_other": { "description": "Please specify your origin, when other is selected.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "ethnicity", "ethnicity_other" ], "title": "PersonEthnicityDetails", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "ethnicity", "ethnicity_other" ] }, "person_future_requirements": { "description": "", "properties": { "alternatives": { "description": "Fields that are due and can be satisfied by providing the corresponding alternative fields instead.", "items": { "$ref": "#/components/schemas/account_requirements_alternative" }, "nullable": true, "type": "array" }, "currently_due": { "description": "Fields that need to be collected to keep the person's account enabled. If not collected by the account's `future_requirements[current_deadline]`, these fields will transition to the main `requirements` hash, and may immediately become `past_due`, but the account may also be given a grace period depending on the account's enablement state prior to transition.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "errors": { "description": "Fields that are `currently_due` and need to be collected again because validation or verification failed.", "items": { "$ref": "#/components/schemas/account_requirements_error" }, "type": "array" }, "eventually_due": { "description": "Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well, and the account's `future_requirements[current_deadline]` becomes set.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "past_due": { "description": "Fields that weren't collected by the account's `requirements.current_deadline`. These fields need to be collected to enable the person's account. New fields will never appear here; `future_requirements.past_due` will always be a subset of `requirements.past_due`.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "pending_verification": { "description": "Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due` or `currently_due`. Fields might appear in `eventually_due` or `currently_due` and in `pending_verification` if verification fails but another verification is still pending.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "required": [ "alternatives", "currently_due", "errors", "eventually_due", "past_due", "pending_verification" ], "title": "PersonFutureRequirements", "type": "object", "x-expandableFields": [ "alternatives", "errors" ], "x-stripeMostCommon": [ "alternatives", "currently_due", "errors", "eventually_due", "past_due", "pending_verification" ] }, "person_race_details": { "description": "", "properties": { "race": { "description": "The persons race.", "items": { "enum": [ "african_american", "american_indian_or_alaska_native", "asian", "asian_indian", "black_or_african_american", "chinese", "ethiopian", "filipino", "guamanian_or_chamorro", "haitian", "jamaican", "japanese", "korean", "native_hawaiian", "native_hawaiian_or_other_pacific_islander", "nigerian", "other_asian", "other_black_or_african_american", "other_pacific_islander", "prefer_not_to_answer", "samoan", "somali", "vietnamese", "white" ], "type": "string" }, "nullable": true, "type": "array" }, "race_other": { "description": "Please specify your race, when other is selected.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "race", "race_other" ], "title": "PersonRaceDetails", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "race", "race_other" ] }, "person_relationship": { "description": "", "properties": { "authorizer": { "description": "Whether the person is the authorizer of the account's representative.", "nullable": true, "type": "boolean" }, "director": { "description": "Whether the person is a director of the account's legal entity. Directors are typically members of the governing board of the company, or responsible for ensuring the company meets its regulatory obligations.", "nullable": true, "type": "boolean" }, "executive": { "description": "Whether the person has significant responsibility to control, manage, or direct the organization.", "nullable": true, "type": "boolean" }, "legal_guardian": { "description": "Whether the person is the legal guardian of the account's representative.", "nullable": true, "type": "boolean" }, "owner": { "description": "Whether the person is an owner of the account’s legal entity.", "nullable": true, "type": "boolean" }, "percent_ownership": { "description": "The percent owned by the person of the account's legal entity.", "nullable": true, "type": "number" }, "representative": { "description": "Whether the person is authorized as the primary representative of the account. This is the person nominated by the business to provide information about themselves, and general information about the account. There can only be one representative at any given time. At the time the account is created, this person should be set to the person responsible for opening the account.", "nullable": true, "type": "boolean" }, "title": { "description": "The person's title (e.g., CEO, Support Engineer).", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "authorizer", "director", "executive", "legal_guardian", "owner", "percent_ownership", "representative", "title" ], "title": "PersonRelationship", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "authorizer", "director", "executive", "legal_guardian", "owner", "percent_ownership", "representative", "title" ] }, "person_requirements": { "description": "", "properties": { "alternatives": { "description": "Fields that are due and can be satisfied by providing the corresponding alternative fields instead.", "items": { "$ref": "#/components/schemas/account_requirements_alternative" }, "nullable": true, "type": "array" }, "currently_due": { "description": "Fields that need to be collected to keep the person's account enabled. If not collected by the account's `current_deadline`, these fields appear in `past_due` as well, and the account is disabled.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "errors": { "description": "Fields that are `currently_due` and need to be collected again because validation or verification failed.", "items": { "$ref": "#/components/schemas/account_requirements_error" }, "type": "array" }, "eventually_due": { "description": "Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well, and the account's `current_deadline` becomes set.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "past_due": { "description": "Fields that weren't collected by the account's `current_deadline`. These fields need to be collected to enable the person's account.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "pending_verification": { "description": "Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. Fields might appear in `eventually_due`, `currently_due`, or `past_due` and in `pending_verification` if verification fails but another verification is still pending.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "required": [ "alternatives", "currently_due", "errors", "eventually_due", "past_due", "pending_verification" ], "title": "PersonRequirements", "type": "object", "x-expandableFields": [ "alternatives", "errors" ], "x-stripeMostCommon": [ "alternatives", "currently_due", "errors", "eventually_due", "past_due", "pending_verification" ] }, "person_us_cfpb_data": { "description": "", "properties": { "ethnicity_details": { "anyOf": [ { "$ref": "#/components/schemas/person_ethnicity_details" } ], "description": "The persons ethnicity details", "nullable": true }, "race_details": { "anyOf": [ { "$ref": "#/components/schemas/person_race_details" } ], "description": "The persons race details", "nullable": true }, "self_identified_gender": { "description": "The persons self-identified gender", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "ethnicity_details", "race_details", "self_identified_gender" ], "title": "PersonUSCfpbData", "type": "object", "x-expandableFields": [ "ethnicity_details", "race_details" ], "x-stripeMostCommon": [ "ethnicity_details", "race_details", "self_identified_gender" ] }, "plan": { "description": "You can now model subscriptions more flexibly using the [Prices API](https://stripe.com/docs/api#prices). It replaces the Plans API and is backwards compatible to simplify your migration.\n\nPlans define the base price, currency, and billing cycle for recurring purchases of products.\n[Products](https://stripe.com/docs/api#products) help you track inventory or provisioning, and plans help you track pricing. Different physical goods or levels of service should be represented by products, and pricing options should be represented by plans. This approach lets you change prices without having to change your provisioning scheme.\n\nFor example, you might have a single \"gold\" product that has plans for $10/month, $100/year, €9/month, and €90/year.\n\nRelated guides: [Set up a subscription](https://stripe.com/docs/billing/subscriptions/set-up-subscription) and more about [products and prices](https://stripe.com/docs/products-prices/overview).", "properties": { "active": { "description": "Whether the plan can be used for new purchases.", "type": "boolean" }, "amount": { "description": "The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`.", "nullable": true, "type": "integer" }, "amount_decimal": { "description": "The unit amount in cents (or local equivalent) to be charged, represented as a decimal string with at most 12 decimal places. Only set if `billing_scheme=per_unit`.", "format": "decimal", "nullable": true, "type": "string" }, "billing_scheme": { "description": "Describes how to compute the price per period. Either `per_unit` or `tiered`. `per_unit` indicates that the fixed amount (specified in `amount`) will be charged per unit in `quantity` (for plans with `usage_type=licensed`), or per unit of total usage (for plans with `usage_type=metered`). `tiered` indicates that the unit pricing will be computed using a tiering strategy as defined using the `tiers` and `tiers_mode` attributes.", "enum": [ "per_unit", "tiered" ], "type": "string" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "interval": { "description": "The frequency at which a subscription is billed. One of `day`, `week`, `month` or `year`.", "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "description": "The number of intervals (specified in the `interval` attribute) between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months.", "type": "integer" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "nullable": true, "type": "object" }, "meter": { "description": "The meter tracking the usage of a metered price", "maxLength": 5000, "nullable": true, "type": "string" }, "nickname": { "description": "A brief description of the plan, hidden from customers.", "maxLength": 5000, "nullable": true, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "plan" ], "type": "string" }, "product": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/product" }, { "$ref": "#/components/schemas/deleted_product" } ], "description": "The product whose pricing this plan determines.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/product" }, { "$ref": "#/components/schemas/deleted_product" } ] } }, "tiers": { "description": "Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.", "items": { "$ref": "#/components/schemas/plan_tier" }, "type": "array" }, "tiers_mode": { "description": "Defines if the tiering price should be `graduated` or `volume` based. In `volume`-based tiering, the maximum quantity within a period determines the per unit price. In `graduated` tiering, pricing can change as the quantity grows.", "enum": [ "graduated", "volume" ], "nullable": true, "type": "string" }, "transform_usage": { "anyOf": [ { "$ref": "#/components/schemas/transform_usage" } ], "description": "Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with `tiers`.", "nullable": true }, "trial_period_days": { "description": "Default number of trial days when subscribing a customer to this plan using [`trial_from_plan=true`](https://stripe.com/docs/api#create_subscription-trial_from_plan).", "nullable": true, "type": "integer" }, "usage_type": { "description": "Configures how the quantity per period should be determined. Can be either `metered` or `licensed`. `licensed` automatically bills the `quantity` set when adding it to a subscription. `metered` aggregates the total usage based on usage records. Defaults to `licensed`.", "enum": [ "licensed", "metered" ], "type": "string" } }, "required": [ "active", "amount", "amount_decimal", "billing_scheme", "created", "currency", "id", "interval", "interval_count", "livemode", "metadata", "meter", "nickname", "object", "product", "tiers_mode", "transform_usage", "trial_period_days", "usage_type" ], "title": "Plan", "type": "object", "x-expandableFields": [ "product", "tiers", "transform_usage" ], "x-resourceId": "plan", "x-stripeMostCommon": [ "active", "amount", "currency", "id", "interval", "metadata", "nickname", "product" ], "x-stripeOperations": [ { "method_name": "delete", "method_on": "service", "method_type": "delete", "operation": "delete", "path": "/v1/plans/{plan}" }, { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/plans" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/plans/{plan}" }, { "method_name": "create", "method_on": "service", "method_type": "create", "operation": "post", "path": "/v1/plans" }, { "method_name": "update", "method_on": "service", "method_type": "update", "operation": "post", "path": "/v1/plans/{plan}" } ], "x-stripeResource": { "class_name": "Plan", "has_collection_class": true, "in_package": "" } }, "plan.created": { "description": "Occurs whenever a plan is created.", "properties": { "object": { "$ref": "#/components/schemas/plan" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "plan.created" } }, "plan.deleted": { "description": "Occurs whenever a plan is deleted.", "properties": { "object": { "$ref": "#/components/schemas/plan" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "plan.deleted" } }, "plan.updated": { "description": "Occurs whenever a plan is updated.", "properties": { "object": { "$ref": "#/components/schemas/plan" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "plan.updated" } }, "plan_tier": { "description": "", "properties": { "flat_amount": { "description": "Price for the entire tier.", "nullable": true, "type": "integer" }, "flat_amount_decimal": { "description": "Same as `flat_amount`, but contains a decimal value with at most 12 decimal places.", "format": "decimal", "nullable": true, "type": "string" }, "unit_amount": { "description": "Per unit price for units relevant to the tier.", "nullable": true, "type": "integer" }, "unit_amount_decimal": { "description": "Same as `unit_amount`, but contains a decimal value with at most 12 decimal places.", "format": "decimal", "nullable": true, "type": "string" }, "up_to": { "description": "Up to and including to this quantity will be contained in the tier.", "nullable": true, "type": "integer" } }, "required": [ "flat_amount", "flat_amount_decimal", "unit_amount", "unit_amount_decimal", "up_to" ], "title": "PlanTier", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "flat_amount", "flat_amount_decimal", "unit_amount", "unit_amount_decimal", "up_to" ] }, "platform_earning_fee_source": { "description": "", "properties": { "charge": { "description": "Charge ID that created this application fee.", "maxLength": 5000, "type": "string" }, "payout": { "description": "Payout ID that created this application fee.", "maxLength": 5000, "type": "string" }, "type": { "description": "Type of object that created the application fee.", "enum": [ "charge", "payout" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "PlatformEarningFeeSource", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "charge", "payout", "type" ] }, "portal_business_profile": { "description": "", "properties": { "headline": { "description": "The messaging shown to customers in the portal.", "maxLength": 5000, "nullable": true, "type": "string" }, "privacy_policy_url": { "description": "A link to the business’s publicly available privacy policy.", "maxLength": 5000, "nullable": true, "type": "string" }, "terms_of_service_url": { "description": "A link to the business’s publicly available terms of service.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "headline", "privacy_policy_url", "terms_of_service_url" ], "title": "PortalBusinessProfile", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "headline", "privacy_policy_url", "terms_of_service_url" ] }, "portal_customer_update": { "description": "", "properties": { "allowed_updates": { "description": "The types of customer updates that are supported. When empty, customers are not updateable.", "items": { "enum": [ "address", "email", "name", "phone", "shipping", "tax_id" ], "type": "string" }, "type": "array" }, "enabled": { "description": "Whether the feature is enabled.", "type": "boolean" } }, "required": [ "allowed_updates", "enabled" ], "title": "PortalCustomerUpdate", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "allowed_updates", "enabled" ] }, "portal_features": { "description": "", "properties": { "customer_update": { "$ref": "#/components/schemas/portal_customer_update" }, "invoice_history": { "$ref": "#/components/schemas/portal_invoice_list" }, "payment_method_update": { "$ref": "#/components/schemas/portal_payment_method_update" }, "subscription_cancel": { "$ref": "#/components/schemas/portal_subscription_cancel" }, "subscription_update": { "$ref": "#/components/schemas/portal_subscription_update" } }, "required": [ "customer_update", "invoice_history", "payment_method_update", "subscription_cancel", "subscription_update" ], "title": "PortalFeatures", "type": "object", "x-expandableFields": [ "customer_update", "invoice_history", "payment_method_update", "subscription_cancel", "subscription_update" ], "x-stripeMostCommon": [ "customer_update", "invoice_history", "payment_method_update", "subscription_cancel", "subscription_update" ] }, "portal_flows_after_completion_hosted_confirmation": { "description": "", "properties": { "custom_message": { "description": "A custom message to display to the customer after the flow is completed.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "custom_message" ], "title": "PortalFlowsAfterCompletionHostedConfirmation", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "custom_message" ] }, "portal_flows_after_completion_redirect": { "description": "", "properties": { "return_url": { "description": "The URL the customer will be redirected to after the flow is completed.", "maxLength": 5000, "type": "string" } }, "required": [ "return_url" ], "title": "PortalFlowsAfterCompletionRedirect", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "return_url" ] }, "portal_flows_coupon_offer": { "description": "", "properties": { "coupon": { "description": "The ID of the coupon to be offered.", "maxLength": 5000, "type": "string" } }, "required": [ "coupon" ], "title": "PortalFlowsCouponOffer", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "coupon" ] }, "portal_flows_flow": { "description": "", "properties": { "after_completion": { "$ref": "#/components/schemas/portal_flows_flow_after_completion" }, "subscription_cancel": { "anyOf": [ { "$ref": "#/components/schemas/portal_flows_flow_subscription_cancel" } ], "description": "Configuration when `flow.type=subscription_cancel`.", "nullable": true }, "subscription_update": { "anyOf": [ { "$ref": "#/components/schemas/portal_flows_flow_subscription_update" } ], "description": "Configuration when `flow.type=subscription_update`.", "nullable": true }, "subscription_update_confirm": { "anyOf": [ { "$ref": "#/components/schemas/portal_flows_flow_subscription_update_confirm" } ], "description": "Configuration when `flow.type=subscription_update_confirm`.", "nullable": true }, "type": { "description": "Type of flow that the customer will go through.", "enum": [ "payment_method_update", "subscription_cancel", "subscription_update", "subscription_update_confirm" ], "type": "string" } }, "required": [ "after_completion", "subscription_cancel", "subscription_update", "subscription_update_confirm", "type" ], "title": "PortalFlowsFlow", "type": "object", "x-expandableFields": [ "after_completion", "subscription_cancel", "subscription_update", "subscription_update_confirm" ], "x-stripeMostCommon": [ "after_completion", "subscription_cancel", "subscription_update", "subscription_update_confirm", "type" ] }, "portal_flows_flow_after_completion": { "description": "", "properties": { "hosted_confirmation": { "anyOf": [ { "$ref": "#/components/schemas/portal_flows_after_completion_hosted_confirmation" } ], "description": "Configuration when `after_completion.type=hosted_confirmation`.", "nullable": true }, "redirect": { "anyOf": [ { "$ref": "#/components/schemas/portal_flows_after_completion_redirect" } ], "description": "Configuration when `after_completion.type=redirect`.", "nullable": true }, "type": { "description": "The specified type of behavior after the flow is completed.", "enum": [ "hosted_confirmation", "portal_homepage", "redirect" ], "type": "string" } }, "required": [ "hosted_confirmation", "redirect", "type" ], "title": "PortalFlowsFlowAfterCompletion", "type": "object", "x-expandableFields": [ "hosted_confirmation", "redirect" ], "x-stripeMostCommon": [ "hosted_confirmation", "redirect", "type" ] }, "portal_flows_flow_subscription_cancel": { "description": "", "properties": { "retention": { "anyOf": [ { "$ref": "#/components/schemas/portal_flows_retention" } ], "description": "Specify a retention strategy to be used in the cancellation flow.", "nullable": true }, "subscription": { "description": "The ID of the subscription to be canceled.", "maxLength": 5000, "type": "string" } }, "required": [ "retention", "subscription" ], "title": "PortalFlowsFlowSubscriptionCancel", "type": "object", "x-expandableFields": [ "retention" ], "x-stripeMostCommon": [ "retention", "subscription" ] }, "portal_flows_flow_subscription_update": { "description": "", "properties": { "subscription": { "description": "The ID of the subscription to be updated.", "maxLength": 5000, "type": "string" } }, "required": [ "subscription" ], "title": "PortalFlowsFlowSubscriptionUpdate", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "subscription" ] }, "portal_flows_flow_subscription_update_confirm": { "description": "", "properties": { "discounts": { "description": "The coupon or promotion code to apply to this subscription update.", "items": { "$ref": "#/components/schemas/portal_flows_subscription_update_confirm_discount" }, "nullable": true, "type": "array" }, "items": { "description": "The [subscription item](https://stripe.com/docs/api/subscription_items) to be updated through this flow. Currently, only up to one may be specified and subscriptions with multiple items are not updatable.", "items": { "$ref": "#/components/schemas/portal_flows_subscription_update_confirm_item" }, "type": "array" }, "subscription": { "description": "The ID of the subscription to be updated.", "maxLength": 5000, "type": "string" } }, "required": [ "discounts", "items", "subscription" ], "title": "PortalFlowsFlowSubscriptionUpdateConfirm", "type": "object", "x-expandableFields": [ "discounts", "items" ], "x-stripeMostCommon": [ "discounts", "items", "subscription" ] }, "portal_flows_retention": { "description": "", "properties": { "coupon_offer": { "anyOf": [ { "$ref": "#/components/schemas/portal_flows_coupon_offer" } ], "description": "Configuration when `retention.type=coupon_offer`.", "nullable": true }, "type": { "description": "Type of retention strategy that will be used.", "enum": [ "coupon_offer" ], "type": "string" } }, "required": [ "coupon_offer", "type" ], "title": "PortalFlowsRetention", "type": "object", "x-expandableFields": [ "coupon_offer" ], "x-stripeMostCommon": [ "coupon_offer", "type" ] }, "portal_flows_subscription_update_confirm_discount": { "description": "", "properties": { "coupon": { "description": "The ID of the coupon to apply to this subscription update.", "maxLength": 5000, "nullable": true, "type": "string" }, "promotion_code": { "description": "The ID of a promotion code to apply to this subscription update.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "coupon", "promotion_code" ], "title": "PortalFlowsSubscriptionUpdateConfirmDiscount", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "coupon", "promotion_code" ] }, "portal_flows_subscription_update_confirm_item": { "description": "", "properties": { "id": { "description": "The ID of the [subscription item](https://stripe.com/docs/api/subscriptions/object#subscription_object-items-data-id) to be updated.", "maxLength": 5000, "nullable": true, "type": "string" }, "price": { "description": "The price the customer should subscribe to through this flow. The price must also be included in the configuration's [`features.subscription_update.products`](https://stripe.com/docs/api/customer_portal/configuration#portal_configuration_object-features-subscription_update-products).", "maxLength": 5000, "nullable": true, "type": "string" }, "quantity": { "description": "[Quantity](https://stripe.com/docs/subscriptions/quantities) for this item that the customer should subscribe to through this flow.", "type": "integer" } }, "required": [ "id", "price" ], "title": "PortalFlowsSubscriptionUpdateConfirmItem", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "id", "price", "quantity" ] }, "portal_invoice_list": { "description": "", "properties": { "enabled": { "description": "Whether the feature is enabled.", "type": "boolean" } }, "required": [ "enabled" ], "title": "PortalInvoiceList", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "enabled" ] }, "portal_login_page": { "description": "", "properties": { "enabled": { "description": "If `true`, a shareable `url` will be generated that will take your customers to a hosted login page for the customer portal.\n\nIf `false`, the previously generated `url`, if any, will be deactivated.", "type": "boolean" }, "url": { "description": "A shareable URL to the hosted portal login page. Your customers will be able to log in with their [email](https://stripe.com/docs/api/customers/object#customer_object-email) and receive a link to their customer portal.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "enabled", "url" ], "title": "PortalLoginPage", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "enabled", "url" ] }, "portal_payment_method_update": { "description": "", "properties": { "enabled": { "description": "Whether the feature is enabled.", "type": "boolean" } }, "required": [ "enabled" ], "title": "PortalPaymentMethodUpdate", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "enabled" ] }, "portal_resource_schedule_update_at_period_end": { "description": "", "properties": { "conditions": { "description": "List of conditions. When any condition is true, an update will be scheduled at the end of the current period.", "items": { "$ref": "#/components/schemas/portal_resource_schedule_update_at_period_end_condition" }, "type": "array" } }, "required": [ "conditions" ], "title": "PortalResourceScheduleUpdateAtPeriodEnd", "type": "object", "x-expandableFields": [ "conditions" ], "x-stripeMostCommon": [ "conditions" ] }, "portal_resource_schedule_update_at_period_end_condition": { "description": "", "properties": { "type": { "description": "The type of condition.", "enum": [ "decreasing_item_amount", "shortening_interval" ], "type": "string" } }, "required": [ "type" ], "title": "PortalResourceScheduleUpdateAtPeriodEndCondition", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "type" ] }, "portal_subscription_cancel": { "description": "", "properties": { "cancellation_reason": { "$ref": "#/components/schemas/portal_subscription_cancellation_reason" }, "enabled": { "description": "Whether the feature is enabled.", "type": "boolean" }, "mode": { "description": "Whether to cancel subscriptions immediately or at the end of the billing period.", "enum": [ "at_period_end", "immediately" ], "type": "string" }, "proration_behavior": { "description": "Whether to create prorations when canceling subscriptions. Possible values are `none` and `create_prorations`.", "enum": [ "always_invoice", "create_prorations", "none" ], "type": "string" } }, "required": [ "cancellation_reason", "enabled", "mode", "proration_behavior" ], "title": "PortalSubscriptionCancel", "type": "object", "x-expandableFields": [ "cancellation_reason" ], "x-stripeMostCommon": [ "cancellation_reason", "enabled", "mode", "proration_behavior" ] }, "portal_subscription_cancellation_reason": { "description": "", "properties": { "enabled": { "description": "Whether the feature is enabled.", "type": "boolean" }, "options": { "description": "Which cancellation reasons will be given as options to the customer.", "items": { "enum": [ "customer_service", "low_quality", "missing_features", "other", "switched_service", "too_complex", "too_expensive", "unused" ], "type": "string" }, "type": "array" } }, "required": [ "enabled", "options" ], "title": "PortalSubscriptionCancellationReason", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "enabled", "options" ] }, "portal_subscription_update": { "description": "", "properties": { "default_allowed_updates": { "description": "The types of subscription updates that are supported for items listed in the `products` attribute. When empty, subscriptions are not updateable.", "items": { "enum": [ "price", "promotion_code", "quantity" ], "type": "string" }, "type": "array" }, "enabled": { "description": "Whether the feature is enabled.", "type": "boolean" }, "products": { "description": "The list of up to 10 products that support subscription updates.", "items": { "$ref": "#/components/schemas/portal_subscription_update_product" }, "nullable": true, "type": "array" }, "proration_behavior": { "description": "Determines how to handle prorations resulting from subscription updates. Valid values are `none`, `create_prorations`, and `always_invoice`. Defaults to a value of `none` if you don't set it during creation.", "enum": [ "always_invoice", "create_prorations", "none" ], "type": "string" }, "schedule_at_period_end": { "$ref": "#/components/schemas/portal_resource_schedule_update_at_period_end" }, "trial_update_behavior": { "description": "Determines how handle updates to trialing subscriptions. Valid values are `end_trial` and `continue_trial`. Defaults to a value of `end_trial` if you don't set it during creation.", "enum": [ "continue_trial", "end_trial" ], "type": "string" } }, "required": [ "default_allowed_updates", "enabled", "proration_behavior", "schedule_at_period_end", "trial_update_behavior" ], "title": "PortalSubscriptionUpdate", "type": "object", "x-expandableFields": [ "products", "schedule_at_period_end" ], "x-stripeMostCommon": [ "default_allowed_updates", "enabled", "products", "proration_behavior", "schedule_at_period_end", "trial_update_behavior" ] }, "portal_subscription_update_product": { "description": "", "properties": { "adjustable_quantity": { "$ref": "#/components/schemas/portal_subscription_update_product_adjustable_quantity" }, "prices": { "description": "The list of price IDs which, when subscribed to, a subscription can be updated.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "product": { "description": "The product ID.", "maxLength": 5000, "type": "string" } }, "required": [ "adjustable_quantity", "prices", "product" ], "title": "PortalSubscriptionUpdateProduct", "type": "object", "x-expandableFields": [ "adjustable_quantity" ], "x-stripeMostCommon": [ "adjustable_quantity", "prices", "product" ] }, "portal_subscription_update_product_adjustable_quantity": { "description": "", "properties": { "enabled": { "description": "If true, the quantity can be adjusted to any non-negative integer.", "type": "boolean" }, "maximum": { "description": "The maximum quantity that can be set for the product.", "nullable": true, "type": "integer" }, "minimum": { "description": "The minimum quantity that can be set for the product.", "type": "integer" } }, "required": [ "enabled", "maximum", "minimum" ], "title": "PortalSubscriptionUpdateProductAdjustableQuantity", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "enabled", "maximum", "minimum" ] }, "price": { "description": "Prices define the unit cost, currency, and (optional) billing cycle for both recurring and one-time purchases of products.\n[Products](https://stripe.com/docs/api#products) help you track inventory or provisioning, and prices help you track payment terms. Different physical goods or levels of service should be represented by products, and pricing options should be represented by prices. This approach lets you change prices without having to change your provisioning scheme.\n\nFor example, you might have a single \"gold\" product that has prices for $10/month, $100/year, and €9 once.\n\nRelated guides: [Set up a subscription](https://stripe.com/docs/billing/subscriptions/set-up-subscription), [create an invoice](https://stripe.com/docs/billing/invoices/create), and more about [products and prices](https://stripe.com/docs/products-prices/overview).", "properties": { "active": { "description": "Whether the price can be used for new purchases.", "type": "boolean" }, "billing_scheme": { "description": "Describes how to compute the price per period. Either `per_unit` or `tiered`. `per_unit` indicates that the fixed amount (specified in `unit_amount` or `unit_amount_decimal`) will be charged per unit in `quantity` (for prices with `usage_type=licensed`), or per unit of total usage (for prices with `usage_type=metered`). `tiered` indicates that the unit pricing will be computed using a tiering strategy as defined using the `tiers` and `tiers_mode` attributes.", "enum": [ "per_unit", "tiered" ], "type": "string" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "currency_options": { "additionalProperties": { "$ref": "#/components/schemas/currency_option" }, "description": "Prices defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).", "type": "object" }, "custom_unit_amount": { "anyOf": [ { "$ref": "#/components/schemas/custom_unit_amount" } ], "description": "When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.", "nullable": true }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "lookup_key": { "description": "A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.", "maxLength": 5000, "nullable": true, "type": "string" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "type": "object" }, "migrate_to": { "anyOf": [ { "$ref": "#/components/schemas/migrate_to" } ], "description": "Subscriptions using this price will be migrated to use the new referenced price.", "nullable": true }, "nickname": { "description": "A brief description of the price, hidden from customers.", "maxLength": 5000, "nullable": true, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "price" ], "type": "string" }, "product": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/product" }, { "$ref": "#/components/schemas/deleted_product" } ], "description": "The ID of the product this price is associated with.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/product" }, { "$ref": "#/components/schemas/deleted_product" } ] } }, "recurring": { "anyOf": [ { "$ref": "#/components/schemas/recurring" } ], "description": "The recurring components of a price such as `interval` and `usage_type`.", "nullable": true }, "tax_behavior": { "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.", "enum": [ "exclusive", "inclusive", "unspecified" ], "nullable": true, "type": "string" }, "tiers": { "description": "Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.", "items": { "$ref": "#/components/schemas/price_tier" }, "type": "array" }, "tiers_mode": { "description": "Defines if the tiering price should be `graduated` or `volume` based. In `volume`-based tiering, the maximum quantity within a period determines the per unit price. In `graduated` tiering, pricing can change as the quantity grows.", "enum": [ "graduated", "volume" ], "nullable": true, "type": "string" }, "transform_quantity": { "anyOf": [ { "$ref": "#/components/schemas/transform_quantity" } ], "description": "Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with `tiers`.", "nullable": true }, "type": { "description": "One of `one_time` or `recurring` depending on whether the price is for a one-time purchase or a recurring (subscription) purchase.", "enum": [ "one_time", "recurring" ], "type": "string" }, "unit_amount": { "description": "The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`.", "nullable": true, "type": "integer" }, "unit_amount_decimal": { "description": "The unit amount in cents (or local equivalent) to be charged, represented as a decimal string with at most 12 decimal places. Only set if `billing_scheme=per_unit`.", "format": "decimal", "nullable": true, "type": "string" } }, "required": [ "active", "billing_scheme", "created", "currency", "custom_unit_amount", "id", "livemode", "lookup_key", "metadata", "nickname", "object", "product", "recurring", "tax_behavior", "tiers_mode", "transform_quantity", "type", "unit_amount", "unit_amount_decimal" ], "title": "Price", "type": "object", "x-expandableFields": [ "currency_options", "custom_unit_amount", "migrate_to", "product", "recurring", "tiers", "transform_quantity" ], "x-resourceId": "price", "x-stripeMostCommon": [ "active", "currency", "id", "metadata", "nickname", "product", "recurring", "tax_behavior", "type", "unit_amount" ], "x-stripeOperations": [ { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/prices" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/prices/{price}" }, { "method_name": "search", "method_on": "service", "method_type": "custom", "operation": "get", "path": "/v1/prices/search" }, { "method_name": "create", "method_on": "service", "method_type": "create", "operation": "post", "path": "/v1/prices" }, { "method_name": "update", "method_on": "service", "method_type": "update", "operation": "post", "path": "/v1/prices/{price}" } ], "x-stripeResource": { "class_name": "Price", "has_collection_class": true, "has_search_result_class": true, "in_package": "" } }, "price.created": { "description": "Occurs whenever a price is created.", "properties": { "object": { "$ref": "#/components/schemas/price" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "price.created" } }, "price.deleted": { "description": "Occurs whenever a price is deleted.", "properties": { "object": { "$ref": "#/components/schemas/price" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "price.deleted" } }, "price.updated": { "description": "Occurs whenever a price is updated.", "properties": { "object": { "$ref": "#/components/schemas/price" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "price.updated" } }, "price_tier": { "description": "", "properties": { "flat_amount": { "description": "Price for the entire tier.", "nullable": true, "type": "integer" }, "flat_amount_decimal": { "description": "Same as `flat_amount`, but contains a decimal value with at most 12 decimal places.", "format": "decimal", "nullable": true, "type": "string" }, "unit_amount": { "description": "Per unit price for units relevant to the tier.", "nullable": true, "type": "integer" }, "unit_amount_decimal": { "description": "Same as `unit_amount`, but contains a decimal value with at most 12 decimal places.", "format": "decimal", "nullable": true, "type": "string" }, "up_to": { "description": "Up to and including to this quantity will be contained in the tier.", "nullable": true, "type": "integer" } }, "required": [ "flat_amount", "flat_amount_decimal", "unit_amount", "unit_amount_decimal", "up_to" ], "title": "PriceTier", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "flat_amount", "flat_amount_decimal", "unit_amount", "unit_amount_decimal", "up_to" ] }, "privacy.redaction_job": { "description": "The Redaction Job object redacts Stripe objects. You can use it\nto coordinate the removal of personal information from selected\nobjects, making them permanently inaccessible in the Stripe Dashboard\nand API.", "properties": { "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "privacy.redaction_job" ], "type": "string" }, "objects": { "anyOf": [ { "$ref": "#/components/schemas/redaction_resource_root_objects" } ], "description": "The objects to redact in this job.", "nullable": true }, "status": { "description": "The status of the job.", "enum": [ "canceled", "canceling", "created", "failed", "ready", "redacting", "succeeded", "validating" ], "type": "string" }, "validation_behavior": { "description": "Validation behavior determines how a job validates objects for redaction eligibility. Default is `error`.", "enum": [ "error", "fix" ], "nullable": true, "type": "string" } }, "required": [ "created", "id", "livemode", "object", "status", "validation_behavior" ], "title": "RedactionResourceRedactionJob", "type": "object", "x-expandableFields": [ "objects" ], "x-resourceId": "privacy.redaction_job", "x-stripeMostCommon": [ "created", "id", "livemode", "object", "objects", "status", "validation_behavior" ], "x-stripeOperations": [ { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/privacy/redaction_jobs" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/privacy/redaction_jobs/{job}" }, { "method_name": "create", "method_on": "service", "method_type": "create", "operation": "post", "path": "/v1/privacy/redaction_jobs" }, { "method_name": "update", "method_on": "service", "method_type": "update", "operation": "post", "path": "/v1/privacy/redaction_jobs/{job}" }, { "method_name": "cancel", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/privacy/redaction_jobs/{job}/cancel" }, { "method_name": "run", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/privacy/redaction_jobs/{job}/run" }, { "method_name": "validate", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/privacy/redaction_jobs/{job}/validate" } ], "x-stripeResource": { "class_name": "RedactionJob", "has_collection_class": true, "in_package": "Privacy" } }, "privacy.redaction_job.canceled": { "description": "Occurs whenever a redaction job is canceled.", "properties": { "object": { "$ref": "#/components/schemas/privacy.redaction_job" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "privacy.redaction_job.canceled" } }, "privacy.redaction_job.created": { "description": "Occurs whenever a redaction job is created.", "properties": { "object": { "$ref": "#/components/schemas/privacy.redaction_job" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "privacy.redaction_job.created" } }, "privacy.redaction_job.ready": { "description": "Occurs whenever a redaction job has been successfully validated and is ready to run.", "properties": { "object": { "$ref": "#/components/schemas/privacy.redaction_job" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "privacy.redaction_job.ready" } }, "privacy.redaction_job.succeeded": { "description": "Occurs whenever a redaction job finishes running.", "properties": { "object": { "$ref": "#/components/schemas/privacy.redaction_job" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "privacy.redaction_job.succeeded" } }, "privacy.redaction_job.validation_error": { "description": "Occurs whenever a redaction job fails validation.", "properties": { "object": { "$ref": "#/components/schemas/privacy.redaction_job" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "privacy.redaction_job.validation_error" } }, "privacy.redaction_job_validation_error": { "description": "The Redaction Job validation error object contains information about\nerrors that affect the ability to redact a specific object in a\nredaction job.", "properties": { "code": { "description": "A code indicating the reason for the error.", "enum": [ "invalid_cascading_source", "invalid_file_purpose", "invalid_state", "locked_by_other_job", "too_many_objects" ], "type": "string" }, "erroring_object": { "anyOf": [ { "$ref": "#/components/schemas/redaction_resource_erroring_object" } ], "description": "If the error is related to a specific object, this field includes the object's identifier and object type.", "nullable": true }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "message": { "description": "A human-readable message providing more details about the error.", "maxLength": 5000, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "privacy.redaction_job_validation_error" ], "type": "string" } }, "required": [ "code", "erroring_object", "id", "message", "object" ], "title": "RedactionResourceValidationError", "type": "object", "x-expandableFields": [ "erroring_object" ], "x-resourceId": "privacy.redaction_job_validation_error", "x-stripeMostCommon": [ "code", "erroring_object", "id", "message", "object" ], "x-stripeOperations": [ { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/privacy/redaction_jobs/{job}/validation_errors" } ], "x-stripeResource": { "class_name": "RedactionJobValidationError", "has_collection_class": true, "in_package": "Privacy" } }, "product": { "description": "Products describe the specific goods or services you offer to your customers.\nFor example, you might offer a Standard and Premium version of your goods or service; each version would be a separate Product.\nThey can be used in conjunction with [Prices](https://stripe.com/docs/api#prices) to configure pricing in Payment Links, Checkout, and Subscriptions.\n\nRelated guides: [Set up a subscription](https://stripe.com/docs/billing/subscriptions/set-up-subscription),\n[share a Payment Link](https://stripe.com/docs/payment-links),\n[accept payments with Checkout](https://stripe.com/docs/payments/accept-a-payment#create-product-prices-upfront),\nand more about [Products and Prices](https://stripe.com/docs/products-prices/overview)", "properties": { "active": { "description": "Whether the product is currently available for purchase.", "type": "boolean" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "default_price": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/price" } ], "description": "The ID of the [Price](https://stripe.com/docs/api/prices) object that is the default price for this product.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/price" } ] } }, "description": { "description": "The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.", "maxLength": 5000, "nullable": true, "type": "string" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "images": { "description": "A list of up to 8 URLs of images for this product, meant to be displayable to the customer.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "marketing_features": { "description": "A list of up to 15 marketing features for this product. These are displayed in [pricing tables](https://stripe.com/docs/payments/checkout/pricing-table).", "items": { "$ref": "#/components/schemas/product_marketing_feature" }, "type": "array" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "type": "object" }, "name": { "description": "The product's name, meant to be displayable to the customer.", "maxLength": 5000, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "product" ], "type": "string" }, "package_dimensions": { "anyOf": [ { "$ref": "#/components/schemas/package_dimensions" } ], "description": "The dimensions of this product for shipping purposes.", "nullable": true }, "shippable": { "description": "Whether this product is shipped (i.e., physical goods).", "nullable": true, "type": "boolean" }, "statement_descriptor": { "description": "Extra information about a product which will appear on your customer's credit card statement. In the case that multiple products are billed at once, the first statement descriptor will be used. Only used for subscription payments.", "maxLength": 5000, "nullable": true, "type": "string" }, "tax_code": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/tax_code" } ], "description": "A [tax code](https://stripe.com/docs/tax/tax-categories) ID.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/tax_code" } ] } }, "type": { "description": "The type of the product. The product is either of type `good`, which is eligible for use with Orders and SKUs, or `service`, which is eligible for use with Subscriptions and Plans.", "enum": [ "good", "service" ], "type": "string" }, "unit_label": { "description": "A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.", "maxLength": 5000, "nullable": true, "type": "string" }, "updated": { "description": "Time at which the object was last updated. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "url": { "description": "A URL of a publicly-accessible webpage for this product.", "maxLength": 2048, "nullable": true, "type": "string" } }, "required": [ "active", "created", "description", "id", "images", "livemode", "marketing_features", "metadata", "name", "object", "package_dimensions", "shippable", "tax_code", "type", "updated", "url" ], "title": "Product", "type": "object", "x-expandableFields": [ "default_price", "marketing_features", "package_dimensions", "tax_code" ], "x-resourceId": "product", "x-stripeMostCommon": [ "active", "default_price", "description", "id", "metadata", "name", "tax_code" ], "x-stripeOperations": [ { "method_name": "delete", "method_on": "service", "method_type": "delete", "operation": "delete", "path": "/v1/products/{id}" }, { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/products" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/products/{id}" }, { "method_name": "search", "method_on": "service", "method_type": "custom", "operation": "get", "path": "/v1/products/search" }, { "method_name": "create", "method_on": "service", "method_type": "create", "operation": "post", "path": "/v1/products" }, { "method_name": "update", "method_on": "service", "method_type": "update", "operation": "post", "path": "/v1/products/{id}" } ], "x-stripeResource": { "class_name": "Product", "has_collection_class": true, "has_search_result_class": true, "in_package": "" } }, "product.created": { "description": "Occurs whenever a product is created.", "properties": { "object": { "$ref": "#/components/schemas/product" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "product.created" } }, "product.deleted": { "description": "Occurs whenever a product is deleted.", "properties": { "object": { "$ref": "#/components/schemas/product" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "product.deleted" } }, "product.updated": { "description": "Occurs whenever a product is updated.", "properties": { "object": { "$ref": "#/components/schemas/product" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "product.updated" } }, "product_feature": { "description": "A product_feature represents an attachment between a feature and a product.\nWhen a product is purchased that has a feature attached, Stripe will create an entitlement to the feature for the purchasing customer.", "properties": { "entitlement_feature": { "$ref": "#/components/schemas/entitlements.feature" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "product_feature" ], "type": "string" } }, "required": [ "entitlement_feature", "id", "livemode", "object" ], "title": "ProductFeature", "type": "object", "x-expandableFields": [ "entitlement_feature" ], "x-resourceId": "product_feature", "x-stripeMostCommon": [ "entitlement_feature", "id" ], "x-stripeOperations": [ { "method_name": "delete", "method_on": "service", "method_type": "delete", "operation": "delete", "path": "/v1/products/{product}/features/{id}" }, { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/products/{product}/features" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/products/{product}/features/{id}" }, { "method_name": "create", "method_on": "service", "method_type": "create", "operation": "post", "path": "/v1/products/{product}/features" } ], "x-stripeResource": { "class_name": "ProductFeature", "has_collection_class": true, "in_package": "" } }, "product_marketing_feature": { "description": "", "properties": { "name": { "description": "The marketing feature name. Up to 80 characters long.", "maxLength": 5000, "type": "string" } }, "title": "ProductMarketingFeature", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "name" ] }, "promotion_code": { "description": "A Promotion Code represents a customer-redeemable code for a [coupon](https://stripe.com/docs/api#coupons).\nYou can create multiple codes for a single coupon.\n\nIf you enable promotion codes in your [customer portal configuration](https://stripe.com/docs/customer-management/configure-portal), then customers can redeem a code themselves when updating a subscription in the portal.\nCustomers can also view the currently active promotion codes and coupons on each of their subscriptions in the portal.", "properties": { "active": { "description": "Whether the promotion code is currently active. A promotion code is only active if the coupon is also valid.", "type": "boolean" }, "code": { "description": "The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for each customer. Valid characters are lower case letters (a-z), upper case letters (A-Z), and digits (0-9).", "maxLength": 5000, "type": "string" }, "coupon": { "$ref": "#/components/schemas/coupon" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "customer": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/customer" }, { "$ref": "#/components/schemas/deleted_customer" } ], "description": "The customer that this promotion code can be used by.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/customer" }, { "$ref": "#/components/schemas/deleted_customer" } ] } }, "customer_account": { "description": "The account that this promotion code can be used by.", "maxLength": 5000, "nullable": true, "type": "string" }, "expires_at": { "description": "Date at which the promotion code can no longer be redeemed.", "format": "unix-time", "nullable": true, "type": "integer" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "max_redemptions": { "description": "Maximum number of times this promotion code can be redeemed.", "nullable": true, "type": "integer" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "nullable": true, "type": "object" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "promotion_code" ], "type": "string" }, "restrictions": { "$ref": "#/components/schemas/promotion_codes_resource_restrictions" }, "times_redeemed": { "description": "Number of times this promotion code has been used.", "type": "integer" } }, "required": [ "active", "code", "coupon", "created", "customer", "expires_at", "id", "livemode", "max_redemptions", "metadata", "object", "restrictions", "times_redeemed" ], "title": "PromotionCode", "type": "object", "x-expandableFields": [ "coupon", "customer", "restrictions" ], "x-resourceId": "promotion_code", "x-stripeMostCommon": [ "code", "coupon", "id", "metadata" ], "x-stripeOperations": [ { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/promotion_codes" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/promotion_codes/{promotion_code}" }, { "method_name": "create", "method_on": "service", "method_type": "create", "operation": "post", "path": "/v1/promotion_codes" }, { "method_name": "update", "method_on": "service", "method_type": "update", "operation": "post", "path": "/v1/promotion_codes/{promotion_code}" } ], "x-stripeResource": { "class_name": "PromotionCode", "has_collection_class": true, "in_package": "" } }, "promotion_code.created": { "description": "Occurs whenever a promotion code is created.", "properties": { "object": { "$ref": "#/components/schemas/promotion_code" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "promotion_code.created" } }, "promotion_code.updated": { "description": "Occurs whenever a promotion code is updated.", "properties": { "object": { "$ref": "#/components/schemas/promotion_code" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "promotion_code.updated" } }, "promotion_code_currency_option": { "description": "", "properties": { "minimum_amount": { "description": "Minimum amount required to redeem this Promotion Code into a Coupon (e.g., a purchase must be $100 or more to work).", "type": "integer" } }, "required": [ "minimum_amount" ], "title": "PromotionCodeCurrencyOption", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "minimum_amount" ] }, "promotion_codes_resource_restrictions": { "description": "", "properties": { "currency_options": { "additionalProperties": { "$ref": "#/components/schemas/promotion_code_currency_option" }, "description": "Promotion code restrictions defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).", "type": "object" }, "first_time_transaction": { "description": "A Boolean indicating if the Promotion Code should only be redeemed for Customers without any successful payments or invoices", "type": "boolean" }, "minimum_amount": { "description": "Minimum amount required to redeem this Promotion Code into a Coupon (e.g., a purchase must be $100 or more to work).", "nullable": true, "type": "integer" }, "minimum_amount_currency": { "description": "Three-letter [ISO code](https://stripe.com/docs/currencies) for minimum_amount", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "first_time_transaction", "minimum_amount", "minimum_amount_currency" ], "title": "PromotionCodesResourceRestrictions", "type": "object", "x-expandableFields": [ "currency_options" ], "x-stripeMostCommon": [ "currency_options", "first_time_transaction", "minimum_amount", "minimum_amount_currency" ] }, "quote": { "description": "A Quote is a way to model prices that you'd like to provide to a customer.\nOnce accepted, it will automatically create an invoice, subscription or subscription schedule.", "properties": { "allow_backdated_lines": { "description": "Allow quote lines to have `starts_at` in the past if collection is paused between `starts_at` and now.", "nullable": true, "type": "boolean" }, "amount_subtotal": { "description": "Total before any discounts or taxes are applied.", "type": "integer" }, "amount_total": { "description": "Total after discounts and taxes are applied.", "type": "integer" }, "application": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/application" }, { "$ref": "#/components/schemas/deleted_application" } ], "description": "ID of the Connect Application that created the quote.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/application" }, { "$ref": "#/components/schemas/deleted_application" } ] } }, "application_fee_amount": { "description": "The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. Only applicable if there are no line items with recurring prices on the quote.", "nullable": true, "type": "integer" }, "application_fee_percent": { "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. Only applicable if there are line items with recurring prices on the quote.", "nullable": true, "type": "number" }, "automatic_tax": { "$ref": "#/components/schemas/quotes_resource_automatic_tax" }, "collection_method": { "description": "Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay invoices at the end of the subscription cycle or on finalization using the default payment method attached to the subscription or customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically`.", "enum": [ "charge_automatically", "send_invoice" ], "type": "string" }, "computed": { "$ref": "#/components/schemas/quotes_resource_computed" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "maxLength": 5000, "nullable": true, "type": "string" }, "customer": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/customer" }, { "$ref": "#/components/schemas/deleted_customer" } ], "description": "The customer which this quote belongs to. A customer is required before finalizing the quote. Once specified, it cannot be changed.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/customer" }, { "$ref": "#/components/schemas/deleted_customer" } ] } }, "customer_account": { "description": "The account which this quote belongs to. A customer or account is required before finalizing the quote. Once specified, it cannot be changed.", "maxLength": 5000, "nullable": true, "type": "string" }, "default_tax_rates": { "description": "The tax rates applied to this quote.", "items": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/tax_rate" } ], "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/tax_rate" } ] } }, "type": "array" }, "description": { "description": "A description that will be displayed on the quote PDF.", "maxLength": 5000, "nullable": true, "type": "string" }, "discounts": { "description": "The discounts applied to this quote.", "items": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/discount" } ], "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/discount" } ] } }, "type": "array" }, "expires_at": { "description": "The date on which the quote will be canceled if in `open` or `draft` status. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "footer": { "description": "A footer that will be displayed on the quote PDF.", "maxLength": 5000, "nullable": true, "type": "string" }, "from_quote": { "anyOf": [ { "$ref": "#/components/schemas/quotes_resource_from_quote" } ], "description": "Details of the quote that was cloned. See the [cloning documentation](https://stripe.com/docs/quotes/clone) for more details.", "nullable": true }, "header": { "description": "A header that will be displayed on the quote PDF.", "maxLength": 5000, "nullable": true, "type": "string" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "invoice": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/invoice" }, { "$ref": "#/components/schemas/deleted_invoice" } ], "description": "The invoice that was created from this quote.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/invoice" }, { "$ref": "#/components/schemas/deleted_invoice" } ] } }, "invoice_settings": { "$ref": "#/components/schemas/invoice_setting_quote_setting" }, "line_items": { "description": "A list of items the customer is being quoted for.", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/item" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "QuotesResourceListLineItems", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] }, "lines": { "description": "A list of [quote lines](https://docs.stripe.com/api/quote_lines) on the quote. These lines describe changes, in the order provided, that will be used to create new subscription schedules or update existing subscription schedules when the quote is accepted.", "items": { "maxLength": 5000, "type": "string" }, "nullable": true, "type": "array" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "type": "object" }, "number": { "description": "A unique number that identifies this particular quote. This number is assigned once the quote is [finalized](https://stripe.com/docs/quotes/overview#finalize).", "maxLength": 5000, "nullable": true, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "quote" ], "type": "string" }, "on_behalf_of": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/account" } ], "description": "The account on behalf of which to charge. See the [Connect documentation](https://support.stripe.com/questions/sending-invoices-on-behalf-of-connected-accounts) for details.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/account" } ] } }, "status": { "description": "The status of the quote.", "enum": [ "accepted", "accepting", "canceled", "draft", "open", "stale" ], "type": "string" }, "status_details": { "anyOf": [ { "$ref": "#/components/schemas/quotes_resource_status_details_status_details" } ], "description": "Details on when and why a quote has been marked as stale or canceled.", "nullable": true }, "status_transitions": { "$ref": "#/components/schemas/quotes_resource_status_transitions" }, "subscription": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/subscription" } ], "description": "The subscription that was created or updated from this quote.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/subscription" } ] } }, "subscription_data": { "$ref": "#/components/schemas/quotes_resource_subscription_data_subscription_data" }, "subscription_data_overrides": { "description": "List representing overrides for `subscription_data` configurations for specific subscription schedules.", "items": { "$ref": "#/components/schemas/quotes_resource_subscription_data_subscription_data_overrides" }, "nullable": true, "type": "array" }, "subscription_schedule": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/subscription_schedule" } ], "description": "The subscription schedule that was created or updated from this quote.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/subscription_schedule" } ] } }, "subscription_schedules": { "description": "The subscription schedules that were created or updated from this quote.", "items": { "$ref": "#/components/schemas/quotes_resource_subscription_schedule_with_applies_to" }, "nullable": true, "type": "array" }, "test_clock": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/test_helpers.test_clock" } ], "description": "ID of the test clock this quote belongs to.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/test_helpers.test_clock" } ] } }, "total_details": { "$ref": "#/components/schemas/quotes_resource_total_details" }, "transfer_data": { "anyOf": [ { "$ref": "#/components/schemas/quotes_resource_transfer_data" } ], "description": "The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the invoices.", "nullable": true } }, "required": [ "amount_subtotal", "amount_total", "application", "application_fee_amount", "application_fee_percent", "automatic_tax", "collection_method", "computed", "created", "currency", "customer", "description", "discounts", "expires_at", "footer", "from_quote", "header", "id", "invoice", "invoice_settings", "livemode", "metadata", "number", "object", "on_behalf_of", "status", "status_transitions", "subscription", "subscription_data", "subscription_schedule", "test_clock", "total_details", "transfer_data" ], "title": "Quote", "type": "object", "x-expandableFields": [ "application", "automatic_tax", "computed", "customer", "default_tax_rates", "discounts", "from_quote", "invoice", "invoice_settings", "line_items", "on_behalf_of", "status_details", "status_transitions", "subscription", "subscription_data", "subscription_data_overrides", "subscription_schedule", "subscription_schedules", "test_clock", "total_details", "transfer_data" ], "x-resourceId": "quote", "x-stripeMostCommon": [ "id", "line_items", "metadata" ], "x-stripeOperations": [ { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/quotes" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/quotes/{quote}" }, { "method_name": "list_computed_upfront_line_items", "method_on": "service", "method_type": "custom", "operation": "get", "path": "/v1/quotes/{quote}/computed_upfront_line_items" }, { "method_name": "list_line_items", "method_on": "service", "method_type": "custom", "operation": "get", "path": "/v1/quotes/{quote}/line_items" }, { "method_name": "list_lines", "method_on": "service", "method_type": "custom", "operation": "get", "path": "/v1/quotes/{quote}/lines" }, { "method_name": "create", "method_on": "service", "method_type": "create", "operation": "post", "path": "/v1/quotes" }, { "method_name": "update", "method_on": "service", "method_type": "update", "operation": "post", "path": "/v1/quotes/{quote}" }, { "method_name": "accept", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/quotes/{quote}/accept" }, { "method_name": "cancel", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/quotes/{quote}/cancel" }, { "method_name": "finalize_quote", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/quotes/{quote}/finalize" }, { "method_name": "mark_draft", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/quotes/{quote}/mark_draft" }, { "method_name": "mark_stale", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/quotes/{quote}/mark_stale" }, { "method_name": "reestimate", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/quotes/{quote}/reestimate" }, { "method_name": "pdf", "method_on": "service", "method_type": "custom", "operation": "get", "path": "/v1/quotes/{quote}/pdf" } ], "x-stripeResource": { "class_name": "Quote", "has_collection_class": true, "in_package": "" } }, "quote.accept_failed": { "description": "Occurs whenever a quote acceptance fails", "properties": { "object": { "$ref": "#/components/schemas/quote" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "quote.accept_failed" } }, "quote.accepted": { "description": "Occurs whenever a quote is accepted.", "properties": { "object": { "$ref": "#/components/schemas/quote" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "quote.accepted" } }, "quote.accepting": { "description": "Occurs whenever a quote's status changes to accepting", "properties": { "object": { "$ref": "#/components/schemas/quote" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "quote.accepting" } }, "quote.canceled": { "description": "Occurs whenever a quote is canceled.", "properties": { "object": { "$ref": "#/components/schemas/quote" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "quote.canceled" } }, "quote.created": { "description": "Occurs whenever a quote is created.", "properties": { "object": { "$ref": "#/components/schemas/quote" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "quote.created" } }, "quote.draft": { "description": "Occurs when a quote's status changes from stale to draft", "properties": { "object": { "$ref": "#/components/schemas/quote" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "quote.draft" } }, "quote.finalized": { "description": "Occurs whenever a quote is finalized.", "properties": { "object": { "$ref": "#/components/schemas/quote" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "quote.finalized" } }, "quote.reestimate_failed": { "description": "Occurs whenever a quote reestimate fails", "properties": { "object": { "$ref": "#/components/schemas/quote" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "quote.reestimate_failed" } }, "quote.reestimated": { "description": "Occurs whenever an async job to compute preview subscription schedules/upcoming invoices for the quote has completed.", "properties": { "object": { "$ref": "#/components/schemas/quote" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "quote.reestimated" } }, "quote.stale": { "description": "Occurs whenever a quote's status changes to stale", "properties": { "object": { "$ref": "#/components/schemas/quote" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "quote.stale" } }, "quote_line": { "description": "A quote line defines a set of changes, in the order provided, that will be applied upon quote acceptance.", "properties": { "actions": { "description": "A list of items the customer is being quoted for.", "items": { "$ref": "#/components/schemas/quote_line_action" }, "type": "array" }, "applies_to": { "anyOf": [ { "$ref": "#/components/schemas/quotes_resource_quote_lines_applies_to" } ], "description": "Details to identify the subscription schedule the quote line applies to.", "nullable": true }, "billing_cycle_anchor": { "description": "For point-in-time quote lines (having no `ends_at` timestamp), this attribute lets you set or remove whether the subscription's billing cycle anchor is reset at the Quote Line `starts_at` timestamp.For time-span based quote lines (having both `starts_at` and `ends_at`), the only valid value is `automatic`, which removes any previously configured billing cycle anchor resets during the window of time spanning the quote line.", "enum": [ "automatic", "line_starts_at" ], "nullable": true, "type": "string" }, "cancel_subscription_schedule": { "anyOf": [ { "$ref": "#/components/schemas/quotes_resource_quote_lines_cancel_subscription_schedule" } ], "description": "A point-in-time operation that cancels an existing subscription schedule at the line's starts_at timestamp. Currently only compatible with `quote_acceptance_date` for `starts_at`. When using cancel_subscription_schedule, the subscription schedule on the quote remains unalterable, except for modifications to the metadata, collection_method or invoice_settings.", "nullable": true }, "ends_at": { "anyOf": [ { "$ref": "#/components/schemas/quotes_resource_quote_lines_timestamp_helpers_ends_at" } ], "description": "Details to identify the end of the time range modified by the proposed change. If not supplied, the quote line is considered a point-in-time operation that only affects the exact timestamp at `starts_at`, and a restricted set of attributes is supported on the quote line.", "nullable": true }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "quote_line" ], "type": "string" }, "proration_behavior": { "description": "Changes to how Stripe handles prorations during the quote line's time span. Affects if and how prorations are created when a future phase starts.", "enum": [ "always_invoice", "create_prorations", "none" ], "nullable": true, "type": "string" }, "set_pause_collection": { "anyOf": [ { "$ref": "#/components/schemas/quotes_resource_quote_lines_set_pause_collection" } ], "description": "Details to modify the pause_collection behavior of the subscription schedule.", "nullable": true }, "set_schedule_end": { "description": "Timestamp helper to end the underlying schedule early, based on the acompanying line's start or end date.", "enum": [ "line_ends_at", "line_starts_at" ], "nullable": true, "type": "string" }, "starts_at": { "anyOf": [ { "$ref": "#/components/schemas/quotes_resource_quote_lines_timestamp_helpers_starts_at" } ], "description": "Details to identify the earliest timestamp where the proposed change should take effect.", "nullable": true }, "trial_settings": { "anyOf": [ { "$ref": "#/components/schemas/quotes_resource_quote_lines_trial_settings" } ], "description": "Settings related to subscription trials.", "nullable": true } }, "required": [ "applies_to", "billing_cycle_anchor", "cancel_subscription_schedule", "ends_at", "id", "object", "proration_behavior", "set_schedule_end", "starts_at" ], "title": "QuoteLine", "type": "object", "x-expandableFields": [ "actions", "applies_to", "cancel_subscription_schedule", "ends_at", "set_pause_collection", "starts_at", "trial_settings" ], "x-resourceId": "quote_line", "x-stripeMostCommon": [ "actions", "applies_to", "billing_cycle_anchor", "cancel_subscription_schedule", "ends_at", "id", "object", "proration_behavior", "set_pause_collection", "set_schedule_end", "starts_at", "trial_settings" ], "x-stripeResource": { "class_name": "QuoteLine", "has_collection_class": true, "in_package": "" } }, "quote_line_action": { "description": "", "properties": { "add_discount": { "anyOf": [ { "$ref": "#/components/schemas/stackable_discount_with_index_and_discount_end" } ], "description": "Details for the `add_discount` type.", "nullable": true }, "add_item": { "anyOf": [ { "$ref": "#/components/schemas/quotes_resource_quote_lines_actions_configuration_item" } ], "description": "Details for the `add_item` type.", "nullable": true }, "add_metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Details for the `add_metadata` type: specify a hash of key-value pairs.", "nullable": true, "type": "object" }, "remove_discount": { "anyOf": [ { "$ref": "#/components/schemas/discounts_resource_stackable_discount" } ], "description": "Details for the `remove_discount` type.", "nullable": true }, "remove_item": { "anyOf": [ { "$ref": "#/components/schemas/quotes_resource_quote_lines_actions_remove_item" } ], "description": "Details for the `remove_item` type.", "nullable": true }, "remove_metadata": { "description": "Details for the `remove_metadata` type: specify an array of metadata keys.", "items": { "maxLength": 5000, "type": "string" }, "nullable": true, "type": "array" }, "set_discounts": { "description": "Details for the `set_discounts` type.", "items": { "$ref": "#/components/schemas/discounts_resource_stackable_discount" }, "nullable": true, "type": "array" }, "set_items": { "description": "Details for the `set_items` type.", "items": { "$ref": "#/components/schemas/quotes_resource_quote_lines_actions_configuration_item" }, "nullable": true, "type": "array" }, "set_metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Details for the `set_metadata` type: specify an array of key-value pairs.", "nullable": true, "type": "object" }, "type": { "description": "The type of action the quote line performs.", "enum": [ "add_discount", "add_item", "add_metadata", "clear_discounts", "clear_metadata", "remove_discount", "remove_item", "remove_metadata", "set_discounts", "set_items", "set_metadata" ], "type": "string" } }, "required": [ "add_discount", "add_item", "add_metadata", "remove_discount", "remove_item", "remove_metadata", "set_discounts", "set_items", "set_metadata", "type" ], "title": "QuoteLineAction", "type": "object", "x-expandableFields": [ "add_discount", "add_item", "remove_discount", "remove_item", "set_discounts", "set_items" ], "x-stripeMostCommon": [ "add_discount", "add_item", "add_metadata", "remove_discount", "remove_item", "remove_metadata", "set_discounts", "set_items", "set_metadata", "type" ] }, "quote_line_discount_end": { "description": "", "properties": { "type": { "description": "The discount end type.", "enum": [ "line_ends_at" ], "type": "string" } }, "required": [ "type" ], "title": "QuoteLineDiscountEnd", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "type" ] }, "quote_preview_invoice": { "description": "Invoices are statements of amounts owed by a customer, and are either\ngenerated one-off, or generated periodically from a subscription.\n\nThey contain [invoice items](https://stripe.com/docs/api#invoiceitems), and proration adjustments\nthat may be caused by subscription upgrades/downgrades (if necessary).\n\nIf your invoice is configured to be billed through automatic charges,\nStripe automatically finalizes your invoice and attempts payment. Note\nthat finalizing the invoice,\n[when automatic](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection), does\nnot happen immediately as the invoice is created. Stripe waits\nuntil one hour after the last webhook was successfully sent (or the last\nwebhook timed out after failing). If you (and the platforms you may have\nconnected to) have no webhooks configured, Stripe waits one hour after\ncreation to finalize the invoice.\n\nIf your invoice is configured to be billed by sending an email, then based on your\n[email settings](https://dashboard.stripe.com/account/billing/automatic),\nStripe will email the invoice to your customer and await payment. These\nemails can contain a link to a hosted page to pay the invoice.\n\nStripe applies any customer credit on the account before determining the\namount due for the invoice (i.e., the amount that will be actually\ncharged). If the amount due for the invoice is less than Stripe's [minimum allowed charge\nper currency](/docs/currencies#minimum-and-maximum-charge-amounts), the\ninvoice is automatically marked paid, and we add the amount due to the\ncustomer's credit balance which is applied to the next invoice.\n\nMore details on the customer's credit balance are\n[here](https://stripe.com/docs/billing/customer/balance).\n\nRelated guide: [Send invoices to customers](https://stripe.com/docs/billing/invoices/sending)", "properties": { "account_country": { "description": "The country of the business associated with this invoice, most often the business creating the invoice.", "maxLength": 5000, "nullable": true, "type": "string" }, "account_name": { "description": "The public name of the business associated with this invoice, most often the business creating the invoice.", "maxLength": 5000, "nullable": true, "type": "string" }, "account_tax_ids": { "description": "The account tax IDs associated with the invoice. Only editable when the invoice is a draft.", "items": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/tax_id" }, { "$ref": "#/components/schemas/deleted_tax_id" } ], "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/tax_id" }, { "$ref": "#/components/schemas/deleted_tax_id" } ] } }, "nullable": true, "type": "array" }, "amount_due": { "description": "Final amount due at this time for this invoice. If the invoice's total is smaller than the minimum charge amount, for example, or if there is account credit that can be applied to the invoice, the `amount_due` may be 0. If there is a positive `starting_balance` for the invoice (the customer owes money), the `amount_due` will also take that into account. The charge that gets generated for the invoice will be for the amount specified in `amount_due`.", "type": "integer" }, "amount_overpaid": { "description": "Amount that was overpaid on the invoice. The amount overpaid is credited to the customer's credit balance.", "type": "integer" }, "amount_paid": { "description": "The amount, in cents (or local equivalent), that was paid.", "type": "integer" }, "amount_remaining": { "description": "The difference between amount_due and amount_paid, in cents (or local equivalent).", "type": "integer" }, "amount_shipping": { "description": "This is the sum of all the shipping amounts.", "type": "integer" }, "amounts_due": { "description": "List of expected payments and corresponding due dates. This value will be null for invoices where collection_method=charge_automatically.", "items": { "$ref": "#/components/schemas/payment_plan_amount" }, "nullable": true, "type": "array" }, "application": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/application" }, { "$ref": "#/components/schemas/deleted_application" } ], "description": "ID of the Connect Application that created the invoice.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/application" }, { "$ref": "#/components/schemas/deleted_application" } ] } }, "applies_to": { "$ref": "#/components/schemas/quotes_resource_quote_lines_applies_to" }, "attempt_count": { "description": "Number of payment attempts made for this invoice, from the perspective of the payment retry schedule. Any payment attempt counts as the first attempt, and subsequently only automatic retries increment the attempt count. In other words, manual payment attempts after the first attempt do not affect the retry schedule. If a failure is returned with a non-retryable return code, the invoice can no longer be retried unless a new payment method is obtained. Retries will continue to be scheduled, and attempt_count will continue to increment, but retries will only be executed if a new payment method is obtained.", "type": "integer" }, "attempted": { "description": "Whether an attempt has been made to pay the invoice. An invoice is not attempted until 1 hour after the `invoice.created` webhook, for example, so you might not want to display that invoice as unpaid to your users.", "type": "boolean" }, "automatic_tax": { "$ref": "#/components/schemas/automatic_tax" }, "automatically_finalizes_at": { "description": "The time when this invoice is currently scheduled to be automatically finalized. The field will be `null` if the invoice is not scheduled to finalize in the future. If the invoice is not in the draft state, this field will always be `null` - see `finalized_at` for the time when an already-finalized invoice was finalized.", "format": "unix-time", "nullable": true, "type": "integer" }, "billing_reason": { "description": "Indicates the reason why the invoice was created.\n\n* `manual`: Unrelated to a subscription, for example, created via the invoice editor.\n* `subscription`: No longer in use. Applies to subscriptions from before May 2018 where no distinction was made between updates, cycles, and thresholds.\n* `subscription_create`: A new subscription was created.\n* `subscription_cycle`: A subscription advanced into a new period.\n* `subscription_threshold`: A subscription reached a billing threshold.\n* `subscription_update`: A subscription was updated.\n* `upcoming`: Reserved for simulated invoices, per the upcoming invoice endpoint.", "enum": [ "automatic_pending_invoice_item_invoice", "manual", "quote_accept", "subscription", "subscription_create", "subscription_cycle", "subscription_threshold", "subscription_update", "upcoming" ], "nullable": true, "type": "string" }, "collection_method": { "description": "Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this invoice using the default source attached to the customer. When sending an invoice, Stripe will email this invoice to the customer with payment instructions.", "enum": [ "charge_automatically", "send_invoice" ], "type": "string" }, "confirmation_secret": { "anyOf": [ { "$ref": "#/components/schemas/invoices_resource_confirmation_secret" } ], "description": "The confirmation secret associated with this invoice. Currently, this contains the client_secret of the PaymentIntent that Stripe creates during invoice finalization.", "nullable": true }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "custom_fields": { "description": "Custom fields displayed on the invoice.", "items": { "$ref": "#/components/schemas/invoice_setting_custom_field" }, "nullable": true, "type": "array" }, "customer_account": { "description": "The ID of the account who will be billed.", "maxLength": 5000, "nullable": true, "type": "string" }, "customer_address": { "anyOf": [ { "$ref": "#/components/schemas/address" } ], "description": "The customer's address. Until the invoice is finalized, this field will equal `customer.address`. Once the invoice is finalized, this field will no longer be updated.", "nullable": true }, "customer_email": { "description": "The customer's email. Until the invoice is finalized, this field will equal `customer.email`. Once the invoice is finalized, this field will no longer be updated.", "maxLength": 5000, "nullable": true, "type": "string" }, "customer_name": { "description": "The customer's name. Until the invoice is finalized, this field will equal `customer.name`. Once the invoice is finalized, this field will no longer be updated.", "maxLength": 5000, "nullable": true, "type": "string" }, "customer_phone": { "description": "The customer's phone number. Until the invoice is finalized, this field will equal `customer.phone`. Once the invoice is finalized, this field will no longer be updated.", "maxLength": 5000, "nullable": true, "type": "string" }, "customer_shipping": { "anyOf": [ { "$ref": "#/components/schemas/shipping" } ], "description": "The customer's shipping information. Until the invoice is finalized, this field will equal `customer.shipping`. Once the invoice is finalized, this field will no longer be updated.", "nullable": true }, "customer_tax_exempt": { "description": "The customer's tax exempt status. Until the invoice is finalized, this field will equal `customer.tax_exempt`. Once the invoice is finalized, this field will no longer be updated.", "enum": [ "exempt", "none", "reverse" ], "nullable": true, "type": "string" }, "customer_tax_ids": { "description": "The customer's tax IDs. Until the invoice is finalized, this field will contain the same tax IDs as `customer.tax_ids`. Once the invoice is finalized, this field will no longer be updated.", "items": { "$ref": "#/components/schemas/invoices_resource_invoice_tax_id" }, "nullable": true, "type": "array" }, "default_margins": { "description": "The margins applied to the invoice. Can be overridden by line item `margins`. Use `expand[]=default_margins` to expand each margin.", "items": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/margin" } ], "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/margin" } ] } }, "nullable": true, "type": "array" }, "default_payment_method": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/payment_method" } ], "description": "ID of the default payment method for the invoice. It must belong to the customer associated with the invoice. If not set, defaults to the subscription's default payment method, if any, or to the default payment method in the customer's invoice settings.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/payment_method" } ] } }, "default_source": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/payment_source" } ], "description": "ID of the default payment source for the invoice. It must belong to the customer associated with the invoice and be in a chargeable state. If not set, defaults to the subscription's default source, if any, or to the customer's default source.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/payment_source" } ] } }, "default_tax_rates": { "description": "The tax rates applied to this invoice, if any.", "items": { "$ref": "#/components/schemas/tax_rate" }, "type": "array" }, "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard.", "maxLength": 5000, "nullable": true, "type": "string" }, "discounts": { "description": "The discounts applied to the invoice. Line item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount.", "items": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/discount" }, { "$ref": "#/components/schemas/deleted_discount" } ], "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/discount" }, { "$ref": "#/components/schemas/deleted_discount" } ] } }, "type": "array" }, "due_date": { "description": "The date on which payment for this invoice is due. This value will be `null` for invoices where `collection_method=charge_automatically`.", "format": "unix-time", "nullable": true, "type": "integer" }, "effective_at": { "description": "The date when this invoice is in effect. Same as `finalized_at` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the invoice PDF and receipt.", "format": "unix-time", "nullable": true, "type": "integer" }, "ending_balance": { "description": "Ending customer balance after the invoice is finalized. Invoices are finalized approximately an hour after successful webhook delivery or when payment collection is attempted for the invoice. If the invoice has not been finalized yet, this will be null.", "nullable": true, "type": "integer" }, "footer": { "description": "Footer displayed on the invoice.", "maxLength": 5000, "nullable": true, "type": "string" }, "from_invoice": { "anyOf": [ { "$ref": "#/components/schemas/invoices_resource_from_invoice" } ], "description": "Details of the invoice that was cloned. See the [revision documentation](https://stripe.com/docs/invoicing/invoice-revisions) for more details.", "nullable": true }, "id": { "description": "Unique identifier for the object. For preview invoices created using the [create preview](https://stripe.com/docs/api/invoices/create_preview) endpoint, this id will be prefixed with `upcoming_in`.", "maxLength": 5000, "type": "string" }, "issuer": { "$ref": "#/components/schemas/connect_account_reference" }, "last_finalization_error": { "anyOf": [ { "$ref": "#/components/schemas/api_errors" } ], "description": "The error encountered during the previous attempt to finalize the invoice. This field is cleared when the invoice is successfully finalized.", "nullable": true }, "latest_revision": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/invoice" } ], "description": "The ID of the most recent non-draft revision of this invoice", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/invoice" } ] } }, "lines": { "description": "The individual line items that make up the invoice. `lines` is sorted as follows: (1) pending invoice items (including prorations) in reverse chronological order, (2) subscription items in reverse chronological order, and (3) invoice items added after invoice creation in chronological order.", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/line_item" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "InvoiceLinesList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "nullable": true, "type": "object" }, "next_payment_attempt": { "description": "The time at which payment will next be attempted. This value will be `null` for invoices where `collection_method=send_invoice`.", "format": "unix-time", "nullable": true, "type": "integer" }, "number": { "description": "A unique, identifying string that appears on emails sent to the customer for this invoice. This starts with the customer's unique invoice_prefix if it is specified.", "maxLength": 5000, "nullable": true, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "quote_preview_invoice" ], "type": "string" }, "on_behalf_of": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/account" } ], "description": "The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://stripe.com/docs/billing/invoices/connect) documentation for details.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/account" } ] } }, "parent": { "anyOf": [ { "$ref": "#/components/schemas/billing_bill_resource_invoicing_parents_invoice_parent" } ], "description": "The parent that generated this invoice", "nullable": true }, "payment_settings": { "$ref": "#/components/schemas/invoices_payment_settings" }, "payments": { "description": "Payments for this invoice", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/invoice_payment" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "InvoicesPaymentsListInvoicePayments", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] }, "period_end": { "description": "End of the usage period during which invoice items were added to this invoice. This looks back one period for a subscription invoice. Use the [line item period](/api/invoices/line_item#invoice_line_item_object-period) to get the service period for each price.", "format": "unix-time", "type": "integer" }, "period_start": { "description": "Start of the usage period during which invoice items were added to this invoice. This looks back one period for a subscription invoice. Use the [line item period](/api/invoices/line_item#invoice_line_item_object-period) to get the service period for each price.", "format": "unix-time", "type": "integer" }, "post_payment_credit_notes_amount": { "description": "Total amount of all post-payment credit notes issued for this invoice.", "type": "integer" }, "pre_payment_credit_notes_amount": { "description": "Total amount of all pre-payment credit notes issued for this invoice.", "type": "integer" }, "receipt_number": { "description": "This is the transaction number that appears on email receipts sent for this invoice.", "maxLength": 5000, "nullable": true, "type": "string" }, "rendering": { "anyOf": [ { "$ref": "#/components/schemas/invoices_resource_invoice_rendering" } ], "description": "The rendering-related settings that control how the invoice is displayed on customer-facing surfaces such as PDF and Hosted Invoice Page.", "nullable": true }, "shipping_cost": { "anyOf": [ { "$ref": "#/components/schemas/invoices_resource_shipping_cost" } ], "description": "The details of the cost of shipping, including the ShippingRate applied on the invoice.", "nullable": true }, "shipping_details": { "anyOf": [ { "$ref": "#/components/schemas/shipping" } ], "description": "Shipping details for the invoice. The Invoice PDF will use the `shipping_details` value if it is set, otherwise the PDF will render the shipping address from the customer.", "nullable": true }, "starting_balance": { "description": "Starting customer balance before the invoice is finalized. If the invoice has not been finalized yet, this will be the current customer balance. For revision invoices, this also includes any customer balance that was applied to the original invoice.", "type": "integer" }, "statement_descriptor": { "description": "Extra information about an invoice for the customer's credit card statement.", "maxLength": 5000, "nullable": true, "type": "string" }, "status": { "description": "The status of the invoice, one of `draft`, `open`, `paid`, `uncollectible`, or `void`. [Learn more](https://stripe.com/docs/billing/invoices/workflow#workflow-overview)", "enum": [ "draft", "open", "paid", "uncollectible", "void" ], "nullable": true, "type": "string", "x-stripeBypassValidation": true }, "status_transitions": { "$ref": "#/components/schemas/invoices_resource_status_transitions" }, "subscription": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/subscription" } ], "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/subscription" } ] } }, "subtotal": { "description": "Total of all subscriptions, invoice items, and prorations on the invoice before any invoice level discount or exclusive tax is applied. Item discounts are already incorporated", "type": "integer" }, "subtotal_excluding_tax": { "description": "The integer amount in cents (or local equivalent) representing the subtotal of the invoice before any invoice level discount or tax is applied. Item discounts are already incorporated", "nullable": true, "type": "integer" }, "test_clock": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/test_helpers.test_clock" } ], "description": "ID of the test clock this invoice belongs to.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/test_helpers.test_clock" } ] } }, "threshold_reason": { "$ref": "#/components/schemas/invoice_threshold_reason" }, "total": { "description": "Total after discounts and taxes.", "type": "integer" }, "total_discount_amounts": { "description": "The aggregate amounts calculated per discount across all line items.", "items": { "$ref": "#/components/schemas/discounts_resource_discount_amount" }, "nullable": true, "type": "array" }, "total_excluding_tax": { "description": "The integer amount in cents (or local equivalent) representing the total amount of the invoice including all discounts but excluding all tax.", "nullable": true, "type": "integer" }, "total_margin_amounts": { "description": "The aggregate amounts calculated per margin across all line items.", "items": { "$ref": "#/components/schemas/margins_resource_margin_amount" }, "nullable": true, "type": "array" }, "total_pretax_credit_amounts": { "description": "Contains pretax credit amounts (ex: discount, credit grants, etc) that apply to this invoice. This is a combined list of total_pretax_credit_amounts across all invoice line items.", "items": { "$ref": "#/components/schemas/invoices_resource_pretax_credit_amount" }, "nullable": true, "type": "array" }, "total_taxes": { "description": "The aggregate tax information of all line items.", "items": { "$ref": "#/components/schemas/billing_bill_resource_invoicing_taxes_tax" }, "nullable": true, "type": "array" }, "webhooks_delivered_at": { "description": "Invoices are automatically paid or sent 1 hour after webhooks are delivered, or until all webhook delivery attempts have [been exhausted](https://stripe.com/docs/billing/webhooks#understand). This field tracks the time when webhooks for this invoice were successfully delivered. If the invoice had no webhooks to deliver, this will be set while the invoice is being created.", "format": "unix-time", "nullable": true, "type": "integer" } }, "required": [ "account_country", "account_name", "account_tax_ids", "amount_due", "amount_overpaid", "amount_paid", "amount_remaining", "amount_shipping", "application", "applies_to", "attempt_count", "attempted", "automatic_tax", "automatically_finalizes_at", "billing_reason", "collection_method", "created", "currency", "custom_fields", "customer_address", "customer_email", "customer_name", "customer_phone", "customer_shipping", "customer_tax_exempt", "default_payment_method", "default_source", "default_tax_rates", "description", "discounts", "due_date", "effective_at", "ending_balance", "footer", "from_invoice", "id", "issuer", "last_finalization_error", "latest_revision", "lines", "livemode", "metadata", "next_payment_attempt", "number", "object", "on_behalf_of", "parent", "payment_settings", "period_end", "period_start", "post_payment_credit_notes_amount", "pre_payment_credit_notes_amount", "receipt_number", "rendering", "shipping_cost", "shipping_details", "starting_balance", "statement_descriptor", "status", "status_transitions", "subscription", "subtotal", "subtotal_excluding_tax", "test_clock", "total", "total_discount_amounts", "total_excluding_tax", "total_pretax_credit_amounts", "total_taxes", "webhooks_delivered_at" ], "title": "PreviewInvoice", "type": "object", "x-expandableFields": [ "account_tax_ids", "amounts_due", "application", "applies_to", "automatic_tax", "confirmation_secret", "custom_fields", "customer_address", "customer_shipping", "customer_tax_ids", "default_margins", "default_payment_method", "default_source", "default_tax_rates", "discounts", "from_invoice", "issuer", "last_finalization_error", "latest_revision", "lines", "on_behalf_of", "parent", "payment_settings", "payments", "rendering", "shipping_cost", "shipping_details", "status_transitions", "subscription", "test_clock", "threshold_reason", "total_discount_amounts", "total_margin_amounts", "total_pretax_credit_amounts", "total_taxes" ], "x-resourceId": "quote_preview_invoice", "x-stripeMostCommon": [ "applies_to", "automatic_tax", "collection_method", "confirmation_secret", "currency", "description", "id", "lines", "metadata", "parent", "period_end", "period_start", "status", "subscription", "total" ], "x-stripeOperations": [ { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/quotes/{quote}/preview_invoices" }, { "method_name": "list_lines", "method_on": "service", "method_type": "custom", "operation": "get", "path": "/v1/quotes/{quote}/preview_invoices/{preview_invoice}/lines" } ], "x-stripeResource": { "class_name": "QuotePreviewInvoice", "has_collection_class": true, "in_package": "" } }, "quote_preview_subscription_schedule": { "description": "", "properties": { "application": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/application" }, { "$ref": "#/components/schemas/deleted_application" } ], "description": "ID of the Connect Application that created the schedule.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/application" }, { "$ref": "#/components/schemas/deleted_application" } ] } }, "applies_to": { "$ref": "#/components/schemas/quotes_resource_quote_lines_applies_to" }, "billing_behavior": { "description": "Configures when the subscription schedule generates prorations for phase transitions. Possible values are `prorate_on_next_phase` or `prorate_up_front` with the default being `prorate_on_next_phase`. `prorate_on_next_phase` will apply phase changes and generate prorations at transition time. `prorate_up_front` will bill for all phases within the current billing cycle up front.", "enum": [ "prorate_on_next_phase", "prorate_up_front" ], "type": "string" }, "billing_mode": { "$ref": "#/components/schemas/subscriptions_resource_billing_mode" }, "canceled_at": { "description": "Time at which the subscription schedule was canceled. Measured in seconds since the Unix epoch.", "format": "unix-time", "nullable": true, "type": "integer" }, "completed_at": { "description": "Time at which the subscription schedule was completed. Measured in seconds since the Unix epoch.", "format": "unix-time", "nullable": true, "type": "integer" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "current_phase": { "anyOf": [ { "$ref": "#/components/schemas/subscription_schedule_current_phase" } ], "description": "Object representing the start and end dates for the current phase of the subscription schedule, if it is `active`.", "nullable": true }, "customer": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/customer" }, { "$ref": "#/components/schemas/deleted_customer" } ], "description": "ID of the customer who owns the subscription schedule.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/customer" }, { "$ref": "#/components/schemas/deleted_customer" } ] } }, "customer_account": { "description": "ID of the account who owns the subscription schedule.", "maxLength": 5000, "nullable": true, "type": "string" }, "default_settings": { "$ref": "#/components/schemas/subscription_schedules_resource_default_settings" }, "end_behavior": { "description": "Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running. `cancel` will end the subscription schedule and cancel the underlying subscription.", "enum": [ "cancel", "none", "release", "renew" ], "type": "string" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "last_price_migration_error": { "anyOf": [ { "$ref": "#/components/schemas/subscriptions_resource_price_migration_error" } ], "description": "Details of the most recent price migration that failed for the subscription schedule.", "nullable": true }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "nullable": true, "type": "object" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "quote_preview_subscription_schedule" ], "type": "string" }, "phases": { "description": "Configuration for the subscription schedule's phases.", "items": { "$ref": "#/components/schemas/subscription_schedule_phase_configuration" }, "type": "array" }, "prebilling": { "anyOf": [ { "$ref": "#/components/schemas/subscription_prebilling_data" } ], "description": "Time period and invoice for a Subscription billed in advance.", "nullable": true }, "released_at": { "description": "Time at which the subscription schedule was released. Measured in seconds since the Unix epoch.", "format": "unix-time", "nullable": true, "type": "integer" }, "released_subscription": { "description": "ID of the subscription once managed by the subscription schedule (if it is released).", "maxLength": 5000, "nullable": true, "type": "string" }, "status": { "description": "The present status of the subscription schedule. Possible values are `not_started`, `active`, `completed`, `released`, and `canceled`. You can read more about the different states in our [behavior guide](https://stripe.com/docs/billing/subscriptions/subscription-schedules).", "enum": [ "active", "canceled", "completed", "not_started", "released" ], "type": "string" }, "subscription": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/subscription" } ], "description": "ID of the subscription managed by the subscription schedule.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/subscription" } ] } }, "test_clock": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/test_helpers.test_clock" } ], "description": "ID of the test clock this subscription schedule belongs to.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/test_helpers.test_clock" } ] } } }, "required": [ "application", "applies_to", "billing_mode", "canceled_at", "completed_at", "created", "current_phase", "customer", "default_settings", "end_behavior", "id", "livemode", "metadata", "object", "phases", "released_at", "released_subscription", "status", "subscription", "test_clock" ], "title": "QuotesResourcePreviewsSchedulesSchedule", "type": "object", "x-expandableFields": [ "application", "applies_to", "billing_mode", "current_phase", "customer", "default_settings", "last_price_migration_error", "phases", "prebilling", "subscription", "test_clock" ], "x-resourceId": "quote_preview_subscription_schedule", "x-stripeMostCommon": [ "applies_to", "current_phase", "customer", "id", "metadata", "phases", "status", "subscription" ], "x-stripeOperations": [ { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/quotes/{quote}/preview_subscription_schedules" } ], "x-stripeResource": { "class_name": "QuotePreviewSubscriptionSchedule", "has_collection_class": true, "in_package": "" } }, "quotes_core_api_resource_last_reestimate_details": { "description": "", "properties": { "failed": { "anyOf": [ { "$ref": "#/components/schemas/quotes_core_api_resource_reestimate_failure" } ], "description": "When `status` is `failed`, provides details about the quote reestimation failure.", "nullable": true }, "status": { "description": "Latest status of the reestimation.", "enum": [ "failed", "in_progress", "succeeded" ], "type": "string" } }, "required": [ "failed", "status" ], "title": "QuotesCoreApiResourceLastReestimateDetails", "type": "object", "x-expandableFields": [ "failed" ], "x-stripeMostCommon": [ "failed", "status" ], "x-stripeResource": { "class_name": "LastReestimateDetails", "in_package": "" } }, "quotes_core_api_resource_reestimate_failure": { "description": "", "properties": { "failure_code": { "description": "The failure `code` is more granular than the `reason` provided and may correspond to a Stripe error code. For automation errors, this field is one of: `reverse_api_failure`, `reverse_api_deadline_exceeeded`, or `reverse_api_response_validation_error`, which are Stripe error codes and map to the error `message` field.", "maxLength": 5000, "nullable": true, "type": "string" }, "message": { "description": "Information derived from the `failure_code` or a freeform message that explains the error as a human-readable English string. For example, \"margin ID is not a valid ID\".", "maxLength": 5000, "nullable": true, "type": "string" }, "reason": { "description": "The reason the reestimation failed.", "enum": [ "automation_failure", "internal_error" ], "type": "string" } }, "required": [ "failure_code", "message", "reason" ], "title": "QuotesCoreApiResourceReestimateFailure", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "failure_code", "message", "reason" ], "x-stripeResource": { "class_name": "ReeestimateFailure", "in_package": "" } }, "quotes_resource_automatic_tax": { "description": "", "properties": { "enabled": { "description": "Automatically calculate taxes", "type": "boolean" }, "liability": { "anyOf": [ { "$ref": "#/components/schemas/connect_account_reference" } ], "description": "The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.", "nullable": true }, "provider": { "description": "The tax provider powering automatic tax.", "maxLength": 5000, "nullable": true, "type": "string" }, "status": { "description": "The status of the most recent automated tax calculation for this quote.", "enum": [ "complete", "failed", "requires_location_inputs" ], "nullable": true, "type": "string" } }, "required": [ "enabled", "liability", "provider", "status" ], "title": "QuotesResourceAutomaticTax", "type": "object", "x-expandableFields": [ "liability" ], "x-stripeMostCommon": [ "enabled", "liability", "provider", "status" ] }, "quotes_resource_computed": { "description": "", "properties": { "last_reestimation_details": { "anyOf": [ { "$ref": "#/components/schemas/quotes_core_api_resource_last_reestimate_details" } ], "description": "Details of the most recent reestimate of the quote's preview schedules and upcoming invoices, including the status of Stripe's calculation.", "nullable": true }, "recurring": { "anyOf": [ { "$ref": "#/components/schemas/quotes_resource_recurring" } ], "description": "The definitive totals and line items the customer will be charged on a recurring basis. Takes into account the line items with recurring prices and discounts with `duration=forever` coupons only. Defaults to `null` if no inputted line items with recurring prices.", "nullable": true }, "updated_at": { "description": "The time at which the quote's estimated schedules and upcoming invoices were generated.", "format": "unix-time", "nullable": true, "type": "integer" }, "upfront": { "$ref": "#/components/schemas/quotes_resource_upfront" } }, "required": [ "recurring", "upfront" ], "title": "QuotesResourceComputed", "type": "object", "x-expandableFields": [ "last_reestimation_details", "recurring", "upfront" ], "x-stripeMostCommon": [ "last_reestimation_details", "recurring", "updated_at", "upfront" ] }, "quotes_resource_from_quote": { "description": "", "properties": { "is_revision": { "description": "Whether this quote is a revision of a different quote.", "type": "boolean" }, "quote": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/quote" } ], "description": "The quote that was cloned.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/quote" } ] } } }, "required": [ "is_revision", "quote" ], "title": "QuotesResourceFromQuote", "type": "object", "x-expandableFields": [ "quote" ], "x-stripeMostCommon": [ "is_revision", "quote" ] }, "quotes_resource_prebilling": { "description": "", "properties": { "iterations": { "type": "integer" } }, "required": [ "iterations" ], "title": "QuotesResourcePrebilling", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "iterations" ] }, "quotes_resource_quote_lines_actions_configuration_item": { "description": "", "properties": { "discounts": { "description": "The discounts applied to the subscription item. Subscription item discounts are applied before subscription discounts. Use `expand[]=discounts` to expand each discount.", "items": { "$ref": "#/components/schemas/discounts_resource_stackable_discount" }, "type": "array" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an item. Metadata on this item will update the underlying subscription item's `metadata` when the phase is entered.", "nullable": true, "type": "object" }, "price": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/price" }, { "$ref": "#/components/schemas/deleted_price" } ], "description": "ID of the price to which the customer should be subscribed.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/price" }, { "$ref": "#/components/schemas/deleted_price" } ] } }, "quantity": { "description": "Quantity of the plan to which the customer should be subscribed.", "type": "integer" }, "tax_rates": { "description": "The tax rates which apply to this `phase_item`. When set, the `default_tax_rates` on the phase do not apply to this `phase_item`.", "items": { "$ref": "#/components/schemas/tax_rate" }, "nullable": true, "type": "array" }, "trial": { "anyOf": [ { "$ref": "#/components/schemas/quotes_resource_quote_lines_trial" } ], "description": "Options that configure the trial on the subscription item.", "nullable": true } }, "required": [ "discounts", "metadata", "price" ], "title": "QuotesResourceQuoteLinesActionsConfigurationItem", "type": "object", "x-expandableFields": [ "discounts", "price", "tax_rates", "trial" ], "x-stripeMostCommon": [ "discounts", "metadata", "price", "quantity", "tax_rates", "trial" ] }, "quotes_resource_quote_lines_actions_remove_item": { "description": "", "properties": { "price": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/price" }, { "$ref": "#/components/schemas/deleted_price" } ], "description": "ID of a price to remove.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/price" }, { "$ref": "#/components/schemas/deleted_price" } ] } } }, "required": [ "price" ], "title": "QuotesResourceQuoteLinesActionsRemoveItem", "type": "object", "x-expandableFields": [ "price" ], "x-stripeMostCommon": [ "price" ] }, "quotes_resource_quote_lines_applies_to": { "description": "", "properties": { "new_reference": { "description": "A custom string that identifies a new subscription schedule being created upon quote acceptance. All quote lines with the same `new_reference` field will be applied to the creation of a new subscription schedule.", "maxLength": 5000, "nullable": true, "type": "string" }, "subscription_schedule": { "description": "The ID of the schedule the line applies to.", "maxLength": 5000, "nullable": true, "type": "string" }, "type": { "description": "Describes whether the quote line is affecting a new schedule or an existing schedule.", "enum": [ "new_reference", "subscription_schedule" ], "type": "string" } }, "required": [ "new_reference", "subscription_schedule", "type" ], "title": "QuotesResourceQuoteLinesAppliesTo", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "new_reference", "subscription_schedule", "type" ] }, "quotes_resource_quote_lines_cancel_subscription_schedule": { "description": "Configures the immediate cancellation settings for a subscription schedule via quotes.", "properties": { "cancel_at": { "description": "Timestamp helper to cancel the underlying schedule on the accompanying line's start date. Must be set to `line_starts_at`.", "enum": [ "line_starts_at" ], "type": "string" }, "invoice_now": { "description": "If the subscription schedule is `active`, indicates if a final invoice will be generated that contains any un-invoiced metered usage and new/pending proration invoice items. Boolean that defaults to `true`.", "nullable": true, "type": "boolean" }, "prorate": { "description": "If the subscription schedule is `active`, indicates if the cancellation should be prorated. Boolean that defaults to `true`.", "nullable": true, "type": "boolean" } }, "required": [ "cancel_at", "invoice_now", "prorate" ], "title": "QuotesResourceQuoteLinesCancelSubscriptionSchedule", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "cancel_at", "invoice_now", "prorate" ] }, "quotes_resource_quote_lines_end_behavior": { "description": "Defines how the scheduled subscription behaves when a trial ends.", "properties": { "prorate_up_front": { "description": "Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.", "enum": [ "defer", "include" ], "nullable": true, "type": "string" } }, "required": [ "prorate_up_front" ], "title": "QuotesResourceQuoteLinesEndBehavior", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "prorate_up_front" ] }, "quotes_resource_quote_lines_set_pause_collection": { "description": "Configures the pause collection settings for a subscription during a phase.", "properties": { "set": { "anyOf": [ { "$ref": "#/components/schemas/subscription_schedules_resource_pause_collection" } ], "description": "If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://stripe.com/docs/billing/subscriptions/pause-payment).", "nullable": true }, "type": { "description": "Defines the type of the pause_collection behavior for the quote line.", "enum": [ "remove", "set" ], "type": "string" } }, "required": [ "type" ], "title": "QuotesResourceQuoteLinesSetPauseCollection", "type": "object", "x-expandableFields": [ "set" ], "x-stripeMostCommon": [ "set", "type" ] }, "quotes_resource_quote_lines_timestamp_helpers_discount_end": { "description": "", "properties": { "discount": { "description": "The ID of a specific discount.", "maxLength": 5000, "type": "string" } }, "required": [ "discount" ], "title": "QuotesResourceQuoteLinesTimestampHelpersDiscountEnd", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "discount" ] }, "quotes_resource_quote_lines_timestamp_helpers_duration": { "description": "", "properties": { "interval": { "description": "Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.", "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "description": "The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.", "type": "integer" } }, "required": [ "interval", "interval_count" ], "title": "QuotesResourceQuoteLinesTimestampHelpersDuration", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "interval", "interval_count" ] }, "quotes_resource_quote_lines_timestamp_helpers_ends_at": { "description": "", "properties": { "computed": { "description": "The timestamp value that will be used to determine when to make changes to the subscription schedule, as computed from the `ends_at` field. For example, if `ends_at[type]=upcoming_invoice`, the upcoming invoice date will be computed at the time the `ends_at` field was specified and saved. This field will not be recomputed upon future requests to update or finalize the quote unless `ends_at` is respecified. This field is guaranteed to be populated after quote acceptance.", "format": "unix-time", "nullable": true, "type": "integer" }, "discount_end": { "anyOf": [ { "$ref": "#/components/schemas/quotes_resource_quote_lines_timestamp_helpers_discount_end" } ], "description": "Use the `end` time of a given discount.", "nullable": true }, "duration": { "anyOf": [ { "$ref": "#/components/schemas/quotes_resource_quote_lines_timestamp_helpers_duration" } ], "description": "Time span for the quote line starting from the `starts_at` date.", "nullable": true }, "timestamp": { "description": "A precise Unix timestamp.", "format": "unix-time", "nullable": true, "type": "integer" }, "type": { "description": "Select a way to pass in `ends_at`.", "enum": [ "billing_period_end", "discount_end", "duration", "quote_acceptance_date", "schedule_end", "timestamp", "upcoming_invoice" ], "type": "string" } }, "required": [ "computed", "duration", "timestamp", "type" ], "title": "QuotesResourceQuoteLinesTimestampHelpersEndsAt", "type": "object", "x-expandableFields": [ "discount_end", "duration" ], "x-stripeMostCommon": [ "computed", "discount_end", "duration", "timestamp", "type" ] }, "quotes_resource_quote_lines_timestamp_helpers_line_id": { "description": "", "properties": { "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" } }, "required": [ "id" ], "title": "QuotesResourceQuoteLinesTimestampHelpersLineId", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "id" ] }, "quotes_resource_quote_lines_timestamp_helpers_starts_at": { "description": "", "properties": { "computed": { "description": "The timestamp value that will be used to determine when to make changes to the subscription schedule, as computed from the `starts_at` field. For example, if `starts_at[type]=upcoming_invoice`, the upcoming invoice date will be computed at the time the `starts_at` field was specified and saved. This field will not be recomputed upon future requests to update or finalize the quote unless `starts_at` is respecified. This field is guaranteed to be populated after quote acceptance.", "format": "unix-time", "nullable": true, "type": "integer" }, "discount_end": { "anyOf": [ { "$ref": "#/components/schemas/quotes_resource_quote_lines_timestamp_helpers_discount_end" } ], "description": "Use the `end` time of a given discount.", "nullable": true }, "line_ends_at": { "anyOf": [ { "$ref": "#/components/schemas/quotes_resource_quote_lines_timestamp_helpers_line_id" } ], "description": "The timestamp the given line ends at.", "nullable": true }, "timestamp": { "description": "A precise Unix timestamp.", "format": "unix-time", "nullable": true, "type": "integer" }, "type": { "description": "Select a way to pass in `starts_at`.", "enum": [ "discount_end", "line_ends_at", "now", "quote_acceptance_date", "schedule_end", "timestamp", "upcoming_invoice" ], "type": "string" } }, "required": [ "computed", "line_ends_at", "timestamp", "type" ], "title": "QuotesResourceQuoteLinesTimestampHelpersStartsAt", "type": "object", "x-expandableFields": [ "discount_end", "line_ends_at" ], "x-stripeMostCommon": [ "computed", "discount_end", "line_ends_at", "timestamp", "type" ] }, "quotes_resource_quote_lines_trial": { "description": "", "properties": { "converts_to": { "description": "List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial.", "items": { "maxLength": 5000, "type": "string" }, "nullable": true, "type": "array" }, "type": { "description": "Determines the type of trial for this item.", "enum": [ "free", "paid" ], "type": "string" } }, "required": [ "type" ], "title": "QuotesResourceQuoteLinesTrial", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "converts_to", "type" ] }, "quotes_resource_quote_lines_trial_settings": { "description": "Configures how the scheduled subscription behaves during the trial period.", "properties": { "end_behavior": { "anyOf": [ { "$ref": "#/components/schemas/quotes_resource_quote_lines_end_behavior" } ], "description": "Defines how the subscription should behave when a trial ends.", "nullable": true } }, "required": [ "end_behavior" ], "title": "QuotesResourceQuoteLinesTrialSettings", "type": "object", "x-expandableFields": [ "end_behavior" ], "x-stripeMostCommon": [ "end_behavior" ] }, "quotes_resource_recurring": { "description": "", "properties": { "amount_subtotal": { "description": "Total before any discounts or taxes are applied.", "type": "integer" }, "amount_total": { "description": "Total after discounts and taxes are applied.", "type": "integer" }, "interval": { "description": "The frequency at which a subscription is billed. One of `day`, `week`, `month` or `year`.", "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "description": "The number of intervals (specified in the `interval` attribute) between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months.", "type": "integer" }, "total_details": { "$ref": "#/components/schemas/quotes_resource_total_details" } }, "required": [ "amount_subtotal", "amount_total", "interval", "interval_count", "total_details" ], "title": "QuotesResourceRecurring", "type": "object", "x-expandableFields": [ "total_details" ], "x-stripeMostCommon": [ "amount_subtotal", "amount_total", "interval", "interval_count", "total_details" ] }, "quotes_resource_status_details_canceled_status_details": { "description": "", "properties": { "reason": { "description": "The reason this quote was marked as canceled.", "enum": [ "canceled", "quote_accepted", "quote_expired", "quote_superseded", "subscription_canceled" ], "nullable": true, "type": "string" }, "transitioned_at": { "description": "Time at which the quote was marked as canceled. Measured in seconds since the Unix epoch.", "format": "unix-time", "nullable": true, "type": "integer" } }, "required": [ "reason", "transitioned_at" ], "title": "QuotesResourceStatusDetailsCanceledStatusDetails", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "reason", "transitioned_at" ] }, "quotes_resource_status_details_lines_invalid": { "description": "", "properties": { "invalid_at": { "description": "The timestamp at which the lines were marked as invalid.", "format": "unix-time", "type": "integer" }, "lines": { "description": "The list of lines that became invalid at the given timestamp.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "required": [ "invalid_at", "lines" ], "title": "QuotesResourceStatusDetailsLinesInvalid", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "invalid_at", "lines" ] }, "quotes_resource_status_details_stale_reason": { "description": "", "properties": { "line_invalid": { "description": "The ID of the line that is invalid if the stale reason type is `line_invalid`.", "maxLength": 5000, "type": "string" }, "lines_invalid": { "description": "The IDs of the lines that are invalid if the stale reason type is `lines_invalid`.", "items": { "$ref": "#/components/schemas/quotes_resource_status_details_lines_invalid" }, "type": "array" }, "marked_stale": { "description": "The user supplied mark stale reason.", "maxLength": 5000, "nullable": true, "type": "string" }, "subscription_canceled": { "description": "The ID of the subscription that was canceled.", "maxLength": 5000, "type": "string" }, "subscription_changed": { "$ref": "#/components/schemas/quotes_resource_status_details_subscription_changed" }, "subscription_expired": { "description": "The ID of the subscription that was expired.", "maxLength": 5000, "type": "string" }, "subscription_schedule_canceled": { "description": "The ID of the subscription schedule that was canceled.", "maxLength": 5000, "type": "string" }, "subscription_schedule_changed": { "$ref": "#/components/schemas/quotes_resource_status_details_subscription_schedule_changed" }, "subscription_schedule_released": { "description": "The ID of the subscription schedule that was released.", "maxLength": 5000, "type": "string" }, "type": { "description": "The reason the quote was marked as stale.", "enum": [ "accept_failed_validations", "bill_on_acceptance_invalid", "line_invalid", "lines_invalid", "marked_stale", "subscription_canceled", "subscription_changed", "subscription_expired", "subscription_schedule_canceled", "subscription_schedule_changed", "subscription_schedule_released" ], "nullable": true, "type": "string" } }, "required": [ "type" ], "title": "QuotesResourceStatusDetailsStaleReason", "type": "object", "x-expandableFields": [ "lines_invalid", "subscription_changed", "subscription_schedule_changed" ], "x-stripeMostCommon": [ "line_invalid", "lines_invalid", "marked_stale", "subscription_canceled", "subscription_changed", "subscription_expired", "subscription_schedule_canceled", "subscription_schedule_changed", "subscription_schedule_released", "type" ] }, "quotes_resource_status_details_stale_status_details": { "description": "", "properties": { "expires_at": { "description": "Time at which the quote expires. Measured in seconds since the Unix epoch.", "format": "unix-time", "nullable": true, "type": "integer" }, "last_reason": { "anyOf": [ { "$ref": "#/components/schemas/quotes_resource_status_details_stale_reason" } ], "description": "The most recent reason this quote was marked as stale.", "nullable": true }, "last_updated_at": { "description": "Time at which the stale reason was updated. Measured in seconds since the Unix epoch.", "format": "unix-time", "nullable": true, "type": "integer" }, "transitioned_at": { "description": "Time at which the quote was marked as stale. Measured in seconds since the Unix epoch.", "format": "unix-time", "nullable": true, "type": "integer" } }, "required": [ "expires_at", "last_reason", "last_updated_at", "transitioned_at" ], "title": "QuotesResourceStatusDetailsStaleStatusDetails", "type": "object", "x-expandableFields": [ "last_reason" ], "x-stripeMostCommon": [ "expires_at", "last_reason", "last_updated_at", "transitioned_at" ] }, "quotes_resource_status_details_status_details": { "description": "", "properties": { "canceled": { "$ref": "#/components/schemas/quotes_resource_status_details_canceled_status_details" }, "stale": { "$ref": "#/components/schemas/quotes_resource_status_details_stale_status_details" } }, "title": "QuotesResourceStatusDetailsStatusDetails", "type": "object", "x-expandableFields": [ "canceled", "stale" ], "x-stripeMostCommon": [ "canceled", "stale" ] }, "quotes_resource_status_details_subscription_changed": { "description": "", "properties": { "previous_subscription": { "anyOf": [ { "$ref": "#/components/schemas/subscription" } ], "description": "The subscription's state before the quote was marked as stale.", "nullable": true } }, "required": [ "previous_subscription" ], "title": "QuotesResourceStatusDetailsSubscriptionChanged", "type": "object", "x-expandableFields": [ "previous_subscription" ], "x-stripeMostCommon": [ "previous_subscription" ] }, "quotes_resource_status_details_subscription_schedule_changed": { "description": "", "properties": { "previous_subscription_schedule": { "anyOf": [ { "$ref": "#/components/schemas/subscription_schedule" } ], "description": "The subscription schedule's state before the quote was marked as stale.", "nullable": true } }, "required": [ "previous_subscription_schedule" ], "title": "QuotesResourceStatusDetailsSubscriptionScheduleChanged", "type": "object", "x-expandableFields": [ "previous_subscription_schedule" ], "x-stripeMostCommon": [ "previous_subscription_schedule" ], "x-stripeResource": { "class_name": "SubscriptionScheduleChanged", "in_package": "" } }, "quotes_resource_status_transitions": { "description": "", "properties": { "accepted_at": { "description": "The time that the quote was accepted. Measured in seconds since Unix epoch.", "format": "unix-time", "nullable": true, "type": "integer" }, "canceled_at": { "description": "The time that the quote was canceled. Measured in seconds since Unix epoch.", "format": "unix-time", "nullable": true, "type": "integer" }, "finalized_at": { "description": "The time that the quote was finalized. Measured in seconds since Unix epoch.", "format": "unix-time", "nullable": true, "type": "integer" } }, "required": [ "accepted_at", "canceled_at", "finalized_at" ], "title": "QuotesResourceStatusTransitions", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "accepted_at", "canceled_at", "finalized_at" ] }, "quotes_resource_subscription_data_bill_from": { "description": "", "properties": { "computed": { "description": "The materialized time.", "format": "unix-time", "nullable": true, "type": "integer" }, "line_starts_at": { "anyOf": [ { "$ref": "#/components/schemas/quotes_resource_quote_lines_timestamp_helpers_line_id" } ], "description": "The timestamp the given line starts at.", "nullable": true }, "timestamp": { "description": "A precise Unix timestamp.", "format": "unix-time", "nullable": true, "type": "integer" }, "type": { "description": "The type of method to specify the `bill_from` time.", "enum": [ "line_starts_at", "now", "pause_collection_start", "quote_acceptance_date", "timestamp" ], "type": "string" } }, "required": [ "computed", "line_starts_at", "timestamp", "type" ], "title": "QuotesResourceSubscriptionDataBillFrom", "type": "object", "x-expandableFields": [ "line_starts_at" ], "x-stripeMostCommon": [ "computed", "line_starts_at", "timestamp", "type" ] }, "quotes_resource_subscription_data_bill_on_acceptance": { "description": "", "properties": { "bill_from": { "anyOf": [ { "$ref": "#/components/schemas/quotes_resource_subscription_data_bill_from" } ], "description": "The start of the period to bill from when the Quote is accepted.", "nullable": true }, "bill_until": { "anyOf": [ { "$ref": "#/components/schemas/quotes_resource_subscription_data_bill_until" } ], "description": "The end of the period to bill until when the Quote is accepted.", "nullable": true } }, "required": [ "bill_from", "bill_until" ], "title": "QuotesResourceSubscriptionDataBillOnAcceptance", "type": "object", "x-expandableFields": [ "bill_from", "bill_until" ], "x-stripeMostCommon": [ "bill_from", "bill_until" ] }, "quotes_resource_subscription_data_bill_until": { "description": "", "properties": { "computed": { "description": "The materialized time.", "format": "unix-time", "nullable": true, "type": "integer" }, "duration": { "anyOf": [ { "$ref": "#/components/schemas/quotes_resource_quote_lines_timestamp_helpers_duration" } ], "description": "Time span for the quote line starting from the `starts_at` date.", "nullable": true }, "line_ends_at": { "anyOf": [ { "$ref": "#/components/schemas/quotes_resource_quote_lines_timestamp_helpers_line_id" } ], "description": "The timestamp the given line ends at.", "nullable": true }, "timestamp": { "description": "A precise Unix timestamp.", "format": "unix-time", "nullable": true, "type": "integer" }, "type": { "description": "The type of method to specify the `bill_until` time.", "enum": [ "duration", "line_ends_at", "schedule_end", "timestamp", "upcoming_invoice" ], "type": "string" } }, "required": [ "computed", "duration", "line_ends_at", "timestamp", "type" ], "title": "QuotesResourceSubscriptionDataBillUntil", "type": "object", "x-expandableFields": [ "duration", "line_ends_at" ], "x-stripeMostCommon": [ "computed", "duration", "line_ends_at", "timestamp", "type" ] }, "quotes_resource_subscription_data_billing_mode": { "description": "The billing mode of the quote.", "properties": { "type": { "description": "Controls how prorations and invoices for subscriptions are calculated and orchestrated.", "enum": [ "classic", "flexible" ], "type": "string" } }, "required": [ "type" ], "title": "QuotesResourceSubscriptionDataBillingMode", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "type" ] }, "quotes_resource_subscription_data_subscription_data": { "description": "", "properties": { "bill_on_acceptance": { "anyOf": [ { "$ref": "#/components/schemas/quotes_resource_subscription_data_bill_on_acceptance" } ], "description": "Describes the period to bill for upon accepting the quote.", "nullable": true }, "billing_behavior": { "description": "Configures when the subscription schedule generates prorations for phase transitions. Possible values are `prorate_on_next_phase` or `prorate_up_front` with the default being `prorate_on_next_phase`. `prorate_on_next_phase` will apply phase changes and generate prorations at transition time. `prorate_up_front` will bill for all phases within the current billing cycle up front.", "enum": [ "prorate_on_next_phase", "prorate_up_front" ], "type": "string" }, "billing_cycle_anchor": { "description": "Whether the subscription will always start a new billing period when the quote is accepted.", "enum": [ "reset" ], "nullable": true, "type": "string" }, "billing_mode": { "$ref": "#/components/schemas/quotes_resource_subscription_data_billing_mode" }, "description": { "description": "The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.", "maxLength": 5000, "nullable": true, "type": "string" }, "effective_date": { "description": "When creating a new subscription, the date of which the subscription schedule will start after the quote is accepted. This date is ignored if it is in the past when the quote is accepted. Measured in seconds since the Unix epoch.", "format": "unix-time", "nullable": true, "type": "integer" }, "end_behavior": { "description": "Behavior of the subscription schedule and underlying subscription when it ends.", "enum": [ "cancel", "release" ], "nullable": true, "type": "string" }, "from_subscription": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/subscription" } ], "description": "The id of the subscription that will be updated when the quote is accepted.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/subscription" } ] } }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will set metadata on the subscription or subscription schedule when the quote is accepted. If a recurring price is included in `line_items`, this field will be passed to the resulting subscription's `metadata` field. If `subscription_data.effective_date` is used, this field will be passed to the resulting subscription schedule's `phases.metadata` field. Unlike object-level metadata, this field is declarative. Updates will clear prior values.", "nullable": true, "type": "object" }, "prebilling": { "anyOf": [ { "$ref": "#/components/schemas/quotes_resource_prebilling" } ], "description": "If specified, the invoicing for the given billing cycle iterations will be processed when the quote is accepted. Cannot be used with `effective_date`.", "nullable": true }, "proration_behavior": { "description": "Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations) when the quote is accepted.", "enum": [ "always_invoice", "create_prorations", "none" ], "type": "string" }, "trial_period_days": { "description": "Integer representing the number of trial period days before the customer is charged for the first time.", "nullable": true, "type": "integer" } }, "required": [ "billing_mode", "description", "effective_date", "metadata", "trial_period_days" ], "title": "QuotesResourceSubscriptionDataSubscriptionData", "type": "object", "x-expandableFields": [ "bill_on_acceptance", "billing_mode", "from_subscription", "prebilling" ], "x-stripeMostCommon": [ "bill_on_acceptance", "billing_behavior", "billing_cycle_anchor", "billing_mode", "description", "effective_date", "end_behavior", "from_subscription", "metadata", "prebilling", "proration_behavior", "trial_period_days" ] }, "quotes_resource_subscription_data_subscription_data_overrides": { "description": "", "properties": { "applies_to": { "$ref": "#/components/schemas/quotes_resource_quote_lines_applies_to" }, "bill_on_acceptance": { "anyOf": [ { "$ref": "#/components/schemas/quotes_resource_subscription_data_bill_on_acceptance" } ], "description": "Describes the period to bill for upon accepting the quote.", "nullable": true }, "billing_behavior": { "description": "Configures when the subscription schedule generates prorations for phase transitions. Possible values are `prorate_on_next_phase` or `prorate_up_front` with the default being `prorate_on_next_phase`. `prorate_on_next_phase` will apply phase changes and generate prorations at transition time. `prorate_up_front` will bill for all phases within the current billing cycle up front.", "enum": [ "prorate_on_next_phase", "prorate_up_front" ], "type": "string" }, "customer": { "description": "The customer which this quote belongs to. A customer is required before finalizing the quote. Once specified, it cannot be changed.", "maxLength": 5000, "nullable": true, "type": "string" }, "description": { "description": "The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.", "maxLength": 5000, "nullable": true, "type": "string" }, "end_behavior": { "description": "Behavior of the subscription schedule and underlying subscription when it ends.", "enum": [ "cancel", "release" ], "nullable": true, "type": "string" }, "proration_behavior": { "description": "Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations) when the quote is accepted.", "enum": [ "always_invoice", "create_prorations", "none" ], "nullable": true, "type": "string" } }, "required": [ "applies_to", "customer", "description" ], "title": "QuotesResourceSubscriptionDataSubscriptionDataOverrides", "type": "object", "x-expandableFields": [ "applies_to", "bill_on_acceptance" ], "x-stripeMostCommon": [ "applies_to", "bill_on_acceptance", "billing_behavior", "customer", "description", "end_behavior", "proration_behavior" ] }, "quotes_resource_subscription_schedule_with_applies_to": { "description": "", "properties": { "applies_to": { "$ref": "#/components/schemas/quotes_resource_quote_lines_applies_to" }, "subscription_schedule": { "description": "The subscription schedule that was created or updated from this quote.", "maxLength": 5000, "type": "string" } }, "required": [ "applies_to", "subscription_schedule" ], "title": "QuotesResourceSubscriptionScheduleWithAppliesTo", "type": "object", "x-expandableFields": [ "applies_to" ], "x-stripeMostCommon": [ "applies_to", "subscription_schedule" ] }, "quotes_resource_total_details": { "description": "", "properties": { "amount_discount": { "description": "This is the sum of all the discounts.", "type": "integer" }, "amount_shipping": { "description": "This is the sum of all the shipping amounts.", "nullable": true, "type": "integer" }, "amount_tax": { "description": "This is the sum of all the tax amounts.", "type": "integer" }, "breakdown": { "$ref": "#/components/schemas/quotes_resource_total_details_resource_breakdown" } }, "required": [ "amount_discount", "amount_shipping", "amount_tax" ], "title": "QuotesResourceTotalDetails", "type": "object", "x-expandableFields": [ "breakdown" ], "x-stripeMostCommon": [ "amount_discount", "amount_shipping", "amount_tax", "breakdown" ] }, "quotes_resource_total_details_resource_breakdown": { "description": "", "properties": { "discounts": { "description": "The aggregated discounts.", "items": { "$ref": "#/components/schemas/line_items_discount_amount" }, "type": "array" }, "taxes": { "description": "The aggregated tax amounts by rate.", "items": { "$ref": "#/components/schemas/line_items_tax_amount" }, "type": "array" } }, "required": [ "discounts", "taxes" ], "title": "QuotesResourceTotalDetailsResourceBreakdown", "type": "object", "x-expandableFields": [ "discounts", "taxes" ], "x-stripeMostCommon": [ "discounts", "taxes" ] }, "quotes_resource_transfer_data": { "description": "", "properties": { "amount": { "description": "The amount in cents (or local equivalent) that will be transferred to the destination account when the invoice is paid. By default, the entire amount is transferred to the destination.", "nullable": true, "type": "integer" }, "amount_percent": { "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount will be transferred to the destination.", "nullable": true, "type": "number" }, "destination": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/account" } ], "description": "The account where funds from the payment will be transferred to upon payment success.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/account" } ] } } }, "required": [ "amount", "amount_percent", "destination" ], "title": "QuotesResourceTransferData", "type": "object", "x-expandableFields": [ "destination" ], "x-stripeMostCommon": [ "amount", "amount_percent", "destination" ] }, "quotes_resource_upfront": { "description": "", "properties": { "amount_subtotal": { "description": "Total before any discounts or taxes are applied.", "type": "integer" }, "amount_total": { "description": "Total after discounts and taxes are applied.", "type": "integer" }, "line_items": { "description": "The line items that will appear on the next invoice after this quote is accepted. This does not include pending invoice items that exist on the customer but may still be included in the next invoice.", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/item" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "QuotesResourceListLineItems", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] }, "total_details": { "$ref": "#/components/schemas/quotes_resource_total_details" } }, "required": [ "amount_subtotal", "amount_total", "total_details" ], "title": "QuotesResourceUpfront", "type": "object", "x-expandableFields": [ "line_items", "total_details" ], "x-stripeMostCommon": [ "amount_subtotal", "amount_total", "line_items", "total_details" ] }, "radar.early_fraud_warning": { "description": "An early fraud warning indicates that the card issuer has notified us that a\ncharge may be fraudulent.\n\nRelated guide: [Early fraud warnings](https://stripe.com/docs/disputes/measuring#early-fraud-warnings)", "properties": { "actionable": { "description": "An EFW is actionable if it has not received a dispute and has not been fully refunded. You may wish to proactively refund a charge that receives an EFW, in order to avoid receiving a dispute later.", "type": "boolean" }, "charge": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/charge" } ], "description": "ID of the charge this early fraud warning is for, optionally expanded.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/charge" } ] } }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "fraud_type": { "description": "The type of fraud labelled by the issuer. One of `card_never_received`, `fraudulent_card_application`, `made_with_counterfeit_card`, `made_with_lost_card`, `made_with_stolen_card`, `misc`, `unauthorized_use_of_card`.", "maxLength": 5000, "type": "string" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "radar.early_fraud_warning" ], "type": "string" }, "payment_intent": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/payment_intent" } ], "description": "ID of the Payment Intent this early fraud warning is for, optionally expanded.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/payment_intent" } ] } } }, "required": [ "actionable", "charge", "created", "fraud_type", "id", "livemode", "object" ], "title": "RadarEarlyFraudWarning", "type": "object", "x-expandableFields": [ "charge", "payment_intent" ], "x-resourceId": "radar.early_fraud_warning", "x-stripeMostCommon": [ "actionable", "charge", "created", "fraud_type", "id", "livemode", "object", "payment_intent" ], "x-stripeOperations": [ { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/radar/early_fraud_warnings" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/radar/early_fraud_warnings/{early_fraud_warning}" } ], "x-stripeResource": { "class_name": "EarlyFraudWarning", "has_collection_class": true, "in_package": "Radar" } }, "radar.early_fraud_warning.created": { "description": "Occurs whenever an early fraud warning is created.", "properties": { "object": { "$ref": "#/components/schemas/radar.early_fraud_warning" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "radar.early_fraud_warning.created" } }, "radar.early_fraud_warning.updated": { "description": "Occurs whenever an early fraud warning is updated.", "properties": { "object": { "$ref": "#/components/schemas/radar.early_fraud_warning" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "radar.early_fraud_warning.updated" } }, "radar.value_list": { "description": "Value lists allow you to group values together which can then be referenced in rules.\n\nRelated guide: [Default Stripe lists](https://stripe.com/docs/radar/lists#managing-list-items)", "properties": { "alias": { "description": "The name of the value list for use in rules.", "maxLength": 5000, "type": "string" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "created_by": { "description": "The name or email address of the user who created this value list.", "maxLength": 5000, "type": "string" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "item_type": { "description": "The type of items in the value list. One of `card_fingerprint`, `card_bin`, `email`, `ip_address`, `country`, `string`, `case_sensitive_string`, `customer_id`, `sepa_debit_fingerprint`, or `us_bank_account_fingerprint`.", "enum": [ "card_bin", "card_fingerprint", "case_sensitive_string", "country", "customer_id", "email", "ip_address", "sepa_debit_fingerprint", "string", "us_bank_account_fingerprint" ], "type": "string" }, "list_items": { "description": "List of items contained within this value list.", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/radar.value_list_item" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "RadarListListItemList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "type": "object" }, "name": { "description": "The name of the value list.", "maxLength": 5000, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "radar.value_list" ], "type": "string" } }, "required": [ "alias", "created", "created_by", "id", "item_type", "list_items", "livemode", "metadata", "name", "object" ], "title": "RadarListList", "type": "object", "x-expandableFields": [ "list_items" ], "x-resourceId": "radar.value_list", "x-stripeMostCommon": [ "alias", "id", "item_type", "list_items", "metadata", "name" ], "x-stripeOperations": [ { "method_name": "delete", "method_on": "service", "method_type": "delete", "operation": "delete", "path": "/v1/radar/value_lists/{value_list}" }, { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/radar/value_lists" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/radar/value_lists/{value_list}" }, { "method_name": "create", "method_on": "service", "method_type": "create", "operation": "post", "path": "/v1/radar/value_lists" }, { "method_name": "update", "method_on": "service", "method_type": "update", "operation": "post", "path": "/v1/radar/value_lists/{value_list}" } ], "x-stripeResource": { "class_name": "ValueList", "has_collection_class": true, "in_package": "Radar" } }, "radar.value_list_item": { "description": "Value list items allow you to add specific values to a given Radar value list, which can then be used in rules.\n\nRelated guide: [Managing list items](https://stripe.com/docs/radar/lists#managing-list-items)", "properties": { "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "created_by": { "description": "The name or email address of the user who added this item to the value list.", "maxLength": 5000, "type": "string" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "radar.value_list_item" ], "type": "string" }, "value": { "description": "The value of the item.", "maxLength": 5000, "type": "string" }, "value_list": { "description": "The identifier of the value list this item belongs to.", "maxLength": 5000, "type": "string" } }, "required": [ "created", "created_by", "id", "livemode", "object", "value", "value_list" ], "title": "RadarListListItem", "type": "object", "x-expandableFields": [], "x-resourceId": "radar.value_list_item", "x-stripeMostCommon": [ "id", "value", "value_list" ], "x-stripeOperations": [ { "method_name": "delete", "method_on": "service", "method_type": "delete", "operation": "delete", "path": "/v1/radar/value_list_items/{item}" }, { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/radar/value_list_items" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/radar/value_list_items/{item}" }, { "method_name": "create", "method_on": "service", "method_type": "create", "operation": "post", "path": "/v1/radar/value_list_items" } ], "x-stripeResource": { "class_name": "ValueListItem", "has_collection_class": true, "in_package": "Radar" } }, "radar_radar_options": { "description": "Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.", "properties": { "session": { "description": "A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.", "maxLength": 5000, "type": "string" } }, "title": "RadarRadarOptions", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "session" ] }, "radar_review_resource_location": { "description": "", "properties": { "city": { "description": "The city where the payment originated.", "maxLength": 5000, "nullable": true, "type": "string" }, "country": { "description": "Two-letter ISO code representing the country where the payment originated.", "maxLength": 5000, "nullable": true, "type": "string" }, "latitude": { "description": "The geographic latitude where the payment originated.", "nullable": true, "type": "number" }, "longitude": { "description": "The geographic longitude where the payment originated.", "nullable": true, "type": "number" }, "region": { "description": "The state/county/province/region where the payment originated.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "city", "country", "latitude", "longitude", "region" ], "title": "RadarReviewResourceLocation", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "city", "country", "latitude", "longitude", "region" ] }, "radar_review_resource_session": { "description": "", "properties": { "browser": { "description": "The browser used in this browser session (e.g., `Chrome`).", "maxLength": 5000, "nullable": true, "type": "string" }, "device": { "description": "Information about the device used for the browser session (e.g., `Samsung SM-G930T`).", "maxLength": 5000, "nullable": true, "type": "string" }, "platform": { "description": "The platform for the browser session (e.g., `Macintosh`).", "maxLength": 5000, "nullable": true, "type": "string" }, "version": { "description": "The version for the browser session (e.g., `61.0.3163.100`).", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "browser", "device", "platform", "version" ], "title": "RadarReviewResourceSession", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "browser", "device", "platform", "version" ] }, "received_payment_method_details_financial_account": { "description": "", "properties": { "id": { "description": "The FinancialAccount ID.", "maxLength": 5000, "type": "string" }, "network": { "description": "The rails the ReceivedCredit was sent over. A FinancialAccount can only send funds over `stripe`.", "enum": [ "stripe" ], "type": "string" } }, "required": [ "id", "network" ], "title": "received_payment_method_details_financial_account", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "id", "network" ], "x-stripeResource": { "class_name": "FinancialAccount", "in_package": "" } }, "recurring": { "description": "", "properties": { "interval": { "description": "The frequency at which a subscription is billed. One of `day`, `week`, `month` or `year`.", "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "description": "The number of intervals (specified in the `interval` attribute) between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months.", "type": "integer" }, "meter": { "description": "The meter tracking the usage of a metered price", "maxLength": 5000, "nullable": true, "type": "string" }, "trial_period_days": { "description": "Default number of trial days when subscribing a customer to this price using [`trial_from_plan=true`](https://stripe.com/docs/api#create_subscription-trial_from_plan).", "nullable": true, "type": "integer" }, "usage_type": { "description": "Configures how the quantity per period should be determined. Can be either `metered` or `licensed`. `licensed` automatically bills the `quantity` set when adding it to a subscription. `metered` aggregates the total usage based on usage records. Defaults to `licensed`.", "enum": [ "licensed", "metered" ], "type": "string" } }, "required": [ "interval", "interval_count", "meter", "trial_period_days", "usage_type" ], "title": "Recurring", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "interval" ] }, "redaction_resource_erroring_object": { "description": "If a Redaction Job Validation Error occurred because of a specific object, this will contain its identifier and object type.", "properties": { "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "object_type": { "description": "Erroring object type", "maxLength": 5000, "type": "string" } }, "required": [ "id", "object_type" ], "title": "RedactionResourceErroringObject", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "id", "object_type" ] }, "redaction_resource_root_objects": { "description": "The objects to redact, grouped by type. All redactable objects associated with these objects will be redacted as well.", "properties": { "charges": { "description": "Charge object identifiers usually starting with `ch_`", "items": { "maxLength": 5000, "type": "string" }, "nullable": true, "type": "array" }, "checkout_sessions": { "description": "CheckoutSession object identifiers starting with `cs_`", "items": { "maxLength": 5000, "type": "string" }, "nullable": true, "type": "array" }, "customers": { "description": "Customer object identifiers starting with `cus_`", "items": { "maxLength": 5000, "type": "string" }, "nullable": true, "type": "array" }, "identity_verification_sessions": { "description": "Identity VerificationSessions object identifiers starting with `vs_`", "items": { "maxLength": 5000, "type": "string" }, "nullable": true, "type": "array" }, "invoices": { "description": "Invoice object identifiers starting with `in_`", "items": { "maxLength": 5000, "type": "string" }, "nullable": true, "type": "array" }, "issuing_cardholders": { "description": "Issuing Cardholder object identifiers starting with `ich_`", "items": { "maxLength": 5000, "type": "string" }, "nullable": true, "type": "array" }, "payment_intents": { "description": "PaymentIntent object identifiers starting with `pi_`", "items": { "maxLength": 5000, "type": "string" }, "nullable": true, "type": "array" }, "radar_value_list_items": { "description": "Fraud ValueListItem object identifiers starting with `rsli_`", "items": { "maxLength": 5000, "type": "string" }, "nullable": true, "type": "array" }, "setup_intents": { "description": "SetupIntent object identifiers starting with `seti_`", "items": { "maxLength": 5000, "type": "string" }, "nullable": true, "type": "array" } }, "required": [ "charges", "checkout_sessions", "customers", "identity_verification_sessions", "invoices", "issuing_cardholders", "payment_intents", "radar_value_list_items", "setup_intents" ], "title": "RedactionResourceRootObjects", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "charges", "checkout_sessions", "customers", "identity_verification_sessions", "invoices", "issuing_cardholders", "payment_intents", "radar_value_list_items", "setup_intents" ] }, "refund": { "description": "Refund objects allow you to refund a previously created charge that isn't\nrefunded yet. Funds are refunded to the credit or debit card that's\ninitially charged.\n\nRelated guide: [Refunds](https://stripe.com/docs/refunds)", "properties": { "amount": { "description": "Amount, in cents (or local equivalent).", "type": "integer" }, "balance_transaction": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/balance_transaction" } ], "description": "Balance transaction that describes the impact on your account balance.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/balance_transaction" } ] } }, "charge": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/charge" } ], "description": "ID of the charge that's refunded.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/charge" } ] } }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "description": { "description": "An arbitrary string attached to the object. You can use this for displaying to users (available on non-card refunds only).", "maxLength": 5000, "type": "string" }, "destination_details": { "$ref": "#/components/schemas/refund_destination_details" }, "failure_balance_transaction": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/balance_transaction" } ], "description": "After the refund fails, this balance transaction describes the adjustment made on your account balance that reverses the initial balance transaction.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/balance_transaction" } ] } }, "failure_reason": { "description": "Provides the reason for the refund failure. Possible values are: `lost_or_stolen_card`, `expired_or_canceled_card`, `charge_for_pending_refund_disputed`, `insufficient_funds`, `declined`, `merchant_request`, or `unknown`.", "maxLength": 5000, "type": "string" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "instructions_email": { "description": "For payment methods without native refund support (for example, Konbini, PromptPay), provide an email address for the customer to receive refund instructions.", "maxLength": 5000, "type": "string" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "nullable": true, "type": "object" }, "next_action": { "$ref": "#/components/schemas/refund_next_action" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "refund" ], "type": "string" }, "payment_intent": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/payment_intent" } ], "description": "ID of the PaymentIntent that's refunded.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/payment_intent" } ] } }, "pending_reason": { "description": "Provides the reason for why the refund is pending. Possible values are: `processing`, `insufficient_funds`, or `charge_pending`.", "enum": [ "charge_pending", "insufficient_funds", "processing" ], "type": "string" }, "presentment_details": { "$ref": "#/components/schemas/payment_flows_payment_intent_presentment_details" }, "reason": { "description": "Reason for the refund, which is either user-provided (`duplicate`, `fraudulent`, or `requested_by_customer`) or generated by Stripe internally (`expired_uncaptured_charge`).", "enum": [ "duplicate", "expired_uncaptured_charge", "fraudulent", "requested_by_customer" ], "nullable": true, "type": "string", "x-stripeBypassValidation": true }, "receipt_number": { "description": "This is the transaction number that appears on email receipts sent for this refund.", "maxLength": 5000, "nullable": true, "type": "string" }, "source_transfer_reversal": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/transfer_reversal" } ], "description": "The transfer reversal that's associated with the refund. Only present if the charge came from another Stripe account.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/transfer_reversal" } ] } }, "status": { "description": "Status of the refund. This can be `pending`, `requires_action`, `succeeded`, `failed`, or `canceled`. Learn more about [failed refunds](https://stripe.com/docs/refunds#failed-refunds).", "maxLength": 5000, "nullable": true, "type": "string" }, "transfer_reversal": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/transfer_reversal" } ], "description": "This refers to the transfer reversal object if the accompanying transfer reverses. This is only applicable if the charge was created using the destination parameter.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/transfer_reversal" } ] } } }, "required": [ "amount", "balance_transaction", "charge", "created", "currency", "id", "metadata", "object", "payment_intent", "reason", "receipt_number", "source_transfer_reversal", "status", "transfer_reversal" ], "title": "Refund", "type": "object", "x-expandableFields": [ "balance_transaction", "charge", "destination_details", "failure_balance_transaction", "next_action", "payment_intent", "presentment_details", "source_transfer_reversal", "transfer_reversal" ], "x-resourceId": "refund", "x-stripeMostCommon": [ "amount", "charge", "currency", "description", "id", "metadata", "payment_intent", "reason", "status" ], "x-stripeOperations": [ { "method_name": "list", "method_on": "collection", "method_type": "list", "operation": "get", "path": "/v1/charges/{charge}/refunds" }, { "method_name": "retrieve", "method_on": "collection", "method_type": "retrieve", "operation": "get", "path": "/v1/charges/{charge}/refunds/{refund}" }, { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/refunds" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/refunds/{refund}" }, { "method_name": "create", "method_on": "service", "method_type": "create", "operation": "post", "path": "/v1/refunds" }, { "method_name": "update", "method_on": "service", "method_type": "update", "operation": "post", "path": "/v1/refunds/{refund}" }, { "method_name": "cancel", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/refunds/{refund}/cancel" }, { "method_name": "expire", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/test_helpers/refunds/{refund}/expire" } ], "x-stripeResource": { "class_name": "Refund", "has_collection_class": true, "in_package": "", "polymorphic_groups": [ "balance_transaction_source" ] } }, "refund.created": { "description": "Occurs whenever a refund is created.", "properties": { "object": { "$ref": "#/components/schemas/refund" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "refund.created" } }, "refund.failed": { "description": "Occurs whenever a refund has failed.", "properties": { "object": { "$ref": "#/components/schemas/refund" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "refund.failed" } }, "refund.updated": { "description": "Occurs whenever a refund is updated.", "properties": { "object": { "$ref": "#/components/schemas/refund" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "refund.updated" } }, "refund_destination_details": { "description": "", "properties": { "affirm": { "$ref": "#/components/schemas/destination_details_unimplemented" }, "afterpay_clearpay": { "$ref": "#/components/schemas/destination_details_unimplemented" }, "alipay": { "$ref": "#/components/schemas/destination_details_unimplemented" }, "alma": { "$ref": "#/components/schemas/destination_details_unimplemented" }, "amazon_pay": { "$ref": "#/components/schemas/destination_details_unimplemented" }, "au_bank_transfer": { "$ref": "#/components/schemas/destination_details_unimplemented" }, "blik": { "$ref": "#/components/schemas/refund_destination_details_blik" }, "br_bank_transfer": { "$ref": "#/components/schemas/refund_destination_details_br_bank_transfer" }, "card": { "$ref": "#/components/schemas/refund_destination_details_card" }, "cashapp": { "$ref": "#/components/schemas/destination_details_unimplemented" }, "customer_cash_balance": { "$ref": "#/components/schemas/destination_details_unimplemented" }, "eps": { "$ref": "#/components/schemas/destination_details_unimplemented" }, "eu_bank_transfer": { "$ref": "#/components/schemas/refund_destination_details_eu_bank_transfer" }, "gb_bank_transfer": { "$ref": "#/components/schemas/refund_destination_details_gb_bank_transfer" }, "giropay": { "$ref": "#/components/schemas/destination_details_unimplemented" }, "grabpay": { "$ref": "#/components/schemas/destination_details_unimplemented" }, "id_bank_transfer": { "$ref": "#/components/schemas/refund_destination_details_id_bank_transfer" }, "jp_bank_transfer": { "$ref": "#/components/schemas/refund_destination_details_jp_bank_transfer" }, "klarna": { "$ref": "#/components/schemas/destination_details_unimplemented" }, "multibanco": { "$ref": "#/components/schemas/refund_destination_details_multibanco" }, "mx_bank_transfer": { "$ref": "#/components/schemas/refund_destination_details_mx_bank_transfer" }, "nz_bank_transfer": { "$ref": "#/components/schemas/destination_details_unimplemented" }, "p24": { "$ref": "#/components/schemas/refund_destination_details_p24" }, "paynow": { "$ref": "#/components/schemas/destination_details_unimplemented" }, "paypal": { "$ref": "#/components/schemas/refund_destination_details_paypal" }, "pix": { "$ref": "#/components/schemas/destination_details_unimplemented" }, "revolut": { "$ref": "#/components/schemas/destination_details_unimplemented" }, "sofort": { "$ref": "#/components/schemas/destination_details_unimplemented" }, "swish": { "$ref": "#/components/schemas/refund_destination_details_swish" }, "th_bank_transfer": { "$ref": "#/components/schemas/refund_destination_details_th_bank_transfer" }, "type": { "description": "The type of transaction-specific details of the payment method used in the refund (e.g., `card`). An additional hash is included on `destination_details` with a name matching this value. It contains information specific to the refund transaction.", "maxLength": 5000, "type": "string" }, "us_bank_transfer": { "$ref": "#/components/schemas/refund_destination_details_us_bank_transfer" }, "wechat_pay": { "$ref": "#/components/schemas/destination_details_unimplemented" }, "zip": { "$ref": "#/components/schemas/destination_details_unimplemented" } }, "required": [ "type" ], "title": "refund_destination_details", "type": "object", "x-expandableFields": [ "affirm", "afterpay_clearpay", "alipay", "alma", "amazon_pay", "au_bank_transfer", "blik", "br_bank_transfer", "card", "cashapp", "customer_cash_balance", "eps", "eu_bank_transfer", "gb_bank_transfer", "giropay", "grabpay", "id_bank_transfer", "jp_bank_transfer", "klarna", "multibanco", "mx_bank_transfer", "nz_bank_transfer", "p24", "paynow", "paypal", "pix", "revolut", "sofort", "swish", "th_bank_transfer", "us_bank_transfer", "wechat_pay", "zip" ], "x-stripeMostCommon": [ "affirm", "afterpay_clearpay", "alipay", "alma", "amazon_pay", "au_bank_transfer", "blik", "br_bank_transfer", "card", "cashapp", "customer_cash_balance", "eps", "eu_bank_transfer", "gb_bank_transfer", "giropay", "grabpay", "id_bank_transfer", "jp_bank_transfer", "klarna", "multibanco", "mx_bank_transfer", "nz_bank_transfer", "p24", "paynow", "paypal", "pix", "revolut", "sofort", "swish", "th_bank_transfer", "type", "us_bank_transfer", "wechat_pay", "zip" ] }, "refund_destination_details_blik": { "description": "", "properties": { "network_decline_code": { "description": "For refunds declined by the network, a decline code provided by the network which indicates the reason the refund failed.", "maxLength": 5000, "nullable": true, "type": "string" }, "reference": { "description": "The reference assigned to the refund.", "maxLength": 5000, "nullable": true, "type": "string" }, "reference_status": { "description": "Status of the reference on the refund. This can be `pending`, `available` or `unavailable`.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "network_decline_code", "reference", "reference_status" ], "title": "refund_destination_details_blik", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "network_decline_code", "reference", "reference_status" ] }, "refund_destination_details_br_bank_transfer": { "description": "", "properties": { "reference": { "description": "The reference assigned to the refund.", "maxLength": 5000, "nullable": true, "type": "string" }, "reference_status": { "description": "Status of the reference on the refund. This can be `pending`, `available` or `unavailable`.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "reference", "reference_status" ], "title": "refund_destination_details_br_bank_transfer", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "reference", "reference_status" ] }, "refund_destination_details_card": { "description": "", "properties": { "reference": { "description": "Value of the reference number assigned to the refund.", "maxLength": 5000, "type": "string" }, "reference_status": { "description": "Status of the reference number on the refund. This can be `pending`, `available` or `unavailable`.", "maxLength": 5000, "type": "string" }, "reference_type": { "description": "Type of the reference number assigned to the refund.", "maxLength": 5000, "type": "string" }, "type": { "description": "The type of refund. This can be `refund`, `reversal`, or `pending`.", "enum": [ "pending", "refund", "reversal" ], "type": "string" } }, "required": [ "type" ], "title": "refund_destination_details_card", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "reference", "reference_status", "reference_type", "type" ] }, "refund_destination_details_eu_bank_transfer": { "description": "", "properties": { "reference": { "description": "The reference assigned to the refund.", "maxLength": 5000, "nullable": true, "type": "string" }, "reference_status": { "description": "Status of the reference on the refund. This can be `pending`, `available` or `unavailable`.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "reference", "reference_status" ], "title": "refund_destination_details_eu_bank_transfer", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "reference", "reference_status" ] }, "refund_destination_details_gb_bank_transfer": { "description": "", "properties": { "reference": { "description": "The reference assigned to the refund.", "maxLength": 5000, "nullable": true, "type": "string" }, "reference_status": { "description": "Status of the reference on the refund. This can be `pending`, `available` or `unavailable`.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "reference", "reference_status" ], "title": "refund_destination_details_gb_bank_transfer", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "reference", "reference_status" ] }, "refund_destination_details_id_bank_transfer": { "description": "", "properties": { "reference": { "description": "The reference assigned to the refund.", "maxLength": 5000, "nullable": true, "type": "string" }, "reference_status": { "description": "Status of the reference on the refund. This can be `pending`, `available` or `unavailable`.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "reference", "reference_status" ], "title": "refund_destination_details_id_bank_transfer", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "reference", "reference_status" ] }, "refund_destination_details_jp_bank_transfer": { "description": "", "properties": { "reference": { "description": "The reference assigned to the refund.", "maxLength": 5000, "nullable": true, "type": "string" }, "reference_status": { "description": "Status of the reference on the refund. This can be `pending`, `available` or `unavailable`.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "reference", "reference_status" ], "title": "refund_destination_details_jp_bank_transfer", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "reference", "reference_status" ] }, "refund_destination_details_multibanco": { "description": "", "properties": { "reference": { "description": "The reference assigned to the refund.", "maxLength": 5000, "nullable": true, "type": "string" }, "reference_status": { "description": "Status of the reference on the refund. This can be `pending`, `available` or `unavailable`.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "reference", "reference_status" ], "title": "refund_destination_details_multibanco", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "reference", "reference_status" ] }, "refund_destination_details_mx_bank_transfer": { "description": "", "properties": { "reference": { "description": "The reference assigned to the refund.", "maxLength": 5000, "nullable": true, "type": "string" }, "reference_status": { "description": "Status of the reference on the refund. This can be `pending`, `available` or `unavailable`.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "reference", "reference_status" ], "title": "refund_destination_details_mx_bank_transfer", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "reference", "reference_status" ] }, "refund_destination_details_p24": { "description": "", "properties": { "reference": { "description": "The reference assigned to the refund.", "maxLength": 5000, "nullable": true, "type": "string" }, "reference_status": { "description": "Status of the reference on the refund. This can be `pending`, `available` or `unavailable`.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "reference", "reference_status" ], "title": "refund_destination_details_p24", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "reference", "reference_status" ] }, "refund_destination_details_paypal": { "description": "", "properties": { "network_decline_code": { "description": "For refunds declined by the network, a decline code provided by the network which indicates the reason the refund failed.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "network_decline_code" ], "title": "refund_destination_details_paypal", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "network_decline_code" ] }, "refund_destination_details_swish": { "description": "", "properties": { "network_decline_code": { "description": "For refunds declined by the network, a decline code provided by the network which indicates the reason the refund failed.", "maxLength": 5000, "nullable": true, "type": "string" }, "reference": { "description": "The reference assigned to the refund.", "maxLength": 5000, "nullable": true, "type": "string" }, "reference_status": { "description": "Status of the reference on the refund. This can be `pending`, `available` or `unavailable`.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "network_decline_code", "reference", "reference_status" ], "title": "refund_destination_details_swish", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "network_decline_code", "reference", "reference_status" ] }, "refund_destination_details_th_bank_transfer": { "description": "", "properties": { "reference": { "description": "The reference assigned to the refund.", "maxLength": 5000, "nullable": true, "type": "string" }, "reference_status": { "description": "Status of the reference on the refund. This can be `pending`, `available` or `unavailable`.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "reference", "reference_status" ], "title": "refund_destination_details_th_bank_transfer", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "reference", "reference_status" ] }, "refund_destination_details_us_bank_transfer": { "description": "", "properties": { "reference": { "description": "The reference assigned to the refund.", "maxLength": 5000, "nullable": true, "type": "string" }, "reference_status": { "description": "Status of the reference on the refund. This can be `pending`, `available` or `unavailable`.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "reference", "reference_status" ], "title": "refund_destination_details_us_bank_transfer", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "reference", "reference_status" ] }, "refund_next_action": { "description": "", "properties": { "display_details": { "$ref": "#/components/schemas/refund_next_action_display_details" }, "type": { "description": "Type of the next action to perform.", "maxLength": 5000, "type": "string" } }, "required": [ "type" ], "title": "RefundNextAction", "type": "object", "x-expandableFields": [ "display_details" ], "x-stripeMostCommon": [ "display_details", "type" ] }, "refund_next_action_display_details": { "description": "", "properties": { "email_sent": { "$ref": "#/components/schemas/email_sent" }, "expires_at": { "description": "The expiry timestamp.", "format": "unix-time", "type": "integer" } }, "required": [ "email_sent", "expires_at" ], "title": "RefundNextActionDisplayDetails", "type": "object", "x-expandableFields": [ "email_sent" ], "x-stripeMostCommon": [ "email_sent", "expires_at" ] }, "reporting.report_run": { "description": "The Report Run object represents an instance of a report type generated with\nspecific run parameters. Once the object is created, Stripe begins processing the report.\nWhen the report has finished running, it will give you a reference to a file\nwhere you can retrieve your results. For an overview, see\n[API Access to Reports](https://stripe.com/docs/reporting/statements/api).\n\nNote that certain report types can only be run based on your live-mode data (not test-mode\ndata), and will error when queried without a [live-mode API key](https://stripe.com/docs/keys#test-live-modes).", "properties": { "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "error": { "description": "If something should go wrong during the run, a message about the failure (populated when\n `status=failed`).", "maxLength": 5000, "nullable": true, "type": "string" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "`true` if the report is run on live mode data and `false` if it is run on test mode data.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "reporting.report_run" ], "type": "string" }, "parameters": { "$ref": "#/components/schemas/financial_reporting_finance_report_run_run_parameters" }, "report_type": { "description": "The ID of the [report type](https://stripe.com/docs/reports/report-types) to run, such as `\"balance.summary.1\"`.", "maxLength": 5000, "type": "string" }, "result": { "anyOf": [ { "$ref": "#/components/schemas/file" } ], "description": "The file object representing the result of the report run (populated when\n `status=succeeded`).", "nullable": true }, "status": { "description": "Status of this report run. This will be `pending` when the run is initially created.\n When the run finishes, this will be set to `succeeded` and the `result` field will be populated.\n Rarely, we may encounter an error, at which point this will be set to `failed` and the `error` field will be populated.", "maxLength": 5000, "type": "string" }, "succeeded_at": { "description": "Timestamp at which this run successfully finished (populated when\n `status=succeeded`). Measured in seconds since the Unix epoch.", "format": "unix-time", "nullable": true, "type": "integer" } }, "required": [ "created", "error", "id", "livemode", "object", "parameters", "report_type", "result", "status", "succeeded_at" ], "title": "reporting_report_run", "type": "object", "x-expandableFields": [ "parameters", "result" ], "x-resourceId": "reporting.report_run", "x-stripeMostCommon": [ "id", "parameters", "report_type", "result", "status" ], "x-stripeOperations": [ { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/reporting/report_runs" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/reporting/report_runs/{report_run}" }, { "method_name": "create", "method_on": "service", "method_type": "create", "operation": "post", "path": "/v1/reporting/report_runs" } ], "x-stripeResource": { "class_name": "ReportRun", "has_collection_class": true, "in_package": "Reporting" } }, "reporting.report_run.failed": { "description": "Occurs whenever a requested `ReportRun` failed to complete.", "properties": { "object": { "$ref": "#/components/schemas/reporting.report_run" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "reporting.report_run.failed" } }, "reporting.report_run.succeeded": { "description": "Occurs whenever a requested `ReportRun` completed successfully.", "properties": { "object": { "$ref": "#/components/schemas/reporting.report_run" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "reporting.report_run.succeeded" } }, "reporting.report_type": { "description": "The Report Type resource corresponds to a particular type of report, such as\nthe \"Activity summary\" or \"Itemized payouts\" reports. These objects are\nidentified by an ID belonging to a set of enumerated values. See\n[API Access to Reports documentation](https://stripe.com/docs/reporting/statements/api)\nfor those Report Type IDs, along with required and optional parameters.\n\nNote that certain report types can only be run based on your live-mode data (not test-mode\ndata), and will error when queried without a [live-mode API key](https://stripe.com/docs/keys#test-live-modes).", "properties": { "data_available_end": { "description": "Most recent time for which this Report Type is available. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "data_available_start": { "description": "Earliest time for which this Report Type is available. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "default_columns": { "description": "List of column names that are included by default when this Report Type gets run. (If the Report Type doesn't support the `columns` parameter, this will be null.)", "items": { "maxLength": 5000, "type": "string" }, "nullable": true, "type": "array" }, "id": { "description": "The [ID of the Report Type](https://stripe.com/docs/reporting/statements/api#available-report-types), such as `balance.summary.1`.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "name": { "description": "Human-readable name of the Report Type", "maxLength": 5000, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "reporting.report_type" ], "type": "string" }, "updated": { "description": "When this Report Type was latest updated. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "version": { "description": "Version of the Report Type. Different versions report with the same ID will have the same purpose, but may take different run parameters or have different result schemas.", "type": "integer" } }, "required": [ "data_available_end", "data_available_start", "default_columns", "id", "livemode", "name", "object", "updated", "version" ], "title": "reporting_report_type", "type": "object", "x-expandableFields": [], "x-resourceId": "reporting.report_type", "x-stripeMostCommon": [ "data_available_end", "data_available_start", "id", "name" ], "x-stripeOperations": [ { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/reporting/report_types" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/reporting/report_types/{report_type}" } ], "x-stripeResource": { "class_name": "ReportType", "has_collection_class": true, "in_package": "Reporting" } }, "reporting.report_type.updated": { "description": "Occurs whenever a `ReportType` is updated (typically to indicate that a new day's data has come available).", "properties": { "object": { "$ref": "#/components/schemas/reporting.report_type" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "reporting.report_type.updated" } }, "reserve_transaction": { "description": "", "properties": { "amount": { "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users.", "maxLength": 5000, "nullable": true, "type": "string" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "reserve_transaction" ], "type": "string" } }, "required": [ "amount", "currency", "description", "id", "object" ], "title": "ReserveTransaction", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "amount", "currency", "description", "id", "object" ], "x-stripeResource": { "class_name": "ReserveTransaction", "in_package": "", "polymorphic_groups": [ "balance_transaction_source" ] } }, "review": { "description": "Reviews can be used to supplement automated fraud detection with human expertise.\n\nLearn more about [Radar](/radar) and reviewing payments\n[here](https://stripe.com/docs/radar/reviews).", "properties": { "billing_zip": { "description": "The ZIP or postal code of the card used, if applicable.", "maxLength": 5000, "nullable": true, "type": "string" }, "charge": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/charge" } ], "description": "The charge associated with this review.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/charge" } ] } }, "closed_reason": { "description": "The reason the review was closed, or null if it has not yet been closed. One of `approved`, `refunded`, `refunded_as_fraud`, `disputed`, `redacted`, `canceled`, `payment_never_settled`, or `acknowledged`.", "enum": [ "acknowledged", "approved", "canceled", "disputed", "payment_never_settled", "redacted", "refunded", "refunded_as_fraud" ], "nullable": true, "type": "string" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "ip_address": { "description": "The IP address where the payment originated.", "maxLength": 5000, "nullable": true, "type": "string" }, "ip_address_location": { "anyOf": [ { "$ref": "#/components/schemas/radar_review_resource_location" } ], "description": "Information related to the location of the payment. Note that this information is an approximation and attempts to locate the nearest population center - it should not be used to determine a specific address.", "nullable": true }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "review" ], "type": "string" }, "open": { "description": "If `true`, the review needs action.", "type": "boolean" }, "opened_reason": { "description": "The reason the review was opened. One of `rule` or `manual`.", "enum": [ "manual", "rule" ], "type": "string" }, "payment_intent": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/payment_intent" } ], "description": "The PaymentIntent ID associated with this review, if one exists.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/payment_intent" } ] } }, "reason": { "description": "The reason the review is currently open or closed. One of `rule`, `manual`, `approved`, `refunded`, `refunded_as_fraud`, `disputed`, `redacted`, `canceled`, `payment_never_settled`, or `acknowledged`.", "maxLength": 5000, "type": "string" }, "session": { "anyOf": [ { "$ref": "#/components/schemas/radar_review_resource_session" } ], "description": "Information related to the browsing session of the user who initiated the payment.", "nullable": true } }, "required": [ "billing_zip", "charge", "closed_reason", "created", "id", "ip_address", "ip_address_location", "livemode", "object", "open", "opened_reason", "reason", "session" ], "title": "RadarReview", "type": "object", "x-expandableFields": [ "charge", "ip_address_location", "payment_intent", "session" ], "x-resourceId": "review", "x-stripeMostCommon": [ "charge", "id", "open", "payment_intent", "reason" ], "x-stripeOperations": [ { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/reviews" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/reviews/{review}" }, { "method_name": "approve", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/reviews/{review}/approve" } ], "x-stripeResource": { "class_name": "Review", "has_collection_class": true, "in_package": "" } }, "review.closed": { "description": "Occurs whenever a review is closed. The review's `reason` field indicates why: `approved`, `disputed`, `refunded`, `refunded_as_fraud`, or `canceled`.", "properties": { "object": { "$ref": "#/components/schemas/review" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "review.closed" } }, "review.opened": { "description": "Occurs whenever a review is opened.", "properties": { "object": { "$ref": "#/components/schemas/review" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "review.opened" } }, "revolut_pay_underlying_payment_method_funding_details": { "description": "", "properties": { "card": { "$ref": "#/components/schemas/payment_method_details_passthrough_card" }, "type": { "description": "funding type of the underlying payment method.", "enum": [ "card" ], "nullable": true, "type": "string" } }, "required": [ "type" ], "title": "revolut_pay_underlying_payment_method_funding_details", "type": "object", "x-expandableFields": [ "card" ], "x-stripeMostCommon": [ "card", "type" ] }, "rule": { "description": "", "properties": { "action": { "description": "The action taken on the payment.", "maxLength": 5000, "type": "string" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "predicate": { "description": "The predicate to evaluate the payment against.", "maxLength": 5000, "type": "string" } }, "required": [ "action", "id", "predicate" ], "title": "RadarRule", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "action", "id", "predicate" ], "x-stripeResource": { "class_name": "Rule", "in_package": "Radar" } }, "scheduled_query_run": { "description": "If you have [scheduled a Sigma query](https://stripe.com/docs/sigma/scheduled-queries), you'll\nreceive a `sigma.scheduled_query_run.created` webhook each time the query\nruns. The webhook contains a `ScheduledQueryRun` object, which you can use to\nretrieve the query results.", "properties": { "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "data_load_time": { "description": "When the query was run, Sigma contained a snapshot of your Stripe data at this time.", "format": "unix-time", "type": "integer" }, "error": { "$ref": "#/components/schemas/sigma_scheduled_query_run_error" }, "file": { "anyOf": [ { "$ref": "#/components/schemas/file" } ], "description": "The file object representing the results of the query.", "nullable": true }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "scheduled_query_run" ], "type": "string" }, "result_available_until": { "description": "Time at which the result expires and is no longer available for download.", "format": "unix-time", "type": "integer" }, "sql": { "description": "SQL for the query.", "maxLength": 100000, "type": "string" }, "status": { "description": "The query's execution status, which will be `completed` for successful runs, and `canceled`, `failed`, or `timed_out` otherwise.", "maxLength": 5000, "type": "string" }, "title": { "description": "Title of the query.", "maxLength": 5000, "type": "string" } }, "required": [ "created", "data_load_time", "file", "id", "livemode", "object", "result_available_until", "sql", "status", "title" ], "title": "ScheduledQueryRun", "type": "object", "x-expandableFields": [ "error", "file" ], "x-resourceId": "scheduled_query_run", "x-stripeMostCommon": [ "data_load_time", "file", "id", "sql", "status", "title" ], "x-stripeOperations": [ { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/sigma/scheduled_query_runs" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/sigma/scheduled_query_runs/{scheduled_query_run}" } ], "x-stripeResource": { "class_name": "ScheduledQueryRun", "has_collection_class": true, "in_package": "Sigma" } }, "schedules_phase_automatic_tax": { "description": "", "properties": { "disabled_reason": { "description": "If Stripe disabled automatic tax, this enum describes why.", "enum": [ "requires_location_inputs" ], "nullable": true, "type": "string" }, "enabled": { "description": "Whether Stripe automatically computes tax on invoices created during this phase.", "type": "boolean" }, "liability": { "anyOf": [ { "$ref": "#/components/schemas/connect_account_reference" } ], "description": "The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.", "nullable": true } }, "required": [ "disabled_reason", "enabled", "liability" ], "title": "SchedulesPhaseAutomaticTax", "type": "object", "x-expandableFields": [ "liability" ], "x-stripeMostCommon": [ "disabled_reason", "enabled", "liability" ] }, "script": { "description": "", "properties": { "configuration": { "description": "The configuration values of the script. The keys and values are specific to the script implementation.", "type": "object" }, "display_name": { "description": "The name of the script used to calculate the discount.", "maxLength": 5000, "type": "string" }, "id": { "description": "The script implementation ID for this coupon.", "maxLength": 5000, "type": "string" } }, "required": [ "configuration", "display_name", "id" ], "title": "Script", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "configuration", "display_name", "id" ] }, "secret_service_resource_scope": { "description": "", "properties": { "type": { "description": "The secret scope type.", "enum": [ "account", "user" ], "type": "string" }, "user": { "description": "The user ID, if type is set to \"user\"", "maxLength": 5000, "type": "string" } }, "required": [ "type" ], "title": "SecretServiceResourceScope", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "type", "user" ] }, "sepa_debit_generated_from": { "description": "", "properties": { "charge": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/charge" } ], "description": "The ID of the Charge that generated this PaymentMethod, if any.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/charge" } ] } }, "setup_attempt": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/setup_attempt" } ], "description": "The ID of the SetupAttempt that generated this PaymentMethod, if any.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/setup_attempt" } ] } } }, "required": [ "charge", "setup_attempt" ], "title": "sepa_debit_generated_from", "type": "object", "x-expandableFields": [ "charge", "setup_attempt" ], "x-stripeMostCommon": [ "charge", "setup_attempt" ] }, "setup_attempt": { "description": "A SetupAttempt describes one attempted confirmation of a SetupIntent,\nwhether that confirmation is successful or unsuccessful. You can use\nSetupAttempts to inspect details of a specific attempt at setting up a\npayment method using a SetupIntent.", "properties": { "application": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/application" } ], "description": "The value of [application](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-application) on the SetupIntent at the time of this confirmation.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/application" } ] } }, "attach_to_self": { "description": "If present, the SetupIntent's payment method will be attached to the in-context Stripe Account.\n\nIt can only be used for this Stripe Account’s own money movement flows like InboundTransfer and OutboundTransfers. It cannot be set to true when setting up a PaymentMethod for a Customer, and defaults to false when attaching a PaymentMethod to a Customer.", "type": "boolean" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "customer": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/customer" }, { "$ref": "#/components/schemas/deleted_customer" } ], "description": "The value of [customer](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-customer) on the SetupIntent at the time of this confirmation.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/customer" }, { "$ref": "#/components/schemas/deleted_customer" } ] } }, "customer_account": { "description": "The value of [customer_account](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-customer_account) on the SetupIntent at the time of this confirmation.", "maxLength": 5000, "nullable": true, "type": "string" }, "flow_directions": { "description": "Indicates the directions of money movement for which this payment method is intended to be used.\n\nInclude `inbound` if you intend to use the payment method as the origin to pull funds from. Include `outbound` if you intend to use the payment method as the destination to send funds to. You can include both if you intend to use the payment method for both purposes.", "items": { "enum": [ "inbound", "outbound" ], "type": "string" }, "nullable": true, "type": "array" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "setup_attempt" ], "type": "string" }, "on_behalf_of": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/account" } ], "description": "The value of [on_behalf_of](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-on_behalf_of) on the SetupIntent at the time of this confirmation.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/account" } ] } }, "payment_method": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/payment_method" } ], "description": "ID of the payment method used with this SetupAttempt.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/payment_method" } ] } }, "payment_method_details": { "$ref": "#/components/schemas/setup_attempt_payment_method_details" }, "setup_error": { "anyOf": [ { "$ref": "#/components/schemas/api_errors" } ], "description": "The error encountered during this attempt to confirm the SetupIntent, if any.", "nullable": true }, "setup_intent": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/setup_intent" } ], "description": "ID of the SetupIntent that this attempt belongs to.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/setup_intent" } ] } }, "status": { "description": "Status of this SetupAttempt, one of `requires_confirmation`, `requires_action`, `processing`, `succeeded`, `failed`, or `abandoned`.", "maxLength": 5000, "type": "string" }, "usage": { "description": "The value of [usage](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-usage) on the SetupIntent at the time of this confirmation, one of `off_session` or `on_session`.", "maxLength": 5000, "type": "string" } }, "required": [ "application", "created", "customer", "flow_directions", "id", "livemode", "object", "on_behalf_of", "payment_method", "payment_method_details", "setup_error", "setup_intent", "status", "usage" ], "title": "PaymentFlowsSetupIntentSetupAttempt", "type": "object", "x-expandableFields": [ "application", "customer", "on_behalf_of", "payment_method", "payment_method_details", "setup_error", "setup_intent" ], "x-resourceId": "setup_attempt", "x-stripeMostCommon": [ "application", "attach_to_self", "created", "customer", "customer_account", "flow_directions", "id", "livemode", "object", "on_behalf_of", "payment_method", "payment_method_details", "setup_error", "setup_intent", "status", "usage" ], "x-stripeOperations": [ { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/setup_attempts" } ], "x-stripeResource": { "class_name": "SetupAttempt", "has_collection_class": true, "in_package": "" } }, "setup_attempt_payment_method_details": { "description": "", "properties": { "acss_debit": { "$ref": "#/components/schemas/setup_attempt_payment_method_details_acss_debit" }, "amazon_pay": { "$ref": "#/components/schemas/setup_attempt_payment_method_details_amazon_pay" }, "au_becs_debit": { "$ref": "#/components/schemas/setup_attempt_payment_method_details_au_becs_debit" }, "bacs_debit": { "$ref": "#/components/schemas/setup_attempt_payment_method_details_bacs_debit" }, "bancontact": { "$ref": "#/components/schemas/setup_attempt_payment_method_details_bancontact" }, "boleto": { "$ref": "#/components/schemas/setup_attempt_payment_method_details_boleto" }, "card": { "$ref": "#/components/schemas/setup_attempt_payment_method_details_card" }, "card_present": { "$ref": "#/components/schemas/setup_attempt_payment_method_details_card_present" }, "cashapp": { "$ref": "#/components/schemas/setup_attempt_payment_method_details_cashapp" }, "id_bank_transfer": { "$ref": "#/components/schemas/setup_attempt_payment_method_details_id_bank_transfer" }, "ideal": { "$ref": "#/components/schemas/setup_attempt_payment_method_details_ideal" }, "kakao_pay": { "$ref": "#/components/schemas/setup_attempt_payment_method_details_kakao_pay" }, "klarna": { "$ref": "#/components/schemas/setup_attempt_payment_method_details_klarna" }, "kr_card": { "$ref": "#/components/schemas/setup_attempt_payment_method_details_kr_card" }, "link": { "$ref": "#/components/schemas/setup_attempt_payment_method_details_link" }, "naver_pay": { "$ref": "#/components/schemas/setup_attempt_payment_method_details_naver_pay" }, "nz_bank_account": { "$ref": "#/components/schemas/setup_attempt_payment_method_details_nz_bank_account" }, "paypal": { "$ref": "#/components/schemas/setup_attempt_payment_method_details_paypal" }, "payto": { "$ref": "#/components/schemas/setup_attempt_payment_method_details_payto" }, "pix": { "$ref": "#/components/schemas/setup_attempt_payment_method_details_pix" }, "revolut_pay": { "$ref": "#/components/schemas/setup_attempt_payment_method_details_revolut_pay" }, "sepa_debit": { "$ref": "#/components/schemas/setup_attempt_payment_method_details_sepa_debit" }, "sofort": { "$ref": "#/components/schemas/setup_attempt_payment_method_details_sofort" }, "stripe_balance": { "$ref": "#/components/schemas/setup_attempt_payment_method_details_stripe_balance" }, "type": { "description": "The type of the payment method used in the SetupIntent (e.g., `card`). An additional hash is included on `payment_method_details` with a name matching this value. It contains confirmation-specific information for the payment method.", "maxLength": 5000, "type": "string" }, "us_bank_account": { "$ref": "#/components/schemas/setup_attempt_payment_method_details_us_bank_account" } }, "required": [ "type" ], "title": "SetupAttemptPaymentMethodDetails", "type": "object", "x-expandableFields": [ "acss_debit", "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", "boleto", "card", "card_present", "cashapp", "id_bank_transfer", "ideal", "kakao_pay", "klarna", "kr_card", "link", "naver_pay", "nz_bank_account", "paypal", "payto", "pix", "revolut_pay", "sepa_debit", "sofort", "stripe_balance", "us_bank_account" ], "x-stripeMostCommon": [ "acss_debit", "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", "boleto", "card", "card_present", "cashapp", "id_bank_transfer", "ideal", "kakao_pay", "klarna", "kr_card", "link", "naver_pay", "nz_bank_account", "paypal", "payto", "pix", "revolut_pay", "sepa_debit", "sofort", "stripe_balance", "type", "us_bank_account" ] }, "setup_attempt_payment_method_details_acss_debit": { "description": "", "properties": {}, "title": "setup_attempt_payment_method_details_acss_debit", "type": "object", "x-expandableFields": [] }, "setup_attempt_payment_method_details_amazon_pay": { "description": "", "properties": {}, "title": "setup_attempt_payment_method_details_amazon_pay", "type": "object", "x-expandableFields": [] }, "setup_attempt_payment_method_details_au_becs_debit": { "description": "", "properties": {}, "title": "setup_attempt_payment_method_details_au_becs_debit", "type": "object", "x-expandableFields": [], "x-stripeResource": { "class_name": "AuBecsDebit", "in_package": "" } }, "setup_attempt_payment_method_details_bacs_debit": { "description": "", "properties": {}, "title": "setup_attempt_payment_method_details_bacs_debit", "type": "object", "x-expandableFields": [] }, "setup_attempt_payment_method_details_bancontact": { "description": "", "properties": { "bank_code": { "description": "Bank code of bank associated with the bank account.", "maxLength": 5000, "nullable": true, "type": "string" }, "bank_name": { "description": "Name of the bank associated with the bank account.", "maxLength": 5000, "nullable": true, "type": "string" }, "bic": { "description": "Bank Identifier Code of the bank associated with the bank account.", "maxLength": 5000, "nullable": true, "type": "string" }, "generated_sepa_debit": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/payment_method" } ], "description": "The ID of the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/payment_method" } ] } }, "generated_sepa_debit_mandate": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/mandate" } ], "description": "The mandate for the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/mandate" } ] } }, "iban_last4": { "description": "Last four characters of the IBAN.", "maxLength": 5000, "nullable": true, "type": "string" }, "preferred_language": { "description": "Preferred language of the Bancontact authorization page that the customer is redirected to.\nCan be one of `en`, `de`, `fr`, or `nl`", "enum": [ "de", "en", "fr", "nl" ], "nullable": true, "type": "string" }, "verified_name": { "description": "Owner's verified full name. Values are verified or provided by Bancontact directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "bank_code", "bank_name", "bic", "generated_sepa_debit", "generated_sepa_debit_mandate", "iban_last4", "preferred_language", "verified_name" ], "title": "setup_attempt_payment_method_details_bancontact", "type": "object", "x-expandableFields": [ "generated_sepa_debit", "generated_sepa_debit_mandate" ], "x-stripeMostCommon": [ "bank_code", "bank_name", "bic", "generated_sepa_debit", "generated_sepa_debit_mandate", "iban_last4", "preferred_language", "verified_name" ], "x-stripeResource": { "class_name": "Bancontact", "in_package": "" } }, "setup_attempt_payment_method_details_boleto": { "description": "", "properties": {}, "title": "setup_attempt_payment_method_details_boleto", "type": "object", "x-expandableFields": [] }, "setup_attempt_payment_method_details_card": { "description": "", "properties": { "brand": { "description": "Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`.", "maxLength": 5000, "nullable": true, "type": "string" }, "checks": { "anyOf": [ { "$ref": "#/components/schemas/setup_attempt_payment_method_details_card_checks" } ], "description": "Check results by Card networks on Card address and CVC at the time of authorization", "nullable": true }, "country": { "description": "Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.", "maxLength": 5000, "nullable": true, "type": "string" }, "description": { "description": "A high-level description of the type of cards issued in this range. (For internal use only and not typically available in standard API requests.)", "maxLength": 5000, "nullable": true, "type": "string" }, "exp_month": { "description": "Two-digit number representing the card's expiration month.", "nullable": true, "type": "integer" }, "exp_year": { "description": "Four-digit number representing the card's expiration year.", "nullable": true, "type": "integer" }, "fingerprint": { "description": "Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.\n\n*As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*", "maxLength": 5000, "nullable": true, "type": "string" }, "funding": { "description": "Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.", "maxLength": 5000, "nullable": true, "type": "string" }, "iin": { "description": "Issuer identification number of the card. (For internal use only and not typically available in standard API requests.)", "maxLength": 5000, "nullable": true, "type": "string" }, "issuer": { "description": "The name of the card's issuing bank. (For internal use only and not typically available in standard API requests.)", "maxLength": 5000, "nullable": true, "type": "string" }, "last4": { "description": "The last four digits of the card.", "maxLength": 5000, "nullable": true, "type": "string" }, "network": { "description": "Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.", "maxLength": 5000, "nullable": true, "type": "string" }, "three_d_secure": { "anyOf": [ { "$ref": "#/components/schemas/three_d_secure_details" } ], "description": "Populated if this authorization used 3D Secure authentication.", "nullable": true }, "wallet": { "anyOf": [ { "$ref": "#/components/schemas/setup_attempt_payment_method_details_card_wallet" } ], "description": "If this Card is part of a card wallet, this contains the details of the card wallet.", "nullable": true } }, "required": [ "brand", "checks", "country", "exp_month", "exp_year", "funding", "last4", "network", "three_d_secure", "wallet" ], "title": "setup_attempt_payment_method_details_card", "type": "object", "x-expandableFields": [ "checks", "three_d_secure", "wallet" ], "x-stripeMostCommon": [ "brand", "checks", "country", "description", "exp_month", "exp_year", "fingerprint", "funding", "iin", "issuer", "last4", "network", "three_d_secure", "wallet" ] }, "setup_attempt_payment_method_details_card_checks": { "description": "", "properties": { "address_line1_check": { "description": "If a address line1 was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.", "maxLength": 5000, "nullable": true, "type": "string" }, "address_postal_code_check": { "description": "If a address postal code was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.", "maxLength": 5000, "nullable": true, "type": "string" }, "cvc_check": { "description": "If a CVC was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "address_line1_check", "address_postal_code_check", "cvc_check" ], "title": "setup_attempt_payment_method_details_card_checks", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "address_line1_check", "address_postal_code_check", "cvc_check" ] }, "setup_attempt_payment_method_details_card_present": { "description": "", "properties": { "generated_card": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/payment_method" } ], "description": "The ID of the Card PaymentMethod which was generated by this SetupAttempt.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/payment_method" } ] } }, "offline": { "anyOf": [ { "$ref": "#/components/schemas/payment_method_details_card_present_offline" } ], "description": "Details about payments collected offline.", "nullable": true } }, "required": [ "generated_card", "offline" ], "title": "setup_attempt_payment_method_details_card_present", "type": "object", "x-expandableFields": [ "generated_card", "offline" ], "x-stripeMostCommon": [ "generated_card", "offline" ], "x-stripeResource": { "class_name": "CardPresent", "in_package": "" } }, "setup_attempt_payment_method_details_card_wallet": { "description": "", "properties": { "apple_pay": { "$ref": "#/components/schemas/payment_method_details_card_wallet_apple_pay" }, "google_pay": { "$ref": "#/components/schemas/payment_method_details_card_wallet_google_pay" }, "type": { "description": "The type of the card wallet, one of `apple_pay`, `google_pay`, or `link`. An additional hash is included on the Wallet subhash with a name matching this value. It contains additional information specific to the card wallet type.", "enum": [ "apple_pay", "google_pay", "link" ], "type": "string" } }, "required": [ "type" ], "title": "setup_attempt_payment_method_details_card_wallet", "type": "object", "x-expandableFields": [ "apple_pay", "google_pay" ], "x-stripeMostCommon": [ "apple_pay", "google_pay", "type" ] }, "setup_attempt_payment_method_details_cashapp": { "description": "", "properties": {}, "title": "setup_attempt_payment_method_details_cashapp", "type": "object", "x-expandableFields": [] }, "setup_attempt_payment_method_details_id_bank_transfer": { "description": "", "properties": { "bank": { "description": "Bank where the account is located.", "enum": [ "bca", "bni", "bri", "cimb", "permata" ], "nullable": true, "type": "string", "x-stripeBypassValidation": true }, "bank_code": { "description": "Local bank code of the bank.", "maxLength": 5000, "nullable": true, "type": "string" }, "bank_name": { "description": "Name of the bank associated with the bank account.", "maxLength": 5000, "nullable": true, "type": "string" }, "display_name": { "description": "Merchant name and billing details name, for the customer to check for the correct merchant when performing the bank transfer.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "bank", "bank_code", "bank_name", "display_name" ], "title": "setup_attempt_payment_method_details_id_bank_transfer", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "bank", "bank_code", "bank_name", "display_name" ], "x-stripeResource": { "class_name": "IdBankTransfer", "in_package": "" } }, "setup_attempt_payment_method_details_ideal": { "description": "", "properties": { "bank": { "description": "The customer's bank. Can be one of `abn_amro`, `asn_bank`, `bunq`, `buut`, `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`.", "enum": [ "abn_amro", "asn_bank", "bunq", "buut", "handelsbanken", "ing", "knab", "moneyou", "n26", "nn", "rabobank", "regiobank", "revolut", "sns_bank", "triodos_bank", "van_lanschot", "yoursafe" ], "nullable": true, "type": "string" }, "bic": { "description": "The Bank Identifier Code of the customer's bank.", "enum": [ "ABNANL2A", "ASNBNL21", "BITSNL2A", "BUNQNL2A", "BUUTNL2A", "FVLBNL22", "HANDNL2A", "INGBNL2A", "KNABNL2H", "MOYONL21", "NNBANL2G", "NTSBDEB1", "RABONL2U", "RBRBNL21", "REVOIE23", "REVOLT21", "SNSBNL2A", "TRIONL2U" ], "nullable": true, "type": "string" }, "generated_sepa_debit": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/payment_method" } ], "description": "The ID of the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/payment_method" } ] } }, "generated_sepa_debit_mandate": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/mandate" } ], "description": "The mandate for the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/mandate" } ] } }, "iban_last4": { "description": "Last four characters of the IBAN.", "maxLength": 5000, "nullable": true, "type": "string" }, "verified_name": { "description": "Owner's verified full name. Values are verified or provided by iDEAL directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "bank", "bic", "generated_sepa_debit", "generated_sepa_debit_mandate", "iban_last4", "verified_name" ], "title": "setup_attempt_payment_method_details_ideal", "type": "object", "x-expandableFields": [ "generated_sepa_debit", "generated_sepa_debit_mandate" ], "x-stripeMostCommon": [ "bank", "bic", "generated_sepa_debit", "generated_sepa_debit_mandate", "iban_last4", "verified_name" ] }, "setup_attempt_payment_method_details_kakao_pay": { "description": "", "properties": {}, "title": "setup_attempt_payment_method_details_kakao_pay", "type": "object", "x-expandableFields": [] }, "setup_attempt_payment_method_details_klarna": { "description": "", "properties": {}, "title": "setup_attempt_payment_method_details_klarna", "type": "object", "x-expandableFields": [] }, "setup_attempt_payment_method_details_kr_card": { "description": "", "properties": {}, "title": "setup_attempt_payment_method_details_kr_card", "type": "object", "x-expandableFields": [] }, "setup_attempt_payment_method_details_link": { "description": "", "properties": {}, "title": "setup_attempt_payment_method_details_link", "type": "object", "x-expandableFields": [] }, "setup_attempt_payment_method_details_naver_pay": { "description": "", "properties": { "buyer_id": { "description": "Uniquely identifies this particular Naver Pay account. You can use this attribute to check whether two Naver Pay accounts are the same.", "maxLength": 5000, "type": "string" } }, "title": "setup_attempt_payment_method_details_naver_pay", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "buyer_id" ] }, "setup_attempt_payment_method_details_nz_bank_account": { "description": "", "properties": {}, "title": "setup_attempt_payment_method_details_nz_bank_account", "type": "object", "x-expandableFields": [], "x-stripeResource": { "class_name": "NzBankAccount", "in_package": "" } }, "setup_attempt_payment_method_details_paypal": { "description": "", "properties": {}, "title": "setup_attempt_payment_method_details_paypal", "type": "object", "x-expandableFields": [] }, "setup_attempt_payment_method_details_payto": { "description": "", "properties": {}, "title": "setup_attempt_payment_method_details_payto", "type": "object", "x-expandableFields": [] }, "setup_attempt_payment_method_details_pix": { "description": "", "properties": {}, "title": "setup_attempt_payment_method_details_pix", "type": "object", "x-expandableFields": [] }, "setup_attempt_payment_method_details_revolut_pay": { "description": "", "properties": {}, "title": "setup_attempt_payment_method_details_revolut_pay", "type": "object", "x-expandableFields": [], "x-stripeResource": { "class_name": "RevolutPay", "in_package": "" } }, "setup_attempt_payment_method_details_sepa_debit": { "description": "", "properties": {}, "title": "setup_attempt_payment_method_details_sepa_debit", "type": "object", "x-expandableFields": [] }, "setup_attempt_payment_method_details_sofort": { "description": "", "properties": { "bank_code": { "description": "Bank code of bank associated with the bank account.", "maxLength": 5000, "nullable": true, "type": "string" }, "bank_name": { "description": "Name of the bank associated with the bank account.", "maxLength": 5000, "nullable": true, "type": "string" }, "bic": { "description": "Bank Identifier Code of the bank associated with the bank account.", "maxLength": 5000, "nullable": true, "type": "string" }, "generated_sepa_debit": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/payment_method" } ], "description": "The ID of the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/payment_method" } ] } }, "generated_sepa_debit_mandate": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/mandate" } ], "description": "The mandate for the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/mandate" } ] } }, "iban_last4": { "description": "Last four characters of the IBAN.", "maxLength": 5000, "nullable": true, "type": "string" }, "preferred_language": { "description": "Preferred language of the Sofort authorization page that the customer is redirected to.\nCan be one of `en`, `de`, `fr`, or `nl`", "enum": [ "de", "en", "fr", "nl" ], "nullable": true, "type": "string" }, "verified_name": { "description": "Owner's verified full name. Values are verified or provided by Sofort directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "bank_code", "bank_name", "bic", "generated_sepa_debit", "generated_sepa_debit_mandate", "iban_last4", "preferred_language", "verified_name" ], "title": "setup_attempt_payment_method_details_sofort", "type": "object", "x-expandableFields": [ "generated_sepa_debit", "generated_sepa_debit_mandate" ], "x-stripeMostCommon": [ "bank_code", "bank_name", "bic", "generated_sepa_debit", "generated_sepa_debit_mandate", "iban_last4", "preferred_language", "verified_name" ] }, "setup_attempt_payment_method_details_stripe_balance": { "description": "", "properties": {}, "title": "setup_attempt_payment_method_details_stripe_balance", "type": "object", "x-expandableFields": [] }, "setup_attempt_payment_method_details_us_bank_account": { "description": "", "properties": {}, "title": "setup_attempt_payment_method_details_us_bank_account", "type": "object", "x-expandableFields": [], "x-stripeResource": { "class_name": "UsBankAccount", "in_package": "" } }, "setup_intent": { "description": "A SetupIntent guides you through the process of setting up and saving a customer's payment credentials for future payments.\nFor example, you can use a SetupIntent to set up and save your customer's card without immediately collecting a payment.\nLater, you can use [PaymentIntents](https://stripe.com/docs/api#payment_intents) to drive the payment flow.\n\nCreate a SetupIntent when you're ready to collect your customer's payment credentials.\nDon't maintain long-lived, unconfirmed SetupIntents because they might not be valid.\nThe SetupIntent transitions through multiple [statuses](https://docs.stripe.com/payments/intents#intent-statuses) as it guides\nyou through the setup process.\n\nSuccessful SetupIntents result in payment credentials that are optimized for future payments.\nFor example, cardholders in [certain regions](https://stripe.com/guides/strong-customer-authentication) might need to be run through\n[Strong Customer Authentication](https://docs.stripe.com/strong-customer-authentication) during payment method collection\nto streamline later [off-session payments](https://docs.stripe.com/payments/setup-intents).\nIf you use the SetupIntent with a [Customer](https://stripe.com/docs/api#setup_intent_object-customer),\nit automatically attaches the resulting payment method to that Customer after successful setup.\nWe recommend using SetupIntents or [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) on\nPaymentIntents to save payment methods to prevent saving invalid or unoptimized payment methods.\n\nBy using SetupIntents, you can reduce friction for your customers, even as regulations change over time.\n\nRelated guide: [Setup Intents API](https://docs.stripe.com/payments/setup-intents)", "properties": { "application": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/application" } ], "description": "ID of the Connect application that created the SetupIntent.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/application" } ] } }, "attach_to_self": { "description": "If present, the SetupIntent's payment method will be attached to the in-context Stripe Account.\n\nIt can only be used for this Stripe Account’s own money movement flows like InboundTransfer and OutboundTransfers. It cannot be set to true when setting up a PaymentMethod for a Customer, and defaults to false when attaching a PaymentMethod to a Customer.", "type": "boolean" }, "automatic_payment_methods": { "anyOf": [ { "$ref": "#/components/schemas/payment_flows_automatic_payment_methods_setup_intent" } ], "description": "Settings for dynamic payment methods compatible with this Setup Intent", "nullable": true }, "cancellation_reason": { "description": "Reason for cancellation of this SetupIntent, one of `abandoned`, `requested_by_customer`, or `duplicate`.", "enum": [ "abandoned", "duplicate", "requested_by_customer" ], "nullable": true, "type": "string" }, "client_secret": { "description": "The client secret of this SetupIntent. Used for client-side retrieval using a publishable key.\n\nThe client secret can be used to complete payment setup from your frontend. It should not be stored, logged, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret.", "maxLength": 5000, "nullable": true, "type": "string" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "customer": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/customer" }, { "$ref": "#/components/schemas/deleted_customer" } ], "description": "ID of the Customer this SetupIntent belongs to, if one exists.\n\nIf present, the SetupIntent's payment method will be attached to the Customer on successful setup. Payment methods attached to other Customers cannot be used with this SetupIntent.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/customer" }, { "$ref": "#/components/schemas/deleted_customer" } ] } }, "customer_account": { "description": "ID of the Account this SetupIntent belongs to, if one exists.\n\nIf present, the SetupIntent's payment method will be attached to the Account on successful setup. Payment methods attached to other Accounts cannot be used with this SetupIntent.", "maxLength": 5000, "nullable": true, "type": "string" }, "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users.", "maxLength": 5000, "nullable": true, "type": "string" }, "flow_directions": { "description": "Indicates the directions of money movement for which this payment method is intended to be used.\n\nInclude `inbound` if you intend to use the payment method as the origin to pull funds from. Include `outbound` if you intend to use the payment method as the destination to send funds to. You can include both if you intend to use the payment method for both purposes.", "items": { "enum": [ "inbound", "outbound" ], "type": "string" }, "nullable": true, "type": "array" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "last_setup_error": { "anyOf": [ { "$ref": "#/components/schemas/api_errors" } ], "description": "The error encountered in the previous SetupIntent confirmation.", "nullable": true }, "latest_attempt": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/setup_attempt" } ], "description": "The most recent SetupAttempt for this SetupIntent.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/setup_attempt" } ] } }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "mandate": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/mandate" } ], "description": "ID of the multi use Mandate generated by the SetupIntent.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/mandate" } ] } }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "nullable": true, "type": "object" }, "next_action": { "anyOf": [ { "$ref": "#/components/schemas/setup_intent_next_action" } ], "description": "If present, this property tells you what actions you need to take in order for your customer to continue payment setup.", "nullable": true }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "setup_intent" ], "type": "string" }, "on_behalf_of": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/account" } ], "description": "The account (if any) for which the setup is intended.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/account" } ] } }, "payment_method": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/payment_method" } ], "description": "ID of the payment method used with this SetupIntent. If the payment method is `card_present` and isn't a digital wallet, then the [generated_card](https://docs.stripe.com/api/setup_attempts/object#setup_attempt_object-payment_method_details-card_present-generated_card) associated with the `latest_attempt` is attached to the Customer instead.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/payment_method" } ] } }, "payment_method_configuration_details": { "anyOf": [ { "$ref": "#/components/schemas/payment_method_config_biz_payment_method_configuration_details" } ], "description": "Information about the [payment method configuration](https://stripe.com/docs/api/payment_method_configurations) used for this Setup Intent.", "nullable": true }, "payment_method_options": { "anyOf": [ { "$ref": "#/components/schemas/setup_intent_payment_method_options" } ], "description": "Payment method-specific configuration for this SetupIntent.", "nullable": true }, "payment_method_types": { "description": "The list of payment method types (e.g. card) that this SetupIntent is allowed to set up. A list of valid payment method types can be found [here](https://docs.stripe.com/api/payment_methods/object#payment_method_object-type).", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "single_use_mandate": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/mandate" } ], "description": "ID of the single_use Mandate generated by the SetupIntent.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/mandate" } ] } }, "status": { "description": "[Status](https://stripe.com/docs/payments/intents#intent-statuses) of this SetupIntent, one of `requires_payment_method`, `requires_confirmation`, `requires_action`, `processing`, `canceled`, or `succeeded`.", "enum": [ "canceled", "processing", "requires_action", "requires_confirmation", "requires_payment_method", "succeeded" ], "type": "string" }, "usage": { "description": "Indicates how the payment method is intended to be used in the future.\n\nUse `on_session` if you intend to only reuse the payment method when the customer is in your checkout flow. Use `off_session` if your customer may or may not be in your checkout flow. If not provided, this value defaults to `off_session`.", "maxLength": 5000, "type": "string" } }, "required": [ "application", "automatic_payment_methods", "cancellation_reason", "client_secret", "created", "customer", "description", "flow_directions", "id", "last_setup_error", "latest_attempt", "livemode", "mandate", "metadata", "next_action", "object", "on_behalf_of", "payment_method", "payment_method_configuration_details", "payment_method_options", "payment_method_types", "single_use_mandate", "status", "usage" ], "title": "SetupIntent", "type": "object", "x-expandableFields": [ "application", "automatic_payment_methods", "customer", "last_setup_error", "latest_attempt", "mandate", "next_action", "on_behalf_of", "payment_method", "payment_method_configuration_details", "payment_method_options", "single_use_mandate" ], "x-resourceId": "setup_intent", "x-stripeMostCommon": [ "automatic_payment_methods", "client_secret", "customer", "description", "id", "last_setup_error", "metadata", "next_action", "payment_method", "status", "usage" ], "x-stripeOperations": [ { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/setup_intents" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/setup_intents/{intent}" }, { "method_name": "create", "method_on": "service", "method_type": "create", "operation": "post", "path": "/v1/setup_intents" }, { "method_name": "update", "method_on": "service", "method_type": "update", "operation": "post", "path": "/v1/setup_intents/{intent}" }, { "method_name": "cancel", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/setup_intents/{intent}/cancel" }, { "method_name": "confirm", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/setup_intents/{intent}/confirm" }, { "method_name": "verify_microdeposits", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/setup_intents/{intent}/verify_microdeposits" } ], "x-stripeResource": { "class_name": "SetupIntent", "has_collection_class": true, "in_package": "" } }, "setup_intent.canceled": { "description": "Occurs when a SetupIntent is canceled.", "properties": { "object": { "$ref": "#/components/schemas/setup_intent" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "setup_intent.canceled" } }, "setup_intent.created": { "description": "Occurs when a new SetupIntent is created.", "properties": { "object": { "$ref": "#/components/schemas/setup_intent" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "setup_intent.created" } }, "setup_intent.requires_action": { "description": "Occurs when a SetupIntent is in requires_action state.", "properties": { "object": { "$ref": "#/components/schemas/setup_intent" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "setup_intent.requires_action" } }, "setup_intent.setup_failed": { "description": "Occurs when a SetupIntent has failed the attempt to setup a payment method.", "properties": { "object": { "$ref": "#/components/schemas/setup_intent" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "setup_intent.setup_failed" } }, "setup_intent.succeeded": { "description": "Occurs when an SetupIntent has successfully setup a payment method.", "properties": { "object": { "$ref": "#/components/schemas/setup_intent" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "setup_intent.succeeded" } }, "setup_intent_next_action": { "description": "", "properties": { "cashapp_handle_redirect_or_display_qr_code": { "$ref": "#/components/schemas/payment_intent_next_action_cashapp_handle_redirect_or_display_qr_code" }, "pix_display_qr_code": { "$ref": "#/components/schemas/setup_intent_next_action_pix_display_qr_code" }, "redirect_to_url": { "$ref": "#/components/schemas/setup_intent_next_action_redirect_to_url" }, "type": { "description": "Type of the next action to perform. Refer to the other child attributes under `next_action` for available values. Examples include: `redirect_to_url`, `use_stripe_sdk`, `alipay_handle_redirect`, `oxxo_display_details`, or `verify_with_microdeposits`.", "maxLength": 5000, "type": "string" }, "use_stripe_sdk": { "description": "When confirming a SetupIntent with Stripe.js, Stripe.js depends on the contents of this dictionary to invoke authentication flows. The shape of the contents is subject to change and is only intended to be used by Stripe.js.", "type": "object" }, "verify_with_microdeposits": { "$ref": "#/components/schemas/setup_intent_next_action_verify_with_microdeposits" } }, "required": [ "type" ], "title": "SetupIntentNextAction", "type": "object", "x-expandableFields": [ "cashapp_handle_redirect_or_display_qr_code", "pix_display_qr_code", "redirect_to_url", "verify_with_microdeposits" ], "x-stripeMostCommon": [ "cashapp_handle_redirect_or_display_qr_code", "pix_display_qr_code", "redirect_to_url", "type", "use_stripe_sdk", "verify_with_microdeposits" ] }, "setup_intent_next_action_pix_display_qr_code": { "description": "", "properties": { "data": { "description": "The raw data string used to generate QR code, it should be used together with QR code library.", "maxLength": 5000, "type": "string" }, "expires_at": { "description": "The date (unix timestamp) when the PIX expires.", "format": "unix-time", "type": "integer" }, "hosted_instructions_url": { "description": "The URL to the hosted pix instructions page, which allows customers to view the pix QR code.", "maxLength": 5000, "type": "string" }, "image_url_png": { "description": "The image_url_png string used to render png QR code", "maxLength": 5000, "type": "string" }, "image_url_svg": { "description": "The image_url_svg string used to render svg QR code", "maxLength": 5000, "type": "string" } }, "title": "SetupIntentNextActionPixDisplayQrCode", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "data", "expires_at", "hosted_instructions_url", "image_url_png", "image_url_svg" ], "x-stripeResource": { "class_name": "SetupIntentPixDisplayQrCode", "in_package": "" } }, "setup_intent_next_action_redirect_to_url": { "description": "", "properties": { "return_url": { "description": "If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion.", "maxLength": 5000, "nullable": true, "type": "string" }, "url": { "description": "The URL you must redirect your customer to in order to authenticate.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "return_url", "url" ], "title": "SetupIntentNextActionRedirectToUrl", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "return_url", "url" ], "x-stripeResource": { "class_name": "NextActionRedirectToUrl", "in_package": "" } }, "setup_intent_next_action_verify_with_microdeposits": { "description": "", "properties": { "arrival_date": { "description": "The timestamp when the microdeposits are expected to land.", "format": "unix-time", "type": "integer" }, "hosted_verification_url": { "description": "The URL for the hosted verification page, which allows customers to verify their bank account.", "maxLength": 5000, "type": "string" }, "microdeposit_type": { "description": "The type of the microdeposit sent to the customer. Used to distinguish between different verification methods.", "enum": [ "amounts", "descriptor_code" ], "nullable": true, "type": "string" } }, "required": [ "arrival_date", "hosted_verification_url", "microdeposit_type" ], "title": "SetupIntentNextActionVerifyWithMicrodeposits", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "arrival_date", "hosted_verification_url", "microdeposit_type" ] }, "setup_intent_payment_method_options": { "description": "", "properties": { "acss_debit": { "$ref": "#/components/schemas/setup_intent_payment_method_options_acss_debit" }, "amazon_pay": { "$ref": "#/components/schemas/setup_intent_payment_method_options_amazon_pay" }, "bacs_debit": { "$ref": "#/components/schemas/setup_intent_payment_method_options_bacs_debit" }, "card": { "$ref": "#/components/schemas/setup_intent_payment_method_options_card" }, "card_present": { "$ref": "#/components/schemas/setup_intent_payment_method_options_card_present" }, "klarna": { "$ref": "#/components/schemas/setup_intent_payment_method_options_klarna" }, "link": { "$ref": "#/components/schemas/setup_intent_payment_method_options_link" }, "paypal": { "$ref": "#/components/schemas/setup_intent_payment_method_options_paypal" }, "payto": { "$ref": "#/components/schemas/setup_intent_payment_method_options_payto" }, "pix": { "$ref": "#/components/schemas/setup_intent_payment_method_options_pix" }, "sepa_debit": { "$ref": "#/components/schemas/setup_intent_payment_method_options_sepa_debit" }, "us_bank_account": { "$ref": "#/components/schemas/setup_intent_payment_method_options_us_bank_account" } }, "title": "SetupIntentPaymentMethodOptions", "type": "object", "x-expandableFields": [ "acss_debit", "amazon_pay", "bacs_debit", "card", "card_present", "klarna", "link", "paypal", "payto", "pix", "sepa_debit", "us_bank_account" ], "x-stripeMostCommon": [ "acss_debit", "amazon_pay", "bacs_debit", "card", "card_present", "klarna", "link", "paypal", "payto", "pix", "sepa_debit", "us_bank_account" ] }, "setup_intent_payment_method_options_acss_debit": { "description": "", "properties": { "currency": { "description": "Currency supported by the bank account", "enum": [ "cad", "usd" ], "nullable": true, "type": "string" }, "mandate_options": { "$ref": "#/components/schemas/setup_intent_payment_method_options_mandate_options_acss_debit" }, "verification_method": { "description": "Bank account verification method.", "enum": [ "automatic", "instant", "microdeposits" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "currency" ], "title": "setup_intent_payment_method_options_acss_debit", "type": "object", "x-expandableFields": [ "mandate_options" ], "x-stripeMostCommon": [ "currency", "mandate_options", "verification_method" ] }, "setup_intent_payment_method_options_amazon_pay": { "description": "", "properties": {}, "title": "setup_intent_payment_method_options_amazon_pay", "type": "object", "x-expandableFields": [] }, "setup_intent_payment_method_options_bacs_debit": { "description": "", "properties": { "mandate_options": { "$ref": "#/components/schemas/setup_intent_payment_method_options_mandate_options_bacs_debit" } }, "title": "setup_intent_payment_method_options_bacs_debit", "type": "object", "x-expandableFields": [ "mandate_options" ], "x-stripeMostCommon": [ "mandate_options" ] }, "setup_intent_payment_method_options_card": { "description": "", "properties": { "mandate_options": { "anyOf": [ { "$ref": "#/components/schemas/setup_intent_payment_method_options_card_mandate_options" } ], "description": "Configuration options for setting up an eMandate for cards issued in India.", "nullable": true }, "network": { "description": "Selected network to process this SetupIntent on. Depends on the available networks of the card attached to the setup intent. Can be only set confirm-time.", "enum": [ "amex", "cartes_bancaires", "diners", "discover", "eftpos_au", "girocard", "interac", "jcb", "link", "mastercard", "unionpay", "unknown", "visa" ], "nullable": true, "type": "string" }, "request_three_d_secure": { "description": "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.", "enum": [ "any", "automatic", "challenge" ], "nullable": true, "type": "string", "x-stripeBypassValidation": true } }, "required": [ "mandate_options", "network", "request_three_d_secure" ], "title": "setup_intent_payment_method_options_card", "type": "object", "x-expandableFields": [ "mandate_options" ], "x-stripeMostCommon": [ "mandate_options", "network", "request_three_d_secure" ] }, "setup_intent_payment_method_options_card_mandate_options": { "description": "", "properties": { "amount": { "description": "Amount to be charged for future payments.", "type": "integer" }, "amount_type": { "description": "One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.", "enum": [ "fixed", "maximum" ], "type": "string" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "description": { "description": "A description of the mandate or subscription that is meant to be displayed to the customer.", "maxLength": 200, "nullable": true, "type": "string" }, "end_date": { "description": "End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.", "format": "unix-time", "nullable": true, "type": "integer" }, "interval": { "description": "Specifies payment frequency. One of `day`, `week`, `month`, `year`, or `sporadic`.", "enum": [ "day", "month", "sporadic", "week", "year" ], "type": "string" }, "interval_count": { "description": "The number of intervals between payments. For example, `interval=month` and `interval_count=3` indicates one payment every three months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). This parameter is optional when `interval=sporadic`.", "nullable": true, "type": "integer" }, "reference": { "description": "Unique identifier for the mandate or subscription.", "maxLength": 80, "type": "string" }, "start_date": { "description": "Start date of the mandate or subscription. Start date should not be lesser than yesterday.", "format": "unix-time", "type": "integer" }, "supported_types": { "description": "Specifies the type of mandates supported. Possible values are `india`.", "items": { "enum": [ "india" ], "type": "string" }, "nullable": true, "type": "array" } }, "required": [ "amount", "amount_type", "currency", "description", "end_date", "interval", "interval_count", "reference", "start_date", "supported_types" ], "title": "setup_intent_payment_method_options_card_mandate_options", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "amount", "amount_type", "currency", "description", "end_date", "interval", "interval_count", "reference", "start_date", "supported_types" ], "x-stripeResource": { "class_name": "MandateOptions", "in_package": "" } }, "setup_intent_payment_method_options_card_present": { "description": "", "properties": {}, "title": "setup_intent_payment_method_options_card_present", "type": "object", "x-expandableFields": [] }, "setup_intent_payment_method_options_klarna": { "description": "", "properties": { "currency": { "description": "The currency of the setup intent. Three letter ISO currency code.", "format": "currency", "nullable": true, "type": "string" }, "preferred_locale": { "description": "Preferred locale of the Klarna checkout page that the customer is redirected to.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "currency", "preferred_locale" ], "title": "setup_intent_payment_method_options_klarna", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "currency", "preferred_locale" ] }, "setup_intent_payment_method_options_link": { "description": "", "properties": { "persistent_token": { "description": "[Deprecated] This is a legacy parameter that no longer has any function.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "persistent_token" ], "title": "setup_intent_payment_method_options_link", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "persistent_token" ] }, "setup_intent_payment_method_options_mandate_options_acss_debit": { "description": "", "properties": { "custom_mandate_url": { "description": "A URL for custom mandate text", "maxLength": 5000, "type": "string" }, "default_for": { "description": "List of Stripe products where this mandate can be selected automatically.", "items": { "enum": [ "invoice", "subscription" ], "type": "string" }, "type": "array" }, "interval_description": { "description": "Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'.", "maxLength": 5000, "nullable": true, "type": "string" }, "payment_schedule": { "description": "Payment schedule for the mandate.", "enum": [ "combined", "interval", "sporadic" ], "nullable": true, "type": "string" }, "transaction_type": { "description": "Transaction type of the mandate.", "enum": [ "business", "personal" ], "nullable": true, "type": "string" } }, "required": [ "interval_description", "payment_schedule", "transaction_type" ], "title": "setup_intent_payment_method_options_mandate_options_acss_debit", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "custom_mandate_url", "default_for", "interval_description", "payment_schedule", "transaction_type" ] }, "setup_intent_payment_method_options_mandate_options_bacs_debit": { "description": "", "properties": { "reference_prefix": { "description": "Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'.", "maxLength": 5000, "type": "string" } }, "title": "setup_intent_payment_method_options_mandate_options_bacs_debit", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "reference_prefix" ], "x-stripeResource": { "class_name": "BacsDebitMandateOptions", "in_package": "" } }, "setup_intent_payment_method_options_mandate_options_payto": { "description": "", "properties": { "amount": { "description": "Amount that will be collected. It is required when `amount_type` is `fixed`.", "nullable": true, "type": "integer" }, "amount_type": { "description": "The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively.", "enum": [ "fixed", "maximum" ], "nullable": true, "type": "string" }, "end_date": { "description": "Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.", "maxLength": 5000, "nullable": true, "type": "string" }, "payment_schedule": { "description": "The periodicity at which payments will be collected.", "enum": [ "adhoc", "annual", "daily", "fortnightly", "monthly", "quarterly", "semi_annual", "weekly" ], "nullable": true, "type": "string" }, "payments_per_period": { "description": "The number of payments that will be made during a payment period. Defaults to 1 except for when `payment_schedule` is `adhoc`. In that case, it defaults to no limit.", "nullable": true, "type": "integer" }, "purpose": { "description": "The purpose for which payments are made. Defaults to retail.", "enum": [ "dependant_support", "government", "loan", "mortgage", "other", "pension", "personal", "retail", "salary", "tax", "utility" ], "nullable": true, "type": "string" }, "start_date": { "description": "Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "amount", "amount_type", "end_date", "payment_schedule", "payments_per_period", "purpose", "start_date" ], "title": "setup_intent_payment_method_options_mandate_options_payto", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "amount", "amount_type", "end_date", "payment_schedule", "payments_per_period", "purpose", "start_date" ] }, "setup_intent_payment_method_options_mandate_options_sepa_debit": { "description": "", "properties": { "reference_prefix": { "description": "Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'.", "maxLength": 5000, "type": "string" } }, "title": "setup_intent_payment_method_options_mandate_options_sepa_debit", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "reference_prefix" ], "x-stripeResource": { "class_name": "SepaDebitMandateOptions", "in_package": "" } }, "setup_intent_payment_method_options_paypal": { "description": "", "properties": { "billing_agreement_id": { "description": "The PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer.", "maxLength": 5000, "nullable": true, "type": "string" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "maxLength": 5000, "nullable": true, "type": "string" }, "subsellers": { "description": "The Stripe connected account IDs of the sellers on the platform for this transaction (optional). Only allowed when [separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers) are used.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "required": [ "billing_agreement_id" ], "title": "setup_intent_payment_method_options_paypal", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "billing_agreement_id", "currency", "subsellers" ] }, "setup_intent_payment_method_options_payto": { "description": "", "properties": { "mandate_options": { "$ref": "#/components/schemas/setup_intent_payment_method_options_mandate_options_payto" } }, "title": "setup_intent_payment_method_options_payto", "type": "object", "x-expandableFields": [ "mandate_options" ], "x-stripeMostCommon": [ "mandate_options" ] }, "setup_intent_payment_method_options_pix": { "description": "", "properties": { "mandate_options": { "$ref": "#/components/schemas/payment_method_options_mandate_options_pix" } }, "title": "setup_intent_payment_method_options_pix", "type": "object", "x-expandableFields": [ "mandate_options" ], "x-stripeMostCommon": [ "mandate_options" ] }, "setup_intent_payment_method_options_sepa_debit": { "description": "", "properties": { "mandate_options": { "$ref": "#/components/schemas/setup_intent_payment_method_options_mandate_options_sepa_debit" } }, "title": "setup_intent_payment_method_options_sepa_debit", "type": "object", "x-expandableFields": [ "mandate_options" ], "x-stripeMostCommon": [ "mandate_options" ] }, "setup_intent_payment_method_options_us_bank_account": { "description": "", "properties": { "financial_connections": { "$ref": "#/components/schemas/linked_account_options_common" }, "mandate_options": { "$ref": "#/components/schemas/payment_method_options_us_bank_account_mandate_options" }, "verification_method": { "description": "Bank account verification method.", "enum": [ "automatic", "instant", "microdeposits" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "setup_intent_payment_method_options_us_bank_account", "type": "object", "x-expandableFields": [ "financial_connections", "mandate_options" ], "x-stripeMostCommon": [ "financial_connections", "mandate_options", "verification_method" ] }, "setup_intent_type_specific_payment_method_options_client": { "description": "", "properties": { "verification_method": { "description": "Bank account verification method.", "enum": [ "automatic", "instant", "microdeposits" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "SetupIntentTypeSpecificPaymentMethodOptionsClient", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "verification_method" ] }, "shipping": { "description": "", "properties": { "address": { "$ref": "#/components/schemas/address" }, "carrier": { "description": "The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.", "maxLength": 5000, "nullable": true, "type": "string" }, "name": { "description": "Recipient name.", "maxLength": 5000, "type": "string" }, "phone": { "description": "Recipient phone (including extension).", "maxLength": 5000, "nullable": true, "type": "string" }, "tracking_number": { "description": "The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "Shipping", "type": "object", "x-expandableFields": [ "address" ], "x-stripeMostCommon": [ "address", "carrier", "name", "phone", "tracking_number" ], "x-stripeResource": { "class_name": "ShippingDetails", "in_package": "" } }, "shipping_rate": { "description": "Shipping rates describe the price of shipping presented to your customers and\napplied to a purchase. For more information, see [Charge for shipping](https://stripe.com/docs/payments/during-payment/charge-shipping).", "properties": { "active": { "description": "Whether the shipping rate can be used for new purchases. Defaults to `true`.", "type": "boolean" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "delivery_estimate": { "anyOf": [ { "$ref": "#/components/schemas/shipping_rate_delivery_estimate" } ], "description": "The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.", "nullable": true }, "display_name": { "description": "The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.", "maxLength": 5000, "nullable": true, "type": "string" }, "fixed_amount": { "$ref": "#/components/schemas/shipping_rate_fixed_amount" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "type": "object" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "shipping_rate" ], "type": "string" }, "tax_behavior": { "description": "Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.", "enum": [ "exclusive", "inclusive", "unspecified" ], "nullable": true, "type": "string" }, "tax_code": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/tax_code" } ], "description": "A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/tax_code" } ] } }, "type": { "description": "The type of calculation to use on the shipping rate.", "enum": [ "fixed_amount" ], "type": "string" } }, "required": [ "active", "created", "delivery_estimate", "display_name", "id", "livemode", "metadata", "object", "tax_behavior", "tax_code", "type" ], "title": "ShippingRate", "type": "object", "x-expandableFields": [ "delivery_estimate", "fixed_amount", "tax_code" ], "x-resourceId": "shipping_rate", "x-stripeMostCommon": [ "active", "display_name", "fixed_amount", "id", "metadata", "tax_behavior", "tax_code", "type" ], "x-stripeOperations": [ { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/shipping_rates" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/shipping_rates/{shipping_rate_token}" }, { "method_name": "create", "method_on": "service", "method_type": "create", "operation": "post", "path": "/v1/shipping_rates" }, { "method_name": "update", "method_on": "service", "method_type": "update", "operation": "post", "path": "/v1/shipping_rates/{shipping_rate_token}" } ], "x-stripeResource": { "class_name": "ShippingRate", "has_collection_class": true, "in_package": "" } }, "shipping_rate_currency_option": { "description": "", "properties": { "amount": { "description": "A non-negative integer in cents representing how much to charge.", "type": "integer" }, "tax_behavior": { "description": "Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.", "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" } }, "required": [ "amount", "tax_behavior" ], "title": "ShippingRateCurrencyOption", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "amount", "tax_behavior" ] }, "shipping_rate_delivery_estimate": { "description": "", "properties": { "maximum": { "anyOf": [ { "$ref": "#/components/schemas/shipping_rate_delivery_estimate_bound" } ], "description": "The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.", "nullable": true }, "minimum": { "anyOf": [ { "$ref": "#/components/schemas/shipping_rate_delivery_estimate_bound" } ], "description": "The lower bound of the estimated range. If empty, represents no lower bound.", "nullable": true } }, "required": [ "maximum", "minimum" ], "title": "ShippingRateDeliveryEstimate", "type": "object", "x-expandableFields": [ "maximum", "minimum" ], "x-stripeMostCommon": [ "maximum", "minimum" ] }, "shipping_rate_delivery_estimate_bound": { "description": "", "properties": { "unit": { "description": "A unit of time.", "enum": [ "business_day", "day", "hour", "month", "week" ], "type": "string" }, "value": { "description": "Must be greater than 0.", "type": "integer" } }, "required": [ "unit", "value" ], "title": "ShippingRateDeliveryEstimateBound", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "unit", "value" ] }, "shipping_rate_fixed_amount": { "description": "", "properties": { "amount": { "description": "A non-negative integer in cents representing how much to charge.", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "currency_options": { "additionalProperties": { "$ref": "#/components/schemas/shipping_rate_currency_option" }, "description": "Shipping rates defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).", "type": "object" } }, "required": [ "amount", "currency" ], "title": "ShippingRateFixedAmount", "type": "object", "x-expandableFields": [ "currency_options" ], "x-stripeMostCommon": [ "amount", "currency", "currency_options" ] }, "sigma.scheduled_query_run.created": { "description": "Occurs whenever a Sigma scheduled query run finishes.", "properties": { "object": { "$ref": "#/components/schemas/scheduled_query_run" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "sigma.scheduled_query_run.created" } }, "sigma_scheduled_query_run_error": { "description": "", "properties": { "message": { "description": "Information about the run failure.", "maxLength": 5000, "type": "string" } }, "required": [ "message" ], "title": "SigmaScheduledQueryRunError", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "message" ] }, "source": { "description": "`Source` objects allow you to accept a variety of payment methods. They\nrepresent a customer's payment instrument, and can be used with the Stripe API\njust like a `Card` object: once chargeable, they can be charged, or can be\nattached to customers.\n\nStripe doesn't recommend using the deprecated [Sources API](https://stripe.com/docs/api/sources).\nWe recommend that you adopt the [PaymentMethods API](https://stripe.com/docs/api/payment_methods).\nThis newer API provides access to our latest features and payment method types.\n\nRelated guides: [Sources API](https://stripe.com/docs/sources) and [Sources & Customers](https://stripe.com/docs/sources/customers).", "properties": { "ach_credit_transfer": { "$ref": "#/components/schemas/source_type_ach_credit_transfer" }, "ach_debit": { "$ref": "#/components/schemas/source_type_ach_debit" }, "acss_debit": { "$ref": "#/components/schemas/source_type_acss_debit" }, "alipay": { "$ref": "#/components/schemas/source_type_alipay" }, "allow_redisplay": { "description": "This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to “unspecified”.", "enum": [ "always", "limited", "unspecified" ], "nullable": true, "type": "string" }, "amount": { "description": "A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount associated with the source. This is the amount for which the source will be chargeable once ready. Required for `single_use` sources.", "nullable": true, "type": "integer" }, "au_becs_debit": { "$ref": "#/components/schemas/source_type_au_becs_debit" }, "bancontact": { "$ref": "#/components/schemas/source_type_bancontact" }, "card": { "$ref": "#/components/schemas/source_type_card" }, "card_present": { "$ref": "#/components/schemas/source_type_card_present" }, "client_secret": { "description": "The client secret of the source. Used for client-side retrieval using a publishable key.", "maxLength": 5000, "type": "string" }, "code_verification": { "$ref": "#/components/schemas/source_code_verification_flow" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "currency": { "description": "Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) associated with the source. This is the currency for which the source will be chargeable once ready. Required for `single_use` sources.", "format": "currency", "nullable": true, "type": "string" }, "customer": { "description": "The ID of the customer to which this source is attached. This will not be present when the source has not been attached to a customer.", "maxLength": 5000, "type": "string" }, "eps": { "$ref": "#/components/schemas/source_type_eps" }, "flow": { "description": "The authentication `flow` of the source. `flow` is one of `redirect`, `receiver`, `code_verification`, `none`.", "maxLength": 5000, "type": "string" }, "giropay": { "$ref": "#/components/schemas/source_type_giropay" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "ideal": { "$ref": "#/components/schemas/source_type_ideal" }, "klarna": { "$ref": "#/components/schemas/source_type_klarna" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "nullable": true, "type": "object" }, "multibanco": { "$ref": "#/components/schemas/source_type_multibanco" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "source" ], "type": "string" }, "owner": { "anyOf": [ { "$ref": "#/components/schemas/source_owner" } ], "description": "Information about the owner of the payment instrument that may be used or required by particular source types.", "nullable": true }, "p24": { "$ref": "#/components/schemas/source_type_p24" }, "paypal": { "$ref": "#/components/schemas/source_type_paypal" }, "receiver": { "$ref": "#/components/schemas/source_receiver_flow" }, "redirect": { "$ref": "#/components/schemas/source_redirect_flow" }, "sepa_credit_transfer": { "$ref": "#/components/schemas/source_type_sepa_credit_transfer" }, "sepa_debit": { "$ref": "#/components/schemas/source_type_sepa_debit" }, "sofort": { "$ref": "#/components/schemas/source_type_sofort" }, "source_order": { "$ref": "#/components/schemas/source_order" }, "statement_descriptor": { "description": "Extra information about a source. This will appear on your customer's statement every time you charge the source.", "maxLength": 5000, "nullable": true, "type": "string" }, "status": { "description": "The status of the source, one of `canceled`, `chargeable`, `consumed`, `failed`, or `pending`. Only `chargeable` sources can be used to create a charge.", "maxLength": 5000, "type": "string" }, "three_d_secure": { "$ref": "#/components/schemas/source_type_three_d_secure" }, "type": { "description": "The `type` of the source. The `type` is a payment method, one of `ach_credit_transfer`, `ach_debit`, `alipay`, `bancontact`, `card`, `card_present`, `eps`, `giropay`, `ideal`, `multibanco`, `klarna`, `p24`, `sepa_debit`, `sofort`, `three_d_secure`, or `wechat`. An additional hash is included on the source with a name matching this value. It contains additional information specific to the [payment method](https://stripe.com/docs/sources) used.", "enum": [ "ach_credit_transfer", "ach_debit", "acss_debit", "alipay", "au_becs_debit", "bancontact", "card", "card_present", "eps", "giropay", "ideal", "klarna", "multibanco", "p24", "paypal", "sepa_credit_transfer", "sepa_debit", "sofort", "three_d_secure", "wechat" ], "type": "string", "x-stripeBypassValidation": true }, "usage": { "description": "Either `reusable` or `single_use`. Whether this source should be reusable or not. Some source types may or may not be reusable by construction, while others may leave the option at creation. If an incompatible value is passed, an error will be returned.", "maxLength": 5000, "nullable": true, "type": "string" }, "wechat": { "$ref": "#/components/schemas/source_type_wechat" } }, "required": [ "allow_redisplay", "amount", "client_secret", "created", "currency", "flow", "id", "livemode", "metadata", "object", "owner", "statement_descriptor", "status", "type", "usage" ], "title": "Source", "type": "object", "x-expandableFields": [ "code_verification", "owner", "receiver", "redirect", "source_order" ], "x-resourceId": "source", "x-stripeMostCommon": [ "amount", "currency", "customer", "id", "metadata", "owner", "redirect", "statement_descriptor", "status", "type" ], "x-stripeOperations": [ { "method_name": "detach", "method_on": "service", "method_type": "custom", "operation": "delete", "path": "/v1/customers/{customer}/sources/{id}" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/sources/{source}" }, { "method_name": "source_transactions", "method_on": "service", "method_type": "custom", "operation": "get", "path": "/v1/sources/{source}/source_transactions" }, { "method_name": "create", "method_on": "service", "method_type": "create", "operation": "post", "path": "/v1/sources" }, { "method_name": "update", "method_on": "service", "method_type": "update", "operation": "post", "path": "/v1/sources/{source}" }, { "method_name": "verify", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/sources/{source}/verify" } ], "x-stripeResource": { "class_name": "Source", "in_package": "", "polymorphic_groups": [ "deleted_payment_source", "payment_source" ] } }, "source.canceled": { "description": "Occurs whenever a source is canceled.", "properties": { "object": { "$ref": "#/components/schemas/source" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "source.canceled" } }, "source.chargeable": { "description": "Occurs whenever a source transitions to chargeable.", "properties": { "object": { "$ref": "#/components/schemas/source" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "source.chargeable" } }, "source.failed": { "description": "Occurs whenever a source fails.", "properties": { "object": { "$ref": "#/components/schemas/source" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "source.failed" } }, "source.mandate_notification": { "description": "Occurs whenever a source mandate notification method is set to manual.", "properties": { "object": { "$ref": "#/components/schemas/source_mandate_notification" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "source.mandate_notification" } }, "source.refund_attributes_required": { "description": "Occurs whenever the refund attributes are required on a receiver source to process a refund or a mispayment.", "properties": { "object": { "$ref": "#/components/schemas/source" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "source.refund_attributes_required" } }, "source.transaction.created": { "description": "Occurs whenever a source transaction is created.", "properties": { "object": { "$ref": "#/components/schemas/source_transaction" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "source.transaction.created" } }, "source.transaction.updated": { "description": "Occurs whenever a source transaction is updated.", "properties": { "object": { "$ref": "#/components/schemas/source_transaction" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "source.transaction.updated" } }, "source_code_verification_flow": { "description": "", "properties": { "attempts_remaining": { "description": "The number of attempts remaining to authenticate the source object with a verification code.", "type": "integer" }, "status": { "description": "The status of the code verification, either `pending` (awaiting verification, `attempts_remaining` should be greater than 0), `succeeded` (successful verification) or `failed` (failed verification, cannot be verified anymore as `attempts_remaining` should be 0).", "maxLength": 5000, "type": "string" } }, "required": [ "attempts_remaining", "status" ], "title": "SourceCodeVerificationFlow", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "attempts_remaining", "status" ] }, "source_mandate_notification": { "description": "Source mandate notifications should be created when a notification related to\na source mandate must be sent to the payer. They will trigger a webhook or\ndeliver an email to the customer.", "properties": { "acss_debit": { "$ref": "#/components/schemas/source_mandate_notification_acss_debit_data" }, "amount": { "description": "A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the amount associated with the mandate notification. The amount is expressed in the currency of the underlying source. Required if the notification type is `debit_initiated`.", "nullable": true, "type": "integer" }, "bacs_debit": { "$ref": "#/components/schemas/source_mandate_notification_bacs_debit_data" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "source_mandate_notification" ], "type": "string" }, "reason": { "description": "The reason of the mandate notification. Valid reasons are `mandate_confirmed` or `debit_initiated`.", "maxLength": 5000, "type": "string" }, "sepa_debit": { "$ref": "#/components/schemas/source_mandate_notification_sepa_debit_data" }, "source": { "$ref": "#/components/schemas/source" }, "status": { "description": "The status of the mandate notification. Valid statuses are `pending` or `submitted`.", "maxLength": 5000, "type": "string" }, "type": { "description": "The type of source this mandate notification is attached to. Should be the source type identifier code for the payment method, such as `three_d_secure`.", "maxLength": 5000, "type": "string" } }, "required": [ "amount", "created", "id", "livemode", "object", "reason", "source", "status", "type" ], "title": "SourceMandateNotification", "type": "object", "x-expandableFields": [ "acss_debit", "bacs_debit", "sepa_debit", "source" ], "x-stripeMostCommon": [ "acss_debit", "amount", "bacs_debit", "created", "id", "livemode", "object", "reason", "sepa_debit", "source", "status", "type" ], "x-stripeResource": { "class_name": "SourceMandateNotification", "in_package": "" } }, "source_mandate_notification_acss_debit_data": { "description": "", "properties": { "statement_descriptor": { "description": "The statement descriptor associate with the debit.", "maxLength": 5000, "type": "string" } }, "title": "SourceMandateNotificationAcssDebitData", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "statement_descriptor" ] }, "source_mandate_notification_bacs_debit_data": { "description": "", "properties": { "last4": { "description": "Last 4 digits of the account number associated with the debit.", "maxLength": 5000, "type": "string" } }, "title": "SourceMandateNotificationBacsDebitData", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "last4" ] }, "source_mandate_notification_sepa_debit_data": { "description": "", "properties": { "creditor_identifier": { "description": "SEPA creditor ID.", "maxLength": 5000, "type": "string" }, "last4": { "description": "Last 4 digits of the account number associated with the debit.", "maxLength": 5000, "type": "string" }, "mandate_reference": { "description": "Mandate reference associated with the debit.", "maxLength": 5000, "type": "string" } }, "title": "SourceMandateNotificationSepaDebitData", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "creditor_identifier", "last4", "mandate_reference" ] }, "source_order": { "description": "", "properties": { "amount": { "description": "A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount for the order.", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "email": { "description": "The email address of the customer placing the order.", "maxLength": 5000, "type": "string" }, "items": { "description": "List of items constituting the order.", "items": { "$ref": "#/components/schemas/source_order_item" }, "nullable": true, "type": "array" }, "shipping": { "$ref": "#/components/schemas/shipping" } }, "required": [ "amount", "currency", "items" ], "title": "SourceOrder", "type": "object", "x-expandableFields": [ "items", "shipping" ], "x-stripeMostCommon": [ "amount", "currency", "email", "items", "shipping" ] }, "source_order_item": { "description": "", "properties": { "amount": { "description": "The amount (price) for this order item.", "nullable": true, "type": "integer" }, "currency": { "description": "This currency of this order item. Required when `amount` is present.", "maxLength": 5000, "nullable": true, "type": "string" }, "description": { "description": "Human-readable description for this order item.", "maxLength": 5000, "nullable": true, "type": "string" }, "parent": { "description": "The ID of the associated object for this line item. Expandable if not null (e.g., expandable to a SKU).", "maxLength": 5000, "nullable": true, "type": "string" }, "quantity": { "description": "The quantity of this order item. When type is `sku`, this is the number of instances of the SKU to be ordered.", "type": "integer" }, "type": { "description": "The type of this order item. Must be `sku`, `tax`, or `shipping`.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "amount", "currency", "description", "parent", "type" ], "title": "SourceOrderItem", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "amount", "currency", "description", "parent", "quantity", "type" ] }, "source_owner": { "description": "", "properties": { "address": { "anyOf": [ { "$ref": "#/components/schemas/address" } ], "description": "Owner's address.", "nullable": true }, "email": { "description": "Owner's email address.", "maxLength": 5000, "nullable": true, "type": "string" }, "name": { "description": "Owner's full name.", "maxLength": 5000, "nullable": true, "type": "string" }, "phone": { "description": "Owner's phone number (including extension).", "maxLength": 5000, "nullable": true, "type": "string" }, "verified_address": { "anyOf": [ { "$ref": "#/components/schemas/address" } ], "description": "Verified owner's address. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated.", "nullable": true }, "verified_email": { "description": "Verified owner's email address. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated.", "maxLength": 5000, "nullable": true, "type": "string" }, "verified_name": { "description": "Verified owner's full name. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated.", "maxLength": 5000, "nullable": true, "type": "string" }, "verified_phone": { "description": "Verified owner's phone number (including extension). Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "address", "email", "name", "phone", "verified_address", "verified_email", "verified_name", "verified_phone" ], "title": "SourceOwner", "type": "object", "x-expandableFields": [ "address", "verified_address" ], "x-stripeMostCommon": [ "address", "email", "name", "phone", "verified_address", "verified_email", "verified_name", "verified_phone" ] }, "source_receiver_flow": { "description": "", "properties": { "address": { "description": "The address of the receiver source. This is the value that should be communicated to the customer to send their funds to.", "maxLength": 5000, "nullable": true, "type": "string" }, "amount_charged": { "description": "The total amount that was moved to your balance. This is almost always equal to the amount charged. In rare cases when customers deposit excess funds and we are unable to refund those, those funds get moved to your balance and show up in amount_charged as well. The amount charged is expressed in the source's currency.", "type": "integer" }, "amount_received": { "description": "The total amount received by the receiver source. `amount_received = amount_returned + amount_charged` should be true for consumed sources unless customers deposit excess funds. The amount received is expressed in the source's currency.", "type": "integer" }, "amount_returned": { "description": "The total amount that was returned to the customer. The amount returned is expressed in the source's currency.", "type": "integer" }, "refund_attributes_method": { "description": "Type of refund attribute method, one of `email`, `manual`, or `none`.", "maxLength": 5000, "type": "string" }, "refund_attributes_status": { "description": "Type of refund attribute status, one of `missing`, `requested`, or `available`.", "maxLength": 5000, "type": "string" } }, "required": [ "address", "amount_charged", "amount_received", "amount_returned", "refund_attributes_method", "refund_attributes_status" ], "title": "SourceReceiverFlow", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "address", "amount_charged", "amount_received", "amount_returned", "refund_attributes_method", "refund_attributes_status" ] }, "source_redirect_flow": { "description": "", "properties": { "failure_reason": { "description": "The failure reason for the redirect, either `user_abort` (the customer aborted or dropped out of the redirect flow), `declined` (the authentication failed or the transaction was declined), or `processing_error` (the redirect failed due to a technical error). Present only if the redirect status is `failed`.", "maxLength": 5000, "nullable": true, "type": "string" }, "return_url": { "description": "The URL you provide to redirect the customer to after they authenticated their payment.", "maxLength": 5000, "type": "string" }, "status": { "description": "The status of the redirect, either `pending` (ready to be used by your customer to authenticate the transaction), `succeeded` (succesful authentication, cannot be reused) or `not_required` (redirect should not be used) or `failed` (failed authentication, cannot be reused).", "maxLength": 5000, "type": "string" }, "url": { "description": "The URL provided to you to redirect a customer to as part of a `redirect` authentication flow.", "maxLength": 2048, "type": "string" } }, "required": [ "failure_reason", "return_url", "status", "url" ], "title": "SourceRedirectFlow", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "failure_reason", "return_url", "status", "url" ] }, "source_transaction": { "description": "Some payment methods have no required amount that a customer must send.\nCustomers can be instructed to send any amount, and it can be made up of\nmultiple transactions. As such, sources can have multiple associated\ntransactions.", "properties": { "ach_credit_transfer": { "$ref": "#/components/schemas/source_transaction_ach_credit_transfer_data" }, "amount": { "description": "A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the amount your customer has pushed to the receiver.", "type": "integer" }, "chf_credit_transfer": { "$ref": "#/components/schemas/source_transaction_chf_credit_transfer_data" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "gbp_credit_transfer": { "$ref": "#/components/schemas/source_transaction_gbp_credit_transfer_data" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "source_transaction" ], "type": "string" }, "paper_check": { "$ref": "#/components/schemas/source_transaction_paper_check_data" }, "sepa_credit_transfer": { "$ref": "#/components/schemas/source_transaction_sepa_credit_transfer_data" }, "source": { "description": "The ID of the source this transaction is attached to.", "maxLength": 5000, "type": "string" }, "status": { "description": "The status of the transaction, one of `succeeded`, `pending`, or `failed`.", "maxLength": 5000, "type": "string" }, "type": { "description": "The type of source this transaction is attached to.", "enum": [ "ach_credit_transfer", "ach_debit", "alipay", "bancontact", "card", "card_present", "eps", "giropay", "ideal", "klarna", "multibanco", "p24", "sepa_debit", "sofort", "three_d_secure", "wechat" ], "type": "string" } }, "required": [ "amount", "created", "currency", "id", "livemode", "object", "source", "status", "type" ], "title": "SourceTransaction", "type": "object", "x-expandableFields": [ "ach_credit_transfer", "chf_credit_transfer", "gbp_credit_transfer", "paper_check", "sepa_credit_transfer" ], "x-resourceId": "source_transaction", "x-stripeMostCommon": [ "ach_credit_transfer", "amount", "chf_credit_transfer", "created", "currency", "gbp_credit_transfer", "id", "livemode", "object", "paper_check", "sepa_credit_transfer", "source", "status", "type" ], "x-stripeResource": { "class_name": "SourceTransaction", "has_collection_class": true, "in_package": "" } }, "source_transaction_ach_credit_transfer_data": { "description": "", "properties": { "customer_data": { "description": "Customer data associated with the transfer.", "maxLength": 5000, "type": "string" }, "fingerprint": { "description": "Bank account fingerprint associated with the transfer.", "maxLength": 5000, "type": "string" }, "last4": { "description": "Last 4 digits of the account number associated with the transfer.", "maxLength": 5000, "type": "string" }, "routing_number": { "description": "Routing number associated with the transfer.", "maxLength": 5000, "type": "string" } }, "title": "SourceTransactionAchCreditTransferData", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "customer_data", "fingerprint", "last4", "routing_number" ] }, "source_transaction_chf_credit_transfer_data": { "description": "", "properties": { "reference": { "description": "Reference associated with the transfer.", "maxLength": 5000, "type": "string" }, "sender_address_country": { "description": "Sender's country address.", "maxLength": 5000, "type": "string" }, "sender_address_line1": { "description": "Sender's line 1 address.", "maxLength": 5000, "type": "string" }, "sender_iban": { "description": "Sender's bank account IBAN.", "maxLength": 5000, "type": "string" }, "sender_name": { "description": "Sender's name.", "maxLength": 5000, "type": "string" } }, "title": "SourceTransactionChfCreditTransferData", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "reference", "sender_address_country", "sender_address_line1", "sender_iban", "sender_name" ] }, "source_transaction_gbp_credit_transfer_data": { "description": "", "properties": { "fingerprint": { "description": "Bank account fingerprint associated with the Stripe owned bank account receiving the transfer.", "maxLength": 5000, "type": "string" }, "funding_method": { "description": "The credit transfer rails the sender used to push this transfer. The possible rails are: Faster Payments, BACS, CHAPS, and wire transfers. Currently only Faster Payments is supported.", "maxLength": 5000, "type": "string" }, "last4": { "description": "Last 4 digits of sender account number associated with the transfer.", "maxLength": 5000, "type": "string" }, "reference": { "description": "Sender entered arbitrary information about the transfer.", "maxLength": 5000, "type": "string" }, "sender_account_number": { "description": "Sender account number associated with the transfer.", "maxLength": 5000, "type": "string" }, "sender_name": { "description": "Sender name associated with the transfer.", "maxLength": 5000, "type": "string" }, "sender_sort_code": { "description": "Sender sort code associated with the transfer.", "maxLength": 5000, "type": "string" } }, "title": "SourceTransactionGbpCreditTransferData", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "fingerprint", "funding_method", "last4", "reference", "sender_account_number", "sender_name", "sender_sort_code" ] }, "source_transaction_paper_check_data": { "description": "", "properties": { "available_at": { "description": "Time at which the deposited funds will be available for use. Measured in seconds since the Unix epoch.", "maxLength": 5000, "type": "string" }, "invoices": { "description": "Comma-separated list of invoice IDs associated with the paper check.", "maxLength": 5000, "type": "string" } }, "title": "SourceTransactionPaperCheckData", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "available_at", "invoices" ] }, "source_transaction_sepa_credit_transfer_data": { "description": "", "properties": { "reference": { "description": "Reference associated with the transfer.", "maxLength": 5000, "type": "string" }, "sender_iban": { "description": "Sender's bank account IBAN.", "maxLength": 5000, "type": "string" }, "sender_name": { "description": "Sender's name.", "maxLength": 5000, "type": "string" } }, "title": "SourceTransactionSepaCreditTransferData", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "reference", "sender_iban", "sender_name" ] }, "source_type_ach_credit_transfer": { "properties": { "account_number": { "nullable": true, "type": "string" }, "bank_name": { "nullable": true, "type": "string" }, "fingerprint": { "nullable": true, "type": "string" }, "refund_account_holder_name": { "nullable": true, "type": "string" }, "refund_account_holder_type": { "nullable": true, "type": "string" }, "refund_routing_number": { "nullable": true, "type": "string" }, "routing_number": { "nullable": true, "type": "string" }, "swift_code": { "nullable": true, "type": "string" } }, "type": "object", "x-stripeResource": { "class_name": "AchCreditTransfer" } }, "source_type_ach_debit": { "properties": { "bank_name": { "nullable": true, "type": "string" }, "country": { "nullable": true, "type": "string" }, "fingerprint": { "nullable": true, "type": "string" }, "last4": { "nullable": true, "type": "string" }, "routing_number": { "nullable": true, "type": "string" }, "type": { "nullable": true, "type": "string" } }, "type": "object", "x-stripeResource": { "class_name": "AchDebit" } }, "source_type_acss_debit": { "properties": { "bank_address_city": { "nullable": true, "type": "string" }, "bank_address_line_1": { "nullable": true, "type": "string" }, "bank_address_line_2": { "nullable": true, "type": "string" }, "bank_address_postal_code": { "nullable": true, "type": "string" }, "bank_name": { "nullable": true, "type": "string" }, "category": { "nullable": true, "type": "string" }, "country": { "nullable": true, "type": "string" }, "fingerprint": { "nullable": true, "type": "string" }, "last4": { "nullable": true, "type": "string" }, "routing_number": { "nullable": true, "type": "string" } }, "type": "object", "x-stripeResource": { "class_name": "AcssDebit" } }, "source_type_alipay": { "properties": { "data_string": { "nullable": true, "type": "string" }, "native_url": { "nullable": true, "type": "string" }, "statement_descriptor": { "nullable": true, "type": "string" } }, "type": "object", "x-stripeResource": { "class_name": "Alipay" } }, "source_type_au_becs_debit": { "properties": { "bsb_number": { "nullable": true, "type": "string" }, "fingerprint": { "nullable": true, "type": "string" }, "last4": { "nullable": true, "type": "string" } }, "type": "object", "x-stripeResource": { "class_name": "AuBecsDebit" } }, "source_type_bancontact": { "properties": { "bank_code": { "nullable": true, "type": "string" }, "bank_name": { "nullable": true, "type": "string" }, "bic": { "nullable": true, "type": "string" }, "iban_last4": { "nullable": true, "type": "string" }, "preferred_language": { "nullable": true, "type": "string" }, "statement_descriptor": { "nullable": true, "type": "string" } }, "type": "object", "x-stripeResource": { "class_name": "Bancontact" } }, "source_type_card": { "properties": { "address_line1_check": { "nullable": true, "type": "string" }, "address_zip_check": { "nullable": true, "type": "string" }, "brand": { "nullable": true, "type": "string" }, "brand_product": { "nullable": true, "type": "string" }, "country": { "nullable": true, "type": "string" }, "cvc_check": { "nullable": true, "type": "string" }, "description": { "type": "string" }, "dynamic_last4": { "nullable": true, "type": "string" }, "exp_month": { "nullable": true, "type": "integer" }, "exp_year": { "nullable": true, "type": "integer" }, "fingerprint": { "type": "string" }, "funding": { "nullable": true, "type": "string" }, "iin": { "type": "string" }, "issuer": { "type": "string" }, "last4": { "nullable": true, "type": "string" }, "name": { "nullable": true, "type": "string" }, "three_d_secure": { "type": "string" }, "tokenization_method": { "nullable": true, "type": "string" } }, "type": "object", "x-stripeResource": { "class_name": "Card" } }, "source_type_card_present": { "properties": { "application_cryptogram": { "type": "string" }, "application_preferred_name": { "type": "string" }, "authorization_code": { "nullable": true, "type": "string" }, "authorization_response_code": { "type": "string" }, "brand": { "nullable": true, "type": "string" }, "brand_product": { "nullable": true, "type": "string" }, "country": { "nullable": true, "type": "string" }, "cvm_type": { "type": "string" }, "data_type": { "nullable": true, "type": "string" }, "dedicated_file_name": { "type": "string" }, "description": { "type": "string" }, "emv_auth_data": { "type": "string" }, "evidence_customer_signature": { "nullable": true, "type": "string" }, "evidence_transaction_certificate": { "nullable": true, "type": "string" }, "exp_month": { "nullable": true, "type": "integer" }, "exp_year": { "nullable": true, "type": "integer" }, "fingerprint": { "type": "string" }, "funding": { "nullable": true, "type": "string" }, "iin": { "type": "string" }, "issuer": { "type": "string" }, "last4": { "nullable": true, "type": "string" }, "pos_device_id": { "nullable": true, "type": "string" }, "pos_entry_mode": { "type": "string" }, "read_method": { "nullable": true, "type": "string" }, "reader": { "nullable": true, "type": "string" }, "terminal_verification_results": { "type": "string" }, "transaction_status_information": { "type": "string" } }, "type": "object", "x-stripeResource": { "class_name": "CardPresent" } }, "source_type_eps": { "properties": { "reference": { "nullable": true, "type": "string" }, "statement_descriptor": { "nullable": true, "type": "string" } }, "type": "object", "x-stripeResource": { "class_name": "Eps" } }, "source_type_giropay": { "properties": { "bank_code": { "nullable": true, "type": "string" }, "bank_name": { "nullable": true, "type": "string" }, "bic": { "nullable": true, "type": "string" }, "statement_descriptor": { "nullable": true, "type": "string" } }, "type": "object", "x-stripeResource": { "class_name": "Giropay" } }, "source_type_ideal": { "properties": { "bank": { "nullable": true, "type": "string" }, "bic": { "nullable": true, "type": "string" }, "iban_last4": { "nullable": true, "type": "string" }, "statement_descriptor": { "nullable": true, "type": "string" } }, "type": "object", "x-stripeResource": { "class_name": "Ideal" } }, "source_type_klarna": { "properties": { "background_image_url": { "type": "string" }, "client_token": { "nullable": true, "type": "string" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "locale": { "type": "string" }, "logo_url": { "type": "string" }, "page_title": { "type": "string" }, "pay_later_asset_urls_descriptive": { "type": "string" }, "pay_later_asset_urls_standard": { "type": "string" }, "pay_later_name": { "type": "string" }, "pay_later_redirect_url": { "type": "string" }, "pay_now_asset_urls_descriptive": { "type": "string" }, "pay_now_asset_urls_standard": { "type": "string" }, "pay_now_name": { "type": "string" }, "pay_now_redirect_url": { "type": "string" }, "pay_over_time_asset_urls_descriptive": { "type": "string" }, "pay_over_time_asset_urls_standard": { "type": "string" }, "pay_over_time_name": { "type": "string" }, "pay_over_time_redirect_url": { "type": "string" }, "payment_method_categories": { "type": "string" }, "purchase_country": { "type": "string" }, "purchase_type": { "type": "string" }, "redirect_url": { "type": "string" }, "shipping_delay": { "type": "integer" }, "shipping_first_name": { "type": "string" }, "shipping_last_name": { "type": "string" } }, "type": "object", "x-stripeResource": { "class_name": "Klarna" } }, "source_type_multibanco": { "properties": { "entity": { "nullable": true, "type": "string" }, "reference": { "nullable": true, "type": "string" }, "refund_account_holder_address_city": { "nullable": true, "type": "string" }, "refund_account_holder_address_country": { "nullable": true, "type": "string" }, "refund_account_holder_address_line1": { "nullable": true, "type": "string" }, "refund_account_holder_address_line2": { "nullable": true, "type": "string" }, "refund_account_holder_address_postal_code": { "nullable": true, "type": "string" }, "refund_account_holder_address_state": { "nullable": true, "type": "string" }, "refund_account_holder_name": { "nullable": true, "type": "string" }, "refund_iban": { "nullable": true, "type": "string" } }, "type": "object", "x-stripeResource": { "class_name": "Multibanco" } }, "source_type_p24": { "properties": { "reference": { "nullable": true, "type": "string" } }, "type": "object", "x-stripeResource": { "class_name": "P24" } }, "source_type_paypal": { "properties": { "billing_agreement": { "nullable": true, "type": "string" }, "fingerprint": { "nullable": true, "type": "string" }, "payer_id": { "nullable": true, "type": "string" }, "reference_id": { "type": "string" }, "reference_transaction_amount": { "type": "string" }, "reference_transaction_charged": { "type": "boolean" }, "statement_descriptor": { "nullable": true, "type": "string" }, "transaction_id": { "type": "string" }, "verified_email": { "nullable": true, "type": "string" } }, "type": "object", "x-stripeResource": { "class_name": "Paypal" } }, "source_type_sepa_credit_transfer": { "properties": { "bank_name": { "nullable": true, "type": "string" }, "bic": { "nullable": true, "type": "string" }, "iban": { "nullable": true, "type": "string" }, "refund_account_holder_address_city": { "nullable": true, "type": "string" }, "refund_account_holder_address_country": { "nullable": true, "type": "string" }, "refund_account_holder_address_line1": { "nullable": true, "type": "string" }, "refund_account_holder_address_line2": { "nullable": true, "type": "string" }, "refund_account_holder_address_postal_code": { "nullable": true, "type": "string" }, "refund_account_holder_address_state": { "nullable": true, "type": "string" }, "refund_account_holder_name": { "nullable": true, "type": "string" }, "refund_iban": { "nullable": true, "type": "string" } }, "type": "object", "x-stripeResource": { "class_name": "SepaCreditTransfer" } }, "source_type_sepa_debit": { "properties": { "bank_code": { "nullable": true, "type": "string" }, "branch_code": { "nullable": true, "type": "string" }, "country": { "nullable": true, "type": "string" }, "fingerprint": { "nullable": true, "type": "string" }, "last4": { "nullable": true, "type": "string" }, "mandate_reference": { "nullable": true, "type": "string" }, "mandate_url": { "nullable": true, "type": "string" } }, "type": "object", "x-stripeResource": { "class_name": "SepaDebit" } }, "source_type_sofort": { "properties": { "bank_code": { "nullable": true, "type": "string" }, "bank_name": { "nullable": true, "type": "string" }, "bic": { "nullable": true, "type": "string" }, "country": { "nullable": true, "type": "string" }, "iban_last4": { "nullable": true, "type": "string" }, "preferred_language": { "nullable": true, "type": "string" }, "statement_descriptor": { "nullable": true, "type": "string" } }, "type": "object", "x-stripeResource": { "class_name": "Sofort" } }, "source_type_three_d_secure": { "properties": { "address_line1_check": { "nullable": true, "type": "string" }, "address_zip_check": { "nullable": true, "type": "string" }, "authenticated": { "nullable": true, "type": "boolean" }, "brand": { "nullable": true, "type": "string" }, "brand_product": { "nullable": true, "type": "string" }, "card": { "nullable": true, "type": "string" }, "country": { "nullable": true, "type": "string" }, "customer": { "nullable": true, "type": "string" }, "cvc_check": { "nullable": true, "type": "string" }, "description": { "type": "string" }, "dynamic_last4": { "nullable": true, "type": "string" }, "exp_month": { "nullable": true, "type": "integer" }, "exp_year": { "nullable": true, "type": "integer" }, "fingerprint": { "type": "string" }, "funding": { "nullable": true, "type": "string" }, "iin": { "type": "string" }, "issuer": { "type": "string" }, "last4": { "nullable": true, "type": "string" }, "name": { "nullable": true, "type": "string" }, "three_d_secure": { "type": "string" }, "tokenization_method": { "nullable": true, "type": "string" } }, "type": "object", "x-stripeResource": { "class_name": "ThreeDSecure" } }, "source_type_wechat": { "properties": { "prepay_id": { "type": "string" }, "qr_code_url": { "nullable": true, "type": "string" }, "statement_descriptor": { "type": "string" } }, "type": "object", "x-stripeResource": { "class_name": "Wechat" } }, "stackable_discount_with_index_and_discount_end": { "description": "", "properties": { "coupon": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/coupon" } ], "description": "ID of the coupon to create a new discount for.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/coupon" } ] } }, "discount": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/discount" } ], "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/discount" } ] } }, "discount_end": { "anyOf": [ { "$ref": "#/components/schemas/quote_line_discount_end" } ], "description": "Details to determine how long the discount should be applied for.", "nullable": true }, "index": { "description": "The index, starting at 0, at which to position the new discount. When not supplied, Stripe defaults to appending the discount to the end of the `discounts` array.", "nullable": true, "type": "integer" }, "promotion_code": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/promotion_code" } ], "description": "ID of the promotion code to create a new discount for.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/promotion_code" } ] } } }, "required": [ "coupon", "discount", "index", "promotion_code" ], "title": "StackableDiscountWithIndexAndDiscountEnd", "type": "object", "x-expandableFields": [ "coupon", "discount", "discount_end", "promotion_code" ], "x-stripeMostCommon": [ "coupon", "discount", "discount_end", "index", "promotion_code" ] }, "subscription": { "description": "Subscriptions allow you to charge a customer on a recurring basis.\n\nRelated guide: [Creating subscriptions](https://stripe.com/docs/billing/subscriptions/creating)", "properties": { "application": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/application" }, { "$ref": "#/components/schemas/deleted_application" } ], "description": "ID of the Connect Application that created the subscription.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/application" }, { "$ref": "#/components/schemas/deleted_application" } ] } }, "application_fee_percent": { "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account.", "nullable": true, "type": "number" }, "automatic_tax": { "$ref": "#/components/schemas/subscription_automatic_tax" }, "billing_cycle_anchor": { "description": "The reference point that aligns future [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle) dates. It sets the day of week for `week` intervals, the day of month for `month` and `year` intervals, and the month of year for `year` intervals. The timestamp is in UTC format.", "format": "unix-time", "type": "integer" }, "billing_cycle_anchor_config": { "anyOf": [ { "$ref": "#/components/schemas/subscriptions_resource_billing_cycle_anchor_config" } ], "description": "The fixed values used to calculate the `billing_cycle_anchor`.", "nullable": true }, "billing_mode": { "$ref": "#/components/schemas/subscriptions_resource_billing_mode" }, "billing_thresholds": { "anyOf": [ { "$ref": "#/components/schemas/subscription_billing_thresholds" } ], "description": "Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period", "nullable": true }, "cancel_at": { "description": "A date in the future at which the subscription will automatically get canceled", "format": "unix-time", "nullable": true, "type": "integer" }, "cancel_at_period_end": { "description": "Whether this subscription will (if `status=active`) or did (if `status=canceled`) cancel at the end of the current billing period.", "type": "boolean" }, "canceled_at": { "description": "If the subscription has been canceled, the date of that cancellation. If the subscription was canceled with `cancel_at_period_end`, `canceled_at` will reflect the time of the most recent update request, not the end of the subscription period when the subscription is automatically moved to a canceled state.", "format": "unix-time", "nullable": true, "type": "integer" }, "cancellation_details": { "anyOf": [ { "$ref": "#/components/schemas/cancellation_details" } ], "description": "Details about why this subscription was cancelled", "nullable": true }, "collection_method": { "description": "Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`.", "enum": [ "charge_automatically", "send_invoice" ], "type": "string" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "customer": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/customer" }, { "$ref": "#/components/schemas/deleted_customer" } ], "description": "ID of the customer who owns the subscription.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/customer" }, { "$ref": "#/components/schemas/deleted_customer" } ] } }, "customer_account": { "description": "ID of the account who owns the subscription.", "maxLength": 5000, "nullable": true, "type": "string" }, "days_until_due": { "description": "Number of days a customer has to pay invoices generated by this subscription. This value will be `null` for subscriptions where `collection_method=charge_automatically`.", "nullable": true, "type": "integer" }, "default_payment_method": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/payment_method" } ], "description": "ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/payment_method" } ] } }, "default_source": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/payment_source" } ], "description": "ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/payment_source" } ] } }, "default_tax_rates": { "description": "The tax rates that will apply to any subscription item that does not have `tax_rates` set. Invoices created will have their `default_tax_rates` populated from the subscription.", "items": { "$ref": "#/components/schemas/tax_rate" }, "nullable": true, "type": "array" }, "description": { "description": "The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.", "maxLength": 500, "nullable": true, "type": "string" }, "discounts": { "description": "The discounts applied to the subscription. Subscription item discounts are applied before subscription discounts. Use `expand[]=discounts` to expand each discount.", "items": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/discount" } ], "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/discount" } ] } }, "type": "array" }, "ended_at": { "description": "If the subscription has ended, the date the subscription ended.", "format": "unix-time", "nullable": true, "type": "integer" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "invoice_settings": { "$ref": "#/components/schemas/subscriptions_resource_subscription_invoice_settings" }, "items": { "description": "List of subscription items, each with an attached price.", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/subscription_item" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "SubscriptionItemList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] }, "last_price_migration_error": { "anyOf": [ { "$ref": "#/components/schemas/subscriptions_resource_price_migration_error" } ], "description": "Details of the most recent price migration that failed for the subscription.", "nullable": true }, "latest_invoice": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/invoice" } ], "description": "The most recent invoice this subscription has generated.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/invoice" } ] } }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "type": "object" }, "next_pending_invoice_item_invoice": { "description": "Specifies the approximate timestamp on which any pending invoice items will be billed according to the schedule provided at `pending_invoice_item_interval`.", "format": "unix-time", "nullable": true, "type": "integer" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "subscription" ], "type": "string" }, "on_behalf_of": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/account" } ], "description": "The account (if any) the charge was made on behalf of for charges associated with this subscription. See the [Connect documentation](https://stripe.com/docs/connect/subscriptions#on-behalf-of) for details.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/account" } ] } }, "pause_collection": { "anyOf": [ { "$ref": "#/components/schemas/subscriptions_resource_pause_collection" } ], "description": "If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://stripe.com/docs/billing/subscriptions/pause-payment).", "nullable": true }, "payment_settings": { "anyOf": [ { "$ref": "#/components/schemas/subscriptions_resource_payment_settings" } ], "description": "Payment settings passed on to invoices created by the subscription.", "nullable": true }, "pending_invoice_item_interval": { "anyOf": [ { "$ref": "#/components/schemas/subscription_pending_invoice_item_interval" } ], "description": "Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://stripe.com/docs/api#create_invoice) for the given subscription at the specified interval.", "nullable": true }, "pending_setup_intent": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/setup_intent" } ], "description": "You can use this [SetupIntent](https://stripe.com/docs/api/setup_intents) to collect user authentication when creating a subscription without immediate payment or updating a subscription's payment method, allowing you to optimize for off-session payments. Learn more in the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication#scenario-2).", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/setup_intent" } ] } }, "pending_update": { "anyOf": [ { "$ref": "#/components/schemas/subscriptions_resource_pending_update" } ], "description": "If specified, [pending updates](https://stripe.com/docs/billing/subscriptions/pending-updates) that will be applied to the subscription once the `latest_invoice` has been paid.", "nullable": true }, "prebilling": { "anyOf": [ { "$ref": "#/components/schemas/subscription_prebilling_data" } ], "description": "Time period and invoice for a Subscription billed in advance.", "nullable": true }, "schedule": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/subscription_schedule" } ], "description": "The schedule attached to the subscription", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/subscription_schedule" } ] } }, "start_date": { "description": "Date when the subscription was first created. The date might differ from the `created` date due to backdating.", "format": "unix-time", "type": "integer" }, "status": { "description": "Possible values are `incomplete`, `incomplete_expired`, `trialing`, `active`, `past_due`, `canceled`, `unpaid`, or `paused`. \n\nFor `collection_method=charge_automatically` a subscription moves into `incomplete` if the initial payment attempt fails. A subscription in this status can only have metadata and default_source updated. Once the first invoice is paid, the subscription moves into an `active` status. If the first invoice is not paid within 23 hours, the subscription transitions to `incomplete_expired`. This is a terminal status, the open invoice will be voided and no further invoices will be generated. \n\nA subscription that is currently in a trial period is `trialing` and moves to `active` when the trial period is over. \n\nA subscription can only enter a `paused` status [when a trial ends without a payment method](https://stripe.com/docs/billing/subscriptions/trials#create-free-trials-without-payment). A `paused` subscription doesn't generate invoices and can be resumed after your customer adds their payment method. The `paused` status is different from [pausing collection](https://stripe.com/docs/billing/subscriptions/pause-payment), which still generates invoices and leaves the subscription's status unchanged. \n\nIf subscription `collection_method=charge_automatically`, it becomes `past_due` when payment is required but cannot be paid (due to failed payment or awaiting additional user actions). Once Stripe has exhausted all payment retry attempts, the subscription will become `canceled` or `unpaid` (depending on your subscriptions settings). \n\nIf subscription `collection_method=send_invoice` it becomes `past_due` when its invoice is not paid by the due date, and `canceled` or `unpaid` if it is still not paid by an additional deadline after that. Note that when a subscription has a status of `unpaid`, no subsequent invoices will be attempted (invoices will be created, but then immediately automatically closed). After receiving updated payment information from a customer, you may choose to reopen and pay their closed invoices.", "enum": [ "active", "canceled", "incomplete", "incomplete_expired", "past_due", "paused", "trialing", "unpaid" ], "type": "string" }, "test_clock": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/test_helpers.test_clock" } ], "description": "ID of the test clock this subscription belongs to.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/test_helpers.test_clock" } ] } }, "transfer_data": { "anyOf": [ { "$ref": "#/components/schemas/subscription_transfer_data" } ], "description": "The account (if any) the subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices.", "nullable": true }, "trial_end": { "description": "If the subscription has a trial, the end of that trial.", "format": "unix-time", "nullable": true, "type": "integer" }, "trial_settings": { "anyOf": [ { "$ref": "#/components/schemas/subscriptions_trials_resource_trial_settings" } ], "description": "Settings related to subscription trials.", "nullable": true }, "trial_start": { "description": "If the subscription has a trial, the beginning of that trial.", "format": "unix-time", "nullable": true, "type": "integer" } }, "required": [ "application", "application_fee_percent", "automatic_tax", "billing_cycle_anchor", "billing_cycle_anchor_config", "billing_mode", "billing_thresholds", "cancel_at", "cancel_at_period_end", "canceled_at", "cancellation_details", "collection_method", "created", "currency", "customer", "days_until_due", "default_payment_method", "default_source", "description", "discounts", "ended_at", "id", "invoice_settings", "items", "latest_invoice", "livemode", "metadata", "next_pending_invoice_item_invoice", "object", "on_behalf_of", "pause_collection", "payment_settings", "pending_invoice_item_interval", "pending_setup_intent", "pending_update", "schedule", "start_date", "status", "test_clock", "transfer_data", "trial_end", "trial_settings", "trial_start" ], "title": "Subscription", "type": "object", "x-expandableFields": [ "application", "automatic_tax", "billing_cycle_anchor_config", "billing_mode", "billing_thresholds", "cancellation_details", "customer", "default_payment_method", "default_source", "default_tax_rates", "discounts", "invoice_settings", "items", "last_price_migration_error", "latest_invoice", "on_behalf_of", "pause_collection", "payment_settings", "pending_invoice_item_interval", "pending_setup_intent", "pending_update", "prebilling", "schedule", "test_clock", "transfer_data", "trial_settings" ], "x-resourceId": "subscription", "x-stripeMostCommon": [ "automatic_tax", "currency", "customer", "default_payment_method", "description", "id", "items", "latest_invoice", "metadata", "pending_setup_intent", "pending_update", "status" ], "x-stripeOperations": [ { "method_name": "cancel", "method_on": "service", "method_type": "custom", "operation": "delete", "path": "/v1/subscriptions/{subscription_exposed_id}" }, { "method_name": "delete_discount", "method_on": "service", "method_type": "custom", "operation": "delete", "path": "/v1/subscriptions/{subscription_exposed_id}/discount" }, { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/subscriptions" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/subscriptions/{subscription_exposed_id}" }, { "method_name": "search", "method_on": "service", "method_type": "custom", "operation": "get", "path": "/v1/subscriptions/search" }, { "method_name": "create", "method_on": "service", "method_type": "create", "operation": "post", "path": "/v1/subscriptions" }, { "method_name": "migrate", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/subscriptions/{subscription}/migrate" }, { "method_name": "resume", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/subscriptions/{subscription}/resume" }, { "method_name": "update", "method_on": "service", "method_type": "update", "operation": "post", "path": "/v1/subscriptions/{subscription_exposed_id}" } ], "x-stripeResource": { "class_name": "Subscription", "has_collection_class": true, "has_search_result_class": true, "in_package": "" } }, "subscription_automatic_tax": { "description": "", "properties": { "disabled_reason": { "description": "If Stripe disabled automatic tax, this enum describes why.", "enum": [ "requires_location_inputs" ], "nullable": true, "type": "string" }, "enabled": { "description": "Whether Stripe automatically computes tax on this subscription.", "type": "boolean" }, "liability": { "anyOf": [ { "$ref": "#/components/schemas/connect_account_reference" } ], "description": "The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.", "nullable": true } }, "required": [ "disabled_reason", "enabled", "liability" ], "title": "SubscriptionAutomaticTax", "type": "object", "x-expandableFields": [ "liability" ], "x-stripeMostCommon": [ "disabled_reason", "enabled", "liability" ] }, "subscription_billing_thresholds": { "description": "", "properties": { "amount_gte": { "description": "Monetary threshold that triggers the subscription to create an invoice", "nullable": true, "type": "integer" }, "reset_billing_cycle_anchor": { "description": "Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. This value may not be `true` if the subscription contains items with plans that have `aggregate_usage=last_ever`.", "nullable": true, "type": "boolean" } }, "required": [ "amount_gte", "reset_billing_cycle_anchor" ], "title": "SubscriptionBillingThresholds", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "amount_gte", "reset_billing_cycle_anchor" ] }, "subscription_item": { "description": "Subscription items allow you to create customer subscriptions with more than\none plan, making it easy to represent complex billing relationships.", "properties": { "billing_thresholds": { "anyOf": [ { "$ref": "#/components/schemas/subscription_item_billing_thresholds" } ], "description": "Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period", "nullable": true }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "type": "integer" }, "current_period_end": { "description": "The end time of this subscription item's current billing period.", "format": "unix-time", "type": "integer" }, "current_period_start": { "description": "The start time of this subscription item's current billing period.", "format": "unix-time", "type": "integer" }, "discounts": { "description": "The discounts applied to the subscription item. Subscription item discounts are applied before subscription discounts. Use `expand[]=discounts` to expand each discount.", "items": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/discount" } ], "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/discount" } ] } }, "type": "array" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "type": "object" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "subscription_item" ], "type": "string" }, "plan": { "$ref": "#/components/schemas/plan" }, "price": { "$ref": "#/components/schemas/price" }, "quantity": { "description": "The [quantity](https://stripe.com/docs/subscriptions/quantities) of the plan to which the customer should be subscribed.", "type": "integer" }, "subscription": { "description": "The `subscription` this `subscription_item` belongs to.", "maxLength": 5000, "type": "string" }, "tax_rates": { "description": "The tax rates which apply to this `subscription_item`. When set, the `default_tax_rates` on the subscription do not apply to this `subscription_item`.", "items": { "$ref": "#/components/schemas/tax_rate" }, "nullable": true, "type": "array" }, "trial": { "anyOf": [ { "$ref": "#/components/schemas/subscriptions_trials_resource_trial" } ], "description": "Options that configure the trial on the subscription item.", "nullable": true } }, "required": [ "billing_thresholds", "created", "current_period_end", "current_period_start", "discounts", "id", "metadata", "object", "plan", "price", "subscription", "tax_rates" ], "title": "SubscriptionItem", "type": "object", "x-expandableFields": [ "billing_thresholds", "discounts", "plan", "price", "tax_rates", "trial" ], "x-resourceId": "subscription_item", "x-stripeMostCommon": [ "id", "metadata", "price", "quantity", "subscription" ], "x-stripeOperations": [ { "method_name": "delete", "method_on": "service", "method_type": "delete", "operation": "delete", "path": "/v1/subscription_items/{item}" }, { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/subscription_items" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/subscription_items/{item}" }, { "method_name": "create", "method_on": "service", "method_type": "create", "operation": "post", "path": "/v1/subscription_items" }, { "method_name": "update", "method_on": "service", "method_type": "update", "operation": "post", "path": "/v1/subscription_items/{item}" } ], "x-stripeResource": { "class_name": "SubscriptionItem", "has_collection_class": true, "in_package": "" } }, "subscription_item_billing_thresholds": { "description": "", "properties": { "usage_gte": { "description": "Usage threshold that triggers the subscription to create an invoice", "nullable": true, "type": "integer" } }, "required": [ "usage_gte" ], "title": "SubscriptionItemBillingThresholds", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "usage_gte" ] }, "subscription_payment_method_options_card": { "description": "", "properties": { "mandate_options": { "$ref": "#/components/schemas/invoice_mandate_options_card" }, "network": { "description": "Selected network to process this Subscription on. Depends on the available networks of the card attached to the Subscription. Can be only set confirm-time.", "enum": [ "amex", "cartes_bancaires", "diners", "discover", "eftpos_au", "girocard", "interac", "jcb", "link", "mastercard", "unionpay", "unknown", "visa" ], "nullable": true, "type": "string" }, "request_three_d_secure": { "description": "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.", "enum": [ "any", "automatic", "challenge" ], "nullable": true, "type": "string" } }, "required": [ "network", "request_three_d_secure" ], "title": "subscription_payment_method_options_card", "type": "object", "x-expandableFields": [ "mandate_options" ], "x-stripeMostCommon": [ "mandate_options", "network", "request_three_d_secure" ] }, "subscription_payment_method_options_mandate_options_pix": { "description": "", "properties": { "amount": { "description": "Amount to be charged for future payments.", "nullable": true, "type": "integer" }, "amount_includes_iof": { "description": "Determines if the amount includes the IOF tax.", "enum": [ "always", "never" ], "nullable": true, "type": "string" }, "end_date": { "description": "Date when the mandate expires and no further payments will be charged, in `YYYY-MM-DD`.", "maxLength": 5000, "nullable": true, "type": "string" }, "payment_schedule": { "description": "Schedule at which the future payments will be charged.", "enum": [ "halfyearly", "monthly", "quarterly", "weekly", "yearly" ], "nullable": true, "type": "string" } }, "required": [ "amount", "amount_includes_iof", "end_date", "payment_schedule" ], "title": "subscription_payment_method_options_mandate_options_pix", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "amount", "amount_includes_iof", "end_date", "payment_schedule" ] }, "subscription_payment_method_options_pix": { "description": "", "properties": { "mandate_options": { "$ref": "#/components/schemas/subscription_payment_method_options_mandate_options_pix" } }, "title": "subscription_payment_method_options_pix", "type": "object", "x-expandableFields": [ "mandate_options" ], "x-stripeMostCommon": [ "mandate_options" ] }, "subscription_pending_invoice_item_interval": { "description": "", "properties": { "interval": { "description": "Specifies invoicing frequency. Either `day`, `week`, `month` or `year`.", "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "description": "The number of intervals between invoices. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks).", "type": "integer" } }, "required": [ "interval", "interval_count" ], "title": "SubscriptionPendingInvoiceItemInterval", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "interval", "interval_count" ] }, "subscription_prebilling_data": { "description": "Prebilling stores the time period and invoice for a Subscription billed in advance.", "properties": { "invoice": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/invoice" } ], "description": "ID of the prebilling invoice.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/invoice" } ] } }, "period_end": { "description": "The end of the last period for which the invoice pre-bills.", "format": "unix-time", "type": "integer" }, "period_start": { "description": "The start of the first period for which the invoice pre-bills.", "format": "unix-time", "type": "integer" }, "update_behavior": { "description": "Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period.", "enum": [ "prebill", "reset" ], "type": "string" } }, "required": [ "invoice", "period_end", "period_start" ], "title": "SubscriptionPrebillingData", "type": "object", "x-expandableFields": [ "invoice" ], "x-stripeMostCommon": [ "invoice", "period_end", "period_start", "update_behavior" ] }, "subscription_schedule": { "description": "A subscription schedule allows you to create and manage the lifecycle of a subscription by predefining expected changes.\n\nRelated guide: [Subscription schedules](https://stripe.com/docs/billing/subscriptions/subscription-schedules)", "properties": { "application": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/application" }, { "$ref": "#/components/schemas/deleted_application" } ], "description": "ID of the Connect Application that created the schedule.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/application" }, { "$ref": "#/components/schemas/deleted_application" } ] } }, "billing_behavior": { "description": "Configures when the subscription schedule generates prorations for phase transitions. Possible values are `prorate_on_next_phase` or `prorate_up_front` with the default being `prorate_on_next_phase`. `prorate_on_next_phase` will apply phase changes and generate prorations at transition time. `prorate_up_front` will bill for all phases within the current billing cycle up front.", "enum": [ "prorate_on_next_phase", "prorate_up_front" ], "type": "string" }, "billing_mode": { "$ref": "#/components/schemas/subscriptions_resource_billing_mode" }, "canceled_at": { "description": "Time at which the subscription schedule was canceled. Measured in seconds since the Unix epoch.", "format": "unix-time", "nullable": true, "type": "integer" }, "completed_at": { "description": "Time at which the subscription schedule was completed. Measured in seconds since the Unix epoch.", "format": "unix-time", "nullable": true, "type": "integer" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "current_phase": { "anyOf": [ { "$ref": "#/components/schemas/subscription_schedule_current_phase" } ], "description": "Object representing the start and end dates for the current phase of the subscription schedule, if it is `active`.", "nullable": true }, "customer": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/customer" }, { "$ref": "#/components/schemas/deleted_customer" } ], "description": "ID of the customer who owns the subscription schedule.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/customer" }, { "$ref": "#/components/schemas/deleted_customer" } ] } }, "customer_account": { "description": "ID of the account who owns the subscription schedule.", "maxLength": 5000, "nullable": true, "type": "string" }, "default_settings": { "$ref": "#/components/schemas/subscription_schedules_resource_default_settings" }, "end_behavior": { "description": "Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running. `cancel` will end the subscription schedule and cancel the underlying subscription.", "enum": [ "cancel", "none", "release", "renew" ], "type": "string" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "last_price_migration_error": { "anyOf": [ { "$ref": "#/components/schemas/subscriptions_resource_price_migration_error" } ], "description": "Details of the most recent price migration that failed for the subscription schedule.", "nullable": true }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "nullable": true, "type": "object" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "subscription_schedule" ], "type": "string" }, "phases": { "description": "Configuration for the subscription schedule's phases.", "items": { "$ref": "#/components/schemas/subscription_schedule_phase_configuration" }, "type": "array" }, "prebilling": { "anyOf": [ { "$ref": "#/components/schemas/subscription_prebilling_data" } ], "description": "Time period and invoice for a Subscription billed in advance.", "nullable": true }, "released_at": { "description": "Time at which the subscription schedule was released. Measured in seconds since the Unix epoch.", "format": "unix-time", "nullable": true, "type": "integer" }, "released_subscription": { "description": "ID of the subscription once managed by the subscription schedule (if it is released).", "maxLength": 5000, "nullable": true, "type": "string" }, "status": { "description": "The present status of the subscription schedule. Possible values are `not_started`, `active`, `completed`, `released`, and `canceled`. You can read more about the different states in our [behavior guide](https://stripe.com/docs/billing/subscriptions/subscription-schedules).", "enum": [ "active", "canceled", "completed", "not_started", "released" ], "type": "string" }, "subscription": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/subscription" } ], "description": "ID of the subscription managed by the subscription schedule.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/subscription" } ] } }, "test_clock": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/test_helpers.test_clock" } ], "description": "ID of the test clock this subscription schedule belongs to.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/test_helpers.test_clock" } ] } } }, "required": [ "application", "billing_mode", "canceled_at", "completed_at", "created", "current_phase", "customer", "default_settings", "end_behavior", "id", "livemode", "metadata", "object", "phases", "released_at", "released_subscription", "status", "subscription", "test_clock" ], "title": "SubscriptionSchedule", "type": "object", "x-expandableFields": [ "application", "billing_mode", "current_phase", "customer", "default_settings", "last_price_migration_error", "phases", "prebilling", "subscription", "test_clock" ], "x-resourceId": "subscription_schedule", "x-stripeMostCommon": [ "current_phase", "customer", "id", "metadata", "phases", "status", "subscription" ], "x-stripeOperations": [ { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/subscription_schedules" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/subscription_schedules/{schedule}" }, { "method_name": "create", "method_on": "service", "method_type": "create", "operation": "post", "path": "/v1/subscription_schedules" }, { "method_name": "update", "method_on": "service", "method_type": "update", "operation": "post", "path": "/v1/subscription_schedules/{schedule}" }, { "method_name": "amend", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/subscription_schedules/{schedule}/amend" }, { "method_name": "cancel", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/subscription_schedules/{schedule}/cancel" }, { "method_name": "release", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/subscription_schedules/{schedule}/release" } ], "x-stripeResource": { "class_name": "SubscriptionSchedule", "has_collection_class": true, "in_package": "" } }, "subscription_schedule.aborted": { "description": "Occurs whenever a subscription schedule is canceled due to the underlying subscription being canceled because of delinquency.", "properties": { "object": { "$ref": "#/components/schemas/subscription_schedule" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "subscription_schedule.aborted" } }, "subscription_schedule.canceled": { "description": "Occurs whenever a subscription schedule is canceled.", "properties": { "object": { "$ref": "#/components/schemas/subscription_schedule" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "subscription_schedule.canceled" } }, "subscription_schedule.completed": { "description": "Occurs whenever a new subscription schedule is completed.", "properties": { "object": { "$ref": "#/components/schemas/subscription_schedule" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "subscription_schedule.completed" } }, "subscription_schedule.created": { "description": "Occurs whenever a new subscription schedule is created.", "properties": { "object": { "$ref": "#/components/schemas/subscription_schedule" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "subscription_schedule.created" } }, "subscription_schedule.expiring": { "description": "Occurs 7 days before a subscription schedule will expire.", "properties": { "object": { "$ref": "#/components/schemas/subscription_schedule" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "subscription_schedule.expiring" } }, "subscription_schedule.price_migration_failed": { "description": "Occurs whenever a price migration failed to transition prices on a subscription schedule.", "properties": { "object": { "$ref": "#/components/schemas/subscription_schedule" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "subscription_schedule.price_migration_failed" } }, "subscription_schedule.released": { "description": "Occurs whenever a new subscription schedule is released.", "properties": { "object": { "$ref": "#/components/schemas/subscription_schedule" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "subscription_schedule.released" } }, "subscription_schedule.updated": { "description": "Occurs whenever a subscription schedule is updated.", "properties": { "object": { "$ref": "#/components/schemas/subscription_schedule" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "subscription_schedule.updated" } }, "subscription_schedule_add_invoice_item": { "description": "An Add Invoice Item describes the prices and quantities that will be added as pending invoice items when entering a phase.", "properties": { "discounts": { "description": "The stackable discounts that will be applied to the item.", "items": { "$ref": "#/components/schemas/discounts_resource_stackable_discount" }, "type": "array" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "nullable": true, "type": "object" }, "period": { "$ref": "#/components/schemas/subscription_schedule_add_invoice_item_period" }, "price": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/price" }, { "$ref": "#/components/schemas/deleted_price" } ], "description": "ID of the price used to generate the invoice item.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/price" }, { "$ref": "#/components/schemas/deleted_price" } ] } }, "quantity": { "description": "The quantity of the invoice item.", "nullable": true, "type": "integer" }, "tax_rates": { "description": "The tax rates which apply to the item. When set, the `default_tax_rates` do not apply to this item.", "items": { "$ref": "#/components/schemas/tax_rate" }, "nullable": true, "type": "array" } }, "required": [ "discounts", "metadata", "period", "price", "quantity" ], "title": "SubscriptionScheduleAddInvoiceItem", "type": "object", "x-expandableFields": [ "discounts", "period", "price", "tax_rates" ], "x-stripeMostCommon": [ "discounts", "metadata", "period", "price", "quantity", "tax_rates" ] }, "subscription_schedule_add_invoice_item_period": { "description": "", "properties": { "end": { "$ref": "#/components/schemas/subscription_schedules_resource_invoice_item_period_resource_period_end" }, "start": { "$ref": "#/components/schemas/subscription_schedules_resource_invoice_item_period_resource_period_start" } }, "required": [ "end", "start" ], "title": "SubscriptionScheduleAddInvoiceItemPeriod", "type": "object", "x-expandableFields": [ "end", "start" ], "x-stripeMostCommon": [ "end", "start" ] }, "subscription_schedule_configuration_item": { "description": "A phase item describes the price and quantity of a phase.", "properties": { "billing_thresholds": { "anyOf": [ { "$ref": "#/components/schemas/subscription_item_billing_thresholds" } ], "description": "Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period", "nullable": true }, "discounts": { "description": "The discounts applied to the subscription item. Subscription item discounts are applied before subscription discounts. Use `expand[]=discounts` to expand each discount.", "items": { "$ref": "#/components/schemas/discounts_resource_stackable_discount" }, "type": "array" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an item. Metadata on this item will update the underlying subscription item's `metadata` when the phase is entered.", "nullable": true, "type": "object" }, "plan": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/plan" }, { "$ref": "#/components/schemas/deleted_plan" } ], "description": "ID of the plan to which the customer should be subscribed.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/plan" }, { "$ref": "#/components/schemas/deleted_plan" } ] } }, "price": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/price" }, { "$ref": "#/components/schemas/deleted_price" } ], "description": "ID of the price to which the customer should be subscribed.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/price" }, { "$ref": "#/components/schemas/deleted_price" } ] } }, "quantity": { "description": "Quantity of the plan to which the customer should be subscribed.", "type": "integer" }, "tax_rates": { "description": "The tax rates which apply to this `phase_item`. When set, the `default_tax_rates` on the phase do not apply to this `phase_item`.", "items": { "$ref": "#/components/schemas/tax_rate" }, "nullable": true, "type": "array" }, "trial": { "anyOf": [ { "$ref": "#/components/schemas/subscriptions_trials_resource_trial" } ], "description": "Options that configure the trial on the subscription item.", "nullable": true } }, "required": [ "billing_thresholds", "discounts", "metadata", "plan", "price" ], "title": "SubscriptionScheduleConfigurationItem", "type": "object", "x-expandableFields": [ "billing_thresholds", "discounts", "plan", "price", "tax_rates", "trial" ], "x-stripeMostCommon": [ "billing_thresholds", "discounts", "metadata", "plan", "price", "quantity", "tax_rates", "trial" ] }, "subscription_schedule_current_phase": { "description": "", "properties": { "end_date": { "description": "The end of this phase of the subscription schedule.", "format": "unix-time", "type": "integer" }, "start_date": { "description": "The start of this phase of the subscription schedule.", "format": "unix-time", "type": "integer" } }, "required": [ "end_date", "start_date" ], "title": "SubscriptionScheduleCurrentPhase", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "end_date", "start_date" ] }, "subscription_schedule_phase_configuration": { "description": "A phase describes the plans, coupon, and trialing status of a subscription for a predefined time period.", "properties": { "add_invoice_items": { "description": "A list of prices and quantities that will generate invoice items appended to the next invoice for this phase.", "items": { "$ref": "#/components/schemas/subscription_schedule_add_invoice_item" }, "type": "array" }, "application_fee_percent": { "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account during this phase of the schedule.", "nullable": true, "type": "number" }, "automatic_tax": { "$ref": "#/components/schemas/schedules_phase_automatic_tax" }, "billing_cycle_anchor": { "description": "Possible values are `phase_start` or `automatic`. If `phase_start` then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. If `automatic` then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).", "enum": [ "automatic", "phase_start" ], "nullable": true, "type": "string" }, "billing_thresholds": { "anyOf": [ { "$ref": "#/components/schemas/subscription_billing_thresholds" } ], "description": "Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period", "nullable": true }, "collection_method": { "description": "Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`.", "enum": [ "charge_automatically", "send_invoice" ], "nullable": true, "type": "string" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "default_payment_method": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/payment_method" } ], "description": "ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/payment_method" } ] } }, "default_tax_rates": { "description": "The default tax rates to apply to the subscription during this phase of the subscription schedule.", "items": { "$ref": "#/components/schemas/tax_rate" }, "nullable": true, "type": "array" }, "description": { "description": "Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.", "maxLength": 5000, "nullable": true, "type": "string" }, "discounts": { "description": "The stackable discounts that will be applied to the subscription on this phase. Subscription item discounts are applied before subscription discounts.", "items": { "$ref": "#/components/schemas/discounts_resource_stackable_discount" }, "type": "array" }, "end_date": { "description": "The end of this phase of the subscription schedule.", "format": "unix-time", "type": "integer" }, "invoice_settings": { "anyOf": [ { "$ref": "#/components/schemas/invoice_setting_subscription_schedule_phase_setting" } ], "description": "The invoice settings applicable during this phase.", "nullable": true }, "items": { "description": "Subscription items to configure the subscription to during this phase of the subscription schedule.", "items": { "$ref": "#/components/schemas/subscription_schedule_configuration_item" }, "type": "array" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a phase. Metadata on a schedule's phase will update the underlying subscription's `metadata` when the phase is entered. Updating the underlying subscription's `metadata` directly will not affect the current phase's `metadata`.", "nullable": true, "type": "object" }, "on_behalf_of": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/account" } ], "description": "The account (if any) the charge was made on behalf of for charges associated with the schedule's subscription. See the Connect documentation for details.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/account" } ] } }, "pause_collection": { "anyOf": [ { "$ref": "#/components/schemas/subscription_schedules_resource_pause_collection" } ], "description": "If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://stripe.com/docs/billing/subscriptions/pause-payment).", "nullable": true }, "proration_behavior": { "description": "When transitioning phases, controls how prorations are handled (if any). Possible values are `create_prorations`, `none`, and `always_invoice`.", "enum": [ "always_invoice", "create_prorations", "none" ], "type": "string" }, "start_date": { "description": "The start of this phase of the subscription schedule.", "format": "unix-time", "type": "integer" }, "transfer_data": { "anyOf": [ { "$ref": "#/components/schemas/subscription_transfer_data" } ], "description": "The account (if any) the associated subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices.", "nullable": true }, "trial_continuation": { "description": "Specify behavior of the trial when crossing schedule phase boundaries", "enum": [ "continue", "none" ], "nullable": true, "type": "string" }, "trial_end": { "description": "When the trial ends within the phase.", "format": "unix-time", "nullable": true, "type": "integer" }, "trial_settings": { "anyOf": [ { "$ref": "#/components/schemas/subscription_schedules_resource_trial_settings" } ], "description": "Settings related to any trials on the subscription during this phase.", "nullable": true } }, "required": [ "add_invoice_items", "application_fee_percent", "billing_cycle_anchor", "billing_thresholds", "collection_method", "currency", "default_payment_method", "description", "discounts", "end_date", "invoice_settings", "items", "metadata", "on_behalf_of", "proration_behavior", "start_date", "transfer_data", "trial_end" ], "title": "SubscriptionSchedulePhaseConfiguration", "type": "object", "x-expandableFields": [ "add_invoice_items", "automatic_tax", "billing_thresholds", "default_payment_method", "default_tax_rates", "discounts", "invoice_settings", "items", "on_behalf_of", "pause_collection", "transfer_data", "trial_settings" ], "x-stripeMostCommon": [ "add_invoice_items", "application_fee_percent", "automatic_tax", "billing_cycle_anchor", "billing_thresholds", "collection_method", "currency", "default_payment_method", "default_tax_rates", "description", "discounts", "end_date", "invoice_settings", "items", "metadata", "on_behalf_of", "pause_collection", "proration_behavior", "start_date", "transfer_data", "trial_continuation", "trial_end", "trial_settings" ] }, "subscription_schedules_resource_default_settings": { "description": "", "properties": { "application_fee_percent": { "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account during this phase of the schedule.", "nullable": true, "type": "number" }, "automatic_tax": { "$ref": "#/components/schemas/subscription_schedules_resource_default_settings_automatic_tax" }, "billing_cycle_anchor": { "description": "Possible values are `phase_start` or `automatic`. If `phase_start` then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. If `automatic` then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).", "enum": [ "automatic", "phase_start" ], "type": "string" }, "billing_thresholds": { "anyOf": [ { "$ref": "#/components/schemas/subscription_billing_thresholds" } ], "description": "Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period", "nullable": true }, "collection_method": { "description": "Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`.", "enum": [ "charge_automatically", "send_invoice" ], "nullable": true, "type": "string" }, "default_payment_method": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/payment_method" } ], "description": "ID of the default payment method for the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/payment_method" } ] } }, "description": { "description": "Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.", "maxLength": 5000, "nullable": true, "type": "string" }, "invoice_settings": { "$ref": "#/components/schemas/invoice_setting_subscription_schedule_setting" }, "on_behalf_of": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/account" } ], "description": "The account (if any) the charge was made on behalf of for charges associated with the schedule's subscription. See the Connect documentation for details.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/account" } ] } }, "transfer_data": { "anyOf": [ { "$ref": "#/components/schemas/subscription_transfer_data" } ], "description": "The account (if any) the associated subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices.", "nullable": true } }, "required": [ "application_fee_percent", "billing_cycle_anchor", "billing_thresholds", "collection_method", "default_payment_method", "description", "invoice_settings", "on_behalf_of", "transfer_data" ], "title": "SubscriptionSchedulesResourceDefaultSettings", "type": "object", "x-expandableFields": [ "automatic_tax", "billing_thresholds", "default_payment_method", "invoice_settings", "on_behalf_of", "transfer_data" ], "x-stripeMostCommon": [ "application_fee_percent", "automatic_tax", "billing_cycle_anchor", "billing_thresholds", "collection_method", "default_payment_method", "description", "invoice_settings", "on_behalf_of", "transfer_data" ] }, "subscription_schedules_resource_default_settings_automatic_tax": { "description": "", "properties": { "disabled_reason": { "description": "If Stripe disabled automatic tax, this enum describes why.", "enum": [ "requires_location_inputs" ], "nullable": true, "type": "string" }, "enabled": { "description": "Whether Stripe automatically computes tax on invoices created during this phase.", "type": "boolean" }, "liability": { "anyOf": [ { "$ref": "#/components/schemas/connect_account_reference" } ], "description": "The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.", "nullable": true } }, "required": [ "disabled_reason", "enabled", "liability" ], "title": "SubscriptionSchedulesResourceDefaultSettingsAutomaticTax", "type": "object", "x-expandableFields": [ "liability" ], "x-stripeMostCommon": [ "disabled_reason", "enabled", "liability" ] }, "subscription_schedules_resource_end_behavior": { "description": "Defines how the scheduled subscription behaves when a trial ends.", "properties": { "prorate_up_front": { "description": "Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.", "enum": [ "defer", "include" ], "nullable": true, "type": "string" } }, "required": [ "prorate_up_front" ], "title": "SubscriptionSchedulesResourceEndBehavior", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "prorate_up_front" ] }, "subscription_schedules_resource_invoice_item_period_resource_period_end": { "description": "", "properties": { "timestamp": { "description": "A precise Unix timestamp for the end of the invoice item period. Must be greater than or equal to `period.start`.", "format": "unix-time", "type": "integer" }, "type": { "description": "Select how to calculate the end of the invoice item period.", "enum": [ "min_item_period_end", "phase_end", "timestamp" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "SubscriptionSchedulesResourceInvoiceItemPeriodResourcePeriodEnd", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "timestamp", "type" ] }, "subscription_schedules_resource_invoice_item_period_resource_period_start": { "description": "", "properties": { "timestamp": { "description": "A precise Unix timestamp for the start of the invoice item period. Must be less than or equal to `period.end`.", "format": "unix-time", "type": "integer" }, "type": { "description": "Select how to calculate the start of the invoice item period.", "enum": [ "max_item_period_start", "phase_start", "timestamp" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "SubscriptionSchedulesResourceInvoiceItemPeriodResourcePeriodStart", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "timestamp", "type" ] }, "subscription_schedules_resource_pause_collection": { "description": "The Pause Collection settings specify how to pause collection for a subscription during a phase by modifying\nthe behavior of the invoices that are generated during the paused period.", "properties": { "behavior": { "description": "The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.", "enum": [ "keep_as_draft", "mark_uncollectible", "void" ], "type": "string" } }, "required": [ "behavior" ], "title": "SubscriptionSchedulesResourcePauseCollection", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "behavior" ] }, "subscription_schedules_resource_trial_settings": { "description": "Configures how the scheduled subscription behaves during the trial period.", "properties": { "end_behavior": { "anyOf": [ { "$ref": "#/components/schemas/subscription_schedules_resource_end_behavior" } ], "description": "Defines how the subscription should behave when a trial ends.", "nullable": true } }, "required": [ "end_behavior" ], "title": "SubscriptionSchedulesResourceTrialSettings", "type": "object", "x-expandableFields": [ "end_behavior" ], "x-stripeMostCommon": [ "end_behavior" ] }, "subscription_transfer_data": { "description": "", "properties": { "amount_percent": { "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination.", "nullable": true, "type": "number" }, "destination": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/account" } ], "description": "The account where funds from the payment will be transferred to upon payment success.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/account" } ] } } }, "required": [ "amount_percent", "destination" ], "title": "SubscriptionTransferData", "type": "object", "x-expandableFields": [ "destination" ], "x-stripeMostCommon": [ "amount_percent", "destination" ] }, "subscriptions_resource_billing_cycle_anchor_config": { "description": "", "properties": { "day_of_month": { "description": "The day of the month of the billing_cycle_anchor.", "type": "integer" }, "hour": { "description": "The hour of the day of the billing_cycle_anchor.", "nullable": true, "type": "integer" }, "minute": { "description": "The minute of the hour of the billing_cycle_anchor.", "nullable": true, "type": "integer" }, "month": { "description": "The month to start full cycle billing periods.", "nullable": true, "type": "integer" }, "second": { "description": "The second of the minute of the billing_cycle_anchor.", "nullable": true, "type": "integer" } }, "required": [ "day_of_month", "hour", "minute", "month", "second" ], "title": "SubscriptionsResourceBillingCycleAnchorConfig", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "day_of_month", "hour", "minute", "month", "second" ] }, "subscriptions_resource_billing_mode": { "description": "The billing mode of the subscription.", "properties": { "type": { "description": "Controls how prorations and invoices for subscriptions are calculated and orchestrated.", "enum": [ "classic", "flexible" ], "type": "string" }, "updated_at": { "description": "Details on when the current billing_mode was adopted.", "format": "unix-time", "type": "integer" } }, "required": [ "type" ], "title": "SubscriptionsResourceBillingMode", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "type", "updated_at" ] }, "subscriptions_resource_pause_collection": { "description": "The Pause Collection settings determine how we will pause collection for this subscription and for how long the subscription\nshould be paused.", "properties": { "behavior": { "description": "The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.", "enum": [ "keep_as_draft", "mark_uncollectible", "void" ], "type": "string" }, "resumes_at": { "description": "The time after which the subscription will resume collecting payments.", "format": "unix-time", "nullable": true, "type": "integer" } }, "required": [ "behavior", "resumes_at" ], "title": "SubscriptionsResourcePauseCollection", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "behavior", "resumes_at" ] }, "subscriptions_resource_payment_method_options": { "description": "", "properties": { "acss_debit": { "anyOf": [ { "$ref": "#/components/schemas/invoice_payment_method_options_acss_debit" } ], "description": "This sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to invoices created by the subscription.", "nullable": true }, "bancontact": { "anyOf": [ { "$ref": "#/components/schemas/invoice_payment_method_options_bancontact" } ], "description": "This sub-hash contains details about the Bancontact payment method options to pass to invoices created by the subscription.", "nullable": true }, "card": { "anyOf": [ { "$ref": "#/components/schemas/subscription_payment_method_options_card" } ], "description": "This sub-hash contains details about the Card payment method options to pass to invoices created by the subscription.", "nullable": true }, "customer_balance": { "anyOf": [ { "$ref": "#/components/schemas/invoice_payment_method_options_customer_balance" } ], "description": "This sub-hash contains details about the Bank transfer payment method options to pass to invoices created by the subscription.", "nullable": true }, "id_bank_transfer": { "anyOf": [ { "$ref": "#/components/schemas/invoice_payment_method_options_id_bank_transfer" } ], "description": "This sub-hash contains details about the Indonesia bank transfer payment method options to pass to invoices created by the subscription.", "nullable": true }, "konbini": { "anyOf": [ { "$ref": "#/components/schemas/invoice_payment_method_options_konbini" } ], "description": "This sub-hash contains details about the Konbini payment method options to pass to invoices created by the subscription.", "nullable": true }, "pix": { "anyOf": [ { "$ref": "#/components/schemas/subscription_payment_method_options_pix" } ], "description": "This sub-hash contains details about the Pix payment method options to pass to invoices created by the subscription.", "nullable": true }, "sepa_debit": { "anyOf": [ { "$ref": "#/components/schemas/invoice_payment_method_options_sepa_debit" } ], "description": "This sub-hash contains details about the SEPA Direct Debit payment method options to pass to invoices created by the subscription.", "nullable": true }, "upi": { "anyOf": [ { "$ref": "#/components/schemas/invoice_payment_method_options_upi" } ], "description": "This sub-hash contains details about the UPI payment method options to pass to invoices created by the subscription.", "nullable": true }, "us_bank_account": { "anyOf": [ { "$ref": "#/components/schemas/invoice_payment_method_options_us_bank_account" } ], "description": "This sub-hash contains details about the ACH direct debit payment method options to pass to invoices created by the subscription.", "nullable": true } }, "required": [ "acss_debit", "bancontact", "card", "customer_balance", "konbini", "sepa_debit", "us_bank_account" ], "title": "SubscriptionsResourcePaymentMethodOptions", "type": "object", "x-expandableFields": [ "acss_debit", "bancontact", "card", "customer_balance", "id_bank_transfer", "konbini", "pix", "sepa_debit", "upi", "us_bank_account" ], "x-stripeMostCommon": [ "acss_debit", "bancontact", "card", "customer_balance", "id_bank_transfer", "konbini", "pix", "sepa_debit", "upi", "us_bank_account" ] }, "subscriptions_resource_payment_settings": { "description": "", "properties": { "payment_method_options": { "anyOf": [ { "$ref": "#/components/schemas/subscriptions_resource_payment_method_options" } ], "description": "Payment-method-specific configuration to provide to invoices created by the subscription.", "nullable": true }, "payment_method_types": { "description": "The list of payment method types to provide to every invoice created by the subscription. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your [invoice template settings](https://dashboard.stripe.com/settings/billing/invoice).", "items": { "enum": [ "ach_credit_transfer", "ach_debit", "acss_debit", "affirm", "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", "boleto", "card", "cashapp", "crypto", "custom", "customer_balance", "eps", "fpx", "giropay", "grabpay", "id_bank_transfer", "ideal", "jp_credit_transfer", "kakao_pay", "klarna", "konbini", "kr_card", "link", "multibanco", "naver_pay", "nz_bank_account", "p24", "payco", "paynow", "paypal", "pix", "promptpay", "revolut_pay", "sepa_credit_transfer", "sepa_debit", "sofort", "stripe_balance", "swish", "upi", "us_bank_account", "wechat_pay" ], "type": "string", "x-stripeBypassValidation": true }, "nullable": true, "type": "array" }, "save_default_payment_method": { "description": "Configure whether Stripe updates `subscription.default_payment_method` when payment succeeds. Defaults to `off`.", "enum": [ "off", "on_subscription" ], "nullable": true, "type": "string" } }, "required": [ "payment_method_options", "payment_method_types", "save_default_payment_method" ], "title": "SubscriptionsResourcePaymentSettings", "type": "object", "x-expandableFields": [ "payment_method_options" ], "x-stripeMostCommon": [ "payment_method_options", "payment_method_types", "save_default_payment_method" ] }, "subscriptions_resource_pending_update": { "description": "Pending Updates store the changes pending from a previous update that will be applied\nto the Subscription upon successful payment.", "properties": { "billing_cycle_anchor": { "description": "If the update is applied, determines the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. The timestamp is in UTC format.", "format": "unix-time", "nullable": true, "type": "integer" }, "expires_at": { "description": "The point after which the changes reflected by this update will be discarded and no longer applied.", "format": "unix-time", "type": "integer" }, "prebilling_iterations": { "description": "The number of iterations of prebilling to apply.", "nullable": true, "type": "integer" }, "subscription_items": { "description": "List of subscription items, each with an attached plan, that will be set if the update is applied.", "items": { "$ref": "#/components/schemas/subscription_item" }, "nullable": true, "type": "array" }, "trial_end": { "description": "Unix timestamp representing the end of the trial period the customer will get before being charged for the first time, if the update is applied.", "format": "unix-time", "nullable": true, "type": "integer" }, "trial_from_plan": { "description": "Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more.", "nullable": true, "type": "boolean" } }, "required": [ "billing_cycle_anchor", "expires_at", "subscription_items", "trial_end", "trial_from_plan" ], "title": "SubscriptionsResourcePendingUpdate", "type": "object", "x-expandableFields": [ "subscription_items" ], "x-stripeMostCommon": [ "billing_cycle_anchor", "expires_at", "prebilling_iterations", "subscription_items", "trial_end", "trial_from_plan" ] }, "subscriptions_resource_price_migration_error": { "description": "", "properties": { "errored_at": { "description": "The time at which the price migration encountered an error.", "format": "unix-time", "type": "integer" }, "failed_transitions": { "description": "The involved price pairs in each failed transition.", "items": { "$ref": "#/components/schemas/subscriptions_resource_price_migration_error_failed_transition" }, "type": "array" }, "type": { "description": "The type of error encountered by the price migration.", "enum": [ "price_uniqueness_violation" ], "type": "string" } }, "required": [ "errored_at", "failed_transitions", "type" ], "title": "SubscriptionsResourcePriceMigrationError", "type": "object", "x-expandableFields": [ "failed_transitions" ], "x-stripeMostCommon": [ "errored_at", "failed_transitions", "type" ] }, "subscriptions_resource_price_migration_error_failed_transition": { "description": "", "properties": { "source_price": { "description": "The original price to be migrated.", "maxLength": 5000, "type": "string" }, "target_price": { "description": "The intended resulting price of the migration.", "maxLength": 5000, "type": "string" } }, "required": [ "source_price", "target_price" ], "title": "SubscriptionsResourcePriceMigrationErrorFailedTransition", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "source_price", "target_price" ] }, "subscriptions_resource_subscription_invoice_settings": { "description": "", "properties": { "account_tax_ids": { "description": "The account tax IDs associated with the subscription. Will be set on invoices generated by the subscription.", "items": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/tax_id" }, { "$ref": "#/components/schemas/deleted_tax_id" } ], "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/tax_id" }, { "$ref": "#/components/schemas/deleted_tax_id" } ] } }, "nullable": true, "type": "array" }, "issuer": { "$ref": "#/components/schemas/connect_account_reference" } }, "required": [ "account_tax_ids", "issuer" ], "title": "SubscriptionsResourceSubscriptionInvoiceSettings", "type": "object", "x-expandableFields": [ "account_tax_ids", "issuer" ], "x-stripeMostCommon": [ "account_tax_ids", "issuer" ] }, "subscriptions_trials_resource_end_behavior": { "description": "Defines how a subscription behaves when a free trial ends.", "properties": { "missing_payment_method": { "description": "Indicates how the subscription should change when the trial ends if the user did not provide a payment method.", "enum": [ "cancel", "create_invoice", "pause" ], "type": "string" } }, "required": [ "missing_payment_method" ], "title": "SubscriptionsTrialsResourceEndBehavior", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "missing_payment_method" ] }, "subscriptions_trials_resource_trial": { "description": "", "properties": { "converts_to": { "description": "List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial.", "items": { "maxLength": 5000, "type": "string" }, "nullable": true, "type": "array" }, "type": { "description": "Determines the type of trial for this item.", "enum": [ "free", "paid" ], "type": "string" } }, "required": [ "type" ], "title": "SubscriptionsTrialsResourceTrial", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "converts_to", "type" ] }, "subscriptions_trials_resource_trial_settings": { "description": "Configures how this subscription behaves during the trial period.", "properties": { "end_behavior": { "$ref": "#/components/schemas/subscriptions_trials_resource_end_behavior" } }, "required": [ "end_behavior" ], "title": "SubscriptionsTrialsResourceTrialSettings", "type": "object", "x-expandableFields": [ "end_behavior" ], "x-stripeMostCommon": [ "end_behavior" ] }, "tax.association": { "description": "A Tax Association exposes the Tax Transactions that Stripe attempted to create on your behalf based on the PaymentIntent input", "properties": { "calculation": { "description": "The [Tax Calculation](https://stripe.com/docs/api/tax/calculations/object) that was included in PaymentIntent.", "maxLength": 5000, "type": "string" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "tax.association" ], "type": "string" }, "payment_intent": { "description": "The [PaymentIntent](https://stripe.com/docs/api/payment_intents/object) that this Tax Association is tracking.", "maxLength": 5000, "type": "string" }, "tax_transaction_attempts": { "description": "Information about the tax transactions linked to this payment intent", "items": { "$ref": "#/components/schemas/tax_product_resource_tax_association_transaction_attempts" }, "nullable": true, "type": "array" } }, "required": [ "calculation", "id", "object", "payment_intent" ], "title": "TaxProductResourceTaxAssociation", "type": "object", "x-expandableFields": [ "tax_transaction_attempts" ], "x-resourceId": "tax.association", "x-stripeMostCommon": [ "calculation", "id", "payment_intent", "tax_transaction_attempts" ], "x-stripeOperations": [ { "method_name": "find", "method_on": "service", "method_type": "custom", "operation": "get", "path": "/v1/tax/associations/find" } ], "x-stripeResource": { "class_name": "Association", "in_package": "Tax" } }, "tax.calculation": { "description": "A Tax Calculation allows you to calculate the tax to collect from your customer.\n\nRelated guide: [Calculate tax in your custom payment flow](https://stripe.com/docs/tax/custom)", "properties": { "amount_total": { "description": "Total amount after taxes in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "maxLength": 5000, "type": "string" }, "customer": { "description": "The ID of an existing [Customer](https://stripe.com/docs/api/customers/object) used for the resource.", "maxLength": 5000, "nullable": true, "type": "string" }, "customer_details": { "$ref": "#/components/schemas/tax_product_resource_customer_details" }, "expires_at": { "description": "Timestamp of date at which the tax calculation will expire.", "format": "unix-time", "nullable": true, "type": "integer" }, "id": { "description": "Unique identifier for the calculation.", "maxLength": 5000, "nullable": true, "type": "string" }, "line_items": { "description": "The list of items the customer is purchasing.", "nullable": true, "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/tax.calculation_line_item" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/tax/calculations/[^/]+/line_items", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "TaxProductResourceTaxCalculationLineItemList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "tax.calculation" ], "type": "string" }, "ship_from_details": { "anyOf": [ { "$ref": "#/components/schemas/tax_product_resource_ship_from_details" } ], "description": "The details of the ship from location, such as the address.", "nullable": true }, "shipping_cost": { "anyOf": [ { "$ref": "#/components/schemas/tax_product_resource_tax_calculation_shipping_cost" } ], "description": "The shipping cost details for the calculation.", "nullable": true }, "tax_amount_exclusive": { "description": "The amount of tax to be collected on top of the line item prices.", "type": "integer" }, "tax_amount_inclusive": { "description": "The amount of tax already included in the line item prices.", "type": "integer" }, "tax_breakdown": { "description": "Breakdown of individual tax amounts that add up to the total.", "items": { "$ref": "#/components/schemas/tax_product_resource_tax_breakdown" }, "type": "array" }, "tax_date": { "description": "Timestamp of date at which the tax rules and rates in effect applies for the calculation.", "format": "unix-time", "type": "integer" } }, "required": [ "amount_total", "currency", "customer", "customer_details", "expires_at", "id", "livemode", "object", "ship_from_details", "shipping_cost", "tax_amount_exclusive", "tax_amount_inclusive", "tax_breakdown", "tax_date" ], "title": "TaxProductResourceTaxCalculation", "type": "object", "x-expandableFields": [ "customer_details", "line_items", "ship_from_details", "shipping_cost", "tax_breakdown" ], "x-resourceId": "tax.calculation", "x-stripeMostCommon": [ "amount_total", "currency", "customer_details", "expires_at", "id", "line_items", "object", "shipping_cost", "tax_amount_exclusive", "tax_amount_inclusive", "tax_breakdown" ], "x-stripeOperations": [ { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/tax/calculations/{calculation}" }, { "method_name": "list_line_items", "method_on": "service", "method_type": "custom", "operation": "get", "path": "/v1/tax/calculations/{calculation}/line_items" }, { "method_name": "create", "method_on": "service", "method_type": "create", "operation": "post", "path": "/v1/tax/calculations" } ], "x-stripeResource": { "class_name": "Calculation", "in_package": "Tax" } }, "tax.calculation_line_item": { "description": "", "properties": { "amount": { "description": "The line item amount in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount.", "type": "integer" }, "amount_tax": { "description": "The amount of tax calculated for this line item, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", "type": "integer" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "nullable": true, "type": "object" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "tax.calculation_line_item" ], "type": "string" }, "product": { "description": "The ID of an existing [Product](https://stripe.com/docs/api/products/object).", "maxLength": 5000, "nullable": true, "type": "string" }, "quantity": { "description": "The number of units of the item being purchased. For reversals, this is the quantity reversed.", "type": "integer" }, "reference": { "description": "A custom identifier for this line item.", "maxLength": 5000, "type": "string" }, "tax_behavior": { "description": "Specifies whether the `amount` includes taxes. If `tax_behavior=inclusive`, then the amount includes taxes.", "enum": [ "exclusive", "inclusive" ], "type": "string" }, "tax_breakdown": { "description": "Detailed account of taxes relevant to this line item.", "items": { "$ref": "#/components/schemas/tax_product_resource_line_item_tax_breakdown" }, "nullable": true, "type": "array" }, "tax_code": { "description": "The [tax code](https://stripe.com/docs/tax/tax-categories) ID used for this resource.", "maxLength": 5000, "type": "string" } }, "required": [ "amount", "amount_tax", "id", "livemode", "metadata", "object", "product", "quantity", "reference", "tax_behavior", "tax_code" ], "title": "TaxProductResourceTaxCalculationLineItem", "type": "object", "x-expandableFields": [ "tax_breakdown" ], "x-resourceId": "tax.calculation_line_item", "x-stripeMostCommon": [ "amount", "amount_tax", "id", "livemode", "metadata", "object", "product", "quantity", "reference", "tax_behavior", "tax_breakdown", "tax_code" ], "x-stripeResource": { "class_name": "CalculationLineItem", "has_collection_class": true, "in_package": "Tax" } }, "tax.form": { "description": "Tax forms are legal documents which are delivered to one or more tax authorities for information reporting purposes.\n\nRelated guide: [US tax reporting for Connect platforms](https://stripe.com/docs/connect/tax-reporting)", "properties": { "au_serr": { "$ref": "#/components/schemas/tax_reporting_resource_tax_form_au_serr" }, "ca_mrdp": { "$ref": "#/components/schemas/tax_reporting_resource_tax_form_ca_mrdp" }, "corrected_by": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/tax.form" } ], "description": "The form that corrects this form, if any.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/tax.form" } ] } }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "eu_dac7": { "$ref": "#/components/schemas/tax_reporting_resource_tax_form_eu_dac7" }, "filing_statuses": { "description": "A list of tax filing statuses. Note that a filing status will only be included if the form has been filed directly with the jurisdiction’s tax authority.", "items": { "$ref": "#/components/schemas/tax_reporting_resource_tax_form_filing_status" }, "type": "array" }, "gb_mrdp": { "$ref": "#/components/schemas/tax_reporting_resource_tax_form_gb_mrdp" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "nz_mrdp": { "$ref": "#/components/schemas/tax_reporting_resource_tax_form_nz_mrdp" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "tax.form" ], "type": "string" }, "payee": { "$ref": "#/components/schemas/tax_reporting_resource_tax_form_payee" }, "type": { "description": "The type of the tax form. An additional hash is included on the tax form with a name matching this value. It contains additional information specific to the tax form type.", "enum": [ "au_serr", "ca_mrdp", "eu_dac7", "gb_mrdp", "nz_mrdp", "us_1099_k", "us_1099_misc", "us_1099_nec" ], "type": "string" }, "us_1099_k": { "$ref": "#/components/schemas/tax_reporting_resource_tax_form_us1099_k" }, "us_1099_misc": { "$ref": "#/components/schemas/tax_reporting_resource_tax_form_us1099_misc" }, "us_1099_nec": { "$ref": "#/components/schemas/tax_reporting_resource_tax_form_us1099_nec" } }, "required": [ "corrected_by", "created", "filing_statuses", "id", "livemode", "object", "payee", "type" ], "title": "TaxForm", "type": "object", "x-expandableFields": [ "au_serr", "ca_mrdp", "corrected_by", "eu_dac7", "filing_statuses", "gb_mrdp", "nz_mrdp", "payee", "us_1099_k", "us_1099_misc", "us_1099_nec" ], "x-resourceId": "tax.form", "x-stripeMostCommon": [ "corrected_by", "filing_statuses", "id", "payee", "type" ], "x-stripeOperations": [ { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/tax/forms" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/tax/forms/{id}" }, { "method_name": "pdf", "method_on": "service", "method_type": "custom", "operation": "get", "path": "/v1/tax/forms/{id}/pdf" } ], "x-stripeResource": { "class_name": "Form", "has_collection_class": true, "in_package": "Tax" } }, "tax.form.updated": { "description": "Occurs when a tax form is updated.", "properties": { "object": { "$ref": "#/components/schemas/tax.form" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "tax.form.updated" } }, "tax.registration": { "description": "A Tax `Registration` lets us know that your business is registered to collect tax on payments within a region, enabling you to [automatically collect tax](https://stripe.com/docs/tax).\n\nStripe doesn't register on your behalf with the relevant authorities when you create a Tax `Registration` object. For more information on how to register to collect tax, see [our guide](https://stripe.com/docs/tax/registering).\n\nRelated guide: [Using the Registrations API](https://stripe.com/docs/tax/registrations-api)", "properties": { "active_from": { "description": "Time at which the registration becomes active. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "country_options": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "expires_at": { "description": "If set, the registration stops being active at this time. If not set, the registration will be active indefinitely. Measured in seconds since the Unix epoch.", "format": "unix-time", "nullable": true, "type": "integer" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "tax.registration" ], "type": "string" }, "status": { "description": "The status of the registration. This field is present for convenience and can be deduced from `active_from` and `expires_at`.", "enum": [ "active", "expired", "scheduled" ], "type": "string" } }, "required": [ "active_from", "country", "country_options", "created", "expires_at", "id", "livemode", "object", "status" ], "title": "TaxProductRegistrationsResourceTaxRegistration", "type": "object", "x-expandableFields": [ "country_options" ], "x-resourceId": "tax.registration", "x-stripeMostCommon": [ "active_from", "country", "country_options", "created", "expires_at", "id", "livemode", "object", "status" ], "x-stripeOperations": [ { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/tax/registrations" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/tax/registrations/{id}" }, { "method_name": "create", "method_on": "service", "method_type": "create", "operation": "post", "path": "/v1/tax/registrations" }, { "method_name": "update", "method_on": "service", "method_type": "update", "operation": "post", "path": "/v1/tax/registrations/{id}" } ], "x-stripeResource": { "class_name": "Registration", "has_collection_class": true, "in_package": "Tax" } }, "tax.settings": { "description": "You can use Tax `Settings` to manage configurations used by Stripe Tax calculations.\n\nRelated guide: [Using the Settings API](https://stripe.com/docs/tax/settings-api)", "properties": { "defaults": { "$ref": "#/components/schemas/tax_product_resource_tax_settings_defaults" }, "head_office": { "anyOf": [ { "$ref": "#/components/schemas/tax_product_resource_tax_settings_head_office" } ], "description": "The place where your business is located.", "nullable": true }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "tax.settings" ], "type": "string" }, "status": { "description": "The status of the Tax `Settings`.", "enum": [ "active", "pending" ], "type": "string" }, "status_details": { "$ref": "#/components/schemas/tax_product_resource_tax_settings_status_details" } }, "required": [ "defaults", "head_office", "livemode", "object", "status", "status_details" ], "title": "TaxProductResourceTaxSettings", "type": "object", "x-expandableFields": [ "defaults", "head_office", "status_details" ], "x-resourceId": "tax.settings", "x-stripeMostCommon": [ "defaults", "head_office", "livemode", "object", "status", "status_details" ], "x-stripeOperations": [ { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/tax/settings" }, { "method_name": "update", "method_on": "service", "method_type": "update", "operation": "post", "path": "/v1/tax/settings" } ], "x-stripeResource": { "class_name": "Settings", "in_package": "Tax" } }, "tax.settings.updated": { "description": "Occurs whenever tax settings is updated.", "properties": { "object": { "$ref": "#/components/schemas/tax.settings" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "tax.settings.updated" } }, "tax.transaction": { "description": "A Tax Transaction records the tax collected from or refunded to your customer.\n\nRelated guide: [Calculate tax in your custom payment flow](https://stripe.com/docs/tax/custom#tax-transaction)", "properties": { "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "maxLength": 5000, "type": "string" }, "customer": { "description": "The ID of an existing [Customer](https://stripe.com/docs/api/customers/object) used for the resource.", "maxLength": 5000, "nullable": true, "type": "string" }, "customer_details": { "$ref": "#/components/schemas/tax_product_resource_customer_details" }, "id": { "description": "Unique identifier for the transaction.", "maxLength": 5000, "type": "string" }, "line_items": { "description": "The tax collected or refunded, by line item.", "nullable": true, "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/tax.transaction_line_item" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/tax/transactions/[^/]+/line_items", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "TaxProductResourceTaxTransactionLineItemList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "nullable": true, "type": "object" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "tax.transaction" ], "type": "string" }, "posted_at": { "description": "The Unix timestamp representing when the tax liability is assumed or reduced.", "format": "unix-time", "type": "integer" }, "reference": { "description": "A custom unique identifier, such as 'myOrder_123'.", "maxLength": 5000, "type": "string" }, "reversal": { "anyOf": [ { "$ref": "#/components/schemas/tax_product_resource_tax_transaction_resource_reversal" } ], "description": "If `type=reversal`, contains information about what was reversed.", "nullable": true }, "ship_from_details": { "anyOf": [ { "$ref": "#/components/schemas/tax_product_resource_ship_from_details" } ], "description": "The details of the ship from location, such as the address.", "nullable": true }, "shipping_cost": { "anyOf": [ { "$ref": "#/components/schemas/tax_product_resource_tax_transaction_shipping_cost" } ], "description": "The shipping cost details for the transaction.", "nullable": true }, "tax_date": { "description": "Timestamp of date at which the tax rules and rates in effect applies for the calculation.", "format": "unix-time", "type": "integer" }, "type": { "description": "If `reversal`, this transaction reverses an earlier transaction.", "enum": [ "reversal", "transaction" ], "type": "string" } }, "required": [ "created", "currency", "customer", "customer_details", "id", "livemode", "metadata", "object", "posted_at", "reference", "reversal", "ship_from_details", "shipping_cost", "tax_date", "type" ], "title": "TaxProductResourceTaxTransaction", "type": "object", "x-expandableFields": [ "customer_details", "line_items", "reversal", "ship_from_details", "shipping_cost" ], "x-resourceId": "tax.transaction", "x-stripeMostCommon": [ "currency", "customer_details", "id", "line_items", "metadata", "object", "reference", "type" ], "x-stripeOperations": [ { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/tax/transactions/{transaction}" }, { "method_name": "list_line_items", "method_on": "service", "method_type": "custom", "operation": "get", "path": "/v1/tax/transactions/{transaction}/line_items" }, { "method_name": "create_from_calculation", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/tax/transactions/create_from_calculation" }, { "method_name": "create_reversal", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/tax/transactions/create_reversal" } ], "x-stripeResource": { "class_name": "Transaction", "in_package": "Tax" } }, "tax.transaction_line_item": { "description": "", "properties": { "amount": { "description": "The line item amount in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount.", "type": "integer" }, "amount_tax": { "description": "The amount of tax calculated for this line item, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", "type": "integer" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "nullable": true, "type": "object" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "tax.transaction_line_item" ], "type": "string" }, "product": { "description": "The ID of an existing [Product](https://stripe.com/docs/api/products/object).", "maxLength": 5000, "nullable": true, "type": "string" }, "quantity": { "description": "The number of units of the item being purchased. For reversals, this is the quantity reversed.", "type": "integer" }, "reference": { "description": "A custom identifier for this line item in the transaction.", "maxLength": 5000, "type": "string" }, "reversal": { "anyOf": [ { "$ref": "#/components/schemas/tax_product_resource_tax_transaction_line_item_resource_reversal" } ], "description": "If `type=reversal`, contains information about what was reversed.", "nullable": true }, "tax_behavior": { "description": "Specifies whether the `amount` includes taxes. If `tax_behavior=inclusive`, then the amount includes taxes.", "enum": [ "exclusive", "inclusive" ], "type": "string" }, "tax_code": { "description": "The [tax code](https://stripe.com/docs/tax/tax-categories) ID used for this resource.", "maxLength": 5000, "type": "string" }, "type": { "description": "If `reversal`, this line item reverses an earlier transaction.", "enum": [ "reversal", "transaction" ], "type": "string" } }, "required": [ "amount", "amount_tax", "id", "livemode", "metadata", "object", "product", "quantity", "reference", "reversal", "tax_behavior", "tax_code", "type" ], "title": "TaxProductResourceTaxTransactionLineItem", "type": "object", "x-expandableFields": [ "reversal" ], "x-resourceId": "tax.transaction_line_item", "x-stripeMostCommon": [ "amount", "amount_tax", "id", "livemode", "metadata", "object", "product", "quantity", "reference", "reversal", "tax_behavior", "tax_code", "type" ], "x-stripeResource": { "class_name": "TransactionLineItem", "has_collection_class": true, "in_package": "Tax" } }, "tax_code": { "description": "[Tax codes](https://stripe.com/docs/tax/tax-categories) classify goods and services for tax purposes.", "properties": { "description": { "description": "A detailed description of which types of products the tax code represents.", "maxLength": 5000, "type": "string" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "name": { "description": "A short name for the tax code.", "maxLength": 5000, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "tax_code" ], "type": "string" } }, "required": [ "description", "id", "name", "object" ], "title": "TaxProductResourceTaxCode", "type": "object", "x-expandableFields": [], "x-resourceId": "tax_code", "x-stripeMostCommon": [ "description", "id", "name", "object" ], "x-stripeOperations": [ { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/tax_codes" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/tax_codes/{id}" } ], "x-stripeResource": { "class_name": "TaxCode", "has_collection_class": true, "in_package": "" } }, "tax_deducted_at_source": { "description": "", "properties": { "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "tax_deducted_at_source" ], "type": "string" }, "period_end": { "description": "The end of the invoicing period. This TDS applies to Stripe fees collected during this invoicing period.", "format": "unix-time", "type": "integer" }, "period_start": { "description": "The start of the invoicing period. This TDS applies to Stripe fees collected during this invoicing period.", "format": "unix-time", "type": "integer" }, "tax_deduction_account_number": { "description": "The TAN that was supplied to Stripe when TDS was assessed", "maxLength": 5000, "type": "string" } }, "required": [ "id", "object", "period_end", "period_start", "tax_deduction_account_number" ], "title": "TaxDeductedAtSource", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "id", "object", "period_end", "period_start", "tax_deduction_account_number" ], "x-stripeResource": { "class_name": "TaxDeductedAtSource", "in_package": "", "polymorphic_groups": [ "balance_transaction_source" ] } }, "tax_i_ds_owner": { "description": "", "properties": { "account": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/account" } ], "description": "The account being referenced when `type` is `account`.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/account" } ] } }, "application": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/application" } ], "description": "The Connect Application being referenced when `type` is `application`.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/application" } ] } }, "customer": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/customer" } ], "description": "The customer being referenced when `type` is `customer`.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/customer" } ] } }, "customer_account": { "description": "The account being referenced when `type` is `customer`.", "maxLength": 5000, "nullable": true, "type": "string" }, "type": { "description": "Type of owner referenced.", "enum": [ "account", "application", "customer", "self" ], "type": "string" } }, "required": [ "type" ], "title": "TaxIDsOwner", "type": "object", "x-expandableFields": [ "account", "application", "customer" ], "x-stripeMostCommon": [ "account", "application", "customer", "customer_account", "type" ] }, "tax_id": { "description": "You can add one or multiple tax IDs to a [customer](https://stripe.com/docs/api/customers) or account.\nCustomer and account tax IDs get displayed on related invoices and credit notes.\n\nRelated guides: [Customer tax identification numbers](https://stripe.com/docs/billing/taxes/tax-ids), [Account tax IDs](https://stripe.com/docs/invoicing/connect#account-tax-ids)", "properties": { "country": { "description": "Two-letter ISO code representing the country of the tax ID.", "maxLength": 5000, "nullable": true, "type": "string" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "customer": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/customer" } ], "description": "ID of the customer.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/customer" } ] } }, "customer_account": { "description": "ID of the account.", "maxLength": 5000, "nullable": true, "type": "string" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "tax_id" ], "type": "string" }, "owner": { "anyOf": [ { "$ref": "#/components/schemas/tax_i_ds_owner" } ], "description": "The account or customer the tax ID belongs to.", "nullable": true }, "type": { "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `aw_tin`, `az_tin`, `ba_tin`, `bb_tin`, `bd_bin`, `bf_ifu`, `bg_uic`, `bh_vat`, `bj_ifu`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cm_niu`, `cn_tin`, `co_nit`, `cr_tin`, `cv_nif`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `et_tin`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kg_tin`, `kh_tin`, `kr_brn`, `kz_bin`, `la_tin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin`. Note that some legacy tax IDs have type `unknown`", "enum": [ "ad_nrt", "ae_trn", "al_tin", "am_tin", "ao_tin", "ar_cuit", "au_abn", "au_arn", "aw_tin", "az_tin", "ba_tin", "bb_tin", "bd_bin", "bf_ifu", "bg_uic", "bh_vat", "bj_ifu", "bo_tin", "br_cnpj", "br_cpf", "bs_tin", "by_tin", "ca_bn", "ca_gst_hst", "ca_pst_bc", "ca_pst_mb", "ca_pst_sk", "ca_qst", "cd_nif", "ch_uid", "ch_vat", "cl_tin", "cm_niu", "cn_tin", "co_nit", "cr_tin", "cv_nif", "de_stn", "do_rcn", "ec_ruc", "eg_tin", "es_cif", "et_tin", "eu_oss_vat", "eu_vat", "gb_vat", "ge_vat", "gn_nif", "hk_br", "hr_oib", "hu_tin", "id_npwp", "il_vat", "in_gst", "is_vat", "jp_cn", "jp_rn", "jp_trn", "ke_pin", "kg_tin", "kh_tin", "kr_brn", "kz_bin", "la_tin", "li_uid", "li_vat", "ma_vat", "md_vat", "me_pib", "mk_vat", "mr_nif", "mx_rfc", "my_frp", "my_itn", "my_sst", "ng_tin", "no_vat", "no_voec", "np_pan", "nz_gst", "om_vat", "pe_ruc", "ph_tin", "ro_tin", "rs_pib", "ru_inn", "ru_kpp", "sa_vat", "sg_gst", "sg_uen", "si_tin", "sn_ninea", "sr_fin", "sv_nit", "th_vat", "tj_tin", "tr_tin", "tw_vat", "tz_vat", "ua_vat", "ug_tin", "unknown", "us_ein", "uy_ruc", "uz_tin", "uz_vat", "ve_rif", "vn_tin", "za_vat", "zm_tin", "zw_tin" ], "type": "string" }, "value": { "description": "Value of the tax ID.", "maxLength": 5000, "type": "string" }, "verification": { "anyOf": [ { "$ref": "#/components/schemas/tax_id_verification" } ], "description": "Tax ID verification information.", "nullable": true } }, "required": [ "country", "created", "customer", "id", "livemode", "object", "owner", "type", "value", "verification" ], "title": "tax_id", "type": "object", "x-expandableFields": [ "customer", "owner", "verification" ], "x-resourceId": "tax_id", "x-stripeMostCommon": [ "country", "customer", "id", "type", "value" ], "x-stripeOperations": [ { "method_name": "delete", "method_on": "service", "method_type": "delete", "operation": "delete", "path": "/v1/customers/{customer}/tax_ids/{id}" }, { "method_name": "delete", "method_on": "service", "method_type": "delete", "operation": "delete", "path": "/v1/tax_ids/{id}" }, { "method_name": "list", "method_on": "collection", "method_type": "list", "operation": "get", "path": "/v1/customers/{customer}/tax_ids" }, { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/customers/{customer}/tax_ids" }, { "method_name": "retrieve", "method_on": "collection", "method_type": "retrieve", "operation": "get", "path": "/v1/customers/{customer}/tax_ids/{id}" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/customers/{customer}/tax_ids/{id}" }, { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/tax_ids" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/tax_ids/{id}" }, { "method_name": "create", "method_on": "collection", "method_type": "create", "operation": "post", "path": "/v1/customers/{customer}/tax_ids", "shared_version_of": "tax_id" }, { "method_name": "create", "method_on": "service", "method_type": "create", "operation": "post", "path": "/v1/customers/{customer}/tax_ids", "shared_version_of": "tax_id" }, { "method_name": "create", "method_on": "service", "method_type": "create", "operation": "post", "path": "/v1/tax_ids" } ], "x-stripeResource": { "class_name": "TaxId", "has_collection_class": true, "in_package": "" } }, "tax_id_verification": { "description": "", "properties": { "status": { "description": "Verification status, one of `pending`, `verified`, `unverified`, or `unavailable`.", "enum": [ "pending", "unavailable", "unverified", "verified" ], "type": "string" }, "verified_address": { "description": "Verified address.", "maxLength": 5000, "nullable": true, "type": "string" }, "verified_name": { "description": "Verified name.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "status", "verified_address", "verified_name" ], "title": "tax_id_verification", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "status", "verified_address", "verified_name" ] }, "tax_product_integration_resource_tax_calculation_reference": { "description": "", "properties": { "calculation_id": { "description": "The calculation identifier for tax calculation response.", "maxLength": 5000, "nullable": true, "type": "string" }, "calculation_item_id": { "description": "The calculation identifier for tax calculation response line item.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "calculation_id", "calculation_item_id" ], "title": "TaxProductIntegrationResourceTaxCalculationReference", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "calculation_id", "calculation_item_id" ] }, "tax_product_registrations_resource_country_options": { "description": "", "properties": { "ae": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default_inbound_goods" }, "al": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default" }, "am": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" }, "ao": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default" }, "at": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe" }, "au": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default_inbound_goods" }, "aw": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default" }, "az": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" }, "ba": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default" }, "bb": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default" }, "bd": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default" }, "be": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe" }, "bf": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default" }, "bg": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe" }, "bh": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default" }, "bj": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" }, "bs": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default" }, "by": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" }, "ca": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_canada" }, "cd": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default" }, "ch": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default_inbound_goods" }, "cl": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" }, "cm": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" }, "co": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" }, "cr": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" }, "cv": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" }, "cy": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe" }, "cz": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe" }, "de": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe" }, "dk": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe" }, "ec": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" }, "ee": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe" }, "eg": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" }, "es": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe" }, "et": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default" }, "fi": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe" }, "fr": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe" }, "gb": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default_inbound_goods" }, "ge": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" }, "gn": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default" }, "gr": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe" }, "hr": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe" }, "hu": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe" }, "id": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" }, "ie": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe" }, "in": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" }, "is": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default" }, "it": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe" }, "jp": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default_inbound_goods" }, "ke": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" }, "kg": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" }, "kh": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" }, "kr": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" }, "kz": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" }, "la": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" }, "lt": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe" }, "lu": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe" }, "lv": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe" }, "ma": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" }, "md": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" }, "me": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default" }, "mk": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default" }, "mr": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default" }, "mt": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe" }, "mx": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" }, "my": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" }, "ng": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" }, "nl": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe" }, "no": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default_inbound_goods" }, "np": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" }, "nz": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default_inbound_goods" }, "om": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default" }, "pe": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" }, "ph": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" }, "pl": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe" }, "pt": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe" }, "ro": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe" }, "rs": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default" }, "ru": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" }, "sa": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" }, "se": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe" }, "sg": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default_inbound_goods" }, "si": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe" }, "sk": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe" }, "sn": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" }, "sr": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default" }, "th": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" }, "tj": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" }, "tr": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" }, "tz": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" }, "ua": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" }, "ug": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" }, "us": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_united_states" }, "uy": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default" }, "uz": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" }, "vn": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" }, "za": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default" }, "zm": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" }, "zw": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default" } }, "title": "TaxProductRegistrationsResourceCountryOptions", "type": "object", "x-expandableFields": [ "ae", "al", "am", "ao", "at", "au", "aw", "az", "ba", "bb", "bd", "be", "bf", "bg", "bh", "bj", "bs", "by", "ca", "cd", "ch", "cl", "cm", "co", "cr", "cv", "cy", "cz", "de", "dk", "ec", "ee", "eg", "es", "et", "fi", "fr", "gb", "ge", "gn", "gr", "hr", "hu", "id", "ie", "in", "is", "it", "jp", "ke", "kg", "kh", "kr", "kz", "la", "lt", "lu", "lv", "ma", "md", "me", "mk", "mr", "mt", "mx", "my", "ng", "nl", "no", "np", "nz", "om", "pe", "ph", "pl", "pt", "ro", "rs", "ru", "sa", "se", "sg", "si", "sk", "sn", "sr", "th", "tj", "tr", "tz", "ua", "ug", "us", "uy", "uz", "vn", "za", "zm", "zw" ], "x-stripeMostCommon": [ "ae", "al", "am", "ao", "at", "au", "aw", "az", "ba", "bb", "bd", "be", "bf", "bg", "bh", "bj", "bs", "by", "ca", "cd", "ch", "cl", "cm", "co", "cr", "cv", "cy", "cz", "de", "dk", "ec", "ee", "eg", "es", "et", "fi", "fr", "gb", "ge", "gn", "gr", "hr", "hu", "id", "ie", "in", "is", "it", "jp", "ke", "kg", "kh", "kr", "kz", "la", "lt", "lu", "lv", "ma", "md", "me", "mk", "mr", "mt", "mx", "my", "ng", "nl", "no", "np", "nz", "om", "pe", "ph", "pl", "pt", "ro", "rs", "ru", "sa", "se", "sg", "si", "sk", "sn", "sr", "th", "tj", "tr", "tz", "ua", "ug", "us", "uy", "uz", "vn", "za", "zm", "zw" ] }, "tax_product_registrations_resource_country_options_ca_province_standard": { "description": "", "properties": { "province": { "description": "Two-letter CA province code ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).", "maxLength": 5000, "type": "string" } }, "required": [ "province" ], "title": "TaxProductRegistrationsResourceCountryOptionsCaProvinceStandard", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "province" ] }, "tax_product_registrations_resource_country_options_canada": { "description": "", "properties": { "province_standard": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_ca_province_standard" }, "type": { "description": "Type of registration in Canada.", "enum": [ "province_standard", "simplified", "standard" ], "type": "string" } }, "required": [ "type" ], "title": "TaxProductRegistrationsResourceCountryOptionsCanada", "type": "object", "x-expandableFields": [ "province_standard" ], "x-stripeMostCommon": [ "province_standard", "type" ] }, "tax_product_registrations_resource_country_options_default": { "description": "", "properties": { "type": { "description": "Type of registration in `country`.", "enum": [ "standard" ], "type": "string" } }, "required": [ "type" ], "title": "TaxProductRegistrationsResourceCountryOptionsDefault", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "type" ] }, "tax_product_registrations_resource_country_options_default_inbound_goods": { "description": "", "properties": { "standard": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default_standard" }, "type": { "description": "Type of registration in `country`.", "enum": [ "standard" ], "type": "string" } }, "required": [ "type" ], "title": "TaxProductRegistrationsResourceCountryOptionsDefaultInboundGoods", "type": "object", "x-expandableFields": [ "standard" ], "x-stripeMostCommon": [ "standard", "type" ] }, "tax_product_registrations_resource_country_options_default_standard": { "description": "", "properties": { "place_of_supply_scheme": { "description": "Place of supply scheme used in an Default standard registration.", "enum": [ "inbound_goods", "standard" ], "type": "string" } }, "required": [ "place_of_supply_scheme" ], "title": "TaxProductRegistrationsResourceCountryOptionsDefaultStandard", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "place_of_supply_scheme" ] }, "tax_product_registrations_resource_country_options_eu_standard": { "description": "", "properties": { "place_of_supply_scheme": { "description": "Place of supply scheme used in an EU standard registration.", "enum": [ "inbound_goods", "small_seller", "standard" ], "type": "string" } }, "required": [ "place_of_supply_scheme" ], "title": "TaxProductRegistrationsResourceCountryOptionsEuStandard", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "place_of_supply_scheme" ] }, "tax_product_registrations_resource_country_options_europe": { "description": "", "properties": { "standard": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_eu_standard" }, "type": { "description": "Type of registration in an EU country.", "enum": [ "ioss", "oss_non_union", "oss_union", "standard" ], "type": "string" } }, "required": [ "type" ], "title": "TaxProductRegistrationsResourceCountryOptionsEurope", "type": "object", "x-expandableFields": [ "standard" ], "x-stripeMostCommon": [ "standard", "type" ] }, "tax_product_registrations_resource_country_options_simplified": { "description": "", "properties": { "type": { "description": "Type of registration in `country`.", "enum": [ "simplified" ], "type": "string" } }, "required": [ "type" ], "title": "TaxProductRegistrationsResourceCountryOptionsSimplified", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "type" ] }, "tax_product_registrations_resource_country_options_united_states": { "description": "", "properties": { "local_amusement_tax": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_us_local_amusement_tax" }, "local_lease_tax": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_us_local_lease_tax" }, "state": { "description": "Two-letter US state code ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).", "maxLength": 5000, "type": "string" }, "state_sales_tax": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_us_state_sales_tax" }, "type": { "description": "Type of registration in the US.", "enum": [ "local_amusement_tax", "local_lease_tax", "state_communications_tax", "state_retail_delivery_fee", "state_sales_tax" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "state", "type" ], "title": "TaxProductRegistrationsResourceCountryOptionsUnitedStates", "type": "object", "x-expandableFields": [ "local_amusement_tax", "local_lease_tax", "state_sales_tax" ], "x-stripeMostCommon": [ "local_amusement_tax", "local_lease_tax", "state", "state_sales_tax", "type" ] }, "tax_product_registrations_resource_country_options_us_local_amusement_tax": { "description": "", "properties": { "jurisdiction": { "description": "A [FIPS code](https://www.census.gov/library/reference/code-lists/ansi.html) representing the local jurisdiction.", "maxLength": 5000, "type": "string" } }, "required": [ "jurisdiction" ], "title": "TaxProductRegistrationsResourceCountryOptionsUsLocalAmusementTax", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "jurisdiction" ] }, "tax_product_registrations_resource_country_options_us_local_lease_tax": { "description": "", "properties": { "jurisdiction": { "description": "A [FIPS code](https://www.census.gov/library/reference/code-lists/ansi.html) representing the local jurisdiction.", "maxLength": 5000, "type": "string" } }, "required": [ "jurisdiction" ], "title": "TaxProductRegistrationsResourceCountryOptionsUsLocalLeaseTax", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "jurisdiction" ] }, "tax_product_registrations_resource_country_options_us_state_sales_tax": { "description": "", "properties": { "elections": { "description": "Elections for the state sales tax registration.", "items": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_us_state_sales_tax_election" }, "type": "array" } }, "title": "TaxProductRegistrationsResourceCountryOptionsUsStateSalesTax", "type": "object", "x-expandableFields": [ "elections" ], "x-stripeMostCommon": [ "elections" ] }, "tax_product_registrations_resource_country_options_us_state_sales_tax_election": { "description": "", "properties": { "jurisdiction": { "description": "A [FIPS code](https://www.census.gov/library/reference/code-lists/ansi.html) representing the local jurisdiction.", "maxLength": 5000, "type": "string" }, "type": { "description": "The type of the election for the state sales tax registration.", "enum": [ "local_use_tax", "simplified_sellers_use_tax", "single_local_use_tax" ], "type": "string" } }, "required": [ "type" ], "title": "TaxProductRegistrationsResourceCountryOptionsUsStateSalesTaxElection", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "jurisdiction", "type" ] }, "tax_product_resource_customer_details": { "description": "", "properties": { "address": { "anyOf": [ { "$ref": "#/components/schemas/tax_product_resource_postal_address" } ], "description": "The customer's postal address (for example, home or business location).", "nullable": true }, "address_source": { "description": "The type of customer address provided.", "enum": [ "billing", "shipping" ], "nullable": true, "type": "string" }, "ip_address": { "description": "The customer's IP address (IPv4 or IPv6).", "maxLength": 5000, "nullable": true, "type": "string" }, "tax_ids": { "description": "The customer's tax IDs (for example, EU VAT numbers).", "items": { "$ref": "#/components/schemas/tax_product_resource_customer_details_resource_tax_id" }, "type": "array" }, "taxability_override": { "description": "The taxability override used for taxation.", "enum": [ "customer_exempt", "none", "reverse_charge" ], "type": "string" } }, "required": [ "address", "address_source", "ip_address", "tax_ids", "taxability_override" ], "title": "TaxProductResourceCustomerDetails", "type": "object", "x-expandableFields": [ "address", "tax_ids" ], "x-stripeMostCommon": [ "address", "address_source", "ip_address", "tax_ids", "taxability_override" ] }, "tax_product_resource_customer_details_resource_tax_id": { "description": "", "properties": { "type": { "description": "The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `al_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, `aw_tin`, `az_tin`, `bd_bin`, `bj_ifu`, `et_tin`, `kg_tin`, `la_tin`, `cm_niu`, `cv_nif`, `bf_ifu`, or `unknown`", "enum": [ "ad_nrt", "ae_trn", "al_tin", "am_tin", "ao_tin", "ar_cuit", "au_abn", "au_arn", "aw_tin", "az_tin", "ba_tin", "bb_tin", "bd_bin", "bf_ifu", "bg_uic", "bh_vat", "bj_ifu", "bo_tin", "br_cnpj", "br_cpf", "bs_tin", "by_tin", "ca_bn", "ca_gst_hst", "ca_pst_bc", "ca_pst_mb", "ca_pst_sk", "ca_qst", "cd_nif", "ch_uid", "ch_vat", "cl_tin", "cm_niu", "cn_tin", "co_nit", "cr_tin", "cv_nif", "de_stn", "do_rcn", "ec_ruc", "eg_tin", "es_cif", "et_tin", "eu_oss_vat", "eu_vat", "gb_vat", "ge_vat", "gn_nif", "hk_br", "hr_oib", "hu_tin", "id_npwp", "il_vat", "in_gst", "is_vat", "jp_cn", "jp_rn", "jp_trn", "ke_pin", "kg_tin", "kh_tin", "kr_brn", "kz_bin", "la_tin", "li_uid", "li_vat", "ma_vat", "md_vat", "me_pib", "mk_vat", "mr_nif", "mx_rfc", "my_frp", "my_itn", "my_sst", "ng_tin", "no_vat", "no_voec", "np_pan", "nz_gst", "om_vat", "pe_ruc", "ph_tin", "ro_tin", "rs_pib", "ru_inn", "ru_kpp", "sa_vat", "sg_gst", "sg_uen", "si_tin", "sn_ninea", "sr_fin", "sv_nit", "th_vat", "tj_tin", "tr_tin", "tw_vat", "tz_vat", "ua_vat", "ug_tin", "unknown", "us_ein", "uy_ruc", "uz_tin", "uz_vat", "ve_rif", "vn_tin", "za_vat", "zm_tin", "zw_tin" ], "type": "string" }, "value": { "description": "The value of the tax ID.", "maxLength": 5000, "type": "string" } }, "required": [ "type", "value" ], "title": "TaxProductResourceCustomerDetailsResourceTaxId", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "type", "value" ] }, "tax_product_resource_jurisdiction": { "description": "", "properties": { "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "display_name": { "description": "A human-readable name for the jurisdiction imposing the tax.", "maxLength": 5000, "type": "string" }, "level": { "description": "Indicates the level of the jurisdiction imposing the tax.", "enum": [ "city", "country", "county", "district", "state" ], "type": "string" }, "state": { "description": "[ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2), without country prefix. For example, \"NY\" for New York, United States.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "country", "display_name", "level", "state" ], "title": "TaxProductResourceJurisdiction", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "country", "display_name", "level", "state" ] }, "tax_product_resource_line_item_tax_breakdown": { "description": "", "properties": { "amount": { "description": "The amount of tax, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", "type": "integer" }, "jurisdiction": { "$ref": "#/components/schemas/tax_product_resource_jurisdiction" }, "sourcing": { "description": "Indicates whether the jurisdiction was determined by the origin (merchant's address) or destination (customer's address).", "enum": [ "destination", "origin" ], "type": "string", "x-stripeBypassValidation": true }, "tax_rate_details": { "anyOf": [ { "$ref": "#/components/schemas/tax_product_resource_line_item_tax_rate_details" } ], "description": "Details regarding the rate for this tax. This field will be `null` when the tax is not imposed, for example if the product is exempt from tax.", "nullable": true }, "taxability_reason": { "description": "The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.", "enum": [ "customer_exempt", "not_collecting", "not_subject_to_tax", "not_supported", "portion_product_exempt", "portion_reduced_rated", "portion_standard_rated", "product_exempt", "product_exempt_holiday", "proportionally_rated", "reduced_rated", "reverse_charge", "standard_rated", "taxable_basis_reduced", "zero_rated" ], "type": "string" }, "taxable_amount": { "description": "The amount on which tax is calculated, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", "type": "integer" } }, "required": [ "amount", "jurisdiction", "sourcing", "tax_rate_details", "taxability_reason", "taxable_amount" ], "title": "TaxProductResourceLineItemTaxBreakdown", "type": "object", "x-expandableFields": [ "jurisdiction", "tax_rate_details" ], "x-stripeMostCommon": [ "amount", "jurisdiction", "sourcing", "tax_rate_details", "taxability_reason", "taxable_amount" ] }, "tax_product_resource_line_item_tax_rate_details": { "description": "", "properties": { "display_name": { "description": "A localized display name for tax type, intended to be human-readable. For example, \"Local Sales and Use Tax\", \"Value-added tax (VAT)\", or \"Umsatzsteuer (USt.)\".", "maxLength": 5000, "type": "string" }, "percentage_decimal": { "description": "The tax rate percentage as a string. For example, 8.5% is represented as \"8.5\".", "maxLength": 5000, "type": "string" }, "tax_type": { "description": "The tax type, such as `vat` or `sales_tax`.", "enum": [ "amusement_tax", "communications_tax", "gst", "hst", "igst", "jct", "lease_tax", "pst", "qst", "retail_delivery_fee", "rst", "sales_tax", "service_tax", "vat" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "display_name", "percentage_decimal", "tax_type" ], "title": "TaxProductResourceLineItemTaxRateDetails", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "display_name", "percentage_decimal", "tax_type" ] }, "tax_product_resource_postal_address": { "description": "", "properties": { "city": { "description": "City, district, suburb, town, or village.", "maxLength": 5000, "nullable": true, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Address line 1 (e.g., street, PO Box, or company name).", "maxLength": 5000, "nullable": true, "type": "string" }, "line2": { "description": "Address line 2 (e.g., apartment, suite, unit, or building).", "maxLength": 5000, "nullable": true, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "nullable": true, "type": "string" }, "state": { "description": "State/province as an [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) subdivision code, without country prefix. Example: \"NY\" or \"TX\".", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "city", "country", "line1", "line2", "postal_code", "state" ], "title": "TaxProductResourcePostalAddress", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state" ] }, "tax_product_resource_ship_from_details": { "description": "", "properties": { "address": { "$ref": "#/components/schemas/tax_product_resource_postal_address" } }, "required": [ "address" ], "title": "TaxProductResourceShipFromDetails", "type": "object", "x-expandableFields": [ "address" ], "x-stripeMostCommon": [ "address" ] }, "tax_product_resource_tax_association_transaction_attempts": { "description": "", "properties": { "committed": { "$ref": "#/components/schemas/tax_product_resource_tax_association_transaction_attempts_resource_committed" }, "errored": { "$ref": "#/components/schemas/tax_product_resource_tax_association_transaction_attempts_resource_errored" }, "source": { "description": "The source of the tax transaction attempt. This is either a refund or a payment intent.", "maxLength": 5000, "type": "string" }, "status": { "description": "The status of the transaction attempt. This can be `errored` or `committed`.", "maxLength": 5000, "type": "string" } }, "required": [ "source", "status" ], "title": "TaxProductResourceTaxAssociationTransactionAttempts", "type": "object", "x-expandableFields": [ "committed", "errored" ], "x-stripeMostCommon": [ "committed", "errored", "source", "status" ] }, "tax_product_resource_tax_association_transaction_attempts_resource_committed": { "description": "", "properties": { "transaction": { "description": "The [Tax Transaction](https://stripe.com/docs/api/tax/transaction/object)", "maxLength": 5000, "type": "string" } }, "required": [ "transaction" ], "title": "TaxProductResourceTaxAssociationTransactionAttemptsResourceCommitted", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "transaction" ] }, "tax_product_resource_tax_association_transaction_attempts_resource_errored": { "description": "", "properties": { "reason": { "description": "Details on why we couldn't commit the tax transaction.", "enum": [ "another_payment_associated_with_calculation", "calculation_expired", "currency_mismatch", "original_transaction_voided", "unique_reference_violation" ], "type": "string" } }, "required": [ "reason" ], "title": "TaxProductResourceTaxAssociationTransactionAttemptsResourceErrored", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "reason" ] }, "tax_product_resource_tax_breakdown": { "description": "", "properties": { "amount": { "description": "The amount of tax, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", "type": "integer" }, "inclusive": { "description": "Specifies whether the tax amount is included in the line item amount.", "type": "boolean" }, "tax_rate_details": { "$ref": "#/components/schemas/tax_product_resource_tax_rate_details" }, "taxability_reason": { "description": "The reasoning behind this tax, for example, if the product is tax exempt. We might extend the possible values for this field to support new tax rules.", "enum": [ "customer_exempt", "not_collecting", "not_subject_to_tax", "not_supported", "portion_product_exempt", "portion_reduced_rated", "portion_standard_rated", "product_exempt", "product_exempt_holiday", "proportionally_rated", "reduced_rated", "reverse_charge", "standard_rated", "taxable_basis_reduced", "zero_rated" ], "type": "string" }, "taxable_amount": { "description": "The amount on which tax is calculated, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", "type": "integer" } }, "required": [ "amount", "inclusive", "tax_rate_details", "taxability_reason", "taxable_amount" ], "title": "TaxProductResourceTaxBreakdown", "type": "object", "x-expandableFields": [ "tax_rate_details" ], "x-stripeMostCommon": [ "amount", "inclusive", "tax_rate_details", "taxability_reason", "taxable_amount" ] }, "tax_product_resource_tax_calculation_shipping_cost": { "description": "", "properties": { "amount": { "description": "The shipping amount in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount.", "type": "integer" }, "amount_tax": { "description": "The amount of tax calculated for shipping, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", "type": "integer" }, "shipping_rate": { "description": "The ID of an existing [ShippingRate](https://stripe.com/docs/api/shipping_rates/object).", "maxLength": 5000, "type": "string" }, "tax_behavior": { "description": "Specifies whether the `amount` includes taxes. If `tax_behavior=inclusive`, then the amount includes taxes.", "enum": [ "exclusive", "inclusive" ], "type": "string" }, "tax_breakdown": { "description": "Detailed account of taxes relevant to shipping cost.", "items": { "$ref": "#/components/schemas/tax_product_resource_line_item_tax_breakdown" }, "type": "array" }, "tax_code": { "description": "The [tax code](https://stripe.com/docs/tax/tax-categories) ID used for shipping.", "maxLength": 5000, "type": "string" } }, "required": [ "amount", "amount_tax", "tax_behavior", "tax_code" ], "title": "TaxProductResourceTaxCalculationShippingCost", "type": "object", "x-expandableFields": [ "tax_breakdown" ], "x-stripeMostCommon": [ "amount", "amount_tax", "shipping_rate", "tax_behavior", "tax_breakdown", "tax_code" ] }, "tax_product_resource_tax_rate_details": { "description": "", "properties": { "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "nullable": true, "type": "string" }, "flat_amount": { "anyOf": [ { "$ref": "#/components/schemas/tax_rate_flat_amount" } ], "description": "The amount of the tax rate when the `rate_type` is `flat_amount`. Tax rates with `rate_type` `percentage` can vary based on the transaction, resulting in this field being `null`. This field exposes the amount and currency of the flat tax rate.", "nullable": true }, "percentage_decimal": { "description": "The tax rate percentage as a string. For example, 8.5% is represented as `\"8.5\"`.", "maxLength": 5000, "type": "string" }, "rate_type": { "description": "Indicates the type of tax rate applied to the taxable amount. This value can be `null` when no tax applies to the location. This field is only present for TaxRates created by Stripe Tax.", "enum": [ "flat_amount", "percentage" ], "nullable": true, "type": "string" }, "state": { "description": "State, county, province, or region.", "maxLength": 5000, "nullable": true, "type": "string" }, "tax_type": { "description": "The tax type, such as `vat` or `sales_tax`.", "enum": [ "amusement_tax", "communications_tax", "gst", "hst", "igst", "jct", "lease_tax", "pst", "qst", "retail_delivery_fee", "rst", "sales_tax", "service_tax", "vat" ], "nullable": true, "type": "string", "x-stripeBypassValidation": true } }, "required": [ "country", "flat_amount", "percentage_decimal", "rate_type", "state", "tax_type" ], "title": "TaxProductResourceTaxRateDetails", "type": "object", "x-expandableFields": [ "flat_amount" ], "x-stripeMostCommon": [ "country", "percentage_decimal", "state", "tax_type" ] }, "tax_product_resource_tax_settings_defaults": { "description": "", "properties": { "tax_behavior": { "description": "Default [tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#tax-behavior) used to specify whether the price is considered inclusive of taxes or exclusive of taxes. If the item's price has a tax behavior set, it will take precedence over the default tax behavior.", "enum": [ "exclusive", "inclusive", "inferred_by_currency" ], "nullable": true, "type": "string" }, "tax_code": { "description": "Default [tax code](https://stripe.com/docs/tax/tax-categories) used to classify your products and prices.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "tax_behavior", "tax_code" ], "title": "TaxProductResourceTaxSettingsDefaults", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "tax_behavior", "tax_code" ] }, "tax_product_resource_tax_settings_head_office": { "description": "", "properties": { "address": { "$ref": "#/components/schemas/address" } }, "required": [ "address" ], "title": "TaxProductResourceTaxSettingsHeadOffice", "type": "object", "x-expandableFields": [ "address" ], "x-stripeMostCommon": [ "address" ] }, "tax_product_resource_tax_settings_status_details": { "description": "", "properties": { "active": { "$ref": "#/components/schemas/tax_product_resource_tax_settings_status_details_resource_active" }, "pending": { "$ref": "#/components/schemas/tax_product_resource_tax_settings_status_details_resource_pending" } }, "title": "TaxProductResourceTaxSettingsStatusDetails", "type": "object", "x-expandableFields": [ "active", "pending" ], "x-stripeMostCommon": [ "active", "pending" ] }, "tax_product_resource_tax_settings_status_details_resource_active": { "description": "", "properties": {}, "title": "TaxProductResourceTaxSettingsStatusDetailsResourceActive", "type": "object", "x-expandableFields": [] }, "tax_product_resource_tax_settings_status_details_resource_pending": { "description": "", "properties": { "missing_fields": { "description": "The list of missing fields that are required to perform calculations. It includes the entry `head_office` when the status is `pending`. It is recommended to set the optional values even if they aren't listed as required for calculating taxes. Calculations can fail if missing fields aren't explicitly provided on every call.", "items": { "maxLength": 5000, "type": "string" }, "nullable": true, "type": "array" } }, "required": [ "missing_fields" ], "title": "TaxProductResourceTaxSettingsStatusDetailsResourcePending", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "missing_fields" ] }, "tax_product_resource_tax_transaction_line_item_resource_reversal": { "description": "", "properties": { "original_line_item": { "description": "The `id` of the line item to reverse in the original transaction.", "maxLength": 5000, "type": "string" } }, "required": [ "original_line_item" ], "title": "TaxProductResourceTaxTransactionLineItemResourceReversal", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "original_line_item" ] }, "tax_product_resource_tax_transaction_resource_reversal": { "description": "", "properties": { "original_transaction": { "description": "The `id` of the reversed `Transaction` object.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "original_transaction" ], "title": "TaxProductResourceTaxTransactionResourceReversal", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "original_transaction" ] }, "tax_product_resource_tax_transaction_shipping_cost": { "description": "", "properties": { "amount": { "description": "The shipping amount in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount.", "type": "integer" }, "amount_tax": { "description": "The amount of tax calculated for shipping, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", "type": "integer" }, "shipping_rate": { "description": "The ID of an existing [ShippingRate](https://stripe.com/docs/api/shipping_rates/object).", "maxLength": 5000, "type": "string" }, "tax_behavior": { "description": "Specifies whether the `amount` includes taxes. If `tax_behavior=inclusive`, then the amount includes taxes.", "enum": [ "exclusive", "inclusive" ], "type": "string" }, "tax_breakdown": { "description": "Detailed account of taxes relevant to shipping cost. (It is not populated for the transaction resource object and will be removed in the next API version.)", "items": { "$ref": "#/components/schemas/tax_product_resource_line_item_tax_breakdown" }, "type": "array" }, "tax_code": { "description": "The [tax code](https://stripe.com/docs/tax/tax-categories) ID used for shipping.", "maxLength": 5000, "type": "string" } }, "required": [ "amount", "amount_tax", "tax_behavior", "tax_code" ], "title": "TaxProductResourceTaxTransactionShippingCost", "type": "object", "x-expandableFields": [ "tax_breakdown" ], "x-stripeMostCommon": [ "amount", "amount_tax", "shipping_rate", "tax_behavior", "tax_breakdown", "tax_code" ] }, "tax_rate": { "description": "Tax rates can be applied to [invoices](/invoicing/taxes/tax-rates), [subscriptions](/billing/taxes/tax-rates) and [Checkout Sessions](/payments/checkout/use-manual-tax-rates) to collect tax.\n\nRelated guide: [Tax rates](/billing/taxes/tax-rates)", "properties": { "active": { "description": "Defaults to `true`. When set to `false`, this tax rate cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set.", "type": "boolean" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "nullable": true, "type": "string" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "description": { "description": "An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.", "maxLength": 5000, "nullable": true, "type": "string" }, "display_name": { "description": "The display name of the tax rates as it will appear to your customer on their receipt email, PDF, and the hosted invoice page.", "maxLength": 5000, "type": "string" }, "effective_percentage": { "description": "Actual/effective tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true,\nthis percentage reflects the rate actually used to calculate tax based on the product's taxability\nand whether the user is registered to collect taxes in the corresponding jurisdiction.", "nullable": true, "type": "number" }, "flat_amount": { "anyOf": [ { "$ref": "#/components/schemas/tax_rate_flat_amount" } ], "description": "The amount of the tax rate when the `rate_type` is `flat_amount`. Tax rates with `rate_type` `percentage` can vary based on the transaction, resulting in this field being `null`. This field exposes the amount and currency of the flat tax rate.", "nullable": true }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "inclusive": { "description": "This specifies if the tax rate is inclusive or exclusive.", "type": "boolean" }, "jurisdiction": { "description": "The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.", "maxLength": 5000, "nullable": true, "type": "string" }, "jurisdiction_level": { "description": "The level of the jurisdiction that imposes this tax rate. Will be `null` for manually defined tax rates.", "enum": [ "city", "country", "county", "district", "multiple", "state" ], "nullable": true, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "nullable": true, "type": "object" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "tax_rate" ], "type": "string" }, "percentage": { "description": "Tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true, this percentage includes the statutory tax rate of non-taxable jurisdictions.", "type": "number" }, "rate_type": { "description": "Indicates the type of tax rate applied to the taxable amount. This value can be `null` when no tax applies to the location. This field is only present for TaxRates created by Stripe Tax.", "enum": [ "flat_amount", "percentage" ], "nullable": true, "type": "string" }, "state": { "description": "[ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2), without country prefix. For example, \"NY\" for New York, United States.", "maxLength": 5000, "nullable": true, "type": "string" }, "tax_type": { "description": "The high-level tax type, such as `vat` or `sales_tax`.", "enum": [ "amusement_tax", "communications_tax", "gst", "hst", "igst", "jct", "lease_tax", "pst", "qst", "retail_delivery_fee", "rst", "sales_tax", "service_tax", "vat" ], "nullable": true, "type": "string", "x-stripeBypassValidation": true } }, "required": [ "active", "country", "created", "description", "display_name", "effective_percentage", "flat_amount", "id", "inclusive", "jurisdiction", "jurisdiction_level", "livemode", "metadata", "object", "percentage", "rate_type", "state", "tax_type" ], "title": "TaxRate", "type": "object", "x-expandableFields": [ "flat_amount" ], "x-resourceId": "tax_rate", "x-stripeMostCommon": [ "active", "country", "description", "display_name", "id", "inclusive", "jurisdiction", "metadata", "percentage", "state" ], "x-stripeOperations": [ { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/tax_rates" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/tax_rates/{tax_rate}" }, { "method_name": "create", "method_on": "service", "method_type": "create", "operation": "post", "path": "/v1/tax_rates" }, { "method_name": "update", "method_on": "service", "method_type": "update", "operation": "post", "path": "/v1/tax_rates/{tax_rate}" } ], "x-stripeResource": { "class_name": "TaxRate", "has_collection_class": true, "in_package": "" } }, "tax_rate.created": { "description": "Occurs whenever a new tax rate is created.", "properties": { "object": { "$ref": "#/components/schemas/tax_rate" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "tax_rate.created" } }, "tax_rate.updated": { "description": "Occurs whenever a tax rate is updated.", "properties": { "object": { "$ref": "#/components/schemas/tax_rate" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "tax_rate.updated" } }, "tax_rate_flat_amount": { "description": "The amount of the tax rate when the `rate_type`` is `flat_amount`. Tax rates with `rate_type` `percentage` can vary based on the transaction, resulting in this field being `null`. This field exposes the amount and currency of the flat tax rate.", "properties": { "amount": { "description": "Amount of the tax when the `rate_type` is `flat_amount`. This positive integer represents how much to charge in the smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).", "type": "integer" }, "currency": { "description": "Three-letter ISO currency code, in lowercase.", "maxLength": 5000, "type": "string" } }, "required": [ "amount", "currency" ], "title": "TaxRateFlatAmount", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "amount", "currency" ], "x-stripeResource": { "class_name": "TaxRateFlatAmount", "in_package": "" } }, "tax_reporting_account_settings_resource_tax_form_settings": { "description": "", "properties": { "consented_to_paperless_delivery": { "description": "Whether the account opted out of receiving their tax forms by postal delivery.", "type": "boolean" } }, "required": [ "consented_to_paperless_delivery" ], "title": "TaxReportingAccountSettingsResourceTaxFormSettings", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "consented_to_paperless_delivery" ] }, "tax_reporting_resource_tax_form_au_serr": { "description": "", "properties": { "reporting_period_end_date": { "description": "End date of the period represented by the information reported on the tax form.", "maxLength": 5000, "type": "string" }, "reporting_period_start_date": { "description": "Start date of the period represented by the information reported on the tax form.", "maxLength": 5000, "type": "string" } }, "required": [ "reporting_period_end_date", "reporting_period_start_date" ], "title": "TaxReportingResourceTaxFormAuSerr", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "reporting_period_end_date", "reporting_period_start_date" ] }, "tax_reporting_resource_tax_form_ca_mrdp": { "description": "", "properties": { "reporting_period_end_date": { "description": "End date of the period represented by the information reported on the tax form.", "maxLength": 5000, "type": "string" }, "reporting_period_start_date": { "description": "Start date of the period represented by the information reported on the tax form.", "maxLength": 5000, "type": "string" } }, "required": [ "reporting_period_end_date", "reporting_period_start_date" ], "title": "TaxReportingResourceTaxFormCAMrdp", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "reporting_period_end_date", "reporting_period_start_date" ] }, "tax_reporting_resource_tax_form_eu_dac7": { "description": "", "properties": { "reporting_period_end_date": { "description": "End date of the period represented by the information reported on the tax form.", "maxLength": 5000, "type": "string" }, "reporting_period_start_date": { "description": "Start date of the period represented by the information reported on the tax form.", "maxLength": 5000, "type": "string" } }, "required": [ "reporting_period_end_date", "reporting_period_start_date" ], "title": "TaxReportingResourceTaxFormEuDac7", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "reporting_period_end_date", "reporting_period_start_date" ] }, "tax_reporting_resource_tax_form_filing_status": { "description": "", "properties": { "effective_at": { "description": "Time when the filing status was updated.", "format": "unix-time", "type": "integer" }, "jurisdiction": { "$ref": "#/components/schemas/tax_reporting_resource_tax_form_filing_status_resource_jurisdiction" }, "value": { "description": "The current status of the filed form.", "enum": [ "accepted", "filed", "rejected" ], "type": "string" } }, "required": [ "effective_at", "jurisdiction", "value" ], "title": "TaxReportingResourceTaxFormFilingStatus", "type": "object", "x-expandableFields": [ "jurisdiction" ], "x-stripeMostCommon": [ "effective_at", "jurisdiction", "value" ] }, "tax_reporting_resource_tax_form_filing_status_resource_jurisdiction": { "description": "", "properties": { "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "level": { "description": "Indicates the level of the jurisdiction where the form was filed.", "enum": [ "country", "state" ], "type": "string" }, "state": { "description": "[ISO 3166-2 U.S. state code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country prefix, if any. For example, \"NY\" for New York, United States. Null for non-U.S. forms.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "country", "level", "state" ], "title": "TaxReportingResourceTaxFormFilingStatusResourceJurisdiction", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "country", "level", "state" ] }, "tax_reporting_resource_tax_form_gb_mrdp": { "description": "", "properties": { "reporting_period_end_date": { "description": "End date of the period represented by the information reported on the tax form.", "maxLength": 5000, "type": "string" }, "reporting_period_start_date": { "description": "Start date of the period represented by the information reported on the tax form.", "maxLength": 5000, "type": "string" } }, "required": [ "reporting_period_end_date", "reporting_period_start_date" ], "title": "TaxReportingResourceTaxFormGbMrdp", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "reporting_period_end_date", "reporting_period_start_date" ] }, "tax_reporting_resource_tax_form_nz_mrdp": { "description": "", "properties": { "reporting_period_end_date": { "description": "End date of the period represented by the information reported on the tax form.", "maxLength": 5000, "type": "string" }, "reporting_period_start_date": { "description": "Start date of the period represented by the information reported on the tax form.", "maxLength": 5000, "type": "string" } }, "required": [ "reporting_period_end_date", "reporting_period_start_date" ], "title": "TaxReportingResourceTaxFormNzMrdp", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "reporting_period_end_date", "reporting_period_start_date" ] }, "tax_reporting_resource_tax_form_payee": { "description": "", "properties": { "account": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/account" } ], "description": "The ID of the payee's Stripe account.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/account" } ] } }, "external_reference": { "description": "The external reference to this payee.", "maxLength": 5000, "nullable": true, "type": "string" }, "type": { "description": "Either `account` or `external_reference`.", "enum": [ "account", "external_reference" ], "type": "string" } }, "required": [ "account", "external_reference", "type" ], "title": "TaxReportingResourceTaxFormPayee", "type": "object", "x-expandableFields": [ "account" ], "x-stripeMostCommon": [ "account", "external_reference", "type" ] }, "tax_reporting_resource_tax_form_us1099_k": { "description": "", "properties": { "reporting_year": { "description": "Year represented by the information reported on the tax form.", "type": "integer" } }, "required": [ "reporting_year" ], "title": "TaxReportingResourceTaxFormUS1099K", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "reporting_year" ] }, "tax_reporting_resource_tax_form_us1099_misc": { "description": "", "properties": { "reporting_year": { "description": "Year represented by the information reported on the tax form.", "type": "integer" } }, "required": [ "reporting_year" ], "title": "TaxReportingResourceTaxFormUS1099MISC", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "reporting_year" ] }, "tax_reporting_resource_tax_form_us1099_nec": { "description": "", "properties": { "reporting_year": { "description": "Year represented by the information reported on the tax form.", "type": "integer" } }, "required": [ "reporting_year" ], "title": "TaxReportingResourceTaxFormUS1099NEC", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "reporting_year" ] }, "terminal.configuration": { "description": "A Configurations object represents how features should be configured for terminal readers.\nFor information about how to use it, see the [Terminal configurations documentation](https://docs.stripe.com/terminal/fleet/configurations-overview).", "properties": { "bbpos_wisepos_e": { "$ref": "#/components/schemas/terminal_configuration_configuration_resource_device_type_specific_config" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "is_account_default": { "description": "Whether this Configuration is the default for your account", "nullable": true, "type": "boolean" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "name": { "description": "String indicating the name of the Configuration object, set by the user", "maxLength": 5000, "nullable": true, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "terminal.configuration" ], "type": "string" }, "offline": { "$ref": "#/components/schemas/terminal_configuration_configuration_resource_offline_config" }, "reader_security": { "$ref": "#/components/schemas/terminal_configuration_configuration_resource_reader_security_config" }, "reboot_window": { "$ref": "#/components/schemas/terminal_configuration_configuration_resource_reboot_window" }, "stripe_s700": { "$ref": "#/components/schemas/terminal_configuration_configuration_resource_device_type_specific_config" }, "tipping": { "$ref": "#/components/schemas/terminal_configuration_configuration_resource_tipping" }, "verifone_p400": { "$ref": "#/components/schemas/terminal_configuration_configuration_resource_device_type_specific_config" }, "wifi": { "$ref": "#/components/schemas/terminal_configuration_configuration_resource_wifi_config" } }, "required": [ "id", "is_account_default", "livemode", "name", "object" ], "title": "TerminalConfigurationConfiguration", "type": "object", "x-expandableFields": [ "bbpos_wisepos_e", "offline", "reader_security", "reboot_window", "stripe_s700", "tipping", "verifone_p400", "wifi" ], "x-resourceId": "terminal.configuration", "x-stripeMostCommon": [ "bbpos_wisepos_e", "id", "is_account_default", "stripe_s700", "tipping", "verifone_p400" ], "x-stripeOperations": [ { "method_name": "delete", "method_on": "service", "method_type": "delete", "operation": "delete", "path": "/v1/terminal/configurations/{configuration}" }, { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/terminal/configurations" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/terminal/configurations/{configuration}" }, { "method_name": "create", "method_on": "service", "method_type": "create", "operation": "post", "path": "/v1/terminal/configurations" }, { "method_name": "update", "method_on": "service", "method_type": "update", "operation": "post", "path": "/v1/terminal/configurations/{configuration}" } ], "x-stripeResource": { "class_name": "Configuration", "has_collection_class": true, "in_package": "Terminal" } }, "terminal.connection_token": { "description": "A Connection Token is used by the Stripe Terminal SDK to connect to a reader.\n\nRelated guide: [Fleet management](https://stripe.com/docs/terminal/fleet/locations)", "properties": { "location": { "description": "The id of the location that this connection token is scoped to. Note that location scoping only applies to internet-connected readers. For more details, see [the docs on scoping connection tokens](https://docs.stripe.com/terminal/fleet/locations-and-zones?dashboard-or-api=api#connection-tokens).", "maxLength": 5000, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "terminal.connection_token" ], "type": "string" }, "secret": { "description": "Your application should pass this token to the Stripe Terminal SDK.", "maxLength": 5000, "type": "string" } }, "required": [ "object", "secret" ], "title": "TerminalConnectionToken", "type": "object", "x-expandableFields": [], "x-resourceId": "terminal.connection_token", "x-stripeMostCommon": [ "location", "secret" ], "x-stripeOperations": [ { "method_name": "create", "method_on": "service", "method_type": "create", "operation": "post", "path": "/v1/terminal/connection_tokens" } ], "x-stripeResource": { "class_name": "ConnectionToken", "in_package": "Terminal" } }, "terminal.location": { "description": "A Location represents a grouping of readers.\n\nRelated guide: [Fleet management](https://stripe.com/docs/terminal/fleet/locations)", "properties": { "address": { "$ref": "#/components/schemas/address" }, "configuration_overrides": { "description": "The ID of a configuration that will be used to customize all readers in this location.", "maxLength": 5000, "type": "string" }, "display_name": { "description": "The display name of the location.", "maxLength": 5000, "type": "string" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "type": "object" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "terminal.location" ], "type": "string" } }, "required": [ "address", "display_name", "id", "livemode", "metadata", "object" ], "title": "TerminalLocationLocation", "type": "object", "x-expandableFields": [ "address" ], "x-resourceId": "terminal.location", "x-stripeMostCommon": [ "address", "display_name", "id", "metadata" ], "x-stripeOperations": [ { "method_name": "delete", "method_on": "service", "method_type": "delete", "operation": "delete", "path": "/v1/terminal/locations/{location}" }, { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/terminal/locations" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/terminal/locations/{location}" }, { "method_name": "create", "method_on": "service", "method_type": "create", "operation": "post", "path": "/v1/terminal/locations" }, { "method_name": "update", "method_on": "service", "method_type": "update", "operation": "post", "path": "/v1/terminal/locations/{location}" } ], "x-stripeResource": { "class_name": "Location", "has_collection_class": true, "in_package": "Terminal" } }, "terminal.onboarding_link": { "description": "Returns redirect links used for onboarding onto Tap to Pay on iPhone.", "properties": { "link_options": { "$ref": "#/components/schemas/terminal_onboarding_link_link_options" }, "link_type": { "description": "The type of link being generated.", "enum": [ "apple_terms_and_conditions" ], "type": "string" }, "object": { "enum": [ "terminal.onboarding_link" ], "type": "string" }, "on_behalf_of": { "description": "Stripe account ID to generate the link for.", "maxLength": 5000, "nullable": true, "type": "string" }, "redirect_url": { "description": "The link passed back to the user for their onboarding.", "maxLength": 5000, "type": "string" } }, "required": [ "link_options", "link_type", "object", "on_behalf_of", "redirect_url" ], "title": "TerminalOnboardingLinkOnboardingLink", "type": "object", "x-expandableFields": [ "link_options" ], "x-resourceId": "terminal.onboarding_link", "x-stripeMostCommon": [ "link_options", "link_type", "object", "on_behalf_of", "redirect_url" ], "x-stripeOperations": [ { "method_name": "create", "method_on": "service", "method_type": "create", "operation": "post", "path": "/v1/terminal/onboarding_links" } ], "x-stripeResource": { "class_name": "OnboardingLink", "in_package": "Terminal" } }, "terminal.reader": { "description": "A Reader represents a physical device for accepting payment details.\n\nRelated guide: [Connecting to a reader](https://stripe.com/docs/terminal/payments/connect-reader)", "properties": { "action": { "anyOf": [ { "$ref": "#/components/schemas/terminal_reader_reader_resource_reader_action" } ], "description": "The most recent action performed by the reader.", "nullable": true }, "device_sw_version": { "description": "The current software version of the reader.", "maxLength": 5000, "nullable": true, "type": "string" }, "device_type": { "description": "Device type of the reader.", "enum": [ "bbpos_chipper2x", "bbpos_wisepad3", "bbpos_wisepos_e", "mobile_phone_reader", "simulated_stripe_s700", "simulated_wisepos_e", "stripe_m2", "stripe_s700", "verifone_P400" ], "type": "string", "x-stripeBypassValidation": true }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "ip_address": { "description": "The local IP address of the reader.", "maxLength": 5000, "nullable": true, "type": "string" }, "label": { "description": "Custom label given to the reader for easier identification.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "location": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/terminal.location" } ], "description": "The location identifier of the reader.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/terminal.location" } ] } }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "type": "object" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "terminal.reader" ], "type": "string" }, "serial_number": { "description": "Serial number of the reader.", "maxLength": 5000, "type": "string" }, "status": { "description": "The networking status of the reader. We do not recommend using this field in flows that may block taking payments.", "enum": [ "offline", "online" ], "nullable": true, "type": "string" } }, "required": [ "action", "device_sw_version", "device_type", "id", "ip_address", "label", "livemode", "location", "metadata", "object", "serial_number", "status" ], "title": "TerminalReaderReader", "type": "object", "x-expandableFields": [ "action", "location" ], "x-resourceId": "terminal.reader", "x-stripeMostCommon": [ "device_type", "id", "label", "location", "metadata", "serial_number", "status" ], "x-stripeOperations": [ { "method_name": "delete", "method_on": "service", "method_type": "delete", "operation": "delete", "path": "/v1/terminal/readers/{reader}" }, { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/terminal/readers" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/terminal/readers/{reader}" }, { "method_name": "create", "method_on": "service", "method_type": "create", "operation": "post", "path": "/v1/terminal/readers" }, { "method_name": "update", "method_on": "service", "method_type": "update", "operation": "post", "path": "/v1/terminal/readers/{reader}" }, { "method_name": "cancel_action", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/terminal/readers/{reader}/cancel_action" }, { "method_name": "collect_inputs", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/terminal/readers/{reader}/collect_inputs" }, { "method_name": "collect_payment_method", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/terminal/readers/{reader}/collect_payment_method" }, { "method_name": "confirm_payment_intent", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/terminal/readers/{reader}/confirm_payment_intent" }, { "method_name": "process_payment_intent", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/terminal/readers/{reader}/process_payment_intent" }, { "method_name": "process_setup_intent", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/terminal/readers/{reader}/process_setup_intent" }, { "method_name": "refund_payment", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/terminal/readers/{reader}/refund_payment" }, { "method_name": "set_reader_display", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/terminal/readers/{reader}/set_reader_display" }, { "method_name": "present_payment_method", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/test_helpers/terminal/readers/{reader}/present_payment_method" }, { "method_name": "succeed_input_collection", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/test_helpers/terminal/readers/{reader}/succeed_input_collection" }, { "method_name": "timeout_input_collection", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/test_helpers/terminal/readers/{reader}/timeout_input_collection" } ], "x-stripeResource": { "class_name": "Reader", "has_collection_class": true, "in_package": "Terminal" } }, "terminal.reader.action_failed": { "description": "Occurs whenever an action sent to a Terminal reader failed.", "properties": { "object": { "$ref": "#/components/schemas/terminal.reader" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "terminal.reader.action_failed" } }, "terminal.reader.action_succeeded": { "description": "Occurs whenever an action sent to a Terminal reader was successful.", "properties": { "object": { "$ref": "#/components/schemas/terminal.reader" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "terminal.reader.action_succeeded" } }, "terminal.reader.action_updated": { "description": "Occurs whenever an action sent to a Terminal reader is updated.", "properties": { "object": { "$ref": "#/components/schemas/terminal.reader" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "terminal.reader.action_updated" } }, "terminal.reader_collected_data": { "description": "Returns data collected by Terminal readers. This data is only stored for 24 hours.", "properties": { "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "magstripe": { "anyOf": [ { "$ref": "#/components/schemas/terminal_reader_collected_data_resource_magstripe_data" } ], "description": "The magstripe data collected by the reader.", "nullable": true }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "terminal.reader_collected_data" ], "type": "string" }, "type": { "description": "The type of data collected by the reader.", "enum": [ "magstripe" ], "type": "string" } }, "required": [ "created", "id", "livemode", "magstripe", "object", "type" ], "title": "TerminalReaderCollectedData", "type": "object", "x-expandableFields": [ "magstripe" ], "x-resourceId": "terminal.reader_collected_data", "x-stripeMostCommon": [ "id", "magstripe", "type" ], "x-stripeOperations": [ { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/terminal/reader_collected_data/{reader_collected_data}" } ], "x-stripeResource": { "class_name": "ReaderCollectedData", "in_package": "Terminal" } }, "terminal_configuration_configuration_resource_currency_specific_config": { "description": "", "properties": { "fixed_amounts": { "description": "Fixed amounts displayed when collecting a tip", "items": { "type": "integer" }, "nullable": true, "type": "array" }, "percentages": { "description": "Percentages displayed when collecting a tip", "items": { "type": "integer" }, "nullable": true, "type": "array" }, "smart_tip_threshold": { "description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed", "type": "integer" } }, "title": "TerminalConfigurationConfigurationResourceCurrencySpecificConfig", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "fixed_amounts", "percentages", "smart_tip_threshold" ] }, "terminal_configuration_configuration_resource_device_type_specific_config": { "description": "", "properties": { "splashscreen": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/file" } ], "description": "A File ID representing an image to display on the reader", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/file" } ] } } }, "title": "TerminalConfigurationConfigurationResourceDeviceTypeSpecificConfig", "type": "object", "x-expandableFields": [ "splashscreen" ], "x-stripeMostCommon": [ "splashscreen" ] }, "terminal_configuration_configuration_resource_enterprise_peap_wifi": { "description": "", "properties": { "ca_certificate_file": { "description": "A File ID representing a PEM file containing the server certificate", "maxLength": 5000, "type": "string" }, "password": { "description": "Password for connecting to the WiFi network", "maxLength": 5000, "type": "string" }, "ssid": { "description": "Name of the WiFi network", "maxLength": 5000, "type": "string" }, "username": { "description": "Username for connecting to the WiFi network", "maxLength": 5000, "type": "string" } }, "required": [ "password", "ssid", "username" ], "title": "TerminalConfigurationConfigurationResourceEnterprisePEAPWifi", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "ca_certificate_file", "password", "ssid", "username" ] }, "terminal_configuration_configuration_resource_enterprise_tls_wifi": { "description": "", "properties": { "ca_certificate_file": { "description": "A File ID representing a PEM file containing the server certificate", "maxLength": 5000, "type": "string" }, "client_certificate_file": { "description": "A File ID representing a PEM file containing the client certificate", "maxLength": 5000, "type": "string" }, "private_key_file": { "description": "A File ID representing a PEM file containing the client RSA private key", "maxLength": 5000, "type": "string" }, "private_key_file_password": { "description": "Password for the private key file", "maxLength": 5000, "type": "string" }, "ssid": { "description": "Name of the WiFi network", "maxLength": 5000, "type": "string" } }, "required": [ "client_certificate_file", "private_key_file", "ssid" ], "title": "TerminalConfigurationConfigurationResourceEnterpriseTLSWifi", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "ca_certificate_file", "client_certificate_file", "private_key_file", "private_key_file_password", "ssid" ] }, "terminal_configuration_configuration_resource_offline_config": { "description": "", "properties": { "enabled": { "description": "Determines whether to allow transactions to be collected while reader is offline. Defaults to false.", "nullable": true, "type": "boolean" } }, "required": [ "enabled" ], "title": "TerminalConfigurationConfigurationResourceOfflineConfig", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "enabled" ] }, "terminal_configuration_configuration_resource_personal_psk_wifi": { "description": "", "properties": { "password": { "description": "Password for connecting to the WiFi network", "maxLength": 5000, "type": "string" }, "ssid": { "description": "Name of the WiFi network", "maxLength": 5000, "type": "string" } }, "required": [ "password", "ssid" ], "title": "TerminalConfigurationConfigurationResourcePersonalPSKWifi", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "password", "ssid" ] }, "terminal_configuration_configuration_resource_reader_security_config": { "description": "", "properties": { "admin_menu_passcode": { "description": "Passcode used to access a reader's admin menu.", "maxLength": 5000, "type": "string" } }, "required": [ "admin_menu_passcode" ], "title": "TerminalConfigurationConfigurationResourceReaderSecurityConfig", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "admin_menu_passcode" ] }, "terminal_configuration_configuration_resource_reboot_window": { "description": "", "properties": { "end_hour": { "description": "Integer between 0 to 23 that represents the end hour of the reboot time window. The value must be different than the start_hour.", "type": "integer" }, "start_hour": { "description": "Integer between 0 to 23 that represents the start hour of the reboot time window.", "type": "integer" } }, "required": [ "end_hour", "start_hour" ], "title": "TerminalConfigurationConfigurationResourceRebootWindow", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "end_hour", "start_hour" ] }, "terminal_configuration_configuration_resource_tipping": { "description": "", "properties": { "aed": { "$ref": "#/components/schemas/terminal_configuration_configuration_resource_currency_specific_config" }, "aud": { "$ref": "#/components/schemas/terminal_configuration_configuration_resource_currency_specific_config" }, "bgn": { "$ref": "#/components/schemas/terminal_configuration_configuration_resource_currency_specific_config" }, "cad": { "$ref": "#/components/schemas/terminal_configuration_configuration_resource_currency_specific_config" }, "chf": { "$ref": "#/components/schemas/terminal_configuration_configuration_resource_currency_specific_config" }, "czk": { "$ref": "#/components/schemas/terminal_configuration_configuration_resource_currency_specific_config" }, "dkk": { "$ref": "#/components/schemas/terminal_configuration_configuration_resource_currency_specific_config" }, "eur": { "$ref": "#/components/schemas/terminal_configuration_configuration_resource_currency_specific_config" }, "gbp": { "$ref": "#/components/schemas/terminal_configuration_configuration_resource_currency_specific_config" }, "hkd": { "$ref": "#/components/schemas/terminal_configuration_configuration_resource_currency_specific_config" }, "huf": { "$ref": "#/components/schemas/terminal_configuration_configuration_resource_currency_specific_config" }, "jpy": { "$ref": "#/components/schemas/terminal_configuration_configuration_resource_currency_specific_config" }, "mxn": { "$ref": "#/components/schemas/terminal_configuration_configuration_resource_currency_specific_config" }, "myr": { "$ref": "#/components/schemas/terminal_configuration_configuration_resource_currency_specific_config" }, "nok": { "$ref": "#/components/schemas/terminal_configuration_configuration_resource_currency_specific_config" }, "nzd": { "$ref": "#/components/schemas/terminal_configuration_configuration_resource_currency_specific_config" }, "pln": { "$ref": "#/components/schemas/terminal_configuration_configuration_resource_currency_specific_config" }, "ron": { "$ref": "#/components/schemas/terminal_configuration_configuration_resource_currency_specific_config" }, "sek": { "$ref": "#/components/schemas/terminal_configuration_configuration_resource_currency_specific_config" }, "sgd": { "$ref": "#/components/schemas/terminal_configuration_configuration_resource_currency_specific_config" }, "usd": { "$ref": "#/components/schemas/terminal_configuration_configuration_resource_currency_specific_config" } }, "title": "TerminalConfigurationConfigurationResourceTipping", "type": "object", "x-expandableFields": [ "aed", "aud", "bgn", "cad", "chf", "czk", "dkk", "eur", "gbp", "hkd", "huf", "jpy", "mxn", "myr", "nok", "nzd", "pln", "ron", "sek", "sgd", "usd" ], "x-stripeMostCommon": [ "aed", "aud", "bgn", "cad", "chf", "czk", "dkk", "eur", "gbp", "hkd", "huf", "jpy", "mxn", "myr", "nok", "nzd", "pln", "ron", "sek", "sgd", "usd" ] }, "terminal_configuration_configuration_resource_wifi_config": { "description": "", "properties": { "enterprise_eap_peap": { "$ref": "#/components/schemas/terminal_configuration_configuration_resource_enterprise_peap_wifi" }, "enterprise_eap_tls": { "$ref": "#/components/schemas/terminal_configuration_configuration_resource_enterprise_tls_wifi" }, "personal_psk": { "$ref": "#/components/schemas/terminal_configuration_configuration_resource_personal_psk_wifi" }, "type": { "description": "Security type of the WiFi network. The hash with the corresponding name contains the credentials for this security type.", "enum": [ "enterprise_eap_peap", "enterprise_eap_tls", "personal_psk" ], "type": "string" } }, "required": [ "type" ], "title": "TerminalConfigurationConfigurationResourceWifiConfig", "type": "object", "x-expandableFields": [ "enterprise_eap_peap", "enterprise_eap_tls", "personal_psk" ], "x-stripeMostCommon": [ "enterprise_eap_peap", "enterprise_eap_tls", "personal_psk", "type" ] }, "terminal_onboarding_link_apple_terms_and_conditions": { "description": "Options associated with the Apple Terms and Conditions link type.", "properties": { "allow_relinking": { "description": "Whether the link should also support users relinking their Apple account.", "nullable": true, "type": "boolean" }, "merchant_display_name": { "description": "The business name of the merchant accepting Apple's Terms and Conditions.", "maxLength": 5000, "type": "string" } }, "required": [ "allow_relinking", "merchant_display_name" ], "title": "TerminalOnboardingLinkAppleTermsAndConditions", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "allow_relinking", "merchant_display_name" ] }, "terminal_onboarding_link_link_options": { "description": "Link type options associated with the current onboarding link object.", "properties": { "apple_terms_and_conditions": { "anyOf": [ { "$ref": "#/components/schemas/terminal_onboarding_link_apple_terms_and_conditions" } ], "description": "The options associated with the Apple Terms and Conditions link type.", "nullable": true } }, "required": [ "apple_terms_and_conditions" ], "title": "TerminalOnboardingLinkLinkOptions", "type": "object", "x-expandableFields": [ "apple_terms_and_conditions" ], "x-stripeMostCommon": [ "apple_terms_and_conditions" ] }, "terminal_reader_collected_data_resource_magstripe_data": { "description": "Represents magstripe data collected by the reader.", "properties": { "data": { "description": "The raw magstripe data collected by the reader.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "data" ], "title": "TerminalReaderCollectedDataResourceMagstripeData", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "data" ] }, "terminal_reader_reader_resource_cart": { "description": "Represents a cart to be displayed on the reader", "properties": { "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "line_items": { "description": "List of line items in the cart.", "items": { "$ref": "#/components/schemas/terminal_reader_reader_resource_line_item" }, "type": "array" }, "tax": { "description": "Tax amount for the entire cart. A positive integer in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", "nullable": true, "type": "integer" }, "total": { "description": "Total amount for the entire cart, including tax. A positive integer in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", "type": "integer" } }, "required": [ "currency", "line_items", "tax", "total" ], "title": "TerminalReaderReaderResourceCart", "type": "object", "x-expandableFields": [ "line_items" ], "x-stripeMostCommon": [ "currency", "line_items", "tax", "total" ] }, "terminal_reader_reader_resource_choice": { "description": "Choice to be selected on a Reader", "properties": { "id": { "description": "The id to be selected", "maxLength": 5000, "nullable": true, "type": "string" }, "style": { "description": "The button style for the choice", "enum": [ "primary", "secondary" ], "nullable": true, "type": "string" }, "text": { "description": "The text to be selected", "maxLength": 5000, "type": "string" } }, "required": [ "id", "style", "text" ], "title": "TerminalReaderReaderResourceChoice", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "id", "style", "text" ] }, "terminal_reader_reader_resource_collect_config": { "description": "Represents a per-transaction override of a reader configuration", "properties": { "enable_customer_cancellation": { "description": "Enable customer-initiated cancellation when processing this payment.", "type": "boolean" }, "skip_tipping": { "description": "Override showing a tipping selection screen on this transaction.", "type": "boolean" }, "tipping": { "$ref": "#/components/schemas/terminal_reader_reader_resource_tipping_config" } }, "title": "TerminalReaderReaderResourceCollectConfig", "type": "object", "x-expandableFields": [ "tipping" ], "x-stripeMostCommon": [ "enable_customer_cancellation", "skip_tipping", "tipping" ] }, "terminal_reader_reader_resource_collect_inputs_action": { "description": "Represents a reader action to collect customer inputs", "properties": { "inputs": { "description": "List of inputs to be collected.", "items": { "$ref": "#/components/schemas/terminal_reader_reader_resource_input" }, "type": "array" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "nullable": true, "type": "object" } }, "required": [ "inputs", "metadata" ], "title": "TerminalReaderReaderResourceCollectInputsAction", "type": "object", "x-expandableFields": [ "inputs" ], "x-stripeMostCommon": [ "inputs", "metadata" ] }, "terminal_reader_reader_resource_collect_payment_method_action": { "description": "Represents a reader action to collect a payment method", "properties": { "account": { "description": "Account the payment intent belongs to.", "maxLength": 5000, "type": "string" }, "collect_config": { "$ref": "#/components/schemas/terminal_reader_reader_resource_collect_config" }, "payment_intent": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/payment_intent" } ], "description": "Most recent PaymentIntent processed by the reader.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/payment_intent" } ] } }, "payment_method": { "$ref": "#/components/schemas/payment_method" } }, "required": [ "payment_intent" ], "title": "TerminalReaderReaderResourceCollectPaymentMethodAction", "type": "object", "x-expandableFields": [ "collect_config", "payment_intent", "payment_method" ], "x-stripeMostCommon": [ "payment_intent" ] }, "terminal_reader_reader_resource_confirm_config": { "description": "Represents a per-transaction override of a reader configuration", "properties": { "return_url": { "description": "If the customer doesn't abandon authenticating the payment, they're redirected to this URL after completion.", "maxLength": 5000, "type": "string" } }, "title": "TerminalReaderReaderResourceConfirmConfig", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "return_url" ] }, "terminal_reader_reader_resource_confirm_payment_intent_action": { "description": "Represents a reader action to confirm a payment", "properties": { "account": { "description": "Account the payment intent belongs to.", "maxLength": 5000, "type": "string" }, "confirm_config": { "$ref": "#/components/schemas/terminal_reader_reader_resource_confirm_config" }, "payment_intent": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/payment_intent" } ], "description": "Most recent PaymentIntent processed by the reader.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/payment_intent" } ] } } }, "required": [ "payment_intent" ], "title": "TerminalReaderReaderResourceConfirmPaymentIntentAction", "type": "object", "x-expandableFields": [ "confirm_config", "payment_intent" ], "x-stripeMostCommon": [ "payment_intent" ] }, "terminal_reader_reader_resource_custom_text": { "description": "Represents custom text to be displayed when collecting the input using a reader", "properties": { "description": { "description": "Customize the default description for this input", "maxLength": 5000, "nullable": true, "type": "string" }, "skip_button": { "description": "Customize the default label for this input's skip button", "maxLength": 5000, "nullable": true, "type": "string" }, "submit_button": { "description": "Customize the default label for this input's submit button", "maxLength": 5000, "nullable": true, "type": "string" }, "title": { "description": "Customize the default title for this input", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "description", "skip_button", "submit_button", "title" ], "title": "TerminalReaderReaderResourceCustomText", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "description", "skip_button", "submit_button", "title" ] }, "terminal_reader_reader_resource_email": { "description": "Information about a email being collected using a reader", "properties": { "value": { "description": "The collected email address", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "value" ], "title": "TerminalReaderReaderResourceEmail", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "value" ] }, "terminal_reader_reader_resource_input": { "description": "Represents an input to be collected using the reader", "properties": { "custom_text": { "anyOf": [ { "$ref": "#/components/schemas/terminal_reader_reader_resource_custom_text" } ], "description": "Default text of input being collected.", "nullable": true }, "email": { "$ref": "#/components/schemas/terminal_reader_reader_resource_email" }, "numeric": { "$ref": "#/components/schemas/terminal_reader_reader_resource_numeric" }, "phone": { "$ref": "#/components/schemas/terminal_reader_reader_resource_phone" }, "required": { "description": "Indicate that this input is required, disabling the skip button.", "nullable": true, "type": "boolean" }, "selection": { "$ref": "#/components/schemas/terminal_reader_reader_resource_selection" }, "signature": { "$ref": "#/components/schemas/terminal_reader_reader_resource_signature" }, "skipped": { "description": "Indicate that this input was skipped by the user.", "type": "boolean" }, "text": { "$ref": "#/components/schemas/terminal_reader_reader_resource_text" }, "toggles": { "description": "List of toggles being collected. Values are present if collection is complete.", "items": { "$ref": "#/components/schemas/terminal_reader_reader_resource_toggle" }, "nullable": true, "type": "array" }, "type": { "description": "Type of input being collected.", "enum": [ "email", "numeric", "phone", "selection", "signature", "text" ], "type": "string" } }, "required": [ "custom_text", "required", "toggles", "type" ], "title": "TerminalReaderReaderResourceInput", "type": "object", "x-expandableFields": [ "custom_text", "email", "numeric", "phone", "selection", "signature", "text", "toggles" ], "x-stripeMostCommon": [ "required", "skipped", "type" ] }, "terminal_reader_reader_resource_line_item": { "description": "Represents a line item to be displayed on the reader", "properties": { "amount": { "description": "The amount of the line item. A positive integer in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", "type": "integer" }, "description": { "description": "Description of the line item.", "maxLength": 5000, "type": "string" }, "quantity": { "description": "The quantity of the line item.", "type": "integer" } }, "required": [ "amount", "description", "quantity" ], "title": "TerminalReaderReaderResourceLineItem", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "amount", "description", "quantity" ] }, "terminal_reader_reader_resource_numeric": { "description": "Information about a number being collected using a reader", "properties": { "value": { "description": "The collected number", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "value" ], "title": "TerminalReaderReaderResourceNumeric", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "value" ] }, "terminal_reader_reader_resource_phone": { "description": "Information about a phone number being collected using a reader", "properties": { "value": { "description": "The collected phone number", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "value" ], "title": "TerminalReaderReaderResourcePhone", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "value" ] }, "terminal_reader_reader_resource_process_config": { "description": "Represents a per-transaction override of a reader configuration", "properties": { "enable_customer_cancellation": { "description": "Enable customer-initiated cancellation when processing this payment.", "type": "boolean" }, "return_url": { "description": "If the customer doesn't abandon authenticating the payment, they're redirected to this URL after completion.", "maxLength": 5000, "type": "string" }, "skip_tipping": { "description": "Override showing a tipping selection screen on this transaction.", "type": "boolean" }, "tipping": { "$ref": "#/components/schemas/terminal_reader_reader_resource_tipping_config" } }, "title": "TerminalReaderReaderResourceProcessConfig", "type": "object", "x-expandableFields": [ "tipping" ], "x-stripeMostCommon": [ "enable_customer_cancellation", "return_url", "skip_tipping", "tipping" ] }, "terminal_reader_reader_resource_process_payment_intent_action": { "description": "Represents a reader action to process a payment intent", "properties": { "account": { "description": "Account the payment intent belongs to.", "maxLength": 5000, "type": "string" }, "payment_intent": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/payment_intent" } ], "description": "Most recent PaymentIntent processed by the reader.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/payment_intent" } ] } }, "process_config": { "$ref": "#/components/schemas/terminal_reader_reader_resource_process_config" } }, "required": [ "payment_intent" ], "title": "TerminalReaderReaderResourceProcessPaymentIntentAction", "type": "object", "x-expandableFields": [ "payment_intent", "process_config" ], "x-stripeMostCommon": [ "payment_intent" ] }, "terminal_reader_reader_resource_process_setup_config": { "description": "Represents a per-setup override of a reader configuration", "properties": { "enable_customer_cancellation": { "description": "Enable customer-initiated cancellation when processing this SetupIntent.", "type": "boolean" } }, "title": "TerminalReaderReaderResourceProcessSetupConfig", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "enable_customer_cancellation" ] }, "terminal_reader_reader_resource_process_setup_intent_action": { "description": "Represents a reader action to process a setup intent", "properties": { "generated_card": { "description": "ID of a card PaymentMethod generated from the card_present PaymentMethod that may be attached to a Customer for future transactions. Only present if it was possible to generate a card PaymentMethod.", "maxLength": 5000, "type": "string" }, "process_config": { "$ref": "#/components/schemas/terminal_reader_reader_resource_process_setup_config" }, "setup_intent": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/setup_intent" } ], "description": "Most recent SetupIntent processed by the reader.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/setup_intent" } ] } } }, "required": [ "setup_intent" ], "title": "TerminalReaderReaderResourceProcessSetupIntentAction", "type": "object", "x-expandableFields": [ "process_config", "setup_intent" ], "x-stripeMostCommon": [ "setup_intent" ] }, "terminal_reader_reader_resource_reader_action": { "description": "Represents an action performed by the reader", "properties": { "collect_inputs": { "$ref": "#/components/schemas/terminal_reader_reader_resource_collect_inputs_action" }, "collect_payment_method": { "$ref": "#/components/schemas/terminal_reader_reader_resource_collect_payment_method_action" }, "confirm_payment_intent": { "$ref": "#/components/schemas/terminal_reader_reader_resource_confirm_payment_intent_action" }, "failure_code": { "description": "Failure code, only set if status is `failed`.", "maxLength": 5000, "nullable": true, "type": "string" }, "failure_message": { "description": "Detailed failure message, only set if status is `failed`.", "maxLength": 5000, "nullable": true, "type": "string" }, "process_payment_intent": { "$ref": "#/components/schemas/terminal_reader_reader_resource_process_payment_intent_action" }, "process_setup_intent": { "$ref": "#/components/schemas/terminal_reader_reader_resource_process_setup_intent_action" }, "refund_payment": { "$ref": "#/components/schemas/terminal_reader_reader_resource_refund_payment_action" }, "set_reader_display": { "$ref": "#/components/schemas/terminal_reader_reader_resource_set_reader_display_action" }, "status": { "description": "Status of the action performed by the reader.", "enum": [ "failed", "in_progress", "succeeded" ], "type": "string" }, "type": { "description": "Type of action performed by the reader.", "enum": [ "collect_inputs", "collect_payment_method", "confirm_payment_intent", "process_payment_intent", "process_setup_intent", "refund_payment", "set_reader_display" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "failure_code", "failure_message", "status", "type" ], "title": "TerminalReaderReaderResourceReaderAction", "type": "object", "x-expandableFields": [ "collect_inputs", "collect_payment_method", "confirm_payment_intent", "process_payment_intent", "process_setup_intent", "refund_payment", "set_reader_display" ], "x-stripeMostCommon": [ "collect_inputs", "collect_payment_method", "confirm_payment_intent", "failure_code", "failure_message", "process_payment_intent", "process_setup_intent", "refund_payment", "set_reader_display", "status", "type" ] }, "terminal_reader_reader_resource_refund_payment_action": { "description": "Represents a reader action to refund a payment", "properties": { "account": { "description": "Account the payment intent belongs to.", "maxLength": 5000, "type": "string" }, "amount": { "description": "The amount being refunded.", "type": "integer" }, "charge": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/charge" } ], "description": "Charge that is being refunded.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/charge" } ] } }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "type": "object" }, "payment_intent": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/payment_intent" } ], "description": "Payment intent that is being refunded.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/payment_intent" } ] } }, "reason": { "description": "The reason for the refund.", "enum": [ "duplicate", "fraudulent", "requested_by_customer" ], "type": "string" }, "refund": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/refund" } ], "description": "Unique identifier for the refund object.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/refund" } ] } }, "refund_application_fee": { "description": "Boolean indicating whether the application fee should be refunded when refunding this charge. If a full charge refund is given, the full application fee will be refunded. Otherwise, the application fee will be refunded in an amount proportional to the amount of the charge refunded. An application fee can be refunded only by the application that created the charge.", "type": "boolean" }, "refund_payment_config": { "$ref": "#/components/schemas/terminal_reader_reader_resource_refund_payment_config" }, "reverse_transfer": { "description": "Boolean indicating whether the transfer should be reversed when refunding this charge. The transfer will be reversed proportionally to the amount being refunded (either the entire or partial amount). A transfer can be reversed only by the application that created the charge.", "type": "boolean" } }, "title": "TerminalReaderReaderResourceRefundPaymentAction", "type": "object", "x-expandableFields": [ "charge", "payment_intent", "refund", "refund_payment_config" ], "x-stripeMostCommon": [ "amount", "charge", "metadata", "payment_intent", "reason", "refund", "refund_application_fee", "refund_payment_config", "reverse_transfer" ] }, "terminal_reader_reader_resource_refund_payment_config": { "description": "Represents a per-transaction override of a reader configuration", "properties": { "enable_customer_cancellation": { "description": "Enable customer-initiated cancellation when refunding this payment.", "type": "boolean" } }, "title": "TerminalReaderReaderResourceRefundPaymentConfig", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "enable_customer_cancellation" ] }, "terminal_reader_reader_resource_selection": { "description": "Information about a selection being collected using a reader", "properties": { "choices": { "description": "List of possible choices to be selected", "items": { "$ref": "#/components/schemas/terminal_reader_reader_resource_choice" }, "type": "array" }, "id": { "description": "The id of the selected choice", "maxLength": 5000, "nullable": true, "type": "string" }, "text": { "description": "The text of the selected choice", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "choices", "id", "text" ], "title": "TerminalReaderReaderResourceSelection", "type": "object", "x-expandableFields": [ "choices" ], "x-stripeMostCommon": [ "choices", "id", "text" ] }, "terminal_reader_reader_resource_set_reader_display_action": { "description": "Represents a reader action to set the reader display", "properties": { "cart": { "anyOf": [ { "$ref": "#/components/schemas/terminal_reader_reader_resource_cart" } ], "description": "Cart object to be displayed by the reader.", "nullable": true }, "type": { "description": "Type of information to be displayed by the reader.", "enum": [ "cart" ], "type": "string" } }, "required": [ "cart", "type" ], "title": "TerminalReaderReaderResourceSetReaderDisplayAction", "type": "object", "x-expandableFields": [ "cart" ], "x-stripeMostCommon": [ "cart", "type" ] }, "terminal_reader_reader_resource_signature": { "description": "Information about a signature being collected using a reader", "properties": { "value": { "description": "The File ID of a collected signature image", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "value" ], "title": "TerminalReaderReaderResourceSignature", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "value" ] }, "terminal_reader_reader_resource_text": { "description": "Information about text being collected using a reader", "properties": { "value": { "description": "The collected text value", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "value" ], "title": "TerminalReaderReaderResourceText", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "value" ] }, "terminal_reader_reader_resource_tipping_config": { "description": "Represents a per-transaction tipping configuration", "properties": { "amount_eligible": { "description": "Amount used to calculate tip suggestions on tipping selection screen for this transaction. Must be a positive integer in the smallest currency unit (e.g., 100 cents to represent $1.00 or 100 to represent ¥100, a zero-decimal currency).", "type": "integer" } }, "title": "TerminalReaderReaderResourceTippingConfig", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "amount_eligible" ] }, "terminal_reader_reader_resource_toggle": { "description": "Information about an input's toggle", "properties": { "default_value": { "description": "The toggle's default value", "enum": [ "disabled", "enabled" ], "nullable": true, "type": "string" }, "description": { "description": "The toggle's description text", "maxLength": 5000, "nullable": true, "type": "string" }, "title": { "description": "The toggle's title text", "maxLength": 5000, "nullable": true, "type": "string" }, "value": { "description": "The toggle's collected value", "enum": [ "disabled", "enabled" ], "nullable": true, "type": "string" } }, "required": [ "default_value", "description", "title", "value" ], "title": "TerminalReaderReaderResourceToggle", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "default_value", "description", "title", "value" ] }, "test_helpers.test_clock": { "description": "A test clock enables deterministic control over objects in testmode. With a test clock, you can create\nobjects at a frozen time in the past or future, and advance to a specific future time to observe webhooks and state changes. After the clock advances,\nyou can either validate the current state of your scenario (and test your assumptions), change the current state of your scenario (and test more complex scenarios), or keep advancing forward in time.", "properties": { "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "deletes_after": { "description": "Time at which this clock is scheduled to auto delete.", "format": "unix-time", "type": "integer" }, "frozen_time": { "description": "Time at which all objects belonging to this clock are frozen.", "format": "unix-time", "type": "integer" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "name": { "description": "The custom name supplied at creation.", "maxLength": 5000, "nullable": true, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "test_helpers.test_clock" ], "type": "string" }, "status": { "description": "The status of the Test Clock.", "enum": [ "advancing", "internal_failure", "ready" ], "type": "string" }, "status_details": { "$ref": "#/components/schemas/billing_clocks_resource_status_details_status_details" } }, "required": [ "created", "deletes_after", "frozen_time", "id", "livemode", "name", "object", "status", "status_details" ], "title": "TestClock", "type": "object", "x-expandableFields": [ "status_details" ], "x-resourceId": "test_helpers.test_clock", "x-stripeMostCommon": [ "created", "deletes_after", "frozen_time", "id", "livemode", "name", "object", "status", "status_details" ], "x-stripeOperations": [ { "method_name": "delete", "method_on": "service", "method_type": "delete", "operation": "delete", "path": "/v1/test_helpers/test_clocks/{test_clock}" }, { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/test_helpers/test_clocks" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/test_helpers/test_clocks/{test_clock}" }, { "method_name": "create", "method_on": "service", "method_type": "create", "operation": "post", "path": "/v1/test_helpers/test_clocks" }, { "method_name": "advance", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/test_helpers/test_clocks/{test_clock}/advance" } ], "x-stripeResource": { "class_name": "TestClock", "has_collection_class": true, "in_package": "TestHelpers" } }, "test_helpers.test_clock.advancing": { "description": "Occurs whenever a test clock starts advancing.", "properties": { "object": { "$ref": "#/components/schemas/test_helpers.test_clock" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "test_helpers.test_clock.advancing" } }, "test_helpers.test_clock.created": { "description": "Occurs whenever a test clock is created.", "properties": { "object": { "$ref": "#/components/schemas/test_helpers.test_clock" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "test_helpers.test_clock.created" } }, "test_helpers.test_clock.deleted": { "description": "Occurs whenever a test clock is deleted.", "properties": { "object": { "$ref": "#/components/schemas/test_helpers.test_clock" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "test_helpers.test_clock.deleted" } }, "test_helpers.test_clock.internal_failure": { "description": "Occurs whenever a test clock fails to advance its frozen time.", "properties": { "object": { "$ref": "#/components/schemas/test_helpers.test_clock" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "test_helpers.test_clock.internal_failure" } }, "test_helpers.test_clock.ready": { "description": "Occurs whenever a test clock transitions to a ready status.", "properties": { "object": { "$ref": "#/components/schemas/test_helpers.test_clock" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "test_helpers.test_clock.ready" } }, "three_d_secure_details": { "description": "", "properties": { "authentication_flow": { "description": "For authenticated transactions: how the customer was authenticated by\nthe issuing bank.", "enum": [ "challenge", "frictionless" ], "nullable": true, "type": "string" }, "electronic_commerce_indicator": { "description": "The Electronic Commerce Indicator (ECI). A protocol-level field\nindicating what degree of authentication was performed.", "enum": [ "01", "02", "05", "06", "07" ], "nullable": true, "type": "string", "x-stripeBypassValidation": true }, "result": { "description": "Indicates the outcome of 3D Secure authentication.", "enum": [ "attempt_acknowledged", "authenticated", "exempted", "failed", "not_supported", "processing_error" ], "nullable": true, "type": "string" }, "result_reason": { "description": "Additional information about why 3D Secure succeeded or failed based\non the `result`.", "enum": [ "abandoned", "bypassed", "canceled", "card_not_enrolled", "network_not_supported", "protocol_error", "rejected" ], "nullable": true, "type": "string" }, "transaction_id": { "description": "The 3D Secure 1 XID or 3D Secure 2 Directory Server Transaction ID\n(dsTransId) for this payment.", "maxLength": 5000, "nullable": true, "type": "string" }, "version": { "description": "The version of 3D Secure that was used.", "enum": [ "1.0.2", "2.1.0", "2.2.0" ], "nullable": true, "type": "string", "x-stripeBypassValidation": true } }, "required": [ "authentication_flow", "electronic_commerce_indicator", "result", "result_reason", "transaction_id", "version" ], "title": "three_d_secure_details", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "authentication_flow", "electronic_commerce_indicator", "result", "result_reason", "transaction_id", "version" ] }, "three_d_secure_details_charge": { "description": "", "properties": { "authentication_flow": { "description": "For authenticated transactions: how the customer was authenticated by\nthe issuing bank.", "enum": [ "challenge", "frictionless" ], "nullable": true, "type": "string" }, "electronic_commerce_indicator": { "description": "The Electronic Commerce Indicator (ECI). A protocol-level field\nindicating what degree of authentication was performed.", "enum": [ "01", "02", "05", "06", "07" ], "nullable": true, "type": "string", "x-stripeBypassValidation": true }, "exemption_indicator": { "description": "The exemption requested via 3DS and accepted by the issuer at authentication time.", "enum": [ "low_risk", "none" ], "nullable": true, "type": "string" }, "exemption_indicator_applied": { "description": "Whether Stripe requested the value of `exemption_indicator` in the transaction. This will depend on\nthe outcome of Stripe's internal risk assessment.", "type": "boolean" }, "result": { "description": "Indicates the outcome of 3D Secure authentication.", "enum": [ "attempt_acknowledged", "authenticated", "exempted", "failed", "not_supported", "processing_error" ], "nullable": true, "type": "string" }, "result_reason": { "description": "Additional information about why 3D Secure succeeded or failed based\non the `result`.", "enum": [ "abandoned", "bypassed", "canceled", "card_not_enrolled", "network_not_supported", "protocol_error", "rejected" ], "nullable": true, "type": "string" }, "transaction_id": { "description": "The 3D Secure 1 XID or 3D Secure 2 Directory Server Transaction ID\n(dsTransId) for this payment.", "maxLength": 5000, "nullable": true, "type": "string" }, "version": { "description": "The version of 3D Secure that was used.", "enum": [ "1.0.2", "2.1.0", "2.2.0" ], "nullable": true, "type": "string", "x-stripeBypassValidation": true } }, "required": [ "authentication_flow", "electronic_commerce_indicator", "exemption_indicator", "result", "result_reason", "transaction_id", "version" ], "title": "three_d_secure_details_charge", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "authentication_flow", "electronic_commerce_indicator", "exemption_indicator", "exemption_indicator_applied", "result", "result_reason", "transaction_id", "version" ] }, "three_d_secure_usage": { "description": "", "properties": { "supported": { "description": "Whether 3D Secure is supported on this card.", "type": "boolean" } }, "required": [ "supported" ], "title": "three_d_secure_usage", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "supported" ] }, "thresholds_resource_usage_alert_filter": { "description": "", "properties": { "customer": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/customer" } ], "description": "Limit the scope of the alert to this customer ID", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/customer" } ] } }, "type": { "enum": [ "customer" ], "type": "string" } }, "required": [ "customer", "type" ], "title": "ThresholdsResourceUsageAlertFilter", "type": "object", "x-expandableFields": [ "customer" ], "x-stripeMostCommon": [ "customer", "type" ] }, "thresholds_resource_usage_threshold_config": { "description": "The usage threshold alert configuration enables setting up alerts for when a certain usage threshold on a specific meter is crossed.", "properties": { "filters": { "description": "The filters allow limiting the scope of this usage alert. You can only specify up to one filter at this time.", "items": { "$ref": "#/components/schemas/thresholds_resource_usage_alert_filter" }, "nullable": true, "type": "array" }, "gte": { "description": "The value at which this alert will trigger.", "type": "integer" }, "meter": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/billing.meter" } ], "description": "The [Billing Meter](/api/billing/meter) ID whose usage is monitored.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/billing.meter" } ] } }, "recurrence": { "description": "Defines how the alert will behave.", "enum": [ "one_time" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "filters", "gte", "meter", "recurrence" ], "title": "ThresholdsResourceUsageThresholdConfig", "type": "object", "x-expandableFields": [ "filters", "meter" ], "x-stripeMostCommon": [ "filters", "gte", "meter", "recurrence" ] }, "token": { "description": "Tokenization is the process Stripe uses to collect sensitive card or bank\naccount details, or personally identifiable information (PII), directly from\nyour customers in a secure manner. A token representing this information is\nreturned to your server to use. Use our\n[recommended payments integrations](https://stripe.com/docs/payments) to perform this process\non the client-side. This guarantees that no sensitive card data touches your server,\nand allows your integration to operate in a PCI-compliant way.\n\nIf you can't use client-side tokenization, you can also create tokens using\nthe API with either your publishable or secret API key. If\nyour integration uses this method, you're responsible for any PCI compliance\nthat it might require, and you must keep your secret API key safe. Unlike with\nclient-side tokenization, your customer's information isn't sent directly to\nStripe, so we can't determine how it's handled or stored.\n\nYou can't store or use tokens more than once. To store card or bank account\ninformation for later use, create [Customer](https://stripe.com/docs/api#customers)\nobjects or [External accounts](/api#external_accounts).\n[Radar](https://stripe.com/docs/radar), our integrated solution for automatic fraud protection,\nperforms best with integrations that use client-side tokenization.", "properties": { "bank_account": { "$ref": "#/components/schemas/bank_account" }, "card": { "$ref": "#/components/schemas/card" }, "client_ip": { "description": "IP address of the client that generates the token.", "maxLength": 5000, "nullable": true, "type": "string" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "token" ], "type": "string" }, "type": { "description": "Type of the token: `account`, `bank_account`, `card`, or `pii`.", "maxLength": 5000, "type": "string" }, "used": { "description": "Determines if you have already used this token (you can only use tokens once).", "type": "boolean" } }, "required": [ "client_ip", "created", "id", "livemode", "object", "type", "used" ], "title": "Token", "type": "object", "x-expandableFields": [ "bank_account", "card" ], "x-resourceId": "token", "x-stripeMostCommon": [ "card", "id" ], "x-stripeOperations": [ { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/tokens/{token}" }, { "method_name": "create", "method_on": "service", "method_type": "create", "operation": "post", "path": "/v1/tokens" } ], "x-stripeResource": { "class_name": "Token", "in_package": "" } }, "token_card_networks": { "description": "", "properties": { "preferred": { "description": "The preferred network for co-branded cards. Can be `cartes_bancaires`, `mastercard`, `visa` or `invalid_preference` if requested network is not valid for the card.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "preferred" ], "title": "token_card_networks", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "preferred" ] }, "topup": { "description": "To top up your Stripe balance, you create a top-up object. You can retrieve\nindividual top-ups, as well as list all top-ups. Top-ups are identified by a\nunique, random ID.\n\nRelated guide: [Topping up your platform account](https://stripe.com/docs/connect/top-ups)", "properties": { "amount": { "description": "Amount transferred.", "type": "integer" }, "balance_transaction": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/balance_transaction" } ], "description": "ID of the balance transaction that describes the impact of this top-up on your account balance. May not be specified depending on status of top-up.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/balance_transaction" } ] } }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "maxLength": 5000, "type": "string" }, "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users.", "maxLength": 5000, "nullable": true, "type": "string" }, "expected_availability_date": { "description": "Date the funds are expected to arrive in your Stripe account for payouts. This factors in delays like weekends or bank holidays. May not be specified depending on status of top-up.", "nullable": true, "type": "integer" }, "failure_code": { "description": "Error code explaining reason for top-up failure if available (see [the errors section](https://stripe.com/docs/api#errors) for a list of codes).", "maxLength": 5000, "nullable": true, "type": "string" }, "failure_message": { "description": "Message to user further explaining reason for top-up failure if available.", "maxLength": 5000, "nullable": true, "type": "string" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "type": "object" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "topup" ], "type": "string" }, "source": { "anyOf": [ { "$ref": "#/components/schemas/source" } ], "description": "The source field is deprecated. It might not always be present in the API response.", "nullable": true }, "statement_descriptor": { "description": "Extra information about a top-up. This will appear on your source's bank statement. It must contain at least one letter.", "maxLength": 5000, "nullable": true, "type": "string" }, "status": { "description": "The status of the top-up is either `canceled`, `failed`, `pending`, `reversed`, or `succeeded`.", "enum": [ "canceled", "failed", "pending", "reversed", "succeeded" ], "type": "string" }, "transfer_group": { "description": "A string that identifies this top-up as part of a group.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "amount", "balance_transaction", "created", "currency", "description", "expected_availability_date", "failure_code", "failure_message", "id", "livemode", "metadata", "object", "source", "statement_descriptor", "status", "transfer_group" ], "title": "Topup", "type": "object", "x-expandableFields": [ "balance_transaction", "source" ], "x-resourceId": "topup", "x-stripeMostCommon": [ "amount", "currency", "description", "id", "metadata", "status" ], "x-stripeOperations": [ { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/topups" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/topups/{topup}" }, { "method_name": "create", "method_on": "service", "method_type": "create", "operation": "post", "path": "/v1/topups" }, { "method_name": "update", "method_on": "service", "method_type": "update", "operation": "post", "path": "/v1/topups/{topup}" }, { "method_name": "cancel", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/topups/{topup}/cancel" } ], "x-stripeResource": { "class_name": "Topup", "has_collection_class": true, "in_package": "", "polymorphic_groups": [ "balance_transaction_source" ] } }, "topup.canceled": { "description": "Occurs whenever a top-up is canceled.", "properties": { "object": { "$ref": "#/components/schemas/topup" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "topup.canceled" } }, "topup.created": { "description": "Occurs whenever a top-up is created.", "properties": { "object": { "$ref": "#/components/schemas/topup" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "topup.created" } }, "topup.failed": { "description": "Occurs whenever a top-up fails.", "properties": { "object": { "$ref": "#/components/schemas/topup" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "topup.failed" } }, "topup.reversed": { "description": "Occurs whenever a top-up is reversed.", "properties": { "object": { "$ref": "#/components/schemas/topup" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "topup.reversed" } }, "topup.succeeded": { "description": "Occurs whenever a top-up succeeds.", "properties": { "object": { "$ref": "#/components/schemas/topup" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "topup.succeeded" } }, "transfer": { "description": "A `Transfer` object is created when you move funds between Stripe accounts as\npart of Connect.\n\nBefore April 6, 2017, transfers also represented movement of funds from a\nStripe account to a card or bank account. This behavior has since been split\nout into a [Payout](https://stripe.com/docs/api#payout_object) object, with corresponding payout endpoints. For more\ninformation, read about the\n[transfer/payout split](https://stripe.com/docs/transfer-payout-split).\n\nRelated guide: [Creating separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers)", "properties": { "amount": { "description": "Amount in cents (or local equivalent) to be transferred.", "type": "integer" }, "amount_reversed": { "description": "Amount in cents (or local equivalent) reversed (can be less than the amount attribute on the transfer if a partial reversal was issued).", "type": "integer" }, "balance_transaction": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/balance_transaction" } ], "description": "Balance transaction that describes the impact of this transfer on your account balance.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/balance_transaction" } ] } }, "created": { "description": "Time that this record of the transfer was first created.", "format": "unix-time", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users.", "maxLength": 5000, "nullable": true, "type": "string" }, "destination": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/account" } ], "description": "ID of the Stripe account the transfer was sent to.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/account" } ] } }, "destination_payment": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/charge" } ], "description": "If the destination is a Stripe account, this will be the ID of the payment that the destination account received for the transfer.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/charge" } ] } }, "fx_quote": { "description": "The FX Quote used for the transfer.", "maxLength": 5000, "type": "string" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "type": "object" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "transfer" ], "type": "string" }, "reversals": { "description": "A list of reversals that have been applied to the transfer.", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/transfer_reversal" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "TransferReversalList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] }, "reversed": { "description": "Whether the transfer has been fully reversed. If the transfer is only partially reversed, this attribute will still be false.", "type": "boolean" }, "source_transaction": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/charge" } ], "description": "ID of the charge that was used to fund the transfer. If null, the transfer was funded from the available balance.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/charge" } ] } }, "source_type": { "description": "The source balance this transfer came from. One of `card`, `fpx`, or `bank_account`.", "maxLength": 5000, "type": "string" }, "transfer_group": { "description": "A string that identifies this transaction as part of a group. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) for details.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "amount", "amount_reversed", "balance_transaction", "created", "currency", "description", "destination", "id", "livemode", "metadata", "object", "reversals", "reversed", "source_transaction", "transfer_group" ], "title": "Transfer", "type": "object", "x-expandableFields": [ "balance_transaction", "destination", "destination_payment", "reversals", "source_transaction" ], "x-resourceId": "transfer", "x-stripeMostCommon": [ "amount", "currency", "description", "destination", "id", "metadata" ], "x-stripeOperations": [ { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/transfers" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/transfers/{transfer}" }, { "method_name": "create", "method_on": "service", "method_type": "create", "operation": "post", "path": "/v1/transfers" }, { "method_name": "update", "method_on": "service", "method_type": "update", "operation": "post", "path": "/v1/transfers/{transfer}" } ], "x-stripeResource": { "class_name": "Transfer", "has_collection_class": true, "in_package": "", "polymorphic_groups": [ "balance_transaction_source" ] } }, "transfer.created": { "description": "Occurs whenever a transfer is created.", "properties": { "object": { "$ref": "#/components/schemas/transfer" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "transfer.created" } }, "transfer.reversed": { "description": "Occurs whenever a transfer is reversed, including partial reversals.", "properties": { "object": { "$ref": "#/components/schemas/transfer" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "transfer.reversed" } }, "transfer.updated": { "description": "Occurs whenever a transfer's description or metadata is updated.", "properties": { "object": { "$ref": "#/components/schemas/transfer" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "transfer.updated" } }, "transfer_data": { "description": "", "properties": { "amount": { "description": "The amount transferred to the destination account. This transfer will occur automatically after the payment succeeds. If no amount is specified, by default the entire payment amount is transferred to the destination account.\n The amount must be less than or equal to the [amount](https://stripe.com/docs/api/payment_intents/object#payment_intent_object-amount), and must be a positive integer\n representing how much to transfer in the smallest currency unit (e.g., 100 cents to charge $1.00).", "type": "integer" }, "destination": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/account" } ], "description": "The account (if any) that the payment is attributed to for tax reporting, and where funds from the payment are transferred to after payment success.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/account" } ] } } }, "required": [ "destination" ], "title": "transfer_data", "type": "object", "x-expandableFields": [ "destination" ], "x-stripeMostCommon": [ "amount", "destination" ] }, "transfer_reversal": { "description": "[Stripe Connect](https://stripe.com/docs/connect) platforms can reverse transfers made to a\nconnected account, either entirely or partially, and can also specify whether\nto refund any related application fees. Transfer reversals add to the\nplatform's balance and subtract from the destination account's balance.\n\nReversing a transfer that was made for a [destination\ncharge](/docs/connect/destination-charges) is allowed only up to the amount of\nthe charge. It is possible to reverse a\n[transfer_group](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options)\ntransfer only if the destination account has enough balance to cover the\nreversal.\n\nRelated guide: [Reverse transfers](https://stripe.com/docs/connect/separate-charges-and-transfers#reverse-transfers)", "properties": { "amount": { "description": "Amount, in cents (or local equivalent).", "type": "integer" }, "balance_transaction": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/balance_transaction" } ], "description": "Balance transaction that describes the impact on your account balance.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/balance_transaction" } ] } }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "destination_payment_refund": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/refund" } ], "description": "Linked payment refund for the transfer reversal.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/refund" } ] } }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "nullable": true, "type": "object" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "transfer_reversal" ], "type": "string" }, "source_refund": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/refund" } ], "description": "ID of the refund responsible for the transfer reversal.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/refund" } ] } }, "transfer": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/transfer" } ], "description": "ID of the transfer that was reversed.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/transfer" } ] } } }, "required": [ "amount", "balance_transaction", "created", "currency", "destination_payment_refund", "id", "metadata", "object", "source_refund", "transfer" ], "title": "TransferReversal", "type": "object", "x-expandableFields": [ "balance_transaction", "destination_payment_refund", "source_refund", "transfer" ], "x-resourceId": "transfer_reversal", "x-stripeMostCommon": [ "amount", "currency", "id", "metadata", "transfer" ], "x-stripeOperations": [ { "method_name": "list", "method_on": "collection", "method_type": "list", "operation": "get", "path": "/v1/transfers/{id}/reversals" }, { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/transfers/{id}/reversals" }, { "method_name": "retrieve", "method_on": "collection", "method_type": "retrieve", "operation": "get", "path": "/v1/transfers/{transfer}/reversals/{id}" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/transfers/{transfer}/reversals/{id}" }, { "method_name": "create", "method_on": "collection", "method_type": "create", "operation": "post", "path": "/v1/transfers/{id}/reversals" }, { "method_name": "create", "method_on": "service", "method_type": "create", "operation": "post", "path": "/v1/transfers/{id}/reversals" }, { "method_name": "update", "method_on": "service", "method_type": "update", "operation": "post", "path": "/v1/transfers/{transfer}/reversals/{id}" } ], "x-stripeResource": { "class_name": "TransferReversal", "has_collection_class": true, "in_package": "", "polymorphic_groups": [ "balance_transaction_source" ] } }, "transfer_schedule": { "description": "", "properties": { "delay_days": { "description": "The number of days charges for the account will be held before being paid out.", "type": "integer" }, "interval": { "description": "How frequently funds will be paid out. One of `manual` (payouts only created via API call), `daily`, `weekly`, or `monthly`.", "maxLength": 5000, "type": "string" }, "monthly_anchor": { "description": "The day of the month funds will be paid out. Only shown if `interval` is monthly. Payouts scheduled between the 29th and 31st of the month are sent on the last day of shorter months.", "type": "integer" }, "monthly_payout_days": { "description": "The days of the month funds will be paid out. Only shown if `interval` is monthly. Payouts scheduled between the 29th and 31st of the month are sent on the last day of shorter months.", "items": { "type": "integer" }, "type": "array" }, "weekly_anchor": { "description": "The day of the week funds will be paid out, of the style 'monday', 'tuesday', etc. Only shown if `interval` is weekly.", "maxLength": 5000, "type": "string" }, "weekly_payout_days": { "description": "The days of the week when available funds are paid out, specified as an array, for example, [`monday`, `tuesday`]. Only shown if `interval` is weekly.", "items": { "enum": [ "friday", "monday", "thursday", "tuesday", "wednesday" ], "type": "string", "x-stripeBypassValidation": true }, "type": "array" } }, "required": [ "delay_days", "interval" ], "title": "TransferSchedule", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "delay_days", "interval", "monthly_anchor", "monthly_payout_days", "weekly_anchor", "weekly_payout_days" ] }, "transform_quantity": { "description": "", "properties": { "divide_by": { "description": "Divide usage by this number.", "type": "integer" }, "round": { "description": "After division, either round the result `up` or `down`.", "enum": [ "down", "up" ], "type": "string" } }, "required": [ "divide_by", "round" ], "title": "TransformQuantity", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "divide_by", "round" ] }, "transform_usage": { "description": "", "properties": { "divide_by": { "description": "Divide usage by this number.", "type": "integer" }, "round": { "description": "After division, either round the result `up` or `down`.", "enum": [ "down", "up" ], "type": "string" } }, "required": [ "divide_by", "round" ], "title": "TransformUsage", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "divide_by", "round" ] }, "treasury.credit_reversal": { "description": "You can reverse some [ReceivedCredits](https://stripe.com/docs/api#received_credits) depending on their network and source flow. Reversing a ReceivedCredit leads to the creation of a new object known as a CreditReversal.", "properties": { "amount": { "description": "Amount (in cents) transferred.", "type": "integer" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "financial_account": { "description": "The FinancialAccount to reverse funds from.", "maxLength": 5000, "type": "string" }, "hosted_regulatory_receipt_url": { "description": "A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.", "maxLength": 5000, "nullable": true, "type": "string" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "type": "object" }, "network": { "description": "The rails used to reverse the funds.", "enum": [ "ach", "stripe" ], "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "treasury.credit_reversal" ], "type": "string" }, "received_credit": { "description": "The ReceivedCredit being reversed.", "maxLength": 5000, "type": "string" }, "status": { "description": "Status of the CreditReversal", "enum": [ "canceled", "posted", "processing" ], "type": "string" }, "status_transitions": { "$ref": "#/components/schemas/treasury_received_credits_resource_status_transitions" }, "transaction": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/treasury.transaction" } ], "description": "The Transaction associated with this object.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/treasury.transaction" } ] } } }, "required": [ "amount", "created", "currency", "financial_account", "hosted_regulatory_receipt_url", "id", "livemode", "metadata", "network", "object", "received_credit", "status", "status_transitions", "transaction" ], "title": "TreasuryReceivedCreditsResourceCreditReversal", "type": "object", "x-expandableFields": [ "status_transitions", "transaction" ], "x-resourceId": "treasury.credit_reversal", "x-stripeMostCommon": [ "amount", "created", "currency", "financial_account", "hosted_regulatory_receipt_url", "id", "livemode", "metadata", "network", "object", "received_credit", "status", "status_transitions", "transaction" ], "x-stripeOperations": [ { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/treasury/credit_reversals" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/treasury/credit_reversals/{credit_reversal}" }, { "method_name": "create", "method_on": "service", "method_type": "create", "operation": "post", "path": "/v1/treasury/credit_reversals" } ], "x-stripeResource": { "class_name": "CreditReversal", "has_collection_class": true, "in_package": "Treasury" } }, "treasury.credit_reversal.created": { "description": "Occurs whenever an CreditReversal is submitted and created.", "properties": { "object": { "$ref": "#/components/schemas/treasury.credit_reversal" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "treasury.credit_reversal.created" } }, "treasury.credit_reversal.posted": { "description": "Occurs whenever an CreditReversal post is posted.", "properties": { "object": { "$ref": "#/components/schemas/treasury.credit_reversal" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "treasury.credit_reversal.posted" } }, "treasury.debit_reversal": { "description": "You can reverse some [ReceivedDebits](https://stripe.com/docs/api#received_debits) depending on their network and source flow. Reversing a ReceivedDebit leads to the creation of a new object known as a DebitReversal.", "properties": { "amount": { "description": "Amount (in cents) transferred.", "type": "integer" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "financial_account": { "description": "The FinancialAccount to reverse funds from.", "maxLength": 5000, "nullable": true, "type": "string" }, "hosted_regulatory_receipt_url": { "description": "A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.", "maxLength": 5000, "nullable": true, "type": "string" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "linked_flows": { "anyOf": [ { "$ref": "#/components/schemas/treasury_received_debits_resource_debit_reversal_linked_flows" } ], "description": "Other flows linked to a DebitReversal.", "nullable": true }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "type": "object" }, "network": { "description": "The rails used to reverse the funds.", "enum": [ "ach", "card" ], "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "treasury.debit_reversal" ], "type": "string" }, "received_debit": { "description": "The ReceivedDebit being reversed.", "maxLength": 5000, "type": "string" }, "status": { "description": "Status of the DebitReversal", "enum": [ "failed", "processing", "succeeded" ], "type": "string" }, "status_transitions": { "$ref": "#/components/schemas/treasury_received_debits_resource_status_transitions" }, "transaction": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/treasury.transaction" } ], "description": "The Transaction associated with this object.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/treasury.transaction" } ] } } }, "required": [ "amount", "created", "currency", "financial_account", "hosted_regulatory_receipt_url", "id", "linked_flows", "livemode", "metadata", "network", "object", "received_debit", "status", "status_transitions", "transaction" ], "title": "TreasuryReceivedDebitsResourceDebitReversal", "type": "object", "x-expandableFields": [ "linked_flows", "status_transitions", "transaction" ], "x-resourceId": "treasury.debit_reversal", "x-stripeMostCommon": [ "amount", "created", "currency", "financial_account", "hosted_regulatory_receipt_url", "id", "linked_flows", "livemode", "metadata", "network", "object", "received_debit", "status", "status_transitions", "transaction" ], "x-stripeOperations": [ { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/treasury/debit_reversals" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/treasury/debit_reversals/{debit_reversal}" }, { "method_name": "create", "method_on": "service", "method_type": "create", "operation": "post", "path": "/v1/treasury/debit_reversals" } ], "x-stripeResource": { "class_name": "DebitReversal", "has_collection_class": true, "in_package": "Treasury" } }, "treasury.debit_reversal.completed": { "description": "Occurs whenever a DebitReversal is completed.", "properties": { "object": { "$ref": "#/components/schemas/treasury.debit_reversal" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "treasury.debit_reversal.completed" } }, "treasury.debit_reversal.created": { "description": "Occurs whenever a DebitReversal is created.", "properties": { "object": { "$ref": "#/components/schemas/treasury.debit_reversal" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "treasury.debit_reversal.created" } }, "treasury.debit_reversal.initial_credit_granted": { "description": "Occurs whenever an initial credit is granted on a DebitReversal.", "properties": { "object": { "$ref": "#/components/schemas/treasury.debit_reversal" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "treasury.debit_reversal.initial_credit_granted" } }, "treasury.financial_account": { "description": "Stripe Treasury provides users with a container for money called a FinancialAccount that is separate from their Payments balance.\nFinancialAccounts serve as the source and destination of Treasury’s money movement APIs.", "properties": { "active_features": { "description": "The array of paths to active Features in the Features hash.", "items": { "enum": [ "card_issuing", "deposit_insurance", "financial_addresses.aba", "financial_addresses.aba.forwarding", "inbound_transfers.ach", "intra_stripe_flows", "outbound_payments.ach", "outbound_payments.us_domestic_wire", "outbound_transfers.ach", "outbound_transfers.us_domestic_wire", "remote_deposit_capture" ], "type": "string", "x-stripeBypassValidation": true }, "type": "array" }, "balance": { "$ref": "#/components/schemas/treasury_financial_accounts_resource_balance" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "display_name": { "description": "The display name for the FinancialAccount. Use this field to customize the names of the FinancialAccounts for your connected accounts. Unlike the `nickname` field, `display_name` is not internal metadata and will be exposed to connected accounts.", "maxLength": 5000, "nullable": true, "type": "string" }, "features": { "$ref": "#/components/schemas/treasury.financial_account_features" }, "financial_addresses": { "description": "The set of credentials that resolve to a FinancialAccount.", "items": { "$ref": "#/components/schemas/treasury_financial_accounts_resource_financial_address" }, "type": "array" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "is_default": { "type": "boolean" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "nullable": true, "type": "object" }, "nickname": { "description": "The nickname for the FinancialAccount.", "maxLength": 5000, "nullable": true, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "treasury.financial_account" ], "type": "string" }, "pending_features": { "description": "The array of paths to pending Features in the Features hash.", "items": { "enum": [ "card_issuing", "deposit_insurance", "financial_addresses.aba", "financial_addresses.aba.forwarding", "inbound_transfers.ach", "intra_stripe_flows", "outbound_payments.ach", "outbound_payments.us_domestic_wire", "outbound_transfers.ach", "outbound_transfers.us_domestic_wire", "remote_deposit_capture" ], "type": "string", "x-stripeBypassValidation": true }, "type": "array" }, "platform_restrictions": { "anyOf": [ { "$ref": "#/components/schemas/treasury_financial_accounts_resource_platform_restrictions" } ], "description": "The set of functionalities that the platform can restrict on the FinancialAccount.", "nullable": true }, "restricted_features": { "description": "The array of paths to restricted Features in the Features hash.", "items": { "enum": [ "card_issuing", "deposit_insurance", "financial_addresses.aba", "financial_addresses.aba.forwarding", "inbound_transfers.ach", "intra_stripe_flows", "outbound_payments.ach", "outbound_payments.us_domestic_wire", "outbound_transfers.ach", "outbound_transfers.us_domestic_wire", "remote_deposit_capture" ], "type": "string", "x-stripeBypassValidation": true }, "type": "array" }, "status": { "description": "Status of this FinancialAccount.", "enum": [ "closed", "open" ], "type": "string", "x-stripeBypassValidation": true }, "status_details": { "$ref": "#/components/schemas/treasury_financial_accounts_resource_status_details" }, "supported_currencies": { "description": "The currencies the FinancialAccount can hold a balance in. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.", "items": { "type": "string" }, "type": "array" } }, "required": [ "balance", "country", "created", "financial_addresses", "id", "livemode", "metadata", "object", "status", "status_details", "supported_currencies" ], "title": "TreasuryFinancialAccountsResourceFinancialAccount", "type": "object", "x-expandableFields": [ "balance", "features", "financial_addresses", "platform_restrictions", "status_details" ], "x-resourceId": "treasury.financial_account", "x-stripeMostCommon": [ "active_features", "balance", "country", "created", "display_name", "features", "financial_addresses", "id", "is_default", "livemode", "metadata", "nickname", "object", "pending_features", "platform_restrictions", "restricted_features", "status", "status_details", "supported_currencies" ], "x-stripeOperations": [ { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/treasury/financial_accounts" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/treasury/financial_accounts/{financial_account}" }, { "method_name": "retrieve_features", "method_on": "service", "method_type": "custom", "operation": "get", "path": "/v1/treasury/financial_accounts/{financial_account}/features" }, { "method_name": "create", "method_on": "service", "method_type": "create", "operation": "post", "path": "/v1/treasury/financial_accounts" }, { "method_name": "update", "method_on": "service", "method_type": "update", "operation": "post", "path": "/v1/treasury/financial_accounts/{financial_account}" }, { "method_name": "close", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/treasury/financial_accounts/{financial_account}/close" }, { "method_name": "update_features", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/treasury/financial_accounts/{financial_account}/features" } ], "x-stripeResource": { "class_name": "FinancialAccount", "has_collection_class": true, "in_package": "Treasury" } }, "treasury.financial_account.closed": { "description": "Occurs whenever the status of the FinancialAccount becomes closed.", "properties": { "object": { "$ref": "#/components/schemas/treasury.financial_account" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "treasury.financial_account.closed" } }, "treasury.financial_account.created": { "description": "Occurs whenever a new FinancialAccount is created.", "properties": { "object": { "$ref": "#/components/schemas/treasury.financial_account" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "treasury.financial_account.created" } }, "treasury.financial_account.features_status_updated": { "description": "Occurs whenever the statuses of any features within an existing FinancialAccount are updated.", "properties": { "object": { "$ref": "#/components/schemas/treasury.financial_account" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "treasury.financial_account.features_status_updated" } }, "treasury.financial_account_features": { "description": "Encodes whether a FinancialAccount has access to a particular Feature, with a `status` enum and associated `status_details`.\nStripe or the platform can control Features via the requested field.", "properties": { "card_issuing": { "$ref": "#/components/schemas/treasury_financial_accounts_resource_toggle_settings" }, "deposit_insurance": { "$ref": "#/components/schemas/treasury_financial_accounts_resource_toggle_settings" }, "financial_addresses": { "$ref": "#/components/schemas/treasury_financial_accounts_resource_financial_addresses_features" }, "inbound_transfers": { "$ref": "#/components/schemas/treasury_financial_accounts_resource_inbound_transfers" }, "intra_stripe_flows": { "$ref": "#/components/schemas/treasury_financial_accounts_resource_toggle_settings" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "treasury.financial_account_features" ], "type": "string" }, "outbound_payments": { "$ref": "#/components/schemas/treasury_financial_accounts_resource_outbound_payments" }, "outbound_transfers": { "$ref": "#/components/schemas/treasury_financial_accounts_resource_outbound_transfers" } }, "required": [ "object" ], "title": "TreasuryFinancialAccountsResourceFinancialAccountFeatures", "type": "object", "x-expandableFields": [ "card_issuing", "deposit_insurance", "financial_addresses", "inbound_transfers", "intra_stripe_flows", "outbound_payments", "outbound_transfers" ], "x-resourceId": "treasury.financial_account_features", "x-stripeMostCommon": [ "card_issuing", "deposit_insurance", "financial_addresses", "inbound_transfers", "intra_stripe_flows", "object", "outbound_payments", "outbound_transfers" ], "x-stripeResource": { "class_name": "FinancialAccountFeatures", "in_package": "Treasury" } }, "treasury.inbound_transfer": { "description": "Use [InboundTransfers](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/into/inbound-transfers) to add funds to your [FinancialAccount](https://stripe.com/docs/api#financial_accounts) via a PaymentMethod that is owned by you. The funds will be transferred via an ACH debit.\n\nRelated guide: [Moving money with Treasury using InboundTransfer objects](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/into/inbound-transfers)", "properties": { "amount": { "description": "Amount (in cents) transferred.", "type": "integer" }, "cancelable": { "description": "Returns `true` if the InboundTransfer is able to be canceled.", "type": "boolean" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users.", "maxLength": 5000, "nullable": true, "type": "string" }, "failure_details": { "anyOf": [ { "$ref": "#/components/schemas/treasury_inbound_transfers_resource_failure_details" } ], "description": "Details about this InboundTransfer's failure. Only set when status is `failed`.", "nullable": true }, "financial_account": { "description": "The FinancialAccount that received the funds.", "maxLength": 5000, "type": "string" }, "hosted_regulatory_receipt_url": { "description": "A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.", "maxLength": 5000, "nullable": true, "type": "string" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "linked_flows": { "$ref": "#/components/schemas/treasury_inbound_transfers_resource_inbound_transfer_resource_linked_flows" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "type": "object" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "treasury.inbound_transfer" ], "type": "string" }, "origin_payment_method": { "description": "The origin payment method to be debited for an InboundTransfer.", "maxLength": 5000, "nullable": true, "type": "string" }, "origin_payment_method_details": { "anyOf": [ { "$ref": "#/components/schemas/inbound_transfers" } ], "description": "Details about the PaymentMethod for an InboundTransfer.", "nullable": true }, "returned": { "description": "Returns `true` if the funds for an InboundTransfer were returned after the InboundTransfer went to the `succeeded` state.", "nullable": true, "type": "boolean" }, "statement_descriptor": { "description": "Statement descriptor shown when funds are debited from the source. Not all payment networks support `statement_descriptor`.", "maxLength": 5000, "type": "string" }, "status": { "description": "Status of the InboundTransfer: `processing`, `succeeded`, `failed`, and `canceled`. An InboundTransfer is `processing` if it is created and pending. The status changes to `succeeded` once the funds have been \"confirmed\" and a `transaction` is created and posted. The status changes to `failed` if the transfer fails.", "enum": [ "canceled", "failed", "processing", "succeeded" ], "type": "string", "x-stripeBypassValidation": true }, "status_transitions": { "$ref": "#/components/schemas/treasury_inbound_transfers_resource_inbound_transfer_resource_status_transitions" }, "transaction": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/treasury.transaction" } ], "description": "The Transaction associated with this object.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/treasury.transaction" } ] } } }, "required": [ "amount", "cancelable", "created", "currency", "description", "failure_details", "financial_account", "hosted_regulatory_receipt_url", "id", "linked_flows", "livemode", "metadata", "object", "origin_payment_method", "origin_payment_method_details", "returned", "statement_descriptor", "status", "status_transitions", "transaction" ], "title": "TreasuryInboundTransfersResourceInboundTransfer", "type": "object", "x-expandableFields": [ "failure_details", "linked_flows", "origin_payment_method_details", "status_transitions", "transaction" ], "x-resourceId": "treasury.inbound_transfer", "x-stripeMostCommon": [ "amount", "cancelable", "created", "currency", "description", "failure_details", "financial_account", "hosted_regulatory_receipt_url", "id", "linked_flows", "livemode", "metadata", "object", "origin_payment_method", "origin_payment_method_details", "returned", "statement_descriptor", "status", "status_transitions", "transaction" ], "x-stripeOperations": [ { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/treasury/inbound_transfers" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/treasury/inbound_transfers/{id}" }, { "method_name": "fail", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/test_helpers/treasury/inbound_transfers/{id}/fail" }, { "method_name": "return_inbound_transfer", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/test_helpers/treasury/inbound_transfers/{id}/return" }, { "method_name": "succeed", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/test_helpers/treasury/inbound_transfers/{id}/succeed" }, { "method_name": "create", "method_on": "service", "method_type": "create", "operation": "post", "path": "/v1/treasury/inbound_transfers" }, { "method_name": "cancel", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/treasury/inbound_transfers/{inbound_transfer}/cancel" } ], "x-stripeResource": { "class_name": "InboundTransfer", "has_collection_class": true, "in_package": "Treasury" } }, "treasury.inbound_transfer.canceled": { "description": "Occurs whenever an InboundTransfer is canceled.", "properties": { "object": { "$ref": "#/components/schemas/treasury.inbound_transfer" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "treasury.inbound_transfer.canceled" } }, "treasury.inbound_transfer.created": { "description": "Occurs whenever an InboundTransfer is created.", "properties": { "object": { "$ref": "#/components/schemas/treasury.inbound_transfer" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "treasury.inbound_transfer.created" } }, "treasury.inbound_transfer.failed": { "description": "Occurs whenever an InboundTransfer has failed.", "properties": { "object": { "$ref": "#/components/schemas/treasury.inbound_transfer" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "treasury.inbound_transfer.failed" } }, "treasury.inbound_transfer.succeeded": { "description": "Occurs whenever an InboundTransfer has succeeded.", "properties": { "object": { "$ref": "#/components/schemas/treasury.inbound_transfer" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "treasury.inbound_transfer.succeeded" } }, "treasury.outbound_payment": { "description": "Use [OutboundPayments](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-payments) to send funds to another party's external bank account or [FinancialAccount](https://stripe.com/docs/api#financial_accounts). To send money to an account belonging to the same user, use an [OutboundTransfer](https://stripe.com/docs/api#outbound_transfers).\n\nSimulate OutboundPayment state changes with the `/v1/test_helpers/treasury/outbound_payments` endpoints. These methods can only be called on test mode objects.\n\nRelated guide: [Moving money with Treasury using OutboundPayment objects](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-payments)", "properties": { "amount": { "description": "Amount (in cents) transferred.", "type": "integer" }, "cancelable": { "description": "Returns `true` if the object can be canceled, and `false` otherwise.", "type": "boolean" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "customer": { "description": "ID of the [customer](https://stripe.com/docs/api/customers) to whom an OutboundPayment is sent.", "maxLength": 5000, "nullable": true, "type": "string" }, "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users.", "maxLength": 5000, "nullable": true, "type": "string" }, "destination_payment_method": { "description": "The PaymentMethod via which an OutboundPayment is sent. This field can be empty if the OutboundPayment was created using `destination_payment_method_data`.", "maxLength": 5000, "nullable": true, "type": "string" }, "destination_payment_method_details": { "anyOf": [ { "$ref": "#/components/schemas/outbound_payments_payment_method_details" } ], "description": "Details about the PaymentMethod for an OutboundPayment.", "nullable": true }, "end_user_details": { "anyOf": [ { "$ref": "#/components/schemas/treasury_outbound_payments_resource_outbound_payment_resource_end_user_details" } ], "description": "Details about the end user.", "nullable": true }, "expected_arrival_date": { "description": "The date when funds are expected to arrive in the destination account.", "format": "unix-time", "type": "integer" }, "financial_account": { "description": "The FinancialAccount that funds were pulled from.", "maxLength": 5000, "type": "string" }, "hosted_regulatory_receipt_url": { "description": "A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.", "maxLength": 5000, "nullable": true, "type": "string" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "type": "object" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "treasury.outbound_payment" ], "type": "string" }, "returned_details": { "anyOf": [ { "$ref": "#/components/schemas/treasury_outbound_payments_resource_returned_status" } ], "description": "Details about a returned OutboundPayment. Only set when the status is `returned`.", "nullable": true }, "statement_descriptor": { "description": "The description that appears on the receiving end for an OutboundPayment (for example, bank statement for external bank transfer).", "maxLength": 5000, "type": "string" }, "status": { "description": "Current status of the OutboundPayment: `processing`, `failed`, `posted`, `returned`, `canceled`. An OutboundPayment is `processing` if it has been created and is pending. The status changes to `posted` once the OutboundPayment has been \"confirmed\" and funds have left the account, or to `failed` or `canceled`. If an OutboundPayment fails to arrive at its destination, its status will change to `returned`.", "enum": [ "canceled", "failed", "posted", "processing", "returned" ], "type": "string" }, "status_transitions": { "$ref": "#/components/schemas/treasury_outbound_payments_resource_outbound_payment_resource_status_transitions" }, "tracking_details": { "anyOf": [ { "$ref": "#/components/schemas/treasury_outbound_payments_resource_outbound_payment_resource_tracking_details" } ], "description": "Details about network-specific tracking information if available.", "nullable": true }, "transaction": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/treasury.transaction" } ], "description": "The Transaction associated with this object.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/treasury.transaction" } ] } } }, "required": [ "amount", "cancelable", "created", "currency", "customer", "description", "destination_payment_method", "destination_payment_method_details", "end_user_details", "expected_arrival_date", "financial_account", "hosted_regulatory_receipt_url", "id", "livemode", "metadata", "object", "returned_details", "statement_descriptor", "status", "status_transitions", "tracking_details", "transaction" ], "title": "TreasuryOutboundPaymentsResourceOutboundPayment", "type": "object", "x-expandableFields": [ "destination_payment_method_details", "end_user_details", "returned_details", "status_transitions", "tracking_details", "transaction" ], "x-resourceId": "treasury.outbound_payment", "x-stripeMostCommon": [ "amount", "cancelable", "created", "currency", "customer", "description", "destination_payment_method", "destination_payment_method_details", "end_user_details", "expected_arrival_date", "financial_account", "hosted_regulatory_receipt_url", "id", "livemode", "metadata", "object", "returned_details", "statement_descriptor", "status", "status_transitions", "tracking_details", "transaction" ], "x-stripeOperations": [ { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/treasury/outbound_payments" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/treasury/outbound_payments/{id}" }, { "method_name": "update", "method_on": "service", "method_type": "update", "operation": "post", "path": "/v1/test_helpers/treasury/outbound_payments/{id}" }, { "method_name": "fail", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/test_helpers/treasury/outbound_payments/{id}/fail" }, { "method_name": "post", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/test_helpers/treasury/outbound_payments/{id}/post" }, { "method_name": "return_outbound_payment", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/test_helpers/treasury/outbound_payments/{id}/return" }, { "method_name": "create", "method_on": "service", "method_type": "create", "operation": "post", "path": "/v1/treasury/outbound_payments" }, { "method_name": "cancel", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/treasury/outbound_payments/{id}/cancel" } ], "x-stripeResource": { "class_name": "OutboundPayment", "has_collection_class": true, "in_package": "Treasury" } }, "treasury.outbound_payment.canceled": { "description": "Occurs whenever an OutboundPayment is canceled.", "properties": { "object": { "$ref": "#/components/schemas/treasury.outbound_payment" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "treasury.outbound_payment.canceled" } }, "treasury.outbound_payment.created": { "description": "Occurs whenever a new OutboundPayment is successfully created.", "properties": { "object": { "$ref": "#/components/schemas/treasury.outbound_payment" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "treasury.outbound_payment.created" } }, "treasury.outbound_payment.expected_arrival_date_updated": { "description": "Occurs whenever the arrival date on an OutboundPayment updates.", "properties": { "object": { "$ref": "#/components/schemas/treasury.outbound_payment" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "treasury.outbound_payment.expected_arrival_date_updated" } }, "treasury.outbound_payment.failed": { "description": "Occurs whenever an OutboundPayment fails.", "properties": { "object": { "$ref": "#/components/schemas/treasury.outbound_payment" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "treasury.outbound_payment.failed" } }, "treasury.outbound_payment.posted": { "description": "Occurs whenever an OutboundPayment posts.", "properties": { "object": { "$ref": "#/components/schemas/treasury.outbound_payment" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "treasury.outbound_payment.posted" } }, "treasury.outbound_payment.returned": { "description": "Occurs whenever an OutboundPayment was returned.", "properties": { "object": { "$ref": "#/components/schemas/treasury.outbound_payment" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "treasury.outbound_payment.returned" } }, "treasury.outbound_payment.tracking_details_updated": { "description": "Occurs whenever tracking_details on an OutboundPayment is updated.", "properties": { "object": { "$ref": "#/components/schemas/treasury.outbound_payment" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "treasury.outbound_payment.tracking_details_updated" } }, "treasury.outbound_transfer": { "description": "Use [OutboundTransfers](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-transfers) to transfer funds from a [FinancialAccount](https://stripe.com/docs/api#financial_accounts) to a PaymentMethod belonging to the same entity. To send funds to a different party, use [OutboundPayments](https://stripe.com/docs/api#outbound_payments) instead. You can send funds over ACH rails or through a domestic wire transfer to a user's own external bank account.\n\nSimulate OutboundTransfer state changes with the `/v1/test_helpers/treasury/outbound_transfers` endpoints. These methods can only be called on test mode objects.\n\nRelated guide: [Moving money with Treasury using OutboundTransfer objects](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-transfers)", "properties": { "amount": { "description": "Amount (in cents) transferred.", "type": "integer" }, "cancelable": { "description": "Returns `true` if the object can be canceled, and `false` otherwise.", "type": "boolean" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users.", "maxLength": 5000, "nullable": true, "type": "string" }, "destination_payment_method": { "description": "The PaymentMethod used as the payment instrument for an OutboundTransfer.", "maxLength": 5000, "nullable": true, "type": "string" }, "destination_payment_method_details": { "$ref": "#/components/schemas/outbound_transfers_payment_method_details" }, "expected_arrival_date": { "description": "The date when funds are expected to arrive in the destination account.", "format": "unix-time", "type": "integer" }, "financial_account": { "description": "The FinancialAccount that funds were pulled from.", "maxLength": 5000, "type": "string" }, "hosted_regulatory_receipt_url": { "description": "A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.", "maxLength": 5000, "nullable": true, "type": "string" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "type": "object" }, "network_details": { "anyOf": [ { "$ref": "#/components/schemas/treasury_outbound_transfers_resource_network_details" } ], "description": "Details about the network used for the OutboundTransfer.", "nullable": true }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "treasury.outbound_transfer" ], "type": "string" }, "returned_details": { "anyOf": [ { "$ref": "#/components/schemas/treasury_outbound_transfers_resource_returned_details" } ], "description": "Details about a returned OutboundTransfer. Only set when the status is `returned`.", "nullable": true }, "statement_descriptor": { "description": "Information about the OutboundTransfer to be sent to the recipient account.", "maxLength": 5000, "type": "string" }, "status": { "description": "Current status of the OutboundTransfer: `processing`, `failed`, `canceled`, `posted`, `returned`. An OutboundTransfer is `processing` if it has been created and is pending. The status changes to `posted` once the OutboundTransfer has been \"confirmed\" and funds have left the account, or to `failed` or `canceled`. If an OutboundTransfer fails to arrive at its destination, its status will change to `returned`.", "enum": [ "canceled", "failed", "posted", "processing", "returned" ], "type": "string" }, "status_transitions": { "$ref": "#/components/schemas/treasury_outbound_transfers_resource_status_transitions" }, "tracking_details": { "anyOf": [ { "$ref": "#/components/schemas/treasury_outbound_transfers_resource_outbound_transfer_resource_tracking_details" } ], "description": "Details about network-specific tracking information if available.", "nullable": true }, "transaction": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/treasury.transaction" } ], "description": "The Transaction associated with this object.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/treasury.transaction" } ] } } }, "required": [ "amount", "cancelable", "created", "currency", "description", "destination_payment_method", "destination_payment_method_details", "expected_arrival_date", "financial_account", "hosted_regulatory_receipt_url", "id", "livemode", "metadata", "object", "returned_details", "statement_descriptor", "status", "status_transitions", "tracking_details", "transaction" ], "title": "TreasuryOutboundTransfersResourceOutboundTransfer", "type": "object", "x-expandableFields": [ "destination_payment_method_details", "network_details", "returned_details", "status_transitions", "tracking_details", "transaction" ], "x-resourceId": "treasury.outbound_transfer", "x-stripeMostCommon": [ "amount", "cancelable", "created", "currency", "description", "destination_payment_method", "destination_payment_method_details", "expected_arrival_date", "financial_account", "hosted_regulatory_receipt_url", "id", "livemode", "metadata", "network_details", "object", "returned_details", "statement_descriptor", "status", "status_transitions", "tracking_details", "transaction" ], "x-stripeOperations": [ { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/treasury/outbound_transfers" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/treasury/outbound_transfers/{outbound_transfer}" }, { "method_name": "update", "method_on": "service", "method_type": "update", "operation": "post", "path": "/v1/test_helpers/treasury/outbound_transfers/{outbound_transfer}" }, { "method_name": "fail", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/test_helpers/treasury/outbound_transfers/{outbound_transfer}/fail" }, { "method_name": "post", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/test_helpers/treasury/outbound_transfers/{outbound_transfer}/post" }, { "method_name": "return_outbound_transfer", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/test_helpers/treasury/outbound_transfers/{outbound_transfer}/return" }, { "method_name": "create", "method_on": "service", "method_type": "create", "operation": "post", "path": "/v1/treasury/outbound_transfers" }, { "method_name": "cancel", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/treasury/outbound_transfers/{outbound_transfer}/cancel" } ], "x-stripeResource": { "class_name": "OutboundTransfer", "has_collection_class": true, "in_package": "Treasury" } }, "treasury.outbound_transfer.canceled": { "description": "Occurs whenever an OutboundTransfer is canceled.", "properties": { "object": { "$ref": "#/components/schemas/treasury.outbound_transfer" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "treasury.outbound_transfer.canceled" } }, "treasury.outbound_transfer.created": { "description": "Occurs whenever an OutboundTransfer is created.", "properties": { "object": { "$ref": "#/components/schemas/treasury.outbound_transfer" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "treasury.outbound_transfer.created" } }, "treasury.outbound_transfer.expected_arrival_date_updated": { "description": "Occurs whenever the arrival date on an OutboundTransfer updates.", "properties": { "object": { "$ref": "#/components/schemas/treasury.outbound_transfer" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "treasury.outbound_transfer.expected_arrival_date_updated" } }, "treasury.outbound_transfer.failed": { "description": "Occurs whenever an OutboundTransfer has failed.", "properties": { "object": { "$ref": "#/components/schemas/treasury.outbound_transfer" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "treasury.outbound_transfer.failed" } }, "treasury.outbound_transfer.posted": { "description": "Occurs whenever an OutboundTransfer is posted.", "properties": { "object": { "$ref": "#/components/schemas/treasury.outbound_transfer" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "treasury.outbound_transfer.posted" } }, "treasury.outbound_transfer.returned": { "description": "Occurs whenever an OutboundTransfer is returned.", "properties": { "object": { "$ref": "#/components/schemas/treasury.outbound_transfer" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "treasury.outbound_transfer.returned" } }, "treasury.outbound_transfer.tracking_details_updated": { "description": "Occurs whenever tracking_details on an OutboundTransfer is updated.", "properties": { "object": { "$ref": "#/components/schemas/treasury.outbound_transfer" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "treasury.outbound_transfer.tracking_details_updated" } }, "treasury.received_credit": { "description": "ReceivedCredits represent funds sent to a [FinancialAccount](https://stripe.com/docs/api#financial_accounts) (for example, via ACH or wire). These money movements are not initiated from the FinancialAccount.", "properties": { "amount": { "description": "Amount (in cents) transferred.", "type": "integer" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users.", "maxLength": 5000, "type": "string" }, "failure_code": { "description": "Reason for the failure. A ReceivedCredit might fail because the receiving FinancialAccount is closed or frozen.", "enum": [ "account_closed", "account_frozen", "international_transaction", "other" ], "nullable": true, "type": "string", "x-stripeBypassValidation": true }, "financial_account": { "description": "The FinancialAccount that received the funds.", "maxLength": 5000, "nullable": true, "type": "string" }, "hosted_regulatory_receipt_url": { "description": "A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.", "maxLength": 5000, "nullable": true, "type": "string" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "initiating_payment_method_details": { "$ref": "#/components/schemas/treasury_shared_resource_initiating_payment_method_details_initiating_payment_method_details" }, "linked_flows": { "$ref": "#/components/schemas/treasury_received_credits_resource_linked_flows" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "network": { "description": "The rails used to send the funds.", "enum": [ "ach", "card", "stripe", "us_domestic_wire" ], "type": "string", "x-stripeBypassValidation": true }, "network_details": { "anyOf": [ { "$ref": "#/components/schemas/treasury_received_credits_resource_network_details" } ], "description": "Details specific to the money movement rails.", "nullable": true }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "treasury.received_credit" ], "type": "string" }, "reversal_details": { "anyOf": [ { "$ref": "#/components/schemas/treasury_received_credits_resource_reversal_details" } ], "description": "Details describing when a ReceivedCredit may be reversed.", "nullable": true }, "status": { "description": "Status of the ReceivedCredit. ReceivedCredits are created either `succeeded` (approved) or `failed` (declined). If a ReceivedCredit is declined, the failure reason can be found in the `failure_code` field.", "enum": [ "failed", "succeeded" ], "type": "string", "x-stripeBypassValidation": true }, "transaction": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/treasury.transaction" } ], "description": "The Transaction associated with this object.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/treasury.transaction" } ] } } }, "required": [ "amount", "created", "currency", "description", "failure_code", "financial_account", "hosted_regulatory_receipt_url", "id", "initiating_payment_method_details", "linked_flows", "livemode", "network", "object", "reversal_details", "status", "transaction" ], "title": "TreasuryReceivedCreditsResourceReceivedCredit", "type": "object", "x-expandableFields": [ "initiating_payment_method_details", "linked_flows", "network_details", "reversal_details", "transaction" ], "x-resourceId": "treasury.received_credit", "x-stripeMostCommon": [ "amount", "created", "currency", "description", "failure_code", "financial_account", "hosted_regulatory_receipt_url", "id", "initiating_payment_method_details", "linked_flows", "livemode", "network", "network_details", "object", "reversal_details", "status", "transaction" ], "x-stripeOperations": [ { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/treasury/received_credits" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/treasury/received_credits/{id}" }, { "method_name": "create", "method_on": "service", "method_type": "create", "operation": "post", "path": "/v1/test_helpers/treasury/received_credits" } ], "x-stripeResource": { "class_name": "ReceivedCredit", "has_collection_class": true, "in_package": "Treasury" } }, "treasury.received_credit.created": { "description": "Occurs whenever a received_credit is created as a result of funds being pushed by another account.", "properties": { "object": { "$ref": "#/components/schemas/treasury.received_credit" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "treasury.received_credit.created" } }, "treasury.received_credit.failed": { "description": "Occurs whenever a received_credit transitions to failed state. Only applicable for check deposits.", "properties": { "object": { "$ref": "#/components/schemas/treasury.received_credit" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "treasury.received_credit.failed" } }, "treasury.received_credit.succeeded": { "description": "Occurs whenever a received_credit transitions to succeeded state. Only applicable for check deposits.", "properties": { "object": { "$ref": "#/components/schemas/treasury.received_credit" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "treasury.received_credit.succeeded" } }, "treasury.received_debit": { "description": "ReceivedDebits represent funds pulled from a [FinancialAccount](https://stripe.com/docs/api#financial_accounts). These are not initiated from the FinancialAccount.", "properties": { "amount": { "description": "Amount (in cents) transferred.", "type": "integer" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users.", "maxLength": 5000, "type": "string" }, "failure_code": { "description": "Reason for the failure. A ReceivedDebit might fail because the FinancialAccount doesn't have sufficient funds, is closed, or is frozen.", "enum": [ "account_closed", "account_frozen", "insufficient_funds", "international_transaction", "other" ], "nullable": true, "type": "string" }, "financial_account": { "description": "The FinancialAccount that funds were pulled from.", "maxLength": 5000, "nullable": true, "type": "string" }, "hosted_regulatory_receipt_url": { "description": "A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.", "maxLength": 5000, "nullable": true, "type": "string" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "initiating_payment_method_details": { "$ref": "#/components/schemas/treasury_shared_resource_initiating_payment_method_details_initiating_payment_method_details" }, "linked_flows": { "$ref": "#/components/schemas/treasury_received_debits_resource_linked_flows" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "network": { "description": "The network used for the ReceivedDebit.", "enum": [ "ach", "card", "stripe" ], "type": "string", "x-stripeBypassValidation": true }, "network_details": { "anyOf": [ { "$ref": "#/components/schemas/treasury_received_debits_resource_network_details" } ], "description": "Details specific to the money movement rails.", "nullable": true }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "treasury.received_debit" ], "type": "string" }, "reversal_details": { "anyOf": [ { "$ref": "#/components/schemas/treasury_received_debits_resource_reversal_details" } ], "description": "Details describing when a ReceivedDebit might be reversed.", "nullable": true }, "status": { "description": "Status of the ReceivedDebit. ReceivedDebits are created with a status of either `succeeded` (approved) or `failed` (declined). The failure reason can be found under the `failure_code`.", "enum": [ "failed", "succeeded" ], "type": "string", "x-stripeBypassValidation": true }, "transaction": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/treasury.transaction" } ], "description": "The Transaction associated with this object.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/treasury.transaction" } ] } } }, "required": [ "amount", "created", "currency", "description", "failure_code", "financial_account", "hosted_regulatory_receipt_url", "id", "linked_flows", "livemode", "network", "object", "reversal_details", "status", "transaction" ], "title": "TreasuryReceivedDebitsResourceReceivedDebit", "type": "object", "x-expandableFields": [ "initiating_payment_method_details", "linked_flows", "network_details", "reversal_details", "transaction" ], "x-resourceId": "treasury.received_debit", "x-stripeMostCommon": [ "amount", "created", "currency", "description", "failure_code", "financial_account", "hosted_regulatory_receipt_url", "id", "initiating_payment_method_details", "linked_flows", "livemode", "network", "network_details", "object", "reversal_details", "status", "transaction" ], "x-stripeOperations": [ { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/treasury/received_debits" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/treasury/received_debits/{id}" }, { "method_name": "create", "method_on": "service", "method_type": "create", "operation": "post", "path": "/v1/test_helpers/treasury/received_debits" } ], "x-stripeResource": { "class_name": "ReceivedDebit", "has_collection_class": true, "in_package": "Treasury" } }, "treasury.received_debit.created": { "description": "Occurs whenever a received_debit is created as a result of funds being pulled by another account.", "properties": { "object": { "$ref": "#/components/schemas/treasury.received_debit" } }, "required": [ "object" ], "type": "object", "x-expandableFields": [], "x-stripeEvent": { "type": "treasury.received_debit.created" } }, "treasury.transaction": { "description": "Transactions represent changes to a [FinancialAccount's](https://stripe.com/docs/api#financial_accounts) balance.", "properties": { "amount": { "description": "Amount (in cents) transferred.", "type": "integer" }, "balance_impact": { "$ref": "#/components/schemas/treasury_transactions_resource_balance_impact" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users.", "maxLength": 5000, "type": "string" }, "entries": { "description": "A list of TransactionEntries that are part of this Transaction. This cannot be expanded in any list endpoints.", "nullable": true, "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/treasury.transaction_entry" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/treasury/transaction_entries", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "TreasuryTransactionsResourceTransactionEntryList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] }, "financial_account": { "description": "The FinancialAccount associated with this object.", "maxLength": 5000, "type": "string" }, "flow": { "description": "ID of the flow that created the Transaction.", "maxLength": 5000, "nullable": true, "type": "string" }, "flow_details": { "anyOf": [ { "$ref": "#/components/schemas/treasury_transactions_resource_flow_details" } ], "description": "Details of the flow that created the Transaction.", "nullable": true }, "flow_type": { "description": "Type of the flow that created the Transaction.", "enum": [ "credit_reversal", "debit_reversal", "inbound_transfer", "issuing_authorization", "other", "outbound_payment", "outbound_transfer", "received_credit", "received_debit" ], "type": "string", "x-stripeBypassValidation": true }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "treasury.transaction" ], "type": "string" }, "status": { "description": "Status of the Transaction.", "enum": [ "open", "posted", "void" ], "type": "string" }, "status_transitions": { "$ref": "#/components/schemas/treasury_transactions_resource_abstract_transaction_resource_status_transitions" } }, "required": [ "amount", "balance_impact", "created", "currency", "description", "financial_account", "flow", "flow_type", "id", "livemode", "object", "status", "status_transitions" ], "title": "TreasuryTransactionsResourceTransaction", "type": "object", "x-expandableFields": [ "balance_impact", "entries", "flow_details", "status_transitions" ], "x-resourceId": "treasury.transaction", "x-stripeMostCommon": [ "amount", "balance_impact", "created", "currency", "description", "entries", "financial_account", "flow", "flow_details", "flow_type", "id", "livemode", "object", "status", "status_transitions" ], "x-stripeOperations": [ { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/treasury/transactions" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/treasury/transactions/{id}" } ], "x-stripeResource": { "class_name": "Transaction", "has_collection_class": true, "in_package": "Treasury" } }, "treasury.transaction_entry": { "description": "TransactionEntries represent individual units of money movements within a single [Transaction](https://stripe.com/docs/api#transactions).", "properties": { "balance_impact": { "$ref": "#/components/schemas/treasury_transactions_resource_balance_impact" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "effective_at": { "description": "When the TransactionEntry will impact the FinancialAccount's balance.", "format": "unix-time", "type": "integer" }, "financial_account": { "description": "The FinancialAccount associated with this object.", "maxLength": 5000, "type": "string" }, "flow": { "description": "Token of the flow associated with the TransactionEntry.", "maxLength": 5000, "nullable": true, "type": "string" }, "flow_details": { "anyOf": [ { "$ref": "#/components/schemas/treasury_transactions_resource_flow_details" } ], "description": "Details of the flow associated with the TransactionEntry.", "nullable": true }, "flow_type": { "description": "Type of the flow associated with the TransactionEntry.", "enum": [ "credit_reversal", "debit_reversal", "inbound_transfer", "issuing_authorization", "other", "outbound_payment", "outbound_transfer", "received_credit", "received_debit" ], "type": "string", "x-stripeBypassValidation": true }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "treasury.transaction_entry" ], "type": "string" }, "transaction": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/treasury.transaction" } ], "description": "The Transaction associated with this object.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/treasury.transaction" } ] } }, "type": { "description": "The specific money movement that generated the TransactionEntry.", "enum": [ "credit_reversal", "credit_reversal_posting", "debit_reversal", "inbound_transfer", "inbound_transfer_return", "issuing_authorization_hold", "issuing_authorization_release", "other", "outbound_payment", "outbound_payment_cancellation", "outbound_payment_failure", "outbound_payment_posting", "outbound_payment_return", "outbound_transfer", "outbound_transfer_cancellation", "outbound_transfer_failure", "outbound_transfer_posting", "outbound_transfer_return", "received_credit", "received_debit" ], "type": "string" } }, "required": [ "balance_impact", "created", "currency", "effective_at", "financial_account", "flow", "flow_type", "id", "livemode", "object", "transaction", "type" ], "title": "TreasuryTransactionsResourceTransactionEntry", "type": "object", "x-expandableFields": [ "balance_impact", "flow_details", "transaction" ], "x-resourceId": "treasury.transaction_entry", "x-stripeMostCommon": [ "balance_impact", "created", "currency", "effective_at", "financial_account", "flow", "flow_details", "flow_type", "id", "livemode", "object", "transaction", "type" ], "x-stripeOperations": [ { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/treasury/transaction_entries" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/treasury/transaction_entries/{id}" } ], "x-stripeResource": { "class_name": "TransactionEntry", "has_collection_class": true, "in_package": "Treasury" } }, "treasury_financial_accounts_resource_aba_record": { "description": "ABA Records contain U.S. bank account details per the ABA format.", "properties": { "account_holder_name": { "description": "The name of the person or business that owns the bank account.", "maxLength": 5000, "type": "string" }, "account_number": { "description": "The account number.", "maxLength": 5000, "nullable": true, "type": "string" }, "account_number_last4": { "description": "The last four characters of the account number.", "maxLength": 5000, "type": "string" }, "bank_name": { "description": "Name of the bank.", "maxLength": 5000, "type": "string" }, "routing_number": { "description": "Routing number for the account.", "maxLength": 5000, "type": "string" } }, "required": [ "account_holder_name", "account_number_last4", "bank_name", "routing_number" ], "title": "TreasuryFinancialAccountsResourceABARecord", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "account_holder_name", "account_number", "account_number_last4", "bank_name", "routing_number" ], "x-stripeResource": { "class_name": "Aba", "in_package": "" } }, "treasury_financial_accounts_resource_aba_toggle_settings": { "description": "Toggle settings for enabling/disabling the ABA address feature", "properties": { "bank": { "description": "Requested bank partner for this Financial Account", "enum": [ "evolve", "fifth_third", "goldman_sachs" ], "type": "string" }, "requested": { "description": "Whether the FinancialAccount should have the Feature.", "type": "boolean" }, "status": { "description": "Whether the Feature is operational.", "enum": [ "active", "pending", "restricted" ], "type": "string" }, "status_details": { "description": "Additional details; includes at least one entry when the status is not `active`.", "items": { "$ref": "#/components/schemas/treasury_financial_accounts_resource_toggles_setting_status_details" }, "type": "array" } }, "required": [ "requested", "status", "status_details" ], "title": "TreasuryFinancialAccountsResourceAbaToggleSettings", "type": "object", "x-expandableFields": [ "status_details" ], "x-stripeMostCommon": [ "bank", "requested", "status", "status_details" ], "x-stripeResource": { "class_name": "AbaToggleSettings", "in_package": "" } }, "treasury_financial_accounts_resource_balance": { "description": "Balance information for the FinancialAccount", "properties": { "cash": { "additionalProperties": { "type": "integer" }, "description": "Funds the user can spend right now.", "type": "object" }, "inbound_pending": { "additionalProperties": { "type": "integer" }, "description": "Funds not spendable yet, but will become available at a later time.", "type": "object" }, "outbound_pending": { "additionalProperties": { "type": "integer" }, "description": "Funds in the account, but not spendable because they are being held for pending outbound flows.", "type": "object" } }, "required": [ "cash", "inbound_pending", "outbound_pending" ], "title": "TreasuryFinancialAccountsResourceBalance", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "cash", "inbound_pending", "outbound_pending" ], "x-stripeResource": { "class_name": "Balance", "in_package": "" } }, "treasury_financial_accounts_resource_closed_status_details": { "description": "", "properties": { "reasons": { "description": "The array that contains reasons for a FinancialAccount closure.", "items": { "enum": [ "account_rejected", "closed_by_platform", "other" ], "type": "string" }, "type": "array" } }, "required": [ "reasons" ], "title": "TreasuryFinancialAccountsResourceClosedStatusDetails", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "reasons" ], "x-stripeResource": { "class_name": "Closed", "in_package": "" } }, "treasury_financial_accounts_resource_financial_address": { "description": "FinancialAddresses contain identifying information that resolves to a FinancialAccount.", "properties": { "aba": { "$ref": "#/components/schemas/treasury_financial_accounts_resource_aba_record" }, "supported_networks": { "description": "The list of networks that the address supports", "items": { "enum": [ "ach", "us_domestic_wire" ], "type": "string", "x-stripeBypassValidation": true }, "type": "array" }, "type": { "description": "The type of financial address", "enum": [ "aba" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "TreasuryFinancialAccountsResourceFinancialAddress", "type": "object", "x-expandableFields": [ "aba" ], "x-stripeMostCommon": [ "aba", "supported_networks", "type" ] }, "treasury_financial_accounts_resource_financial_addresses_features": { "description": "Settings related to Financial Addresses features on a Financial Account", "properties": { "aba": { "$ref": "#/components/schemas/treasury_financial_accounts_resource_aba_toggle_settings" } }, "title": "TreasuryFinancialAccountsResourceFinancialAddressesFeatures", "type": "object", "x-expandableFields": [ "aba" ], "x-stripeMostCommon": [ "aba" ], "x-stripeResource": { "class_name": "FinancialAddresses", "in_package": "" } }, "treasury_financial_accounts_resource_inbound_ach_toggle_settings": { "description": "Toggle settings for enabling/disabling an inbound ACH specific feature", "properties": { "requested": { "description": "Whether the FinancialAccount should have the Feature.", "type": "boolean" }, "status": { "description": "Whether the Feature is operational.", "enum": [ "active", "pending", "restricted" ], "type": "string" }, "status_details": { "description": "Additional details; includes at least one entry when the status is not `active`.", "items": { "$ref": "#/components/schemas/treasury_financial_accounts_resource_toggles_setting_status_details" }, "type": "array" } }, "required": [ "requested", "status", "status_details" ], "title": "TreasuryFinancialAccountsResourceInboundAchToggleSettings", "type": "object", "x-expandableFields": [ "status_details" ], "x-stripeMostCommon": [ "requested", "status", "status_details" ], "x-stripeResource": { "class_name": "InboundAchToggleSettings", "in_package": "" } }, "treasury_financial_accounts_resource_inbound_transfers": { "description": "InboundTransfers contains inbound transfers features for a FinancialAccount.", "properties": { "ach": { "$ref": "#/components/schemas/treasury_financial_accounts_resource_inbound_ach_toggle_settings" } }, "title": "TreasuryFinancialAccountsResourceInboundTransfers", "type": "object", "x-expandableFields": [ "ach" ], "x-stripeMostCommon": [ "ach" ], "x-stripeResource": { "class_name": "InboundTransfers", "in_package": "" } }, "treasury_financial_accounts_resource_outbound_ach_toggle_settings": { "description": "Toggle settings for enabling/disabling an outbound ACH specific feature", "properties": { "requested": { "description": "Whether the FinancialAccount should have the Feature.", "type": "boolean" }, "status": { "description": "Whether the Feature is operational.", "enum": [ "active", "pending", "restricted" ], "type": "string" }, "status_details": { "description": "Additional details; includes at least one entry when the status is not `active`.", "items": { "$ref": "#/components/schemas/treasury_financial_accounts_resource_toggles_setting_status_details" }, "type": "array" } }, "required": [ "requested", "status", "status_details" ], "title": "TreasuryFinancialAccountsResourceOutboundAchToggleSettings", "type": "object", "x-expandableFields": [ "status_details" ], "x-stripeMostCommon": [ "requested", "status", "status_details" ], "x-stripeResource": { "class_name": "OutboundAchToggleSettings", "in_package": "" } }, "treasury_financial_accounts_resource_outbound_payments": { "description": "Settings related to Outbound Payments features on a Financial Account", "properties": { "ach": { "$ref": "#/components/schemas/treasury_financial_accounts_resource_outbound_ach_toggle_settings" }, "us_domestic_wire": { "$ref": "#/components/schemas/treasury_financial_accounts_resource_toggle_settings" } }, "title": "TreasuryFinancialAccountsResourceOutboundPayments", "type": "object", "x-expandableFields": [ "ach", "us_domestic_wire" ], "x-stripeMostCommon": [ "ach", "us_domestic_wire" ], "x-stripeResource": { "class_name": "OutboundPayments", "in_package": "" } }, "treasury_financial_accounts_resource_outbound_transfers": { "description": "OutboundTransfers contains outbound transfers features for a FinancialAccount.", "properties": { "ach": { "$ref": "#/components/schemas/treasury_financial_accounts_resource_outbound_ach_toggle_settings" }, "us_domestic_wire": { "$ref": "#/components/schemas/treasury_financial_accounts_resource_toggle_settings" } }, "title": "TreasuryFinancialAccountsResourceOutboundTransfers", "type": "object", "x-expandableFields": [ "ach", "us_domestic_wire" ], "x-stripeMostCommon": [ "ach", "us_domestic_wire" ], "x-stripeResource": { "class_name": "OutboundTransfers", "in_package": "" } }, "treasury_financial_accounts_resource_platform_restrictions": { "description": "Restrictions that a Connect Platform has placed on this FinancialAccount.", "properties": { "inbound_flows": { "description": "Restricts all inbound money movement.", "enum": [ "restricted", "unrestricted" ], "nullable": true, "type": "string" }, "outbound_flows": { "description": "Restricts all outbound money movement.", "enum": [ "restricted", "unrestricted" ], "nullable": true, "type": "string" } }, "required": [ "inbound_flows", "outbound_flows" ], "title": "TreasuryFinancialAccountsResourcePlatformRestrictions", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "inbound_flows", "outbound_flows" ], "x-stripeResource": { "class_name": "PlatformRestriction", "in_package": "" } }, "treasury_financial_accounts_resource_status_details": { "description": "", "properties": { "closed": { "anyOf": [ { "$ref": "#/components/schemas/treasury_financial_accounts_resource_closed_status_details" } ], "description": "Details related to the closure of this FinancialAccount", "nullable": true } }, "required": [ "closed" ], "title": "TreasuryFinancialAccountsResourceStatusDetails", "type": "object", "x-expandableFields": [ "closed" ], "x-stripeMostCommon": [ "closed" ], "x-stripeResource": { "class_name": "StatusDetails", "in_package": "" } }, "treasury_financial_accounts_resource_toggle_settings": { "description": "Toggle settings for enabling/disabling a feature", "properties": { "requested": { "description": "Whether the FinancialAccount should have the Feature.", "type": "boolean" }, "status": { "description": "Whether the Feature is operational.", "enum": [ "active", "pending", "restricted" ], "type": "string" }, "status_details": { "description": "Additional details; includes at least one entry when the status is not `active`.", "items": { "$ref": "#/components/schemas/treasury_financial_accounts_resource_toggles_setting_status_details" }, "type": "array" } }, "required": [ "requested", "status", "status_details" ], "title": "TreasuryFinancialAccountsResourceToggleSettings", "type": "object", "x-expandableFields": [ "status_details" ], "x-stripeMostCommon": [ "requested", "status", "status_details" ], "x-stripeResource": { "class_name": "ToggleSettings", "in_package": "" } }, "treasury_financial_accounts_resource_toggles_setting_status_details": { "description": "Additional details on the FinancialAccount Features information.", "properties": { "code": { "description": "Represents the reason why the status is `pending` or `restricted`.", "enum": [ "activating", "capability_not_requested", "financial_account_closed", "rejected_other", "rejected_unsupported_business", "requirements_past_due", "requirements_pending_verification", "restricted_by_platform", "restricted_other" ], "type": "string", "x-stripeBypassValidation": true }, "resolution": { "description": "Represents what the user should do, if anything, to activate the Feature.", "enum": [ "contact_stripe", "provide_information", "remove_restriction" ], "nullable": true, "type": "string", "x-stripeBypassValidation": true }, "restriction": { "description": "The `platform_restrictions` that are restricting this Feature.", "enum": [ "inbound_flows", "outbound_flows" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "code", "resolution" ], "title": "TreasuryFinancialAccountsResourceTogglesSettingStatusDetails", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "code", "resolution", "restriction" ], "x-stripeResource": { "class_name": "StatusDetails", "in_package": "" } }, "treasury_inbound_transfers_resource_failure_details": { "description": "", "properties": { "code": { "description": "Reason for the failure.", "enum": [ "account_closed", "account_frozen", "bank_account_restricted", "bank_ownership_changed", "debit_not_authorized", "incorrect_account_holder_address", "incorrect_account_holder_name", "incorrect_account_holder_tax_id", "insufficient_funds", "invalid_account_number", "invalid_currency", "no_account", "other" ], "type": "string" } }, "required": [ "code" ], "title": "TreasuryInboundTransfersResourceFailureDetails", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "code" ] }, "treasury_inbound_transfers_resource_inbound_transfer_resource_linked_flows": { "description": "", "properties": { "received_debit": { "description": "If funds for this flow were returned after the flow went to the `succeeded` state, this field contains a reference to the ReceivedDebit return.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "received_debit" ], "title": "TreasuryInboundTransfersResourceInboundTransferResourceLinkedFlows", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "received_debit" ] }, "treasury_inbound_transfers_resource_inbound_transfer_resource_status_transitions": { "description": "", "properties": { "canceled_at": { "description": "Timestamp describing when an InboundTransfer changed status to `canceled`.", "format": "unix-time", "nullable": true, "type": "integer" }, "failed_at": { "description": "Timestamp describing when an InboundTransfer changed status to `failed`.", "format": "unix-time", "nullable": true, "type": "integer" }, "succeeded_at": { "description": "Timestamp describing when an InboundTransfer changed status to `succeeded`.", "format": "unix-time", "nullable": true, "type": "integer" } }, "required": [ "failed_at", "succeeded_at" ], "title": "TreasuryInboundTransfersResourceInboundTransferResourceStatusTransitions", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "canceled_at", "failed_at", "succeeded_at" ], "x-stripeResource": { "class_name": "StatusTransitions", "in_package": "" } }, "treasury_outbound_payments_resource_ach_tracking_details": { "description": "", "properties": { "trace_id": { "description": "ACH trace ID of the OutboundPayment for payments sent over the `ach` network.", "maxLength": 5000, "type": "string" } }, "required": [ "trace_id" ], "title": "TreasuryOutboundPaymentsResourceACHTrackingDetails", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "trace_id" ] }, "treasury_outbound_payments_resource_outbound_payment_resource_end_user_details": { "description": "", "properties": { "ip_address": { "description": "IP address of the user initiating the OutboundPayment. Set if `present` is set to `true`. IP address collection is required for risk and compliance reasons. This will be used to help determine if the OutboundPayment is authorized or should be blocked.", "maxLength": 5000, "nullable": true, "type": "string" }, "present": { "description": "`true` if the OutboundPayment creation request is being made on behalf of an end user by a platform. Otherwise, `false`.", "type": "boolean" } }, "required": [ "ip_address", "present" ], "title": "TreasuryOutboundPaymentsResourceOutboundPaymentResourceEndUserDetails", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "ip_address", "present" ] }, "treasury_outbound_payments_resource_outbound_payment_resource_status_transitions": { "description": "", "properties": { "canceled_at": { "description": "Timestamp describing when an OutboundPayment changed status to `canceled`.", "format": "unix-time", "nullable": true, "type": "integer" }, "failed_at": { "description": "Timestamp describing when an OutboundPayment changed status to `failed`.", "format": "unix-time", "nullable": true, "type": "integer" }, "posted_at": { "description": "Timestamp describing when an OutboundPayment changed status to `posted`.", "format": "unix-time", "nullable": true, "type": "integer" }, "returned_at": { "description": "Timestamp describing when an OutboundPayment changed status to `returned`.", "format": "unix-time", "nullable": true, "type": "integer" } }, "required": [ "canceled_at", "failed_at", "posted_at", "returned_at" ], "title": "TreasuryOutboundPaymentsResourceOutboundPaymentResourceStatusTransitions", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "canceled_at", "failed_at", "posted_at", "returned_at" ], "x-stripeResource": { "class_name": "StatusTransitions", "in_package": "" } }, "treasury_outbound_payments_resource_outbound_payment_resource_tracking_details": { "description": "", "properties": { "ach": { "$ref": "#/components/schemas/treasury_outbound_payments_resource_ach_tracking_details" }, "type": { "description": "The US bank account network used to send funds.", "enum": [ "ach", "us_domestic_wire" ], "type": "string" }, "us_domestic_wire": { "$ref": "#/components/schemas/treasury_outbound_payments_resource_us_domestic_wire_tracking_details" } }, "required": [ "type" ], "title": "TreasuryOutboundPaymentsResourceOutboundPaymentResourceTrackingDetails", "type": "object", "x-expandableFields": [ "ach", "us_domestic_wire" ], "x-stripeMostCommon": [ "ach", "type", "us_domestic_wire" ] }, "treasury_outbound_payments_resource_returned_status": { "description": "", "properties": { "code": { "description": "Reason for the return.", "enum": [ "account_closed", "account_frozen", "bank_account_restricted", "bank_ownership_changed", "declined", "incorrect_account_holder_name", "invalid_account_number", "invalid_currency", "no_account", "other" ], "type": "string" }, "transaction": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/treasury.transaction" } ], "description": "The Transaction associated with this object.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/treasury.transaction" } ] } } }, "required": [ "code", "transaction" ], "title": "TreasuryOutboundPaymentsResourceReturnedStatus", "type": "object", "x-expandableFields": [ "transaction" ], "x-stripeMostCommon": [ "code", "transaction" ] }, "treasury_outbound_payments_resource_us_domestic_wire_tracking_details": { "description": "", "properties": { "chips": { "description": "CHIPS System Sequence Number (SSN) of the OutboundPayment for payments sent over the `us_domestic_wire` network.", "maxLength": 5000, "nullable": true, "type": "string" }, "imad": { "description": "IMAD of the OutboundPayment for payments sent over the `us_domestic_wire` network.", "maxLength": 5000, "nullable": true, "type": "string" }, "omad": { "description": "OMAD of the OutboundPayment for payments sent over the `us_domestic_wire` network.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "chips", "imad", "omad" ], "title": "TreasuryOutboundPaymentsResourceUSDomesticWireTrackingDetails", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "chips", "imad", "omad" ] }, "treasury_outbound_transfers_resource_ach_network_details": { "description": "", "properties": { "addenda": { "description": "ACH Addenda record", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "addenda" ], "title": "TreasuryOutboundTransfersResourceACHNetworkDetails", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "addenda" ] }, "treasury_outbound_transfers_resource_ach_tracking_details": { "description": "", "properties": { "trace_id": { "description": "ACH trace ID of the OutboundTransfer for transfers sent over the `ach` network.", "maxLength": 5000, "type": "string" } }, "required": [ "trace_id" ], "title": "TreasuryOutboundTransfersResourceACHTrackingDetails", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "trace_id" ] }, "treasury_outbound_transfers_resource_network_details": { "description": "", "properties": { "ach": { "anyOf": [ { "$ref": "#/components/schemas/treasury_outbound_transfers_resource_ach_network_details" } ], "description": "Details about an ACH transaction.", "nullable": true }, "type": { "description": "The type of flow that originated the OutboundTransfer.", "enum": [ "ach" ], "type": "string" } }, "required": [ "type" ], "title": "TreasuryOutboundTransfersResourceNetworkDetails", "type": "object", "x-expandableFields": [ "ach" ], "x-stripeMostCommon": [ "ach", "type" ], "x-stripeResource": { "class_name": "NetworkDetails", "in_package": "" } }, "treasury_outbound_transfers_resource_outbound_transfer_resource_tracking_details": { "description": "", "properties": { "ach": { "$ref": "#/components/schemas/treasury_outbound_transfers_resource_ach_tracking_details" }, "type": { "description": "The US bank account network used to send funds.", "enum": [ "ach", "us_domestic_wire" ], "type": "string" }, "us_domestic_wire": { "$ref": "#/components/schemas/treasury_outbound_transfers_resource_us_domestic_wire_tracking_details" } }, "required": [ "type" ], "title": "TreasuryOutboundTransfersResourceOutboundTransferResourceTrackingDetails", "type": "object", "x-expandableFields": [ "ach", "us_domestic_wire" ], "x-stripeMostCommon": [ "ach", "type", "us_domestic_wire" ] }, "treasury_outbound_transfers_resource_returned_details": { "description": "", "properties": { "code": { "description": "Reason for the return.", "enum": [ "account_closed", "account_frozen", "bank_account_restricted", "bank_ownership_changed", "declined", "incorrect_account_holder_name", "invalid_account_number", "invalid_currency", "no_account", "other" ], "type": "string" }, "transaction": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/treasury.transaction" } ], "description": "The Transaction associated with this object.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/treasury.transaction" } ] } } }, "required": [ "code", "transaction" ], "title": "TreasuryOutboundTransfersResourceReturnedDetails", "type": "object", "x-expandableFields": [ "transaction" ], "x-stripeMostCommon": [ "code", "transaction" ], "x-stripeResource": { "class_name": "ReturnedDetails", "in_package": "" } }, "treasury_outbound_transfers_resource_status_transitions": { "description": "", "properties": { "canceled_at": { "description": "Timestamp describing when an OutboundTransfer changed status to `canceled`", "format": "unix-time", "nullable": true, "type": "integer" }, "failed_at": { "description": "Timestamp describing when an OutboundTransfer changed status to `failed`", "format": "unix-time", "nullable": true, "type": "integer" }, "posted_at": { "description": "Timestamp describing when an OutboundTransfer changed status to `posted`", "format": "unix-time", "nullable": true, "type": "integer" }, "returned_at": { "description": "Timestamp describing when an OutboundTransfer changed status to `returned`", "format": "unix-time", "nullable": true, "type": "integer" } }, "required": [ "canceled_at", "failed_at", "posted_at", "returned_at" ], "title": "TreasuryOutboundTransfersResourceStatusTransitions", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "canceled_at", "failed_at", "posted_at", "returned_at" ], "x-stripeResource": { "class_name": "StatusTransitions", "in_package": "" } }, "treasury_outbound_transfers_resource_us_domestic_wire_tracking_details": { "description": "", "properties": { "chips": { "description": "CHIPS System Sequence Number (SSN) of the OutboundTransfer for transfers sent over the `us_domestic_wire` network.", "maxLength": 5000, "nullable": true, "type": "string" }, "imad": { "description": "IMAD of the OutboundTransfer for transfers sent over the `us_domestic_wire` network.", "maxLength": 5000, "nullable": true, "type": "string" }, "omad": { "description": "OMAD of the OutboundTransfer for transfers sent over the `us_domestic_wire` network.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "chips", "imad", "omad" ], "title": "TreasuryOutboundTransfersResourceUSDomesticWireTrackingDetails", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "chips", "imad", "omad" ] }, "treasury_received_credits_resource_ach_network_details": { "description": "", "properties": { "addenda": { "description": "ACH Addenda record", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "addenda" ], "title": "TreasuryReceivedCreditsResourceACHNetworkDetails", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "addenda" ] }, "treasury_received_credits_resource_linked_flows": { "description": "", "properties": { "credit_reversal": { "description": "The CreditReversal created as a result of this ReceivedCredit being reversed.", "maxLength": 5000, "nullable": true, "type": "string" }, "issuing_authorization": { "description": "Set if the ReceivedCredit was created due to an [Issuing Authorization](https://stripe.com/docs/api#issuing_authorizations) object.", "maxLength": 5000, "nullable": true, "type": "string" }, "issuing_transaction": { "description": "Set if the ReceivedCredit is also viewable as an [Issuing transaction](https://stripe.com/docs/api#issuing_transactions) object.", "maxLength": 5000, "nullable": true, "type": "string" }, "source_flow": { "description": "ID of the source flow. Set if `network` is `stripe` and the source flow is visible to the user. Examples of source flows include OutboundPayments, payouts, or CreditReversals.", "maxLength": 5000, "nullable": true, "type": "string" }, "source_flow_details": { "anyOf": [ { "$ref": "#/components/schemas/treasury_received_credits_resource_source_flows_details" } ], "description": "The expandable object of the source flow.", "nullable": true }, "source_flow_type": { "description": "The type of flow that originated the ReceivedCredit (for example, `outbound_payment`).", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "credit_reversal", "issuing_authorization", "issuing_transaction", "source_flow", "source_flow_type" ], "title": "TreasuryReceivedCreditsResourceLinkedFlows", "type": "object", "x-expandableFields": [ "source_flow_details" ], "x-stripeMostCommon": [ "credit_reversal", "issuing_authorization", "issuing_transaction", "source_flow", "source_flow_details", "source_flow_type" ] }, "treasury_received_credits_resource_network_details": { "description": "", "properties": { "ach": { "anyOf": [ { "$ref": "#/components/schemas/treasury_received_credits_resource_ach_network_details" } ], "description": "Details about an ACH transaction.", "nullable": true }, "type": { "description": "The type of flow that originated the ReceivedCredit.", "enum": [ "ach" ], "type": "string" } }, "required": [ "type" ], "title": "TreasuryReceivedCreditsResourceNetworkDetails", "type": "object", "x-expandableFields": [ "ach" ], "x-stripeMostCommon": [ "ach", "type" ] }, "treasury_received_credits_resource_reversal_details": { "description": "", "properties": { "deadline": { "description": "Time before which a ReceivedCredit can be reversed.", "format": "unix-time", "nullable": true, "type": "integer" }, "restricted_reason": { "description": "Set if a ReceivedCredit cannot be reversed.", "enum": [ "already_reversed", "deadline_passed", "network_restricted", "other", "source_flow_restricted" ], "nullable": true, "type": "string" } }, "required": [ "deadline", "restricted_reason" ], "title": "TreasuryReceivedCreditsResourceReversalDetails", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "deadline", "restricted_reason" ] }, "treasury_received_credits_resource_source_flows_details": { "description": "", "properties": { "credit_reversal": { "$ref": "#/components/schemas/treasury.credit_reversal" }, "outbound_payment": { "$ref": "#/components/schemas/treasury.outbound_payment" }, "outbound_transfer": { "$ref": "#/components/schemas/treasury.outbound_transfer" }, "payout": { "$ref": "#/components/schemas/payout" }, "type": { "description": "The type of the source flow that originated the ReceivedCredit.", "enum": [ "credit_reversal", "other", "outbound_payment", "outbound_transfer", "payout" ], "type": "string" } }, "required": [ "type" ], "title": "TreasuryReceivedCreditsResourceSourceFlowsDetails", "type": "object", "x-expandableFields": [ "credit_reversal", "outbound_payment", "outbound_transfer", "payout" ], "x-stripeMostCommon": [ "credit_reversal", "outbound_payment", "outbound_transfer", "payout", "type" ] }, "treasury_received_credits_resource_status_transitions": { "description": "", "properties": { "posted_at": { "description": "Timestamp describing when the CreditReversal changed status to `posted`", "format": "unix-time", "nullable": true, "type": "integer" } }, "required": [ "posted_at" ], "title": "TreasuryReceivedCreditsResourceStatusTransitions", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "posted_at" ] }, "treasury_received_debits_resource_ach_network_details": { "description": "", "properties": { "addenda": { "description": "ACH Addenda record", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "addenda" ], "title": "TreasuryReceivedDebitsResourceACHNetworkDetails", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "addenda" ] }, "treasury_received_debits_resource_debit_reversal_linked_flows": { "description": "", "properties": { "issuing_dispute": { "description": "Set if there is an Issuing dispute associated with the DebitReversal.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "issuing_dispute" ], "title": "TreasuryReceivedDebitsResourceDebitReversalLinkedFlows", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "issuing_dispute" ] }, "treasury_received_debits_resource_linked_flows": { "description": "", "properties": { "debit_reversal": { "description": "The DebitReversal created as a result of this ReceivedDebit being reversed.", "maxLength": 5000, "nullable": true, "type": "string" }, "inbound_transfer": { "description": "Set if the ReceivedDebit is associated with an InboundTransfer's return of funds.", "maxLength": 5000, "nullable": true, "type": "string" }, "issuing_authorization": { "description": "Set if the ReceivedDebit was created due to an [Issuing Authorization](https://stripe.com/docs/api#issuing_authorizations) object.", "maxLength": 5000, "nullable": true, "type": "string" }, "issuing_transaction": { "description": "Set if the ReceivedDebit is also viewable as an [Issuing Dispute](https://stripe.com/docs/api#issuing_disputes) object.", "maxLength": 5000, "nullable": true, "type": "string" }, "payout": { "description": "Set if the ReceivedDebit was created due to a [Payout](https://stripe.com/docs/api#payouts) object.", "maxLength": 5000, "nullable": true, "type": "string" }, "received_credit_capital_withholding": { "description": "The ReceivedCredit that Capital withheld from", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "debit_reversal", "inbound_transfer", "issuing_authorization", "issuing_transaction", "payout" ], "title": "TreasuryReceivedDebitsResourceLinkedFlows", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "debit_reversal", "inbound_transfer", "issuing_authorization", "issuing_transaction", "payout", "received_credit_capital_withholding" ] }, "treasury_received_debits_resource_network_details": { "description": "", "properties": { "ach": { "anyOf": [ { "$ref": "#/components/schemas/treasury_received_debits_resource_ach_network_details" } ], "description": "Details about an ACH transaction.", "nullable": true }, "type": { "description": "The type of flow that originated the ReceivedDebit.", "enum": [ "ach" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "TreasuryReceivedDebitsResourceNetworkDetails", "type": "object", "x-expandableFields": [ "ach" ], "x-stripeMostCommon": [ "ach", "type" ] }, "treasury_received_debits_resource_reversal_details": { "description": "", "properties": { "deadline": { "description": "Time before which a ReceivedDebit can be reversed.", "format": "unix-time", "nullable": true, "type": "integer" }, "restricted_reason": { "description": "Set if a ReceivedDebit can't be reversed.", "enum": [ "already_reversed", "deadline_passed", "network_restricted", "other", "source_flow_restricted" ], "nullable": true, "type": "string" } }, "required": [ "deadline", "restricted_reason" ], "title": "TreasuryReceivedDebitsResourceReversalDetails", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "deadline", "restricted_reason" ] }, "treasury_received_debits_resource_status_transitions": { "description": "", "properties": { "completed_at": { "description": "Timestamp describing when the DebitReversal changed status to `completed`.", "format": "unix-time", "nullable": true, "type": "integer" } }, "required": [ "completed_at" ], "title": "TreasuryReceivedDebitsResourceStatusTransitions", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "completed_at" ] }, "treasury_shared_resource_billing_details": { "description": "", "properties": { "address": { "$ref": "#/components/schemas/address" }, "email": { "description": "Email address.", "maxLength": 5000, "nullable": true, "type": "string" }, "name": { "description": "Full name.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "address", "email", "name" ], "title": "TreasurySharedResourceBillingDetails", "type": "object", "x-expandableFields": [ "address" ], "x-stripeMostCommon": [ "address", "email", "name" ], "x-stripeResource": { "class_name": "BillingDetails", "in_package": "" } }, "treasury_shared_resource_initiating_payment_method_details_initiating_payment_method_details": { "description": "", "properties": { "balance": { "description": "Set when `type` is `balance`.", "enum": [ "payments" ], "type": "string" }, "billing_details": { "$ref": "#/components/schemas/treasury_shared_resource_billing_details" }, "financial_account": { "$ref": "#/components/schemas/received_payment_method_details_financial_account" }, "issuing_card": { "description": "Set when `type` is `issuing_card`. This is an [Issuing Card](https://stripe.com/docs/api#issuing_cards) ID.", "maxLength": 5000, "type": "string" }, "type": { "description": "Polymorphic type matching the originating money movement's source. This can be an external account, a Stripe balance, or a FinancialAccount.", "enum": [ "balance", "financial_account", "issuing_card", "stripe", "us_bank_account" ], "type": "string", "x-stripeBypassValidation": true }, "us_bank_account": { "$ref": "#/components/schemas/treasury_shared_resource_initiating_payment_method_details_us_bank_account" } }, "required": [ "billing_details", "type" ], "title": "TreasurySharedResourceInitiatingPaymentMethodDetailsInitiatingPaymentMethodDetails", "type": "object", "x-expandableFields": [ "billing_details", "financial_account", "us_bank_account" ], "x-stripeMostCommon": [ "balance", "billing_details", "financial_account", "issuing_card", "type", "us_bank_account" ] }, "treasury_shared_resource_initiating_payment_method_details_us_bank_account": { "description": "", "properties": { "bank_name": { "description": "Bank name.", "maxLength": 5000, "nullable": true, "type": "string" }, "last4": { "description": "The last four digits of the bank account number.", "maxLength": 5000, "nullable": true, "type": "string" }, "routing_number": { "description": "The routing number for the bank account.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "bank_name", "last4", "routing_number" ], "title": "TreasurySharedResourceInitiatingPaymentMethodDetailsUSBankAccount", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "bank_name", "last4", "routing_number" ], "x-stripeResource": { "class_name": "UsBankAccount", "in_package": "" } }, "treasury_transactions_resource_abstract_transaction_resource_status_transitions": { "description": "", "properties": { "posted_at": { "description": "Timestamp describing when the Transaction changed status to `posted`.", "format": "unix-time", "nullable": true, "type": "integer" }, "void_at": { "description": "Timestamp describing when the Transaction changed status to `void`.", "format": "unix-time", "nullable": true, "type": "integer" } }, "required": [ "posted_at", "void_at" ], "title": "TreasuryTransactionsResourceAbstractTransactionResourceStatusTransitions", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "posted_at", "void_at" ] }, "treasury_transactions_resource_balance_impact": { "description": "Change to a FinancialAccount's balance", "properties": { "cash": { "description": "The change made to funds the user can spend right now.", "type": "integer" }, "inbound_pending": { "description": "The change made to funds that are not spendable yet, but will become available at a later time.", "type": "integer" }, "outbound_pending": { "description": "The change made to funds in the account, but not spendable because they are being held for pending outbound flows.", "type": "integer" } }, "required": [ "cash", "inbound_pending", "outbound_pending" ], "title": "TreasuryTransactionsResourceBalanceImpact", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "cash", "inbound_pending", "outbound_pending" ] }, "treasury_transactions_resource_flow_details": { "description": "", "properties": { "credit_reversal": { "$ref": "#/components/schemas/treasury.credit_reversal" }, "debit_reversal": { "$ref": "#/components/schemas/treasury.debit_reversal" }, "inbound_transfer": { "$ref": "#/components/schemas/treasury.inbound_transfer" }, "issuing_authorization": { "$ref": "#/components/schemas/issuing.authorization" }, "outbound_payment": { "$ref": "#/components/schemas/treasury.outbound_payment" }, "outbound_transfer": { "$ref": "#/components/schemas/treasury.outbound_transfer" }, "received_credit": { "$ref": "#/components/schemas/treasury.received_credit" }, "received_debit": { "$ref": "#/components/schemas/treasury.received_debit" }, "type": { "description": "Type of the flow that created the Transaction. Set to the same value as `flow_type`.", "enum": [ "credit_reversal", "debit_reversal", "inbound_transfer", "issuing_authorization", "other", "outbound_payment", "outbound_transfer", "received_credit", "received_debit" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "TreasuryTransactionsResourceFlowDetails", "type": "object", "x-expandableFields": [ "credit_reversal", "debit_reversal", "inbound_transfer", "issuing_authorization", "outbound_payment", "outbound_transfer", "received_credit", "received_debit" ], "x-stripeMostCommon": [ "credit_reversal", "debit_reversal", "inbound_transfer", "issuing_authorization", "outbound_payment", "outbound_transfer", "received_credit", "received_debit", "type" ] }, "us_bank_account_networks": { "description": "", "properties": { "preferred": { "description": "The preferred network.", "maxLength": 5000, "nullable": true, "type": "string" }, "supported": { "description": "All supported networks.", "items": { "enum": [ "ach", "us_domestic_wire" ], "type": "string" }, "type": "array" } }, "required": [ "preferred", "supported" ], "title": "us_bank_account_networks", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "preferred", "supported" ] }, "verification_session_redaction": { "description": "", "properties": { "status": { "description": "Indicates whether this object and its related objects have been redacted or not.", "enum": [ "processing", "redacted" ], "type": "string" } }, "required": [ "status" ], "title": "verification_session_redaction", "type": "object", "x-expandableFields": [], "x-stripeMostCommon": [ "status" ] }, "webhook_endpoint": { "description": "You can configure [webhook endpoints](https://docs.stripe.com/webhooks/) via the API to be\nnotified about events that happen in your Stripe account or connected\naccounts.\n\nMost users configure webhooks from [the dashboard](https://dashboard.stripe.com/webhooks), which provides a user interface for registering and testing your webhook endpoints.\n\nRelated guide: [Setting up webhooks](https://docs.stripe.com/webhooks/configure)", "properties": { "api_version": { "description": "The API version events are rendered as for this webhook endpoint.", "maxLength": 5000, "nullable": true, "type": "string" }, "application": { "description": "The ID of the associated Connect application.", "maxLength": 5000, "nullable": true, "type": "string" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "description": { "description": "An optional description of what the webhook is used for.", "maxLength": 5000, "nullable": true, "type": "string" }, "enabled_events": { "description": "The list of events to enable for this endpoint. `['*']` indicates that all events are enabled, except those that require explicit selection.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "type": "object" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "webhook_endpoint" ], "type": "string" }, "secret": { "description": "The endpoint's secret, used to generate [webhook signatures](https://docs.stripe.com/webhooks/signatures). Only returned at creation.", "maxLength": 5000, "type": "string" }, "status": { "description": "The status of the webhook. It can be `enabled` or `disabled`.", "maxLength": 5000, "type": "string" }, "url": { "description": "The URL of the webhook endpoint.", "maxLength": 5000, "type": "string" } }, "required": [ "api_version", "application", "created", "description", "enabled_events", "id", "livemode", "metadata", "object", "status", "url" ], "title": "NotificationWebhookEndpoint", "type": "object", "x-expandableFields": [], "x-resourceId": "webhook_endpoint", "x-stripeMostCommon": [ "api_version", "description", "enabled_events", "id", "metadata", "status", "url" ], "x-stripeOperations": [ { "method_name": "delete", "method_on": "service", "method_type": "delete", "operation": "delete", "path": "/v1/webhook_endpoints/{webhook_endpoint}" }, { "method_name": "list", "method_on": "service", "method_type": "list", "operation": "get", "path": "/v1/webhook_endpoints" }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/webhook_endpoints/{webhook_endpoint}" }, { "method_name": "create", "method_on": "service", "method_type": "create", "operation": "post", "path": "/v1/webhook_endpoints" }, { "method_name": "update", "method_on": "service", "method_type": "update", "operation": "post", "path": "/v1/webhook_endpoints/{webhook_endpoint}" } ], "x-stripeResource": { "class_name": "WebhookEndpoint", "has_collection_class": true, "in_package": "" } } }, "securitySchemes": { "basicAuth": { "description": "Basic HTTP authentication. Allowed headers-- Authorization: Basic | Authorization: Basic ", "scheme": "basic", "type": "http" }, "bearerAuth": { "bearerFormat": "auth-scheme", "description": "Bearer HTTP authentication. Allowed headers-- Authorization: Bearer ", "scheme": "bearer", "type": "http" } } }, "info": { "contact": { "email": "dev-platform@stripe.com", "name": "Stripe Dev Platform Team", "url": "https://stripe.com" }, "description": "The Stripe REST API. Please see https://stripe.com/docs/api for more details.", "termsOfService": "https://stripe.com/us/terms/", "title": "Stripe API", "version": "2025-08-27.preview; embedded_connect_beta=v2; server_side_confirmation_beta=v1; orders_beta=v4; unified_accounts_beta=v1; terminal_collect_inputs_beta=v2; terminal_collect_confirm_beta=v1; retrieve_tax_forms_beta=v1; checkout_server_update_beta=v1; payment_records_beta=v2; financial_connections_transactions_beta=v1; invoice_partial_payments_beta=v3; invoice_payment_plans_beta=v1; payment_intent_with_tax_api_beta=v1; custom_checkout_beta=v2; id_bank_transfer_beta=v2; fx_quote_preview=v1", "x-stripeSpecFilename": "spec3.beta.sdk" }, "openapi": "3.0.0", "paths": { "/v1/account": { "get": { "description": "

Retrieves the details of an account.

", "operationId": "GetAccount", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/account" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve account" } }, "/v1/account_links": { "post": { "description": "

Creates an AccountLink object that includes a single-use Stripe URL that the platform can redirect their user to in order to take them through the Connect Onboarding flow.

", "operationId": "PostAccountLinks", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "collection_options": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "account": { "description": "The identifier of the account to create an account link for.", "maxLength": 5000, "type": "string" }, "collect": { "description": "The collect parameter is deprecated. Use `collection_options` instead.", "enum": [ "currently_due", "eventually_due" ], "type": "string" }, "collection_options": { "description": "Specifies the requirements that Stripe collects from connected accounts in the Connect Onboarding flow.", "properties": { "fields": { "description": "Specifies whether the platform collects only currently_due requirements (`currently_due`) or both currently_due and eventually_due requirements (`eventually_due`). If you don't specify `collection_options`, the default value is `currently_due`.", "enum": [ "currently_due", "eventually_due" ], "type": "string" }, "future_requirements": { "description": "Specifies whether the platform collects future_requirements in addition to requirements in Connect Onboarding. The default value is `omit`.", "enum": [ "include", "omit" ], "type": "string" } }, "title": "collection_options_params", "type": "object", "x-stripeMostCommon": [ "fields", "future_requirements" ] }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "refresh_url": { "description": "The URL the user will be redirected to if the account link is expired, has been previously-visited, or is otherwise invalid. The URL you specify should attempt to generate a new account link with the same parameters used to create the original account link, then redirect the user to the new account link's URL so they can continue with Connect Onboarding. If a new account link cannot be generated or the redirect fails you should display a useful error to the user.", "type": "string" }, "return_url": { "description": "The URL that the user will be redirected to upon leaving or completing the linked flow.", "type": "string" }, "type": { "description": "The type of account link the user is requesting.\n\nYou can create Account Links of type `account_update` only for connected accounts where your platform is responsible for collecting requirements, including Custom accounts. You can't create them for accounts that have access to a Stripe-hosted Dashboard. If you use [Connect embedded components](/connect/get-started-connect-embedded-components), you can include components that allow your connected accounts to update their own information. For an account without Stripe-hosted Dashboard access where Stripe is liable for negative balances, you must use embedded components.", "enum": [ "account_onboarding", "account_update", "capital_financing_offer", "capital_financing_reporting" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "account", "type" ], "type": "object", "x-stripeMostCommon": [ "account", "refresh_url", "return_url", "type" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/account_link" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create an account link" } }, "/v1/account_notices": { "get": { "description": "

Retrieves a list of AccountNotice objects. The objects are sorted in descending order by creation date, with the most-recently-created object appearing first.

", "operationId": "GetAccountNotices", "parameters": [ { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "Set to false to only return unsent AccountNotices.", "in": "query", "name": "sent", "required": false, "schema": { "type": "boolean" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/account_notice" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/account_notices", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "IssuingComplianceNoticeList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List AccountNotices" } }, "/v1/account_notices/{account_notice}": { "get": { "description": "

Retrieves an AccountNotice object.

", "operationId": "GetAccountNoticesAccountNotice", "parameters": [ { "in": "path", "name": "account_notice", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/account_notice" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve an AccountNotice" }, "post": { "description": "

Updates an AccountNotice object.

", "operationId": "PostAccountNoticesAccountNotice", "parameters": [ { "in": "path", "name": "account_notice", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "email": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "email": { "description": "Information about the email you sent.", "properties": { "plain_text": { "description": "Content of the email in plain text. The copy must match exactly the language that Stripe Compliance has approved for use.", "maxLength": 10000, "type": "string" }, "recipient": { "description": "Email address of the recipient.", "type": "string" }, "subject": { "description": "Subject of the email.", "maxLength": 5000, "type": "string" } }, "required": [ "plain_text", "recipient", "subject" ], "title": "email_params", "type": "object", "x-stripeMostCommon": [ "plain_text", "recipient", "subject" ] }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "sent_at": { "description": "Date when you sent the notice.", "format": "unix-time", "type": "integer" } }, "required": [ "email", "sent_at" ], "type": "object", "x-stripeMostCommon": [ "email", "metadata", "sent_at" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/account_notice" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update an AccountNotice" } }, "/v1/account_sessions": { "post": { "description": "

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.

", "operationId": "PostAccountSessions", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "components": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "account": { "description": "The identifier of the account to create an Account Session for.", "type": "string" }, "components": { "description": "Each key of the dictionary represents an embedded component, and each embedded component maps to its configuration (e.g. whether it has been enabled or not).", "properties": { "account_management": { "description": "Configuration for the [account management](/connect/supported-embedded-components/account-management/) embedded component.", "properties": { "enabled": { "description": "Whether the embedded component is enabled.", "type": "boolean" }, "features": { "description": "The list of features enabled in the embedded component.", "properties": { "disable_stripe_user_authentication": { "description": "Whether Stripe user authentication is disabled. This value can only be `true` for accounts where `controller.requirement_collection` is `application` for the account. The default value is the opposite of the `external_account_collection` value. For example, if you don't set `external_account_collection`, it defaults to `true` and `disable_stripe_user_authentication` defaults to `false`.", "type": "boolean" }, "external_account_collection": { "description": "Whether external account collection is enabled. This feature can only be `false` for accounts where you’re responsible for collecting updated information when requirements are due or change, like Custom accounts. The default value for this feature is `true`.", "type": "boolean" } }, "title": "account_features_param", "type": "object", "x-stripeMostCommon": [ "disable_stripe_user_authentication", "external_account_collection" ] } }, "required": [ "enabled" ], "title": "account_config_param", "type": "object", "x-stripeMostCommon": [ "enabled", "features" ] }, "account_onboarding": { "description": "Configuration for the [account onboarding](/connect/supported-embedded-components/account-onboarding/) embedded component.", "properties": { "enabled": { "description": "Whether the embedded component is enabled.", "type": "boolean" }, "features": { "description": "The list of features enabled in the embedded component.", "properties": { "disable_stripe_user_authentication": { "description": "Whether Stripe user authentication is disabled. This value can only be `true` for accounts where `controller.requirement_collection` is `application` for the account. The default value is the opposite of the `external_account_collection` value. For example, if you don't set `external_account_collection`, it defaults to `true` and `disable_stripe_user_authentication` defaults to `false`.", "type": "boolean" }, "external_account_collection": { "description": "Whether external account collection is enabled. This feature can only be `false` for accounts where you’re responsible for collecting updated information when requirements are due or change, like Custom accounts. The default value for this feature is `true`.", "type": "boolean" } }, "title": "account_features_param", "type": "object", "x-stripeMostCommon": [ "disable_stripe_user_authentication", "external_account_collection" ] } }, "required": [ "enabled" ], "title": "account_config_param", "type": "object", "x-stripeMostCommon": [ "enabled", "features" ] }, "app_install": { "description": "Configuration for the [app install](/connect/supported-embedded-components/app-install/) embedded component.", "properties": { "enabled": { "description": "Whether the embedded component is enabled.", "type": "boolean" }, "features": { "description": "The list of features enabled in the embedded component.", "properties": { "allowed_apps": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The list of apps allowed to be enabled in the embedded component." } }, "title": "app_features_param", "type": "object", "x-stripeMostCommon": [ "allowed_apps" ] } }, "required": [ "enabled" ], "title": "app_config_param", "type": "object", "x-stripeMostCommon": [ "enabled", "features" ] }, "app_viewport": { "description": "Configuration for the [app viewport](/connect/supported-embedded-components/app-viewport/) embedded component.", "properties": { "enabled": { "description": "Whether the embedded component is enabled.", "type": "boolean" }, "features": { "description": "The list of features enabled in the embedded component.", "properties": { "allowed_apps": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The list of apps allowed to be enabled in the embedded component." } }, "title": "app_features_param", "type": "object", "x-stripeMostCommon": [ "allowed_apps" ] } }, "required": [ "enabled" ], "title": "app_config_param", "type": "object", "x-stripeMostCommon": [ "enabled", "features" ] }, "balance_report": { "description": "Configuration for the [balance report](/connect/supported-embedded-components/financial-reports#balance-report) embedded component.", "properties": { "enabled": { "description": "Whether the embedded component is enabled.", "type": "boolean" }, "features": { "description": "An empty list, because this embedded component has no features.", "properties": {}, "title": "base_features_param", "type": "object" } }, "required": [ "enabled" ], "title": "base_config_param", "type": "object", "x-stripeMostCommon": [ "enabled", "features" ] }, "balances": { "description": "Configuration for the [balances](/connect/supported-embedded-components/balances/) embedded component.", "properties": { "enabled": { "description": "Whether the embedded component is enabled.", "type": "boolean" }, "features": { "description": "The list of features enabled in the embedded component.", "properties": { "disable_stripe_user_authentication": { "description": "Whether Stripe user authentication is disabled. This value can only be `true` for accounts where `controller.requirement_collection` is `application` for the account. The default value is the opposite of the `external_account_collection` value. For example, if you don't set `external_account_collection`, it defaults to `true` and `disable_stripe_user_authentication` defaults to `false`.", "type": "boolean" }, "edit_payout_schedule": { "description": "Whether to allow payout schedule to be changed. Defaults to `true` when `controller.losses.payments` is set to `stripe` for the account, otherwise `false`.", "type": "boolean" }, "external_account_collection": { "description": "Whether external account collection is enabled. This feature can only be `false` for accounts where you’re responsible for collecting updated information when requirements are due or change, like Custom accounts. The default value for this feature is `true`.", "type": "boolean" }, "instant_payouts": { "description": "Whether to allow creation of instant payouts. Defaults to `true` when `controller.losses.payments` is set to `stripe` for the account, otherwise `false`.", "type": "boolean" }, "standard_payouts": { "description": "Whether to allow creation of standard payouts. Defaults to `true` when `controller.losses.payments` is set to `stripe` for the account, otherwise `false`.", "type": "boolean" } }, "title": "payouts_features_param", "type": "object", "x-stripeMostCommon": [ "disable_stripe_user_authentication", "edit_payout_schedule", "external_account_collection", "instant_payouts", "standard_payouts" ] } }, "required": [ "enabled" ], "title": "payouts_config_param", "type": "object", "x-stripeMostCommon": [ "enabled", "features" ] }, "capital_financing": { "description": "Configuration for the [Capital financing](/connect/supported-embedded-components/capital-financing/) embedded component.", "properties": { "enabled": { "description": "Whether the embedded component is enabled.", "type": "boolean" }, "features": { "description": "An empty list, because this embedded component has no features.", "properties": {}, "title": "base_features_param", "type": "object" } }, "required": [ "enabled" ], "title": "base_config_param", "type": "object", "x-stripeMostCommon": [ "enabled", "features" ] }, "capital_financing_application": { "description": "Configuration for the [Capital financing application](/connect/supported-embedded-components/capital-financing-application/) embedded component.", "properties": { "enabled": { "description": "Whether the embedded component is enabled.", "type": "boolean" }, "features": { "description": "An empty list, because this embedded component has no features.", "properties": {}, "title": "base_features_param", "type": "object" } }, "required": [ "enabled" ], "title": "base_config_param", "type": "object", "x-stripeMostCommon": [ "enabled", "features" ] }, "capital_financing_promotion": { "description": "Configuration for the [Capital financing promotion](/connect/supported-embedded-components/capital-financing-promotion/) embedded component.", "properties": { "enabled": { "description": "Whether the embedded component is enabled.", "type": "boolean" }, "features": { "description": "An empty list, because this embedded component has no features.", "properties": {}, "title": "base_features_param", "type": "object" } }, "required": [ "enabled" ], "title": "base_config_param", "type": "object", "x-stripeMostCommon": [ "enabled", "features" ] }, "capital_overview": { "description": "Configuration for the [Capital overview](/connect/supported-embedded-components/capital-overview/) embedded component.", "properties": { "enabled": { "description": "Whether the embedded component is enabled.", "type": "boolean" }, "features": { "description": "An empty list, because this embedded component has no features.", "properties": {}, "title": "base_features_param", "type": "object" } }, "required": [ "enabled" ], "title": "base_config_param", "type": "object", "x-stripeMostCommon": [ "enabled", "features" ] }, "disputes_list": { "description": "Configuration for the [disputes list](/connect/supported-embedded-components/disputes-list/) embedded component.", "properties": { "enabled": { "description": "Whether the embedded component is enabled.", "type": "boolean" }, "features": { "description": "The list of features enabled in the embedded component.", "properties": { "capture_payments": { "description": "Whether to allow capturing and cancelling payment intents. This is `true` by default.", "type": "boolean" }, "destination_on_behalf_of_charge_management": { "description": "Whether connected accounts can manage destination charges that are created on behalf of them. This is `false` by default.", "type": "boolean" }, "dispute_management": { "description": "Whether responding to disputes is enabled, including submitting evidence and accepting disputes. This is `true` by default.", "type": "boolean" }, "refund_management": { "description": "Whether sending refunds is enabled. This is `true` by default.", "type": "boolean" } }, "title": "disputes_list_features_param", "type": "object", "x-stripeMostCommon": [ "capture_payments", "destination_on_behalf_of_charge_management", "dispute_management", "refund_management" ] } }, "required": [ "enabled" ], "title": "disputes_list_config_param", "type": "object", "x-stripeMostCommon": [ "enabled", "features" ] }, "documents": { "description": "Configuration for the [documents](/connect/supported-embedded-components/documents/) embedded component.", "properties": { "enabled": { "description": "Whether the embedded component is enabled.", "type": "boolean" }, "features": { "description": "An empty list, because this embedded component has no features.", "properties": {}, "title": "base_features_param", "type": "object" } }, "required": [ "enabled" ], "title": "base_config_param", "type": "object", "x-stripeMostCommon": [ "enabled", "features" ] }, "export_tax_transactions": { "description": "Configuration for the [export tax transactions](/connect/supported-embedded-components/export-tax-transactions/) embedded component.", "properties": { "enabled": { "description": "Whether the embedded component is enabled.", "type": "boolean" }, "features": { "description": "An empty list, because this embedded component has no features.", "properties": {}, "title": "base_features_param", "type": "object" } }, "required": [ "enabled" ], "title": "base_config_param", "type": "object", "x-stripeMostCommon": [ "enabled", "features" ] }, "financial_account": { "description": "Configuration for the [financial account](/connect/supported-embedded-components/financial-account/) embedded component.", "properties": { "enabled": { "description": "Whether the embedded component is enabled.", "type": "boolean" }, "features": { "description": "The list of features enabled in the embedded component.", "properties": { "disable_stripe_user_authentication": { "description": "Whether Stripe user authentication is disabled. This value can only be `true` for accounts where `controller.requirement_collection` is `application` for the account. The default value is the opposite of the `external_account_collection` value. For example, if you don't set `external_account_collection`, it defaults to `true` and `disable_stripe_user_authentication` defaults to `false`.", "type": "boolean" }, "external_account_collection": { "description": "Whether external account collection is enabled. This feature can only be `false` for accounts where you’re responsible for collecting updated information when requirements are due or change, like Custom accounts. The default value for this feature is `true`.", "type": "boolean" }, "send_money": { "description": "Whether to allow sending money.", "type": "boolean" }, "transfer_balance": { "description": "Whether to allow transferring balance.", "type": "boolean" } }, "title": "financial_account_features_param", "type": "object", "x-stripeMostCommon": [ "disable_stripe_user_authentication", "external_account_collection", "send_money", "transfer_balance" ] } }, "required": [ "enabled" ], "title": "financial_account_config_param", "type": "object", "x-stripeMostCommon": [ "enabled", "features" ] }, "financial_account_transactions": { "description": "Configuration for the [financial account transactions](/connect/supported-embedded-components/financial-account-transactions/) embedded component.", "properties": { "enabled": { "description": "Whether the embedded component is enabled.", "type": "boolean" }, "features": { "description": "The list of features enabled in the embedded component.", "properties": { "card_spend_dispute_management": { "description": "Whether to allow card spend dispute management features.", "type": "boolean" } }, "title": "financial_account_transactions_features_param", "type": "object", "x-stripeMostCommon": [ "card_spend_dispute_management" ] } }, "required": [ "enabled" ], "title": "financial_account_transactions_config_param", "type": "object", "x-stripeMostCommon": [ "enabled", "features" ] }, "instant_payouts_promotion": { "description": "Configuration for the [instant payouts promotion](/connect/supported-embedded-components/instant-payouts-promotion/) embedded component.", "properties": { "enabled": { "description": "Whether the embedded component is enabled.", "type": "boolean" }, "features": { "description": "The list of features enabled in the embedded component.", "properties": { "disable_stripe_user_authentication": { "description": "Whether Stripe user authentication is disabled. This value can only be `true` for accounts where `controller.requirement_collection` is `application` for the account. The default value is the opposite of the `external_account_collection` value. For example, if you don't set `external_account_collection`, it defaults to `true` and `disable_stripe_user_authentication` defaults to `false`.", "type": "boolean" }, "external_account_collection": { "description": "Whether external account collection is enabled. This feature can only be `false` for accounts where you’re responsible for collecting updated information when requirements are due or change, like Custom accounts. The default value for this feature is `true`.", "type": "boolean" }, "instant_payouts": { "description": "Whether to allow creation of instant payouts. Defaults to `true` when `controller.losses.payments` is set to `stripe` for the account, otherwise `false`.", "type": "boolean" } }, "title": "instant_payouts_promotion_features_param", "type": "object", "x-stripeMostCommon": [ "disable_stripe_user_authentication", "external_account_collection", "instant_payouts" ] } }, "required": [ "enabled" ], "title": "instant_payouts_promotion_config_param", "type": "object", "x-stripeMostCommon": [ "enabled", "features" ] }, "issuing_card": { "description": "Configuration for the [issuing card](/connect/supported-embedded-components/issuing-card/) embedded component.", "properties": { "enabled": { "description": "Whether the embedded component is enabled.", "type": "boolean" }, "features": { "description": "The list of features enabled in the embedded component.", "properties": { "card_management": { "description": "Whether to allow card management features.", "type": "boolean" }, "card_spend_dispute_management": { "description": "Whether to allow card spend dispute management features.", "type": "boolean" }, "cardholder_management": { "description": "Whether to allow cardholder management features.", "type": "boolean" }, "spend_control_management": { "description": "Whether to allow spend control management features.", "type": "boolean" } }, "title": "issuing_card_features_param", "type": "object", "x-stripeMostCommon": [ "card_management", "card_spend_dispute_management", "cardholder_management", "spend_control_management" ] } }, "required": [ "enabled" ], "title": "issuing_card_config_param", "type": "object", "x-stripeMostCommon": [ "enabled", "features" ] }, "issuing_cards_list": { "description": "Configuration for the [issuing cards list](/connect/supported-embedded-components/issuing-cards-list/) embedded component.", "properties": { "enabled": { "description": "Whether the embedded component is enabled.", "type": "boolean" }, "features": { "description": "The list of features enabled in the embedded component.", "properties": { "card_management": { "description": "Whether to allow card management features.", "type": "boolean" }, "card_spend_dispute_management": { "description": "Whether to allow card spend dispute management features.", "type": "boolean" }, "cardholder_management": { "description": "Whether to allow cardholder management features.", "type": "boolean" }, "disable_stripe_user_authentication": { "description": "Whether Stripe user authentication is disabled. This value can only be `true` for accounts where `controller.requirement_collection` is `application` for the account. The default value is the opposite of the `external_account_collection` value. For example, if you don't set `external_account_collection`, it defaults to `true` and `disable_stripe_user_authentication` defaults to `false`.", "type": "boolean" }, "spend_control_management": { "description": "Whether to allow spend control management features.", "type": "boolean" } }, "title": "issuing_cards_list_features_param", "type": "object", "x-stripeMostCommon": [ "card_management", "card_spend_dispute_management", "cardholder_management", "disable_stripe_user_authentication", "spend_control_management" ] } }, "required": [ "enabled" ], "title": "issuing_cards_list_config_param", "type": "object", "x-stripeMostCommon": [ "enabled", "features" ] }, "notification_banner": { "description": "Configuration for the [notification banner](/connect/supported-embedded-components/notification-banner/) embedded component.", "properties": { "enabled": { "description": "Whether the embedded component is enabled.", "type": "boolean" }, "features": { "description": "The list of features enabled in the embedded component.", "properties": { "disable_stripe_user_authentication": { "description": "Whether Stripe user authentication is disabled. This value can only be `true` for accounts where `controller.requirement_collection` is `application` for the account. The default value is the opposite of the `external_account_collection` value. For example, if you don't set `external_account_collection`, it defaults to `true` and `disable_stripe_user_authentication` defaults to `false`.", "type": "boolean" }, "external_account_collection": { "description": "Whether external account collection is enabled. This feature can only be `false` for accounts where you’re responsible for collecting updated information when requirements are due or change, like Custom accounts. The default value for this feature is `true`.", "type": "boolean" } }, "title": "account_features_param", "type": "object", "x-stripeMostCommon": [ "disable_stripe_user_authentication", "external_account_collection" ] } }, "required": [ "enabled" ], "title": "account_config_param", "type": "object", "x-stripeMostCommon": [ "enabled", "features" ] }, "payment_details": { "description": "Configuration for the [payment details](/connect/supported-embedded-components/payment-details/) embedded component.", "properties": { "enabled": { "description": "Whether the embedded component is enabled.", "type": "boolean" }, "features": { "description": "The list of features enabled in the embedded component.", "properties": { "capture_payments": { "description": "Whether to allow capturing and cancelling payment intents. This is `true` by default.", "type": "boolean" }, "destination_on_behalf_of_charge_management": { "description": "Whether connected accounts can manage destination charges that are created on behalf of them. This is `false` by default.", "type": "boolean" }, "dispute_management": { "description": "Whether responding to disputes is enabled, including submitting evidence and accepting disputes. This is `true` by default.", "type": "boolean" }, "refund_management": { "description": "Whether sending refunds is enabled. This is `true` by default.", "type": "boolean" } }, "title": "payments_features_param", "type": "object", "x-stripeMostCommon": [ "capture_payments", "destination_on_behalf_of_charge_management", "dispute_management", "refund_management" ] } }, "required": [ "enabled" ], "title": "payments_config_param", "type": "object", "x-stripeMostCommon": [ "enabled", "features" ] }, "payment_disputes": { "description": "Configuration for the [payment disputes](/connect/supported-embedded-components/payment-disputes/) embedded component.", "properties": { "enabled": { "description": "Whether the embedded component is enabled.", "type": "boolean" }, "features": { "description": "The list of features enabled in the embedded component.", "properties": { "destination_on_behalf_of_charge_management": { "description": "Whether connected accounts can manage destination charges that are created on behalf of them. This is `false` by default.", "type": "boolean" }, "dispute_management": { "description": "Whether responding to disputes is enabled, including submitting evidence and accepting disputes. This is `true` by default.", "type": "boolean" }, "refund_management": { "description": "Whether sending refunds is enabled. This is `true` by default.", "type": "boolean" } }, "title": "payment_disputes_features_param", "type": "object", "x-stripeMostCommon": [ "destination_on_behalf_of_charge_management", "dispute_management", "refund_management" ] } }, "required": [ "enabled" ], "title": "payment_disputes_config_param", "type": "object", "x-stripeMostCommon": [ "enabled", "features" ] }, "payment_method_settings": { "description": "Configuration for the [payment method settings](/connect/supported-embedded-components/payment-method-settings/) embedded component.", "properties": { "enabled": { "description": "Whether the embedded component is enabled.", "type": "boolean" }, "features": { "description": "An empty list, because this embedded component has no features.", "properties": {}, "title": "base_features_param", "type": "object" } }, "required": [ "enabled" ], "title": "base_config_param", "type": "object", "x-stripeMostCommon": [ "enabled", "features" ] }, "payments": { "description": "Configuration for the [payments](/connect/supported-embedded-components/payments/) embedded component.", "properties": { "enabled": { "description": "Whether the embedded component is enabled.", "type": "boolean" }, "features": { "description": "The list of features enabled in the embedded component.", "properties": { "capture_payments": { "description": "Whether to allow capturing and cancelling payment intents. This is `true` by default.", "type": "boolean" }, "destination_on_behalf_of_charge_management": { "description": "Whether connected accounts can manage destination charges that are created on behalf of them. This is `false` by default.", "type": "boolean" }, "dispute_management": { "description": "Whether responding to disputes is enabled, including submitting evidence and accepting disputes. This is `true` by default.", "type": "boolean" }, "refund_management": { "description": "Whether sending refunds is enabled. This is `true` by default.", "type": "boolean" } }, "title": "payments_features_param", "type": "object", "x-stripeMostCommon": [ "capture_payments", "destination_on_behalf_of_charge_management", "dispute_management", "refund_management" ] } }, "required": [ "enabled" ], "title": "payments_config_param", "type": "object", "x-stripeMostCommon": [ "enabled", "features" ] }, "payout_details": { "description": "Configuration for the [payout details](/connect/supported-embedded-components/payout-details/) embedded component.", "properties": { "enabled": { "description": "Whether the embedded component is enabled.", "type": "boolean" }, "features": { "description": "An empty list, because this embedded component has no features.", "properties": {}, "title": "base_features_param", "type": "object" } }, "required": [ "enabled" ], "title": "base_config_param", "type": "object", "x-stripeMostCommon": [ "enabled", "features" ] }, "payout_reconciliation_report": { "description": "Configuration for the [payout reconciliation report](/connect/supported-embedded-components/financial-reports#payout-reconciliation-report) embedded component.", "properties": { "enabled": { "description": "Whether the embedded component is enabled.", "type": "boolean" }, "features": { "description": "An empty list, because this embedded component has no features.", "properties": {}, "title": "base_features_param", "type": "object" } }, "required": [ "enabled" ], "title": "base_config_param", "type": "object", "x-stripeMostCommon": [ "enabled", "features" ] }, "payouts": { "description": "Configuration for the [payouts](/connect/supported-embedded-components/payouts/) embedded component.", "properties": { "enabled": { "description": "Whether the embedded component is enabled.", "type": "boolean" }, "features": { "description": "The list of features enabled in the embedded component.", "properties": { "disable_stripe_user_authentication": { "description": "Whether Stripe user authentication is disabled. This value can only be `true` for accounts where `controller.requirement_collection` is `application` for the account. The default value is the opposite of the `external_account_collection` value. For example, if you don't set `external_account_collection`, it defaults to `true` and `disable_stripe_user_authentication` defaults to `false`.", "type": "boolean" }, "edit_payout_schedule": { "description": "Whether to allow payout schedule to be changed. Defaults to `true` when `controller.losses.payments` is set to `stripe` for the account, otherwise `false`.", "type": "boolean" }, "external_account_collection": { "description": "Whether external account collection is enabled. This feature can only be `false` for accounts where you’re responsible for collecting updated information when requirements are due or change, like Custom accounts. The default value for this feature is `true`.", "type": "boolean" }, "instant_payouts": { "description": "Whether to allow creation of instant payouts. Defaults to `true` when `controller.losses.payments` is set to `stripe` for the account, otherwise `false`.", "type": "boolean" }, "standard_payouts": { "description": "Whether to allow creation of standard payouts. Defaults to `true` when `controller.losses.payments` is set to `stripe` for the account, otherwise `false`.", "type": "boolean" } }, "title": "payouts_features_param", "type": "object", "x-stripeMostCommon": [ "disable_stripe_user_authentication", "edit_payout_schedule", "external_account_collection", "instant_payouts", "standard_payouts" ] } }, "required": [ "enabled" ], "title": "payouts_config_param", "type": "object", "x-stripeMostCommon": [ "enabled", "features" ] }, "payouts_list": { "description": "Configuration for the [payouts list](/connect/supported-embedded-components/payouts-list/) embedded component.", "properties": { "enabled": { "description": "Whether the embedded component is enabled.", "type": "boolean" }, "features": { "description": "An empty list, because this embedded component has no features.", "properties": {}, "title": "base_features_param", "type": "object" } }, "required": [ "enabled" ], "title": "base_config_param", "type": "object", "x-stripeMostCommon": [ "enabled", "features" ] }, "product_tax_code_selector": { "description": "Configuration for the [product tax code selector](/connect/supported-embedded-components/product-tax-code-selector/) embedded component.", "properties": { "enabled": { "description": "Whether the embedded component is enabled.", "type": "boolean" }, "features": { "description": "An empty list, because this embedded component has no features.", "properties": {}, "title": "base_features_param", "type": "object" } }, "required": [ "enabled" ], "title": "base_config_param", "type": "object", "x-stripeMostCommon": [ "enabled", "features" ] }, "recipients": { "description": "Configuration for the [recipients](/connect/supported-embedded-components/recipients/) embedded component.", "properties": { "enabled": { "description": "Whether the embedded component is enabled.", "type": "boolean" }, "features": { "properties": { "send_money": { "description": "Whether to allow sending money.", "type": "boolean" } }, "title": "recipients_features_param", "type": "object", "x-stripeMostCommon": [ "send_money" ] } }, "required": [ "enabled" ], "title": "recipients_config_param", "type": "object", "x-stripeMostCommon": [ "enabled", "features" ] }, "reporting_chart": { "description": "Configuration for the [reporting chart](/connect/supported-embedded-components/reporting-chart/) embedded component.", "properties": { "enabled": { "description": "Whether the embedded component is enabled.", "type": "boolean" }, "features": { "description": "An empty list, because this embedded component has no features.", "properties": {}, "title": "base_features_param", "type": "object" } }, "required": [ "enabled" ], "title": "base_config_param", "type": "object", "x-stripeMostCommon": [ "enabled", "features" ] }, "tax_registrations": { "description": "Configuration for the [tax registrations](/connect/supported-embedded-components/tax-registrations/) embedded component.", "properties": { "enabled": { "description": "Whether the embedded component is enabled.", "type": "boolean" }, "features": { "description": "An empty list, because this embedded component has no features.", "properties": {}, "title": "base_features_param", "type": "object" } }, "required": [ "enabled" ], "title": "base_config_param", "type": "object", "x-stripeMostCommon": [ "enabled", "features" ] }, "tax_settings": { "description": "Configuration for the [tax settings](/connect/supported-embedded-components/tax-settings/) embedded component.", "properties": { "enabled": { "description": "Whether the embedded component is enabled.", "type": "boolean" }, "features": { "description": "An empty list, because this embedded component has no features.", "properties": {}, "title": "base_features_param", "type": "object" } }, "required": [ "enabled" ], "title": "base_config_param", "type": "object", "x-stripeMostCommon": [ "enabled", "features" ] }, "tax_threshold_monitoring": { "description": "Configuration for the [tax threshold monitoring](/connect/supported-embedded-components/tax-threshold-monitoring/) embedded component.", "properties": { "enabled": { "description": "Whether the embedded component is enabled.", "type": "boolean" }, "features": { "description": "An empty list, because this embedded component has no features.", "properties": {}, "title": "base_features_param", "type": "object" } }, "required": [ "enabled" ], "title": "base_config_param", "type": "object", "x-stripeMostCommon": [ "enabled", "features" ] } }, "title": "account_session_create_components_param", "type": "object", "x-stripeMostCommon": [ "account_management", "account_onboarding", "app_install", "app_viewport", "balance_report", "balances", "capital_financing", "capital_financing_application", "capital_financing_promotion", "capital_overview", "disputes_list", "documents", "export_tax_transactions", "financial_account", "financial_account_transactions", "instant_payouts_promotion", "issuing_card", "issuing_cards_list", "notification_banner", "payment_details", "payment_disputes", "payment_method_settings", "payments", "payout_details", "payout_reconciliation_report", "payouts", "payouts_list", "product_tax_code_selector", "recipients", "reporting_chart", "tax_registrations", "tax_settings", "tax_threshold_monitoring" ] }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "required": [ "account", "components" ], "type": "object", "x-stripeMostCommon": [ "account", "components" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/account_session" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create an Account Session" } }, "/v1/accounts": { "get": { "description": "

Returns a list of accounts connected to your platform via Connect. If you’re not a platform, the list is empty.

", "operationId": "GetAccounts", "parameters": [ { "description": "Only return connected accounts that were created during the given date interval.", "explode": true, "in": "query", "name": "created", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "description": "Minimum value to filter by (exclusive)", "type": "integer" }, "gte": { "description": "Minimum value to filter by (inclusive)", "type": "integer" }, "lt": { "description": "Maximum value to filter by (exclusive)", "type": "integer" }, "lte": { "description": "Maximum value to filter by (inclusive)", "type": "integer" } }, "title": "range_query_specs", "type": "object", "x-stripeMostCommon": [ "gt", "gte", "lt", "lte" ] }, { "type": "integer" } ] }, "style": "deepObject" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/account" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/accounts", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "AccountList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all connected accounts" }, "post": { "description": "

With Connect, you can create Stripe accounts for your users.\nTo do this, you’ll first need to register your platform.

\n\n

If you’ve already collected information for your connected accounts, you can prefill that information when\ncreating the account. Connect Onboarding won’t ask for the prefilled information during account onboarding.\nYou can prefill any information on the account.

", "operationId": "PostAccounts", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "business_profile": { "explode": true, "style": "deepObject" }, "capabilities": { "explode": true, "style": "deepObject" }, "company": { "explode": true, "style": "deepObject" }, "controller": { "explode": true, "style": "deepObject" }, "documents": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "groups": { "explode": true, "style": "deepObject" }, "individual": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "risk_controls": { "explode": true, "style": "deepObject" }, "settings": { "explode": true, "style": "deepObject" }, "tos_acceptance": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "account_token": { "description": "An [account token](https://stripe.com/docs/api#create_account_token), used to securely provide details to the account.", "maxLength": 5000, "type": "string" }, "business_profile": { "description": "Business information about the account.", "properties": { "annual_revenue": { "description": "The applicant's gross annual revenue for its preceding fiscal year.", "properties": { "amount": { "description": "A non-negative integer representing the amount in the [smallest currency unit](/currencies#zero-decimal).", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "fiscal_year_end": { "description": "The close-out date of the preceding fiscal year in ISO 8601 format. E.g. 2023-12-31 for the 31st of December, 2023.", "maxLength": 5000, "type": "string" } }, "required": [ "amount", "currency", "fiscal_year_end" ], "title": "annual_revenue_specs", "type": "object", "x-stripeMostCommon": [ "amount", "currency", "fiscal_year_end" ] }, "estimated_worker_count": { "description": "An estimated upper bound of employees, contractors, vendors, etc. currently working for the business.", "type": "integer" }, "mcc": { "description": "[The merchant category code for the account](/connect/setting-mcc). MCCs are used to classify businesses based on the goods or services they provide.", "maxLength": 4, "type": "string" }, "minority_owned_business_designation": { "description": "Whether the business is a minority-owned, women-owned, and/or LGBTQI+ -owned business.", "items": { "enum": [ "lgbtqi_owned_business", "minority_owned_business", "none_of_these_apply", "prefer_not_to_answer", "women_owned_business" ], "type": "string" }, "type": "array" }, "monthly_estimated_revenue": { "description": "An estimate of the monthly revenue of the business. Only accepted for accounts in Brazil and India.", "properties": { "amount": { "description": "A non-negative integer representing how much to charge in the [smallest currency unit](/currencies#zero-decimal).", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" } }, "required": [ "amount", "currency" ], "title": "monthly_estimated_revenue_specs", "type": "object", "x-stripeMostCommon": [ "amount", "currency" ] }, "name": { "description": "The customer-facing business name.", "maxLength": 5000, "type": "string" }, "product_description": { "description": "Internal-only description of the product sold by, or service provided by, the business. Used by Stripe for risk and underwriting purposes.", "maxLength": 40000, "type": "string" }, "support_address": { "description": "A publicly available mailing address for sending support issues to.", "properties": { "city": { "description": "City, district, suburb, town, or village.", "maxLength": 100, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Address line 1 (e.g., street, PO Box, or company name).", "maxLength": 200, "type": "string" }, "line2": { "description": "Address line 2 (e.g., apartment, suite, unit, or building).", "maxLength": 200, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "State, county, province, or region.", "maxLength": 5000, "type": "string" } }, "title": "address_specs", "type": "object", "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state" ] }, "support_email": { "description": "A publicly available email address for sending support issues to.", "type": "string" }, "support_phone": { "description": "A publicly available phone number to call with support issues.", "maxLength": 5000, "type": "string" }, "support_url": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "A publicly available website for handling support issues." }, "url": { "description": "The business's publicly available website.", "type": "string" } }, "title": "business_profile_specs", "type": "object", "x-stripeMostCommon": [ "annual_revenue", "customer_regions", "estimated_worker_count", "funding_source", "industry", "mcc", "minority_owned_business_designation", "monthly_estimated_revenue", "name", "payment_collection_methods", "privacy_policy_url", "product_description", "singapore_account_activity_survey", "specified_commercial_transactions_act_url", "support_address", "support_email", "support_phone", "support_url", "terms_of_service_url", "url", "url_opt_out_reason" ] }, "business_type": { "description": "The business type. Once you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.", "enum": [ "company", "government_entity", "individual", "non_profit" ], "type": "string", "x-stripeBypassValidation": true }, "capabilities": { "description": "Each key of the dictionary represents a capability, and each capability\nmaps to its settings (for example, whether it has been requested or not). Each\ncapability is inactive until you have provided its specific\nrequirements and Stripe has verified them. An account might have some\nof its requested capabilities be active and some be inactive.\n\nRequired when [account.controller.stripe_dashboard.type](/api/accounts/create#create_account-controller-dashboard-type)\nis `none`, which includes Custom accounts.", "properties": { "acss_debit_payments": { "description": "The acss_debit_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "affirm_payments": { "description": "The affirm_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "afterpay_clearpay_payments": { "description": "The afterpay_clearpay_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "alma_payments": { "description": "The alma_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "amazon_pay_payments": { "description": "The amazon_pay_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "au_becs_debit_payments": { "description": "The au_becs_debit_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "automatic_indirect_tax": { "description": "The automatic_indirect_tax capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "bacs_debit_payments": { "description": "The bacs_debit_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "bancontact_payments": { "description": "The bancontact_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "bank_transfer_payments": { "description": "The bank_transfer_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "billie_payments": { "description": "The billie_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "blik_payments": { "description": "The blik_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "boleto_payments": { "description": "The boleto_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "card_issuing": { "description": "The card_issuing capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "card_payments": { "description": "The card_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "cartes_bancaires_payments": { "description": "The cartes_bancaires_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "cashapp_payments": { "description": "The cashapp_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "crypto_payments": { "description": "The crypto_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "eps_payments": { "description": "The eps_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "fpx_payments": { "description": "The fpx_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "gb_bank_transfer_payments": { "description": "The gb_bank_transfer_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "giropay_payments": { "description": "The giropay_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "gopay_payments": { "description": "The gopay_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "grabpay_payments": { "description": "The grabpay_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "id_bank_transfer_payments": { "description": "The id_bank_transfer_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "id_bank_transfer_payments_bca": { "description": "The id_bank_transfer_payments_bca capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "ideal_payments": { "description": "The ideal_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "india_international_payments": { "description": "The india_international_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "jcb_payments": { "description": "The jcb_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "jp_bank_transfer_payments": { "description": "The jp_bank_transfer_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "kakao_pay_payments": { "description": "The kakao_pay_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "klarna_payments": { "description": "The klarna_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "konbini_payments": { "description": "The konbini_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "kr_card_payments": { "description": "The kr_card_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "legacy_payments": { "description": "The legacy_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "link_payments": { "description": "The link_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "mb_way_payments": { "description": "The mb_way_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "mobilepay_payments": { "description": "The mobilepay_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "multibanco_payments": { "description": "The multibanco_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "mx_bank_transfer_payments": { "description": "The mx_bank_transfer_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "naver_pay_payments": { "description": "The naver_pay_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "nz_bank_account_becs_debit_payments": { "description": "The nz_bank_account_becs_debit_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "oxxo_payments": { "description": "The oxxo_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "p24_payments": { "description": "The p24_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "pay_by_bank_payments": { "description": "The pay_by_bank_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "payco_payments": { "description": "The payco_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "paynow_payments": { "description": "The paynow_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "paypal_payments": { "description": "The paypal_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "paypay_payments": { "description": "The paypay_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "payto_payments": { "description": "The payto_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "pix_payments": { "description": "The pix_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "promptpay_payments": { "description": "The promptpay_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "qris_payments": { "description": "The qris_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "rechnung_payments": { "description": "The rechnung_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "revolut_pay_payments": { "description": "The revolut_pay_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "samsung_pay_payments": { "description": "The samsung_pay_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "satispay_payments": { "description": "The satispay_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "sepa_bank_transfer_payments": { "description": "The sepa_bank_transfer_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "sepa_debit_payments": { "description": "The sepa_debit_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "shopeepay_payments": { "description": "The shopeepay_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "sofort_payments": { "description": "The sofort_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "stripe_balance_payments": { "description": "The stripe_balance_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "swish_payments": { "description": "The swish_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "tax_reporting_us_1099_k": { "description": "The tax_reporting_us_1099_k capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "tax_reporting_us_1099_misc": { "description": "The tax_reporting_us_1099_misc capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "transfers": { "description": "The transfers capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "treasury": { "description": "The treasury capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "treasury_evolve": { "description": "The treasury_evolve capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "treasury_fifth_third": { "description": "The treasury_fifth_third capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "treasury_goldman_sachs": { "description": "The treasury_goldman_sachs capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "twint_payments": { "description": "The twint_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "us_bank_account_ach_payments": { "description": "The us_bank_account_ach_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "us_bank_transfer_payments": { "description": "The us_bank_transfer_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "zip_payments": { "description": "The zip_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] } }, "title": "capabilities_param", "type": "object", "x-stripeMostCommon": [ "ach_debit_payments", "acss_debit_payments", "affirm_payments", "afterpay_clearpay_payments", "alipay_payments", "alma_payments", "amazon_pay_payments", "apple_pay_later_payments", "au_bank_transfer_payments", "au_becs_debit_payments", "automatic_indirect_tax", "bacs_debit_payments", "bacs_debit_stripe_sun_payments", "bancontact_payments", "bank_transfer_payments", "beneficiary_transfers", "billie_payments", "bizum_payments", "blik_payments", "boleto_payments", "ca_bank_transfer_payments", "capchase_pay_payments", "card_issuing", "card_issuing_charge_card", "card_issuing_charge_card_fifth_third", "card_issuing_charge_card_stripe", "card_issuing_consumer", "card_issuing_consumer_revolving_credit_card_celtic", "card_issuing_fa_prepaid_card_lead", "card_issuing_fa_spend_card_celtic", "card_issuing_fa_spend_card_stripe", "card_issuing_prepaid_card_cross_river", "card_issuing_spend_card_cross_river", "card_payments", "cartes_bancaires_payments", "cash_advances", "cashapp_payments", "click_to_pay_payments", "crypto_financial_account_recipients", "crypto_financial_accounts", "crypto_payments", "crypto_transfers", "crypto_transfers_platform", "demo_pay_payments", "duitnow_payments", "dummy_passthrough_card_payments", "edenred_payments", "eps_payments", "fpx_payments", "fr_meal_voucher_conecs_payments", "fund_and_send", "funding_credit", "gb_bank_transfer_payments", "getbalance_payments", "giropay_payments", "gopay_payments", "grabpay_payments", "id_bank_transfer_payments", "id_bank_transfer_payments_bca", "id_credit_transfer_payments", "ideal_payments", "india_international_payments", "jcb_payments", "jp_bank_transfer_payments", "kakao_pay_payments", "klarna_payments", "konbini_payments", "kr_card_payments", "kr_market_payments", "kriya_payments", "legacy_payments", "link_payments", "loans", "mb_way_payments", "meta_pay_payments", "mobilepay_payments", "mondu_payments", "multibanco_payments", "mx_bank_transfer_payments", "naver_pay_payments", "netbanking_payments", "ng_bank_payments", "ng_bank_transfer_payments", "ng_card_payments", "ng_market_payments", "ng_ussd_payments", "ng_wallet_payments", "nz_bank_account_becs_debit_payments", "nz_bank_transfer_payments", "octopus_payments", "oxxo_payments", "p24_payments", "pay_by_bank_payments", "payco_payments", "payments", "paynow_payments", "paypal_payments", "paypay_payments", "payto_payments", "pix_payments", "promptpay_payments", "qris_payments", "rechnung_payments", "revolut_pay_payments", "samsung_pay_payments", "satispay_payments", "scalapay_payments", "sepa_bank_transfer_payments", "sepa_debit_payments", "sequra_payments", "shop_pay_payments", "shopeepay_payments", "sofort_payments", "south_korea_market_payments", "stripe_balance_payments", "stripe_funded_fee_credits", "submerchant_payments", "sunbit_payments", "swish_payments", "tax_reporting_us_1099_k", "tax_reporting_us_1099_misc", "transfers", "treasury", "treasury_evolve", "treasury_fifth_third", "treasury_goldman_sachs", "twint_payments", "upi_payments", "us_bank_account_ach_payments", "us_bank_transfer_payments", "us_cash_voucher_transfers", "us_paper_check_payments", "vipps_payments", "wechat_pay_payments", "zip_payments" ] }, "company": { "description": "Information about the company or business. This field is available for any `business_type`. Once you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.", "properties": { "address": { "description": "The company's primary address.", "properties": { "city": { "description": "City, district, suburb, town, or village.", "maxLength": 100, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Address line 1 (e.g., street, PO Box, or company name).", "maxLength": 200, "type": "string" }, "line2": { "description": "Address line 2 (e.g., apartment, suite, unit, or building).", "maxLength": 200, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "State, county, province, or region.", "maxLength": 5000, "type": "string" } }, "title": "legal_entity_and_kyc_address_specs", "type": "object", "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state" ] }, "address_kana": { "description": "The Kana variation of the company's primary address (Japan only).", "properties": { "city": { "description": "City or ward.", "maxLength": 5000, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Block or building number.", "maxLength": 5000, "type": "string" }, "line2": { "description": "Building details.", "maxLength": 5000, "type": "string" }, "postal_code": { "description": "Postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "Prefecture.", "maxLength": 5000, "type": "string" }, "town": { "description": "Town or cho-me.", "maxLength": 5000, "type": "string" } }, "title": "japan_address_kana_specs", "type": "object", "x-stripeMostCommon": [ "city", "country", "db_code", "line1", "line2", "postal_code", "state", "town" ] }, "address_kanji": { "description": "The Kanji variation of the company's primary address (Japan only).", "properties": { "city": { "description": "City or ward.", "maxLength": 5000, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Block or building number.", "maxLength": 5000, "type": "string" }, "line2": { "description": "Building details.", "maxLength": 5000, "type": "string" }, "postal_code": { "description": "Postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "Prefecture.", "maxLength": 5000, "type": "string" }, "town": { "description": "Town or cho-me.", "maxLength": 5000, "type": "string" } }, "title": "japan_address_kanji_specs", "type": "object", "x-stripeMostCommon": [ "city", "country", "db_code", "line1", "line2", "postal_code", "state", "town" ] }, "directors_provided": { "description": "Whether the company's directors have been provided. Set this Boolean to `true` after creating all the company's directors with [the Persons API](/api/persons) for accounts with a `relationship.director` requirement. This value is not automatically set to `true` after creating directors, so it needs to be updated to indicate all directors have been provided.", "type": "boolean" }, "directorship_declaration": { "description": "This hash is used to attest that the directors information provided to Stripe is both current and correct.", "properties": { "date": { "description": "The Unix timestamp marking when the directorship declaration attestation was made.", "format": "unix-time", "type": "integer" }, "ip": { "description": "The IP address from which the directorship declaration attestation was made.", "type": "string" }, "user_agent": { "description": "The user agent of the browser from which the directorship declaration attestation was made.", "maxLength": 5000, "type": "string" } }, "title": "company_directorship_declaration", "type": "object", "x-stripeMostCommon": [ "date", "ip", "user_agent" ] }, "executives_provided": { "description": "Whether the company's executives have been provided. Set this Boolean to `true` after creating all the company's executives with [the Persons API](/api/persons) for accounts with a `relationship.executive` requirement.", "type": "boolean" }, "export_license_id": { "description": "The export license ID number of the company, also referred as Import Export Code (India only).", "maxLength": 5000, "type": "string" }, "export_purpose_code": { "description": "The purpose code to use for export transactions (India only).", "maxLength": 5000, "type": "string" }, "name": { "description": "The company's legal name.", "maxLength": 100, "type": "string" }, "name_kana": { "description": "The Kana variation of the company's legal name (Japan only).", "maxLength": 100, "type": "string" }, "name_kanji": { "description": "The Kanji variation of the company's legal name (Japan only).", "maxLength": 100, "type": "string" }, "owners_provided": { "description": "Whether the company's owners have been provided. Set this Boolean to `true` after creating all the company's owners with [the Persons API](/api/persons) for accounts with a `relationship.owner` requirement.", "type": "boolean" }, "ownership_declaration": { "description": "This hash is used to attest that the beneficial owner information provided to Stripe is both current and correct.", "properties": { "date": { "description": "The Unix timestamp marking when the beneficial owner attestation was made.", "format": "unix-time", "type": "integer" }, "ip": { "description": "The IP address from which the beneficial owner attestation was made.", "type": "string" }, "user_agent": { "description": "The user agent of the browser from which the beneficial owner attestation was made.", "maxLength": 5000, "type": "string" } }, "title": "company_ownership_declaration", "type": "object", "x-stripeMostCommon": [ "date", "ip", "user_agent" ] }, "ownership_exemption_reason": { "description": "This value is used to determine if a business is exempt from providing ultimate beneficial owners. See [this support article](https://support.stripe.com/questions/exemption-from-providing-ownership-details) and [changelog](https://docs.stripe.com/changelog/acacia/2025-01-27/ownership-exemption-reason-accounts-api) for more details.", "enum": [ "", "qualified_entity_exceeds_ownership_threshold", "qualifies_as_financial_institution" ], "type": "string" }, "phone": { "description": "The company's phone number (used for verification).", "maxLength": 5000, "type": "string" }, "registration_date": { "anyOf": [ { "properties": { "day": { "description": "The day of registration, between 1 and 31.", "type": "integer" }, "month": { "description": "The month of registration, between 1 and 12.", "type": "integer" }, "year": { "description": "The four-digit year of registration.", "type": "integer" } }, "required": [ "day", "month", "year" ], "title": "registration_date_specs", "type": "object", "x-stripeMostCommon": [ "day", "month", "year" ] }, { "enum": [ "" ], "type": "string" } ], "description": "When the business was incorporated or registered." }, "registration_number": { "description": "The identification number given to a company when it is registered or incorporated, if distinct from the identification number used for filing taxes. (Examples are the CIN for companies and LLP IN for partnerships in India, and the Company Registration Number in Hong Kong).", "maxLength": 5000, "type": "string" }, "structure": { "description": "The category identifying the legal structure of the company or legal entity. See [Business structure](/connect/identity-verification#business-structure) for more details. Pass an empty string to unset this value.", "enum": [ "", "free_zone_establishment", "free_zone_llc", "government_instrumentality", "governmental_unit", "incorporated_non_profit", "incorporated_partnership", "limited_liability_partnership", "llc", "multi_member_llc", "private_company", "private_corporation", "private_partnership", "public_company", "public_corporation", "public_partnership", "registered_charity", "single_member_llc", "sole_establishment", "sole_proprietorship", "tax_exempt_government_instrumentality", "unincorporated_association", "unincorporated_non_profit", "unincorporated_partnership" ], "type": "string", "x-stripeBypassValidation": true }, "tax_id": { "description": "The business ID number of the company, as appropriate for the company’s country. (Examples are an Employer ID Number in the U.S., a Business Number in Canada, or a Company Number in the UK.)", "maxLength": 5000, "type": "string" }, "tax_id_registrar": { "description": "The jurisdiction in which the `tax_id` is registered (Germany-based companies only).", "maxLength": 5000, "type": "string" }, "vat_id": { "description": "The VAT number of the company.", "maxLength": 5000, "type": "string" }, "verification": { "description": "Information on the verification state of the company.", "properties": { "document": { "description": "A document verifying the business.", "properties": { "back": { "description": "The back of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `additional_verification`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.", "maxLength": 500, "type": "string" }, "front": { "description": "The front of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `additional_verification`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.", "maxLength": 500, "type": "string" } }, "title": "verification_document_specs", "type": "object", "x-stripeMostCommon": [ "back", "front" ] } }, "title": "verification_specs", "type": "object", "x-stripeMostCommon": [ "document" ] } }, "title": "company_specs", "type": "object", "x-stripeMostCommon": [ "address", "address_kana", "address_kanji", "contact_point_verification_address", "cross_border_transaction_classifications", "directors_provided", "directorship_declaration", "executives_provided", "export_license_id", "export_purpose_code", "fiscal_code", "invoicing_recipient_code", "name", "name_kana", "name_kanji", "owners_provided", "ownership_declaration", "ownership_exemption_reason", "pan", "phone", "registered_email", "registration_date", "registration_number", "stock_data", "structure", "tax_deduction_account_number", "tax_id", "tax_id_registrar", "trust_owned", "vat_id", "vat_registration_status", "verification" ] }, "controller": { "description": "A hash of configuration describing the account controller's attributes.", "properties": { "application": { "description": "A hash of configuration describing the Connect application that controls the account.", "properties": { "loss_liable": { "description": "Whether the controller is liable for losses on this account. For details, see [Understanding Connect Account Balances](https://stripe.com/docs/connect/account-balances).", "type": "boolean" }, "onboarding_owner": { "description": "Whether the controller owns onboarding for this account.", "type": "boolean" }, "pricing_controls": { "description": "Whether the controller has pricing controls for this account.", "type": "boolean" } }, "required": [ "loss_liable" ], "title": "controller_application_specs", "type": "object", "x-stripeMostCommon": [ "loss_liable", "onboarding_owner", "pricing_controls" ] }, "dashboard": { "description": "Properties of the account's dashboard.", "properties": { "type": { "description": "Whether this account should have access to the full Stripe Dashboard (`full`), to the Express Dashboard (`express`), or to no Stripe-hosted dashboard (`none`). Defaults to `full`.", "enum": [ "express", "full", "none" ], "type": "string" } }, "title": "controller_dashboard_specs", "type": "object", "x-stripeMostCommon": [ "type" ] }, "fees": { "description": "A hash of configuration for who pays Stripe fees for product usage on this account.", "properties": { "payer": { "description": "A value indicating the responsible payer of Stripe fees on this account. Defaults to `account`. Learn more about [fee behavior on connected accounts](https://docs.stripe.com/connect/direct-charges-fee-payer-behavior).", "enum": [ "account", "application" ], "type": "string" } }, "title": "controller_fees_specs", "type": "object", "x-stripeMostCommon": [ "payer" ] }, "losses": { "description": "A hash of configuration for products that have negative balance liability, and whether Stripe or a Connect application is responsible for them.", "properties": { "payments": { "description": "A value indicating who is liable when this account can't pay back negative balances resulting from payments. Defaults to `stripe`.", "enum": [ "application", "stripe" ], "type": "string" } }, "title": "controller_losses_specs", "type": "object", "x-stripeMostCommon": [ "payments" ] }, "requirement_collection": { "description": "A value indicating responsibility for collecting updated information when requirements on the account are due or change. Defaults to `stripe`.", "enum": [ "application", "stripe" ], "type": "string" }, "stripe_dashboard": { "description": "A hash of configuration for Stripe-hosted dashboards.", "properties": { "type": { "description": "Whether this account should have access to the full Stripe Dashboard (`full`), to the Express Dashboard (`express`), or to no Stripe-hosted dashboard (`none`). Defaults to `full`.", "enum": [ "express", "full", "none" ], "type": "string" } }, "title": "controller_dashboard_specs", "type": "object", "x-stripeMostCommon": [ "type" ] } }, "title": "controller_specs", "type": "object", "x-stripeMostCommon": [ "application", "dashboard", "fees", "losses", "requirement_collection", "stripe_dashboard" ] }, "country": { "description": "The country in which the account holder resides, or in which the business is legally established. This should be an ISO 3166-1 alpha-2 country code. For example, if you are in the United States and the business for which you're creating an account is legally represented in Canada, you would use `CA` as the country for the account being created. Available countries include [Stripe's global markets](https://stripe.com/global) as well as countries where [cross-border payouts](https://stripe.com/docs/connect/cross-border-payouts) are supported.", "maxLength": 5000, "type": "string" }, "default_currency": { "description": "Three-letter ISO currency code representing the default currency for the account. This must be a currency that [Stripe supports in the account's country](https://docs.stripe.com/payouts).", "format": "currency", "type": "string" }, "documents": { "description": "Documents that may be submitted to satisfy various informational requests.", "properties": { "bank_account_ownership_verification": { "description": "One or more documents that support the [Bank account ownership verification](https://support.stripe.com/questions/bank-account-ownership-verification) requirement. Must be a document associated with the account’s primary active bank account that displays the last 4 digits of the account number, either a statement or a check.", "properties": { "files": { "description": "One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.", "items": { "maxLength": 500, "type": "string" }, "type": "array" } }, "title": "documents_param", "type": "object", "x-stripeMostCommon": [ "files" ] }, "company_license": { "description": "One or more documents that demonstrate proof of a company's license to operate.", "properties": { "files": { "description": "One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.", "items": { "maxLength": 500, "type": "string" }, "type": "array" } }, "title": "documents_param", "type": "object", "x-stripeMostCommon": [ "files" ] }, "company_memorandum_of_association": { "description": "One or more documents showing the company's Memorandum of Association.", "properties": { "files": { "description": "One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.", "items": { "maxLength": 500, "type": "string" }, "type": "array" } }, "title": "documents_param", "type": "object", "x-stripeMostCommon": [ "files" ] }, "company_ministerial_decree": { "description": "(Certain countries only) One or more documents showing the ministerial decree legalizing the company's establishment.", "properties": { "files": { "description": "One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.", "items": { "maxLength": 500, "type": "string" }, "type": "array" } }, "title": "documents_param", "type": "object", "x-stripeMostCommon": [ "files" ] }, "company_registration_verification": { "description": "One or more documents that demonstrate proof of a company's registration with the appropriate local authorities.", "properties": { "files": { "description": "One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.", "items": { "maxLength": 500, "type": "string" }, "type": "array" } }, "title": "documents_param", "type": "object", "x-stripeMostCommon": [ "files" ] }, "company_tax_id_verification": { "description": "One or more documents that demonstrate proof of a company's tax ID.", "properties": { "files": { "description": "One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.", "items": { "maxLength": 500, "type": "string" }, "type": "array" } }, "title": "documents_param", "type": "object", "x-stripeMostCommon": [ "files" ] }, "proof_of_address": { "description": "One or more documents that demonstrate proof of address.", "properties": { "files": { "description": "One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.", "items": { "maxLength": 500, "type": "string" }, "type": "array" } }, "title": "documents_param", "type": "object", "x-stripeMostCommon": [ "files" ] }, "proof_of_registration": { "description": "One or more documents showing the company’s proof of registration with the national business registry.", "properties": { "files": { "description": "One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.", "items": { "maxLength": 500, "type": "string" }, "type": "array" } }, "title": "documents_param", "type": "object", "x-stripeMostCommon": [ "files" ] }, "proof_of_ultimate_beneficial_ownership": { "description": "One or more documents that demonstrate proof of ultimate beneficial ownership.", "properties": { "files": { "description": "One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.", "items": { "maxLength": 500, "type": "string" }, "type": "array" } }, "title": "documents_param", "type": "object", "x-stripeMostCommon": [ "files" ] } }, "title": "documents_specs", "type": "object", "x-stripeMostCommon": [ "bank_account_ownership_verification", "company_address_verification", "company_license", "company_memorandum_of_association", "company_ministerial_decree", "company_registration_verification", "company_tax_id_verification", "company_vat_id_verification", "proof_of_address", "proof_of_registration", "proof_of_ultimate_beneficial_ownership" ] }, "email": { "description": "The email address of the account holder. This is only to make the account easier to identify to you. If [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts, Stripe doesn't email the account without your consent.", "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "external_account": { "description": "A card or bank account to attach to the account for receiving [payouts](/connect/bank-debit-card-payouts) (you won’t be able to use it for top-ups). You can provide either a token, like the ones returned by [Stripe.js](/js), or a dictionary, as documented in the `external_account` parameter for [bank account](/api#account_create_bank_account) creation.

By default, providing an external account sets it as the new default external account for its currency, and deletes the old default if one exists. To add additional external accounts without replacing the existing default for the currency, use the [bank account](/api#account_create_bank_account) or [card creation](/api#account_create_card) APIs. After you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.", "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true }, "groups": { "description": "A hash of account group type to tokens. These are account groups this account should be added to.", "properties": { "payments_pricing": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "The group the account is in to determine their payments pricing, and null if the account is on customized pricing. [See the Platform pricing tool documentation](https://stripe.com/docs/connect/platform-pricing-tools) for details." } }, "title": "account_groups_specs", "type": "object", "x-stripeMostCommon": [ "payments_pricing" ] }, "individual": { "description": "Information about the person represented by the account. This field is null unless `business_type` is set to `individual`. Once you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.", "properties": { "address": { "description": "The individual's primary address.", "properties": { "city": { "description": "City, district, suburb, town, or village.", "maxLength": 100, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Address line 1 (e.g., street, PO Box, or company name).", "maxLength": 200, "type": "string" }, "line2": { "description": "Address line 2 (e.g., apartment, suite, unit, or building).", "maxLength": 200, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "State, county, province, or region.", "maxLength": 5000, "type": "string" } }, "title": "address_specs", "type": "object", "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state" ] }, "address_kana": { "description": "The Kana variation of the individual's primary address (Japan only).", "properties": { "city": { "description": "City or ward.", "maxLength": 5000, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Block or building number.", "maxLength": 5000, "type": "string" }, "line2": { "description": "Building details.", "maxLength": 5000, "type": "string" }, "postal_code": { "description": "Postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "Prefecture.", "maxLength": 5000, "type": "string" }, "town": { "description": "Town or cho-me.", "maxLength": 5000, "type": "string" } }, "title": "japan_address_kana_specs", "type": "object", "x-stripeMostCommon": [ "city", "country", "db_code", "line1", "line2", "postal_code", "state", "town" ] }, "address_kanji": { "description": "The Kanji variation of the individual's primary address (Japan only).", "properties": { "city": { "description": "City or ward.", "maxLength": 5000, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Block or building number.", "maxLength": 5000, "type": "string" }, "line2": { "description": "Building details.", "maxLength": 5000, "type": "string" }, "postal_code": { "description": "Postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "Prefecture.", "maxLength": 5000, "type": "string" }, "town": { "description": "Town or cho-me.", "maxLength": 5000, "type": "string" } }, "title": "japan_address_kanji_specs", "type": "object", "x-stripeMostCommon": [ "city", "country", "db_code", "line1", "line2", "postal_code", "state", "town" ] }, "dob": { "anyOf": [ { "properties": { "day": { "description": "The day of birth, between 1 and 31.", "type": "integer" }, "month": { "description": "The month of birth, between 1 and 12.", "type": "integer" }, "year": { "description": "The four-digit year of birth.", "type": "integer" } }, "required": [ "day", "month", "year" ], "title": "date_of_birth_specs", "type": "object", "x-stripeMostCommon": [ "day", "month", "year" ] }, { "enum": [ "" ], "type": "string" } ], "description": "The individual's date of birth." }, "email": { "description": "The individual's email address.", "type": "string" }, "first_name": { "description": "The individual's first name.", "maxLength": 100, "type": "string" }, "first_name_kana": { "description": "The Kana variation of the individual's first name (Japan only).", "maxLength": 5000, "type": "string" }, "first_name_kanji": { "description": "The Kanji variation of the individual's first name (Japan only).", "maxLength": 5000, "type": "string" }, "full_name_aliases": { "anyOf": [ { "items": { "maxLength": 300, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "A list of alternate names or aliases that the individual is known by." }, "gender": { "description": "The individual's gender", "type": "string" }, "id_number": { "description": "The government-issued ID number of the individual, as appropriate for the representative's country. (Examples are a Social Security Number in the U.S., or a Social Insurance Number in Canada). Instead of the number itself, you can also provide a [PII token created with Stripe.js](/js/tokens/create_token?type=pii).", "maxLength": 5000, "type": "string" }, "id_number_secondary": { "description": "The government-issued secondary ID number of the individual, as appropriate for the representative's country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token created with Stripe.js](/js/tokens/create_token?type=pii).", "maxLength": 5000, "type": "string" }, "last_name": { "description": "The individual's last name.", "maxLength": 100, "type": "string" }, "last_name_kana": { "description": "The Kana variation of the individual's last name (Japan only).", "maxLength": 5000, "type": "string" }, "last_name_kanji": { "description": "The Kanji variation of the individual's last name (Japan only).", "maxLength": 5000, "type": "string" }, "maiden_name": { "description": "The individual's maiden name.", "maxLength": 5000, "type": "string" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "phone": { "description": "The individual's phone number.", "type": "string" }, "political_exposure": { "description": "Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction.", "enum": [ "existing", "none" ], "type": "string" }, "registered_address": { "description": "The individual's registered address.", "properties": { "city": { "description": "City, district, suburb, town, or village.", "maxLength": 100, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Address line 1 (e.g., street, PO Box, or company name).", "maxLength": 200, "type": "string" }, "line2": { "description": "Address line 2 (e.g., apartment, suite, unit, or building).", "maxLength": 200, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "State, county, province, or region.", "maxLength": 5000, "type": "string" } }, "title": "address_specs", "type": "object", "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state" ] }, "relationship": { "description": "Describes the person’s relationship to the account.", "properties": { "director": { "description": "Whether the person is a director of the account's legal entity. Directors are typically members of the governing board of the company, or responsible for ensuring the company meets its regulatory obligations.", "type": "boolean" }, "executive": { "description": "Whether the person has significant responsibility to control, manage, or direct the organization.", "type": "boolean" }, "owner": { "description": "Whether the person is an owner of the account’s legal entity.", "type": "boolean" }, "percent_ownership": { "anyOf": [ { "type": "number" }, { "enum": [ "" ], "type": "string" } ], "description": "The percent owned by the person of the account's legal entity." }, "title": { "description": "The person's title (e.g., CEO, Support Engineer).", "maxLength": 5000, "type": "string" } }, "title": "individual_relationship_specs", "type": "object", "x-stripeMostCommon": [ "controller", "director", "executive", "officer", "owner", "partner", "percent_ownership", "title" ] }, "ssn_last_4": { "description": "The last four digits of the individual's Social Security Number (U.S. only).", "maxLength": 5000, "type": "string" }, "verification": { "description": "The individual's verification document information.", "properties": { "additional_document": { "description": "A document showing address, either a passport, local ID card, or utility bill from a well-known utility company.", "properties": { "back": { "description": "The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.", "maxLength": 500, "type": "string" }, "front": { "description": "The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.", "maxLength": 500, "type": "string" } }, "title": "person_verification_document_specs", "type": "object", "x-stripeMostCommon": [ "back", "electronic_id", "front" ] }, "document": { "description": "An identifying document, either a passport or local ID card.", "properties": { "back": { "description": "The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.", "maxLength": 500, "type": "string" }, "front": { "description": "The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.", "maxLength": 500, "type": "string" } }, "title": "person_verification_document_specs", "type": "object", "x-stripeMostCommon": [ "back", "electronic_id", "front" ] } }, "title": "person_verification_specs", "type": "object", "x-stripeMostCommon": [ "additional_document", "document", "proof_of_liveness" ] } }, "title": "individual_specs", "type": "object", "x-stripeMostCommon": [ "address", "address_kana", "address_kanji", "birth_city", "birth_country", "dob", "email", "first_name", "first_name_kana", "first_name_kanji", "full_name_aliases", "gender", "id_number", "id_number_secondary", "last_name", "last_name_kana", "last_name_kanji", "maiden_name", "metadata", "phone", "political_exposure", "registered_address", "relationship", "ssn_last_4", "verification" ] }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "risk_controls": { "description": "A hash to configure risk controls on the account. Please see [this page for more details](/connect/pausing-payments-or-payouts-on-connected-accounts).", "properties": { "charges": { "description": "Represents the risk control status of charges. Please see [this page for more details](https://stripe.com/docs/connect/pausing-payments-or-payouts-on-connected-accounts).", "properties": { "pause_requested": { "description": "To request to pause a risk control, pass `true`. To request to unpause a risk control, pass `false`.\nThere can be a delay before the risk control is paused or unpaused.", "type": "boolean" } }, "title": "risk_control_param", "type": "object", "x-stripeMostCommon": [ "pause_requested" ] }, "payouts": { "description": "Represents the risk control status of payouts. Please see [this page for more details](https://stripe.com/docs/connect/pausing-payments-or-payouts-on-connected-accounts).", "properties": { "pause_requested": { "description": "To request to pause a risk control, pass `true`. To request to unpause a risk control, pass `false`.\nThere can be a delay before the risk control is paused or unpaused.", "type": "boolean" } }, "title": "risk_control_param", "type": "object", "x-stripeMostCommon": [ "pause_requested" ] } }, "title": "risk_controls_hash_param", "type": "object", "x-stripeMostCommon": [ "charges", "payouts", "rejected_reason" ] }, "settings": { "description": "Options for customizing how the account functions within Stripe.", "properties": { "bacs_debit_payments": { "description": "Settings specific to Bacs Direct Debit.", "properties": { "display_name": { "description": "The Bacs Direct Debit Display Name for this account. For payments made with Bacs Direct Debit, this name appears on the mandate as the statement descriptor. Mobile banking apps display it as the name of the business. To use custom branding, set the Bacs Direct Debit Display Name during or right after creation. Custom branding incurs an additional monthly fee for the platform. If you don't set the display name before requesting Bacs capability, it's automatically set as \"Stripe\" and the account is onboarded to Stripe branding, which is free.", "type": "string" } }, "title": "bacs_debit_payments_specs", "type": "object", "x-stripeMostCommon": [ "display_name" ] }, "bank_bca_onboarding": { "description": "Settings specific to bank BCA onboarding for Indonesia bank transfers payments method.", "properties": { "account_holder_name": { "description": "Bank BCA business account holder name", "maxLength": 5000, "type": "string" }, "business_account_number": { "description": "Bank BCA business account number", "maxLength": 5000, "type": "string" } }, "title": "bank_bca_onboarding_settings_specs", "type": "object", "x-stripeMostCommon": [ "account_holder_name", "business_account_number" ] }, "branding": { "description": "Settings used to apply the account's branding to email receipts, invoices, Checkout, and other products.", "properties": { "icon": { "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) An icon for the account. Must be square and at least 128px x 128px.", "maxLength": 5000, "type": "string" }, "logo": { "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) A logo for the account that will be used in Checkout instead of the icon and without the account's name next to it if provided. Must be at least 128px x 128px.", "maxLength": 5000, "type": "string" }, "primary_color": { "description": "A CSS hex color value representing the primary branding color for this account.", "maxLength": 5000, "type": "string" }, "secondary_color": { "description": "A CSS hex color value representing the secondary branding color for this account.", "maxLength": 5000, "type": "string" } }, "title": "branding_settings_specs", "type": "object", "x-stripeMostCommon": [ "icon", "logo", "primary_color", "secondary_color", "show_support_phone" ] }, "capital": { "description": "Settings specific to the account's use of the Capital product.", "properties": { "payout_destination": { "additionalProperties": { "maxLength": 5000, "type": "string" }, "description": "Per-currency mapping of user-selected destination accounts used to pay out loans.", "type": "object" }, "payout_destination_selector": { "additionalProperties": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "description": "Per-currency mapping of all destination accounts eligible to receive Capital financing payouts.", "type": "object" } }, "title": "capital_settings_specs", "type": "object", "x-stripeMostCommon": [ "payout_destination", "payout_destination_selector" ] }, "card_issuing": { "description": "Settings specific to the account's use of the Card Issuing product.", "properties": { "tos_acceptance": { "description": "Details on the account's acceptance of the [Stripe Issuing Terms and Disclosures](/issuing/connect/tos_acceptance).", "properties": { "date": { "description": "The Unix timestamp marking when the account representative accepted the service agreement.", "format": "unix-time", "type": "integer" }, "ip": { "description": "The IP address from which the account representative accepted the service agreement.", "type": "string" }, "user_agent": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "The user agent of the browser from which the account representative accepted the service agreement." } }, "title": "settings_terms_of_service_specs", "type": "object", "x-stripeMostCommon": [ "date", "ip", "user_agent" ] } }, "title": "card_issuing_settings_specs", "type": "object", "x-stripeMostCommon": [ "tos_acceptance", "tos_acceptances" ] }, "card_payments": { "description": "Settings specific to card charging on the account.", "properties": { "decline_on": { "description": "Automatically declines certain charge types regardless of whether the card issuer accepted or declined the charge.", "properties": { "avs_failure": { "description": "Whether Stripe automatically declines charges with an incorrect ZIP or postal code. This setting only applies when a ZIP or postal code is provided and they fail bank verification.", "type": "boolean" }, "cvc_failure": { "description": "Whether Stripe automatically declines charges with an incorrect CVC. This setting only applies when a CVC is provided and it fails bank verification.", "type": "boolean" } }, "title": "decline_charge_on_specs", "type": "object", "x-stripeMostCommon": [ "avs_failure", "cvc_failure" ] }, "statement_descriptor_prefix": { "description": "The default text that appears on credit card statements when a charge is made. This field prefixes any dynamic `statement_descriptor` specified on the charge. `statement_descriptor_prefix` is useful for maximizing descriptor space for the dynamic portion.", "maxLength": 10, "type": "string" }, "statement_descriptor_prefix_kana": { "anyOf": [ { "maxLength": 10, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "The Kana variation of the default text that appears on credit card statements when a charge is made (Japan only). This field prefixes any dynamic `statement_descriptor_suffix_kana` specified on the charge. `statement_descriptor_prefix_kana` is useful for maximizing descriptor space for the dynamic portion." }, "statement_descriptor_prefix_kanji": { "anyOf": [ { "maxLength": 10, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "The Kanji variation of the default text that appears on credit card statements when a charge is made (Japan only). This field prefixes any dynamic `statement_descriptor_suffix_kanji` specified on the charge. `statement_descriptor_prefix_kanji` is useful for maximizing descriptor space for the dynamic portion." } }, "title": "card_payments_settings_specs", "type": "object", "x-stripeMostCommon": [ "decline_on", "onboarding_policy", "statement_descriptor_prefix", "statement_descriptor_prefix_kana", "statement_descriptor_prefix_kanji" ] }, "invoices": { "description": "Settings specific to the account’s use of Invoices.", "properties": { "hosted_payment_method_save": { "description": "Whether payment methods should be saved when a payment is completed for a one-time invoices on a hosted invoice page.", "enum": [ "always", "never", "offer" ], "type": "string" } }, "title": "invoices_settings_specs_create", "type": "object", "x-stripeMostCommon": [ "hosted_payment_method_save" ] }, "payments": { "description": "Settings that apply across payment methods for charging on the account.", "properties": { "statement_descriptor": { "description": "The default text that appears on statements for non-card charges outside of Japan. For card charges, if you don't set a `statement_descriptor_prefix`, this text is also used as the statement descriptor prefix. In that case, if concatenating the statement descriptor suffix causes the combined statement descriptor to exceed 22 characters, we truncate the `statement_descriptor` text to limit the full descriptor to 22 characters. For more information about statement descriptors and their requirements, see the [account settings documentation](https://docs.stripe.com/get-started/account/statement-descriptors).", "maxLength": 22, "type": "string" }, "statement_descriptor_kana": { "description": "The Kana variation of `statement_descriptor` used for charges in Japan. Japanese statement descriptors have [special requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors).", "maxLength": 22, "type": "string" }, "statement_descriptor_kanji": { "description": "The Kanji variation of `statement_descriptor` used for charges in Japan. Japanese statement descriptors have [special requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors).", "maxLength": 22, "type": "string" } }, "title": "payments_settings_specs", "type": "object", "x-stripeMostCommon": [ "statement_descriptor", "statement_descriptor_kana", "statement_descriptor_kanji" ] }, "payouts": { "description": "Settings specific to the account's payouts.", "properties": { "debit_negative_balances": { "description": "A Boolean indicating whether Stripe should try to reclaim negative balances from an attached bank account. For details, see [Understanding Connect Account Balances](/connect/account-balances).", "type": "boolean" }, "schedule": { "description": "Details on when funds from charges are available, and when they are paid out to an external account. For details, see our [Setting Bank and Debit Card Payouts](/connect/bank-transfers#payout-information) documentation.", "properties": { "delay_days": { "anyOf": [ { "enum": [ "minimum" ], "maxLength": 5000, "type": "string" }, { "type": "integer" } ], "description": "The number of days charge funds are held before being paid out. May also be set to `minimum`, representing the lowest available value for the account country. Default is `minimum`. The `delay_days` parameter remains at the last configured value if `interval` is `manual`. [Learn more about controlling payout delay days](/connect/manage-payout-schedule)." }, "interval": { "description": "How frequently available funds are paid out. One of: `daily`, `manual`, `weekly`, or `monthly`. Default is `daily`.", "enum": [ "daily", "manual", "monthly", "weekly" ], "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true }, "monthly_anchor": { "description": "The day of the month when available funds are paid out, specified as a number between 1--31. Payouts nominally scheduled between the 29th and 31st of the month are instead sent on the last day of a shorter month. Required and applicable only if `interval` is `monthly`.", "type": "integer" }, "monthly_payout_days": { "description": "The days of the month when available funds are paid out, specified as an array of numbers between 1--31. Payouts nominally scheduled between the 29th and 31st of the month are instead sent on the last day of a shorter month. Required and applicable only if `interval` is `monthly` and `monthly_anchor` is not set.", "items": { "type": "integer" }, "type": "array" }, "weekly_anchor": { "description": "The day of the week when available funds are paid out, specified as `monday`, `tuesday`, etc. Required and applicable only if `interval` is `weekly`.", "enum": [ "friday", "monday", "saturday", "sunday", "thursday", "tuesday", "wednesday" ], "maxLength": 5000, "type": "string" }, "weekly_payout_days": { "description": "The days of the week when available funds are paid out, specified as an array, e.g., [`monday`, `tuesday`]. Required and applicable only if `interval` is `weekly`.", "items": { "enum": [ "friday", "monday", "thursday", "tuesday", "wednesday" ], "type": "string", "x-stripeBypassValidation": true }, "type": "array" } }, "title": "transfer_schedule_specs", "type": "object", "x-stripeMostCommon": [ "automatic", "delay_days", "interval", "monthly_anchor", "monthly_payout_days", "timezone", "weekly_anchor", "weekly_payout_days" ] }, "statement_descriptor": { "description": "The text that appears on the bank account statement for payouts. If not set, this defaults to the platform's bank descriptor as set in the Dashboard.", "maxLength": 22, "type": "string" } }, "title": "payout_settings_specs", "type": "object", "x-stripeMostCommon": [ "debit_negative_balances", "schedule", "statement_descriptor" ] }, "tax_forms": { "description": "Settings specific to the account's tax forms.", "properties": { "consented_to_paperless_delivery": { "description": "Whether the account opted out of receiving their tax forms by postal delivery.", "type": "boolean" } }, "title": "tax_form_settings_param", "type": "object", "x-stripeMostCommon": [ "consented_to_paperless_delivery" ] }, "treasury": { "description": "Settings specific to the account's Treasury FinancialAccounts.", "properties": { "tos_acceptance": { "description": "Details on the account's acceptance of the Stripe Treasury Services Agreement.", "properties": { "date": { "description": "The Unix timestamp marking when the account representative accepted the service agreement.", "format": "unix-time", "type": "integer" }, "ip": { "description": "The IP address from which the account representative accepted the service agreement.", "type": "string" }, "user_agent": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "The user agent of the browser from which the account representative accepted the service agreement." } }, "title": "settings_terms_of_service_specs", "type": "object", "x-stripeMostCommon": [ "date", "ip", "user_agent" ] } }, "title": "treasury_settings_specs", "type": "object", "x-stripeMostCommon": [ "tos_acceptance" ] } }, "title": "settings_specs", "type": "object", "x-stripeMostCommon": [ "affirm_payments", "bacs_debit_payments", "bank_bca_onboarding", "branding", "capital", "card_issuing", "card_issuing_charge_card", "card_issuing_payout", "card_payments", "crypto_payments", "fund_and_send", "funding_credit", "invoices", "konbini_payments", "payments", "payouts", "tax_forms", "treasury" ] }, "tos_acceptance": { "description": "Details on the account's acceptance of the [Stripe Services Agreement](/connect/updating-accounts#tos-acceptance). This property can only be updated for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. This property defaults to a `full` service agreement when empty.", "properties": { "date": { "description": "The Unix timestamp marking when the account representative accepted their service agreement.", "format": "unix-time", "type": "integer" }, "ip": { "description": "The IP address from which the account representative accepted their service agreement.", "type": "string" }, "service_agreement": { "description": "The user's service agreement type.", "maxLength": 5000, "type": "string" }, "user_agent": { "description": "The user agent of the browser from which the account representative accepted their service agreement.", "maxLength": 5000, "type": "string" } }, "title": "tos_acceptance_specs", "type": "object", "x-stripeMostCommon": [ "date", "ip", "service_agreement", "user_agent" ] }, "type": { "description": "The type of Stripe account to create. May be one of `custom`, `express` or `standard`.", "enum": [ "custom", "express", "standard" ], "type": "string" } }, "type": "object", "x-stripeMostCommon": [ "business_type", "capabilities", "company", "controller", "country", "email", "individual", "metadata", "tos_acceptance", "type" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/account" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } } } }, "/v1/accounts/{account}": { "delete": { "description": "

With Connect, you can delete accounts you manage.

\n\n

Test-mode accounts can be deleted at any time.

\n\n

Live-mode accounts that have access to the standard dashboard and Stripe is responsible for negative account balances cannot be deleted, which includes Standard accounts. All other Live-mode accounts, can be deleted when all balances are zero.

\n\n

If you want to delete your own account, use the account information tab in your account settings instead.

", "operationId": "DeleteAccountsAccount", "parameters": [ { "in": "path", "name": "account", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted_account" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Delete an account" }, "get": { "description": "

Retrieves the details of an account.

", "operationId": "GetAccountsAccount", "parameters": [ { "in": "path", "name": "account", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/account" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve account" }, "post": { "description": "

Updates a connected account by setting the values of the parameters passed. Any parameters not provided are\nleft unchanged.

\n\n

For accounts where controller.requirement_collection\nis application, which includes Custom accounts, you can update any information on the account.

\n\n

For accounts where controller.requirement_collection\nis stripe, which includes Standard and Express accounts, you can update all information until you create\nan Account Link or Account Session to start Connect onboarding,\nafter which some properties can no longer be updated.

\n\n

To update your own account, use the Dashboard. Refer to our\nConnect documentation to learn more about updating accounts.

", "operationId": "PostAccountsAccount", "parameters": [ { "in": "path", "name": "account", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "business_profile": { "explode": true, "style": "deepObject" }, "capabilities": { "explode": true, "style": "deepObject" }, "company": { "explode": true, "style": "deepObject" }, "documents": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "groups": { "explode": true, "style": "deepObject" }, "individual": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "risk_controls": { "explode": true, "style": "deepObject" }, "settings": { "explode": true, "style": "deepObject" }, "tos_acceptance": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "account_token": { "description": "An [account token](https://stripe.com/docs/api#create_account_token), used to securely provide details to the account.", "maxLength": 5000, "type": "string" }, "business_profile": { "description": "Business information about the account.", "properties": { "annual_revenue": { "description": "The applicant's gross annual revenue for its preceding fiscal year.", "properties": { "amount": { "description": "A non-negative integer representing the amount in the [smallest currency unit](/currencies#zero-decimal).", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "fiscal_year_end": { "description": "The close-out date of the preceding fiscal year in ISO 8601 format. E.g. 2023-12-31 for the 31st of December, 2023.", "maxLength": 5000, "type": "string" } }, "required": [ "amount", "currency", "fiscal_year_end" ], "title": "annual_revenue_specs", "type": "object", "x-stripeMostCommon": [ "amount", "currency", "fiscal_year_end" ] }, "estimated_worker_count": { "description": "An estimated upper bound of employees, contractors, vendors, etc. currently working for the business.", "type": "integer" }, "mcc": { "description": "[The merchant category code for the account](/connect/setting-mcc). MCCs are used to classify businesses based on the goods or services they provide.", "maxLength": 4, "type": "string" }, "minority_owned_business_designation": { "description": "Whether the business is a minority-owned, women-owned, and/or LGBTQI+ -owned business.", "items": { "enum": [ "lgbtqi_owned_business", "minority_owned_business", "none_of_these_apply", "prefer_not_to_answer", "women_owned_business" ], "type": "string" }, "type": "array" }, "monthly_estimated_revenue": { "description": "An estimate of the monthly revenue of the business. Only accepted for accounts in Brazil and India.", "properties": { "amount": { "description": "A non-negative integer representing how much to charge in the [smallest currency unit](/currencies#zero-decimal).", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" } }, "required": [ "amount", "currency" ], "title": "monthly_estimated_revenue_specs", "type": "object", "x-stripeMostCommon": [ "amount", "currency" ] }, "name": { "description": "The customer-facing business name.", "maxLength": 5000, "type": "string" }, "product_description": { "description": "Internal-only description of the product sold by, or service provided by, the business. Used by Stripe for risk and underwriting purposes.", "maxLength": 40000, "type": "string" }, "support_address": { "description": "A publicly available mailing address for sending support issues to.", "properties": { "city": { "description": "City, district, suburb, town, or village.", "maxLength": 100, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Address line 1 (e.g., street, PO Box, or company name).", "maxLength": 200, "type": "string" }, "line2": { "description": "Address line 2 (e.g., apartment, suite, unit, or building).", "maxLength": 200, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "State, county, province, or region.", "maxLength": 5000, "type": "string" } }, "title": "address_specs", "type": "object", "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state" ] }, "support_email": { "description": "A publicly available email address for sending support issues to.", "type": "string" }, "support_phone": { "description": "A publicly available phone number to call with support issues.", "maxLength": 5000, "type": "string" }, "support_url": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "A publicly available website for handling support issues." }, "url": { "description": "The business's publicly available website.", "type": "string" } }, "title": "business_profile_update_specs", "type": "object", "x-stripeMostCommon": [ "annual_revenue", "customer_regions", "estimated_worker_count", "funding_source", "industry", "mcc", "minority_owned_business_designation", "monthly_estimated_revenue", "name", "payment_collection_methods", "privacy_policy_url", "product_description", "singapore_account_activity_survey", "specified_commercial_transactions_act_url", "support_address", "support_email", "support_phone", "support_url", "terms_of_service_url", "url", "url_opt_out_reason" ] }, "business_type": { "description": "The business type. Once you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.", "enum": [ "company", "government_entity", "individual", "non_profit" ], "type": "string", "x-stripeBypassValidation": true }, "capabilities": { "description": "Each key of the dictionary represents a capability, and each capability\nmaps to its settings (for example, whether it has been requested or not). Each\ncapability is inactive until you have provided its specific\nrequirements and Stripe has verified them. An account might have some\nof its requested capabilities be active and some be inactive.\n\nRequired when [account.controller.stripe_dashboard.type](/api/accounts/create#create_account-controller-dashboard-type)\nis `none`, which includes Custom accounts.", "properties": { "acss_debit_payments": { "description": "The acss_debit_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "affirm_payments": { "description": "The affirm_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "afterpay_clearpay_payments": { "description": "The afterpay_clearpay_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "alma_payments": { "description": "The alma_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "amazon_pay_payments": { "description": "The amazon_pay_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "au_becs_debit_payments": { "description": "The au_becs_debit_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "automatic_indirect_tax": { "description": "The automatic_indirect_tax capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "bacs_debit_payments": { "description": "The bacs_debit_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "bancontact_payments": { "description": "The bancontact_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "bank_transfer_payments": { "description": "The bank_transfer_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "billie_payments": { "description": "The billie_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "blik_payments": { "description": "The blik_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "boleto_payments": { "description": "The boleto_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "card_issuing": { "description": "The card_issuing capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "card_payments": { "description": "The card_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "cartes_bancaires_payments": { "description": "The cartes_bancaires_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "cashapp_payments": { "description": "The cashapp_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "crypto_payments": { "description": "The crypto_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "eps_payments": { "description": "The eps_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "fpx_payments": { "description": "The fpx_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "gb_bank_transfer_payments": { "description": "The gb_bank_transfer_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "giropay_payments": { "description": "The giropay_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "gopay_payments": { "description": "The gopay_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "grabpay_payments": { "description": "The grabpay_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "id_bank_transfer_payments": { "description": "The id_bank_transfer_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "id_bank_transfer_payments_bca": { "description": "The id_bank_transfer_payments_bca capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "ideal_payments": { "description": "The ideal_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "india_international_payments": { "description": "The india_international_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "jcb_payments": { "description": "The jcb_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "jp_bank_transfer_payments": { "description": "The jp_bank_transfer_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "kakao_pay_payments": { "description": "The kakao_pay_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "klarna_payments": { "description": "The klarna_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "konbini_payments": { "description": "The konbini_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "kr_card_payments": { "description": "The kr_card_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "legacy_payments": { "description": "The legacy_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "link_payments": { "description": "The link_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "mb_way_payments": { "description": "The mb_way_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "mobilepay_payments": { "description": "The mobilepay_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "multibanco_payments": { "description": "The multibanco_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "mx_bank_transfer_payments": { "description": "The mx_bank_transfer_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "naver_pay_payments": { "description": "The naver_pay_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "nz_bank_account_becs_debit_payments": { "description": "The nz_bank_account_becs_debit_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "oxxo_payments": { "description": "The oxxo_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "p24_payments": { "description": "The p24_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "pay_by_bank_payments": { "description": "The pay_by_bank_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "payco_payments": { "description": "The payco_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "paynow_payments": { "description": "The paynow_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "paypal_payments": { "description": "The paypal_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "paypay_payments": { "description": "The paypay_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "payto_payments": { "description": "The payto_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "pix_payments": { "description": "The pix_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "promptpay_payments": { "description": "The promptpay_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "qris_payments": { "description": "The qris_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "rechnung_payments": { "description": "The rechnung_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "revolut_pay_payments": { "description": "The revolut_pay_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "samsung_pay_payments": { "description": "The samsung_pay_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "satispay_payments": { "description": "The satispay_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "sepa_bank_transfer_payments": { "description": "The sepa_bank_transfer_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "sepa_debit_payments": { "description": "The sepa_debit_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "shopeepay_payments": { "description": "The shopeepay_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "sofort_payments": { "description": "The sofort_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "stripe_balance_payments": { "description": "The stripe_balance_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "swish_payments": { "description": "The swish_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "tax_reporting_us_1099_k": { "description": "The tax_reporting_us_1099_k capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "tax_reporting_us_1099_misc": { "description": "The tax_reporting_us_1099_misc capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "transfers": { "description": "The transfers capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "treasury": { "description": "The treasury capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "treasury_evolve": { "description": "The treasury_evolve capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "treasury_fifth_third": { "description": "The treasury_fifth_third capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "treasury_goldman_sachs": { "description": "The treasury_goldman_sachs capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "twint_payments": { "description": "The twint_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "us_bank_account_ach_payments": { "description": "The us_bank_account_ach_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "us_bank_transfer_payments": { "description": "The us_bank_transfer_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "zip_payments": { "description": "The zip_payments capability.", "properties": { "requested": { "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", "type": "boolean" } }, "title": "capability_param", "type": "object", "x-stripeMostCommon": [ "requested" ] } }, "title": "capabilities_param", "type": "object", "x-stripeMostCommon": [ "ach_debit_payments", "acss_debit_payments", "affirm_payments", "afterpay_clearpay_payments", "alipay_payments", "alma_payments", "amazon_pay_payments", "apple_pay_later_payments", "au_bank_transfer_payments", "au_becs_debit_payments", "automatic_indirect_tax", "bacs_debit_payments", "bacs_debit_stripe_sun_payments", "bancontact_payments", "bank_transfer_payments", "beneficiary_transfers", "billie_payments", "bizum_payments", "blik_payments", "boleto_payments", "ca_bank_transfer_payments", "capchase_pay_payments", "card_issuing", "card_issuing_charge_card", "card_issuing_charge_card_fifth_third", "card_issuing_charge_card_stripe", "card_issuing_consumer", "card_issuing_consumer_revolving_credit_card_celtic", "card_issuing_fa_prepaid_card_lead", "card_issuing_fa_spend_card_celtic", "card_issuing_fa_spend_card_stripe", "card_issuing_prepaid_card_cross_river", "card_issuing_spend_card_cross_river", "card_payments", "cartes_bancaires_payments", "cash_advances", "cashapp_payments", "click_to_pay_payments", "crypto_financial_account_recipients", "crypto_financial_accounts", "crypto_payments", "crypto_transfers", "crypto_transfers_platform", "demo_pay_payments", "duitnow_payments", "dummy_passthrough_card_payments", "edenred_payments", "eps_payments", "fpx_payments", "fr_meal_voucher_conecs_payments", "fund_and_send", "funding_credit", "gb_bank_transfer_payments", "getbalance_payments", "giropay_payments", "gopay_payments", "grabpay_payments", "id_bank_transfer_payments", "id_bank_transfer_payments_bca", "id_credit_transfer_payments", "ideal_payments", "india_international_payments", "jcb_payments", "jp_bank_transfer_payments", "kakao_pay_payments", "klarna_payments", "konbini_payments", "kr_card_payments", "kr_market_payments", "kriya_payments", "legacy_payments", "link_payments", "loans", "mb_way_payments", "meta_pay_payments", "mobilepay_payments", "mondu_payments", "multibanco_payments", "mx_bank_transfer_payments", "naver_pay_payments", "netbanking_payments", "ng_bank_payments", "ng_bank_transfer_payments", "ng_card_payments", "ng_market_payments", "ng_ussd_payments", "ng_wallet_payments", "nz_bank_account_becs_debit_payments", "nz_bank_transfer_payments", "octopus_payments", "oxxo_payments", "p24_payments", "pay_by_bank_payments", "payco_payments", "payments", "paynow_payments", "paypal_payments", "paypay_payments", "payto_payments", "pix_payments", "promptpay_payments", "qris_payments", "rechnung_payments", "revolut_pay_payments", "samsung_pay_payments", "satispay_payments", "scalapay_payments", "sepa_bank_transfer_payments", "sepa_debit_payments", "sequra_payments", "shop_pay_payments", "shopeepay_payments", "sofort_payments", "south_korea_market_payments", "stripe_balance_payments", "stripe_funded_fee_credits", "submerchant_payments", "sunbit_payments", "swish_payments", "tax_reporting_us_1099_k", "tax_reporting_us_1099_misc", "transfers", "treasury", "treasury_evolve", "treasury_fifth_third", "treasury_goldman_sachs", "twint_payments", "upi_payments", "us_bank_account_ach_payments", "us_bank_transfer_payments", "us_cash_voucher_transfers", "us_paper_check_payments", "vipps_payments", "wechat_pay_payments", "zip_payments" ] }, "company": { "description": "Information about the company or business. This field is available for any `business_type`. Once you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.", "properties": { "address": { "description": "The company's primary address.", "properties": { "city": { "description": "City, district, suburb, town, or village.", "maxLength": 100, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Address line 1 (e.g., street, PO Box, or company name).", "maxLength": 200, "type": "string" }, "line2": { "description": "Address line 2 (e.g., apartment, suite, unit, or building).", "maxLength": 200, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "State, county, province, or region.", "maxLength": 5000, "type": "string" } }, "title": "legal_entity_and_kyc_address_specs", "type": "object", "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state" ] }, "address_kana": { "description": "The Kana variation of the company's primary address (Japan only).", "properties": { "city": { "description": "City or ward.", "maxLength": 5000, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Block or building number.", "maxLength": 5000, "type": "string" }, "line2": { "description": "Building details.", "maxLength": 5000, "type": "string" }, "postal_code": { "description": "Postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "Prefecture.", "maxLength": 5000, "type": "string" }, "town": { "description": "Town or cho-me.", "maxLength": 5000, "type": "string" } }, "title": "japan_address_kana_specs", "type": "object", "x-stripeMostCommon": [ "city", "country", "db_code", "line1", "line2", "postal_code", "state", "town" ] }, "address_kanji": { "description": "The Kanji variation of the company's primary address (Japan only).", "properties": { "city": { "description": "City or ward.", "maxLength": 5000, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Block or building number.", "maxLength": 5000, "type": "string" }, "line2": { "description": "Building details.", "maxLength": 5000, "type": "string" }, "postal_code": { "description": "Postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "Prefecture.", "maxLength": 5000, "type": "string" }, "town": { "description": "Town or cho-me.", "maxLength": 5000, "type": "string" } }, "title": "japan_address_kanji_specs", "type": "object", "x-stripeMostCommon": [ "city", "country", "db_code", "line1", "line2", "postal_code", "state", "town" ] }, "directors_provided": { "description": "Whether the company's directors have been provided. Set this Boolean to `true` after creating all the company's directors with [the Persons API](/api/persons) for accounts with a `relationship.director` requirement. This value is not automatically set to `true` after creating directors, so it needs to be updated to indicate all directors have been provided.", "type": "boolean" }, "directorship_declaration": { "description": "This hash is used to attest that the directors information provided to Stripe is both current and correct.", "properties": { "date": { "description": "The Unix timestamp marking when the directorship declaration attestation was made.", "format": "unix-time", "type": "integer" }, "ip": { "description": "The IP address from which the directorship declaration attestation was made.", "type": "string" }, "user_agent": { "description": "The user agent of the browser from which the directorship declaration attestation was made.", "maxLength": 5000, "type": "string" } }, "title": "company_directorship_declaration", "type": "object", "x-stripeMostCommon": [ "date", "ip", "user_agent" ] }, "executives_provided": { "description": "Whether the company's executives have been provided. Set this Boolean to `true` after creating all the company's executives with [the Persons API](/api/persons) for accounts with a `relationship.executive` requirement.", "type": "boolean" }, "export_license_id": { "description": "The export license ID number of the company, also referred as Import Export Code (India only).", "maxLength": 5000, "type": "string" }, "export_purpose_code": { "description": "The purpose code to use for export transactions (India only).", "maxLength": 5000, "type": "string" }, "name": { "description": "The company's legal name.", "maxLength": 100, "type": "string" }, "name_kana": { "description": "The Kana variation of the company's legal name (Japan only).", "maxLength": 100, "type": "string" }, "name_kanji": { "description": "The Kanji variation of the company's legal name (Japan only).", "maxLength": 100, "type": "string" }, "owners_provided": { "description": "Whether the company's owners have been provided. Set this Boolean to `true` after creating all the company's owners with [the Persons API](/api/persons) for accounts with a `relationship.owner` requirement.", "type": "boolean" }, "ownership_declaration": { "description": "This hash is used to attest that the beneficial owner information provided to Stripe is both current and correct.", "properties": { "date": { "description": "The Unix timestamp marking when the beneficial owner attestation was made.", "format": "unix-time", "type": "integer" }, "ip": { "description": "The IP address from which the beneficial owner attestation was made.", "type": "string" }, "user_agent": { "description": "The user agent of the browser from which the beneficial owner attestation was made.", "maxLength": 5000, "type": "string" } }, "title": "company_ownership_declaration", "type": "object", "x-stripeMostCommon": [ "date", "ip", "user_agent" ] }, "ownership_exemption_reason": { "description": "This value is used to determine if a business is exempt from providing ultimate beneficial owners. See [this support article](https://support.stripe.com/questions/exemption-from-providing-ownership-details) and [changelog](https://docs.stripe.com/changelog/acacia/2025-01-27/ownership-exemption-reason-accounts-api) for more details.", "enum": [ "", "qualified_entity_exceeds_ownership_threshold", "qualifies_as_financial_institution" ], "type": "string" }, "phone": { "description": "The company's phone number (used for verification).", "maxLength": 5000, "type": "string" }, "registration_date": { "anyOf": [ { "properties": { "day": { "description": "The day of registration, between 1 and 31.", "type": "integer" }, "month": { "description": "The month of registration, between 1 and 12.", "type": "integer" }, "year": { "description": "The four-digit year of registration.", "type": "integer" } }, "required": [ "day", "month", "year" ], "title": "registration_date_specs", "type": "object", "x-stripeMostCommon": [ "day", "month", "year" ] }, { "enum": [ "" ], "type": "string" } ] }, "registration_number": { "description": "The identification number given to a company when it is registered or incorporated, if distinct from the identification number used for filing taxes. (Examples are the CIN for companies and LLP IN for partnerships in India, and the Company Registration Number in Hong Kong).", "maxLength": 5000, "type": "string" }, "structure": { "description": "The category identifying the legal structure of the company or legal entity. See [Business structure](/connect/identity-verification#business-structure) for more details. Pass an empty string to unset this value.", "enum": [ "", "free_zone_establishment", "free_zone_llc", "government_instrumentality", "governmental_unit", "incorporated_non_profit", "incorporated_partnership", "limited_liability_partnership", "llc", "multi_member_llc", "private_company", "private_corporation", "private_partnership", "public_company", "public_corporation", "public_partnership", "registered_charity", "single_member_llc", "sole_establishment", "sole_proprietorship", "tax_exempt_government_instrumentality", "unincorporated_association", "unincorporated_non_profit", "unincorporated_partnership" ], "type": "string", "x-stripeBypassValidation": true }, "tax_id": { "description": "The business ID number of the company, as appropriate for the company’s country. (Examples are an Employer ID Number in the U.S., a Business Number in Canada, or a Company Number in the UK.)", "maxLength": 5000, "type": "string" }, "tax_id_registrar": { "description": "The jurisdiction in which the `tax_id` is registered (Germany-based companies only).", "maxLength": 5000, "type": "string" }, "vat_id": { "description": "The VAT number of the company.", "maxLength": 5000, "type": "string" }, "verification": { "description": "Information on the verification state of the company.", "properties": { "document": { "description": "A document verifying the business.", "properties": { "back": { "description": "The back of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `additional_verification`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.", "maxLength": 500, "type": "string" }, "front": { "description": "The front of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `additional_verification`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.", "maxLength": 500, "type": "string" } }, "title": "verification_document_specs", "type": "object", "x-stripeMostCommon": [ "back", "front" ] } }, "title": "verification_specs", "type": "object", "x-stripeMostCommon": [ "document" ] } }, "title": "company_update_specs", "type": "object", "x-stripeMostCommon": [ "address", "address_kana", "address_kanji", "contact_point_verification_address", "cross_border_transaction_classifications", "directors_provided", "directorship_declaration", "executives_provided", "export_license_id", "export_purpose_code", "fiscal_code", "invoicing_recipient_code", "name", "name_kana", "name_kanji", "owners_provided", "ownership_declaration", "ownership_exemption_reason", "pan", "phone", "registered_email", "registration_date", "registration_number", "stock_data", "structure", "tax_deduction_account_number", "tax_id", "tax_id_registrar", "trust_owned", "vat_id", "vat_registration_status", "verification" ] }, "default_currency": { "description": "Three-letter ISO currency code representing the default currency for the account. This must be a currency that [Stripe supports in the account's country](https://docs.stripe.com/payouts).", "format": "currency", "type": "string" }, "documents": { "description": "Documents that may be submitted to satisfy various informational requests.", "properties": { "bank_account_ownership_verification": { "description": "One or more documents that support the [Bank account ownership verification](https://support.stripe.com/questions/bank-account-ownership-verification) requirement. Must be a document associated with the account’s primary active bank account that displays the last 4 digits of the account number, either a statement or a check.", "properties": { "files": { "description": "One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.", "items": { "maxLength": 500, "type": "string" }, "type": "array" } }, "title": "documents_param", "type": "object", "x-stripeMostCommon": [ "files" ] }, "company_license": { "description": "One or more documents that demonstrate proof of a company's license to operate.", "properties": { "files": { "description": "One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.", "items": { "maxLength": 500, "type": "string" }, "type": "array" } }, "title": "documents_param", "type": "object", "x-stripeMostCommon": [ "files" ] }, "company_memorandum_of_association": { "description": "One or more documents showing the company's Memorandum of Association.", "properties": { "files": { "description": "One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.", "items": { "maxLength": 500, "type": "string" }, "type": "array" } }, "title": "documents_param", "type": "object", "x-stripeMostCommon": [ "files" ] }, "company_ministerial_decree": { "description": "(Certain countries only) One or more documents showing the ministerial decree legalizing the company's establishment.", "properties": { "files": { "description": "One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.", "items": { "maxLength": 500, "type": "string" }, "type": "array" } }, "title": "documents_param", "type": "object", "x-stripeMostCommon": [ "files" ] }, "company_registration_verification": { "description": "One or more documents that demonstrate proof of a company's registration with the appropriate local authorities.", "properties": { "files": { "description": "One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.", "items": { "maxLength": 500, "type": "string" }, "type": "array" } }, "title": "documents_param", "type": "object", "x-stripeMostCommon": [ "files" ] }, "company_tax_id_verification": { "description": "One or more documents that demonstrate proof of a company's tax ID.", "properties": { "files": { "description": "One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.", "items": { "maxLength": 500, "type": "string" }, "type": "array" } }, "title": "documents_param", "type": "object", "x-stripeMostCommon": [ "files" ] }, "proof_of_address": { "description": "One or more documents that demonstrate proof of address.", "properties": { "files": { "description": "One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.", "items": { "maxLength": 500, "type": "string" }, "type": "array" } }, "title": "documents_param", "type": "object", "x-stripeMostCommon": [ "files" ] }, "proof_of_registration": { "description": "One or more documents showing the company’s proof of registration with the national business registry.", "properties": { "files": { "description": "One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.", "items": { "maxLength": 500, "type": "string" }, "type": "array" } }, "title": "documents_param", "type": "object", "x-stripeMostCommon": [ "files" ] }, "proof_of_ultimate_beneficial_ownership": { "description": "One or more documents that demonstrate proof of ultimate beneficial ownership.", "properties": { "files": { "description": "One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.", "items": { "maxLength": 500, "type": "string" }, "type": "array" } }, "title": "documents_param", "type": "object", "x-stripeMostCommon": [ "files" ] } }, "title": "documents_specs", "type": "object", "x-stripeMostCommon": [ "bank_account_ownership_verification", "company_address_verification", "company_license", "company_memorandum_of_association", "company_ministerial_decree", "company_registration_verification", "company_tax_id_verification", "company_vat_id_verification", "proof_of_address", "proof_of_registration", "proof_of_ultimate_beneficial_ownership" ] }, "email": { "description": "The email address of the account holder. This is only to make the account easier to identify to you. If [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts, Stripe doesn't email the account without your consent.", "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "external_account": { "description": "A card or bank account to attach to the account for receiving [payouts](/connect/bank-debit-card-payouts) (you won’t be able to use it for top-ups). You can provide either a token, like the ones returned by [Stripe.js](/js), or a dictionary, as documented in the `external_account` parameter for [bank account](/api#account_create_bank_account) creation.

By default, providing an external account sets it as the new default external account for its currency, and deletes the old default if one exists. To add additional external accounts without replacing the existing default for the currency, use the [bank account](/api#account_create_bank_account) or [card creation](/api#account_create_card) APIs. After you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.", "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true }, "groups": { "description": "A hash of account group type to tokens. These are account groups this account should be added to.", "properties": { "payments_pricing": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "The group the account is in to determine their payments pricing, and null if the account is on customized pricing. [See the Platform pricing tool documentation](https://stripe.com/docs/connect/platform-pricing-tools) for details." } }, "title": "account_groups_specs", "type": "object", "x-stripeMostCommon": [ "payments_pricing" ] }, "individual": { "description": "Information about the person represented by the account. This field is null unless `business_type` is set to `individual`. Once you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.", "properties": { "address": { "description": "The individual's primary address.", "properties": { "city": { "description": "City, district, suburb, town, or village.", "maxLength": 100, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Address line 1 (e.g., street, PO Box, or company name).", "maxLength": 200, "type": "string" }, "line2": { "description": "Address line 2 (e.g., apartment, suite, unit, or building).", "maxLength": 200, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "State, county, province, or region.", "maxLength": 5000, "type": "string" } }, "title": "address_specs", "type": "object", "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state" ] }, "address_kana": { "description": "The Kana variation of the individual's primary address (Japan only).", "properties": { "city": { "description": "City or ward.", "maxLength": 5000, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Block or building number.", "maxLength": 5000, "type": "string" }, "line2": { "description": "Building details.", "maxLength": 5000, "type": "string" }, "postal_code": { "description": "Postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "Prefecture.", "maxLength": 5000, "type": "string" }, "town": { "description": "Town or cho-me.", "maxLength": 5000, "type": "string" } }, "title": "japan_address_kana_specs", "type": "object", "x-stripeMostCommon": [ "city", "country", "db_code", "line1", "line2", "postal_code", "state", "town" ] }, "address_kanji": { "description": "The Kanji variation of the individual's primary address (Japan only).", "properties": { "city": { "description": "City or ward.", "maxLength": 5000, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Block or building number.", "maxLength": 5000, "type": "string" }, "line2": { "description": "Building details.", "maxLength": 5000, "type": "string" }, "postal_code": { "description": "Postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "Prefecture.", "maxLength": 5000, "type": "string" }, "town": { "description": "Town or cho-me.", "maxLength": 5000, "type": "string" } }, "title": "japan_address_kanji_specs", "type": "object", "x-stripeMostCommon": [ "city", "country", "db_code", "line1", "line2", "postal_code", "state", "town" ] }, "dob": { "anyOf": [ { "properties": { "day": { "description": "The day of birth, between 1 and 31.", "type": "integer" }, "month": { "description": "The month of birth, between 1 and 12.", "type": "integer" }, "year": { "description": "The four-digit year of birth.", "type": "integer" } }, "required": [ "day", "month", "year" ], "title": "date_of_birth_specs", "type": "object", "x-stripeMostCommon": [ "day", "month", "year" ] }, { "enum": [ "" ], "type": "string" } ], "description": "The individual's date of birth." }, "email": { "description": "The individual's email address.", "type": "string" }, "first_name": { "description": "The individual's first name.", "maxLength": 100, "type": "string" }, "first_name_kana": { "description": "The Kana variation of the individual's first name (Japan only).", "maxLength": 5000, "type": "string" }, "first_name_kanji": { "description": "The Kanji variation of the individual's first name (Japan only).", "maxLength": 5000, "type": "string" }, "full_name_aliases": { "anyOf": [ { "items": { "maxLength": 300, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "A list of alternate names or aliases that the individual is known by." }, "gender": { "description": "The individual's gender", "type": "string" }, "id_number": { "description": "The government-issued ID number of the individual, as appropriate for the representative's country. (Examples are a Social Security Number in the U.S., or a Social Insurance Number in Canada). Instead of the number itself, you can also provide a [PII token created with Stripe.js](/js/tokens/create_token?type=pii).", "maxLength": 5000, "type": "string" }, "id_number_secondary": { "description": "The government-issued secondary ID number of the individual, as appropriate for the representative's country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token created with Stripe.js](/js/tokens/create_token?type=pii).", "maxLength": 5000, "type": "string" }, "last_name": { "description": "The individual's last name.", "maxLength": 100, "type": "string" }, "last_name_kana": { "description": "The Kana variation of the individual's last name (Japan only).", "maxLength": 5000, "type": "string" }, "last_name_kanji": { "description": "The Kanji variation of the individual's last name (Japan only).", "maxLength": 5000, "type": "string" }, "maiden_name": { "description": "The individual's maiden name.", "maxLength": 5000, "type": "string" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "phone": { "description": "The individual's phone number.", "type": "string" }, "political_exposure": { "description": "Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction.", "enum": [ "existing", "none" ], "type": "string" }, "registered_address": { "description": "The individual's registered address.", "properties": { "city": { "description": "City, district, suburb, town, or village.", "maxLength": 100, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Address line 1 (e.g., street, PO Box, or company name).", "maxLength": 200, "type": "string" }, "line2": { "description": "Address line 2 (e.g., apartment, suite, unit, or building).", "maxLength": 200, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "State, county, province, or region.", "maxLength": 5000, "type": "string" } }, "title": "address_specs", "type": "object", "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state" ] }, "relationship": { "description": "Describes the person’s relationship to the account.", "properties": { "director": { "description": "Whether the person is a director of the account's legal entity. Directors are typically members of the governing board of the company, or responsible for ensuring the company meets its regulatory obligations.", "type": "boolean" }, "executive": { "description": "Whether the person has significant responsibility to control, manage, or direct the organization.", "type": "boolean" }, "owner": { "description": "Whether the person is an owner of the account’s legal entity.", "type": "boolean" }, "percent_ownership": { "anyOf": [ { "type": "number" }, { "enum": [ "" ], "type": "string" } ], "description": "The percent owned by the person of the account's legal entity." }, "title": { "description": "The person's title (e.g., CEO, Support Engineer).", "maxLength": 5000, "type": "string" } }, "title": "individual_relationship_specs", "type": "object", "x-stripeMostCommon": [ "controller", "director", "executive", "officer", "owner", "partner", "percent_ownership", "title" ] }, "ssn_last_4": { "description": "The last four digits of the individual's Social Security Number (U.S. only).", "maxLength": 5000, "type": "string" }, "verification": { "description": "The individual's verification document information.", "properties": { "additional_document": { "description": "A document showing address, either a passport, local ID card, or utility bill from a well-known utility company.", "properties": { "back": { "description": "The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.", "maxLength": 500, "type": "string" }, "front": { "description": "The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.", "maxLength": 500, "type": "string" } }, "title": "person_verification_document_specs", "type": "object", "x-stripeMostCommon": [ "back", "electronic_id", "front" ] }, "document": { "description": "An identifying document, either a passport or local ID card.", "properties": { "back": { "description": "The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.", "maxLength": 500, "type": "string" }, "front": { "description": "The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.", "maxLength": 500, "type": "string" } }, "title": "person_verification_document_specs", "type": "object", "x-stripeMostCommon": [ "back", "electronic_id", "front" ] } }, "title": "person_verification_specs", "type": "object", "x-stripeMostCommon": [ "additional_document", "document", "proof_of_liveness" ] } }, "title": "individual_update_specs", "type": "object", "x-stripeMostCommon": [ "address", "address_kana", "address_kanji", "birth_city", "birth_country", "dob", "email", "first_name", "first_name_kana", "first_name_kanji", "full_name_aliases", "gender", "id_number", "id_number_secondary", "last_name", "last_name_kana", "last_name_kanji", "maiden_name", "metadata", "phone", "political_exposure", "registered_address", "relationship", "ssn_last_4", "verification" ] }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "risk_controls": { "description": "A hash to configure risk controls on the account. Please see [this page for more details](/connect/pausing-payments-or-payouts-on-connected-accounts).", "properties": { "charges": { "description": "Represents the risk control status of charges. Please see [this page for more details](https://stripe.com/docs/connect/pausing-payments-or-payouts-on-connected-accounts).", "properties": { "pause_requested": { "description": "To request to pause a risk control, pass `true`. To request to unpause a risk control, pass `false`.\nThere can be a delay before the risk control is paused or unpaused.", "type": "boolean" } }, "title": "risk_control_param", "type": "object", "x-stripeMostCommon": [ "pause_requested" ] }, "payouts": { "description": "Represents the risk control status of payouts. Please see [this page for more details](https://stripe.com/docs/connect/pausing-payments-or-payouts-on-connected-accounts).", "properties": { "pause_requested": { "description": "To request to pause a risk control, pass `true`. To request to unpause a risk control, pass `false`.\nThere can be a delay before the risk control is paused or unpaused.", "type": "boolean" } }, "title": "risk_control_param", "type": "object", "x-stripeMostCommon": [ "pause_requested" ] } }, "title": "risk_controls_hash_param", "type": "object", "x-stripeMostCommon": [ "charges", "payouts", "rejected_reason" ] }, "settings": { "description": "Options for customizing how the account functions within Stripe.", "properties": { "bacs_debit_payments": { "description": "Settings specific to Bacs Direct Debit payments.", "properties": { "display_name": { "description": "The Bacs Direct Debit Display Name for this account. For payments made with Bacs Direct Debit, this name appears on the mandate as the statement descriptor. Mobile banking apps display it as the name of the business. To use custom branding, set the Bacs Direct Debit Display Name during or right after creation. Custom branding incurs an additional monthly fee for the platform. If you don't set the display name before requesting Bacs capability, it's automatically set as \"Stripe\" and the account is onboarded to Stripe branding, which is free.", "type": "string" } }, "title": "bacs_debit_payments_specs", "type": "object", "x-stripeMostCommon": [ "display_name" ] }, "bank_bca_onboarding": { "description": "Settings specific to bank BCA onboarding for Indonesia bank transfers payments method.", "properties": { "account_holder_name": { "description": "Bank BCA business account holder name", "maxLength": 5000, "type": "string" }, "business_account_number": { "description": "Bank BCA business account number", "maxLength": 5000, "type": "string" } }, "title": "bank_bca_onboarding_settings_specs", "type": "object", "x-stripeMostCommon": [ "account_holder_name", "business_account_number" ] }, "branding": { "description": "Settings used to apply the account's branding to email receipts, invoices, Checkout, and other products.", "properties": { "icon": { "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) An icon for the account. Must be square and at least 128px x 128px.", "maxLength": 5000, "type": "string" }, "logo": { "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) A logo for the account that will be used in Checkout instead of the icon and without the account's name next to it if provided. Must be at least 128px x 128px.", "maxLength": 5000, "type": "string" }, "primary_color": { "description": "A CSS hex color value representing the primary branding color for this account.", "maxLength": 5000, "type": "string" }, "secondary_color": { "description": "A CSS hex color value representing the secondary branding color for this account.", "maxLength": 5000, "type": "string" } }, "title": "branding_settings_specs", "type": "object", "x-stripeMostCommon": [ "icon", "logo", "primary_color", "secondary_color", "show_support_phone" ] }, "capital": { "description": "Settings specific to the account's use of the Capital product.", "properties": { "payout_destination": { "additionalProperties": { "maxLength": 5000, "type": "string" }, "description": "Per-currency mapping of user-selected destination accounts used to pay out loans.", "type": "object" }, "payout_destination_selector": { "additionalProperties": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "description": "Per-currency mapping of all destination accounts eligible to receive Capital financing payouts.", "type": "object" } }, "title": "capital_settings_specs", "type": "object", "x-stripeMostCommon": [ "payout_destination", "payout_destination_selector" ] }, "card_issuing": { "description": "Settings specific to the account's use of the Card Issuing product.", "properties": { "tos_acceptance": { "description": "Details on the account's acceptance of the [Stripe Issuing Terms and Disclosures](/issuing/connect/tos_acceptance).", "properties": { "date": { "description": "The Unix timestamp marking when the account representative accepted the service agreement.", "format": "unix-time", "type": "integer" }, "ip": { "description": "The IP address from which the account representative accepted the service agreement.", "type": "string" }, "user_agent": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "The user agent of the browser from which the account representative accepted the service agreement." } }, "title": "settings_terms_of_service_specs", "type": "object", "x-stripeMostCommon": [ "date", "ip", "user_agent" ] } }, "title": "card_issuing_settings_specs", "type": "object", "x-stripeMostCommon": [ "tos_acceptance", "tos_acceptances" ] }, "card_payments": { "description": "Settings specific to card charging on the account.", "properties": { "decline_on": { "description": "Automatically declines certain charge types regardless of whether the card issuer accepted or declined the charge.", "properties": { "avs_failure": { "description": "Whether Stripe automatically declines charges with an incorrect ZIP or postal code. This setting only applies when a ZIP or postal code is provided and they fail bank verification.", "type": "boolean" }, "cvc_failure": { "description": "Whether Stripe automatically declines charges with an incorrect CVC. This setting only applies when a CVC is provided and it fails bank verification.", "type": "boolean" } }, "title": "decline_charge_on_specs", "type": "object", "x-stripeMostCommon": [ "avs_failure", "cvc_failure" ] }, "statement_descriptor_prefix": { "description": "The default text that appears on credit card statements when a charge is made. This field prefixes any dynamic `statement_descriptor` specified on the charge. `statement_descriptor_prefix` is useful for maximizing descriptor space for the dynamic portion.", "maxLength": 10, "type": "string" }, "statement_descriptor_prefix_kana": { "anyOf": [ { "maxLength": 10, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "The Kana variation of the default text that appears on credit card statements when a charge is made (Japan only). This field prefixes any dynamic `statement_descriptor_suffix_kana` specified on the charge. `statement_descriptor_prefix_kana` is useful for maximizing descriptor space for the dynamic portion." }, "statement_descriptor_prefix_kanji": { "anyOf": [ { "maxLength": 10, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "The Kanji variation of the default text that appears on credit card statements when a charge is made (Japan only). This field prefixes any dynamic `statement_descriptor_suffix_kanji` specified on the charge. `statement_descriptor_prefix_kanji` is useful for maximizing descriptor space for the dynamic portion." } }, "title": "card_payments_settings_specs", "type": "object", "x-stripeMostCommon": [ "decline_on", "onboarding_policy", "statement_descriptor_prefix", "statement_descriptor_prefix_kana", "statement_descriptor_prefix_kanji" ] }, "invoices": { "description": "Settings specific to the account's use of Invoices.", "properties": { "default_account_tax_ids": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The list of default Account Tax IDs to automatically include on invoices. Account Tax IDs get added when an invoice is finalized." }, "hosted_payment_method_save": { "description": "Whether payment methods should be saved when a payment is completed for a one-time invoices on a hosted invoice page.", "enum": [ "always", "never", "offer" ], "type": "string" } }, "title": "invoices_settings_specs", "type": "object", "x-stripeMostCommon": [ "default_account_tax_ids", "hosted_payment_method_save" ] }, "payments": { "description": "Settings that apply across payment methods for charging on the account.", "properties": { "statement_descriptor": { "description": "The default text that appears on statements for non-card charges outside of Japan. For card charges, if you don't set a `statement_descriptor_prefix`, this text is also used as the statement descriptor prefix. In that case, if concatenating the statement descriptor suffix causes the combined statement descriptor to exceed 22 characters, we truncate the `statement_descriptor` text to limit the full descriptor to 22 characters. For more information about statement descriptors and their requirements, see the [account settings documentation](https://docs.stripe.com/get-started/account/statement-descriptors).", "maxLength": 22, "type": "string" }, "statement_descriptor_kana": { "description": "The Kana variation of `statement_descriptor` used for charges in Japan. Japanese statement descriptors have [special requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors).", "maxLength": 22, "type": "string" }, "statement_descriptor_kanji": { "description": "The Kanji variation of `statement_descriptor` used for charges in Japan. Japanese statement descriptors have [special requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors).", "maxLength": 22, "type": "string" } }, "title": "payments_settings_specs", "type": "object", "x-stripeMostCommon": [ "statement_descriptor", "statement_descriptor_kana", "statement_descriptor_kanji" ] }, "payouts": { "description": "Settings specific to the account's payouts.", "properties": { "debit_negative_balances": { "description": "A Boolean indicating whether Stripe should try to reclaim negative balances from an attached bank account. For details, see [Understanding Connect Account Balances](/connect/account-balances).", "type": "boolean" }, "schedule": { "description": "Details on when funds from charges are available, and when they are paid out to an external account. For details, see our [Setting Bank and Debit Card Payouts](/connect/bank-transfers#payout-information) documentation.", "properties": { "delay_days": { "anyOf": [ { "enum": [ "minimum" ], "maxLength": 5000, "type": "string" }, { "type": "integer" } ], "description": "The number of days charge funds are held before being paid out. May also be set to `minimum`, representing the lowest available value for the account country. Default is `minimum`. The `delay_days` parameter remains at the last configured value if `interval` is `manual`. [Learn more about controlling payout delay days](/connect/manage-payout-schedule)." }, "interval": { "description": "How frequently available funds are paid out. One of: `daily`, `manual`, `weekly`, or `monthly`. Default is `daily`.", "enum": [ "daily", "manual", "monthly", "weekly" ], "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true }, "monthly_anchor": { "description": "The day of the month when available funds are paid out, specified as a number between 1--31. Payouts nominally scheduled between the 29th and 31st of the month are instead sent on the last day of a shorter month. Required and applicable only if `interval` is `monthly`.", "type": "integer" }, "monthly_payout_days": { "description": "The days of the month when available funds are paid out, specified as an array of numbers between 1--31. Payouts nominally scheduled between the 29th and 31st of the month are instead sent on the last day of a shorter month. Required and applicable only if `interval` is `monthly` and `monthly_anchor` is not set.", "items": { "type": "integer" }, "type": "array" }, "weekly_anchor": { "description": "The day of the week when available funds are paid out, specified as `monday`, `tuesday`, etc. Required and applicable only if `interval` is `weekly`.", "enum": [ "friday", "monday", "saturday", "sunday", "thursday", "tuesday", "wednesday" ], "maxLength": 5000, "type": "string" }, "weekly_payout_days": { "description": "The days of the week when available funds are paid out, specified as an array, e.g., [`monday`, `tuesday`]. Required and applicable only if `interval` is `weekly`.", "items": { "enum": [ "friday", "monday", "thursday", "tuesday", "wednesday" ], "type": "string", "x-stripeBypassValidation": true }, "type": "array" } }, "title": "transfer_schedule_specs", "type": "object", "x-stripeMostCommon": [ "automatic", "delay_days", "interval", "monthly_anchor", "monthly_payout_days", "timezone", "weekly_anchor", "weekly_payout_days" ] }, "statement_descriptor": { "description": "The text that appears on the bank account statement for payouts. If not set, this defaults to the platform's bank descriptor as set in the Dashboard.", "maxLength": 22, "type": "string" } }, "title": "payout_settings_specs", "type": "object", "x-stripeMostCommon": [ "debit_negative_balances", "schedule", "statement_descriptor" ] }, "tax_forms": { "description": "Settings specific to the account's tax forms.", "properties": { "consented_to_paperless_delivery": { "description": "Whether the account opted out of receiving their tax forms by postal delivery.", "type": "boolean" } }, "title": "tax_form_settings_param", "type": "object", "x-stripeMostCommon": [ "consented_to_paperless_delivery" ] }, "treasury": { "description": "Settings specific to the account's Treasury FinancialAccounts.", "properties": { "tos_acceptance": { "description": "Details on the account's acceptance of the Stripe Treasury Services Agreement.", "properties": { "date": { "description": "The Unix timestamp marking when the account representative accepted the service agreement.", "format": "unix-time", "type": "integer" }, "ip": { "description": "The IP address from which the account representative accepted the service agreement.", "type": "string" }, "user_agent": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "The user agent of the browser from which the account representative accepted the service agreement." } }, "title": "settings_terms_of_service_specs", "type": "object", "x-stripeMostCommon": [ "date", "ip", "user_agent" ] } }, "title": "treasury_settings_specs", "type": "object", "x-stripeMostCommon": [ "tos_acceptance" ] } }, "title": "settings_specs_update", "type": "object", "x-stripeMostCommon": [ "affirm_payments", "bacs_debit_payments", "bank_bca_onboarding", "branding", "capital", "card_issuing", "card_issuing_charge_card", "card_issuing_payout", "card_payments", "crypto_payments", "fund_and_send", "funding_credit", "invoices", "konbini_payments", "payments", "payouts", "tax_forms", "treasury" ] }, "tos_acceptance": { "description": "Details on the account's acceptance of the [Stripe Services Agreement](/connect/updating-accounts#tos-acceptance). This property can only be updated for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. This property defaults to a `full` service agreement when empty.", "properties": { "date": { "description": "The Unix timestamp marking when the account representative accepted their service agreement.", "format": "unix-time", "type": "integer" }, "ip": { "description": "The IP address from which the account representative accepted their service agreement.", "type": "string" }, "service_agreement": { "description": "The user's service agreement type.", "maxLength": 5000, "type": "string" }, "user_agent": { "description": "The user agent of the browser from which the account representative accepted their service agreement.", "maxLength": 5000, "type": "string" } }, "title": "tos_acceptance_specs", "type": "object", "x-stripeMostCommon": [ "date", "ip", "service_agreement", "user_agent" ] } }, "type": "object", "x-stripeMostCommon": [ "business_type", "capabilities", "company", "email", "individual", "metadata", "tos_acceptance" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/account" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update an account" } }, "/v1/accounts/{account}/capabilities": { "get": { "description": "

Returns a list of capabilities associated with the account. The capabilities are returned sorted by creation date, with the most recent capability appearing first.

", "operationId": "GetAccountsAccountCapabilities", "parameters": [ { "in": "path", "name": "account", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/capability" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "ListAccountCapability", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all account capabilities" } }, "/v1/accounts/{account}/capabilities/{capability}": { "get": { "description": "

Retrieves information about the specified Account Capability.

", "operationId": "GetAccountsAccountCapabilitiesCapability", "parameters": [ { "in": "path", "name": "account", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "in": "path", "name": "capability", "required": true, "schema": { "type": "string" }, "style": "simple" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve an Account Capability" }, "post": { "description": "

Updates an existing Account Capability. Request or remove a capability by updating its requested parameter.

", "operationId": "PostAccountsAccountCapabilitiesCapability", "parameters": [ { "in": "path", "name": "account", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "in": "path", "name": "capability", "required": true, "schema": { "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "requested": { "description": "To request a new capability for an account, pass true. There can be a delay before the requested capability becomes active. If the capability has any activation requirements, the response includes them in the `requirements` arrays.\n\nIf a capability isn't permanent, you can remove it from the account by passing false. Some capabilities are permanent after they've been requested. Attempting to remove a permanent capability returns an error.", "type": "boolean" } }, "type": "object", "x-stripeMostCommon": [ "requested" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update an Account Capability" } }, "/v1/accounts/{account}/external_accounts": { "get": { "description": "

List external accounts for an account.

", "operationId": "GetAccountsAccountExternalAccounts", "parameters": [ { "in": "path", "name": "account", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "Filter external accounts according to a particular object type.", "in": "query", "name": "object", "required": false, "schema": { "enum": [ "bank_account", "card" ], "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true, "x-stripeParam": { "class_name": "object_type" } }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "description": "The list contains all external accounts that have been attached to the Stripe account. These may be bank accounts or cards.", "items": { "$ref": "#/components/schemas/external_account" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "ExternalAccountList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all external accounts" }, "post": { "description": "

Create an external account for a given account.

", "operationId": "PostAccountsAccountExternalAccounts", "parameters": [ { "in": "path", "name": "account", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "default_for_currency": { "description": "When set to true, or if this is the first external account added in this currency, this account becomes the default external account for its currency.", "type": "boolean" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "external_account": { "description": "A token, like the ones returned by [Stripe.js](https://stripe.com/docs/js) or a dictionary containing a user's external account details (with the options shown below). Please refer to full [documentation](https://stripe.com/docs/api/external_accounts) instead.", "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" } }, "required": [ "external_account" ], "type": "object", "x-stripeMostCommon": [ "external_account", "metadata" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/external_account" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create an external account" } }, "/v1/accounts/{account}/external_accounts/{id}": { "delete": { "description": "

Delete a specified external account for a given account.

", "operationId": "DeleteAccountsAccountExternalAccountsId", "parameters": [ { "in": "path", "name": "account", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "description": "Unique identifier for the external account to be deleted.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted_external_account" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Delete an external account" }, "get": { "description": "

Retrieve a specified external account for a given account.

", "operationId": "GetAccountsAccountExternalAccountsId", "parameters": [ { "in": "path", "name": "account", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "Unique identifier for the external account to be retrieved.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/external_account" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve an external account" }, "post": { "description": "

Updates the metadata, account holder name, account holder type of a bank account belonging to\na connected account and optionally sets it as the default for its currency. Other bank account\ndetails are not editable by design.

\n\n

You can only update bank accounts when account.controller.requirement_collection is application, which includes Custom accounts.

\n\n

You can re-enable a disabled bank account by performing an update call without providing any\narguments or changes.

", "operationId": "PostAccountsAccountExternalAccountsId", "parameters": [ { "in": "path", "name": "account", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "documents": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "account_holder_name": { "description": "The name of the person or business that owns the bank account.", "maxLength": 5000, "type": "string" }, "account_holder_type": { "description": "The type of entity that holds the account. This can be either `individual` or `company`.", "enum": [ "", "company", "individual" ], "maxLength": 5000, "type": "string" }, "account_type": { "description": "The bank account type. This can only be `checking` or `savings` in most countries. In Japan, this can only be `futsu` or `toza`.", "enum": [ "checking", "futsu", "savings", "toza" ], "maxLength": 5000, "type": "string" }, "address_city": { "description": "City/District/Suburb/Town/Village.", "maxLength": 5000, "type": "string" }, "address_country": { "description": "Billing address country, if provided when creating card.", "maxLength": 5000, "type": "string" }, "address_line1": { "description": "Address line 1 (Street address/PO Box/Company name).", "maxLength": 5000, "type": "string" }, "address_line2": { "description": "Address line 2 (Apartment/Suite/Unit/Building).", "maxLength": 5000, "type": "string" }, "address_state": { "description": "State/County/Province/Region.", "maxLength": 5000, "type": "string" }, "address_zip": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "default_for_currency": { "description": "When set to true, this becomes the default external account for its currency.", "type": "boolean" }, "documents": { "description": "Documents that may be submitted to satisfy various informational requests.", "properties": { "bank_account_ownership_verification": { "description": "One or more documents that support the [Bank account ownership verification](https://support.stripe.com/questions/bank-account-ownership-verification) requirement. Must be a document associated with the bank account that displays the last 4 digits of the account number, either a statement or a check.", "properties": { "files": { "description": "One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.", "items": { "maxLength": 500, "type": "string" }, "type": "array" } }, "title": "documents_param", "type": "object", "x-stripeMostCommon": [ "files" ] } }, "title": "external_account_documents_param", "type": "object", "x-stripeMostCommon": [ "bank_account_ownership_verification" ] }, "exp_month": { "description": "Two digit number representing the card’s expiration month.", "maxLength": 5000, "type": "string" }, "exp_year": { "description": "Four digit number representing the card’s expiration year.", "maxLength": 5000, "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "name": { "description": "Cardholder name.", "maxLength": 5000, "type": "string" } }, "type": "object", "x-stripeMostCommon": [ "default_for_currency", "metadata" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/external_account" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } } } }, "/v1/accounts/{account}/login_links": { "post": { "description": "

Creates a login link for a connected account to access the Express Dashboard.

\n\n

You can only create login links for accounts that use the Express Dashboard and are connected to your platform.

", "operationId": "PostAccountsAccountLoginLinks", "parameters": [ { "in": "path", "name": "account", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/login_link" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a login link" } }, "/v1/accounts/{account}/persons": { "get": { "description": "

Returns a list of people associated with the account’s legal entity. The people are returned sorted by creation date, with the most recent people appearing first.

", "operationId": "GetAccountsAccountPersons", "parameters": [ { "in": "path", "name": "account", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "Filters on the list of people returned based on the person's relationship to the account's company.", "explode": true, "in": "query", "name": "relationship", "required": false, "schema": { "properties": { "authorizer": { "description": "A filter on the list of people returned based on whether these people are authorizers of the account's representative.", "type": "boolean" }, "director": { "description": "A filter on the list of people returned based on whether these people are directors of the account's company.", "type": "boolean" }, "executive": { "description": "A filter on the list of people returned based on whether these people are executives of the account's company.", "type": "boolean" }, "legal_guardian": { "description": "A filter on the list of people returned based on whether these people are legal guardians of the account's representative.", "type": "boolean" }, "owner": { "description": "A filter on the list of people returned based on whether these people are owners of the account's company.", "type": "boolean" }, "representative": { "description": "A filter on the list of people returned based on whether these people are the representative of the account's company.", "type": "boolean" } }, "title": "all_people_relationship_specs", "type": "object", "x-stripeMostCommon": [ "authorizer", "director", "executive", "legal_guardian", "officer", "owner", "partner", "representative" ] }, "style": "deepObject" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/person" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "PersonList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all persons" }, "post": { "description": "

Creates a new person.

", "operationId": "PostAccountsAccountPersons", "parameters": [ { "in": "path", "name": "account", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "additional_tos_acceptances": { "explode": true, "style": "deepObject" }, "address": { "explode": true, "style": "deepObject" }, "address_kana": { "explode": true, "style": "deepObject" }, "address_kanji": { "explode": true, "style": "deepObject" }, "dob": { "explode": true, "style": "deepObject" }, "documents": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "full_name_aliases": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "registered_address": { "explode": true, "style": "deepObject" }, "relationship": { "explode": true, "style": "deepObject" }, "us_cfpb_data": { "explode": true, "style": "deepObject" }, "verification": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "additional_tos_acceptances": { "description": "Details on the legal guardian's or authorizer's acceptance of the required Stripe agreements.", "properties": { "account": { "description": "Details on the legal guardian's acceptance of the main Stripe service agreement.", "properties": { "date": { "description": "The Unix timestamp marking when the account representative accepted the service agreement.", "format": "unix-time", "type": "integer" }, "ip": { "description": "The IP address from which the account representative accepted the service agreement.", "type": "string" }, "user_agent": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "The user agent of the browser from which the account representative accepted the service agreement." } }, "title": "settings_terms_of_service_specs", "type": "object", "x-stripeMostCommon": [ "date", "ip", "user_agent" ] } }, "title": "person_additional_tos_acceptances_specs", "type": "object", "x-stripeMostCommon": [ "account", "representative" ] }, "address": { "description": "The person's address.", "properties": { "city": { "description": "City, district, suburb, town, or village.", "maxLength": 100, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Address line 1 (e.g., street, PO Box, or company name).", "maxLength": 200, "type": "string" }, "line2": { "description": "Address line 2 (e.g., apartment, suite, unit, or building).", "maxLength": 200, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "State, county, province, or region.", "maxLength": 5000, "type": "string" } }, "title": "legal_entity_and_kyc_address_specs", "type": "object", "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state" ] }, "address_kana": { "description": "The Kana variation of the person's address (Japan only).", "properties": { "city": { "description": "City or ward.", "maxLength": 5000, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Block or building number.", "maxLength": 5000, "type": "string" }, "line2": { "description": "Building details.", "maxLength": 5000, "type": "string" }, "postal_code": { "description": "Postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "Prefecture.", "maxLength": 5000, "type": "string" }, "town": { "description": "Town or cho-me.", "maxLength": 5000, "type": "string" } }, "title": "japan_address_kana_specs", "type": "object", "x-stripeMostCommon": [ "city", "country", "db_code", "line1", "line2", "postal_code", "state", "town" ] }, "address_kanji": { "description": "The Kanji variation of the person's address (Japan only).", "properties": { "city": { "description": "City or ward.", "maxLength": 5000, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Block or building number.", "maxLength": 5000, "type": "string" }, "line2": { "description": "Building details.", "maxLength": 5000, "type": "string" }, "postal_code": { "description": "Postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "Prefecture.", "maxLength": 5000, "type": "string" }, "town": { "description": "Town or cho-me.", "maxLength": 5000, "type": "string" } }, "title": "japan_address_kanji_specs", "type": "object", "x-stripeMostCommon": [ "city", "country", "db_code", "line1", "line2", "postal_code", "state", "town" ] }, "dob": { "anyOf": [ { "properties": { "day": { "description": "The day of birth, between 1 and 31.", "type": "integer" }, "month": { "description": "The month of birth, between 1 and 12.", "type": "integer" }, "year": { "description": "The four-digit year of birth.", "type": "integer" } }, "required": [ "day", "month", "year" ], "title": "date_of_birth_specs", "type": "object", "x-stripeMostCommon": [ "day", "month", "year" ] }, { "enum": [ "" ], "type": "string" } ], "description": "The person's date of birth." }, "documents": { "description": "Documents that may be submitted to satisfy various informational requests.", "properties": { "company_authorization": { "description": "One or more documents that demonstrate proof that this person is authorized to represent the company.", "properties": { "files": { "description": "One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.", "items": { "anyOf": [ { "maxLength": 500, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "type": "array" } }, "title": "documents_param", "type": "object", "x-stripeMostCommon": [ "files" ] }, "passport": { "description": "One or more documents showing the person's passport page with photo and personal data.", "properties": { "files": { "description": "One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.", "items": { "anyOf": [ { "maxLength": 500, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "type": "array" } }, "title": "documents_param", "type": "object", "x-stripeMostCommon": [ "files" ] }, "visa": { "description": "One or more documents showing the person's visa required for living in the country where they are residing.", "properties": { "files": { "description": "One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.", "items": { "anyOf": [ { "maxLength": 500, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "type": "array" } }, "title": "documents_param", "type": "object", "x-stripeMostCommon": [ "files" ] } }, "title": "person_documents_specs", "type": "object", "x-stripeMostCommon": [ "DASHBOARD_proof_of_liveness", "company_authorization", "passport", "visa" ] }, "email": { "description": "The person's email address.", "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "first_name": { "description": "The person's first name.", "maxLength": 5000, "type": "string" }, "first_name_kana": { "description": "The Kana variation of the person's first name (Japan only).", "maxLength": 5000, "type": "string" }, "first_name_kanji": { "description": "The Kanji variation of the person's first name (Japan only).", "maxLength": 5000, "type": "string" }, "full_name_aliases": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "A list of alternate names or aliases that the person is known by." }, "gender": { "description": "The person's gender (International regulations require either \"male\" or \"female\").", "type": "string" }, "id_number": { "description": "The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii).", "maxLength": 5000, "type": "string" }, "id_number_secondary": { "description": "The person's secondary ID number, as appropriate for their country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii).", "maxLength": 5000, "type": "string" }, "last_name": { "description": "The person's last name.", "maxLength": 5000, "type": "string" }, "last_name_kana": { "description": "The Kana variation of the person's last name (Japan only).", "maxLength": 5000, "type": "string" }, "last_name_kanji": { "description": "The Kanji variation of the person's last name (Japan only).", "maxLength": 5000, "type": "string" }, "maiden_name": { "description": "The person's maiden name.", "maxLength": 5000, "type": "string" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "nationality": { "description": "The country where the person is a national. Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)), or \"XX\" if unavailable.", "maxLength": 5000, "type": "string" }, "person_token": { "description": "A [person token](https://docs.stripe.com/connect/account-tokens), used to securely provide details to the person.", "maxLength": 5000, "type": "string" }, "phone": { "description": "The person's phone number.", "type": "string" }, "political_exposure": { "description": "Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction.", "enum": [ "existing", "none" ], "type": "string" }, "registered_address": { "description": "The person's registered address.", "properties": { "city": { "description": "City, district, suburb, town, or village.", "maxLength": 100, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Address line 1 (e.g., street, PO Box, or company name).", "maxLength": 200, "type": "string" }, "line2": { "description": "Address line 2 (e.g., apartment, suite, unit, or building).", "maxLength": 200, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "State, county, province, or region.", "maxLength": 5000, "type": "string" } }, "title": "address_specs", "type": "object", "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state" ] }, "relationship": { "description": "The relationship that this person has with the account's legal entity.", "properties": { "authorizer": { "description": "Whether the person is the authorizer of the account's representative.", "type": "boolean" }, "director": { "description": "Whether the person is a director of the account's legal entity. Directors are typically members of the governing board of the company, or responsible for ensuring the company meets its regulatory obligations.", "type": "boolean" }, "executive": { "description": "Whether the person has significant responsibility to control, manage, or direct the organization.", "type": "boolean" }, "legal_guardian": { "description": "Whether the person is the legal guardian of the account's representative.", "type": "boolean" }, "owner": { "description": "Whether the person is an owner of the account’s legal entity.", "type": "boolean" }, "percent_ownership": { "anyOf": [ { "type": "number" }, { "enum": [ "" ], "type": "string" } ], "description": "The percent owned by the person of the account's legal entity." }, "representative": { "description": "Whether the person is authorized as the primary representative of the account. This is the person nominated by the business to provide information about themselves, and general information about the account. There can only be one representative at any given time. At the time the account is created, this person should be set to the person responsible for opening the account.", "type": "boolean" }, "title": { "description": "The person's title (e.g., CEO, Support Engineer).", "maxLength": 5000, "type": "string" } }, "title": "relationship_specs", "type": "object", "x-stripeMostCommon": [ "authorizer", "controller", "director", "executive", "legal_guardian", "officer", "owner", "partner", "percent_ownership", "representative", "title" ] }, "ssn_last_4": { "description": "The last four digits of the person's Social Security number (U.S. only).", "type": "string" }, "us_cfpb_data": { "description": "Demographic data related to the person.", "properties": { "ethnicity_details": { "description": "The persons ethnicity details", "properties": { "ethnicity": { "description": "The persons ethnicity", "items": { "enum": [ "cuban", "hispanic_or_latino", "mexican", "not_hispanic_or_latino", "other_hispanic_or_latino", "prefer_not_to_answer", "puerto_rican" ], "type": "string" }, "type": "array" }, "ethnicity_other": { "description": "Please specify your origin, when other is selected.", "maxLength": 5000, "type": "string" } }, "title": "us_cfpb_ethnicity_details_specs", "type": "object", "x-stripeMostCommon": [ "ethnicity", "ethnicity_other" ] }, "race_details": { "description": "The persons race details", "properties": { "race": { "description": "The persons race.", "items": { "enum": [ "african_american", "american_indian_or_alaska_native", "asian", "asian_indian", "black_or_african_american", "chinese", "ethiopian", "filipino", "guamanian_or_chamorro", "haitian", "jamaican", "japanese", "korean", "native_hawaiian", "native_hawaiian_or_other_pacific_islander", "nigerian", "other_asian", "other_black_or_african_american", "other_pacific_islander", "prefer_not_to_answer", "samoan", "somali", "vietnamese", "white" ], "type": "string" }, "type": "array" }, "race_other": { "description": "Please specify your race, when other is selected.", "maxLength": 5000, "type": "string" } }, "title": "us_cfpb_race_details_specs", "type": "object", "x-stripeMostCommon": [ "race", "race_other" ] }, "self_identified_gender": { "description": "The persons self-identified gender", "maxLength": 5000, "type": "string" } }, "title": "us_cfpb_data_specs", "type": "object", "x-stripeMostCommon": [ "ethnicity_details", "race_details", "self_identified_gender" ] }, "verification": { "description": "The person's verification status.", "properties": { "additional_document": { "description": "A document showing address, either a passport, local ID card, or utility bill from a well-known utility company.", "properties": { "back": { "description": "The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.", "maxLength": 500, "type": "string" }, "front": { "description": "The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.", "maxLength": 500, "type": "string" } }, "title": "person_verification_document_specs", "type": "object", "x-stripeMostCommon": [ "back", "electronic_id", "front" ] }, "document": { "description": "An identifying document, either a passport or local ID card.", "properties": { "back": { "description": "The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.", "maxLength": 500, "type": "string" }, "front": { "description": "The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.", "maxLength": 500, "type": "string" } }, "title": "person_verification_document_specs", "type": "object", "x-stripeMostCommon": [ "back", "electronic_id", "front" ] } }, "title": "person_verification_specs", "type": "object", "x-stripeMostCommon": [ "additional_document", "document", "proof_of_liveness" ] } }, "type": "object", "x-stripeMostCommon": [ "address", "dob", "email", "first_name", "id_number", "last_name", "metadata", "phone", "relationship", "ssn_last_4" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/person" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a person" } }, "/v1/accounts/{account}/persons/{person}": { "delete": { "description": "

Deletes an existing person’s relationship to the account’s legal entity. Any person with a relationship for an account can be deleted through the API, except if the person is the account_opener. If your integration is using the executive parameter, you cannot delete the only verified executive on file.

", "operationId": "DeleteAccountsAccountPersonsPerson", "parameters": [ { "in": "path", "name": "account", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "in": "path", "name": "person", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted_person" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Delete a person" }, "get": { "description": "

Retrieves an existing person.

", "operationId": "GetAccountsAccountPersonsPerson", "parameters": [ { "in": "path", "name": "account", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "person", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/person" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a person" }, "post": { "description": "

Updates an existing person.

", "operationId": "PostAccountsAccountPersonsPerson", "parameters": [ { "in": "path", "name": "account", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "in": "path", "name": "person", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "additional_tos_acceptances": { "explode": true, "style": "deepObject" }, "address": { "explode": true, "style": "deepObject" }, "address_kana": { "explode": true, "style": "deepObject" }, "address_kanji": { "explode": true, "style": "deepObject" }, "dob": { "explode": true, "style": "deepObject" }, "documents": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "full_name_aliases": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "registered_address": { "explode": true, "style": "deepObject" }, "relationship": { "explode": true, "style": "deepObject" }, "us_cfpb_data": { "explode": true, "style": "deepObject" }, "verification": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "additional_tos_acceptances": { "description": "Details on the legal guardian's or authorizer's acceptance of the required Stripe agreements.", "properties": { "account": { "description": "Details on the legal guardian's acceptance of the main Stripe service agreement.", "properties": { "date": { "description": "The Unix timestamp marking when the account representative accepted the service agreement.", "format": "unix-time", "type": "integer" }, "ip": { "description": "The IP address from which the account representative accepted the service agreement.", "type": "string" }, "user_agent": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "The user agent of the browser from which the account representative accepted the service agreement." } }, "title": "settings_terms_of_service_specs", "type": "object", "x-stripeMostCommon": [ "date", "ip", "user_agent" ] } }, "title": "person_additional_tos_acceptances_specs", "type": "object", "x-stripeMostCommon": [ "account", "representative" ] }, "address": { "description": "The person's address.", "properties": { "city": { "description": "City, district, suburb, town, or village.", "maxLength": 100, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Address line 1 (e.g., street, PO Box, or company name).", "maxLength": 200, "type": "string" }, "line2": { "description": "Address line 2 (e.g., apartment, suite, unit, or building).", "maxLength": 200, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "State, county, province, or region.", "maxLength": 5000, "type": "string" } }, "title": "legal_entity_and_kyc_address_specs", "type": "object", "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state" ] }, "address_kana": { "description": "The Kana variation of the person's address (Japan only).", "properties": { "city": { "description": "City or ward.", "maxLength": 5000, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Block or building number.", "maxLength": 5000, "type": "string" }, "line2": { "description": "Building details.", "maxLength": 5000, "type": "string" }, "postal_code": { "description": "Postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "Prefecture.", "maxLength": 5000, "type": "string" }, "town": { "description": "Town or cho-me.", "maxLength": 5000, "type": "string" } }, "title": "japan_address_kana_specs", "type": "object", "x-stripeMostCommon": [ "city", "country", "db_code", "line1", "line2", "postal_code", "state", "town" ] }, "address_kanji": { "description": "The Kanji variation of the person's address (Japan only).", "properties": { "city": { "description": "City or ward.", "maxLength": 5000, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Block or building number.", "maxLength": 5000, "type": "string" }, "line2": { "description": "Building details.", "maxLength": 5000, "type": "string" }, "postal_code": { "description": "Postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "Prefecture.", "maxLength": 5000, "type": "string" }, "town": { "description": "Town or cho-me.", "maxLength": 5000, "type": "string" } }, "title": "japan_address_kanji_specs", "type": "object", "x-stripeMostCommon": [ "city", "country", "db_code", "line1", "line2", "postal_code", "state", "town" ] }, "dob": { "anyOf": [ { "properties": { "day": { "description": "The day of birth, between 1 and 31.", "type": "integer" }, "month": { "description": "The month of birth, between 1 and 12.", "type": "integer" }, "year": { "description": "The four-digit year of birth.", "type": "integer" } }, "required": [ "day", "month", "year" ], "title": "date_of_birth_specs", "type": "object", "x-stripeMostCommon": [ "day", "month", "year" ] }, { "enum": [ "" ], "type": "string" } ], "description": "The person's date of birth." }, "documents": { "description": "Documents that may be submitted to satisfy various informational requests.", "properties": { "company_authorization": { "description": "One or more documents that demonstrate proof that this person is authorized to represent the company.", "properties": { "files": { "description": "One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.", "items": { "anyOf": [ { "maxLength": 500, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "type": "array" } }, "title": "documents_param", "type": "object", "x-stripeMostCommon": [ "files" ] }, "passport": { "description": "One or more documents showing the person's passport page with photo and personal data.", "properties": { "files": { "description": "One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.", "items": { "anyOf": [ { "maxLength": 500, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "type": "array" } }, "title": "documents_param", "type": "object", "x-stripeMostCommon": [ "files" ] }, "visa": { "description": "One or more documents showing the person's visa required for living in the country where they are residing.", "properties": { "files": { "description": "One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.", "items": { "anyOf": [ { "maxLength": 500, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "type": "array" } }, "title": "documents_param", "type": "object", "x-stripeMostCommon": [ "files" ] } }, "title": "person_documents_specs", "type": "object", "x-stripeMostCommon": [ "DASHBOARD_proof_of_liveness", "company_authorization", "passport", "visa" ] }, "email": { "description": "The person's email address.", "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "first_name": { "description": "The person's first name.", "maxLength": 5000, "type": "string" }, "first_name_kana": { "description": "The Kana variation of the person's first name (Japan only).", "maxLength": 5000, "type": "string" }, "first_name_kanji": { "description": "The Kanji variation of the person's first name (Japan only).", "maxLength": 5000, "type": "string" }, "full_name_aliases": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "A list of alternate names or aliases that the person is known by." }, "gender": { "description": "The person's gender (International regulations require either \"male\" or \"female\").", "type": "string" }, "id_number": { "description": "The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii).", "maxLength": 5000, "type": "string" }, "id_number_secondary": { "description": "The person's secondary ID number, as appropriate for their country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii).", "maxLength": 5000, "type": "string" }, "last_name": { "description": "The person's last name.", "maxLength": 5000, "type": "string" }, "last_name_kana": { "description": "The Kana variation of the person's last name (Japan only).", "maxLength": 5000, "type": "string" }, "last_name_kanji": { "description": "The Kanji variation of the person's last name (Japan only).", "maxLength": 5000, "type": "string" }, "maiden_name": { "description": "The person's maiden name.", "maxLength": 5000, "type": "string" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "nationality": { "description": "The country where the person is a national. Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)), or \"XX\" if unavailable.", "maxLength": 5000, "type": "string" }, "person_token": { "description": "A [person token](https://docs.stripe.com/connect/account-tokens), used to securely provide details to the person.", "maxLength": 5000, "type": "string" }, "phone": { "description": "The person's phone number.", "type": "string" }, "political_exposure": { "description": "Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction.", "enum": [ "existing", "none" ], "type": "string" }, "registered_address": { "description": "The person's registered address.", "properties": { "city": { "description": "City, district, suburb, town, or village.", "maxLength": 100, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Address line 1 (e.g., street, PO Box, or company name).", "maxLength": 200, "type": "string" }, "line2": { "description": "Address line 2 (e.g., apartment, suite, unit, or building).", "maxLength": 200, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "State, county, province, or region.", "maxLength": 5000, "type": "string" } }, "title": "address_specs", "type": "object", "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state" ] }, "relationship": { "description": "The relationship that this person has with the account's legal entity.", "properties": { "authorizer": { "description": "Whether the person is the authorizer of the account's representative.", "type": "boolean" }, "director": { "description": "Whether the person is a director of the account's legal entity. Directors are typically members of the governing board of the company, or responsible for ensuring the company meets its regulatory obligations.", "type": "boolean" }, "executive": { "description": "Whether the person has significant responsibility to control, manage, or direct the organization.", "type": "boolean" }, "legal_guardian": { "description": "Whether the person is the legal guardian of the account's representative.", "type": "boolean" }, "owner": { "description": "Whether the person is an owner of the account’s legal entity.", "type": "boolean" }, "percent_ownership": { "anyOf": [ { "type": "number" }, { "enum": [ "" ], "type": "string" } ], "description": "The percent owned by the person of the account's legal entity." }, "representative": { "description": "Whether the person is authorized as the primary representative of the account. This is the person nominated by the business to provide information about themselves, and general information about the account. There can only be one representative at any given time. At the time the account is created, this person should be set to the person responsible for opening the account.", "type": "boolean" }, "title": { "description": "The person's title (e.g., CEO, Support Engineer).", "maxLength": 5000, "type": "string" } }, "title": "relationship_specs", "type": "object", "x-stripeMostCommon": [ "authorizer", "controller", "director", "executive", "legal_guardian", "officer", "owner", "partner", "percent_ownership", "representative", "title" ] }, "ssn_last_4": { "description": "The last four digits of the person's Social Security number (U.S. only).", "type": "string" }, "us_cfpb_data": { "description": "Demographic data related to the person.", "properties": { "ethnicity_details": { "description": "The persons ethnicity details", "properties": { "ethnicity": { "description": "The persons ethnicity", "items": { "enum": [ "cuban", "hispanic_or_latino", "mexican", "not_hispanic_or_latino", "other_hispanic_or_latino", "prefer_not_to_answer", "puerto_rican" ], "type": "string" }, "type": "array" }, "ethnicity_other": { "description": "Please specify your origin, when other is selected.", "maxLength": 5000, "type": "string" } }, "title": "us_cfpb_ethnicity_details_specs", "type": "object", "x-stripeMostCommon": [ "ethnicity", "ethnicity_other" ] }, "race_details": { "description": "The persons race details", "properties": { "race": { "description": "The persons race.", "items": { "enum": [ "african_american", "american_indian_or_alaska_native", "asian", "asian_indian", "black_or_african_american", "chinese", "ethiopian", "filipino", "guamanian_or_chamorro", "haitian", "jamaican", "japanese", "korean", "native_hawaiian", "native_hawaiian_or_other_pacific_islander", "nigerian", "other_asian", "other_black_or_african_american", "other_pacific_islander", "prefer_not_to_answer", "samoan", "somali", "vietnamese", "white" ], "type": "string" }, "type": "array" }, "race_other": { "description": "Please specify your race, when other is selected.", "maxLength": 5000, "type": "string" } }, "title": "us_cfpb_race_details_specs", "type": "object", "x-stripeMostCommon": [ "race", "race_other" ] }, "self_identified_gender": { "description": "The persons self-identified gender", "maxLength": 5000, "type": "string" } }, "title": "us_cfpb_data_specs", "type": "object", "x-stripeMostCommon": [ "ethnicity_details", "race_details", "self_identified_gender" ] }, "verification": { "description": "The person's verification status.", "properties": { "additional_document": { "description": "A document showing address, either a passport, local ID card, or utility bill from a well-known utility company.", "properties": { "back": { "description": "The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.", "maxLength": 500, "type": "string" }, "front": { "description": "The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.", "maxLength": 500, "type": "string" } }, "title": "person_verification_document_specs", "type": "object", "x-stripeMostCommon": [ "back", "electronic_id", "front" ] }, "document": { "description": "An identifying document, either a passport or local ID card.", "properties": { "back": { "description": "The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.", "maxLength": 500, "type": "string" }, "front": { "description": "The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.", "maxLength": 500, "type": "string" } }, "title": "person_verification_document_specs", "type": "object", "x-stripeMostCommon": [ "back", "electronic_id", "front" ] } }, "title": "person_verification_specs", "type": "object", "x-stripeMostCommon": [ "additional_document", "document", "proof_of_liveness" ] } }, "type": "object", "x-stripeMostCommon": [ "address", "dob", "email", "first_name", "id_number", "last_name", "metadata", "phone", "relationship", "ssn_last_4" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/person" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a person" } }, "/v1/accounts/{account}/reject": { "post": { "description": "

With Connect, you can reject accounts that you have flagged as suspicious.

\n\n

Only accounts where your platform is liable for negative account balances, which includes Custom and Express accounts, can be rejected. Test-mode accounts can be rejected at any time. Live-mode accounts can only be rejected after all balances are zero.

", "operationId": "PostAccountsAccountReject", "parameters": [ { "in": "path", "name": "account", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "reason": { "description": "The reason for rejecting the account. Can be `fraud`, `terms_of_service`, or `other`.", "maxLength": 5000, "type": "string" } }, "required": [ "reason" ], "type": "object", "x-stripeMostCommon": [ "reason" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/account" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Reject an account" } }, "/v1/apple_pay/domains": { "get": { "description": "

List apple pay domains.

", "operationId": "GetApplePayDomains", "parameters": [ { "in": "query", "name": "domain_name", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/apple_pay_domain" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/apple_pay/domains", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "ApplePayDomainList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } } }, "post": { "description": "

Create an apple pay domain.

", "operationId": "PostApplePayDomains", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "domain_name": { "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "required": [ "domain_name" ], "type": "object", "x-stripeMostCommon": [ "domain_name" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/apple_pay_domain" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } } } }, "/v1/apple_pay/domains/{domain}": { "delete": { "description": "

Delete an apple pay domain.

", "operationId": "DeleteApplePayDomainsDomain", "parameters": [ { "in": "path", "name": "domain", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted_apple_pay_domain" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } } }, "get": { "description": "

Retrieve an apple pay domain.

", "operationId": "GetApplePayDomainsDomain", "parameters": [ { "in": "path", "name": "domain", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/apple_pay_domain" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } } } }, "/v1/application_fees": { "get": { "description": "

Returns a list of application fees you’ve previously collected. The application fees are returned in sorted order, with the most recent fees appearing first.

", "operationId": "GetApplicationFees", "parameters": [ { "description": "Only return application fees for the charge specified by this charge ID.", "in": "query", "name": "charge", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Only return applications fees that were created during the given date interval.", "explode": true, "in": "query", "name": "created", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "description": "Minimum value to filter by (exclusive)", "type": "integer" }, "gte": { "description": "Minimum value to filter by (inclusive)", "type": "integer" }, "lt": { "description": "Maximum value to filter by (exclusive)", "type": "integer" }, "lte": { "description": "Maximum value to filter by (inclusive)", "type": "integer" } }, "title": "range_query_specs", "type": "object", "x-stripeMostCommon": [ "gt", "gte", "lt", "lte" ] }, { "type": "integer" } ] }, "style": "deepObject" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/application_fee" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/application_fees", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "PlatformEarningList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all application fees" } }, "/v1/application_fees/{fee}/refunds/{id}": { "get": { "description": "

By default, you can see the 10 most recent refunds stored directly on the application fee object, but you can also retrieve details about a specific refund stored on the application fee.

", "operationId": "GetApplicationFeesFeeRefundsId", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "fee", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fee_refund" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve an application fee refund" }, "post": { "description": "

Updates the specified application fee refund by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

\n\n

This request only accepts metadata as an argument.

", "operationId": "PostApplicationFeesFeeRefundsId", "parameters": [ { "in": "path", "name": "fee", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." } }, "type": "object", "x-stripeMostCommon": [ "metadata" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fee_refund" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update an application fee refund" } }, "/v1/application_fees/{id}": { "get": { "description": "

Retrieves the details of an application fee that your account has collected. The same information is returned when refunding the application fee.

", "operationId": "GetApplicationFeesId", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/application_fee" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve an application fee" } }, "/v1/application_fees/{id}/refunds": { "get": { "description": "

You can see a list of the refunds belonging to a specific application fee. Note that the 10 most recent refunds are always available by default on the application fee object. If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional refunds.

", "operationId": "GetApplicationFeesIdRefunds", "parameters": [ { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/fee_refund" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "FeeRefundList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all application fee refunds" }, "post": { "description": "

Refunds an application fee that has previously been collected but not yet refunded.\nFunds will be refunded to the Stripe account from which the fee was originally collected.

\n\n

You can optionally refund only part of an application fee.\nYou can do so multiple times, until the entire fee has been refunded.

\n\n

Once entirely refunded, an application fee can’t be refunded again.\nThis method will raise an error when called on an already-refunded application fee,\nor when trying to refund more money than is left on an application fee.

", "operationId": "PostApplicationFeesIdRefunds", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "amount": { "description": "A positive integer, in _cents (or local equivalent)_, representing how much of this fee to refund. Can refund only up to the remaining unrefunded amount of the fee.", "type": "integer" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" } }, "type": "object", "x-stripeMostCommon": [ "amount", "metadata" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fee_refund" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create an application fee refund" } }, "/v1/apps/secrets": { "get": { "description": "

List all secrets stored on the given scope.

", "operationId": "GetAppsSecrets", "parameters": [ { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "Specifies the scoping of the secret. Requests originating from UI extensions can only access account-scoped secrets or secrets scoped to their own user.", "explode": true, "in": "query", "name": "scope", "required": true, "schema": { "properties": { "type": { "description": "The secret scope type.", "enum": [ "account", "user" ], "type": "string" }, "user": { "description": "The user ID. This field is required if `type` is set to `user`, and should not be provided if `type` is set to `account`.", "maxLength": 5000, "type": "string" } }, "required": [ "type" ], "title": "scope_param", "type": "object", "x-stripeMostCommon": [ "type", "user" ] }, "style": "deepObject" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/apps.secret" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/apps/secrets", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "SecretServiceResourceSecretList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List secrets" }, "post": { "description": "

Create or replace a secret in the secret store.

", "operationId": "PostAppsSecrets", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "scope": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "expires_at": { "description": "The Unix timestamp for the expiry time of the secret, after which the secret deletes.", "format": "unix-time", "type": "integer" }, "name": { "description": "A name for the secret that's unique within the scope.", "maxLength": 5000, "type": "string" }, "payload": { "description": "The plaintext secret value to be stored.", "maxLength": 5000, "type": "string" }, "scope": { "description": "Specifies the scoping of the secret. Requests originating from UI extensions can only access account-scoped secrets or secrets scoped to their own user.", "properties": { "type": { "description": "The secret scope type.", "enum": [ "account", "user" ], "type": "string" }, "user": { "description": "The user ID. This field is required if `type` is set to `user`, and should not be provided if `type` is set to `account`.", "maxLength": 5000, "type": "string" } }, "required": [ "type" ], "title": "scope_param", "type": "object", "x-stripeMostCommon": [ "type", "user" ] } }, "required": [ "name", "payload", "scope" ], "type": "object", "x-stripeMostCommon": [ "expires_at", "name", "payload", "scope" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/apps.secret" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Set a Secret" } }, "/v1/apps/secrets/delete": { "post": { "description": "

Deletes a secret from the secret store by name and scope.

", "operationId": "PostAppsSecretsDelete", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "scope": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "name": { "description": "A name for the secret that's unique within the scope.", "maxLength": 5000, "type": "string" }, "scope": { "description": "Specifies the scoping of the secret. Requests originating from UI extensions can only access account-scoped secrets or secrets scoped to their own user.", "properties": { "type": { "description": "The secret scope type.", "enum": [ "account", "user" ], "type": "string" }, "user": { "description": "The user ID. This field is required if `type` is set to `user`, and should not be provided if `type` is set to `account`.", "maxLength": 5000, "type": "string" } }, "required": [ "type" ], "title": "scope_param", "type": "object", "x-stripeMostCommon": [ "type", "user" ] } }, "required": [ "name", "scope" ], "type": "object", "x-stripeMostCommon": [ "name", "scope" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/apps.secret" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Delete a Secret" } }, "/v1/apps/secrets/find": { "get": { "description": "

Finds a secret in the secret store by name and scope.

", "operationId": "GetAppsSecretsFind", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A name for the secret that's unique within the scope.", "in": "query", "name": "name", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies the scoping of the secret. Requests originating from UI extensions can only access account-scoped secrets or secrets scoped to their own user.", "explode": true, "in": "query", "name": "scope", "required": true, "schema": { "properties": { "type": { "description": "The secret scope type.", "enum": [ "account", "user" ], "type": "string" }, "user": { "description": "The user ID. This field is required if `type` is set to `user`, and should not be provided if `type` is set to `account`.", "maxLength": 5000, "type": "string" } }, "required": [ "type" ], "title": "scope_param", "type": "object", "x-stripeMostCommon": [ "type", "user" ] }, "style": "deepObject" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/apps.secret" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Find a Secret" } }, "/v1/balance": { "get": { "description": "

Retrieves the current account balance, based on the authentication that was used to make the request.\n For a sample request, see Accounting for negative balances.

", "operationId": "GetBalance", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/balance" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve balance" } }, "/v1/balance_settings": { "get": { "description": "

Retrieves balance settings for a given connected account.\n Related guide: Making API calls for connected accounts

", "operationId": "GetBalanceSettings", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/balance_settings" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve balance settings" }, "post": { "description": "

Updates balance settings for a given connected account.\n Related guide: Making API calls for connected accounts

", "operationId": "PostBalanceSettings", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "payments": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "payments": { "description": "Settings that apply to the [Payments Balance](https://docs.stripe.com/api/balance).", "properties": { "debit_negative_balances": { "description": "A Boolean indicating whether Stripe should try to reclaim negative balances from an attached bank account. For details, see [Understanding Connect Account Balances](/connect/account-balances).", "type": "boolean" }, "payouts": { "description": "Settings specific to the account's payouts.", "properties": { "minimum_balance_by_currency": { "anyOf": [ { "additionalProperties": { "anyOf": [ { "type": "integer" }, { "enum": [ "" ], "type": "string" } ] }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "The minimum balance amount to retain per currency after automatic payouts. Only funds that exceed these amounts are paid out. Learn more about the [minimum balances for automatic payouts](/payouts/minimum-balances-for-automatic-payouts)." }, "schedule": { "description": "Details on when funds from charges are available, and when they are paid out to an external account. For details, see our [Setting Bank and Debit Card Payouts](/connect/bank-transfers#payout-information) documentation.", "properties": { "interval": { "description": "How frequently available funds are paid out. One of: `daily`, `manual`, `weekly`, or `monthly`. Default is `daily`.", "enum": [ "daily", "manual", "monthly", "weekly" ], "type": "string" }, "monthly_payout_days": { "description": "The days of the month when available funds are paid out, specified as an array of numbers between 1--31. Payouts nominally scheduled between the 29th and 31st of the month are instead sent on the last day of a shorter month. Required and applicable only if `interval` is `monthly`.", "items": { "type": "integer" }, "type": "array" }, "weekly_payout_days": { "description": "The days of the week when available funds are paid out, specified as an array, e.g., [`monday`, `tuesday`]. Required and applicable only if `interval` is `weekly`.", "items": { "enum": [ "friday", "monday", "thursday", "tuesday", "wednesday" ], "type": "string", "x-stripeBypassValidation": true }, "type": "array" } }, "title": "payout_schedule", "type": "object", "x-stripeMostCommon": [ "interval", "monthly_payout_days", "weekly_payout_days" ] }, "statement_descriptor": { "description": "The text that appears on the bank account statement for payouts. If not set, this defaults to the platform's bank descriptor as set in the Dashboard.", "maxLength": 22, "type": "string" } }, "title": "payouts", "type": "object", "x-stripeMostCommon": [ "automatic_transfer_rules_by_currency", "minimum_balance_by_currency", "schedule", "statement_descriptor" ] }, "settlement_timing": { "description": "Settings related to the account's balance settlement timing.", "properties": { "delay_days_override": { "description": "The number of days charge funds are held before becoming available. The default value is `minimum`, representing the lowest available value for the account. The maximum value is 31. The `delay_days` parameter remains at the last configured value if `payouts.schedule.interval` is `manual`. [Learn more about controlling delay days](/connect/manage-payout-schedule).", "type": "integer" } }, "title": "settlement_timing", "type": "object", "x-stripeMostCommon": [ "delay_days_override", "payment_method_options" ] } }, "title": "payments", "type": "object", "x-stripeMostCommon": [ "debit_negative_balances", "payouts", "settlement_timing" ] } }, "required": [ "payments" ], "type": "object", "x-stripeMostCommon": [ "payments" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/balance_settings" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update balance settings" } }, "/v1/balance_transactions": { "get": { "description": "

Returns a list of transactions that have contributed to the Stripe account balance (e.g., charges, transfers, and so forth). The transactions are returned in sorted order, with the most recent transactions appearing first.

\n\n

Note that this endpoint was previously called “Balance history” and used the path /v1/balance/history.

", "operationId": "GetBalanceTransactions", "parameters": [ { "description": "Only return transactions that were created during the given date interval.", "explode": true, "in": "query", "name": "created", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "description": "Minimum value to filter by (exclusive)", "type": "integer" }, "gte": { "description": "Minimum value to filter by (inclusive)", "type": "integer" }, "lt": { "description": "Maximum value to filter by (exclusive)", "type": "integer" }, "lte": { "description": "Maximum value to filter by (inclusive)", "type": "integer" } }, "title": "range_query_specs", "type": "object", "x-stripeMostCommon": [ "gt", "gte", "lt", "lte" ] }, { "type": "integer" } ] }, "style": "deepObject" }, { "description": "Only return transactions in a certain currency. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "in": "query", "name": "currency", "required": false, "schema": { "format": "currency", "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "For automatic Stripe payouts only, only returns transactions that were paid out on the specified payout ID.", "in": "query", "name": "payout", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Only returns the original transaction.", "in": "query", "name": "source", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Only returns transactions of the given type. One of: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `climate_order_purchase`, `climate_order_refund`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_outbound`, `obligation_reversal_inbound`, `payment`, `payment_failure_refund`, `payment_network_reserve_hold`, `payment_network_reserve_release`, `payment_refund`, `payment_reversal`, `payment_unreconciled`, `payout`, `payout_cancel`, `payout_failure`, `payout_minimum_balance_hold`, `payout_minimum_balance_release`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `stripe_balance_payment_debit`, `stripe_balance_payment_debit_reversal`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`.", "in": "query", "name": "type", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/balance_transaction" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/balance_transactions", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "BalanceTransactionsList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all balance transactions" } }, "/v1/balance_transactions/{id}": { "get": { "description": "

Retrieves the balance transaction with the given ID.

\n\n

Note that this endpoint previously used the path /v1/balance/history/:id.

", "operationId": "GetBalanceTransactionsId", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/balance_transaction" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a balance transaction" } }, "/v1/billing/alerts": { "get": { "description": "

Lists billing active and inactive alerts

", "operationId": "GetBillingAlerts", "parameters": [ { "description": "Filter results to only include this type of alert.", "in": "query", "name": "alert_type", "required": false, "schema": { "enum": [ "usage_threshold" ], "type": "string", "x-stripeBypassValidation": true }, "style": "form" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "Filter results to only include alerts with the given meter.", "in": "query", "name": "meter", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/billing.alert" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/billing/alerts", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "ThresholdsResourceAlertList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List billing alerts" }, "post": { "description": "

Creates a billing alert

", "operationId": "PostBillingAlerts", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "usage_threshold": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "alert_type": { "description": "The type of alert to create.", "enum": [ "usage_threshold" ], "type": "string", "x-stripeBypassValidation": true }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "title": { "description": "The title of the alert.", "maxLength": 256, "type": "string" }, "usage_threshold": { "description": "The configuration of the usage threshold.", "properties": { "filters": { "description": "The filters allows limiting the scope of this usage alert. You can only specify up to one filter at this time.", "items": { "properties": { "customer": { "description": "Limit the scope to this usage alert only to this customer.", "maxLength": 5000, "type": "string" }, "type": { "description": "What type of filter is being applied to this usage alert.", "enum": [ "customer" ], "type": "string" } }, "required": [ "type" ], "title": "usage_alert_filter", "type": "object", "x-stripeMostCommon": [ "customer", "type" ] }, "type": "array" }, "gte": { "description": "Defines at which value the alert will fire.", "type": "integer" }, "meter": { "description": "The [Billing Meter](/api/billing/meter) ID whose usage is monitored.", "maxLength": 5000, "type": "string" }, "recurrence": { "description": "Defines how the alert will behave.", "enum": [ "one_time" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "gte", "meter", "recurrence" ], "title": "usage_threshold_config", "type": "object", "x-stripeMostCommon": [ "filters", "gte", "meter", "recurrence" ] } }, "required": [ "alert_type", "title" ], "type": "object", "x-stripeMostCommon": [ "alert_type", "title", "usage_threshold" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/billing.alert" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a billing alert" } }, "/v1/billing/alerts/{id}": { "get": { "description": "

Retrieves a billing alert given an ID

", "operationId": "GetBillingAlertsId", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/billing.alert" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a billing alert" } }, "/v1/billing/alerts/{id}/activate": { "post": { "description": "

Reactivates this alert, allowing it to trigger again.

", "operationId": "PostBillingAlertsIdActivate", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/billing.alert" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Activate a billing alert" } }, "/v1/billing/alerts/{id}/archive": { "post": { "description": "

Archives this alert, removing it from the list view and APIs. This is non-reversible.

", "operationId": "PostBillingAlertsIdArchive", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/billing.alert" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Archive a billing alert" } }, "/v1/billing/alerts/{id}/deactivate": { "post": { "description": "

Deactivates this alert, preventing it from triggering.

", "operationId": "PostBillingAlertsIdDeactivate", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/billing.alert" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Deactivate a billing alert" } }, "/v1/billing/analytics/meter_usage": { "get": { "description": "

Returns aggregated meter usage data for a customer within a specified time interval. The data can be grouped by various dimensions and can include multiple meters if specified.

", "operationId": "GetBillingAnalyticsMeterUsage", "parameters": [ { "description": "The customer id to fetch meter usage data for.", "in": "query", "name": "customer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "The timestamp from when to stop aggregating meter events (exclusive). Must be aligned with minute boundaries.", "in": "query", "name": "end_time", "required": true, "schema": { "format": "unix-time", "type": "integer" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "An array of meter parameters to specify which meters to include in the usage data. If not specified, usage across all meters for the customer is included.", "explode": true, "in": "query", "name": "meters", "required": false, "schema": { "items": { "properties": { "dimension_filters": { "additionalProperties": { "type": "string" }, "description": "Key-value pairs used to filter usage events by meter dimension values. If specified, usage will be filtered for matching usage events.", "type": "object" }, "dimension_group_by_keys": { "description": "List of meter dimension keys to group by. If specified, usage events will be grouped by the given meter dimension key's values.", "items": { "maxLength": 100, "type": "string" }, "type": "array" }, "meter_id": { "description": "Meter id to query usage for.", "maxLength": 5000, "type": "string" }, "tenant_filters": { "additionalProperties": { "type": "string" }, "description": "Key-value pairs used to filter usage events by high cardinality tenant dimension values. If specified, usage will be filtered for matching usage events.", "type": "object" } }, "required": [ "meter_id" ], "title": "meter_param", "type": "object", "x-stripeMostCommon": [ "dimension_filters", "dimension_group_by_keys", "meter_id", "tenant_filters" ] }, "type": "array" }, "style": "deepObject" }, { "description": "The timestamp from when to start aggregating meter events (inclusive). Must be aligned with minute boundaries.", "in": "query", "name": "start_time", "required": true, "schema": { "format": "unix-time", "type": "integer" }, "style": "form" }, { "description": "The timezone to use for the start and end times. Defaults to UTC if not specified.", "in": "query", "name": "timezone", "required": false, "schema": { "enum": [ "Africa/Abidjan", "Africa/Accra", "Africa/Addis_Ababa", "Africa/Algiers", "Africa/Asmara", "Africa/Asmera", "Africa/Bamako", "Africa/Bangui", "Africa/Banjul", "Africa/Bissau", "Africa/Blantyre", "Africa/Brazzaville", "Africa/Bujumbura", "Africa/Cairo", "Africa/Casablanca", "Africa/Ceuta", "Africa/Conakry", "Africa/Dakar", "Africa/Dar_es_Salaam", "Africa/Djibouti", "Africa/Douala", "Africa/El_Aaiun", "Africa/Freetown", "Africa/Gaborone", "Africa/Harare", "Africa/Johannesburg", "Africa/Juba", "Africa/Kampala", "Africa/Khartoum", "Africa/Kigali", "Africa/Kinshasa", "Africa/Lagos", "Africa/Libreville", "Africa/Lome", "Africa/Luanda", "Africa/Lubumbashi", "Africa/Lusaka", "Africa/Malabo", "Africa/Maputo", "Africa/Maseru", "Africa/Mbabane", "Africa/Mogadishu", "Africa/Monrovia", "Africa/Nairobi", "Africa/Ndjamena", "Africa/Niamey", "Africa/Nouakchott", "Africa/Ouagadougou", "Africa/Porto-Novo", "Africa/Sao_Tome", "Africa/Timbuktu", "Africa/Tripoli", "Africa/Tunis", "Africa/Windhoek", "America/Adak", "America/Anchorage", "America/Anguilla", "America/Antigua", "America/Araguaina", "America/Argentina/Buenos_Aires", "America/Argentina/Catamarca", "America/Argentina/ComodRivadavia", "America/Argentina/Cordoba", "America/Argentina/Jujuy", "America/Argentina/La_Rioja", "America/Argentina/Mendoza", "America/Argentina/Rio_Gallegos", "America/Argentina/Salta", "America/Argentina/San_Juan", "America/Argentina/San_Luis", "America/Argentina/Tucuman", "America/Argentina/Ushuaia", "America/Aruba", "America/Asuncion", "America/Atikokan", "America/Atka", "America/Bahia", "America/Bahia_Banderas", "America/Barbados", "America/Belem", "America/Belize", "America/Blanc-Sablon", "America/Boa_Vista", "America/Bogota", "America/Boise", "America/Buenos_Aires", "America/Cambridge_Bay", "America/Campo_Grande", "America/Cancun", "America/Caracas", "America/Catamarca", "America/Cayenne", "America/Cayman", "America/Chicago", "America/Chihuahua", "America/Ciudad_Juarez", "America/Coral_Harbour", "America/Cordoba", "America/Costa_Rica", "America/Coyhaique", "America/Creston", "America/Cuiaba", "America/Curacao", "America/Danmarkshavn", "America/Dawson", "America/Dawson_Creek", "America/Denver", "America/Detroit", "America/Dominica", "America/Edmonton", "America/Eirunepe", "America/El_Salvador", "America/Ensenada", "America/Fort_Nelson", "America/Fort_Wayne", "America/Fortaleza", "America/Glace_Bay", "America/Godthab", "America/Goose_Bay", "America/Grand_Turk", "America/Grenada", "America/Guadeloupe", "America/Guatemala", "America/Guayaquil", "America/Guyana", "America/Halifax", "America/Havana", "America/Hermosillo", "America/Indiana/Indianapolis", "America/Indiana/Knox", "America/Indiana/Marengo", "America/Indiana/Petersburg", "America/Indiana/Tell_City", "America/Indiana/Vevay", "America/Indiana/Vincennes", "America/Indiana/Winamac", "America/Indianapolis", "America/Inuvik", "America/Iqaluit", "America/Jamaica", "America/Jujuy", "America/Juneau", "America/Kentucky/Louisville", "America/Kentucky/Monticello", "America/Knox_IN", "America/Kralendijk", "America/La_Paz", "America/Lima", "America/Los_Angeles", "America/Louisville", "America/Lower_Princes", "America/Maceio", "America/Managua", "America/Manaus", "America/Marigot", "America/Martinique", "America/Matamoros", "America/Mazatlan", "America/Mendoza", "America/Menominee", "America/Merida", "America/Metlakatla", "America/Mexico_City", "America/Miquelon", "America/Moncton", "America/Monterrey", "America/Montevideo", "America/Montreal", "America/Montserrat", "America/Nassau", "America/New_York", "America/Nipigon", "America/Nome", "America/Noronha", "America/North_Dakota/Beulah", "America/North_Dakota/Center", "America/North_Dakota/New_Salem", "America/Nuuk", "America/Ojinaga", "America/Panama", "America/Pangnirtung", "America/Paramaribo", "America/Phoenix", "America/Port-au-Prince", "America/Port_of_Spain", "America/Porto_Acre", "America/Porto_Velho", "America/Puerto_Rico", "America/Punta_Arenas", "America/Rainy_River", "America/Rankin_Inlet", "America/Recife", "America/Regina", "America/Resolute", "America/Rio_Branco", "America/Rosario", "America/Santa_Isabel", "America/Santarem", "America/Santiago", "America/Santo_Domingo", "America/Sao_Paulo", "America/Scoresbysund", "America/Shiprock", "America/Sitka", "America/St_Barthelemy", "America/St_Johns", "America/St_Kitts", "America/St_Lucia", "America/St_Thomas", "America/St_Vincent", "America/Swift_Current", "America/Tegucigalpa", "America/Thule", "America/Thunder_Bay", "America/Tijuana", "America/Toronto", "America/Tortola", "America/Vancouver", "America/Virgin", "America/Whitehorse", "America/Winnipeg", "America/Yakutat", "America/Yellowknife", "Antarctica/Casey", "Antarctica/Davis", "Antarctica/DumontDUrville", "Antarctica/Macquarie", "Antarctica/Mawson", "Antarctica/McMurdo", "Antarctica/Palmer", "Antarctica/Rothera", "Antarctica/South_Pole", "Antarctica/Syowa", "Antarctica/Troll", "Antarctica/Vostok", "Arctic/Longyearbyen", "Asia/Aden", "Asia/Almaty", "Asia/Amman", "Asia/Anadyr", "Asia/Aqtau", "Asia/Aqtobe", "Asia/Ashgabat", "Asia/Ashkhabad", "Asia/Atyrau", "Asia/Baghdad", "Asia/Bahrain", "Asia/Baku", "Asia/Bangkok", "Asia/Barnaul", "Asia/Beirut", "Asia/Bishkek", "Asia/Brunei", "Asia/Calcutta", "Asia/Chita", "Asia/Choibalsan", "Asia/Chongqing", "Asia/Chungking", "Asia/Colombo", "Asia/Dacca", "Asia/Damascus", "Asia/Dhaka", "Asia/Dili", "Asia/Dubai", "Asia/Dushanbe", "Asia/Famagusta", "Asia/Gaza", "Asia/Harbin", "Asia/Hebron", "Asia/Ho_Chi_Minh", "Asia/Hong_Kong", "Asia/Hovd", "Asia/Irkutsk", "Asia/Istanbul", "Asia/Jakarta", "Asia/Jayapura", "Asia/Jerusalem", "Asia/Kabul", "Asia/Kamchatka", "Asia/Karachi", "Asia/Kashgar", "Asia/Kathmandu", "Asia/Katmandu", "Asia/Khandyga", "Asia/Kolkata", "Asia/Krasnoyarsk", "Asia/Kuala_Lumpur", "Asia/Kuching", "Asia/Kuwait", "Asia/Macao", "Asia/Macau", "Asia/Magadan", "Asia/Makassar", "Asia/Manila", "Asia/Muscat", "Asia/Nicosia", "Asia/Novokuznetsk", "Asia/Novosibirsk", "Asia/Omsk", "Asia/Oral", "Asia/Phnom_Penh", "Asia/Pontianak", "Asia/Pyongyang", "Asia/Qatar", "Asia/Qostanay", "Asia/Qyzylorda", "Asia/Rangoon", "Asia/Riyadh", "Asia/Saigon", "Asia/Sakhalin", "Asia/Samarkand", "Asia/Seoul", "Asia/Shanghai", "Asia/Singapore", "Asia/Srednekolymsk", "Asia/Taipei", "Asia/Tashkent", "Asia/Tbilisi", "Asia/Tehran", "Asia/Tel_Aviv", "Asia/Thimbu", "Asia/Thimphu", "Asia/Tokyo", "Asia/Tomsk", "Asia/Ujung_Pandang", "Asia/Ulaanbaatar", "Asia/Ulan_Bator", "Asia/Urumqi", "Asia/Ust-Nera", "Asia/Vientiane", "Asia/Vladivostok", "Asia/Yakutsk", "Asia/Yangon", "Asia/Yekaterinburg", "Asia/Yerevan", "Atlantic/Azores", "Atlantic/Bermuda", "Atlantic/Canary", "Atlantic/Cape_Verde", "Atlantic/Faeroe", "Atlantic/Faroe", "Atlantic/Jan_Mayen", "Atlantic/Madeira", "Atlantic/Reykjavik", "Atlantic/South_Georgia", "Atlantic/St_Helena", "Atlantic/Stanley", "Australia/ACT", "Australia/Adelaide", "Australia/Brisbane", "Australia/Broken_Hill", "Australia/Canberra", "Australia/Currie", "Australia/Darwin", "Australia/Eucla", "Australia/Hobart", "Australia/LHI", "Australia/Lindeman", "Australia/Lord_Howe", "Australia/Melbourne", "Australia/NSW", "Australia/North", "Australia/Perth", "Australia/Queensland", "Australia/South", "Australia/Sydney", "Australia/Tasmania", "Australia/Victoria", "Australia/West", "Australia/Yancowinna", "Brazil/Acre", "Brazil/DeNoronha", "Brazil/East", "Brazil/West", "CET", "CST6CDT", "Canada/Atlantic", "Canada/Central", "Canada/Eastern", "Canada/Mountain", "Canada/Newfoundland", "Canada/Pacific", "Canada/Saskatchewan", "Canada/Yukon", "Chile/Continental", "Chile/EasterIsland", "Cuba", "EET", "EST", "EST5EDT", "Egypt", "Eire", "Etc/GMT", "Etc/GMT+0", "Etc/GMT+1", "Etc/GMT+10", "Etc/GMT+11", "Etc/GMT+12", "Etc/GMT+2", "Etc/GMT+3", "Etc/GMT+4", "Etc/GMT+5", "Etc/GMT+6", "Etc/GMT+7", "Etc/GMT+8", "Etc/GMT+9", "Etc/GMT-0", "Etc/GMT-1", "Etc/GMT-10", "Etc/GMT-11", "Etc/GMT-12", "Etc/GMT-13", "Etc/GMT-14", "Etc/GMT-2", "Etc/GMT-3", "Etc/GMT-4", "Etc/GMT-5", "Etc/GMT-6", "Etc/GMT-7", "Etc/GMT-8", "Etc/GMT-9", "Etc/GMT0", "Etc/Greenwich", "Etc/UCT", "Etc/UTC", "Etc/Universal", "Etc/Zulu", "Europe/Amsterdam", "Europe/Andorra", "Europe/Astrakhan", "Europe/Athens", "Europe/Belfast", "Europe/Belgrade", "Europe/Berlin", "Europe/Bratislava", "Europe/Brussels", "Europe/Bucharest", "Europe/Budapest", "Europe/Busingen", "Europe/Chisinau", "Europe/Copenhagen", "Europe/Dublin", "Europe/Gibraltar", "Europe/Guernsey", "Europe/Helsinki", "Europe/Isle_of_Man", "Europe/Istanbul", "Europe/Jersey", "Europe/Kaliningrad", "Europe/Kiev", "Europe/Kirov", "Europe/Kyiv", "Europe/Lisbon", "Europe/Ljubljana", "Europe/London", "Europe/Luxembourg", "Europe/Madrid", "Europe/Malta", "Europe/Mariehamn", "Europe/Minsk", "Europe/Monaco", "Europe/Moscow", "Europe/Nicosia", "Europe/Oslo", "Europe/Paris", "Europe/Podgorica", "Europe/Prague", "Europe/Riga", "Europe/Rome", "Europe/Samara", "Europe/San_Marino", "Europe/Sarajevo", "Europe/Saratov", "Europe/Simferopol", "Europe/Skopje", "Europe/Sofia", "Europe/Stockholm", "Europe/Tallinn", "Europe/Tirane", "Europe/Tiraspol", "Europe/Ulyanovsk", "Europe/Uzhgorod", "Europe/Vaduz", "Europe/Vatican", "Europe/Vienna", "Europe/Vilnius", "Europe/Volgograd", "Europe/Warsaw", "Europe/Zagreb", "Europe/Zaporozhye", "Europe/Zurich", "Factory", "GB", "GB-Eire", "GMT", "GMT+0", "GMT-0", "GMT0", "Greenwich", "HST", "Hongkong", "Iceland", "Indian/Antananarivo", "Indian/Chagos", "Indian/Christmas", "Indian/Cocos", "Indian/Comoro", "Indian/Kerguelen", "Indian/Mahe", "Indian/Maldives", "Indian/Mauritius", "Indian/Mayotte", "Indian/Reunion", "Iran", "Israel", "Jamaica", "Japan", "Kwajalein", "Libya", "MET", "MST", "MST7MDT", "Mexico/BajaNorte", "Mexico/BajaSur", "Mexico/General", "NZ", "NZ-CHAT", "Navajo", "PRC", "PST8PDT", "Pacific/Apia", "Pacific/Auckland", "Pacific/Bougainville", "Pacific/Chatham", "Pacific/Chuuk", "Pacific/Easter", "Pacific/Efate", "Pacific/Enderbury", "Pacific/Fakaofo", "Pacific/Fiji", "Pacific/Funafuti", "Pacific/Galapagos", "Pacific/Gambier", "Pacific/Guadalcanal", "Pacific/Guam", "Pacific/Honolulu", "Pacific/Johnston", "Pacific/Kanton", "Pacific/Kiritimati", "Pacific/Kosrae", "Pacific/Kwajalein", "Pacific/Majuro", "Pacific/Marquesas", "Pacific/Midway", "Pacific/Nauru", "Pacific/Niue", "Pacific/Norfolk", "Pacific/Noumea", "Pacific/Pago_Pago", "Pacific/Palau", "Pacific/Pitcairn", "Pacific/Pohnpei", "Pacific/Ponape", "Pacific/Port_Moresby", "Pacific/Rarotonga", "Pacific/Saipan", "Pacific/Samoa", "Pacific/Tahiti", "Pacific/Tarawa", "Pacific/Tongatapu", "Pacific/Truk", "Pacific/Wake", "Pacific/Wallis", "Pacific/Yap", "Poland", "Portugal", "ROC", "ROK", "Singapore", "Turkey", "UCT", "US/Alaska", "US/Aleutian", "US/Arizona", "US/Central", "US/East-Indiana", "US/Eastern", "US/Hawaii", "US/Indiana-Starke", "US/Michigan", "US/Mountain", "US/Pacific", "US/Pacific-New", "US/Samoa", "UTC", "Universal", "W-SU", "WET", "Zulu" ], "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies what granularity to use when aggregating meter usage events. If not specified, a single event would be returned for the specified time range.", "in": "query", "name": "value_grouping_window", "required": false, "schema": { "enum": [ "day", "hour", "month", "week" ], "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/billing.analytics.meter_usage" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieves aggregated meter usage data" } }, "/v1/billing/credit_balance_summary": { "get": { "description": "

Retrieves the credit balance summary for a customer.

", "operationId": "GetBillingCreditBalanceSummary", "parameters": [ { "description": "The customer for which to fetch credit balance summary.", "in": "query", "name": "customer", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "The account for which to fetch credit balance summary.", "in": "query", "name": "customer_account", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "The filter criteria for the credit balance summary.", "explode": true, "in": "query", "name": "filter", "required": true, "schema": { "properties": { "applicability_scope": { "description": "The billing credit applicability scope for which to fetch credit balance summary.", "properties": { "price_type": { "description": "The price type that credit grants can apply to. We currently only support the `metered` price type. Cannot be used in combination with `prices`.", "enum": [ "metered" ], "type": "string" }, "prices": { "description": "A list of prices that the credit grant can apply to. We currently only support the `metered` prices. Cannot be used in combination with `price_type`.", "items": { "properties": { "id": { "description": "The price ID this credit grant should apply to.", "maxLength": 5000, "type": "string" } }, "required": [ "id" ], "title": "applicable_price_param", "type": "object", "x-stripeMostCommon": [ "id" ] }, "type": "array" } }, "title": "scope_param", "type": "object", "x-stripeMostCommon": [ "billable_items", "price_type", "prices" ] }, "credit_grant": { "description": "The credit grant for which to fetch credit balance summary.", "maxLength": 5000, "type": "string" }, "type": { "description": "Specify the type of this filter.", "enum": [ "applicability_scope", "credit_grant" ], "type": "string" } }, "required": [ "type" ], "title": "balance_summary_filter_param", "type": "object", "x-stripeMostCommon": [ "applicability_scope", "credit_grant", "type" ] }, "style": "deepObject" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/billing.credit_balance_summary" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve the credit balance summary for a customer" } }, "/v1/billing/credit_balance_transactions": { "get": { "description": "

Retrieve a list of credit balance transactions.

", "operationId": "GetBillingCreditBalanceTransactions", "parameters": [ { "description": "The credit grant for which to fetch credit balance transactions.", "in": "query", "name": "credit_grant", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "The customer for which to fetch credit balance transactions.", "in": "query", "name": "customer", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "The account for which to fetch credit balance transactions.", "in": "query", "name": "customer_account", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/billing.credit_balance_transaction" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/billing/credit_grants", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "BillingCreditGrantsResourceBalanceTransactionList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List credit balance transactions" } }, "/v1/billing/credit_balance_transactions/{id}": { "get": { "description": "

Retrieves a credit balance transaction.

", "operationId": "GetBillingCreditBalanceTransactionsId", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "Unique identifier for the object.", "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/billing.credit_balance_transaction" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a credit balance transaction" } }, "/v1/billing/credit_grants": { "get": { "description": "

Retrieve a list of credit grants.

", "operationId": "GetBillingCreditGrants", "parameters": [ { "description": "Only return credit grants for this customer.", "in": "query", "name": "customer", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Only return credit grants for this account.", "in": "query", "name": "customer_account", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/billing.credit_grant" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/billing/credit_grants", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "BillingCreditGrantsResourceCreditGrantList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List credit grants" }, "post": { "description": "

Creates a credit grant.

", "operationId": "PostBillingCreditGrants", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "amount": { "explode": true, "style": "deepObject" }, "applicability_config": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "amount": { "description": "Amount of this credit grant.", "properties": { "monetary": { "description": "The monetary amount.", "properties": { "currency": { "description": "Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the `value` parameter.", "format": "currency", "type": "string" }, "value": { "description": "A positive integer representing the amount of the credit grant.", "type": "integer" } }, "required": [ "currency", "value" ], "title": "monetary_amount_param", "type": "object", "x-stripeMostCommon": [ "currency", "value" ] }, "type": { "description": "The type of this amount. We currently only support `monetary` billing credits.", "enum": [ "monetary" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "amount_param", "type": "object", "x-stripeMostCommon": [ "custom_pricing_unit", "monetary", "type" ] }, "applicability_config": { "description": "Configuration specifying what this credit grant applies to. We currently only support `metered` prices that have a [Billing Meter](https://docs.stripe.com/api/billing/meter) attached to them.", "properties": { "scope": { "description": "Specify the scope of this applicability config.", "properties": { "price_type": { "description": "The price type that credit grants can apply to. We currently only support the `metered` price type. Cannot be used in combination with `prices`.", "enum": [ "metered" ], "type": "string" }, "prices": { "description": "A list of prices that the credit grant can apply to. We currently only support the `metered` prices. Cannot be used in combination with `price_type`.", "items": { "properties": { "id": { "description": "The price ID this credit grant should apply to.", "maxLength": 5000, "type": "string" } }, "required": [ "id" ], "title": "applicable_price_param", "type": "object", "x-stripeMostCommon": [ "id" ] }, "type": "array" } }, "title": "scope_param", "type": "object", "x-stripeMostCommon": [ "billable_items", "price_type", "prices" ] } }, "required": [ "scope" ], "title": "applicability_config_param", "type": "object", "x-stripeMostCommon": [ "scope" ] }, "category": { "description": "The category of this credit grant.", "enum": [ "paid", "promotional" ], "type": "string" }, "customer": { "description": "ID of the customer to receive the billing credits.", "maxLength": 5000, "type": "string" }, "customer_account": { "description": "ID of the account to receive the billing credits.", "maxLength": 5000, "type": "string" }, "effective_at": { "description": "The time when the billing credits become effective-when they're eligible for use. It defaults to the current timestamp if not specified.", "format": "unix-time", "type": "integer" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "expires_at": { "description": "The time when the billing credits expire. If not specified, the billing credits don't expire.", "format": "unix-time", "type": "integer" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of key-value pairs that you can attach to an object. You can use this to store additional information about the object (for example, cost basis) in a structured format.", "type": "object" }, "name": { "description": "A descriptive name shown in the Dashboard.", "maxLength": 100, "type": "string" }, "priority": { "description": "The desired priority for applying this credit grant. If not specified, it will be set to the default value of 50. The highest priority is 0 and the lowest is 100.", "type": "integer" } }, "required": [ "amount", "applicability_config", "category" ], "type": "object", "x-stripeMostCommon": [ "amount", "applicability_config", "category", "customer", "customer_account", "effective_at", "expires_at", "metadata", "name", "priority" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/billing.credit_grant" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a credit grant" } }, "/v1/billing/credit_grants/{id}": { "get": { "description": "

Retrieves a credit grant.

", "operationId": "GetBillingCreditGrantsId", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "Unique identifier for the object.", "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/billing.credit_grant" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a credit grant" }, "post": { "description": "

Updates a credit grant.

", "operationId": "PostBillingCreditGrantsId", "parameters": [ { "description": "Unique identifier for the object.", "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "expires_at": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "expires_at": { "anyOf": [ { "format": "unix-time", "type": "integer" }, { "enum": [ "" ], "type": "string" } ], "description": "The time when the billing credits created by this credit grant expire. If set to empty, the billing credits never expire." }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of key-value pairs you can attach to an object. You can use this to store additional information about the object (for example, cost basis) in a structured format.", "type": "object" } }, "type": "object", "x-stripeMostCommon": [ "expires_at", "metadata" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/billing.credit_grant" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a credit grant" } }, "/v1/billing/credit_grants/{id}/expire": { "post": { "description": "

Expires a credit grant.

", "operationId": "PostBillingCreditGrantsIdExpire", "parameters": [ { "description": "Unique identifier for the object.", "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/billing.credit_grant" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Expire a credit grant" } }, "/v1/billing/credit_grants/{id}/void": { "post": { "description": "

Voids a credit grant.

", "operationId": "PostBillingCreditGrantsIdVoid", "parameters": [ { "description": "Unique identifier for the object.", "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/billing.credit_grant" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Void a credit grant" } }, "/v1/billing/margins": { "get": { "description": "

Retrieve a list of your margins.

", "operationId": "GetBillingMargins", "parameters": [ { "description": "Only return margins that are active or inactive. For example, pass `true` to only list active margins.", "in": "query", "name": "active", "required": false, "schema": { "type": "boolean" }, "style": "form" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/margin" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/billing/margins", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "MarginList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all margins" }, "post": { "description": "

Create a margin object to be used with invoices, invoice items, and invoice line items for a customer to represent a partner discount. A margin has a percent_off which is the percent that will be taken off the subtotal after all items and other discounts and promotions) of any invoices for a customer. Calculation of prorations do not include any partner margins applied on the original invoice item.

", "operationId": "PostBillingMargins", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "active": { "description": "Whether the margin can be applied to invoices, invoice items, or invoice line items or not. Defaults to `true`.", "type": "boolean" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "name": { "description": "Name of the margin, which is displayed to customers, such as on invoices.", "maxLength": 5000, "type": "string" }, "percent_off": { "description": "Percent that will be taken off the subtotal before tax (after all other discounts and promotions) of any invoice to which the margin is applied.", "type": "number" } }, "required": [ "percent_off" ], "type": "object", "x-stripeMostCommon": [ "active", "metadata", "name", "percent_off" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/margin" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a margin" } }, "/v1/billing/margins/{margin}": { "get": { "description": "

Retrieve a margin object with the given ID.

", "operationId": "GetBillingMarginsMargin", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "margin", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/margin" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a margin" }, "post": { "description": "

Update the specified margin object. Certain fields of the margin object are not editable.

", "operationId": "PostBillingMarginsMargin", "parameters": [ { "in": "path", "name": "margin", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "active": { "description": "Whether the margin can be applied to invoices, invoice items, or invoice line items or not.", "type": "boolean" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "name": { "description": "Name of the margin, which is displayed to customers, such as on invoices.", "maxLength": 5000, "type": "string" } }, "type": "object", "x-stripeMostCommon": [ "active", "metadata", "name" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/margin" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a margin" } }, "/v1/billing/meter_event_adjustments": { "post": { "description": "

Creates a billing meter event adjustment.

", "operationId": "PostBillingMeterEventAdjustments", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "cancel": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "cancel": { "description": "Specifies which event to cancel.", "properties": { "identifier": { "description": "Unique identifier for the event. You can only cancel events within 24 hours of Stripe receiving them.", "maxLength": 100, "type": "string" } }, "title": "event_adjustment_cancel_settings_param", "type": "object", "x-stripeMostCommon": [ "identifier" ] }, "event_name": { "description": "The name of the meter event. Corresponds with the `event_name` field on a meter.", "maxLength": 100, "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "type": { "description": "Specifies whether to cancel a single event or a range of events for a time period. Time period cancellation is not supported yet.", "enum": [ "cancel" ], "type": "string" } }, "required": [ "event_name", "type" ], "type": "object", "x-stripeMostCommon": [ "cancel", "event_name", "type" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/billing.meter_event_adjustment" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a billing meter event adjustment" } }, "/v1/billing/meter_events": { "post": { "description": "

Creates a billing meter event.

", "operationId": "PostBillingMeterEvents", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "payload": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "event_name": { "description": "The name of the meter event. Corresponds with the `event_name` field on a meter.", "maxLength": 100, "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "identifier": { "description": "A unique identifier for the event. If not provided, one is generated. We recommend using UUID-like identifiers. We will enforce uniqueness within a rolling period of at least 24 hours. The enforcement of uniqueness primarily addresses issues arising from accidental retries or other problems occurring within extremely brief time intervals. This approach helps prevent duplicate entries and ensures data integrity in high-frequency operations.", "maxLength": 100, "type": "string" }, "payload": { "additionalProperties": { "type": "string" }, "description": "The payload of the event. This must contain the fields corresponding to a meter's `customer_mapping.event_payload_key` (default is `stripe_customer_id`) and `value_settings.event_payload_key` (default is `value`). Read more about the [payload](https://docs.stripe.com/billing/subscriptions/usage-based/recording-usage#payload-key-overrides).", "type": "object" }, "timestamp": { "description": "The time of the event. Measured in seconds since the Unix epoch. Must be within the past 35 calendar days or up to 5 minutes in the future. Defaults to current timestamp if not specified.", "format": "unix-time", "type": "integer" } }, "required": [ "event_name", "payload" ], "type": "object", "x-stripeMostCommon": [ "event_name", "identifier", "payload", "timestamp" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/billing.meter_event" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a billing meter event" } }, "/v1/billing/meters": { "get": { "description": "

Retrieve a list of billing meters.

", "operationId": "GetBillingMeters", "parameters": [ { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Filter results to only include meters with the given status.", "in": "query", "name": "status", "required": false, "schema": { "enum": [ "active", "inactive" ], "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/billing.meter" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/billing/meters", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "BillingMeterResourceBillingMeterList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List billing meters" }, "post": { "description": "

Creates a billing meter.

", "operationId": "PostBillingMeters", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "customer_mapping": { "explode": true, "style": "deepObject" }, "default_aggregation": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "value_settings": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "customer_mapping": { "description": "Fields that specify how to map a meter event to a customer.", "properties": { "event_payload_key": { "description": "The key in the meter event payload to use for mapping the event to a customer.", "maxLength": 100, "type": "string" }, "type": { "description": "The method for mapping a meter event to a customer. Must be `by_id`.", "enum": [ "by_id" ], "type": "string" } }, "required": [ "event_payload_key", "type" ], "title": "customer_mapping_param", "type": "object", "x-stripeMostCommon": [ "event_payload_key", "type" ] }, "default_aggregation": { "description": "The default settings to aggregate a meter's events with.", "properties": { "formula": { "description": "Specifies how events are aggregated. Allowed values are `count` to count the number of events, `sum` to sum each event's value and `last` to take the last event's value in the window.", "enum": [ "count", "last", "sum" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "formula" ], "title": "aggregation_settings_param", "type": "object", "x-stripeMostCommon": [ "formula" ] }, "display_name": { "description": "The meter’s name. Not visible to the customer.", "maxLength": 250, "type": "string" }, "event_name": { "description": "The name of the meter event to record usage for. Corresponds with the `event_name` field on meter events.", "maxLength": 100, "type": "string" }, "event_time_window": { "description": "The time window which meter events have been pre-aggregated for, if any.", "enum": [ "day", "hour" ], "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "value_settings": { "description": "Fields that specify how to calculate a meter event's value.", "properties": { "event_payload_key": { "description": "The key in the usage event payload to use as the value for this meter. For example, if the event payload contains usage on a `bytes_used` field, then set the event_payload_key to \"bytes_used\".", "maxLength": 100, "type": "string" } }, "required": [ "event_payload_key" ], "title": "meter_value_settings_param", "type": "object", "x-stripeMostCommon": [ "event_payload_key" ] } }, "required": [ "default_aggregation", "display_name", "event_name" ], "type": "object", "x-stripeMostCommon": [ "customer_mapping", "default_aggregation", "display_name", "event_name", "event_time_window", "value_settings" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/billing.meter" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a billing meter" } }, "/v1/billing/meters/{id}": { "get": { "description": "

Retrieves a billing meter given an ID.

", "operationId": "GetBillingMetersId", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/billing.meter" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a billing meter" }, "post": { "description": "

Updates a billing meter.

", "operationId": "PostBillingMetersId", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "display_name": { "description": "The meter’s name. Not visible to the customer.", "maxLength": 250, "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object", "x-stripeMostCommon": [ "display_name" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/billing.meter" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a billing meter" } }, "/v1/billing/meters/{id}/deactivate": { "post": { "description": "

When a meter is deactivated, no more meter events will be accepted for this meter. You can’t attach a deactivated meter to a price.

", "operationId": "PostBillingMetersIdDeactivate", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/billing.meter" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Deactivate a billing meter" } }, "/v1/billing/meters/{id}/event_summaries": { "get": { "description": "

Retrieve a list of billing meter event summaries.

", "operationId": "GetBillingMetersIdEventSummaries", "parameters": [ { "description": "The customer for which to fetch event summaries.", "in": "query", "name": "customer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "The timestamp from when to stop aggregating meter events (exclusive). Must be aligned with minute boundaries.", "in": "query", "name": "end_time", "required": true, "schema": { "format": "unix-time", "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "Unique identifier for the object.", "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "The timestamp from when to start aggregating meter events (inclusive). Must be aligned with minute boundaries.", "in": "query", "name": "start_time", "required": true, "schema": { "format": "unix-time", "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies what granularity to use when generating event summaries. If not specified, a single event summary would be returned for the specified time range. For hourly granularity, start and end times must align with hour boundaries (e.g., 00:00, 01:00, ..., 23:00). For daily granularity, start and end times must align with UTC day boundaries (00:00 UTC).", "in": "query", "name": "value_grouping_window", "required": false, "schema": { "enum": [ "day", "hour" ], "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/billing.meter_event_summary" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/billing/meters/[^/]+/event_summaries", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "BillingMeterResourceBillingMeterEventSummaryList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List billing meter event summaries" } }, "/v1/billing/meters/{id}/reactivate": { "post": { "description": "

When a meter is reactivated, events for this meter can be accepted and you can attach the meter to a price.

", "operationId": "PostBillingMetersIdReactivate", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/billing.meter" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Reactivate a billing meter" } }, "/v1/billing_portal/configurations": { "get": { "description": "

Returns a list of configurations that describe the functionality of the customer portal.

", "operationId": "GetBillingPortalConfigurations", "parameters": [ { "description": "Only return configurations that are active or inactive (e.g., pass `true` to only list active configurations).", "in": "query", "name": "active", "required": false, "schema": { "type": "boolean" }, "style": "form" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "Only return the default or non-default configurations (e.g., pass `true` to only list the default configuration).", "in": "query", "name": "is_default", "required": false, "schema": { "type": "boolean" }, "style": "form" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/billing_portal.configuration" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/billing_portal/configurations", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "PortalPublicResourceConfigurationList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List portal configurations" }, "post": { "description": "

Creates a configuration that describes the functionality and behavior of a PortalSession

", "operationId": "PostBillingPortalConfigurations", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "business_profile": { "explode": true, "style": "deepObject" }, "default_return_url": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "features": { "explode": true, "style": "deepObject" }, "login_page": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "name": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "business_profile": { "description": "The business information shown to customers in the portal.", "properties": { "headline": { "anyOf": [ { "maxLength": 60, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "The messaging shown to customers in the portal." }, "privacy_policy_url": { "description": "A link to the business’s publicly available privacy policy.", "type": "string" }, "terms_of_service_url": { "description": "A link to the business’s publicly available terms of service.", "type": "string" } }, "title": "business_profile_create_param", "type": "object", "x-stripeMostCommon": [ "headline", "privacy_policy_url", "terms_of_service_url" ] }, "default_return_url": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "The default URL to redirect customers to when they click on the portal's link to return to your website. This can be [overriden](https://stripe.com/docs/api/customer_portal/sessions/create#create_portal_session-return_url) when creating the session." }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "features": { "description": "Information about the features available in the portal.", "properties": { "customer_update": { "description": "Information about updating the customer details in the portal.", "properties": { "allowed_updates": { "anyOf": [ { "items": { "enum": [ "address", "email", "name", "phone", "shipping", "tax_id" ], "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The types of customer updates that are supported. When empty, customers are not updateable." }, "enabled": { "description": "Whether the feature is enabled.", "type": "boolean" } }, "required": [ "enabled" ], "title": "customer_update_creation_param", "type": "object", "x-stripeMostCommon": [ "allowed_updates", "enabled" ] }, "invoice_history": { "description": "Information about showing the billing history in the portal.", "properties": { "enabled": { "description": "Whether the feature is enabled.", "type": "boolean" } }, "required": [ "enabled" ], "title": "invoice_list_param", "type": "object", "x-stripeMostCommon": [ "enabled" ] }, "payment_method_update": { "description": "Information about updating payment methods in the portal.", "properties": { "enabled": { "description": "Whether the feature is enabled.", "type": "boolean" } }, "required": [ "enabled" ], "title": "payment_method_update_param", "type": "object", "x-stripeMostCommon": [ "enabled" ] }, "subscription_cancel": { "description": "Information about canceling subscriptions in the portal.", "properties": { "cancellation_reason": { "description": "Whether the cancellation reasons will be collected in the portal and which options are exposed to the customer", "properties": { "enabled": { "description": "Whether the feature is enabled.", "type": "boolean" }, "options": { "anyOf": [ { "items": { "enum": [ "customer_service", "low_quality", "missing_features", "other", "switched_service", "too_complex", "too_expensive", "unused" ], "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "Which cancellation reasons will be given as options to the customer." } }, "required": [ "enabled", "options" ], "title": "subscription_cancellation_reason_creation_param", "type": "object", "x-stripeMostCommon": [ "enabled", "options" ] }, "enabled": { "description": "Whether the feature is enabled.", "type": "boolean" }, "mode": { "description": "Whether to cancel subscriptions immediately or at the end of the billing period.", "enum": [ "at_period_end", "immediately" ], "type": "string" }, "proration_behavior": { "description": "Whether to create prorations when canceling subscriptions. Possible values are `none` and `create_prorations`, which is only compatible with `mode=immediately`. Passing `always_invoice` will result in an error. No prorations are generated when canceling a subscription at the end of its natural billing period.", "enum": [ "always_invoice", "create_prorations", "none" ], "type": "string" } }, "required": [ "enabled" ], "title": "subscription_cancel_creation_param", "type": "object", "x-stripeMostCommon": [ "cancellation_reason", "cancellation_redirect", "enabled", "mode", "proration_behavior", "retention_options" ] }, "subscription_update": { "description": "Information about updating subscriptions in the portal.", "properties": { "default_allowed_updates": { "anyOf": [ { "items": { "enum": [ "price", "promotion_code", "quantity" ], "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The types of subscription updates that are supported. When empty, subscriptions are not updateable." }, "enabled": { "description": "Whether the feature is enabled.", "type": "boolean" }, "products": { "anyOf": [ { "items": { "properties": { "adjustable_quantity": { "description": "Control whether the quantity of the product can be adjusted.", "properties": { "enabled": { "description": "Set to true if the quantity can be adjusted to any non-negative integer.", "type": "boolean" }, "maximum": { "description": "The maximum quantity that can be set for the product.", "type": "integer" }, "minimum": { "description": "The minimum quantity that can be set for the product.", "type": "integer" } }, "required": [ "enabled" ], "title": "subscription_update_product_adjustable_quantity_param", "type": "object", "x-stripeMostCommon": [ "enabled", "maximum", "minimum" ] }, "prices": { "description": "The list of price IDs for the product that a subscription can be updated to.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "product": { "description": "The product id.", "maxLength": 5000, "type": "string" } }, "required": [ "prices", "product" ], "title": "subscription_update_product_param", "type": "object", "x-stripeMostCommon": [ "adjustable_quantity", "prices", "product" ] }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The list of up to 10 products that support subscription updates." }, "proration_behavior": { "description": "Determines how to handle prorations resulting from subscription updates. Valid values are `none`, `create_prorations`, and `always_invoice`.", "enum": [ "always_invoice", "create_prorations", "none" ], "type": "string" }, "schedule_at_period_end": { "description": "Setting to control when an update should be scheduled at the end of the period instead of applying immediately.", "properties": { "conditions": { "description": "List of conditions. When any condition is true, the update will be scheduled at the end of the current period.", "items": { "properties": { "type": { "description": "The type of condition.", "enum": [ "decreasing_item_amount", "shortening_interval" ], "type": "string" } }, "required": [ "type" ], "title": "schedule_update_at_period_end_condition_param", "type": "object", "x-stripeMostCommon": [ "type" ] }, "type": "array" } }, "title": "schedule_update_at_period_end_creating_param", "type": "object", "x-stripeMostCommon": [ "conditions" ] }, "trial_update_behavior": { "description": "The behavior when updating a subscription that is trialing.", "enum": [ "continue_trial", "end_trial" ], "type": "string" } }, "required": [ "enabled" ], "title": "subscription_update_creation_param", "type": "object", "x-stripeMostCommon": [ "billing_cycle_anchor", "default_allowed_updates", "enabled", "products", "proration_behavior", "proration_date", "schedule_at_period_end", "trial_update_behavior" ] } }, "title": "features_creation_param", "type": "object", "x-stripeMostCommon": [ "customer_update", "invoice_history", "payment_method_update", "subscription_cancel", "subscription_update" ] }, "login_page": { "description": "The hosted login page for this configuration. Learn more about the portal login page in our [integration docs](https://stripe.com/docs/billing/subscriptions/integrating-customer-portal#share).", "properties": { "enabled": { "description": "Set to `true` to generate a shareable URL [`login_page.url`](https://stripe.com/docs/api/customer_portal/configuration#portal_configuration_object-login_page-url) that will take your customers to a hosted login page for the customer portal.", "type": "boolean" } }, "required": [ "enabled" ], "title": "login_page_create_param", "type": "object", "x-stripeMostCommon": [ "enabled" ] }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "name": { "anyOf": [ { "maxLength": 256, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "The name of the configuration." } }, "required": [ "features" ], "type": "object", "x-stripeMostCommon": [ "business_profile", "default_return_url", "features", "login_page", "metadata", "name" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/billing_portal.configuration" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a portal configuration" } }, "/v1/billing_portal/configurations/{configuration}": { "get": { "description": "

Retrieves a configuration that describes the functionality of the customer portal.

", "operationId": "GetBillingPortalConfigurationsConfiguration", "parameters": [ { "in": "path", "name": "configuration", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/billing_portal.configuration" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a portal configuration" }, "post": { "description": "

Updates a configuration that describes the functionality of the customer portal.

", "operationId": "PostBillingPortalConfigurationsConfiguration", "parameters": [ { "in": "path", "name": "configuration", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "business_profile": { "explode": true, "style": "deepObject" }, "default_return_url": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "features": { "explode": true, "style": "deepObject" }, "login_page": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "name": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "active": { "description": "Whether the configuration is active and can be used to create portal sessions.", "type": "boolean" }, "business_profile": { "description": "The business information shown to customers in the portal.", "properties": { "headline": { "anyOf": [ { "maxLength": 60, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "The messaging shown to customers in the portal." }, "privacy_policy_url": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "A link to the business’s publicly available privacy policy." }, "terms_of_service_url": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "A link to the business’s publicly available terms of service." } }, "title": "business_profile_update_param", "type": "object", "x-stripeMostCommon": [ "headline", "privacy_policy_url", "terms_of_service_url" ] }, "default_return_url": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "The default URL to redirect customers to when they click on the portal's link to return to your website. This can be [overriden](https://stripe.com/docs/api/customer_portal/sessions/create#create_portal_session-return_url) when creating the session." }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "features": { "description": "Information about the features available in the portal.", "properties": { "customer_update": { "description": "Information about updating the customer details in the portal.", "properties": { "allowed_updates": { "anyOf": [ { "items": { "enum": [ "address", "email", "name", "phone", "shipping", "tax_id" ], "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The types of customer updates that are supported. When empty, customers are not updateable." }, "enabled": { "description": "Whether the feature is enabled.", "type": "boolean" } }, "title": "customer_update_updating_param", "type": "object", "x-stripeMostCommon": [ "allowed_updates", "enabled" ] }, "invoice_history": { "description": "Information about showing the billing history in the portal.", "properties": { "enabled": { "description": "Whether the feature is enabled.", "type": "boolean" } }, "required": [ "enabled" ], "title": "invoice_list_param", "type": "object", "x-stripeMostCommon": [ "enabled" ] }, "payment_method_update": { "description": "Information about updating payment methods in the portal.", "properties": { "enabled": { "description": "Whether the feature is enabled.", "type": "boolean" } }, "required": [ "enabled" ], "title": "payment_method_update_param", "type": "object", "x-stripeMostCommon": [ "enabled" ] }, "subscription_cancel": { "description": "Information about canceling subscriptions in the portal.", "properties": { "cancellation_reason": { "description": "Whether the cancellation reasons will be collected in the portal and which options are exposed to the customer", "properties": { "enabled": { "description": "Whether the feature is enabled.", "type": "boolean" }, "options": { "anyOf": [ { "items": { "enum": [ "customer_service", "low_quality", "missing_features", "other", "switched_service", "too_complex", "too_expensive", "unused" ], "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "Which cancellation reasons will be given as options to the customer." } }, "required": [ "enabled" ], "title": "subscription_cancellation_reason_updating_param", "type": "object", "x-stripeMostCommon": [ "enabled", "options" ] }, "enabled": { "description": "Whether the feature is enabled.", "type": "boolean" }, "mode": { "description": "Whether to cancel subscriptions immediately or at the end of the billing period.", "enum": [ "at_period_end", "immediately" ], "type": "string" }, "proration_behavior": { "description": "Whether to create prorations when canceling subscriptions. Possible values are `none` and `create_prorations`, which is only compatible with `mode=immediately`. Passing `always_invoice` will result in an error. No prorations are generated when canceling a subscription at the end of its natural billing period.", "enum": [ "always_invoice", "create_prorations", "none" ], "type": "string" } }, "title": "subscription_cancel_updating_param", "type": "object", "x-stripeMostCommon": [ "cancellation_reason", "cancellation_redirect", "enabled", "mode", "proration_behavior", "retention_options" ] }, "subscription_update": { "description": "Information about updating subscriptions in the portal.", "properties": { "default_allowed_updates": { "anyOf": [ { "items": { "enum": [ "price", "promotion_code", "quantity" ], "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The types of subscription updates that are supported. When empty, subscriptions are not updateable." }, "enabled": { "description": "Whether the feature is enabled.", "type": "boolean" }, "products": { "anyOf": [ { "items": { "properties": { "adjustable_quantity": { "description": "Control whether the quantity of the product can be adjusted.", "properties": { "enabled": { "description": "Set to true if the quantity can be adjusted to any non-negative integer.", "type": "boolean" }, "maximum": { "description": "The maximum quantity that can be set for the product.", "type": "integer" }, "minimum": { "description": "The minimum quantity that can be set for the product.", "type": "integer" } }, "required": [ "enabled" ], "title": "subscription_update_product_adjustable_quantity_param", "type": "object", "x-stripeMostCommon": [ "enabled", "maximum", "minimum" ] }, "prices": { "description": "The list of price IDs for the product that a subscription can be updated to.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "product": { "description": "The product id.", "maxLength": 5000, "type": "string" } }, "required": [ "prices", "product" ], "title": "subscription_update_product_param", "type": "object", "x-stripeMostCommon": [ "adjustable_quantity", "prices", "product" ] }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The list of up to 10 products that support subscription updates." }, "proration_behavior": { "description": "Determines how to handle prorations resulting from subscription updates. Valid values are `none`, `create_prorations`, and `always_invoice`.", "enum": [ "always_invoice", "create_prorations", "none" ], "type": "string" }, "schedule_at_period_end": { "description": "Setting to control when an update should be scheduled at the end of the period instead of applying immediately.", "properties": { "conditions": { "anyOf": [ { "items": { "properties": { "type": { "description": "The type of condition.", "enum": [ "decreasing_item_amount", "shortening_interval" ], "type": "string" } }, "required": [ "type" ], "title": "schedule_update_at_period_end_condition_param", "type": "object", "x-stripeMostCommon": [ "type" ] }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "List of conditions. When any condition is true, the update will be scheduled at the end of the current period." } }, "title": "schedule_update_at_period_end_updating_param", "type": "object", "x-stripeMostCommon": [ "conditions" ] }, "trial_update_behavior": { "description": "The behavior when updating a subscription that is trialing.", "enum": [ "continue_trial", "end_trial" ], "type": "string" } }, "title": "subscription_update_updating_param", "type": "object", "x-stripeMostCommon": [ "billing_cycle_anchor", "default_allowed_updates", "enabled", "products", "proration_behavior", "proration_date", "schedule_at_period_end", "trial_update_behavior" ] } }, "title": "features_updating_param", "type": "object", "x-stripeMostCommon": [ "customer_update", "invoice_history", "payment_method_update", "subscription_cancel", "subscription_update" ] }, "login_page": { "description": "The hosted login page for this configuration. Learn more about the portal login page in our [integration docs](https://stripe.com/docs/billing/subscriptions/integrating-customer-portal#share).", "properties": { "enabled": { "description": "Set to `true` to generate a shareable URL [`login_page.url`](https://stripe.com/docs/api/customer_portal/configuration#portal_configuration_object-login_page-url) that will take your customers to a hosted login page for the customer portal.\n\nSet to `false` to deactivate the `login_page.url`.", "type": "boolean" } }, "required": [ "enabled" ], "title": "login_page_update_param", "type": "object", "x-stripeMostCommon": [ "enabled" ] }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "name": { "anyOf": [ { "maxLength": 256, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "The name of the configuration." } }, "type": "object", "x-stripeMostCommon": [ "active", "business_profile", "default_return_url", "features", "login_page", "metadata", "name" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/billing_portal.configuration" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a portal configuration" } }, "/v1/billing_portal/sessions": { "post": { "description": "

Creates a session of the customer portal.

", "operationId": "PostBillingPortalSessions", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "flow_data": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "configuration": { "description": "The ID of an existing [configuration](https://stripe.com/docs/api/customer_portal/configuration) to use for this session, describing its functionality and features. If not specified, the session uses the default configuration.", "maxLength": 5000, "type": "string" }, "customer": { "description": "The ID of an existing customer.", "maxLength": 5000, "type": "string" }, "customer_account": { "description": "The ID of an existing account.", "maxLength": 5000, "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "flow_data": { "description": "Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows.", "properties": { "after_completion": { "description": "Behavior after the flow is completed.", "properties": { "hosted_confirmation": { "description": "Configuration when `after_completion.type=hosted_confirmation`.", "properties": { "custom_message": { "description": "A custom message to display to the customer after the flow is completed.", "maxLength": 500, "type": "string" } }, "title": "after_completion_hosted_confirmation_param", "type": "object", "x-stripeMostCommon": [ "custom_message" ] }, "redirect": { "description": "Configuration when `after_completion.type=redirect`.", "properties": { "return_url": { "description": "The URL the customer will be redirected to after the flow is completed.", "type": "string" } }, "required": [ "return_url" ], "title": "after_completion_redirect_param", "type": "object", "x-stripeMostCommon": [ "return_url" ] }, "type": { "description": "The specified behavior after the flow is completed.", "enum": [ "hosted_confirmation", "portal_homepage", "redirect" ], "type": "string" } }, "required": [ "type" ], "title": "flow_data_after_completion_param", "type": "object", "x-stripeMostCommon": [ "hosted_confirmation", "redirect", "type" ] }, "subscription_cancel": { "description": "Configuration when `flow_data.type=subscription_cancel`.", "properties": { "retention": { "description": "Specify a retention strategy to be used in the cancellation flow.", "properties": { "coupon_offer": { "description": "Configuration when `retention.type=coupon_offer`.", "properties": { "coupon": { "description": "The ID of the coupon to be offered.", "maxLength": 5000, "type": "string" } }, "required": [ "coupon" ], "title": "coupon_offer_param", "type": "object", "x-stripeMostCommon": [ "coupon" ] }, "type": { "description": "Type of retention strategy to use with the customer.", "enum": [ "coupon_offer" ], "type": "string" } }, "required": [ "coupon_offer", "type" ], "title": "retention_param", "type": "object", "x-stripeMostCommon": [ "coupon_offer", "type" ] }, "subscription": { "description": "The ID of the subscription to be canceled.", "maxLength": 5000, "type": "string" } }, "required": [ "subscription" ], "title": "flow_data_subscription_cancel_param", "type": "object", "x-stripeMostCommon": [ "retention", "subscription" ] }, "subscription_update": { "description": "Configuration when `flow_data.type=subscription_update`.", "properties": { "subscription": { "description": "The ID of the subscription to be updated.", "maxLength": 5000, "type": "string" } }, "required": [ "subscription" ], "title": "flow_data_subscription_update_param", "type": "object", "x-stripeMostCommon": [ "subscription" ] }, "subscription_update_confirm": { "description": "Configuration when `flow_data.type=subscription_update_confirm`.", "properties": { "discounts": { "description": "The coupon or promotion code to apply to this subscription update.", "items": { "properties": { "coupon": { "description": "The ID of the coupon to apply to this subscription update.", "maxLength": 5000, "type": "string" }, "promotion_code": { "description": "The ID of a promotion code to apply to this subscription update.", "maxLength": 5000, "type": "string" } }, "title": "subscription_update_confirm_discount_params", "type": "object", "x-stripeMostCommon": [ "coupon", "promotion_code" ] }, "type": "array" }, "items": { "description": "The [subscription item](https://stripe.com/docs/api/subscription_items) to be updated through this flow. Currently, only up to one may be specified and subscriptions with multiple items are not updatable.", "items": { "properties": { "id": { "description": "The ID of the [subscription item](https://stripe.com/docs/api/subscriptions/object#subscription_object-items-data-id) to be updated.", "maxLength": 5000, "type": "string" }, "price": { "description": "The price the customer should subscribe to through this flow. The price must also be included in the configuration's [`features.subscription_update.products`](https://stripe.com/docs/api/customer_portal/configuration#portal_configuration_object-features-subscription_update-products).", "maxLength": 5000, "type": "string" }, "quantity": { "description": "[Quantity](https://stripe.com/docs/subscriptions/quantities) for this item that the customer should subscribe to through this flow.", "type": "integer" } }, "required": [ "id" ], "title": "subscription_update_confirm_item_params", "type": "object", "x-stripeMostCommon": [ "deleted", "id", "price", "quantity" ] }, "type": "array" }, "subscription": { "description": "The ID of the subscription to be updated.", "maxLength": 5000, "type": "string" } }, "required": [ "items", "subscription" ], "title": "flow_data_subscription_update_confirm_param", "type": "object", "x-stripeMostCommon": [ "discounts", "items", "recurring_items", "subscription" ] }, "type": { "description": "Type of flow that the customer will go through.", "enum": [ "payment_method_update", "subscription_cancel", "subscription_update", "subscription_update_confirm" ], "type": "string" } }, "required": [ "type" ], "title": "flow_data_param", "type": "object", "x-stripeMostCommon": [ "after_completion", "subscription_cancel", "subscription_update", "subscription_update_confirm", "type" ] }, "locale": { "description": "The IETF language tag of the locale customer portal is displayed in. If blank or auto, the customer’s `preferred_locales` or browser’s locale is used.", "enum": [ "auto", "bg", "cs", "da", "de", "el", "en", "en-AU", "en-CA", "en-GB", "en-IE", "en-IN", "en-NZ", "en-SG", "es", "es-419", "et", "fi", "fil", "fr", "fr-CA", "hr", "hu", "id", "it", "ja", "ko", "lt", "lv", "ms", "mt", "nb", "nl", "pl", "pt", "pt-BR", "ro", "ru", "sk", "sl", "sv", "th", "tr", "vi", "zh", "zh-HK", "zh-TW" ], "type": "string" }, "on_behalf_of": { "description": "The `on_behalf_of` account to use for this session. When specified, only subscriptions and invoices with this `on_behalf_of` account appear in the portal. For more information, see the [docs](https://stripe.com/docs/connect/separate-charges-and-transfers#settlement-merchant). Use the [Accounts API](https://stripe.com/docs/api/accounts/object#account_object-settings-branding) to modify the `on_behalf_of` account's branding settings, which the portal displays.", "type": "string" }, "return_url": { "description": "The default URL to redirect customers to when they click on the portal's link to return to your website.", "type": "string" } }, "type": "object", "x-stripeMostCommon": [ "configuration", "customer", "customer_account", "flow_data", "locale", "on_behalf_of", "return_url" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/billing_portal.session" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a portal session" } }, "/v1/capital/financing_offers": { "get": { "description": "

Retrieves the financing offers available for Connected accounts that belong to your platform.

", "operationId": "GetCapitalFinancingOffers", "parameters": [ { "description": "limit list to offers belonging to given connected account", "in": "query", "name": "connected_account", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Only return offers that were created during the given date interval.", "explode": true, "in": "query", "name": "created", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "description": "Minimum value to filter by (exclusive)", "type": "integer" }, "gte": { "description": "Minimum value to filter by (inclusive)", "type": "integer" }, "lt": { "description": "Maximum value to filter by (exclusive)", "type": "integer" }, "lte": { "description": "Maximum value to filter by (inclusive)", "type": "integer" } }, "title": "range_query_specs", "type": "object", "x-stripeMostCommon": [ "gt", "gte", "lt", "lte" ] }, { "type": "integer" } ] }, "style": "deepObject" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "limit list to offers with given status", "in": "query", "name": "status", "required": false, "schema": { "enum": [ "accepted", "canceled", "completed", "delivered", "expired", "fully_repaid", "paid_out", "rejected", "revoked", "undelivered" ], "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/capital.financing_offer" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/capital/financing_offers", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "CapitalConnectConnectFinancingList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List financing offers" } }, "/v1/capital/financing_offers/{financing_offer}": { "get": { "description": "

Get the details of the financing offer

", "operationId": "GetCapitalFinancingOffersFinancingOffer", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "financing_offer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capital.financing_offer" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a given financing offer" } }, "/v1/capital/financing_offers/{financing_offer}/mark_delivered": { "post": { "description": "

Acknowledges that platform has received and delivered the financing_offer to\nthe intended merchant recipient.

", "operationId": "PostCapitalFinancingOffersFinancingOfferMarkDelivered", "parameters": [ { "in": "path", "name": "financing_offer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capital.financing_offer" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Mark that a financing offer has been delivered" } }, "/v1/capital/financing_summary": { "get": { "description": "

Retrieve the financing state for the account that was authenticated in the request.

", "operationId": "GetCapitalFinancingSummary", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capital.financing_summary" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve financing summary" } }, "/v1/capital/financing_transactions": { "get": { "description": "

Returns a list of financing transactions. The transactions are returned in sorted order,\nwith the most recent transactions appearing first.

", "operationId": "GetCapitalFinancingTransactions", "parameters": [ { "description": "For transactions of type `paydown` and reason `automatic_withholding` only, only returns transactions that were created as a result of this charge.", "in": "query", "name": "charge", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "Returns transactions that were created that apply to this financing offer ID.", "in": "query", "name": "financing_offer", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "Only returns transactions that are responsible for reversing this financing transaction ID.", "in": "query", "name": "reversed_transaction", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "For transactions of type `paydown` and reason `automatic_withholding` only, only returns transactions that were created as a result of this Treasury Transaction.", "in": "query", "name": "treasury_transaction", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/capital.financing_transaction" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "CapitalConnectFinancingTransactionList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all financing transactions" } }, "/v1/capital/financing_transactions/{financing_transaction}": { "get": { "description": "

Retrieves a financing transaction for a financing offer.

", "operationId": "GetCapitalFinancingTransactionsFinancingTransaction", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "financing_transaction", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capital.financing_transaction" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a given financing transaction." } }, "/v1/charges": { "get": { "description": "

Returns a list of charges you’ve previously created. The charges are returned in sorted order, with the most recent charges appearing first.

", "operationId": "GetCharges", "parameters": [ { "description": "Only return charges that were created during the given date interval.", "explode": true, "in": "query", "name": "created", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "description": "Minimum value to filter by (exclusive)", "type": "integer" }, "gte": { "description": "Minimum value to filter by (inclusive)", "type": "integer" }, "lt": { "description": "Maximum value to filter by (exclusive)", "type": "integer" }, "lte": { "description": "Maximum value to filter by (inclusive)", "type": "integer" } }, "title": "range_query_specs", "type": "object", "x-stripeMostCommon": [ "gt", "gte", "lt", "lte" ] }, { "type": "integer" } ] }, "style": "deepObject" }, { "description": "Only return charges for the customer specified by this customer ID.", "in": "query", "name": "customer", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "Only return charges that were created by the PaymentIntent specified by this PaymentIntent ID.", "in": "query", "name": "payment_intent", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "type": "string" }, "style": "form" }, { "description": "Only return charges for this transfer group, limited to 100.", "in": "query", "name": "transfer_group", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/charge" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/charges", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "ChargeList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all charges" }, "post": { "description": "

This method is no longer recommended—use the Payment Intents API\nto initiate a new payment instead. Confirmation of the PaymentIntent creates the Charge\nobject used to request payment.

", "operationId": "PostCharges", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "destination": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "radar_options": { "explode": true, "style": "deepObject" }, "shipping": { "explode": true, "style": "deepObject" }, "transfer_data": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "amount": { "description": "Amount intended to be collected by this payment. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).", "type": "integer" }, "application_fee": { "type": "integer" }, "application_fee_amount": { "description": "A fee in cents (or local equivalent) that will be applied to the charge and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the `Stripe-Account` header in order to take an application fee. For more information, see the application fees [documentation](https://stripe.com/docs/connect/direct-charges#collect-fees).", "type": "integer" }, "capture": { "description": "Whether to immediately capture the charge. Defaults to `true`. When `false`, the charge issues an authorization (or pre-authorization), and will need to be [captured](https://stripe.com/docs/api#capture_charge) later. Uncaptured charges expire after a set number of days (7 by default). For more information, see the [authorizing charges and settling later](https://stripe.com/docs/charges/placing-a-hold) documentation.", "type": "boolean" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "customer": { "description": "The ID of an existing customer that will be charged in this request.", "maxLength": 500, "type": "string" }, "description": { "description": "An arbitrary string which you can attach to a `Charge` object. It is displayed when in the web interface alongside the charge. Note that if you use Stripe to send automatic email receipts to your customers, your receipt emails will include the `description` of the charge(s) that they are describing.", "maxLength": 40000, "type": "string" }, "destination": { "properties": { "account": { "description": "ID of an existing, connected Stripe account.", "maxLength": 5000, "type": "string" }, "amount": { "description": "The amount to transfer to the destination account without creating an `Application Fee` object. Cannot be combined with the `application_fee` parameter. Must be less than or equal to the charge amount.", "type": "integer" } }, "required": [ "account" ], "title": "destination_specs", "type": "object", "x-stripeMostCommon": [ "account", "amount" ] }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "on_behalf_of": { "description": "The Stripe account ID for which these funds are intended. Automatically set if you use the `destination` parameter. For details, see [Creating Separate Charges and Transfers](https://stripe.com/docs/connect/separate-charges-and-transfers#settlement-merchant).", "maxLength": 5000, "type": "string" }, "radar_options": { "description": "Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.", "properties": { "session": { "description": "A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.", "maxLength": 5000, "type": "string" } }, "title": "radar_options_with_hidden_options", "type": "object", "x-stripeMostCommon": [ "session", "skip_rules" ] }, "receipt_email": { "description": "The email address to which this charge's [receipt](https://stripe.com/docs/dashboard/receipts) will be sent. The receipt will not be sent until the charge is paid, and no receipts will be sent for test mode charges. If this charge is for a [Customer](https://stripe.com/docs/api/customers/object), the email address specified here will override the customer's email address. If `receipt_email` is specified for a charge in live mode, a receipt will be sent regardless of your [email settings](https://dashboard.stripe.com/account/emails).", "type": "string" }, "shipping": { "description": "Shipping information for the charge. Helps prevent fraud on charges for physical goods.", "properties": { "address": { "description": "Shipping address.", "properties": { "city": { "description": "City, district, suburb, town, or village.", "maxLength": 5000, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Address line 1 (e.g., street, PO Box, or company name).", "maxLength": 5000, "type": "string" }, "line2": { "description": "Address line 2 (e.g., apartment, suite, unit, or building).", "maxLength": 5000, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "State, county, province, or region.", "maxLength": 5000, "type": "string" } }, "title": "optional_fields_address", "type": "object", "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state" ] }, "carrier": { "description": "The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.", "maxLength": 5000, "type": "string" }, "name": { "description": "Recipient name.", "maxLength": 5000, "type": "string" }, "phone": { "description": "Recipient phone (including extension).", "maxLength": 5000, "type": "string" }, "tracking_number": { "description": "The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.", "maxLength": 5000, "type": "string" } }, "required": [ "address", "name" ], "title": "optional_fields_shipping", "type": "object", "x-stripeMostCommon": [ "address", "carrier", "name", "phone", "tracking_number" ] }, "source": { "description": "A payment source to be charged. This can be the ID of a [card](https://stripe.com/docs/api#cards) (i.e., credit or debit card), a [bank account](https://stripe.com/docs/api#bank_accounts), a [source](https://stripe.com/docs/api#sources), a [token](https://stripe.com/docs/api#tokens), or a [connected account](https://stripe.com/docs/connect/account-debits#charging-a-connected-account). For certain sources---namely, [cards](https://stripe.com/docs/api#cards), [bank accounts](https://stripe.com/docs/api#bank_accounts), and attached [sources](https://stripe.com/docs/api#sources)---you must also pass the ID of the associated customer.", "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true }, "statement_descriptor": { "description": "For a non-card charge, text that appears on the customer's statement as the statement descriptor. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).\n\nFor a card charge, this value is ignored unless you don't specify a `statement_descriptor_suffix`, in which case this value is used as the suffix.", "maxLength": 22, "type": "string" }, "statement_descriptor_suffix": { "description": "Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement. If the account has no prefix value, the suffix is concatenated to the account's statement descriptor.", "maxLength": 22, "type": "string" }, "transfer_data": { "description": "An optional dictionary including the account to automatically transfer to as part of a destination charge. [See the Connect documentation](https://stripe.com/docs/connect/destination-charges) for details.", "properties": { "amount": { "description": "The amount transferred to the destination account, if specified. By default, the entire charge amount is transferred to the destination account.", "type": "integer" }, "destination": { "description": "ID of an existing, connected Stripe account.", "maxLength": 5000, "type": "string" } }, "required": [ "destination" ], "title": "transfer_data_specs", "type": "object", "x-stripeMostCommon": [ "amount", "description", "destination" ] }, "transfer_group": { "description": "A string that identifies this transaction as part of a group. For details, see [Grouping transactions](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options).", "type": "string" } }, "type": "object", "x-stripeMostCommon": [ "amount", "application_fee", "currency", "customer", "description", "destination", "metadata", "receipt_email", "shipping", "source", "statement_descriptor", "statement_descriptor_suffix" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/charge" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } } } }, "/v1/charges/search": { "get": { "description": "

Search for charges you’ve previously created using Stripe’s Search Query Language.\nDon’t use search in read-after-write flows where strict consistency is necessary. Under normal operating\nconditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up\nto an hour behind during outages. Search functionality is not available to merchants in India.

", "operationId": "GetChargesSearch", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.", "in": "query", "name": "page", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for charges](https://stripe.com/docs/search#query-fields-for-charges).", "in": "query", "name": "query", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/charge" }, "type": "array" }, "has_more": { "type": "boolean" }, "next_page": { "maxLength": 5000, "nullable": true, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "search_result" ], "type": "string" }, "total_count": { "description": "The total number of objects that match the query, only accurate up to 10,000.", "type": "integer" }, "url": { "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "next_page", "object", "url" ], "title": "SearchResult", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "next_page", "object", "total_count", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Search charges" } }, "/v1/charges/{charge}": { "get": { "description": "

Retrieves the details of a charge that has previously been created. Supply the unique charge ID that was returned from your previous request, and Stripe will return the corresponding charge information. The same information is returned when creating or refunding the charge.

", "operationId": "GetChargesCharge", "parameters": [ { "in": "path", "name": "charge", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/charge" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a charge" }, "post": { "description": "

Updates the specified charge by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

", "operationId": "PostChargesCharge", "parameters": [ { "in": "path", "name": "charge", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "fraud_details": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "payment_details": { "explode": true, "style": "deepObject" }, "shipping": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "customer": { "description": "The ID of an existing customer that will be associated with this request. This field may only be updated if there is no existing associated customer with this charge.", "maxLength": 5000, "type": "string" }, "description": { "description": "An arbitrary string which you can attach to a charge object. It is displayed when in the web interface alongside the charge. Note that if you use Stripe to send automatic email receipts to your customers, your receipt emails will include the `description` of the charge(s) that they are describing.", "maxLength": 40000, "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "fraud_details": { "description": "A set of key-value pairs you can attach to a charge giving information about its riskiness. If you believe a charge is fraudulent, include a `user_report` key with a value of `fraudulent`. If you believe a charge is safe, include a `user_report` key with a value of `safe`. Stripe will use the information you send to improve our fraud detection algorithms.", "properties": { "user_report": { "description": "Either `safe` or `fraudulent`.", "enum": [ "", "fraudulent", "safe" ], "maxLength": 5000, "type": "string" } }, "required": [ "user_report" ], "title": "fraud_details", "type": "object", "x-stripeMostCommon": [ "user_report" ] }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "payment_details": { "description": "Provides industry-specific information about the charge.", "properties": { "car_rental": { "description": "Car rental details for this PaymentIntent.", "properties": { "affiliate": { "description": "Affiliate details for this purchase.", "properties": { "name": { "description": "The name of the affiliate that originated the purchase.", "maxLength": 5000, "type": "string" } }, "required": [ "name" ], "title": "affiliate", "type": "object", "x-stripeMostCommon": [ "name" ] }, "booking_number": { "description": "The booking number associated with the car rental.", "maxLength": 100, "type": "string" }, "car_class_code": { "description": "Class code of the car.", "maxLength": 4, "type": "string" }, "car_make": { "description": "Make of the car.", "maxLength": 10, "type": "string" }, "car_model": { "description": "Model of the car.", "maxLength": 10, "type": "string" }, "company": { "description": "The name of the rental car company.", "maxLength": 26, "type": "string" }, "customer_service_phone_number": { "description": "The customer service phone number of the car rental company.", "maxLength": 16, "type": "string" }, "days_rented": { "description": "Number of days the car is being rented.", "type": "integer" }, "delivery": { "description": "Delivery details for this purchase.", "properties": { "mode": { "description": "The delivery method for the payment", "enum": [ "email", "phone", "pickup", "post" ], "type": "string" }, "recipient": { "description": "Details of the recipient.", "properties": { "email": { "description": "The email of the recipient the ticket is delivered to.", "maxLength": 5000, "type": "string" }, "name": { "description": "The name of the recipient the ticket is delivered to.", "maxLength": 5000, "type": "string" }, "phone": { "description": "The phone number of the recipient the ticket is delivered to.", "maxLength": 5000, "type": "string" } }, "title": "delivery_recipient", "type": "object", "x-stripeMostCommon": [ "email", "name", "phone" ] } }, "title": "delivery", "type": "object", "x-stripeMostCommon": [ "mode", "recipient" ] }, "distance": { "description": "The details of the distance traveled during the rental period.", "properties": { "amount": { "description": "Distance traveled.", "type": "integer" }, "unit": { "description": "Unit of measurement for the distance traveled. One of `miles` or `kilometers`.", "enum": [ "kilometers", "miles" ], "type": "string" } }, "title": "car_rental_distance", "type": "object", "x-stripeMostCommon": [ "amount", "unit" ] }, "drivers": { "description": "The details of the passengers in the travel reservation", "items": { "properties": { "driver_identification_number": { "description": "Driver's identification number.", "maxLength": 20, "type": "string" }, "driver_tax_number": { "description": "Driver's tax number.", "maxLength": 20, "type": "string" }, "name": { "description": "Full name of the person or entity on the car reservation.", "maxLength": 5000, "type": "string" } }, "required": [ "name" ], "title": "car_rental_driver", "type": "object", "x-stripeMostCommon": [ "driver_identification_number", "driver_tax_number", "name" ] }, "type": "array" }, "extra_charges": { "description": "List of additional charges being billed.", "items": { "enum": [ "extra_mileage", "gas", "late_return", "one_way_service", "parking_violation" ], "type": "string" }, "type": "array" }, "no_show": { "description": "Indicates if the customer did not keep nor cancel their booking.", "type": "boolean" }, "pickup_address": { "description": "Car pick-up address.", "properties": { "city": { "description": "City, district, suburb, town, or village.", "maxLength": 5000, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Address line 1 (e.g., street, PO Box, or company name).", "maxLength": 5000, "type": "string" }, "line2": { "description": "Address line 2 (e.g., apartment, suite, unit, or building).", "maxLength": 5000, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "State, county, province, or region.", "maxLength": 5000, "type": "string" } }, "title": "optional_fields_address", "type": "object", "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state" ] }, "pickup_at": { "description": "Car pick-up time. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "pickup_location_name": { "description": "Name of the pickup location.", "maxLength": 38, "type": "string" }, "rate_amount": { "description": "Rental rate.", "type": "integer" }, "rate_interval": { "description": "The frequency at which the rate amount is applied. One of `day`, `week` or `month`", "enum": [ "day", "month", "week" ], "type": "string" }, "renter_name": { "description": "The name of the person or entity renting the car.", "maxLength": 100, "type": "string" }, "return_address": { "description": "Car return address.", "properties": { "city": { "description": "City, district, suburb, town, or village.", "maxLength": 5000, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Address line 1 (e.g., street, PO Box, or company name).", "maxLength": 5000, "type": "string" }, "line2": { "description": "Address line 2 (e.g., apartment, suite, unit, or building).", "maxLength": 5000, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "State, county, province, or region.", "maxLength": 5000, "type": "string" } }, "title": "optional_fields_address", "type": "object", "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state" ] }, "return_at": { "description": "Car return time. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "return_location_name": { "description": "Name of the return location.", "maxLength": 38, "type": "string" }, "tax_exempt": { "description": "Indicates whether the goods or services are tax-exempt or tax is not collected.", "type": "boolean" }, "vehicle_identification_number": { "description": "The vehicle identification number.", "maxLength": 20, "type": "string" } }, "required": [ "booking_number", "days_rented", "pickup_at", "return_at" ], "title": "car_rental", "type": "object", "x-stripeMostCommon": [ "affiliate", "booking_number", "car_class_code", "car_make", "car_model", "company", "customer_service_phone_number", "days_rented", "delivery", "distance", "drivers", "extra_charges", "no_show", "pickup_address", "pickup_at", "pickup_location_name", "rate_amount", "rate_interval", "renter_name", "return_address", "return_at", "return_location_name", "tax_exempt", "vehicle_identification_number" ] }, "customer_reference": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Some customers might be required by their company or organization to provide this information. If so, provide this value. Otherwise you can ignore this field." }, "event_details": { "description": "Event details for this PaymentIntent", "properties": { "access_controlled_venue": { "description": "Indicates if the tickets are digitally checked when entering the venue.", "type": "boolean" }, "address": { "description": "The event location's address.", "properties": { "city": { "description": "City, district, suburb, town, or village.", "maxLength": 5000, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Address line 1 (e.g., street, PO Box, or company name).", "maxLength": 5000, "type": "string" }, "line2": { "description": "Address line 2 (e.g., apartment, suite, unit, or building).", "maxLength": 5000, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "State, county, province, or region.", "maxLength": 5000, "type": "string" } }, "title": "optional_fields_address", "type": "object", "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state" ] }, "affiliate": { "description": "Affiliate details for this purchase.", "properties": { "name": { "description": "The name of the affiliate that originated the purchase.", "maxLength": 5000, "type": "string" } }, "required": [ "name" ], "title": "affiliate", "type": "object", "x-stripeMostCommon": [ "name" ] }, "company": { "description": "The name of the company", "maxLength": 5000, "type": "string" }, "delivery": { "description": "Delivery details for this purchase.", "properties": { "mode": { "description": "The delivery method for the payment", "enum": [ "email", "phone", "pickup", "post" ], "type": "string" }, "recipient": { "description": "Details of the recipient.", "properties": { "email": { "description": "The email of the recipient the ticket is delivered to.", "maxLength": 5000, "type": "string" }, "name": { "description": "The name of the recipient the ticket is delivered to.", "maxLength": 5000, "type": "string" }, "phone": { "description": "The phone number of the recipient the ticket is delivered to.", "maxLength": 5000, "type": "string" } }, "title": "delivery_recipient", "type": "object", "x-stripeMostCommon": [ "email", "name", "phone" ] } }, "title": "delivery", "type": "object", "x-stripeMostCommon": [ "mode", "recipient" ] }, "ends_at": { "description": "Event end time. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "genre": { "description": "Type of the event entertainment (concert, sports event etc)", "maxLength": 5000, "type": "string" }, "name": { "description": "The name of the event.", "maxLength": 5000, "type": "string" }, "starts_at": { "description": "Event start time. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" } }, "required": [ "name" ], "title": "event", "type": "object", "x-stripeMostCommon": [ "access_controlled_venue", "address", "affiliate", "company", "delivery", "ends_at", "genre", "name", "starts_at" ] }, "flight": { "description": "Flight reservation details for this PaymentIntent", "properties": { "affiliate": { "description": "Affiliate details for this purchase.", "properties": { "name": { "description": "The name of the affiliate that originated the purchase.", "maxLength": 5000, "type": "string" } }, "required": [ "name" ], "title": "affiliate", "type": "object", "x-stripeMostCommon": [ "name" ] }, "agency_number": { "description": "The agency number (i.e. International Air Transport Association (IATA) agency number) of the travel agency that made the booking.", "maxLength": 8, "type": "string" }, "carrier": { "description": "The International Air Transport Association (IATA) carrier code of the carrier that issued the ticket.", "maxLength": 3, "type": "string" }, "delivery": { "description": "Delivery details for this purchase.", "properties": { "mode": { "description": "The delivery method for the payment", "enum": [ "email", "phone", "pickup", "post" ], "type": "string" }, "recipient": { "description": "Details of the recipient.", "properties": { "email": { "description": "The email of the recipient the ticket is delivered to.", "maxLength": 5000, "type": "string" }, "name": { "description": "The name of the recipient the ticket is delivered to.", "maxLength": 5000, "type": "string" }, "phone": { "description": "The phone number of the recipient the ticket is delivered to.", "maxLength": 5000, "type": "string" } }, "title": "delivery_recipient", "type": "object", "x-stripeMostCommon": [ "email", "name", "phone" ] } }, "title": "delivery", "type": "object", "x-stripeMostCommon": [ "mode", "recipient" ] }, "passenger_name": { "description": "The name of the person or entity on the reservation.", "maxLength": 26, "type": "string" }, "passengers": { "description": "The details of the passengers in the travel reservation.", "items": { "properties": { "name": { "description": "Full name of the person or entity on the flight reservation.", "maxLength": 5000, "type": "string" } }, "required": [ "name" ], "title": "flight_passenger", "type": "object", "x-stripeMostCommon": [ "name" ] }, "type": "array" }, "segments": { "description": "The individual flight segments associated with the trip.", "items": { "properties": { "amount": { "description": "The flight segment amount.", "type": "integer" }, "arrival_airport": { "description": "The International Air Transport Association (IATA) airport code for the arrival airport.", "maxLength": 3, "type": "string" }, "arrives_at": { "description": "The arrival time for the flight segment. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "carrier": { "description": "The International Air Transport Association (IATA) carrier code of the carrier operating the flight segment.", "maxLength": 2, "type": "string" }, "departs_at": { "description": "The departure time for the flight segment. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "departure_airport": { "description": "The International Air Transport Association (IATA) airport code for the departure airport.", "maxLength": 3, "type": "string" }, "flight_number": { "description": "The flight number associated with the segment", "maxLength": 4, "type": "string" }, "service_class": { "description": "The fare class for the segment.", "enum": [ "business", "economy", "first", "premium_economy" ], "type": "string" } }, "required": [ "departs_at" ], "title": "flight_segment", "type": "object", "x-stripeMostCommon": [ "amount", "arrival_airport", "arrives_at", "carrier", "departs_at", "departure_airport", "flight_number", "service_class" ] }, "type": "array" }, "ticket_number": { "description": "The ticket number associated with the travel reservation.", "maxLength": 14, "type": "string" } }, "required": [ "segments" ], "title": "flight", "type": "object", "x-stripeMostCommon": [ "affiliate", "agency_number", "carrier", "delivery", "passenger_name", "passengers", "segments", "ticket_number" ] }, "lodging": { "description": "Lodging reservation details for this PaymentIntent", "properties": { "address": { "description": "The lodging location's address.", "properties": { "city": { "description": "City, district, suburb, town, or village.", "maxLength": 5000, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Address line 1 (e.g., street, PO Box, or company name).", "maxLength": 5000, "type": "string" }, "line2": { "description": "Address line 2 (e.g., apartment, suite, unit, or building).", "maxLength": 5000, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "State, county, province, or region.", "maxLength": 5000, "type": "string" } }, "title": "optional_fields_address", "type": "object", "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state" ] }, "adults": { "description": "The number of adults on the booking", "type": "integer" }, "affiliate": { "description": "Affiliate details for this purchase.", "properties": { "name": { "description": "The name of the affiliate that originated the purchase.", "maxLength": 5000, "type": "string" } }, "required": [ "name" ], "title": "affiliate", "type": "object", "x-stripeMostCommon": [ "name" ] }, "booking_number": { "description": "The booking number associated with the lodging reservation.", "maxLength": 100, "type": "string" }, "category": { "description": "The lodging category", "enum": [ "hotel", "vacation_rental" ], "type": "string" }, "checkin_at": { "description": "Lodging check-in time. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "checkout_at": { "description": "Lodging check-out time. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "customer_service_phone_number": { "description": "The customer service phone number of the lodging company.", "type": "string" }, "daily_room_rate_amount": { "description": "The daily lodging room rate.", "type": "integer" }, "delivery": { "description": "Delivery details for this purchase.", "properties": { "mode": { "description": "The delivery method for the payment", "enum": [ "email", "phone", "pickup", "post" ], "type": "string" }, "recipient": { "description": "Details of the recipient.", "properties": { "email": { "description": "The email of the recipient the ticket is delivered to.", "maxLength": 5000, "type": "string" }, "name": { "description": "The name of the recipient the ticket is delivered to.", "maxLength": 5000, "type": "string" }, "phone": { "description": "The phone number of the recipient the ticket is delivered to.", "maxLength": 5000, "type": "string" } }, "title": "delivery_recipient", "type": "object", "x-stripeMostCommon": [ "email", "name", "phone" ] } }, "title": "delivery", "type": "object", "x-stripeMostCommon": [ "mode", "recipient" ] }, "extra_charges": { "description": "List of additional charges being billed.", "items": { "enum": [ "gift_shop", "laundry", "mini_bar", "other", "restaurant", "telephone" ], "type": "string" }, "type": "array" }, "fire_safety_act_compliance": { "description": "Indicates whether the lodging location is compliant with the Fire Safety Act.", "type": "boolean" }, "name": { "description": "The name of the lodging location.", "maxLength": 100, "type": "string" }, "no_show": { "description": "Indicates if the customer did not keep their booking while failing to cancel the reservation.", "type": "boolean" }, "number_of_rooms": { "description": "The number of rooms on the booking", "type": "integer" }, "passengers": { "description": "The details of the passengers in the travel reservation", "items": { "properties": { "name": { "description": "Full name of the person or entity on the lodging reservation.", "maxLength": 5000, "type": "string" } }, "required": [ "name" ], "title": "lodging_passenger", "type": "object", "x-stripeMostCommon": [ "name" ] }, "type": "array" }, "property_phone_number": { "description": "The phone number of the lodging location.", "type": "string" }, "room_class": { "description": "The room class for this purchase.", "maxLength": 5000, "type": "string" }, "room_nights": { "description": "The number of room nights", "type": "integer" }, "total_room_tax_amount": { "description": "The total tax amount associating with the room reservation.", "type": "integer" }, "total_tax_amount": { "description": "The total tax amount", "type": "integer" } }, "required": [ "checkin_at", "checkout_at" ], "title": "lodging", "type": "object", "x-stripeMostCommon": [ "address", "adults", "affiliate", "booking_number", "category", "checkin_at", "checkout_at", "customer_service_phone_number", "daily_room_rate_amount", "delivery", "extra_charges", "fire_safety_act_compliance", "name", "no_show", "number_of_rooms", "passengers", "property_phone_number", "room_class", "room_nights", "total_room_tax_amount", "total_tax_amount" ] }, "order_reference": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "A unique value assigned by the business to identify the transaction." }, "subscription": { "description": "Subscription details for this PaymentIntent", "properties": { "affiliate": { "description": "Affiliate details for this purchase.", "properties": { "name": { "description": "The name of the affiliate that originated the purchase.", "maxLength": 5000, "type": "string" } }, "required": [ "name" ], "title": "affiliate", "type": "object", "x-stripeMostCommon": [ "name" ] }, "auto_renewal": { "description": "Info whether the subscription will be auto renewed upon expiry.", "type": "boolean" }, "billing_interval": { "description": "Subscription billing details for this purchase.", "properties": { "count": { "description": "The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.", "type": "integer" }, "interval": { "description": "Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.", "enum": [ "day", "month", "week", "year" ], "type": "string" } }, "required": [ "count", "interval" ], "title": "subscription_billing_interval", "type": "object", "x-stripeMostCommon": [ "count", "interval" ] }, "ends_at": { "description": "Subscription end time. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "name": { "description": "Name of the product on subscription. e.g. Apple Music Subscription", "maxLength": 5000, "type": "string" }, "starts_at": { "description": "Subscription start time. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" } }, "required": [ "name" ], "title": "subscription", "type": "object", "x-stripeMostCommon": [ "affiliate", "auto_renewal", "billing_interval", "ends_at", "name", "starts_at" ] } }, "title": "payment_details", "type": "object", "x-stripeMostCommon": [ "benefit", "car_rental", "car_rental_data", "event_details", "flight", "healthcare", "lodging", "lodging_data", "subscription" ] }, "receipt_email": { "description": "This is the email address that the receipt for this charge will be sent to. If this field is updated, then a new email receipt will be sent to the updated address.", "maxLength": 5000, "type": "string" }, "shipping": { "description": "Shipping information for the charge. Helps prevent fraud on charges for physical goods.", "properties": { "address": { "description": "Shipping address.", "properties": { "city": { "description": "City, district, suburb, town, or village.", "maxLength": 5000, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Address line 1 (e.g., street, PO Box, or company name).", "maxLength": 5000, "type": "string" }, "line2": { "description": "Address line 2 (e.g., apartment, suite, unit, or building).", "maxLength": 5000, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "State, county, province, or region.", "maxLength": 5000, "type": "string" } }, "title": "optional_fields_address", "type": "object", "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state" ] }, "carrier": { "description": "The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.", "maxLength": 5000, "type": "string" }, "name": { "description": "Recipient name.", "maxLength": 5000, "type": "string" }, "phone": { "description": "Recipient phone (including extension).", "maxLength": 5000, "type": "string" }, "tracking_number": { "description": "The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.", "maxLength": 5000, "type": "string" } }, "required": [ "address", "name" ], "title": "optional_fields_shipping", "type": "object", "x-stripeMostCommon": [ "address", "carrier", "name", "phone", "tracking_number" ] }, "transfer_group": { "description": "A string that identifies this transaction as part of a group. `transfer_group` may only be provided if it has not been set. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) for details.", "type": "string" } }, "type": "object", "x-stripeMostCommon": [ "customer", "description", "metadata", "receipt_email", "shipping" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/charge" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a charge" } }, "/v1/charges/{charge}/capture": { "post": { "description": "

Capture the payment of an existing, uncaptured charge that was created with the capture option set to false.

\n\n

Uncaptured payments expire a set number of days after they are created (7 by default), after which they are marked as refunded and capture attempts will fail.

\n\n

Don’t use this method to capture a PaymentIntent-initiated charge. Use Capture a PaymentIntent.

", "operationId": "PostChargesChargeCapture", "parameters": [ { "in": "path", "name": "charge", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "payment_details": { "explode": true, "style": "deepObject" }, "transfer_data": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "amount": { "description": "The amount to capture, which must be less than or equal to the original amount.", "type": "integer" }, "application_fee": { "description": "An application fee to add on to this charge.", "type": "integer" }, "application_fee_amount": { "description": "An application fee amount to add on to this charge, which must be less than or equal to the original amount.", "type": "integer" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "payment_details": { "description": "Provides industry-specific information about the charge.", "properties": { "car_rental": { "description": "Car rental details for this PaymentIntent.", "properties": { "affiliate": { "description": "Affiliate details for this purchase.", "properties": { "name": { "description": "The name of the affiliate that originated the purchase.", "maxLength": 5000, "type": "string" } }, "required": [ "name" ], "title": "affiliate", "type": "object", "x-stripeMostCommon": [ "name" ] }, "booking_number": { "description": "The booking number associated with the car rental.", "maxLength": 100, "type": "string" }, "car_class_code": { "description": "Class code of the car.", "maxLength": 4, "type": "string" }, "car_make": { "description": "Make of the car.", "maxLength": 10, "type": "string" }, "car_model": { "description": "Model of the car.", "maxLength": 10, "type": "string" }, "company": { "description": "The name of the rental car company.", "maxLength": 26, "type": "string" }, "customer_service_phone_number": { "description": "The customer service phone number of the car rental company.", "maxLength": 16, "type": "string" }, "days_rented": { "description": "Number of days the car is being rented.", "type": "integer" }, "delivery": { "description": "Delivery details for this purchase.", "properties": { "mode": { "description": "The delivery method for the payment", "enum": [ "email", "phone", "pickup", "post" ], "type": "string" }, "recipient": { "description": "Details of the recipient.", "properties": { "email": { "description": "The email of the recipient the ticket is delivered to.", "maxLength": 5000, "type": "string" }, "name": { "description": "The name of the recipient the ticket is delivered to.", "maxLength": 5000, "type": "string" }, "phone": { "description": "The phone number of the recipient the ticket is delivered to.", "maxLength": 5000, "type": "string" } }, "title": "delivery_recipient", "type": "object", "x-stripeMostCommon": [ "email", "name", "phone" ] } }, "title": "delivery", "type": "object", "x-stripeMostCommon": [ "mode", "recipient" ] }, "distance": { "description": "The details of the distance traveled during the rental period.", "properties": { "amount": { "description": "Distance traveled.", "type": "integer" }, "unit": { "description": "Unit of measurement for the distance traveled. One of `miles` or `kilometers`.", "enum": [ "kilometers", "miles" ], "type": "string" } }, "title": "car_rental_distance", "type": "object", "x-stripeMostCommon": [ "amount", "unit" ] }, "drivers": { "description": "The details of the passengers in the travel reservation", "items": { "properties": { "driver_identification_number": { "description": "Driver's identification number.", "maxLength": 20, "type": "string" }, "driver_tax_number": { "description": "Driver's tax number.", "maxLength": 20, "type": "string" }, "name": { "description": "Full name of the person or entity on the car reservation.", "maxLength": 5000, "type": "string" } }, "required": [ "name" ], "title": "car_rental_driver", "type": "object", "x-stripeMostCommon": [ "driver_identification_number", "driver_tax_number", "name" ] }, "type": "array" }, "extra_charges": { "description": "List of additional charges being billed.", "items": { "enum": [ "extra_mileage", "gas", "late_return", "one_way_service", "parking_violation" ], "type": "string" }, "type": "array" }, "no_show": { "description": "Indicates if the customer did not keep nor cancel their booking.", "type": "boolean" }, "pickup_address": { "description": "Car pick-up address.", "properties": { "city": { "description": "City, district, suburb, town, or village.", "maxLength": 5000, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Address line 1 (e.g., street, PO Box, or company name).", "maxLength": 5000, "type": "string" }, "line2": { "description": "Address line 2 (e.g., apartment, suite, unit, or building).", "maxLength": 5000, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "State, county, province, or region.", "maxLength": 5000, "type": "string" } }, "title": "optional_fields_address", "type": "object", "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state" ] }, "pickup_at": { "description": "Car pick-up time. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "pickup_location_name": { "description": "Name of the pickup location.", "maxLength": 38, "type": "string" }, "rate_amount": { "description": "Rental rate.", "type": "integer" }, "rate_interval": { "description": "The frequency at which the rate amount is applied. One of `day`, `week` or `month`", "enum": [ "day", "month", "week" ], "type": "string" }, "renter_name": { "description": "The name of the person or entity renting the car.", "maxLength": 100, "type": "string" }, "return_address": { "description": "Car return address.", "properties": { "city": { "description": "City, district, suburb, town, or village.", "maxLength": 5000, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Address line 1 (e.g., street, PO Box, or company name).", "maxLength": 5000, "type": "string" }, "line2": { "description": "Address line 2 (e.g., apartment, suite, unit, or building).", "maxLength": 5000, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "State, county, province, or region.", "maxLength": 5000, "type": "string" } }, "title": "optional_fields_address", "type": "object", "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state" ] }, "return_at": { "description": "Car return time. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "return_location_name": { "description": "Name of the return location.", "maxLength": 38, "type": "string" }, "tax_exempt": { "description": "Indicates whether the goods or services are tax-exempt or tax is not collected.", "type": "boolean" }, "vehicle_identification_number": { "description": "The vehicle identification number.", "maxLength": 20, "type": "string" } }, "required": [ "booking_number", "days_rented", "pickup_at", "return_at" ], "title": "car_rental", "type": "object", "x-stripeMostCommon": [ "affiliate", "booking_number", "car_class_code", "car_make", "car_model", "company", "customer_service_phone_number", "days_rented", "delivery", "distance", "drivers", "extra_charges", "no_show", "pickup_address", "pickup_at", "pickup_location_name", "rate_amount", "rate_interval", "renter_name", "return_address", "return_at", "return_location_name", "tax_exempt", "vehicle_identification_number" ] }, "customer_reference": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Some customers might be required by their company or organization to provide this information. If so, provide this value. Otherwise you can ignore this field." }, "event_details": { "description": "Event details for this PaymentIntent", "properties": { "access_controlled_venue": { "description": "Indicates if the tickets are digitally checked when entering the venue.", "type": "boolean" }, "address": { "description": "The event location's address.", "properties": { "city": { "description": "City, district, suburb, town, or village.", "maxLength": 5000, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Address line 1 (e.g., street, PO Box, or company name).", "maxLength": 5000, "type": "string" }, "line2": { "description": "Address line 2 (e.g., apartment, suite, unit, or building).", "maxLength": 5000, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "State, county, province, or region.", "maxLength": 5000, "type": "string" } }, "title": "optional_fields_address", "type": "object", "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state" ] }, "affiliate": { "description": "Affiliate details for this purchase.", "properties": { "name": { "description": "The name of the affiliate that originated the purchase.", "maxLength": 5000, "type": "string" } }, "required": [ "name" ], "title": "affiliate", "type": "object", "x-stripeMostCommon": [ "name" ] }, "company": { "description": "The name of the company", "maxLength": 5000, "type": "string" }, "delivery": { "description": "Delivery details for this purchase.", "properties": { "mode": { "description": "The delivery method for the payment", "enum": [ "email", "phone", "pickup", "post" ], "type": "string" }, "recipient": { "description": "Details of the recipient.", "properties": { "email": { "description": "The email of the recipient the ticket is delivered to.", "maxLength": 5000, "type": "string" }, "name": { "description": "The name of the recipient the ticket is delivered to.", "maxLength": 5000, "type": "string" }, "phone": { "description": "The phone number of the recipient the ticket is delivered to.", "maxLength": 5000, "type": "string" } }, "title": "delivery_recipient", "type": "object", "x-stripeMostCommon": [ "email", "name", "phone" ] } }, "title": "delivery", "type": "object", "x-stripeMostCommon": [ "mode", "recipient" ] }, "ends_at": { "description": "Event end time. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "genre": { "description": "Type of the event entertainment (concert, sports event etc)", "maxLength": 5000, "type": "string" }, "name": { "description": "The name of the event.", "maxLength": 5000, "type": "string" }, "starts_at": { "description": "Event start time. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" } }, "required": [ "name" ], "title": "event", "type": "object", "x-stripeMostCommon": [ "access_controlled_venue", "address", "affiliate", "company", "delivery", "ends_at", "genre", "name", "starts_at" ] }, "flight": { "description": "Flight reservation details for this PaymentIntent", "properties": { "affiliate": { "description": "Affiliate details for this purchase.", "properties": { "name": { "description": "The name of the affiliate that originated the purchase.", "maxLength": 5000, "type": "string" } }, "required": [ "name" ], "title": "affiliate", "type": "object", "x-stripeMostCommon": [ "name" ] }, "agency_number": { "description": "The agency number (i.e. International Air Transport Association (IATA) agency number) of the travel agency that made the booking.", "maxLength": 8, "type": "string" }, "carrier": { "description": "The International Air Transport Association (IATA) carrier code of the carrier that issued the ticket.", "maxLength": 3, "type": "string" }, "delivery": { "description": "Delivery details for this purchase.", "properties": { "mode": { "description": "The delivery method for the payment", "enum": [ "email", "phone", "pickup", "post" ], "type": "string" }, "recipient": { "description": "Details of the recipient.", "properties": { "email": { "description": "The email of the recipient the ticket is delivered to.", "maxLength": 5000, "type": "string" }, "name": { "description": "The name of the recipient the ticket is delivered to.", "maxLength": 5000, "type": "string" }, "phone": { "description": "The phone number of the recipient the ticket is delivered to.", "maxLength": 5000, "type": "string" } }, "title": "delivery_recipient", "type": "object", "x-stripeMostCommon": [ "email", "name", "phone" ] } }, "title": "delivery", "type": "object", "x-stripeMostCommon": [ "mode", "recipient" ] }, "passenger_name": { "description": "The name of the person or entity on the reservation.", "maxLength": 26, "type": "string" }, "passengers": { "description": "The details of the passengers in the travel reservation.", "items": { "properties": { "name": { "description": "Full name of the person or entity on the flight reservation.", "maxLength": 5000, "type": "string" } }, "required": [ "name" ], "title": "flight_passenger", "type": "object", "x-stripeMostCommon": [ "name" ] }, "type": "array" }, "segments": { "description": "The individual flight segments associated with the trip.", "items": { "properties": { "amount": { "description": "The flight segment amount.", "type": "integer" }, "arrival_airport": { "description": "The International Air Transport Association (IATA) airport code for the arrival airport.", "maxLength": 3, "type": "string" }, "arrives_at": { "description": "The arrival time for the flight segment. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "carrier": { "description": "The International Air Transport Association (IATA) carrier code of the carrier operating the flight segment.", "maxLength": 2, "type": "string" }, "departs_at": { "description": "The departure time for the flight segment. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "departure_airport": { "description": "The International Air Transport Association (IATA) airport code for the departure airport.", "maxLength": 3, "type": "string" }, "flight_number": { "description": "The flight number associated with the segment", "maxLength": 4, "type": "string" }, "service_class": { "description": "The fare class for the segment.", "enum": [ "business", "economy", "first", "premium_economy" ], "type": "string" } }, "required": [ "departs_at" ], "title": "flight_segment", "type": "object", "x-stripeMostCommon": [ "amount", "arrival_airport", "arrives_at", "carrier", "departs_at", "departure_airport", "flight_number", "service_class" ] }, "type": "array" }, "ticket_number": { "description": "The ticket number associated with the travel reservation.", "maxLength": 14, "type": "string" } }, "required": [ "segments" ], "title": "flight", "type": "object", "x-stripeMostCommon": [ "affiliate", "agency_number", "carrier", "delivery", "passenger_name", "passengers", "segments", "ticket_number" ] }, "lodging": { "description": "Lodging reservation details for this PaymentIntent", "properties": { "address": { "description": "The lodging location's address.", "properties": { "city": { "description": "City, district, suburb, town, or village.", "maxLength": 5000, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Address line 1 (e.g., street, PO Box, or company name).", "maxLength": 5000, "type": "string" }, "line2": { "description": "Address line 2 (e.g., apartment, suite, unit, or building).", "maxLength": 5000, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "State, county, province, or region.", "maxLength": 5000, "type": "string" } }, "title": "optional_fields_address", "type": "object", "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state" ] }, "adults": { "description": "The number of adults on the booking", "type": "integer" }, "affiliate": { "description": "Affiliate details for this purchase.", "properties": { "name": { "description": "The name of the affiliate that originated the purchase.", "maxLength": 5000, "type": "string" } }, "required": [ "name" ], "title": "affiliate", "type": "object", "x-stripeMostCommon": [ "name" ] }, "booking_number": { "description": "The booking number associated with the lodging reservation.", "maxLength": 100, "type": "string" }, "category": { "description": "The lodging category", "enum": [ "hotel", "vacation_rental" ], "type": "string" }, "checkin_at": { "description": "Lodging check-in time. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "checkout_at": { "description": "Lodging check-out time. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "customer_service_phone_number": { "description": "The customer service phone number of the lodging company.", "type": "string" }, "daily_room_rate_amount": { "description": "The daily lodging room rate.", "type": "integer" }, "delivery": { "description": "Delivery details for this purchase.", "properties": { "mode": { "description": "The delivery method for the payment", "enum": [ "email", "phone", "pickup", "post" ], "type": "string" }, "recipient": { "description": "Details of the recipient.", "properties": { "email": { "description": "The email of the recipient the ticket is delivered to.", "maxLength": 5000, "type": "string" }, "name": { "description": "The name of the recipient the ticket is delivered to.", "maxLength": 5000, "type": "string" }, "phone": { "description": "The phone number of the recipient the ticket is delivered to.", "maxLength": 5000, "type": "string" } }, "title": "delivery_recipient", "type": "object", "x-stripeMostCommon": [ "email", "name", "phone" ] } }, "title": "delivery", "type": "object", "x-stripeMostCommon": [ "mode", "recipient" ] }, "extra_charges": { "description": "List of additional charges being billed.", "items": { "enum": [ "gift_shop", "laundry", "mini_bar", "other", "restaurant", "telephone" ], "type": "string" }, "type": "array" }, "fire_safety_act_compliance": { "description": "Indicates whether the lodging location is compliant with the Fire Safety Act.", "type": "boolean" }, "name": { "description": "The name of the lodging location.", "maxLength": 100, "type": "string" }, "no_show": { "description": "Indicates if the customer did not keep their booking while failing to cancel the reservation.", "type": "boolean" }, "number_of_rooms": { "description": "The number of rooms on the booking", "type": "integer" }, "passengers": { "description": "The details of the passengers in the travel reservation", "items": { "properties": { "name": { "description": "Full name of the person or entity on the lodging reservation.", "maxLength": 5000, "type": "string" } }, "required": [ "name" ], "title": "lodging_passenger", "type": "object", "x-stripeMostCommon": [ "name" ] }, "type": "array" }, "property_phone_number": { "description": "The phone number of the lodging location.", "type": "string" }, "room_class": { "description": "The room class for this purchase.", "maxLength": 5000, "type": "string" }, "room_nights": { "description": "The number of room nights", "type": "integer" }, "total_room_tax_amount": { "description": "The total tax amount associating with the room reservation.", "type": "integer" }, "total_tax_amount": { "description": "The total tax amount", "type": "integer" } }, "required": [ "checkin_at", "checkout_at" ], "title": "lodging", "type": "object", "x-stripeMostCommon": [ "address", "adults", "affiliate", "booking_number", "category", "checkin_at", "checkout_at", "customer_service_phone_number", "daily_room_rate_amount", "delivery", "extra_charges", "fire_safety_act_compliance", "name", "no_show", "number_of_rooms", "passengers", "property_phone_number", "room_class", "room_nights", "total_room_tax_amount", "total_tax_amount" ] }, "order_reference": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "A unique value assigned by the business to identify the transaction." }, "subscription": { "description": "Subscription details for this PaymentIntent", "properties": { "affiliate": { "description": "Affiliate details for this purchase.", "properties": { "name": { "description": "The name of the affiliate that originated the purchase.", "maxLength": 5000, "type": "string" } }, "required": [ "name" ], "title": "affiliate", "type": "object", "x-stripeMostCommon": [ "name" ] }, "auto_renewal": { "description": "Info whether the subscription will be auto renewed upon expiry.", "type": "boolean" }, "billing_interval": { "description": "Subscription billing details for this purchase.", "properties": { "count": { "description": "The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.", "type": "integer" }, "interval": { "description": "Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.", "enum": [ "day", "month", "week", "year" ], "type": "string" } }, "required": [ "count", "interval" ], "title": "subscription_billing_interval", "type": "object", "x-stripeMostCommon": [ "count", "interval" ] }, "ends_at": { "description": "Subscription end time. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "name": { "description": "Name of the product on subscription. e.g. Apple Music Subscription", "maxLength": 5000, "type": "string" }, "starts_at": { "description": "Subscription start time. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" } }, "required": [ "name" ], "title": "subscription", "type": "object", "x-stripeMostCommon": [ "affiliate", "auto_renewal", "billing_interval", "ends_at", "name", "starts_at" ] } }, "title": "payment_details", "type": "object", "x-stripeMostCommon": [ "benefit", "car_rental", "car_rental_data", "event_details", "flight", "healthcare", "lodging", "lodging_data", "subscription" ] }, "receipt_email": { "description": "The email address to send this charge's receipt to. This will override the previously-specified email address for this charge, if one was set. Receipts will not be sent in test mode.", "type": "string" }, "statement_descriptor": { "description": "For a non-card charge, text that appears on the customer's statement as the statement descriptor. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).\n\nFor a card charge, this value is ignored unless you don't specify a `statement_descriptor_suffix`, in which case this value is used as the suffix.", "maxLength": 22, "type": "string" }, "statement_descriptor_suffix": { "description": "Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement. If the account has no prefix value, the suffix is concatenated to the account's statement descriptor.", "maxLength": 22, "type": "string" }, "transfer_data": { "description": "An optional dictionary including the account to automatically transfer to as part of a destination charge. [See the Connect documentation](https://stripe.com/docs/connect/destination-charges) for details.", "properties": { "amount": { "description": "The amount transferred to the destination account, if specified. By default, the entire charge amount is transferred to the destination account.", "type": "integer" } }, "title": "transfer_data_specs", "type": "object", "x-stripeMostCommon": [ "amount" ] }, "transfer_group": { "description": "A string that identifies this transaction as part of a group. `transfer_group` may only be provided if it has not been set. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) for details.", "type": "string" } }, "type": "object", "x-stripeMostCommon": [ "amount", "application_fee", "receipt_email", "statement_descriptor", "statement_descriptor_suffix" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/charge" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Capture a payment" } }, "/v1/charges/{charge}/refunds": { "get": { "description": "

You can see a list of the refunds belonging to a specific charge. Note that the 10 most recent refunds are always available by default on the charge object. If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional refunds.

", "operationId": "GetChargesChargeRefunds", "parameters": [ { "in": "path", "name": "charge", "required": true, "schema": { "type": "string" }, "style": "simple" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/refund" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "RefundList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all refunds" } }, "/v1/charges/{charge}/refunds/{refund}": { "get": { "description": "

Retrieves the details of an existing refund.

", "operationId": "GetChargesChargeRefundsRefund", "parameters": [ { "in": "path", "name": "charge", "required": true, "schema": { "type": "string" }, "style": "simple" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "refund", "required": true, "schema": { "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/refund" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } } } }, "/v1/checkout/sessions": { "get": { "description": "

Returns a list of Checkout Sessions.

", "operationId": "GetCheckoutSessions", "parameters": [ { "description": "Only return Checkout Sessions that were created during the given date interval.", "explode": true, "in": "query", "name": "created", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "description": "Minimum value to filter by (exclusive)", "type": "integer" }, "gte": { "description": "Minimum value to filter by (inclusive)", "type": "integer" }, "lt": { "description": "Maximum value to filter by (exclusive)", "type": "integer" }, "lte": { "description": "Maximum value to filter by (inclusive)", "type": "integer" } }, "title": "range_query_specs", "type": "object", "x-stripeMostCommon": [ "gt", "gte", "lt", "lte" ] }, { "type": "integer" } ] }, "style": "deepObject" }, { "description": "Only return the Checkout Sessions for the Customer specified.", "in": "query", "name": "customer", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Only return the Checkout Sessions for the Account specified.", "in": "query", "name": "customer_account", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Only return the Checkout Sessions for the Customer details specified.", "explode": true, "in": "query", "name": "customer_details", "required": false, "schema": { "properties": { "email": { "description": "Customer's email address.", "type": "string" } }, "required": [ "email" ], "title": "customer_details_params", "type": "object", "x-stripeMostCommon": [ "email" ] }, "style": "deepObject" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "Only return the Checkout Session for the PaymentIntent specified.", "in": "query", "name": "payment_intent", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Only return the Checkout Sessions for the Payment Link specified.", "in": "query", "name": "payment_link", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Only return the Checkout Sessions matching the given status.", "in": "query", "name": "status", "required": false, "schema": { "enum": [ "complete", "expired", "open" ], "type": "string" }, "style": "form" }, { "description": "Only return the Checkout Session for the subscription specified.", "in": "query", "name": "subscription", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/checkout.session" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "PaymentPagesCheckoutSessionList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all Checkout Sessions" }, "post": { "description": "

Creates a Checkout Session object.

", "operationId": "PostCheckoutSessions", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "adaptive_pricing": { "explode": true, "style": "deepObject" }, "after_expiration": { "explode": true, "style": "deepObject" }, "automatic_tax": { "explode": true, "style": "deepObject" }, "consent_collection": { "explode": true, "style": "deepObject" }, "custom_fields": { "explode": true, "style": "deepObject" }, "custom_text": { "explode": true, "style": "deepObject" }, "customer_update": { "explode": true, "style": "deepObject" }, "discounts": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "invoice_creation": { "explode": true, "style": "deepObject" }, "line_items": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "optional_items": { "explode": true, "style": "deepObject" }, "payment_intent_data": { "explode": true, "style": "deepObject" }, "payment_method_data": { "explode": true, "style": "deepObject" }, "payment_method_options": { "explode": true, "style": "deepObject" }, "payment_method_types": { "explode": true, "style": "deepObject" }, "permissions": { "explode": true, "style": "deepObject" }, "phone_number_collection": { "explode": true, "style": "deepObject" }, "saved_payment_method_options": { "explode": true, "style": "deepObject" }, "setup_intent_data": { "explode": true, "style": "deepObject" }, "shipping_address_collection": { "explode": true, "style": "deepObject" }, "shipping_options": { "explode": true, "style": "deepObject" }, "subscription_data": { "explode": true, "style": "deepObject" }, "tax_id_collection": { "explode": true, "style": "deepObject" }, "wallet_options": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "adaptive_pricing": { "description": "Settings for price localization with [Adaptive Pricing](https://docs.stripe.com/payments/checkout/adaptive-pricing).", "properties": { "enabled": { "description": "If set to `true`, Adaptive Pricing is available on [eligible sessions](https://docs.stripe.com/payments/currencies/localize-prices/adaptive-pricing?payment-ui=stripe-hosted#restrictions). Defaults to your [dashboard setting](https://dashboard.stripe.com/settings/adaptive-pricing).", "type": "boolean" } }, "title": "adaptive_pricing_params", "type": "object", "x-stripeMostCommon": [ "enabled" ] }, "after_expiration": { "description": "Configure actions after a Checkout Session has expired.", "properties": { "recovery": { "description": "Configure a Checkout Session that can be used to recover an expired session.", "properties": { "allow_promotion_codes": { "description": "Enables user redeemable promotion codes on the recovered Checkout Sessions. Defaults to `false`", "type": "boolean" }, "enabled": { "description": "If `true`, a recovery URL will be generated to recover this Checkout Session if it\nexpires before a successful transaction is completed. It will be attached to the\nCheckout Session object upon expiration.", "type": "boolean" } }, "required": [ "enabled" ], "title": "recovery_params", "type": "object", "x-stripeMostCommon": [ "allow_promotion_codes", "enabled" ] } }, "title": "after_expiration_params", "type": "object", "x-stripeMostCommon": [ "recovery" ] }, "allow_promotion_codes": { "description": "Enables user redeemable promotion codes.", "type": "boolean" }, "automatic_tax": { "description": "Settings for automatic tax lookup for this session and resulting payments, invoices, and subscriptions.", "properties": { "enabled": { "description": "Set to `true` to [calculate tax automatically](https://docs.stripe.com/tax) using the customer's location.\n\nEnabling this parameter causes Checkout to collect any billing address information necessary for tax calculation.", "type": "boolean" }, "liability": { "description": "The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.", "properties": { "account": { "description": "The connected account being referenced when `type` is `account`.", "type": "string" }, "type": { "description": "Type of the account referenced in the request.", "enum": [ "account", "self" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "param", "type": "object", "x-stripeMostCommon": [ "account", "type" ] } }, "required": [ "enabled" ], "title": "automatic_tax_params", "type": "object", "x-stripeMostCommon": [ "enabled", "liability" ] }, "billing_address_collection": { "description": "Specify whether Checkout should collect the customer's billing address. Defaults to `auto`.", "enum": [ "auto", "required" ], "type": "string" }, "cancel_url": { "description": "If set, Checkout displays a back button and customers will be directed to this URL if they decide to cancel payment and return to your website. This parameter is not allowed if ui_mode is `embedded` or `custom`.", "type": "string" }, "client_reference_id": { "description": "A unique string to reference the Checkout Session. This can be a\ncustomer ID, a cart ID, or similar, and can be used to reconcile the\nsession with your internal systems.", "maxLength": 200, "type": "string" }, "consent_collection": { "description": "Configure fields for the Checkout Session to gather active consent from customers.", "properties": { "payment_method_reuse_agreement": { "description": "Determines the display of payment method reuse agreement text in the UI. If set to `hidden`, it will hide legal text related to the reuse of a payment method.", "properties": { "position": { "description": "Determines the position and visibility of the payment method reuse agreement in the UI. When set to `auto`, Stripe's\ndefaults will be used. When set to `hidden`, the payment method reuse agreement text will always be hidden in the UI.", "enum": [ "auto", "hidden" ], "type": "string" } }, "required": [ "position" ], "title": "payment_method_reuse_agreement_params", "type": "object", "x-stripeMostCommon": [ "position" ] }, "promotions": { "description": "If set to `auto`, enables the collection of customer consent for promotional communications. The Checkout\nSession will determine whether to display an option to opt into promotional communication\nfrom the merchant depending on the customer's locale. Only available to US merchants.", "enum": [ "auto", "none" ], "type": "string" }, "terms_of_service": { "description": "If set to `required`, it requires customers to check a terms of service checkbox before being able to pay.\nThere must be a valid terms of service URL set in your [Dashboard settings](https://dashboard.stripe.com/settings/public).", "enum": [ "none", "required" ], "type": "string" } }, "title": "consent_collection_params", "type": "object", "x-stripeMostCommon": [ "payment_method_reuse_agreement", "promotions", "terms_of_service" ] }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). Required in `setup` mode when `payment_method_types` is not set.", "format": "currency", "type": "string" }, "custom_fields": { "description": "Collect additional information from your customer using custom fields. Up to 3 fields are supported.", "items": { "properties": { "dropdown": { "description": "Configuration for `type=dropdown` fields.", "properties": { "default_value": { "description": "The value that will pre-fill the field on the payment page.Must match a `value` in the `options` array.", "maxLength": 100, "type": "string" }, "options": { "description": "The options available for the customer to select. Up to 200 options allowed.", "items": { "properties": { "label": { "description": "The label for the option, displayed to the customer. Up to 100 characters.", "maxLength": 100, "type": "string" }, "value": { "description": "The value for this option, not displayed to the customer, used by your integration to reconcile the option selected by the customer. Must be unique to this option, alphanumeric, and up to 100 characters.", "maxLength": 100, "type": "string" } }, "required": [ "label", "value" ], "title": "custom_field_option_param", "type": "object", "x-stripeMostCommon": [ "label", "value" ] }, "type": "array" } }, "required": [ "options" ], "title": "custom_field_dropdown_param", "type": "object", "x-stripeMostCommon": [ "default_value", "options" ] }, "key": { "description": "String of your choice that your integration can use to reconcile this field. Must be unique to this field, alphanumeric, and up to 200 characters.", "maxLength": 200, "type": "string" }, "label": { "description": "The label for the field, displayed to the customer.", "properties": { "custom": { "description": "Custom text for the label, displayed to the customer. Up to 50 characters.", "maxLength": 50, "type": "string" }, "type": { "description": "The type of the label.", "enum": [ "custom" ], "type": "string" } }, "required": [ "custom", "type" ], "title": "custom_field_label_param", "type": "object", "x-stripeMostCommon": [ "custom", "type" ] }, "numeric": { "description": "Configuration for `type=numeric` fields.", "properties": { "default_value": { "description": "The value that will pre-fill the field on the payment page.", "maxLength": 255, "type": "string" }, "maximum_length": { "description": "The maximum character length constraint for the customer's input.", "type": "integer" }, "minimum_length": { "description": "The minimum character length requirement for the customer's input.", "type": "integer" } }, "title": "custom_field_numeric_param", "type": "object", "x-stripeMostCommon": [ "default_value", "maximum_length", "minimum_length" ] }, "optional": { "description": "Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`.", "type": "boolean" }, "text": { "description": "Configuration for `type=text` fields.", "properties": { "default_value": { "description": "The value that will pre-fill the field on the payment page.", "maxLength": 255, "type": "string" }, "maximum_length": { "description": "The maximum character length constraint for the customer's input.", "type": "integer" }, "minimum_length": { "description": "The minimum character length requirement for the customer's input.", "type": "integer" } }, "title": "custom_field_text_param", "type": "object", "x-stripeMostCommon": [ "default_value", "maximum_length", "minimum_length" ] }, "type": { "description": "The type of the field.", "enum": [ "dropdown", "numeric", "text" ], "type": "string" } }, "required": [ "key", "label", "type" ], "title": "custom_field_param", "type": "object", "x-stripeMostCommon": [ "dropdown", "key", "label", "numeric", "optional", "text", "type" ] }, "type": "array" }, "custom_text": { "description": "Display additional text for your customers using custom text.", "properties": { "after_submit": { "anyOf": [ { "properties": { "message": { "description": "Text may be up to 1200 characters in length.", "maxLength": 1200, "type": "string" } }, "required": [ "message" ], "title": "custom_text_position_param", "type": "object", "x-stripeMostCommon": [ "message" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Custom text that should be displayed after the payment confirmation button." }, "shipping_address": { "anyOf": [ { "properties": { "message": { "description": "Text may be up to 1200 characters in length.", "maxLength": 1200, "type": "string" } }, "required": [ "message" ], "title": "custom_text_position_param", "type": "object", "x-stripeMostCommon": [ "message" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Custom text that should be displayed alongside shipping address collection." }, "submit": { "anyOf": [ { "properties": { "message": { "description": "Text may be up to 1200 characters in length.", "maxLength": 1200, "type": "string" } }, "required": [ "message" ], "title": "custom_text_position_param", "type": "object", "x-stripeMostCommon": [ "message" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Custom text that should be displayed alongside the payment confirmation button." }, "terms_of_service_acceptance": { "anyOf": [ { "properties": { "message": { "description": "Text may be up to 1200 characters in length.", "maxLength": 1200, "type": "string" } }, "required": [ "message" ], "title": "custom_text_position_param", "type": "object", "x-stripeMostCommon": [ "message" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Custom text that should be displayed in place of the default terms of service agreement text." } }, "title": "custom_text_param", "type": "object", "x-stripeMostCommon": [ "after_submit", "shipping_address", "submit", "terms_of_service_acceptance" ] }, "customer": { "description": "ID of an existing Customer, if one exists. In `payment` mode, the customer’s most recently saved card\npayment method will be used to prefill the email, name, card details, and billing address\non the Checkout page. In `subscription` mode, the customer’s [default payment method](https://stripe.com/docs/api/customers/update#update_customer-invoice_settings-default_payment_method)\nwill be used if it’s a card, otherwise the most recently saved card will be used. A valid billing address, billing name and billing email are required on the payment method for Checkout to prefill the customer's card details.\n\nIf the Customer already has a valid [email](https://stripe.com/docs/api/customers/object#customer_object-email) set, the email will be prefilled and not editable in Checkout.\nIf the Customer does not have a valid `email`, Checkout will set the email entered during the session on the Customer.\n\nIf blank for Checkout Sessions in `subscription` mode or with `customer_creation` set as `always` in `payment` mode, Checkout will create a new Customer object based on information provided during the payment flow.\n\nYou can set [`payment_intent_data.setup_future_usage`](https://stripe.com/docs/api/checkout/sessions/create#create_checkout_session-payment_intent_data-setup_future_usage) to have Checkout automatically attach the payment method to the Customer you pass in for future reuse.", "maxLength": 5000, "type": "string" }, "customer_account": { "description": "ID of an existing Account, if one exists. Has the same behavior as `customer`.", "maxLength": 5000, "type": "string" }, "customer_creation": { "description": "Configure whether a Checkout Session creates a [Customer](https://stripe.com/docs/api/customers) during Session confirmation.\n\nWhen a Customer is not created, you can still retrieve email, address, and other customer data entered in Checkout\nwith [customer_details](https://stripe.com/docs/api/checkout/sessions/object#checkout_session_object-customer_details).\n\nSessions that don't create Customers instead are grouped by [guest customers](https://stripe.com/docs/payments/checkout/guest-customers)\nin the Dashboard. Promotion codes limited to first time customers will return invalid for these Sessions.\n\nCan only be set in `payment` and `setup` mode.", "enum": [ "always", "if_required" ], "type": "string" }, "customer_email": { "description": "If provided, this value will be used when the Customer object is created.\nIf not provided, customers will be asked to enter their email address.\nUse this parameter to prefill customer data if you already have an email\non file. To access information about the customer once a session is\ncomplete, use the `customer` field.", "type": "string" }, "customer_update": { "description": "Controls what fields on Customer can be updated by the Checkout Session. Can only be provided when `customer` is provided.", "properties": { "address": { "description": "Describes whether Checkout saves the billing address onto `customer.address`.\nTo always collect a full billing address, use `billing_address_collection`. Defaults to `never`.", "enum": [ "auto", "never" ], "type": "string", "x-stripeBypassValidation": true }, "name": { "description": "Describes whether Checkout saves the name onto `customer.name`. Defaults to `never`.", "enum": [ "auto", "never" ], "type": "string", "x-stripeBypassValidation": true }, "shipping": { "description": "Describes whether Checkout saves shipping information onto `customer.shipping`.\nTo collect shipping information, use `shipping_address_collection`. Defaults to `never`.", "enum": [ "auto", "never" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "customer_update_params", "type": "object", "x-stripeMostCommon": [ "address", "name", "shipping" ] }, "discounts": { "description": "The coupon or promotion code to apply to this Session. Currently, only up to one may be specified.", "items": { "properties": { "coupon": { "description": "The ID of the coupon to apply to this Session.", "maxLength": 5000, "type": "string" }, "coupon_data": { "description": "Data used to generate a new [Coupon](https://stripe.com/docs/api/coupon) object inline. One of `coupon` or `coupon_data` is required when updating discounts.", "properties": { "amount_off": { "description": "A positive integer representing the amount to subtract from an invoice total (required if `percent_off` is not passed).", "type": "integer" }, "currency": { "description": "Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the `amount_off` parameter (required if `amount_off` is passed).", "format": "currency", "type": "string" }, "duration": { "description": "Specifies how long the discount will be in effect if used on a subscription. Defaults to `once`.", "enum": [ "forever", "once", "repeating" ], "type": "string", "x-stripeBypassValidation": true }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "name": { "description": "Name of the coupon displayed to customers on, for instance invoices, or receipts. By default the `id` is shown if `name` is not set.", "maxLength": 40, "type": "string" }, "percent_off": { "description": "A positive float larger than 0, and smaller or equal to 100, that represents the discount the coupon will apply (required if `amount_off` is not passed).", "type": "number" } }, "title": "coupon_data", "type": "object", "x-stripeMostCommon": [ "amount_off", "currency", "duration", "metadata", "name", "percent_off" ] }, "promotion_code": { "description": "The ID of a promotion code to apply to this Session.", "maxLength": 5000, "type": "string" } }, "title": "discount_params", "type": "object", "x-stripeMostCommon": [ "coupon", "coupon_data", "promotion_code" ] }, "type": "array" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "expires_at": { "description": "The Epoch time in seconds at which the Checkout Session will expire. It can be anywhere from 30 minutes to 24 hours after Checkout Session creation. By default, this value is 24 hours from creation.", "format": "unix-time", "type": "integer" }, "invoice_creation": { "description": "Generate a post-purchase Invoice for one-time payments.", "properties": { "enabled": { "description": "Set to `true` to enable invoice creation.", "type": "boolean" }, "invoice_data": { "description": "Parameters passed when creating invoices for payment-mode Checkout Sessions.", "properties": { "account_tax_ids": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The account tax IDs associated with the invoice." }, "custom_fields": { "anyOf": [ { "items": { "properties": { "name": { "description": "The name of the custom field. This may be up to 40 characters.", "maxLength": 40, "type": "string" }, "value": { "description": "The value of the custom field. This may be up to 140 characters.", "maxLength": 140, "type": "string" } }, "required": [ "name", "value" ], "title": "custom_field_params", "type": "object", "x-stripeMostCommon": [ "name", "value" ] }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "Default custom fields to be displayed on invoices for this customer." }, "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users.", "maxLength": 1500, "type": "string" }, "footer": { "description": "Default footer to be displayed on invoices for this customer.", "maxLength": 5000, "type": "string" }, "issuer": { "description": "The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.", "properties": { "account": { "description": "The connected account being referenced when `type` is `account`.", "type": "string" }, "type": { "description": "Type of the account referenced in the request.", "enum": [ "account", "self" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "param", "type": "object", "x-stripeMostCommon": [ "account", "type" ] }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "rendering_options": { "anyOf": [ { "properties": { "amount_tax_display": { "description": "How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. One of `exclude_tax` or `include_inclusive_tax`. `include_inclusive_tax` will include inclusive tax (and exclude exclusive tax) in invoice PDF amounts. `exclude_tax` will exclude all tax (inclusive and exclusive alike) from invoice PDF amounts.", "enum": [ "", "exclude_tax", "include_inclusive_tax" ], "type": "string" }, "template": { "description": "ID of the invoice rendering template to use for this invoice.", "maxLength": 5000, "type": "string" } }, "title": "checkout_rendering_options_param", "type": "object", "x-stripeMostCommon": [ "amount_tax_display", "invoice_title", "template" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Default options for invoice PDF rendering for this customer." } }, "title": "invoice_data_params", "type": "object", "x-stripeMostCommon": [ "account_tax_ids", "custom_fields", "description", "footer", "issuer", "metadata", "rendering_options" ] } }, "required": [ "enabled" ], "title": "invoice_creation_params", "type": "object", "x-stripeMostCommon": [ "enabled", "invoice_data" ] }, "line_items": { "description": "A list of items the customer is purchasing. Use this parameter to pass one-time or recurring [Prices](https://stripe.com/docs/api/prices). The parameter is required for `payment` and `subscription` mode.\n\nFor `payment` mode, there is a maximum of 100 line items, however it is recommended to consolidate line items if there are more than a few dozen.\n\nFor `subscription` mode, there is a maximum of 20 line items with recurring Prices and 20 line items with one-time Prices. Line items with one-time Prices will be on the initial invoice only.", "items": { "properties": { "adjustable_quantity": { "description": "When set, provides configuration for this item’s quantity to be adjusted by the customer during Checkout.", "properties": { "enabled": { "description": "Set to true if the quantity can be adjusted to any non-negative integer.", "type": "boolean" }, "maximum": { "description": "The maximum quantity the customer can purchase for the Checkout Session. By default this value is 99. You can specify a value up to 999999.", "type": "integer" }, "minimum": { "description": "The minimum quantity the customer must purchase for the Checkout Session. By default this value is 0.", "type": "integer" } }, "required": [ "enabled" ], "title": "adjustable_quantity_params", "type": "object", "x-stripeMostCommon": [ "enabled", "maximum", "minimum" ] }, "dynamic_tax_rates": { "description": "The [tax rates](https://stripe.com/docs/api/tax_rates) that will be applied to this line item depending on the customer's billing/shipping address. We currently support the following countries: US, GB, AU, and all countries in the EU.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "price": { "description": "The ID of the [Price](https://stripe.com/docs/api/prices) or [Plan](https://stripe.com/docs/api/plans) object. One of `price` or `price_data` is required.", "maxLength": 5000, "type": "string" }, "price_data": { "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.", "properties": { "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "product": { "description": "The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to. One of `product` or `product_data` is required.", "maxLength": 5000, "type": "string" }, "product_data": { "description": "Data used to generate a new [Product](https://docs.stripe.com/api/products) object inline. One of `product` or `product_data` is required.", "properties": { "description": { "description": "The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.", "maxLength": 40000, "type": "string" }, "images": { "description": "A list of up to 8 URLs of images for this product, meant to be displayable to the customer.", "items": { "type": "string" }, "type": "array" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "name": { "description": "The product's name, meant to be displayable to the customer.", "maxLength": 5000, "type": "string" }, "tax_code": { "description": "A [tax code](https://stripe.com/docs/tax/tax-categories) ID.", "maxLength": 5000, "type": "string" } }, "required": [ "name" ], "title": "product_data", "type": "object", "x-stripeMostCommon": [ "description", "images", "metadata", "name", "tax_code", "unit_label" ] }, "recurring": { "description": "The recurring components of a price such as `interval` and `interval_count`.", "properties": { "interval": { "description": "Specifies billing frequency. Either `day`, `week`, `month` or `year`.", "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "description": "The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).", "type": "integer" } }, "required": [ "interval" ], "title": "recurring_adhoc", "type": "object", "x-stripeMostCommon": [ "interval" ] }, "tax_behavior": { "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.", "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" }, "unit_amount": { "description": "A non-negative integer in cents (or local equivalent) representing how much to charge. One of `unit_amount` or `unit_amount_decimal` is required.", "type": "integer" }, "unit_amount_decimal": { "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", "format": "decimal", "type": "string" } }, "required": [ "currency" ], "title": "price_data_with_product_data", "type": "object", "x-stripeMostCommon": [ "currency", "product", "unit_amount" ] }, "quantity": { "description": "The quantity of the line item being purchased. Quantity should not be defined when `recurring.usage_type=metered`.", "type": "integer" }, "tax_rates": { "description": "The [tax rates](https://stripe.com/docs/api/tax_rates) which apply to this line item.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "title": "line_item_params", "type": "object", "x-stripeMostCommon": [ "adjustable_quantity", "dynamic_tax_rates", "metadata", "price", "price_data", "quantity", "tax_rates" ] }, "type": "array" }, "locale": { "description": "The IETF language tag of the locale Checkout is displayed in. If blank or `auto`, the browser's locale is used.", "enum": [ "auto", "bg", "cs", "da", "de", "el", "en", "en-GB", "es", "es-419", "et", "fi", "fil", "fr", "fr-CA", "hr", "hu", "id", "it", "ja", "ko", "lt", "lv", "ms", "mt", "nb", "nl", "pl", "pt", "pt-BR", "ro", "ru", "sk", "sl", "sv", "th", "tr", "vi", "zh", "zh-HK", "zh-TW" ], "type": "string", "x-stripeBypassValidation": true }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "mode": { "description": "The mode of the Checkout Session. Pass `subscription` if the Checkout Session includes at least one recurring item.", "enum": [ "payment", "setup", "subscription" ], "type": "string" }, "optional_items": { "description": "A list of optional items the customer can add to their order at checkout. Use this parameter to pass one-time or recurring [Prices](https://stripe.com/docs/api/prices).\n\nThere is a maximum of 10 optional items allowed on a Checkout Session, and the existing limits on the number of line items allowed on a Checkout Session apply to the combined number of line items and optional items.\n\nFor `payment` mode, there is a maximum of 100 combined line items and optional items, however it is recommended to consolidate items if there are more than a few dozen.\n\nFor `subscription` mode, there is a maximum of 20 line items and optional items with recurring Prices and 20 line items and optional items with one-time Prices.", "items": { "properties": { "adjustable_quantity": { "description": "When set, provides configuration for the customer to adjust the quantity of the line item created when a customer chooses to add this optional item to their order.", "properties": { "enabled": { "description": "Set to true if the quantity can be adjusted to any non-negative integer.", "type": "boolean" }, "maximum": { "description": "The maximum quantity of this item the customer can purchase. By default this value is 99. You can specify a value up to 999999.", "type": "integer" }, "minimum": { "description": "The minimum quantity of this item the customer must purchase, if they choose to purchase it. Because this item is optional, the customer will always be able to remove it from their order, even if the `minimum` configured here is greater than 0. By default this value is 0.", "type": "integer" } }, "required": [ "enabled" ], "title": "optional_item_adjustable_quantity_params", "type": "object", "x-stripeMostCommon": [ "enabled", "maximum", "minimum" ] }, "price": { "description": "The ID of the [Price](https://stripe.com/docs/api/prices) or [Plan](https://stripe.com/docs/api/plans) object.", "maxLength": 5000, "type": "string" }, "quantity": { "description": "The initial quantity of the line item created when a customer chooses to add this optional item to their order.", "type": "integer" } }, "required": [ "price", "quantity" ], "title": "optional_item_params", "type": "object", "x-stripeMostCommon": [ "adjustable_quantity", "price", "quantity" ] }, "type": "array" }, "origin_context": { "description": "Where the user is coming from. This informs the optimizations that are applied to the session.", "enum": [ "mobile_app", "web" ], "type": "string" }, "payment_intent_data": { "description": "A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in `payment` mode.", "properties": { "application_fee_amount": { "description": "The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total amount captured. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).", "type": "integer" }, "capture_method": { "description": "Controls when the funds will be captured from the customer's account.", "enum": [ "automatic", "automatic_async", "manual" ], "type": "string" }, "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users.", "maxLength": 1000, "type": "string" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "on_behalf_of": { "description": "The Stripe account ID for which these funds are intended. For details,\nsee the PaymentIntents [use case for connected\naccounts](/docs/payments/connected-accounts).", "type": "string" }, "receipt_email": { "description": "Email address that the receipt for the resulting payment will be sent to. If `receipt_email` is specified for a payment in live mode, a receipt will be sent regardless of your [email settings](https://dashboard.stripe.com/account/emails).", "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to [make future payments](https://stripe.com/docs/payments/payment-intents#future-usage) with the payment\nmethod collected by this Checkout Session.\n\nWhen setting this to `on_session`, Checkout will show a notice to the\ncustomer that their payment details will be saved.\n\nWhen setting this to `off_session`, Checkout will show a notice to the\ncustomer that their payment details will be saved and used for future\npayments.\n\nIf a Customer has been provided or Checkout creates a new Customer,\nCheckout will attach the payment method to the Customer.\n\nIf Checkout does not create a Customer, the payment method is not attached\nto a Customer. To reuse the payment method, you can retrieve it from the\nCheckout Session's PaymentIntent.\n\nWhen processing card payments, Checkout also uses `setup_future_usage`\nto dynamically optimize your payment flow and comply with regional\nlegislation and network rules, such as SCA.", "enum": [ "off_session", "on_session" ], "type": "string" }, "shipping": { "description": "Shipping information for this payment.", "properties": { "address": { "description": "Shipping address.", "properties": { "city": { "description": "City, district, suburb, town, or village.", "maxLength": 5000, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Address line 1 (e.g., street, PO Box, or company name).", "maxLength": 5000, "type": "string" }, "line2": { "description": "Address line 2 (e.g., apartment, suite, unit, or building).", "maxLength": 5000, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "State, county, province, or region.", "maxLength": 5000, "type": "string" } }, "required": [ "line1" ], "title": "address", "type": "object", "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state" ] }, "carrier": { "description": "The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.", "maxLength": 5000, "type": "string" }, "name": { "description": "Recipient name.", "maxLength": 5000, "type": "string" }, "phone": { "description": "Recipient phone (including extension).", "maxLength": 5000, "type": "string" }, "tracking_number": { "description": "The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.", "maxLength": 5000, "type": "string" } }, "required": [ "address", "name" ], "title": "shipping", "type": "object", "x-stripeMostCommon": [ "address", "carrier", "name", "phone", "tracking_number" ] }, "statement_descriptor": { "description": "Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).\n\nSetting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead.", "maxLength": 22, "type": "string" }, "statement_descriptor_suffix": { "description": "Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement.", "maxLength": 22, "type": "string" }, "transfer_data": { "description": "The parameters used to automatically create a Transfer when the payment succeeds.\nFor more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).", "properties": { "amount": { "description": "The amount that will be transferred automatically when a charge succeeds.", "type": "integer" }, "destination": { "description": "If specified, successful charges will be attributed to the destination\naccount for tax reporting, and the funds from charges will be transferred\nto the destination account. The ID of the resulting transfer will be\nreturned on the successful charge's `transfer` field.", "type": "string" } }, "required": [ "destination" ], "title": "transfer_data_params", "type": "object", "x-stripeMostCommon": [ "amount", "destination" ] }, "transfer_group": { "description": "A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/connect/separate-charges-and-transfers) for details.", "type": "string" } }, "title": "payment_intent_data_params", "type": "object", "x-stripeMostCommon": [ "application_fee_amount", "capture_method", "cross_border_classification", "description", "fulfillment_date", "metadata", "on_behalf_of", "receipt_email", "setup_future_usage", "shipping", "statement_descriptor", "statement_descriptor_suffix", "transfer_data", "transfer_group" ] }, "payment_method_collection": { "description": "Specify whether Checkout should collect a payment method. When set to `if_required`, Checkout will not collect a payment method when the total due for the session is 0.\nThis may occur if the Checkout Session includes a free trial or a discount.\n\nCan only be set in `subscription` mode. Defaults to `always`.\n\nIf you'd like information on how to collect a payment method outside of Checkout, read the guide on configuring [subscriptions with a free trial](https://stripe.com/docs/payments/checkout/free-trials).", "enum": [ "always", "if_required" ], "type": "string" }, "payment_method_configuration": { "description": "The ID of the payment method configuration to use with this Checkout session.", "maxLength": 100, "type": "string" }, "payment_method_data": { "description": "This parameter allows you to set some attributes on the payment method created during a Checkout session.", "properties": { "allow_redisplay": { "description": "Allow redisplay will be set on the payment method on confirmation and indicates whether this payment method can be shown again to the customer in a checkout flow. Only set this field if you wish to override the allow_redisplay value determined by Checkout.", "enum": [ "always", "limited", "unspecified" ], "type": "string" } }, "title": "payment_method_data_param", "type": "object", "x-stripeMostCommon": [ "allow_redisplay" ] }, "payment_method_options": { "description": "Payment-method-specific configuration.", "properties": { "acss_debit": { "description": "contains details about the ACSS Debit payment method options.", "properties": { "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). This is only accepted for Checkout Sessions in `setup` mode.", "enum": [ "cad", "usd" ], "type": "string" }, "mandate_options": { "description": "Additional fields for Mandate creation", "properties": { "custom_mandate_url": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "A URL for custom mandate text to render during confirmation step.\nThe URL will be rendered with additional GET parameters `payment_intent` and `payment_intent_client_secret` when confirming a Payment Intent,\nor `setup_intent` and `setup_intent_client_secret` when confirming a Setup Intent." }, "default_for": { "description": "List of Stripe products where this mandate can be selected automatically. Only usable in `setup` mode.", "items": { "enum": [ "invoice", "subscription" ], "type": "string" }, "type": "array" }, "interval_description": { "description": "Description of the mandate interval. Only required if 'payment_schedule' parameter is 'interval' or 'combined'.", "maxLength": 500, "type": "string" }, "payment_schedule": { "description": "Payment schedule for the mandate.", "enum": [ "combined", "interval", "sporadic" ], "type": "string" }, "transaction_type": { "description": "Transaction type of the mandate.", "enum": [ "business", "personal" ], "type": "string" } }, "title": "mandate_options_param", "type": "object", "x-stripeMostCommon": [ "custom_mandate_url", "default_for", "interval_description", "payment_schedule", "transaction_type" ] }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none", "off_session", "on_session" ], "type": "string" }, "target_date": { "description": "Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.", "maxLength": 5000, "type": "string" }, "verification_method": { "description": "Verification method for the intent", "enum": [ "automatic", "instant", "microdeposits" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "currency", "mandate_options", "setup_future_usage", "target_date", "verification_method" ] }, "affirm": { "description": "contains details about the Affirm payment method options.", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "capture_method", "setup_future_usage" ] }, "afterpay_clearpay": { "description": "contains details about the Afterpay Clearpay payment method options.", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "capture_method", "setup_future_usage" ] }, "alipay": { "description": "contains details about the Alipay payment method options.", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "currency", "setup_future_usage" ] }, "amazon_pay": { "description": "contains details about the AmazonPay payment method options.", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none", "off_session" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "capture_method", "setup_future_usage" ] }, "au_becs_debit": { "description": "contains details about the AU Becs Debit payment method options.", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string" }, "target_date": { "description": "Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.", "maxLength": 5000, "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "setup_future_usage", "target_date" ] }, "bacs_debit": { "description": "contains details about the Bacs Debit payment method options.", "properties": { "mandate_options": { "description": "Additional fields for Mandate creation", "properties": { "reference_prefix": { "anyOf": [ { "maxLength": 12, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'." } }, "title": "payment_method_options_mandate_options_param", "type": "object", "x-stripeMostCommon": [ "reference_prefix" ] }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none", "off_session", "on_session" ], "type": "string" }, "target_date": { "description": "Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.", "maxLength": 5000, "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "mandate_options", "setup_future_usage", "target_date" ] }, "bancontact": { "description": "contains details about the Bancontact payment method options.", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "setup_future_usage" ] }, "boleto": { "description": "contains details about the Boleto payment method options.", "properties": { "expires_after_days": { "description": "The number of calendar days before a Boleto voucher expires. For example, if you create a Boleto voucher on Monday and you set expires_after_days to 2, the Boleto invoice will expire on Wednesday at 23:59 America/Sao_Paulo time.", "type": "integer" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none", "off_session", "on_session" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "expires_after_days", "setup_future_usage" ] }, "card": { "description": "contains details about the Card payment method options.", "properties": { "installments": { "description": "Installment options for card payments", "properties": { "enabled": { "description": "Setting to true enables installments for this Checkout Session.\nSetting to false will prevent any installment plan from applying to a payment.", "type": "boolean" } }, "title": "installments_param", "type": "object", "x-stripeMostCommon": [ "enabled" ] }, "request_decremental_authorization": { "description": "Request ability to [capture beyond the standard authorization validity window](/payments/extended-authorization) for this CheckoutSession.", "enum": [ "if_available", "never" ], "type": "string" }, "request_extended_authorization": { "description": "Request ability to [capture beyond the standard authorization validity window](/payments/extended-authorization) for this CheckoutSession.", "enum": [ "if_available", "never" ], "type": "string" }, "request_incremental_authorization": { "description": "Request ability to [increment the authorization](/payments/incremental-authorization) for this CheckoutSession.", "enum": [ "if_available", "never" ], "type": "string" }, "request_multicapture": { "description": "Request ability to make [multiple captures](/payments/multicapture) for this CheckoutSession.", "enum": [ "if_available", "never" ], "type": "string" }, "request_overcapture": { "description": "Request ability to [overcapture](/payments/overcapture) for this CheckoutSession.", "enum": [ "if_available", "never" ], "type": "string" }, "request_three_d_secure": { "description": "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.", "enum": [ "any", "automatic", "challenge" ], "type": "string", "x-stripeBypassValidation": true }, "restrictions": { "description": "Restrictions to apply to the card payment method. For example, you can block specific card brands.", "properties": { "brands_blocked": { "description": "Specify the card brands to block in the Checkout Session. If a customer enters or selects a card belonging to a blocked brand, they can't complete the Session.", "items": { "enum": [ "american_express", "discover_global_network", "mastercard", "visa" ], "type": "string" }, "type": "array" } }, "title": "restrictions_param", "type": "object", "x-stripeMostCommon": [ "brands_blocked" ] }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "off_session", "on_session" ], "type": "string" }, "statement_descriptor_suffix_kana": { "description": "Provides information about a card payment that customers see on their statements. Concatenated with the Kana prefix (shortened Kana descriptor) or Kana statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 22 characters.", "maxLength": 22, "type": "string" }, "statement_descriptor_suffix_kanji": { "description": "Provides information about a card payment that customers see on their statements. Concatenated with the Kanji prefix (shortened Kanji descriptor) or Kanji statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 17 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 17 characters.", "maxLength": 17, "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "capture_method", "installments", "recipient_details", "request_decremental_authorization", "request_extended_authorization", "request_incremental_authorization", "request_multicapture", "request_overcapture", "request_three_d_secure", "restrictions", "sender_details", "setup_future_usage", "statement_descriptor_suffix_kana", "statement_descriptor_suffix_kanji" ] }, "cashapp": { "description": "contains details about the Cashapp Pay payment method options.", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none", "off_session", "on_session" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "capture_method", "setup_future_usage" ] }, "customer_balance": { "description": "contains details about the Customer Balance payment method options.", "properties": { "bank_transfer": { "description": "Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`.", "properties": { "eu_bank_transfer": { "description": "Configuration for eu_bank_transfer funding type.", "properties": { "country": { "description": "The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`.", "maxLength": 5000, "type": "string" } }, "required": [ "country" ], "title": "eu_bank_transfer_params", "type": "object", "x-stripeMostCommon": [ "country" ] }, "requested_address_types": { "description": "List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.\n\nPermitted values include: `sort_code`, `zengin`, `iban`, or `spei`.", "items": { "enum": [ "aba", "iban", "sepa", "sort_code", "spei", "swift", "zengin" ], "type": "string", "x-stripeBypassValidation": true }, "type": "array" }, "type": { "description": "The list of bank transfer types that this PaymentIntent is allowed to use for funding.", "enum": [ "eu_bank_transfer", "gb_bank_transfer", "jp_bank_transfer", "mx_bank_transfer", "us_bank_transfer" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "bank_transfer_param", "type": "object", "x-stripeMostCommon": [ "eu_bank_transfer", "id_bank_transfer", "requested_address_types", "type" ] }, "funding_type": { "description": "The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.", "enum": [ "bank_transfer" ], "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "bank_transfer", "funding_type", "setup_future_usage" ] }, "eps": { "description": "contains details about the EPS payment method options.", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "setup_future_usage" ] }, "fpx": { "description": "contains details about the FPX payment method options.", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "setup_future_usage" ] }, "giropay": { "description": "contains details about the Giropay payment method options.", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "setup_future_usage" ] }, "grabpay": { "description": "contains details about the Grabpay payment method options.", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "setup_future_usage" ] }, "ideal": { "description": "contains details about the Ideal payment method options.", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "setup_future_usage" ] }, "kakao_pay": { "description": "contains details about the Kakao Pay payment method options.", "properties": { "capture_method": { "description": "Controls when the funds will be captured from the customer's account.", "enum": [ "manual" ], "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none", "off_session" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "capture_method", "setup_future_usage" ] }, "klarna": { "description": "contains details about the Klarna payment method options.", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string" }, "subscriptions": { "anyOf": [ { "items": { "properties": { "interval": { "description": "Unit of time between subscription charges.", "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "description": "The number of intervals (specified in the `interval` attribute) between subscription charges. For example, `interval=month` and `interval_count=3` charges every 3 months.", "type": "integer" }, "name": { "description": "Name for subscription.", "maxLength": 255, "type": "string" }, "next_billing": { "description": "Describes the upcoming charge for this subscription.", "properties": { "amount": { "description": "The amount of the next charge for the subscription.", "type": "integer" }, "date": { "description": "The date of the next charge for the subscription in YYYY-MM-DD format.", "maxLength": 5000, "type": "string" } }, "required": [ "amount", "date" ], "title": "subscription_next_billing_param", "type": "object", "x-stripeMostCommon": [ "amount", "date" ] }, "reference": { "description": "A non-customer-facing reference to correlate subscription charges in the Klarna app. Use a value that persists across subscription charges.", "maxLength": 255, "type": "string" } }, "required": [ "interval", "next_billing", "reference" ], "title": "setup_intent_subscription_param", "type": "object", "x-stripeMostCommon": [ "interval", "interval_count", "name", "next_billing", "reference" ] }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "Subscription details if the Checkout Session sets up a future subscription." } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "capture_method", "interoperability_token", "setup_future_usage", "subscriptions" ] }, "konbini": { "description": "contains details about the Konbini payment method options.", "properties": { "expires_after_days": { "description": "The number of calendar days (between 1 and 60) after which Konbini payment instructions will expire. For example, if a PaymentIntent is confirmed with Konbini and `expires_after_days` set to 2 on Monday JST, the instructions will expire on Wednesday 23:59:59 JST. Defaults to 3 days.", "type": "integer" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "expires_after_days", "setup_future_usage" ] }, "kr_card": { "description": "contains details about the Korean card payment method options.", "properties": { "capture_method": { "description": "Controls when the funds will be captured from the customer's account.", "enum": [ "manual" ], "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none", "off_session" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "capture_method", "setup_future_usage" ] }, "link": { "description": "contains details about the Link payment method options.", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none", "off_session" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "capture_method", "setup_future_usage" ] }, "mobilepay": { "description": "contains details about the Mobilepay payment method options.", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "capture_method", "setup_future_usage" ] }, "multibanco": { "description": "contains details about the Multibanco payment method options.", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "setup_future_usage" ] }, "naver_pay": { "description": "contains details about the Naver Pay payment method options.", "properties": { "capture_method": { "description": "Controls when the funds will be captured from the customer's account.", "enum": [ "manual" ], "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none", "off_session" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "capture_method", "setup_future_usage" ] }, "oxxo": { "description": "contains details about the OXXO payment method options.", "properties": { "expires_after_days": { "description": "The number of calendar days before an OXXO voucher expires. For example, if you create an OXXO voucher on Monday and you set expires_after_days to 2, the OXXO invoice will expire on Wednesday at 23:59 America/Mexico_City time.", "type": "integer" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "expires_after_days", "setup_future_usage" ] }, "p24": { "description": "contains details about the P24 payment method options.", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string" }, "tos_shown_and_accepted": { "description": "Confirm that the payer has accepted the P24 terms and conditions.", "type": "boolean" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "setup_future_usage", "tos_shown_and_accepted" ] }, "pay_by_bank": { "description": "contains details about the Pay By Bank payment method options.", "properties": {}, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "allow_delayed_notification", "country", "locale", "statement_descriptor" ] }, "payco": { "description": "contains details about the PAYCO payment method options.", "properties": { "capture_method": { "description": "Controls when the funds will be captured from the customer's account.", "enum": [ "manual" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "capture_method" ] }, "paynow": { "description": "contains details about the PayNow payment method options.", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "setup_future_usage" ] }, "paypal": { "description": "contains details about the PayPal payment method options.", "properties": { "capture_method": { "description": "Controls when the funds will be captured from the customer's account.", "enum": [ "", "manual" ], "type": "string" }, "preferred_locale": { "description": "[Preferred locale](https://stripe.com/docs/payments/paypal/supported-locales) of the PayPal checkout page that the customer is redirected to.", "enum": [ "cs-CZ", "da-DK", "de-AT", "de-DE", "de-LU", "el-GR", "en-GB", "en-US", "es-ES", "fi-FI", "fr-BE", "fr-FR", "fr-LU", "hu-HU", "it-IT", "nl-BE", "nl-NL", "pl-PL", "pt-PT", "sk-SK", "sv-SE" ], "type": "string", "x-stripeBypassValidation": true }, "reference": { "description": "A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID.", "maxLength": 127, "type": "string" }, "reference_id": { "description": "A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID.", "maxLength": 127, "type": "string" }, "risk_correlation_id": { "description": "The risk correlation ID for an on-session payment using a saved PayPal payment method.", "maxLength": 32, "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "", "none", "off_session" ], "type": "string" }, "subsellers": { "description": "The Stripe connected account IDs of the sellers on the platform for this transaction (optional). Only allowed when [separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers) are used.", "items": { "maxLength": 32, "type": "string" }, "type": "array" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "capture_method", "preferred_locale", "reference", "reference_id", "risk_correlation_id", "setup_future_usage", "subsellers" ] }, "payto": { "description": "contains details about the PayTo payment method options.", "properties": { "mandate_options": { "description": "Additional fields for Mandate creation", "properties": { "amount": { "description": "Amount that will be collected. It is required when `amount_type` is `fixed`.", "type": "integer" }, "amount_type": { "description": "The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively.", "enum": [ "fixed", "maximum" ], "type": "string" }, "end_date": { "description": "Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.", "maxLength": 5000, "type": "string" }, "payment_schedule": { "description": "The periodicity at which payments will be collected.", "enum": [ "adhoc", "annual", "daily", "fortnightly", "monthly", "quarterly", "semi_annual", "weekly" ], "type": "string" }, "payments_per_period": { "description": "The number of payments that will be made during a payment period. Defaults to 1 except for when `payment_schedule` is `adhoc`. In that case, it defaults to no limit.", "type": "integer" }, "purpose": { "description": "The purpose for which payments are made. Defaults to retail.", "enum": [ "dependant_support", "government", "loan", "mortgage", "other", "pension", "personal", "retail", "salary", "tax", "utility" ], "type": "string" }, "start_date": { "description": "Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time.", "maxLength": 5000, "type": "string" } }, "title": "setup_intent_payment_method_options_mandate_options_param", "type": "object", "x-stripeMostCommon": [ "amount", "amount_type", "end_date", "payment_schedule", "payments_per_period", "purpose", "start_date" ] }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none", "off_session" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "mandate_options", "setup_future_usage" ] }, "pix": { "description": "contains details about the Pix payment method options.", "properties": { "amount_includes_iof": { "description": "Determines if the amount includes the IOF tax. Defaults to `never`.", "enum": [ "always", "never" ], "type": "string" }, "expires_after_seconds": { "description": "The number of seconds (between 10 and 1209600) after which Pix payment will expire. Defaults to 86400 seconds.", "type": "integer" }, "mandate_options": { "description": "Additional fields for mandate creation.", "properties": { "amount": { "description": "Amount to be charged for future payments. Required when `amount_type=fixed`. If not provided for `amount_type=maximum`, defaults to 40000.", "type": "integer" }, "amount_includes_iof": { "description": "Determines if the amount includes the IOF tax. Defaults to `never`.", "enum": [ "always", "never" ], "type": "string" }, "amount_type": { "description": "Type of amount. Defaults to `maximum`.", "enum": [ "fixed", "maximum" ], "type": "string" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Only `brl` is supported currently.", "format": "currency", "type": "string" }, "end_date": { "description": "Date when the mandate expires and no further payments will be charged, in `YYYY-MM-DD`. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.", "maxLength": 5000, "type": "string" }, "payment_schedule": { "description": "Schedule at which the future payments will be charged. Defaults to `weekly`.", "enum": [ "halfyearly", "monthly", "quarterly", "weekly", "yearly" ], "type": "string" }, "reference": { "description": "Subscription name displayed to buyers in their bank app. Defaults to the displayable business name.", "maxLength": 35, "type": "string" }, "start_date": { "description": "Start date of the mandate, in `YYYY-MM-DD`. Start date should be at least 3 days in the future. Defaults to 3 days after the current date.", "maxLength": 5000, "type": "string" } }, "title": "payment_method_options_mandate_options_param", "type": "object", "x-stripeMostCommon": [ "amount", "amount_includes_iof", "amount_type", "currency", "end_date", "payment_schedule", "reference", "start_date" ] }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none", "off_session" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "amount_includes_iof", "expires_after_seconds", "mandate_options", "setup_future_usage" ] }, "revolut_pay": { "description": "contains details about the RevolutPay payment method options.", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none", "off_session" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "capture_method", "setup_future_usage" ] }, "samsung_pay": { "description": "contains details about the Samsung Pay payment method options.", "properties": { "capture_method": { "description": "Controls when the funds will be captured from the customer's account.", "enum": [ "manual" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "capture_method" ] }, "sepa_debit": { "description": "contains details about the Sepa Debit payment method options.", "properties": { "mandate_options": { "description": "Additional fields for Mandate creation", "properties": { "reference_prefix": { "anyOf": [ { "maxLength": 12, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'." } }, "title": "payment_method_options_mandate_options_param", "type": "object", "x-stripeMostCommon": [ "reference", "reference_prefix" ] }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none", "off_session", "on_session" ], "type": "string" }, "target_date": { "description": "Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.", "maxLength": 5000, "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "mandate_options", "setup_future_usage", "target_date", "verification_method" ] }, "sofort": { "description": "contains details about the Sofort payment method options.", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "setup_future_usage" ] }, "swish": { "description": "contains details about the Swish payment method options.", "properties": { "reference": { "description": "The order reference that will be displayed to customers in the Swish application. Defaults to the `id` of the Payment Intent.", "maxLength": 5000, "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "authorization_method", "reference" ] }, "us_bank_account": { "description": "contains details about the Us Bank Account payment method options.", "properties": { "financial_connections": { "description": "Additional fields for Financial Connections Session creation", "properties": { "permissions": { "description": "The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.", "items": { "enum": [ "balances", "ownership", "payment_method", "transactions" ], "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true }, "type": "array" }, "prefetch": { "description": "List of data features that you would like to retrieve upon account creation.", "items": { "enum": [ "balances", "inferred_balances", "ownership", "transactions" ], "type": "string", "x-stripeBypassValidation": true }, "type": "array" } }, "title": "linked_account_options_param", "type": "object", "x-stripeMostCommon": [ "permissions", "prefetch" ] }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none", "off_session", "on_session" ], "type": "string" }, "target_date": { "description": "Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.", "maxLength": 5000, "type": "string" }, "verification_method": { "description": "Verification method for the intent", "enum": [ "automatic", "instant" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "financial_connections", "setup_future_usage", "target_date", "verification_method" ] }, "wechat_pay": { "description": "contains details about the WeChat Pay payment method options.", "properties": { "app_id": { "description": "The app ID registered with WeChat Pay. Only required when client is ios or android.", "maxLength": 5000, "type": "string" }, "client": { "description": "The client type that the end customer will pay from", "enum": [ "android", "ios", "web" ], "type": "string", "x-stripeBypassValidation": true }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string" } }, "required": [ "client" ], "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "app_id", "client", "setup_future_usage" ] } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "acss_debit", "affirm", "afterpay_clearpay", "alipay", "alma", "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", "billie", "boleto", "card", "cashapp", "crypto", "customer_balance", "demo_pay", "eps", "fpx", "giropay", "grabpay", "id_bank_transfer", "ideal", "kakao_pay", "klarna", "konbini", "kr_card", "kr_market", "link", "mobilepay", "multibanco", "naver_pay", "ng_bank", "ng_bank_transfer", "ng_card", "ng_market", "ng_ussd", "oxxo", "p24", "pay_by_bank", "payco", "paynow", "paypal", "payto", "pix", "revolut_pay", "samsung_pay", "satispay", "sepa_debit", "sofort", "swish", "upi", "us_bank_account", "wechat_pay" ] }, "payment_method_types": { "description": "A list of the types of payment methods (e.g., `card`) this Checkout Session can accept.\n\nYou can omit this attribute to manage your payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods).\nSee [Dynamic Payment Methods](https://stripe.com/docs/payments/payment-methods/integration-options#using-dynamic-payment-methods) for more details.\n\nRead more about the supported payment methods and their requirements in our [payment\nmethod details guide](/docs/payments/checkout/payment-methods).\n\nIf multiple payment methods are passed, Checkout will dynamically reorder them to\nprioritize the most relevant payment methods based on the customer's location and\nother characteristics.", "items": { "enum": [ "acss_debit", "affirm", "afterpay_clearpay", "alipay", "alma", "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", "billie", "blik", "boleto", "card", "cashapp", "crypto", "customer_balance", "eps", "fpx", "giropay", "gopay", "grabpay", "ideal", "kakao_pay", "klarna", "konbini", "kr_card", "link", "mb_way", "mobilepay", "multibanco", "naver_pay", "nz_bank_account", "oxxo", "p24", "pay_by_bank", "payco", "paynow", "paypal", "paypay", "payto", "pix", "promptpay", "qris", "rechnung", "revolut_pay", "samsung_pay", "satispay", "sepa_debit", "shopeepay", "sofort", "swish", "twint", "us_bank_account", "wechat_pay", "zip" ], "type": "string", "x-stripeBypassValidation": true }, "type": "array" }, "permissions": { "description": "This property is used to set up permissions for various actions (e.g., update) on the CheckoutSession object. Can only be set when creating `embedded` or `custom` sessions.\n\nFor specific permissions, please refer to their dedicated subsections, such as `permissions.update_shipping_details`.", "properties": { "update": { "description": "Permissions for updating the Checkout Session.", "properties": { "line_items": { "description": "Determines which entity is allowed to update the line items.\n\nDefault is `client_only`. Stripe Checkout client will automatically update the line items. If set to `server_only`, only your server is allowed to update the line items.\n\nWhen set to `server_only`, you must add the onLineItemsChange event handler when initializing the Stripe Checkout client and manually update the line items from your server using the Stripe API.", "enum": [ "client_only", "server_only" ], "type": "string" }, "shipping_details": { "description": "Determines which entity is allowed to update the shipping details.\n\nDefault is `client_only`. Stripe Checkout client will automatically update the shipping details. If set to `server_only`, only your server is allowed to update the shipping details.\n\nWhen set to `server_only`, you must add the onShippingDetailsChange event handler when initializing the Stripe Checkout client and manually update the shipping details from your server using the Stripe API.", "enum": [ "client_only", "server_only" ], "type": "string" } }, "title": "permissions_update_param", "type": "object", "x-stripeMostCommon": [ "line_items", "shipping_details" ] }, "update_discounts": { "description": "Determines which entity is allowed to update the discounts (coupons or promotion codes) that apply to this session.\n\nDefault is `client_only`. Stripe Checkout client will automatically handle discount updates. If set to `server_only`, only your server is allowed to update discounts.", "enum": [ "client_only", "server_only" ], "type": "string" }, "update_line_items": { "description": "Determines which entity is allowed to update the line items.\n\nDefault is `client_only`. Stripe Checkout client will automatically update the line items. If set to `server_only`, only your server is allowed to update the line items.\n\nWhen set to `server_only`, you must add the onLineItemsChange event handler when initializing the Stripe Checkout client and manually update the line items from your server using the Stripe API.", "enum": [ "client_only", "server_only" ], "type": "string" }, "update_shipping_details": { "description": "Determines which entity is allowed to update the shipping details.\n\nDefault is `client_only`. Stripe Checkout client will automatically update the shipping details. If set to `server_only`, only your server is allowed to update the shipping details.\n\nWhen set to `server_only`, you must add the onShippingDetailsChange event handler when initializing the Stripe Checkout client and manually update the shipping details from your server using the Stripe API.", "enum": [ "client_only", "server_only" ], "type": "string" } }, "title": "permissions_param", "type": "object", "x-stripeMostCommon": [ "update", "update_discounts", "update_line_items", "update_shipping_details" ] }, "phone_number_collection": { "description": "Controls phone number collection settings for the session.\n\nWe recommend that you review your privacy policy and check with your legal contacts\nbefore using this feature. Learn more about [collecting phone numbers with Checkout](https://stripe.com/docs/payments/checkout/phone-numbers).", "properties": { "enabled": { "description": "Set to `true` to enable phone number collection.\n\nCan only be set in `payment` and `subscription` mode.", "type": "boolean" } }, "required": [ "enabled" ], "title": "phone_number_collection_params", "type": "object", "x-stripeMostCommon": [ "enabled" ] }, "redirect_on_completion": { "description": "This parameter applies to `ui_mode: embedded`. Learn more about the [redirect behavior](https://stripe.com/docs/payments/checkout/custom-success-page?payment-ui=embedded-form) of embedded sessions. Defaults to `always`.", "enum": [ "always", "if_required", "never" ], "type": "string" }, "return_url": { "description": "The URL to redirect your customer back to after they authenticate or cancel their payment on the\npayment method's app or site. This parameter is required if `ui_mode` is `embedded` or `custom`\nand redirect-based payment methods are enabled on the session.", "type": "string" }, "saved_payment_method_options": { "description": "Controls saved payment method settings for the session. Only available in `payment` and `subscription` mode.", "properties": { "allow_redisplay_filters": { "description": "Uses the `allow_redisplay` value of each saved payment method to filter the set presented to a returning customer. By default, only saved payment methods with ’allow_redisplay: ‘always’ are shown in Checkout.", "items": { "enum": [ "always", "limited", "unspecified" ], "type": "string" }, "type": "array" }, "payment_method_remove": { "description": "Enable customers to choose if they wish to remove their saved payment methods. Disabled by default.", "enum": [ "disabled", "enabled" ], "type": "string" }, "payment_method_save": { "description": "Enable customers to choose if they wish to save their payment method for future use. Disabled by default.", "enum": [ "disabled", "enabled" ], "type": "string" } }, "title": "saved_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "allow_redisplay_filters", "payment_method_remove", "payment_method_save" ] }, "setup_intent_data": { "description": "A subset of parameters to be passed to SetupIntent creation for Checkout Sessions in `setup` mode.", "properties": { "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users.", "maxLength": 1000, "type": "string" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "on_behalf_of": { "description": "The Stripe account for which the setup is intended.", "type": "string" } }, "title": "setup_intent_data_param", "type": "object", "x-stripeMostCommon": [ "description", "metadata", "on_behalf_of" ] }, "shipping_address_collection": { "description": "When set, provides configuration for Checkout to collect a shipping address from a customer.", "properties": { "allowed_countries": { "description": "An array of two-letter ISO country codes representing which countries Checkout should provide as options for\nshipping locations.", "items": { "enum": [ "AC", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CV", "CW", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MK", "ML", "MM", "MN", "MO", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SZ", "TA", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VN", "VU", "WF", "WS", "XK", "YE", "YT", "ZA", "ZM", "ZW", "ZZ" ], "type": "string" }, "type": "array" } }, "required": [ "allowed_countries" ], "title": "shipping_address_collection_params", "type": "object", "x-stripeMostCommon": [ "allowed_countries" ] }, "shipping_options": { "description": "The shipping rate options to apply to this Session. Up to a maximum of 5.", "items": { "properties": { "shipping_rate": { "description": "The ID of the Shipping Rate to use for this shipping option.", "maxLength": 5000, "type": "string" }, "shipping_rate_data": { "description": "Parameters to be passed to Shipping Rate creation for this shipping option.", "properties": { "delivery_estimate": { "description": "The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.", "properties": { "maximum": { "description": "The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.", "properties": { "unit": { "description": "A unit of time.", "enum": [ "business_day", "day", "hour", "month", "week" ], "type": "string" }, "value": { "description": "Must be greater than 0.", "type": "integer" } }, "required": [ "unit", "value" ], "title": "delivery_estimate_bound", "type": "object", "x-stripeMostCommon": [ "unit", "value" ] }, "minimum": { "description": "The lower bound of the estimated range. If empty, represents no lower bound.", "properties": { "unit": { "description": "A unit of time.", "enum": [ "business_day", "day", "hour", "month", "week" ], "type": "string" }, "value": { "description": "Must be greater than 0.", "type": "integer" } }, "required": [ "unit", "value" ], "title": "delivery_estimate_bound", "type": "object", "x-stripeMostCommon": [ "unit", "value" ] } }, "title": "delivery_estimate", "type": "object", "x-stripeMostCommon": [ "maximum", "minimum" ] }, "display_name": { "description": "The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.", "maxLength": 100, "type": "string" }, "fixed_amount": { "description": "Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`.", "properties": { "amount": { "description": "A non-negative integer in cents representing how much to charge.", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "currency_options": { "additionalProperties": { "properties": { "amount": { "description": "A non-negative integer in cents representing how much to charge.", "type": "integer" }, "tax_behavior": { "description": "Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.", "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" } }, "required": [ "amount" ], "title": "currency_option", "type": "object", "x-stripeMostCommon": [ "amount", "tax_behavior" ] }, "description": "Shipping rates defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).", "type": "object" } }, "required": [ "amount", "currency" ], "title": "fixed_amount", "type": "object", "x-stripeMostCommon": [ "amount", "currency", "currency_options" ] }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "tax_behavior": { "description": "Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.", "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" }, "tax_code": { "description": "A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`.", "type": "string" }, "type": { "description": "The type of calculation to use on the shipping rate.", "enum": [ "fixed_amount" ], "type": "string" } }, "required": [ "display_name" ], "title": "method_params", "type": "object", "x-stripeMostCommon": [ "display_name", "fixed_amount", "metadata", "tax_behavior", "tax_code", "type" ] } }, "title": "shipping_option_params", "type": "object", "x-stripeMostCommon": [ "shipping_rate", "shipping_rate_data" ] }, "type": "array" }, "submit_type": { "description": "Describes the type of transaction being performed by Checkout in order\nto customize relevant text on the page, such as the submit button.\n `submit_type` can only be specified on Checkout Sessions in\n`payment` or `subscription` mode. If blank or `auto`, `pay` is used.", "enum": [ "auto", "book", "donate", "pay", "subscribe" ], "type": "string" }, "subscription_data": { "description": "A subset of parameters to be passed to subscription creation for Checkout Sessions in `subscription` mode.", "properties": { "application_fee_percent": { "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. To use an application fee percent, the request must be made on behalf of another account, using the `Stripe-Account` header or an OAuth key. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).", "type": "number" }, "billing_cycle_anchor": { "description": "A future timestamp to anchor the subscription's billing cycle for new subscriptions.", "format": "unix-time", "type": "integer" }, "billing_mode": { "description": "Controls how prorations and invoices for subscriptions are calculated and orchestrated.", "properties": { "type": { "description": "Controls the calculation and orchestration of prorations and invoices for subscriptions.", "enum": [ "classic", "flexible" ], "type": "string" } }, "required": [ "type" ], "title": "billing_mode", "type": "object", "x-stripeMostCommon": [ "flexible", "type" ] }, "default_tax_rates": { "description": "The tax rates that will apply to any subscription item that does not have\n`tax_rates` set. Invoices created will have their `default_tax_rates` populated\nfrom the subscription.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "description": { "description": "The subscription's description, meant to be displayable to the customer.\nUse this field to optionally store an explanation of the subscription\nfor rendering in the [customer portal](https://stripe.com/docs/customer-management).", "maxLength": 500, "type": "string" }, "invoice_settings": { "description": "All invoices will be billed using the specified settings.", "properties": { "issuer": { "description": "The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.", "properties": { "account": { "description": "The connected account being referenced when `type` is `account`.", "type": "string" }, "type": { "description": "Type of the account referenced in the request.", "enum": [ "account", "self" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "param", "type": "object", "x-stripeMostCommon": [ "account", "type" ] } }, "title": "invoice_settings_params", "type": "object", "x-stripeMostCommon": [ "issuer" ] }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "on_behalf_of": { "description": "The account on behalf of which to charge, for each of the subscription's invoices.", "type": "string" }, "proration_behavior": { "description": "Determines how to handle prorations resulting from the `billing_cycle_anchor`. If no value is passed, the default is `create_prorations`.", "enum": [ "create_prorations", "none" ], "type": "string" }, "transfer_data": { "description": "If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges.", "properties": { "amount_percent": { "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination.", "type": "number" }, "destination": { "description": "ID of an existing, connected Stripe account.", "type": "string" } }, "required": [ "destination" ], "title": "transfer_data_specs", "type": "object", "x-stripeMostCommon": [ "amount_percent", "destination" ] }, "trial_end": { "description": "Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. Has to be at least 48 hours in the future.", "format": "unix-time", "type": "integer" }, "trial_period_days": { "description": "Integer representing the number of trial period days before the customer is charged for the first time. Has to be at least 1.", "type": "integer" }, "trial_settings": { "description": "Settings related to subscription trials.", "properties": { "end_behavior": { "description": "Defines how the subscription should behave when the user's free trial ends.", "properties": { "missing_payment_method": { "description": "Indicates how the subscription should change when the trial ends if the user did not provide a payment method.", "enum": [ "cancel", "create_invoice", "pause" ], "type": "string" } }, "required": [ "missing_payment_method" ], "title": "end_behavior", "type": "object", "x-stripeMostCommon": [ "missing_payment_method" ] } }, "required": [ "end_behavior" ], "title": "trial_settings_config", "type": "object", "x-stripeMostCommon": [ "end_behavior" ] } }, "title": "subscription_data_params", "type": "object", "x-stripeMostCommon": [ "application_fee_percent", "billing_cycle_anchor", "billing_mode", "default_tax_rates", "description", "invoice_settings", "metadata", "on_behalf_of", "proration_behavior", "tax_filing_currency", "transfer_data", "trial_end", "trial_period_days" ] }, "success_url": { "description": "The URL to which Stripe should send customers when payment or setup\nis complete.\nThis parameter is not allowed if ui_mode is `embedded` or `custom`. If you'd like to use\ninformation from the successful Checkout Session on your page, read the\nguide on [customizing your success page](https://stripe.com/docs/payments/checkout/custom-success-page).", "type": "string" }, "tax_id_collection": { "description": "Controls tax ID collection during checkout.", "properties": { "enabled": { "description": "Enable tax ID collection during checkout. Defaults to `false`.", "type": "boolean" }, "required": { "description": "Describes whether a tax ID is required during checkout. Defaults to `never`.", "enum": [ "if_supported", "never" ], "type": "string" } }, "required": [ "enabled" ], "title": "tax_id_collection_params", "type": "object", "x-stripeMostCommon": [ "enabled", "required" ] }, "ui_mode": { "description": "The UI mode of the Session. Defaults to `hosted`.", "enum": [ "custom", "embedded", "hosted" ], "type": "string" }, "wallet_options": { "description": "Wallet-specific configuration.", "properties": { "link": { "description": "contains details about the Link wallet options.", "properties": { "display": { "description": "Specifies whether Checkout should display Link as a payment option. By default, Checkout will display all the supported wallets that the Checkout Session was created with. This is the `auto` behavior, and it is the default choice.", "enum": [ "auto", "never" ], "type": "string" } }, "title": "wallet_options_param", "type": "object", "x-stripeMostCommon": [ "display" ] } }, "title": "wallet_options_param", "type": "object", "x-stripeMostCommon": [ "link" ] } }, "type": "object", "x-stripeMostCommon": [ "automatic_tax", "client_reference_id", "customer", "customer_email", "line_items", "metadata", "mode", "return_url", "success_url", "ui_mode" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/checkout.session" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a Checkout Session" } }, "/v1/checkout/sessions/{session}": { "get": { "description": "

Retrieves a Checkout Session object.

", "operationId": "GetCheckoutSessionsSession", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "session", "required": true, "schema": { "maxLength": 66, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/checkout.session" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a Checkout Session" }, "post": { "description": "

Updates a Checkout Session object.

\n\n

Related guide: Dynamically update Checkout

", "operationId": "PostCheckoutSessionsSession", "parameters": [ { "in": "path", "name": "session", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "collected_information": { "explode": true, "style": "deepObject" }, "discounts": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "line_items": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "shipping_options": { "explode": true, "style": "deepObject" }, "subscription_data": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "collected_information": { "description": "Information about the customer collected within the Checkout Session. Can only be set when updating `embedded` or `custom` sessions.", "properties": { "shipping_details": { "description": "The shipping details to apply to this Session.", "properties": { "address": { "description": "The address of the customer", "properties": { "city": { "description": "City, district, suburb, town, or village.", "maxLength": 5000, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Address line 1 (e.g., street, PO Box, or company name).", "maxLength": 5000, "type": "string" }, "line2": { "description": "Address line 2 (e.g., apartment, suite, unit, or building).", "maxLength": 5000, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "State, county, province, or region.", "maxLength": 5000, "type": "string" } }, "required": [ "country", "line1" ], "title": "address", "type": "object", "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state" ] }, "name": { "description": "The name of customer", "maxLength": 255, "type": "string" } }, "required": [ "address", "name" ], "title": "shipping_details_params", "type": "object", "x-stripeMostCommon": [ "address", "name" ] } }, "title": "collected_information_params", "type": "object", "x-stripeMostCommon": [ "billing_details", "shipping_details" ] }, "discounts": { "anyOf": [ { "items": { "properties": { "coupon": { "description": "The ID of the [Coupon](https://stripe.com/docs/api/coupons) to apply to this Session. One of `coupon` or `coupon_data` is required when updating discounts.", "maxLength": 5000, "type": "string" }, "coupon_data": { "description": "Data used to generate a new [Coupon](https://stripe.com/docs/api/coupon) object inline. One of `coupon` or `coupon_data` is required when updating discounts.", "properties": { "amount_off": { "description": "A positive integer representing the amount to subtract from an invoice total (required if `percent_off` is not passed).", "type": "integer" }, "currency": { "description": "Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the `amount_off` parameter (required if `amount_off` is passed).", "format": "currency", "type": "string" }, "duration": { "description": "Specifies how long the discount will be in effect if used on a subscription. Defaults to `once`.", "enum": [ "forever", "once", "repeating" ], "type": "string", "x-stripeBypassValidation": true }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "name": { "description": "Name of the coupon displayed to customers on, for instance invoices, or receipts. By default the `id` is shown if `name` is not set.", "maxLength": 40, "type": "string" }, "percent_off": { "description": "A positive float larger than 0, and smaller or equal to 100, that represents the discount the coupon will apply (required if `amount_off` is not passed).", "type": "number" } }, "title": "coupon_data", "type": "object", "x-stripeMostCommon": [ "amount_off", "currency", "duration", "metadata", "name", "percent_off" ] } }, "title": "discount_params", "type": "object", "x-stripeMostCommon": [ "coupon", "coupon_data" ] }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "List of coupons and promotion codes attached to the Checkout Session." }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "line_items": { "description": "A list of items the customer is purchasing.\n\nWhen updating line items, you must retransmit the entire array of line items.\n\nTo retain an existing line item, specify its `id`.\n\nTo update an existing line item, specify its `id` along with the new values of the fields to update.\n\nTo add a new line item, specify one of `price` or `price_data` and `quantity`.\n\nTo remove an existing line item, omit the line item's ID from the retransmitted array.\n\nTo reorder a line item, specify it at the desired position in the retransmitted array.", "items": { "properties": { "adjustable_quantity": { "description": "When set, provides configuration for this item’s quantity to be adjusted by the customer during Checkout.", "properties": { "enabled": { "description": "Set to true if the quantity can be adjusted to any positive integer. Setting to false will remove any previously specified constraints on quantity.", "type": "boolean" }, "maximum": { "description": "The maximum quantity the customer can purchase for the Checkout Session. By default this value is 99. You can specify a value up to 999999.", "type": "integer" }, "minimum": { "description": "The minimum quantity the customer must purchase for the Checkout Session. By default this value is 0.", "type": "integer" } }, "required": [ "enabled" ], "title": "adjustable_quantity_params", "type": "object", "x-stripeMostCommon": [ "enabled", "maximum", "minimum" ] }, "id": { "description": "ID of an existing line item.", "maxLength": 5000, "type": "string" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "price": { "description": "The ID of the [Price](https://stripe.com/docs/api/prices). One of `price` or `price_data` is required when creating a new line item.", "maxLength": 5000, "type": "string" }, "price_data": { "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required when creating a new line item.", "properties": { "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "product": { "description": "The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to. One of `product` or `product_data` is required.", "maxLength": 5000, "type": "string" }, "product_data": { "description": "Data used to generate a new [Product](https://docs.stripe.com/api/products) object inline. One of `product` or `product_data` is required.", "properties": { "description": { "description": "The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.", "maxLength": 40000, "type": "string" }, "images": { "description": "A list of up to 8 URLs of images for this product, meant to be displayable to the customer.", "items": { "type": "string" }, "type": "array" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "name": { "description": "The product's name, meant to be displayable to the customer.", "maxLength": 5000, "type": "string" }, "tax_code": { "description": "A [tax code](https://stripe.com/docs/tax/tax-categories) ID.", "maxLength": 5000, "type": "string" } }, "required": [ "name" ], "title": "product_data", "type": "object", "x-stripeMostCommon": [ "description", "images", "metadata", "name", "tax_code", "unit_label" ] }, "recurring": { "description": "The recurring components of a price such as `interval` and `interval_count`.", "properties": { "interval": { "description": "Specifies billing frequency. Either `day`, `week`, `month` or `year`.", "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "description": "The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).", "type": "integer" } }, "required": [ "interval" ], "title": "recurring_adhoc", "type": "object", "x-stripeMostCommon": [ "interval" ] }, "tax_behavior": { "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.", "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" }, "unit_amount": { "description": "A non-negative integer in cents (or local equivalent) representing how much to charge. One of `unit_amount` or `unit_amount_decimal` is required.", "type": "integer" }, "unit_amount_decimal": { "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", "format": "decimal", "type": "string" } }, "required": [ "currency" ], "title": "price_data_with_product_data", "type": "object", "x-stripeMostCommon": [ "currency", "product", "unit_amount" ] }, "quantity": { "description": "The quantity of the line item being purchased. Quantity should not be defined when `recurring.usage_type=metered`.", "type": "integer" }, "tax_rates": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The [tax rates](https://stripe.com/docs/api/tax_rates) which apply to this line item." } }, "title": "line_item_params", "type": "object", "x-stripeMostCommon": [ "adjustable_quantity", "id", "metadata", "price", "price_data", "quantity", "tax_rates" ] }, "type": "array" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "shipping_options": { "anyOf": [ { "items": { "properties": { "shipping_rate": { "description": "The ID of the Shipping Rate to use for this shipping option.", "maxLength": 5000, "type": "string" }, "shipping_rate_data": { "description": "Parameters to be passed to Shipping Rate creation for this shipping option.", "properties": { "delivery_estimate": { "description": "The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.", "properties": { "maximum": { "description": "The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.", "properties": { "unit": { "description": "A unit of time.", "enum": [ "business_day", "day", "hour", "month", "week" ], "type": "string" }, "value": { "description": "Must be greater than 0.", "type": "integer" } }, "required": [ "unit", "value" ], "title": "delivery_estimate_bound", "type": "object", "x-stripeMostCommon": [ "unit", "value" ] }, "minimum": { "description": "The lower bound of the estimated range. If empty, represents no lower bound.", "properties": { "unit": { "description": "A unit of time.", "enum": [ "business_day", "day", "hour", "month", "week" ], "type": "string" }, "value": { "description": "Must be greater than 0.", "type": "integer" } }, "required": [ "unit", "value" ], "title": "delivery_estimate_bound", "type": "object", "x-stripeMostCommon": [ "unit", "value" ] } }, "title": "delivery_estimate", "type": "object", "x-stripeMostCommon": [ "maximum", "minimum" ] }, "display_name": { "description": "The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.", "maxLength": 100, "type": "string" }, "fixed_amount": { "description": "Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`.", "properties": { "amount": { "description": "A non-negative integer in cents representing how much to charge.", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "currency_options": { "additionalProperties": { "properties": { "amount": { "description": "A non-negative integer in cents representing how much to charge.", "type": "integer" }, "tax_behavior": { "description": "Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.", "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" } }, "required": [ "amount" ], "title": "currency_option", "type": "object", "x-stripeMostCommon": [ "amount", "tax_behavior" ] }, "description": "Shipping rates defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).", "type": "object" } }, "required": [ "amount", "currency" ], "title": "fixed_amount", "type": "object", "x-stripeMostCommon": [ "amount", "currency", "currency_options" ] }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "tax_behavior": { "description": "Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.", "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" }, "tax_code": { "description": "A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`.", "type": "string" }, "type": { "description": "The type of calculation to use on the shipping rate.", "enum": [ "fixed_amount" ], "type": "string" } }, "required": [ "display_name" ], "title": "method_params", "type": "object", "x-stripeMostCommon": [ "display_name", "fixed_amount", "metadata", "tax_behavior", "tax_code", "type" ] } }, "title": "shipping_option_params", "type": "object", "x-stripeMostCommon": [ "shipping_rate", "shipping_rate_data" ] }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The shipping rate options to apply to this Session. Up to a maximum of 5." }, "subscription_data": { "description": "A subset of parameters to be passed to subscription creation for Checkout Sessions in `subscription` mode.", "properties": { "trial_end": { "description": "Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. Has to be at least 48 hours in the future.", "format": "unix-time", "type": "integer" }, "trial_period_days": { "anyOf": [ { "type": "integer" }, { "enum": [ "" ], "type": "string" } ], "description": "Integer representing the number of trial period days before the customer is charged for the first time. Has to be at least 1." } }, "title": "subscription_data_params", "type": "object", "x-stripeMostCommon": [ "invoice_settings", "trial_end", "trial_period_days" ] } }, "type": "object", "x-stripeMostCommon": [ "line_items", "metadata" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/checkout.session" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a Checkout Session" } }, "/v1/checkout/sessions/{session}/expire": { "post": { "description": "

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

\n\n

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

", "operationId": "PostCheckoutSessionsSessionExpire", "parameters": [ { "in": "path", "name": "session", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/checkout.session" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Expire a Checkout Session" } }, "/v1/checkout/sessions/{session}/line_items": { "get": { "description": "

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.

", "operationId": "GetCheckoutSessionsSessionLineItems", "parameters": [ { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "in": "path", "name": "session", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/item" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "PaymentPagesCheckoutSessionListLineItems", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a Checkout Session's line items" } }, "/v1/climate/orders": { "get": { "description": "

Lists all Climate order objects. The orders are returned sorted by creation date, with the\nmost recently created orders appearing first.

", "operationId": "GetClimateOrders", "parameters": [ { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/climate.order" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/climate/orders", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "ClimateRemovalsOrdersList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List orders" }, "post": { "description": "

Creates a Climate order object for a given Climate product. The order will be processed immediately\nafter creation and payment will be deducted your Stripe balance.

", "operationId": "PostClimateOrders", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "beneficiary": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "amount": { "description": "Requested amount of carbon removal units. Either this or `metric_tons` must be specified.", "type": "integer" }, "beneficiary": { "description": "Publicly sharable reference for the end beneficiary of carbon removal. Assumed to be the Stripe account if not set.", "properties": { "public_name": { "description": "Publicly displayable name for the end beneficiary of carbon removal.", "maxLength": 5000, "type": "string" } }, "required": [ "public_name" ], "title": "beneficiary_params", "type": "object", "x-stripeMostCommon": [ "public_name" ] }, "currency": { "description": "Request currency for the order as a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a supported [settlement currency for your account](https://stripe.com/docs/currencies). If omitted, the account's default currency will be used.", "maxLength": 5000, "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "metric_tons": { "description": "Requested number of tons for the order. Either this or `amount` must be specified.", "format": "decimal", "type": "string" }, "product": { "description": "Unique identifier of the Climate product.", "maxLength": 5000, "type": "string" } }, "required": [ "product" ], "type": "object", "x-stripeMostCommon": [ "amount", "beneficiary", "currency", "metadata", "metric_tons", "product" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/climate.order" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create an order" } }, "/v1/climate/orders/{order}": { "get": { "description": "

Retrieves the details of a Climate order object with the given ID.

", "operationId": "GetClimateOrdersOrder", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "Unique identifier of the order.", "in": "path", "name": "order", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/climate.order" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve an order" }, "post": { "description": "

Updates the specified order by setting the values of the parameters passed.

", "operationId": "PostClimateOrdersOrder", "parameters": [ { "description": "Unique identifier of the order.", "in": "path", "name": "order", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "beneficiary": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "beneficiary": { "anyOf": [ { "properties": { "public_name": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Publicly displayable name for the end beneficiary of carbon removal." } }, "required": [ "public_name" ], "title": "beneficiary_params", "type": "object", "x-stripeMostCommon": [ "public_name" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Publicly sharable reference for the end beneficiary of carbon removal. Assumed to be the Stripe account if not set." }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" } }, "type": "object", "x-stripeMostCommon": [ "beneficiary", "metadata" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/climate.order" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update an order" } }, "/v1/climate/orders/{order}/cancel": { "post": { "description": "

Cancels a Climate order. You can cancel an order within 24 hours of creation. Stripe refunds the\nreservation amount_subtotal, but not the amount_fees for user-triggered cancellations. Frontier\nmight cancel reservations if suppliers fail to deliver. If Frontier cancels the reservation, Stripe\nprovides 90 days advance notice and refunds the amount_total.

", "operationId": "PostClimateOrdersOrderCancel", "parameters": [ { "description": "Unique identifier of the order.", "in": "path", "name": "order", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/climate.order" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Cancel an order" } }, "/v1/climate/products": { "get": { "description": "

Lists all available Climate product objects.

", "operationId": "GetClimateProducts", "parameters": [ { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/climate.product" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/climate/products", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "ClimateRemovalsProductsList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List products" } }, "/v1/climate/products/{product}": { "get": { "description": "

Retrieves the details of a Climate product with the given ID.

", "operationId": "GetClimateProductsProduct", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "product", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/climate.product" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a product" } }, "/v1/climate/suppliers": { "get": { "description": "

Lists all available Climate supplier objects.

", "operationId": "GetClimateSuppliers", "parameters": [ { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/climate.supplier" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/climate/suppliers", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "ClimateRemovalsSuppliersList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List suppliers" } }, "/v1/climate/suppliers/{supplier}": { "get": { "description": "

Retrieves a Climate supplier object.

", "operationId": "GetClimateSuppliersSupplier", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "supplier", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/climate.supplier" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a supplier" } }, "/v1/confirmation_tokens/{confirmation_token}": { "get": { "description": "

Retrieves an existing ConfirmationToken object

", "operationId": "GetConfirmationTokensConfirmationToken", "parameters": [ { "in": "path", "name": "confirmation_token", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/confirmation_token" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a ConfirmationToken" } }, "/v1/country_specs": { "get": { "description": "

Lists all Country Spec objects available in the API.

", "operationId": "GetCountrySpecs", "parameters": [ { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/country_spec" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/country_specs", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "CountrySpecList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List Country Specs" } }, "/v1/country_specs/{country}": { "get": { "description": "

Returns a Country Spec for a given Country code.

", "operationId": "GetCountrySpecsCountry", "parameters": [ { "in": "path", "name": "country", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/country_spec" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a Country Spec" } }, "/v1/coupons": { "get": { "description": "

Returns a list of your coupons.

", "operationId": "GetCoupons", "parameters": [ { "description": "A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.", "explode": true, "in": "query", "name": "created", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "description": "Minimum value to filter by (exclusive)", "type": "integer" }, "gte": { "description": "Minimum value to filter by (inclusive)", "type": "integer" }, "lt": { "description": "Maximum value to filter by (exclusive)", "type": "integer" }, "lte": { "description": "Maximum value to filter by (inclusive)", "type": "integer" } }, "title": "range_query_specs", "type": "object", "x-stripeMostCommon": [ "gt", "gte", "lt", "lte" ] }, { "type": "integer" } ] }, "style": "deepObject" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/coupon" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/coupons", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "CouponsResourceCouponList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all coupons" }, "post": { "description": "

You can create coupons easily via the coupon management page of the Stripe dashboard. Coupon creation is also accessible via the API if you need to create coupons on the fly.

\n\n

A coupon has either a percent_off or an amount_off and currency. If you set an amount_off, that amount will be subtracted from any invoice’s subtotal. For example, an invoice with a subtotal of 100 will have a final total of 0 if a coupon with an amount_off of 200 is applied to it and an invoice with a subtotal of 300 will have a final total of 100 if a coupon with an amount_off of 200 is applied to it.

", "operationId": "PostCoupons", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "applies_to": { "explode": true, "style": "deepObject" }, "currency_options": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "script": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "amount_off": { "description": "A positive integer representing the amount to subtract from an invoice total (required if `percent_off` is not passed).", "type": "integer" }, "applies_to": { "description": "A hash containing directions for what this Coupon will apply discounts to.", "properties": { "products": { "description": "An array of Product IDs that this Coupon will apply to.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "title": "applies_to_params", "type": "object", "x-stripeMostCommon": [ "product_classes", "products" ] }, "currency": { "description": "Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the `amount_off` parameter (required if `amount_off` is passed).", "format": "currency", "type": "string" }, "currency_options": { "additionalProperties": { "properties": { "amount_off": { "description": "A positive integer representing the amount to subtract from an invoice total.", "type": "integer" } }, "required": [ "amount_off" ], "title": "currency_option", "type": "object", "x-stripeMostCommon": [ "amount_off" ] }, "description": "Coupons defined in each available currency option (only supported if `amount_off` is passed). Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).", "type": "object" }, "duration": { "description": "Specifies how long the discount will be in effect if used on a subscription. Defaults to `once`.", "enum": [ "forever", "once", "repeating" ], "type": "string", "x-stripeBypassValidation": true }, "duration_in_months": { "description": "Required only if `duration` is `repeating`, in which case it must be a positive integer that specifies the number of months the discount will be in effect.", "type": "integer" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "id": { "description": "Unique string of your choice that will be used to identify this coupon when applying it to a customer. If you don't want to specify a particular code, you can leave the ID blank and we'll generate a random code for you.", "maxLength": 5000, "type": "string" }, "max_redemptions": { "description": "A positive integer specifying the number of times the coupon can be redeemed before it's no longer valid. For example, you might have a 50% off coupon that the first 20 readers of your blog can use.", "type": "integer" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "name": { "description": "Name of the coupon displayed to customers on, for instance invoices, or receipts. By default the `id` is shown if `name` is not set.", "maxLength": 40, "type": "string" }, "percent_off": { "description": "A positive float larger than 0, and smaller or equal to 100, that represents the discount the coupon will apply (required if `amount_off` is not passed).", "type": "number" }, "redeem_by": { "description": "Unix timestamp specifying the last time at which the coupon can be redeemed. After the redeem_by date, the coupon can no longer be applied to new customers.", "format": "unix-time", "type": "integer" }, "script": { "description": "Configuration of the [script](https://docs.stripe.com/billing/subscriptions/script-coupons) used to calculate the discount.", "properties": { "configuration": { "description": "The configuration values of the script. The keys and values are specific to the script implementation.", "type": "object" }, "id": { "description": "The script implementation ID for this coupon.", "maxLength": 5000, "type": "string" } }, "required": [ "configuration", "id" ], "title": "script_param", "type": "object", "x-stripeMostCommon": [ "configuration", "id" ] } }, "type": "object", "x-stripeMostCommon": [ "amount_off", "currency", "duration", "metadata", "name", "percent_off" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/coupon" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a coupon" } }, "/v1/coupons/{coupon}": { "delete": { "description": "

You can delete coupons via the coupon management page of the Stripe dashboard. However, deleting a coupon does not affect any customers who have already applied the coupon; it means that new customers can’t redeem the coupon. You can also delete coupons via the API.

", "operationId": "DeleteCouponsCoupon", "parameters": [ { "in": "path", "name": "coupon", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted_coupon" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Delete a coupon" }, "get": { "description": "

Retrieves the coupon with the given ID.

", "operationId": "GetCouponsCoupon", "parameters": [ { "in": "path", "name": "coupon", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/coupon" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a coupon" }, "post": { "description": "

Updates the metadata of a coupon. Other coupon details (currency, duration, amount_off) are, by design, not editable.

", "operationId": "PostCouponsCoupon", "parameters": [ { "in": "path", "name": "coupon", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "currency_options": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "currency_options": { "additionalProperties": { "properties": { "amount_off": { "description": "A positive integer representing the amount to subtract from an invoice total.", "type": "integer" } }, "required": [ "amount_off" ], "title": "currency_option", "type": "object", "x-stripeMostCommon": [ "amount_off" ] }, "description": "Coupons defined in each available currency option (only supported if the coupon is amount-based). Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).", "type": "object" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "name": { "description": "Name of the coupon displayed to customers on, for instance invoices, or receipts. By default the `id` is shown if `name` is not set.", "maxLength": 40, "type": "string" } }, "type": "object", "x-stripeMostCommon": [ "metadata", "name" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/coupon" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a coupon" } }, "/v1/credit_notes": { "get": { "description": "

Returns a list of credit notes.

", "operationId": "GetCreditNotes", "parameters": [ { "description": "Only return credit notes that were created during the given date interval.", "explode": true, "in": "query", "name": "created", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "description": "Minimum value to filter by (exclusive)", "type": "integer" }, "gte": { "description": "Minimum value to filter by (inclusive)", "type": "integer" }, "lt": { "description": "Maximum value to filter by (exclusive)", "type": "integer" }, "lte": { "description": "Maximum value to filter by (inclusive)", "type": "integer" } }, "title": "range_query_specs", "type": "object", "x-stripeMostCommon": [ "gt", "gte", "lt", "lte" ] }, { "type": "integer" } ] }, "style": "deepObject" }, { "description": "Only return credit notes for the customer specified by this customer ID.", "in": "query", "name": "customer", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Only return credit notes for the account specified by this account ID.", "in": "query", "name": "customer_account", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "Only return credit notes for the invoice specified by this invoice ID.", "in": "query", "name": "invoice", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/credit_note" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "CreditNotesList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all credit notes" }, "post": { "description": "

Issue a credit note to adjust the amount of a finalized invoice. A credit note will first reduce the invoice’s amount_remaining (and amount_due), but not below zero.\nThis amount is indicated by the credit note’s pre_payment_amount. The excess amount is indicated by post_payment_amount, and it can result in any combination of the following:

\n\n
    \n
  • Refunds: create a new refund (using refund_amount) or link existing refunds (using refunds).
    • \n
  • Customer balance credit: credit the customer’s balance (using credit_amount) which will be automatically applied to their next invoice when it’s finalized.
    • \n
  • Outside of Stripe credit: record the amount that is or will be credited outside of Stripe (using out_of_band_amount).
    • \n
\n\n

The sum of refunds, customer balance credits, and outside of Stripe credits must equal the post_payment_amount.

\n\n

You may issue multiple credit notes for an invoice. Each credit note may increment the invoice’s pre_payment_credit_notes_amount,\npost_payment_credit_notes_amount, or both, depending on the invoice’s amount_remaining at the time of credit note creation.

", "operationId": "PostCreditNotes", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "lines": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "refunds": { "explode": true, "style": "deepObject" }, "shipping_cost": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "amount": { "description": "The integer amount in cents (or local equivalent) representing the total amount of the credit note. One of `amount`, `lines`, or `shipping_cost` must be provided.", "type": "integer" }, "credit_amount": { "description": "The integer amount in cents (or local equivalent) representing the amount to credit the customer's balance, which will be automatically applied to their next invoice.", "type": "integer" }, "effective_at": { "description": "The date when this credit note is in effect. Same as `created` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the credit note PDF.", "format": "unix-time", "type": "integer" }, "email_type": { "description": "Type of email to send to the customer, one of `credit_note` or `none` and the default is `credit_note`.", "enum": [ "credit_note", "none" ], "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "invoice": { "description": "ID of the invoice.", "maxLength": 5000, "type": "string" }, "lines": { "description": "Line items that make up the credit note. One of `amount`, `lines`, or `shipping_cost` must be provided.", "items": { "properties": { "amount": { "description": "The line item amount to credit. Only valid when `type` is `invoice_line_item`. If invoice is set up with `automatic_tax[enabled]=true`, this amount is tax exclusive", "type": "integer" }, "description": { "description": "The description of the credit note line item. Only valid when the `type` is `custom_line_item`.", "maxLength": 5000, "type": "string" }, "invoice_line_item": { "description": "The invoice line item to credit. Only valid when the `type` is `invoice_line_item`.", "maxLength": 5000, "type": "string" }, "quantity": { "description": "The line item quantity to credit.", "type": "integer" }, "tax_amounts": { "anyOf": [ { "items": { "properties": { "amount": { "description": "The amount, in cents (or local equivalent), of the tax.", "type": "integer" }, "tax_rate": { "description": "The id of the tax rate for this tax amount. The tax rate must have been automatically created by Stripe.", "maxLength": 5000, "type": "string" }, "taxable_amount": { "description": "The amount on which tax is calculated, in cents (or local equivalent).", "type": "integer" } }, "required": [ "amount", "tax_rate", "taxable_amount" ], "title": "tax_amount_with_tax_rate_param", "type": "object", "x-stripeMostCommon": [ "amount", "tax_rate", "taxable_amount" ] }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "A list of up to 10 tax amounts for the credit note line item. Cannot be mixed with `tax_rates`." }, "tax_rates": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The tax rates which apply to the credit note line item. Only valid when the `type` is `custom_line_item` and cannot be mixed with `tax_amounts`." }, "type": { "description": "Type of the credit note line item, one of `invoice_line_item` or `custom_line_item`", "enum": [ "custom_line_item", "invoice_line_item" ], "type": "string" }, "unit_amount": { "description": "The integer unit amount in cents (or local equivalent) of the credit note line item. This `unit_amount` will be multiplied by the quantity to get the full amount to credit for this line item. Only valid when `type` is `custom_line_item`.", "type": "integer" }, "unit_amount_decimal": { "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", "format": "decimal", "type": "string" } }, "required": [ "type" ], "title": "credit_note_line_item_params", "type": "object", "x-stripeMostCommon": [ "amount", "description", "invoice_line_item", "quantity", "tax_amounts", "tax_rates", "type", "unit_amount", "unit_amount_decimal" ] }, "type": "array" }, "memo": { "description": "The credit note's memo appears on the credit note PDF.", "maxLength": 5000, "type": "string" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "out_of_band_amount": { "description": "The integer amount in cents (or local equivalent) representing the amount that is credited outside of Stripe.", "type": "integer" }, "reason": { "description": "Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory`", "enum": [ "duplicate", "fraudulent", "order_change", "product_unsatisfactory" ], "type": "string" }, "refund_amount": { "description": "The integer amount in cents (or local equivalent) representing the amount to refund. If set, a refund will be created for the charge associated with the invoice.", "type": "integer" }, "refunds": { "description": "Refunds to link to this credit note.", "items": { "properties": { "amount_refunded": { "description": "Amount of the refund that applies to this credit note, in cents (or local equivalent). Defaults to the entire refund amount.", "type": "integer" }, "refund": { "description": "ID of an existing refund to link this credit note to. Required when `type` is `refund`.", "type": "string" } }, "title": "credit_note_refund_params", "type": "object", "x-stripeMostCommon": [ "amount_refunded", "payment_record_refund", "refund", "type" ] }, "type": "array" }, "shipping_cost": { "description": "When shipping_cost contains the shipping_rate from the invoice, the shipping_cost is included in the credit note. One of `amount`, `lines`, or `shipping_cost` must be provided.", "properties": { "shipping_rate": { "description": "The ID of the shipping rate to use for this order.", "maxLength": 5000, "type": "string" } }, "title": "credit_note_shipping_cost", "type": "object", "x-stripeMostCommon": [ "shipping_rate" ] } }, "required": [ "invoice" ], "type": "object", "x-stripeMostCommon": [ "invoice", "lines", "memo", "metadata", "reason" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/credit_note" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a credit note" } }, "/v1/credit_notes/preview": { "get": { "description": "

Get a preview of a credit note without creating it.

", "operationId": "GetCreditNotesPreview", "parameters": [ { "description": "The integer amount in cents (or local equivalent) representing the total amount of the credit note. One of `amount`, `lines`, or `shipping_cost` must be provided.", "in": "query", "name": "amount", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "The integer amount in cents (or local equivalent) representing the amount to credit the customer's balance, which will be automatically applied to their next invoice.", "in": "query", "name": "credit_amount", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "The date when this credit note is in effect. Same as `created` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the credit note PDF.", "in": "query", "name": "effective_at", "required": false, "schema": { "format": "unix-time", "type": "integer" }, "style": "form" }, { "description": "Type of email to send to the customer, one of `credit_note` or `none` and the default is `credit_note`.", "in": "query", "name": "email_type", "required": false, "schema": { "enum": [ "credit_note", "none" ], "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "ID of the invoice.", "in": "query", "name": "invoice", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Line items that make up the credit note. One of `amount`, `lines`, or `shipping_cost` must be provided.", "explode": true, "in": "query", "name": "lines", "required": false, "schema": { "items": { "properties": { "amount": { "description": "The line item amount to credit. Only valid when `type` is `invoice_line_item`. If invoice is set up with `automatic_tax[enabled]=true`, this amount is tax exclusive", "type": "integer" }, "description": { "description": "The description of the credit note line item. Only valid when the `type` is `custom_line_item`.", "maxLength": 5000, "type": "string" }, "invoice_line_item": { "description": "The invoice line item to credit. Only valid when the `type` is `invoice_line_item`.", "maxLength": 5000, "type": "string" }, "quantity": { "description": "The line item quantity to credit.", "type": "integer" }, "tax_amounts": { "anyOf": [ { "items": { "properties": { "amount": { "description": "The amount, in cents (or local equivalent), of the tax.", "type": "integer" }, "tax_rate": { "description": "The id of the tax rate for this tax amount. The tax rate must have been automatically created by Stripe.", "maxLength": 5000, "type": "string" }, "taxable_amount": { "description": "The amount on which tax is calculated, in cents (or local equivalent).", "type": "integer" } }, "required": [ "amount", "tax_rate", "taxable_amount" ], "title": "tax_amount_with_tax_rate_param", "type": "object", "x-stripeMostCommon": [ "amount", "tax_rate", "taxable_amount" ] }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "A list of up to 10 tax amounts for the credit note line item. Cannot be mixed with `tax_rates`." }, "tax_rates": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The tax rates which apply to the credit note line item. Only valid when the `type` is `custom_line_item` and cannot be mixed with `tax_amounts`." }, "type": { "description": "Type of the credit note line item, one of `invoice_line_item` or `custom_line_item`", "enum": [ "custom_line_item", "invoice_line_item" ], "type": "string" }, "unit_amount": { "description": "The integer unit amount in cents (or local equivalent) of the credit note line item. This `unit_amount` will be multiplied by the quantity to get the full amount to credit for this line item. Only valid when `type` is `custom_line_item`.", "type": "integer" }, "unit_amount_decimal": { "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", "format": "decimal", "type": "string" } }, "required": [ "type" ], "title": "credit_note_line_item_params", "type": "object", "x-stripeMostCommon": [ "amount", "description", "invoice_line_item", "quantity", "tax_amounts", "tax_rates", "type", "unit_amount", "unit_amount_decimal" ] }, "type": "array" }, "style": "deepObject" }, { "description": "The credit note's memo appears on the credit note PDF.", "in": "query", "name": "memo", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "explode": true, "in": "query", "name": "metadata", "required": false, "schema": { "additionalProperties": { "type": "string" }, "type": "object" }, "style": "deepObject" }, { "description": "The integer amount in cents (or local equivalent) representing the amount that is credited outside of Stripe.", "in": "query", "name": "out_of_band_amount", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory`", "in": "query", "name": "reason", "required": false, "schema": { "enum": [ "duplicate", "fraudulent", "order_change", "product_unsatisfactory" ], "type": "string" }, "style": "form" }, { "description": "The integer amount in cents (or local equivalent) representing the amount to refund. If set, a refund will be created for the charge associated with the invoice.", "in": "query", "name": "refund_amount", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "Refunds to link to this credit note.", "explode": true, "in": "query", "name": "refunds", "required": false, "schema": { "items": { "properties": { "amount_refunded": { "description": "Amount of the refund that applies to this credit note, in cents (or local equivalent). Defaults to the entire refund amount.", "type": "integer" }, "refund": { "description": "ID of an existing refund to link this credit note to. Required when `type` is `refund`.", "type": "string" } }, "title": "credit_note_refund_params", "type": "object", "x-stripeMostCommon": [ "amount_refunded", "payment_record_refund", "refund", "type" ] }, "type": "array" }, "style": "deepObject" }, { "description": "When shipping_cost contains the shipping_rate from the invoice, the shipping_cost is included in the credit note. One of `amount`, `lines`, or `shipping_cost` must be provided.", "explode": true, "in": "query", "name": "shipping_cost", "required": false, "schema": { "properties": { "shipping_rate": { "description": "The ID of the shipping rate to use for this order.", "maxLength": 5000, "type": "string" } }, "title": "credit_note_shipping_cost", "type": "object", "x-stripeMostCommon": [ "shipping_rate" ] }, "style": "deepObject" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/credit_note" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Preview a credit note" } }, "/v1/credit_notes/preview/lines": { "get": { "description": "

When retrieving a credit note preview, you’ll get a lines property containing the first handful of those items. This URL you can retrieve the full (paginated) list of line items.

", "operationId": "GetCreditNotesPreviewLines", "parameters": [ { "description": "The integer amount in cents (or local equivalent) representing the total amount of the credit note. One of `amount`, `lines`, or `shipping_cost` must be provided.", "in": "query", "name": "amount", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "The integer amount in cents (or local equivalent) representing the amount to credit the customer's balance, which will be automatically applied to their next invoice.", "in": "query", "name": "credit_amount", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "The date when this credit note is in effect. Same as `created` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the credit note PDF.", "in": "query", "name": "effective_at", "required": false, "schema": { "format": "unix-time", "type": "integer" }, "style": "form" }, { "description": "Type of email to send to the customer, one of `credit_note` or `none` and the default is `credit_note`.", "in": "query", "name": "email_type", "required": false, "schema": { "enum": [ "credit_note", "none" ], "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "ID of the invoice.", "in": "query", "name": "invoice", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "Line items that make up the credit note. One of `amount`, `lines`, or `shipping_cost` must be provided.", "explode": true, "in": "query", "name": "lines", "required": false, "schema": { "items": { "properties": { "amount": { "description": "The line item amount to credit. Only valid when `type` is `invoice_line_item`. If invoice is set up with `automatic_tax[enabled]=true`, this amount is tax exclusive", "type": "integer" }, "description": { "description": "The description of the credit note line item. Only valid when the `type` is `custom_line_item`.", "maxLength": 5000, "type": "string" }, "invoice_line_item": { "description": "The invoice line item to credit. Only valid when the `type` is `invoice_line_item`.", "maxLength": 5000, "type": "string" }, "quantity": { "description": "The line item quantity to credit.", "type": "integer" }, "tax_amounts": { "anyOf": [ { "items": { "properties": { "amount": { "description": "The amount, in cents (or local equivalent), of the tax.", "type": "integer" }, "tax_rate": { "description": "The id of the tax rate for this tax amount. The tax rate must have been automatically created by Stripe.", "maxLength": 5000, "type": "string" }, "taxable_amount": { "description": "The amount on which tax is calculated, in cents (or local equivalent).", "type": "integer" } }, "required": [ "amount", "tax_rate", "taxable_amount" ], "title": "tax_amount_with_tax_rate_param", "type": "object", "x-stripeMostCommon": [ "amount", "tax_rate", "taxable_amount" ] }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "A list of up to 10 tax amounts for the credit note line item. Cannot be mixed with `tax_rates`." }, "tax_rates": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The tax rates which apply to the credit note line item. Only valid when the `type` is `custom_line_item` and cannot be mixed with `tax_amounts`." }, "type": { "description": "Type of the credit note line item, one of `invoice_line_item` or `custom_line_item`", "enum": [ "custom_line_item", "invoice_line_item" ], "type": "string" }, "unit_amount": { "description": "The integer unit amount in cents (or local equivalent) of the credit note line item. This `unit_amount` will be multiplied by the quantity to get the full amount to credit for this line item. Only valid when `type` is `custom_line_item`.", "type": "integer" }, "unit_amount_decimal": { "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", "format": "decimal", "type": "string" } }, "required": [ "type" ], "title": "credit_note_line_item_params", "type": "object", "x-stripeMostCommon": [ "amount", "description", "invoice_line_item", "quantity", "tax_amounts", "tax_rates", "type", "unit_amount", "unit_amount_decimal" ] }, "type": "array" }, "style": "deepObject" }, { "description": "The credit note's memo appears on the credit note PDF.", "in": "query", "name": "memo", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "explode": true, "in": "query", "name": "metadata", "required": false, "schema": { "additionalProperties": { "type": "string" }, "type": "object" }, "style": "deepObject" }, { "description": "The integer amount in cents (or local equivalent) representing the amount that is credited outside of Stripe.", "in": "query", "name": "out_of_band_amount", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory`", "in": "query", "name": "reason", "required": false, "schema": { "enum": [ "duplicate", "fraudulent", "order_change", "product_unsatisfactory" ], "type": "string" }, "style": "form" }, { "description": "The integer amount in cents (or local equivalent) representing the amount to refund. If set, a refund will be created for the charge associated with the invoice.", "in": "query", "name": "refund_amount", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "Refunds to link to this credit note.", "explode": true, "in": "query", "name": "refunds", "required": false, "schema": { "items": { "properties": { "amount_refunded": { "description": "Amount of the refund that applies to this credit note, in cents (or local equivalent). Defaults to the entire refund amount.", "type": "integer" }, "refund": { "description": "ID of an existing refund to link this credit note to. Required when `type` is `refund`.", "type": "string" } }, "title": "credit_note_refund_params", "type": "object", "x-stripeMostCommon": [ "amount_refunded", "payment_record_refund", "refund", "type" ] }, "type": "array" }, "style": "deepObject" }, { "description": "When shipping_cost contains the shipping_rate from the invoice, the shipping_cost is included in the credit note. One of `amount`, `lines`, or `shipping_cost` must be provided.", "explode": true, "in": "query", "name": "shipping_cost", "required": false, "schema": { "properties": { "shipping_rate": { "description": "The ID of the shipping rate to use for this order.", "maxLength": 5000, "type": "string" } }, "title": "credit_note_shipping_cost", "type": "object", "x-stripeMostCommon": [ "shipping_rate" ] }, "style": "deepObject" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/credit_note_line_item" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "CreditNoteLinesList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a credit note preview's line items" } }, "/v1/credit_notes/{credit_note}/lines": { "get": { "description": "

When retrieving a credit note, you’ll get a lines property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.

", "operationId": "GetCreditNotesCreditNoteLines", "parameters": [ { "in": "path", "name": "credit_note", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/credit_note_line_item" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "CreditNoteLinesList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a credit note's line items" } }, "/v1/credit_notes/{id}": { "get": { "description": "

Retrieves the credit note object with the given identifier.

", "operationId": "GetCreditNotesId", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/credit_note" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a credit note" }, "post": { "description": "

Updates an existing credit note.

", "operationId": "PostCreditNotesId", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "memo": { "description": "Credit note memo.", "maxLength": 5000, "type": "string" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" } }, "type": "object", "x-stripeMostCommon": [ "memo", "metadata" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/credit_note" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a credit note" } }, "/v1/credit_notes/{id}/void": { "post": { "description": "

Marks a credit note as void. Learn more about voiding credit notes.

", "operationId": "PostCreditNotesIdVoid", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/credit_note" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Void a credit note" } }, "/v1/customer_sessions": { "post": { "description": "

Creates a Customer Session object that includes a single-use client secret that you can use on your front-end to grant client-side API access for certain customer resources.

", "operationId": "PostCustomerSessions", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "components": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "components": { "description": "Configuration for each component. Exactly 1 component must be enabled.", "properties": { "buy_button": { "description": "Configuration for buy button.", "properties": { "enabled": { "description": "Whether the buy button is enabled.", "type": "boolean" } }, "required": [ "enabled" ], "title": "buy_button_param", "type": "object", "x-stripeMostCommon": [ "enabled" ] }, "payment_element": { "description": "Configuration for the Payment Element.", "properties": { "enabled": { "description": "Whether the Payment Element is enabled.", "type": "boolean" }, "features": { "description": "This hash defines whether the Payment Element supports certain features.", "properties": { "payment_method_allow_redisplay_filters": { "description": "A list of [`allow_redisplay`](https://docs.stripe.com/api/payment_methods/object#payment_method_object-allow_redisplay) values that controls which saved payment methods the Payment Element displays by filtering to only show payment methods with an `allow_redisplay` value that is present in this list.\n\nIf not specified, defaults to [\"always\"]. In order to display all saved payment methods, specify [\"always\", \"limited\", \"unspecified\"].", "items": { "enum": [ "always", "limited", "unspecified" ], "type": "string" }, "type": "array" }, "payment_method_redisplay": { "description": "Controls whether or not the Payment Element shows saved payment methods. This parameter defaults to `disabled`.", "enum": [ "disabled", "enabled" ], "type": "string", "x-stripeBypassValidation": true }, "payment_method_redisplay_limit": { "description": "Determines the max number of saved payment methods for the Payment Element to display. This parameter defaults to `3`. The maximum redisplay limit is `10`.", "type": "integer" }, "payment_method_remove": { "description": "Controls whether the Payment Element displays the option to remove a saved payment method. This parameter defaults to `disabled`.\n\nAllowing buyers to remove their saved payment methods impacts subscriptions that depend on that payment method. Removing the payment method detaches the [`customer` object](https://docs.stripe.com/api/payment_methods/object#payment_method_object-customer) from that [PaymentMethod](https://docs.stripe.com/api/payment_methods).", "enum": [ "disabled", "enabled" ], "type": "string", "x-stripeBypassValidation": true }, "payment_method_save": { "description": "Controls whether the Payment Element displays a checkbox offering to save a new payment method. This parameter defaults to `disabled`.\n\nIf a customer checks the box, the [`allow_redisplay`](https://docs.stripe.com/api/payment_methods/object#payment_method_object-allow_redisplay) value on the PaymentMethod is set to `'always'` at confirmation time. For PaymentIntents, the [`setup_future_usage`](https://docs.stripe.com/api/payment_intents/object#payment_intent_object-setup_future_usage) value is also set to the value defined in `payment_method_save_usage`.", "enum": [ "disabled", "enabled" ], "type": "string", "x-stripeBypassValidation": true }, "payment_method_save_usage": { "description": "When using PaymentIntents and the customer checks the save checkbox, this field determines the [`setup_future_usage`](https://docs.stripe.com/api/payment_intents/object#payment_intent_object-setup_future_usage) value used to confirm the PaymentIntent.\n\nWhen using SetupIntents, directly configure the [`usage`](https://docs.stripe.com/api/setup_intents/object#setup_intent_object-usage) value on SetupIntent creation.", "enum": [ "off_session", "on_session" ], "type": "string" } }, "title": "features_param", "type": "object", "x-stripeMostCommon": [ "payment_method_allow_redisplay_filters", "payment_method_redisplay", "payment_method_redisplay_limit", "payment_method_remove", "payment_method_remove_last", "payment_method_save", "payment_method_save_usage", "payment_method_set_as_default", "payment_method_update" ] } }, "required": [ "enabled" ], "title": "payment_element_param", "type": "object", "x-stripeMostCommon": [ "enabled", "features" ] }, "pricing_table": { "description": "Configuration for the pricing table.", "properties": { "enabled": { "description": "Whether the pricing table is enabled.", "type": "boolean" } }, "required": [ "enabled" ], "title": "pricing_table_param", "type": "object", "x-stripeMostCommon": [ "enabled" ] } }, "title": "components", "type": "object", "x-stripeMostCommon": [ "active_entitlements", "buy_button", "customer_portal", "customer_sheet", "mobile_payment_element", "payment_element", "payment_sheet", "pricing_table" ] }, "customer": { "description": "The ID of an existing customer for which to create the Customer Session.", "maxLength": 5000, "type": "string" }, "customer_account": { "description": "The ID of an existing Account for which to create the Customer Session.", "maxLength": 5000, "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "required": [ "components" ], "type": "object", "x-stripeMostCommon": [ "components", "customer" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer_session" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a Customer Session" } }, "/v1/customers": { "get": { "description": "

Returns a list of your customers. The customers are returned sorted by creation date, with the most recent customers appearing first.

", "operationId": "GetCustomers", "parameters": [ { "description": "Only return customers that were created during the given date interval.", "explode": true, "in": "query", "name": "created", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "description": "Minimum value to filter by (exclusive)", "type": "integer" }, "gte": { "description": "Minimum value to filter by (inclusive)", "type": "integer" }, "lt": { "description": "Maximum value to filter by (exclusive)", "type": "integer" }, "lte": { "description": "Maximum value to filter by (inclusive)", "type": "integer" } }, "title": "range_query_specs", "type": "object", "x-stripeMostCommon": [ "gt", "gte", "lt", "lte" ] }, { "type": "integer" } ] }, "style": "deepObject" }, { "description": "A case-sensitive filter on the list based on the customer's `email` field. The value must be a string.", "in": "query", "name": "email", "required": false, "schema": { "maxLength": 512, "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Provides a list of customers that are associated with the specified test clock. The response will not include customers with test clocks if this parameter is not set.", "in": "query", "name": "test_clock", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/customer" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/customers", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "CustomerResourceCustomerList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all customers" }, "post": { "description": "

Creates a new customer object.

", "operationId": "PostCustomers", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "address": { "explode": true, "style": "deepObject" }, "cash_balance": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "invoice_settings": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "preferred_locales": { "explode": true, "style": "deepObject" }, "shipping": { "explode": true, "style": "deepObject" }, "tax": { "explode": true, "style": "deepObject" }, "tax_id_data": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "address": { "anyOf": [ { "properties": { "city": { "description": "City, district, suburb, town, or village.", "maxLength": 5000, "type": "string" }, "country": { "description": "A freeform text field for the country. However, in order to activate some tax features, the format should be a two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Address line 1 (e.g., street, PO Box, or company name).", "maxLength": 5000, "type": "string" }, "line2": { "description": "Address line 2 (e.g., apartment, suite, unit, or building).", "maxLength": 5000, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "State, county, province, or region.", "maxLength": 5000, "type": "string" } }, "title": "optional_fields_customer_address", "type": "object", "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state" ] }, { "enum": [ "" ], "type": "string" } ], "description": "The customer's address." }, "balance": { "description": "An integer amount in cents (or local equivalent) that represents the customer's current balance, which affect the customer's future invoices. A negative amount represents a credit that decreases the amount due on an invoice; a positive amount increases the amount due on an invoice.", "type": "integer" }, "cash_balance": { "description": "Balance information and default balance settings for this customer.", "properties": { "settings": { "description": "Settings controlling the behavior of the customer's cash balance,\nsuch as reconciliation of funds received.", "properties": { "reconciliation_mode": { "description": "Controls how funds transferred by the customer are applied to payment intents and invoices. Valid options are `automatic`, `manual`, or `merchant_default`. For more information about these reconciliation modes, see [Reconciliation](https://stripe.com/docs/payments/customer-balance/reconciliation).", "enum": [ "automatic", "manual", "merchant_default" ], "type": "string" } }, "title": "balance_settings_param", "type": "object", "x-stripeMostCommon": [ "reconciliation_mode" ] } }, "title": "cash_balance_param", "type": "object", "x-stripeMostCommon": [ "settings" ] }, "description": { "description": "An arbitrary string that you can attach to a customer object. It is displayed alongside the customer in the dashboard.", "maxLength": 5000, "type": "string" }, "email": { "description": "Customer's email address. It's displayed alongside the customer in your dashboard and can be useful for searching and tracking. This may be up to *512 characters*.", "maxLength": 512, "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "invoice_prefix": { "description": "The prefix for the customer used to generate unique invoice numbers. Must be 3–12 uppercase letters or numbers.", "maxLength": 5000, "type": "string" }, "invoice_settings": { "description": "Default invoice settings for this customer.", "properties": { "custom_fields": { "anyOf": [ { "items": { "properties": { "name": { "description": "The name of the custom field. This may be up to 40 characters.", "maxLength": 40, "type": "string" }, "value": { "description": "The value of the custom field. This may be up to 140 characters.", "maxLength": 140, "type": "string" } }, "required": [ "name", "value" ], "title": "custom_field_params", "type": "object", "x-stripeMostCommon": [ "name", "value" ] }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The list of up to 4 default custom fields to be displayed on invoices for this customer. When updating, pass an empty string to remove previously-defined fields." }, "default_payment_method": { "description": "ID of a payment method that's attached to the customer, to be used as the customer's default payment method for subscriptions and invoices.", "maxLength": 5000, "type": "string" }, "footer": { "description": "Default footer to be displayed on invoices for this customer.", "maxLength": 5000, "type": "string" }, "rendering_options": { "anyOf": [ { "properties": { "amount_tax_display": { "description": "How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. One of `exclude_tax` or `include_inclusive_tax`. `include_inclusive_tax` will include inclusive tax (and exclude exclusive tax) in invoice PDF amounts. `exclude_tax` will exclude all tax (inclusive and exclusive alike) from invoice PDF amounts.", "enum": [ "", "exclude_tax", "include_inclusive_tax" ], "type": "string" }, "template": { "description": "ID of the invoice rendering template to use for future invoices.", "maxLength": 5000, "type": "string" } }, "title": "customer_rendering_options_param", "type": "object", "x-stripeMostCommon": [ "amount_tax_display", "invoice_title", "template" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Default options for invoice PDF rendering for this customer." } }, "title": "customer_param", "type": "object", "x-stripeMostCommon": [ "amount_to_forgive", "amount_to_forgive_currency", "custom_fields", "days_until_due", "default_payment_method", "footer", "rendering_options", "send_hosted_payment_email", "supported_payment_methods" ] }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "name": { "description": "The customer's full name or business name.", "maxLength": 256, "type": "string" }, "next_invoice_sequence": { "description": "The sequence to be used on the customer's next invoice. Defaults to 1.", "type": "integer" }, "payment_method": { "maxLength": 5000, "type": "string" }, "phone": { "description": "The customer's phone number.", "maxLength": 20, "type": "string" }, "preferred_locales": { "description": "Customer's preferred languages, ordered by preference.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "shipping": { "anyOf": [ { "properties": { "address": { "description": "Customer shipping address.", "properties": { "city": { "description": "City, district, suburb, town, or village.", "maxLength": 5000, "type": "string" }, "country": { "description": "A freeform text field for the country. However, in order to activate some tax features, the format should be a two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Address line 1 (e.g., street, PO Box, or company name).", "maxLength": 5000, "type": "string" }, "line2": { "description": "Address line 2 (e.g., apartment, suite, unit, or building).", "maxLength": 5000, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "State, county, province, or region.", "maxLength": 5000, "type": "string" } }, "title": "optional_fields_customer_address", "type": "object", "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state" ] }, "name": { "description": "Customer name.", "maxLength": 5000, "type": "string" }, "phone": { "description": "Customer phone (including extension).", "maxLength": 5000, "type": "string" } }, "required": [ "address", "name" ], "title": "customer_shipping", "type": "object", "x-stripeMostCommon": [ "address", "name", "phone" ] }, { "enum": [ "" ], "type": "string" } ], "description": "The customer's shipping information. Appears on invoices emailed to this customer." }, "source": { "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true }, "tax": { "description": "Tax details about the customer.", "properties": { "ip_address": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "A recent IP address of the customer used for tax reporting and tax location inference. Stripe recommends updating the IP address when a new PaymentMethod is attached or the address field on the customer is updated. We recommend against updating this field more frequently since it could result in unexpected tax location/reporting outcomes." }, "validate_location": { "description": "A flag that indicates when Stripe should validate the customer tax location. Defaults to `deferred`.", "enum": [ "deferred", "immediately" ], "type": "string" } }, "title": "shared_tax_create_param", "type": "object", "x-stripeMostCommon": [ "ip_address", "validate_location" ] }, "tax_exempt": { "description": "The customer's tax exemption. One of `none`, `exempt`, or `reverse`.", "enum": [ "", "exempt", "none", "reverse" ], "type": "string" }, "tax_id_data": { "description": "The customer's tax IDs.", "items": { "properties": { "type": { "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `aw_tin`, `az_tin`, `ba_tin`, `bb_tin`, `bd_bin`, `bf_ifu`, `bg_uic`, `bh_vat`, `bj_ifu`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cm_niu`, `cn_tin`, `co_nit`, `cr_tin`, `cv_nif`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `et_tin`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kg_tin`, `kh_tin`, `kr_brn`, `kz_bin`, `la_tin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin`", "enum": [ "ad_nrt", "ae_trn", "al_tin", "am_tin", "ao_tin", "ar_cuit", "au_abn", "au_arn", "aw_tin", "az_tin", "ba_tin", "bb_tin", "bd_bin", "bf_ifu", "bg_uic", "bh_vat", "bj_ifu", "bo_tin", "br_cnpj", "br_cpf", "bs_tin", "by_tin", "ca_bn", "ca_gst_hst", "ca_pst_bc", "ca_pst_mb", "ca_pst_sk", "ca_qst", "cd_nif", "ch_uid", "ch_vat", "cl_tin", "cm_niu", "cn_tin", "co_nit", "cr_tin", "cv_nif", "de_stn", "do_rcn", "ec_ruc", "eg_tin", "es_cif", "et_tin", "eu_oss_vat", "eu_vat", "gb_vat", "ge_vat", "gn_nif", "hk_br", "hr_oib", "hu_tin", "id_npwp", "il_vat", "in_gst", "is_vat", "jp_cn", "jp_rn", "jp_trn", "ke_pin", "kg_tin", "kh_tin", "kr_brn", "kz_bin", "la_tin", "li_uid", "li_vat", "ma_vat", "md_vat", "me_pib", "mk_vat", "mr_nif", "mx_rfc", "my_frp", "my_itn", "my_sst", "ng_tin", "no_vat", "no_voec", "np_pan", "nz_gst", "om_vat", "pe_ruc", "ph_tin", "ro_tin", "rs_pib", "ru_inn", "ru_kpp", "sa_vat", "sg_gst", "sg_uen", "si_tin", "sn_ninea", "sr_fin", "sv_nit", "th_vat", "tj_tin", "tr_tin", "tw_vat", "tz_vat", "ua_vat", "ug_tin", "us_ein", "uy_ruc", "uz_tin", "uz_vat", "ve_rif", "vn_tin", "za_vat", "zm_tin", "zw_tin" ], "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true }, "value": { "description": "Value of the tax ID.", "type": "string" } }, "required": [ "type", "value" ], "title": "data_params", "type": "object", "x-stripeMostCommon": [ "type", "value" ] }, "type": "array" }, "test_clock": { "description": "ID of the test clock to attach to the customer.", "maxLength": 5000, "type": "string" }, "validate": { "type": "boolean" } }, "type": "object", "x-stripeMostCommon": [ "address", "description", "email", "metadata", "name", "payment_method", "phone", "shipping", "tax" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a customer" } }, "/v1/customers/search": { "get": { "description": "

Search for customers you’ve previously created using Stripe’s Search Query Language.\nDon’t use search in read-after-write flows where strict consistency is necessary. Under normal operating\nconditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up\nto an hour behind during outages. Search functionality is not available to merchants in India.

", "operationId": "GetCustomersSearch", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.", "in": "query", "name": "page", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for customers](https://stripe.com/docs/search#query-fields-for-customers).", "in": "query", "name": "query", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/customer" }, "type": "array" }, "has_more": { "type": "boolean" }, "next_page": { "maxLength": 5000, "nullable": true, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "search_result" ], "type": "string" }, "total_count": { "description": "The total number of objects that match the query, only accurate up to 10,000.", "type": "integer" }, "url": { "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "next_page", "object", "url" ], "title": "SearchResult", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "next_page", "object", "total_count", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Search customers" } }, "/v1/customers/{customer}": { "delete": { "description": "

Permanently deletes a customer. It cannot be undone. Also immediately cancels any active subscriptions on the customer.

", "operationId": "DeleteCustomersCustomer", "parameters": [ { "in": "path", "name": "customer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted_customer" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Delete a customer" }, "get": { "description": "

Retrieves a Customer object.

", "operationId": "GetCustomersCustomer", "parameters": [ { "in": "path", "name": "customer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/customer" }, { "$ref": "#/components/schemas/deleted_customer" } ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a customer" }, "post": { "description": "

Updates the specified customer by setting the values of the parameters passed. Any parameters not provided will be left unchanged. For example, if you pass the source parameter, that becomes the customer’s active source (e.g., a card) to be used for all charges in the future. When you update a customer to a new valid card source by passing the source parameter: for each of the customer’s current subscriptions, if the subscription bills automatically and is in the past_due state, then the latest open invoice for the subscription with automatic collection enabled will be retried. This retry will not count as an automatic retry, and will not affect the next regularly scheduled payment for the invoice. Changing the default_source for a customer will not trigger this behavior.

\n\n

This request accepts mostly the same arguments as the customer creation call.

", "operationId": "PostCustomersCustomer", "parameters": [ { "in": "path", "name": "customer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "address": { "explode": true, "style": "deepObject" }, "cash_balance": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "invoice_settings": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "preferred_locales": { "explode": true, "style": "deepObject" }, "shipping": { "explode": true, "style": "deepObject" }, "tax": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "address": { "anyOf": [ { "properties": { "city": { "description": "City, district, suburb, town, or village.", "maxLength": 5000, "type": "string" }, "country": { "description": "A freeform text field for the country. However, in order to activate some tax features, the format should be a two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Address line 1 (e.g., street, PO Box, or company name).", "maxLength": 5000, "type": "string" }, "line2": { "description": "Address line 2 (e.g., apartment, suite, unit, or building).", "maxLength": 5000, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "State, county, province, or region.", "maxLength": 5000, "type": "string" } }, "title": "optional_fields_customer_address", "type": "object", "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state" ] }, { "enum": [ "" ], "type": "string" } ], "description": "The customer's address." }, "balance": { "description": "An integer amount in cents (or local equivalent) that represents the customer's current balance, which affect the customer's future invoices. A negative amount represents a credit that decreases the amount due on an invoice; a positive amount increases the amount due on an invoice.", "type": "integer" }, "cash_balance": { "description": "Balance information and default balance settings for this customer.", "properties": { "settings": { "description": "Settings controlling the behavior of the customer's cash balance,\nsuch as reconciliation of funds received.", "properties": { "reconciliation_mode": { "description": "Controls how funds transferred by the customer are applied to payment intents and invoices. Valid options are `automatic`, `manual`, or `merchant_default`. For more information about these reconciliation modes, see [Reconciliation](https://stripe.com/docs/payments/customer-balance/reconciliation).", "enum": [ "automatic", "manual", "merchant_default" ], "type": "string" } }, "title": "balance_settings_param", "type": "object", "x-stripeMostCommon": [ "reconciliation_mode" ] } }, "title": "cash_balance_param", "type": "object", "x-stripeMostCommon": [ "settings" ] }, "default_source": { "description": "If you are using payment methods created via the PaymentMethods API, see the [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/update#update_customer-invoice_settings-default_payment_method) parameter.\n\nProvide the ID of a payment source already attached to this customer to make it this customer's default payment source.\n\nIf you want to add a new payment source and make it the default, see the [source](https://stripe.com/docs/api/customers/update#update_customer-source) property.", "maxLength": 500, "type": "string" }, "description": { "description": "An arbitrary string that you can attach to a customer object. It is displayed alongside the customer in the dashboard.", "maxLength": 5000, "type": "string" }, "email": { "description": "Customer's email address. It's displayed alongside the customer in your dashboard and can be useful for searching and tracking. This may be up to *512 characters*.", "maxLength": 512, "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "invoice_prefix": { "description": "The prefix for the customer used to generate unique invoice numbers. Must be 3–12 uppercase letters or numbers.", "maxLength": 5000, "type": "string" }, "invoice_settings": { "description": "Default invoice settings for this customer.", "properties": { "custom_fields": { "anyOf": [ { "items": { "properties": { "name": { "description": "The name of the custom field. This may be up to 40 characters.", "maxLength": 40, "type": "string" }, "value": { "description": "The value of the custom field. This may be up to 140 characters.", "maxLength": 140, "type": "string" } }, "required": [ "name", "value" ], "title": "custom_field_params", "type": "object", "x-stripeMostCommon": [ "name", "value" ] }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The list of up to 4 default custom fields to be displayed on invoices for this customer. When updating, pass an empty string to remove previously-defined fields." }, "default_payment_method": { "description": "ID of a payment method that's attached to the customer, to be used as the customer's default payment method for subscriptions and invoices.", "maxLength": 5000, "type": "string" }, "footer": { "description": "Default footer to be displayed on invoices for this customer.", "maxLength": 5000, "type": "string" }, "rendering_options": { "anyOf": [ { "properties": { "amount_tax_display": { "description": "How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. One of `exclude_tax` or `include_inclusive_tax`. `include_inclusive_tax` will include inclusive tax (and exclude exclusive tax) in invoice PDF amounts. `exclude_tax` will exclude all tax (inclusive and exclusive alike) from invoice PDF amounts.", "enum": [ "", "exclude_tax", "include_inclusive_tax" ], "type": "string" }, "template": { "description": "ID of the invoice rendering template to use for future invoices.", "maxLength": 5000, "type": "string" } }, "title": "customer_rendering_options_param", "type": "object", "x-stripeMostCommon": [ "amount_tax_display", "invoice_title", "template" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Default options for invoice PDF rendering for this customer." } }, "title": "customer_param", "type": "object", "x-stripeMostCommon": [ "amount_to_forgive", "amount_to_forgive_currency", "custom_fields", "days_until_due", "default_payment_method", "footer", "rendering_options", "send_hosted_payment_email", "supported_payment_methods" ] }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "name": { "description": "The customer's full name or business name.", "maxLength": 256, "type": "string" }, "next_invoice_sequence": { "description": "The sequence to be used on the customer's next invoice. Defaults to 1.", "type": "integer" }, "phone": { "description": "The customer's phone number.", "maxLength": 20, "type": "string" }, "preferred_locales": { "description": "Customer's preferred languages, ordered by preference.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "shipping": { "anyOf": [ { "properties": { "address": { "description": "Customer shipping address.", "properties": { "city": { "description": "City, district, suburb, town, or village.", "maxLength": 5000, "type": "string" }, "country": { "description": "A freeform text field for the country. However, in order to activate some tax features, the format should be a two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Address line 1 (e.g., street, PO Box, or company name).", "maxLength": 5000, "type": "string" }, "line2": { "description": "Address line 2 (e.g., apartment, suite, unit, or building).", "maxLength": 5000, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "State, county, province, or region.", "maxLength": 5000, "type": "string" } }, "title": "optional_fields_customer_address", "type": "object", "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state" ] }, "name": { "description": "Customer name.", "maxLength": 5000, "type": "string" }, "phone": { "description": "Customer phone (including extension).", "maxLength": 5000, "type": "string" } }, "required": [ "address", "name" ], "title": "customer_shipping", "type": "object", "x-stripeMostCommon": [ "address", "name", "phone" ] }, { "enum": [ "" ], "type": "string" } ], "description": "The customer's shipping information. Appears on invoices emailed to this customer." }, "source": { "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true }, "tax": { "description": "Tax details about the customer.", "properties": { "ip_address": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "A recent IP address of the customer used for tax reporting and tax location inference. Stripe recommends updating the IP address when a new PaymentMethod is attached or the address field on the customer is updated. We recommend against updating this field more frequently since it could result in unexpected tax location/reporting outcomes." }, "validate_location": { "description": "A flag that indicates when Stripe should validate the customer tax location. Defaults to `auto`.", "enum": [ "auto", "deferred", "immediately" ], "type": "string" } }, "title": "shared_tax_update_param", "type": "object", "x-stripeMostCommon": [ "ip_address", "validate_location" ] }, "tax_exempt": { "description": "The customer's tax exemption. One of `none`, `exempt`, or `reverse`.", "enum": [ "", "exempt", "none", "reverse" ], "type": "string" }, "validate": { "type": "boolean" } }, "type": "object", "x-stripeMostCommon": [ "address", "description", "email", "metadata", "name", "phone", "shipping", "tax" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a customer" } }, "/v1/customers/{customer}/balance_transactions": { "get": { "description": "

Returns a list of transactions that updated the customer’s balances.

", "operationId": "GetCustomersCustomerBalanceTransactions", "parameters": [ { "in": "path", "name": "customer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/customer_balance_transaction" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "CustomerBalanceTransactionList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List customer balance transactions" }, "post": { "description": "

Creates an immutable transaction that updates the customer’s credit balance.

", "operationId": "PostCustomersCustomerBalanceTransactions", "parameters": [ { "in": "path", "name": "customer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "amount": { "description": "The integer amount in **cents (or local equivalent)** to apply to the customer's credit balance.", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). Specifies the [`invoice_credit_balance`](https://stripe.com/docs/api/customers/object#customer_object-invoice_credit_balance) that this transaction will apply to. If the customer's `currency` is not set, it will be updated to this value.", "format": "currency", "type": "string" }, "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users.", "maxLength": 350, "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." } }, "required": [ "amount", "currency" ], "type": "object", "x-stripeMostCommon": [ "amount", "currency", "description", "metadata" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer_balance_transaction" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a customer balance transaction" } }, "/v1/customers/{customer}/balance_transactions/{transaction}": { "get": { "description": "

Retrieves a specific customer balance transaction that updated the customer’s balances.

", "operationId": "GetCustomersCustomerBalanceTransactionsTransaction", "parameters": [ { "in": "path", "name": "customer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "transaction", "required": true, "schema": { "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer_balance_transaction" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a customer balance transaction" }, "post": { "description": "

Most credit balance transaction fields are immutable, but you may update its description and metadata.

", "operationId": "PostCustomersCustomerBalanceTransactionsTransaction", "parameters": [ { "in": "path", "name": "customer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "in": "path", "name": "transaction", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users.", "maxLength": 350, "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." } }, "type": "object", "x-stripeMostCommon": [ "description", "metadata" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer_balance_transaction" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a customer credit balance transaction" } }, "/v1/customers/{customer}/cash_balance": { "get": { "description": "

Retrieves a customer’s cash balance.

", "operationId": "GetCustomersCustomerCashBalance", "parameters": [ { "in": "path", "name": "customer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cash_balance" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a cash balance" }, "post": { "description": "

Changes the settings on a customer’s cash balance.

", "operationId": "PostCustomersCustomerCashBalance", "parameters": [ { "in": "path", "name": "customer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "settings": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "settings": { "description": "A hash of settings for this cash balance.", "properties": { "reconciliation_mode": { "description": "Controls how funds transferred by the customer are applied to payment intents and invoices. Valid options are `automatic`, `manual`, or `merchant_default`. For more information about these reconciliation modes, see [Reconciliation](https://stripe.com/docs/payments/customer-balance/reconciliation).", "enum": [ "automatic", "manual", "merchant_default" ], "type": "string" } }, "title": "balance_settings_param", "type": "object", "x-stripeMostCommon": [ "reconciliation_mode" ] } }, "type": "object", "x-stripeMostCommon": [ "settings" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cash_balance" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a cash balance's settings" } }, "/v1/customers/{customer}/cash_balance_transactions": { "get": { "description": "

Returns a list of transactions that modified the customer’s cash balance.

", "operationId": "GetCustomersCustomerCashBalanceTransactions", "parameters": [ { "in": "path", "name": "customer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Customers with certain payments enabled have a cash balance, representing funds that were paid\nby the customer to a merchant, but have not yet been allocated to a payment. Cash Balance Transactions\nrepresent when funds are moved into or out of this balance. This includes funding by the customer, allocation\nto payments, and refunds to the customer.", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/customer_cash_balance_transaction" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "CustomerCashBalanceTransactionList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List cash balance transactions" } }, "/v1/customers/{customer}/cash_balance_transactions/{transaction}": { "get": { "description": "

Retrieves a specific cash balance transaction, which updated the customer’s cash balance.

", "operationId": "GetCustomersCustomerCashBalanceTransactionsTransaction", "parameters": [ { "in": "path", "name": "customer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "transaction", "required": true, "schema": { "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer_cash_balance_transaction" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a cash balance transaction" } }, "/v1/customers/{customer}/discount": { "delete": { "description": "

Removes the currently applied discount on a customer.

", "operationId": "DeleteCustomersCustomerDiscount", "parameters": [ { "in": "path", "name": "customer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted_discount" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Delete a customer discount" } }, "/v1/customers/{customer}/funding_instructions": { "post": { "description": "

Retrieve funding instructions for a customer cash balance. If funding instructions do not yet exist for the customer, new\nfunding instructions will be created. If funding instructions have already been created for a given customer, the same\nfunding instructions will be retrieved. In other words, we will return the same funding instructions each time.

", "operationId": "PostCustomersCustomerFundingInstructions", "parameters": [ { "in": "path", "name": "customer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "bank_transfer": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "bank_transfer": { "description": "Additional parameters for `bank_transfer` funding types", "properties": { "eu_bank_transfer": { "description": "Configuration for eu_bank_transfer funding type.", "properties": { "country": { "description": "The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`.", "maxLength": 5000, "type": "string" } }, "required": [ "country" ], "title": "eu_bank_account_params", "type": "object", "x-stripeMostCommon": [ "country" ] }, "requested_address_types": { "description": "List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.\n\nPermitted values include: `sort_code`, `zengin`, `iban`, or `spei`.", "items": { "enum": [ "iban", "sort_code", "spei", "zengin" ], "type": "string", "x-stripeBypassValidation": true }, "type": "array" }, "type": { "description": "The type of the `bank_transfer`", "enum": [ "eu_bank_transfer", "gb_bank_transfer", "jp_bank_transfer", "mx_bank_transfer", "us_bank_transfer" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "bank_transfer_params", "type": "object", "x-stripeMostCommon": [ "eu_bank_transfer", "requested_address_types", "type" ] }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "funding_type": { "description": "The `funding_type` to get the instructions for.", "enum": [ "bank_transfer" ], "type": "string" } }, "required": [ "bank_transfer", "currency", "funding_type" ], "type": "object", "x-stripeMostCommon": [ "bank_transfer", "currency", "funding_type" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/funding_instructions" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create or retrieve funding instructions for a customer cash balance" } }, "/v1/customers/{customer}/payment_methods": { "get": { "description": "

Returns a list of PaymentMethods for a given Customer

", "operationId": "GetCustomersCustomerPaymentMethods", "parameters": [ { "description": "This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow.", "in": "query", "name": "allow_redisplay", "required": false, "schema": { "enum": [ "always", "limited", "unspecified" ], "type": "string" }, "style": "form" }, { "in": "path", "name": "customer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "An optional filter on the list, based on the object `type` field. Without the filter, the list includes all current and future payment method types. If your integration expects only one type of payment method in the response, make sure to provide a type value in the request.", "in": "query", "name": "type", "required": false, "schema": { "enum": [ "acss_debit", "affirm", "afterpay_clearpay", "alipay", "alma", "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", "billie", "blik", "boleto", "card", "cashapp", "crypto", "customer_balance", "eps", "fpx", "giropay", "gopay", "grabpay", "id_bank_transfer", "ideal", "kakao_pay", "klarna", "konbini", "kr_card", "link", "mb_way", "mobilepay", "multibanco", "naver_pay", "nz_bank_account", "oxxo", "p24", "pay_by_bank", "payco", "paynow", "paypal", "paypay", "payto", "pix", "promptpay", "qris", "rechnung", "revolut_pay", "samsung_pay", "satispay", "sepa_debit", "shopeepay", "sofort", "stripe_balance", "swish", "twint", "us_bank_account", "wechat_pay", "zip" ], "type": "string", "x-stripeBypassValidation": true }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/payment_method" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "CustomerPaymentMethodResourceList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List a Customer's PaymentMethods" } }, "/v1/customers/{customer}/payment_methods/{payment_method}": { "get": { "description": "

Retrieves a PaymentMethod object for a given Customer.

", "operationId": "GetCustomersCustomerPaymentMethodsPaymentMethod", "parameters": [ { "in": "path", "name": "customer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "payment_method", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_method" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a Customer's PaymentMethod" } }, "/v1/customers/{customer}/sources": { "get": { "description": "

List sources for a specified customer.

", "operationId": "GetCustomersCustomerSources", "parameters": [ { "in": "path", "name": "customer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "Filter sources according to a particular object type.", "in": "query", "name": "object", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/payment_source" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "ApmsSourcesSourceList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } } }, "post": { "description": "

When you create a new credit card, you must specify a customer or recipient on which to create it.

\n\n

If the card’s owner has no default card, then the new card will become the default.\nHowever, if the owner already has a default, then it will not change.\nTo change the default, you should update the customer to have a new default_source.

", "operationId": "PostCustomersCustomerSources", "parameters": [ { "in": "path", "name": "customer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "source": { "description": "Please refer to full [documentation](https://stripe.com/docs/api) instead.", "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true }, "validate": { "type": "boolean" } }, "required": [ "source" ], "type": "object", "x-stripeMostCommon": [ "metadata", "source" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_source" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a card" } }, "/v1/customers/{customer}/sources/{id}": { "delete": { "description": "

Delete a specified source for a given customer.

", "operationId": "DeleteCustomersCustomerSourcesId", "parameters": [ { "in": "path", "name": "customer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/payment_source" }, { "$ref": "#/components/schemas/deleted_payment_source" } ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Delete a customer source" }, "get": { "description": "

Retrieve a specified source for a given customer.

", "operationId": "GetCustomersCustomerSourcesId", "parameters": [ { "in": "path", "name": "customer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 500, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_source" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } } }, "post": { "description": "

Update a specified source for a given customer.

", "operationId": "PostCustomersCustomerSourcesId", "parameters": [ { "in": "path", "name": "customer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "owner": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "account_holder_name": { "description": "The name of the person or business that owns the bank account.", "maxLength": 5000, "type": "string" }, "account_holder_type": { "description": "The type of entity that holds the account. This can be either `individual` or `company`.", "enum": [ "company", "individual" ], "maxLength": 5000, "type": "string" }, "address_city": { "description": "City/District/Suburb/Town/Village.", "maxLength": 5000, "type": "string" }, "address_country": { "description": "Billing address country, if provided when creating card.", "maxLength": 5000, "type": "string" }, "address_line1": { "description": "Address line 1 (Street address/PO Box/Company name).", "maxLength": 5000, "type": "string" }, "address_line2": { "description": "Address line 2 (Apartment/Suite/Unit/Building).", "maxLength": 5000, "type": "string" }, "address_state": { "description": "State/County/Province/Region.", "maxLength": 5000, "type": "string" }, "address_zip": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "exp_month": { "description": "Two digit number representing the card’s expiration month.", "maxLength": 5000, "type": "string" }, "exp_year": { "description": "Four digit number representing the card’s expiration year.", "maxLength": 5000, "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "name": { "description": "Cardholder name.", "maxLength": 5000, "type": "string" }, "owner": { "properties": { "address": { "description": "Owner's address.", "properties": { "city": { "description": "City, district, suburb, town, or village.", "maxLength": 5000, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Address line 1 (e.g., street, PO Box, or company name).", "maxLength": 5000, "type": "string" }, "line2": { "description": "Address line 2 (e.g., apartment, suite, unit, or building).", "maxLength": 5000, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "State, county, province, or region.", "maxLength": 5000, "type": "string" } }, "title": "source_address", "type": "object", "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state" ] }, "email": { "description": "Owner's email address.", "type": "string" }, "name": { "description": "Owner's full name.", "maxLength": 5000, "type": "string" }, "phone": { "description": "Owner's phone number.", "maxLength": 5000, "type": "string" } }, "title": "owner", "type": "object", "x-stripeMostCommon": [ "address", "email", "name", "phone" ] } }, "type": "object", "x-stripeMostCommon": [ "account_holder_name", "account_holder_type", "address_city", "address_country", "address_line1", "address_line2", "address_state", "address_zip", "exp_month", "exp_year", "metadata", "name", "owner" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/card" }, { "$ref": "#/components/schemas/bank_account" }, { "$ref": "#/components/schemas/source" } ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } } } }, "/v1/customers/{customer}/sources/{id}/verify": { "post": { "description": "

Verify a specified bank account for a given customer.

", "operationId": "PostCustomersCustomerSourcesIdVerify", "parameters": [ { "in": "path", "name": "customer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "amounts": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "amounts": { "description": "Two positive integers, in *cents*, equal to the values of the microdeposits sent to the bank account.", "items": { "type": "integer" }, "type": "array" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object", "x-stripeMostCommon": [ "amounts" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bank_account" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Verify a bank account" } }, "/v1/customers/{customer}/tax_ids": { "get": { "description": "

Returns a list of tax IDs for a customer.

", "operationId": "GetCustomersCustomerTaxIds", "parameters": [ { "in": "path", "name": "customer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/tax_id" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "TaxIDsList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all Customer tax IDs" }, "post": { "description": "

Creates a new tax_id object for a customer.

", "operationId": "PostCustomersCustomerTaxIds", "parameters": [ { "in": "path", "name": "customer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "type": { "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `aw_tin`, `az_tin`, `ba_tin`, `bb_tin`, `bd_bin`, `bf_ifu`, `bg_uic`, `bh_vat`, `bj_ifu`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cm_niu`, `cn_tin`, `co_nit`, `cr_tin`, `cv_nif`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `et_tin`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kg_tin`, `kh_tin`, `kr_brn`, `kz_bin`, `la_tin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin`", "enum": [ "ad_nrt", "ae_trn", "al_tin", "am_tin", "ao_tin", "ar_cuit", "au_abn", "au_arn", "aw_tin", "az_tin", "ba_tin", "bb_tin", "bd_bin", "bf_ifu", "bg_uic", "bh_vat", "bj_ifu", "bo_tin", "br_cnpj", "br_cpf", "bs_tin", "by_tin", "ca_bn", "ca_gst_hst", "ca_pst_bc", "ca_pst_mb", "ca_pst_sk", "ca_qst", "cd_nif", "ch_uid", "ch_vat", "cl_tin", "cm_niu", "cn_tin", "co_nit", "cr_tin", "cv_nif", "de_stn", "do_rcn", "ec_ruc", "eg_tin", "es_cif", "et_tin", "eu_oss_vat", "eu_vat", "gb_vat", "ge_vat", "gn_nif", "hk_br", "hr_oib", "hu_tin", "id_npwp", "il_vat", "in_gst", "is_vat", "jp_cn", "jp_rn", "jp_trn", "ke_pin", "kg_tin", "kh_tin", "kr_brn", "kz_bin", "la_tin", "li_uid", "li_vat", "ma_vat", "md_vat", "me_pib", "mk_vat", "mr_nif", "mx_rfc", "my_frp", "my_itn", "my_sst", "ng_tin", "no_vat", "no_voec", "np_pan", "nz_gst", "om_vat", "pe_ruc", "ph_tin", "ro_tin", "rs_pib", "ru_inn", "ru_kpp", "sa_vat", "sg_gst", "sg_uen", "si_tin", "sn_ninea", "sr_fin", "sv_nit", "th_vat", "tj_tin", "tr_tin", "tw_vat", "tz_vat", "ua_vat", "ug_tin", "us_ein", "uy_ruc", "uz_tin", "uz_vat", "ve_rif", "vn_tin", "za_vat", "zm_tin", "zw_tin" ], "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true }, "value": { "description": "Value of the tax ID.", "type": "string" } }, "required": [ "type", "value" ], "type": "object", "x-stripeMostCommon": [ "type", "value" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax_id" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a Customer tax ID" } }, "/v1/customers/{customer}/tax_ids/{id}": { "delete": { "description": "

Deletes an existing tax_id object.

", "operationId": "DeleteCustomersCustomerTaxIdsId", "parameters": [ { "in": "path", "name": "customer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted_tax_id" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Delete a Customer tax ID" }, "get": { "description": "

Retrieves the tax_id object with the given identifier.

", "operationId": "GetCustomersCustomerTaxIdsId", "parameters": [ { "in": "path", "name": "customer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax_id" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a Customer tax ID" } }, "/v1/disputes": { "get": { "description": "

Returns a list of your disputes.

", "operationId": "GetDisputes", "parameters": [ { "description": "Only return disputes associated to the charge specified by this charge ID.", "in": "query", "name": "charge", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Only return disputes that were created during the given date interval.", "explode": true, "in": "query", "name": "created", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "description": "Minimum value to filter by (exclusive)", "type": "integer" }, "gte": { "description": "Minimum value to filter by (inclusive)", "type": "integer" }, "lt": { "description": "Maximum value to filter by (exclusive)", "type": "integer" }, "lte": { "description": "Maximum value to filter by (inclusive)", "type": "integer" } }, "title": "range_query_specs", "type": "object", "x-stripeMostCommon": [ "gt", "gte", "lt", "lte" ] }, { "type": "integer" } ] }, "style": "deepObject" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "Only return disputes associated to the PaymentIntent specified by this PaymentIntent ID.", "in": "query", "name": "payment_intent", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/dispute" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/disputes", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "DisputeList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all disputes" } }, "/v1/disputes/{dispute}": { "get": { "description": "

Retrieves the dispute with the given ID.

", "operationId": "GetDisputesDispute", "parameters": [ { "in": "path", "name": "dispute", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dispute" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a dispute" }, "post": { "description": "

When you get a dispute, contacting your customer is always the best first step. If that doesn’t work, you can submit evidence to help us resolve the dispute in your favor. You can do this in your dashboard, but if you prefer, you can use the API to submit evidence programmatically.

\n\n

Depending on your dispute type, different evidence fields will give you a better chance of winning your dispute. To figure out which evidence fields to provide, see our guide to dispute types.

", "operationId": "PostDisputesDispute", "parameters": [ { "in": "path", "name": "dispute", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "evidence": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "evidence": { "description": "Evidence to upload, to respond to a dispute. Updating any field in the hash will submit all fields in the hash for review. The combined character count of all fields is limited to 150,000.", "properties": { "access_activity_log": { "description": "Any server or activity logs showing proof that the customer accessed or downloaded the purchased digital product. This information should include IP addresses, corresponding timestamps, and any detailed recorded activity. Has a maximum character count of 20,000.", "maxLength": 20000, "type": "string" }, "billing_address": { "description": "The billing address provided by the customer.", "maxLength": 5000, "type": "string" }, "cancellation_policy": { "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Your subscription cancellation policy, as shown to the customer.", "type": "string" }, "cancellation_policy_disclosure": { "description": "An explanation of how and when the customer was shown your refund policy prior to purchase. Has a maximum character count of 20,000.", "maxLength": 20000, "type": "string" }, "cancellation_rebuttal": { "description": "A justification for why the customer's subscription was not canceled. Has a maximum character count of 20,000.", "maxLength": 20000, "type": "string" }, "customer_communication": { "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any communication with the customer that you feel is relevant to your case. Examples include emails proving that the customer received the product or service, or demonstrating their use of or satisfaction with the product or service.", "type": "string" }, "customer_email_address": { "description": "The email address of the customer.", "maxLength": 5000, "type": "string" }, "customer_name": { "description": "The name of the customer.", "maxLength": 5000, "type": "string" }, "customer_purchase_ip": { "description": "The IP address that the customer used when making the purchase.", "maxLength": 5000, "type": "string" }, "customer_signature": { "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) A relevant document or contract showing the customer's signature.", "type": "string" }, "duplicate_charge_documentation": { "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Documentation for the prior charge that can uniquely identify the charge, such as a receipt, shipping label, work order, etc. This document should be paired with a similar document from the disputed payment that proves the two payments are separate.", "type": "string" }, "duplicate_charge_explanation": { "description": "An explanation of the difference between the disputed charge versus the prior charge that appears to be a duplicate. Has a maximum character count of 20,000.", "maxLength": 20000, "type": "string" }, "duplicate_charge_id": { "description": "The Stripe ID for the prior charge which appears to be a duplicate of the disputed charge.", "maxLength": 5000, "type": "string" }, "enhanced_evidence": { "anyOf": [ { "properties": { "visa_compelling_evidence_3": { "description": "Evidence provided for Visa Compelling Evidence 3.0 evidence submission.", "properties": { "disputed_transaction": { "description": "Disputed transaction details for Visa Compelling Evidence 3.0 evidence submission.", "properties": { "customer_account_id": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "User Account ID used to log into business platform. Must be recognizable by the user." }, "customer_device_fingerprint": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Unique identifier of the cardholder’s device derived from a combination of at least two hardware and software attributes. Must be at least 20 characters." }, "customer_device_id": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Unique identifier of the cardholder’s device such as a device serial number (e.g., International Mobile Equipment Identity [IMEI]). Must be at least 15 characters." }, "customer_email_address": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "The email address of the customer." }, "customer_purchase_ip": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "The IP address that the customer used when making the purchase." }, "merchandise_or_services": { "description": "Categorization of disputed payment.", "enum": [ "merchandise", "services" ], "type": "string" }, "product_description": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "A description of the product or service that was sold." }, "shipping_address": { "description": "The address to which a physical product was shipped. All fields are required for Visa Compelling Evidence 3.0 evidence submission.", "properties": { "city": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "City, district, suburb, town, or village." }, "country": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))." }, "line1": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Address line 1 (e.g., street, PO Box, or company name)." }, "line2": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Address line 2 (e.g., apartment, suite, unit, or building)." }, "postal_code": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "ZIP or postal code." }, "state": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "State, county, province, or region." } }, "title": "shipping_address", "type": "object", "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state" ] } }, "title": "visa_compelling_evidence3_disputed_transaction", "type": "object", "x-stripeMostCommon": [ "customer_account_id", "customer_device_fingerprint", "customer_device_id", "customer_email_address", "customer_purchase_ip", "merchandise_or_services", "product_description", "shipping_address" ] }, "prior_undisputed_transactions": { "description": "List of exactly two prior undisputed transaction objects for Visa Compelling Evidence 3.0 evidence submission.", "items": { "properties": { "charge": { "description": "Stripe charge ID for the Visa Compelling Evidence 3.0 eligible prior charge.", "maxLength": 5000, "type": "string" }, "customer_account_id": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "User Account ID used to log into business platform. Must be recognizable by the user." }, "customer_device_fingerprint": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Unique identifier of the cardholder’s device derived from a combination of at least two hardware and software attributes. Must be at least 20 characters." }, "customer_device_id": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Unique identifier of the cardholder’s device such as a device serial number (e.g., International Mobile Equipment Identity [IMEI]). Must be at least 15 characters." }, "customer_email_address": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "The email address of the customer." }, "customer_purchase_ip": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "The IP address that the customer used when making the purchase." }, "product_description": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "A description of the product or service that was sold." }, "shipping_address": { "description": "The address to which a physical product was shipped. All fields are required for Visa Compelling Evidence 3.0 evidence submission.", "properties": { "city": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "City, district, suburb, town, or village." }, "country": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))." }, "line1": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Address line 1 (e.g., street, PO Box, or company name)." }, "line2": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Address line 2 (e.g., apartment, suite, unit, or building)." }, "postal_code": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "ZIP or postal code." }, "state": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "State, county, province, or region." } }, "title": "shipping_address", "type": "object", "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state" ] } }, "required": [ "charge" ], "title": "visa_compelling_evidence3_prior_undisputed_transaction", "type": "object", "x-stripeMostCommon": [ "charge", "customer_account_id", "customer_device_fingerprint", "customer_device_id", "customer_email_address", "customer_purchase_ip", "product_description", "shipping_address" ] }, "type": "array" } }, "title": "visa_compelling_evidence3", "type": "object", "x-stripeMostCommon": [ "disputed_transaction", "prior_undisputed_transactions" ] }, "visa_compliance": { "description": "Evidence provided for Visa compliance evidence submission.", "properties": { "fee_acknowledged": { "description": "A field acknowledging the fee incurred when countering a Visa compliance dispute. If this field is set to true, evidence can be submitted for the compliance dispute. Stripe collects a 500 USD (or local equivalent) amount to cover the network costs associated with resolving compliance disputes. Stripe refunds the 500 USD network fee if you win the dispute.", "type": "boolean" } }, "title": "visa_compliance", "type": "object", "x-stripeMostCommon": [ "fee_acknowledged" ] } }, "title": "enhanced_evidence", "type": "object", "x-stripeMostCommon": [ "visa_compelling_evidence_3", "visa_compliance" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Additional evidence for qualifying evidence programs." }, "product_description": { "description": "A description of the product or service that was sold. Has a maximum character count of 20,000.", "maxLength": 20000, "type": "string" }, "receipt": { "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any receipt or message sent to the customer notifying them of the charge.", "type": "string" }, "refund_policy": { "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Your refund policy, as shown to the customer.", "type": "string" }, "refund_policy_disclosure": { "description": "Documentation demonstrating that the customer was shown your refund policy prior to purchase. Has a maximum character count of 20,000.", "maxLength": 20000, "type": "string" }, "refund_refusal_explanation": { "description": "A justification for why the customer is not entitled to a refund. Has a maximum character count of 20,000.", "maxLength": 20000, "type": "string" }, "service_date": { "description": "The date on which the customer received or began receiving the purchased service, in a clear human-readable format.", "maxLength": 5000, "type": "string" }, "service_documentation": { "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Documentation showing proof that a service was provided to the customer. This could include a copy of a signed contract, work order, or other form of written agreement.", "type": "string" }, "shipping_address": { "description": "The address to which a physical product was shipped. You should try to include as complete address information as possible.", "maxLength": 5000, "type": "string" }, "shipping_carrier": { "description": "The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc. If multiple carriers were used for this purchase, please separate them with commas.", "maxLength": 5000, "type": "string" }, "shipping_date": { "description": "The date on which a physical product began its route to the shipping address, in a clear human-readable format.", "maxLength": 5000, "type": "string" }, "shipping_documentation": { "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Documentation showing proof that a product was shipped to the customer at the same address the customer provided to you. This could include a copy of the shipment receipt, shipping label, etc. It should show the customer's full shipping address, if possible.", "type": "string" }, "shipping_tracking_number": { "description": "The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.", "maxLength": 5000, "type": "string" }, "uncategorized_file": { "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any additional evidence or statements.", "type": "string" }, "uncategorized_text": { "description": "Any additional evidence or statements. Has a maximum character count of 20,000.", "maxLength": 20000, "type": "string" } }, "title": "dispute_evidence_params", "type": "object", "x-stripeMostCommon": [ "access_activity_log", "billing_address", "booking", "cancellation_policy", "cancellation_policy_disclosure", "cancellation_rebuttal", "credit_voucher", "customer_communication", "customer_email_address", "customer_name", "customer_purchase_ip", "customer_signature", "duplicate_charge_documentation", "duplicate_charge_explanation", "duplicate_charge_id", "enhanced_evidence", "event_details", "government_order", "narrative", "prior_undisputed_payments", "product_description", "product_service_ad", "receipt", "refund_policy", "refund_policy_disclosure", "refund_refusal_explanation", "service_date", "service_documentation", "shipping_address", "shipping_carrier", "shipping_date", "shipping_documentation", "shipping_tracking_number", "terms_disclosure", "uncategorized_file", "uncategorized_text" ] }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "submit": { "description": "Whether to immediately submit evidence to the bank. If `false`, evidence is staged on the dispute. Staged evidence is visible in the API and Dashboard, and can be submitted to the bank by making another request with this attribute set to `true` (the default).", "type": "boolean" } }, "type": "object", "x-stripeMostCommon": [ "evidence", "metadata", "submit" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dispute" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a dispute" } }, "/v1/disputes/{dispute}/close": { "post": { "description": "

Closing the dispute for a charge indicates that you do not have any evidence to submit and are essentially dismissing the dispute, acknowledging it as lost.

\n\n

The status of the dispute will change from needs_response to lost. Closing a dispute is irreversible.

", "operationId": "PostDisputesDisputeClose", "parameters": [ { "in": "path", "name": "dispute", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dispute" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Close a dispute" } }, "/v1/entitlements/active_entitlements": { "get": { "description": "

Retrieve a list of active entitlements for a customer

", "operationId": "GetEntitlementsActiveEntitlements", "parameters": [ { "description": "The ID of the customer.", "in": "query", "name": "customer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/entitlements.active_entitlement" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "EntitlementsResourceCustomerEntitlementList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all active entitlements" } }, "/v1/entitlements/active_entitlements/{id}": { "get": { "description": "

Retrieve an active entitlement

", "operationId": "GetEntitlementsActiveEntitlementsId", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "The ID of the entitlement.", "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/entitlements.active_entitlement" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve an active entitlement" } }, "/v1/entitlements/features": { "get": { "description": "

Retrieve a list of features

", "operationId": "GetEntitlementsFeatures", "parameters": [ { "description": "If set, filter results to only include features with the given archive status.", "in": "query", "name": "archived", "required": false, "schema": { "type": "boolean" }, "style": "form" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "If set, filter results to only include features with the given lookup_key.", "in": "query", "name": "lookup_key", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/entitlements.feature" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/entitlements/features", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "EntitlementsResourceFeatureList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all features" }, "post": { "description": "

Creates a feature

", "operationId": "PostEntitlementsFeatures", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "lookup_key": { "description": "A unique key you provide as your own system identifier. This may be up to 80 characters.", "maxLength": 80, "type": "string" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "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.", "type": "object" }, "name": { "description": "The feature's name, for your own purpose, not meant to be displayable to the customer.", "maxLength": 80, "type": "string" } }, "required": [ "lookup_key", "name" ], "type": "object", "x-stripeMostCommon": [ "lookup_key", "metadata", "name" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/entitlements.feature" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a feature" } }, "/v1/entitlements/features/{id}": { "get": { "description": "

Retrieves a feature

", "operationId": "GetEntitlementsFeaturesId", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "The ID of the feature.", "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/entitlements.feature" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a feature" }, "post": { "description": "

Update a feature’s metadata or permanently deactivate it.

", "operationId": "PostEntitlementsFeaturesId", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "active": { "description": "Inactive features cannot be attached to new products and will not be returned from the features list endpoint.", "type": "boolean" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "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." }, "name": { "description": "The feature's name, for your own purpose, not meant to be displayable to the customer.", "maxLength": 80, "type": "string" } }, "type": "object", "x-stripeMostCommon": [ "metadata", "name" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/entitlements.feature" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Updates a feature" } }, "/v1/ephemeral_keys": { "post": { "description": "

Creates a short-lived API key for a given resource.

", "operationId": "PostEphemeralKeys", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "customer": { "description": "The ID of the Customer you'd like to modify using the resulting ephemeral key.", "maxLength": 5000, "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "issuing_card": { "description": "The ID of the Issuing Card you'd like to access using the resulting ephemeral key.", "maxLength": 5000, "type": "string" }, "nonce": { "description": "A single-use token, created by Stripe.js, used for creating ephemeral keys for Issuing Cards without exchanging sensitive information.", "maxLength": 5000, "type": "string" }, "verification_session": { "description": "The ID of the Identity VerificationSession you'd like to access using the resulting ephemeral key", "maxLength": 5000, "type": "string" } }, "type": "object", "x-stripeMostCommon": [ "customer", "issuing_card", "nonce", "verification_session" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ephemeral_key" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create an ephemeral key" } }, "/v1/ephemeral_keys/{key}": { "delete": { "description": "

Invalidates a short-lived API key for a given resource.

", "operationId": "DeleteEphemeralKeysKey", "parameters": [ { "in": "path", "name": "key", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ephemeral_key" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Immediately invalidate an ephemeral key" } }, "/v1/events": { "get": { "description": "

List events, going back up to 30 days. Each event data is rendered according to Stripe API version at its creation time, specified in event object api_version attribute (not according to your current Stripe API version or Stripe-Version header).

", "operationId": "GetEvents", "parameters": [ { "description": "Only return events that were created during the given date interval.", "explode": true, "in": "query", "name": "created", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "description": "Minimum value to filter by (exclusive)", "type": "integer" }, "gte": { "description": "Minimum value to filter by (inclusive)", "type": "integer" }, "lt": { "description": "Maximum value to filter by (exclusive)", "type": "integer" }, "lte": { "description": "Maximum value to filter by (inclusive)", "type": "integer" } }, "title": "range_query_specs", "type": "object", "x-stripeMostCommon": [ "gt", "gte", "lt", "lte" ] }, { "type": "integer" } ] }, "style": "deepObject" }, { "description": "Filter events by whether all webhooks were successfully delivered. If false, events which are still pending or have failed all delivery attempts to a webhook endpoint will be returned.", "in": "query", "name": "delivery_success", "required": false, "schema": { "type": "boolean" }, "style": "form" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "A string containing a specific event name, or group of events using * as a wildcard. The list will be filtered to include only events with a matching event property.", "in": "query", "name": "type", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "An array of up to 20 strings containing specific event names. The list will be filtered to include only events with a matching event property. You may pass either `type` or `types`, but not both.", "explode": true, "in": "query", "name": "types", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/event" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/events", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "NotificationEventList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all events" } }, "/v1/events/{id}": { "get": { "description": "

Retrieves the details of an event if it was created in the last 30 days. Supply the unique identifier of the event, which you might have received in a webhook.

", "operationId": "GetEventsId", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/event" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve an event" } }, "/v1/exchange_rates": { "get": { "description": "

Returns a list of objects that contain the rates at which foreign currencies are converted to one another. Only shows the currencies for which Stripe supports.

", "operationId": "GetExchangeRates", "parameters": [ { "description": "A cursor for use in pagination. `ending_before` is the currency that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with the exchange rate for currency X your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and total number of supported payout currencies, and the default is the max.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "A cursor for use in pagination. `starting_after` is the currency that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with the exchange rate for currency X, your subsequent call can include `starting_after=X` in order to fetch the next page of the list.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/exchange_rate" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/exchange_rates", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "ExchangeRateList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all exchange rates" } }, "/v1/exchange_rates/{rate_id}": { "get": { "description": "

Retrieves the exchange rates from the given currency to every supported currency.

", "operationId": "GetExchangeRatesRateId", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "rate_id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/exchange_rate" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve an exchange rate" } }, "/v1/external_accounts": { "get": { "description": "

List external accounts for an account.

", "operationId": "GetExternalAccounts", "parameters": [ { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "Filter external accounts according to a particular object type.", "in": "query", "name": "object", "required": false, "schema": { "enum": [ "bank_account", "card" ], "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true, "x-stripeParam": { "class_name": "object_type" } }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "description": "The list contains all external accounts that have been attached to the Stripe account. These may be bank accounts or cards.", "items": { "$ref": "#/components/schemas/external_account" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "ExternalAccountList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all external accounts" }, "post": { "description": "

Create an external account for a given connected account.

", "operationId": "PostExternalAccounts", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "default_for_currency": { "description": "When set to true, or if this is the first external account added in this currency, this account becomes the default external account for its currency.", "type": "boolean" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "external_account": { "description": "Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user’s external account details (with the options shown below).", "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" } }, "required": [ "external_account" ], "type": "object", "x-stripeMostCommon": [ "external_account", "metadata" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/external_account" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create an external account" } }, "/v1/external_accounts/{id}": { "delete": { "description": "

Delete a specified external account for a given account.

", "operationId": "DeleteExternalAccountsId", "parameters": [ { "description": "Unique identifier for the external account to be deleted.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted_external_account" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Delete an external account" }, "get": { "description": "

Retrieve a specified external account for a given account.

", "operationId": "GetExternalAccountsId", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "Unique identifier for the external account to be retrieved.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/external_account" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve an external account" }, "post": { "description": "

Updates the metadata, account holder name, account holder type of a bank account belonging to\na connected account and optionally sets it as the default for its currency. Other bank account\ndetails are not editable by design.

\n\n

You can only update bank accounts when account.controller.requirement_collection is application, which includes Custom accounts.

\n\n

You can re-enable a disabled bank account by performing an update call without providing any\narguments or changes.

", "operationId": "PostExternalAccountsId", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "documents": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "account_holder_name": { "description": "The name of the person or business that owns the bank account.", "maxLength": 5000, "type": "string" }, "account_holder_type": { "description": "The type of entity that holds the account. This can be either `individual` or `company`.", "enum": [ "", "company", "individual" ], "maxLength": 5000, "type": "string" }, "account_type": { "description": "The bank account type. This can only be `checking` or `savings` in most countries. In Japan, this can only be `futsu` or `toza`.", "enum": [ "checking", "futsu", "savings", "toza" ], "maxLength": 5000, "type": "string" }, "address_city": { "description": "City/District/Suburb/Town/Village.", "maxLength": 5000, "type": "string" }, "address_country": { "description": "Billing address country, if provided when creating card.", "maxLength": 5000, "type": "string" }, "address_line1": { "description": "Address line 1 (Street address/PO Box/Company name).", "maxLength": 5000, "type": "string" }, "address_line2": { "description": "Address line 2 (Apartment/Suite/Unit/Building).", "maxLength": 5000, "type": "string" }, "address_state": { "description": "State/County/Province/Region.", "maxLength": 5000, "type": "string" }, "address_zip": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "default_for_currency": { "description": "When set to true, this becomes the default external account for its currency.", "type": "boolean" }, "documents": { "description": "Documents that may be submitted to satisfy various informational requests.", "properties": { "bank_account_ownership_verification": { "description": "One or more documents that support the [Bank account ownership verification](https://support.stripe.com/questions/bank-account-ownership-verification) requirement. Must be a document associated with the bank account that displays the last 4 digits of the account number, either a statement or a check.", "properties": { "files": { "description": "One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.", "items": { "maxLength": 500, "type": "string" }, "type": "array" } }, "title": "documents_param", "type": "object", "x-stripeMostCommon": [ "files" ] } }, "title": "external_account_documents_param", "type": "object", "x-stripeMostCommon": [ "bank_account_ownership_verification" ] }, "exp_month": { "description": "Two digit number representing the card’s expiration month.", "maxLength": 5000, "type": "string" }, "exp_year": { "description": "Four digit number representing the card’s expiration year.", "maxLength": 5000, "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "name": { "description": "Cardholder name.", "maxLength": 5000, "type": "string" } }, "type": "object", "x-stripeMostCommon": [ "default_for_currency", "metadata" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/external_account" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } } } }, "/v1/file_links": { "get": { "description": "

Returns a list of file links.

", "operationId": "GetFileLinks", "parameters": [ { "description": "Only return links that were created during the given date interval.", "explode": true, "in": "query", "name": "created", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "description": "Minimum value to filter by (exclusive)", "type": "integer" }, "gte": { "description": "Minimum value to filter by (inclusive)", "type": "integer" }, "lt": { "description": "Maximum value to filter by (exclusive)", "type": "integer" }, "lte": { "description": "Maximum value to filter by (inclusive)", "type": "integer" } }, "title": "range_query_specs", "type": "object", "x-stripeMostCommon": [ "gt", "gte", "lt", "lte" ] }, { "type": "integer" } ] }, "style": "deepObject" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "Filter links by their expiration status. By default, Stripe returns all links.", "in": "query", "name": "expired", "required": false, "schema": { "type": "boolean" }, "style": "form" }, { "description": "Only return links for the given file.", "in": "query", "name": "file", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/file_link" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/file_links", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "FileResourceFileLinkList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all file links" }, "post": { "description": "

Creates a new file link object.

", "operationId": "PostFileLinks", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "expires_at": { "description": "The link isn't usable after this future timestamp.", "format": "unix-time", "type": "integer" }, "file": { "description": "The ID of the file. The file's `purpose` must be one of the following: `business_icon`, `business_logo`, `customer_signature`, `dispute_evidence`, `finance_report_run`, `financial_account_statement`, `identity_document_downloadable`, `issuing_regulatory_reporting`, `pci_document`, `selfie`, `sigma_scheduled_query`, `tax_document_user_upload`, `terminal_android_apk`, or `terminal_reader_splashscreen`.", "maxLength": 5000, "type": "string" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." } }, "required": [ "file" ], "type": "object", "x-stripeMostCommon": [ "expires_at", "file", "metadata" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/file_link" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a file link" } }, "/v1/file_links/{link}": { "get": { "description": "

Retrieves the file link with the given ID.

", "operationId": "GetFileLinksLink", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "link", "required": true, "schema": { "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/file_link" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a file link" }, "post": { "description": "

Updates an existing file link object. Expired links can no longer be updated.

", "operationId": "PostFileLinksLink", "parameters": [ { "in": "path", "name": "link", "required": true, "schema": { "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "expires_at": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "expires_at": { "anyOf": [ { "enum": [ "now" ], "maxLength": 5000, "type": "string" }, { "format": "unix-time", "type": "integer" }, { "enum": [ "" ], "type": "string" } ], "description": "A future timestamp after which the link will no longer be usable, or `now` to expire the link immediately." }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." } }, "type": "object", "x-stripeMostCommon": [ "expires_at", "metadata" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/file_link" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a file link" } }, "/v1/files": { "get": { "description": "

Returns a list of the files that your account has access to. Stripe sorts and returns the files by their creation dates, placing the most recently created files at the top.

", "operationId": "GetFiles", "parameters": [ { "description": "Only return files that were created during the given date interval.", "explode": true, "in": "query", "name": "created", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "description": "Minimum value to filter by (exclusive)", "type": "integer" }, "gte": { "description": "Minimum value to filter by (inclusive)", "type": "integer" }, "lt": { "description": "Maximum value to filter by (exclusive)", "type": "integer" }, "lte": { "description": "Maximum value to filter by (inclusive)", "type": "integer" } }, "title": "range_query_specs", "type": "object", "x-stripeMostCommon": [ "gt", "gte", "lt", "lte" ] }, { "type": "integer" } ] }, "style": "deepObject" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "Filter queries by the file purpose. If you don't provide a purpose, the queries return unfiltered files.", "in": "query", "name": "purpose", "required": false, "schema": { "enum": [ "account_requirement", "additional_verification", "business_icon", "business_logo", "customer_signature", "dispute_evidence", "document_provider_identity_document", "finance_report_run", "financial_account_statement", "identity_document", "identity_document_downloadable", "issuing_regulatory_reporting", "pci_document", "selfie", "sigma_scheduled_query", "tax_document_user_upload", "terminal_android_apk", "terminal_reader_splashscreen" ], "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/file" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/files", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "FileResourceFileList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all files" }, "post": { "description": "

To upload a file to Stripe, you need to send a request of type multipart/form-data. Include the file you want to upload in the request, and the parameters for creating a file.

\n\n

All of Stripe’s officially supported Client libraries support sending multipart/form-data.

", "operationId": "PostFiles", "requestBody": { "content": { "multipart/form-data": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "file_link_data": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "file": { "description": "A file to upload. Make sure that the specifications follow RFC 2388, which defines file transfers for the `multipart/form-data` protocol.", "format": "binary", "type": "string" }, "file_link_data": { "description": "Optional parameters that automatically create a [file link](https://stripe.com/docs/api#file_links) for the newly created file.", "properties": { "create": { "description": "Set this to `true` to create a file link for the newly created file. Creating a link is only possible when the file's `purpose` is one of the following: `business_icon`, `business_logo`, `customer_signature`, `dispute_evidence`, `issuing_regulatory_reporting`, `pci_document`, `tax_document_user_upload`, `terminal_android_apk`, or `terminal_reader_splashscreen`.", "type": "boolean" }, "expires_at": { "description": "The link isn't available after this future timestamp.", "format": "unix-time", "type": "integer" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." } }, "required": [ "create" ], "title": "file_link_creation_params", "type": "object", "x-stripeMostCommon": [ "create", "expires_at", "metadata" ] }, "purpose": { "description": "The [purpose](https://stripe.com/docs/file-upload#uploading-a-file) of the uploaded file.", "enum": [ "account_requirement", "additional_verification", "business_icon", "business_logo", "customer_signature", "dispute_evidence", "identity_document", "issuing_regulatory_reporting", "pci_document", "tax_document_user_upload", "terminal_android_apk", "terminal_reader_splashscreen" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "file", "purpose" ], "type": "object", "x-stripeMostCommon": [ "file", "purpose" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/file" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "servers": [ { "url": "https://files.stripe.com/" } ], "summary": "Create a file" } }, "/v1/files/{file}": { "get": { "description": "

Retrieves the details of an existing file object. After you supply a unique file ID, Stripe returns the corresponding file object. Learn how to access file contents.

", "operationId": "GetFilesFile", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "file", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/file" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a file" } }, "/v1/financial_connections/accounts": { "get": { "description": "

Returns a list of Financial Connections Account objects.

", "operationId": "GetFinancialConnectionsAccounts", "parameters": [ { "description": "If present, only return accounts that belong to the specified account holder. `account_holder[customer]` and `account_holder[account]` are mutually exclusive.", "explode": true, "in": "query", "name": "account_holder", "required": false, "schema": { "properties": { "account": { "description": "The ID of the Stripe account whose accounts will be retrieved.", "maxLength": 5000, "type": "string" }, "customer": { "description": "The ID of the Stripe customer whose accounts will be retrieved.", "maxLength": 5000, "type": "string" }, "customer_account": { "description": "The Account ID of the Stripe customer whose accounts will be retrieved.", "maxLength": 5000, "type": "string" } }, "title": "accountholder_params", "type": "object", "x-stripeMostCommon": [ "account", "customer", "customer_account" ] }, "style": "deepObject" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "If present, only return accounts that were collected as part of the given session.", "in": "query", "name": "session", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/financial_connections.account" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/financial_connections/accounts", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "BankConnectionsResourceLinkedAccountList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List Accounts" } }, "/v1/financial_connections/accounts/{account}": { "get": { "description": "

Retrieves the details of an Financial Connections Account.

", "operationId": "GetFinancialConnectionsAccountsAccount", "parameters": [ { "in": "path", "name": "account", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/financial_connections.account" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve an Account" } }, "/v1/financial_connections/accounts/{account}/disconnect": { "post": { "description": "

Disables your access to a Financial Connections Account. You will no longer be able to access data associated with the account (e.g. balances, transactions).

", "operationId": "PostFinancialConnectionsAccountsAccountDisconnect", "parameters": [ { "in": "path", "name": "account", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/financial_connections.account" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Disconnect an Account" } }, "/v1/financial_connections/accounts/{account}/inferred_balances": { "get": { "description": "

Lists the recorded inferred balances for a Financial Connections Account.

", "operationId": "GetFinancialConnectionsAccountsAccountInferredBalances", "parameters": [ { "in": "path", "name": "account", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "A list of historical balances for an account, with at most one record per calendar day.\nEach balance may be sourced from a balance snapshot provided by a financial institution, or inferred using transactions data.\nGaps in the list indicate that Stripe did not detect a change in balance on the missing dates.", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/financial_connections.account_inferred_balance" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "BankConnectionsExternalResourcesInferredBalanceList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List Account's inferred balances" } }, "/v1/financial_connections/accounts/{account}/owners": { "get": { "description": "

Lists all owners for a given Account

", "operationId": "GetFinancialConnectionsAccountsAccountOwners", "parameters": [ { "in": "path", "name": "account", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "The ID of the ownership object to fetch owners from.", "in": "query", "name": "ownership", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/financial_connections.account_owner" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "BankConnectionsResourceOwnerList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List Account Owners" } }, "/v1/financial_connections/accounts/{account}/refresh": { "post": { "description": "

Refreshes the data associated with a Financial Connections Account.

", "operationId": "PostFinancialConnectionsAccountsAccountRefresh", "parameters": [ { "in": "path", "name": "account", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "features": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "features": { "description": "The list of account features that you would like to refresh.", "items": { "enum": [ "balance", "inferred_balances", "ownership", "transactions" ], "type": "string", "x-stripeBypassValidation": true }, "type": "array" } }, "required": [ "features" ], "type": "object", "x-stripeMostCommon": [ "features" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/financial_connections.account" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Refresh Account data" } }, "/v1/financial_connections/accounts/{account}/subscribe": { "post": { "description": "

Subscribes to periodic refreshes of data associated with a Financial Connections Account.

", "operationId": "PostFinancialConnectionsAccountsAccountSubscribe", "parameters": [ { "in": "path", "name": "account", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "features": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "features": { "description": "The list of account features to which you would like to subscribe.", "items": { "enum": [ "balance", "inferred_balances", "transactions" ], "type": "string", "x-stripeBypassValidation": true }, "type": "array" } }, "required": [ "features" ], "type": "object", "x-stripeMostCommon": [ "features" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/financial_connections.account" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Subscribe to data refreshes for an Account" } }, "/v1/financial_connections/accounts/{account}/unsubscribe": { "post": { "description": "

Unsubscribes from periodic refreshes of data associated with a Financial Connections Account.

", "operationId": "PostFinancialConnectionsAccountsAccountUnsubscribe", "parameters": [ { "in": "path", "name": "account", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "features": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "features": { "description": "The list of account features from which you would like to unsubscribe.", "items": { "enum": [ "balance", "inferred_balances", "transactions" ], "type": "string", "x-stripeBypassValidation": true }, "type": "array" } }, "required": [ "features" ], "type": "object", "x-stripeMostCommon": [ "features" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/financial_connections.account" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Unsubscribe from data refreshes for an Account" } }, "/v1/financial_connections/institutions": { "get": { "description": "

Returns a list of Financial Connections Institution objects.

", "operationId": "GetFinancialConnectionsInstitutions", "parameters": [ { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/financial_connections.institution" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/financial_connections/institutions", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "BankConnectionsResourceExternalInstitutionList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List Institutions" } }, "/v1/financial_connections/institutions/{institution}": { "get": { "description": "

Retrieves the details of a Financial Connections Institution.

", "operationId": "GetFinancialConnectionsInstitutionsInstitution", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "institution", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/financial_connections.institution" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve an Institution" } }, "/v1/financial_connections/sessions": { "post": { "description": "

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.

", "operationId": "PostFinancialConnectionsSessions", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "account_holder": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "filters": { "explode": true, "style": "deepObject" }, "limits": { "explode": true, "style": "deepObject" }, "manual_entry": { "explode": true, "style": "deepObject" }, "permissions": { "explode": true, "style": "deepObject" }, "prefetch": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "account_holder": { "description": "The account holder to link accounts for.", "properties": { "account": { "description": "The ID of the Stripe account whose accounts will be retrieved. Should only be present if `type` is `account`.", "maxLength": 5000, "type": "string" }, "customer": { "description": "The ID of the Stripe customer whose accounts will be retrieved. Should only be present if `type` is `customer`.", "maxLength": 5000, "type": "string" }, "customer_account": { "description": "The ID of the Stripe customer Account whose accounts will be retrieved. Should only be present if `type` is `customer`.", "maxLength": 5000, "type": "string" }, "type": { "description": "Type of account holder to collect accounts for.", "enum": [ "account", "customer" ], "type": "string" } }, "required": [ "type" ], "title": "accountholder_params", "type": "object", "x-stripeMostCommon": [ "account", "customer", "customer_account", "type" ] }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "filters": { "description": "Filters to restrict the kinds of accounts to collect.", "properties": { "account_subcategories": { "description": "Restricts the Session to subcategories of accounts that can be linked. Valid subcategories are: `checking`, `savings`, `mortgage`, `line_of_credit`, `credit_card`.", "items": { "enum": [ "checking", "credit_card", "line_of_credit", "mortgage", "savings" ], "type": "string" }, "type": "array" }, "countries": { "description": "List of countries from which to collect accounts.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "institution": { "description": "Stripe ID of the institution with which the customer should be directed to log in.", "maxLength": 5000, "type": "string" } }, "title": "filters_params", "type": "object", "x-stripeMostCommon": [ "account_subcategories", "countries", "institution" ] }, "limits": { "description": "Settings for configuring Session-specific limits.", "properties": { "accounts": { "description": "The number of accounts that can be linked in this Session.", "type": "integer" } }, "required": [ "accounts" ], "title": "limits_params", "type": "object", "x-stripeMostCommon": [ "accounts" ] }, "manual_entry": { "description": "Customize manual entry behavior", "properties": { "mode": { "description": "Whether manual entry will be handled by Stripe during the Session.", "enum": [ "automatic", "custom" ], "type": "string" } }, "title": "manual_entry_params", "type": "object", "x-stripeMostCommon": [ "mode" ] }, "permissions": { "description": "List of data features that you would like to request access to.\n\nPossible values are `balances`, `transactions`, `ownership`, and `payment_method`.", "items": { "enum": [ "balances", "ownership", "payment_method", "transactions" ], "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true }, "type": "array" }, "prefetch": { "description": "List of data features that you would like to retrieve upon account creation.", "items": { "enum": [ "balances", "inferred_balances", "ownership", "transactions" ], "type": "string", "x-stripeBypassValidation": true }, "type": "array" }, "return_url": { "description": "For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.", "maxLength": 5000, "type": "string" } }, "required": [ "account_holder", "permissions" ], "type": "object", "x-stripeMostCommon": [ "account_holder", "filters", "limits", "manual_entry", "permissions", "prefetch", "return_url" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/financial_connections.session" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a Session" } }, "/v1/financial_connections/sessions/{session}": { "get": { "description": "

Retrieves the details of a Financial Connections Session

", "operationId": "GetFinancialConnectionsSessionsSession", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "session", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/financial_connections.session" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a Session" } }, "/v1/financial_connections/transactions": { "get": { "description": "

Returns a list of Financial Connections Transaction objects.

", "operationId": "GetFinancialConnectionsTransactions", "parameters": [ { "description": "The ID of the Financial Connections Account whose transactions will be retrieved.", "in": "query", "name": "account", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "A filter on the list based on the object `transacted_at` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with the following options:", "explode": true, "in": "query", "name": "transacted_at", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "description": "Minimum value to filter by (exclusive)", "type": "integer" }, "gte": { "description": "Minimum value to filter by (inclusive)", "type": "integer" }, "lt": { "description": "Maximum value to filter by (exclusive)", "type": "integer" }, "lte": { "description": "Maximum value to filter by (inclusive)", "type": "integer" } }, "title": "range_query_specs", "type": "object", "x-stripeMostCommon": [ "gt", "gte", "lt", "lte" ] }, { "type": "integer" } ] }, "style": "deepObject" }, { "description": "A filter on the list based on the object `transaction_refresh` field. The value can be a dictionary with the following options:", "explode": true, "in": "query", "name": "transaction_refresh", "required": false, "schema": { "properties": { "after": { "description": "Return results where the transactions were created or updated by a refresh that took place after this refresh (non-inclusive).", "maxLength": 5000, "type": "string" } }, "required": [ "after" ], "title": "transaction_refresh_params", "type": "object", "x-stripeMostCommon": [ "after" ] }, "style": "deepObject" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/financial_connections.transaction" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/financial_connections/transactions", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "BankConnectionsResourceTransactionList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List Transactions" } }, "/v1/financial_connections/transactions/{transaction}": { "get": { "description": "

Retrieves the details of a Financial Connections Transaction

", "operationId": "GetFinancialConnectionsTransactionsTransaction", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "transaction", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/financial_connections.transaction" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a Transaction" } }, "/v1/forwarding/requests": { "get": { "description": "

Lists all ForwardingRequest objects.

", "operationId": "GetForwardingRequests", "parameters": [ { "description": "Similar to other List endpoints, filters results based on created timestamp. You can pass gt, gte, lt, and lte timestamp values.", "explode": true, "in": "query", "name": "created", "required": false, "schema": { "properties": { "gt": { "description": "Return results where the `created` field is greater than this value.", "type": "integer" }, "gte": { "description": "Return results where the `created` field is greater than or equal to this value.", "type": "integer" }, "lt": { "description": "Return results where the `created` field is less than this value.", "type": "integer" }, "lte": { "description": "Return results where the `created` field is less than or equal to this value.", "type": "integer" } }, "title": "created_param", "type": "object", "x-stripeMostCommon": [ "gt", "gte", "lt", "lte" ] }, "style": "deepObject" }, { "description": "A pagination cursor to fetch the previous page of the list. The value must be a ForwardingRequest ID.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "A pagination cursor to fetch the next page of the list. The value must be a ForwardingRequest ID.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "List of ForwardingRequest data.", "properties": { "data": { "items": { "$ref": "#/components/schemas/forwarding.request" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "ForwardingRequestList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all ForwardingRequests" }, "post": { "description": "

Creates a ForwardingRequest object.

", "operationId": "PostForwardingRequests", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "replacements": { "explode": true, "style": "deepObject" }, "request": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "payment_method": { "description": "The PaymentMethod to insert into the forwarded request. Forwarding previously consumed PaymentMethods is allowed.", "maxLength": 5000, "type": "string" }, "replacements": { "description": "The field kinds to be replaced in the forwarded request.", "items": { "enum": [ "card_cvc", "card_expiry", "card_number", "cardholder_name", "request_signature" ], "type": "string", "x-stripeBypassValidation": true }, "type": "array" }, "request": { "description": "The request body and headers to be sent to the destination endpoint.", "properties": { "body": { "description": "The body payload to send to the destination endpoint.", "maxLength": 5000, "type": "string" }, "headers": { "description": "The headers to include in the forwarded request. Can be omitted if no additional headers (excluding Stripe-generated ones such as the Content-Type header) should be included.", "items": { "properties": { "name": { "description": "The header name.", "maxLength": 5000, "type": "string" }, "value": { "description": "The header value.", "maxLength": 5000, "type": "string" } }, "required": [ "name", "value" ], "title": "header_param", "type": "object", "x-stripeMostCommon": [ "name", "value" ] }, "type": "array" } }, "title": "request_param", "type": "object", "x-stripeMostCommon": [ "body", "headers" ] }, "url": { "description": "The destination URL for the forwarded request. Must be supported by the config.", "maxLength": 5000, "type": "string" } }, "required": [ "payment_method", "replacements", "url" ], "type": "object", "x-stripeMostCommon": [ "metadata", "payment_method", "replacements", "request", "url" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forwarding.request" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a ForwardingRequest" } }, "/v1/forwarding/requests/{id}": { "get": { "description": "

Retrieves a ForwardingRequest object.

", "operationId": "GetForwardingRequestsId", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forwarding.request" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a ForwardingRequest" } }, "/v1/fx_quotes": { "get": { "description": "

Returns a list of FX quotes that have been issued. The FX quotes are returned in sorted order, with the most recent FX quotes appearing first.

", "operationId": "GetFxQuotes", "parameters": [ { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/fx_quote" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/fx_quotes", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "FXFXQuoteResourceMerchantFXQuoteList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List active FX Quotes" }, "post": { "description": "

Creates an FX Quote object

", "operationId": "PostFxQuotes", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "from_currencies": { "explode": true, "style": "deepObject" }, "usage": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "from_currencies": { "description": "A list of three letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be [supported currencies](https://stripe.com/docs/currencies).", "items": { "format": "currency", "type": "string" }, "type": "array" }, "lock_duration": { "description": "The duration that you wish the quote to be locked for. The quote will be usable for the duration specified. The default is `none`. The maximum is 1 day.", "enum": [ "day", "five_minutes", "hour", "none" ], "type": "string" }, "to_currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "usage": { "description": "The usage specific information for the quote.", "properties": { "payment": { "description": "The payment transaction details that are intended for the FX Quote.", "properties": { "destination": { "description": "The Stripe account ID that the funds will be transferred to.\n\nThis field should match the account ID that would be used in the PaymentIntent’s transfer_data[destination] field.", "maxLength": 5000, "type": "string" }, "on_behalf_of": { "description": "The Stripe account ID that these funds are intended for.\n\nThis field should match the account ID that would be used in the PaymentIntent’s on_behalf_of field.", "maxLength": 5000, "type": "string" } }, "title": "payment_param", "type": "object", "x-stripeMostCommon": [ "destination", "on_behalf_of" ] }, "transfer": { "description": "The transfer transaction details that are intended for the FX Quote.", "properties": { "destination": { "description": "The Stripe account ID that the funds will be transferred to.\n\nThis field should match the account ID that would be used in the Transfer’s destination field.", "maxLength": 5000, "type": "string" } }, "required": [ "destination" ], "title": "transfer_param", "type": "object", "x-stripeMostCommon": [ "destination" ] }, "type": { "description": "Which transaction the FX Quote will be used for\n\nCan be “payment” | “transfer”", "enum": [ "payment", "transfer" ], "type": "string" } }, "required": [ "type" ], "title": "usage_param", "type": "object", "x-stripeMostCommon": [ "payment", "transfer", "type" ] } }, "required": [ "from_currencies", "lock_duration", "to_currency" ], "type": "object", "x-stripeMostCommon": [ "from_currencies", "lock_duration", "to_currency" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fx_quote" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create an FX Quote" } }, "/v1/fx_quotes/{id}": { "get": { "description": "

Retrieve an FX Quote object

", "operationId": "GetFxQuotesId", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fx_quote" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve an FX Quote" } }, "/v1/identity/verification_reports": { "get": { "description": "

List all verification reports.

", "operationId": "GetIdentityVerificationReports", "parameters": [ { "description": "A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems.", "in": "query", "name": "client_reference_id", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Only return VerificationReports that were created during the given date interval.", "explode": true, "in": "query", "name": "created", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "description": "Minimum value to filter by (exclusive)", "type": "integer" }, "gte": { "description": "Minimum value to filter by (inclusive)", "type": "integer" }, "lt": { "description": "Maximum value to filter by (exclusive)", "type": "integer" }, "lte": { "description": "Maximum value to filter by (inclusive)", "type": "integer" } }, "title": "range_query_specs", "type": "object", "x-stripeMostCommon": [ "gt", "gte", "lt", "lte" ] }, { "type": "integer" } ] }, "style": "deepObject" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Only return VerificationReports of this type", "in": "query", "name": "type", "required": false, "schema": { "enum": [ "document", "id_number" ], "type": "string", "x-stripeBypassValidation": true }, "style": "form" }, { "description": "Only return VerificationReports created by this VerificationSession ID. It is allowed to provide a VerificationIntent ID.", "in": "query", "name": "verification_session", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/identity.verification_report" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/identity/verification_reports", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "GelatoVerificationReportList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List VerificationReports" } }, "/v1/identity/verification_reports/{report}": { "get": { "description": "

Retrieves an existing VerificationReport

", "operationId": "GetIdentityVerificationReportsReport", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "report", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/identity.verification_report" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a VerificationReport" } }, "/v1/identity/verification_sessions": { "get": { "description": "

Returns a list of VerificationSessions

", "operationId": "GetIdentityVerificationSessions", "parameters": [ { "description": "A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems.", "in": "query", "name": "client_reference_id", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Only return VerificationSessions that were created during the given date interval.", "explode": true, "in": "query", "name": "created", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "description": "Minimum value to filter by (exclusive)", "type": "integer" }, "gte": { "description": "Minimum value to filter by (inclusive)", "type": "integer" }, "lt": { "description": "Maximum value to filter by (exclusive)", "type": "integer" }, "lte": { "description": "Maximum value to filter by (inclusive)", "type": "integer" } }, "title": "range_query_specs", "type": "object", "x-stripeMostCommon": [ "gt", "gte", "lt", "lte" ] }, { "type": "integer" } ] }, "style": "deepObject" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "in": "query", "name": "related_customer", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "in": "query", "name": "related_customer_account", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Only return VerificationSessions with this status. [Learn more about the lifecycle of sessions](https://stripe.com/docs/identity/how-sessions-work).", "in": "query", "name": "status", "required": false, "schema": { "enum": [ "canceled", "processing", "requires_input", "verified" ], "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/identity.verification_session" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/identity/verification_sessions", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "GelatoVerificationSessionList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List VerificationSessions" }, "post": { "description": "

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

", "operationId": "PostIdentityVerificationSessions", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "options": { "explode": true, "style": "deepObject" }, "provided_details": { "explode": true, "style": "deepObject" }, "related_person": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "client_reference_id": { "description": "A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems.", "maxLength": 5000, "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "options": { "description": "A set of options for the session’s verification checks.", "properties": { "document": { "anyOf": [ { "properties": { "allowed_types": { "description": "Array of strings of allowed identity document types. If the provided identity document isn’t one of the allowed types, the verification check will fail with a document_type_not_allowed error code.", "items": { "enum": [ "driving_license", "id_card", "passport" ], "type": "string" }, "type": "array" }, "require_id_number": { "description": "Collect an ID number and perform an [ID number check](https://stripe.com/docs/identity/verification-checks?type=id-number) with the document’s extracted name and date of birth.", "type": "boolean" }, "require_live_capture": { "description": "Disable image uploads, identity document images have to be captured using the device’s camera.", "type": "boolean" }, "require_matching_selfie": { "description": "Capture a face image and perform a [selfie check](https://stripe.com/docs/identity/verification-checks?type=selfie) comparing a photo ID and a picture of your user’s face. [Learn more](https://stripe.com/docs/identity/selfie).", "type": "boolean" } }, "title": "document_options", "type": "object", "x-stripeMostCommon": [ "allowed_types", "require_id_number", "require_live_capture", "require_matching_selfie" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Options that apply to the [document check](https://stripe.com/docs/identity/verification-checks?type=document)." } }, "title": "session_options_param", "type": "object", "x-stripeMostCommon": [ "document", "duplicate", "email", "matching", "phone", "phone_otp", "phone_records" ] }, "provided_details": { "description": "Details provided about the user being verified. These details may be shown to the user.", "properties": { "email": { "description": "Email of user being verified", "type": "string" }, "phone": { "description": "Phone number of user being verified", "type": "string" } }, "title": "provided_details_param", "type": "object", "x-stripeMostCommon": [ "address", "dob", "email", "name", "phone" ] }, "related_customer": { "description": "Customer ID", "maxLength": 5000, "type": "string" }, "related_customer_account": { "description": "Token referencing a Customer Account resource.", "maxLength": 5000, "type": "string" }, "related_person": { "description": "Tokens referencing a Person resource and it's associated account.", "properties": { "account": { "description": "A token representing a connected account. If provided, the person parameter is also required and must be associated with the account.", "maxLength": 5000, "type": "string" }, "person": { "description": "A token referencing a Person resource that this verification is being used to verify.", "maxLength": 5000, "type": "string" } }, "required": [ "account", "person" ], "title": "related_person_param", "type": "object", "x-stripeMostCommon": [ "account", "person" ] }, "return_url": { "description": "The URL that the user will be redirected to upon completing the verification flow.", "type": "string" }, "type": { "description": "The type of [verification check](https://stripe.com/docs/identity/verification-checks) to be performed. You must provide a `type` if not passing `verification_flow`.", "enum": [ "document", "id_number" ], "type": "string", "x-stripeBypassValidation": true }, "verification_flow": { "description": "The ID of a verification flow from the Dashboard. See https://docs.stripe.com/identity/verification-flows.", "maxLength": 5000, "type": "string" } }, "type": "object", "x-stripeMostCommon": [ "client_reference_id", "metadata", "options", "provided_details", "related_customer", "related_customer_account", "related_person", "return_url", "type", "verification_flow" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/identity.verification_session" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a VerificationSession" } }, "/v1/identity/verification_sessions/{session}": { "get": { "description": "

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.

", "operationId": "GetIdentityVerificationSessionsSession", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "session", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/identity.verification_session" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a VerificationSession" }, "post": { "description": "

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.

", "operationId": "PostIdentityVerificationSessionsSession", "parameters": [ { "in": "path", "name": "session", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "options": { "explode": true, "style": "deepObject" }, "provided_details": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "options": { "description": "A set of options for the session’s verification checks.", "properties": { "document": { "anyOf": [ { "properties": { "allowed_types": { "description": "Array of strings of allowed identity document types. If the provided identity document isn’t one of the allowed types, the verification check will fail with a document_type_not_allowed error code.", "items": { "enum": [ "driving_license", "id_card", "passport" ], "type": "string" }, "type": "array" }, "require_id_number": { "description": "Collect an ID number and perform an [ID number check](https://stripe.com/docs/identity/verification-checks?type=id-number) with the document’s extracted name and date of birth.", "type": "boolean" }, "require_live_capture": { "description": "Disable image uploads, identity document images have to be captured using the device’s camera.", "type": "boolean" }, "require_matching_selfie": { "description": "Capture a face image and perform a [selfie check](https://stripe.com/docs/identity/verification-checks?type=selfie) comparing a photo ID and a picture of your user’s face. [Learn more](https://stripe.com/docs/identity/selfie).", "type": "boolean" } }, "title": "document_options", "type": "object", "x-stripeMostCommon": [ "allowed_types", "require_id_number", "require_live_capture", "require_matching_selfie" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Options that apply to the [document check](https://stripe.com/docs/identity/verification-checks?type=document)." } }, "title": "session_options_param", "type": "object", "x-stripeMostCommon": [ "document", "duplicate", "email", "matching", "phone", "phone_otp", "phone_records" ] }, "provided_details": { "description": "Details provided about the user being verified. These details may be shown to the user.", "properties": { "email": { "description": "Email of user being verified", "type": "string" }, "phone": { "description": "Phone number of user being verified", "type": "string" } }, "title": "provided_details_param", "type": "object", "x-stripeMostCommon": [ "address", "dob", "email", "name", "phone" ] }, "type": { "description": "The type of [verification check](https://stripe.com/docs/identity/verification-checks) to be performed.", "enum": [ "document", "id_number" ], "type": "string", "x-stripeBypassValidation": true } }, "type": "object", "x-stripeMostCommon": [ "metadata", "options", "provided_details", "type" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/identity.verification_session" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a VerificationSession" } }, "/v1/identity/verification_sessions/{session}/cancel": { "post": { "description": "

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.

", "operationId": "PostIdentityVerificationSessionsSessionCancel", "parameters": [ { "in": "path", "name": "session", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/identity.verification_session" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Cancel a VerificationSession" } }, "/v1/identity/verification_sessions/{session}/redact": { "post": { "description": "

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 redaction process may take up to four days. When the redaction process is in progress, the\nVerificationSession’s redaction.status field will be set to processing; when the process is\nfinished, it will change to redacted and an identity.verification_session.redacted event\nwill be emitted.

\n\n

Redaction is irreversible. Redacted objects are still accessible in the Stripe API, but all the\nfields that contain personal data will be replaced by the string [redacted] or a similar\nplaceholder. The metadata field will also be erased. Redacted objects cannot be updated or\nused for any purpose.

\n\n

Learn more.

", "operationId": "PostIdentityVerificationSessionsSessionRedact", "parameters": [ { "in": "path", "name": "session", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/identity.verification_session" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Redact a VerificationSession" } }, "/v1/invoice_payments": { "get": { "description": "

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

", "operationId": "GetInvoicePayments", "parameters": [ { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "The identifier of the invoice whose payments to return.", "in": "query", "name": "invoice", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "The payment details of the invoice payments to return.", "explode": true, "in": "query", "name": "payment", "required": false, "schema": { "properties": { "payment_intent": { "description": "Only return invoice payments associated by this payment intent ID.", "maxLength": 5000, "type": "string" }, "payment_record": { "description": "Only return invoice payments associated by this payment record ID.", "maxLength": 5000, "type": "string" }, "type": { "description": "Only return invoice payments associated by this payment type.", "enum": [ "payment_intent", "payment_record" ], "type": "string" } }, "required": [ "type" ], "title": "payment_param", "type": "object", "x-stripeMostCommon": [ "payment_intent", "payment_record", "type" ] }, "style": "deepObject" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "The status of the invoice payments to return.", "in": "query", "name": "status", "required": false, "schema": { "enum": [ "canceled", "open", "paid" ], "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/invoice_payment" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "InvoicesPaymentsListInvoicePayments", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all payments for an invoice" } }, "/v1/invoice_payments/{invoice_payment}": { "get": { "description": "

Retrieves the invoice payment with the given ID.

", "operationId": "GetInvoicePaymentsInvoicePayment", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "invoice_payment", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/invoice_payment" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve an InvoicePayment" } }, "/v1/invoice_rendering_templates": { "get": { "description": "

List all templates, ordered by creation date, with the most recently created template appearing first.

", "operationId": "GetInvoiceRenderingTemplates", "parameters": [ { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "in": "query", "name": "status", "required": false, "schema": { "enum": [ "active", "archived" ], "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/invoice_rendering_template" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "InvoiceRenderingTemplatesList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all invoice rendering templates" } }, "/v1/invoice_rendering_templates/{template}": { "get": { "description": "

Retrieves an invoice rendering template with the given ID. It by default returns the latest version of the template. Optionally, specify a version to see previous versions.

", "operationId": "GetInvoiceRenderingTemplatesTemplate", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "template", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "in": "query", "name": "version", "required": false, "schema": { "type": "integer" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/invoice_rendering_template" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve an invoice rendering template" } }, "/v1/invoice_rendering_templates/{template}/archive": { "post": { "description": "

Updates the status of an invoice rendering template to ‘archived’ so no new Stripe objects (customers, invoices, etc.) can reference it. The template can also no longer be updated. However, if the template is already set on a Stripe object, it will continue to be applied on invoices generated by it.

", "operationId": "PostInvoiceRenderingTemplatesTemplateArchive", "parameters": [ { "in": "path", "name": "template", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/invoice_rendering_template" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Archive an invoice rendering template" } }, "/v1/invoice_rendering_templates/{template}/unarchive": { "post": { "description": "

Unarchive an invoice rendering template so it can be used on new Stripe objects again.

", "operationId": "PostInvoiceRenderingTemplatesTemplateUnarchive", "parameters": [ { "in": "path", "name": "template", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/invoice_rendering_template" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Unarchive an invoice rendering template" } }, "/v1/invoiceitems": { "get": { "description": "

Returns a list of your invoice items. Invoice items are returned sorted by creation date, with the most recently created invoice items appearing first.

", "operationId": "GetInvoiceitems", "parameters": [ { "description": "Only return invoice items that were created during the given date interval.", "explode": true, "in": "query", "name": "created", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "description": "Minimum value to filter by (exclusive)", "type": "integer" }, "gte": { "description": "Minimum value to filter by (inclusive)", "type": "integer" }, "lt": { "description": "Maximum value to filter by (exclusive)", "type": "integer" }, "lte": { "description": "Maximum value to filter by (inclusive)", "type": "integer" } }, "title": "range_query_specs", "type": "object", "x-stripeMostCommon": [ "gt", "gte", "lt", "lte" ] }, { "type": "integer" } ] }, "style": "deepObject" }, { "description": "The identifier of the customer whose invoice items to return. If none is provided, all invoice items will be returned.", "in": "query", "name": "customer", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "The identifier of the account whose invoice items to return. If none is provided, all invoice items will be returned.", "in": "query", "name": "customer_account", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "Only return invoice items belonging to this invoice. If none is provided, all invoice items will be returned. If specifying an invoice, no customer identifier is needed.", "in": "query", "name": "invoice", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "Set to `true` to only show pending invoice items, which are not yet attached to any invoices. Set to `false` to only show invoice items already attached to invoices. If unspecified, no filter is applied.", "in": "query", "name": "pending", "required": false, "schema": { "type": "boolean" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/invoiceitem" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/invoiceitems", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "InvoicesItemsList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all invoice items" }, "post": { "description": "

Creates an item to be added to a draft invoice (up to 250 items per invoice). If no invoice is specified, the item will be on the next invoice created for the customer specified.

", "operationId": "PostInvoiceitems", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "discounts": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "margins": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "period": { "explode": true, "style": "deepObject" }, "price_data": { "explode": true, "style": "deepObject" }, "pricing": { "explode": true, "style": "deepObject" }, "tax_code": { "explode": true, "style": "deepObject" }, "tax_rates": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "amount": { "description": "The integer amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. Passing in a negative `amount` will reduce the `amount_due` on the invoice.", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "customer": { "description": "The ID of the customer who will be billed when this invoice item is billed.", "maxLength": 5000, "type": "string" }, "customer_account": { "description": "The ID of the account who will be billed when this invoice item is billed.", "maxLength": 5000, "type": "string" }, "description": { "description": "An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking.", "maxLength": 5000, "type": "string" }, "discountable": { "description": "Controls whether discounts apply to this invoice item. Defaults to false for prorations or negative invoice items, and true for all other invoice items.", "type": "boolean" }, "discounts": { "anyOf": [ { "items": { "properties": { "coupon": { "description": "ID of the coupon to create a new discount for.", "maxLength": 5000, "type": "string" }, "discount": { "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", "maxLength": 5000, "type": "string" }, "discount_end": { "description": "Details to determine how long the discount should be applied for.", "properties": { "duration": { "description": "Time span for the redeemed discount.", "properties": { "interval": { "description": "Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.", "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "description": "The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.", "type": "integer" } }, "required": [ "interval", "interval_count" ], "title": "discount_end_duration_specs", "type": "object", "x-stripeMostCommon": [ "interval", "interval_count" ] }, "timestamp": { "description": "A precise Unix timestamp for the discount to end. Must be in the future.", "format": "unix-time", "type": "integer" }, "type": { "description": "The type of calculation made to determine when the discount ends.", "enum": [ "duration", "timestamp" ], "type": "string" } }, "required": [ "type" ], "title": "discount_end", "type": "object", "x-stripeMostCommon": [ "duration", "timestamp", "type" ] }, "promotion_code": { "description": "ID of the promotion code to create a new discount for.", "maxLength": 5000, "type": "string" } }, "title": "discounts_data_param", "type": "object", "x-stripeMostCommon": [ "coupon" ] }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The coupons and promotion codes to redeem into discounts for the invoice item or invoice line item." }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "invoice": { "description": "The ID of an existing invoice to add this invoice item to. For subscription invoices, when left blank, the invoice item will be added to the next upcoming scheduled invoice. For standalone invoices, the invoice item won't be automatically added unless you pass `pending_invoice_item_behavior: 'include'` when creating the invoice. This is useful when adding invoice items in response to an invoice.created webhook. You can only add invoice items to draft invoices and there is a maximum of 250 items per invoice.", "maxLength": 5000, "type": "string" }, "margins": { "description": "The ids of the margins to apply to the invoice item. When set, the `default_margins` on the invoice do not apply to this invoice item.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "period": { "description": "The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details.", "properties": { "end": { "description": "The end of the period, which must be greater than or equal to the start. This value is inclusive.", "format": "unix-time", "type": "integer" }, "start": { "description": "The start of the period. This value is inclusive.", "format": "unix-time", "type": "integer" } }, "required": [ "end", "start" ], "title": "period", "type": "object", "x-stripeMostCommon": [ "end", "start" ] }, "price_data": { "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.", "properties": { "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "product": { "description": "The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.", "maxLength": 5000, "type": "string" }, "tax_behavior": { "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.", "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" }, "unit_amount": { "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.", "type": "integer" }, "unit_amount_decimal": { "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", "format": "decimal", "type": "string" } }, "required": [ "currency", "product" ], "title": "one_time_price_data", "type": "object", "x-stripeMostCommon": [ "currency", "product", "unit_amount" ] }, "pricing": { "description": "The pricing information for the invoice item.", "properties": { "price": { "description": "The ID of the price object.", "maxLength": 5000, "type": "string" } }, "title": "pricing_param", "type": "object", "x-stripeMostCommon": [ "price" ] }, "quantity": { "description": "Non-negative integer. The quantity of units for the invoice item.", "type": "integer" }, "subscription": { "description": "The ID of a subscription to add this invoice item to. When left blank, the invoice item is added to the next upcoming scheduled invoice. When set, scheduled invoices for subscriptions other than the specified subscription will ignore the invoice item. Use this when you want to express that an invoice item has been accrued within the context of a particular subscription.", "maxLength": 5000, "type": "string" }, "tax_behavior": { "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.", "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" }, "tax_code": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "A [tax code](https://stripe.com/docs/tax/tax-categories) ID." }, "tax_rates": { "description": "The tax rates which apply to the invoice item. When set, the `default_tax_rates` on the invoice do not apply to this invoice item.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "unit_amount_decimal": { "description": "The decimal unit amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. This `unit_amount_decimal` will be multiplied by the quantity to get the full amount. Passing in a negative `unit_amount_decimal` will reduce the `amount_due` on the invoice. Accepts at most 12 decimal places.", "format": "decimal", "type": "string" } }, "type": "object", "x-stripeMostCommon": [ "amount", "currency", "customer", "description", "metadata", "period", "pricing" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/invoiceitem" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create an invoice item" } }, "/v1/invoiceitems/{invoiceitem}": { "delete": { "description": "

Deletes an invoice item, removing it from an invoice. Deleting invoice items is only possible when they’re not attached to invoices, or if it’s attached to a draft invoice.

", "operationId": "DeleteInvoiceitemsInvoiceitem", "parameters": [ { "in": "path", "name": "invoiceitem", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted_invoiceitem" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Delete an invoice item" }, "get": { "description": "

Retrieves the invoice item with the given ID.

", "operationId": "GetInvoiceitemsInvoiceitem", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "invoiceitem", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/invoiceitem" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve an invoice item" }, "post": { "description": "

Updates the amount or description of an invoice item on an upcoming invoice. Updating an invoice item is only possible before the invoice it’s attached to is closed.

", "operationId": "PostInvoiceitemsInvoiceitem", "parameters": [ { "in": "path", "name": "invoiceitem", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "discounts": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "margins": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "period": { "explode": true, "style": "deepObject" }, "price_data": { "explode": true, "style": "deepObject" }, "pricing": { "explode": true, "style": "deepObject" }, "tax_code": { "explode": true, "style": "deepObject" }, "tax_rates": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "amount": { "description": "The integer amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. If you want to apply a credit to the customer's account, pass a negative amount.", "type": "integer" }, "description": { "description": "An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking.", "maxLength": 5000, "type": "string" }, "discountable": { "description": "Controls whether discounts apply to this invoice item. Defaults to false for prorations or negative invoice items, and true for all other invoice items. Cannot be set to true for prorations.", "type": "boolean" }, "discounts": { "anyOf": [ { "items": { "properties": { "coupon": { "description": "ID of the coupon to create a new discount for.", "maxLength": 5000, "type": "string" }, "discount": { "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", "maxLength": 5000, "type": "string" }, "discount_end": { "description": "Details to determine how long the discount should be applied for.", "properties": { "duration": { "description": "Time span for the redeemed discount.", "properties": { "interval": { "description": "Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.", "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "description": "The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.", "type": "integer" } }, "required": [ "interval", "interval_count" ], "title": "discount_end_duration_specs", "type": "object", "x-stripeMostCommon": [ "interval", "interval_count" ] }, "timestamp": { "description": "A precise Unix timestamp for the discount to end. Must be in the future.", "format": "unix-time", "type": "integer" }, "type": { "description": "The type of calculation made to determine when the discount ends.", "enum": [ "duration", "timestamp" ], "type": "string" } }, "required": [ "type" ], "title": "discount_end", "type": "object", "x-stripeMostCommon": [ "duration", "timestamp", "type" ] }, "promotion_code": { "description": "ID of the promotion code to create a new discount for.", "maxLength": 5000, "type": "string" } }, "title": "discounts_data_param", "type": "object", "x-stripeMostCommon": [ "coupon" ] }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The coupons, promotion codes & existing discounts which apply to the invoice item or invoice line item. Item discounts are applied before invoice discounts. Pass an empty string to remove previously-defined discounts." }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "margins": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The ids of the margins to apply to the invoice item. When set, the `default_margins` on the invoice do not apply to this invoice item." }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "period": { "description": "The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details.", "properties": { "end": { "description": "The end of the period, which must be greater than or equal to the start. This value is inclusive.", "format": "unix-time", "type": "integer" }, "start": { "description": "The start of the period. This value is inclusive.", "format": "unix-time", "type": "integer" } }, "required": [ "end", "start" ], "title": "period", "type": "object", "x-stripeMostCommon": [ "end", "start" ] }, "price_data": { "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.", "properties": { "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "product": { "description": "The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.", "maxLength": 5000, "type": "string" }, "tax_behavior": { "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.", "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" }, "unit_amount": { "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.", "type": "integer" }, "unit_amount_decimal": { "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", "format": "decimal", "type": "string" } }, "required": [ "currency", "product" ], "title": "one_time_price_data", "type": "object", "x-stripeMostCommon": [ "currency", "product", "unit_amount" ] }, "pricing": { "description": "The pricing information for the invoice item.", "properties": { "price": { "description": "The ID of the price object.", "maxLength": 5000, "type": "string" } }, "title": "pricing_param", "type": "object", "x-stripeMostCommon": [ "price" ] }, "quantity": { "description": "Non-negative integer. The quantity of units for the invoice item.", "type": "integer" }, "tax_behavior": { "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.", "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" }, "tax_code": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "A [tax code](https://stripe.com/docs/tax/tax-categories) ID." }, "tax_rates": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The tax rates which apply to the invoice item. When set, the `default_tax_rates` on the invoice do not apply to this invoice item. Pass an empty string to remove previously-defined tax rates." }, "unit_amount_decimal": { "description": "The decimal unit amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. This `unit_amount_decimal` will be multiplied by the quantity to get the full amount. Passing in a negative `unit_amount_decimal` will reduce the `amount_due` on the invoice. Accepts at most 12 decimal places.", "format": "decimal", "type": "string" } }, "type": "object", "x-stripeMostCommon": [ "amount", "description", "metadata", "period", "pricing" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/invoiceitem" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update an invoice item" } }, "/v1/invoices": { "get": { "description": "

You can list all invoices, or list the invoices for a specific customer. The invoices are returned sorted by creation date, with the most recently created invoices appearing first.

", "operationId": "GetInvoices", "parameters": [ { "description": "The collection method of the invoice to retrieve. Either `charge_automatically` or `send_invoice`.", "in": "query", "name": "collection_method", "required": false, "schema": { "enum": [ "charge_automatically", "send_invoice" ], "type": "string" }, "style": "form" }, { "description": "Only return invoices that were created during the given date interval.", "explode": true, "in": "query", "name": "created", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "description": "Minimum value to filter by (exclusive)", "type": "integer" }, "gte": { "description": "Minimum value to filter by (inclusive)", "type": "integer" }, "lt": { "description": "Maximum value to filter by (exclusive)", "type": "integer" }, "lte": { "description": "Maximum value to filter by (inclusive)", "type": "integer" } }, "title": "range_query_specs", "type": "object", "x-stripeMostCommon": [ "gt", "gte", "lt", "lte" ] }, { "type": "integer" } ] }, "style": "deepObject" }, { "description": "Only return invoices for the customer specified by this customer ID.", "in": "query", "name": "customer", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Only return invoices for the account specified by this account ID.", "in": "query", "name": "customer_account", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "explode": true, "in": "query", "name": "due_date", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "description": "Minimum value to filter by (exclusive)", "type": "integer" }, "gte": { "description": "Minimum value to filter by (inclusive)", "type": "integer" }, "lt": { "description": "Maximum value to filter by (exclusive)", "type": "integer" }, "lte": { "description": "Maximum value to filter by (inclusive)", "type": "integer" } }, "title": "range_query_specs", "type": "object", "x-stripeMostCommon": [ "gt", "gte", "lt", "lte" ] }, { "type": "integer" } ] }, "style": "deepObject" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "The status of the invoice, one of `draft`, `open`, `paid`, `uncollectible`, or `void`. [Learn more](https://stripe.com/docs/billing/invoices/workflow#workflow-overview)", "in": "query", "name": "status", "required": false, "schema": { "enum": [ "draft", "open", "paid", "uncollectible", "void" ], "type": "string" }, "style": "form" }, { "description": "Only return invoices for the subscription specified by this subscription ID.", "in": "query", "name": "subscription", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/invoice" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/invoices", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "InvoicesResourceList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all invoices" }, "post": { "description": "

This endpoint creates a draft invoice for a given customer. The invoice remains a draft until you finalize the invoice, which allows you to pay or send the invoice to your customers.

", "operationId": "PostInvoices", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "account_tax_ids": { "explode": true, "style": "deepObject" }, "amounts_due": { "explode": true, "style": "deepObject" }, "automatic_tax": { "explode": true, "style": "deepObject" }, "custom_fields": { "explode": true, "style": "deepObject" }, "default_margins": { "explode": true, "style": "deepObject" }, "default_tax_rates": { "explode": true, "style": "deepObject" }, "discounts": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "from_invoice": { "explode": true, "style": "deepObject" }, "issuer": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "payment_settings": { "explode": true, "style": "deepObject" }, "rendering": { "explode": true, "style": "deepObject" }, "shipping_cost": { "explode": true, "style": "deepObject" }, "shipping_details": { "explode": true, "style": "deepObject" }, "transfer_data": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "account_tax_ids": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The account tax IDs associated with the invoice. Only editable when the invoice is a draft." }, "amounts_due": { "anyOf": [ { "items": { "properties": { "amount": { "description": "The amount in cents (or local equivalent).", "type": "integer" }, "days_until_due": { "description": "Number of days from when invoice is finalized until the payment is due.", "type": "integer" }, "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users.", "maxLength": 5000, "type": "string" }, "due_date": { "description": "Date on which a payment plan’s payment is due.", "format": "unix-time", "type": "integer" } }, "required": [ "amount", "description" ], "title": "payment_plan_amount_param", "type": "object", "x-stripeMostCommon": [ "amount", "days_until_due", "description", "due_date" ] }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "List of expected payments and corresponding due dates. Valid only for invoices where `collection_method=send_invoice`." }, "application_fee_amount": { "description": "A fee in cents (or local equivalent) that will be applied to the invoice and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees [documentation](https://stripe.com/docs/billing/invoices/connect#collecting-fees).", "type": "integer" }, "auto_advance": { "description": "Controls whether Stripe performs [automatic collection](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection) of the invoice. If `false`, the invoice's state doesn't automatically advance without an explicit action. Defaults to false.", "type": "boolean" }, "automatic_tax": { "description": "Settings for automatic tax lookup for this invoice.", "properties": { "enabled": { "description": "Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified [tax rates](https://stripe.com/docs/api/tax_rates), negative amounts, or `tax_behavior=unspecified`) cannot be added to automatic tax invoices.", "type": "boolean" }, "liability": { "description": "The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.", "properties": { "account": { "description": "The connected account being referenced when `type` is `account`.", "type": "string" }, "type": { "description": "Type of the account referenced in the request.", "enum": [ "account", "self" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "param", "type": "object", "x-stripeMostCommon": [ "account", "type" ] } }, "required": [ "enabled" ], "title": "automatic_tax_param", "type": "object", "x-stripeMostCommon": [ "enabled", "liability" ] }, "automatically_finalizes_at": { "description": "The time when this invoice should be scheduled to finalize (up to 5 years in the future). The invoice is finalized at this time if it's still in draft state.", "format": "unix-time", "type": "integer" }, "collection_method": { "description": "Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this invoice using the default source attached to the customer. When sending an invoice, Stripe will email this invoice to the customer with payment instructions. Defaults to `charge_automatically`.", "enum": [ "charge_automatically", "send_invoice" ], "type": "string" }, "currency": { "description": "The currency to create this invoice in. Defaults to that of `customer` if not specified.", "format": "currency", "type": "string" }, "custom_fields": { "anyOf": [ { "items": { "properties": { "name": { "description": "The name of the custom field. This may be up to 40 characters.", "maxLength": 40, "type": "string" }, "value": { "description": "The value of the custom field. This may be up to 140 characters.", "maxLength": 140, "type": "string" } }, "required": [ "name", "value" ], "title": "custom_field_params", "type": "object", "x-stripeMostCommon": [ "name", "value" ] }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "A list of up to 4 custom fields to be displayed on the invoice." }, "customer": { "description": "The ID of the customer who will be billed.", "maxLength": 5000, "type": "string" }, "customer_account": { "description": "The ID of the account who will be billed.", "maxLength": 5000, "type": "string" }, "days_until_due": { "description": "The number of days from when the invoice is created until it is due. Valid only for invoices where `collection_method=send_invoice`.", "type": "integer" }, "default_margins": { "description": "The ids of the margins to apply to the invoice. Can be overridden by line item `margins`.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "default_payment_method": { "description": "ID of the default payment method for the invoice. It must belong to the customer associated with the invoice. If not set, defaults to the subscription's default payment method, if any, or to the default payment method in the customer's invoice settings.", "maxLength": 5000, "type": "string" }, "default_source": { "description": "ID of the default payment source for the invoice. It must belong to the customer associated with the invoice and be in a chargeable state. If not set, defaults to the subscription's default source, if any, or to the customer's default source.", "maxLength": 5000, "type": "string" }, "default_tax_rates": { "description": "The tax rates that will apply to any line item that does not have `tax_rates` set.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard.", "maxLength": 1500, "type": "string" }, "discounts": { "anyOf": [ { "items": { "properties": { "coupon": { "description": "ID of the coupon to create a new discount for.", "maxLength": 5000, "type": "string" }, "discount": { "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", "maxLength": 5000, "type": "string" }, "discount_end": { "description": "Details to determine how long the discount should be applied for.", "properties": { "duration": { "description": "Time span for the redeemed discount.", "properties": { "interval": { "description": "Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.", "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "description": "The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.", "type": "integer" } }, "required": [ "interval", "interval_count" ], "title": "discount_end_duration_specs", "type": "object", "x-stripeMostCommon": [ "interval", "interval_count" ] }, "timestamp": { "description": "A precise Unix timestamp for the discount to end. Must be in the future.", "format": "unix-time", "type": "integer" }, "type": { "description": "The type of calculation made to determine when the discount ends.", "enum": [ "duration", "timestamp" ], "type": "string" } }, "required": [ "type" ], "title": "discount_end", "type": "object", "x-stripeMostCommon": [ "duration", "timestamp", "type" ] }, "promotion_code": { "description": "ID of the promotion code to create a new discount for.", "maxLength": 5000, "type": "string" } }, "title": "discounts_data_param", "type": "object", "x-stripeMostCommon": [ "coupon" ] }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The coupons and promotion codes to redeem into discounts for the invoice. If not specified, inherits the discount from the invoice's customer. Pass an empty string to avoid inheriting any discounts." }, "due_date": { "description": "The date on which payment for this invoice is due. Valid only for invoices where `collection_method=send_invoice`.", "format": "unix-time", "type": "integer" }, "effective_at": { "description": "The date when this invoice is in effect. Same as `finalized_at` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the invoice PDF and receipt.", "format": "unix-time", "type": "integer" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "footer": { "description": "Footer to be displayed on the invoice.", "maxLength": 5000, "type": "string" }, "from_invoice": { "description": "Revise an existing invoice. The new invoice will be created in `status=draft`. See the [revision documentation](https://stripe.com/docs/invoicing/invoice-revisions) for more details.", "properties": { "action": { "description": "The relation between the new invoice and the original invoice. Currently, only 'revision' is permitted", "enum": [ "revision" ], "maxLength": 5000, "type": "string" }, "invoice": { "description": "The `id` of the invoice that will be cloned.", "maxLength": 5000, "type": "string" } }, "required": [ "action", "invoice" ], "title": "from_invoice", "type": "object", "x-stripeMostCommon": [ "action", "invoice" ] }, "issuer": { "description": "The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.", "properties": { "account": { "description": "The connected account being referenced when `type` is `account`.", "type": "string" }, "type": { "description": "Type of the account referenced in the request.", "enum": [ "account", "self" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "param", "type": "object", "x-stripeMostCommon": [ "account", "type" ] }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "number": { "description": "Set the number for this invoice. If no number is present then a number will be assigned automatically when the invoice is finalized. In many markets, regulations require invoices to be unique, sequential and / or gapless. You are responsible for ensuring this is true across all your different invoicing systems in the event that you edit the invoice number using our API. If you use only Stripe for your invoices and do not change invoice numbers, Stripe handles this aspect of compliance for you automatically.", "maxLength": 26, "type": "string" }, "on_behalf_of": { "description": "The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://stripe.com/docs/billing/invoices/connect) documentation for details.", "type": "string" }, "payment_settings": { "description": "Configuration settings for the PaymentIntent that is generated when the invoice is finalized.", "properties": { "default_mandate": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "ID of the mandate to be used for this invoice. It must correspond to the payment method used to pay the invoice, including the invoice's default_payment_method or default_source, if set." }, "payment_method_options": { "description": "Payment-method-specific configuration to provide to the invoice’s PaymentIntent.", "properties": { "acss_debit": { "anyOf": [ { "properties": { "mandate_options": { "description": "Additional fields for Mandate creation", "properties": { "transaction_type": { "description": "Transaction type of the mandate.", "enum": [ "business", "personal" ], "type": "string" } }, "title": "mandate_options_param", "type": "object", "x-stripeMostCommon": [ "transaction_type" ] }, "verification_method": { "description": "Verification method for the intent", "enum": [ "automatic", "instant", "microdeposits" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "invoice_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "mandate_options", "verification_method" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If paying by `acss_debit`, this sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to the invoice’s PaymentIntent." }, "bancontact": { "anyOf": [ { "properties": { "preferred_language": { "description": "Preferred language of the Bancontact authorization page that the customer is redirected to.", "enum": [ "de", "en", "fr", "nl" ], "type": "string" } }, "title": "invoice_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "preferred_language" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If paying by `bancontact`, this sub-hash contains details about the Bancontact payment method options to pass to the invoice’s PaymentIntent." }, "card": { "anyOf": [ { "properties": { "installments": { "description": "Installment configuration for payments attempted on this invoice.\n\nFor more information, see the [installments integration guide](https://stripe.com/docs/payments/installments).", "properties": { "enabled": { "description": "Setting to true enables installments for this invoice.\nSetting to false will prevent any selected plan from applying to a payment.", "type": "boolean" }, "plan": { "anyOf": [ { "properties": { "count": { "description": "For `fixed_count` installment plans, this is required. It represents the number of installment payments your customer will make to their credit card.", "type": "integer" }, "interval": { "description": "For `fixed_count` installment plans, this is required. It represents the interval between installment payments your customer will make to their credit card.\nOne of `month`.", "enum": [ "month" ], "type": "string" }, "type": { "description": "Type of installment plan, one of `fixed_count`, `bonus`, or `revolving`.", "enum": [ "bonus", "fixed_count", "revolving" ], "type": "string" } }, "required": [ "type" ], "title": "installment_plan", "type": "object", "x-stripeMostCommon": [ "count", "interval", "type" ] }, { "enum": [ "" ], "type": "string" } ], "description": "The selected installment plan to use for this invoice." } }, "title": "installments_param", "type": "object", "x-stripeMostCommon": [ "enabled", "plan" ] }, "request_three_d_secure": { "description": "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.", "enum": [ "any", "automatic", "challenge" ], "type": "string" } }, "title": "invoice_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "installments", "request_three_d_secure" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If paying by `card`, this sub-hash contains details about the Card payment method options to pass to the invoice’s PaymentIntent." }, "customer_balance": { "anyOf": [ { "properties": { "bank_transfer": { "description": "Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`.", "properties": { "eu_bank_transfer": { "description": "Configuration for eu_bank_transfer funding type.", "properties": { "country": { "description": "The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`.", "maxLength": 5000, "type": "string" } }, "required": [ "country" ], "title": "eu_bank_transfer_param", "type": "object", "x-stripeMostCommon": [ "country" ] }, "type": { "description": "The bank transfer type that can be used for funding. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.", "type": "string" } }, "title": "bank_transfer_param", "type": "object", "x-stripeMostCommon": [ "eu_bank_transfer", "id_bank_transfer", "type" ] }, "funding_type": { "description": "The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.", "type": "string" } }, "title": "invoice_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "bank_transfer", "funding_type" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If paying by `customer_balance`, this sub-hash contains details about the Bank transfer payment method options to pass to the invoice’s PaymentIntent." }, "id_bank_transfer": { "anyOf": [ { "properties": {}, "title": "invoice_payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "If paying by `id_bank_transfer`, this sub-hash contains details about the Indonesia bank transfer payment method options to pass to the invoice’s PaymentIntent." }, "konbini": { "anyOf": [ { "properties": {}, "title": "invoice_payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "If paying by `konbini`, this sub-hash contains details about the Konbini payment method options to pass to the invoice’s PaymentIntent." }, "pix": { "anyOf": [ { "properties": { "amount_includes_iof": { "description": "Determines if the amount includes the IOF tax. Defaults to `never`.", "enum": [ "always", "never" ], "type": "string" } }, "title": "invoice_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "amount_includes_iof" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If paying by `pix`, this sub-hash contains details about the Pix payment method options to pass to the invoice’s PaymentIntent." }, "sepa_debit": { "anyOf": [ { "properties": {}, "title": "invoice_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "verification_method" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If paying by `sepa_debit`, this sub-hash contains details about the SEPA Direct Debit payment method options to pass to the invoice’s PaymentIntent." }, "upi": { "anyOf": [ { "properties": { "mandate_options": { "description": "Configuration options for setting up an eMandate", "properties": { "amount": { "description": "Amount to be charged for future payments.", "type": "integer" }, "amount_type": { "description": "One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.", "enum": [ "fixed", "maximum" ], "type": "string" }, "description": { "description": "A description of the mandate or subscription that is meant to be displayed to the customer.", "maxLength": 20, "type": "string" }, "end_date": { "description": "End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.", "format": "unix-time", "type": "integer" } }, "title": "invoice_payment_method_options_mandate_options_param", "type": "object", "x-stripeMostCommon": [ "amount", "amount_type", "description", "end_date" ] } }, "title": "invoice_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "mandate_options" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If paying by `upi`, this sub-hash contains details about the UPI payment method options to pass to the invoice’s PaymentIntent." }, "us_bank_account": { "anyOf": [ { "properties": { "financial_connections": { "description": "Additional fields for Financial Connections Session creation", "properties": { "filters": { "description": "Provide filters for the linked accounts that the customer can select for the payment method.", "properties": { "account_subcategories": { "description": "The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.", "items": { "enum": [ "checking", "savings" ], "type": "string" }, "type": "array" }, "institution": { "description": "ID of the institution to use to filter for selectable accounts.", "maxLength": 5000, "type": "string" } }, "title": "invoice_linked_account_options_filters_param", "type": "object", "x-stripeMostCommon": [ "account_subcategories", "institution" ] }, "permissions": { "description": "The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.", "items": { "enum": [ "balances", "ownership", "payment_method", "transactions" ], "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true }, "type": "array" }, "prefetch": { "description": "List of data features that you would like to retrieve upon account creation.", "items": { "enum": [ "balances", "inferred_balances", "ownership", "transactions" ], "type": "string", "x-stripeBypassValidation": true }, "type": "array" } }, "title": "invoice_linked_account_options_param", "type": "object", "x-stripeMostCommon": [ "filters", "permissions", "prefetch" ] }, "verification_method": { "description": "Verification method for the intent", "enum": [ "automatic", "instant", "microdeposits" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "invoice_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "financial_connections", "verification_method" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If paying by `us_bank_account`, this sub-hash contains details about the ACH direct debit payment method options to pass to the invoice’s PaymentIntent." } }, "title": "payment_method_options", "type": "object", "x-stripeMostCommon": [ "acss_debit", "bancontact", "card", "customer_balance", "id_bank_transfer", "konbini", "pix", "sepa_debit", "upi", "us_bank_account" ] }, "payment_method_types": { "anyOf": [ { "items": { "enum": [ "ach_credit_transfer", "ach_debit", "acss_debit", "affirm", "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", "boleto", "card", "cashapp", "crypto", "custom", "customer_balance", "eps", "fpx", "giropay", "grabpay", "id_bank_transfer", "ideal", "jp_credit_transfer", "kakao_pay", "klarna", "konbini", "kr_card", "link", "multibanco", "naver_pay", "nz_bank_account", "p24", "payco", "paynow", "paypal", "pix", "promptpay", "revolut_pay", "sepa_credit_transfer", "sepa_debit", "sofort", "stripe_balance", "swish", "upi", "us_bank_account", "wechat_pay" ], "type": "string", "x-stripeBypassValidation": true }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The list of payment method types (e.g. card) to provide to the invoice’s PaymentIntent. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your [invoice template settings](https://dashboard.stripe.com/settings/billing/invoice)." } }, "title": "payment_settings", "type": "object", "x-stripeMostCommon": [ "default_mandate", "payment_method_configuration", "payment_method_options", "payment_method_types" ] }, "pending_invoice_items_behavior": { "description": "How to handle pending invoice items on invoice creation. Defaults to `exclude` if the parameter is omitted.", "enum": [ "exclude", "include" ], "type": "string", "x-stripeBypassValidation": true }, "rendering": { "description": "The rendering-related settings that control how the invoice is displayed on customer-facing surfaces such as PDF and Hosted Invoice Page.", "properties": { "amount_tax_display": { "description": "How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. One of `exclude_tax` or `include_inclusive_tax`. `include_inclusive_tax` will include inclusive tax (and exclude exclusive tax) in invoice PDF amounts. `exclude_tax` will exclude all tax (inclusive and exclusive alike) from invoice PDF amounts.", "enum": [ "", "exclude_tax", "include_inclusive_tax" ], "type": "string" }, "pdf": { "description": "Invoice pdf rendering options", "properties": { "page_size": { "description": "Page size for invoice PDF. Can be set to `a4`, `letter`, or `auto`.\n If set to `auto`, invoice PDF page size defaults to `a4` for customers with\n Japanese locale and `letter` for customers with other locales.", "enum": [ "a4", "auto", "letter" ], "type": "string" } }, "title": "rendering_pdf_param", "type": "object", "x-stripeMostCommon": [ "page_size" ] }, "template": { "description": "ID of the invoice rendering template to use for this invoice.", "maxLength": 5000, "type": "string" }, "template_version": { "anyOf": [ { "type": "integer" }, { "enum": [ "" ], "type": "string" } ], "description": "The specific version of invoice rendering template to use for this invoice." } }, "title": "rendering_param", "type": "object", "x-stripeMostCommon": [ "amount_tax_display", "custom_text", "invoice_title", "pdf", "summary_items_data", "template", "template_version" ] }, "shipping_cost": { "description": "Settings for the cost of shipping for this invoice.", "properties": { "shipping_rate": { "description": "The ID of the shipping rate to use for this order.", "maxLength": 5000, "type": "string" }, "shipping_rate_data": { "description": "Parameters to create a new ad-hoc shipping rate for this order.", "properties": { "delivery_estimate": { "description": "The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.", "properties": { "maximum": { "description": "The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.", "properties": { "unit": { "description": "A unit of time.", "enum": [ "business_day", "day", "hour", "month", "week" ], "type": "string" }, "value": { "description": "Must be greater than 0.", "type": "integer" } }, "required": [ "unit", "value" ], "title": "delivery_estimate_bound", "type": "object", "x-stripeMostCommon": [ "unit", "value" ] }, "minimum": { "description": "The lower bound of the estimated range. If empty, represents no lower bound.", "properties": { "unit": { "description": "A unit of time.", "enum": [ "business_day", "day", "hour", "month", "week" ], "type": "string" }, "value": { "description": "Must be greater than 0.", "type": "integer" } }, "required": [ "unit", "value" ], "title": "delivery_estimate_bound", "type": "object", "x-stripeMostCommon": [ "unit", "value" ] } }, "title": "delivery_estimate", "type": "object", "x-stripeMostCommon": [ "maximum", "minimum" ] }, "display_name": { "description": "The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.", "maxLength": 100, "type": "string" }, "fixed_amount": { "description": "Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`.", "properties": { "amount": { "description": "A non-negative integer in cents representing how much to charge.", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "currency_options": { "additionalProperties": { "properties": { "amount": { "description": "A non-negative integer in cents representing how much to charge.", "type": "integer" }, "tax_behavior": { "description": "Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.", "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" } }, "required": [ "amount" ], "title": "currency_option", "type": "object", "x-stripeMostCommon": [ "amount", "tax_behavior" ] }, "description": "Shipping rates defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).", "type": "object" } }, "required": [ "amount", "currency" ], "title": "fixed_amount", "type": "object", "x-stripeMostCommon": [ "amount", "currency", "currency_options" ] }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "tax_behavior": { "description": "Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.", "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" }, "tax_code": { "description": "A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`.", "type": "string" }, "type": { "description": "The type of calculation to use on the shipping rate.", "enum": [ "fixed_amount" ], "type": "string" } }, "required": [ "display_name" ], "title": "method_params", "type": "object", "x-stripeMostCommon": [ "display_name", "fixed_amount", "metadata", "tax_behavior", "tax_code", "type" ] } }, "title": "shipping_cost", "type": "object", "x-stripeMostCommon": [ "shipping_rate", "shipping_rate_data" ] }, "shipping_details": { "description": "Shipping details for the invoice. The Invoice PDF will use the `shipping_details` value if it is set, otherwise the PDF will render the shipping address from the customer.", "properties": { "address": { "description": "Shipping address", "properties": { "city": { "description": "City, district, suburb, town, or village.", "maxLength": 5000, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Address line 1 (e.g., street, PO Box, or company name).", "maxLength": 5000, "type": "string" }, "line2": { "description": "Address line 2 (e.g., apartment, suite, unit, or building).", "maxLength": 5000, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "State, county, province, or region.", "maxLength": 5000, "type": "string" } }, "title": "optional_fields_address", "type": "object", "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state" ] }, "name": { "description": "Recipient name.", "maxLength": 5000, "type": "string" }, "phone": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Recipient phone (including extension)" } }, "required": [ "address", "name" ], "title": "recipient_shipping_with_optional_fields_address", "type": "object", "x-stripeMostCommon": [ "address", "name", "phone" ] }, "statement_descriptor": { "description": "Extra information about a charge for the customer's credit card statement. It must contain at least one letter. If not specified and this invoice is part of a subscription, the default `statement_descriptor` will be set to the first subscription item's product's `statement_descriptor`.", "maxLength": 22, "type": "string" }, "subscription": { "description": "The ID of the subscription to invoice, if any. If set, the created invoice will only include pending invoice items for that subscription. The subscription's billing cycle and regular subscription events won't be affected.", "maxLength": 5000, "type": "string" }, "transfer_data": { "description": "If specified, the funds from the invoice will be transferred to the destination and the ID of the resulting transfer will be found on the invoice's charge.", "properties": { "amount": { "description": "The amount that will be transferred automatically when the invoice is paid. If no amount is set, the full amount is transferred.", "type": "integer" }, "destination": { "description": "ID of an existing, connected Stripe account.", "type": "string" } }, "required": [ "destination" ], "title": "transfer_data_specs", "type": "object", "x-stripeMostCommon": [ "amount", "destination" ] } }, "type": "object", "x-stripeMostCommon": [ "auto_advance", "automatic_tax", "collection_method", "customer", "description", "metadata", "subscription" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/invoice" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create an invoice" } }, "/v1/invoices/create_preview": { "post": { "description": "

At any time, you can preview the upcoming invoice for a subscription or subscription schedule. This will show you all the charges that are pending, including subscription renewal charges, invoice item charges, etc. It will also show you any discounts that are applicable to the invoice.

\n\n

You can also preview the effects of creating or updating a subscription or subscription schedule, including a preview of any prorations that will take place. To ensure that the actual proration is calculated exactly the same as the previewed proration, you should pass the subscription_details.proration_date parameter when doing the actual subscription update.

\n\n

The recommended way to get only the prorations being previewed on the invoice is to consider line items where parent.subscription_item_details.proration is true.

\n\n

Note that when you are viewing an upcoming invoice, you are simply viewing a preview – the invoice has not yet been created. As such, the upcoming invoice will not show up in invoice listing calls, and you cannot use the API to pay or edit the invoice. If you want to change the amount that your customer will be billed, you can add, remove, or update pending invoice items, or update the customer’s discount.

\n\n

Note: Currency conversion calculations use the latest exchange rates. Exchange rates may vary between the time of the preview and the time of the actual invoice creation. Learn more

", "operationId": "PostInvoicesCreatePreview", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "automatic_tax": { "explode": true, "style": "deepObject" }, "customer_details": { "explode": true, "style": "deepObject" }, "discounts": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "invoice_items": { "explode": true, "style": "deepObject" }, "issuer": { "explode": true, "style": "deepObject" }, "on_behalf_of": { "explode": true, "style": "deepObject" }, "schedule_details": { "explode": true, "style": "deepObject" }, "subscription_details": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "automatic_tax": { "description": "Settings for automatic tax lookup for this invoice preview.", "properties": { "enabled": { "description": "Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified [tax rates](https://stripe.com/docs/api/tax_rates), negative amounts, or `tax_behavior=unspecified`) cannot be added to automatic tax invoices.", "type": "boolean" }, "liability": { "description": "The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.", "properties": { "account": { "description": "The connected account being referenced when `type` is `account`.", "type": "string" }, "type": { "description": "Type of the account referenced in the request.", "enum": [ "account", "self" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "param", "type": "object", "x-stripeMostCommon": [ "account", "type" ] } }, "required": [ "enabled" ], "title": "automatic_tax_param", "type": "object", "x-stripeMostCommon": [ "enabled", "liability" ] }, "currency": { "description": "The currency to preview this invoice in. Defaults to that of `customer` if not specified.", "format": "currency", "type": "string" }, "customer": { "description": "The identifier of the customer whose upcoming invoice you'd like to retrieve. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set.", "maxLength": 5000, "type": "string" }, "customer_account": { "description": "The identifier of the account whose upcoming invoice you'd like to retrieve. If `automatic_tax` is enabled then one of `customer`, `customer_account`, `customer_details`, `subscription`, or `schedule` must be set.", "maxLength": 5000, "type": "string" }, "customer_details": { "description": "Details about the customer you want to invoice or overrides for an existing customer. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set.", "properties": { "address": { "anyOf": [ { "properties": { "city": { "description": "City, district, suburb, town, or village.", "maxLength": 5000, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Address line 1 (e.g., street, PO Box, or company name).", "maxLength": 5000, "type": "string" }, "line2": { "description": "Address line 2 (e.g., apartment, suite, unit, or building).", "maxLength": 5000, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "State, county, province, or region.", "maxLength": 5000, "type": "string" } }, "title": "optional_fields_address", "type": "object", "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state" ] }, { "enum": [ "" ], "type": "string" } ], "description": "The customer's address." }, "shipping": { "anyOf": [ { "properties": { "address": { "description": "Customer shipping address.", "properties": { "city": { "description": "City, district, suburb, town, or village.", "maxLength": 5000, "type": "string" }, "country": { "description": "A freeform text field for the country. However, in order to activate some tax features, the format should be a two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Address line 1 (e.g., street, PO Box, or company name).", "maxLength": 5000, "type": "string" }, "line2": { "description": "Address line 2 (e.g., apartment, suite, unit, or building).", "maxLength": 5000, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "State, county, province, or region.", "maxLength": 5000, "type": "string" } }, "title": "optional_fields_customer_address", "type": "object", "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state" ] }, "name": { "description": "Customer name.", "maxLength": 5000, "type": "string" }, "phone": { "description": "Customer phone (including extension).", "maxLength": 5000, "type": "string" } }, "required": [ "address", "name" ], "title": "customer_shipping", "type": "object", "x-stripeMostCommon": [ "address", "name", "phone" ] }, { "enum": [ "" ], "type": "string" } ], "description": "The customer's shipping information. Appears on invoices emailed to this customer." }, "tax": { "description": "Tax details about the customer.", "properties": { "ip_address": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "A recent IP address of the customer used for tax reporting and tax location inference. Stripe recommends updating the IP address when a new PaymentMethod is attached or the address field on the customer is updated. We recommend against updating this field more frequently since it could result in unexpected tax location/reporting outcomes." } }, "title": "tax_param", "type": "object", "x-stripeMostCommon": [ "ip_address" ] }, "tax_exempt": { "description": "The customer's tax exemption. One of `none`, `exempt`, or `reverse`.", "enum": [ "", "exempt", "none", "reverse" ], "type": "string" }, "tax_ids": { "description": "The customer's tax IDs.", "items": { "properties": { "type": { "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `aw_tin`, `az_tin`, `ba_tin`, `bb_tin`, `bd_bin`, `bf_ifu`, `bg_uic`, `bh_vat`, `bj_ifu`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cm_niu`, `cn_tin`, `co_nit`, `cr_tin`, `cv_nif`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `et_tin`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kg_tin`, `kh_tin`, `kr_brn`, `kz_bin`, `la_tin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin`", "enum": [ "ad_nrt", "ae_trn", "al_tin", "am_tin", "ao_tin", "ar_cuit", "au_abn", "au_arn", "aw_tin", "az_tin", "ba_tin", "bb_tin", "bd_bin", "bf_ifu", "bg_uic", "bh_vat", "bj_ifu", "bo_tin", "br_cnpj", "br_cpf", "bs_tin", "by_tin", "ca_bn", "ca_gst_hst", "ca_pst_bc", "ca_pst_mb", "ca_pst_sk", "ca_qst", "cd_nif", "ch_uid", "ch_vat", "cl_tin", "cm_niu", "cn_tin", "co_nit", "cr_tin", "cv_nif", "de_stn", "do_rcn", "ec_ruc", "eg_tin", "es_cif", "et_tin", "eu_oss_vat", "eu_vat", "gb_vat", "ge_vat", "gn_nif", "hk_br", "hr_oib", "hu_tin", "id_npwp", "il_vat", "in_gst", "is_vat", "jp_cn", "jp_rn", "jp_trn", "ke_pin", "kg_tin", "kh_tin", "kr_brn", "kz_bin", "la_tin", "li_uid", "li_vat", "ma_vat", "md_vat", "me_pib", "mk_vat", "mr_nif", "mx_rfc", "my_frp", "my_itn", "my_sst", "ng_tin", "no_vat", "no_voec", "np_pan", "nz_gst", "om_vat", "pe_ruc", "ph_tin", "ro_tin", "rs_pib", "ru_inn", "ru_kpp", "sa_vat", "sg_gst", "sg_uen", "si_tin", "sn_ninea", "sr_fin", "sv_nit", "th_vat", "tj_tin", "tr_tin", "tw_vat", "tz_vat", "ua_vat", "ug_tin", "us_ein", "uy_ruc", "uz_tin", "uz_vat", "ve_rif", "vn_tin", "za_vat", "zm_tin", "zw_tin" ], "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true }, "value": { "description": "Value of the tax ID.", "type": "string" } }, "required": [ "type", "value" ], "title": "data_params", "type": "object", "x-stripeMostCommon": [ "type", "value" ] }, "type": "array" } }, "title": "customer_details_param", "type": "object", "x-stripeMostCommon": [ "address", "shipping", "tax", "tax_exempt", "tax_ids" ] }, "discounts": { "anyOf": [ { "items": { "properties": { "coupon": { "description": "ID of the coupon to create a new discount for.", "maxLength": 5000, "type": "string" }, "discount": { "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", "maxLength": 5000, "type": "string" }, "discount_end": { "description": "Details to determine how long the discount should be applied for.", "properties": { "duration": { "description": "Time span for the redeemed discount.", "properties": { "interval": { "description": "Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.", "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "description": "The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.", "type": "integer" } }, "required": [ "interval", "interval_count" ], "title": "discount_end_duration_specs", "type": "object", "x-stripeMostCommon": [ "interval", "interval_count" ] }, "timestamp": { "description": "A precise Unix timestamp for the discount to end. Must be in the future.", "format": "unix-time", "type": "integer" }, "type": { "description": "The type of calculation made to determine when the discount ends.", "enum": [ "duration", "timestamp" ], "type": "string" } }, "required": [ "type" ], "title": "discount_end", "type": "object", "x-stripeMostCommon": [ "duration", "timestamp", "type" ] }, "promotion_code": { "description": "ID of the promotion code to create a new discount for.", "maxLength": 5000, "type": "string" } }, "title": "discounts_data_param", "type": "object", "x-stripeMostCommon": [ "coupon", "settings" ] }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The coupons to redeem into discounts for the invoice preview. If not specified, inherits the discount from the subscription or customer. This works for both coupons directly applied to an invoice and coupons applied to a subscription. Pass an empty string to avoid inheriting any discounts." }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "invoice_items": { "description": "List of invoice items to add or update in the upcoming invoice preview (up to 250).", "items": { "properties": { "amount": { "description": "The integer amount in cents (or local equivalent) of previewed invoice item.", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). Only applicable to new invoice items.", "format": "currency", "type": "string" }, "description": { "description": "An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking.", "maxLength": 5000, "type": "string" }, "discountable": { "description": "Explicitly controls whether discounts apply to this invoice item. Defaults to true, except for negative invoice items.", "type": "boolean" }, "discounts": { "anyOf": [ { "items": { "properties": { "coupon": { "description": "ID of the coupon to create a new discount for.", "maxLength": 5000, "type": "string" }, "discount": { "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", "maxLength": 5000, "type": "string" }, "discount_end": { "description": "Details to determine how long the discount should be applied for.", "properties": { "duration": { "description": "Time span for the redeemed discount.", "properties": { "interval": { "description": "Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.", "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "description": "The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.", "type": "integer" } }, "required": [ "interval", "interval_count" ], "title": "discount_end_duration_specs", "type": "object", "x-stripeMostCommon": [ "interval", "interval_count" ] }, "timestamp": { "description": "A precise Unix timestamp for the discount to end. Must be in the future.", "format": "unix-time", "type": "integer" }, "type": { "description": "The type of calculation made to determine when the discount ends.", "enum": [ "duration", "timestamp" ], "type": "string" } }, "required": [ "type" ], "title": "discount_end", "type": "object", "x-stripeMostCommon": [ "duration", "timestamp", "type" ] }, "promotion_code": { "description": "ID of the promotion code to create a new discount for.", "maxLength": 5000, "type": "string" } }, "title": "discounts_data_param", "type": "object", "x-stripeMostCommon": [ "coupon" ] }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The coupons to redeem into discounts for the invoice item in the preview." }, "invoiceitem": { "description": "The ID of the invoice item to update in preview. If not specified, a new invoice item will be added to the preview of the upcoming invoice.", "maxLength": 5000, "type": "string" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "period": { "description": "The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details.", "properties": { "end": { "description": "The end of the period, which must be greater than or equal to the start. This value is inclusive.", "format": "unix-time", "type": "integer" }, "start": { "description": "The start of the period. This value is inclusive.", "format": "unix-time", "type": "integer" } }, "required": [ "end", "start" ], "title": "period", "type": "object", "x-stripeMostCommon": [ "end", "start" ] }, "price": { "description": "The ID of the price object. One of `price` or `price_data` is required.", "maxLength": 5000, "type": "string" }, "price_data": { "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.", "properties": { "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "product": { "description": "The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.", "maxLength": 5000, "type": "string" }, "tax_behavior": { "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.", "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" }, "unit_amount": { "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.", "type": "integer" }, "unit_amount_decimal": { "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", "format": "decimal", "type": "string" } }, "required": [ "currency", "product" ], "title": "one_time_price_data", "type": "object", "x-stripeMostCommon": [ "currency", "product", "unit_amount" ] }, "quantity": { "description": "Non-negative integer. The quantity of units for the invoice item.", "type": "integer" }, "tax_behavior": { "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.", "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" }, "tax_code": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "A [tax code](https://stripe.com/docs/tax/tax-categories) ID." }, "tax_rates": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The tax rates that apply to the item. When set, any `default_tax_rates` do not apply to this item." }, "unit_amount": { "description": "The integer unit amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. This unit_amount will be multiplied by the quantity to get the full amount. If you want to apply a credit to the customer's account, pass a negative unit_amount.", "type": "integer" }, "unit_amount_decimal": { "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", "format": "decimal", "type": "string" } }, "title": "invoice_item_preview_params", "type": "object", "x-stripeMostCommon": [ "amount", "currency", "description", "discountable", "discounts", "invoiceitem", "metadata", "period", "price", "quantity", "tax_behavior", "tax_code", "tax_rates", "unit_amount", "unit_amount_decimal" ] }, "type": "array" }, "issuer": { "description": "The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.", "properties": { "account": { "description": "The connected account being referenced when `type` is `account`.", "type": "string" }, "type": { "description": "Type of the account referenced in the request.", "enum": [ "account", "self" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "param", "type": "object", "x-stripeMostCommon": [ "account", "type" ] }, "on_behalf_of": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://stripe.com/docs/billing/invoices/connect) documentation for details." }, "preview_mode": { "description": "Customizes the types of values to include when calculating the invoice. Defaults to `next` if unspecified.", "enum": [ "next", "recurring" ], "type": "string" }, "schedule": { "description": "The identifier of the schedule whose upcoming invoice you'd like to retrieve. Cannot be used with subscription or subscription fields.", "maxLength": 5000, "type": "string" }, "schedule_details": { "description": "The schedule creation or modification params to apply as a preview. Cannot be used with `subscription` or `subscription_` prefixed fields.", "properties": { "amendments": { "description": "Changes to apply to the phases of the subscription schedule, in the order provided.", "items": { "properties": { "amendment_end": { "description": "Details to identify the end of the time range modified by the proposed change. If not supplied, the amendment is considered a point-in-time operation that only affects the exact timestamp at `amendment_start`, and a restricted set of attributes is supported on the amendment.", "properties": { "discount_end": { "description": "Use the `end` time of a given discount.", "properties": { "discount": { "description": "The ID of a specific discount.", "maxLength": 5000, "type": "string" } }, "required": [ "discount" ], "title": "discount_end_specs", "type": "object", "x-stripeMostCommon": [ "discount" ] }, "duration": { "description": "Time span for the amendment starting from the `amendment_start`.", "properties": { "interval": { "description": "Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.", "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "description": "The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.", "type": "integer" } }, "required": [ "interval", "interval_count" ], "title": "duration_specs", "type": "object", "x-stripeMostCommon": [ "interval", "interval_count" ] }, "timestamp": { "description": "A precise Unix timestamp for the amendment to end. Must be after the `amendment_start`.", "format": "unix-time", "type": "integer" }, "type": { "description": "Select one of three ways to pass the `amendment_end`.", "enum": [ "discount_end", "duration", "schedule_end", "timestamp", "trial_end", "trial_start", "upcoming_invoice" ], "type": "string" } }, "required": [ "type" ], "title": "specs", "type": "object", "x-stripeMostCommon": [ "discount_end", "duration", "timestamp", "type" ] }, "amendment_start": { "description": "Details to identify the earliest timestamp where the proposed change should take effect.", "properties": { "amendment_end": { "description": "Details of another amendment in the same array, immediately after which this amendment should begin.", "properties": { "index": { "description": "The position of the previous amendment in the `amendments` array after which this amendment should begin. Indexes start from 0 and must be less than the index of the current amendment in the array.", "type": "integer" } }, "required": [ "index" ], "title": "amendment_end_index_specs", "type": "object", "x-stripeMostCommon": [ "index" ] }, "discount_end": { "description": "Use the `end` time of a given discount.", "properties": { "discount": { "description": "The ID of a specific discount.", "maxLength": 5000, "type": "string" } }, "required": [ "discount" ], "title": "discount_end_specs", "type": "object", "x-stripeMostCommon": [ "discount" ] }, "timestamp": { "description": "A precise Unix timestamp for the amendment to start.", "format": "unix-time", "type": "integer" }, "type": { "description": "Select one of three ways to pass the `amendment_start`.", "enum": [ "amendment_end", "discount_end", "now", "schedule_end", "timestamp", "trial_end", "trial_start", "upcoming_invoice" ], "type": "string" } }, "required": [ "type" ], "title": "specs", "type": "object", "x-stripeMostCommon": [ "amendment_end", "discount_end", "timestamp", "type" ] }, "billing_cycle_anchor": { "description": "For point-in-time amendments (having no `amendment_end`), this attribute lets you set or remove whether the subscription's billing cycle anchor is reset at the `amendment_start` timestamp.For time-span based amendments (having both `amendment_start` and `amendment_end`), the only value valid is `automatic`, which removes any previously configured billing cycle anchor resets scheduled to occur during the window of time spanned by the amendment.", "enum": [ "amendment_start", "automatic" ], "type": "string" }, "discount_actions": { "description": "Changes to the coupons being redeemed or discounts being applied during the amendment time span.", "items": { "properties": { "add": { "description": "Details of the discount to add.", "properties": { "coupon": { "description": "The coupon code to redeem.", "maxLength": 5000, "type": "string" }, "discount": { "description": "An ID of an existing discount for a coupon that was already redeemed.", "maxLength": 5000, "type": "string" }, "discount_end": { "description": "Details to determine how long the discount should be applied for.", "properties": { "type": { "description": "The type of calculation made to determine when the discount ends.", "enum": [ "amendment_end" ], "type": "string" } }, "required": [ "type" ], "title": "amendment_discount_end", "type": "object", "x-stripeMostCommon": [ "type" ] }, "index": { "description": "The index, starting at 0, at which to position the new discount. When not supplied, Stripe defaults to appending the discount to the end of the `discounts` array.", "type": "integer" }, "promotion_code": { "description": "The promotion code to redeem.", "maxLength": 5000, "type": "string" } }, "title": "add_discount_specs", "type": "object", "x-stripeMostCommon": [ "coupon", "discount", "discount_end", "index", "promotion_code" ] }, "remove": { "description": "Details of the discount to remove.", "properties": { "coupon": { "description": "The coupon code to remove from the `discounts` array.", "maxLength": 5000, "type": "string" }, "discount": { "description": "The ID of a discount to remove from the `discounts` array.", "maxLength": 5000, "type": "string" }, "promotion_code": { "description": "The ID of a promotion code to remove from the `discounts` array.", "maxLength": 5000, "type": "string" } }, "title": "remove_discount_specs", "type": "object", "x-stripeMostCommon": [ "coupon", "discount", "promotion_code" ] }, "set": { "description": "Details of the discount to replace the existing discounts with.", "properties": { "coupon": { "description": "The coupon code to replace the `discounts` array with.", "maxLength": 5000, "type": "string" }, "discount": { "description": "An ID of an existing discount to replace the `discounts` array with.", "maxLength": 5000, "type": "string" }, "promotion_code": { "description": "An ID of an existing promotion code to replace the `discounts` array with.", "maxLength": 5000, "type": "string" } }, "title": "set_discount_specs", "type": "object", "x-stripeMostCommon": [ "coupon", "discount", "promotion_code" ] }, "type": { "description": "Determines the type of discount action.", "enum": [ "add", "remove", "set" ], "type": "string" } }, "required": [ "type" ], "title": "specs", "type": "object", "x-stripeMostCommon": [ "add", "remove", "set", "type" ] }, "type": "array" }, "item_actions": { "description": "Changes to the subscription items during the amendment time span.", "items": { "properties": { "add": { "description": "Details of the subscription item to add. If an item with the same `price` exists, it will be replaced by this new item. Otherwise, it adds the new item.", "properties": { "discounts": { "description": "The discounts applied to the item. Subscription item discounts are applied before subscription discounts.", "items": { "properties": { "coupon": { "description": "ID of the coupon to create a new discount for.", "maxLength": 5000, "type": "string" }, "discount": { "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", "maxLength": 5000, "type": "string" }, "discount_end": { "description": "Details to determine how long the discount should be applied for.", "properties": { "duration": { "description": "Time span for the redeemed discount.", "properties": { "interval": { "description": "Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.", "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "description": "The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.", "type": "integer" } }, "required": [ "interval", "interval_count" ], "title": "discount_end_duration_specs", "type": "object", "x-stripeMostCommon": [ "interval", "interval_count" ] }, "timestamp": { "description": "A precise Unix timestamp for the discount to end. Must be in the future.", "format": "unix-time", "type": "integer" }, "type": { "description": "The type of calculation made to determine when the discount ends.", "enum": [ "duration", "timestamp" ], "type": "string" } }, "required": [ "type" ], "title": "discount_end", "type": "object", "x-stripeMostCommon": [ "duration", "timestamp", "type" ] }, "promotion_code": { "description": "ID of the promotion code to create a new discount for.", "maxLength": 5000, "type": "string" } }, "title": "discounts_data_param", "type": "object", "x-stripeMostCommon": [ "coupon" ] }, "type": "array" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "price": { "description": "The ID of the price object.", "maxLength": 5000, "type": "string" }, "quantity": { "description": "Quantity for this item.", "type": "integer" }, "tax_rates": { "description": "The tax rates that apply to this subscription item. When set, the `default_tax_rates` on the subscription do not apply to this `subscription_item`.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "trial": { "description": "Options that configure the trial on the subscription item.", "properties": { "converts_to": { "description": "List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. Currently only supports at most 1 price ID.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "type": { "description": "Determines the type of trial for this item.", "enum": [ "free", "paid" ], "type": "string" } }, "required": [ "type" ], "title": "trial_specs", "type": "object", "x-stripeMostCommon": [ "converts_to", "type" ] } }, "required": [ "price" ], "title": "add_item_specs", "type": "object", "x-stripeMostCommon": [ "discounts", "metadata", "price", "quantity", "tax_rates", "trial" ] }, "remove": { "description": "Details of the subscription item to remove.", "properties": { "price": { "description": "ID of a price to remove.", "maxLength": 5000, "type": "string" } }, "required": [ "price" ], "title": "remove_item_specs", "type": "object", "x-stripeMostCommon": [ "price" ] }, "set": { "description": "Details of the subscription item to replace the existing items with. If an item with the `set[price]` already exists, the `items` array is not cleared. Instead, all of the other `set` properties that are passed in this request will replace the existing values for the configuration item.", "properties": { "discounts": { "description": "If an item with the `price` already exists, passing this will override the `discounts` array on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `discounts`.", "items": { "properties": { "coupon": { "description": "ID of the coupon to create a new discount for.", "maxLength": 5000, "type": "string" }, "discount": { "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", "maxLength": 5000, "type": "string" }, "discount_end": { "description": "Details to determine how long the discount should be applied for.", "properties": { "duration": { "description": "Time span for the redeemed discount.", "properties": { "interval": { "description": "Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.", "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "description": "The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.", "type": "integer" } }, "required": [ "interval", "interval_count" ], "title": "discount_end_duration_specs", "type": "object", "x-stripeMostCommon": [ "interval", "interval_count" ] }, "timestamp": { "description": "A precise Unix timestamp for the discount to end. Must be in the future.", "format": "unix-time", "type": "integer" }, "type": { "description": "The type of calculation made to determine when the discount ends.", "enum": [ "duration", "timestamp" ], "type": "string" } }, "required": [ "type" ], "title": "discount_end", "type": "object", "x-stripeMostCommon": [ "duration", "timestamp", "type" ] }, "promotion_code": { "description": "ID of the promotion code to create a new discount for.", "maxLength": 5000, "type": "string" } }, "title": "discounts_data_param", "type": "object", "x-stripeMostCommon": [ "coupon" ] }, "type": "array" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "If an item with the `price` already exists, passing this will override the `metadata` on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `metadata`.", "type": "object" }, "price": { "description": "The ID of the price object.", "maxLength": 5000, "type": "string" }, "quantity": { "description": "If an item with the `price` already exists, passing this will override the quantity on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `quantity`.", "type": "integer" }, "tax_rates": { "description": "If an item with the `price` already exists, passing this will override the `tax_rates` array on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `tax_rates`.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "trial": { "description": "If an item with the `price` already exists, passing this will override the `trial` configuration on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `trial`.", "properties": { "converts_to": { "description": "List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. Currently only supports at most 1 price ID.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "type": { "description": "Determines the type of trial for this item.", "enum": [ "free", "paid" ], "type": "string" } }, "required": [ "type" ], "title": "trial_specs", "type": "object", "x-stripeMostCommon": [ "converts_to", "type" ] } }, "required": [ "price" ], "title": "set_item_specs", "type": "object", "x-stripeMostCommon": [ "discounts", "metadata", "price", "quantity", "tax_rates", "trial" ] }, "type": { "description": "Determines the type of item action.", "enum": [ "add", "remove", "set" ], "type": "string" } }, "required": [ "type" ], "title": "specs", "type": "object", "x-stripeMostCommon": [ "add", "remove", "set", "type" ] }, "type": "array" }, "metadata_actions": { "description": "Instructions for how to modify phase metadata", "items": { "properties": { "add": { "additionalProperties": { "type": "string" }, "description": "Key-value pairs to add to schedule phase metadata. These values will merge with existing schedule phase metadata.", "type": "object" }, "remove": { "description": "Keys to remove from schedule phase metadata.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "set": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Key-value pairs to set as schedule phase metadata. Existing schedule phase metadata will be overwritten." }, "type": { "description": "Select one of three ways to update phase-level `metadata` on subscription schedules.", "enum": [ "add", "remove", "set" ], "type": "string" } }, "required": [ "type" ], "title": "specs", "type": "object", "x-stripeMostCommon": [ "add", "remove", "set", "type" ] }, "type": "array" }, "proration_behavior": { "description": "Changes to how Stripe handles prorations during the amendment time span. Affects if and how prorations are created when a future phase starts. In cases where the amendment changes the currently active phase, it is used to determine whether or how to prorate now, at the time of the request. Also supported as a point-in-time operation when `amendment_end` is `null`.", "enum": [ "always_invoice", "create_prorations", "none" ], "type": "string" }, "set_pause_collection": { "description": "Defines how to pause collection for the underlying subscription throughout the duration of the amendment.", "properties": { "set": { "description": "Details of the pause_collection behavior to apply to the amendment.", "properties": { "behavior": { "description": "The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.", "enum": [ "keep_as_draft", "mark_uncollectible", "void" ], "type": "string" } }, "required": [ "behavior" ], "title": "pause_collection_params", "type": "object", "x-stripeMostCommon": [ "behavior" ] }, "type": { "description": "Determines the type of the pause_collection amendment.", "enum": [ "remove", "set" ], "type": "string" } }, "required": [ "type" ], "title": "specs", "type": "object", "x-stripeMostCommon": [ "set", "type" ] }, "set_schedule_end": { "description": "Ends the subscription schedule early as dictated by either the accompanying amendment's start or end.", "enum": [ "amendment_end", "amendment_start" ], "type": "string" }, "trial_settings": { "description": "Settings related to subscription trials.", "properties": { "end_behavior": { "description": "Defines how the subscription should behave when a trial ends.", "properties": { "prorate_up_front": { "description": "Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.", "enum": [ "defer", "include" ], "type": "string" } }, "title": "end_behavior_specs", "type": "object", "x-stripeMostCommon": [ "prorate_up_front" ] } }, "title": "trial_settings_specs", "type": "object", "x-stripeMostCommon": [ "end_behavior" ] } }, "required": [ "amendment_start" ], "title": "amendment_specs", "type": "object", "x-stripeMostCommon": [ "amendment_end", "amendment_start", "billing_cycle_anchor", "discount_actions", "item_actions", "metadata_actions", "proration_behavior", "set_pause_collection", "set_schedule_end", "trial_settings" ] }, "type": "array" }, "billing_behavior": { "description": "Configures when the subscription schedule generates prorations for phase transitions. Possible values are `prorate_on_next_phase` or `prorate_up_front` with the default being `prorate_on_next_phase`. `prorate_on_next_phase` will apply phase changes and generate prorations at transition time. `prorate_up_front` will bill for all phases within the current billing cycle up front.", "enum": [ "prorate_on_next_phase", "prorate_up_front" ], "type": "string" }, "billing_mode": { "description": "Controls how prorations and invoices for subscriptions are calculated and orchestrated.", "properties": { "type": { "description": "Controls the calculation and orchestration of prorations and invoices for subscriptions.", "enum": [ "classic", "flexible" ], "type": "string" } }, "required": [ "type" ], "title": "billing_mode", "type": "object", "x-stripeMostCommon": [ "flexible", "type" ] }, "end_behavior": { "description": "Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running. `cancel` will end the subscription schedule and cancel the underlying subscription.", "enum": [ "cancel", "release" ], "type": "string" }, "phases": { "description": "List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the `end_date` of one phase will always equal the `start_date` of the next phase.", "items": { "properties": { "add_invoice_items": { "description": "A list of prices and quantities that will generate invoice items appended to the next invoice for this phase. You may pass up to 20 items.", "items": { "properties": { "discounts": { "description": "The coupons to redeem into discounts for the item.", "items": { "properties": { "coupon": { "description": "ID of the coupon to create a new discount for.", "maxLength": 5000, "type": "string" }, "discount": { "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", "maxLength": 5000, "type": "string" }, "discount_end": { "description": "Details to determine how long the discount should be applied for.", "properties": { "duration": { "description": "Time span for the redeemed discount.", "properties": { "interval": { "description": "Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.", "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "description": "The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.", "type": "integer" } }, "required": [ "interval", "interval_count" ], "title": "discount_end_duration_specs", "type": "object", "x-stripeMostCommon": [ "interval", "interval_count" ] }, "timestamp": { "description": "A precise Unix timestamp for the discount to end. Must be in the future.", "format": "unix-time", "type": "integer" }, "type": { "description": "The type of calculation made to determine when the discount ends.", "enum": [ "duration", "timestamp" ], "type": "string" } }, "required": [ "type" ], "title": "discount_end", "type": "object", "x-stripeMostCommon": [ "duration", "timestamp", "type" ] }, "promotion_code": { "description": "ID of the promotion code to create a new discount for.", "maxLength": 5000, "type": "string" } }, "title": "discounts_data_param", "type": "object", "x-stripeMostCommon": [ "coupon" ] }, "type": "array" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "period": { "description": "The period associated with this invoice item. If not set, `period.start.type` defaults to `max_item_period_start` and `period.end.type` defaults to `min_item_period_end`.", "properties": { "end": { "description": "End of the invoice item period.", "properties": { "timestamp": { "description": "A precise Unix timestamp for the end of the invoice item period. Must be greater than or equal to `period.start`.", "format": "unix-time", "type": "integer" }, "type": { "description": "Select how to calculate the end of the invoice item period.", "enum": [ "min_item_period_end", "phase_end", "timestamp" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "invoice_item_period_end", "type": "object", "x-stripeMostCommon": [ "timestamp", "type" ] }, "start": { "description": "Start of the invoice item period.", "properties": { "timestamp": { "description": "A precise Unix timestamp for the start of the invoice item period. Must be less than or equal to `period.end`.", "format": "unix-time", "type": "integer" }, "type": { "description": "Select how to calculate the start of the invoice item period.", "enum": [ "max_item_period_start", "phase_start", "timestamp" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "invoice_item_period_start", "type": "object", "x-stripeMostCommon": [ "timestamp", "type" ] } }, "required": [ "end", "start" ], "title": "invoice_item_period", "type": "object", "x-stripeMostCommon": [ "end", "start" ] }, "price": { "description": "The ID of the price object. One of `price` or `price_data` is required.", "maxLength": 5000, "type": "string" }, "price_data": { "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.", "properties": { "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "product": { "description": "The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.", "maxLength": 5000, "type": "string" }, "tax_behavior": { "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.", "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" }, "unit_amount": { "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge or a negative integer representing the amount to credit to the customer.", "type": "integer" }, "unit_amount_decimal": { "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", "format": "decimal", "type": "string" } }, "required": [ "currency", "product" ], "title": "one_time_price_data_with_negative_amounts", "type": "object", "x-stripeMostCommon": [ "currency", "product", "unit_amount" ] }, "quantity": { "description": "Quantity for this item. Defaults to 1.", "type": "integer" }, "tax_rates": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The tax rates which apply to the item. When set, the `default_tax_rates` do not apply to this item." } }, "title": "add_invoice_item_entry", "type": "object", "x-stripeMostCommon": [ "price", "quantity" ], "x-stripeParam": { "class_name": "AddInvoiceItem" } }, "type": "array" }, "application_fee_percent": { "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).", "type": "number" }, "automatic_tax": { "description": "Automatic tax settings for this phase.", "properties": { "enabled": { "description": "Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription.", "type": "boolean" }, "liability": { "description": "The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.", "properties": { "account": { "description": "The connected account being referenced when `type` is `account`.", "type": "string" }, "type": { "description": "Type of the account referenced in the request.", "enum": [ "account", "self" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "param", "type": "object", "x-stripeMostCommon": [ "account", "type" ] } }, "required": [ "enabled" ], "title": "automatic_tax_config", "type": "object", "x-stripeMostCommon": [ "enabled", "liability" ] }, "billing_cycle_anchor": { "description": "Can be set to `phase_start` to set the anchor to the start of the phase or `automatic` to automatically change it if needed. Cannot be set to `phase_start` if this phase specifies a trial. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).", "enum": [ "automatic", "phase_start" ], "type": "string" }, "billing_thresholds": { "anyOf": [ { "properties": { "amount_gte": { "description": "Monetary threshold that triggers the subscription to advance to a new billing period", "type": "integer" }, "reset_billing_cycle_anchor": { "description": "Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged.", "type": "boolean" } }, "title": "billing_thresholds_param", "type": "object", "x-stripeMostCommon": [ "amount_gte", "reset_billing_cycle_anchor" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds." }, "collection_method": { "description": "Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically` on creation.", "enum": [ "charge_automatically", "send_invoice" ], "type": "string" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "default_payment_method": { "description": "ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings.", "maxLength": 5000, "type": "string" }, "default_tax_rates": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will set the Subscription's [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates), which means they will be the Invoice's [`default_tax_rates`](https://stripe.com/docs/api/invoices/create#create_invoice-default_tax_rates) for any Invoices issued by the Subscription during this Phase." }, "description": { "anyOf": [ { "maxLength": 500, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs." }, "discounts": { "anyOf": [ { "items": { "properties": { "coupon": { "description": "ID of the coupon to create a new discount for.", "maxLength": 5000, "type": "string" }, "discount": { "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", "maxLength": 5000, "type": "string" }, "discount_end": { "description": "Details to determine how long the discount should be applied for.", "properties": { "duration": { "description": "Time span for the redeemed discount.", "properties": { "interval": { "description": "Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.", "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "description": "The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.", "type": "integer" } }, "required": [ "interval", "interval_count" ], "title": "discount_end_duration_specs", "type": "object", "x-stripeMostCommon": [ "interval", "interval_count" ] }, "timestamp": { "description": "A precise Unix timestamp for the discount to end. Must be in the future.", "format": "unix-time", "type": "integer" }, "type": { "description": "The type of calculation made to determine when the discount ends.", "enum": [ "duration", "timestamp" ], "type": "string" } }, "required": [ "type" ], "title": "discount_end", "type": "object", "x-stripeMostCommon": [ "duration", "timestamp", "type" ] }, "promotion_code": { "description": "ID of the promotion code to create a new discount for.", "maxLength": 5000, "type": "string" } }, "title": "discounts_data_param", "type": "object", "x-stripeMostCommon": [ "coupon" ] }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The coupons to redeem into discounts for the schedule phase. If not specified, inherits the discount from the subscription's customer. Pass an empty string to avoid inheriting any discounts." }, "duration": { "description": "The number of intervals the phase should last. If set, `end_date` must not be set.", "properties": { "interval": { "description": "Specifies phase duration. Either `day`, `week`, `month` or `year`.", "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "description": "The multiplier applied to the interval.", "type": "integer" } }, "required": [ "interval" ], "title": "duration_params", "type": "object", "x-stripeMostCommon": [ "interval", "interval_count" ] }, "end_date": { "anyOf": [ { "format": "unix-time", "type": "integer" }, { "enum": [ "now" ], "maxLength": 5000, "type": "string" } ], "description": "The date at which this phase of the subscription schedule ends. If set, `iterations` must not be set." }, "invoice_settings": { "description": "All invoices will be billed using the specified settings.", "properties": { "account_tax_ids": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule." }, "days_until_due": { "description": "Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`.", "type": "integer" }, "issuer": { "description": "The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.", "properties": { "account": { "description": "The connected account being referenced when `type` is `account`.", "type": "string" }, "type": { "description": "Type of the account referenced in the request.", "enum": [ "account", "self" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "param", "type": "object", "x-stripeMostCommon": [ "account", "type" ] } }, "title": "invoice_settings", "type": "object", "x-stripeMostCommon": [ "account_tax_ids", "custom_fields", "days_until_due", "description", "footer", "issuer", "send_hosted_payment_email", "supported_payment_methods" ] }, "items": { "description": "List of configuration items, each with an attached price, to apply during this phase of the subscription schedule.", "items": { "properties": { "billing_thresholds": { "anyOf": [ { "properties": { "usage_gte": { "description": "Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte))", "type": "integer" } }, "required": [ "usage_gte" ], "title": "item_billing_thresholds_param", "type": "object", "x-stripeMostCommon": [ "usage_gte" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds." }, "discounts": { "anyOf": [ { "items": { "properties": { "coupon": { "description": "ID of the coupon to create a new discount for.", "maxLength": 5000, "type": "string" }, "discount": { "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", "maxLength": 5000, "type": "string" }, "discount_end": { "description": "Details to determine how long the discount should be applied for.", "properties": { "duration": { "description": "Time span for the redeemed discount.", "properties": { "interval": { "description": "Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.", "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "description": "The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.", "type": "integer" } }, "required": [ "interval", "interval_count" ], "title": "discount_end_duration_specs", "type": "object", "x-stripeMostCommon": [ "interval", "interval_count" ] }, "timestamp": { "description": "A precise Unix timestamp for the discount to end. Must be in the future.", "format": "unix-time", "type": "integer" }, "type": { "description": "The type of calculation made to determine when the discount ends.", "enum": [ "duration", "timestamp" ], "type": "string" } }, "required": [ "type" ], "title": "discount_end", "type": "object", "x-stripeMostCommon": [ "duration", "timestamp", "type" ] }, "promotion_code": { "description": "ID of the promotion code to create a new discount for.", "maxLength": 5000, "type": "string" } }, "title": "discounts_data_param", "type": "object", "x-stripeMostCommon": [ "coupon" ] }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The coupons to redeem into discounts for the subscription item." }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a configuration item. Metadata on a configuration item will update the underlying subscription item's `metadata` when the phase is entered, adding new keys and replacing existing keys. Individual keys in the subscription item's `metadata` can be unset by posting an empty value to them in the configuration item's `metadata`. To unset all keys in the subscription item's `metadata`, update the subscription item directly or unset every key individually from the configuration item's `metadata`.", "type": "object" }, "plan": { "description": "The plan ID to subscribe to. You may specify the same ID in `plan` and `price`.", "maxLength": 5000, "type": "string" }, "price": { "description": "The ID of the price object.", "maxLength": 5000, "type": "string" }, "price_data": { "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.", "properties": { "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "product": { "description": "The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.", "maxLength": 5000, "type": "string" }, "recurring": { "description": "The recurring components of a price such as `interval` and `interval_count`.", "properties": { "interval": { "description": "Specifies billing frequency. Either `day`, `week`, `month` or `year`.", "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "description": "The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).", "type": "integer" } }, "required": [ "interval" ], "title": "recurring_adhoc", "type": "object", "x-stripeMostCommon": [ "interval" ] }, "tax_behavior": { "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.", "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" }, "unit_amount": { "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.", "type": "integer" }, "unit_amount_decimal": { "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", "format": "decimal", "type": "string" } }, "required": [ "currency", "product", "recurring" ], "title": "recurring_price_data", "type": "object", "x-stripeMostCommon": [ "currency", "product", "recurring", "unit_amount" ] }, "quantity": { "description": "Quantity for the given price. Can be set only if the price's `usage_type` is `licensed` and not `metered`.", "type": "integer" }, "tax_rates": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates." }, "trial": { "description": "Options that configure the trial on the subscription item.", "properties": { "converts_to": { "description": "List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. Currently only supports at most 1 price ID.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "type": { "description": "Determines the type of trial for this item.", "enum": [ "free", "paid" ], "type": "string" } }, "required": [ "type" ], "title": "trial_specs", "type": "object", "x-stripeMostCommon": [ "converts_to", "type" ] } }, "title": "configuration_item_params", "type": "object", "x-stripeMostCommon": [ "billing_thresholds", "current_trial", "discounts", "metadata", "plan", "price", "quantity", "tax_rates", "trial" ] }, "type": "array" }, "iterations": { "description": "Integer representing the multiplier applied to the price interval. For example, `iterations=2` applied to a price with `interval=month` and `interval_count=3` results in a phase of duration `2 * 3 months = 6 months`. If set, `end_date` must not be set. This parameter is deprecated and will be removed in a future version. Use `duration` instead.", "type": "integer" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a phase. Metadata on a schedule's phase will update the underlying subscription's `metadata` when the phase is entered, adding new keys and replacing existing keys in the subscription's `metadata`. Individual keys in the subscription's `metadata` can be unset by posting an empty value to them in the phase's `metadata`. To unset all keys in the subscription's `metadata`, update the subscription directly or unset every key individually from the phase's `metadata`.", "type": "object" }, "on_behalf_of": { "description": "The account on behalf of which to charge, for each of the associated subscription's invoices.", "type": "string" }, "pause_collection": { "description": "If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://stripe.com/docs/billing/subscriptions/pause-payment).", "properties": { "behavior": { "description": "The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.", "enum": [ "keep_as_draft", "mark_uncollectible", "void" ], "type": "string" } }, "required": [ "behavior" ], "title": "pause_collection_params", "type": "object", "x-stripeMostCommon": [ "behavior" ] }, "proration_behavior": { "description": "Controls whether the subscription schedule should create [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when transitioning to this phase if there is a difference in billing configuration. It's different from the request-level [proration_behavior](https://stripe.com/docs/api/subscription_schedules/update#update_subscription_schedule-proration_behavior) parameter which controls what happens if the update request affects the billing configuration (item price, quantity, etc.) of the current phase.", "enum": [ "always_invoice", "create_prorations", "none" ], "type": "string" }, "start_date": { "anyOf": [ { "format": "unix-time", "type": "integer" }, { "enum": [ "now" ], "maxLength": 5000, "type": "string" } ], "description": "The date at which this phase of the subscription schedule starts or `now`. Must be set on the first phase." }, "transfer_data": { "description": "The data with which to automatically create a Transfer for each of the associated subscription's invoices.", "properties": { "amount_percent": { "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination.", "type": "number" }, "destination": { "description": "ID of an existing, connected Stripe account.", "type": "string" } }, "required": [ "destination" ], "title": "transfer_data_specs", "type": "object", "x-stripeMostCommon": [ "amount_percent", "destination" ] }, "trial": { "description": "If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.", "type": "boolean" }, "trial_continuation": { "description": "Specify trial behavior when crossing phase boundaries", "enum": [ "continue", "none" ], "type": "string" }, "trial_end": { "anyOf": [ { "format": "unix-time", "type": "integer" }, { "enum": [ "now" ], "maxLength": 5000, "type": "string" } ], "description": "Sets the phase to trialing from the start date to this date. Must be before the phase end date, can not be combined with `trial`" }, "trial_settings": { "description": "Settings related to subscription trials.", "properties": { "end_behavior": { "description": "Defines how the subscription should behave when a trial ends.", "properties": { "prorate_up_front": { "description": "Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.", "enum": [ "defer", "include" ], "type": "string" } }, "title": "end_behavior_specs", "type": "object", "x-stripeMostCommon": [ "prorate_up_front" ] } }, "title": "trial_settings_specs", "type": "object", "x-stripeMostCommon": [ "end_behavior" ] } }, "required": [ "items" ], "title": "phase_configuration_params", "type": "object", "x-stripeMostCommon": [ "add_invoice_items", "application_fee_percent", "automatic_tax", "billing_cycle_anchor", "billing_thresholds", "collection_method", "currency", "default_payment_method", "default_tax_rates", "description", "discounts", "duration", "end_date", "invoice_settings", "items", "iterations", "metadata", "on_behalf_of", "pause_collection", "proration_behavior", "start_date", "tax_filing_currency", "transfer_data", "trial", "trial_continuation", "trial_end", "trial_settings" ] }, "type": "array" }, "prebilling": { "anyOf": [ { "items": { "properties": { "bill_until": { "description": "The end of the prebilled time period.", "properties": { "amendment_end": { "description": "End the prebilled period when a specified amendment ends.", "properties": { "index": { "description": "The position of the amendment in the `amendments` array at which prebilling should end. Indexes start from 0 and must be less than the total number of supplied amendments.", "type": "integer" } }, "required": [ "index" ], "title": "amendment_end_specs", "type": "object", "x-stripeMostCommon": [ "index" ] }, "duration": { "description": "Time span for prebilling, starting from `bill_from`.", "properties": { "interval": { "description": "Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.", "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "description": "The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.", "type": "integer" } }, "required": [ "interval", "interval_count" ], "title": "duration_specs", "type": "object", "x-stripeMostCommon": [ "interval", "interval_count" ] }, "timestamp": { "description": "End the prebilled period at a precise integer timestamp, starting from the Unix epoch.", "format": "unix-time", "type": "integer" }, "type": { "description": "Select one of several ways to pass the `bill_until` value.", "enum": [ "amendment_end", "duration", "schedule_end", "timestamp" ], "type": "string" } }, "required": [ "type" ], "title": "specs", "type": "object", "x-stripeMostCommon": [ "amendment_end", "duration", "timestamp", "type" ] }, "iterations": { "description": "This is used to determine the number of billing cycles to prebill.", "type": "integer" } }, "title": "prebilling_params", "type": "object", "x-stripeMostCommon": [ "bill_until", "iterations" ] }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "Provide any time periods to bill in advance." }, "proration_behavior": { "description": "In cases where the `schedule_details` params update the currently active phase, specifies if and how to prorate at the time of the request.", "enum": [ "always_invoice", "create_prorations", "none" ], "type": "string" } }, "title": "schedule_details_params", "type": "object", "x-stripeMostCommon": [ "amendments", "billing_behavior", "billing_mode", "billing_schedules", "end_behavior", "phases", "prebilling", "proration_behavior" ] }, "subscription": { "description": "The identifier of the subscription for which you'd like to retrieve the upcoming invoice. If not provided, but a `subscription_details.items` is provided, you will preview creating a subscription with those items. If neither `subscription` nor `subscription_details.items` is provided, you will retrieve the next upcoming invoice from among the customer's subscriptions.", "maxLength": 5000, "type": "string" }, "subscription_details": { "description": "The subscription creation or modification params to apply as a preview. Cannot be used with `schedule` or `schedule_details` fields.", "properties": { "billing_cycle_anchor": { "anyOf": [ { "enum": [ "now", "unchanged" ], "maxLength": 5000, "type": "string" }, { "format": "unix-time", "type": "integer" } ], "description": "For new subscriptions, a future timestamp to anchor the subscription's [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle). This is used to determine the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. For existing subscriptions, the value can only be set to `now` or `unchanged`." }, "billing_mode": { "description": "Controls how prorations and invoices for subscriptions are calculated and orchestrated.", "properties": { "type": { "description": "Controls the calculation and orchestration of prorations and invoices for subscriptions.", "enum": [ "classic", "flexible" ], "type": "string" } }, "required": [ "type" ], "title": "billing_mode", "type": "object", "x-stripeMostCommon": [ "flexible", "type" ] }, "cancel_at": { "anyOf": [ { "format": "unix-time", "type": "integer" }, { "enum": [ "" ], "type": "string" }, { "enum": [ "max_period_end", "min_period_end" ], "type": "string" } ], "description": "A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period." }, "cancel_at_period_end": { "description": "Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`.", "type": "boolean" }, "cancel_now": { "description": "This simulates the subscription being canceled or expired immediately.", "type": "boolean" }, "default_tax_rates": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "If provided, the invoice returned will preview updating or creating a subscription with these default tax rates. The default tax rates will apply to any line item that does not have `tax_rates` set." }, "items": { "description": "A list of up to 20 subscription items, each with an attached price.", "items": { "properties": { "billing_thresholds": { "anyOf": [ { "properties": { "usage_gte": { "description": "Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte))", "type": "integer" } }, "required": [ "usage_gte" ], "title": "item_billing_thresholds_param", "type": "object", "x-stripeMostCommon": [ "usage_gte" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds." }, "clear_usage": { "description": "Delete all usage for a given subscription item. You must pass this when deleting a usage records subscription item. `clear_usage` has no effect if the plan has a billing meter attached.", "type": "boolean" }, "deleted": { "description": "A flag that, if set to `true`, will delete the specified item.", "type": "boolean" }, "discounts": { "anyOf": [ { "items": { "properties": { "coupon": { "description": "ID of the coupon to create a new discount for.", "maxLength": 5000, "type": "string" }, "discount": { "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", "maxLength": 5000, "type": "string" }, "discount_end": { "description": "Details to determine how long the discount should be applied for.", "properties": { "duration": { "description": "Time span for the redeemed discount.", "properties": { "interval": { "description": "Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.", "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "description": "The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.", "type": "integer" } }, "required": [ "interval", "interval_count" ], "title": "discount_end_duration_specs", "type": "object", "x-stripeMostCommon": [ "interval", "interval_count" ] }, "timestamp": { "description": "A precise Unix timestamp for the discount to end. Must be in the future.", "format": "unix-time", "type": "integer" }, "type": { "description": "The type of calculation made to determine when the discount ends.", "enum": [ "duration", "timestamp" ], "type": "string" } }, "required": [ "type" ], "title": "discount_end", "type": "object", "x-stripeMostCommon": [ "duration", "timestamp", "type" ] }, "promotion_code": { "description": "ID of the promotion code to create a new discount for.", "maxLength": 5000, "type": "string" } }, "title": "discounts_data_param", "type": "object", "x-stripeMostCommon": [ "coupon", "settings" ] }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The coupons to redeem into discounts for the subscription item." }, "id": { "description": "Subscription item to update.", "maxLength": 5000, "type": "string" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "plan": { "description": "Plan ID for this item, as a string.", "maxLength": 5000, "type": "string" }, "price": { "description": "The ID of the price object. One of `price` or `price_data` is required. When changing a subscription item's price, `quantity` is set to 1 unless a `quantity` parameter is provided.", "maxLength": 5000, "type": "string" }, "price_data": { "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.", "properties": { "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "product": { "description": "The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.", "maxLength": 5000, "type": "string" }, "recurring": { "description": "The recurring components of a price such as `interval` and `interval_count`.", "properties": { "interval": { "description": "Specifies billing frequency. Either `day`, `week`, `month` or `year`.", "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "description": "The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).", "type": "integer" } }, "required": [ "interval" ], "title": "recurring_adhoc", "type": "object", "x-stripeMostCommon": [ "interval" ] }, "tax_behavior": { "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.", "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" }, "unit_amount": { "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.", "type": "integer" }, "unit_amount_decimal": { "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", "format": "decimal", "type": "string" } }, "required": [ "currency", "product", "recurring" ], "title": "recurring_price_data", "type": "object", "x-stripeMostCommon": [ "currency", "product", "recurring", "unit_amount" ] }, "quantity": { "description": "Quantity for this item.", "type": "integer" }, "tax_rates": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates." } }, "title": "subscription_item_update_params", "type": "object", "x-stripeMostCommon": [ "billing_thresholds", "clear_usage", "current_trial", "deleted", "discounts", "id", "metadata", "plan", "price", "quantity", "service_starts_at", "tax_rates" ] }, "type": "array" }, "prebilling": { "description": "The pre-billing to apply to the subscription as a preview.", "properties": { "iterations": { "description": "This is used to determine the number of billing cycles to prebill.", "type": "integer" } }, "required": [ "iterations" ], "title": "prebilling_preview_params", "type": "object", "x-stripeMostCommon": [ "iterations" ] }, "proration_behavior": { "description": "Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.", "enum": [ "always_invoice", "create_prorations", "none" ], "type": "string" }, "proration_date": { "description": "If previewing an update to a subscription, and doing proration, `subscription_details.proration_date` forces the proration to be calculated as though the update was done at the specified time. The time given must be within the current subscription period and within the current phase of the schedule backing this subscription, if the schedule exists. If set, `subscription`, and one of `subscription_details.items`, or `subscription_details.trial_end` are required. Also, `subscription_details.proration_behavior` cannot be set to 'none'.", "format": "unix-time", "type": "integer" }, "resume_at": { "description": "For paused subscriptions, setting `subscription_details.resume_at` to `now` will preview the invoice that will be generated if the subscription is resumed.", "enum": [ "now" ], "maxLength": 5000, "type": "string" }, "start_date": { "description": "Date a subscription is intended to start (can be future or past).", "format": "unix-time", "type": "integer" }, "trial_end": { "anyOf": [ { "enum": [ "now" ], "maxLength": 5000, "type": "string" }, { "format": "unix-time", "type": "integer" } ], "description": "If provided, the invoice returned will preview updating or creating a subscription with that trial end. If set, one of `subscription_details.items` or `subscription` is required." } }, "title": "subscription_details_params", "type": "object", "x-stripeMostCommon": [ "billing_cycle_anchor", "billing_mode", "billing_schedules", "cancel_at", "cancel_at_period_end", "cancel_now", "default_tax_rates", "items", "prebilling", "proration_behavior", "proration_date", "resume_at", "start_date", "trial_end" ] } }, "type": "object", "x-stripeMostCommon": [ "automatic_tax", "customer", "subscription" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/invoice" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a preview invoice" } }, "/v1/invoices/search": { "get": { "description": "

Search for invoices you’ve previously created using Stripe’s Search Query Language.\nDon’t use search in read-after-write flows where strict consistency is necessary. Under normal operating\nconditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up\nto an hour behind during outages. Search functionality is not available to merchants in India.

", "operationId": "GetInvoicesSearch", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.", "in": "query", "name": "page", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for invoices](https://stripe.com/docs/search#query-fields-for-invoices).", "in": "query", "name": "query", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/invoice" }, "type": "array" }, "has_more": { "type": "boolean" }, "next_page": { "maxLength": 5000, "nullable": true, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "search_result" ], "type": "string" }, "total_count": { "description": "The total number of objects that match the query, only accurate up to 10,000.", "type": "integer" }, "url": { "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "next_page", "object", "url" ], "title": "SearchResult", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "next_page", "object", "total_count", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Search invoices" } }, "/v1/invoices/{invoice}": { "delete": { "description": "

Permanently deletes a one-off invoice draft. This cannot be undone. Attempts to delete invoices that are no longer in a draft state will fail; once an invoice has been finalized or if an invoice is for a subscription, it must be voided.

", "operationId": "DeleteInvoicesInvoice", "parameters": [ { "in": "path", "name": "invoice", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted_invoice" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Delete a draft invoice" }, "get": { "description": "

Retrieves the invoice with the given ID.

", "operationId": "GetInvoicesInvoice", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "invoice", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/invoice" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve an invoice" }, "post": { "description": "

Draft invoices are fully editable. Once an invoice is finalized,\nmonetary values, as well as collection_method, become uneditable.

\n\n

If you would like to stop the Stripe Billing engine from automatically finalizing, reattempting payments on,\nsending reminders for, or automatically reconciling invoices, pass\nauto_advance=false.

", "operationId": "PostInvoicesInvoice", "parameters": [ { "in": "path", "name": "invoice", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "account_tax_ids": { "explode": true, "style": "deepObject" }, "amounts_due": { "explode": true, "style": "deepObject" }, "automatic_tax": { "explode": true, "style": "deepObject" }, "custom_fields": { "explode": true, "style": "deepObject" }, "default_margins": { "explode": true, "style": "deepObject" }, "default_source": { "explode": true, "style": "deepObject" }, "default_tax_rates": { "explode": true, "style": "deepObject" }, "discounts": { "explode": true, "style": "deepObject" }, "effective_at": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "issuer": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "number": { "explode": true, "style": "deepObject" }, "on_behalf_of": { "explode": true, "style": "deepObject" }, "payment_settings": { "explode": true, "style": "deepObject" }, "rendering": { "explode": true, "style": "deepObject" }, "shipping_cost": { "explode": true, "style": "deepObject" }, "shipping_details": { "explode": true, "style": "deepObject" }, "transfer_data": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "account_tax_ids": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The account tax IDs associated with the invoice. Only editable when the invoice is a draft." }, "amounts_due": { "anyOf": [ { "items": { "properties": { "amount": { "description": "The amount in cents (or local equivalent).", "type": "integer" }, "days_until_due": { "description": "Number of days from when invoice is finalized until the payment is due.", "type": "integer" }, "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users.", "maxLength": 5000, "type": "string" }, "due_date": { "description": "Date on which a payment plan’s payment is due.", "format": "unix-time", "type": "integer" } }, "required": [ "amount", "description" ], "title": "payment_plan_amount_param", "type": "object", "x-stripeMostCommon": [ "amount", "days_until_due", "description", "due_date" ] }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "List of expected payments and corresponding due dates. Valid only for invoices where `collection_method=send_invoice`." }, "application_fee_amount": { "description": "A fee in cents (or local equivalent) that will be applied to the invoice and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees [documentation](https://stripe.com/docs/billing/invoices/connect#collecting-fees).", "type": "integer" }, "auto_advance": { "description": "Controls whether Stripe performs [automatic collection](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection) of the invoice.", "type": "boolean" }, "automatic_tax": { "description": "Settings for automatic tax lookup for this invoice.", "properties": { "enabled": { "description": "Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified [tax rates](https://stripe.com/docs/api/tax_rates), negative amounts, or `tax_behavior=unspecified`) cannot be added to automatic tax invoices.", "type": "boolean" }, "liability": { "description": "The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.", "properties": { "account": { "description": "The connected account being referenced when `type` is `account`.", "type": "string" }, "type": { "description": "Type of the account referenced in the request.", "enum": [ "account", "self" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "param", "type": "object", "x-stripeMostCommon": [ "account", "type" ] } }, "required": [ "enabled" ], "title": "automatic_tax_param", "type": "object", "x-stripeMostCommon": [ "enabled", "liability" ] }, "automatically_finalizes_at": { "description": "The time when this invoice should be scheduled to finalize (up to 5 years in the future). The invoice is finalized at this time if it's still in draft state. To turn off automatic finalization, set `auto_advance` to false.", "format": "unix-time", "type": "integer" }, "collection_method": { "description": "Either `charge_automatically` or `send_invoice`. This field can be updated only on `draft` invoices.", "enum": [ "charge_automatically", "send_invoice" ], "type": "string" }, "custom_fields": { "anyOf": [ { "items": { "properties": { "name": { "description": "The name of the custom field. This may be up to 40 characters.", "maxLength": 40, "type": "string" }, "value": { "description": "The value of the custom field. This may be up to 140 characters.", "maxLength": 140, "type": "string" } }, "required": [ "name", "value" ], "title": "custom_field_params", "type": "object", "x-stripeMostCommon": [ "name", "value" ] }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "A list of up to 4 custom fields to be displayed on the invoice. If a value for `custom_fields` is specified, the list specified will replace the existing custom field list on this invoice. Pass an empty string to remove previously-defined fields." }, "days_until_due": { "description": "The number of days from which the invoice is created until it is due. Only valid for invoices where `collection_method=send_invoice`. This field can only be updated on `draft` invoices.", "type": "integer" }, "default_margins": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The ids of the margins to apply to the invoice. Can be overridden by line item `margins`." }, "default_payment_method": { "description": "ID of the default payment method for the invoice. It must belong to the customer associated with the invoice. If not set, defaults to the subscription's default payment method, if any, or to the default payment method in the customer's invoice settings.", "maxLength": 5000, "type": "string" }, "default_source": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "ID of the default payment source for the invoice. It must belong to the customer associated with the invoice and be in a chargeable state. If not set, defaults to the subscription's default source, if any, or to the customer's default source." }, "default_tax_rates": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The tax rates that will apply to any line item that does not have `tax_rates` set. Pass an empty string to remove previously-defined tax rates." }, "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard.", "maxLength": 1500, "type": "string" }, "discounts": { "anyOf": [ { "items": { "properties": { "coupon": { "description": "ID of the coupon to create a new discount for.", "maxLength": 5000, "type": "string" }, "discount": { "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", "maxLength": 5000, "type": "string" }, "discount_end": { "description": "Details to determine how long the discount should be applied for.", "properties": { "duration": { "description": "Time span for the redeemed discount.", "properties": { "interval": { "description": "Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.", "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "description": "The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.", "type": "integer" } }, "required": [ "interval", "interval_count" ], "title": "discount_end_duration_specs", "type": "object", "x-stripeMostCommon": [ "interval", "interval_count" ] }, "timestamp": { "description": "A precise Unix timestamp for the discount to end. Must be in the future.", "format": "unix-time", "type": "integer" }, "type": { "description": "The type of calculation made to determine when the discount ends.", "enum": [ "duration", "timestamp" ], "type": "string" } }, "required": [ "type" ], "title": "discount_end", "type": "object", "x-stripeMostCommon": [ "duration", "timestamp", "type" ] }, "promotion_code": { "description": "ID of the promotion code to create a new discount for.", "maxLength": 5000, "type": "string" } }, "title": "discounts_data_param", "type": "object", "x-stripeMostCommon": [ "coupon" ] }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The discounts that will apply to the invoice. Pass an empty string to remove previously-defined discounts." }, "due_date": { "description": "The date on which payment for this invoice is due. Only valid for invoices where `collection_method=send_invoice`. This field can only be updated on `draft` invoices.", "format": "unix-time", "type": "integer" }, "effective_at": { "anyOf": [ { "format": "unix-time", "type": "integer" }, { "enum": [ "" ], "type": "string" } ], "description": "The date when this invoice is in effect. Same as `finalized_at` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the invoice PDF and receipt." }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "footer": { "description": "Footer to be displayed on the invoice.", "maxLength": 5000, "type": "string" }, "issuer": { "description": "The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.", "properties": { "account": { "description": "The connected account being referenced when `type` is `account`.", "type": "string" }, "type": { "description": "Type of the account referenced in the request.", "enum": [ "account", "self" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "param", "type": "object", "x-stripeMostCommon": [ "account", "type" ] }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "number": { "anyOf": [ { "maxLength": 26, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Set the number for this invoice. If no number is present then a number will be assigned automatically when the invoice is finalized. In many markets, regulations require invoices to be unique, sequential and / or gapless. You are responsible for ensuring this is true across all your different invoicing systems in the event that you edit the invoice number using our API. If you use only Stripe for your invoices and do not change invoice numbers, Stripe handles this aspect of compliance for you automatically." }, "on_behalf_of": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://stripe.com/docs/billing/invoices/connect) documentation for details." }, "payment_settings": { "description": "Configuration settings for the PaymentIntent that is generated when the invoice is finalized.", "properties": { "default_mandate": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "ID of the mandate to be used for this invoice. It must correspond to the payment method used to pay the invoice, including the invoice's default_payment_method or default_source, if set." }, "payment_method_options": { "description": "Payment-method-specific configuration to provide to the invoice’s PaymentIntent.", "properties": { "acss_debit": { "anyOf": [ { "properties": { "mandate_options": { "description": "Additional fields for Mandate creation", "properties": { "transaction_type": { "description": "Transaction type of the mandate.", "enum": [ "business", "personal" ], "type": "string" } }, "title": "mandate_options_param", "type": "object", "x-stripeMostCommon": [ "transaction_type" ] }, "verification_method": { "description": "Verification method for the intent", "enum": [ "automatic", "instant", "microdeposits" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "invoice_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "mandate_options", "verification_method" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If paying by `acss_debit`, this sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to the invoice’s PaymentIntent." }, "bancontact": { "anyOf": [ { "properties": { "preferred_language": { "description": "Preferred language of the Bancontact authorization page that the customer is redirected to.", "enum": [ "de", "en", "fr", "nl" ], "type": "string" } }, "title": "invoice_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "preferred_language" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If paying by `bancontact`, this sub-hash contains details about the Bancontact payment method options to pass to the invoice’s PaymentIntent." }, "card": { "anyOf": [ { "properties": { "installments": { "description": "Installment configuration for payments attempted on this invoice.\n\nFor more information, see the [installments integration guide](https://stripe.com/docs/payments/installments).", "properties": { "enabled": { "description": "Setting to true enables installments for this invoice.\nSetting to false will prevent any selected plan from applying to a payment.", "type": "boolean" }, "plan": { "anyOf": [ { "properties": { "count": { "description": "For `fixed_count` installment plans, this is required. It represents the number of installment payments your customer will make to their credit card.", "type": "integer" }, "interval": { "description": "For `fixed_count` installment plans, this is required. It represents the interval between installment payments your customer will make to their credit card.\nOne of `month`.", "enum": [ "month" ], "type": "string" }, "type": { "description": "Type of installment plan, one of `fixed_count`, `bonus`, or `revolving`.", "enum": [ "bonus", "fixed_count", "revolving" ], "type": "string" } }, "required": [ "type" ], "title": "installment_plan", "type": "object", "x-stripeMostCommon": [ "count", "interval", "type" ] }, { "enum": [ "" ], "type": "string" } ], "description": "The selected installment plan to use for this invoice." } }, "title": "installments_param", "type": "object", "x-stripeMostCommon": [ "enabled", "plan" ] }, "request_three_d_secure": { "description": "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.", "enum": [ "any", "automatic", "challenge" ], "type": "string" } }, "title": "invoice_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "installments", "request_three_d_secure" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If paying by `card`, this sub-hash contains details about the Card payment method options to pass to the invoice’s PaymentIntent." }, "customer_balance": { "anyOf": [ { "properties": { "bank_transfer": { "description": "Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`.", "properties": { "eu_bank_transfer": { "description": "Configuration for eu_bank_transfer funding type.", "properties": { "country": { "description": "The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`.", "maxLength": 5000, "type": "string" } }, "required": [ "country" ], "title": "eu_bank_transfer_param", "type": "object", "x-stripeMostCommon": [ "country" ] }, "type": { "description": "The bank transfer type that can be used for funding. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.", "type": "string" } }, "title": "bank_transfer_param", "type": "object", "x-stripeMostCommon": [ "eu_bank_transfer", "id_bank_transfer", "type" ] }, "funding_type": { "description": "The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.", "type": "string" } }, "title": "invoice_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "bank_transfer", "funding_type" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If paying by `customer_balance`, this sub-hash contains details about the Bank transfer payment method options to pass to the invoice’s PaymentIntent." }, "id_bank_transfer": { "anyOf": [ { "properties": {}, "title": "invoice_payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "If paying by `id_bank_transfer`, this sub-hash contains details about the Indonesia bank transfer payment method options to pass to the invoice’s PaymentIntent." }, "konbini": { "anyOf": [ { "properties": {}, "title": "invoice_payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "If paying by `konbini`, this sub-hash contains details about the Konbini payment method options to pass to the invoice’s PaymentIntent." }, "pix": { "anyOf": [ { "properties": { "amount_includes_iof": { "description": "Determines if the amount includes the IOF tax. Defaults to `never`.", "enum": [ "always", "never" ], "type": "string" } }, "title": "invoice_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "amount_includes_iof" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If paying by `pix`, this sub-hash contains details about the Pix payment method options to pass to the invoice’s PaymentIntent." }, "sepa_debit": { "anyOf": [ { "properties": {}, "title": "invoice_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "verification_method" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If paying by `sepa_debit`, this sub-hash contains details about the SEPA Direct Debit payment method options to pass to the invoice’s PaymentIntent." }, "upi": { "anyOf": [ { "properties": { "mandate_options": { "description": "Configuration options for setting up an eMandate", "properties": { "amount": { "description": "Amount to be charged for future payments.", "type": "integer" }, "amount_type": { "description": "One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.", "enum": [ "fixed", "maximum" ], "type": "string" }, "description": { "description": "A description of the mandate or subscription that is meant to be displayed to the customer.", "maxLength": 20, "type": "string" }, "end_date": { "description": "End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.", "format": "unix-time", "type": "integer" } }, "title": "invoice_payment_method_options_mandate_options_param", "type": "object", "x-stripeMostCommon": [ "amount", "amount_type", "description", "end_date" ] } }, "title": "invoice_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "mandate_options" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If paying by `upi`, this sub-hash contains details about the UPI payment method options to pass to the invoice’s PaymentIntent." }, "us_bank_account": { "anyOf": [ { "properties": { "financial_connections": { "description": "Additional fields for Financial Connections Session creation", "properties": { "filters": { "description": "Provide filters for the linked accounts that the customer can select for the payment method.", "properties": { "account_subcategories": { "description": "The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.", "items": { "enum": [ "checking", "savings" ], "type": "string" }, "type": "array" }, "institution": { "description": "ID of the institution to use to filter for selectable accounts.", "maxLength": 5000, "type": "string" } }, "title": "invoice_linked_account_options_filters_param", "type": "object", "x-stripeMostCommon": [ "account_subcategories", "institution" ] }, "permissions": { "description": "The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.", "items": { "enum": [ "balances", "ownership", "payment_method", "transactions" ], "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true }, "type": "array" }, "prefetch": { "description": "List of data features that you would like to retrieve upon account creation.", "items": { "enum": [ "balances", "inferred_balances", "ownership", "transactions" ], "type": "string", "x-stripeBypassValidation": true }, "type": "array" } }, "title": "invoice_linked_account_options_param", "type": "object", "x-stripeMostCommon": [ "filters", "permissions", "prefetch" ] }, "verification_method": { "description": "Verification method for the intent", "enum": [ "automatic", "instant", "microdeposits" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "invoice_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "financial_connections", "verification_method" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If paying by `us_bank_account`, this sub-hash contains details about the ACH direct debit payment method options to pass to the invoice’s PaymentIntent." } }, "title": "payment_method_options", "type": "object", "x-stripeMostCommon": [ "acss_debit", "bancontact", "card", "customer_balance", "id_bank_transfer", "konbini", "pix", "sepa_debit", "upi", "us_bank_account" ] }, "payment_method_types": { "anyOf": [ { "items": { "enum": [ "ach_credit_transfer", "ach_debit", "acss_debit", "affirm", "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", "boleto", "card", "cashapp", "crypto", "custom", "customer_balance", "eps", "fpx", "giropay", "grabpay", "id_bank_transfer", "ideal", "jp_credit_transfer", "kakao_pay", "klarna", "konbini", "kr_card", "link", "multibanco", "naver_pay", "nz_bank_account", "p24", "payco", "paynow", "paypal", "pix", "promptpay", "revolut_pay", "sepa_credit_transfer", "sepa_debit", "sofort", "stripe_balance", "swish", "upi", "us_bank_account", "wechat_pay" ], "type": "string", "x-stripeBypassValidation": true }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The list of payment method types (e.g. card) to provide to the invoice’s PaymentIntent. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your [invoice template settings](https://dashboard.stripe.com/settings/billing/invoice)." } }, "title": "payment_settings", "type": "object", "x-stripeMostCommon": [ "default_mandate", "payment_method_configuration", "payment_method_options", "payment_method_types" ] }, "rendering": { "description": "The rendering-related settings that control how the invoice is displayed on customer-facing surfaces such as PDF and Hosted Invoice Page.", "properties": { "amount_tax_display": { "description": "How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. One of `exclude_tax` or `include_inclusive_tax`. `include_inclusive_tax` will include inclusive tax (and exclude exclusive tax) in invoice PDF amounts. `exclude_tax` will exclude all tax (inclusive and exclusive alike) from invoice PDF amounts.", "enum": [ "", "exclude_tax", "include_inclusive_tax" ], "type": "string" }, "pdf": { "description": "Invoice pdf rendering options", "properties": { "page_size": { "description": "Page size for invoice PDF. Can be set to `a4`, `letter`, or `auto`.\n If set to `auto`, invoice PDF page size defaults to `a4` for customers with\n Japanese locale and `letter` for customers with other locales.", "enum": [ "a4", "auto", "letter" ], "type": "string" } }, "title": "rendering_pdf_param", "type": "object", "x-stripeMostCommon": [ "page_size" ] }, "template": { "description": "ID of the invoice rendering template to use for this invoice.", "maxLength": 5000, "type": "string" }, "template_version": { "anyOf": [ { "type": "integer" }, { "enum": [ "" ], "type": "string" } ], "description": "The specific version of invoice rendering template to use for this invoice." } }, "title": "rendering_param", "type": "object", "x-stripeMostCommon": [ "amount_tax_display", "custom_text", "invoice_title", "pdf", "summary_items_data", "template", "template_version" ] }, "shipping_cost": { "anyOf": [ { "properties": { "shipping_rate": { "description": "The ID of the shipping rate to use for this order.", "maxLength": 5000, "type": "string" }, "shipping_rate_data": { "description": "Parameters to create a new ad-hoc shipping rate for this order.", "properties": { "delivery_estimate": { "description": "The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.", "properties": { "maximum": { "description": "The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.", "properties": { "unit": { "description": "A unit of time.", "enum": [ "business_day", "day", "hour", "month", "week" ], "type": "string" }, "value": { "description": "Must be greater than 0.", "type": "integer" } }, "required": [ "unit", "value" ], "title": "delivery_estimate_bound", "type": "object", "x-stripeMostCommon": [ "unit", "value" ] }, "minimum": { "description": "The lower bound of the estimated range. If empty, represents no lower bound.", "properties": { "unit": { "description": "A unit of time.", "enum": [ "business_day", "day", "hour", "month", "week" ], "type": "string" }, "value": { "description": "Must be greater than 0.", "type": "integer" } }, "required": [ "unit", "value" ], "title": "delivery_estimate_bound", "type": "object", "x-stripeMostCommon": [ "unit", "value" ] } }, "title": "delivery_estimate", "type": "object", "x-stripeMostCommon": [ "maximum", "minimum" ] }, "display_name": { "description": "The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.", "maxLength": 100, "type": "string" }, "fixed_amount": { "description": "Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`.", "properties": { "amount": { "description": "A non-negative integer in cents representing how much to charge.", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "currency_options": { "additionalProperties": { "properties": { "amount": { "description": "A non-negative integer in cents representing how much to charge.", "type": "integer" }, "tax_behavior": { "description": "Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.", "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" } }, "required": [ "amount" ], "title": "currency_option", "type": "object", "x-stripeMostCommon": [ "amount", "tax_behavior" ] }, "description": "Shipping rates defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).", "type": "object" } }, "required": [ "amount", "currency" ], "title": "fixed_amount", "type": "object", "x-stripeMostCommon": [ "amount", "currency", "currency_options" ] }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "tax_behavior": { "description": "Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.", "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" }, "tax_code": { "description": "A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`.", "type": "string" }, "type": { "description": "The type of calculation to use on the shipping rate.", "enum": [ "fixed_amount" ], "type": "string" } }, "required": [ "display_name" ], "title": "method_params", "type": "object", "x-stripeMostCommon": [ "display_name", "fixed_amount", "metadata", "tax_behavior", "tax_code", "type" ] } }, "title": "shipping_cost", "type": "object", "x-stripeMostCommon": [ "shipping_rate", "shipping_rate_data" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Settings for the cost of shipping for this invoice." }, "shipping_details": { "anyOf": [ { "properties": { "address": { "description": "Shipping address", "properties": { "city": { "description": "City, district, suburb, town, or village.", "maxLength": 5000, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Address line 1 (e.g., street, PO Box, or company name).", "maxLength": 5000, "type": "string" }, "line2": { "description": "Address line 2 (e.g., apartment, suite, unit, or building).", "maxLength": 5000, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "State, county, province, or region.", "maxLength": 5000, "type": "string" } }, "title": "optional_fields_address", "type": "object", "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state" ] }, "name": { "description": "Recipient name.", "maxLength": 5000, "type": "string" }, "phone": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Recipient phone (including extension)" } }, "required": [ "address", "name" ], "title": "recipient_shipping_with_optional_fields_address", "type": "object", "x-stripeMostCommon": [ "address", "name", "phone" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Shipping details for the invoice. The Invoice PDF will use the `shipping_details` value if it is set, otherwise the PDF will render the shipping address from the customer." }, "statement_descriptor": { "description": "Extra information about a charge for the customer's credit card statement. It must contain at least one letter. If not specified and this invoice is part of a subscription, the default `statement_descriptor` will be set to the first subscription item's product's `statement_descriptor`.", "maxLength": 22, "type": "string" }, "transfer_data": { "anyOf": [ { "properties": { "amount": { "description": "The amount that will be transferred automatically when the invoice is paid. If no amount is set, the full amount is transferred.", "type": "integer" }, "destination": { "description": "ID of an existing, connected Stripe account.", "type": "string" } }, "required": [ "destination" ], "title": "transfer_data_specs", "type": "object", "x-stripeMostCommon": [ "amount", "destination" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If specified, the funds from the invoice will be transferred to the destination and the ID of the resulting transfer will be found on the invoice's charge. This will be unset if you POST an empty value." } }, "type": "object", "x-stripeMostCommon": [ "auto_advance", "automatic_tax", "collection_method", "description", "metadata" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/invoice" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update an invoice" } }, "/v1/invoices/{invoice}/add_lines": { "post": { "description": "

Adds multiple line items to an invoice. This is only possible when an invoice is still a draft.

", "operationId": "PostInvoicesInvoiceAddLines", "parameters": [ { "in": "path", "name": "invoice", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "invoice_metadata": { "explode": true, "style": "deepObject" }, "lines": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "invoice_metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "lines": { "description": "The line items to add.", "items": { "properties": { "amount": { "description": "The integer amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. If you want to apply a credit to the customer's account, pass a negative amount.", "type": "integer" }, "description": { "description": "An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking.", "maxLength": 5000, "type": "string" }, "discountable": { "description": "Controls whether discounts apply to this line item. Defaults to false for prorations or negative line items, and true for all other line items. Cannot be set to true for prorations.", "type": "boolean" }, "discounts": { "anyOf": [ { "items": { "properties": { "coupon": { "description": "ID of the coupon to create a new discount for.", "maxLength": 5000, "type": "string" }, "discount": { "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", "maxLength": 5000, "type": "string" }, "discount_end": { "description": "Details to determine how long the discount should be applied for.", "properties": { "duration": { "description": "Time span for the redeemed discount.", "properties": { "interval": { "description": "Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.", "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "description": "The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.", "type": "integer" } }, "required": [ "interval", "interval_count" ], "title": "discount_end_duration_specs", "type": "object", "x-stripeMostCommon": [ "interval", "interval_count" ] }, "timestamp": { "description": "A precise Unix timestamp for the discount to end. Must be in the future.", "format": "unix-time", "type": "integer" }, "type": { "description": "The type of calculation made to determine when the discount ends.", "enum": [ "duration", "timestamp" ], "type": "string" } }, "required": [ "type" ], "title": "discount_end", "type": "object", "x-stripeMostCommon": [ "duration", "timestamp", "type" ] }, "promotion_code": { "description": "ID of the promotion code to create a new discount for.", "maxLength": 5000, "type": "string" } }, "title": "discounts_data_param", "type": "object", "x-stripeMostCommon": [ "coupon" ] }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The coupons, promotion codes & existing discounts which apply to the line item. Item discounts are applied before invoice discounts. Pass an empty string to remove previously-defined discounts." }, "invoice_item": { "description": "ID of an unassigned invoice item to assign to this invoice. If not provided, a new item will be created.", "maxLength": 5000, "type": "string" }, "margins": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The IDs of the margins to apply to the line item. When set, the `default_margins` on the invoice do not apply to this line item." }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "period": { "description": "The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details.", "properties": { "end": { "description": "The end of the period, which must be greater than or equal to the start. This value is inclusive.", "format": "unix-time", "type": "integer" }, "start": { "description": "The start of the period. This value is inclusive.", "format": "unix-time", "type": "integer" } }, "required": [ "end", "start" ], "title": "period", "type": "object", "x-stripeMostCommon": [ "end", "start" ] }, "price_data": { "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.", "properties": { "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "product": { "description": "The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to. One of `product` or `product_data` is required.", "maxLength": 5000, "type": "string" }, "product_data": { "description": "Data used to generate a new [Product](https://docs.stripe.com/api/products) object inline. One of `product` or `product_data` is required.", "properties": { "description": { "description": "The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.", "maxLength": 40000, "type": "string" }, "images": { "description": "A list of up to 8 URLs of images for this product, meant to be displayable to the customer.", "items": { "type": "string" }, "type": "array" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "name": { "description": "The product's name, meant to be displayable to the customer.", "maxLength": 5000, "type": "string" }, "tax_code": { "description": "A [tax code](https://stripe.com/docs/tax/tax-categories) ID.", "maxLength": 5000, "type": "string" } }, "required": [ "name" ], "title": "product_data", "type": "object", "x-stripeMostCommon": [ "description", "images", "metadata", "name", "tax_code", "unit_label" ] }, "tax_behavior": { "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.", "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" }, "unit_amount": { "description": "A non-negative integer in cents (or local equivalent) representing how much to charge. One of `unit_amount` or `unit_amount_decimal` is required.", "type": "integer" }, "unit_amount_decimal": { "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", "format": "decimal", "type": "string" } }, "required": [ "currency" ], "title": "one_time_price_data_with_product_data", "type": "object", "x-stripeMostCommon": [ "currency", "product", "unit_amount" ] }, "pricing": { "description": "The pricing information for the invoice item.", "properties": { "price": { "description": "The ID of the price object.", "maxLength": 5000, "type": "string" } }, "title": "pricing_param", "type": "object", "x-stripeMostCommon": [ "price" ] }, "quantity": { "description": "Non-negative integer. The quantity of units for the line item.", "type": "integer" }, "tax_amounts": { "anyOf": [ { "items": { "properties": { "amount": { "description": "The amount, in cents (or local equivalent), of the tax.", "type": "integer" }, "tax_rate_data": { "description": "Data to find or create a TaxRate object.\n\nStripe automatically creates or reuses a TaxRate object for each tax amount. If the `tax_rate_data` exactly matches a previous value, Stripe will reuse the TaxRate object. TaxRate objects created automatically by Stripe are immediately archived, do not appear in the line item’s `tax_rates`, and cannot be directly added to invoices, payments, or line items.", "properties": { "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "description": { "description": "An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.", "maxLength": 5000, "type": "string" }, "display_name": { "description": "The display name of the tax rate, which will be shown to users.", "maxLength": 100, "type": "string" }, "inclusive": { "description": "This specifies if the tax rate is inclusive or exclusive.", "type": "boolean" }, "jurisdiction": { "description": "The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.", "maxLength": 200, "type": "string" }, "jurisdiction_level": { "description": "The level of the jurisdiction that imposes this tax rate.", "enum": [ "city", "country", "county", "district", "multiple", "state" ], "type": "string" }, "percentage": { "description": "The statutory tax rate percent. This field accepts decimal values between 0 and 100 inclusive with at most 4 decimal places. To accommodate fixed-amount taxes, set the percentage to zero. Stripe will not display zero percentages on the invoice unless the `amount` of the tax is also zero.", "type": "number" }, "state": { "description": "[ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country prefix. For example, \"NY\" for New York, United States.", "maxLength": 5000, "type": "string" }, "tax_type": { "description": "The high-level tax type, such as `vat` or `sales_tax`.", "enum": [ "amusement_tax", "communications_tax", "gst", "hst", "igst", "jct", "lease_tax", "pst", "qst", "retail_delivery_fee", "rst", "sales_tax", "service_tax", "vat" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "display_name", "inclusive", "percentage" ], "title": "tax_rate_data_param", "type": "object", "x-stripeMostCommon": [ "country", "description", "display_name", "inclusive", "jurisdiction", "jurisdiction_level", "percentage", "state", "tax_type" ] }, "taxability_reason": { "description": "The reasoning behind this tax, for example, if the product is tax exempt.", "enum": [ "customer_exempt", "not_collecting", "not_subject_to_tax", "not_supported", "portion_product_exempt", "portion_reduced_rated", "portion_standard_rated", "product_exempt", "product_exempt_holiday", "proportionally_rated", "reduced_rated", "reverse_charge", "standard_rated", "taxable_basis_reduced", "zero_rated" ], "type": "string", "x-stripeBypassValidation": true }, "taxable_amount": { "description": "The amount on which tax is calculated, in cents (or local equivalent).", "type": "integer" } }, "required": [ "amount", "tax_rate_data", "taxable_amount" ], "title": "tax_amount_param", "type": "object", "x-stripeMostCommon": [ "amount", "tax_rate_data", "taxability_reason", "taxable_amount" ] }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "A list of up to 10 tax amounts for this line item. This can be useful if you calculate taxes on your own or use a third-party to calculate them. You cannot set tax amounts if any line item has [tax_rates](https://stripe.com/docs/api/invoices/line_item#invoice_line_item_object-tax_rates) or if the invoice has [default_tax_rates](https://stripe.com/docs/api/invoices/object#invoice_object-default_tax_rates) or uses [automatic tax](https://stripe.com/docs/tax/invoicing). Pass an empty string to remove previously defined tax amounts." }, "tax_rates": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The tax rates which apply to the line item. When set, the `default_tax_rates` on the invoice do not apply to this line item. Pass an empty string to remove previously-defined tax rates." } }, "title": "lines_data_param", "type": "object", "x-stripeMostCommon": [ "amount", "description", "invoice_item", "metadata", "period", "pricing", "quantity" ] }, "type": "array" } }, "required": [ "lines" ], "type": "object", "x-stripeMostCommon": [ "invoice_metadata", "lines" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/invoice" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Bulk add invoice line items" } }, "/v1/invoices/{invoice}/attach_payment": { "post": { "description": "

Attaches a PaymentIntent or an Out of Band Payment to the invoice, adding it to the list of payments.

\n\n

For the PaymentIntent, when the PaymentIntent’s status changes to succeeded, the payment is credited\nto the invoice, increasing its amount_paid. When the invoice is fully paid, the\ninvoice’s status becomes paid.

\n\n

If the PaymentIntent’s status is already succeeded when it’s attached, it’s\ncredited to the invoice immediately.

\n\n

See: Partial payments to learn more.

", "operationId": "PostInvoicesInvoiceAttachPayment", "parameters": [ { "in": "path", "name": "invoice", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "payment_record_data": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "amount_requested": { "description": "The portion of the `amount` on the PaymentIntent or out of band payment to apply to this invoice. It defaults to the entire amount.", "type": "integer" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "payment_intent": { "description": "The ID of the PaymentIntent to attach to the invoice.", "maxLength": 5000, "type": "string" }, "payment_record": { "description": "The ID of the PaymentRecord to attach to the invoice.", "maxLength": 5000, "type": "string" }, "payment_record_data": { "description": "The PaymentRecord data for attaching an out of band payment to the invoice.", "properties": { "amount": { "description": "The amount that was paid out of band.", "type": "integer" }, "currency": { "description": "The currency that was paid out of band.", "format": "currency", "type": "string" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "money_movement_type": { "description": "The type of money movement for this out of band payment record.", "maxLength": 5000, "type": "string" }, "paid_at": { "description": "The timestamp when this out of band payment was paid.", "format": "unix-time", "type": "integer" }, "payment_reference": { "description": "The reference for this out of band payment record.", "maxLength": 5000, "type": "string" } }, "required": [ "amount", "currency", "money_movement_type" ], "title": "out_of_band_payment", "type": "object", "x-stripeMostCommon": [ "amount", "currency", "money_movement_type", "payment_method", "payment_reference" ] } }, "type": "object", "x-stripeMostCommon": [ "amount_requested", "payment_intent", "payment_record", "payment_record_data" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/invoice" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Attach a payment to an Invoice" } }, "/v1/invoices/{invoice}/finalize": { "post": { "description": "

Stripe automatically finalizes drafts before sending and attempting payment on invoices. However, if you’d like to finalize a draft invoice manually, you can do so using this method.

", "operationId": "PostInvoicesInvoiceFinalize", "parameters": [ { "in": "path", "name": "invoice", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "auto_advance": { "description": "Controls whether Stripe performs [automatic collection](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection) of the invoice. If `false`, the invoice's state doesn't automatically advance without an explicit action.", "type": "boolean" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object", "x-stripeMostCommon": [ "auto_advance" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/invoice" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Finalize an invoice" } }, "/v1/invoices/{invoice}/lines": { "get": { "description": "

When retrieving an invoice, you’ll get a lines property containing the total count of line items and the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.

", "operationId": "GetInvoicesInvoiceLines", "parameters": [ { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "invoice", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/line_item" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "InvoiceLinesList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve an invoice's line items" } }, "/v1/invoices/{invoice}/lines/{line_item_id}": { "post": { "description": "

Updates an invoice’s line item. Some fields, such as tax_amounts, only live on the invoice line item,\nso they can only be updated through this endpoint. Other fields, such as amount, live on both the invoice\nitem and the invoice line item, so updates on this endpoint will propagate to the invoice item as well.\nUpdating an invoice’s line item is only possible before the invoice is finalized.

", "operationId": "PostInvoicesInvoiceLinesLineItemId", "parameters": [ { "description": "Invoice ID of line item", "in": "path", "name": "invoice", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "description": "Invoice line item ID", "in": "path", "name": "line_item_id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "discounts": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "margins": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "period": { "explode": true, "style": "deepObject" }, "price_data": { "explode": true, "style": "deepObject" }, "pricing": { "explode": true, "style": "deepObject" }, "tax_amounts": { "explode": true, "style": "deepObject" }, "tax_rates": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "amount": { "description": "The integer amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. If you want to apply a credit to the customer's account, pass a negative amount.", "type": "integer" }, "description": { "description": "An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking.", "maxLength": 5000, "type": "string" }, "discountable": { "description": "Controls whether discounts apply to this line item. Defaults to false for prorations or negative line items, and true for all other line items. Cannot be set to true for prorations.", "type": "boolean" }, "discounts": { "anyOf": [ { "items": { "properties": { "coupon": { "description": "ID of the coupon to create a new discount for.", "maxLength": 5000, "type": "string" }, "discount": { "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", "maxLength": 5000, "type": "string" }, "discount_end": { "description": "Details to determine how long the discount should be applied for.", "properties": { "duration": { "description": "Time span for the redeemed discount.", "properties": { "interval": { "description": "Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.", "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "description": "The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.", "type": "integer" } }, "required": [ "interval", "interval_count" ], "title": "discount_end_duration_specs", "type": "object", "x-stripeMostCommon": [ "interval", "interval_count" ] }, "timestamp": { "description": "A precise Unix timestamp for the discount to end. Must be in the future.", "format": "unix-time", "type": "integer" }, "type": { "description": "The type of calculation made to determine when the discount ends.", "enum": [ "duration", "timestamp" ], "type": "string" } }, "required": [ "type" ], "title": "discount_end", "type": "object", "x-stripeMostCommon": [ "duration", "timestamp", "type" ] }, "promotion_code": { "description": "ID of the promotion code to create a new discount for.", "maxLength": 5000, "type": "string" } }, "title": "discounts_data_param", "type": "object", "x-stripeMostCommon": [ "coupon" ] }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The coupons, promotion codes & existing discounts which apply to the line item. Item discounts are applied before invoice discounts. Pass an empty string to remove previously-defined discounts." }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "margins": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The IDs of the margins to apply to the line item. When set, the `default_margins` on the invoice do not apply to this line item." }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`. For [type=subscription](https://stripe.com/docs/api/invoices/line_item#invoice_line_item_object-type) line items, the incoming metadata specified on the request is directly used to set this value, in contrast to [type=invoiceitem](api/invoices/line_item#invoice_line_item_object-type) line items, where any existing metadata on the invoice line is merged with the incoming data." }, "period": { "description": "The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details.", "properties": { "end": { "description": "The end of the period, which must be greater than or equal to the start. This value is inclusive.", "format": "unix-time", "type": "integer" }, "start": { "description": "The start of the period. This value is inclusive.", "format": "unix-time", "type": "integer" } }, "required": [ "end", "start" ], "title": "period", "type": "object", "x-stripeMostCommon": [ "end", "start" ] }, "price_data": { "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.", "properties": { "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "product": { "description": "The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to. One of `product` or `product_data` is required.", "maxLength": 5000, "type": "string" }, "product_data": { "description": "Data used to generate a new [Product](https://docs.stripe.com/api/products) object inline. One of `product` or `product_data` is required.", "properties": { "description": { "description": "The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.", "maxLength": 40000, "type": "string" }, "images": { "description": "A list of up to 8 URLs of images for this product, meant to be displayable to the customer.", "items": { "type": "string" }, "type": "array" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "name": { "description": "The product's name, meant to be displayable to the customer.", "maxLength": 5000, "type": "string" }, "tax_code": { "description": "A [tax code](https://stripe.com/docs/tax/tax-categories) ID.", "maxLength": 5000, "type": "string" } }, "required": [ "name" ], "title": "product_data", "type": "object", "x-stripeMostCommon": [ "description", "images", "metadata", "name", "tax_code", "unit_label" ] }, "tax_behavior": { "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.", "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" }, "unit_amount": { "description": "A non-negative integer in cents (or local equivalent) representing how much to charge. One of `unit_amount` or `unit_amount_decimal` is required.", "type": "integer" }, "unit_amount_decimal": { "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", "format": "decimal", "type": "string" } }, "required": [ "currency" ], "title": "one_time_price_data_with_product_data", "type": "object", "x-stripeMostCommon": [ "currency", "product", "unit_amount" ] }, "pricing": { "description": "The pricing information for the invoice item.", "properties": { "price": { "description": "The ID of the price object.", "maxLength": 5000, "type": "string" } }, "title": "pricing_param", "type": "object", "x-stripeMostCommon": [ "price" ] }, "quantity": { "description": "Non-negative integer. The quantity of units for the line item.", "type": "integer" }, "tax_amounts": { "anyOf": [ { "items": { "properties": { "amount": { "description": "The amount, in cents (or local equivalent), of the tax.", "type": "integer" }, "tax_rate_data": { "description": "Data to find or create a TaxRate object.\n\nStripe automatically creates or reuses a TaxRate object for each tax amount. If the `tax_rate_data` exactly matches a previous value, Stripe will reuse the TaxRate object. TaxRate objects created automatically by Stripe are immediately archived, do not appear in the line item’s `tax_rates`, and cannot be directly added to invoices, payments, or line items.", "properties": { "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "description": { "description": "An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.", "maxLength": 5000, "type": "string" }, "display_name": { "description": "The display name of the tax rate, which will be shown to users.", "maxLength": 100, "type": "string" }, "inclusive": { "description": "This specifies if the tax rate is inclusive or exclusive.", "type": "boolean" }, "jurisdiction": { "description": "The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.", "maxLength": 200, "type": "string" }, "jurisdiction_level": { "description": "The level of the jurisdiction that imposes this tax rate.", "enum": [ "city", "country", "county", "district", "multiple", "state" ], "type": "string" }, "percentage": { "description": "The statutory tax rate percent. This field accepts decimal values between 0 and 100 inclusive with at most 4 decimal places. To accommodate fixed-amount taxes, set the percentage to zero. Stripe will not display zero percentages on the invoice unless the `amount` of the tax is also zero.", "type": "number" }, "state": { "description": "[ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country prefix. For example, \"NY\" for New York, United States.", "maxLength": 5000, "type": "string" }, "tax_type": { "description": "The high-level tax type, such as `vat` or `sales_tax`.", "enum": [ "amusement_tax", "communications_tax", "gst", "hst", "igst", "jct", "lease_tax", "pst", "qst", "retail_delivery_fee", "rst", "sales_tax", "service_tax", "vat" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "display_name", "inclusive", "percentage" ], "title": "tax_rate_data_param", "type": "object", "x-stripeMostCommon": [ "country", "description", "display_name", "inclusive", "jurisdiction", "jurisdiction_level", "percentage", "state", "tax_type" ] }, "taxability_reason": { "description": "The reasoning behind this tax, for example, if the product is tax exempt.", "enum": [ "customer_exempt", "not_collecting", "not_subject_to_tax", "not_supported", "portion_product_exempt", "portion_reduced_rated", "portion_standard_rated", "product_exempt", "product_exempt_holiday", "proportionally_rated", "reduced_rated", "reverse_charge", "standard_rated", "taxable_basis_reduced", "zero_rated" ], "type": "string", "x-stripeBypassValidation": true }, "taxable_amount": { "description": "The amount on which tax is calculated, in cents (or local equivalent).", "type": "integer" } }, "required": [ "amount", "tax_rate_data", "taxable_amount" ], "title": "tax_amount_param", "type": "object", "x-stripeMostCommon": [ "amount", "tax_rate_data", "taxability_reason", "taxable_amount" ] }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "A list of up to 10 tax amounts for this line item. This can be useful if you calculate taxes on your own or use a third-party to calculate them. You cannot set tax amounts if any line item has [tax_rates](https://stripe.com/docs/api/invoices/line_item#invoice_line_item_object-tax_rates) or if the invoice has [default_tax_rates](https://stripe.com/docs/api/invoices/object#invoice_object-default_tax_rates) or uses [automatic tax](https://stripe.com/docs/tax/invoicing). Pass an empty string to remove previously defined tax amounts." }, "tax_rates": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The tax rates which apply to the line item. When set, the `default_tax_rates` on the invoice do not apply to this line item. Pass an empty string to remove previously-defined tax rates." } }, "type": "object", "x-stripeMostCommon": [ "amount", "description", "metadata", "period", "pricing", "quantity" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/line_item" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update an invoice's line item" } }, "/v1/invoices/{invoice}/mark_uncollectible": { "post": { "description": "

Marking an invoice as uncollectible is useful for keeping track of bad debts that can be written off for accounting purposes.

", "operationId": "PostInvoicesInvoiceMarkUncollectible", "parameters": [ { "in": "path", "name": "invoice", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/invoice" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Mark an invoice as uncollectible" } }, "/v1/invoices/{invoice}/pay": { "post": { "description": "

Stripe automatically creates and then attempts to collect payment on invoices for customers on subscriptions according to your subscriptions settings. However, if you’d like to attempt payment on an invoice out of the normal collection schedule or for some other reason, you can do so.

", "operationId": "PostInvoicesInvoicePay", "parameters": [ { "in": "path", "name": "invoice", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "mandate": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "forgive": { "description": "In cases where the source used to pay the invoice has insufficient funds, passing `forgive=true` controls whether a charge should be attempted for the full amount available on the source, up to the amount to fully pay the invoice. This effectively forgives the difference between the amount available on the source and the amount due. \n\nPassing `forgive=false` will fail the charge if the source hasn't been pre-funded with the right amount. An example for this case is with ACH Credit Transfers and wires: if the amount wired is less than the amount due by a small amount, you might want to forgive the difference. Defaults to `false`.", "type": "boolean" }, "mandate": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "ID of the mandate to be used for this invoice. It must correspond to the payment method used to pay the invoice, including the payment_method param or the invoice's default_payment_method or default_source, if set." }, "off_session": { "description": "Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to `true` (off-session).", "type": "boolean" }, "paid_out_of_band": { "description": "Boolean representing whether an invoice is paid outside of Stripe. This will result in no charge being made. Defaults to `false`.", "type": "boolean" }, "payment_method": { "description": "A PaymentMethod to be charged. The PaymentMethod must be the ID of a PaymentMethod belonging to the customer associated with the invoice being paid.", "maxLength": 5000, "type": "string" }, "source": { "description": "A payment source to be charged. The source must be the ID of a source belonging to the customer associated with the invoice being paid.", "maxLength": 5000, "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/invoice" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Pay an invoice" } }, "/v1/invoices/{invoice}/remove_lines": { "post": { "description": "

Removes multiple line items from an invoice. This is only possible when an invoice is still a draft.

", "operationId": "PostInvoicesInvoiceRemoveLines", "parameters": [ { "in": "path", "name": "invoice", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "invoice_metadata": { "explode": true, "style": "deepObject" }, "lines": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "invoice_metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "lines": { "description": "The line items to remove.", "items": { "properties": { "behavior": { "description": "Either `delete` or `unassign`. Deleted line items are permanently deleted. Unassigned line items can be reassigned to an invoice.", "enum": [ "delete", "unassign" ], "type": "string" }, "id": { "description": "ID of an existing line item to remove from this invoice.", "maxLength": 5000, "type": "string" } }, "required": [ "behavior", "id" ], "title": "lines_data_param", "type": "object", "x-stripeMostCommon": [ "behavior", "id" ] }, "type": "array" } }, "required": [ "lines" ], "type": "object", "x-stripeMostCommon": [ "invoice_metadata", "lines" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/invoice" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Bulk remove invoice line items" } }, "/v1/invoices/{invoice}/send": { "post": { "description": "

Stripe will automatically send invoices to customers according to your subscriptions settings. However, if you’d like to manually send an invoice to your customer out of the normal schedule, you can do so. When sending invoices that have already been paid, there will be no reference to the payment in the email.

\n\n

Requests made in test-mode result in no emails being sent, despite sending an invoice.sent event.

", "operationId": "PostInvoicesInvoiceSend", "parameters": [ { "in": "path", "name": "invoice", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/invoice" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Send an invoice for manual payment" } }, "/v1/invoices/{invoice}/update_lines": { "post": { "description": "

Updates multiple line items on an invoice. This is only possible when an invoice is still a draft.

", "operationId": "PostInvoicesInvoiceUpdateLines", "parameters": [ { "in": "path", "name": "invoice", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "invoice_metadata": { "explode": true, "style": "deepObject" }, "lines": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "invoice_metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`. For [type=subscription](https://stripe.com/docs/api/invoices/line_item#invoice_line_item_object-type) line items, the incoming metadata specified on the request is directly used to set this value, in contrast to [type=invoiceitem](api/invoices/line_item#invoice_line_item_object-type) line items, where any existing metadata on the invoice line is merged with the incoming data." }, "lines": { "description": "The line items to update.", "items": { "properties": { "amount": { "description": "The integer amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. If you want to apply a credit to the customer's account, pass a negative amount.", "type": "integer" }, "description": { "description": "An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking.", "maxLength": 5000, "type": "string" }, "discountable": { "description": "Controls whether discounts apply to this line item. Defaults to false for prorations or negative line items, and true for all other line items. Cannot be set to true for prorations.", "type": "boolean" }, "discounts": { "anyOf": [ { "items": { "properties": { "coupon": { "description": "ID of the coupon to create a new discount for.", "maxLength": 5000, "type": "string" }, "discount": { "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", "maxLength": 5000, "type": "string" }, "discount_end": { "description": "Details to determine how long the discount should be applied for.", "properties": { "duration": { "description": "Time span for the redeemed discount.", "properties": { "interval": { "description": "Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.", "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "description": "The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.", "type": "integer" } }, "required": [ "interval", "interval_count" ], "title": "discount_end_duration_specs", "type": "object", "x-stripeMostCommon": [ "interval", "interval_count" ] }, "timestamp": { "description": "A precise Unix timestamp for the discount to end. Must be in the future.", "format": "unix-time", "type": "integer" }, "type": { "description": "The type of calculation made to determine when the discount ends.", "enum": [ "duration", "timestamp" ], "type": "string" } }, "required": [ "type" ], "title": "discount_end", "type": "object", "x-stripeMostCommon": [ "duration", "timestamp", "type" ] }, "promotion_code": { "description": "ID of the promotion code to create a new discount for.", "maxLength": 5000, "type": "string" } }, "title": "discounts_data_param", "type": "object", "x-stripeMostCommon": [ "coupon" ] }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The coupons, promotion codes & existing discounts which apply to the line item. Item discounts are applied before invoice discounts. Pass an empty string to remove previously-defined discounts." }, "id": { "description": "ID of an existing line item on the invoice.", "maxLength": 5000, "type": "string" }, "margins": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The IDs of the margins to apply to the line item. When set, the `default_margins` on the invoice do not apply to this line item." }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`. For [type=subscription](https://stripe.com/docs/api/invoices/line_item#invoice_line_item_object-type) line items, the incoming metadata specified on the request is directly used to set this value, in contrast to [type=invoiceitem](api/invoices/line_item#invoice_line_item_object-type) line items, where any existing metadata on the invoice line is merged with the incoming data." }, "period": { "description": "The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details.", "properties": { "end": { "description": "The end of the period, which must be greater than or equal to the start. This value is inclusive.", "format": "unix-time", "type": "integer" }, "start": { "description": "The start of the period. This value is inclusive.", "format": "unix-time", "type": "integer" } }, "required": [ "end", "start" ], "title": "period", "type": "object", "x-stripeMostCommon": [ "end", "start" ] }, "price_data": { "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.", "properties": { "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "product": { "description": "The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to. One of `product` or `product_data` is required.", "maxLength": 5000, "type": "string" }, "product_data": { "description": "Data used to generate a new [Product](https://docs.stripe.com/api/products) object inline. One of `product` or `product_data` is required.", "properties": { "description": { "description": "The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.", "maxLength": 40000, "type": "string" }, "images": { "description": "A list of up to 8 URLs of images for this product, meant to be displayable to the customer.", "items": { "type": "string" }, "type": "array" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "name": { "description": "The product's name, meant to be displayable to the customer.", "maxLength": 5000, "type": "string" }, "tax_code": { "description": "A [tax code](https://stripe.com/docs/tax/tax-categories) ID.", "maxLength": 5000, "type": "string" } }, "required": [ "name" ], "title": "product_data", "type": "object", "x-stripeMostCommon": [ "description", "images", "metadata", "name", "tax_code", "unit_label" ] }, "tax_behavior": { "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.", "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" }, "unit_amount": { "description": "A non-negative integer in cents (or local equivalent) representing how much to charge. One of `unit_amount` or `unit_amount_decimal` is required.", "type": "integer" }, "unit_amount_decimal": { "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", "format": "decimal", "type": "string" } }, "required": [ "currency" ], "title": "one_time_price_data_with_product_data", "type": "object", "x-stripeMostCommon": [ "currency", "product", "unit_amount" ] }, "pricing": { "description": "The pricing information for the invoice item.", "properties": { "price": { "description": "The ID of the price object.", "maxLength": 5000, "type": "string" } }, "title": "pricing_param", "type": "object", "x-stripeMostCommon": [ "price" ] }, "quantity": { "description": "Non-negative integer. The quantity of units for the line item.", "type": "integer" }, "tax_amounts": { "anyOf": [ { "items": { "properties": { "amount": { "description": "The amount, in cents (or local equivalent), of the tax.", "type": "integer" }, "tax_rate_data": { "description": "Data to find or create a TaxRate object.\n\nStripe automatically creates or reuses a TaxRate object for each tax amount. If the `tax_rate_data` exactly matches a previous value, Stripe will reuse the TaxRate object. TaxRate objects created automatically by Stripe are immediately archived, do not appear in the line item’s `tax_rates`, and cannot be directly added to invoices, payments, or line items.", "properties": { "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "description": { "description": "An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.", "maxLength": 5000, "type": "string" }, "display_name": { "description": "The display name of the tax rate, which will be shown to users.", "maxLength": 100, "type": "string" }, "inclusive": { "description": "This specifies if the tax rate is inclusive or exclusive.", "type": "boolean" }, "jurisdiction": { "description": "The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.", "maxLength": 200, "type": "string" }, "jurisdiction_level": { "description": "The level of the jurisdiction that imposes this tax rate.", "enum": [ "city", "country", "county", "district", "multiple", "state" ], "type": "string" }, "percentage": { "description": "The statutory tax rate percent. This field accepts decimal values between 0 and 100 inclusive with at most 4 decimal places. To accommodate fixed-amount taxes, set the percentage to zero. Stripe will not display zero percentages on the invoice unless the `amount` of the tax is also zero.", "type": "number" }, "state": { "description": "[ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country prefix. For example, \"NY\" for New York, United States.", "maxLength": 5000, "type": "string" }, "tax_type": { "description": "The high-level tax type, such as `vat` or `sales_tax`.", "enum": [ "amusement_tax", "communications_tax", "gst", "hst", "igst", "jct", "lease_tax", "pst", "qst", "retail_delivery_fee", "rst", "sales_tax", "service_tax", "vat" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "display_name", "inclusive", "percentage" ], "title": "tax_rate_data_param", "type": "object", "x-stripeMostCommon": [ "country", "description", "display_name", "inclusive", "jurisdiction", "jurisdiction_level", "percentage", "state", "tax_type" ] }, "taxability_reason": { "description": "The reasoning behind this tax, for example, if the product is tax exempt.", "enum": [ "customer_exempt", "not_collecting", "not_subject_to_tax", "not_supported", "portion_product_exempt", "portion_reduced_rated", "portion_standard_rated", "product_exempt", "product_exempt_holiday", "proportionally_rated", "reduced_rated", "reverse_charge", "standard_rated", "taxable_basis_reduced", "zero_rated" ], "type": "string", "x-stripeBypassValidation": true }, "taxable_amount": { "description": "The amount on which tax is calculated, in cents (or local equivalent).", "type": "integer" } }, "required": [ "amount", "tax_rate_data", "taxable_amount" ], "title": "tax_amount_param", "type": "object", "x-stripeMostCommon": [ "amount", "tax_rate_data", "taxability_reason", "taxable_amount" ] }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "A list of up to 10 tax amounts for this line item. This can be useful if you calculate taxes on your own or use a third-party to calculate them. You cannot set tax amounts if any line item has [tax_rates](https://stripe.com/docs/api/invoices/line_item#invoice_line_item_object-tax_rates) or if the invoice has [default_tax_rates](https://stripe.com/docs/api/invoices/object#invoice_object-default_tax_rates) or uses [automatic tax](https://stripe.com/docs/tax/invoicing). Pass an empty string to remove previously defined tax amounts." }, "tax_rates": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The tax rates which apply to the line item. When set, the `default_tax_rates` on the invoice do not apply to this line item. Pass an empty string to remove previously-defined tax rates." } }, "required": [ "id" ], "title": "lines_data_param", "type": "object", "x-stripeMostCommon": [ "amount", "description", "id", "metadata", "period", "pricing", "quantity" ] }, "type": "array" } }, "required": [ "lines" ], "type": "object", "x-stripeMostCommon": [ "invoice_metadata", "lines" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/invoice" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Bulk update invoice line items" } }, "/v1/invoices/{invoice}/void": { "post": { "description": "

Mark a finalized invoice as void. This cannot be undone. Voiding an invoice is similar to deletion, however it only applies to finalized invoices and maintains a papertrail where the invoice can still be found.

\n\n

Consult with local regulations to determine whether and how an invoice might be amended, canceled, or voided in the jurisdiction you’re doing business in. You might need to issue another invoice or credit note instead. Stripe recommends that you consult with your legal counsel for advice specific to your business.

", "operationId": "PostInvoicesInvoiceVoid", "parameters": [ { "in": "path", "name": "invoice", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/invoice" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Void an invoice" } }, "/v1/issuing/authorizations": { "get": { "description": "

Returns a list of Issuing Authorization objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

", "operationId": "GetIssuingAuthorizations", "parameters": [ { "description": "Only return authorizations that belong to the given card.", "in": "query", "name": "card", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Only return authorizations that belong to the given cardholder.", "in": "query", "name": "cardholder", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Only return authorizations that were created during the given date interval.", "explode": true, "in": "query", "name": "created", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "description": "Minimum value to filter by (exclusive)", "type": "integer" }, "gte": { "description": "Minimum value to filter by (inclusive)", "type": "integer" }, "lt": { "description": "Maximum value to filter by (exclusive)", "type": "integer" }, "lte": { "description": "Maximum value to filter by (inclusive)", "type": "integer" } }, "title": "range_query_specs", "type": "object", "x-stripeMostCommon": [ "gt", "gte", "lt", "lte" ] }, { "type": "integer" } ] }, "style": "deepObject" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Only return authorizations with the given status. One of `pending`, `closed`, or `reversed`.", "in": "query", "name": "status", "required": false, "schema": { "enum": [ "closed", "expired", "pending", "reversed" ], "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/issuing.authorization" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/issuing/authorizations", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "IssuingAuthorizationList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all authorizations" } }, "/v1/issuing/authorizations/{authorization}": { "get": { "description": "

Retrieves an Issuing Authorization object.

", "operationId": "GetIssuingAuthorizationsAuthorization", "parameters": [ { "in": "path", "name": "authorization", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issuing.authorization" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve an authorization" }, "post": { "description": "

Updates the specified Issuing Authorization object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

", "operationId": "PostIssuingAuthorizationsAuthorization", "parameters": [ { "in": "path", "name": "authorization", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." } }, "type": "object", "x-stripeMostCommon": [ "metadata" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issuing.authorization" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update an authorization" } }, "/v1/issuing/authorizations/{authorization}/approve": { "post": { "deprecated": true, "description": "

[Deprecated] Approves a pending Issuing Authorization object. This request should be made within the timeout window of the real-time authorization flow. \nThis method is deprecated. Instead, respond directly to the webhook request to approve an authorization.

", "operationId": "PostIssuingAuthorizationsAuthorizationApprove", "parameters": [ { "in": "path", "name": "authorization", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "amount": { "description": "If the authorization's `pending_request.is_amount_controllable` property is `true`, you may provide this value to control how much to hold for the authorization. Must be positive (use [`decline`](https://stripe.com/docs/api/issuing/authorizations/decline) to decline an authorization request).", "type": "integer" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." } }, "type": "object", "x-stripeMostCommon": [ "amount", "metadata" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issuing.authorization" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Approve an authorization" } }, "/v1/issuing/authorizations/{authorization}/decline": { "post": { "deprecated": true, "description": "

[Deprecated] Declines a pending Issuing Authorization object. This request should be made within the timeout window of the real time authorization flow.\nThis method is deprecated. Instead, respond directly to the webhook request to decline an authorization.

", "operationId": "PostIssuingAuthorizationsAuthorizationDecline", "parameters": [ { "in": "path", "name": "authorization", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." } }, "type": "object", "x-stripeMostCommon": [ "metadata" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issuing.authorization" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Decline an authorization" } }, "/v1/issuing/cardholders": { "get": { "description": "

Returns a list of Issuing Cardholder objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

", "operationId": "GetIssuingCardholders", "parameters": [ { "description": "Only return cardholders that were created during the given date interval.", "explode": true, "in": "query", "name": "created", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "description": "Minimum value to filter by (exclusive)", "type": "integer" }, "gte": { "description": "Minimum value to filter by (inclusive)", "type": "integer" }, "lt": { "description": "Maximum value to filter by (exclusive)", "type": "integer" }, "lte": { "description": "Maximum value to filter by (inclusive)", "type": "integer" } }, "title": "range_query_specs", "type": "object", "x-stripeMostCommon": [ "gt", "gte", "lt", "lte" ] }, { "type": "integer" } ] }, "style": "deepObject" }, { "description": "Only return cardholders that have the given email address.", "in": "query", "name": "email", "required": false, "schema": { "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "Only return cardholders that have the given phone number.", "in": "query", "name": "phone_number", "required": false, "schema": { "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Only return cardholders that have the given status. One of `active`, `inactive`, or `blocked`.", "in": "query", "name": "status", "required": false, "schema": { "enum": [ "active", "blocked", "inactive" ], "type": "string" }, "style": "form" }, { "description": "Only return cardholders that have the given type. One of `individual` or `company`.", "in": "query", "name": "type", "required": false, "schema": { "enum": [ "company", "individual" ], "type": "string", "x-stripeBypassValidation": true }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/issuing.cardholder" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/issuing/cardholders", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "IssuingCardholderList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all cardholders" }, "post": { "description": "

Creates a new Issuing Cardholder object that can be issued cards.

", "operationId": "PostIssuingCardholders", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "billing": { "explode": true, "style": "deepObject" }, "company": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "individual": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "preferred_locales": { "explode": true, "style": "deepObject" }, "spending_controls": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "billing": { "description": "The cardholder's billing address.", "properties": { "address": { "description": "The cardholder’s billing address.", "properties": { "city": { "description": "City, district, suburb, town, or village.", "maxLength": 5000, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Address line 1 (e.g., street, PO Box, or company name).", "maxLength": 5000, "type": "string" }, "line2": { "description": "Address line 2 (e.g., apartment, suite, unit, or building).", "maxLength": 5000, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "State, county, province, or region.", "maxLength": 5000, "type": "string" } }, "required": [ "city", "country", "line1", "postal_code" ], "title": "required_address", "type": "object", "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state" ] } }, "required": [ "address" ], "title": "billing_specs", "type": "object", "x-stripeMostCommon": [ "address" ] }, "company": { "description": "Additional information about a `company` cardholder.", "properties": { "tax_id": { "description": "The entity's business ID number.", "maxLength": 5000, "type": "string" } }, "title": "company_param", "type": "object", "x-stripeMostCommon": [ "tax_id" ] }, "email": { "description": "The cardholder's email address.", "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "individual": { "description": "Additional information about an `individual` cardholder.", "properties": { "card_issuing": { "description": "Information related to the card_issuing program for this cardholder.", "properties": { "user_terms_acceptance": { "description": "Information about cardholder acceptance of Celtic [Authorized User Terms](https://stripe.com/docs/issuing/cards#accept-authorized-user-terms). Required for cards backed by a Celtic program.", "properties": { "date": { "description": "The Unix timestamp marking when the cardholder accepted the Authorized User Terms. Required for Celtic Spend Card users.", "format": "unix-time", "type": "integer" }, "ip": { "description": "The IP address from which the cardholder accepted the Authorized User Terms. Required for Celtic Spend Card users.", "type": "string" }, "user_agent": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "The user agent of the browser from which the cardholder accepted the Authorized User Terms." } }, "title": "terms_acceptance_param", "type": "object", "x-stripeMostCommon": [ "date", "ip", "user_agent" ] } }, "title": "card_issuing_param", "type": "object", "x-stripeMostCommon": [ "user_terms_acceptance" ] }, "dob": { "description": "The date of birth of this cardholder. Cardholders must be older than 13 years old.", "properties": { "day": { "description": "The day of birth, between 1 and 31.", "type": "integer" }, "month": { "description": "The month of birth, between 1 and 12.", "type": "integer" }, "year": { "description": "The four-digit year of birth.", "type": "integer" } }, "required": [ "day", "month", "year" ], "title": "date_of_birth_specs", "type": "object", "x-stripeMostCommon": [ "day", "month", "year" ] }, "first_name": { "description": "The first name of this cardholder. Required before activating Cards. This field cannot contain any numbers, special characters (except periods, commas, hyphens, spaces and apostrophes) or non-latin letters.", "type": "string" }, "last_name": { "description": "The last name of this cardholder. Required before activating Cards. This field cannot contain any numbers, special characters (except periods, commas, hyphens, spaces and apostrophes) or non-latin letters.", "type": "string" }, "verification": { "description": "Government-issued ID document for this cardholder.", "properties": { "document": { "description": "An identifying document, either a passport or local ID card.", "properties": { "back": { "description": "The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`.", "maxLength": 5000, "type": "string" }, "front": { "description": "The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`.", "maxLength": 5000, "type": "string" } }, "title": "person_verification_document_param", "type": "object", "x-stripeMostCommon": [ "back", "front" ] } }, "title": "person_verification_param", "type": "object", "x-stripeMostCommon": [ "document" ] } }, "title": "individual_param", "type": "object", "x-stripeMostCommon": [ "card_issuing", "dob", "first_name", "last_name", "user_terms_acceptance", "verification" ] }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "name": { "description": "The cardholder's name. This will be printed on cards issued to them. The maximum length of this field is 24 characters. This field cannot contain any special characters or numbers.", "type": "string" }, "phone_number": { "description": "The cardholder's phone number. This will be transformed to [E.164](https://en.wikipedia.org/wiki/E.164) if it is not provided in that format already. This is required for all cardholders who will be creating EU cards.\n While phone number is optional if the cardholder will not be creating EU cards, note that this cardholder will not be eligible for 3DS without a phone number. See the [3D Secure documentation](https://stripe.com/docs/issuing/3d-secure#when-is-3d-secure-applied) for more details.", "type": "string" }, "preferred_locales": { "description": "The cardholder’s preferred locales (languages), ordered by preference. Locales can be `de`, `en`, `es`, `fr`, or `it`.\n This changes the language of the [3D Secure flow](https://stripe.com/docs/issuing/3d-secure) and one-time password messages sent to the cardholder.", "items": { "enum": [ "de", "en", "es", "fr", "it" ], "type": "string" }, "type": "array" }, "spending_controls": { "description": "Rules that control spending across this cardholder's cards. Refer to our [documentation](https://stripe.com/docs/issuing/controls/spending-controls) for more details.", "properties": { "allowed_categories": { "description": "Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to allow. All other categories will be blocked. Cannot be set with `blocked_categories`.", "items": { "enum": [ "ac_refrigeration_repair", "accounting_bookkeeping_services", "advertising_services", "agricultural_cooperative", "airlines_air_carriers", "airports_flying_fields", "ambulance_services", "amusement_parks_carnivals", "antique_reproductions", "antique_shops", "aquariums", "architectural_surveying_services", "art_dealers_and_galleries", "artists_supply_and_craft_shops", "auto_and_home_supply_stores", "auto_body_repair_shops", "auto_paint_shops", "auto_service_shops", "automated_cash_disburse", "automated_fuel_dispensers", "automobile_associations", "automotive_parts_and_accessories_stores", "automotive_tire_stores", "bail_and_bond_payments", "bakeries", "bands_orchestras", "barber_and_beauty_shops", "betting_casino_gambling", "bicycle_shops", "billiard_pool_establishments", "boat_dealers", "boat_rentals_and_leases", "book_stores", "books_periodicals_and_newspapers", "bowling_alleys", "bus_lines", "business_secretarial_schools", "buying_shopping_services", "cable_satellite_and_other_pay_television_and_radio", "camera_and_photographic_supply_stores", "candy_nut_and_confectionery_stores", "car_and_truck_dealers_new_used", "car_and_truck_dealers_used_only", "car_rental_agencies", "car_washes", "carpentry_services", "carpet_upholstery_cleaning", "caterers", "charitable_and_social_service_organizations_fundraising", "chemicals_and_allied_products", "child_care_services", "childrens_and_infants_wear_stores", "chiropodists_podiatrists", "chiropractors", "cigar_stores_and_stands", "civic_social_fraternal_associations", "cleaning_and_maintenance", "clothing_rental", "colleges_universities", "commercial_equipment", "commercial_footwear", "commercial_photography_art_and_graphics", "commuter_transport_and_ferries", "computer_network_services", "computer_programming", "computer_repair", "computer_software_stores", "computers_peripherals_and_software", "concrete_work_services", "construction_materials", "consulting_public_relations", "correspondence_schools", "cosmetic_stores", "counseling_services", "country_clubs", "courier_services", "court_costs", "credit_reporting_agencies", "cruise_lines", "dairy_products_stores", "dance_hall_studios_schools", "dating_escort_services", "dentists_orthodontists", "department_stores", "detective_agencies", "digital_goods_applications", "digital_goods_games", "digital_goods_large_volume", "digital_goods_media", "direct_marketing_catalog_merchant", "direct_marketing_combination_catalog_and_retail_merchant", "direct_marketing_inbound_telemarketing", "direct_marketing_insurance_services", "direct_marketing_other", "direct_marketing_outbound_telemarketing", "direct_marketing_subscription", "direct_marketing_travel", "discount_stores", "doctors", "door_to_door_sales", "drapery_window_covering_and_upholstery_stores", "drinking_places", "drug_stores_and_pharmacies", "drugs_drug_proprietaries_and_druggist_sundries", "dry_cleaners", "durable_goods", "duty_free_stores", "eating_places_restaurants", "educational_services", "electric_razor_stores", "electric_vehicle_charging", "electrical_parts_and_equipment", "electrical_services", "electronics_repair_shops", "electronics_stores", "elementary_secondary_schools", "emergency_services_gcas_visa_use_only", "employment_temp_agencies", "equipment_rental", "exterminating_services", "family_clothing_stores", "fast_food_restaurants", "financial_institutions", "fines_government_administrative_entities", "fireplace_fireplace_screens_and_accessories_stores", "floor_covering_stores", "florists", "florists_supplies_nursery_stock_and_flowers", "freezer_and_locker_meat_provisioners", "fuel_dealers_non_automotive", "funeral_services_crematories", "furniture_home_furnishings_and_equipment_stores_except_appliances", "furniture_repair_refinishing", "furriers_and_fur_shops", "general_services", "gift_card_novelty_and_souvenir_shops", "glass_paint_and_wallpaper_stores", "glassware_crystal_stores", "golf_courses_public", "government_licensed_horse_dog_racing_us_region_only", "government_licensed_online_casions_online_gambling_us_region_only", "government_owned_lotteries_non_us_region", "government_owned_lotteries_us_region_only", "government_services", "grocery_stores_supermarkets", "hardware_equipment_and_supplies", "hardware_stores", "health_and_beauty_spas", "hearing_aids_sales_and_supplies", "heating_plumbing_a_c", "hobby_toy_and_game_shops", "home_supply_warehouse_stores", "hospitals", "hotels_motels_and_resorts", "household_appliance_stores", "industrial_supplies", "information_retrieval_services", "insurance_default", "insurance_underwriting_premiums", "intra_company_purchases", "jewelry_stores_watches_clocks_and_silverware_stores", "landscaping_services", "laundries", "laundry_cleaning_services", "legal_services_attorneys", "luggage_and_leather_goods_stores", "lumber_building_materials_stores", "manual_cash_disburse", "marinas_service_and_supplies", "marketplaces", "masonry_stonework_and_plaster", "massage_parlors", "medical_and_dental_labs", "medical_dental_ophthalmic_and_hospital_equipment_and_supplies", "medical_services", "membership_organizations", "mens_and_boys_clothing_and_accessories_stores", "mens_womens_clothing_stores", "metal_service_centers", "miscellaneous", "miscellaneous_apparel_and_accessory_shops", "miscellaneous_auto_dealers", "miscellaneous_business_services", "miscellaneous_food_stores", "miscellaneous_general_merchandise", "miscellaneous_general_services", "miscellaneous_home_furnishing_specialty_stores", "miscellaneous_publishing_and_printing", "miscellaneous_recreation_services", "miscellaneous_repair_shops", "miscellaneous_specialty_retail", "mobile_home_dealers", "motion_picture_theaters", "motor_freight_carriers_and_trucking", "motor_homes_dealers", "motor_vehicle_supplies_and_new_parts", "motorcycle_shops_and_dealers", "motorcycle_shops_dealers", "music_stores_musical_instruments_pianos_and_sheet_music", "news_dealers_and_newsstands", "non_fi_money_orders", "non_fi_stored_value_card_purchase_load", "nondurable_goods", "nurseries_lawn_and_garden_supply_stores", "nursing_personal_care", "office_and_commercial_furniture", "opticians_eyeglasses", "optometrists_ophthalmologist", "orthopedic_goods_prosthetic_devices", "osteopaths", "package_stores_beer_wine_and_liquor", "paints_varnishes_and_supplies", "parking_lots_garages", "passenger_railways", "pawn_shops", "pet_shops_pet_food_and_supplies", "petroleum_and_petroleum_products", "photo_developing", "photographic_photocopy_microfilm_equipment_and_supplies", "photographic_studios", "picture_video_production", "piece_goods_notions_and_other_dry_goods", "plumbing_heating_equipment_and_supplies", "political_organizations", "postal_services_government_only", "precious_stones_and_metals_watches_and_jewelry", "professional_services", "public_warehousing_and_storage", "quick_copy_repro_and_blueprint", "railroads", "real_estate_agents_and_managers_rentals", "record_stores", "recreational_vehicle_rentals", "religious_goods_stores", "religious_organizations", "roofing_siding_sheet_metal", "secretarial_support_services", "security_brokers_dealers", "service_stations", "sewing_needlework_fabric_and_piece_goods_stores", "shoe_repair_hat_cleaning", "shoe_stores", "small_appliance_repair", "snowmobile_dealers", "special_trade_services", "specialty_cleaning", "sporting_goods_stores", "sporting_recreation_camps", "sports_and_riding_apparel_stores", "sports_clubs_fields", "stamp_and_coin_stores", "stationary_office_supplies_printing_and_writing_paper", "stationery_stores_office_and_school_supply_stores", "swimming_pools_sales", "t_ui_travel_germany", "tailors_alterations", "tax_payments_government_agencies", "tax_preparation_services", "taxicabs_limousines", "telecommunication_equipment_and_telephone_sales", "telecommunication_services", "telegraph_services", "tent_and_awning_shops", "testing_laboratories", "theatrical_ticket_agencies", "timeshares", "tire_retreading_and_repair", "tolls_bridge_fees", "tourist_attractions_and_exhibits", "towing_services", "trailer_parks_campgrounds", "transportation_services", "travel_agencies_tour_operators", "truck_stop_iteration", "truck_utility_trailer_rentals", "typesetting_plate_making_and_related_services", "typewriter_stores", "u_s_federal_government_agencies_or_departments", "uniforms_commercial_clothing", "used_merchandise_and_secondhand_stores", "utilities", "variety_stores", "veterinary_services", "video_amusement_game_supplies", "video_game_arcades", "video_tape_rental_stores", "vocational_trade_schools", "watch_jewelry_repair", "welding_repair", "wholesale_clubs", "wig_and_toupee_stores", "wires_money_orders", "womens_accessory_and_specialty_shops", "womens_ready_to_wear_stores", "wrecking_and_salvage_yards" ], "maxLength": 5000, "type": "string" }, "type": "array" }, "allowed_merchant_countries": { "description": "Array of strings containing representing countries from which authorizations will be allowed. Authorizations from merchants in all other countries will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `blocked_merchant_countries`. Provide an empty value to unset this control.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "blocked_categories": { "description": "Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to decline. All other categories will be allowed. Cannot be set with `allowed_categories`.", "items": { "enum": [ "ac_refrigeration_repair", "accounting_bookkeeping_services", "advertising_services", "agricultural_cooperative", "airlines_air_carriers", "airports_flying_fields", "ambulance_services", "amusement_parks_carnivals", "antique_reproductions", "antique_shops", "aquariums", "architectural_surveying_services", "art_dealers_and_galleries", "artists_supply_and_craft_shops", "auto_and_home_supply_stores", "auto_body_repair_shops", "auto_paint_shops", "auto_service_shops", "automated_cash_disburse", "automated_fuel_dispensers", "automobile_associations", "automotive_parts_and_accessories_stores", "automotive_tire_stores", "bail_and_bond_payments", "bakeries", "bands_orchestras", "barber_and_beauty_shops", "betting_casino_gambling", "bicycle_shops", "billiard_pool_establishments", "boat_dealers", "boat_rentals_and_leases", "book_stores", "books_periodicals_and_newspapers", "bowling_alleys", "bus_lines", "business_secretarial_schools", "buying_shopping_services", "cable_satellite_and_other_pay_television_and_radio", "camera_and_photographic_supply_stores", "candy_nut_and_confectionery_stores", "car_and_truck_dealers_new_used", "car_and_truck_dealers_used_only", "car_rental_agencies", "car_washes", "carpentry_services", "carpet_upholstery_cleaning", "caterers", "charitable_and_social_service_organizations_fundraising", "chemicals_and_allied_products", "child_care_services", "childrens_and_infants_wear_stores", "chiropodists_podiatrists", "chiropractors", "cigar_stores_and_stands", "civic_social_fraternal_associations", "cleaning_and_maintenance", "clothing_rental", "colleges_universities", "commercial_equipment", "commercial_footwear", "commercial_photography_art_and_graphics", "commuter_transport_and_ferries", "computer_network_services", "computer_programming", "computer_repair", "computer_software_stores", "computers_peripherals_and_software", "concrete_work_services", "construction_materials", "consulting_public_relations", "correspondence_schools", "cosmetic_stores", "counseling_services", "country_clubs", "courier_services", "court_costs", "credit_reporting_agencies", "cruise_lines", "dairy_products_stores", "dance_hall_studios_schools", "dating_escort_services", "dentists_orthodontists", "department_stores", "detective_agencies", "digital_goods_applications", "digital_goods_games", "digital_goods_large_volume", "digital_goods_media", "direct_marketing_catalog_merchant", "direct_marketing_combination_catalog_and_retail_merchant", "direct_marketing_inbound_telemarketing", "direct_marketing_insurance_services", "direct_marketing_other", "direct_marketing_outbound_telemarketing", "direct_marketing_subscription", "direct_marketing_travel", "discount_stores", "doctors", "door_to_door_sales", "drapery_window_covering_and_upholstery_stores", "drinking_places", "drug_stores_and_pharmacies", "drugs_drug_proprietaries_and_druggist_sundries", "dry_cleaners", "durable_goods", "duty_free_stores", "eating_places_restaurants", "educational_services", "electric_razor_stores", "electric_vehicle_charging", "electrical_parts_and_equipment", "electrical_services", "electronics_repair_shops", "electronics_stores", "elementary_secondary_schools", "emergency_services_gcas_visa_use_only", "employment_temp_agencies", "equipment_rental", "exterminating_services", "family_clothing_stores", "fast_food_restaurants", "financial_institutions", "fines_government_administrative_entities", "fireplace_fireplace_screens_and_accessories_stores", "floor_covering_stores", "florists", "florists_supplies_nursery_stock_and_flowers", "freezer_and_locker_meat_provisioners", "fuel_dealers_non_automotive", "funeral_services_crematories", "furniture_home_furnishings_and_equipment_stores_except_appliances", "furniture_repair_refinishing", "furriers_and_fur_shops", "general_services", "gift_card_novelty_and_souvenir_shops", "glass_paint_and_wallpaper_stores", "glassware_crystal_stores", "golf_courses_public", "government_licensed_horse_dog_racing_us_region_only", "government_licensed_online_casions_online_gambling_us_region_only", "government_owned_lotteries_non_us_region", "government_owned_lotteries_us_region_only", "government_services", "grocery_stores_supermarkets", "hardware_equipment_and_supplies", "hardware_stores", "health_and_beauty_spas", "hearing_aids_sales_and_supplies", "heating_plumbing_a_c", "hobby_toy_and_game_shops", "home_supply_warehouse_stores", "hospitals", "hotels_motels_and_resorts", "household_appliance_stores", "industrial_supplies", "information_retrieval_services", "insurance_default", "insurance_underwriting_premiums", "intra_company_purchases", "jewelry_stores_watches_clocks_and_silverware_stores", "landscaping_services", "laundries", "laundry_cleaning_services", "legal_services_attorneys", "luggage_and_leather_goods_stores", "lumber_building_materials_stores", "manual_cash_disburse", "marinas_service_and_supplies", "marketplaces", "masonry_stonework_and_plaster", "massage_parlors", "medical_and_dental_labs", "medical_dental_ophthalmic_and_hospital_equipment_and_supplies", "medical_services", "membership_organizations", "mens_and_boys_clothing_and_accessories_stores", "mens_womens_clothing_stores", "metal_service_centers", "miscellaneous", "miscellaneous_apparel_and_accessory_shops", "miscellaneous_auto_dealers", "miscellaneous_business_services", "miscellaneous_food_stores", "miscellaneous_general_merchandise", "miscellaneous_general_services", "miscellaneous_home_furnishing_specialty_stores", "miscellaneous_publishing_and_printing", "miscellaneous_recreation_services", "miscellaneous_repair_shops", "miscellaneous_specialty_retail", "mobile_home_dealers", "motion_picture_theaters", "motor_freight_carriers_and_trucking", "motor_homes_dealers", "motor_vehicle_supplies_and_new_parts", "motorcycle_shops_and_dealers", "motorcycle_shops_dealers", "music_stores_musical_instruments_pianos_and_sheet_music", "news_dealers_and_newsstands", "non_fi_money_orders", "non_fi_stored_value_card_purchase_load", "nondurable_goods", "nurseries_lawn_and_garden_supply_stores", "nursing_personal_care", "office_and_commercial_furniture", "opticians_eyeglasses", "optometrists_ophthalmologist", "orthopedic_goods_prosthetic_devices", "osteopaths", "package_stores_beer_wine_and_liquor", "paints_varnishes_and_supplies", "parking_lots_garages", "passenger_railways", "pawn_shops", "pet_shops_pet_food_and_supplies", "petroleum_and_petroleum_products", "photo_developing", "photographic_photocopy_microfilm_equipment_and_supplies", "photographic_studios", "picture_video_production", "piece_goods_notions_and_other_dry_goods", "plumbing_heating_equipment_and_supplies", "political_organizations", "postal_services_government_only", "precious_stones_and_metals_watches_and_jewelry", "professional_services", "public_warehousing_and_storage", "quick_copy_repro_and_blueprint", "railroads", "real_estate_agents_and_managers_rentals", "record_stores", "recreational_vehicle_rentals", "religious_goods_stores", "religious_organizations", "roofing_siding_sheet_metal", "secretarial_support_services", "security_brokers_dealers", "service_stations", "sewing_needlework_fabric_and_piece_goods_stores", "shoe_repair_hat_cleaning", "shoe_stores", "small_appliance_repair", "snowmobile_dealers", "special_trade_services", "specialty_cleaning", "sporting_goods_stores", "sporting_recreation_camps", "sports_and_riding_apparel_stores", "sports_clubs_fields", "stamp_and_coin_stores", "stationary_office_supplies_printing_and_writing_paper", "stationery_stores_office_and_school_supply_stores", "swimming_pools_sales", "t_ui_travel_germany", "tailors_alterations", "tax_payments_government_agencies", "tax_preparation_services", "taxicabs_limousines", "telecommunication_equipment_and_telephone_sales", "telecommunication_services", "telegraph_services", "tent_and_awning_shops", "testing_laboratories", "theatrical_ticket_agencies", "timeshares", "tire_retreading_and_repair", "tolls_bridge_fees", "tourist_attractions_and_exhibits", "towing_services", "trailer_parks_campgrounds", "transportation_services", "travel_agencies_tour_operators", "truck_stop_iteration", "truck_utility_trailer_rentals", "typesetting_plate_making_and_related_services", "typewriter_stores", "u_s_federal_government_agencies_or_departments", "uniforms_commercial_clothing", "used_merchandise_and_secondhand_stores", "utilities", "variety_stores", "veterinary_services", "video_amusement_game_supplies", "video_game_arcades", "video_tape_rental_stores", "vocational_trade_schools", "watch_jewelry_repair", "welding_repair", "wholesale_clubs", "wig_and_toupee_stores", "wires_money_orders", "womens_accessory_and_specialty_shops", "womens_ready_to_wear_stores", "wrecking_and_salvage_yards" ], "maxLength": 5000, "type": "string" }, "type": "array" }, "blocked_merchant_countries": { "description": "Array of strings containing representing countries from which authorizations will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `allowed_merchant_countries`. Provide an empty value to unset this control.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "spending_limits": { "description": "Limit spending with amount-based rules that apply across this cardholder's cards.", "items": { "properties": { "amount": { "description": "Maximum amount allowed to spend per interval.", "type": "integer" }, "categories": { "description": "Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) this limit applies to. Omitting this field will apply the limit to all categories.", "items": { "enum": [ "ac_refrigeration_repair", "accounting_bookkeeping_services", "advertising_services", "agricultural_cooperative", "airlines_air_carriers", "airports_flying_fields", "ambulance_services", "amusement_parks_carnivals", "antique_reproductions", "antique_shops", "aquariums", "architectural_surveying_services", "art_dealers_and_galleries", "artists_supply_and_craft_shops", "auto_and_home_supply_stores", "auto_body_repair_shops", "auto_paint_shops", "auto_service_shops", "automated_cash_disburse", "automated_fuel_dispensers", "automobile_associations", "automotive_parts_and_accessories_stores", "automotive_tire_stores", "bail_and_bond_payments", "bakeries", "bands_orchestras", "barber_and_beauty_shops", "betting_casino_gambling", "bicycle_shops", "billiard_pool_establishments", "boat_dealers", "boat_rentals_and_leases", "book_stores", "books_periodicals_and_newspapers", "bowling_alleys", "bus_lines", "business_secretarial_schools", "buying_shopping_services", "cable_satellite_and_other_pay_television_and_radio", "camera_and_photographic_supply_stores", "candy_nut_and_confectionery_stores", "car_and_truck_dealers_new_used", "car_and_truck_dealers_used_only", "car_rental_agencies", "car_washes", "carpentry_services", "carpet_upholstery_cleaning", "caterers", "charitable_and_social_service_organizations_fundraising", "chemicals_and_allied_products", "child_care_services", "childrens_and_infants_wear_stores", "chiropodists_podiatrists", "chiropractors", "cigar_stores_and_stands", "civic_social_fraternal_associations", "cleaning_and_maintenance", "clothing_rental", "colleges_universities", "commercial_equipment", "commercial_footwear", "commercial_photography_art_and_graphics", "commuter_transport_and_ferries", "computer_network_services", "computer_programming", "computer_repair", "computer_software_stores", "computers_peripherals_and_software", "concrete_work_services", "construction_materials", "consulting_public_relations", "correspondence_schools", "cosmetic_stores", "counseling_services", "country_clubs", "courier_services", "court_costs", "credit_reporting_agencies", "cruise_lines", "dairy_products_stores", "dance_hall_studios_schools", "dating_escort_services", "dentists_orthodontists", "department_stores", "detective_agencies", "digital_goods_applications", "digital_goods_games", "digital_goods_large_volume", "digital_goods_media", "direct_marketing_catalog_merchant", "direct_marketing_combination_catalog_and_retail_merchant", "direct_marketing_inbound_telemarketing", "direct_marketing_insurance_services", "direct_marketing_other", "direct_marketing_outbound_telemarketing", "direct_marketing_subscription", "direct_marketing_travel", "discount_stores", "doctors", "door_to_door_sales", "drapery_window_covering_and_upholstery_stores", "drinking_places", "drug_stores_and_pharmacies", "drugs_drug_proprietaries_and_druggist_sundries", "dry_cleaners", "durable_goods", "duty_free_stores", "eating_places_restaurants", "educational_services", "electric_razor_stores", "electric_vehicle_charging", "electrical_parts_and_equipment", "electrical_services", "electronics_repair_shops", "electronics_stores", "elementary_secondary_schools", "emergency_services_gcas_visa_use_only", "employment_temp_agencies", "equipment_rental", "exterminating_services", "family_clothing_stores", "fast_food_restaurants", "financial_institutions", "fines_government_administrative_entities", "fireplace_fireplace_screens_and_accessories_stores", "floor_covering_stores", "florists", "florists_supplies_nursery_stock_and_flowers", "freezer_and_locker_meat_provisioners", "fuel_dealers_non_automotive", "funeral_services_crematories", "furniture_home_furnishings_and_equipment_stores_except_appliances", "furniture_repair_refinishing", "furriers_and_fur_shops", "general_services", "gift_card_novelty_and_souvenir_shops", "glass_paint_and_wallpaper_stores", "glassware_crystal_stores", "golf_courses_public", "government_licensed_horse_dog_racing_us_region_only", "government_licensed_online_casions_online_gambling_us_region_only", "government_owned_lotteries_non_us_region", "government_owned_lotteries_us_region_only", "government_services", "grocery_stores_supermarkets", "hardware_equipment_and_supplies", "hardware_stores", "health_and_beauty_spas", "hearing_aids_sales_and_supplies", "heating_plumbing_a_c", "hobby_toy_and_game_shops", "home_supply_warehouse_stores", "hospitals", "hotels_motels_and_resorts", "household_appliance_stores", "industrial_supplies", "information_retrieval_services", "insurance_default", "insurance_underwriting_premiums", "intra_company_purchases", "jewelry_stores_watches_clocks_and_silverware_stores", "landscaping_services", "laundries", "laundry_cleaning_services", "legal_services_attorneys", "luggage_and_leather_goods_stores", "lumber_building_materials_stores", "manual_cash_disburse", "marinas_service_and_supplies", "marketplaces", "masonry_stonework_and_plaster", "massage_parlors", "medical_and_dental_labs", "medical_dental_ophthalmic_and_hospital_equipment_and_supplies", "medical_services", "membership_organizations", "mens_and_boys_clothing_and_accessories_stores", "mens_womens_clothing_stores", "metal_service_centers", "miscellaneous", "miscellaneous_apparel_and_accessory_shops", "miscellaneous_auto_dealers", "miscellaneous_business_services", "miscellaneous_food_stores", "miscellaneous_general_merchandise", "miscellaneous_general_services", "miscellaneous_home_furnishing_specialty_stores", "miscellaneous_publishing_and_printing", "miscellaneous_recreation_services", "miscellaneous_repair_shops", "miscellaneous_specialty_retail", "mobile_home_dealers", "motion_picture_theaters", "motor_freight_carriers_and_trucking", "motor_homes_dealers", "motor_vehicle_supplies_and_new_parts", "motorcycle_shops_and_dealers", "motorcycle_shops_dealers", "music_stores_musical_instruments_pianos_and_sheet_music", "news_dealers_and_newsstands", "non_fi_money_orders", "non_fi_stored_value_card_purchase_load", "nondurable_goods", "nurseries_lawn_and_garden_supply_stores", "nursing_personal_care", "office_and_commercial_furniture", "opticians_eyeglasses", "optometrists_ophthalmologist", "orthopedic_goods_prosthetic_devices", "osteopaths", "package_stores_beer_wine_and_liquor", "paints_varnishes_and_supplies", "parking_lots_garages", "passenger_railways", "pawn_shops", "pet_shops_pet_food_and_supplies", "petroleum_and_petroleum_products", "photo_developing", "photographic_photocopy_microfilm_equipment_and_supplies", "photographic_studios", "picture_video_production", "piece_goods_notions_and_other_dry_goods", "plumbing_heating_equipment_and_supplies", "political_organizations", "postal_services_government_only", "precious_stones_and_metals_watches_and_jewelry", "professional_services", "public_warehousing_and_storage", "quick_copy_repro_and_blueprint", "railroads", "real_estate_agents_and_managers_rentals", "record_stores", "recreational_vehicle_rentals", "religious_goods_stores", "religious_organizations", "roofing_siding_sheet_metal", "secretarial_support_services", "security_brokers_dealers", "service_stations", "sewing_needlework_fabric_and_piece_goods_stores", "shoe_repair_hat_cleaning", "shoe_stores", "small_appliance_repair", "snowmobile_dealers", "special_trade_services", "specialty_cleaning", "sporting_goods_stores", "sporting_recreation_camps", "sports_and_riding_apparel_stores", "sports_clubs_fields", "stamp_and_coin_stores", "stationary_office_supplies_printing_and_writing_paper", "stationery_stores_office_and_school_supply_stores", "swimming_pools_sales", "t_ui_travel_germany", "tailors_alterations", "tax_payments_government_agencies", "tax_preparation_services", "taxicabs_limousines", "telecommunication_equipment_and_telephone_sales", "telecommunication_services", "telegraph_services", "tent_and_awning_shops", "testing_laboratories", "theatrical_ticket_agencies", "timeshares", "tire_retreading_and_repair", "tolls_bridge_fees", "tourist_attractions_and_exhibits", "towing_services", "trailer_parks_campgrounds", "transportation_services", "travel_agencies_tour_operators", "truck_stop_iteration", "truck_utility_trailer_rentals", "typesetting_plate_making_and_related_services", "typewriter_stores", "u_s_federal_government_agencies_or_departments", "uniforms_commercial_clothing", "used_merchandise_and_secondhand_stores", "utilities", "variety_stores", "veterinary_services", "video_amusement_game_supplies", "video_game_arcades", "video_tape_rental_stores", "vocational_trade_schools", "watch_jewelry_repair", "welding_repair", "wholesale_clubs", "wig_and_toupee_stores", "wires_money_orders", "womens_accessory_and_specialty_shops", "womens_ready_to_wear_stores", "wrecking_and_salvage_yards" ], "maxLength": 5000, "type": "string" }, "type": "array" }, "interval": { "description": "Interval (or event) to which the amount applies.", "enum": [ "all_time", "daily", "monthly", "per_authorization", "weekly", "yearly" ], "type": "string" } }, "required": [ "amount", "interval" ], "title": "spending_limits_param", "type": "object", "x-stripeMostCommon": [ "amount", "categories", "interval" ] }, "type": "array" }, "spending_limits_currency": { "description": "Currency of amounts within `spending_limits`. Defaults to your merchant country's currency.", "type": "string" } }, "title": "authorization_controls_param_v2", "type": "object", "x-stripeMostCommon": [ "allowed_categories", "allowed_merchant_countries", "allowed_merchant_network_ids", "blocked_categories", "blocked_merchant_countries", "blocked_merchant_network_ids", "spending_limits", "spending_limits_currency" ] }, "status": { "description": "Specifies whether to permit authorizations on this cardholder's cards. Defaults to `active`.", "enum": [ "active", "inactive" ], "type": "string" }, "type": { "description": "One of `individual` or `company`. See [Choose a cardholder type](https://stripe.com/docs/issuing/other/choose-cardholder) for more details.", "enum": [ "company", "individual" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "billing", "name" ], "type": "object", "x-stripeMostCommon": [ "billing", "email", "metadata", "name", "phone_number" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issuing.cardholder" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a cardholder" } }, "/v1/issuing/cardholders/{cardholder}": { "get": { "description": "

Retrieves an Issuing Cardholder object.

", "operationId": "GetIssuingCardholdersCardholder", "parameters": [ { "in": "path", "name": "cardholder", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issuing.cardholder" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a cardholder" }, "post": { "description": "

Updates the specified Issuing Cardholder object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

", "operationId": "PostIssuingCardholdersCardholder", "parameters": [ { "in": "path", "name": "cardholder", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "billing": { "explode": true, "style": "deepObject" }, "company": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "individual": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "preferred_locales": { "explode": true, "style": "deepObject" }, "spending_controls": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "billing": { "description": "The cardholder's billing address.", "properties": { "address": { "description": "The cardholder’s billing address.", "properties": { "city": { "description": "City, district, suburb, town, or village.", "maxLength": 5000, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Address line 1 (e.g., street, PO Box, or company name).", "maxLength": 5000, "type": "string" }, "line2": { "description": "Address line 2 (e.g., apartment, suite, unit, or building).", "maxLength": 5000, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "State, county, province, or region.", "maxLength": 5000, "type": "string" } }, "required": [ "city", "country", "line1", "postal_code" ], "title": "required_address", "type": "object", "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state" ] } }, "required": [ "address" ], "title": "billing_specs", "type": "object", "x-stripeMostCommon": [ "address" ] }, "company": { "description": "Additional information about a `company` cardholder.", "properties": { "tax_id": { "description": "The entity's business ID number.", "maxLength": 5000, "type": "string" } }, "title": "company_param", "type": "object", "x-stripeMostCommon": [ "tax_id" ] }, "email": { "description": "The cardholder's email address.", "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "individual": { "description": "Additional information about an `individual` cardholder.", "properties": { "card_issuing": { "description": "Information related to the card_issuing program for this cardholder.", "properties": { "user_terms_acceptance": { "description": "Information about cardholder acceptance of Celtic [Authorized User Terms](https://stripe.com/docs/issuing/cards#accept-authorized-user-terms). Required for cards backed by a Celtic program.", "properties": { "date": { "description": "The Unix timestamp marking when the cardholder accepted the Authorized User Terms. Required for Celtic Spend Card users.", "format": "unix-time", "type": "integer" }, "ip": { "description": "The IP address from which the cardholder accepted the Authorized User Terms. Required for Celtic Spend Card users.", "type": "string" }, "user_agent": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "The user agent of the browser from which the cardholder accepted the Authorized User Terms." } }, "title": "terms_acceptance_param", "type": "object", "x-stripeMostCommon": [ "date", "ip", "user_agent" ] } }, "title": "card_issuing_param", "type": "object", "x-stripeMostCommon": [ "user_terms_acceptance" ] }, "dob": { "description": "The date of birth of this cardholder. Cardholders must be older than 13 years old.", "properties": { "day": { "description": "The day of birth, between 1 and 31.", "type": "integer" }, "month": { "description": "The month of birth, between 1 and 12.", "type": "integer" }, "year": { "description": "The four-digit year of birth.", "type": "integer" } }, "required": [ "day", "month", "year" ], "title": "date_of_birth_specs", "type": "object", "x-stripeMostCommon": [ "day", "month", "year" ] }, "first_name": { "description": "The first name of this cardholder. Required before activating Cards. This field cannot contain any numbers, special characters (except periods, commas, hyphens, spaces and apostrophes) or non-latin letters.", "type": "string" }, "last_name": { "description": "The last name of this cardholder. Required before activating Cards. This field cannot contain any numbers, special characters (except periods, commas, hyphens, spaces and apostrophes) or non-latin letters.", "type": "string" }, "verification": { "description": "Government-issued ID document for this cardholder.", "properties": { "document": { "description": "An identifying document, either a passport or local ID card.", "properties": { "back": { "description": "The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`.", "maxLength": 5000, "type": "string" }, "front": { "description": "The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`.", "maxLength": 5000, "type": "string" } }, "title": "person_verification_document_param", "type": "object", "x-stripeMostCommon": [ "back", "front" ] } }, "title": "person_verification_param", "type": "object", "x-stripeMostCommon": [ "document" ] } }, "title": "individual_param", "type": "object", "x-stripeMostCommon": [ "card_issuing", "dob", "first_name", "last_name", "user_terms_acceptance", "verification" ] }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "phone_number": { "description": "The cardholder's phone number. This is required for all cardholders who will be creating EU cards. See the [3D Secure documentation](https://stripe.com/docs/issuing/3d-secure) for more details.", "type": "string" }, "preferred_locales": { "description": "The cardholder’s preferred locales (languages), ordered by preference. Locales can be `de`, `en`, `es`, `fr`, or `it`.\n This changes the language of the [3D Secure flow](https://stripe.com/docs/issuing/3d-secure) and one-time password messages sent to the cardholder.", "items": { "enum": [ "de", "en", "es", "fr", "it" ], "type": "string" }, "type": "array" }, "spending_controls": { "description": "Rules that control spending across this cardholder's cards. Refer to our [documentation](https://stripe.com/docs/issuing/controls/spending-controls) for more details.", "properties": { "allowed_categories": { "description": "Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to allow. All other categories will be blocked. Cannot be set with `blocked_categories`.", "items": { "enum": [ "ac_refrigeration_repair", "accounting_bookkeeping_services", "advertising_services", "agricultural_cooperative", "airlines_air_carriers", "airports_flying_fields", "ambulance_services", "amusement_parks_carnivals", "antique_reproductions", "antique_shops", "aquariums", "architectural_surveying_services", "art_dealers_and_galleries", "artists_supply_and_craft_shops", "auto_and_home_supply_stores", "auto_body_repair_shops", "auto_paint_shops", "auto_service_shops", "automated_cash_disburse", "automated_fuel_dispensers", "automobile_associations", "automotive_parts_and_accessories_stores", "automotive_tire_stores", "bail_and_bond_payments", "bakeries", "bands_orchestras", "barber_and_beauty_shops", "betting_casino_gambling", "bicycle_shops", "billiard_pool_establishments", "boat_dealers", "boat_rentals_and_leases", "book_stores", "books_periodicals_and_newspapers", "bowling_alleys", "bus_lines", "business_secretarial_schools", "buying_shopping_services", "cable_satellite_and_other_pay_television_and_radio", "camera_and_photographic_supply_stores", "candy_nut_and_confectionery_stores", "car_and_truck_dealers_new_used", "car_and_truck_dealers_used_only", "car_rental_agencies", "car_washes", "carpentry_services", "carpet_upholstery_cleaning", "caterers", "charitable_and_social_service_organizations_fundraising", "chemicals_and_allied_products", "child_care_services", "childrens_and_infants_wear_stores", "chiropodists_podiatrists", "chiropractors", "cigar_stores_and_stands", "civic_social_fraternal_associations", "cleaning_and_maintenance", "clothing_rental", "colleges_universities", "commercial_equipment", "commercial_footwear", "commercial_photography_art_and_graphics", "commuter_transport_and_ferries", "computer_network_services", "computer_programming", "computer_repair", "computer_software_stores", "computers_peripherals_and_software", "concrete_work_services", "construction_materials", "consulting_public_relations", "correspondence_schools", "cosmetic_stores", "counseling_services", "country_clubs", "courier_services", "court_costs", "credit_reporting_agencies", "cruise_lines", "dairy_products_stores", "dance_hall_studios_schools", "dating_escort_services", "dentists_orthodontists", "department_stores", "detective_agencies", "digital_goods_applications", "digital_goods_games", "digital_goods_large_volume", "digital_goods_media", "direct_marketing_catalog_merchant", "direct_marketing_combination_catalog_and_retail_merchant", "direct_marketing_inbound_telemarketing", "direct_marketing_insurance_services", "direct_marketing_other", "direct_marketing_outbound_telemarketing", "direct_marketing_subscription", "direct_marketing_travel", "discount_stores", "doctors", "door_to_door_sales", "drapery_window_covering_and_upholstery_stores", "drinking_places", "drug_stores_and_pharmacies", "drugs_drug_proprietaries_and_druggist_sundries", "dry_cleaners", "durable_goods", "duty_free_stores", "eating_places_restaurants", "educational_services", "electric_razor_stores", "electric_vehicle_charging", "electrical_parts_and_equipment", "electrical_services", "electronics_repair_shops", "electronics_stores", "elementary_secondary_schools", "emergency_services_gcas_visa_use_only", "employment_temp_agencies", "equipment_rental", "exterminating_services", "family_clothing_stores", "fast_food_restaurants", "financial_institutions", "fines_government_administrative_entities", "fireplace_fireplace_screens_and_accessories_stores", "floor_covering_stores", "florists", "florists_supplies_nursery_stock_and_flowers", "freezer_and_locker_meat_provisioners", "fuel_dealers_non_automotive", "funeral_services_crematories", "furniture_home_furnishings_and_equipment_stores_except_appliances", "furniture_repair_refinishing", "furriers_and_fur_shops", "general_services", "gift_card_novelty_and_souvenir_shops", "glass_paint_and_wallpaper_stores", "glassware_crystal_stores", "golf_courses_public", "government_licensed_horse_dog_racing_us_region_only", "government_licensed_online_casions_online_gambling_us_region_only", "government_owned_lotteries_non_us_region", "government_owned_lotteries_us_region_only", "government_services", "grocery_stores_supermarkets", "hardware_equipment_and_supplies", "hardware_stores", "health_and_beauty_spas", "hearing_aids_sales_and_supplies", "heating_plumbing_a_c", "hobby_toy_and_game_shops", "home_supply_warehouse_stores", "hospitals", "hotels_motels_and_resorts", "household_appliance_stores", "industrial_supplies", "information_retrieval_services", "insurance_default", "insurance_underwriting_premiums", "intra_company_purchases", "jewelry_stores_watches_clocks_and_silverware_stores", "landscaping_services", "laundries", "laundry_cleaning_services", "legal_services_attorneys", "luggage_and_leather_goods_stores", "lumber_building_materials_stores", "manual_cash_disburse", "marinas_service_and_supplies", "marketplaces", "masonry_stonework_and_plaster", "massage_parlors", "medical_and_dental_labs", "medical_dental_ophthalmic_and_hospital_equipment_and_supplies", "medical_services", "membership_organizations", "mens_and_boys_clothing_and_accessories_stores", "mens_womens_clothing_stores", "metal_service_centers", "miscellaneous", "miscellaneous_apparel_and_accessory_shops", "miscellaneous_auto_dealers", "miscellaneous_business_services", "miscellaneous_food_stores", "miscellaneous_general_merchandise", "miscellaneous_general_services", "miscellaneous_home_furnishing_specialty_stores", "miscellaneous_publishing_and_printing", "miscellaneous_recreation_services", "miscellaneous_repair_shops", "miscellaneous_specialty_retail", "mobile_home_dealers", "motion_picture_theaters", "motor_freight_carriers_and_trucking", "motor_homes_dealers", "motor_vehicle_supplies_and_new_parts", "motorcycle_shops_and_dealers", "motorcycle_shops_dealers", "music_stores_musical_instruments_pianos_and_sheet_music", "news_dealers_and_newsstands", "non_fi_money_orders", "non_fi_stored_value_card_purchase_load", "nondurable_goods", "nurseries_lawn_and_garden_supply_stores", "nursing_personal_care", "office_and_commercial_furniture", "opticians_eyeglasses", "optometrists_ophthalmologist", "orthopedic_goods_prosthetic_devices", "osteopaths", "package_stores_beer_wine_and_liquor", "paints_varnishes_and_supplies", "parking_lots_garages", "passenger_railways", "pawn_shops", "pet_shops_pet_food_and_supplies", "petroleum_and_petroleum_products", "photo_developing", "photographic_photocopy_microfilm_equipment_and_supplies", "photographic_studios", "picture_video_production", "piece_goods_notions_and_other_dry_goods", "plumbing_heating_equipment_and_supplies", "political_organizations", "postal_services_government_only", "precious_stones_and_metals_watches_and_jewelry", "professional_services", "public_warehousing_and_storage", "quick_copy_repro_and_blueprint", "railroads", "real_estate_agents_and_managers_rentals", "record_stores", "recreational_vehicle_rentals", "religious_goods_stores", "religious_organizations", "roofing_siding_sheet_metal", "secretarial_support_services", "security_brokers_dealers", "service_stations", "sewing_needlework_fabric_and_piece_goods_stores", "shoe_repair_hat_cleaning", "shoe_stores", "small_appliance_repair", "snowmobile_dealers", "special_trade_services", "specialty_cleaning", "sporting_goods_stores", "sporting_recreation_camps", "sports_and_riding_apparel_stores", "sports_clubs_fields", "stamp_and_coin_stores", "stationary_office_supplies_printing_and_writing_paper", "stationery_stores_office_and_school_supply_stores", "swimming_pools_sales", "t_ui_travel_germany", "tailors_alterations", "tax_payments_government_agencies", "tax_preparation_services", "taxicabs_limousines", "telecommunication_equipment_and_telephone_sales", "telecommunication_services", "telegraph_services", "tent_and_awning_shops", "testing_laboratories", "theatrical_ticket_agencies", "timeshares", "tire_retreading_and_repair", "tolls_bridge_fees", "tourist_attractions_and_exhibits", "towing_services", "trailer_parks_campgrounds", "transportation_services", "travel_agencies_tour_operators", "truck_stop_iteration", "truck_utility_trailer_rentals", "typesetting_plate_making_and_related_services", "typewriter_stores", "u_s_federal_government_agencies_or_departments", "uniforms_commercial_clothing", "used_merchandise_and_secondhand_stores", "utilities", "variety_stores", "veterinary_services", "video_amusement_game_supplies", "video_game_arcades", "video_tape_rental_stores", "vocational_trade_schools", "watch_jewelry_repair", "welding_repair", "wholesale_clubs", "wig_and_toupee_stores", "wires_money_orders", "womens_accessory_and_specialty_shops", "womens_ready_to_wear_stores", "wrecking_and_salvage_yards" ], "maxLength": 5000, "type": "string" }, "type": "array" }, "allowed_merchant_countries": { "description": "Array of strings containing representing countries from which authorizations will be allowed. Authorizations from merchants in all other countries will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `blocked_merchant_countries`. Provide an empty value to unset this control.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "blocked_categories": { "description": "Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to decline. All other categories will be allowed. Cannot be set with `allowed_categories`.", "items": { "enum": [ "ac_refrigeration_repair", "accounting_bookkeeping_services", "advertising_services", "agricultural_cooperative", "airlines_air_carriers", "airports_flying_fields", "ambulance_services", "amusement_parks_carnivals", "antique_reproductions", "antique_shops", "aquariums", "architectural_surveying_services", "art_dealers_and_galleries", "artists_supply_and_craft_shops", "auto_and_home_supply_stores", "auto_body_repair_shops", "auto_paint_shops", "auto_service_shops", "automated_cash_disburse", "automated_fuel_dispensers", "automobile_associations", "automotive_parts_and_accessories_stores", "automotive_tire_stores", "bail_and_bond_payments", "bakeries", "bands_orchestras", "barber_and_beauty_shops", "betting_casino_gambling", "bicycle_shops", "billiard_pool_establishments", "boat_dealers", "boat_rentals_and_leases", "book_stores", "books_periodicals_and_newspapers", "bowling_alleys", "bus_lines", "business_secretarial_schools", "buying_shopping_services", "cable_satellite_and_other_pay_television_and_radio", "camera_and_photographic_supply_stores", "candy_nut_and_confectionery_stores", "car_and_truck_dealers_new_used", "car_and_truck_dealers_used_only", "car_rental_agencies", "car_washes", "carpentry_services", "carpet_upholstery_cleaning", "caterers", "charitable_and_social_service_organizations_fundraising", "chemicals_and_allied_products", "child_care_services", "childrens_and_infants_wear_stores", "chiropodists_podiatrists", "chiropractors", "cigar_stores_and_stands", "civic_social_fraternal_associations", "cleaning_and_maintenance", "clothing_rental", "colleges_universities", "commercial_equipment", "commercial_footwear", "commercial_photography_art_and_graphics", "commuter_transport_and_ferries", "computer_network_services", "computer_programming", "computer_repair", "computer_software_stores", "computers_peripherals_and_software", "concrete_work_services", "construction_materials", "consulting_public_relations", "correspondence_schools", "cosmetic_stores", "counseling_services", "country_clubs", "courier_services", "court_costs", "credit_reporting_agencies", "cruise_lines", "dairy_products_stores", "dance_hall_studios_schools", "dating_escort_services", "dentists_orthodontists", "department_stores", "detective_agencies", "digital_goods_applications", "digital_goods_games", "digital_goods_large_volume", "digital_goods_media", "direct_marketing_catalog_merchant", "direct_marketing_combination_catalog_and_retail_merchant", "direct_marketing_inbound_telemarketing", "direct_marketing_insurance_services", "direct_marketing_other", "direct_marketing_outbound_telemarketing", "direct_marketing_subscription", "direct_marketing_travel", "discount_stores", "doctors", "door_to_door_sales", "drapery_window_covering_and_upholstery_stores", "drinking_places", "drug_stores_and_pharmacies", "drugs_drug_proprietaries_and_druggist_sundries", "dry_cleaners", "durable_goods", "duty_free_stores", "eating_places_restaurants", "educational_services", "electric_razor_stores", "electric_vehicle_charging", "electrical_parts_and_equipment", "electrical_services", "electronics_repair_shops", "electronics_stores", "elementary_secondary_schools", "emergency_services_gcas_visa_use_only", "employment_temp_agencies", "equipment_rental", "exterminating_services", "family_clothing_stores", "fast_food_restaurants", "financial_institutions", "fines_government_administrative_entities", "fireplace_fireplace_screens_and_accessories_stores", "floor_covering_stores", "florists", "florists_supplies_nursery_stock_and_flowers", "freezer_and_locker_meat_provisioners", "fuel_dealers_non_automotive", "funeral_services_crematories", "furniture_home_furnishings_and_equipment_stores_except_appliances", "furniture_repair_refinishing", "furriers_and_fur_shops", "general_services", "gift_card_novelty_and_souvenir_shops", "glass_paint_and_wallpaper_stores", "glassware_crystal_stores", "golf_courses_public", "government_licensed_horse_dog_racing_us_region_only", "government_licensed_online_casions_online_gambling_us_region_only", "government_owned_lotteries_non_us_region", "government_owned_lotteries_us_region_only", "government_services", "grocery_stores_supermarkets", "hardware_equipment_and_supplies", "hardware_stores", "health_and_beauty_spas", "hearing_aids_sales_and_supplies", "heating_plumbing_a_c", "hobby_toy_and_game_shops", "home_supply_warehouse_stores", "hospitals", "hotels_motels_and_resorts", "household_appliance_stores", "industrial_supplies", "information_retrieval_services", "insurance_default", "insurance_underwriting_premiums", "intra_company_purchases", "jewelry_stores_watches_clocks_and_silverware_stores", "landscaping_services", "laundries", "laundry_cleaning_services", "legal_services_attorneys", "luggage_and_leather_goods_stores", "lumber_building_materials_stores", "manual_cash_disburse", "marinas_service_and_supplies", "marketplaces", "masonry_stonework_and_plaster", "massage_parlors", "medical_and_dental_labs", "medical_dental_ophthalmic_and_hospital_equipment_and_supplies", "medical_services", "membership_organizations", "mens_and_boys_clothing_and_accessories_stores", "mens_womens_clothing_stores", "metal_service_centers", "miscellaneous", "miscellaneous_apparel_and_accessory_shops", "miscellaneous_auto_dealers", "miscellaneous_business_services", "miscellaneous_food_stores", "miscellaneous_general_merchandise", "miscellaneous_general_services", "miscellaneous_home_furnishing_specialty_stores", "miscellaneous_publishing_and_printing", "miscellaneous_recreation_services", "miscellaneous_repair_shops", "miscellaneous_specialty_retail", "mobile_home_dealers", "motion_picture_theaters", "motor_freight_carriers_and_trucking", "motor_homes_dealers", "motor_vehicle_supplies_and_new_parts", "motorcycle_shops_and_dealers", "motorcycle_shops_dealers", "music_stores_musical_instruments_pianos_and_sheet_music", "news_dealers_and_newsstands", "non_fi_money_orders", "non_fi_stored_value_card_purchase_load", "nondurable_goods", "nurseries_lawn_and_garden_supply_stores", "nursing_personal_care", "office_and_commercial_furniture", "opticians_eyeglasses", "optometrists_ophthalmologist", "orthopedic_goods_prosthetic_devices", "osteopaths", "package_stores_beer_wine_and_liquor", "paints_varnishes_and_supplies", "parking_lots_garages", "passenger_railways", "pawn_shops", "pet_shops_pet_food_and_supplies", "petroleum_and_petroleum_products", "photo_developing", "photographic_photocopy_microfilm_equipment_and_supplies", "photographic_studios", "picture_video_production", "piece_goods_notions_and_other_dry_goods", "plumbing_heating_equipment_and_supplies", "political_organizations", "postal_services_government_only", "precious_stones_and_metals_watches_and_jewelry", "professional_services", "public_warehousing_and_storage", "quick_copy_repro_and_blueprint", "railroads", "real_estate_agents_and_managers_rentals", "record_stores", "recreational_vehicle_rentals", "religious_goods_stores", "religious_organizations", "roofing_siding_sheet_metal", "secretarial_support_services", "security_brokers_dealers", "service_stations", "sewing_needlework_fabric_and_piece_goods_stores", "shoe_repair_hat_cleaning", "shoe_stores", "small_appliance_repair", "snowmobile_dealers", "special_trade_services", "specialty_cleaning", "sporting_goods_stores", "sporting_recreation_camps", "sports_and_riding_apparel_stores", "sports_clubs_fields", "stamp_and_coin_stores", "stationary_office_supplies_printing_and_writing_paper", "stationery_stores_office_and_school_supply_stores", "swimming_pools_sales", "t_ui_travel_germany", "tailors_alterations", "tax_payments_government_agencies", "tax_preparation_services", "taxicabs_limousines", "telecommunication_equipment_and_telephone_sales", "telecommunication_services", "telegraph_services", "tent_and_awning_shops", "testing_laboratories", "theatrical_ticket_agencies", "timeshares", "tire_retreading_and_repair", "tolls_bridge_fees", "tourist_attractions_and_exhibits", "towing_services", "trailer_parks_campgrounds", "transportation_services", "travel_agencies_tour_operators", "truck_stop_iteration", "truck_utility_trailer_rentals", "typesetting_plate_making_and_related_services", "typewriter_stores", "u_s_federal_government_agencies_or_departments", "uniforms_commercial_clothing", "used_merchandise_and_secondhand_stores", "utilities", "variety_stores", "veterinary_services", "video_amusement_game_supplies", "video_game_arcades", "video_tape_rental_stores", "vocational_trade_schools", "watch_jewelry_repair", "welding_repair", "wholesale_clubs", "wig_and_toupee_stores", "wires_money_orders", "womens_accessory_and_specialty_shops", "womens_ready_to_wear_stores", "wrecking_and_salvage_yards" ], "maxLength": 5000, "type": "string" }, "type": "array" }, "blocked_merchant_countries": { "description": "Array of strings containing representing countries from which authorizations will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `allowed_merchant_countries`. Provide an empty value to unset this control.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "spending_limits": { "description": "Limit spending with amount-based rules that apply across this cardholder's cards.", "items": { "properties": { "amount": { "description": "Maximum amount allowed to spend per interval.", "type": "integer" }, "categories": { "description": "Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) this limit applies to. Omitting this field will apply the limit to all categories.", "items": { "enum": [ "ac_refrigeration_repair", "accounting_bookkeeping_services", "advertising_services", "agricultural_cooperative", "airlines_air_carriers", "airports_flying_fields", "ambulance_services", "amusement_parks_carnivals", "antique_reproductions", "antique_shops", "aquariums", "architectural_surveying_services", "art_dealers_and_galleries", "artists_supply_and_craft_shops", "auto_and_home_supply_stores", "auto_body_repair_shops", "auto_paint_shops", "auto_service_shops", "automated_cash_disburse", "automated_fuel_dispensers", "automobile_associations", "automotive_parts_and_accessories_stores", "automotive_tire_stores", "bail_and_bond_payments", "bakeries", "bands_orchestras", "barber_and_beauty_shops", "betting_casino_gambling", "bicycle_shops", "billiard_pool_establishments", "boat_dealers", "boat_rentals_and_leases", "book_stores", "books_periodicals_and_newspapers", "bowling_alleys", "bus_lines", "business_secretarial_schools", "buying_shopping_services", "cable_satellite_and_other_pay_television_and_radio", "camera_and_photographic_supply_stores", "candy_nut_and_confectionery_stores", "car_and_truck_dealers_new_used", "car_and_truck_dealers_used_only", "car_rental_agencies", "car_washes", "carpentry_services", "carpet_upholstery_cleaning", "caterers", "charitable_and_social_service_organizations_fundraising", "chemicals_and_allied_products", "child_care_services", "childrens_and_infants_wear_stores", "chiropodists_podiatrists", "chiropractors", "cigar_stores_and_stands", "civic_social_fraternal_associations", "cleaning_and_maintenance", "clothing_rental", "colleges_universities", "commercial_equipment", "commercial_footwear", "commercial_photography_art_and_graphics", "commuter_transport_and_ferries", "computer_network_services", "computer_programming", "computer_repair", "computer_software_stores", "computers_peripherals_and_software", "concrete_work_services", "construction_materials", "consulting_public_relations", "correspondence_schools", "cosmetic_stores", "counseling_services", "country_clubs", "courier_services", "court_costs", "credit_reporting_agencies", "cruise_lines", "dairy_products_stores", "dance_hall_studios_schools", "dating_escort_services", "dentists_orthodontists", "department_stores", "detective_agencies", "digital_goods_applications", "digital_goods_games", "digital_goods_large_volume", "digital_goods_media", "direct_marketing_catalog_merchant", "direct_marketing_combination_catalog_and_retail_merchant", "direct_marketing_inbound_telemarketing", "direct_marketing_insurance_services", "direct_marketing_other", "direct_marketing_outbound_telemarketing", "direct_marketing_subscription", "direct_marketing_travel", "discount_stores", "doctors", "door_to_door_sales", "drapery_window_covering_and_upholstery_stores", "drinking_places", "drug_stores_and_pharmacies", "drugs_drug_proprietaries_and_druggist_sundries", "dry_cleaners", "durable_goods", "duty_free_stores", "eating_places_restaurants", "educational_services", "electric_razor_stores", "electric_vehicle_charging", "electrical_parts_and_equipment", "electrical_services", "electronics_repair_shops", "electronics_stores", "elementary_secondary_schools", "emergency_services_gcas_visa_use_only", "employment_temp_agencies", "equipment_rental", "exterminating_services", "family_clothing_stores", "fast_food_restaurants", "financial_institutions", "fines_government_administrative_entities", "fireplace_fireplace_screens_and_accessories_stores", "floor_covering_stores", "florists", "florists_supplies_nursery_stock_and_flowers", "freezer_and_locker_meat_provisioners", "fuel_dealers_non_automotive", "funeral_services_crematories", "furniture_home_furnishings_and_equipment_stores_except_appliances", "furniture_repair_refinishing", "furriers_and_fur_shops", "general_services", "gift_card_novelty_and_souvenir_shops", "glass_paint_and_wallpaper_stores", "glassware_crystal_stores", "golf_courses_public", "government_licensed_horse_dog_racing_us_region_only", "government_licensed_online_casions_online_gambling_us_region_only", "government_owned_lotteries_non_us_region", "government_owned_lotteries_us_region_only", "government_services", "grocery_stores_supermarkets", "hardware_equipment_and_supplies", "hardware_stores", "health_and_beauty_spas", "hearing_aids_sales_and_supplies", "heating_plumbing_a_c", "hobby_toy_and_game_shops", "home_supply_warehouse_stores", "hospitals", "hotels_motels_and_resorts", "household_appliance_stores", "industrial_supplies", "information_retrieval_services", "insurance_default", "insurance_underwriting_premiums", "intra_company_purchases", "jewelry_stores_watches_clocks_and_silverware_stores", "landscaping_services", "laundries", "laundry_cleaning_services", "legal_services_attorneys", "luggage_and_leather_goods_stores", "lumber_building_materials_stores", "manual_cash_disburse", "marinas_service_and_supplies", "marketplaces", "masonry_stonework_and_plaster", "massage_parlors", "medical_and_dental_labs", "medical_dental_ophthalmic_and_hospital_equipment_and_supplies", "medical_services", "membership_organizations", "mens_and_boys_clothing_and_accessories_stores", "mens_womens_clothing_stores", "metal_service_centers", "miscellaneous", "miscellaneous_apparel_and_accessory_shops", "miscellaneous_auto_dealers", "miscellaneous_business_services", "miscellaneous_food_stores", "miscellaneous_general_merchandise", "miscellaneous_general_services", "miscellaneous_home_furnishing_specialty_stores", "miscellaneous_publishing_and_printing", "miscellaneous_recreation_services", "miscellaneous_repair_shops", "miscellaneous_specialty_retail", "mobile_home_dealers", "motion_picture_theaters", "motor_freight_carriers_and_trucking", "motor_homes_dealers", "motor_vehicle_supplies_and_new_parts", "motorcycle_shops_and_dealers", "motorcycle_shops_dealers", "music_stores_musical_instruments_pianos_and_sheet_music", "news_dealers_and_newsstands", "non_fi_money_orders", "non_fi_stored_value_card_purchase_load", "nondurable_goods", "nurseries_lawn_and_garden_supply_stores", "nursing_personal_care", "office_and_commercial_furniture", "opticians_eyeglasses", "optometrists_ophthalmologist", "orthopedic_goods_prosthetic_devices", "osteopaths", "package_stores_beer_wine_and_liquor", "paints_varnishes_and_supplies", "parking_lots_garages", "passenger_railways", "pawn_shops", "pet_shops_pet_food_and_supplies", "petroleum_and_petroleum_products", "photo_developing", "photographic_photocopy_microfilm_equipment_and_supplies", "photographic_studios", "picture_video_production", "piece_goods_notions_and_other_dry_goods", "plumbing_heating_equipment_and_supplies", "political_organizations", "postal_services_government_only", "precious_stones_and_metals_watches_and_jewelry", "professional_services", "public_warehousing_and_storage", "quick_copy_repro_and_blueprint", "railroads", "real_estate_agents_and_managers_rentals", "record_stores", "recreational_vehicle_rentals", "religious_goods_stores", "religious_organizations", "roofing_siding_sheet_metal", "secretarial_support_services", "security_brokers_dealers", "service_stations", "sewing_needlework_fabric_and_piece_goods_stores", "shoe_repair_hat_cleaning", "shoe_stores", "small_appliance_repair", "snowmobile_dealers", "special_trade_services", "specialty_cleaning", "sporting_goods_stores", "sporting_recreation_camps", "sports_and_riding_apparel_stores", "sports_clubs_fields", "stamp_and_coin_stores", "stationary_office_supplies_printing_and_writing_paper", "stationery_stores_office_and_school_supply_stores", "swimming_pools_sales", "t_ui_travel_germany", "tailors_alterations", "tax_payments_government_agencies", "tax_preparation_services", "taxicabs_limousines", "telecommunication_equipment_and_telephone_sales", "telecommunication_services", "telegraph_services", "tent_and_awning_shops", "testing_laboratories", "theatrical_ticket_agencies", "timeshares", "tire_retreading_and_repair", "tolls_bridge_fees", "tourist_attractions_and_exhibits", "towing_services", "trailer_parks_campgrounds", "transportation_services", "travel_agencies_tour_operators", "truck_stop_iteration", "truck_utility_trailer_rentals", "typesetting_plate_making_and_related_services", "typewriter_stores", "u_s_federal_government_agencies_or_departments", "uniforms_commercial_clothing", "used_merchandise_and_secondhand_stores", "utilities", "variety_stores", "veterinary_services", "video_amusement_game_supplies", "video_game_arcades", "video_tape_rental_stores", "vocational_trade_schools", "watch_jewelry_repair", "welding_repair", "wholesale_clubs", "wig_and_toupee_stores", "wires_money_orders", "womens_accessory_and_specialty_shops", "womens_ready_to_wear_stores", "wrecking_and_salvage_yards" ], "maxLength": 5000, "type": "string" }, "type": "array" }, "interval": { "description": "Interval (or event) to which the amount applies.", "enum": [ "all_time", "daily", "monthly", "per_authorization", "weekly", "yearly" ], "type": "string" } }, "required": [ "amount", "interval" ], "title": "spending_limits_param", "type": "object", "x-stripeMostCommon": [ "amount", "categories", "interval" ] }, "type": "array" }, "spending_limits_currency": { "description": "Currency of amounts within `spending_limits`. Defaults to your merchant country's currency.", "type": "string" } }, "title": "authorization_controls_param_v2", "type": "object", "x-stripeMostCommon": [ "allowed_categories", "allowed_merchant_countries", "allowed_merchant_network_ids", "blocked_categories", "blocked_merchant_countries", "blocked_merchant_network_ids", "spending_limits", "spending_limits_currency" ] }, "status": { "description": "Specifies whether to permit authorizations on this cardholder's cards.", "enum": [ "active", "inactive" ], "type": "string" } }, "type": "object", "x-stripeMostCommon": [ "billing", "email", "metadata", "phone_number" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issuing.cardholder" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a cardholder" } }, "/v1/issuing/cards": { "get": { "description": "

Returns a list of Issuing Card objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

", "operationId": "GetIssuingCards", "parameters": [ { "description": "Only return cards belonging to the Cardholder with the provided ID.", "in": "query", "name": "cardholder", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Only return cards that were issued during the given date interval.", "explode": true, "in": "query", "name": "created", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "description": "Minimum value to filter by (exclusive)", "type": "integer" }, "gte": { "description": "Minimum value to filter by (inclusive)", "type": "integer" }, "lt": { "description": "Maximum value to filter by (exclusive)", "type": "integer" }, "lte": { "description": "Maximum value to filter by (inclusive)", "type": "integer" } }, "title": "range_query_specs", "type": "object", "x-stripeMostCommon": [ "gt", "gte", "lt", "lte" ] }, { "type": "integer" } ] }, "style": "deepObject" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Only return cards that have the given expiration month.", "in": "query", "name": "exp_month", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "Only return cards that have the given expiration year.", "in": "query", "name": "exp_year", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "Only return cards that have the given last four digits.", "in": "query", "name": "last4", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "in": "query", "name": "personalization_design", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Only return cards that have the given status. One of `active`, `inactive`, or `canceled`.", "in": "query", "name": "status", "required": false, "schema": { "enum": [ "active", "canceled", "inactive" ], "type": "string", "x-stripeBypassValidation": true }, "style": "form" }, { "description": "Only return cards that have the given type. One of `virtual` or `physical`.", "in": "query", "name": "type", "required": false, "schema": { "enum": [ "physical", "virtual" ], "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/issuing.card" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/issuing/cards", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "IssuingCardList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all cards" }, "post": { "description": "

Creates an Issuing Card object.

", "operationId": "PostIssuingCards", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "pin": { "explode": true, "style": "deepObject" }, "second_line": { "explode": true, "style": "deepObject" }, "shipping": { "explode": true, "style": "deepObject" }, "spending_controls": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "cardholder": { "description": "The [Cardholder](https://stripe.com/docs/api#issuing_cardholder_object) object with which the card will be associated.", "maxLength": 5000, "type": "string" }, "currency": { "description": "The currency for the card.", "type": "string" }, "exp_month": { "description": "The desired expiration month (1-12) for this card if [specifying a custom expiration date](/issuing/cards/virtual/issue-cards?testing-method=with-code#exp-dates).", "type": "integer" }, "exp_year": { "description": "The desired 4-digit expiration year for this card if [specifying a custom expiration date](/issuing/cards/virtual/issue-cards?testing-method=with-code#exp-dates).", "type": "integer" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "financial_account": { "description": "The new financial account ID the card will be associated with. This field allows a card to be reassigned to a different financial account.", "type": "string" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "personalization_design": { "description": "The personalization design object belonging to this card.", "maxLength": 5000, "type": "string" }, "pin": { "description": "The desired PIN for this card.", "properties": { "encrypted_number": { "description": "The card's desired new PIN, encrypted under Stripe's public key.", "maxLength": 5000, "type": "string" } }, "title": "encrypted_pin_param", "type": "object", "x-stripeMostCommon": [ "encrypted_number" ] }, "replacement_for": { "description": "The card this is meant to be a replacement for (if any).", "maxLength": 5000, "type": "string" }, "replacement_reason": { "description": "If `replacement_for` is specified, this should indicate why that card is being replaced.", "enum": [ "damaged", "expired", "lost", "stolen" ], "type": "string", "x-stripeBypassValidation": true }, "second_line": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "The second line to print on the card. Max length: 24 characters." }, "shipping": { "description": "The address where the card will be shipped.", "properties": { "address": { "description": "The address that the card is shipped to.", "properties": { "city": { "description": "City, district, suburb, town, or village.", "maxLength": 5000, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Address line 1 (e.g., street, PO Box, or company name).", "maxLength": 5000, "type": "string" }, "line2": { "description": "Address line 2 (e.g., apartment, suite, unit, or building).", "maxLength": 5000, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "State, county, province, or region.", "maxLength": 5000, "type": "string" } }, "required": [ "city", "country", "line1", "postal_code" ], "title": "required_address", "type": "object", "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state" ] }, "address_validation": { "description": "Address validation settings.", "properties": { "mode": { "description": "The address validation capabilities to use.", "enum": [ "disabled", "normalization_only", "validation_and_normalization" ], "type": "string" } }, "required": [ "mode" ], "title": "address_validation_param", "type": "object", "x-stripeMostCommon": [ "mode" ] }, "customs": { "description": "Customs information for the shipment.", "properties": { "eori_number": { "description": "The Economic Operators Registration and Identification (EORI) number to use for Customs. Required for bulk shipments to Europe.", "maxLength": 5000, "type": "string" } }, "title": "customs_param", "type": "object", "x-stripeMostCommon": [ "eori_number" ] }, "name": { "description": "The name printed on the shipping label when shipping the card.", "maxLength": 5000, "type": "string" }, "phone_number": { "description": "Phone number of the recipient of the shipment.", "type": "string" }, "require_signature": { "description": "Whether a signature is required for card delivery.", "type": "boolean" }, "service": { "description": "Shipment service.", "enum": [ "express", "priority", "standard" ], "type": "string", "x-stripeBypassValidation": true }, "type": { "description": "Packaging options.", "enum": [ "bulk", "individual" ], "type": "string" } }, "required": [ "address", "name" ], "title": "shipping_specs", "type": "object", "x-stripeMostCommon": [ "address", "address_validation", "customs", "name", "phone_number", "require_signature", "service", "speed", "type" ] }, "spending_controls": { "description": "Rules that control spending for this card. Refer to our [documentation](https://stripe.com/docs/issuing/controls/spending-controls) for more details.", "properties": { "allowed_categories": { "description": "Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to allow. All other categories will be blocked. Cannot be set with `blocked_categories`.", "items": { "enum": [ "ac_refrigeration_repair", "accounting_bookkeeping_services", "advertising_services", "agricultural_cooperative", "airlines_air_carriers", "airports_flying_fields", "ambulance_services", "amusement_parks_carnivals", "antique_reproductions", "antique_shops", "aquariums", "architectural_surveying_services", "art_dealers_and_galleries", "artists_supply_and_craft_shops", "auto_and_home_supply_stores", "auto_body_repair_shops", "auto_paint_shops", "auto_service_shops", "automated_cash_disburse", "automated_fuel_dispensers", "automobile_associations", "automotive_parts_and_accessories_stores", "automotive_tire_stores", "bail_and_bond_payments", "bakeries", "bands_orchestras", "barber_and_beauty_shops", "betting_casino_gambling", "bicycle_shops", "billiard_pool_establishments", "boat_dealers", "boat_rentals_and_leases", "book_stores", "books_periodicals_and_newspapers", "bowling_alleys", "bus_lines", "business_secretarial_schools", "buying_shopping_services", "cable_satellite_and_other_pay_television_and_radio", "camera_and_photographic_supply_stores", "candy_nut_and_confectionery_stores", "car_and_truck_dealers_new_used", "car_and_truck_dealers_used_only", "car_rental_agencies", "car_washes", "carpentry_services", "carpet_upholstery_cleaning", "caterers", "charitable_and_social_service_organizations_fundraising", "chemicals_and_allied_products", "child_care_services", "childrens_and_infants_wear_stores", "chiropodists_podiatrists", "chiropractors", "cigar_stores_and_stands", "civic_social_fraternal_associations", "cleaning_and_maintenance", "clothing_rental", "colleges_universities", "commercial_equipment", "commercial_footwear", "commercial_photography_art_and_graphics", "commuter_transport_and_ferries", "computer_network_services", "computer_programming", "computer_repair", "computer_software_stores", "computers_peripherals_and_software", "concrete_work_services", "construction_materials", "consulting_public_relations", "correspondence_schools", "cosmetic_stores", "counseling_services", "country_clubs", "courier_services", "court_costs", "credit_reporting_agencies", "cruise_lines", "dairy_products_stores", "dance_hall_studios_schools", "dating_escort_services", "dentists_orthodontists", "department_stores", "detective_agencies", "digital_goods_applications", "digital_goods_games", "digital_goods_large_volume", "digital_goods_media", "direct_marketing_catalog_merchant", "direct_marketing_combination_catalog_and_retail_merchant", "direct_marketing_inbound_telemarketing", "direct_marketing_insurance_services", "direct_marketing_other", "direct_marketing_outbound_telemarketing", "direct_marketing_subscription", "direct_marketing_travel", "discount_stores", "doctors", "door_to_door_sales", "drapery_window_covering_and_upholstery_stores", "drinking_places", "drug_stores_and_pharmacies", "drugs_drug_proprietaries_and_druggist_sundries", "dry_cleaners", "durable_goods", "duty_free_stores", "eating_places_restaurants", "educational_services", "electric_razor_stores", "electric_vehicle_charging", "electrical_parts_and_equipment", "electrical_services", "electronics_repair_shops", "electronics_stores", "elementary_secondary_schools", "emergency_services_gcas_visa_use_only", "employment_temp_agencies", "equipment_rental", "exterminating_services", "family_clothing_stores", "fast_food_restaurants", "financial_institutions", "fines_government_administrative_entities", "fireplace_fireplace_screens_and_accessories_stores", "floor_covering_stores", "florists", "florists_supplies_nursery_stock_and_flowers", "freezer_and_locker_meat_provisioners", "fuel_dealers_non_automotive", "funeral_services_crematories", "furniture_home_furnishings_and_equipment_stores_except_appliances", "furniture_repair_refinishing", "furriers_and_fur_shops", "general_services", "gift_card_novelty_and_souvenir_shops", "glass_paint_and_wallpaper_stores", "glassware_crystal_stores", "golf_courses_public", "government_licensed_horse_dog_racing_us_region_only", "government_licensed_online_casions_online_gambling_us_region_only", "government_owned_lotteries_non_us_region", "government_owned_lotteries_us_region_only", "government_services", "grocery_stores_supermarkets", "hardware_equipment_and_supplies", "hardware_stores", "health_and_beauty_spas", "hearing_aids_sales_and_supplies", "heating_plumbing_a_c", "hobby_toy_and_game_shops", "home_supply_warehouse_stores", "hospitals", "hotels_motels_and_resorts", "household_appliance_stores", "industrial_supplies", "information_retrieval_services", "insurance_default", "insurance_underwriting_premiums", "intra_company_purchases", "jewelry_stores_watches_clocks_and_silverware_stores", "landscaping_services", "laundries", "laundry_cleaning_services", "legal_services_attorneys", "luggage_and_leather_goods_stores", "lumber_building_materials_stores", "manual_cash_disburse", "marinas_service_and_supplies", "marketplaces", "masonry_stonework_and_plaster", "massage_parlors", "medical_and_dental_labs", "medical_dental_ophthalmic_and_hospital_equipment_and_supplies", "medical_services", "membership_organizations", "mens_and_boys_clothing_and_accessories_stores", "mens_womens_clothing_stores", "metal_service_centers", "miscellaneous", "miscellaneous_apparel_and_accessory_shops", "miscellaneous_auto_dealers", "miscellaneous_business_services", "miscellaneous_food_stores", "miscellaneous_general_merchandise", "miscellaneous_general_services", "miscellaneous_home_furnishing_specialty_stores", "miscellaneous_publishing_and_printing", "miscellaneous_recreation_services", "miscellaneous_repair_shops", "miscellaneous_specialty_retail", "mobile_home_dealers", "motion_picture_theaters", "motor_freight_carriers_and_trucking", "motor_homes_dealers", "motor_vehicle_supplies_and_new_parts", "motorcycle_shops_and_dealers", "motorcycle_shops_dealers", "music_stores_musical_instruments_pianos_and_sheet_music", "news_dealers_and_newsstands", "non_fi_money_orders", "non_fi_stored_value_card_purchase_load", "nondurable_goods", "nurseries_lawn_and_garden_supply_stores", "nursing_personal_care", "office_and_commercial_furniture", "opticians_eyeglasses", "optometrists_ophthalmologist", "orthopedic_goods_prosthetic_devices", "osteopaths", "package_stores_beer_wine_and_liquor", "paints_varnishes_and_supplies", "parking_lots_garages", "passenger_railways", "pawn_shops", "pet_shops_pet_food_and_supplies", "petroleum_and_petroleum_products", "photo_developing", "photographic_photocopy_microfilm_equipment_and_supplies", "photographic_studios", "picture_video_production", "piece_goods_notions_and_other_dry_goods", "plumbing_heating_equipment_and_supplies", "political_organizations", "postal_services_government_only", "precious_stones_and_metals_watches_and_jewelry", "professional_services", "public_warehousing_and_storage", "quick_copy_repro_and_blueprint", "railroads", "real_estate_agents_and_managers_rentals", "record_stores", "recreational_vehicle_rentals", "religious_goods_stores", "religious_organizations", "roofing_siding_sheet_metal", "secretarial_support_services", "security_brokers_dealers", "service_stations", "sewing_needlework_fabric_and_piece_goods_stores", "shoe_repair_hat_cleaning", "shoe_stores", "small_appliance_repair", "snowmobile_dealers", "special_trade_services", "specialty_cleaning", "sporting_goods_stores", "sporting_recreation_camps", "sports_and_riding_apparel_stores", "sports_clubs_fields", "stamp_and_coin_stores", "stationary_office_supplies_printing_and_writing_paper", "stationery_stores_office_and_school_supply_stores", "swimming_pools_sales", "t_ui_travel_germany", "tailors_alterations", "tax_payments_government_agencies", "tax_preparation_services", "taxicabs_limousines", "telecommunication_equipment_and_telephone_sales", "telecommunication_services", "telegraph_services", "tent_and_awning_shops", "testing_laboratories", "theatrical_ticket_agencies", "timeshares", "tire_retreading_and_repair", "tolls_bridge_fees", "tourist_attractions_and_exhibits", "towing_services", "trailer_parks_campgrounds", "transportation_services", "travel_agencies_tour_operators", "truck_stop_iteration", "truck_utility_trailer_rentals", "typesetting_plate_making_and_related_services", "typewriter_stores", "u_s_federal_government_agencies_or_departments", "uniforms_commercial_clothing", "used_merchandise_and_secondhand_stores", "utilities", "variety_stores", "veterinary_services", "video_amusement_game_supplies", "video_game_arcades", "video_tape_rental_stores", "vocational_trade_schools", "watch_jewelry_repair", "welding_repair", "wholesale_clubs", "wig_and_toupee_stores", "wires_money_orders", "womens_accessory_and_specialty_shops", "womens_ready_to_wear_stores", "wrecking_and_salvage_yards" ], "maxLength": 5000, "type": "string" }, "type": "array" }, "allowed_merchant_countries": { "description": "Array of strings containing representing countries from which authorizations will be allowed. Authorizations from merchants in all other countries will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `blocked_merchant_countries`. Provide an empty value to unset this control.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "blocked_categories": { "description": "Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to decline. All other categories will be allowed. Cannot be set with `allowed_categories`.", "items": { "enum": [ "ac_refrigeration_repair", "accounting_bookkeeping_services", "advertising_services", "agricultural_cooperative", "airlines_air_carriers", "airports_flying_fields", "ambulance_services", "amusement_parks_carnivals", "antique_reproductions", "antique_shops", "aquariums", "architectural_surveying_services", "art_dealers_and_galleries", "artists_supply_and_craft_shops", "auto_and_home_supply_stores", "auto_body_repair_shops", "auto_paint_shops", "auto_service_shops", "automated_cash_disburse", "automated_fuel_dispensers", "automobile_associations", "automotive_parts_and_accessories_stores", "automotive_tire_stores", "bail_and_bond_payments", "bakeries", "bands_orchestras", "barber_and_beauty_shops", "betting_casino_gambling", "bicycle_shops", "billiard_pool_establishments", "boat_dealers", "boat_rentals_and_leases", "book_stores", "books_periodicals_and_newspapers", "bowling_alleys", "bus_lines", "business_secretarial_schools", "buying_shopping_services", "cable_satellite_and_other_pay_television_and_radio", "camera_and_photographic_supply_stores", "candy_nut_and_confectionery_stores", "car_and_truck_dealers_new_used", "car_and_truck_dealers_used_only", "car_rental_agencies", "car_washes", "carpentry_services", "carpet_upholstery_cleaning", "caterers", "charitable_and_social_service_organizations_fundraising", "chemicals_and_allied_products", "child_care_services", "childrens_and_infants_wear_stores", "chiropodists_podiatrists", "chiropractors", "cigar_stores_and_stands", "civic_social_fraternal_associations", "cleaning_and_maintenance", "clothing_rental", "colleges_universities", "commercial_equipment", "commercial_footwear", "commercial_photography_art_and_graphics", "commuter_transport_and_ferries", "computer_network_services", "computer_programming", "computer_repair", "computer_software_stores", "computers_peripherals_and_software", "concrete_work_services", "construction_materials", "consulting_public_relations", "correspondence_schools", "cosmetic_stores", "counseling_services", "country_clubs", "courier_services", "court_costs", "credit_reporting_agencies", "cruise_lines", "dairy_products_stores", "dance_hall_studios_schools", "dating_escort_services", "dentists_orthodontists", "department_stores", "detective_agencies", "digital_goods_applications", "digital_goods_games", "digital_goods_large_volume", "digital_goods_media", "direct_marketing_catalog_merchant", "direct_marketing_combination_catalog_and_retail_merchant", "direct_marketing_inbound_telemarketing", "direct_marketing_insurance_services", "direct_marketing_other", "direct_marketing_outbound_telemarketing", "direct_marketing_subscription", "direct_marketing_travel", "discount_stores", "doctors", "door_to_door_sales", "drapery_window_covering_and_upholstery_stores", "drinking_places", "drug_stores_and_pharmacies", "drugs_drug_proprietaries_and_druggist_sundries", "dry_cleaners", "durable_goods", "duty_free_stores", "eating_places_restaurants", "educational_services", "electric_razor_stores", "electric_vehicle_charging", "electrical_parts_and_equipment", "electrical_services", "electronics_repair_shops", "electronics_stores", "elementary_secondary_schools", "emergency_services_gcas_visa_use_only", "employment_temp_agencies", "equipment_rental", "exterminating_services", "family_clothing_stores", "fast_food_restaurants", "financial_institutions", "fines_government_administrative_entities", "fireplace_fireplace_screens_and_accessories_stores", "floor_covering_stores", "florists", "florists_supplies_nursery_stock_and_flowers", "freezer_and_locker_meat_provisioners", "fuel_dealers_non_automotive", "funeral_services_crematories", "furniture_home_furnishings_and_equipment_stores_except_appliances", "furniture_repair_refinishing", "furriers_and_fur_shops", "general_services", "gift_card_novelty_and_souvenir_shops", "glass_paint_and_wallpaper_stores", "glassware_crystal_stores", "golf_courses_public", "government_licensed_horse_dog_racing_us_region_only", "government_licensed_online_casions_online_gambling_us_region_only", "government_owned_lotteries_non_us_region", "government_owned_lotteries_us_region_only", "government_services", "grocery_stores_supermarkets", "hardware_equipment_and_supplies", "hardware_stores", "health_and_beauty_spas", "hearing_aids_sales_and_supplies", "heating_plumbing_a_c", "hobby_toy_and_game_shops", "home_supply_warehouse_stores", "hospitals", "hotels_motels_and_resorts", "household_appliance_stores", "industrial_supplies", "information_retrieval_services", "insurance_default", "insurance_underwriting_premiums", "intra_company_purchases", "jewelry_stores_watches_clocks_and_silverware_stores", "landscaping_services", "laundries", "laundry_cleaning_services", "legal_services_attorneys", "luggage_and_leather_goods_stores", "lumber_building_materials_stores", "manual_cash_disburse", "marinas_service_and_supplies", "marketplaces", "masonry_stonework_and_plaster", "massage_parlors", "medical_and_dental_labs", "medical_dental_ophthalmic_and_hospital_equipment_and_supplies", "medical_services", "membership_organizations", "mens_and_boys_clothing_and_accessories_stores", "mens_womens_clothing_stores", "metal_service_centers", "miscellaneous", "miscellaneous_apparel_and_accessory_shops", "miscellaneous_auto_dealers", "miscellaneous_business_services", "miscellaneous_food_stores", "miscellaneous_general_merchandise", "miscellaneous_general_services", "miscellaneous_home_furnishing_specialty_stores", "miscellaneous_publishing_and_printing", "miscellaneous_recreation_services", "miscellaneous_repair_shops", "miscellaneous_specialty_retail", "mobile_home_dealers", "motion_picture_theaters", "motor_freight_carriers_and_trucking", "motor_homes_dealers", "motor_vehicle_supplies_and_new_parts", "motorcycle_shops_and_dealers", "motorcycle_shops_dealers", "music_stores_musical_instruments_pianos_and_sheet_music", "news_dealers_and_newsstands", "non_fi_money_orders", "non_fi_stored_value_card_purchase_load", "nondurable_goods", "nurseries_lawn_and_garden_supply_stores", "nursing_personal_care", "office_and_commercial_furniture", "opticians_eyeglasses", "optometrists_ophthalmologist", "orthopedic_goods_prosthetic_devices", "osteopaths", "package_stores_beer_wine_and_liquor", "paints_varnishes_and_supplies", "parking_lots_garages", "passenger_railways", "pawn_shops", "pet_shops_pet_food_and_supplies", "petroleum_and_petroleum_products", "photo_developing", "photographic_photocopy_microfilm_equipment_and_supplies", "photographic_studios", "picture_video_production", "piece_goods_notions_and_other_dry_goods", "plumbing_heating_equipment_and_supplies", "political_organizations", "postal_services_government_only", "precious_stones_and_metals_watches_and_jewelry", "professional_services", "public_warehousing_and_storage", "quick_copy_repro_and_blueprint", "railroads", "real_estate_agents_and_managers_rentals", "record_stores", "recreational_vehicle_rentals", "religious_goods_stores", "religious_organizations", "roofing_siding_sheet_metal", "secretarial_support_services", "security_brokers_dealers", "service_stations", "sewing_needlework_fabric_and_piece_goods_stores", "shoe_repair_hat_cleaning", "shoe_stores", "small_appliance_repair", "snowmobile_dealers", "special_trade_services", "specialty_cleaning", "sporting_goods_stores", "sporting_recreation_camps", "sports_and_riding_apparel_stores", "sports_clubs_fields", "stamp_and_coin_stores", "stationary_office_supplies_printing_and_writing_paper", "stationery_stores_office_and_school_supply_stores", "swimming_pools_sales", "t_ui_travel_germany", "tailors_alterations", "tax_payments_government_agencies", "tax_preparation_services", "taxicabs_limousines", "telecommunication_equipment_and_telephone_sales", "telecommunication_services", "telegraph_services", "tent_and_awning_shops", "testing_laboratories", "theatrical_ticket_agencies", "timeshares", "tire_retreading_and_repair", "tolls_bridge_fees", "tourist_attractions_and_exhibits", "towing_services", "trailer_parks_campgrounds", "transportation_services", "travel_agencies_tour_operators", "truck_stop_iteration", "truck_utility_trailer_rentals", "typesetting_plate_making_and_related_services", "typewriter_stores", "u_s_federal_government_agencies_or_departments", "uniforms_commercial_clothing", "used_merchandise_and_secondhand_stores", "utilities", "variety_stores", "veterinary_services", "video_amusement_game_supplies", "video_game_arcades", "video_tape_rental_stores", "vocational_trade_schools", "watch_jewelry_repair", "welding_repair", "wholesale_clubs", "wig_and_toupee_stores", "wires_money_orders", "womens_accessory_and_specialty_shops", "womens_ready_to_wear_stores", "wrecking_and_salvage_yards" ], "maxLength": 5000, "type": "string" }, "type": "array" }, "blocked_merchant_countries": { "description": "Array of strings containing representing countries from which authorizations will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `allowed_merchant_countries`. Provide an empty value to unset this control.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "spending_limits": { "description": "Limit spending with amount-based rules that apply across any cards this card replaced (i.e., its `replacement_for` card and _that_ card's `replacement_for` card, up the chain).", "items": { "properties": { "amount": { "description": "Maximum amount allowed to spend per interval.", "type": "integer" }, "categories": { "description": "Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) this limit applies to. Omitting this field will apply the limit to all categories.", "items": { "enum": [ "ac_refrigeration_repair", "accounting_bookkeeping_services", "advertising_services", "agricultural_cooperative", "airlines_air_carriers", "airports_flying_fields", "ambulance_services", "amusement_parks_carnivals", "antique_reproductions", "antique_shops", "aquariums", "architectural_surveying_services", "art_dealers_and_galleries", "artists_supply_and_craft_shops", "auto_and_home_supply_stores", "auto_body_repair_shops", "auto_paint_shops", "auto_service_shops", "automated_cash_disburse", "automated_fuel_dispensers", "automobile_associations", "automotive_parts_and_accessories_stores", "automotive_tire_stores", "bail_and_bond_payments", "bakeries", "bands_orchestras", "barber_and_beauty_shops", "betting_casino_gambling", "bicycle_shops", "billiard_pool_establishments", "boat_dealers", "boat_rentals_and_leases", "book_stores", "books_periodicals_and_newspapers", "bowling_alleys", "bus_lines", "business_secretarial_schools", "buying_shopping_services", "cable_satellite_and_other_pay_television_and_radio", "camera_and_photographic_supply_stores", "candy_nut_and_confectionery_stores", "car_and_truck_dealers_new_used", "car_and_truck_dealers_used_only", "car_rental_agencies", "car_washes", "carpentry_services", "carpet_upholstery_cleaning", "caterers", "charitable_and_social_service_organizations_fundraising", "chemicals_and_allied_products", "child_care_services", "childrens_and_infants_wear_stores", "chiropodists_podiatrists", "chiropractors", "cigar_stores_and_stands", "civic_social_fraternal_associations", "cleaning_and_maintenance", "clothing_rental", "colleges_universities", "commercial_equipment", "commercial_footwear", "commercial_photography_art_and_graphics", "commuter_transport_and_ferries", "computer_network_services", "computer_programming", "computer_repair", "computer_software_stores", "computers_peripherals_and_software", "concrete_work_services", "construction_materials", "consulting_public_relations", "correspondence_schools", "cosmetic_stores", "counseling_services", "country_clubs", "courier_services", "court_costs", "credit_reporting_agencies", "cruise_lines", "dairy_products_stores", "dance_hall_studios_schools", "dating_escort_services", "dentists_orthodontists", "department_stores", "detective_agencies", "digital_goods_applications", "digital_goods_games", "digital_goods_large_volume", "digital_goods_media", "direct_marketing_catalog_merchant", "direct_marketing_combination_catalog_and_retail_merchant", "direct_marketing_inbound_telemarketing", "direct_marketing_insurance_services", "direct_marketing_other", "direct_marketing_outbound_telemarketing", "direct_marketing_subscription", "direct_marketing_travel", "discount_stores", "doctors", "door_to_door_sales", "drapery_window_covering_and_upholstery_stores", "drinking_places", "drug_stores_and_pharmacies", "drugs_drug_proprietaries_and_druggist_sundries", "dry_cleaners", "durable_goods", "duty_free_stores", "eating_places_restaurants", "educational_services", "electric_razor_stores", "electric_vehicle_charging", "electrical_parts_and_equipment", "electrical_services", "electronics_repair_shops", "electronics_stores", "elementary_secondary_schools", "emergency_services_gcas_visa_use_only", "employment_temp_agencies", "equipment_rental", "exterminating_services", "family_clothing_stores", "fast_food_restaurants", "financial_institutions", "fines_government_administrative_entities", "fireplace_fireplace_screens_and_accessories_stores", "floor_covering_stores", "florists", "florists_supplies_nursery_stock_and_flowers", "freezer_and_locker_meat_provisioners", "fuel_dealers_non_automotive", "funeral_services_crematories", "furniture_home_furnishings_and_equipment_stores_except_appliances", "furniture_repair_refinishing", "furriers_and_fur_shops", "general_services", "gift_card_novelty_and_souvenir_shops", "glass_paint_and_wallpaper_stores", "glassware_crystal_stores", "golf_courses_public", "government_licensed_horse_dog_racing_us_region_only", "government_licensed_online_casions_online_gambling_us_region_only", "government_owned_lotteries_non_us_region", "government_owned_lotteries_us_region_only", "government_services", "grocery_stores_supermarkets", "hardware_equipment_and_supplies", "hardware_stores", "health_and_beauty_spas", "hearing_aids_sales_and_supplies", "heating_plumbing_a_c", "hobby_toy_and_game_shops", "home_supply_warehouse_stores", "hospitals", "hotels_motels_and_resorts", "household_appliance_stores", "industrial_supplies", "information_retrieval_services", "insurance_default", "insurance_underwriting_premiums", "intra_company_purchases", "jewelry_stores_watches_clocks_and_silverware_stores", "landscaping_services", "laundries", "laundry_cleaning_services", "legal_services_attorneys", "luggage_and_leather_goods_stores", "lumber_building_materials_stores", "manual_cash_disburse", "marinas_service_and_supplies", "marketplaces", "masonry_stonework_and_plaster", "massage_parlors", "medical_and_dental_labs", "medical_dental_ophthalmic_and_hospital_equipment_and_supplies", "medical_services", "membership_organizations", "mens_and_boys_clothing_and_accessories_stores", "mens_womens_clothing_stores", "metal_service_centers", "miscellaneous", "miscellaneous_apparel_and_accessory_shops", "miscellaneous_auto_dealers", "miscellaneous_business_services", "miscellaneous_food_stores", "miscellaneous_general_merchandise", "miscellaneous_general_services", "miscellaneous_home_furnishing_specialty_stores", "miscellaneous_publishing_and_printing", "miscellaneous_recreation_services", "miscellaneous_repair_shops", "miscellaneous_specialty_retail", "mobile_home_dealers", "motion_picture_theaters", "motor_freight_carriers_and_trucking", "motor_homes_dealers", "motor_vehicle_supplies_and_new_parts", "motorcycle_shops_and_dealers", "motorcycle_shops_dealers", "music_stores_musical_instruments_pianos_and_sheet_music", "news_dealers_and_newsstands", "non_fi_money_orders", "non_fi_stored_value_card_purchase_load", "nondurable_goods", "nurseries_lawn_and_garden_supply_stores", "nursing_personal_care", "office_and_commercial_furniture", "opticians_eyeglasses", "optometrists_ophthalmologist", "orthopedic_goods_prosthetic_devices", "osteopaths", "package_stores_beer_wine_and_liquor", "paints_varnishes_and_supplies", "parking_lots_garages", "passenger_railways", "pawn_shops", "pet_shops_pet_food_and_supplies", "petroleum_and_petroleum_products", "photo_developing", "photographic_photocopy_microfilm_equipment_and_supplies", "photographic_studios", "picture_video_production", "piece_goods_notions_and_other_dry_goods", "plumbing_heating_equipment_and_supplies", "political_organizations", "postal_services_government_only", "precious_stones_and_metals_watches_and_jewelry", "professional_services", "public_warehousing_and_storage", "quick_copy_repro_and_blueprint", "railroads", "real_estate_agents_and_managers_rentals", "record_stores", "recreational_vehicle_rentals", "religious_goods_stores", "religious_organizations", "roofing_siding_sheet_metal", "secretarial_support_services", "security_brokers_dealers", "service_stations", "sewing_needlework_fabric_and_piece_goods_stores", "shoe_repair_hat_cleaning", "shoe_stores", "small_appliance_repair", "snowmobile_dealers", "special_trade_services", "specialty_cleaning", "sporting_goods_stores", "sporting_recreation_camps", "sports_and_riding_apparel_stores", "sports_clubs_fields", "stamp_and_coin_stores", "stationary_office_supplies_printing_and_writing_paper", "stationery_stores_office_and_school_supply_stores", "swimming_pools_sales", "t_ui_travel_germany", "tailors_alterations", "tax_payments_government_agencies", "tax_preparation_services", "taxicabs_limousines", "telecommunication_equipment_and_telephone_sales", "telecommunication_services", "telegraph_services", "tent_and_awning_shops", "testing_laboratories", "theatrical_ticket_agencies", "timeshares", "tire_retreading_and_repair", "tolls_bridge_fees", "tourist_attractions_and_exhibits", "towing_services", "trailer_parks_campgrounds", "transportation_services", "travel_agencies_tour_operators", "truck_stop_iteration", "truck_utility_trailer_rentals", "typesetting_plate_making_and_related_services", "typewriter_stores", "u_s_federal_government_agencies_or_departments", "uniforms_commercial_clothing", "used_merchandise_and_secondhand_stores", "utilities", "variety_stores", "veterinary_services", "video_amusement_game_supplies", "video_game_arcades", "video_tape_rental_stores", "vocational_trade_schools", "watch_jewelry_repair", "welding_repair", "wholesale_clubs", "wig_and_toupee_stores", "wires_money_orders", "womens_accessory_and_specialty_shops", "womens_ready_to_wear_stores", "wrecking_and_salvage_yards" ], "maxLength": 5000, "type": "string" }, "type": "array" }, "interval": { "description": "Interval (or event) to which the amount applies.", "enum": [ "all_time", "daily", "monthly", "per_authorization", "weekly", "yearly" ], "type": "string" } }, "required": [ "amount", "interval" ], "title": "spending_limits_param", "type": "object", "x-stripeMostCommon": [ "amount", "categories", "interval" ] }, "type": "array" } }, "title": "authorization_controls_param", "type": "object", "x-stripeMostCommon": [ "allowed_categories", "allowed_merchant_countries", "allowed_merchant_currencies", "allowed_merchant_network_ids", "blocked_categories", "blocked_merchant_countries", "blocked_merchant_currencies", "blocked_merchant_network_ids", "max_approvals", "spending_limits" ] }, "status": { "description": "Whether authorizations can be approved on this card. May be blocked from activating cards depending on past-due Cardholder requirements. Defaults to `inactive`.", "enum": [ "active", "inactive" ], "type": "string" }, "type": { "description": "The type of card to issue. Possible values are `physical` or `virtual`.", "enum": [ "physical", "virtual" ], "type": "string" } }, "required": [ "currency", "type" ], "type": "object", "x-stripeMostCommon": [ "cardholder", "currency", "exp_month", "exp_year", "metadata", "status", "type" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issuing.card" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a card" } }, "/v1/issuing/cards/{card}": { "get": { "description": "

Retrieves an Issuing Card object.

", "operationId": "GetIssuingCardsCard", "parameters": [ { "in": "path", "name": "card", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issuing.card" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a card" }, "post": { "description": "

Updates the specified Issuing Card object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

", "operationId": "PostIssuingCardsCard", "parameters": [ { "in": "path", "name": "card", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "pin": { "explode": true, "style": "deepObject" }, "shipping": { "explode": true, "style": "deepObject" }, "spending_controls": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "cancellation_reason": { "description": "Reason why the `status` of this card is `canceled`.", "enum": [ "lost", "stolen" ], "type": "string", "x-stripeBypassValidation": true }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "personalization_design": { "maxLength": 5000, "type": "string" }, "pin": { "description": "The desired new PIN for this card.", "properties": { "encrypted_number": { "description": "The card's desired new PIN, encrypted under Stripe's public key.", "maxLength": 5000, "type": "string" } }, "title": "encrypted_pin_param", "type": "object", "x-stripeMostCommon": [ "encrypted_number" ] }, "shipping": { "description": "Updated shipping information for the card.", "properties": { "address": { "description": "The address that the card is shipped to.", "properties": { "city": { "description": "City, district, suburb, town, or village.", "maxLength": 5000, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Address line 1 (e.g., street, PO Box, or company name).", "maxLength": 5000, "type": "string" }, "line2": { "description": "Address line 2 (e.g., apartment, suite, unit, or building).", "maxLength": 5000, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "State, county, province, or region.", "maxLength": 5000, "type": "string" } }, "required": [ "city", "country", "line1", "postal_code" ], "title": "required_address", "type": "object", "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state" ] }, "address_validation": { "description": "Address validation settings.", "properties": { "mode": { "description": "The address validation capabilities to use.", "enum": [ "disabled", "normalization_only", "validation_and_normalization" ], "type": "string" } }, "required": [ "mode" ], "title": "address_validation_param", "type": "object", "x-stripeMostCommon": [ "mode" ] }, "customs": { "description": "Customs information for the shipment.", "properties": { "eori_number": { "description": "The Economic Operators Registration and Identification (EORI) number to use for Customs. Required for bulk shipments to Europe.", "maxLength": 5000, "type": "string" } }, "title": "customs_param", "type": "object", "x-stripeMostCommon": [ "eori_number" ] }, "name": { "description": "The name printed on the shipping label when shipping the card.", "maxLength": 5000, "type": "string" }, "phone_number": { "description": "Phone number of the recipient of the shipment.", "type": "string" }, "require_signature": { "description": "Whether a signature is required for card delivery.", "type": "boolean" }, "service": { "description": "Shipment service.", "enum": [ "express", "priority", "standard" ], "type": "string", "x-stripeBypassValidation": true }, "type": { "description": "Packaging options.", "enum": [ "bulk", "individual" ], "type": "string" } }, "required": [ "address", "name" ], "title": "shipping_specs", "type": "object", "x-stripeMostCommon": [ "address", "address_validation", "customs", "name", "phone_number", "require_signature", "service", "speed", "type" ] }, "spending_controls": { "description": "Rules that control spending for this card. Refer to our [documentation](https://stripe.com/docs/issuing/controls/spending-controls) for more details.", "properties": { "allowed_categories": { "description": "Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to allow. All other categories will be blocked. Cannot be set with `blocked_categories`.", "items": { "enum": [ "ac_refrigeration_repair", "accounting_bookkeeping_services", "advertising_services", "agricultural_cooperative", "airlines_air_carriers", "airports_flying_fields", "ambulance_services", "amusement_parks_carnivals", "antique_reproductions", "antique_shops", "aquariums", "architectural_surveying_services", "art_dealers_and_galleries", "artists_supply_and_craft_shops", "auto_and_home_supply_stores", "auto_body_repair_shops", "auto_paint_shops", "auto_service_shops", "automated_cash_disburse", "automated_fuel_dispensers", "automobile_associations", "automotive_parts_and_accessories_stores", "automotive_tire_stores", "bail_and_bond_payments", "bakeries", "bands_orchestras", "barber_and_beauty_shops", "betting_casino_gambling", "bicycle_shops", "billiard_pool_establishments", "boat_dealers", "boat_rentals_and_leases", "book_stores", "books_periodicals_and_newspapers", "bowling_alleys", "bus_lines", "business_secretarial_schools", "buying_shopping_services", "cable_satellite_and_other_pay_television_and_radio", "camera_and_photographic_supply_stores", "candy_nut_and_confectionery_stores", "car_and_truck_dealers_new_used", "car_and_truck_dealers_used_only", "car_rental_agencies", "car_washes", "carpentry_services", "carpet_upholstery_cleaning", "caterers", "charitable_and_social_service_organizations_fundraising", "chemicals_and_allied_products", "child_care_services", "childrens_and_infants_wear_stores", "chiropodists_podiatrists", "chiropractors", "cigar_stores_and_stands", "civic_social_fraternal_associations", "cleaning_and_maintenance", "clothing_rental", "colleges_universities", "commercial_equipment", "commercial_footwear", "commercial_photography_art_and_graphics", "commuter_transport_and_ferries", "computer_network_services", "computer_programming", "computer_repair", "computer_software_stores", "computers_peripherals_and_software", "concrete_work_services", "construction_materials", "consulting_public_relations", "correspondence_schools", "cosmetic_stores", "counseling_services", "country_clubs", "courier_services", "court_costs", "credit_reporting_agencies", "cruise_lines", "dairy_products_stores", "dance_hall_studios_schools", "dating_escort_services", "dentists_orthodontists", "department_stores", "detective_agencies", "digital_goods_applications", "digital_goods_games", "digital_goods_large_volume", "digital_goods_media", "direct_marketing_catalog_merchant", "direct_marketing_combination_catalog_and_retail_merchant", "direct_marketing_inbound_telemarketing", "direct_marketing_insurance_services", "direct_marketing_other", "direct_marketing_outbound_telemarketing", "direct_marketing_subscription", "direct_marketing_travel", "discount_stores", "doctors", "door_to_door_sales", "drapery_window_covering_and_upholstery_stores", "drinking_places", "drug_stores_and_pharmacies", "drugs_drug_proprietaries_and_druggist_sundries", "dry_cleaners", "durable_goods", "duty_free_stores", "eating_places_restaurants", "educational_services", "electric_razor_stores", "electric_vehicle_charging", "electrical_parts_and_equipment", "electrical_services", "electronics_repair_shops", "electronics_stores", "elementary_secondary_schools", "emergency_services_gcas_visa_use_only", "employment_temp_agencies", "equipment_rental", "exterminating_services", "family_clothing_stores", "fast_food_restaurants", "financial_institutions", "fines_government_administrative_entities", "fireplace_fireplace_screens_and_accessories_stores", "floor_covering_stores", "florists", "florists_supplies_nursery_stock_and_flowers", "freezer_and_locker_meat_provisioners", "fuel_dealers_non_automotive", "funeral_services_crematories", "furniture_home_furnishings_and_equipment_stores_except_appliances", "furniture_repair_refinishing", "furriers_and_fur_shops", "general_services", "gift_card_novelty_and_souvenir_shops", "glass_paint_and_wallpaper_stores", "glassware_crystal_stores", "golf_courses_public", "government_licensed_horse_dog_racing_us_region_only", "government_licensed_online_casions_online_gambling_us_region_only", "government_owned_lotteries_non_us_region", "government_owned_lotteries_us_region_only", "government_services", "grocery_stores_supermarkets", "hardware_equipment_and_supplies", "hardware_stores", "health_and_beauty_spas", "hearing_aids_sales_and_supplies", "heating_plumbing_a_c", "hobby_toy_and_game_shops", "home_supply_warehouse_stores", "hospitals", "hotels_motels_and_resorts", "household_appliance_stores", "industrial_supplies", "information_retrieval_services", "insurance_default", "insurance_underwriting_premiums", "intra_company_purchases", "jewelry_stores_watches_clocks_and_silverware_stores", "landscaping_services", "laundries", "laundry_cleaning_services", "legal_services_attorneys", "luggage_and_leather_goods_stores", "lumber_building_materials_stores", "manual_cash_disburse", "marinas_service_and_supplies", "marketplaces", "masonry_stonework_and_plaster", "massage_parlors", "medical_and_dental_labs", "medical_dental_ophthalmic_and_hospital_equipment_and_supplies", "medical_services", "membership_organizations", "mens_and_boys_clothing_and_accessories_stores", "mens_womens_clothing_stores", "metal_service_centers", "miscellaneous", "miscellaneous_apparel_and_accessory_shops", "miscellaneous_auto_dealers", "miscellaneous_business_services", "miscellaneous_food_stores", "miscellaneous_general_merchandise", "miscellaneous_general_services", "miscellaneous_home_furnishing_specialty_stores", "miscellaneous_publishing_and_printing", "miscellaneous_recreation_services", "miscellaneous_repair_shops", "miscellaneous_specialty_retail", "mobile_home_dealers", "motion_picture_theaters", "motor_freight_carriers_and_trucking", "motor_homes_dealers", "motor_vehicle_supplies_and_new_parts", "motorcycle_shops_and_dealers", "motorcycle_shops_dealers", "music_stores_musical_instruments_pianos_and_sheet_music", "news_dealers_and_newsstands", "non_fi_money_orders", "non_fi_stored_value_card_purchase_load", "nondurable_goods", "nurseries_lawn_and_garden_supply_stores", "nursing_personal_care", "office_and_commercial_furniture", "opticians_eyeglasses", "optometrists_ophthalmologist", "orthopedic_goods_prosthetic_devices", "osteopaths", "package_stores_beer_wine_and_liquor", "paints_varnishes_and_supplies", "parking_lots_garages", "passenger_railways", "pawn_shops", "pet_shops_pet_food_and_supplies", "petroleum_and_petroleum_products", "photo_developing", "photographic_photocopy_microfilm_equipment_and_supplies", "photographic_studios", "picture_video_production", "piece_goods_notions_and_other_dry_goods", "plumbing_heating_equipment_and_supplies", "political_organizations", "postal_services_government_only", "precious_stones_and_metals_watches_and_jewelry", "professional_services", "public_warehousing_and_storage", "quick_copy_repro_and_blueprint", "railroads", "real_estate_agents_and_managers_rentals", "record_stores", "recreational_vehicle_rentals", "religious_goods_stores", "religious_organizations", "roofing_siding_sheet_metal", "secretarial_support_services", "security_brokers_dealers", "service_stations", "sewing_needlework_fabric_and_piece_goods_stores", "shoe_repair_hat_cleaning", "shoe_stores", "small_appliance_repair", "snowmobile_dealers", "special_trade_services", "specialty_cleaning", "sporting_goods_stores", "sporting_recreation_camps", "sports_and_riding_apparel_stores", "sports_clubs_fields", "stamp_and_coin_stores", "stationary_office_supplies_printing_and_writing_paper", "stationery_stores_office_and_school_supply_stores", "swimming_pools_sales", "t_ui_travel_germany", "tailors_alterations", "tax_payments_government_agencies", "tax_preparation_services", "taxicabs_limousines", "telecommunication_equipment_and_telephone_sales", "telecommunication_services", "telegraph_services", "tent_and_awning_shops", "testing_laboratories", "theatrical_ticket_agencies", "timeshares", "tire_retreading_and_repair", "tolls_bridge_fees", "tourist_attractions_and_exhibits", "towing_services", "trailer_parks_campgrounds", "transportation_services", "travel_agencies_tour_operators", "truck_stop_iteration", "truck_utility_trailer_rentals", "typesetting_plate_making_and_related_services", "typewriter_stores", "u_s_federal_government_agencies_or_departments", "uniforms_commercial_clothing", "used_merchandise_and_secondhand_stores", "utilities", "variety_stores", "veterinary_services", "video_amusement_game_supplies", "video_game_arcades", "video_tape_rental_stores", "vocational_trade_schools", "watch_jewelry_repair", "welding_repair", "wholesale_clubs", "wig_and_toupee_stores", "wires_money_orders", "womens_accessory_and_specialty_shops", "womens_ready_to_wear_stores", "wrecking_and_salvage_yards" ], "maxLength": 5000, "type": "string" }, "type": "array" }, "allowed_merchant_countries": { "description": "Array of strings containing representing countries from which authorizations will be allowed. Authorizations from merchants in all other countries will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `blocked_merchant_countries`. Provide an empty value to unset this control.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "blocked_categories": { "description": "Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to decline. All other categories will be allowed. Cannot be set with `allowed_categories`.", "items": { "enum": [ "ac_refrigeration_repair", "accounting_bookkeeping_services", "advertising_services", "agricultural_cooperative", "airlines_air_carriers", "airports_flying_fields", "ambulance_services", "amusement_parks_carnivals", "antique_reproductions", "antique_shops", "aquariums", "architectural_surveying_services", "art_dealers_and_galleries", "artists_supply_and_craft_shops", "auto_and_home_supply_stores", "auto_body_repair_shops", "auto_paint_shops", "auto_service_shops", "automated_cash_disburse", "automated_fuel_dispensers", "automobile_associations", "automotive_parts_and_accessories_stores", "automotive_tire_stores", "bail_and_bond_payments", "bakeries", "bands_orchestras", "barber_and_beauty_shops", "betting_casino_gambling", "bicycle_shops", "billiard_pool_establishments", "boat_dealers", "boat_rentals_and_leases", "book_stores", "books_periodicals_and_newspapers", "bowling_alleys", "bus_lines", "business_secretarial_schools", "buying_shopping_services", "cable_satellite_and_other_pay_television_and_radio", "camera_and_photographic_supply_stores", "candy_nut_and_confectionery_stores", "car_and_truck_dealers_new_used", "car_and_truck_dealers_used_only", "car_rental_agencies", "car_washes", "carpentry_services", "carpet_upholstery_cleaning", "caterers", "charitable_and_social_service_organizations_fundraising", "chemicals_and_allied_products", "child_care_services", "childrens_and_infants_wear_stores", "chiropodists_podiatrists", "chiropractors", "cigar_stores_and_stands", "civic_social_fraternal_associations", "cleaning_and_maintenance", "clothing_rental", "colleges_universities", "commercial_equipment", "commercial_footwear", "commercial_photography_art_and_graphics", "commuter_transport_and_ferries", "computer_network_services", "computer_programming", "computer_repair", "computer_software_stores", "computers_peripherals_and_software", "concrete_work_services", "construction_materials", "consulting_public_relations", "correspondence_schools", "cosmetic_stores", "counseling_services", "country_clubs", "courier_services", "court_costs", "credit_reporting_agencies", "cruise_lines", "dairy_products_stores", "dance_hall_studios_schools", "dating_escort_services", "dentists_orthodontists", "department_stores", "detective_agencies", "digital_goods_applications", "digital_goods_games", "digital_goods_large_volume", "digital_goods_media", "direct_marketing_catalog_merchant", "direct_marketing_combination_catalog_and_retail_merchant", "direct_marketing_inbound_telemarketing", "direct_marketing_insurance_services", "direct_marketing_other", "direct_marketing_outbound_telemarketing", "direct_marketing_subscription", "direct_marketing_travel", "discount_stores", "doctors", "door_to_door_sales", "drapery_window_covering_and_upholstery_stores", "drinking_places", "drug_stores_and_pharmacies", "drugs_drug_proprietaries_and_druggist_sundries", "dry_cleaners", "durable_goods", "duty_free_stores", "eating_places_restaurants", "educational_services", "electric_razor_stores", "electric_vehicle_charging", "electrical_parts_and_equipment", "electrical_services", "electronics_repair_shops", "electronics_stores", "elementary_secondary_schools", "emergency_services_gcas_visa_use_only", "employment_temp_agencies", "equipment_rental", "exterminating_services", "family_clothing_stores", "fast_food_restaurants", "financial_institutions", "fines_government_administrative_entities", "fireplace_fireplace_screens_and_accessories_stores", "floor_covering_stores", "florists", "florists_supplies_nursery_stock_and_flowers", "freezer_and_locker_meat_provisioners", "fuel_dealers_non_automotive", "funeral_services_crematories", "furniture_home_furnishings_and_equipment_stores_except_appliances", "furniture_repair_refinishing", "furriers_and_fur_shops", "general_services", "gift_card_novelty_and_souvenir_shops", "glass_paint_and_wallpaper_stores", "glassware_crystal_stores", "golf_courses_public", "government_licensed_horse_dog_racing_us_region_only", "government_licensed_online_casions_online_gambling_us_region_only", "government_owned_lotteries_non_us_region", "government_owned_lotteries_us_region_only", "government_services", "grocery_stores_supermarkets", "hardware_equipment_and_supplies", "hardware_stores", "health_and_beauty_spas", "hearing_aids_sales_and_supplies", "heating_plumbing_a_c", "hobby_toy_and_game_shops", "home_supply_warehouse_stores", "hospitals", "hotels_motels_and_resorts", "household_appliance_stores", "industrial_supplies", "information_retrieval_services", "insurance_default", "insurance_underwriting_premiums", "intra_company_purchases", "jewelry_stores_watches_clocks_and_silverware_stores", "landscaping_services", "laundries", "laundry_cleaning_services", "legal_services_attorneys", "luggage_and_leather_goods_stores", "lumber_building_materials_stores", "manual_cash_disburse", "marinas_service_and_supplies", "marketplaces", "masonry_stonework_and_plaster", "massage_parlors", "medical_and_dental_labs", "medical_dental_ophthalmic_and_hospital_equipment_and_supplies", "medical_services", "membership_organizations", "mens_and_boys_clothing_and_accessories_stores", "mens_womens_clothing_stores", "metal_service_centers", "miscellaneous", "miscellaneous_apparel_and_accessory_shops", "miscellaneous_auto_dealers", "miscellaneous_business_services", "miscellaneous_food_stores", "miscellaneous_general_merchandise", "miscellaneous_general_services", "miscellaneous_home_furnishing_specialty_stores", "miscellaneous_publishing_and_printing", "miscellaneous_recreation_services", "miscellaneous_repair_shops", "miscellaneous_specialty_retail", "mobile_home_dealers", "motion_picture_theaters", "motor_freight_carriers_and_trucking", "motor_homes_dealers", "motor_vehicle_supplies_and_new_parts", "motorcycle_shops_and_dealers", "motorcycle_shops_dealers", "music_stores_musical_instruments_pianos_and_sheet_music", "news_dealers_and_newsstands", "non_fi_money_orders", "non_fi_stored_value_card_purchase_load", "nondurable_goods", "nurseries_lawn_and_garden_supply_stores", "nursing_personal_care", "office_and_commercial_furniture", "opticians_eyeglasses", "optometrists_ophthalmologist", "orthopedic_goods_prosthetic_devices", "osteopaths", "package_stores_beer_wine_and_liquor", "paints_varnishes_and_supplies", "parking_lots_garages", "passenger_railways", "pawn_shops", "pet_shops_pet_food_and_supplies", "petroleum_and_petroleum_products", "photo_developing", "photographic_photocopy_microfilm_equipment_and_supplies", "photographic_studios", "picture_video_production", "piece_goods_notions_and_other_dry_goods", "plumbing_heating_equipment_and_supplies", "political_organizations", "postal_services_government_only", "precious_stones_and_metals_watches_and_jewelry", "professional_services", "public_warehousing_and_storage", "quick_copy_repro_and_blueprint", "railroads", "real_estate_agents_and_managers_rentals", "record_stores", "recreational_vehicle_rentals", "religious_goods_stores", "religious_organizations", "roofing_siding_sheet_metal", "secretarial_support_services", "security_brokers_dealers", "service_stations", "sewing_needlework_fabric_and_piece_goods_stores", "shoe_repair_hat_cleaning", "shoe_stores", "small_appliance_repair", "snowmobile_dealers", "special_trade_services", "specialty_cleaning", "sporting_goods_stores", "sporting_recreation_camps", "sports_and_riding_apparel_stores", "sports_clubs_fields", "stamp_and_coin_stores", "stationary_office_supplies_printing_and_writing_paper", "stationery_stores_office_and_school_supply_stores", "swimming_pools_sales", "t_ui_travel_germany", "tailors_alterations", "tax_payments_government_agencies", "tax_preparation_services", "taxicabs_limousines", "telecommunication_equipment_and_telephone_sales", "telecommunication_services", "telegraph_services", "tent_and_awning_shops", "testing_laboratories", "theatrical_ticket_agencies", "timeshares", "tire_retreading_and_repair", "tolls_bridge_fees", "tourist_attractions_and_exhibits", "towing_services", "trailer_parks_campgrounds", "transportation_services", "travel_agencies_tour_operators", "truck_stop_iteration", "truck_utility_trailer_rentals", "typesetting_plate_making_and_related_services", "typewriter_stores", "u_s_federal_government_agencies_or_departments", "uniforms_commercial_clothing", "used_merchandise_and_secondhand_stores", "utilities", "variety_stores", "veterinary_services", "video_amusement_game_supplies", "video_game_arcades", "video_tape_rental_stores", "vocational_trade_schools", "watch_jewelry_repair", "welding_repair", "wholesale_clubs", "wig_and_toupee_stores", "wires_money_orders", "womens_accessory_and_specialty_shops", "womens_ready_to_wear_stores", "wrecking_and_salvage_yards" ], "maxLength": 5000, "type": "string" }, "type": "array" }, "blocked_merchant_countries": { "description": "Array of strings containing representing countries from which authorizations will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `allowed_merchant_countries`. Provide an empty value to unset this control.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "spending_limits": { "description": "Limit spending with amount-based rules that apply across any cards this card replaced (i.e., its `replacement_for` card and _that_ card's `replacement_for` card, up the chain).", "items": { "properties": { "amount": { "description": "Maximum amount allowed to spend per interval.", "type": "integer" }, "categories": { "description": "Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) this limit applies to. Omitting this field will apply the limit to all categories.", "items": { "enum": [ "ac_refrigeration_repair", "accounting_bookkeeping_services", "advertising_services", "agricultural_cooperative", "airlines_air_carriers", "airports_flying_fields", "ambulance_services", "amusement_parks_carnivals", "antique_reproductions", "antique_shops", "aquariums", "architectural_surveying_services", "art_dealers_and_galleries", "artists_supply_and_craft_shops", "auto_and_home_supply_stores", "auto_body_repair_shops", "auto_paint_shops", "auto_service_shops", "automated_cash_disburse", "automated_fuel_dispensers", "automobile_associations", "automotive_parts_and_accessories_stores", "automotive_tire_stores", "bail_and_bond_payments", "bakeries", "bands_orchestras", "barber_and_beauty_shops", "betting_casino_gambling", "bicycle_shops", "billiard_pool_establishments", "boat_dealers", "boat_rentals_and_leases", "book_stores", "books_periodicals_and_newspapers", "bowling_alleys", "bus_lines", "business_secretarial_schools", "buying_shopping_services", "cable_satellite_and_other_pay_television_and_radio", "camera_and_photographic_supply_stores", "candy_nut_and_confectionery_stores", "car_and_truck_dealers_new_used", "car_and_truck_dealers_used_only", "car_rental_agencies", "car_washes", "carpentry_services", "carpet_upholstery_cleaning", "caterers", "charitable_and_social_service_organizations_fundraising", "chemicals_and_allied_products", "child_care_services", "childrens_and_infants_wear_stores", "chiropodists_podiatrists", "chiropractors", "cigar_stores_and_stands", "civic_social_fraternal_associations", "cleaning_and_maintenance", "clothing_rental", "colleges_universities", "commercial_equipment", "commercial_footwear", "commercial_photography_art_and_graphics", "commuter_transport_and_ferries", "computer_network_services", "computer_programming", "computer_repair", "computer_software_stores", "computers_peripherals_and_software", "concrete_work_services", "construction_materials", "consulting_public_relations", "correspondence_schools", "cosmetic_stores", "counseling_services", "country_clubs", "courier_services", "court_costs", "credit_reporting_agencies", "cruise_lines", "dairy_products_stores", "dance_hall_studios_schools", "dating_escort_services", "dentists_orthodontists", "department_stores", "detective_agencies", "digital_goods_applications", "digital_goods_games", "digital_goods_large_volume", "digital_goods_media", "direct_marketing_catalog_merchant", "direct_marketing_combination_catalog_and_retail_merchant", "direct_marketing_inbound_telemarketing", "direct_marketing_insurance_services", "direct_marketing_other", "direct_marketing_outbound_telemarketing", "direct_marketing_subscription", "direct_marketing_travel", "discount_stores", "doctors", "door_to_door_sales", "drapery_window_covering_and_upholstery_stores", "drinking_places", "drug_stores_and_pharmacies", "drugs_drug_proprietaries_and_druggist_sundries", "dry_cleaners", "durable_goods", "duty_free_stores", "eating_places_restaurants", "educational_services", "electric_razor_stores", "electric_vehicle_charging", "electrical_parts_and_equipment", "electrical_services", "electronics_repair_shops", "electronics_stores", "elementary_secondary_schools", "emergency_services_gcas_visa_use_only", "employment_temp_agencies", "equipment_rental", "exterminating_services", "family_clothing_stores", "fast_food_restaurants", "financial_institutions", "fines_government_administrative_entities", "fireplace_fireplace_screens_and_accessories_stores", "floor_covering_stores", "florists", "florists_supplies_nursery_stock_and_flowers", "freezer_and_locker_meat_provisioners", "fuel_dealers_non_automotive", "funeral_services_crematories", "furniture_home_furnishings_and_equipment_stores_except_appliances", "furniture_repair_refinishing", "furriers_and_fur_shops", "general_services", "gift_card_novelty_and_souvenir_shops", "glass_paint_and_wallpaper_stores", "glassware_crystal_stores", "golf_courses_public", "government_licensed_horse_dog_racing_us_region_only", "government_licensed_online_casions_online_gambling_us_region_only", "government_owned_lotteries_non_us_region", "government_owned_lotteries_us_region_only", "government_services", "grocery_stores_supermarkets", "hardware_equipment_and_supplies", "hardware_stores", "health_and_beauty_spas", "hearing_aids_sales_and_supplies", "heating_plumbing_a_c", "hobby_toy_and_game_shops", "home_supply_warehouse_stores", "hospitals", "hotels_motels_and_resorts", "household_appliance_stores", "industrial_supplies", "information_retrieval_services", "insurance_default", "insurance_underwriting_premiums", "intra_company_purchases", "jewelry_stores_watches_clocks_and_silverware_stores", "landscaping_services", "laundries", "laundry_cleaning_services", "legal_services_attorneys", "luggage_and_leather_goods_stores", "lumber_building_materials_stores", "manual_cash_disburse", "marinas_service_and_supplies", "marketplaces", "masonry_stonework_and_plaster", "massage_parlors", "medical_and_dental_labs", "medical_dental_ophthalmic_and_hospital_equipment_and_supplies", "medical_services", "membership_organizations", "mens_and_boys_clothing_and_accessories_stores", "mens_womens_clothing_stores", "metal_service_centers", "miscellaneous", "miscellaneous_apparel_and_accessory_shops", "miscellaneous_auto_dealers", "miscellaneous_business_services", "miscellaneous_food_stores", "miscellaneous_general_merchandise", "miscellaneous_general_services", "miscellaneous_home_furnishing_specialty_stores", "miscellaneous_publishing_and_printing", "miscellaneous_recreation_services", "miscellaneous_repair_shops", "miscellaneous_specialty_retail", "mobile_home_dealers", "motion_picture_theaters", "motor_freight_carriers_and_trucking", "motor_homes_dealers", "motor_vehicle_supplies_and_new_parts", "motorcycle_shops_and_dealers", "motorcycle_shops_dealers", "music_stores_musical_instruments_pianos_and_sheet_music", "news_dealers_and_newsstands", "non_fi_money_orders", "non_fi_stored_value_card_purchase_load", "nondurable_goods", "nurseries_lawn_and_garden_supply_stores", "nursing_personal_care", "office_and_commercial_furniture", "opticians_eyeglasses", "optometrists_ophthalmologist", "orthopedic_goods_prosthetic_devices", "osteopaths", "package_stores_beer_wine_and_liquor", "paints_varnishes_and_supplies", "parking_lots_garages", "passenger_railways", "pawn_shops", "pet_shops_pet_food_and_supplies", "petroleum_and_petroleum_products", "photo_developing", "photographic_photocopy_microfilm_equipment_and_supplies", "photographic_studios", "picture_video_production", "piece_goods_notions_and_other_dry_goods", "plumbing_heating_equipment_and_supplies", "political_organizations", "postal_services_government_only", "precious_stones_and_metals_watches_and_jewelry", "professional_services", "public_warehousing_and_storage", "quick_copy_repro_and_blueprint", "railroads", "real_estate_agents_and_managers_rentals", "record_stores", "recreational_vehicle_rentals", "religious_goods_stores", "religious_organizations", "roofing_siding_sheet_metal", "secretarial_support_services", "security_brokers_dealers", "service_stations", "sewing_needlework_fabric_and_piece_goods_stores", "shoe_repair_hat_cleaning", "shoe_stores", "small_appliance_repair", "snowmobile_dealers", "special_trade_services", "specialty_cleaning", "sporting_goods_stores", "sporting_recreation_camps", "sports_and_riding_apparel_stores", "sports_clubs_fields", "stamp_and_coin_stores", "stationary_office_supplies_printing_and_writing_paper", "stationery_stores_office_and_school_supply_stores", "swimming_pools_sales", "t_ui_travel_germany", "tailors_alterations", "tax_payments_government_agencies", "tax_preparation_services", "taxicabs_limousines", "telecommunication_equipment_and_telephone_sales", "telecommunication_services", "telegraph_services", "tent_and_awning_shops", "testing_laboratories", "theatrical_ticket_agencies", "timeshares", "tire_retreading_and_repair", "tolls_bridge_fees", "tourist_attractions_and_exhibits", "towing_services", "trailer_parks_campgrounds", "transportation_services", "travel_agencies_tour_operators", "truck_stop_iteration", "truck_utility_trailer_rentals", "typesetting_plate_making_and_related_services", "typewriter_stores", "u_s_federal_government_agencies_or_departments", "uniforms_commercial_clothing", "used_merchandise_and_secondhand_stores", "utilities", "variety_stores", "veterinary_services", "video_amusement_game_supplies", "video_game_arcades", "video_tape_rental_stores", "vocational_trade_schools", "watch_jewelry_repair", "welding_repair", "wholesale_clubs", "wig_and_toupee_stores", "wires_money_orders", "womens_accessory_and_specialty_shops", "womens_ready_to_wear_stores", "wrecking_and_salvage_yards" ], "maxLength": 5000, "type": "string" }, "type": "array" }, "interval": { "description": "Interval (or event) to which the amount applies.", "enum": [ "all_time", "daily", "monthly", "per_authorization", "weekly", "yearly" ], "type": "string" } }, "required": [ "amount", "interval" ], "title": "spending_limits_param", "type": "object", "x-stripeMostCommon": [ "amount", "categories", "interval" ] }, "type": "array" } }, "title": "authorization_controls_param", "type": "object", "x-stripeMostCommon": [ "allowed_categories", "allowed_merchant_countries", "allowed_merchant_currencies", "allowed_merchant_network_ids", "blocked_categories", "blocked_merchant_countries", "blocked_merchant_currencies", "blocked_merchant_network_ids", "max_approvals", "spending_limits" ] }, "status": { "description": "Dictates whether authorizations can be approved on this card. May be blocked from activating cards depending on past-due Cardholder requirements. Defaults to `inactive`. If this card is being canceled because it was lost or stolen, this information should be provided as `cancellation_reason`.", "enum": [ "active", "canceled", "inactive" ], "type": "string", "x-stripeBypassValidation": true } }, "type": "object", "x-stripeMostCommon": [ "cancellation_reason", "metadata", "status" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issuing.card" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a card" } }, "/v1/issuing/credit_underwriting_records": { "get": { "description": "

Retrieves a list of CreditUnderwritingRecord objects. The objects are sorted in descending order by creation date, with the most-recently-created object appearing first.

", "operationId": "GetIssuingCreditUnderwritingRecords", "parameters": [ { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/issuing.credit_underwriting_record" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/issuing/credit_underwriting_records", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "IssuingComplianceCreditUnderwritingRecordList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all records" } }, "/v1/issuing/credit_underwriting_records/create_from_application": { "post": { "description": "

Creates a CreditUnderwritingRecord object with information about a credit application submission.

", "operationId": "PostIssuingCreditUnderwritingRecordsCreateFromApplication", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "application": { "explode": true, "style": "deepObject" }, "credit_user": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "application": { "description": "Details about the application submission.", "properties": { "application_method": { "description": "The channel through which the applicant has submitted their application. Defaults to `online`.", "enum": [ "in_person", "mail", "online", "phone" ], "type": "string" }, "purpose": { "description": "Scope of demand made by the applicant.", "enum": [ "credit_limit_increase", "credit_line_opening" ], "type": "string" }, "submitted_at": { "description": "Date when the applicant submitted their application.", "format": "unix-time", "type": "integer" } }, "required": [ "purpose", "submitted_at" ], "title": "application_params", "type": "object", "x-stripeMostCommon": [ "purpose", "submitted_at" ] }, "credit_user": { "description": "Information about the company or person applying or holding the account.", "properties": { "email": { "description": "Email of the applicant or accountholder.", "type": "string" }, "name": { "description": "Full name of the company or person.", "maxLength": 5000, "type": "string" } }, "required": [ "email", "name" ], "title": "credit_user_params", "type": "object", "x-stripeMostCommon": [ "email", "name" ] }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" } }, "required": [ "application", "credit_user" ], "type": "object", "x-stripeMostCommon": [ "application", "credit_user", "metadata" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issuing.credit_underwriting_record" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create from an application" } }, "/v1/issuing/credit_underwriting_records/create_from_proactive_review": { "post": { "description": "

Creates a CreditUnderwritingRecord object from an underwriting decision coming from a proactive review of an existing accountholder.

", "operationId": "PostIssuingCreditUnderwritingRecordsCreateFromProactiveReview", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "credit_user": { "explode": true, "style": "deepObject" }, "decision": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "underwriting_exception": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "credit_user": { "description": "Information about the company or person applying or holding the account.", "properties": { "email": { "description": "Email of the applicant or accountholder.", "type": "string" }, "name": { "description": "Full name of the company or person.", "maxLength": 5000, "type": "string" } }, "required": [ "email", "name" ], "title": "credit_user_params", "type": "object", "x-stripeMostCommon": [ "email", "name" ] }, "decided_at": { "description": "Date when a decision was made.", "format": "unix-time", "type": "integer" }, "decision": { "description": "Details about the decision.", "properties": { "credit_limit_approved": { "description": "Details about the credit limit approved. An approved credit limit is required before you can set a `credit_limit_amount` in the [CreditPolicy API](https://stripe.com/docs/api/issuing/credit_policy/)", "properties": { "amount": { "description": "The credit approved, in the currency of the account and [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", "type": "integer" }, "currency": { "description": "The currency of the credit approved, will default to the Account's Issuing currency.", "format": "currency", "type": "string" } }, "required": [ "amount" ], "title": "credit_limit_approved_params", "type": "object", "x-stripeMostCommon": [ "amount", "consumer_revolving_credit", "currency" ] }, "credit_limit_decreased": { "description": "Details about the credit limit decreased.", "properties": { "amount": { "description": "The credit approved, in the currency of the account and [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", "type": "integer" }, "currency": { "description": "The currency of the credit approved, will default to the Account's Issuing currency.", "format": "currency", "type": "string" }, "reason_other_explanation": { "description": "Details about the `reasons.other` when present.", "maxLength": 5000, "type": "string" }, "reasons": { "description": "List of reasons why the existing credit was decreased, up to 4 reasons, in order of importance.", "items": { "enum": [ "applicant_is_not_beneficial_owner", "applicant_too_young", "application_is_not_beneficial_owner", "bankruptcy", "business_size_too_small", "change_in_financial_state", "change_in_utilization_of_credit_line", "current_account_tier_ineligible", "customer_already_exists", "customer_requested_account_closure", "debt_to_cash_balance_ratio_too_high", "debt_to_equity_ratio_too_high", "decrease_in_income_to_expense_ratio", "decrease_in_social_media_performance", "delinquent_credit_obligations", "dispute_rate_too_high", "duration_of_residence", "exceeds_acceptable_platform_exposure", "excessive_income_or_revenue_obligations", "expenses_to_cash_balance_ratio_too_high", "foreclosure_or_repossession", "frozen_file_at_credit_bureau", "garnishment_or_attachment", "government_loan_program_criteria", "has_recent_credit_limit_increase", "high_concentration_of_clients", "high_risk_industry", "incomplete_application", "inconsistent_monthly_revenues", "insufficient_account_history_with_platform", "insufficient_bank_account_history", "insufficient_cash_balance", "insufficient_cash_flow", "insufficient_collateral", "insufficient_credit_experience", "insufficient_credit_utilization", "insufficient_deposits", "insufficient_income", "insufficient_margin_ratio", "insufficient_operating_profit", "insufficient_period_in_operation", "insufficient_reserves", "insufficient_revenue", "insufficient_social_media_performance", "insufficient_time_in_network", "insufficient_trade_credit_insurance", "insufficient_usage_as_qualified_expenses", "invalid_business_license", "lacking_cash_account", "late_payment_history_reported_to_bureau", "lien_collection_action_or_judgement", "negative_public_information", "no_credit_file", "other", "outside_supported_country", "outside_supported_state", "poor_payment_history_with_platform", "prior_or_current_legal_action", "prohibited_industry", "rate_of_cash_balance_fluctuation_too_high", "recent_inquiries_on_business_credit_report", "removal_of_bank_account_connection", "revenue_discrepancy", "runway_too_short", "suspected_fraud", "too_many_non_sufficient_funds_or_overdrafts", "unable_to_verify_address", "unable_to_verify_identity", "unable_to_verify_income_or_revenue", "unprofitable", "unsupportable_business_type" ], "type": "string" }, "type": "array" } }, "required": [ "amount", "reasons" ], "title": "credit_limit_decreased_params", "type": "object", "x-stripeMostCommon": [ "amount", "consumer_revolving_credit", "currency", "reason_other_explanation", "reasons" ] }, "credit_line_closed": { "description": "Details about the credit line closed.", "properties": { "reason_other_explanation": { "description": "Details about the `reasons.other` when present.", "maxLength": 5000, "type": "string" }, "reasons": { "description": "List of reasons why the credit line was closed, up to 4 reasons, in order of importance.", "items": { "enum": [ "applicant_is_not_beneficial_owner", "applicant_too_young", "application_is_not_beneficial_owner", "bankruptcy", "business_size_too_small", "change_in_financial_state", "change_in_utilization_of_credit_line", "current_account_tier_ineligible", "customer_already_exists", "customer_requested_account_closure", "debt_to_cash_balance_ratio_too_high", "debt_to_equity_ratio_too_high", "decrease_in_income_to_expense_ratio", "decrease_in_social_media_performance", "delinquent_credit_obligations", "dispute_rate_too_high", "duration_of_residence", "exceeds_acceptable_platform_exposure", "excessive_income_or_revenue_obligations", "expenses_to_cash_balance_ratio_too_high", "foreclosure_or_repossession", "frozen_file_at_credit_bureau", "garnishment_or_attachment", "government_loan_program_criteria", "has_recent_credit_limit_increase", "high_concentration_of_clients", "high_risk_industry", "incomplete_application", "inconsistent_monthly_revenues", "insufficient_account_history_with_platform", "insufficient_bank_account_history", "insufficient_cash_balance", "insufficient_cash_flow", "insufficient_collateral", "insufficient_credit_experience", "insufficient_credit_utilization", "insufficient_deposits", "insufficient_income", "insufficient_margin_ratio", "insufficient_operating_profit", "insufficient_period_in_operation", "insufficient_reserves", "insufficient_revenue", "insufficient_social_media_performance", "insufficient_time_in_network", "insufficient_trade_credit_insurance", "insufficient_usage_as_qualified_expenses", "invalid_business_license", "lacking_cash_account", "late_payment_history_reported_to_bureau", "lien_collection_action_or_judgement", "negative_public_information", "no_credit_file", "other", "outside_supported_country", "outside_supported_state", "poor_payment_history_with_platform", "prior_or_current_legal_action", "prohibited_industry", "rate_of_cash_balance_fluctuation_too_high", "recent_inquiries_on_business_credit_report", "removal_of_bank_account_connection", "revenue_discrepancy", "runway_too_short", "suspected_fraud", "too_many_non_sufficient_funds_or_overdrafts", "unable_to_verify_address", "unable_to_verify_identity", "unable_to_verify_income_or_revenue", "unprofitable", "unsupportable_business_type" ], "type": "string", "x-stripeBypassValidation": true }, "type": "array" } }, "required": [ "reasons" ], "title": "credit_line_closed_params", "type": "object", "x-stripeMostCommon": [ "reason_other_explanation", "reasons" ] }, "type": { "description": "Outcome of the decision.", "enum": [ "credit_limit_approved", "credit_limit_decreased", "credit_line_closed", "no_changes" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "proactive_decision_params", "type": "object", "x-stripeMostCommon": [ "annual_percentage_rate_changed", "credit_limit_approved", "credit_limit_decreased", "credit_line_closed", "credit_line_suspended", "suspension_reasons_lifted", "type" ] }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "regulatory_reporting_file": { "description": "File containing regulatory reporting data for the decision. Required if you are subject to this [reporting requirement](https://stripe.com/docs/issuing/credit/report-required-regulatory-data-for-credit-decisions).", "maxLength": 5000, "type": "string" }, "underwriting_exception": { "description": "If an exception to the usual underwriting criteria was made for this decision, details about the exception must be provided. Exceptions should only be granted in rare circumstances, in consultation with Stripe Compliance.", "properties": { "explanation": { "description": "Written explanation for the exception.", "maxLength": 5000, "type": "string" }, "original_decision_type": { "description": "The decision before the exception was applied.", "enum": [ "additional_information_requested", "application_rejected", "credit_limit_approved", "credit_limit_decreased", "credit_line_closed", "no_changes", "withdrawn_by_applicant" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "explanation", "original_decision_type" ], "title": "underwriting_exception_params", "type": "object", "x-stripeMostCommon": [ "explanation", "original_decision_type" ] } }, "required": [ "credit_user", "decided_at", "decision" ], "type": "object", "x-stripeMostCommon": [ "credit_user", "decided_at", "decision", "metadata" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issuing.credit_underwriting_record" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create from a proactive review" } }, "/v1/issuing/credit_underwriting_records/{credit_underwriting_record}": { "get": { "description": "

Retrieves a CreditUnderwritingRecord object.

", "operationId": "GetIssuingCreditUnderwritingRecordsCreditUnderwritingRecord", "parameters": [ { "in": "path", "name": "credit_underwriting_record", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issuing.credit_underwriting_record" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a record" } }, "/v1/issuing/credit_underwriting_records/{credit_underwriting_record}/correct": { "post": { "description": "

Update a CreditUnderwritingRecord object to correct mistakes.

", "operationId": "PostIssuingCreditUnderwritingRecordsCreditUnderwritingRecordCorrect", "parameters": [ { "in": "path", "name": "credit_underwriting_record", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "application": { "explode": true, "style": "deepObject" }, "credit_user": { "explode": true, "style": "deepObject" }, "decision": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "underwriting_exception": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "application": { "description": "Details about the application submission.", "properties": { "application_method": { "description": "The channel through which the applicant has submitted their application. Defaults to `online`.", "enum": [ "in_person", "mail", "online", "phone" ], "type": "string" }, "purpose": { "description": "Scope of demand made by the applicant.", "enum": [ "credit_limit_increase", "credit_line_opening" ], "type": "string" }, "submitted_at": { "description": "Date when the applicant submitted their application.", "format": "unix-time", "type": "integer" } }, "required": [ "purpose", "submitted_at" ], "title": "application_params", "type": "object", "x-stripeMostCommon": [ "purpose", "submitted_at" ] }, "credit_user": { "description": "Information about the company or person applying or holding the account.", "properties": { "email": { "description": "Email of the applicant or accountholder.", "type": "string" }, "name": { "description": "Full name of the company or person.", "maxLength": 5000, "type": "string" } }, "required": [ "email", "name" ], "title": "credit_user_params", "type": "object", "x-stripeMostCommon": [ "email", "name" ] }, "decided_at": { "description": "Date when a decision was made.", "format": "unix-time", "type": "integer" }, "decision": { "description": "Details about the decision.", "properties": { "application_rejected": { "description": "Details about the application rejection.", "properties": { "reason_other_explanation": { "description": "Details about the `reasons.other` when present.", "maxLength": 5000, "type": "string" }, "reasons": { "description": "List of reasons why the application was rejected, up to 4 reasons, in order of importance.", "items": { "enum": [ "applicant_is_not_beneficial_owner", "applicant_too_young", "application_is_not_beneficial_owner", "bankruptcy", "business_size_too_small", "current_account_tier_ineligible", "customer_already_exists", "customer_requested_account_closure", "debt_to_cash_balance_ratio_too_high", "debt_to_equity_ratio_too_high", "delinquent_credit_obligations", "dispute_rate_too_high", "duration_of_residence", "excessive_income_or_revenue_obligations", "expenses_to_cash_balance_ratio_too_high", "foreclosure_or_repossession", "frozen_file_at_credit_bureau", "garnishment_or_attachment", "government_loan_program_criteria", "high_concentration_of_clients", "high_risk_industry", "incomplete_application", "inconsistent_monthly_revenues", "insufficient_account_history_with_platform", "insufficient_bank_account_history", "insufficient_cash_balance", "insufficient_cash_flow", "insufficient_collateral", "insufficient_credit_experience", "insufficient_deposits", "insufficient_income", "insufficient_margin_ratio", "insufficient_operating_profit", "insufficient_period_in_operation", "insufficient_reserves", "insufficient_revenue", "insufficient_social_media_performance", "insufficient_time_in_network", "insufficient_trade_credit_insurance", "invalid_business_license", "lacking_cash_account", "late_payment_history_reported_to_bureau", "lien_collection_action_or_judgement", "negative_public_information", "no_credit_file", "other", "outside_supported_country", "outside_supported_state", "poor_payment_history_with_platform", "prior_or_current_legal_action", "prohibited_industry", "rate_of_cash_balance_fluctuation_too_high", "recent_inquiries_on_business_credit_report", "removal_of_bank_account_connection", "revenue_discrepancy", "runway_too_short", "suspected_fraud", "too_many_non_sufficient_funds_or_overdrafts", "unable_to_verify_address", "unable_to_verify_identity", "unable_to_verify_income_or_revenue", "unprofitable", "unsupportable_business_type" ], "type": "string" }, "type": "array" } }, "required": [ "reasons" ], "title": "application_rejected_params", "type": "object", "x-stripeMostCommon": [ "reason_other_explanation", "reasons" ] }, "credit_limit_approved": { "description": "Details about the credit limit approved. An approved credit limit is required before you can set a `credit_limit_amount` in the [CreditPolicy API](https://stripe.com/docs/api/issuing/credit_policy/)", "properties": { "amount": { "description": "The credit approved, in the currency of the account and [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", "type": "integer" }, "currency": { "description": "The currency of the credit approved, will default to the Account's Issuing currency.", "format": "currency", "type": "string" } }, "required": [ "amount" ], "title": "credit_limit_approved_params", "type": "object", "x-stripeMostCommon": [ "amount", "consumer_revolving_credit", "currency" ] }, "credit_limit_decreased": { "description": "Details about the credit limit decreased.", "properties": { "amount": { "description": "The credit approved, in the currency of the account and [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", "type": "integer" }, "currency": { "description": "The currency of the credit approved, will default to the Account's Issuing currency.", "format": "currency", "type": "string" }, "reason_other_explanation": { "description": "Details about the `reasons.other` when present.", "maxLength": 5000, "type": "string" }, "reasons": { "description": "List of reasons why the existing credit was decreased, up to 4 reasons, in order of importance.", "items": { "enum": [ "applicant_is_not_beneficial_owner", "applicant_too_young", "application_is_not_beneficial_owner", "bankruptcy", "business_size_too_small", "change_in_financial_state", "change_in_utilization_of_credit_line", "current_account_tier_ineligible", "customer_already_exists", "customer_requested_account_closure", "debt_to_cash_balance_ratio_too_high", "debt_to_equity_ratio_too_high", "decrease_in_income_to_expense_ratio", "decrease_in_social_media_performance", "delinquent_credit_obligations", "dispute_rate_too_high", "duration_of_residence", "exceeds_acceptable_platform_exposure", "excessive_income_or_revenue_obligations", "expenses_to_cash_balance_ratio_too_high", "foreclosure_or_repossession", "frozen_file_at_credit_bureau", "garnishment_or_attachment", "government_loan_program_criteria", "has_recent_credit_limit_increase", "high_concentration_of_clients", "high_risk_industry", "incomplete_application", "inconsistent_monthly_revenues", "insufficient_account_history_with_platform", "insufficient_bank_account_history", "insufficient_cash_balance", "insufficient_cash_flow", "insufficient_collateral", "insufficient_credit_experience", "insufficient_credit_utilization", "insufficient_deposits", "insufficient_income", "insufficient_margin_ratio", "insufficient_operating_profit", "insufficient_period_in_operation", "insufficient_reserves", "insufficient_revenue", "insufficient_social_media_performance", "insufficient_time_in_network", "insufficient_trade_credit_insurance", "insufficient_usage_as_qualified_expenses", "invalid_business_license", "lacking_cash_account", "late_payment_history_reported_to_bureau", "lien_collection_action_or_judgement", "negative_public_information", "no_credit_file", "other", "outside_supported_country", "outside_supported_state", "poor_payment_history_with_platform", "prior_or_current_legal_action", "prohibited_industry", "rate_of_cash_balance_fluctuation_too_high", "recent_inquiries_on_business_credit_report", "removal_of_bank_account_connection", "revenue_discrepancy", "runway_too_short", "suspected_fraud", "too_many_non_sufficient_funds_or_overdrafts", "unable_to_verify_address", "unable_to_verify_identity", "unable_to_verify_income_or_revenue", "unprofitable", "unsupportable_business_type" ], "type": "string" }, "type": "array" } }, "required": [ "amount", "reasons" ], "title": "credit_limit_decreased_params", "type": "object", "x-stripeMostCommon": [ "amount", "consumer_revolving_credit", "currency", "reason_other_explanation", "reasons" ] }, "credit_line_closed": { "description": "Details about the credit line closed.", "properties": { "reason_other_explanation": { "description": "Details about the `reasons.other` when present.", "maxLength": 5000, "type": "string" }, "reasons": { "description": "List of reasons why the credit line was closed, up to 4 reasons, in order of importance.", "items": { "enum": [ "applicant_is_not_beneficial_owner", "applicant_too_young", "application_is_not_beneficial_owner", "bankruptcy", "business_size_too_small", "change_in_financial_state", "change_in_utilization_of_credit_line", "current_account_tier_ineligible", "customer_already_exists", "customer_requested_account_closure", "debt_to_cash_balance_ratio_too_high", "debt_to_equity_ratio_too_high", "decrease_in_income_to_expense_ratio", "decrease_in_social_media_performance", "delinquent_credit_obligations", "dispute_rate_too_high", "duration_of_residence", "exceeds_acceptable_platform_exposure", "excessive_income_or_revenue_obligations", "expenses_to_cash_balance_ratio_too_high", "foreclosure_or_repossession", "frozen_file_at_credit_bureau", "garnishment_or_attachment", "government_loan_program_criteria", "has_recent_credit_limit_increase", "high_concentration_of_clients", "high_risk_industry", "incomplete_application", "inconsistent_monthly_revenues", "insufficient_account_history_with_platform", "insufficient_bank_account_history", "insufficient_cash_balance", "insufficient_cash_flow", "insufficient_collateral", "insufficient_credit_experience", "insufficient_credit_utilization", "insufficient_deposits", "insufficient_income", "insufficient_margin_ratio", "insufficient_operating_profit", "insufficient_period_in_operation", "insufficient_reserves", "insufficient_revenue", "insufficient_social_media_performance", "insufficient_time_in_network", "insufficient_trade_credit_insurance", "insufficient_usage_as_qualified_expenses", "invalid_business_license", "lacking_cash_account", "late_payment_history_reported_to_bureau", "lien_collection_action_or_judgement", "negative_public_information", "no_credit_file", "other", "outside_supported_country", "outside_supported_state", "poor_payment_history_with_platform", "prior_or_current_legal_action", "prohibited_industry", "rate_of_cash_balance_fluctuation_too_high", "recent_inquiries_on_business_credit_report", "removal_of_bank_account_connection", "revenue_discrepancy", "runway_too_short", "suspected_fraud", "too_many_non_sufficient_funds_or_overdrafts", "unable_to_verify_address", "unable_to_verify_identity", "unable_to_verify_income_or_revenue", "unprofitable", "unsupportable_business_type" ], "type": "string", "x-stripeBypassValidation": true }, "type": "array" } }, "required": [ "reasons" ], "title": "credit_line_closed_params", "type": "object", "x-stripeMostCommon": [ "reason_other_explanation", "reasons" ] }, "type": { "description": "Outcome of the decision.", "enum": [ "additional_information_requested", "application_rejected", "credit_limit_approved", "credit_limit_decreased", "credit_line_closed", "no_changes", "withdrawn_by_applicant" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "correct_decision_params", "type": "object", "x-stripeMostCommon": [ "application_rejected", "credit_limit_approved", "credit_limit_decreased", "credit_line_closed", "credit_line_suspended", "suspension_reasons_lifted", "type" ] }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "regulatory_reporting_file": { "description": "File containing regulatory reporting data for the decision. Required if you are subject to this [reporting requirement](https://stripe.com/docs/issuing/credit/report-required-regulatory-data-for-credit-decisions). Optional if previously provided and no changes are needed.", "maxLength": 5000, "type": "string" }, "underwriting_exception": { "description": "If an exception to the usual underwriting criteria was made for this decision, details about the exception must be provided. Exceptions should only be granted in rare circumstances, in consultation with Stripe Compliance.", "properties": { "explanation": { "description": "Written explanation for the exception.", "maxLength": 5000, "type": "string" }, "original_decision_type": { "description": "The decision before the exception was applied.", "enum": [ "additional_information_requested", "application_rejected", "credit_limit_approved", "credit_limit_decreased", "credit_line_closed", "no_changes", "withdrawn_by_applicant" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "explanation", "original_decision_type" ], "title": "underwriting_exception_params", "type": "object", "x-stripeMostCommon": [ "explanation", "original_decision_type" ] } }, "type": "object", "x-stripeMostCommon": [ "application", "credit_user", "decided_at", "decision", "metadata" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issuing.credit_underwriting_record" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Correct an erroneous record" } }, "/v1/issuing/credit_underwriting_records/{credit_underwriting_record}/report_decision": { "post": { "description": "

Update a CreditUnderwritingRecord object from a decision made on a credit application.

", "operationId": "PostIssuingCreditUnderwritingRecordsCreditUnderwritingRecordReportDecision", "parameters": [ { "in": "path", "name": "credit_underwriting_record", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "decision": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "underwriting_exception": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "decided_at": { "description": "Date when a decision was made.", "format": "unix-time", "type": "integer" }, "decision": { "description": "Details about the decision.", "properties": { "application_rejected": { "description": "Details about the application rejection.", "properties": { "reason_other_explanation": { "description": "Details about the `reasons.other` when present.", "maxLength": 5000, "type": "string" }, "reasons": { "description": "List of reasons why the application was rejected, up to 4 reasons, in order of importance.", "items": { "enum": [ "applicant_is_not_beneficial_owner", "applicant_too_young", "application_is_not_beneficial_owner", "bankruptcy", "business_size_too_small", "current_account_tier_ineligible", "customer_already_exists", "customer_requested_account_closure", "debt_to_cash_balance_ratio_too_high", "debt_to_equity_ratio_too_high", "delinquent_credit_obligations", "dispute_rate_too_high", "duration_of_residence", "excessive_income_or_revenue_obligations", "expenses_to_cash_balance_ratio_too_high", "foreclosure_or_repossession", "frozen_file_at_credit_bureau", "garnishment_or_attachment", "government_loan_program_criteria", "high_concentration_of_clients", "high_risk_industry", "incomplete_application", "inconsistent_monthly_revenues", "insufficient_account_history_with_platform", "insufficient_bank_account_history", "insufficient_cash_balance", "insufficient_cash_flow", "insufficient_collateral", "insufficient_credit_experience", "insufficient_deposits", "insufficient_income", "insufficient_margin_ratio", "insufficient_operating_profit", "insufficient_period_in_operation", "insufficient_reserves", "insufficient_revenue", "insufficient_social_media_performance", "insufficient_time_in_network", "insufficient_trade_credit_insurance", "invalid_business_license", "lacking_cash_account", "late_payment_history_reported_to_bureau", "lien_collection_action_or_judgement", "negative_public_information", "no_credit_file", "other", "outside_supported_country", "outside_supported_state", "poor_payment_history_with_platform", "prior_or_current_legal_action", "prohibited_industry", "rate_of_cash_balance_fluctuation_too_high", "recent_inquiries_on_business_credit_report", "removal_of_bank_account_connection", "revenue_discrepancy", "runway_too_short", "suspected_fraud", "too_many_non_sufficient_funds_or_overdrafts", "unable_to_verify_address", "unable_to_verify_identity", "unable_to_verify_income_or_revenue", "unprofitable", "unsupportable_business_type" ], "type": "string" }, "type": "array" } }, "required": [ "reasons" ], "title": "application_rejected_params", "type": "object", "x-stripeMostCommon": [ "reason_other_explanation", "reasons" ] }, "credit_limit_approved": { "description": "Details about the credit limit approved. An approved credit limit is required before you can set a `credit_limit_amount` in the [CreditPolicy API](https://stripe.com/docs/api/issuing/credit_policy/)", "properties": { "amount": { "description": "The credit approved, in the currency of the account and [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", "type": "integer" }, "currency": { "description": "The currency of the credit approved, will default to the Account's Issuing currency.", "format": "currency", "type": "string" } }, "required": [ "amount" ], "title": "credit_limit_approved_params", "type": "object", "x-stripeMostCommon": [ "amount", "consumer_revolving_credit", "currency" ] }, "type": { "description": "Outcome of the decision.", "enum": [ "additional_information_requested", "application_rejected", "credit_limit_approved", "withdrawn_by_applicant" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "application_decision_params", "type": "object", "x-stripeMostCommon": [ "annual_percentage_rate_changed", "application_rejected", "credit_limit_approved", "type" ] }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "regulatory_reporting_file": { "description": "File containing regulatory reporting data for the decision. Required if you are subject to this [reporting requirement](https://stripe.com/docs/issuing/credit/report-required-regulatory-data-for-credit-decisions).", "maxLength": 5000, "type": "string" }, "underwriting_exception": { "description": "If an exception to the usual underwriting criteria was made for this decision, details about the exception must be provided. Exceptions should only be granted in rare circumstances, in consultation with Stripe Compliance.", "properties": { "explanation": { "description": "Written explanation for the exception.", "maxLength": 5000, "type": "string" }, "original_decision_type": { "description": "The decision before the exception was applied.", "enum": [ "additional_information_requested", "application_rejected", "credit_limit_approved", "credit_limit_decreased", "credit_line_closed", "no_changes", "withdrawn_by_applicant" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "explanation", "original_decision_type" ], "title": "underwriting_exception_params", "type": "object", "x-stripeMostCommon": [ "explanation", "original_decision_type" ] } }, "required": [ "decided_at", "decision" ], "type": "object", "x-stripeMostCommon": [ "decided_at", "decision", "metadata" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issuing.credit_underwriting_record" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Report a decision" } }, "/v1/issuing/dispute_settlement_details": { "get": { "description": "

Returns a list of Issuing DisputeSettlementDetail objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

", "operationId": "GetIssuingDisputeSettlementDetails", "parameters": [ { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "Select the Issuing dispute settlement details for the given settlement.", "in": "query", "name": "settlement", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/issuing.dispute_settlement_detail" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/issuing/dispute_settlement_details", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "IssuingDisputeSettlementDetailList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all dispute settlement details" } }, "/v1/issuing/dispute_settlement_details/{dispute_settlement_detail}": { "get": { "description": "

Retrieves an Issuing DisputeSettlementDetail object.

", "operationId": "GetIssuingDisputeSettlementDetailsDisputeSettlementDetail", "parameters": [ { "in": "path", "name": "dispute_settlement_detail", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issuing.dispute_settlement_detail" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a dispute settlement detail" } }, "/v1/issuing/disputes": { "get": { "description": "

Returns a list of Issuing Dispute objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

", "operationId": "GetIssuingDisputes", "parameters": [ { "description": "Only return Issuing disputes that were created during the given date interval.", "explode": true, "in": "query", "name": "created", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "description": "Minimum value to filter by (exclusive)", "type": "integer" }, "gte": { "description": "Minimum value to filter by (inclusive)", "type": "integer" }, "lt": { "description": "Maximum value to filter by (exclusive)", "type": "integer" }, "lte": { "description": "Maximum value to filter by (inclusive)", "type": "integer" } }, "title": "range_query_specs", "type": "object", "x-stripeMostCommon": [ "gt", "gte", "lt", "lte" ] }, { "type": "integer" } ] }, "style": "deepObject" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Select Issuing disputes with the given status.", "in": "query", "name": "status", "required": false, "schema": { "enum": [ "expired", "lost", "submitted", "unsubmitted", "won" ], "type": "string" }, "style": "form" }, { "description": "Select the Issuing dispute for the given transaction.", "in": "query", "name": "transaction", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/issuing.dispute" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/issuing/disputes", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "IssuingDisputeList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all disputes" }, "post": { "description": "

Creates an Issuing Dispute object. Individual pieces of evidence within the evidence object are optional at this point. Stripe only validates that required evidence is present during submission. Refer to Dispute reasons and evidence for more details about evidence requirements.

", "operationId": "PostIssuingDisputes", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "evidence": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "treasury": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "amount": { "description": "The dispute amount in the card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). If not set, defaults to the full transaction amount.", "type": "integer" }, "evidence": { "description": "Evidence provided for the dispute.", "properties": { "canceled": { "anyOf": [ { "properties": { "additional_documentation": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute." }, "canceled_at": { "anyOf": [ { "format": "unix-time", "type": "integer" }, { "enum": [ "" ], "type": "string" } ], "description": "Date when order was canceled." }, "cancellation_policy_provided": { "anyOf": [ { "type": "boolean" }, { "enum": [ "" ], "type": "string" } ], "description": "Whether the cardholder was provided with a cancellation policy." }, "cancellation_reason": { "anyOf": [ { "maxLength": 2500, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Reason for canceling the order." }, "expected_at": { "anyOf": [ { "format": "unix-time", "type": "integer" }, { "enum": [ "" ], "type": "string" } ], "description": "Date when the cardholder expected to receive the product." }, "explanation": { "anyOf": [ { "maxLength": 2500, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Explanation of why the cardholder is disputing this transaction." }, "product_description": { "anyOf": [ { "maxLength": 2500, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Description of the merchandise or service that was purchased." }, "product_type": { "description": "Whether the product was a merchandise or service.", "enum": [ "", "merchandise", "service" ], "type": "string" }, "return_status": { "description": "Result of cardholder's attempt to return the product.", "enum": [ "", "merchant_rejected", "successful" ], "type": "string" }, "returned_at": { "anyOf": [ { "format": "unix-time", "type": "integer" }, { "enum": [ "" ], "type": "string" } ], "description": "Date when the product was returned or attempted to be returned." } }, "title": "canceled", "type": "object", "x-stripeMostCommon": [ "additional_documentation", "canceled_at", "cancellation_policy_provided", "cancellation_reason", "expected_at", "explanation", "product_description", "product_type", "return_status", "returned_at" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Evidence provided when `reason` is 'canceled'." }, "duplicate": { "anyOf": [ { "properties": { "additional_documentation": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute." }, "card_statement": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Copy of the card statement showing that the product had already been paid for." }, "cash_receipt": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Copy of the receipt showing that the product had been paid for in cash." }, "check_image": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Image of the front and back of the check that was used to pay for the product." }, "explanation": { "anyOf": [ { "maxLength": 2500, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Explanation of why the cardholder is disputing this transaction." }, "original_transaction": { "description": "Transaction (e.g., ipi_...) that the disputed transaction is a duplicate of. Of the two or more transactions that are copies of each other, this is original undisputed one.", "maxLength": 5000, "type": "string" } }, "title": "duplicate", "type": "object", "x-stripeMostCommon": [ "additional_documentation", "card_statement", "cash_receipt", "check_image", "explanation", "original_transaction" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Evidence provided when `reason` is 'duplicate'." }, "fraudulent": { "anyOf": [ { "properties": { "additional_documentation": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute." }, "explanation": { "anyOf": [ { "maxLength": 2500, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Explanation of why the cardholder is disputing this transaction." } }, "title": "fraudulent", "type": "object", "x-stripeMostCommon": [ "additional_documentation", "explanation" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Evidence provided when `reason` is 'fraudulent'." }, "merchandise_not_as_described": { "anyOf": [ { "properties": { "additional_documentation": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute." }, "explanation": { "anyOf": [ { "maxLength": 2500, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Explanation of why the cardholder is disputing this transaction." }, "received_at": { "anyOf": [ { "format": "unix-time", "type": "integer" }, { "enum": [ "" ], "type": "string" } ], "description": "Date when the product was received." }, "return_description": { "anyOf": [ { "maxLength": 2500, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Description of the cardholder's attempt to return the product." }, "return_status": { "description": "Result of cardholder's attempt to return the product.", "enum": [ "", "merchant_rejected", "successful" ], "type": "string" }, "returned_at": { "anyOf": [ { "format": "unix-time", "type": "integer" }, { "enum": [ "" ], "type": "string" } ], "description": "Date when the product was returned or attempted to be returned." } }, "title": "merchandise_not_as_described", "type": "object", "x-stripeMostCommon": [ "additional_documentation", "explanation", "received_at", "return_description", "return_status", "returned_at" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Evidence provided when `reason` is 'merchandise_not_as_described'." }, "no_valid_authorization": { "anyOf": [ { "properties": { "additional_documentation": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute." }, "explanation": { "anyOf": [ { "maxLength": 2500, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Explanation of why the cardholder is disputing this transaction." } }, "title": "no_valid_authorization", "type": "object", "x-stripeMostCommon": [ "additional_documentation", "explanation" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Evidence provided when `reason` is 'no_valid_authorization'." }, "not_received": { "anyOf": [ { "properties": { "additional_documentation": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute." }, "expected_at": { "anyOf": [ { "format": "unix-time", "type": "integer" }, { "enum": [ "" ], "type": "string" } ], "description": "Date when the cardholder expected to receive the product." }, "explanation": { "anyOf": [ { "maxLength": 2500, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Explanation of why the cardholder is disputing this transaction." }, "product_description": { "anyOf": [ { "maxLength": 2500, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Description of the merchandise or service that was purchased." }, "product_type": { "description": "Whether the product was a merchandise or service.", "enum": [ "", "merchandise", "service" ], "type": "string" } }, "title": "not_received", "type": "object", "x-stripeMostCommon": [ "additional_documentation", "expected_at", "explanation", "product_description", "product_type" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Evidence provided when `reason` is 'not_received'." }, "other": { "anyOf": [ { "properties": { "additional_documentation": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute." }, "explanation": { "anyOf": [ { "maxLength": 2500, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Explanation of why the cardholder is disputing this transaction." }, "product_description": { "anyOf": [ { "maxLength": 2500, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Description of the merchandise or service that was purchased." }, "product_type": { "description": "Whether the product was a merchandise or service.", "enum": [ "", "merchandise", "service" ], "type": "string" } }, "title": "other", "type": "object", "x-stripeMostCommon": [ "additional_documentation", "explanation", "product_description", "product_type" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Evidence provided when `reason` is 'other'." }, "reason": { "description": "The reason for filing the dispute. The evidence should be submitted in the field of the same name.", "enum": [ "canceled", "duplicate", "fraudulent", "merchandise_not_as_described", "no_valid_authorization", "not_received", "other", "service_not_as_described" ], "type": "string", "x-stripeBypassValidation": true }, "service_not_as_described": { "anyOf": [ { "properties": { "additional_documentation": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute." }, "canceled_at": { "anyOf": [ { "format": "unix-time", "type": "integer" }, { "enum": [ "" ], "type": "string" } ], "description": "Date when order was canceled." }, "cancellation_reason": { "anyOf": [ { "maxLength": 2500, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Reason for canceling the order." }, "explanation": { "anyOf": [ { "maxLength": 2500, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Explanation of why the cardholder is disputing this transaction." }, "received_at": { "anyOf": [ { "format": "unix-time", "type": "integer" }, { "enum": [ "" ], "type": "string" } ], "description": "Date when the product was received." } }, "title": "service_not_as_described", "type": "object", "x-stripeMostCommon": [ "additional_documentation", "canceled_at", "cancellation_reason", "explanation", "received_at" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Evidence provided when `reason` is 'service_not_as_described'." } }, "title": "evidence_param", "type": "object", "x-stripeMostCommon": [ "canceled", "duplicate", "fraudulent", "merchandise_not_as_described", "no_valid_authorization", "not_received", "other", "reason", "service_not_as_described" ] }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "transaction": { "description": "The ID of the issuing transaction to create a dispute for. For transaction on Treasury FinancialAccounts, use `treasury.received_debit`.", "maxLength": 5000, "type": "string" }, "treasury": { "description": "Params for disputes related to Treasury FinancialAccounts", "properties": { "received_debit": { "description": "The ID of the ReceivedDebit to initiate an Issuings dispute for.", "maxLength": 5000, "type": "string" } }, "required": [ "received_debit" ], "title": "treasury_param", "type": "object", "x-stripeMostCommon": [ "received_debit" ] } }, "type": "object", "x-stripeMostCommon": [ "evidence", "metadata", "transaction" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issuing.dispute" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a dispute" } }, "/v1/issuing/disputes/{dispute}": { "get": { "description": "

Retrieves an Issuing Dispute object.

", "operationId": "GetIssuingDisputesDispute", "parameters": [ { "in": "path", "name": "dispute", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issuing.dispute" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a dispute" }, "post": { "description": "

Updates the specified Issuing Dispute object by setting the values of the parameters passed. Any parameters not provided will be left unchanged. Properties on the evidence object can be unset by passing in an empty string.

", "operationId": "PostIssuingDisputesDispute", "parameters": [ { "in": "path", "name": "dispute", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "evidence": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "amount": { "description": "The dispute amount in the card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", "type": "integer" }, "evidence": { "description": "Evidence provided for the dispute.", "properties": { "canceled": { "anyOf": [ { "properties": { "additional_documentation": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute." }, "canceled_at": { "anyOf": [ { "format": "unix-time", "type": "integer" }, { "enum": [ "" ], "type": "string" } ], "description": "Date when order was canceled." }, "cancellation_policy_provided": { "anyOf": [ { "type": "boolean" }, { "enum": [ "" ], "type": "string" } ], "description": "Whether the cardholder was provided with a cancellation policy." }, "cancellation_reason": { "anyOf": [ { "maxLength": 2500, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Reason for canceling the order." }, "expected_at": { "anyOf": [ { "format": "unix-time", "type": "integer" }, { "enum": [ "" ], "type": "string" } ], "description": "Date when the cardholder expected to receive the product." }, "explanation": { "anyOf": [ { "maxLength": 2500, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Explanation of why the cardholder is disputing this transaction." }, "product_description": { "anyOf": [ { "maxLength": 2500, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Description of the merchandise or service that was purchased." }, "product_type": { "description": "Whether the product was a merchandise or service.", "enum": [ "", "merchandise", "service" ], "type": "string" }, "return_status": { "description": "Result of cardholder's attempt to return the product.", "enum": [ "", "merchant_rejected", "successful" ], "type": "string" }, "returned_at": { "anyOf": [ { "format": "unix-time", "type": "integer" }, { "enum": [ "" ], "type": "string" } ], "description": "Date when the product was returned or attempted to be returned." } }, "title": "canceled", "type": "object", "x-stripeMostCommon": [ "additional_documentation", "canceled_at", "cancellation_policy_provided", "cancellation_reason", "expected_at", "explanation", "product_description", "product_type", "return_status", "returned_at" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Evidence provided when `reason` is 'canceled'." }, "duplicate": { "anyOf": [ { "properties": { "additional_documentation": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute." }, "card_statement": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Copy of the card statement showing that the product had already been paid for." }, "cash_receipt": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Copy of the receipt showing that the product had been paid for in cash." }, "check_image": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Image of the front and back of the check that was used to pay for the product." }, "explanation": { "anyOf": [ { "maxLength": 2500, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Explanation of why the cardholder is disputing this transaction." }, "original_transaction": { "description": "Transaction (e.g., ipi_...) that the disputed transaction is a duplicate of. Of the two or more transactions that are copies of each other, this is original undisputed one.", "maxLength": 5000, "type": "string" } }, "title": "duplicate", "type": "object", "x-stripeMostCommon": [ "additional_documentation", "card_statement", "cash_receipt", "check_image", "explanation", "original_transaction" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Evidence provided when `reason` is 'duplicate'." }, "fraudulent": { "anyOf": [ { "properties": { "additional_documentation": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute." }, "explanation": { "anyOf": [ { "maxLength": 2500, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Explanation of why the cardholder is disputing this transaction." } }, "title": "fraudulent", "type": "object", "x-stripeMostCommon": [ "additional_documentation", "explanation" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Evidence provided when `reason` is 'fraudulent'." }, "merchandise_not_as_described": { "anyOf": [ { "properties": { "additional_documentation": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute." }, "explanation": { "anyOf": [ { "maxLength": 2500, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Explanation of why the cardholder is disputing this transaction." }, "received_at": { "anyOf": [ { "format": "unix-time", "type": "integer" }, { "enum": [ "" ], "type": "string" } ], "description": "Date when the product was received." }, "return_description": { "anyOf": [ { "maxLength": 2500, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Description of the cardholder's attempt to return the product." }, "return_status": { "description": "Result of cardholder's attempt to return the product.", "enum": [ "", "merchant_rejected", "successful" ], "type": "string" }, "returned_at": { "anyOf": [ { "format": "unix-time", "type": "integer" }, { "enum": [ "" ], "type": "string" } ], "description": "Date when the product was returned or attempted to be returned." } }, "title": "merchandise_not_as_described", "type": "object", "x-stripeMostCommon": [ "additional_documentation", "explanation", "received_at", "return_description", "return_status", "returned_at" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Evidence provided when `reason` is 'merchandise_not_as_described'." }, "no_valid_authorization": { "anyOf": [ { "properties": { "additional_documentation": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute." }, "explanation": { "anyOf": [ { "maxLength": 2500, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Explanation of why the cardholder is disputing this transaction." } }, "title": "no_valid_authorization", "type": "object", "x-stripeMostCommon": [ "additional_documentation", "explanation" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Evidence provided when `reason` is 'no_valid_authorization'." }, "not_received": { "anyOf": [ { "properties": { "additional_documentation": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute." }, "expected_at": { "anyOf": [ { "format": "unix-time", "type": "integer" }, { "enum": [ "" ], "type": "string" } ], "description": "Date when the cardholder expected to receive the product." }, "explanation": { "anyOf": [ { "maxLength": 2500, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Explanation of why the cardholder is disputing this transaction." }, "product_description": { "anyOf": [ { "maxLength": 2500, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Description of the merchandise or service that was purchased." }, "product_type": { "description": "Whether the product was a merchandise or service.", "enum": [ "", "merchandise", "service" ], "type": "string" } }, "title": "not_received", "type": "object", "x-stripeMostCommon": [ "additional_documentation", "expected_at", "explanation", "product_description", "product_type" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Evidence provided when `reason` is 'not_received'." }, "other": { "anyOf": [ { "properties": { "additional_documentation": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute." }, "explanation": { "anyOf": [ { "maxLength": 2500, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Explanation of why the cardholder is disputing this transaction." }, "product_description": { "anyOf": [ { "maxLength": 2500, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Description of the merchandise or service that was purchased." }, "product_type": { "description": "Whether the product was a merchandise or service.", "enum": [ "", "merchandise", "service" ], "type": "string" } }, "title": "other", "type": "object", "x-stripeMostCommon": [ "additional_documentation", "explanation", "product_description", "product_type" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Evidence provided when `reason` is 'other'." }, "reason": { "description": "The reason for filing the dispute. The evidence should be submitted in the field of the same name.", "enum": [ "canceled", "duplicate", "fraudulent", "merchandise_not_as_described", "no_valid_authorization", "not_received", "other", "service_not_as_described" ], "type": "string", "x-stripeBypassValidation": true }, "service_not_as_described": { "anyOf": [ { "properties": { "additional_documentation": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute." }, "canceled_at": { "anyOf": [ { "format": "unix-time", "type": "integer" }, { "enum": [ "" ], "type": "string" } ], "description": "Date when order was canceled." }, "cancellation_reason": { "anyOf": [ { "maxLength": 2500, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Reason for canceling the order." }, "explanation": { "anyOf": [ { "maxLength": 2500, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Explanation of why the cardholder is disputing this transaction." }, "received_at": { "anyOf": [ { "format": "unix-time", "type": "integer" }, { "enum": [ "" ], "type": "string" } ], "description": "Date when the product was received." } }, "title": "service_not_as_described", "type": "object", "x-stripeMostCommon": [ "additional_documentation", "canceled_at", "cancellation_reason", "explanation", "received_at" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Evidence provided when `reason` is 'service_not_as_described'." } }, "title": "evidence_param", "type": "object", "x-stripeMostCommon": [ "canceled", "duplicate", "fraudulent", "merchandise_not_as_described", "no_valid_authorization", "not_received", "other", "reason", "service_not_as_described" ] }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." } }, "type": "object", "x-stripeMostCommon": [ "evidence", "metadata" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issuing.dispute" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a dispute" } }, "/v1/issuing/disputes/{dispute}/submit": { "post": { "description": "

Submits an Issuing Dispute to the card network. Stripe validates that all evidence fields required for the dispute’s reason are present. For more details, see Dispute reasons and evidence.

", "operationId": "PostIssuingDisputesDisputeSubmit", "parameters": [ { "in": "path", "name": "dispute", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." } }, "type": "object", "x-stripeMostCommon": [ "metadata" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issuing.dispute" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Submit a dispute" } }, "/v1/issuing/fraud_liability_debits": { "get": { "description": "

Returns a list of Issuing FraudLiabilityDebit objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

", "operationId": "GetIssuingFraudLiabilityDebits", "parameters": [ { "description": "Only return Issuing Fraud Liability Debits that were created during the given date interval.", "explode": true, "in": "query", "name": "created", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "description": "Minimum value to filter by (exclusive)", "type": "integer" }, "gte": { "description": "Minimum value to filter by (inclusive)", "type": "integer" }, "lt": { "description": "Maximum value to filter by (exclusive)", "type": "integer" }, "lte": { "description": "Maximum value to filter by (inclusive)", "type": "integer" } }, "title": "range_query_specs", "type": "object", "x-stripeMostCommon": [ "gt", "gte", "lt", "lte" ] }, { "type": "integer" } ] }, "style": "deepObject" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/issuing.fraud_liability_debit" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/issuing/fraud_liability_debits", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "IssuingFraudLiabilityDebitList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all fraud liability debits" } }, "/v1/issuing/fraud_liability_debits/{fraud_liability_debit}": { "get": { "description": "

Retrieves an Issuing FraudLiabilityDebit object.

", "operationId": "GetIssuingFraudLiabilityDebitsFraudLiabilityDebit", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "fraud_liability_debit", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issuing.fraud_liability_debit" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve an Issuing fraud liability debit" } }, "/v1/issuing/personalization_designs": { "get": { "description": "

Returns a list of personalization design objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

", "operationId": "GetIssuingPersonalizationDesigns", "parameters": [ { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "Only return personalization designs with the given lookup keys.", "explode": true, "in": "query", "name": "lookup_keys", "required": false, "schema": { "items": { "maxLength": 200, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "Only return personalization designs with the given preferences.", "explode": true, "in": "query", "name": "preferences", "required": false, "schema": { "properties": { "is_default": { "description": "Only return the personalization design that's set as the default. A connected account uses the Connect platform's default design if no personalization design is set as the default.", "type": "boolean" }, "is_platform_default": { "description": "Only return the personalization design that is set as the Connect platform's default. This parameter is only applicable to connected accounts.", "type": "boolean" } }, "title": "preferences_list_param", "type": "object", "x-stripeMostCommon": [ "is_default", "is_platform_default" ] }, "style": "deepObject" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Only return personalization designs with the given status.", "in": "query", "name": "status", "required": false, "schema": { "enum": [ "active", "inactive", "rejected", "review" ], "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/issuing.personalization_design" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/issuing/personalization_designs", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "IssuingPersonalizationDesignList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all personalization designs" }, "post": { "description": "

Creates a personalization design object.

", "operationId": "PostIssuingPersonalizationDesigns", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "carrier_text": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "preferences": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "card_logo": { "description": "The file for the card logo, for use with physical bundles that support card logos. Must have a `purpose` value of `issuing_logo`.", "type": "string" }, "carrier_text": { "description": "Hash containing carrier text, for use with physical bundles that support carrier text.", "properties": { "footer_body": { "anyOf": [ { "maxLength": 200, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "The footer body text of the carrier letter." }, "footer_title": { "anyOf": [ { "maxLength": 30, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "The footer title text of the carrier letter." }, "header_body": { "anyOf": [ { "maxLength": 200, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "The header body text of the carrier letter." }, "header_title": { "anyOf": [ { "maxLength": 30, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "The header title text of the carrier letter." } }, "title": "carrier_text_param", "type": "object", "x-stripeMostCommon": [ "footer_body", "footer_title", "header_body", "header_title" ] }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "lookup_key": { "description": "A lookup key used to retrieve personalization designs dynamically from a static string. This may be up to 200 characters.", "maxLength": 200, "type": "string" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "name": { "description": "Friendly display name.", "maxLength": 200, "type": "string" }, "physical_bundle": { "description": "The physical bundle object belonging to this personalization design.", "maxLength": 5000, "type": "string" }, "preferences": { "description": "Information on whether this personalization design is used to create cards when one is not specified.", "properties": { "is_default": { "description": "Whether we use this personalization design to create cards when one isn't specified. A connected account uses the Connect platform's default design if no personalization design is set as the default design.", "type": "boolean" } }, "required": [ "is_default" ], "title": "preferences_param", "type": "object", "x-stripeMostCommon": [ "is_default" ] }, "transfer_lookup_key": { "description": "If set to true, will atomically remove the lookup key from the existing personalization design, and assign it to this personalization design.", "type": "boolean" } }, "required": [ "physical_bundle" ], "type": "object", "x-stripeMostCommon": [ "card_logo", "carrier_text", "lookup_key", "metadata", "name", "physical_bundle", "preferences", "transfer_lookup_key" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issuing.personalization_design" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a personalization design" } }, "/v1/issuing/personalization_designs/{personalization_design}": { "get": { "description": "

Retrieves a personalization design object.

", "operationId": "GetIssuingPersonalizationDesignsPersonalizationDesign", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "personalization_design", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issuing.personalization_design" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a personalization design" }, "post": { "description": "

Updates a card personalization object.

", "operationId": "PostIssuingPersonalizationDesignsPersonalizationDesign", "parameters": [ { "in": "path", "name": "personalization_design", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "card_logo": { "explode": true, "style": "deepObject" }, "carrier_text": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "lookup_key": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "name": { "explode": true, "style": "deepObject" }, "preferences": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "card_logo": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "The file for the card logo, for use with physical bundles that support card logos. Must have a `purpose` value of `issuing_logo`." }, "carrier_text": { "anyOf": [ { "properties": { "footer_body": { "anyOf": [ { "maxLength": 200, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "The footer body text of the carrier letter." }, "footer_title": { "anyOf": [ { "maxLength": 30, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "The footer title text of the carrier letter." }, "header_body": { "anyOf": [ { "maxLength": 200, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "The header body text of the carrier letter." }, "header_title": { "anyOf": [ { "maxLength": 30, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "The header title text of the carrier letter." } }, "title": "carrier_text_param", "type": "object", "x-stripeMostCommon": [ "footer_body", "footer_title", "header_body", "header_title" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Hash containing carrier text, for use with physical bundles that support carrier text." }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "lookup_key": { "anyOf": [ { "maxLength": 200, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "A lookup key used to retrieve personalization designs dynamically from a static string. This may be up to 200 characters." }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "name": { "anyOf": [ { "maxLength": 200, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Friendly display name. Providing an empty string will set the field to null." }, "physical_bundle": { "description": "The physical bundle object belonging to this personalization design.", "maxLength": 5000, "type": "string" }, "preferences": { "description": "Information on whether this personalization design is used to create cards when one is not specified.", "properties": { "is_default": { "description": "Whether we use this personalization design to create cards when one isn't specified. A connected account uses the Connect platform's default design if no personalization design is set as the default design.", "type": "boolean" } }, "required": [ "is_default" ], "title": "preferences_param", "type": "object", "x-stripeMostCommon": [ "is_default" ] }, "transfer_lookup_key": { "description": "If set to true, will atomically remove the lookup key from the existing personalization design, and assign it to this personalization design.", "type": "boolean" } }, "type": "object", "x-stripeMostCommon": [ "card_logo", "carrier_text", "lookup_key", "metadata", "name", "physical_bundle", "preferences", "transfer_lookup_key" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issuing.personalization_design" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a personalization design" } }, "/v1/issuing/physical_bundles": { "get": { "description": "

Returns a list of physical bundle objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

", "operationId": "GetIssuingPhysicalBundles", "parameters": [ { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Only return physical bundles with the given status.", "in": "query", "name": "status", "required": false, "schema": { "enum": [ "active", "inactive", "review" ], "type": "string" }, "style": "form" }, { "description": "Only return physical bundles with the given type.", "in": "query", "name": "type", "required": false, "schema": { "enum": [ "custom", "standard" ], "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/issuing.physical_bundle" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/issuing/physical_bundles", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "IssuingPhysicalBundleList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all physical bundles" } }, "/v1/issuing/physical_bundles/{physical_bundle}": { "get": { "description": "

Retrieves a physical bundle object.

", "operationId": "GetIssuingPhysicalBundlesPhysicalBundle", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "physical_bundle", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issuing.physical_bundle" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a physical bundle" } }, "/v1/issuing/tokens": { "get": { "description": "

Lists all Issuing Token objects for a given card.

", "operationId": "GetIssuingTokens", "parameters": [ { "description": "The Issuing card identifier to list tokens for.", "in": "query", "name": "card", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Only return Issuing tokens that were created during the given date interval.", "explode": true, "in": "query", "name": "created", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "description": "Minimum value to filter by (exclusive)", "type": "integer" }, "gte": { "description": "Minimum value to filter by (inclusive)", "type": "integer" }, "lt": { "description": "Maximum value to filter by (exclusive)", "type": "integer" }, "lte": { "description": "Maximum value to filter by (inclusive)", "type": "integer" } }, "title": "range_query_specs", "type": "object", "x-stripeMostCommon": [ "gt", "gte", "lt", "lte" ] }, { "type": "integer" } ] }, "style": "deepObject" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Select Issuing tokens with the given status.", "in": "query", "name": "status", "required": false, "schema": { "enum": [ "active", "deleted", "requested", "suspended" ], "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/issuing.token" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "IssuingNetworkTokenList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all issuing tokens for card" } }, "/v1/issuing/tokens/{token}": { "get": { "description": "

Retrieves an Issuing Token object.

", "operationId": "GetIssuingTokensToken", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "token", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issuing.token" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve an issuing token" }, "post": { "description": "

Attempts to update the specified Issuing Token object to the status specified.

", "operationId": "PostIssuingTokensToken", "parameters": [ { "in": "path", "name": "token", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "status": { "description": "Specifies which status the token should be updated to.", "enum": [ "active", "deleted", "suspended" ], "type": "string" } }, "required": [ "status" ], "type": "object", "x-stripeMostCommon": [ "status" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issuing.token" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a token status" } }, "/v1/issuing/transactions": { "get": { "description": "

Returns a list of Issuing Transaction objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

", "operationId": "GetIssuingTransactions", "parameters": [ { "description": "Only return transactions that belong to the given card.", "in": "query", "name": "card", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Only return transactions that belong to the given cardholder.", "in": "query", "name": "cardholder", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Only return transactions that were created during the given date interval.", "explode": true, "in": "query", "name": "created", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "description": "Minimum value to filter by (exclusive)", "type": "integer" }, "gte": { "description": "Minimum value to filter by (inclusive)", "type": "integer" }, "lt": { "description": "Maximum value to filter by (exclusive)", "type": "integer" }, "lte": { "description": "Maximum value to filter by (inclusive)", "type": "integer" } }, "title": "range_query_specs", "type": "object", "x-stripeMostCommon": [ "gt", "gte", "lt", "lte" ] }, { "type": "integer" } ] }, "style": "deepObject" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "Only return transactions that are associated with the given settlement.", "in": "query", "name": "settlement", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Only return transactions that have the given type. One of `capture` or `refund`.", "in": "query", "name": "type", "required": false, "schema": { "enum": [ "capture", "refund" ], "type": "string", "x-stripeBypassValidation": true }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/issuing.transaction" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/issuing/transactions", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "IssuingTransactionList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all transactions" } }, "/v1/issuing/transactions/{transaction}": { "get": { "description": "

Retrieves an Issuing Transaction object.

", "operationId": "GetIssuingTransactionsTransaction", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "transaction", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issuing.transaction" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a transaction" }, "post": { "description": "

Updates the specified Issuing Transaction object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

", "operationId": "PostIssuingTransactionsTransaction", "parameters": [ { "in": "path", "name": "transaction", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." } }, "type": "object", "x-stripeMostCommon": [ "metadata" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issuing.transaction" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a transaction" } }, "/v1/mandates": { "get": { "description": "

Retrieves a list of Mandates for a given PaymentMethod.

", "operationId": "GetMandates", "parameters": [ { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "The Stripe account ID that the mandates are intended for. Learn more about the [use case for connected accounts payments](https://stripe.com/docs/payments/connected-accounts).", "in": "query", "name": "on_behalf_of", "required": false, "schema": { "type": "string" }, "style": "form" }, { "in": "query", "name": "payment_method", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "The status of the mandates to retrieve. Status indicates whether or not you can use it to initiate a payment, and can have a value of `active`, `pending`, or `inactive`.", "in": "query", "name": "status", "required": true, "schema": { "enum": [ "active", "inactive", "pending" ], "type": "string", "x-stripeBypassValidation": true }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/mandate" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/mandates", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "PaymentFlowsMandateList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List of Mandates for a PaymentMethod" } }, "/v1/mandates/{mandate}": { "get": { "description": "

Retrieves a Mandate object.

", "operationId": "GetMandatesMandate", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "mandate", "required": true, "schema": { "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/mandate" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a Mandate" } }, "/v1/orders": { "get": { "description": "

Returns a list of your orders. The orders are returned sorted by creation date, with the most recently created orders appearing first.

", "operationId": "GetOrders", "parameters": [ { "description": "Only return orders for the given customer.", "in": "query", "name": "customer", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/order" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/orders", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "OrdersV2ResourceOrderList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all orders" }, "post": { "description": "

Creates a new open order object.

", "operationId": "PostOrders", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "automatic_tax": { "explode": true, "style": "deepObject" }, "billing_details": { "explode": true, "style": "deepObject" }, "discounts": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "line_items": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "payment": { "explode": true, "style": "deepObject" }, "shipping_cost": { "explode": true, "style": "deepObject" }, "shipping_details": { "explode": true, "style": "deepObject" }, "tax_details": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "automatic_tax": { "description": "Settings for automatic tax calculation for this order.", "properties": { "enabled": { "description": "Enable automatic tax calculation which will automatically compute tax rates on this order.", "type": "boolean" } }, "required": [ "enabled" ], "title": "automatic_tax", "type": "object", "x-stripeMostCommon": [ "enabled" ] }, "billing_details": { "anyOf": [ { "properties": { "address": { "description": "The billing address provided by the customer.", "properties": { "city": { "description": "City, district, suburb, town, or village.", "maxLength": 5000, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Address line 1 (e.g., street, PO Box, or company name).", "maxLength": 5000, "type": "string" }, "line2": { "description": "Address line 2 (e.g., apartment, suite, unit, or building).", "maxLength": 5000, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "State/province as an [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) subdivision code, without country prefix. Example: \"NY\" or \"TX\".", "maxLength": 5000, "type": "string" } }, "title": "validated_optional_fields_address", "type": "object", "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state" ] }, "email": { "description": "The billing email provided by the customer.", "type": "string" }, "name": { "description": "The billing name provided by the customer.", "maxLength": 5000, "type": "string" }, "phone": { "description": "The billing phone number provided by the customer.", "maxLength": 20, "type": "string" } }, "title": "billing_details", "type": "object", "x-stripeMostCommon": [ "address", "email", "name", "phone" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Billing details for the customer. If a customer is provided, this will be automatically populated with values from that customer if override values are not provided." }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "customer": { "description": "The customer associated with this order.", "maxLength": 5000, "type": "string" }, "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users.", "maxLength": 5000, "type": "string" }, "discounts": { "anyOf": [ { "items": { "properties": { "coupon": { "description": "ID of the coupon to create a new discount for.", "maxLength": 5000, "type": "string" }, "discount": { "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", "maxLength": 5000, "type": "string" }, "promotion_code": { "description": "ID of the promotion code to create a new discount for.", "maxLength": 5000, "type": "string" } }, "title": "discounts_data_param", "type": "object", "x-stripeMostCommon": [ "coupon", "coupon_data" ] }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The coupons, promotion codes, and/or discounts to apply to the order." }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "ip_address": { "description": "The IP address of the purchaser for this order.", "type": "string" }, "line_items": { "description": "A list of line items the customer is ordering. Each line item includes information about the product, the quantity, and the resulting cost.", "items": { "properties": { "description": { "description": "The description for the line item. Will default to the name of the associated product.", "maxLength": 5000, "type": "string" }, "discounts": { "anyOf": [ { "items": { "properties": { "coupon": { "description": "ID of the coupon to create a new discount for.", "maxLength": 5000, "type": "string" }, "discount": { "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", "maxLength": 5000, "type": "string" } }, "title": "discounts_data_param", "type": "object", "x-stripeMostCommon": [ "coupon", "coupon_data" ] }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The discounts applied to this line item." }, "price": { "description": "The ID of a [Price](https://docs.stripe.com/api/prices) to add to the Order.\n\nThe `price` parameter is an alternative to using the `product` parameter. If each of your products are sold at a single price, you can set `Product.default_price` and then pass the `product` parameter when creating a line item. If your products are sold at several possible prices, use the `price` parameter to explicitly specify which one to use.", "maxLength": 5000, "type": "string" }, "price_data": { "description": "Data used to generate a new Price object inline.\n\nThe `price_data` parameter is an alternative to using the `product` or `price` parameters. If you create a Product upfront and configure a `Product.default_price`, pass the `product` parameter when creating a line item. If you prefer not to define Products upfront, or if you charge variable prices, pass the `price_data` parameter to describe the price for this line item.\n\nEach time you pass `price_data` we create a Price for the Product. This Price is hidden in both the Dashboard and API lists and cannot be reused.", "properties": { "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "product": { "description": "ID of the [Product](https://docs.stripe.com/api/products) this [Price](https://docs.stripe.com/api/prices) belongs to.\n\nUse this to implement a variable-pricing model in your integration. This is required if `product_data` is not specified.", "maxLength": 5000, "type": "string" }, "tax_behavior": { "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.", "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" }, "unit_amount": { "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.", "type": "integer" }, "unit_amount_decimal": { "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", "format": "decimal", "type": "string" } }, "title": "price_data_with_optional_product", "type": "object", "x-stripeMostCommon": [ "currency", "product", "unit_amount" ] }, "product": { "description": "The ID of a [Product](https://docs.stripe.com/api/products) to add to the Order.\n\nThe Product must have a `default_price` specified. Otherwise, specify the price by passing the `price` or `price_data` parameter.", "maxLength": 5000, "type": "string" }, "product_data": { "description": "Defines a [Product](https://docs.stripe.com/api/products) inline and adds it to the Order.\n\n`product_data` is an alternative to the `product` parameter. If you created a Product upfront, use the `product` parameter to refer to the existing Product. But if you prefer not to create Products upfront, pass the `product_data` parameter to define a Product inline as part of configuring the Order.\n\n`product_data` automatically creates a Product, just as if you had manually created the Product. If a Product with the same ID already exists, then `product_data` re-uses it to avoid duplicates.", "properties": { "description": { "anyOf": [ { "maxLength": 40000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes." }, "id": { "description": "A unique identifier for this product.\n\n`product_data` automatically creates a Product with this ID. If a Product with the same ID already exists, then `product_data` re-uses it to avoid duplicates. If any of the fields in the existing Product are different from the values in `product_data`, `product_data` updates the existing Product with the new information. So set `product_data[id]` to the same string every time you sell the same product, but don't re-use the same string for different products.", "maxLength": 5000, "type": "string" }, "images": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "A list of up to 8 URLs of images for this product, meant to be displayable to the customer." }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "name": { "description": "The product's name, meant to be displayable to the customer.", "maxLength": 5000, "type": "string" }, "package_dimensions": { "anyOf": [ { "properties": { "height": { "description": "Height, in inches. Maximum precision is 2 decimal places.", "type": "number" }, "length": { "description": "Length, in inches. Maximum precision is 2 decimal places.", "type": "number" }, "weight": { "description": "Weight, in ounces. Maximum precision is 2 decimal places.", "type": "number" }, "width": { "description": "Width, in inches. Maximum precision is 2 decimal places.", "type": "number" } }, "required": [ "height", "length", "weight", "width" ], "title": "package_dimensions_specs", "type": "object", "x-stripeMostCommon": [ "height", "length", "weight", "width" ] }, { "enum": [ "" ], "type": "string" } ], "description": "The dimensions of this product for shipping purposes." }, "shippable": { "description": "Whether this product is shipped (i.e., physical goods).", "type": "boolean" }, "tax_code": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "A [tax code](https://stripe.com/docs/tax/tax-categories) ID." }, "url": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "A URL of a publicly-accessible webpage for this product." } }, "required": [ "id", "name" ], "title": "product_upsert_data", "type": "object", "x-stripeMostCommon": [ "id", "metadata", "name", "sku", "tax_code" ] }, "quantity": { "description": "The quantity of the line item.", "type": "integer" }, "tax_rates": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The tax rates applied to this line item." } }, "title": "create_params", "type": "object", "x-stripeMostCommon": [ "product", "quantity" ] }, "type": "array" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "payment": { "description": "Payment information associated with the order, including payment settings.", "properties": { "settings": { "description": "Settings describing how the order should configure generated PaymentIntents.", "properties": { "application_fee_amount": { "description": "The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account.", "type": "integer" }, "payment_method_options": { "description": "PaymentMethod-specific configuration to provide to the order's PaymentIntent.", "properties": { "acss_debit": { "description": "If paying by `acss_debit`, this sub-hash contains details about the ACSS Debit payment method options to pass to the order's PaymentIntent.", "properties": { "mandate_options": { "description": "Additional fields for Mandate creation", "properties": { "custom_mandate_url": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "A URL for custom mandate text to render during confirmation step.\nThe URL will be rendered with additional GET parameters `payment_intent` and `payment_intent_client_secret` when confirming a Payment Intent,\nor `setup_intent` and `setup_intent_client_secret` when confirming a Setup Intent." }, "interval_description": { "description": "Description of the mandate interval. Only required if 'payment_schedule' parameter is 'interval' or 'combined'.", "maxLength": 500, "type": "string" }, "payment_schedule": { "description": "Payment schedule for the mandate.", "enum": [ "combined", "interval", "sporadic" ], "type": "string" }, "transaction_type": { "description": "Transaction type of the mandate.", "enum": [ "business", "personal" ], "type": "string" } }, "title": "payment_intent_payment_method_options_mandate_options_param", "type": "object", "x-stripeMostCommon": [ "custom_mandate_url", "interval_description", "payment_schedule", "transaction_type" ] }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "", "none", "off_session", "on_session" ], "type": "string" }, "target_date": { "description": "Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.", "maxLength": 5000, "type": "string" }, "verification_method": { "description": "Bank account verification method.", "enum": [ "automatic", "instant", "microdeposits" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "payment_intent_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "financial_connections", "mandate_options", "setup_future_usage", "target_date", "verification_method" ] }, "afterpay_clearpay": { "description": "If paying by `afterpay_clearpay`, this sub-hash contains details about the AfterpayClearpay payment method options to pass to the order's PaymentIntent.", "properties": { "capture_method": { "description": "Controls when the funds are captured from the customer's account.\n\nIf provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.", "enum": [ "automatic", "automatic_async", "manual" ], "type": "string" }, "reference": { "description": "An internal identifier or reference this payment corresponds to. The identifier is limited to 128 characters and may contain only letters, digits, underscores, backslashes and dashes.", "maxLength": 128, "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with the payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the order's Customer, if present, after the order's PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.", "enum": [ "none" ], "type": "string" } }, "title": "afterpay_clearpay_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "capture_method", "reference", "setup_future_usage" ] }, "alipay": { "description": "If paying by `alipay`, this sub-hash contains details about the Alipay payment method options to pass to the order's PaymentIntent.", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "", "none", "off_session" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "setup_future_usage" ] }, "bancontact": { "description": "If paying by `bancontact`, this sub-hash contains details about the Bancontact payment method options to pass to the order's PaymentIntent.", "properties": { "preferred_language": { "description": "Preferred language of the Bancontact authorization page that the customer is redirected to.", "enum": [ "de", "en", "fr", "nl" ], "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "", "none", "off_session" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "preferred_language", "setup_future_usage" ] }, "card": { "description": "If paying by `card`, this sub-hash contains details about the Card payment method options to pass to the order's PaymentIntent.", "properties": { "capture_method": { "description": "Controls when the funds will be captured from the customer's account.", "enum": [ "automatic", "automatic_async", "manual" ], "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with the payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the order's Customer, if present, after the order's PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.", "enum": [ "none", "off_session", "on_session" ], "type": "string" } }, "title": "card_payment_method_options", "type": "object", "x-stripeMostCommon": [ "capture_method", "setup_future_usage" ] }, "customer_balance": { "description": "If paying by `customer_balance`, this sub-hash contains details about the Customer Balance payment method options to pass to the order's PaymentIntent.", "properties": { "bank_transfer": { "description": "Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`.", "properties": { "eu_bank_transfer": { "description": "Configuration for the eu_bank_transfer funding type.", "properties": { "country": { "description": "The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`.", "maxLength": 5000, "type": "string" } }, "required": [ "country" ], "title": "eu_bank_transfer_params", "type": "object", "x-stripeMostCommon": [ "country" ] }, "requested_address_types": { "description": "List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.\n\nPermitted values include: `sort_code`, `zengin`, `iban`, or `spei`.", "items": { "enum": [ "aba", "iban", "sepa", "sort_code", "spei", "swift", "zengin" ], "type": "string", "x-stripeBypassValidation": true }, "type": "array" }, "type": { "description": "The list of bank transfer types that this PaymentIntent is allowed to use for funding Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.", "enum": [ "eu_bank_transfer", "gb_bank_transfer", "jp_bank_transfer", "mx_bank_transfer", "us_bank_transfer" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "bank_transfer_param", "type": "object", "x-stripeMostCommon": [ "eu_bank_transfer", "id_bank_account", "id_bank_transfer", "requested_address_types", "type" ] }, "funding_type": { "description": "The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.", "enum": [ "bank_transfer" ], "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "none" ], "type": "string" } }, "title": "payment_intent_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "bank_transfer", "funding_type", "setup_future_usage" ] }, "ideal": { "description": "If paying by `ideal`, this sub-hash contains details about the iDEAL payment method options to pass to the order's PaymentIntent.", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "", "none", "off_session" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "setup_future_usage" ] }, "klarna": { "description": "If paying by `klarna`, this sub-hash contains details about the Klarna payment method options to pass to the order's PaymentIntent.", "properties": { "capture_method": { "description": "Controls when the funds are captured from the customer's account.\n\nIf provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.", "enum": [ "", "manual" ], "type": "string" }, "on_demand": { "description": "On-demand details if setting up or charging an on-demand payment.", "properties": { "average_amount": { "description": "Your average amount value. You can use a value across your customer base, or segment based on customer type, country, etc.", "type": "integer" }, "maximum_amount": { "description": "The maximum value you may charge a customer per purchase. You can use a value across your customer base, or segment based on customer type, country, etc.", "type": "integer" }, "minimum_amount": { "description": "The lowest or minimum value you may charge a customer per purchase. You can use a value across your customer base, or segment based on customer type, country, etc.", "type": "integer" }, "purchase_interval": { "description": "Interval at which the customer is making purchases", "enum": [ "day", "month", "week", "year" ], "type": "string" }, "purchase_interval_count": { "description": "The number of `purchase_interval` between charges", "type": "integer" } }, "title": "on_demand_param", "type": "object", "x-stripeMostCommon": [ "average_amount", "maximum_amount", "minimum_amount", "purchase_interval", "purchase_interval_count" ] }, "preferred_locale": { "description": "Preferred language of the Klarna authorization page that the customer is redirected to", "enum": [ "cs-CZ", "da-DK", "de-AT", "de-CH", "de-DE", "el-GR", "en-AT", "en-AU", "en-BE", "en-CA", "en-CH", "en-CZ", "en-DE", "en-DK", "en-ES", "en-FI", "en-FR", "en-GB", "en-GR", "en-IE", "en-IT", "en-NL", "en-NO", "en-NZ", "en-PL", "en-PT", "en-RO", "en-SE", "en-US", "es-ES", "es-US", "fi-FI", "fr-BE", "fr-CA", "fr-CH", "fr-FR", "it-CH", "it-IT", "nb-NO", "nl-BE", "nl-NL", "pl-PL", "pt-PT", "ro-RO", "sv-FI", "sv-SE" ], "type": "string", "x-stripeBypassValidation": true }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "none", "off_session", "on_session" ], "type": "string" }, "subscriptions": { "anyOf": [ { "items": { "properties": { "interval": { "description": "Unit of time between subscription charges.", "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "description": "The number of intervals (specified in the `interval` attribute) between subscription charges. For example, `interval=month` and `interval_count=3` charges every 3 months.", "type": "integer" }, "name": { "description": "Name for subscription.", "maxLength": 255, "type": "string" }, "next_billing": { "description": "Describes the upcoming charge for this subscription.", "properties": { "amount": { "description": "The amount of the next charge for the subscription.", "type": "integer" }, "date": { "description": "The date of the next charge for the subscription in YYYY-MM-DD format.", "maxLength": 5000, "type": "string" } }, "required": [ "amount", "date" ], "title": "subscription_next_billing_param", "type": "object", "x-stripeMostCommon": [ "amount", "date" ] }, "reference": { "description": "A non-customer-facing reference to correlate subscription charges in the Klarna app. Use a value that persists across subscription charges.", "maxLength": 255, "type": "string" } }, "required": [ "interval", "reference" ], "title": "subscription_param", "type": "object", "x-stripeMostCommon": [ "interval", "interval_count", "name", "next_billing", "reference" ] }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "Subscription details if setting up or charging a subscription." } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "capture_method", "extra_merchant_data_blob", "interoperability_token", "line_items", "on_demand", "partner_confirmation_token", "payment_details", "payment_method_category", "payment_option_id", "preferred_locale", "request_incremental_authorization", "request_multicapture", "setup_future_usage", "subscriptions", "supplementary_purchase_data" ] }, "link": { "description": "If paying by `link`, this sub-hash contains details about the Link payment method options to pass to the order's PaymentIntent.", "properties": { "capture_method": { "description": "Controls when the funds are captured from the customer's account.\n\nIf provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.", "enum": [ "", "manual" ], "type": "string" }, "persistent_token": { "description": "[Deprecated] This is a legacy parameter that no longer has any function.", "maxLength": 5000, "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "", "none", "off_session" ], "type": "string" } }, "title": "payment_intent_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "capture_method", "persistent_token", "request_multicapture", "setup_future_usage" ] }, "oxxo": { "description": "If paying by `oxxo`, this sub-hash contains details about the OXXO payment method options to pass to the order's PaymentIntent.", "properties": { "expires_after_days": { "description": "The number of calendar days before an OXXO voucher expires. For example, if you create an OXXO voucher on Monday and you set expires_after_days to 2, the OXXO invoice will expire on Wednesday at 23:59 America/Mexico_City time.", "type": "integer" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "expires_after_days", "setup_future_usage" ] }, "p24": { "description": "If paying by `p24`, this sub-hash contains details about the P24 payment method options to pass to the order's PaymentIntent.", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "none" ], "type": "string" }, "tos_shown_and_accepted": { "description": "Confirm that the payer has accepted the P24 terms and conditions.", "type": "boolean" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "installments", "setup_future_usage", "tos_shown_and_accepted" ] }, "paypal": { "description": "If paying by `paypal`, this sub-hash contains details about the PayPal payment method options to pass to the order's PaymentIntent.", "properties": { "capture_method": { "description": "Controls when the funds will be captured from the customer's account.", "enum": [ "", "manual" ], "type": "string" }, "line_items": { "description": "The line items purchased by the customer.", "items": { "properties": { "category": { "description": "Type of the line item.", "enum": [ "digital_goods", "donation", "physical_goods" ], "type": "string" }, "description": { "description": "Description of the line item.", "maxLength": 127, "type": "string" }, "name": { "description": "Descriptive name of the line item.", "maxLength": 127, "type": "string" }, "quantity": { "description": "Quantity of the line item. Must be a positive number.", "type": "integer" }, "sku": { "description": "Client facing stock keeping unit, article number or similar.", "maxLength": 127, "type": "string" }, "sold_by": { "description": "The Stripe account ID of the connected account that sells the item.", "maxLength": 5000, "type": "string" }, "tax": { "description": "The tax information for the line item.", "properties": { "amount": { "description": "The tax for a single unit of the line item in minor units. Cannot be a negative number.", "type": "integer" }, "behavior": { "description": "The tax behavior for the line item.", "enum": [ "exclusive", "inclusive" ], "type": "string" } }, "required": [ "amount", "behavior" ], "title": "line_item_tax_param", "type": "object", "x-stripeMostCommon": [ "amount", "behavior" ] }, "unit_amount": { "description": "Price for a single unit of the line item in minor units. Cannot be a negative number.", "type": "integer" } }, "required": [ "name", "quantity", "unit_amount" ], "title": "line_item_param", "type": "object", "x-stripeMostCommon": [ "category", "description", "name", "quantity", "sku", "sold_by", "tax", "unit_amount" ] }, "type": "array" }, "preferred_locale": { "description": "[Preferred locale](https://stripe.com/docs/payments/paypal/supported-locales) of the PayPal checkout page that the customer is redirected to.", "enum": [ "cs-CZ", "da-DK", "de-AT", "de-DE", "de-LU", "el-GR", "en-GB", "en-US", "es-ES", "fi-FI", "fr-BE", "fr-FR", "fr-LU", "hu-HU", "it-IT", "nl-BE", "nl-NL", "pl-PL", "pt-PT", "sk-SK", "sv-SE" ], "type": "string", "x-stripeBypassValidation": true }, "reference": { "description": "A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID.", "maxLength": 127, "type": "string" }, "reference_id": { "description": "A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID.", "maxLength": 127, "type": "string" }, "risk_correlation_id": { "description": "The risk correlation ID for an on-session payment using a saved PayPal payment method.", "maxLength": 32, "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "", "none", "off_session" ], "type": "string" }, "subsellers": { "description": "The Stripe connected account IDs of the sellers on the platform for this transaction (optional). Only allowed when [separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers) are used.", "items": { "maxLength": 32, "type": "string" }, "type": "array" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "allow_delayed_notification", "capture_method", "line_items", "preferred_locale", "reference", "reference_id", "risk_correlation_id", "setup_future_usage", "subsellers" ] }, "sepa_debit": { "description": "If paying by `sepa_debit`, this sub-hash contains details about the SEPA Debit payment method options to pass to the order's PaymentIntent.", "properties": { "mandate_options": { "description": "Additional fields for Mandate creation", "properties": { "reference_prefix": { "anyOf": [ { "maxLength": 12, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'." } }, "title": "payment_method_options_mandate_options_param", "type": "object", "x-stripeMostCommon": [ "reference", "reference_prefix" ] }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "", "none", "off_session", "on_session" ], "type": "string" }, "target_date": { "description": "Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.", "maxLength": 5000, "type": "string" } }, "title": "payment_intent_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "mandate_options", "setup_future_usage", "target_date", "verification_method" ] }, "sofort": { "description": "If paying by `sofort`, this sub-hash contains details about the Sofort payment method options to pass to the order's PaymentIntent.", "properties": { "preferred_language": { "description": "Language shown to the payer on redirect.", "enum": [ "", "de", "en", "es", "fr", "it", "nl", "pl" ], "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "", "none", "off_session" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "preferred_language", "setup_future_usage" ] }, "wechat_pay": { "description": "If paying by `wechat_pay`, this sub-hash contains details about the WeChat Pay payment method options to pass to the order's PaymentIntent.", "properties": { "app_id": { "description": "The app ID registered with WeChat Pay. Only required when client is ios or android.", "maxLength": 5000, "type": "string" }, "client": { "description": "The client type that the end customer will pay from", "enum": [ "android", "ios", "web" ], "type": "string", "x-stripeBypassValidation": true }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "app_id", "client", "setup_future_usage" ] } }, "title": "create_params", "type": "object", "x-stripeMostCommon": [ "acss_debit", "afterpay_clearpay", "alipay", "bancontact", "card", "customer_balance", "ideal", "klarna", "link", "oxxo", "p24", "paypal", "sepa_debit", "sofort", "wechat_pay" ] }, "payment_method_types": { "description": "The list of [payment method types](https://stripe.com/docs/payments/payment-methods/overview) to provide to the order's PaymentIntent. Do not include this attribute if you prefer to manage your payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods).", "items": { "enum": [ "acss_debit", "afterpay_clearpay", "alipay", "au_becs_debit", "bacs_debit", "bancontact", "card", "customer_balance", "eps", "fpx", "giropay", "grabpay", "ideal", "klarna", "link", "oxxo", "p24", "paypal", "sepa_debit", "sofort", "wechat_pay" ], "type": "string" }, "type": "array" }, "return_url": { "description": "The URL to redirect the customer to after they authenticate their payment.", "type": "string" }, "statement_descriptor": { "description": "For non-card charges, you can use this value as the complete description that appears on your customers' statements. Must contain at least one letter, maximum 22 characters.", "maxLength": 22, "type": "string" }, "statement_descriptor_suffix": { "description": "Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor.", "maxLength": 22, "type": "string" }, "transfer_data": { "description": "Provides configuration for completing a transfer for the order after it is paid.", "properties": { "amount": { "description": "The amount that will be transferred automatically when the order is paid. If no amount is set, the full amount is transferred. There cannot be any line items with recurring prices when using this field.", "type": "integer" }, "destination": { "description": "ID of the Connected account receiving the transfer.", "type": "string" } }, "required": [ "destination" ], "title": "transfer_data", "type": "object", "x-stripeMostCommon": [ "amount", "amount_percent", "destination" ] } }, "title": "create_params", "type": "object", "x-stripeMostCommon": [ "application_fee_amount", "payment_method_options", "payment_method_types", "return_url", "skip_payment_intent_creation", "statement_descriptor", "statement_descriptor_suffix", "transfer_data", "transfer_group" ] } }, "required": [ "settings" ], "title": "create_params", "type": "object", "x-stripeMostCommon": [ "settings" ] }, "shipping_cost": { "anyOf": [ { "properties": { "shipping_rate": { "description": "The ID of the shipping rate to use for this order.", "maxLength": 5000, "type": "string" }, "shipping_rate_data": { "description": "Parameters to create a new ad-hoc shipping rate for this order.", "properties": { "delivery_estimate": { "description": "The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.", "properties": { "maximum": { "description": "The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.", "properties": { "unit": { "description": "A unit of time.", "enum": [ "business_day", "day", "hour", "month", "week" ], "type": "string" }, "value": { "description": "Must be greater than 0.", "type": "integer" } }, "required": [ "unit", "value" ], "title": "delivery_estimate_bound", "type": "object", "x-stripeMostCommon": [ "unit", "value" ] }, "minimum": { "description": "The lower bound of the estimated range. If empty, represents no lower bound.", "properties": { "unit": { "description": "A unit of time.", "enum": [ "business_day", "day", "hour", "month", "week" ], "type": "string" }, "value": { "description": "Must be greater than 0.", "type": "integer" } }, "required": [ "unit", "value" ], "title": "delivery_estimate_bound", "type": "object", "x-stripeMostCommon": [ "unit", "value" ] } }, "title": "delivery_estimate", "type": "object", "x-stripeMostCommon": [ "maximum", "minimum" ] }, "display_name": { "description": "The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.", "maxLength": 100, "type": "string" }, "fixed_amount": { "description": "Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`.", "properties": { "amount": { "description": "A non-negative integer in cents representing how much to charge.", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "currency_options": { "additionalProperties": { "properties": { "amount": { "description": "A non-negative integer in cents representing how much to charge.", "type": "integer" }, "tax_behavior": { "description": "Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.", "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" } }, "required": [ "amount" ], "title": "currency_option", "type": "object", "x-stripeMostCommon": [ "amount", "tax_behavior" ] }, "description": "Shipping rates defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).", "type": "object" } }, "required": [ "amount", "currency" ], "title": "fixed_amount", "type": "object", "x-stripeMostCommon": [ "amount", "currency", "currency_options" ] }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "tax_behavior": { "description": "Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.", "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" }, "tax_code": { "description": "A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`.", "type": "string" }, "type": { "description": "The type of calculation to use on the shipping rate.", "enum": [ "fixed_amount" ], "type": "string" } }, "required": [ "display_name" ], "title": "method_params", "type": "object", "x-stripeMostCommon": [ "display_name", "fixed_amount", "metadata", "tax_behavior", "tax_code", "type" ] } }, "title": "shipping_cost", "type": "object", "x-stripeMostCommon": [ "shipping_rate", "shipping_rate_data" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Settings for the customer cost of shipping for this order." }, "shipping_details": { "anyOf": [ { "properties": { "address": { "description": "The shipping address for the order.", "properties": { "city": { "description": "City, district, suburb, town, or village.", "maxLength": 5000, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Address line 1 (e.g., street, PO Box, or company name).", "maxLength": 5000, "type": "string" }, "line2": { "description": "Address line 2 (e.g., apartment, suite, unit, or building).", "maxLength": 5000, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "State/province as an [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) subdivision code, without country prefix. Example: \"NY\" or \"TX\".", "maxLength": 5000, "type": "string" } }, "title": "validated_optional_fields_address", "type": "object", "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state" ] }, "name": { "description": "The name of the recipient of the order.", "maxLength": 5000, "type": "string" }, "phone": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "The phone number (including extension) for the recipient of the order." } }, "required": [ "address", "name" ], "title": "shipping_details", "type": "object", "x-stripeMostCommon": [ "address", "name", "phone" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Shipping details for the order." }, "tax_details": { "description": "Additional tax details about the purchaser to be used for this order.", "properties": { "tax_exempt": { "description": "The purchaser's tax exemption status. One of `none`, `exempt`, or `reverse`.", "enum": [ "", "exempt", "none", "reverse" ], "type": "string" }, "tax_ids": { "description": "The purchaser's tax IDs to be used for this order.", "items": { "properties": { "type": { "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `aw_tin`, `az_tin`, `ba_tin`, `bb_tin`, `bd_bin`, `bf_ifu`, `bg_uic`, `bh_vat`, `bj_ifu`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cm_niu`, `cn_tin`, `co_nit`, `cr_tin`, `cv_nif`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `et_tin`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kg_tin`, `kh_tin`, `kr_brn`, `kz_bin`, `la_tin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin`", "enum": [ "ad_nrt", "ae_trn", "al_tin", "am_tin", "ao_tin", "ar_cuit", "au_abn", "au_arn", "aw_tin", "az_tin", "ba_tin", "bb_tin", "bd_bin", "bf_ifu", "bg_uic", "bh_vat", "bj_ifu", "bo_tin", "br_cnpj", "br_cpf", "bs_tin", "by_tin", "ca_bn", "ca_gst_hst", "ca_pst_bc", "ca_pst_mb", "ca_pst_sk", "ca_qst", "cd_nif", "ch_uid", "ch_vat", "cl_tin", "cm_niu", "cn_tin", "co_nit", "cr_tin", "cv_nif", "de_stn", "do_rcn", "ec_ruc", "eg_tin", "es_cif", "et_tin", "eu_oss_vat", "eu_vat", "gb_vat", "ge_vat", "gn_nif", "hk_br", "hr_oib", "hu_tin", "id_npwp", "il_vat", "in_gst", "is_vat", "jp_cn", "jp_rn", "jp_trn", "ke_pin", "kg_tin", "kh_tin", "kr_brn", "kz_bin", "la_tin", "li_uid", "li_vat", "ma_vat", "md_vat", "me_pib", "mk_vat", "mr_nif", "mx_rfc", "my_frp", "my_itn", "my_sst", "ng_tin", "no_vat", "no_voec", "np_pan", "nz_gst", "om_vat", "pe_ruc", "ph_tin", "ro_tin", "rs_pib", "ru_inn", "ru_kpp", "sa_vat", "sg_gst", "sg_uen", "si_tin", "sn_ninea", "sr_fin", "sv_nit", "th_vat", "tj_tin", "tr_tin", "tw_vat", "tz_vat", "ua_vat", "ug_tin", "us_ein", "uy_ruc", "uz_tin", "uz_vat", "ve_rif", "vn_tin", "za_vat", "zm_tin", "zw_tin" ], "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true }, "value": { "description": "Value of the tax ID.", "type": "string" } }, "required": [ "type", "value" ], "title": "data_params", "type": "object", "x-stripeMostCommon": [ "type", "value" ] }, "type": "array" } }, "title": "tax_details", "type": "object", "x-stripeMostCommon": [ "tax_exempt", "tax_ids" ] } }, "required": [ "currency", "line_items" ], "type": "object", "x-stripeMostCommon": [ "currency", "customer", "description", "line_items", "metadata", "payment" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/order" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create an order" } }, "/v1/orders/{id}": { "get": { "description": "

Retrieves the details of an existing order. Supply the unique order ID from either an order creation request or the order list, and Stripe will return the corresponding order information.

", "operationId": "GetOrdersId", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/order" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve an order" }, "post": { "description": "

Updates the specific order by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

", "operationId": "PostOrdersId", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "automatic_tax": { "explode": true, "style": "deepObject" }, "billing_details": { "explode": true, "style": "deepObject" }, "description": { "explode": true, "style": "deepObject" }, "discounts": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "line_items": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "payment": { "explode": true, "style": "deepObject" }, "shipping_cost": { "explode": true, "style": "deepObject" }, "shipping_details": { "explode": true, "style": "deepObject" }, "tax_details": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "automatic_tax": { "description": "Settings for automatic tax calculation for this order.", "properties": { "enabled": { "description": "Enable automatic tax calculation which will automatically compute tax rates on this order.", "type": "boolean" } }, "required": [ "enabled" ], "title": "automatic_tax", "type": "object", "x-stripeMostCommon": [ "enabled" ] }, "billing_details": { "anyOf": [ { "properties": { "address": { "description": "The billing address provided by the customer.", "properties": { "city": { "description": "City, district, suburb, town, or village.", "maxLength": 5000, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Address line 1 (e.g., street, PO Box, or company name).", "maxLength": 5000, "type": "string" }, "line2": { "description": "Address line 2 (e.g., apartment, suite, unit, or building).", "maxLength": 5000, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "State/province as an [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) subdivision code, without country prefix. Example: \"NY\" or \"TX\".", "maxLength": 5000, "type": "string" } }, "title": "validated_optional_fields_address", "type": "object", "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state" ] }, "email": { "description": "The billing email provided by the customer.", "type": "string" }, "name": { "description": "The billing name provided by the customer.", "maxLength": 5000, "type": "string" }, "phone": { "description": "The billing phone number provided by the customer.", "maxLength": 20, "type": "string" } }, "title": "billing_details", "type": "object", "x-stripeMostCommon": [ "address", "email", "name", "phone" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Billing details for the customer. If a customer is provided, this will be automatically populated with values from that customer if override values are not provided." }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "customer": { "description": "The customer associated with this order.", "maxLength": 5000, "type": "string" }, "description": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "An arbitrary string attached to the object. Often useful for displaying to users." }, "discounts": { "anyOf": [ { "items": { "properties": { "coupon": { "description": "ID of the coupon to create a new discount for.", "maxLength": 5000, "type": "string" }, "discount": { "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", "maxLength": 5000, "type": "string" }, "promotion_code": { "description": "ID of the promotion code to create a new discount for.", "maxLength": 5000, "type": "string" } }, "title": "discounts_data_param", "type": "object", "x-stripeMostCommon": [ "coupon", "coupon_data" ] }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The coupons, promotion codes, and/or discounts to apply to the order. Pass the empty string `\"\"` to unset this field." }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "ip_address": { "description": "The IP address of the purchaser for this order.", "type": "string" }, "line_items": { "description": "A list of line items the customer is ordering. Each line item includes information about the product, the quantity, and the resulting cost.", "items": { "properties": { "description": { "description": "The description for the line item. Will default to the name of the associated product.", "maxLength": 5000, "type": "string" }, "discounts": { "anyOf": [ { "items": { "properties": { "coupon": { "description": "ID of the coupon to create a new discount for.", "maxLength": 5000, "type": "string" }, "discount": { "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", "maxLength": 5000, "type": "string" } }, "title": "discounts_data_param", "type": "object", "x-stripeMostCommon": [ "coupon", "coupon_data" ] }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The discounts applied to this line item." }, "id": { "description": "The ID of an existing line item on the order.", "maxLength": 5000, "type": "string" }, "price": { "description": "The ID of a [Price](https://docs.stripe.com/api/prices) to add to the Order.\n\nThe `price` parameter is an alternative to using the `product` parameter. If each of your products are sold at a single price, you can set `Product.default_price` and then pass the `product` parameter when creating a line item. If your products are sold at several possible prices, use the `price` parameter to explicitly specify which one to use.", "maxLength": 5000, "type": "string" }, "price_data": { "description": "Data used to generate a new Price object inline.\n\nThe `price_data` parameter is an alternative to using the `product` or `price` parameters. If you create a Product upfront and configure a `Product.default_price`, pass the `product` parameter when creating a line item. If you prefer not to define Products upfront, or if you charge variable prices, pass the `price_data` parameter to describe the price for this line item.\n\nEach time you pass `price_data` we create a Price for the Product. This Price is hidden in both the Dashboard and API lists and cannot be reused.", "properties": { "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "product": { "description": "ID of the [Product](https://docs.stripe.com/api/products) this [Price](https://docs.stripe.com/api/prices) belongs to.\n\nUse this to implement a variable-pricing model in your integration. This is required if `product_data` is not specified.", "maxLength": 5000, "type": "string" }, "tax_behavior": { "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.", "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" }, "unit_amount": { "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.", "type": "integer" }, "unit_amount_decimal": { "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", "format": "decimal", "type": "string" } }, "title": "price_data_with_optional_product", "type": "object", "x-stripeMostCommon": [ "currency", "product", "unit_amount" ] }, "product": { "description": "The ID of a [Product](https://docs.stripe.com/api/products) to add to the Order.\n\nThe Product must have a `default_price` specified. Otherwise, specify the price by passing the `price` or `price_data` parameter.", "maxLength": 5000, "type": "string" }, "product_data": { "description": "Defines a [Product](https://docs.stripe.com/api/products) inline and adds it to the Order.\n\n`product_data` is an alternative to the `product` parameter. If you created a Product upfront, use the `product` parameter to refer to the existing Product. But if you prefer not to create Products upfront, pass the `product_data` parameter to define a Product inline as part of configuring the Order.\n\n`product_data` automatically creates a Product, just as if you had manually created the Product. If a Product with the same ID already exists, then `product_data` re-uses it to avoid duplicates.", "properties": { "description": { "anyOf": [ { "maxLength": 40000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes." }, "id": { "description": "A unique identifier for this product.\n\n`product_data` automatically creates a Product with this ID. If a Product with the same ID already exists, then `product_data` re-uses it to avoid duplicates. If any of the fields in the existing Product are different from the values in `product_data`, `product_data` updates the existing Product with the new information. So set `product_data[id]` to the same string every time you sell the same product, but don't re-use the same string for different products.", "maxLength": 5000, "type": "string" }, "images": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "A list of up to 8 URLs of images for this product, meant to be displayable to the customer." }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "name": { "description": "The product's name, meant to be displayable to the customer.", "maxLength": 5000, "type": "string" }, "package_dimensions": { "anyOf": [ { "properties": { "height": { "description": "Height, in inches. Maximum precision is 2 decimal places.", "type": "number" }, "length": { "description": "Length, in inches. Maximum precision is 2 decimal places.", "type": "number" }, "weight": { "description": "Weight, in ounces. Maximum precision is 2 decimal places.", "type": "number" }, "width": { "description": "Width, in inches. Maximum precision is 2 decimal places.", "type": "number" } }, "required": [ "height", "length", "weight", "width" ], "title": "package_dimensions_specs", "type": "object", "x-stripeMostCommon": [ "height", "length", "weight", "width" ] }, { "enum": [ "" ], "type": "string" } ], "description": "The dimensions of this product for shipping purposes." }, "shippable": { "description": "Whether this product is shipped (i.e., physical goods).", "type": "boolean" }, "tax_code": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "A [tax code](https://stripe.com/docs/tax/tax-categories) ID." }, "url": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "A URL of a publicly-accessible webpage for this product." } }, "required": [ "id", "name" ], "title": "product_upsert_data", "type": "object", "x-stripeMostCommon": [ "id", "metadata", "name", "sku", "tax_code" ] }, "quantity": { "description": "The quantity of the line item.", "type": "integer" }, "tax_rates": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The tax rates applied to this line item." } }, "title": "update_params", "type": "object", "x-stripeMostCommon": [ "id", "product", "quantity" ] }, "type": "array" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "payment": { "description": "Payment information associated with the order, including payment settings.", "properties": { "settings": { "description": "Settings describing how the order should configure generated PaymentIntents.", "properties": { "application_fee_amount": { "anyOf": [ { "type": "integer" }, { "enum": [ "" ], "type": "string" } ], "description": "The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account." }, "payment_method_options": { "description": "PaymentMethod-specific configuration to provide to the order's PaymentIntent.", "properties": { "acss_debit": { "anyOf": [ { "properties": { "mandate_options": { "description": "Additional fields for Mandate creation", "properties": { "custom_mandate_url": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "A URL for custom mandate text to render during confirmation step.\nThe URL will be rendered with additional GET parameters `payment_intent` and `payment_intent_client_secret` when confirming a Payment Intent,\nor `setup_intent` and `setup_intent_client_secret` when confirming a Setup Intent." }, "interval_description": { "description": "Description of the mandate interval. Only required if 'payment_schedule' parameter is 'interval' or 'combined'.", "maxLength": 500, "type": "string" }, "payment_schedule": { "description": "Payment schedule for the mandate.", "enum": [ "combined", "interval", "sporadic" ], "type": "string" }, "transaction_type": { "description": "Transaction type of the mandate.", "enum": [ "business", "personal" ], "type": "string" } }, "title": "payment_intent_payment_method_options_mandate_options_param", "type": "object", "x-stripeMostCommon": [ "custom_mandate_url", "interval_description", "payment_schedule", "transaction_type" ] }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "", "none", "off_session", "on_session" ], "type": "string" }, "target_date": { "description": "Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.", "maxLength": 5000, "type": "string" }, "verification_method": { "description": "Bank account verification method.", "enum": [ "automatic", "instant", "microdeposits" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "payment_intent_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "financial_connections", "mandate_options", "setup_future_usage", "target_date", "verification_method" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If paying by `acss_debit`, this sub-hash contains details about the ACSS Debit payment method options to pass to the order's PaymentIntent." }, "afterpay_clearpay": { "anyOf": [ { "properties": { "capture_method": { "description": "Controls when the funds are captured from the customer's account.\n\nIf provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.", "enum": [ "automatic", "automatic_async", "manual" ], "type": "string" }, "reference": { "description": "An internal identifier or reference this payment corresponds to. The identifier is limited to 128 characters and may contain only letters, digits, underscores, backslashes and dashes.", "maxLength": 128, "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with the payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the order's Customer, if present, after the order's PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.", "enum": [ "none" ], "type": "string" } }, "title": "afterpay_clearpay_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "capture_method", "reference", "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If paying by `afterpay_clearpay`, this sub-hash contains details about the AfterpayClearpay payment method options to pass to the order's PaymentIntent." }, "alipay": { "anyOf": [ { "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "", "none", "off_session" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If paying by `alipay`, this sub-hash contains details about the Alipay payment method options to pass to the order's PaymentIntent." }, "bancontact": { "anyOf": [ { "properties": { "preferred_language": { "description": "Preferred language of the Bancontact authorization page that the customer is redirected to.", "enum": [ "de", "en", "fr", "nl" ], "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "", "none", "off_session" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "preferred_language", "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If paying by `bancontact`, this sub-hash contains details about the Bancontact payment method options to pass to the order's PaymentIntent." }, "card": { "anyOf": [ { "properties": { "capture_method": { "description": "Controls when the funds will be captured from the customer's account.", "enum": [ "automatic", "automatic_async", "manual" ], "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with the payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the order's Customer, if present, after the order's PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.", "enum": [ "none", "off_session", "on_session" ], "type": "string" } }, "title": "card_payment_method_options", "type": "object", "x-stripeMostCommon": [ "capture_method", "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If paying by `card`, this sub-hash contains details about the Card payment method options to pass to the order's PaymentIntent." }, "customer_balance": { "anyOf": [ { "properties": { "bank_transfer": { "description": "Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`.", "properties": { "eu_bank_transfer": { "description": "Configuration for the eu_bank_transfer funding type.", "properties": { "country": { "description": "The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`.", "maxLength": 5000, "type": "string" } }, "required": [ "country" ], "title": "eu_bank_transfer_params", "type": "object", "x-stripeMostCommon": [ "country" ] }, "requested_address_types": { "description": "List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.\n\nPermitted values include: `sort_code`, `zengin`, `iban`, or `spei`.", "items": { "enum": [ "aba", "iban", "sepa", "sort_code", "spei", "swift", "zengin" ], "type": "string", "x-stripeBypassValidation": true }, "type": "array" }, "type": { "description": "The list of bank transfer types that this PaymentIntent is allowed to use for funding Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.", "enum": [ "eu_bank_transfer", "gb_bank_transfer", "jp_bank_transfer", "mx_bank_transfer", "us_bank_transfer" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "bank_transfer_param", "type": "object", "x-stripeMostCommon": [ "eu_bank_transfer", "id_bank_account", "id_bank_transfer", "requested_address_types", "type" ] }, "funding_type": { "description": "The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.", "enum": [ "bank_transfer" ], "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "none" ], "type": "string" } }, "title": "payment_intent_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "bank_transfer", "funding_type", "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If paying by `customer_balance`, this sub-hash contains details about the Customer Balance payment method options to pass to the order's PaymentIntent." }, "ideal": { "anyOf": [ { "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "", "none", "off_session" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If paying by `ideal`, this sub-hash contains details about the iDEAL payment method options to pass to the order's PaymentIntent." }, "klarna": { "anyOf": [ { "properties": { "capture_method": { "description": "Controls when the funds are captured from the customer's account.\n\nIf provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.", "enum": [ "", "manual" ], "type": "string" }, "on_demand": { "description": "On-demand details if setting up or charging an on-demand payment.", "properties": { "average_amount": { "description": "Your average amount value. You can use a value across your customer base, or segment based on customer type, country, etc.", "type": "integer" }, "maximum_amount": { "description": "The maximum value you may charge a customer per purchase. You can use a value across your customer base, or segment based on customer type, country, etc.", "type": "integer" }, "minimum_amount": { "description": "The lowest or minimum value you may charge a customer per purchase. You can use a value across your customer base, or segment based on customer type, country, etc.", "type": "integer" }, "purchase_interval": { "description": "Interval at which the customer is making purchases", "enum": [ "day", "month", "week", "year" ], "type": "string" }, "purchase_interval_count": { "description": "The number of `purchase_interval` between charges", "type": "integer" } }, "title": "on_demand_param", "type": "object", "x-stripeMostCommon": [ "average_amount", "maximum_amount", "minimum_amount", "purchase_interval", "purchase_interval_count" ] }, "preferred_locale": { "description": "Preferred language of the Klarna authorization page that the customer is redirected to", "enum": [ "cs-CZ", "da-DK", "de-AT", "de-CH", "de-DE", "el-GR", "en-AT", "en-AU", "en-BE", "en-CA", "en-CH", "en-CZ", "en-DE", "en-DK", "en-ES", "en-FI", "en-FR", "en-GB", "en-GR", "en-IE", "en-IT", "en-NL", "en-NO", "en-NZ", "en-PL", "en-PT", "en-RO", "en-SE", "en-US", "es-ES", "es-US", "fi-FI", "fr-BE", "fr-CA", "fr-CH", "fr-FR", "it-CH", "it-IT", "nb-NO", "nl-BE", "nl-NL", "pl-PL", "pt-PT", "ro-RO", "sv-FI", "sv-SE" ], "type": "string", "x-stripeBypassValidation": true }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "none", "off_session", "on_session" ], "type": "string" }, "subscriptions": { "anyOf": [ { "items": { "properties": { "interval": { "description": "Unit of time between subscription charges.", "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "description": "The number of intervals (specified in the `interval` attribute) between subscription charges. For example, `interval=month` and `interval_count=3` charges every 3 months.", "type": "integer" }, "name": { "description": "Name for subscription.", "maxLength": 255, "type": "string" }, "next_billing": { "description": "Describes the upcoming charge for this subscription.", "properties": { "amount": { "description": "The amount of the next charge for the subscription.", "type": "integer" }, "date": { "description": "The date of the next charge for the subscription in YYYY-MM-DD format.", "maxLength": 5000, "type": "string" } }, "required": [ "amount", "date" ], "title": "subscription_next_billing_param", "type": "object", "x-stripeMostCommon": [ "amount", "date" ] }, "reference": { "description": "A non-customer-facing reference to correlate subscription charges in the Klarna app. Use a value that persists across subscription charges.", "maxLength": 255, "type": "string" } }, "required": [ "interval", "reference" ], "title": "subscription_param", "type": "object", "x-stripeMostCommon": [ "interval", "interval_count", "name", "next_billing", "reference" ] }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "Subscription details if setting up or charging a subscription." } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "capture_method", "extra_merchant_data_blob", "interoperability_token", "line_items", "on_demand", "partner_confirmation_token", "payment_details", "payment_method_category", "payment_option_id", "preferred_locale", "request_incremental_authorization", "request_multicapture", "setup_future_usage", "subscriptions", "supplementary_purchase_data" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If paying by `klarna`, this sub-hash contains details about the Klarna payment method options to pass to the order's PaymentIntent." }, "link": { "anyOf": [ { "properties": { "capture_method": { "description": "Controls when the funds are captured from the customer's account.\n\nIf provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.", "enum": [ "", "manual" ], "type": "string" }, "persistent_token": { "description": "[Deprecated] This is a legacy parameter that no longer has any function.", "maxLength": 5000, "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "", "none", "off_session" ], "type": "string" } }, "title": "payment_intent_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "capture_method", "persistent_token", "request_multicapture", "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If paying by `link`, this sub-hash contains details about the Link payment method options to pass to the order's PaymentIntent." }, "oxxo": { "anyOf": [ { "properties": { "expires_after_days": { "description": "The number of calendar days before an OXXO voucher expires. For example, if you create an OXXO voucher on Monday and you set expires_after_days to 2, the OXXO invoice will expire on Wednesday at 23:59 America/Mexico_City time.", "type": "integer" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "expires_after_days", "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If paying by `oxxo`, this sub-hash contains details about the OXXO payment method options to pass to the order's PaymentIntent." }, "p24": { "anyOf": [ { "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "none" ], "type": "string" }, "tos_shown_and_accepted": { "description": "Confirm that the payer has accepted the P24 terms and conditions.", "type": "boolean" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "installments", "setup_future_usage", "tos_shown_and_accepted" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If paying by `p24`, this sub-hash contains details about the P24 payment method options to pass to the order's PaymentIntent." }, "paypal": { "anyOf": [ { "properties": { "capture_method": { "description": "Controls when the funds will be captured from the customer's account.", "enum": [ "", "manual" ], "type": "string" }, "line_items": { "description": "The line items purchased by the customer.", "items": { "properties": { "category": { "description": "Type of the line item.", "enum": [ "digital_goods", "donation", "physical_goods" ], "type": "string" }, "description": { "description": "Description of the line item.", "maxLength": 127, "type": "string" }, "name": { "description": "Descriptive name of the line item.", "maxLength": 127, "type": "string" }, "quantity": { "description": "Quantity of the line item. Must be a positive number.", "type": "integer" }, "sku": { "description": "Client facing stock keeping unit, article number or similar.", "maxLength": 127, "type": "string" }, "sold_by": { "description": "The Stripe account ID of the connected account that sells the item.", "maxLength": 5000, "type": "string" }, "tax": { "description": "The tax information for the line item.", "properties": { "amount": { "description": "The tax for a single unit of the line item in minor units. Cannot be a negative number.", "type": "integer" }, "behavior": { "description": "The tax behavior for the line item.", "enum": [ "exclusive", "inclusive" ], "type": "string" } }, "required": [ "amount", "behavior" ], "title": "line_item_tax_param", "type": "object", "x-stripeMostCommon": [ "amount", "behavior" ] }, "unit_amount": { "description": "Price for a single unit of the line item in minor units. Cannot be a negative number.", "type": "integer" } }, "required": [ "name", "quantity", "unit_amount" ], "title": "line_item_param", "type": "object", "x-stripeMostCommon": [ "category", "description", "name", "quantity", "sku", "sold_by", "tax", "unit_amount" ] }, "type": "array" }, "preferred_locale": { "description": "[Preferred locale](https://stripe.com/docs/payments/paypal/supported-locales) of the PayPal checkout page that the customer is redirected to.", "enum": [ "cs-CZ", "da-DK", "de-AT", "de-DE", "de-LU", "el-GR", "en-GB", "en-US", "es-ES", "fi-FI", "fr-BE", "fr-FR", "fr-LU", "hu-HU", "it-IT", "nl-BE", "nl-NL", "pl-PL", "pt-PT", "sk-SK", "sv-SE" ], "type": "string", "x-stripeBypassValidation": true }, "reference": { "description": "A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID.", "maxLength": 127, "type": "string" }, "reference_id": { "description": "A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID.", "maxLength": 127, "type": "string" }, "risk_correlation_id": { "description": "The risk correlation ID for an on-session payment using a saved PayPal payment method.", "maxLength": 32, "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "", "none", "off_session" ], "type": "string" }, "subsellers": { "description": "The Stripe connected account IDs of the sellers on the platform for this transaction (optional). Only allowed when [separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers) are used.", "items": { "maxLength": 32, "type": "string" }, "type": "array" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "allow_delayed_notification", "capture_method", "line_items", "preferred_locale", "reference", "reference_id", "risk_correlation_id", "setup_future_usage", "subsellers" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If paying by `paypal`, this sub-hash contains details about the PayPal payment method options to pass to the order's PaymentIntent." }, "sepa_debit": { "anyOf": [ { "properties": { "mandate_options": { "description": "Additional fields for Mandate creation", "properties": { "reference_prefix": { "anyOf": [ { "maxLength": 12, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'." } }, "title": "payment_method_options_mandate_options_param", "type": "object", "x-stripeMostCommon": [ "reference", "reference_prefix" ] }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "", "none", "off_session", "on_session" ], "type": "string" }, "target_date": { "description": "Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.", "maxLength": 5000, "type": "string" } }, "title": "payment_intent_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "mandate_options", "setup_future_usage", "target_date", "verification_method" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If paying by `sepa_debit`, this sub-hash contains details about the SEPA Debit payment method options to pass to the order's PaymentIntent." }, "sofort": { "anyOf": [ { "properties": { "preferred_language": { "description": "Language shown to the payer on redirect.", "enum": [ "", "de", "en", "es", "fr", "it", "nl", "pl" ], "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "", "none", "off_session" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "preferred_language", "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If paying by `sofort`, this sub-hash contains details about the Sofort payment method options to pass to the order's PaymentIntent." }, "wechat_pay": { "anyOf": [ { "properties": { "app_id": { "description": "The app ID registered with WeChat Pay. Only required when client is ios or android.", "maxLength": 5000, "type": "string" }, "client": { "description": "The client type that the end customer will pay from", "enum": [ "android", "ios", "web" ], "type": "string", "x-stripeBypassValidation": true }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "app_id", "client", "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If paying by `wechat_pay`, this sub-hash contains details about the WeChat Pay payment method options to pass to the order's PaymentIntent." } }, "title": "update_params", "type": "object", "x-stripeMostCommon": [ "acss_debit", "afterpay_clearpay", "alipay", "bancontact", "card", "customer_balance", "ideal", "klarna", "link", "oxxo", "p24", "paypal", "sepa_debit", "sofort", "wechat_pay" ] }, "payment_method_types": { "description": "The list of [payment method types](https://stripe.com/docs/payments/payment-methods/overview) to provide to the order's PaymentIntent. Do not include this attribute if you prefer to manage your payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods).", "items": { "enum": [ "acss_debit", "afterpay_clearpay", "alipay", "au_becs_debit", "bacs_debit", "bancontact", "card", "customer_balance", "eps", "fpx", "giropay", "grabpay", "ideal", "klarna", "link", "oxxo", "p24", "paypal", "sepa_debit", "sofort", "wechat_pay" ], "type": "string" }, "type": "array" }, "return_url": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "The URL to redirect the customer to after they authenticate their payment." }, "statement_descriptor": { "description": "For non-card charges, you can use this value as the complete description that appears on your customers' statements. Must contain at least one letter, maximum 22 characters.", "maxLength": 22, "type": "string" }, "statement_descriptor_suffix": { "description": "Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor.", "maxLength": 22, "type": "string" }, "transfer_data": { "anyOf": [ { "properties": { "amount": { "description": "The amount that will be transferred automatically when the order is paid. If no amount is set, the full amount is transferred. There cannot be any line items with recurring prices when using this field.", "type": "integer" }, "destination": { "description": "ID of the Connected account receiving the transfer.", "type": "string" } }, "required": [ "destination" ], "title": "transfer_data", "type": "object", "x-stripeMostCommon": [ "amount", "amount_percent", "destination" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Provides configuration for completing a transfer for the order after it is paid." } }, "title": "update_params", "type": "object", "x-stripeMostCommon": [ "application_fee_amount", "payment_method_options", "payment_method_types", "return_url", "skip_payment_intent_creation", "statement_descriptor", "statement_descriptor_suffix", "transfer_data", "transfer_group" ] } }, "required": [ "settings" ], "title": "update_params", "type": "object", "x-stripeMostCommon": [ "settings" ] }, "shipping_cost": { "anyOf": [ { "properties": { "shipping_rate": { "description": "The ID of the shipping rate to use for this order.", "maxLength": 5000, "type": "string" }, "shipping_rate_data": { "description": "Parameters to create a new ad-hoc shipping rate for this order.", "properties": { "delivery_estimate": { "description": "The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.", "properties": { "maximum": { "description": "The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.", "properties": { "unit": { "description": "A unit of time.", "enum": [ "business_day", "day", "hour", "month", "week" ], "type": "string" }, "value": { "description": "Must be greater than 0.", "type": "integer" } }, "required": [ "unit", "value" ], "title": "delivery_estimate_bound", "type": "object", "x-stripeMostCommon": [ "unit", "value" ] }, "minimum": { "description": "The lower bound of the estimated range. If empty, represents no lower bound.", "properties": { "unit": { "description": "A unit of time.", "enum": [ "business_day", "day", "hour", "month", "week" ], "type": "string" }, "value": { "description": "Must be greater than 0.", "type": "integer" } }, "required": [ "unit", "value" ], "title": "delivery_estimate_bound", "type": "object", "x-stripeMostCommon": [ "unit", "value" ] } }, "title": "delivery_estimate", "type": "object", "x-stripeMostCommon": [ "maximum", "minimum" ] }, "display_name": { "description": "The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.", "maxLength": 100, "type": "string" }, "fixed_amount": { "description": "Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`.", "properties": { "amount": { "description": "A non-negative integer in cents representing how much to charge.", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "currency_options": { "additionalProperties": { "properties": { "amount": { "description": "A non-negative integer in cents representing how much to charge.", "type": "integer" }, "tax_behavior": { "description": "Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.", "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" } }, "required": [ "amount" ], "title": "currency_option", "type": "object", "x-stripeMostCommon": [ "amount", "tax_behavior" ] }, "description": "Shipping rates defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).", "type": "object" } }, "required": [ "amount", "currency" ], "title": "fixed_amount", "type": "object", "x-stripeMostCommon": [ "amount", "currency", "currency_options" ] }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "tax_behavior": { "description": "Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.", "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" }, "tax_code": { "description": "A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`.", "type": "string" }, "type": { "description": "The type of calculation to use on the shipping rate.", "enum": [ "fixed_amount" ], "type": "string" } }, "required": [ "display_name" ], "title": "method_params", "type": "object", "x-stripeMostCommon": [ "display_name", "fixed_amount", "metadata", "tax_behavior", "tax_code", "type" ] } }, "title": "shipping_cost", "type": "object", "x-stripeMostCommon": [ "shipping_rate", "shipping_rate_data" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Settings for the customer cost of shipping for this order." }, "shipping_details": { "anyOf": [ { "properties": { "address": { "description": "The shipping address for the order.", "properties": { "city": { "description": "City, district, suburb, town, or village.", "maxLength": 5000, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Address line 1 (e.g., street, PO Box, or company name).", "maxLength": 5000, "type": "string" }, "line2": { "description": "Address line 2 (e.g., apartment, suite, unit, or building).", "maxLength": 5000, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "State/province as an [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) subdivision code, without country prefix. Example: \"NY\" or \"TX\".", "maxLength": 5000, "type": "string" } }, "title": "validated_optional_fields_address", "type": "object", "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state" ] }, "name": { "description": "The name of the recipient of the order.", "maxLength": 5000, "type": "string" }, "phone": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "The phone number (including extension) for the recipient of the order." } }, "required": [ "address", "name" ], "title": "shipping_details", "type": "object", "x-stripeMostCommon": [ "address", "name", "phone" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Shipping details for the order." }, "tax_details": { "description": "Additional tax details about the purchaser to be used for this order.", "properties": { "tax_exempt": { "description": "The purchaser's tax exemption status. One of `none`, `exempt`, or `reverse`.", "enum": [ "", "exempt", "none", "reverse" ], "type": "string" }, "tax_ids": { "description": "The purchaser's tax IDs to be used for this order.", "items": { "properties": { "type": { "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `aw_tin`, `az_tin`, `ba_tin`, `bb_tin`, `bd_bin`, `bf_ifu`, `bg_uic`, `bh_vat`, `bj_ifu`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cm_niu`, `cn_tin`, `co_nit`, `cr_tin`, `cv_nif`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `et_tin`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kg_tin`, `kh_tin`, `kr_brn`, `kz_bin`, `la_tin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin`", "enum": [ "ad_nrt", "ae_trn", "al_tin", "am_tin", "ao_tin", "ar_cuit", "au_abn", "au_arn", "aw_tin", "az_tin", "ba_tin", "bb_tin", "bd_bin", "bf_ifu", "bg_uic", "bh_vat", "bj_ifu", "bo_tin", "br_cnpj", "br_cpf", "bs_tin", "by_tin", "ca_bn", "ca_gst_hst", "ca_pst_bc", "ca_pst_mb", "ca_pst_sk", "ca_qst", "cd_nif", "ch_uid", "ch_vat", "cl_tin", "cm_niu", "cn_tin", "co_nit", "cr_tin", "cv_nif", "de_stn", "do_rcn", "ec_ruc", "eg_tin", "es_cif", "et_tin", "eu_oss_vat", "eu_vat", "gb_vat", "ge_vat", "gn_nif", "hk_br", "hr_oib", "hu_tin", "id_npwp", "il_vat", "in_gst", "is_vat", "jp_cn", "jp_rn", "jp_trn", "ke_pin", "kg_tin", "kh_tin", "kr_brn", "kz_bin", "la_tin", "li_uid", "li_vat", "ma_vat", "md_vat", "me_pib", "mk_vat", "mr_nif", "mx_rfc", "my_frp", "my_itn", "my_sst", "ng_tin", "no_vat", "no_voec", "np_pan", "nz_gst", "om_vat", "pe_ruc", "ph_tin", "ro_tin", "rs_pib", "ru_inn", "ru_kpp", "sa_vat", "sg_gst", "sg_uen", "si_tin", "sn_ninea", "sr_fin", "sv_nit", "th_vat", "tj_tin", "tr_tin", "tw_vat", "tz_vat", "ua_vat", "ug_tin", "us_ein", "uy_ruc", "uz_tin", "uz_vat", "ve_rif", "vn_tin", "za_vat", "zm_tin", "zw_tin" ], "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true }, "value": { "description": "Value of the tax ID.", "type": "string" } }, "required": [ "type", "value" ], "title": "data_params", "type": "object", "x-stripeMostCommon": [ "type", "value" ] }, "type": "array" } }, "title": "tax_details", "type": "object", "x-stripeMostCommon": [ "tax_exempt", "tax_ids" ] } }, "type": "object", "x-stripeMostCommon": [ "currency", "customer", "description", "line_items", "metadata", "payment" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/order" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update an order" } }, "/v1/orders/{id}/cancel": { "post": { "description": "

Cancels the order as well as the payment intent if one is attached.

", "operationId": "PostOrdersIdCancel", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/order" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Cancel an order" } }, "/v1/orders/{id}/line_items": { "get": { "description": "

When retrieving an order, 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.

", "operationId": "GetOrdersIdLineItems", "parameters": [ { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/item" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "OrdersV2ResourceLineItemList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve an order's line items" } }, "/v1/orders/{id}/reopen": { "post": { "description": "

Reopens a submitted order.

", "operationId": "PostOrdersIdReopen", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/order" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Reopen an order" } }, "/v1/orders/{id}/submit": { "post": { "description": "

Submitting an Order transitions the status to processing and creates a PaymentIntent object so the order can be paid. If the Order has an amount_total of 0, no PaymentIntent object will be created. Once the order is submitted, its contents cannot be changed, unless the reopen method is called.

", "operationId": "PostOrdersIdSubmit", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "expected_total": { "description": "`expected_total` should always be set to the order's `amount_total` field. If they don't match, submitting the order will fail. This helps detect race conditions where something else concurrently modifies the order.", "type": "integer" } }, "required": [ "expected_total" ], "type": "object", "x-stripeMostCommon": [ "expected_total" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/order" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Submit an order" } }, "/v1/payment_attempt_records": { "get": { "description": "

List all the Payment Attempt Records attached to the specified Payment Record.

", "operationId": "GetPaymentAttemptRecords", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "The ID of the Payment Record.", "in": "query", "name": "payment_record", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "A list of PaymentAttemptRecords.", "properties": { "data": { "items": { "$ref": "#/components/schemas/payment_attempt_record" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "PaymentsPrimitivesPaymentRecordsResourcePaymentAttemptRecordList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List Payment Attempt Records" } }, "/v1/payment_attempt_records/{id}": { "get": { "description": "

Retrieves a Payment Attempt Record with the given ID

", "operationId": "GetPaymentAttemptRecordsId", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "The ID of the Payment Attempt Record.", "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_attempt_record" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a Payment Attempt Record" } }, "/v1/payment_intents": { "get": { "description": "

Returns a list of PaymentIntents.

", "operationId": "GetPaymentIntents", "parameters": [ { "description": "A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp or a dictionary with a number of different query options.", "explode": true, "in": "query", "name": "created", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "description": "Minimum value to filter by (exclusive)", "type": "integer" }, "gte": { "description": "Minimum value to filter by (inclusive)", "type": "integer" }, "lt": { "description": "Maximum value to filter by (exclusive)", "type": "integer" }, "lte": { "description": "Maximum value to filter by (inclusive)", "type": "integer" } }, "title": "range_query_specs", "type": "object", "x-stripeMostCommon": [ "gt", "gte", "lt", "lte" ] }, { "type": "integer" } ] }, "style": "deepObject" }, { "description": "Only return PaymentIntents for the customer that this customer ID specifies.", "in": "query", "name": "customer", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Only return PaymentIntents for the account that this ID specifies.", "in": "query", "name": "customer_account", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/payment_intent" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/payment_intents", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "PaymentFlowsPaymentIntentList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all PaymentIntents" }, "post": { "description": "

Creates a PaymentIntent object.

\n\n

After the PaymentIntent is created, attach a payment method and confirm\nto continue the payment. Learn more about the available payment flows\nwith the Payment Intents API.

\n\n

When you use confirm=true during creation, it’s equivalent to creating\nand confirming the PaymentIntent in the same call. You can use any parameters\navailable in the confirm API when you supply\nconfirm=true.

", "operationId": "PostPaymentIntents", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "amount_details": { "explode": true, "style": "deepObject" }, "automatic_payment_methods": { "explode": true, "style": "deepObject" }, "excluded_payment_method_types": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "hooks": { "explode": true, "style": "deepObject" }, "mandate_data": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "off_session": { "explode": true, "style": "deepObject" }, "payment_details": { "explode": true, "style": "deepObject" }, "payment_method_data": { "explode": true, "style": "deepObject" }, "payment_method_options": { "explode": true, "style": "deepObject" }, "payment_method_types": { "explode": true, "style": "deepObject" }, "radar_options": { "explode": true, "style": "deepObject" }, "shipping": { "explode": true, "style": "deepObject" }, "transfer_data": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "amount": { "description": "Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).", "type": "integer" }, "amount_details": { "description": "Provides industry-specific information about the amount.", "properties": { "discount_amount": { "anyOf": [ { "type": "integer" }, { "enum": [ "" ], "type": "string" } ], "description": "The amount an item was discounted for." }, "line_items": { "anyOf": [ { "items": { "properties": { "discount_amount": { "description": "The amount an item was discounted for. Positive integer.", "type": "integer" }, "payment_method_options": { "description": "Payment method-specific information for line items.", "properties": { "card": { "description": "This sub-hash contains line item details that are specific to `card` payment method.\"", "properties": { "commodity_code": { "description": "Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, etc.", "maxLength": 12, "type": "string" } }, "title": "payment_intent_amount_details_line_item_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "commodity_code" ] }, "card_present": { "description": "This sub-hash contains line item details that are specific to `card_present` payment method.\"", "properties": { "commodity_code": { "description": "Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, etc.", "maxLength": 12, "type": "string" } }, "title": "amount_details_line_item_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "commodity_code" ] }, "klarna": { "description": "This sub-hash contains line item details that are specific to `klarna` payment method.\"", "properties": { "image_url": { "description": "URL to an image for the product. Max length, 4096 characters.", "maxLength": 4096, "type": "string" }, "product_url": { "description": "URL to the product page. Max length, 4096 characters.", "maxLength": 4096, "type": "string" }, "subscription_reference": { "description": "Reference for the subscription this line item is for.", "maxLength": 255, "type": "string" } }, "title": "payment_intent_amount_details_line_item_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "image_url", "product_url", "subscription_reference" ] }, "paypal": { "description": "This sub-hash contains line item details that are specific to `paypal` payment method.\"", "properties": { "category": { "description": "Type of the line item.", "enum": [ "digital_goods", "donation", "physical_goods" ], "type": "string" }, "description": { "description": "Description of the line item.", "maxLength": 127, "type": "string" }, "sold_by": { "description": "The Stripe account ID of the connected account that sells the item.", "maxLength": 127, "type": "string" } }, "title": "amount_details_line_item_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "category", "description", "sold_by" ] } }, "title": "amount_details_line_item_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "card", "card_present", "dummy_auth_push", "klarna", "link", "paypal" ] }, "product_code": { "description": "Unique identifier of the product. At most 12 characters long.", "maxLength": 12, "type": "string" }, "product_name": { "description": "Name of the product. At most 100 characters long.", "maxLength": 1024, "type": "string" }, "quantity": { "description": "Number of items of the product. Positive integer.", "type": "integer" }, "tax": { "description": "Contains information about the tax on the item.", "properties": { "total_tax_amount": { "description": "The total tax on an item. Non-negative integer.", "type": "integer" } }, "required": [ "total_tax_amount" ], "title": "amount_details_line_item_tax_param", "type": "object", "x-stripeMostCommon": [ "total_tax_amount" ] }, "unit_cost": { "description": "Cost of the product. Non-negative integer.", "type": "integer" }, "unit_of_measure": { "description": "A unit of measure for the line item, such as gallons, feet, meters, etc.", "maxLength": 12, "type": "string" } }, "required": [ "product_name", "quantity", "unit_cost" ], "title": "amount_details_line_item_param", "type": "object", "x-stripeMostCommon": [ "discount_amount", "payment_method_options", "product_code", "product_name", "quantity", "tax", "unit_cost", "unit_of_measure" ] }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "A list of line items, each containing information about a product in the PaymentIntent. There is a maximum of 100 line items." }, "shipping": { "anyOf": [ { "properties": { "amount": { "anyOf": [ { "type": "integer" }, { "enum": [ "" ], "type": "string" } ], "description": "Portion of the amount that is for shipping." }, "from_postal_code": { "anyOf": [ { "maxLength": 10, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "The postal code that represents the shipping source." }, "to_postal_code": { "anyOf": [ { "maxLength": 10, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "The postal code that represents the shipping destination." } }, "title": "amount_details_shipping_param", "type": "object", "x-stripeMostCommon": [ "amount", "from_postal_code", "to_postal_code" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Contains information about the shipping portion of the amount." }, "tax": { "anyOf": [ { "properties": { "total_tax_amount": { "description": "Total portion of the amount that is for tax.", "type": "integer" } }, "required": [ "total_tax_amount" ], "title": "amount_details_tax_param", "type": "object", "x-stripeMostCommon": [ "total_tax_amount" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Contains information about the tax portion of the amount." } }, "title": "amount_details_param", "type": "object", "x-stripeMostCommon": [ "discount_amount", "line_items", "shipping", "tax" ] }, "application_fee_amount": { "description": "The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total amount captured. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).", "type": "integer" }, "automatic_payment_methods": { "description": "When you enable this parameter, this PaymentIntent accepts payment methods that you enable in the Dashboard and that are compatible with this PaymentIntent's other parameters.", "properties": { "allow_redirects": { "description": "Controls whether this PaymentIntent will accept redirect-based payment methods.\n\nRedirect-based payment methods may require your customer to be redirected to a payment method's app or site for authentication or additional steps. To [confirm](https://stripe.com/docs/api/payment_intents/confirm) this PaymentIntent, you may be required to provide a `return_url` to redirect customers back to your site after they authenticate or complete the payment.", "enum": [ "always", "never" ], "type": "string" }, "enabled": { "description": "Whether this feature is enabled.", "type": "boolean" } }, "required": [ "enabled" ], "title": "automatic_payment_methods_param", "type": "object", "x-stripeMostCommon": [ "allow_redirects", "enabled" ] }, "capture_method": { "description": "Controls when the funds will be captured from the customer's account.", "enum": [ "automatic", "automatic_async", "manual" ], "type": "string" }, "confirm": { "description": "Set to `true` to attempt to [confirm this PaymentIntent](https://stripe.com/docs/api/payment_intents/confirm) immediately. This parameter defaults to `false`. When creating and confirming a PaymentIntent at the same time, you can also provide the parameters available in the [Confirm API](https://stripe.com/docs/api/payment_intents/confirm).", "type": "boolean" }, "confirmation_method": { "description": "Describes whether we can confirm this PaymentIntent automatically, or if it requires customer action to confirm the payment.", "enum": [ "automatic", "manual" ], "type": "string" }, "confirmation_token": { "description": "ID of the ConfirmationToken used to confirm this PaymentIntent.\n\nIf the provided ConfirmationToken contains properties that are also being provided in this request, such as `payment_method`, then the values in this request will take precedence.", "maxLength": 5000, "type": "string" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "customer": { "description": "ID of the Customer this PaymentIntent belongs to, if one exists.\n\nPayment methods attached to other Customers cannot be used with this PaymentIntent.\n\nIf [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead.", "maxLength": 5000, "type": "string" }, "customer_account": { "description": "ID of the Account this PaymentIntent belongs to, if one exists.\n\nPayment methods attached to other Accounts cannot be used with this PaymentIntent.\n\nIf [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Account after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Account instead.", "maxLength": 5000, "type": "string" }, "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users.", "maxLength": 1000, "type": "string" }, "error_on_requires_action": { "description": "Set to `true` to fail the payment attempt if the PaymentIntent transitions into `requires_action`. Use this parameter for simpler integrations that don't handle customer actions, such as [saving cards without authentication](https://stripe.com/docs/payments/save-card-without-authentication). This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm).", "type": "boolean" }, "excluded_payment_method_types": { "description": "The list of payment method types to exclude from use with this payment.", "items": { "enum": [ "acss_debit", "affirm", "afterpay_clearpay", "alipay", "alma", "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", "billie", "blik", "boleto", "card", "cashapp", "crypto", "customer_balance", "eps", "fpx", "giropay", "gopay", "grabpay", "id_bank_transfer", "ideal", "kakao_pay", "klarna", "konbini", "kr_card", "mb_way", "mobilepay", "multibanco", "naver_pay", "nz_bank_account", "oxxo", "p24", "pay_by_bank", "payco", "paynow", "paypal", "paypay", "payto", "pix", "promptpay", "qris", "rechnung", "revolut_pay", "samsung_pay", "satispay", "sepa_debit", "shopeepay", "sofort", "stripe_balance", "swish", "twint", "us_bank_account", "wechat_pay", "zip" ], "type": "string", "x-stripeBypassValidation": true }, "type": "array" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "fx_quote": { "description": "The FX rate in the quote is validated and used to convert the presentment amount to the settlement amount.", "maxLength": 5000, "type": "string" }, "hooks": { "description": "Automations to be run during the PaymentIntent lifecycle", "properties": { "inputs": { "description": "Arguments passed in automations", "properties": { "tax": { "description": "Tax arguments for automations", "properties": { "calculation": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "The [TaxCalculation](https://stripe.com/docs/api/tax/calculations) id" } }, "required": [ "calculation" ], "title": "async_workflows_inputs_tax_param", "type": "object", "x-stripeMostCommon": [ "calculation" ] } }, "title": "async_workflows_inputs_param", "type": "object", "x-stripeMostCommon": [ "tax" ] } }, "title": "async_workflows_param", "type": "object", "x-stripeMostCommon": [ "inputs" ] }, "mandate": { "description": "ID of the mandate that's used for this payment. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm).", "maxLength": 5000, "type": "string" }, "mandate_data": { "anyOf": [ { "properties": { "customer_acceptance": { "description": "This hash contains details about the customer acceptance of the Mandate.", "properties": { "accepted_at": { "description": "The time at which the customer accepted the Mandate.", "format": "unix-time", "type": "integer" }, "offline": { "description": "If this is a Mandate accepted offline, this hash contains details about the offline acceptance.", "properties": {}, "title": "offline_param", "type": "object" }, "online": { "description": "If this is a Mandate accepted online, this hash contains details about the online acceptance.", "properties": { "ip_address": { "description": "The IP address from which the Mandate was accepted by the customer.", "type": "string" }, "user_agent": { "description": "The user agent of the browser from which the Mandate was accepted by the customer.", "maxLength": 5000, "type": "string" } }, "required": [ "ip_address", "user_agent" ], "title": "online_param", "type": "object", "x-stripeMostCommon": [ "ip_address", "user_agent" ] }, "type": { "description": "The type of customer acceptance information included with the Mandate. One of `online` or `offline`.", "enum": [ "offline", "online" ], "maxLength": 5000, "type": "string" } }, "required": [ "type" ], "title": "customer_acceptance_param", "type": "object", "x-stripeMostCommon": [ "accepted_at", "offline", "online", "type" ] } }, "required": [ "customer_acceptance" ], "title": "secret_key_param", "type": "object", "x-stripeMostCommon": [ "customer_acceptance" ] }, { "enum": [ "" ], "type": "string" } ], "description": "This hash contains details about the Mandate to create. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm)." }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "off_session": { "anyOf": [ { "type": "boolean" }, { "enum": [ "one_off", "recurring" ], "maxLength": 5000, "type": "string" } ], "description": "Set to `true` to indicate that the customer isn't in your checkout flow during this payment attempt and can't authenticate. Use this parameter in scenarios where you collect card details and [charge them later](https://stripe.com/docs/payments/cards/charging-saved-cards). This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm)." }, "on_behalf_of": { "description": "The Stripe account ID that these funds are intended for. Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).", "type": "string" }, "payment_details": { "description": "Provides industry-specific information about the charge.", "properties": { "car_rental": { "description": "Car rental details for this PaymentIntent.", "properties": { "affiliate": { "description": "Affiliate details for this purchase.", "properties": { "name": { "description": "The name of the affiliate that originated the purchase.", "maxLength": 5000, "type": "string" } }, "required": [ "name" ], "title": "affiliate", "type": "object", "x-stripeMostCommon": [ "name" ] }, "booking_number": { "description": "The booking number associated with the car rental.", "maxLength": 100, "type": "string" }, "car_class_code": { "description": "Class code of the car.", "maxLength": 4, "type": "string" }, "car_make": { "description": "Make of the car.", "maxLength": 10, "type": "string" }, "car_model": { "description": "Model of the car.", "maxLength": 10, "type": "string" }, "company": { "description": "The name of the rental car company.", "maxLength": 26, "type": "string" }, "customer_service_phone_number": { "description": "The customer service phone number of the car rental company.", "maxLength": 16, "type": "string" }, "days_rented": { "description": "Number of days the car is being rented.", "type": "integer" }, "delivery": { "description": "Delivery details for this purchase.", "properties": { "mode": { "description": "The delivery method for the payment", "enum": [ "email", "phone", "pickup", "post" ], "type": "string" }, "recipient": { "description": "Details of the recipient.", "properties": { "email": { "description": "The email of the recipient the ticket is delivered to.", "maxLength": 5000, "type": "string" }, "name": { "description": "The name of the recipient the ticket is delivered to.", "maxLength": 5000, "type": "string" }, "phone": { "description": "The phone number of the recipient the ticket is delivered to.", "maxLength": 5000, "type": "string" } }, "title": "delivery_recipient", "type": "object", "x-stripeMostCommon": [ "email", "name", "phone" ] } }, "title": "delivery", "type": "object", "x-stripeMostCommon": [ "mode", "recipient" ] }, "distance": { "description": "The details of the distance traveled during the rental period.", "properties": { "amount": { "description": "Distance traveled.", "type": "integer" }, "unit": { "description": "Unit of measurement for the distance traveled. One of `miles` or `kilometers`.", "enum": [ "kilometers", "miles" ], "type": "string" } }, "title": "car_rental_distance", "type": "object", "x-stripeMostCommon": [ "amount", "unit" ] }, "drivers": { "description": "The details of the passengers in the travel reservation", "items": { "properties": { "driver_identification_number": { "description": "Driver's identification number.", "maxLength": 20, "type": "string" }, "driver_tax_number": { "description": "Driver's tax number.", "maxLength": 20, "type": "string" }, "name": { "description": "Full name of the person or entity on the car reservation.", "maxLength": 5000, "type": "string" } }, "required": [ "name" ], "title": "car_rental_driver", "type": "object", "x-stripeMostCommon": [ "driver_identification_number", "driver_tax_number", "name" ] }, "type": "array" }, "extra_charges": { "description": "List of additional charges being billed.", "items": { "enum": [ "extra_mileage", "gas", "late_return", "one_way_service", "parking_violation" ], "type": "string" }, "type": "array" }, "no_show": { "description": "Indicates if the customer did not keep nor cancel their booking.", "type": "boolean" }, "pickup_address": { "description": "Car pick-up address.", "properties": { "city": { "description": "City, district, suburb, town, or village.", "maxLength": 5000, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Address line 1 (e.g., street, PO Box, or company name).", "maxLength": 5000, "type": "string" }, "line2": { "description": "Address line 2 (e.g., apartment, suite, unit, or building).", "maxLength": 5000, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "State, county, province, or region.", "maxLength": 5000, "type": "string" } }, "title": "optional_fields_address", "type": "object", "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state" ] }, "pickup_at": { "description": "Car pick-up time. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "pickup_location_name": { "description": "Name of the pickup location.", "maxLength": 38, "type": "string" }, "rate_amount": { "description": "Rental rate.", "type": "integer" }, "rate_interval": { "description": "The frequency at which the rate amount is applied. One of `day`, `week` or `month`", "enum": [ "day", "month", "week" ], "type": "string" }, "renter_name": { "description": "The name of the person or entity renting the car.", "maxLength": 100, "type": "string" }, "return_address": { "description": "Car return address.", "properties": { "city": { "description": "City, district, suburb, town, or village.", "maxLength": 5000, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Address line 1 (e.g., street, PO Box, or company name).", "maxLength": 5000, "type": "string" }, "line2": { "description": "Address line 2 (e.g., apartment, suite, unit, or building).", "maxLength": 5000, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "State, county, province, or region.", "maxLength": 5000, "type": "string" } }, "title": "optional_fields_address", "type": "object", "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state" ] }, "return_at": { "description": "Car return time. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "return_location_name": { "description": "Name of the return location.", "maxLength": 38, "type": "string" }, "tax_exempt": { "description": "Indicates whether the goods or services are tax-exempt or tax is not collected.", "type": "boolean" }, "vehicle_identification_number": { "description": "The vehicle identification number.", "maxLength": 20, "type": "string" } }, "required": [ "booking_number", "days_rented", "pickup_at", "return_at" ], "title": "car_rental", "type": "object", "x-stripeMostCommon": [ "affiliate", "booking_number", "car_class_code", "car_make", "car_model", "company", "customer_service_phone_number", "days_rented", "delivery", "distance", "drivers", "extra_charges", "no_show", "pickup_address", "pickup_at", "pickup_location_name", "rate_amount", "rate_interval", "renter_name", "return_address", "return_at", "return_location_name", "tax_exempt", "vehicle_identification_number" ] }, "customer_reference": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Some customers might be required by their company or organization to provide this information. If so, provide this value. Otherwise you can ignore this field." }, "event_details": { "description": "Event details for this PaymentIntent", "properties": { "access_controlled_venue": { "description": "Indicates if the tickets are digitally checked when entering the venue.", "type": "boolean" }, "address": { "description": "The event location's address.", "properties": { "city": { "description": "City, district, suburb, town, or village.", "maxLength": 5000, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Address line 1 (e.g., street, PO Box, or company name).", "maxLength": 5000, "type": "string" }, "line2": { "description": "Address line 2 (e.g., apartment, suite, unit, or building).", "maxLength": 5000, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "State, county, province, or region.", "maxLength": 5000, "type": "string" } }, "title": "optional_fields_address", "type": "object", "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state" ] }, "affiliate": { "description": "Affiliate details for this purchase.", "properties": { "name": { "description": "The name of the affiliate that originated the purchase.", "maxLength": 5000, "type": "string" } }, "required": [ "name" ], "title": "affiliate", "type": "object", "x-stripeMostCommon": [ "name" ] }, "company": { "description": "The name of the company", "maxLength": 5000, "type": "string" }, "delivery": { "description": "Delivery details for this purchase.", "properties": { "mode": { "description": "The delivery method for the payment", "enum": [ "email", "phone", "pickup", "post" ], "type": "string" }, "recipient": { "description": "Details of the recipient.", "properties": { "email": { "description": "The email of the recipient the ticket is delivered to.", "maxLength": 5000, "type": "string" }, "name": { "description": "The name of the recipient the ticket is delivered to.", "maxLength": 5000, "type": "string" }, "phone": { "description": "The phone number of the recipient the ticket is delivered to.", "maxLength": 5000, "type": "string" } }, "title": "delivery_recipient", "type": "object", "x-stripeMostCommon": [ "email", "name", "phone" ] } }, "title": "delivery", "type": "object", "x-stripeMostCommon": [ "mode", "recipient" ] }, "ends_at": { "description": "Event end time. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "genre": { "description": "Type of the event entertainment (concert, sports event etc)", "maxLength": 5000, "type": "string" }, "name": { "description": "The name of the event.", "maxLength": 5000, "type": "string" }, "starts_at": { "description": "Event start time. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" } }, "required": [ "name" ], "title": "event", "type": "object", "x-stripeMostCommon": [ "access_controlled_venue", "address", "affiliate", "company", "delivery", "ends_at", "genre", "name", "starts_at" ] }, "flight": { "description": "Flight reservation details for this PaymentIntent", "properties": { "affiliate": { "description": "Affiliate details for this purchase.", "properties": { "name": { "description": "The name of the affiliate that originated the purchase.", "maxLength": 5000, "type": "string" } }, "required": [ "name" ], "title": "affiliate", "type": "object", "x-stripeMostCommon": [ "name" ] }, "agency_number": { "description": "The agency number (i.e. International Air Transport Association (IATA) agency number) of the travel agency that made the booking.", "maxLength": 8, "type": "string" }, "carrier": { "description": "The International Air Transport Association (IATA) carrier code of the carrier that issued the ticket.", "maxLength": 3, "type": "string" }, "delivery": { "description": "Delivery details for this purchase.", "properties": { "mode": { "description": "The delivery method for the payment", "enum": [ "email", "phone", "pickup", "post" ], "type": "string" }, "recipient": { "description": "Details of the recipient.", "properties": { "email": { "description": "The email of the recipient the ticket is delivered to.", "maxLength": 5000, "type": "string" }, "name": { "description": "The name of the recipient the ticket is delivered to.", "maxLength": 5000, "type": "string" }, "phone": { "description": "The phone number of the recipient the ticket is delivered to.", "maxLength": 5000, "type": "string" } }, "title": "delivery_recipient", "type": "object", "x-stripeMostCommon": [ "email", "name", "phone" ] } }, "title": "delivery", "type": "object", "x-stripeMostCommon": [ "mode", "recipient" ] }, "passenger_name": { "description": "The name of the person or entity on the reservation.", "maxLength": 26, "type": "string" }, "passengers": { "description": "The details of the passengers in the travel reservation.", "items": { "properties": { "name": { "description": "Full name of the person or entity on the flight reservation.", "maxLength": 5000, "type": "string" } }, "required": [ "name" ], "title": "flight_passenger", "type": "object", "x-stripeMostCommon": [ "name" ] }, "type": "array" }, "segments": { "description": "The individual flight segments associated with the trip.", "items": { "properties": { "amount": { "description": "The flight segment amount.", "type": "integer" }, "arrival_airport": { "description": "The International Air Transport Association (IATA) airport code for the arrival airport.", "maxLength": 3, "type": "string" }, "arrives_at": { "description": "The arrival time for the flight segment. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "carrier": { "description": "The International Air Transport Association (IATA) carrier code of the carrier operating the flight segment.", "maxLength": 2, "type": "string" }, "departs_at": { "description": "The departure time for the flight segment. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "departure_airport": { "description": "The International Air Transport Association (IATA) airport code for the departure airport.", "maxLength": 3, "type": "string" }, "flight_number": { "description": "The flight number associated with the segment", "maxLength": 4, "type": "string" }, "service_class": { "description": "The fare class for the segment.", "enum": [ "business", "economy", "first", "premium_economy" ], "type": "string" } }, "required": [ "departs_at" ], "title": "flight_segment", "type": "object", "x-stripeMostCommon": [ "amount", "arrival_airport", "arrives_at", "carrier", "departs_at", "departure_airport", "flight_number", "service_class" ] }, "type": "array" }, "ticket_number": { "description": "The ticket number associated with the travel reservation.", "maxLength": 14, "type": "string" } }, "required": [ "segments" ], "title": "flight", "type": "object", "x-stripeMostCommon": [ "affiliate", "agency_number", "carrier", "delivery", "passenger_name", "passengers", "segments", "ticket_number" ] }, "lodging": { "description": "Lodging reservation details for this PaymentIntent", "properties": { "address": { "description": "The lodging location's address.", "properties": { "city": { "description": "City, district, suburb, town, or village.", "maxLength": 5000, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Address line 1 (e.g., street, PO Box, or company name).", "maxLength": 5000, "type": "string" }, "line2": { "description": "Address line 2 (e.g., apartment, suite, unit, or building).", "maxLength": 5000, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "State, county, province, or region.", "maxLength": 5000, "type": "string" } }, "title": "optional_fields_address", "type": "object", "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state" ] }, "adults": { "description": "The number of adults on the booking", "type": "integer" }, "affiliate": { "description": "Affiliate details for this purchase.", "properties": { "name": { "description": "The name of the affiliate that originated the purchase.", "maxLength": 5000, "type": "string" } }, "required": [ "name" ], "title": "affiliate", "type": "object", "x-stripeMostCommon": [ "name" ] }, "booking_number": { "description": "The booking number associated with the lodging reservation.", "maxLength": 100, "type": "string" }, "category": { "description": "The lodging category", "enum": [ "hotel", "vacation_rental" ], "type": "string" }, "checkin_at": { "description": "Lodging check-in time. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "checkout_at": { "description": "Lodging check-out time. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "customer_service_phone_number": { "description": "The customer service phone number of the lodging company.", "type": "string" }, "daily_room_rate_amount": { "description": "The daily lodging room rate.", "type": "integer" }, "delivery": { "description": "Delivery details for this purchase.", "properties": { "mode": { "description": "The delivery method for the payment", "enum": [ "email", "phone", "pickup", "post" ], "type": "string" }, "recipient": { "description": "Details of the recipient.", "properties": { "email": { "description": "The email of the recipient the ticket is delivered to.", "maxLength": 5000, "type": "string" }, "name": { "description": "The name of the recipient the ticket is delivered to.", "maxLength": 5000, "type": "string" }, "phone": { "description": "The phone number of the recipient the ticket is delivered to.", "maxLength": 5000, "type": "string" } }, "title": "delivery_recipient", "type": "object", "x-stripeMostCommon": [ "email", "name", "phone" ] } }, "title": "delivery", "type": "object", "x-stripeMostCommon": [ "mode", "recipient" ] }, "extra_charges": { "description": "List of additional charges being billed.", "items": { "enum": [ "gift_shop", "laundry", "mini_bar", "other", "restaurant", "telephone" ], "type": "string" }, "type": "array" }, "fire_safety_act_compliance": { "description": "Indicates whether the lodging location is compliant with the Fire Safety Act.", "type": "boolean" }, "name": { "description": "The name of the lodging location.", "maxLength": 100, "type": "string" }, "no_show": { "description": "Indicates if the customer did not keep their booking while failing to cancel the reservation.", "type": "boolean" }, "number_of_rooms": { "description": "The number of rooms on the booking", "type": "integer" }, "passengers": { "description": "The details of the passengers in the travel reservation", "items": { "properties": { "name": { "description": "Full name of the person or entity on the lodging reservation.", "maxLength": 5000, "type": "string" } }, "required": [ "name" ], "title": "lodging_passenger", "type": "object", "x-stripeMostCommon": [ "name" ] }, "type": "array" }, "property_phone_number": { "description": "The phone number of the lodging location.", "type": "string" }, "room_class": { "description": "The room class for this purchase.", "maxLength": 5000, "type": "string" }, "room_nights": { "description": "The number of room nights", "type": "integer" }, "total_room_tax_amount": { "description": "The total tax amount associating with the room reservation.", "type": "integer" }, "total_tax_amount": { "description": "The total tax amount", "type": "integer" } }, "required": [ "checkin_at", "checkout_at" ], "title": "lodging", "type": "object", "x-stripeMostCommon": [ "address", "adults", "affiliate", "booking_number", "category", "checkin_at", "checkout_at", "customer_service_phone_number", "daily_room_rate_amount", "delivery", "extra_charges", "fire_safety_act_compliance", "name", "no_show", "number_of_rooms", "passengers", "property_phone_number", "room_class", "room_nights", "total_room_tax_amount", "total_tax_amount" ] }, "order_reference": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "A unique value assigned by the business to identify the transaction." }, "subscription": { "description": "Subscription details for this PaymentIntent", "properties": { "affiliate": { "description": "Affiliate details for this purchase.", "properties": { "name": { "description": "The name of the affiliate that originated the purchase.", "maxLength": 5000, "type": "string" } }, "required": [ "name" ], "title": "affiliate", "type": "object", "x-stripeMostCommon": [ "name" ] }, "auto_renewal": { "description": "Info whether the subscription will be auto renewed upon expiry.", "type": "boolean" }, "billing_interval": { "description": "Subscription billing details for this purchase.", "properties": { "count": { "description": "The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.", "type": "integer" }, "interval": { "description": "Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.", "enum": [ "day", "month", "week", "year" ], "type": "string" } }, "required": [ "count", "interval" ], "title": "subscription_billing_interval", "type": "object", "x-stripeMostCommon": [ "count", "interval" ] }, "ends_at": { "description": "Subscription end time. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "name": { "description": "Name of the product on subscription. e.g. Apple Music Subscription", "maxLength": 5000, "type": "string" }, "starts_at": { "description": "Subscription start time. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" } }, "required": [ "name" ], "title": "subscription", "type": "object", "x-stripeMostCommon": [ "affiliate", "auto_renewal", "billing_interval", "ends_at", "name", "starts_at" ] } }, "title": "payment_details", "type": "object", "x-stripeMostCommon": [ "benefit", "car_rental", "car_rental_data", "event_details", "flight", "healthcare", "lodging", "lodging_data", "subscription" ] }, "payment_method": { "description": "ID of the payment method (a PaymentMethod, Card, or [compatible Source](https://stripe.com/docs/payments/payment-methods#compatibility) object) to attach to this PaymentIntent.\n\nIf you don't provide the `payment_method` parameter or the `source` parameter with `confirm=true`, `source` automatically populates with `customer.default_source` to improve migration for users of the Charges API. We recommend that you explicitly provide the `payment_method` moving forward.\nIf the payment method is attached to a Customer, you must also provide the ID of that Customer as the [customer](https://stripe.com/docs/api#create_payment_intent-customer) parameter of this PaymentIntent.\nend", "maxLength": 5000, "type": "string" }, "payment_method_configuration": { "description": "The ID of the [payment method configuration](https://stripe.com/docs/api/payment_method_configurations) to use with this PaymentIntent.", "maxLength": 100, "type": "string" }, "payment_method_data": { "description": "If provided, this hash will be used to create a PaymentMethod. The new PaymentMethod will appear\nin the [payment_method](https://stripe.com/docs/api/payment_intents/object#payment_intent_object-payment_method)\nproperty on the PaymentIntent.", "properties": { "acss_debit": { "description": "If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method.", "properties": { "account_number": { "description": "Customer's bank account number.", "maxLength": 5000, "type": "string" }, "institution_number": { "description": "Institution number of the customer's bank.", "maxLength": 5000, "type": "string" }, "transit_number": { "description": "Transit number of the customer's bank.", "maxLength": 5000, "type": "string" } }, "required": [ "account_number", "institution_number", "transit_number" ], "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "account_number", "financial_connections_account", "institution_number", "transit_number" ] }, "affirm": { "description": "If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method.", "properties": {}, "title": "param", "type": "object" }, "afterpay_clearpay": { "description": "If this is an `AfterpayClearpay` PaymentMethod, this hash contains details about the AfterpayClearpay payment method.", "properties": {}, "title": "param", "type": "object" }, "alipay": { "description": "If this is an `Alipay` PaymentMethod, this hash contains details about the Alipay payment method.", "properties": {}, "title": "param", "type": "object" }, "allow_redisplay": { "description": "This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to `unspecified`.", "enum": [ "always", "limited", "unspecified" ], "type": "string" }, "alma": { "description": "If this is a Alma PaymentMethod, this hash contains details about the Alma payment method.", "properties": {}, "title": "param", "type": "object" }, "amazon_pay": { "description": "If this is a AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method.", "properties": {}, "title": "param", "type": "object" }, "au_becs_debit": { "description": "If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account.", "properties": { "account_number": { "description": "The account number for the bank account.", "maxLength": 5000, "type": "string" }, "bsb_number": { "description": "Bank-State-Branch number of the bank account.", "maxLength": 5000, "type": "string" } }, "required": [ "account_number", "bsb_number" ], "title": "param", "type": "object", "x-stripeMostCommon": [ "account_number", "bsb_number" ] }, "bacs_debit": { "description": "If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.", "properties": { "account_number": { "description": "Account number of the bank account that the funds will be debited from.", "maxLength": 5000, "type": "string" }, "sort_code": { "description": "Sort code of the bank account. (e.g., `10-20-30`)", "maxLength": 5000, "type": "string" } }, "title": "param", "type": "object", "x-stripeMostCommon": [ "account_number", "sort_code" ] }, "bancontact": { "description": "If this is a `bancontact` PaymentMethod, this hash contains details about the Bancontact payment method.", "properties": {}, "title": "param", "type": "object" }, "billie": { "description": "If this is a `billie` PaymentMethod, this hash contains details about the Billie payment method.", "properties": {}, "title": "param", "type": "object" }, "billing_details": { "description": "Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.", "properties": { "address": { "anyOf": [ { "properties": { "city": { "description": "City, district, suburb, town, or village.", "maxLength": 5000, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Address line 1 (e.g., street, PO Box, or company name).", "maxLength": 5000, "type": "string" }, "line2": { "description": "Address line 2 (e.g., apartment, suite, unit, or building).", "maxLength": 5000, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "State, county, province, or region.", "maxLength": 5000, "type": "string" } }, "title": "billing_details_address", "type": "object", "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Billing address." }, "email": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Email address." }, "name": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Full name." }, "phone": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Billing phone number (including extension)." }, "tax_id": { "description": "Taxpayer identification number. Used only for transactions between LATAM buyers and non-LATAM sellers.", "maxLength": 5000, "type": "string" } }, "title": "billing_details_inner_params", "type": "object", "x-stripeMostCommon": [ "address", "email", "name", "phone", "tax_id" ] }, "blik": { "description": "If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.", "properties": {}, "title": "param", "type": "object" }, "boleto": { "description": "If this is a `boleto` PaymentMethod, this hash contains details about the Boleto payment method.", "properties": { "tax_id": { "description": "The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers)", "maxLength": 5000, "type": "string" } }, "required": [ "tax_id" ], "title": "param", "type": "object", "x-stripeMostCommon": [ "tax_id" ] }, "cashapp": { "description": "If this is a `cashapp` PaymentMethod, this hash contains details about the Cash App Pay payment method.", "properties": {}, "title": "param", "type": "object" }, "crypto": { "description": "If this is a Crypto PaymentMethod, this hash contains details about the Crypto payment method.", "properties": {}, "title": "param", "type": "object" }, "customer_balance": { "description": "If this is a `customer_balance` PaymentMethod, this hash contains details about the CustomerBalance payment method.", "properties": {}, "title": "param", "type": "object" }, "eps": { "description": "If this is an `eps` PaymentMethod, this hash contains details about the EPS payment method.", "properties": { "bank": { "description": "The customer's bank.", "enum": [ "arzte_und_apotheker_bank", "austrian_anadi_bank_ag", "bank_austria", "bankhaus_carl_spangler", "bankhaus_schelhammer_und_schattera_ag", "bawag_psk_ag", "bks_bank_ag", "brull_kallmus_bank_ag", "btv_vier_lander_bank", "capital_bank_grawe_gruppe_ag", "deutsche_bank_ag", "dolomitenbank", "easybank_ag", "erste_bank_und_sparkassen", "hypo_alpeadriabank_international_ag", "hypo_bank_burgenland_aktiengesellschaft", "hypo_noe_lb_fur_niederosterreich_u_wien", "hypo_oberosterreich_salzburg_steiermark", "hypo_tirol_bank_ag", "hypo_vorarlberg_bank_ag", "marchfelder_bank", "oberbank_ag", "raiffeisen_bankengruppe_osterreich", "schoellerbank_ag", "sparda_bank_wien", "volksbank_gruppe", "volkskreditbank_ag", "vr_bank_braunau" ], "maxLength": 5000, "type": "string" } }, "title": "param", "type": "object", "x-stripeMostCommon": [ "bank" ] }, "fpx": { "description": "If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method.", "properties": { "account_holder_type": { "description": "Account holder type for FPX transaction", "enum": [ "company", "individual" ], "maxLength": 5000, "type": "string" }, "bank": { "description": "The customer's bank.", "enum": [ "affin_bank", "agrobank", "alliance_bank", "ambank", "bank_islam", "bank_muamalat", "bank_of_china", "bank_rakyat", "bsn", "cimb", "deutsche_bank", "hong_leong_bank", "hsbc", "kfh", "maybank2e", "maybank2u", "ocbc", "pb_enterprise", "public_bank", "rhb", "standard_chartered", "uob" ], "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true } }, "required": [ "bank" ], "title": "param", "type": "object", "x-stripeMostCommon": [ "account_holder_type", "bank" ] }, "giropay": { "description": "If this is a `giropay` PaymentMethod, this hash contains details about the Giropay payment method.", "properties": {}, "title": "param", "type": "object" }, "gopay": { "description": "If this is a Gopay PaymentMethod, this hash contains details about the Gopay payment method.", "properties": {}, "title": "param", "type": "object" }, "grabpay": { "description": "If this is a `grabpay` PaymentMethod, this hash contains details about the GrabPay payment method.", "properties": {}, "title": "param", "type": "object" }, "id_bank_transfer": { "description": "If this is an `IdBankTransfer` PaymentMethod, this hash contains details about the IdBankTransfer payment method.", "properties": { "bank": { "description": "Bank where the account is held.", "enum": [ "bca", "bni", "bri", "cimb", "permata" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "param", "type": "object", "x-stripeMostCommon": [ "bank" ] }, "ideal": { "description": "If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method.", "properties": { "bank": { "description": "The customer's bank. Only use this parameter for existing customers. Don't use it for new customers.", "enum": [ "abn_amro", "asn_bank", "bunq", "buut", "handelsbanken", "ing", "knab", "moneyou", "n26", "nn", "rabobank", "regiobank", "revolut", "sns_bank", "triodos_bank", "van_lanschot", "yoursafe" ], "maxLength": 5000, "type": "string" } }, "title": "param", "type": "object", "x-stripeMostCommon": [ "bank" ] }, "interac_present": { "description": "If this is an `interac_present` PaymentMethod, this hash contains details about the Interac Present payment method.", "properties": {}, "title": "param", "type": "object", "x-stripeMostCommon": [ "device_identifier", "device_type", "emv", "location" ] }, "kakao_pay": { "description": "If this is a `kakao_pay` PaymentMethod, this hash contains details about the Kakao Pay payment method.", "properties": {}, "title": "param", "type": "object" }, "klarna": { "description": "If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method.", "properties": { "dob": { "description": "Customer's date of birth", "properties": { "day": { "description": "The day of birth, between 1 and 31.", "type": "integer" }, "month": { "description": "The month of birth, between 1 and 12.", "type": "integer" }, "year": { "description": "The four-digit year of birth.", "type": "integer" } }, "required": [ "day", "month", "year" ], "title": "date_of_birth", "type": "object", "x-stripeMostCommon": [ "day", "month", "year" ] } }, "title": "param", "type": "object", "x-stripeMostCommon": [ "dob" ] }, "konbini": { "description": "If this is a `konbini` PaymentMethod, this hash contains details about the Konbini payment method.", "properties": {}, "title": "param", "type": "object" }, "kr_card": { "description": "If this is a `kr_card` PaymentMethod, this hash contains details about the Korean Card payment method.", "properties": {}, "title": "param", "type": "object" }, "link": { "description": "If this is an `Link` PaymentMethod, this hash contains details about the Link payment method.", "properties": {}, "title": "param", "type": "object" }, "mb_way": { "description": "If this is a MB WAY PaymentMethod, this hash contains details about the MB WAY payment method.", "properties": {}, "title": "param", "type": "object" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "mobilepay": { "description": "If this is a `mobilepay` PaymentMethod, this hash contains details about the MobilePay payment method.", "properties": {}, "title": "param", "type": "object" }, "multibanco": { "description": "If this is a `multibanco` PaymentMethod, this hash contains details about the Multibanco payment method.", "properties": {}, "title": "param", "type": "object" }, "naver_pay": { "description": "If this is a `naver_pay` PaymentMethod, this hash contains details about the Naver Pay payment method.", "properties": { "funding": { "description": "Whether to use Naver Pay points or a card to fund this transaction. If not provided, this defaults to `card`.", "enum": [ "card", "points" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "param", "type": "object", "x-stripeMostCommon": [ "funding" ] }, "nz_bank_account": { "description": "If this is an nz_bank_account PaymentMethod, this hash contains details about the nz_bank_account payment method.", "properties": { "account_holder_name": { "description": "The name on the bank account. Only required if the account holder name is different from the name of the authorized signatory collected in the PaymentMethod’s billing details.", "maxLength": 5000, "type": "string" }, "account_number": { "description": "The account number for the bank account.", "maxLength": 5000, "type": "string" }, "bank_code": { "description": "The numeric code for the bank account's bank.", "maxLength": 5000, "type": "string" }, "branch_code": { "description": "The numeric code for the bank account's bank branch.", "maxLength": 5000, "type": "string" }, "reference": { "maxLength": 128, "type": "string" }, "suffix": { "description": "The suffix of the bank account number.", "maxLength": 5000, "type": "string" } }, "required": [ "account_number", "bank_code", "branch_code", "suffix" ], "title": "param", "type": "object", "x-stripeMostCommon": [ "account_holder_name", "account_number", "bank_code", "branch_code", "reference", "suffix" ] }, "oxxo": { "description": "If this is an `oxxo` PaymentMethod, this hash contains details about the OXXO payment method.", "properties": {}, "title": "param", "type": "object" }, "p24": { "description": "If this is a `p24` PaymentMethod, this hash contains details about the P24 payment method.", "properties": { "bank": { "description": "The customer's bank.", "enum": [ "alior_bank", "bank_millennium", "bank_nowy_bfg_sa", "bank_pekao_sa", "banki_spbdzielcze", "blik", "bnp_paribas", "boz", "citi_handlowy", "credit_agricole", "envelobank", "etransfer_pocztowy24", "getin_bank", "ideabank", "ing", "inteligo", "mbank_mtransfer", "nest_przelew", "noble_pay", "pbac_z_ipko", "plus_bank", "santander_przelew24", "tmobile_usbugi_bankowe", "toyota_bank", "velobank", "volkswagen_bank" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "param", "type": "object", "x-stripeMostCommon": [ "bank" ] }, "pay_by_bank": { "description": "If this is a `pay_by_bank` PaymentMethod, this hash contains details about the PayByBank payment method.", "properties": {}, "title": "param", "type": "object" }, "payco": { "description": "If this is a `payco` PaymentMethod, this hash contains details about the PAYCO payment method.", "properties": {}, "title": "param", "type": "object" }, "paynow": { "description": "If this is a `paynow` PaymentMethod, this hash contains details about the PayNow payment method.", "properties": {}, "title": "param", "type": "object" }, "paypal": { "description": "If this is a `paypal` PaymentMethod, this hash contains details about the PayPal payment method.", "properties": {}, "title": "param", "type": "object" }, "paypay": { "description": "If this is a `paypay` PaymentMethod, this hash contains details about the PayPay payment method.", "properties": {}, "title": "param", "type": "object" }, "payto": { "description": "If this is a `payto` PaymentMethod, this hash contains details about the PayTo payment method.", "properties": { "account_number": { "description": "The account number for the bank account.", "maxLength": 5000, "type": "string" }, "bsb_number": { "description": "Bank-State-Branch number of the bank account.", "maxLength": 5000, "type": "string" }, "pay_id": { "description": "The PayID alias for the bank account.", "maxLength": 5000, "type": "string" } }, "title": "param", "type": "object", "x-stripeMostCommon": [ "account_number", "bsb_number", "pay_id" ] }, "pix": { "description": "If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.", "properties": {}, "title": "param", "type": "object", "x-stripeMostCommon": [ "tax_id" ] }, "promptpay": { "description": "If this is a `promptpay` PaymentMethod, this hash contains details about the PromptPay payment method.", "properties": {}, "title": "param", "type": "object" }, "qris": { "description": "If this is a `qris` PaymentMethod, this hash contains details about the QRIS payment method.", "properties": {}, "title": "param", "type": "object" }, "radar_options": { "description": "Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.", "properties": { "session": { "description": "A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.", "maxLength": 5000, "type": "string" } }, "title": "radar_options_with_hidden_options", "type": "object", "x-stripeMostCommon": [ "session", "skip_rules" ] }, "rechnung": { "description": "If this is a `rechnung` PaymentMethod, this hash contains details about the Rechnung payment method.", "properties": { "dob": { "description": "Customer's date of birth", "properties": { "day": { "description": "The day of birth, between 1 and 31.", "type": "integer" }, "month": { "description": "The month of birth, between 1 and 12.", "type": "integer" }, "year": { "description": "The four-digit year of birth.", "type": "integer" } }, "required": [ "day", "month", "year" ], "title": "date_of_birth", "type": "object", "x-stripeMostCommon": [ "day", "month", "year" ] } }, "required": [ "dob" ], "title": "param", "type": "object", "x-stripeMostCommon": [ "dob" ] }, "revolut_pay": { "description": "If this is a `revolut_pay` PaymentMethod, this hash contains details about the Revolut Pay payment method.", "properties": {}, "title": "param", "type": "object" }, "samsung_pay": { "description": "If this is a `samsung_pay` PaymentMethod, this hash contains details about the SamsungPay payment method.", "properties": {}, "title": "param", "type": "object" }, "satispay": { "description": "If this is a `satispay` PaymentMethod, this hash contains details about the Satispay payment method.", "properties": {}, "title": "param", "type": "object" }, "sepa_debit": { "description": "If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account.", "properties": { "iban": { "description": "IBAN of the bank account.", "maxLength": 5000, "type": "string" } }, "required": [ "iban" ], "title": "param", "type": "object", "x-stripeMostCommon": [ "iban" ] }, "shopeepay": { "description": "If this is a Shopeepay PaymentMethod, this hash contains details about the Shopeepay payment method.", "properties": {}, "title": "param", "type": "object" }, "sofort": { "description": "If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.", "properties": { "country": { "description": "Two-letter ISO code representing the country the bank account is located in.", "enum": [ "AT", "BE", "DE", "ES", "IT", "NL" ], "type": "string" } }, "required": [ "country" ], "title": "param", "type": "object", "x-stripeMostCommon": [ "country" ] }, "stripe_balance": { "description": "This hash contains details about the Stripe balance payment method.", "properties": { "account": { "description": "The connected account ID whose Stripe balance to use as the source of payment", "maxLength": 5000, "type": "string" }, "source_type": { "description": "The [source_type](https://docs.stripe.com/api/balance/balance_object#balance_object-available-source_types) of the balance", "enum": [ "bank_account", "card", "fpx" ], "type": "string" } }, "title": "param", "type": "object", "x-stripeMostCommon": [ "account", "source_type" ] }, "swish": { "description": "If this is a `swish` PaymentMethod, this hash contains details about the Swish payment method.", "properties": {}, "title": "param", "type": "object" }, "twint": { "description": "If this is a TWINT PaymentMethod, this hash contains details about the TWINT payment method.", "properties": {}, "title": "param", "type": "object" }, "type": { "description": "The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.", "enum": [ "acss_debit", "affirm", "afterpay_clearpay", "alipay", "alma", "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", "billie", "blik", "boleto", "cashapp", "crypto", "customer_balance", "eps", "fpx", "giropay", "gopay", "grabpay", "id_bank_transfer", "ideal", "kakao_pay", "klarna", "konbini", "kr_card", "link", "mb_way", "mobilepay", "multibanco", "naver_pay", "nz_bank_account", "oxxo", "p24", "pay_by_bank", "payco", "paynow", "paypal", "paypay", "payto", "pix", "promptpay", "qris", "rechnung", "revolut_pay", "samsung_pay", "satispay", "sepa_debit", "shopeepay", "sofort", "stripe_balance", "swish", "twint", "us_bank_account", "wechat_pay", "zip" ], "type": "string", "x-stripeBypassValidation": true }, "us_bank_account": { "description": "If this is an `us_bank_account` PaymentMethod, this hash contains details about the US bank account payment method.", "properties": { "account_holder_type": { "description": "Account holder type: individual or company.", "enum": [ "company", "individual" ], "type": "string" }, "account_number": { "description": "Account number of the bank account.", "maxLength": 5000, "type": "string" }, "account_type": { "description": "Account type: checkings or savings. Defaults to checking if omitted.", "enum": [ "checking", "savings" ], "type": "string" }, "financial_connections_account": { "description": "The ID of a Financial Connections Account to use as a payment method.", "maxLength": 5000, "type": "string" }, "routing_number": { "description": "Routing number of the bank account.", "maxLength": 5000, "type": "string" } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "account_holder_type", "account_number", "account_type", "financial_connections_account", "routing_number" ] }, "wechat_pay": { "description": "If this is an `wechat_pay` PaymentMethod, this hash contains details about the wechat_pay payment method.", "properties": {}, "title": "param", "type": "object" }, "zip": { "description": "If this is a `zip` PaymentMethod, this hash contains details about the Zip payment method.", "properties": {}, "title": "param", "type": "object" } }, "required": [ "type" ], "title": "payment_method_data_params", "type": "object", "x-stripeMostCommon": [ "billing_details", "metadata", "type" ] }, "payment_method_options": { "description": "Payment method-specific configuration for this PaymentIntent.", "properties": { "acss_debit": { "anyOf": [ { "properties": { "mandate_options": { "description": "Additional fields for Mandate creation", "properties": { "custom_mandate_url": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "A URL for custom mandate text to render during confirmation step.\nThe URL will be rendered with additional GET parameters `payment_intent` and `payment_intent_client_secret` when confirming a Payment Intent,\nor `setup_intent` and `setup_intent_client_secret` when confirming a Setup Intent." }, "interval_description": { "description": "Description of the mandate interval. Only required if 'payment_schedule' parameter is 'interval' or 'combined'.", "maxLength": 500, "type": "string" }, "payment_schedule": { "description": "Payment schedule for the mandate.", "enum": [ "combined", "interval", "sporadic" ], "type": "string" }, "transaction_type": { "description": "Transaction type of the mandate.", "enum": [ "business", "personal" ], "type": "string" } }, "title": "payment_intent_payment_method_options_mandate_options_param", "type": "object", "x-stripeMostCommon": [ "custom_mandate_url", "interval_description", "payment_schedule", "transaction_type" ] }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "", "none", "off_session", "on_session" ], "type": "string" }, "target_date": { "description": "Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.", "maxLength": 5000, "type": "string" }, "verification_method": { "description": "Bank account verification method.", "enum": [ "automatic", "instant", "microdeposits" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "payment_intent_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "financial_connections", "mandate_options", "setup_future_usage", "target_date", "verification_method" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `acss_debit` PaymentMethod, this sub-hash contains details about the ACSS Debit payment method options." }, "affirm": { "anyOf": [ { "properties": { "capture_method": { "description": "Controls when the funds are captured from the customer's account.\n\nIf provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.", "enum": [ "", "manual" ], "type": "string" }, "preferred_locale": { "description": "Preferred language of the Affirm authorization page that the customer is redirected to.", "maxLength": 30, "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "capture_method", "preferred_locale", "purchase_details", "request_multicapture", "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is an `affirm` PaymentMethod, this sub-hash contains details about the Affirm payment method options." }, "afterpay_clearpay": { "anyOf": [ { "properties": { "capture_method": { "description": "Controls when the funds are captured from the customer's account.\n\nIf provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.", "enum": [ "", "manual" ], "type": "string" }, "reference": { "description": "An internal identifier or reference that this payment corresponds to. You must limit the identifier to 128 characters, and it can only contain letters, numbers, underscores, backslashes, and dashes.\nThis field differs from the statement descriptor and item name.", "maxLength": 128, "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "none" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "capture_method", "reference", "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `afterpay_clearpay` PaymentMethod, this sub-hash contains details about the Afterpay Clearpay payment method options." }, "alipay": { "anyOf": [ { "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "", "none", "off_session" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `alipay` PaymentMethod, this sub-hash contains details about the Alipay payment method options." }, "alma": { "anyOf": [ { "properties": { "capture_method": { "description": "Controls when the funds are captured from the customer's account.\n\nIf provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.", "enum": [ "", "manual" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "capture_method" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `alma` PaymentMethod, this sub-hash contains details about the Alma payment method options." }, "amazon_pay": { "anyOf": [ { "properties": { "capture_method": { "description": "Controls when the funds are captured from the customer's account.\n\nIf provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.", "enum": [ "", "manual" ], "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "", "none", "off_session" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "capture_method", "charge_metadata", "charge_permission_id", "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `amazon_pay` PaymentMethod, this sub-hash contains details about the Amazon Pay payment method options." }, "au_becs_debit": { "anyOf": [ { "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "", "none", "off_session", "on_session" ], "type": "string" }, "target_date": { "description": "Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.", "maxLength": 5000, "type": "string" } }, "title": "payment_intent_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "setup_future_usage", "target_date" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `au_becs_debit` PaymentMethod, this sub-hash contains details about the AU BECS Direct Debit payment method options." }, "bacs_debit": { "anyOf": [ { "properties": { "mandate_options": { "description": "Additional fields for Mandate creation", "properties": { "reference_prefix": { "anyOf": [ { "maxLength": 12, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'." } }, "title": "payment_method_options_mandate_options_param", "type": "object", "x-stripeMostCommon": [ "reference_prefix" ] }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "", "none", "off_session", "on_session" ], "type": "string" }, "target_date": { "description": "Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.", "maxLength": 5000, "type": "string" } }, "title": "payment_intent_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "mandate_options", "setup_future_usage", "target_date" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `bacs_debit` PaymentMethod, this sub-hash contains details about the BACS Debit payment method options." }, "bancontact": { "anyOf": [ { "properties": { "preferred_language": { "description": "Preferred language of the Bancontact authorization page that the customer is redirected to.", "enum": [ "de", "en", "fr", "nl" ], "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "", "none", "off_session" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "preferred_language", "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `bancontact` PaymentMethod, this sub-hash contains details about the Bancontact payment method options." }, "billie": { "anyOf": [ { "properties": { "capture_method": { "description": "Controls when the funds are captured from the customer's account.\n\nIf provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.", "enum": [ "", "manual" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "capture_method", "company_details", "extra_merchant_data_blob", "reference", "request_extended_authorization", "request_multicapture", "request_overcapture" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `billie` PaymentMethod, this sub-hash contains details about the Billie payment method options." }, "blik": { "anyOf": [ { "properties": { "code": { "description": "The 6-digit BLIK code that a customer has generated using their banking application. Can only be set on confirmation.", "maxLength": 5000, "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "", "none" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "payment_intent_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "code", "mandate_options", "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `blik` PaymentMethod, this sub-hash contains details about the BLIK payment method options." }, "boleto": { "anyOf": [ { "properties": { "expires_after_days": { "description": "The number of calendar days before a Boleto voucher expires. For example, if you create a Boleto voucher on Monday and you set expires_after_days to 2, the Boleto invoice will expire on Wednesday at 23:59 America/Sao_Paulo time.", "type": "integer" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "", "none", "off_session", "on_session" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "expires_after_days", "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `boleto` PaymentMethod, this sub-hash contains details about the Boleto payment method options." }, "card": { "anyOf": [ { "properties": { "capture_method": { "description": "Controls when the funds are captured from the customer's account.\n\nIf provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.", "enum": [ "", "manual" ], "type": "string", "x-stripeBypassValidation": true }, "cvc_token": { "description": "A single-use `cvc_update` Token that represents a card CVC value. When provided, the CVC value will be verified during the card payment attempt. This parameter can only be provided during confirmation.", "maxLength": 5000, "type": "string" }, "installments": { "description": "Installment configuration for payments attempted on this PaymentIntent.\n\nFor more information, see the [installments integration guide](https://stripe.com/docs/payments/installments).", "properties": { "enabled": { "description": "Setting to true enables installments for this PaymentIntent.\nThis will cause the response to contain a list of available installment plans.\nSetting to false will prevent any selected plan from applying to a charge.", "type": "boolean" }, "plan": { "anyOf": [ { "properties": { "count": { "description": "For `fixed_count` installment plans, this is required. It represents the number of installment payments your customer will make to their credit card.", "type": "integer" }, "interval": { "description": "For `fixed_count` installment plans, this is required. It represents the interval between installment payments your customer will make to their credit card.\nOne of `month`.", "enum": [ "month" ], "type": "string" }, "type": { "description": "Type of installment plan, one of `fixed_count`, `bonus`, or `revolving`.", "enum": [ "bonus", "fixed_count", "revolving" ], "type": "string" } }, "required": [ "type" ], "title": "installment_plan", "type": "object", "x-stripeMostCommon": [ "count", "interval", "type" ] }, { "enum": [ "" ], "type": "string" } ], "description": "The selected installment plan to use for this payment attempt.\nThis parameter can only be provided during confirmation." } }, "title": "installments_param", "type": "object", "x-stripeMostCommon": [ "enabled", "plan" ] }, "mandate_options": { "description": "Configuration options for setting up an eMandate for cards issued in India.", "properties": { "amount": { "description": "Amount to be charged for future payments.", "type": "integer" }, "amount_type": { "description": "One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.", "enum": [ "fixed", "maximum" ], "type": "string" }, "description": { "description": "A description of the mandate or subscription that is meant to be displayed to the customer.", "maxLength": 200, "type": "string" }, "end_date": { "description": "End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.", "format": "unix-time", "type": "integer" }, "interval": { "description": "Specifies payment frequency. One of `day`, `week`, `month`, `year`, or `sporadic`.", "enum": [ "day", "month", "sporadic", "week", "year" ], "type": "string" }, "interval_count": { "description": "The number of intervals between payments. For example, `interval=month` and `interval_count=3` indicates one payment every three months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). This parameter is optional when `interval=sporadic`.", "type": "integer" }, "reference": { "description": "Unique identifier for the mandate or subscription.", "maxLength": 80, "type": "string" }, "start_date": { "description": "Start date of the mandate or subscription. Start date should not be lesser than yesterday.", "format": "unix-time", "type": "integer" }, "supported_types": { "description": "Specifies the type of mandates supported. Possible values are `india`.", "items": { "enum": [ "india" ], "type": "string" }, "type": "array" } }, "required": [ "amount", "amount_type", "interval", "reference", "start_date" ], "title": "mandate_options_param", "type": "object", "x-stripeMostCommon": [ "amount", "amount_type", "description", "end_date", "interval", "interval_count", "reference", "start_date", "supported_types" ] }, "moto": { "description": "When specified, this parameter indicates that a transaction will be marked\nas MOTO (Mail Order Telephone Order) and thus out of scope for SCA. This\nparameter can only be provided during confirmation.", "type": "boolean" }, "network": { "description": "Selected network to process this PaymentIntent on. Depends on the available networks of the card attached to the PaymentIntent. Can be only set confirm-time.", "enum": [ "amex", "cartes_bancaires", "diners", "discover", "eftpos_au", "girocard", "interac", "jcb", "link", "mastercard", "unionpay", "unknown", "visa" ], "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true }, "request_decremental_authorization": { "description": "Request ability to [decrement the authorization](https://stripe.com/docs/payments/decremental-authorization) for this PaymentIntent.", "enum": [ "if_available", "never" ], "type": "string" }, "request_extended_authorization": { "description": "Request ability to [capture beyond the standard authorization validity window](https://stripe.com/docs/payments/extended-authorization) for this PaymentIntent.", "enum": [ "if_available", "never" ], "type": "string" }, "request_incremental_authorization": { "description": "Request ability to [increment the authorization](https://stripe.com/docs/payments/incremental-authorization) for this PaymentIntent.", "enum": [ "if_available", "never" ], "type": "string" }, "request_multicapture": { "description": "Request ability to make [multiple captures](https://stripe.com/docs/payments/multicapture) for this PaymentIntent.", "enum": [ "if_available", "never" ], "type": "string" }, "request_overcapture": { "description": "Request ability to [overcapture](https://stripe.com/docs/payments/overcapture) for this PaymentIntent.", "enum": [ "if_available", "never" ], "type": "string" }, "request_partial_authorization": { "description": "Request partial authorization on this PaymentIntent.", "enum": [ "if_available", "never" ], "type": "string" }, "request_three_d_secure": { "description": "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.", "enum": [ "any", "automatic", "challenge" ], "type": "string", "x-stripeBypassValidation": true }, "require_cvc_recollection": { "description": "When enabled, using a card that is attached to a customer will require the CVC to be provided again (i.e. using the cvc_token parameter).", "type": "boolean" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "", "none", "off_session", "on_session" ], "type": "string" }, "statement_descriptor_suffix_kana": { "anyOf": [ { "maxLength": 22, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Provides information about a card payment that customers see on their statements. Concatenated with the Kana prefix (shortened Kana descriptor) or Kana statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 22 characters." }, "statement_descriptor_suffix_kanji": { "anyOf": [ { "maxLength": 17, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Provides information about a card payment that customers see on their statements. Concatenated with the Kanji prefix (shortened Kanji descriptor) or Kanji statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 17 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 17 characters." }, "statement_details": { "anyOf": [ { "properties": { "address": { "description": "Please pass in an address that is within your Stripe user account country", "properties": { "city": { "description": "City, district, suburb, town, or village.", "maxLength": 5000, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Address line 1 (e.g., street, PO Box, or company name).", "maxLength": 5000, "type": "string" }, "line2": { "description": "Address line 2 (e.g., apartment, suite, unit, or building).", "maxLength": 5000, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "State, county, province, or region.", "maxLength": 5000, "type": "string" } }, "title": "statement_details_address_param", "type": "object", "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state" ] }, "phone": { "description": "Phone number (e.g., a toll-free number that customers can call)", "maxLength": 5000, "type": "string" } }, "title": "statement_details_param", "type": "object", "x-stripeMostCommon": [ "address", "phone" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Statement details for this payment intent. You can use this to override the merchant details shown on your customers' statements." }, "three_d_secure": { "description": "If 3D Secure authentication was performed with a third-party provider,\nthe authentication details to use for this payment.", "properties": { "ares_trans_status": { "description": "The `transStatus` returned from the card Issuer’s ACS in the ARes.", "enum": [ "A", "C", "I", "N", "R", "U", "Y" ], "type": "string" }, "cryptogram": { "description": "The cryptogram, also known as the \"authentication value\" (AAV, CAVV or\nAEVV). This value is 20 bytes, base64-encoded into a 28-character string.\n(Most 3D Secure providers will return the base64-encoded version, which\nis what you should specify here.)", "maxLength": 5000, "type": "string" }, "electronic_commerce_indicator": { "description": "The Electronic Commerce Indicator (ECI) is returned by your 3D Secure\nprovider and indicates what degree of authentication was performed.", "enum": [ "01", "02", "05", "06", "07" ], "type": "string", "x-stripeBypassValidation": true }, "exemption_indicator": { "description": "The exemption requested via 3DS and accepted by the issuer at authentication time.", "enum": [ "low_risk", "none" ], "type": "string" }, "network_options": { "description": "Network specific 3DS fields. Network specific arguments require an\nexplicit card brand choice. The parameter `payment_method_options.card.network``\nmust be populated accordingly", "properties": { "cartes_bancaires": { "description": "Cartes Bancaires-specific 3DS fields.", "properties": { "cb_avalgo": { "description": "The cryptogram calculation algorithm used by the card Issuer's ACS\nto calculate the Authentication cryptogram. Also known as `cavvAlgorithm`.\nmessageExtension: CB-AVALGO", "enum": [ "0", "1", "2", "3", "4", "A" ], "type": "string" }, "cb_exemption": { "description": "The exemption indicator returned from Cartes Bancaires in the ARes.\nmessage extension: CB-EXEMPTION; string (4 characters)\nThis is a 3 byte bitmap (low significant byte first and most significant\nbit first) that has been Base64 encoded", "maxLength": 4, "type": "string" }, "cb_score": { "description": "The risk score returned from Cartes Bancaires in the ARes.\nmessage extension: CB-SCORE; numeric value 0-99", "type": "integer" } }, "required": [ "cb_avalgo" ], "title": "cartes_bancaires_network_options_param", "type": "object", "x-stripeMostCommon": [ "cb_avalgo", "cb_exemption", "cb_score" ] } }, "title": "network_options_param", "type": "object", "x-stripeMostCommon": [ "cartes_bancaires" ] }, "requestor_challenge_indicator": { "description": "The challenge indicator (`threeDSRequestorChallengeInd`) which was requested in the\nAReq sent to the card Issuer's ACS. A string containing 2 digits from 01-99.", "maxLength": 2, "type": "string" }, "transaction_id": { "description": "For 3D Secure 1, the XID. For 3D Secure 2, the Directory Server\nTransaction ID (dsTransID).", "maxLength": 5000, "type": "string" }, "version": { "description": "The version of 3D Secure that was performed.", "enum": [ "1.0.2", "2.1.0", "2.2.0" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "cryptogram", "transaction_id", "version" ], "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "ares_trans_status", "cryptogram", "electronic_commerce_indicator", "exemption_indicator", "network_options", "requestor_challenge_indicator", "transaction_id", "version" ] } }, "title": "payment_intent_param", "type": "object", "x-stripeMostCommon": [ "allow_partial_amount", "buy_now_pay_later_options", "capture_delay_days", "capture_method", "commerce_type", "cvc_token", "installments", "mandate_options", "mcc", "mit_exemption", "moto", "network", "network_options", "network_token", "recipient_details", "request_decremental_authorization", "request_extended_authorization", "request_flexible_extended_authorization", "request_incremental_authorization", "request_incremental_authorization_support", "request_multicapture", "request_overcapture", "request_partial_authorization", "request_reauthorization", "request_three_d_secure", "require_cvc_recollection", "sender_details", "setup_future_usage", "statement_descriptor_suffix_kana", "statement_descriptor_suffix_kanji", "statement_details", "stored_credential_transaction_type", "stored_credential_usage", "three_d_secure", "transaction_purpose" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Configuration for any card payments attempted on this PaymentIntent." }, "card_present": { "anyOf": [ { "properties": { "request_extended_authorization": { "description": "Request ability to capture this payment beyond the standard [authorization validity window](https://stripe.com/docs/terminal/features/extended-authorizations#authorization-validity)", "type": "boolean" }, "request_incremental_authorization_support": { "description": "Request ability to [increment](https://stripe.com/docs/terminal/features/incremental-authorizations) this PaymentIntent if the combination of MCC and card brand is eligible. Check [incremental_authorization_supported](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported) in the [Confirm](https://stripe.com/docs/api/payment_intents/confirm) response to verify support.", "type": "boolean" }, "routing": { "description": "Network routing priority on co-branded EMV cards supporting domestic debit and international card schemes.", "properties": { "requested_priority": { "description": "Routing requested priority", "enum": [ "domestic", "international" ], "type": "string" } }, "title": "routing_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "requested_priority" ] } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "buy_now_pay_later_options", "capture_method", "request_extended_authorization", "request_flexible_extended_authorization", "request_incremental_authorization", "request_incremental_authorization_support", "request_partial_authorization", "request_reauthorization", "routing" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `card_present` PaymentMethod, this sub-hash contains details about the Card Present payment method options." }, "cashapp": { "anyOf": [ { "properties": { "capture_method": { "description": "Controls when the funds are captured from the customer's account.\n\nIf provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.", "enum": [ "", "manual" ], "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "", "none", "off_session", "on_session" ], "type": "string" } }, "title": "payment_intent_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "capture_method", "request_incremental_authorization", "restricted_transaction_categories", "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `cashapp` PaymentMethod, this sub-hash contains details about the Cash App Pay payment method options." }, "crypto": { "anyOf": [ { "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "none" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "mode", "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `crypto` PaymentMethod, this sub-hash contains details about the Crypto payment method options." }, "customer_balance": { "anyOf": [ { "properties": { "bank_transfer": { "description": "Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`.", "properties": { "eu_bank_transfer": { "description": "Configuration for the eu_bank_transfer funding type.", "properties": { "country": { "description": "The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`.", "maxLength": 5000, "type": "string" } }, "required": [ "country" ], "title": "eu_bank_transfer_params", "type": "object", "x-stripeMostCommon": [ "country" ] }, "requested_address_types": { "description": "List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.\n\nPermitted values include: `sort_code`, `zengin`, `iban`, or `spei`.", "items": { "enum": [ "aba", "iban", "sepa", "sort_code", "spei", "swift", "zengin" ], "type": "string", "x-stripeBypassValidation": true }, "type": "array" }, "type": { "description": "The list of bank transfer types that this PaymentIntent is allowed to use for funding Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.", "enum": [ "eu_bank_transfer", "gb_bank_transfer", "jp_bank_transfer", "mx_bank_transfer", "us_bank_transfer" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "bank_transfer_param", "type": "object", "x-stripeMostCommon": [ "eu_bank_transfer", "id_bank_account", "id_bank_transfer", "requested_address_types", "type" ] }, "funding_type": { "description": "The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.", "enum": [ "bank_transfer" ], "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "none" ], "type": "string" } }, "title": "payment_intent_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "bank_transfer", "funding_type", "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `customer balance` PaymentMethod, this sub-hash contains details about the customer balance payment method options." }, "eps": { "anyOf": [ { "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "none" ], "type": "string" } }, "title": "payment_intent_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `eps` PaymentMethod, this sub-hash contains details about the EPS payment method options." }, "fpx": { "anyOf": [ { "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `fpx` PaymentMethod, this sub-hash contains details about the FPX payment method options." }, "giropay": { "anyOf": [ { "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `giropay` PaymentMethod, this sub-hash contains details about the Giropay payment method options." }, "gopay": { "anyOf": [ { "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "none", "off_session" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `gopay` PaymentMethod, this sub-hash contains details about the Gopay payment method options." }, "grabpay": { "anyOf": [ { "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `grabpay` PaymentMethod, this sub-hash contains details about the Grabpay payment method options." }, "id_bank_transfer": { "anyOf": [ { "properties": { "expires_after": { "description": "The UNIX timestamp until which the virtual bank account is valid. Permitted range is from 5 minutes from now until 31 days from now. If unset, it defaults to 3 days from now.", "type": "integer" }, "expires_at": { "description": "The UNIX timestamp until which the virtual bank account is valid. Permitted range is from now until 30 days from now. If unset, it defaults to 1 days from now.", "format": "unix-time", "type": "integer" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "none" ], "type": "string" } }, "title": "payment_intent_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "expires_after", "expires_at", "on_existing_payment_intent", "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `id_bank_transfer` PaymentMethod, this sub-hash contains details about the Indonesia Bank Transfer payment method options." }, "ideal": { "anyOf": [ { "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "", "none", "off_session" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `ideal` PaymentMethod, this sub-hash contains details about the Ideal payment method options." }, "interac_present": { "anyOf": [ { "properties": {}, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `interac_present` PaymentMethod, this sub-hash contains details about the Card Present payment method options." }, "kakao_pay": { "anyOf": [ { "properties": { "capture_method": { "description": "Controls when the funds are captured from the customer's account.\n\nIf provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.", "enum": [ "", "manual" ], "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "", "none", "off_session" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "capture_method", "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `kakao_pay` PaymentMethod, this sub-hash contains details about the Kakao Pay payment method options." }, "klarna": { "anyOf": [ { "properties": { "capture_method": { "description": "Controls when the funds are captured from the customer's account.\n\nIf provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.", "enum": [ "", "manual" ], "type": "string" }, "on_demand": { "description": "On-demand details if setting up or charging an on-demand payment.", "properties": { "average_amount": { "description": "Your average amount value. You can use a value across your customer base, or segment based on customer type, country, etc.", "type": "integer" }, "maximum_amount": { "description": "The maximum value you may charge a customer per purchase. You can use a value across your customer base, or segment based on customer type, country, etc.", "type": "integer" }, "minimum_amount": { "description": "The lowest or minimum value you may charge a customer per purchase. You can use a value across your customer base, or segment based on customer type, country, etc.", "type": "integer" }, "purchase_interval": { "description": "Interval at which the customer is making purchases", "enum": [ "day", "month", "week", "year" ], "type": "string" }, "purchase_interval_count": { "description": "The number of `purchase_interval` between charges", "type": "integer" } }, "title": "on_demand_param", "type": "object", "x-stripeMostCommon": [ "average_amount", "maximum_amount", "minimum_amount", "purchase_interval", "purchase_interval_count" ] }, "preferred_locale": { "description": "Preferred language of the Klarna authorization page that the customer is redirected to", "enum": [ "cs-CZ", "da-DK", "de-AT", "de-CH", "de-DE", "el-GR", "en-AT", "en-AU", "en-BE", "en-CA", "en-CH", "en-CZ", "en-DE", "en-DK", "en-ES", "en-FI", "en-FR", "en-GB", "en-GR", "en-IE", "en-IT", "en-NL", "en-NO", "en-NZ", "en-PL", "en-PT", "en-RO", "en-SE", "en-US", "es-ES", "es-US", "fi-FI", "fr-BE", "fr-CA", "fr-CH", "fr-FR", "it-CH", "it-IT", "nb-NO", "nl-BE", "nl-NL", "pl-PL", "pt-PT", "ro-RO", "sv-FI", "sv-SE" ], "type": "string", "x-stripeBypassValidation": true }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "none", "off_session", "on_session" ], "type": "string" }, "subscriptions": { "anyOf": [ { "items": { "properties": { "interval": { "description": "Unit of time between subscription charges.", "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "description": "The number of intervals (specified in the `interval` attribute) between subscription charges. For example, `interval=month` and `interval_count=3` charges every 3 months.", "type": "integer" }, "name": { "description": "Name for subscription.", "maxLength": 255, "type": "string" }, "next_billing": { "description": "Describes the upcoming charge for this subscription.", "properties": { "amount": { "description": "The amount of the next charge for the subscription.", "type": "integer" }, "date": { "description": "The date of the next charge for the subscription in YYYY-MM-DD format.", "maxLength": 5000, "type": "string" } }, "required": [ "amount", "date" ], "title": "subscription_next_billing_param", "type": "object", "x-stripeMostCommon": [ "amount", "date" ] }, "reference": { "description": "A non-customer-facing reference to correlate subscription charges in the Klarna app. Use a value that persists across subscription charges.", "maxLength": 255, "type": "string" } }, "required": [ "interval", "reference" ], "title": "subscription_param", "type": "object", "x-stripeMostCommon": [ "interval", "interval_count", "name", "next_billing", "reference" ] }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "Subscription details if setting up or charging a subscription." } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "capture_method", "extra_merchant_data_blob", "interoperability_token", "line_items", "on_demand", "partner_confirmation_token", "payment_details", "payment_method_category", "payment_option_id", "preferred_locale", "request_incremental_authorization", "request_multicapture", "setup_future_usage", "subscriptions", "supplementary_purchase_data" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `klarna` PaymentMethod, this sub-hash contains details about the Klarna payment method options." }, "konbini": { "anyOf": [ { "properties": { "confirmation_number": { "anyOf": [ { "maxLength": 11, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "An optional 10 to 11 digit numeric-only string determining the confirmation code at applicable convenience stores. Must not consist of only zeroes and could be rejected in case of insufficient uniqueness. We recommend to use the customer's phone number." }, "expires_after_days": { "anyOf": [ { "type": "integer" }, { "enum": [ "" ], "type": "string" } ], "description": "The number of calendar days (between 1 and 60) after which Konbini payment instructions will expire. For example, if a PaymentIntent is confirmed with Konbini and `expires_after_days` set to 2 on Monday JST, the instructions will expire on Wednesday 23:59:59 JST. Defaults to 3 days." }, "expires_at": { "anyOf": [ { "format": "unix-time", "type": "integer" }, { "enum": [ "" ], "type": "string" } ], "description": "The timestamp at which the Konbini payment instructions will expire. Only one of `expires_after_days` or `expires_at` may be set." }, "product_description": { "anyOf": [ { "maxLength": 22, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "A product descriptor of up to 22 characters, which will appear to customers at the convenience store." }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "confirmation_number", "expires_after_days", "expires_at", "fee_amount", "product_description", "setup_future_usage", "tax_amount" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `konbini` PaymentMethod, this sub-hash contains details about the Konbini payment method options." }, "kr_card": { "anyOf": [ { "properties": { "capture_method": { "description": "Controls when the funds are captured from the customer's account.\n\nIf provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.", "enum": [ "", "manual" ], "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "", "none", "off_session" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "capture_method", "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `kr_card` PaymentMethod, this sub-hash contains details about the KR Card payment method options." }, "link": { "anyOf": [ { "properties": { "capture_method": { "description": "Controls when the funds are captured from the customer's account.\n\nIf provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.", "enum": [ "", "manual" ], "type": "string" }, "persistent_token": { "description": "[Deprecated] This is a legacy parameter that no longer has any function.", "maxLength": 5000, "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "", "none", "off_session" ], "type": "string" } }, "title": "payment_intent_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "capture_method", "persistent_token", "request_multicapture", "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `link` PaymentMethod, this sub-hash contains details about the Link payment method options." }, "mb_way": { "anyOf": [ { "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `mb_way` PaymentMethod, this sub-hash contains details about the MB WAY payment method options." }, "mobilepay": { "anyOf": [ { "properties": { "capture_method": { "description": "Controls when the funds are captured from the customer's account.\n\nIf provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.", "enum": [ "", "manual" ], "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "capture_method", "reference", "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `MobilePay` PaymentMethod, this sub-hash contains details about the MobilePay payment method options." }, "multibanco": { "anyOf": [ { "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `multibanco` PaymentMethod, this sub-hash contains details about the Multibanco payment method options." }, "naver_pay": { "anyOf": [ { "properties": { "capture_method": { "description": "Controls when the funds are captured from the customer's account.\n\nIf provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.", "enum": [ "", "manual" ], "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "", "none", "off_session" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "capture_method", "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `naver_pay` PaymentMethod, this sub-hash contains details about the Naver Pay payment method options." }, "nz_bank_account": { "anyOf": [ { "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "", "none", "off_session", "on_session" ], "type": "string" }, "target_date": { "description": "Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.", "maxLength": 5000, "type": "string" } }, "title": "payment_intent_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "setup_future_usage", "target_date" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `nz_bank_account` PaymentMethod, this sub-hash contains details about the NZ BECS Direct Debit payment method options." }, "oxxo": { "anyOf": [ { "properties": { "expires_after_days": { "description": "The number of calendar days before an OXXO voucher expires. For example, if you create an OXXO voucher on Monday and you set expires_after_days to 2, the OXXO invoice will expire on Wednesday at 23:59 America/Mexico_City time.", "type": "integer" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "expires_after_days", "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `oxxo` PaymentMethod, this sub-hash contains details about the OXXO payment method options." }, "p24": { "anyOf": [ { "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "none" ], "type": "string" }, "tos_shown_and_accepted": { "description": "Confirm that the payer has accepted the P24 terms and conditions.", "type": "boolean" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "installments", "setup_future_usage", "tos_shown_and_accepted" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `p24` PaymentMethod, this sub-hash contains details about the Przelewy24 payment method options." }, "pay_by_bank": { "anyOf": [ { "properties": {}, "title": "payment_intent_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "allow_delayed_notification", "country", "locale", "statement_descriptor" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `pay_by_bank` PaymentMethod, this sub-hash contains details about the PayByBank payment method options." }, "payco": { "anyOf": [ { "properties": { "capture_method": { "description": "Controls when the funds are captured from the customer's account.\n\nIf provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.", "enum": [ "", "manual" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "capture_method" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `payco` PaymentMethod, this sub-hash contains details about the PAYCO payment method options." }, "paynow": { "anyOf": [ { "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `paynow` PaymentMethod, this sub-hash contains details about the PayNow payment method options." }, "paypal": { "anyOf": [ { "properties": { "capture_method": { "description": "Controls when the funds will be captured from the customer's account.", "enum": [ "", "manual" ], "type": "string" }, "line_items": { "description": "The line items purchased by the customer.", "items": { "properties": { "category": { "description": "Type of the line item.", "enum": [ "digital_goods", "donation", "physical_goods" ], "type": "string" }, "description": { "description": "Description of the line item.", "maxLength": 127, "type": "string" }, "name": { "description": "Descriptive name of the line item.", "maxLength": 127, "type": "string" }, "quantity": { "description": "Quantity of the line item. Must be a positive number.", "type": "integer" }, "sku": { "description": "Client facing stock keeping unit, article number or similar.", "maxLength": 127, "type": "string" }, "sold_by": { "description": "The Stripe account ID of the connected account that sells the item.", "maxLength": 5000, "type": "string" }, "tax": { "description": "The tax information for the line item.", "properties": { "amount": { "description": "The tax for a single unit of the line item in minor units. Cannot be a negative number.", "type": "integer" }, "behavior": { "description": "The tax behavior for the line item.", "enum": [ "exclusive", "inclusive" ], "type": "string" } }, "required": [ "amount", "behavior" ], "title": "line_item_tax_param", "type": "object", "x-stripeMostCommon": [ "amount", "behavior" ] }, "unit_amount": { "description": "Price for a single unit of the line item in minor units. Cannot be a negative number.", "type": "integer" } }, "required": [ "name", "quantity", "unit_amount" ], "title": "line_item_param", "type": "object", "x-stripeMostCommon": [ "category", "description", "name", "quantity", "sku", "sold_by", "tax", "unit_amount" ] }, "type": "array" }, "preferred_locale": { "description": "[Preferred locale](https://stripe.com/docs/payments/paypal/supported-locales) of the PayPal checkout page that the customer is redirected to.", "enum": [ "cs-CZ", "da-DK", "de-AT", "de-DE", "de-LU", "el-GR", "en-GB", "en-US", "es-ES", "fi-FI", "fr-BE", "fr-FR", "fr-LU", "hu-HU", "it-IT", "nl-BE", "nl-NL", "pl-PL", "pt-PT", "sk-SK", "sv-SE" ], "type": "string", "x-stripeBypassValidation": true }, "reference": { "description": "A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID.", "maxLength": 127, "type": "string" }, "reference_id": { "description": "A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID.", "maxLength": 127, "type": "string" }, "risk_correlation_id": { "description": "The risk correlation ID for an on-session payment using a saved PayPal payment method.", "maxLength": 32, "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "", "none", "off_session" ], "type": "string" }, "subsellers": { "description": "The Stripe connected account IDs of the sellers on the platform for this transaction (optional). Only allowed when [separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers) are used.", "items": { "maxLength": 32, "type": "string" }, "type": "array" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "allow_delayed_notification", "capture_method", "line_items", "preferred_locale", "reference", "reference_id", "risk_correlation_id", "setup_future_usage", "subsellers" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `paypal` PaymentMethod, this sub-hash contains details about the PayPal payment method options." }, "paypay": { "anyOf": [ { "properties": { "capture_method": { "description": "Controls when the funds are captured from the customer's account.\n\nIf provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.", "enum": [ "", "manual" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "capture_method" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `paypay` PaymentMethod, this sub-hash contains details about the PayPay payment method options." }, "payto": { "anyOf": [ { "properties": { "mandate_options": { "description": "Additional fields for Mandate creation. Only `purpose` field is configurable for PayTo PaymentIntent with `setup_future_usage=none`. Other fields are only applicable to PayTo PaymentIntent with `setup_future_usage=off_session`", "properties": { "amount": { "description": "Amount that will be collected. It is required when `amount_type` is `fixed`.", "type": "integer" }, "amount_type": { "description": "The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively.", "enum": [ "fixed", "maximum" ], "type": "string" }, "end_date": { "description": "Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.", "maxLength": 5000, "type": "string" }, "payment_schedule": { "description": "The periodicity at which payments will be collected.", "enum": [ "adhoc", "annual", "daily", "fortnightly", "monthly", "quarterly", "semi_annual", "weekly" ], "type": "string" }, "payments_per_period": { "description": "The number of payments that will be made during a payment period. Defaults to 1 except for when `payment_schedule` is `adhoc`. In that case, it defaults to no limit.", "type": "integer" }, "purpose": { "description": "The purpose for which payments are made. Defaults to retail.", "enum": [ "dependant_support", "government", "loan", "mortgage", "other", "pension", "personal", "retail", "salary", "tax", "utility" ], "type": "string" } }, "title": "payment_intent_payment_method_options_mandate_options_param", "type": "object", "x-stripeMostCommon": [ "amount", "amount_type", "end_date", "payment_schedule", "payments_per_period", "purpose" ] }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "", "none", "off_session" ], "type": "string" } }, "title": "payment_intent_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "mandate_options", "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `payto` PaymentMethod, this sub-hash contains details about the PayTo payment method options." }, "pix": { "anyOf": [ { "properties": { "amount_includes_iof": { "description": "Determines if the amount includes the IOF tax. Defaults to `never`.", "enum": [ "always", "never" ], "type": "string" }, "expires_after_seconds": { "description": "The number of seconds (between 10 and 1209600) after which Pix payment will expire. Defaults to 86400 seconds.", "type": "integer" }, "expires_at": { "description": "The timestamp at which the Pix expires (between 10 and 1209600 seconds in the future). Defaults to 1 day in the future.", "format": "unix-time", "type": "integer" }, "mandate_options": { "description": "Additional fields for mandate creation. Only applicable when `setup_future_usage=off_session`.", "properties": { "amount": { "description": "Amount to be charged for future payments. Required when `amount_type=fixed`. If not provided for `amount_type=maximum`, defaults to 40000.", "type": "integer" }, "amount_includes_iof": { "description": "Determines if the amount includes the IOF tax. Defaults to `never`.", "enum": [ "always", "never" ], "type": "string" }, "amount_type": { "description": "Type of amount. Defaults to `maximum`.", "enum": [ "fixed", "maximum" ], "type": "string" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Only `brl` is supported currently.", "format": "currency", "type": "string" }, "end_date": { "description": "Date when the mandate expires and no further payments will be charged, in `YYYY-MM-DD`. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.", "maxLength": 5000, "type": "string" }, "payment_schedule": { "description": "Schedule at which the future payments will be charged. Defaults to `weekly`.", "enum": [ "halfyearly", "monthly", "quarterly", "weekly", "yearly" ], "type": "string" }, "reference": { "description": "Subscription name displayed to buyers in their bank app. Defaults to the displayable business name.", "maxLength": 35, "type": "string" }, "start_date": { "description": "Start date of the mandate, in `YYYY-MM-DD`. Start date should be at least 3 days in the future. Defaults to 3 days after the current date.", "maxLength": 5000, "type": "string" } }, "title": "payment_method_options_mandate_options_param", "type": "object", "x-stripeMostCommon": [ "amount", "amount_includes_iof", "amount_type", "currency", "end_date", "payment_schedule", "reference", "start_date" ] }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "none", "off_session" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "amount_includes_iof", "expires_after_seconds", "expires_at", "mandate_options", "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `pix` PaymentMethod, this sub-hash contains details about the Pix payment method options." }, "promptpay": { "anyOf": [ { "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `promptpay` PaymentMethod, this sub-hash contains details about the PromptPay payment method options." }, "qris": { "anyOf": [ { "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `qris` PaymentMethod, this sub-hash contains details about the QRIS payment method options." }, "rechnung": { "anyOf": [ { "properties": {}, "title": "payment_intent_payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `rechnung` PaymentMethod, this sub-hash contains details about the Rechnung payment method options." }, "revolut_pay": { "anyOf": [ { "properties": { "capture_method": { "description": "Controls when the funds are captured from the customer's account.\n\nIf provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.", "enum": [ "", "manual" ], "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "", "none", "off_session" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "capture_method", "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `revolut_pay` PaymentMethod, this sub-hash contains details about the Revolut Pay payment method options." }, "samsung_pay": { "anyOf": [ { "properties": { "capture_method": { "description": "Controls when the funds are captured from the customer's account.\n\nIf provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.", "enum": [ "", "manual" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "capture_method" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `samsung_pay` PaymentMethod, this sub-hash contains details about the Samsung Pay payment method options." }, "satispay": { "anyOf": [ { "properties": { "capture_method": { "description": "Controls when the funds are captured from the customer's account.\n\nIf provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.", "enum": [ "", "manual" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "capture_method", "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `satispay` PaymentMethod, this sub-hash contains details about the Satispay payment method options." }, "sepa_debit": { "anyOf": [ { "properties": { "mandate_options": { "description": "Additional fields for Mandate creation", "properties": { "reference_prefix": { "anyOf": [ { "maxLength": 12, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'." } }, "title": "payment_method_options_mandate_options_param", "type": "object", "x-stripeMostCommon": [ "reference", "reference_prefix" ] }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "", "none", "off_session", "on_session" ], "type": "string" }, "target_date": { "description": "Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.", "maxLength": 5000, "type": "string" } }, "title": "payment_intent_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "mandate_options", "setup_future_usage", "target_date", "verification_method" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `sepa_debit` PaymentIntent, this sub-hash contains details about the SEPA Debit payment method options." }, "shopeepay": { "anyOf": [ { "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `shopeepay` PaymentMethod, this sub-hash contains details about the ShopeePay payment method options." }, "sofort": { "anyOf": [ { "properties": { "preferred_language": { "description": "Language shown to the payer on redirect.", "enum": [ "", "de", "en", "es", "fr", "it", "nl", "pl" ], "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "", "none", "off_session" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "preferred_language", "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `sofort` PaymentMethod, this sub-hash contains details about the SOFORT payment method options." }, "stripe_balance": { "anyOf": [ { "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "", "none", "off_session" ], "type": "string" } }, "title": "payment_intent_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `stripe_balance` PaymentMethod, this sub-hash contains details about the Stripe Balance payment method options." }, "swish": { "anyOf": [ { "properties": { "reference": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "A reference for this payment to be displayed in the Swish app." }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "none" ], "type": "string" } }, "title": "payment_intent_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "authorization_method", "reference", "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `Swish` PaymentMethod, this sub-hash contains details about the Swish payment method options." }, "twint": { "anyOf": [ { "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `twint` PaymentMethod, this sub-hash contains details about the TWINT payment method options." }, "us_bank_account": { "anyOf": [ { "properties": { "financial_connections": { "description": "Additional fields for Financial Connections Session creation", "properties": { "filters": { "description": "Provide filters for the linked accounts that the customer can select for the payment method.", "properties": { "account_subcategories": { "description": "The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.", "items": { "enum": [ "checking", "savings" ], "maxLength": 5000, "type": "string" }, "type": "array" }, "institution": { "description": "ID of the institution to use to filter for selectable accounts.", "maxLength": 5000, "type": "string" } }, "title": "linked_account_options_filters_param", "type": "object", "x-stripeMostCommon": [ "account_subcategories", "institution" ] }, "manual_entry": { "description": "Customize manual entry behavior", "properties": { "mode": { "description": "Settings for configuring manual entry of account details.", "enum": [ "automatic", "custom" ], "type": "string" } }, "required": [ "mode" ], "title": "linked_account_options_manual_entry_param", "type": "object", "x-stripeMostCommon": [ "mode" ] }, "permissions": { "description": "The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.", "items": { "enum": [ "balances", "ownership", "payment_method", "transactions" ], "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true }, "type": "array" }, "prefetch": { "description": "List of data features that you would like to retrieve upon account creation.", "items": { "enum": [ "balances", "inferred_balances", "ownership", "transactions" ], "type": "string", "x-stripeBypassValidation": true }, "type": "array" }, "return_url": { "description": "For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.", "maxLength": 5000, "type": "string" } }, "title": "linked_account_options_param", "type": "object", "x-stripeMostCommon": [ "filters", "manual_entry", "permissions", "prefetch", "return_url" ] }, "mandate_options": { "description": "Additional fields for Mandate creation", "properties": { "collection_method": { "description": "The method used to collect offline mandate customer acceptance.", "enum": [ "", "paper" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "mandate_options_param", "type": "object", "x-stripeMostCommon": [ "collection_method" ] }, "networks": { "description": "Additional fields for network related functions", "properties": { "requested": { "description": "Triggers validations to run across the selected networks", "items": { "enum": [ "ach", "us_domestic_wire" ], "type": "string" }, "type": "array" } }, "title": "networks_options_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "preferred_settlement_speed": { "description": "Preferred transaction settlement speed", "enum": [ "", "fastest", "standard" ], "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "", "none", "off_session", "on_session" ], "type": "string" }, "target_date": { "description": "Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.", "maxLength": 5000, "type": "string" }, "verification_method": { "description": "Bank account verification method.", "enum": [ "automatic", "instant", "microdeposits" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "payment_intent_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "financial_connections", "mandate_options", "networks", "preferred_settlement_speed", "setup_future_usage", "target_date", "verification_method" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `us_bank_account` PaymentMethod, this sub-hash contains details about the US bank account payment method options." }, "wechat_pay": { "anyOf": [ { "properties": { "app_id": { "description": "The app ID registered with WeChat Pay. Only required when client is ios or android.", "maxLength": 5000, "type": "string" }, "client": { "description": "The client type that the end customer will pay from", "enum": [ "android", "ios", "web" ], "type": "string", "x-stripeBypassValidation": true }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "app_id", "client", "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `wechat_pay` PaymentMethod, this sub-hash contains details about the WeChat Pay payment method options." }, "zip": { "anyOf": [ { "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `zip` PaymentMethod, this sub-hash contains details about the Zip payment method options." } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "acss_debit", "affirm", "afterpay_clearpay", "alipay", "alma", "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", "billie", "blik", "boleto", "boleto_pilot", "card", "card_present", "cashapp", "crypto", "customer_balance", "demo_pay", "dummy_auth_push", "dummy_passthrough_card", "eps", "fpx", "getbalance", "giropay", "gopay", "grabpay", "id_bank_transfer", "ideal", "interac_present", "kakao_pay", "klarna", "knet", "konbini", "kr_card", "kr_market", "link", "mb_way", "mobilepay", "mondu", "multibanco", "naver_pay", "ng_bank", "ng_bank_transfer", "ng_card", "ng_market", "ng_ussd", "nz_bank_account", "oxxo", "p24", "pay_by_bank", "payco", "paynow", "paypal", "paypay", "payto", "pix", "promptpay", "qris", "rechnung", "revolut_pay", "samsung_pay", "satispay", "sepa_debit", "shopeepay", "sofort", "stripe_balance", "swish", "twint", "upi", "us_bank_account", "vipps", "wechat_pay", "zip" ] }, "payment_method_types": { "description": "The list of payment method types (for example, a card) that this PaymentIntent can use. If you don't provide this, Stripe will dynamically show relevant payment methods from your [payment method settings](https://dashboard.stripe.com/settings/payment_methods). A list of valid payment method types can be found [here](https://docs.stripe.com/api/payment_methods/object#payment_method_object-type).", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "radar_options": { "description": "Options to configure Radar. Learn more about [Radar Sessions](https://stripe.com/docs/radar/radar-session).", "properties": { "session": { "description": "A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.", "maxLength": 5000, "type": "string" } }, "title": "radar_options_with_hidden_options", "type": "object", "x-stripeMostCommon": [ "session", "skip_rules" ] }, "receipt_email": { "description": "Email address to send the receipt to. If you specify `receipt_email` for a payment in live mode, you send a receipt regardless of your [email settings](https://dashboard.stripe.com/account/emails).", "type": "string" }, "return_url": { "description": "The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. If you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm).", "type": "string" }, "secret_key_confirmation": { "description": "Indicates whether confirmation for this PaymentIntent using a secret key is `required` or `optional`.", "enum": [ "optional", "required" ], "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "off_session", "on_session" ], "type": "string" }, "shipping": { "description": "Shipping information for this PaymentIntent.", "properties": { "address": { "description": "Shipping address.", "properties": { "city": { "description": "City, district, suburb, town, or village.", "maxLength": 5000, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Address line 1 (e.g., street, PO Box, or company name).", "maxLength": 5000, "type": "string" }, "line2": { "description": "Address line 2 (e.g., apartment, suite, unit, or building).", "maxLength": 5000, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "State, county, province, or region.", "maxLength": 5000, "type": "string" } }, "title": "optional_fields_address", "type": "object", "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state" ] }, "carrier": { "description": "The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.", "maxLength": 5000, "type": "string" }, "name": { "description": "Recipient name.", "maxLength": 5000, "type": "string" }, "phone": { "description": "Recipient phone (including extension).", "maxLength": 5000, "type": "string" }, "tracking_number": { "description": "The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.", "maxLength": 5000, "type": "string" } }, "required": [ "address", "name" ], "title": "optional_fields_shipping", "type": "object", "x-stripeMostCommon": [ "address", "carrier", "name", "phone", "tracking_number" ] }, "statement_descriptor": { "description": "Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).\n\nSetting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead.", "maxLength": 22, "type": "string" }, "statement_descriptor_suffix": { "description": "Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement.", "maxLength": 22, "type": "string" }, "transfer_data": { "description": "The parameters that you can use to automatically create a Transfer.\nLearn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).", "properties": { "amount": { "description": "The amount that will be transferred automatically when a charge succeeds.\nThe amount is capped at the total transaction amount and if no amount is set,\nthe full amount is transferred.\n\nIf you intend to collect a fee and you need a more robust reporting experience, using\n[application_fee_amount](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-application_fee_amount)\nmight be a better fit for your integration.", "type": "integer" }, "destination": { "description": "If specified, successful charges will be attributed to the destination\naccount for tax reporting, and the funds from charges will be transferred\nto the destination account. The ID of the resulting transfer will be\nreturned on the successful charge's `transfer` field.", "type": "string" } }, "required": [ "destination" ], "title": "transfer_data_creation_params", "type": "object", "x-stripeMostCommon": [ "amount", "description", "destination", "metadata", "payment_data" ] }, "transfer_group": { "description": "A string that identifies the resulting payment as part of a group. Learn more about the [use case for connected accounts](https://stripe.com/docs/connect/separate-charges-and-transfers).", "type": "string" }, "use_stripe_sdk": { "description": "Set to `true` when confirming server-side and using Stripe.js, iOS, or Android client-side SDKs to handle the next actions.", "type": "boolean" } }, "required": [ "amount", "currency" ], "type": "object", "x-stripeMostCommon": [ "amount", "automatic_payment_methods", "confirm", "currency", "customer", "description", "metadata", "off_session", "payment_method", "receipt_email", "setup_future_usage", "shipping", "statement_descriptor", "statement_descriptor_suffix" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_intent" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a PaymentIntent" } }, "/v1/payment_intents/search": { "get": { "description": "

Search for PaymentIntents you’ve previously created using Stripe’s Search Query Language.\nDon’t use search in read-after-write flows where strict consistency is necessary. Under normal operating\nconditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up\nto an hour behind during outages. Search functionality is not available to merchants in India.

", "operationId": "GetPaymentIntentsSearch", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.", "in": "query", "name": "page", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for payment intents](https://stripe.com/docs/search#query-fields-for-payment-intents).", "in": "query", "name": "query", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/payment_intent" }, "type": "array" }, "has_more": { "type": "boolean" }, "next_page": { "maxLength": 5000, "nullable": true, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "search_result" ], "type": "string" }, "total_count": { "description": "The total number of objects that match the query, only accurate up to 10,000.", "type": "integer" }, "url": { "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "next_page", "object", "url" ], "title": "SearchResult", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "next_page", "object", "total_count", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Search PaymentIntents" } }, "/v1/payment_intents/{intent}": { "get": { "description": "

Retrieves the details of a PaymentIntent that has previously been created.

\n\n

You can retrieve a PaymentIntent client-side using a publishable key when the client_secret is in the query string.

\n\n

If you retrieve a PaymentIntent with a publishable key, it only returns a subset of properties. Refer to the payment intent object reference for more details.

", "operationId": "GetPaymentIntentsIntent", "parameters": [ { "description": "The client secret of the PaymentIntent. We require it if you use a publishable key to retrieve the source.", "in": "query", "name": "client_secret", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "intent", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_intent" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a PaymentIntent" }, "post": { "description": "

Updates properties on a PaymentIntent object without confirming.

\n\n

Depending on which properties you update, you might need to confirm the\nPaymentIntent again. For example, updating the payment_method\nalways requires you to confirm the PaymentIntent again. If you prefer to\nupdate and confirm at the same time, we recommend updating properties through\nthe confirm API instead.

", "operationId": "PostPaymentIntentsIntent", "parameters": [ { "in": "path", "name": "intent", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "amount_details": { "explode": true, "style": "deepObject" }, "application_fee_amount": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "hooks": { "explode": true, "style": "deepObject" }, "mandate_data": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "payment_details": { "explode": true, "style": "deepObject" }, "payment_method_data": { "explode": true, "style": "deepObject" }, "payment_method_options": { "explode": true, "style": "deepObject" }, "payment_method_types": { "explode": true, "style": "deepObject" }, "receipt_email": { "explode": true, "style": "deepObject" }, "shipping": { "explode": true, "style": "deepObject" }, "transfer_data": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "amount": { "description": "Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).", "type": "integer" }, "amount_details": { "anyOf": [ { "properties": { "discount_amount": { "anyOf": [ { "type": "integer" }, { "enum": [ "" ], "type": "string" } ], "description": "The amount an item was discounted for." }, "line_items": { "anyOf": [ { "items": { "properties": { "discount_amount": { "description": "The amount an item was discounted for. Positive integer.", "type": "integer" }, "payment_method_options": { "description": "Payment method-specific information for line items.", "properties": { "card": { "description": "This sub-hash contains line item details that are specific to `card` payment method.\"", "properties": { "commodity_code": { "description": "Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, etc.", "maxLength": 12, "type": "string" } }, "title": "payment_intent_amount_details_line_item_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "commodity_code" ] }, "card_present": { "description": "This sub-hash contains line item details that are specific to `card_present` payment method.\"", "properties": { "commodity_code": { "description": "Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, etc.", "maxLength": 12, "type": "string" } }, "title": "amount_details_line_item_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "commodity_code" ] }, "klarna": { "description": "This sub-hash contains line item details that are specific to `klarna` payment method.\"", "properties": { "image_url": { "description": "URL to an image for the product. Max length, 4096 characters.", "maxLength": 4096, "type": "string" }, "product_url": { "description": "URL to the product page. Max length, 4096 characters.", "maxLength": 4096, "type": "string" }, "subscription_reference": { "description": "Reference for the subscription this line item is for.", "maxLength": 255, "type": "string" } }, "title": "payment_intent_amount_details_line_item_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "image_url", "product_url", "subscription_reference" ] }, "paypal": { "description": "This sub-hash contains line item details that are specific to `paypal` payment method.\"", "properties": { "category": { "description": "Type of the line item.", "enum": [ "digital_goods", "donation", "physical_goods" ], "type": "string" }, "description": { "description": "Description of the line item.", "maxLength": 127, "type": "string" }, "sold_by": { "description": "The Stripe account ID of the connected account that sells the item.", "maxLength": 127, "type": "string" } }, "title": "amount_details_line_item_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "category", "description", "sold_by" ] } }, "title": "amount_details_line_item_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "card", "card_present", "dummy_auth_push", "klarna", "link", "paypal" ] }, "product_code": { "description": "Unique identifier of the product. At most 12 characters long.", "maxLength": 12, "type": "string" }, "product_name": { "description": "Name of the product. At most 100 characters long.", "maxLength": 1024, "type": "string" }, "quantity": { "description": "Number of items of the product. Positive integer.", "type": "integer" }, "tax": { "description": "Contains information about the tax on the item.", "properties": { "total_tax_amount": { "description": "The total tax on an item. Non-negative integer.", "type": "integer" } }, "required": [ "total_tax_amount" ], "title": "amount_details_line_item_tax_param", "type": "object", "x-stripeMostCommon": [ "total_tax_amount" ] }, "unit_cost": { "description": "Cost of the product. Non-negative integer.", "type": "integer" }, "unit_of_measure": { "description": "A unit of measure for the line item, such as gallons, feet, meters, etc.", "maxLength": 12, "type": "string" } }, "required": [ "product_name", "quantity", "unit_cost" ], "title": "amount_details_line_item_param", "type": "object", "x-stripeMostCommon": [ "discount_amount", "payment_method_options", "product_code", "product_name", "quantity", "tax", "unit_cost", "unit_of_measure" ] }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "A list of line items, each containing information about a product in the PaymentIntent. There is a maximum of 100 line items." }, "shipping": { "anyOf": [ { "properties": { "amount": { "anyOf": [ { "type": "integer" }, { "enum": [ "" ], "type": "string" } ], "description": "Portion of the amount that is for shipping." }, "from_postal_code": { "anyOf": [ { "maxLength": 10, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "The postal code that represents the shipping source." }, "to_postal_code": { "anyOf": [ { "maxLength": 10, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "The postal code that represents the shipping destination." } }, "title": "amount_details_shipping_param", "type": "object", "x-stripeMostCommon": [ "amount", "from_postal_code", "to_postal_code" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Contains information about the shipping portion of the amount." }, "tax": { "anyOf": [ { "properties": { "total_tax_amount": { "description": "Total portion of the amount that is for tax.", "type": "integer" } }, "required": [ "total_tax_amount" ], "title": "amount_details_tax_param", "type": "object", "x-stripeMostCommon": [ "total_tax_amount" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Contains information about the tax portion of the amount." } }, "title": "amount_details_param", "type": "object", "x-stripeMostCommon": [ "discount_amount", "line_items", "shipping", "tax" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Provides industry-specific information about the amount." }, "application_fee_amount": { "anyOf": [ { "type": "integer" }, { "enum": [ "" ], "type": "string" } ], "description": "The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total amount captured. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts)." }, "capture_method": { "description": "Controls when the funds will be captured from the customer's account.", "enum": [ "automatic", "automatic_async", "manual" ], "type": "string" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "customer": { "description": "ID of the Customer this PaymentIntent belongs to, if one exists.\n\nPayment methods attached to other Customers cannot be used with this PaymentIntent.\n\nIf [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead.", "maxLength": 5000, "type": "string" }, "customer_account": { "description": "ID of the Account this PaymentIntent belongs to, if one exists.\n\nPayment methods attached to other Accounts cannot be used with this PaymentIntent.\n\nIf [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Account after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Account instead.", "maxLength": 5000, "type": "string" }, "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users.", "maxLength": 1000, "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "fx_quote": { "description": "The FX rate in the quote is validated and used to convert the presentment amount to the settlement amount.", "maxLength": 5000, "type": "string" }, "hooks": { "description": "Automations to be run during the PaymentIntent lifecycle", "properties": { "inputs": { "description": "Arguments passed in automations", "properties": { "tax": { "description": "Tax arguments for automations", "properties": { "calculation": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "The [TaxCalculation](https://stripe.com/docs/api/tax/calculations) id" } }, "required": [ "calculation" ], "title": "async_workflows_inputs_tax_param", "type": "object", "x-stripeMostCommon": [ "calculation" ] } }, "title": "async_workflows_inputs_param", "type": "object", "x-stripeMostCommon": [ "tax" ] } }, "title": "async_workflows_param", "type": "object", "x-stripeMostCommon": [ "inputs" ] }, "mandate_data": { "description": "This hash contains details about the Mandate to create.", "properties": { "customer_acceptance": { "description": "This hash contains details about the customer acceptance of the Mandate.", "properties": { "online": { "description": "If this is a Mandate accepted online, this hash contains details about the online acceptance.", "properties": { "ip_address": { "description": "The IP address from which the Mandate was accepted by the customer.", "type": "string" }, "user_agent": { "description": "The user agent of the browser from which the Mandate was accepted by the customer.", "maxLength": 5000, "type": "string" } }, "title": "online_param", "type": "object", "x-stripeMostCommon": [ "ip_address", "user_agent" ] }, "type": { "description": "The type of customer acceptance information included with the Mandate.", "enum": [ "online" ], "maxLength": 5000, "type": "string" } }, "required": [ "online", "type" ], "title": "customer_acceptance_param", "type": "object", "x-stripeMostCommon": [ "online", "type" ] } }, "required": [ "customer_acceptance" ], "title": "client_key_param", "type": "object", "x-stripeMostCommon": [ "customer_acceptance" ], "x-stripeParam": { "class_name": "MandateDataPublishableKey" } }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "payment_details": { "anyOf": [ { "properties": { "car_rental": { "description": "Car rental details for this PaymentIntent.", "properties": { "affiliate": { "description": "Affiliate details for this purchase.", "properties": { "name": { "description": "The name of the affiliate that originated the purchase.", "maxLength": 5000, "type": "string" } }, "required": [ "name" ], "title": "affiliate", "type": "object", "x-stripeMostCommon": [ "name" ] }, "booking_number": { "description": "The booking number associated with the car rental.", "maxLength": 100, "type": "string" }, "car_class_code": { "description": "Class code of the car.", "maxLength": 4, "type": "string" }, "car_make": { "description": "Make of the car.", "maxLength": 10, "type": "string" }, "car_model": { "description": "Model of the car.", "maxLength": 10, "type": "string" }, "company": { "description": "The name of the rental car company.", "maxLength": 26, "type": "string" }, "customer_service_phone_number": { "description": "The customer service phone number of the car rental company.", "maxLength": 16, "type": "string" }, "days_rented": { "description": "Number of days the car is being rented.", "type": "integer" }, "delivery": { "description": "Delivery details for this purchase.", "properties": { "mode": { "description": "The delivery method for the payment", "enum": [ "email", "phone", "pickup", "post" ], "type": "string" }, "recipient": { "description": "Details of the recipient.", "properties": { "email": { "description": "The email of the recipient the ticket is delivered to.", "maxLength": 5000, "type": "string" }, "name": { "description": "The name of the recipient the ticket is delivered to.", "maxLength": 5000, "type": "string" }, "phone": { "description": "The phone number of the recipient the ticket is delivered to.", "maxLength": 5000, "type": "string" } }, "title": "delivery_recipient", "type": "object", "x-stripeMostCommon": [ "email", "name", "phone" ] } }, "title": "delivery", "type": "object", "x-stripeMostCommon": [ "mode", "recipient" ] }, "distance": { "description": "The details of the distance traveled during the rental period.", "properties": { "amount": { "description": "Distance traveled.", "type": "integer" }, "unit": { "description": "Unit of measurement for the distance traveled. One of `miles` or `kilometers`.", "enum": [ "kilometers", "miles" ], "type": "string" } }, "title": "car_rental_distance", "type": "object", "x-stripeMostCommon": [ "amount", "unit" ] }, "drivers": { "description": "The details of the passengers in the travel reservation", "items": { "properties": { "driver_identification_number": { "description": "Driver's identification number.", "maxLength": 20, "type": "string" }, "driver_tax_number": { "description": "Driver's tax number.", "maxLength": 20, "type": "string" }, "name": { "description": "Full name of the person or entity on the car reservation.", "maxLength": 5000, "type": "string" } }, "required": [ "name" ], "title": "car_rental_driver", "type": "object", "x-stripeMostCommon": [ "driver_identification_number", "driver_tax_number", "name" ] }, "type": "array" }, "extra_charges": { "description": "List of additional charges being billed.", "items": { "enum": [ "extra_mileage", "gas", "late_return", "one_way_service", "parking_violation" ], "type": "string" }, "type": "array" }, "no_show": { "description": "Indicates if the customer did not keep nor cancel their booking.", "type": "boolean" }, "pickup_address": { "description": "Car pick-up address.", "properties": { "city": { "description": "City, district, suburb, town, or village.", "maxLength": 5000, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Address line 1 (e.g., street, PO Box, or company name).", "maxLength": 5000, "type": "string" }, "line2": { "description": "Address line 2 (e.g., apartment, suite, unit, or building).", "maxLength": 5000, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "State, county, province, or region.", "maxLength": 5000, "type": "string" } }, "title": "optional_fields_address", "type": "object", "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state" ] }, "pickup_at": { "description": "Car pick-up time. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "pickup_location_name": { "description": "Name of the pickup location.", "maxLength": 38, "type": "string" }, "rate_amount": { "description": "Rental rate.", "type": "integer" }, "rate_interval": { "description": "The frequency at which the rate amount is applied. One of `day`, `week` or `month`", "enum": [ "day", "month", "week" ], "type": "string" }, "renter_name": { "description": "The name of the person or entity renting the car.", "maxLength": 100, "type": "string" }, "return_address": { "description": "Car return address.", "properties": { "city": { "description": "City, district, suburb, town, or village.", "maxLength": 5000, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Address line 1 (e.g., street, PO Box, or company name).", "maxLength": 5000, "type": "string" }, "line2": { "description": "Address line 2 (e.g., apartment, suite, unit, or building).", "maxLength": 5000, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "State, county, province, or region.", "maxLength": 5000, "type": "string" } }, "title": "optional_fields_address", "type": "object", "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state" ] }, "return_at": { "description": "Car return time. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "return_location_name": { "description": "Name of the return location.", "maxLength": 38, "type": "string" }, "tax_exempt": { "description": "Indicates whether the goods or services are tax-exempt or tax is not collected.", "type": "boolean" }, "vehicle_identification_number": { "description": "The vehicle identification number.", "maxLength": 20, "type": "string" } }, "required": [ "booking_number", "days_rented", "pickup_at", "return_at" ], "title": "car_rental", "type": "object", "x-stripeMostCommon": [ "affiliate", "booking_number", "car_class_code", "car_make", "car_model", "company", "customer_service_phone_number", "days_rented", "delivery", "distance", "drivers", "extra_charges", "no_show", "pickup_address", "pickup_at", "pickup_location_name", "rate_amount", "rate_interval", "renter_name", "return_address", "return_at", "return_location_name", "tax_exempt", "vehicle_identification_number" ] }, "customer_reference": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Some customers might be required by their company or organization to provide this information. If so, provide this value. Otherwise you can ignore this field." }, "event_details": { "description": "Event details for this PaymentIntent", "properties": { "access_controlled_venue": { "description": "Indicates if the tickets are digitally checked when entering the venue.", "type": "boolean" }, "address": { "description": "The event location's address.", "properties": { "city": { "description": "City, district, suburb, town, or village.", "maxLength": 5000, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Address line 1 (e.g., street, PO Box, or company name).", "maxLength": 5000, "type": "string" }, "line2": { "description": "Address line 2 (e.g., apartment, suite, unit, or building).", "maxLength": 5000, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "State, county, province, or region.", "maxLength": 5000, "type": "string" } }, "title": "optional_fields_address", "type": "object", "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state" ] }, "affiliate": { "description": "Affiliate details for this purchase.", "properties": { "name": { "description": "The name of the affiliate that originated the purchase.", "maxLength": 5000, "type": "string" } }, "required": [ "name" ], "title": "affiliate", "type": "object", "x-stripeMostCommon": [ "name" ] }, "company": { "description": "The name of the company", "maxLength": 5000, "type": "string" }, "delivery": { "description": "Delivery details for this purchase.", "properties": { "mode": { "description": "The delivery method for the payment", "enum": [ "email", "phone", "pickup", "post" ], "type": "string" }, "recipient": { "description": "Details of the recipient.", "properties": { "email": { "description": "The email of the recipient the ticket is delivered to.", "maxLength": 5000, "type": "string" }, "name": { "description": "The name of the recipient the ticket is delivered to.", "maxLength": 5000, "type": "string" }, "phone": { "description": "The phone number of the recipient the ticket is delivered to.", "maxLength": 5000, "type": "string" } }, "title": "delivery_recipient", "type": "object", "x-stripeMostCommon": [ "email", "name", "phone" ] } }, "title": "delivery", "type": "object", "x-stripeMostCommon": [ "mode", "recipient" ] }, "ends_at": { "description": "Event end time. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "genre": { "description": "Type of the event entertainment (concert, sports event etc)", "maxLength": 5000, "type": "string" }, "name": { "description": "The name of the event.", "maxLength": 5000, "type": "string" }, "starts_at": { "description": "Event start time. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" } }, "required": [ "name" ], "title": "event", "type": "object", "x-stripeMostCommon": [ "access_controlled_venue", "address", "affiliate", "company", "delivery", "ends_at", "genre", "name", "starts_at" ] }, "flight": { "description": "Flight reservation details for this PaymentIntent", "properties": { "affiliate": { "description": "Affiliate details for this purchase.", "properties": { "name": { "description": "The name of the affiliate that originated the purchase.", "maxLength": 5000, "type": "string" } }, "required": [ "name" ], "title": "affiliate", "type": "object", "x-stripeMostCommon": [ "name" ] }, "agency_number": { "description": "The agency number (i.e. International Air Transport Association (IATA) agency number) of the travel agency that made the booking.", "maxLength": 8, "type": "string" }, "carrier": { "description": "The International Air Transport Association (IATA) carrier code of the carrier that issued the ticket.", "maxLength": 3, "type": "string" }, "delivery": { "description": "Delivery details for this purchase.", "properties": { "mode": { "description": "The delivery method for the payment", "enum": [ "email", "phone", "pickup", "post" ], "type": "string" }, "recipient": { "description": "Details of the recipient.", "properties": { "email": { "description": "The email of the recipient the ticket is delivered to.", "maxLength": 5000, "type": "string" }, "name": { "description": "The name of the recipient the ticket is delivered to.", "maxLength": 5000, "type": "string" }, "phone": { "description": "The phone number of the recipient the ticket is delivered to.", "maxLength": 5000, "type": "string" } }, "title": "delivery_recipient", "type": "object", "x-stripeMostCommon": [ "email", "name", "phone" ] } }, "title": "delivery", "type": "object", "x-stripeMostCommon": [ "mode", "recipient" ] }, "passenger_name": { "description": "The name of the person or entity on the reservation.", "maxLength": 26, "type": "string" }, "passengers": { "description": "The details of the passengers in the travel reservation.", "items": { "properties": { "name": { "description": "Full name of the person or entity on the flight reservation.", "maxLength": 5000, "type": "string" } }, "required": [ "name" ], "title": "flight_passenger", "type": "object", "x-stripeMostCommon": [ "name" ] }, "type": "array" }, "segments": { "description": "The individual flight segments associated with the trip.", "items": { "properties": { "amount": { "description": "The flight segment amount.", "type": "integer" }, "arrival_airport": { "description": "The International Air Transport Association (IATA) airport code for the arrival airport.", "maxLength": 3, "type": "string" }, "arrives_at": { "description": "The arrival time for the flight segment. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "carrier": { "description": "The International Air Transport Association (IATA) carrier code of the carrier operating the flight segment.", "maxLength": 2, "type": "string" }, "departs_at": { "description": "The departure time for the flight segment. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "departure_airport": { "description": "The International Air Transport Association (IATA) airport code for the departure airport.", "maxLength": 3, "type": "string" }, "flight_number": { "description": "The flight number associated with the segment", "maxLength": 4, "type": "string" }, "service_class": { "description": "The fare class for the segment.", "enum": [ "business", "economy", "first", "premium_economy" ], "type": "string" } }, "required": [ "departs_at" ], "title": "flight_segment", "type": "object", "x-stripeMostCommon": [ "amount", "arrival_airport", "arrives_at", "carrier", "departs_at", "departure_airport", "flight_number", "service_class" ] }, "type": "array" }, "ticket_number": { "description": "The ticket number associated with the travel reservation.", "maxLength": 14, "type": "string" } }, "required": [ "segments" ], "title": "flight", "type": "object", "x-stripeMostCommon": [ "affiliate", "agency_number", "carrier", "delivery", "passenger_name", "passengers", "segments", "ticket_number" ] }, "lodging": { "description": "Lodging reservation details for this PaymentIntent", "properties": { "address": { "description": "The lodging location's address.", "properties": { "city": { "description": "City, district, suburb, town, or village.", "maxLength": 5000, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Address line 1 (e.g., street, PO Box, or company name).", "maxLength": 5000, "type": "string" }, "line2": { "description": "Address line 2 (e.g., apartment, suite, unit, or building).", "maxLength": 5000, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "State, county, province, or region.", "maxLength": 5000, "type": "string" } }, "title": "optional_fields_address", "type": "object", "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state" ] }, "adults": { "description": "The number of adults on the booking", "type": "integer" }, "affiliate": { "description": "Affiliate details for this purchase.", "properties": { "name": { "description": "The name of the affiliate that originated the purchase.", "maxLength": 5000, "type": "string" } }, "required": [ "name" ], "title": "affiliate", "type": "object", "x-stripeMostCommon": [ "name" ] }, "booking_number": { "description": "The booking number associated with the lodging reservation.", "maxLength": 100, "type": "string" }, "category": { "description": "The lodging category", "enum": [ "hotel", "vacation_rental" ], "type": "string" }, "checkin_at": { "description": "Lodging check-in time. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "checkout_at": { "description": "Lodging check-out time. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "customer_service_phone_number": { "description": "The customer service phone number of the lodging company.", "type": "string" }, "daily_room_rate_amount": { "description": "The daily lodging room rate.", "type": "integer" }, "delivery": { "description": "Delivery details for this purchase.", "properties": { "mode": { "description": "The delivery method for the payment", "enum": [ "email", "phone", "pickup", "post" ], "type": "string" }, "recipient": { "description": "Details of the recipient.", "properties": { "email": { "description": "The email of the recipient the ticket is delivered to.", "maxLength": 5000, "type": "string" }, "name": { "description": "The name of the recipient the ticket is delivered to.", "maxLength": 5000, "type": "string" }, "phone": { "description": "The phone number of the recipient the ticket is delivered to.", "maxLength": 5000, "type": "string" } }, "title": "delivery_recipient", "type": "object", "x-stripeMostCommon": [ "email", "name", "phone" ] } }, "title": "delivery", "type": "object", "x-stripeMostCommon": [ "mode", "recipient" ] }, "extra_charges": { "description": "List of additional charges being billed.", "items": { "enum": [ "gift_shop", "laundry", "mini_bar", "other", "restaurant", "telephone" ], "type": "string" }, "type": "array" }, "fire_safety_act_compliance": { "description": "Indicates whether the lodging location is compliant with the Fire Safety Act.", "type": "boolean" }, "name": { "description": "The name of the lodging location.", "maxLength": 100, "type": "string" }, "no_show": { "description": "Indicates if the customer did not keep their booking while failing to cancel the reservation.", "type": "boolean" }, "number_of_rooms": { "description": "The number of rooms on the booking", "type": "integer" }, "passengers": { "description": "The details of the passengers in the travel reservation", "items": { "properties": { "name": { "description": "Full name of the person or entity on the lodging reservation.", "maxLength": 5000, "type": "string" } }, "required": [ "name" ], "title": "lodging_passenger", "type": "object", "x-stripeMostCommon": [ "name" ] }, "type": "array" }, "property_phone_number": { "description": "The phone number of the lodging location.", "type": "string" }, "room_class": { "description": "The room class for this purchase.", "maxLength": 5000, "type": "string" }, "room_nights": { "description": "The number of room nights", "type": "integer" }, "total_room_tax_amount": { "description": "The total tax amount associating with the room reservation.", "type": "integer" }, "total_tax_amount": { "description": "The total tax amount", "type": "integer" } }, "required": [ "checkin_at", "checkout_at" ], "title": "lodging", "type": "object", "x-stripeMostCommon": [ "address", "adults", "affiliate", "booking_number", "category", "checkin_at", "checkout_at", "customer_service_phone_number", "daily_room_rate_amount", "delivery", "extra_charges", "fire_safety_act_compliance", "name", "no_show", "number_of_rooms", "passengers", "property_phone_number", "room_class", "room_nights", "total_room_tax_amount", "total_tax_amount" ] }, "order_reference": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "A unique value assigned by the business to identify the transaction." }, "subscription": { "description": "Subscription details for this PaymentIntent", "properties": { "affiliate": { "description": "Affiliate details for this purchase.", "properties": { "name": { "description": "The name of the affiliate that originated the purchase.", "maxLength": 5000, "type": "string" } }, "required": [ "name" ], "title": "affiliate", "type": "object", "x-stripeMostCommon": [ "name" ] }, "auto_renewal": { "description": "Info whether the subscription will be auto renewed upon expiry.", "type": "boolean" }, "billing_interval": { "description": "Subscription billing details for this purchase.", "properties": { "count": { "description": "The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.", "type": "integer" }, "interval": { "description": "Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.", "enum": [ "day", "month", "week", "year" ], "type": "string" } }, "required": [ "count", "interval" ], "title": "subscription_billing_interval", "type": "object", "x-stripeMostCommon": [ "count", "interval" ] }, "ends_at": { "description": "Subscription end time. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "name": { "description": "Name of the product on subscription. e.g. Apple Music Subscription", "maxLength": 5000, "type": "string" }, "starts_at": { "description": "Subscription start time. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" } }, "required": [ "name" ], "title": "subscription", "type": "object", "x-stripeMostCommon": [ "affiliate", "auto_renewal", "billing_interval", "ends_at", "name", "starts_at" ] } }, "title": "payment_details", "type": "object", "x-stripeMostCommon": [ "benefit", "car_rental", "car_rental_data", "event_details", "flight", "healthcare", "lodging", "lodging_data", "subscription" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Provides industry-specific information about the charge." }, "payment_method": { "maxLength": 5000, "type": "string" }, "payment_method_configuration": { "description": "The ID of the [payment method configuration](https://stripe.com/docs/api/payment_method_configurations) to use with this PaymentIntent.", "maxLength": 100, "type": "string" }, "payment_method_data": { "description": "If provided, this hash will be used to create a PaymentMethod. The new PaymentMethod will appear\nin the [payment_method](https://stripe.com/docs/api/payment_intents/object#payment_intent_object-payment_method)\nproperty on the PaymentIntent.", "properties": { "acss_debit": { "description": "If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method.", "properties": { "account_number": { "description": "Customer's bank account number.", "maxLength": 5000, "type": "string" }, "institution_number": { "description": "Institution number of the customer's bank.", "maxLength": 5000, "type": "string" }, "transit_number": { "description": "Transit number of the customer's bank.", "maxLength": 5000, "type": "string" } }, "required": [ "account_number", "institution_number", "transit_number" ], "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "account_number", "financial_connections_account", "institution_number", "transit_number" ] }, "affirm": { "description": "If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method.", "properties": {}, "title": "param", "type": "object" }, "afterpay_clearpay": { "description": "If this is an `AfterpayClearpay` PaymentMethod, this hash contains details about the AfterpayClearpay payment method.", "properties": {}, "title": "param", "type": "object" }, "alipay": { "description": "If this is an `Alipay` PaymentMethod, this hash contains details about the Alipay payment method.", "properties": {}, "title": "param", "type": "object" }, "allow_redisplay": { "description": "This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to `unspecified`.", "enum": [ "always", "limited", "unspecified" ], "type": "string" }, "alma": { "description": "If this is a Alma PaymentMethod, this hash contains details about the Alma payment method.", "properties": {}, "title": "param", "type": "object" }, "amazon_pay": { "description": "If this is a AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method.", "properties": {}, "title": "param", "type": "object" }, "au_becs_debit": { "description": "If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account.", "properties": { "account_number": { "description": "The account number for the bank account.", "maxLength": 5000, "type": "string" }, "bsb_number": { "description": "Bank-State-Branch number of the bank account.", "maxLength": 5000, "type": "string" } }, "required": [ "account_number", "bsb_number" ], "title": "param", "type": "object", "x-stripeMostCommon": [ "account_number", "bsb_number" ] }, "bacs_debit": { "description": "If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.", "properties": { "account_number": { "description": "Account number of the bank account that the funds will be debited from.", "maxLength": 5000, "type": "string" }, "sort_code": { "description": "Sort code of the bank account. (e.g., `10-20-30`)", "maxLength": 5000, "type": "string" } }, "title": "param", "type": "object", "x-stripeMostCommon": [ "account_number", "sort_code" ] }, "bancontact": { "description": "If this is a `bancontact` PaymentMethod, this hash contains details about the Bancontact payment method.", "properties": {}, "title": "param", "type": "object" }, "billie": { "description": "If this is a `billie` PaymentMethod, this hash contains details about the Billie payment method.", "properties": {}, "title": "param", "type": "object" }, "billing_details": { "description": "Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.", "properties": { "address": { "anyOf": [ { "properties": { "city": { "description": "City, district, suburb, town, or village.", "maxLength": 5000, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Address line 1 (e.g., street, PO Box, or company name).", "maxLength": 5000, "type": "string" }, "line2": { "description": "Address line 2 (e.g., apartment, suite, unit, or building).", "maxLength": 5000, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "State, county, province, or region.", "maxLength": 5000, "type": "string" } }, "title": "billing_details_address", "type": "object", "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Billing address." }, "email": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Email address." }, "name": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Full name." }, "phone": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Billing phone number (including extension)." }, "tax_id": { "description": "Taxpayer identification number. Used only for transactions between LATAM buyers and non-LATAM sellers.", "maxLength": 5000, "type": "string" } }, "title": "billing_details_inner_params", "type": "object", "x-stripeMostCommon": [ "address", "email", "name", "phone", "tax_id" ] }, "blik": { "description": "If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.", "properties": {}, "title": "param", "type": "object" }, "boleto": { "description": "If this is a `boleto` PaymentMethod, this hash contains details about the Boleto payment method.", "properties": { "tax_id": { "description": "The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers)", "maxLength": 5000, "type": "string" } }, "required": [ "tax_id" ], "title": "param", "type": "object", "x-stripeMostCommon": [ "tax_id" ] }, "cashapp": { "description": "If this is a `cashapp` PaymentMethod, this hash contains details about the Cash App Pay payment method.", "properties": {}, "title": "param", "type": "object" }, "crypto": { "description": "If this is a Crypto PaymentMethod, this hash contains details about the Crypto payment method.", "properties": {}, "title": "param", "type": "object" }, "customer_balance": { "description": "If this is a `customer_balance` PaymentMethod, this hash contains details about the CustomerBalance payment method.", "properties": {}, "title": "param", "type": "object" }, "eps": { "description": "If this is an `eps` PaymentMethod, this hash contains details about the EPS payment method.", "properties": { "bank": { "description": "The customer's bank.", "enum": [ "arzte_und_apotheker_bank", "austrian_anadi_bank_ag", "bank_austria", "bankhaus_carl_spangler", "bankhaus_schelhammer_und_schattera_ag", "bawag_psk_ag", "bks_bank_ag", "brull_kallmus_bank_ag", "btv_vier_lander_bank", "capital_bank_grawe_gruppe_ag", "deutsche_bank_ag", "dolomitenbank", "easybank_ag", "erste_bank_und_sparkassen", "hypo_alpeadriabank_international_ag", "hypo_bank_burgenland_aktiengesellschaft", "hypo_noe_lb_fur_niederosterreich_u_wien", "hypo_oberosterreich_salzburg_steiermark", "hypo_tirol_bank_ag", "hypo_vorarlberg_bank_ag", "marchfelder_bank", "oberbank_ag", "raiffeisen_bankengruppe_osterreich", "schoellerbank_ag", "sparda_bank_wien", "volksbank_gruppe", "volkskreditbank_ag", "vr_bank_braunau" ], "maxLength": 5000, "type": "string" } }, "title": "param", "type": "object", "x-stripeMostCommon": [ "bank" ] }, "fpx": { "description": "If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method.", "properties": { "account_holder_type": { "description": "Account holder type for FPX transaction", "enum": [ "company", "individual" ], "maxLength": 5000, "type": "string" }, "bank": { "description": "The customer's bank.", "enum": [ "affin_bank", "agrobank", "alliance_bank", "ambank", "bank_islam", "bank_muamalat", "bank_of_china", "bank_rakyat", "bsn", "cimb", "deutsche_bank", "hong_leong_bank", "hsbc", "kfh", "maybank2e", "maybank2u", "ocbc", "pb_enterprise", "public_bank", "rhb", "standard_chartered", "uob" ], "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true } }, "required": [ "bank" ], "title": "param", "type": "object", "x-stripeMostCommon": [ "account_holder_type", "bank" ] }, "giropay": { "description": "If this is a `giropay` PaymentMethod, this hash contains details about the Giropay payment method.", "properties": {}, "title": "param", "type": "object" }, "gopay": { "description": "If this is a Gopay PaymentMethod, this hash contains details about the Gopay payment method.", "properties": {}, "title": "param", "type": "object" }, "grabpay": { "description": "If this is a `grabpay` PaymentMethod, this hash contains details about the GrabPay payment method.", "properties": {}, "title": "param", "type": "object" }, "id_bank_transfer": { "description": "If this is an `IdBankTransfer` PaymentMethod, this hash contains details about the IdBankTransfer payment method.", "properties": { "bank": { "description": "Bank where the account is held.", "enum": [ "bca", "bni", "bri", "cimb", "permata" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "param", "type": "object", "x-stripeMostCommon": [ "bank" ] }, "ideal": { "description": "If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method.", "properties": { "bank": { "description": "The customer's bank. Only use this parameter for existing customers. Don't use it for new customers.", "enum": [ "abn_amro", "asn_bank", "bunq", "buut", "handelsbanken", "ing", "knab", "moneyou", "n26", "nn", "rabobank", "regiobank", "revolut", "sns_bank", "triodos_bank", "van_lanschot", "yoursafe" ], "maxLength": 5000, "type": "string" } }, "title": "param", "type": "object", "x-stripeMostCommon": [ "bank" ] }, "interac_present": { "description": "If this is an `interac_present` PaymentMethod, this hash contains details about the Interac Present payment method.", "properties": {}, "title": "param", "type": "object", "x-stripeMostCommon": [ "device_identifier", "device_type", "emv", "location" ] }, "kakao_pay": { "description": "If this is a `kakao_pay` PaymentMethod, this hash contains details about the Kakao Pay payment method.", "properties": {}, "title": "param", "type": "object" }, "klarna": { "description": "If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method.", "properties": { "dob": { "description": "Customer's date of birth", "properties": { "day": { "description": "The day of birth, between 1 and 31.", "type": "integer" }, "month": { "description": "The month of birth, between 1 and 12.", "type": "integer" }, "year": { "description": "The four-digit year of birth.", "type": "integer" } }, "required": [ "day", "month", "year" ], "title": "date_of_birth", "type": "object", "x-stripeMostCommon": [ "day", "month", "year" ] } }, "title": "param", "type": "object", "x-stripeMostCommon": [ "dob" ] }, "konbini": { "description": "If this is a `konbini` PaymentMethod, this hash contains details about the Konbini payment method.", "properties": {}, "title": "param", "type": "object" }, "kr_card": { "description": "If this is a `kr_card` PaymentMethod, this hash contains details about the Korean Card payment method.", "properties": {}, "title": "param", "type": "object" }, "link": { "description": "If this is an `Link` PaymentMethod, this hash contains details about the Link payment method.", "properties": {}, "title": "param", "type": "object" }, "mb_way": { "description": "If this is a MB WAY PaymentMethod, this hash contains details about the MB WAY payment method.", "properties": {}, "title": "param", "type": "object" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "mobilepay": { "description": "If this is a `mobilepay` PaymentMethod, this hash contains details about the MobilePay payment method.", "properties": {}, "title": "param", "type": "object" }, "multibanco": { "description": "If this is a `multibanco` PaymentMethod, this hash contains details about the Multibanco payment method.", "properties": {}, "title": "param", "type": "object" }, "naver_pay": { "description": "If this is a `naver_pay` PaymentMethod, this hash contains details about the Naver Pay payment method.", "properties": { "funding": { "description": "Whether to use Naver Pay points or a card to fund this transaction. If not provided, this defaults to `card`.", "enum": [ "card", "points" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "param", "type": "object", "x-stripeMostCommon": [ "funding" ] }, "nz_bank_account": { "description": "If this is an nz_bank_account PaymentMethod, this hash contains details about the nz_bank_account payment method.", "properties": { "account_holder_name": { "description": "The name on the bank account. Only required if the account holder name is different from the name of the authorized signatory collected in the PaymentMethod’s billing details.", "maxLength": 5000, "type": "string" }, "account_number": { "description": "The account number for the bank account.", "maxLength": 5000, "type": "string" }, "bank_code": { "description": "The numeric code for the bank account's bank.", "maxLength": 5000, "type": "string" }, "branch_code": { "description": "The numeric code for the bank account's bank branch.", "maxLength": 5000, "type": "string" }, "reference": { "maxLength": 128, "type": "string" }, "suffix": { "description": "The suffix of the bank account number.", "maxLength": 5000, "type": "string" } }, "required": [ "account_number", "bank_code", "branch_code", "suffix" ], "title": "param", "type": "object", "x-stripeMostCommon": [ "account_holder_name", "account_number", "bank_code", "branch_code", "reference", "suffix" ] }, "oxxo": { "description": "If this is an `oxxo` PaymentMethod, this hash contains details about the OXXO payment method.", "properties": {}, "title": "param", "type": "object" }, "p24": { "description": "If this is a `p24` PaymentMethod, this hash contains details about the P24 payment method.", "properties": { "bank": { "description": "The customer's bank.", "enum": [ "alior_bank", "bank_millennium", "bank_nowy_bfg_sa", "bank_pekao_sa", "banki_spbdzielcze", "blik", "bnp_paribas", "boz", "citi_handlowy", "credit_agricole", "envelobank", "etransfer_pocztowy24", "getin_bank", "ideabank", "ing", "inteligo", "mbank_mtransfer", "nest_przelew", "noble_pay", "pbac_z_ipko", "plus_bank", "santander_przelew24", "tmobile_usbugi_bankowe", "toyota_bank", "velobank", "volkswagen_bank" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "param", "type": "object", "x-stripeMostCommon": [ "bank" ] }, "pay_by_bank": { "description": "If this is a `pay_by_bank` PaymentMethod, this hash contains details about the PayByBank payment method.", "properties": {}, "title": "param", "type": "object" }, "payco": { "description": "If this is a `payco` PaymentMethod, this hash contains details about the PAYCO payment method.", "properties": {}, "title": "param", "type": "object" }, "paynow": { "description": "If this is a `paynow` PaymentMethod, this hash contains details about the PayNow payment method.", "properties": {}, "title": "param", "type": "object" }, "paypal": { "description": "If this is a `paypal` PaymentMethod, this hash contains details about the PayPal payment method.", "properties": {}, "title": "param", "type": "object" }, "paypay": { "description": "If this is a `paypay` PaymentMethod, this hash contains details about the PayPay payment method.", "properties": {}, "title": "param", "type": "object" }, "payto": { "description": "If this is a `payto` PaymentMethod, this hash contains details about the PayTo payment method.", "properties": { "account_number": { "description": "The account number for the bank account.", "maxLength": 5000, "type": "string" }, "bsb_number": { "description": "Bank-State-Branch number of the bank account.", "maxLength": 5000, "type": "string" }, "pay_id": { "description": "The PayID alias for the bank account.", "maxLength": 5000, "type": "string" } }, "title": "param", "type": "object", "x-stripeMostCommon": [ "account_number", "bsb_number", "pay_id" ] }, "pix": { "description": "If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.", "properties": {}, "title": "param", "type": "object", "x-stripeMostCommon": [ "tax_id" ] }, "promptpay": { "description": "If this is a `promptpay` PaymentMethod, this hash contains details about the PromptPay payment method.", "properties": {}, "title": "param", "type": "object" }, "qris": { "description": "If this is a `qris` PaymentMethod, this hash contains details about the QRIS payment method.", "properties": {}, "title": "param", "type": "object" }, "radar_options": { "description": "Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.", "properties": { "session": { "description": "A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.", "maxLength": 5000, "type": "string" } }, "title": "radar_options_with_hidden_options", "type": "object", "x-stripeMostCommon": [ "session", "skip_rules" ] }, "rechnung": { "description": "If this is a `rechnung` PaymentMethod, this hash contains details about the Rechnung payment method.", "properties": { "dob": { "description": "Customer's date of birth", "properties": { "day": { "description": "The day of birth, between 1 and 31.", "type": "integer" }, "month": { "description": "The month of birth, between 1 and 12.", "type": "integer" }, "year": { "description": "The four-digit year of birth.", "type": "integer" } }, "required": [ "day", "month", "year" ], "title": "date_of_birth", "type": "object", "x-stripeMostCommon": [ "day", "month", "year" ] } }, "required": [ "dob" ], "title": "param", "type": "object", "x-stripeMostCommon": [ "dob" ] }, "revolut_pay": { "description": "If this is a `revolut_pay` PaymentMethod, this hash contains details about the Revolut Pay payment method.", "properties": {}, "title": "param", "type": "object" }, "samsung_pay": { "description": "If this is a `samsung_pay` PaymentMethod, this hash contains details about the SamsungPay payment method.", "properties": {}, "title": "param", "type": "object" }, "satispay": { "description": "If this is a `satispay` PaymentMethod, this hash contains details about the Satispay payment method.", "properties": {}, "title": "param", "type": "object" }, "sepa_debit": { "description": "If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account.", "properties": { "iban": { "description": "IBAN of the bank account.", "maxLength": 5000, "type": "string" } }, "required": [ "iban" ], "title": "param", "type": "object", "x-stripeMostCommon": [ "iban" ] }, "shopeepay": { "description": "If this is a Shopeepay PaymentMethod, this hash contains details about the Shopeepay payment method.", "properties": {}, "title": "param", "type": "object" }, "sofort": { "description": "If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.", "properties": { "country": { "description": "Two-letter ISO code representing the country the bank account is located in.", "enum": [ "AT", "BE", "DE", "ES", "IT", "NL" ], "type": "string" } }, "required": [ "country" ], "title": "param", "type": "object", "x-stripeMostCommon": [ "country" ] }, "stripe_balance": { "description": "This hash contains details about the Stripe balance payment method.", "properties": { "account": { "description": "The connected account ID whose Stripe balance to use as the source of payment", "maxLength": 5000, "type": "string" }, "source_type": { "description": "The [source_type](https://docs.stripe.com/api/balance/balance_object#balance_object-available-source_types) of the balance", "enum": [ "bank_account", "card", "fpx" ], "type": "string" } }, "title": "param", "type": "object", "x-stripeMostCommon": [ "account", "source_type" ] }, "swish": { "description": "If this is a `swish` PaymentMethod, this hash contains details about the Swish payment method.", "properties": {}, "title": "param", "type": "object" }, "twint": { "description": "If this is a TWINT PaymentMethod, this hash contains details about the TWINT payment method.", "properties": {}, "title": "param", "type": "object" }, "type": { "description": "The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.", "enum": [ "acss_debit", "affirm", "afterpay_clearpay", "alipay", "alma", "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", "billie", "blik", "boleto", "cashapp", "crypto", "customer_balance", "eps", "fpx", "giropay", "gopay", "grabpay", "id_bank_transfer", "ideal", "kakao_pay", "klarna", "konbini", "kr_card", "link", "mb_way", "mobilepay", "multibanco", "naver_pay", "nz_bank_account", "oxxo", "p24", "pay_by_bank", "payco", "paynow", "paypal", "paypay", "payto", "pix", "promptpay", "qris", "rechnung", "revolut_pay", "samsung_pay", "satispay", "sepa_debit", "shopeepay", "sofort", "stripe_balance", "swish", "twint", "us_bank_account", "wechat_pay", "zip" ], "type": "string", "x-stripeBypassValidation": true }, "us_bank_account": { "description": "If this is an `us_bank_account` PaymentMethod, this hash contains details about the US bank account payment method.", "properties": { "account_holder_type": { "description": "Account holder type: individual or company.", "enum": [ "company", "individual" ], "type": "string" }, "account_number": { "description": "Account number of the bank account.", "maxLength": 5000, "type": "string" }, "account_type": { "description": "Account type: checkings or savings. Defaults to checking if omitted.", "enum": [ "checking", "savings" ], "type": "string" }, "financial_connections_account": { "description": "The ID of a Financial Connections Account to use as a payment method.", "maxLength": 5000, "type": "string" }, "routing_number": { "description": "Routing number of the bank account.", "maxLength": 5000, "type": "string" } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "account_holder_type", "account_number", "account_type", "financial_connections_account", "routing_number" ] }, "wechat_pay": { "description": "If this is an `wechat_pay` PaymentMethod, this hash contains details about the wechat_pay payment method.", "properties": {}, "title": "param", "type": "object" }, "zip": { "description": "If this is a `zip` PaymentMethod, this hash contains details about the Zip payment method.", "properties": {}, "title": "param", "type": "object" } }, "required": [ "type" ], "title": "payment_method_data_params", "type": "object", "x-stripeMostCommon": [ "billing_details", "metadata", "type" ] }, "payment_method_options": { "description": "Payment-method-specific configuration for this PaymentIntent.", "properties": { "acss_debit": { "anyOf": [ { "properties": { "mandate_options": { "description": "Additional fields for Mandate creation", "properties": { "custom_mandate_url": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "A URL for custom mandate text to render during confirmation step.\nThe URL will be rendered with additional GET parameters `payment_intent` and `payment_intent_client_secret` when confirming a Payment Intent,\nor `setup_intent` and `setup_intent_client_secret` when confirming a Setup Intent." }, "interval_description": { "description": "Description of the mandate interval. Only required if 'payment_schedule' parameter is 'interval' or 'combined'.", "maxLength": 500, "type": "string" }, "payment_schedule": { "description": "Payment schedule for the mandate.", "enum": [ "combined", "interval", "sporadic" ], "type": "string" }, "transaction_type": { "description": "Transaction type of the mandate.", "enum": [ "business", "personal" ], "type": "string" } }, "title": "payment_intent_payment_method_options_mandate_options_param", "type": "object", "x-stripeMostCommon": [ "custom_mandate_url", "interval_description", "payment_schedule", "transaction_type" ] }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "", "none", "off_session", "on_session" ], "type": "string" }, "target_date": { "description": "Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.", "maxLength": 5000, "type": "string" }, "verification_method": { "description": "Bank account verification method.", "enum": [ "automatic", "instant", "microdeposits" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "payment_intent_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "financial_connections", "mandate_options", "setup_future_usage", "target_date", "verification_method" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `acss_debit` PaymentMethod, this sub-hash contains details about the ACSS Debit payment method options." }, "affirm": { "anyOf": [ { "properties": { "capture_method": { "description": "Controls when the funds are captured from the customer's account.\n\nIf provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.", "enum": [ "", "manual" ], "type": "string" }, "preferred_locale": { "description": "Preferred language of the Affirm authorization page that the customer is redirected to.", "maxLength": 30, "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "capture_method", "preferred_locale", "purchase_details", "request_multicapture", "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is an `affirm` PaymentMethod, this sub-hash contains details about the Affirm payment method options." }, "afterpay_clearpay": { "anyOf": [ { "properties": { "capture_method": { "description": "Controls when the funds are captured from the customer's account.\n\nIf provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.", "enum": [ "", "manual" ], "type": "string" }, "reference": { "description": "An internal identifier or reference that this payment corresponds to. You must limit the identifier to 128 characters, and it can only contain letters, numbers, underscores, backslashes, and dashes.\nThis field differs from the statement descriptor and item name.", "maxLength": 128, "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "none" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "capture_method", "reference", "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `afterpay_clearpay` PaymentMethod, this sub-hash contains details about the Afterpay Clearpay payment method options." }, "alipay": { "anyOf": [ { "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "", "none", "off_session" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `alipay` PaymentMethod, this sub-hash contains details about the Alipay payment method options." }, "alma": { "anyOf": [ { "properties": { "capture_method": { "description": "Controls when the funds are captured from the customer's account.\n\nIf provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.", "enum": [ "", "manual" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "capture_method" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `alma` PaymentMethod, this sub-hash contains details about the Alma payment method options." }, "amazon_pay": { "anyOf": [ { "properties": { "capture_method": { "description": "Controls when the funds are captured from the customer's account.\n\nIf provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.", "enum": [ "", "manual" ], "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "", "none", "off_session" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "capture_method", "charge_metadata", "charge_permission_id", "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `amazon_pay` PaymentMethod, this sub-hash contains details about the Amazon Pay payment method options." }, "au_becs_debit": { "anyOf": [ { "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "", "none", "off_session", "on_session" ], "type": "string" }, "target_date": { "description": "Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.", "maxLength": 5000, "type": "string" } }, "title": "payment_intent_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "setup_future_usage", "target_date" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `au_becs_debit` PaymentMethod, this sub-hash contains details about the AU BECS Direct Debit payment method options." }, "bacs_debit": { "anyOf": [ { "properties": { "mandate_options": { "description": "Additional fields for Mandate creation", "properties": { "reference_prefix": { "anyOf": [ { "maxLength": 12, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'." } }, "title": "payment_method_options_mandate_options_param", "type": "object", "x-stripeMostCommon": [ "reference_prefix" ] }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "", "none", "off_session", "on_session" ], "type": "string" }, "target_date": { "description": "Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.", "maxLength": 5000, "type": "string" } }, "title": "payment_intent_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "mandate_options", "setup_future_usage", "target_date" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `bacs_debit` PaymentMethod, this sub-hash contains details about the BACS Debit payment method options." }, "bancontact": { "anyOf": [ { "properties": { "preferred_language": { "description": "Preferred language of the Bancontact authorization page that the customer is redirected to.", "enum": [ "de", "en", "fr", "nl" ], "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "", "none", "off_session" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "preferred_language", "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `bancontact` PaymentMethod, this sub-hash contains details about the Bancontact payment method options." }, "billie": { "anyOf": [ { "properties": { "capture_method": { "description": "Controls when the funds are captured from the customer's account.\n\nIf provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.", "enum": [ "", "manual" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "capture_method", "company_details", "extra_merchant_data_blob", "reference", "request_extended_authorization", "request_multicapture", "request_overcapture" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `billie` PaymentMethod, this sub-hash contains details about the Billie payment method options." }, "blik": { "anyOf": [ { "properties": { "code": { "description": "The 6-digit BLIK code that a customer has generated using their banking application. Can only be set on confirmation.", "maxLength": 5000, "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "", "none" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "payment_intent_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "code", "mandate_options", "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `blik` PaymentMethod, this sub-hash contains details about the BLIK payment method options." }, "boleto": { "anyOf": [ { "properties": { "expires_after_days": { "description": "The number of calendar days before a Boleto voucher expires. For example, if you create a Boleto voucher on Monday and you set expires_after_days to 2, the Boleto invoice will expire on Wednesday at 23:59 America/Sao_Paulo time.", "type": "integer" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "", "none", "off_session", "on_session" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "expires_after_days", "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `boleto` PaymentMethod, this sub-hash contains details about the Boleto payment method options." }, "card": { "anyOf": [ { "properties": { "capture_method": { "description": "Controls when the funds are captured from the customer's account.\n\nIf provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.", "enum": [ "", "manual" ], "type": "string", "x-stripeBypassValidation": true }, "cvc_token": { "description": "A single-use `cvc_update` Token that represents a card CVC value. When provided, the CVC value will be verified during the card payment attempt. This parameter can only be provided during confirmation.", "maxLength": 5000, "type": "string" }, "installments": { "description": "Installment configuration for payments attempted on this PaymentIntent.\n\nFor more information, see the [installments integration guide](https://stripe.com/docs/payments/installments).", "properties": { "enabled": { "description": "Setting to true enables installments for this PaymentIntent.\nThis will cause the response to contain a list of available installment plans.\nSetting to false will prevent any selected plan from applying to a charge.", "type": "boolean" }, "plan": { "anyOf": [ { "properties": { "count": { "description": "For `fixed_count` installment plans, this is required. It represents the number of installment payments your customer will make to their credit card.", "type": "integer" }, "interval": { "description": "For `fixed_count` installment plans, this is required. It represents the interval between installment payments your customer will make to their credit card.\nOne of `month`.", "enum": [ "month" ], "type": "string" }, "type": { "description": "Type of installment plan, one of `fixed_count`, `bonus`, or `revolving`.", "enum": [ "bonus", "fixed_count", "revolving" ], "type": "string" } }, "required": [ "type" ], "title": "installment_plan", "type": "object", "x-stripeMostCommon": [ "count", "interval", "type" ] }, { "enum": [ "" ], "type": "string" } ], "description": "The selected installment plan to use for this payment attempt.\nThis parameter can only be provided during confirmation." } }, "title": "installments_param", "type": "object", "x-stripeMostCommon": [ "enabled", "plan" ] }, "mandate_options": { "description": "Configuration options for setting up an eMandate for cards issued in India.", "properties": { "amount": { "description": "Amount to be charged for future payments.", "type": "integer" }, "amount_type": { "description": "One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.", "enum": [ "fixed", "maximum" ], "type": "string" }, "description": { "description": "A description of the mandate or subscription that is meant to be displayed to the customer.", "maxLength": 200, "type": "string" }, "end_date": { "description": "End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.", "format": "unix-time", "type": "integer" }, "interval": { "description": "Specifies payment frequency. One of `day`, `week`, `month`, `year`, or `sporadic`.", "enum": [ "day", "month", "sporadic", "week", "year" ], "type": "string" }, "interval_count": { "description": "The number of intervals between payments. For example, `interval=month` and `interval_count=3` indicates one payment every three months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). This parameter is optional when `interval=sporadic`.", "type": "integer" }, "reference": { "description": "Unique identifier for the mandate or subscription.", "maxLength": 80, "type": "string" }, "start_date": { "description": "Start date of the mandate or subscription. Start date should not be lesser than yesterday.", "format": "unix-time", "type": "integer" }, "supported_types": { "description": "Specifies the type of mandates supported. Possible values are `india`.", "items": { "enum": [ "india" ], "type": "string" }, "type": "array" } }, "required": [ "amount", "amount_type", "interval", "reference", "start_date" ], "title": "mandate_options_param", "type": "object", "x-stripeMostCommon": [ "amount", "amount_type", "description", "end_date", "interval", "interval_count", "reference", "start_date", "supported_types" ] }, "moto": { "description": "When specified, this parameter indicates that a transaction will be marked\nas MOTO (Mail Order Telephone Order) and thus out of scope for SCA. This\nparameter can only be provided during confirmation.", "type": "boolean" }, "network": { "description": "Selected network to process this PaymentIntent on. Depends on the available networks of the card attached to the PaymentIntent. Can be only set confirm-time.", "enum": [ "amex", "cartes_bancaires", "diners", "discover", "eftpos_au", "girocard", "interac", "jcb", "link", "mastercard", "unionpay", "unknown", "visa" ], "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true }, "request_decremental_authorization": { "description": "Request ability to [decrement the authorization](https://stripe.com/docs/payments/decremental-authorization) for this PaymentIntent.", "enum": [ "if_available", "never" ], "type": "string" }, "request_extended_authorization": { "description": "Request ability to [capture beyond the standard authorization validity window](https://stripe.com/docs/payments/extended-authorization) for this PaymentIntent.", "enum": [ "if_available", "never" ], "type": "string" }, "request_incremental_authorization": { "description": "Request ability to [increment the authorization](https://stripe.com/docs/payments/incremental-authorization) for this PaymentIntent.", "enum": [ "if_available", "never" ], "type": "string" }, "request_multicapture": { "description": "Request ability to make [multiple captures](https://stripe.com/docs/payments/multicapture) for this PaymentIntent.", "enum": [ "if_available", "never" ], "type": "string" }, "request_overcapture": { "description": "Request ability to [overcapture](https://stripe.com/docs/payments/overcapture) for this PaymentIntent.", "enum": [ "if_available", "never" ], "type": "string" }, "request_partial_authorization": { "description": "Request partial authorization on this PaymentIntent.", "enum": [ "if_available", "never" ], "type": "string" }, "request_three_d_secure": { "description": "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.", "enum": [ "any", "automatic", "challenge" ], "type": "string", "x-stripeBypassValidation": true }, "require_cvc_recollection": { "description": "When enabled, using a card that is attached to a customer will require the CVC to be provided again (i.e. using the cvc_token parameter).", "type": "boolean" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "", "none", "off_session", "on_session" ], "type": "string" }, "statement_descriptor_suffix_kana": { "anyOf": [ { "maxLength": 22, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Provides information about a card payment that customers see on their statements. Concatenated with the Kana prefix (shortened Kana descriptor) or Kana statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 22 characters." }, "statement_descriptor_suffix_kanji": { "anyOf": [ { "maxLength": 17, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Provides information about a card payment that customers see on their statements. Concatenated with the Kanji prefix (shortened Kanji descriptor) or Kanji statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 17 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 17 characters." }, "statement_details": { "anyOf": [ { "properties": { "address": { "description": "Please pass in an address that is within your Stripe user account country", "properties": { "city": { "description": "City, district, suburb, town, or village.", "maxLength": 5000, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Address line 1 (e.g., street, PO Box, or company name).", "maxLength": 5000, "type": "string" }, "line2": { "description": "Address line 2 (e.g., apartment, suite, unit, or building).", "maxLength": 5000, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "State, county, province, or region.", "maxLength": 5000, "type": "string" } }, "title": "statement_details_address_param", "type": "object", "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state" ] }, "phone": { "description": "Phone number (e.g., a toll-free number that customers can call)", "maxLength": 5000, "type": "string" } }, "title": "statement_details_param", "type": "object", "x-stripeMostCommon": [ "address", "phone" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Statement details for this payment intent. You can use this to override the merchant details shown on your customers' statements." }, "three_d_secure": { "description": "If 3D Secure authentication was performed with a third-party provider,\nthe authentication details to use for this payment.", "properties": { "ares_trans_status": { "description": "The `transStatus` returned from the card Issuer’s ACS in the ARes.", "enum": [ "A", "C", "I", "N", "R", "U", "Y" ], "type": "string" }, "cryptogram": { "description": "The cryptogram, also known as the \"authentication value\" (AAV, CAVV or\nAEVV). This value is 20 bytes, base64-encoded into a 28-character string.\n(Most 3D Secure providers will return the base64-encoded version, which\nis what you should specify here.)", "maxLength": 5000, "type": "string" }, "electronic_commerce_indicator": { "description": "The Electronic Commerce Indicator (ECI) is returned by your 3D Secure\nprovider and indicates what degree of authentication was performed.", "enum": [ "01", "02", "05", "06", "07" ], "type": "string", "x-stripeBypassValidation": true }, "exemption_indicator": { "description": "The exemption requested via 3DS and accepted by the issuer at authentication time.", "enum": [ "low_risk", "none" ], "type": "string" }, "network_options": { "description": "Network specific 3DS fields. Network specific arguments require an\nexplicit card brand choice. The parameter `payment_method_options.card.network``\nmust be populated accordingly", "properties": { "cartes_bancaires": { "description": "Cartes Bancaires-specific 3DS fields.", "properties": { "cb_avalgo": { "description": "The cryptogram calculation algorithm used by the card Issuer's ACS\nto calculate the Authentication cryptogram. Also known as `cavvAlgorithm`.\nmessageExtension: CB-AVALGO", "enum": [ "0", "1", "2", "3", "4", "A" ], "type": "string" }, "cb_exemption": { "description": "The exemption indicator returned from Cartes Bancaires in the ARes.\nmessage extension: CB-EXEMPTION; string (4 characters)\nThis is a 3 byte bitmap (low significant byte first and most significant\nbit first) that has been Base64 encoded", "maxLength": 4, "type": "string" }, "cb_score": { "description": "The risk score returned from Cartes Bancaires in the ARes.\nmessage extension: CB-SCORE; numeric value 0-99", "type": "integer" } }, "required": [ "cb_avalgo" ], "title": "cartes_bancaires_network_options_param", "type": "object", "x-stripeMostCommon": [ "cb_avalgo", "cb_exemption", "cb_score" ] } }, "title": "network_options_param", "type": "object", "x-stripeMostCommon": [ "cartes_bancaires" ] }, "requestor_challenge_indicator": { "description": "The challenge indicator (`threeDSRequestorChallengeInd`) which was requested in the\nAReq sent to the card Issuer's ACS. A string containing 2 digits from 01-99.", "maxLength": 2, "type": "string" }, "transaction_id": { "description": "For 3D Secure 1, the XID. For 3D Secure 2, the Directory Server\nTransaction ID (dsTransID).", "maxLength": 5000, "type": "string" }, "version": { "description": "The version of 3D Secure that was performed.", "enum": [ "1.0.2", "2.1.0", "2.2.0" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "cryptogram", "transaction_id", "version" ], "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "ares_trans_status", "cryptogram", "electronic_commerce_indicator", "exemption_indicator", "network_options", "requestor_challenge_indicator", "transaction_id", "version" ] } }, "title": "payment_intent_param", "type": "object", "x-stripeMostCommon": [ "allow_partial_amount", "buy_now_pay_later_options", "capture_delay_days", "capture_method", "commerce_type", "cvc_token", "installments", "mandate_options", "mcc", "mit_exemption", "moto", "network", "network_options", "network_token", "recipient_details", "request_decremental_authorization", "request_extended_authorization", "request_flexible_extended_authorization", "request_incremental_authorization", "request_incremental_authorization_support", "request_multicapture", "request_overcapture", "request_partial_authorization", "request_reauthorization", "request_three_d_secure", "require_cvc_recollection", "sender_details", "setup_future_usage", "statement_descriptor_suffix_kana", "statement_descriptor_suffix_kanji", "statement_details", "stored_credential_transaction_type", "stored_credential_usage", "three_d_secure", "transaction_purpose" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Configuration for any card payments attempted on this PaymentIntent." }, "card_present": { "anyOf": [ { "properties": { "request_extended_authorization": { "description": "Request ability to capture this payment beyond the standard [authorization validity window](https://stripe.com/docs/terminal/features/extended-authorizations#authorization-validity)", "type": "boolean" }, "request_incremental_authorization_support": { "description": "Request ability to [increment](https://stripe.com/docs/terminal/features/incremental-authorizations) this PaymentIntent if the combination of MCC and card brand is eligible. Check [incremental_authorization_supported](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported) in the [Confirm](https://stripe.com/docs/api/payment_intents/confirm) response to verify support.", "type": "boolean" }, "routing": { "description": "Network routing priority on co-branded EMV cards supporting domestic debit and international card schemes.", "properties": { "requested_priority": { "description": "Routing requested priority", "enum": [ "domestic", "international" ], "type": "string" } }, "title": "routing_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "requested_priority" ] } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "buy_now_pay_later_options", "capture_method", "request_extended_authorization", "request_flexible_extended_authorization", "request_incremental_authorization", "request_incremental_authorization_support", "request_partial_authorization", "request_reauthorization", "routing" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `card_present` PaymentMethod, this sub-hash contains details about the Card Present payment method options." }, "cashapp": { "anyOf": [ { "properties": { "capture_method": { "description": "Controls when the funds are captured from the customer's account.\n\nIf provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.", "enum": [ "", "manual" ], "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "", "none", "off_session", "on_session" ], "type": "string" } }, "title": "payment_intent_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "capture_method", "request_incremental_authorization", "restricted_transaction_categories", "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `cashapp` PaymentMethod, this sub-hash contains details about the Cash App Pay payment method options." }, "crypto": { "anyOf": [ { "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "none" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "mode", "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `crypto` PaymentMethod, this sub-hash contains details about the Crypto payment method options." }, "customer_balance": { "anyOf": [ { "properties": { "bank_transfer": { "description": "Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`.", "properties": { "eu_bank_transfer": { "description": "Configuration for the eu_bank_transfer funding type.", "properties": { "country": { "description": "The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`.", "maxLength": 5000, "type": "string" } }, "required": [ "country" ], "title": "eu_bank_transfer_params", "type": "object", "x-stripeMostCommon": [ "country" ] }, "requested_address_types": { "description": "List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.\n\nPermitted values include: `sort_code`, `zengin`, `iban`, or `spei`.", "items": { "enum": [ "aba", "iban", "sepa", "sort_code", "spei", "swift", "zengin" ], "type": "string", "x-stripeBypassValidation": true }, "type": "array" }, "type": { "description": "The list of bank transfer types that this PaymentIntent is allowed to use for funding Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.", "enum": [ "eu_bank_transfer", "gb_bank_transfer", "jp_bank_transfer", "mx_bank_transfer", "us_bank_transfer" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "bank_transfer_param", "type": "object", "x-stripeMostCommon": [ "eu_bank_transfer", "id_bank_account", "id_bank_transfer", "requested_address_types", "type" ] }, "funding_type": { "description": "The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.", "enum": [ "bank_transfer" ], "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "none" ], "type": "string" } }, "title": "payment_intent_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "bank_transfer", "funding_type", "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `customer balance` PaymentMethod, this sub-hash contains details about the customer balance payment method options." }, "eps": { "anyOf": [ { "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "none" ], "type": "string" } }, "title": "payment_intent_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `eps` PaymentMethod, this sub-hash contains details about the EPS payment method options." }, "fpx": { "anyOf": [ { "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `fpx` PaymentMethod, this sub-hash contains details about the FPX payment method options." }, "giropay": { "anyOf": [ { "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `giropay` PaymentMethod, this sub-hash contains details about the Giropay payment method options." }, "gopay": { "anyOf": [ { "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "none", "off_session" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `gopay` PaymentMethod, this sub-hash contains details about the Gopay payment method options." }, "grabpay": { "anyOf": [ { "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `grabpay` PaymentMethod, this sub-hash contains details about the Grabpay payment method options." }, "id_bank_transfer": { "anyOf": [ { "properties": { "expires_after": { "description": "The UNIX timestamp until which the virtual bank account is valid. Permitted range is from 5 minutes from now until 31 days from now. If unset, it defaults to 3 days from now.", "type": "integer" }, "expires_at": { "description": "The UNIX timestamp until which the virtual bank account is valid. Permitted range is from now until 30 days from now. If unset, it defaults to 1 days from now.", "format": "unix-time", "type": "integer" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "none" ], "type": "string" } }, "title": "payment_intent_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "expires_after", "expires_at", "on_existing_payment_intent", "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `id_bank_transfer` PaymentMethod, this sub-hash contains details about the Indonesia Bank Transfer payment method options." }, "ideal": { "anyOf": [ { "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "", "none", "off_session" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `ideal` PaymentMethod, this sub-hash contains details about the Ideal payment method options." }, "interac_present": { "anyOf": [ { "properties": {}, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `interac_present` PaymentMethod, this sub-hash contains details about the Card Present payment method options." }, "kakao_pay": { "anyOf": [ { "properties": { "capture_method": { "description": "Controls when the funds are captured from the customer's account.\n\nIf provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.", "enum": [ "", "manual" ], "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "", "none", "off_session" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "capture_method", "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `kakao_pay` PaymentMethod, this sub-hash contains details about the Kakao Pay payment method options." }, "klarna": { "anyOf": [ { "properties": { "capture_method": { "description": "Controls when the funds are captured from the customer's account.\n\nIf provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.", "enum": [ "", "manual" ], "type": "string" }, "on_demand": { "description": "On-demand details if setting up or charging an on-demand payment.", "properties": { "average_amount": { "description": "Your average amount value. You can use a value across your customer base, or segment based on customer type, country, etc.", "type": "integer" }, "maximum_amount": { "description": "The maximum value you may charge a customer per purchase. You can use a value across your customer base, or segment based on customer type, country, etc.", "type": "integer" }, "minimum_amount": { "description": "The lowest or minimum value you may charge a customer per purchase. You can use a value across your customer base, or segment based on customer type, country, etc.", "type": "integer" }, "purchase_interval": { "description": "Interval at which the customer is making purchases", "enum": [ "day", "month", "week", "year" ], "type": "string" }, "purchase_interval_count": { "description": "The number of `purchase_interval` between charges", "type": "integer" } }, "title": "on_demand_param", "type": "object", "x-stripeMostCommon": [ "average_amount", "maximum_amount", "minimum_amount", "purchase_interval", "purchase_interval_count" ] }, "preferred_locale": { "description": "Preferred language of the Klarna authorization page that the customer is redirected to", "enum": [ "cs-CZ", "da-DK", "de-AT", "de-CH", "de-DE", "el-GR", "en-AT", "en-AU", "en-BE", "en-CA", "en-CH", "en-CZ", "en-DE", "en-DK", "en-ES", "en-FI", "en-FR", "en-GB", "en-GR", "en-IE", "en-IT", "en-NL", "en-NO", "en-NZ", "en-PL", "en-PT", "en-RO", "en-SE", "en-US", "es-ES", "es-US", "fi-FI", "fr-BE", "fr-CA", "fr-CH", "fr-FR", "it-CH", "it-IT", "nb-NO", "nl-BE", "nl-NL", "pl-PL", "pt-PT", "ro-RO", "sv-FI", "sv-SE" ], "type": "string", "x-stripeBypassValidation": true }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "none", "off_session", "on_session" ], "type": "string" }, "subscriptions": { "anyOf": [ { "items": { "properties": { "interval": { "description": "Unit of time between subscription charges.", "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "description": "The number of intervals (specified in the `interval` attribute) between subscription charges. For example, `interval=month` and `interval_count=3` charges every 3 months.", "type": "integer" }, "name": { "description": "Name for subscription.", "maxLength": 255, "type": "string" }, "next_billing": { "description": "Describes the upcoming charge for this subscription.", "properties": { "amount": { "description": "The amount of the next charge for the subscription.", "type": "integer" }, "date": { "description": "The date of the next charge for the subscription in YYYY-MM-DD format.", "maxLength": 5000, "type": "string" } }, "required": [ "amount", "date" ], "title": "subscription_next_billing_param", "type": "object", "x-stripeMostCommon": [ "amount", "date" ] }, "reference": { "description": "A non-customer-facing reference to correlate subscription charges in the Klarna app. Use a value that persists across subscription charges.", "maxLength": 255, "type": "string" } }, "required": [ "interval", "reference" ], "title": "subscription_param", "type": "object", "x-stripeMostCommon": [ "interval", "interval_count", "name", "next_billing", "reference" ] }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "Subscription details if setting up or charging a subscription." } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "capture_method", "extra_merchant_data_blob", "interoperability_token", "line_items", "on_demand", "partner_confirmation_token", "payment_details", "payment_method_category", "payment_option_id", "preferred_locale", "request_incremental_authorization", "request_multicapture", "setup_future_usage", "subscriptions", "supplementary_purchase_data" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `klarna` PaymentMethod, this sub-hash contains details about the Klarna payment method options." }, "konbini": { "anyOf": [ { "properties": { "confirmation_number": { "anyOf": [ { "maxLength": 11, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "An optional 10 to 11 digit numeric-only string determining the confirmation code at applicable convenience stores. Must not consist of only zeroes and could be rejected in case of insufficient uniqueness. We recommend to use the customer's phone number." }, "expires_after_days": { "anyOf": [ { "type": "integer" }, { "enum": [ "" ], "type": "string" } ], "description": "The number of calendar days (between 1 and 60) after which Konbini payment instructions will expire. For example, if a PaymentIntent is confirmed with Konbini and `expires_after_days` set to 2 on Monday JST, the instructions will expire on Wednesday 23:59:59 JST. Defaults to 3 days." }, "expires_at": { "anyOf": [ { "format": "unix-time", "type": "integer" }, { "enum": [ "" ], "type": "string" } ], "description": "The timestamp at which the Konbini payment instructions will expire. Only one of `expires_after_days` or `expires_at` may be set." }, "product_description": { "anyOf": [ { "maxLength": 22, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "A product descriptor of up to 22 characters, which will appear to customers at the convenience store." }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "confirmation_number", "expires_after_days", "expires_at", "fee_amount", "product_description", "setup_future_usage", "tax_amount" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `konbini` PaymentMethod, this sub-hash contains details about the Konbini payment method options." }, "kr_card": { "anyOf": [ { "properties": { "capture_method": { "description": "Controls when the funds are captured from the customer's account.\n\nIf provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.", "enum": [ "", "manual" ], "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "", "none", "off_session" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "capture_method", "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `kr_card` PaymentMethod, this sub-hash contains details about the KR Card payment method options." }, "link": { "anyOf": [ { "properties": { "capture_method": { "description": "Controls when the funds are captured from the customer's account.\n\nIf provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.", "enum": [ "", "manual" ], "type": "string" }, "persistent_token": { "description": "[Deprecated] This is a legacy parameter that no longer has any function.", "maxLength": 5000, "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "", "none", "off_session" ], "type": "string" } }, "title": "payment_intent_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "capture_method", "persistent_token", "request_multicapture", "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `link` PaymentMethod, this sub-hash contains details about the Link payment method options." }, "mb_way": { "anyOf": [ { "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `mb_way` PaymentMethod, this sub-hash contains details about the MB WAY payment method options." }, "mobilepay": { "anyOf": [ { "properties": { "capture_method": { "description": "Controls when the funds are captured from the customer's account.\n\nIf provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.", "enum": [ "", "manual" ], "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "capture_method", "reference", "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `MobilePay` PaymentMethod, this sub-hash contains details about the MobilePay payment method options." }, "multibanco": { "anyOf": [ { "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `multibanco` PaymentMethod, this sub-hash contains details about the Multibanco payment method options." }, "naver_pay": { "anyOf": [ { "properties": { "capture_method": { "description": "Controls when the funds are captured from the customer's account.\n\nIf provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.", "enum": [ "", "manual" ], "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "", "none", "off_session" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "capture_method", "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `naver_pay` PaymentMethod, this sub-hash contains details about the Naver Pay payment method options." }, "nz_bank_account": { "anyOf": [ { "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "", "none", "off_session", "on_session" ], "type": "string" }, "target_date": { "description": "Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.", "maxLength": 5000, "type": "string" } }, "title": "payment_intent_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "setup_future_usage", "target_date" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `nz_bank_account` PaymentMethod, this sub-hash contains details about the NZ BECS Direct Debit payment method options." }, "oxxo": { "anyOf": [ { "properties": { "expires_after_days": { "description": "The number of calendar days before an OXXO voucher expires. For example, if you create an OXXO voucher on Monday and you set expires_after_days to 2, the OXXO invoice will expire on Wednesday at 23:59 America/Mexico_City time.", "type": "integer" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "expires_after_days", "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `oxxo` PaymentMethod, this sub-hash contains details about the OXXO payment method options." }, "p24": { "anyOf": [ { "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "none" ], "type": "string" }, "tos_shown_and_accepted": { "description": "Confirm that the payer has accepted the P24 terms and conditions.", "type": "boolean" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "installments", "setup_future_usage", "tos_shown_and_accepted" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `p24` PaymentMethod, this sub-hash contains details about the Przelewy24 payment method options." }, "pay_by_bank": { "anyOf": [ { "properties": {}, "title": "payment_intent_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "allow_delayed_notification", "country", "locale", "statement_descriptor" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `pay_by_bank` PaymentMethod, this sub-hash contains details about the PayByBank payment method options." }, "payco": { "anyOf": [ { "properties": { "capture_method": { "description": "Controls when the funds are captured from the customer's account.\n\nIf provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.", "enum": [ "", "manual" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "capture_method" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `payco` PaymentMethod, this sub-hash contains details about the PAYCO payment method options." }, "paynow": { "anyOf": [ { "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `paynow` PaymentMethod, this sub-hash contains details about the PayNow payment method options." }, "paypal": { "anyOf": [ { "properties": { "capture_method": { "description": "Controls when the funds will be captured from the customer's account.", "enum": [ "", "manual" ], "type": "string" }, "line_items": { "description": "The line items purchased by the customer.", "items": { "properties": { "category": { "description": "Type of the line item.", "enum": [ "digital_goods", "donation", "physical_goods" ], "type": "string" }, "description": { "description": "Description of the line item.", "maxLength": 127, "type": "string" }, "name": { "description": "Descriptive name of the line item.", "maxLength": 127, "type": "string" }, "quantity": { "description": "Quantity of the line item. Must be a positive number.", "type": "integer" }, "sku": { "description": "Client facing stock keeping unit, article number or similar.", "maxLength": 127, "type": "string" }, "sold_by": { "description": "The Stripe account ID of the connected account that sells the item.", "maxLength": 5000, "type": "string" }, "tax": { "description": "The tax information for the line item.", "properties": { "amount": { "description": "The tax for a single unit of the line item in minor units. Cannot be a negative number.", "type": "integer" }, "behavior": { "description": "The tax behavior for the line item.", "enum": [ "exclusive", "inclusive" ], "type": "string" } }, "required": [ "amount", "behavior" ], "title": "line_item_tax_param", "type": "object", "x-stripeMostCommon": [ "amount", "behavior" ] }, "unit_amount": { "description": "Price for a single unit of the line item in minor units. Cannot be a negative number.", "type": "integer" } }, "required": [ "name", "quantity", "unit_amount" ], "title": "line_item_param", "type": "object", "x-stripeMostCommon": [ "category", "description", "name", "quantity", "sku", "sold_by", "tax", "unit_amount" ] }, "type": "array" }, "preferred_locale": { "description": "[Preferred locale](https://stripe.com/docs/payments/paypal/supported-locales) of the PayPal checkout page that the customer is redirected to.", "enum": [ "cs-CZ", "da-DK", "de-AT", "de-DE", "de-LU", "el-GR", "en-GB", "en-US", "es-ES", "fi-FI", "fr-BE", "fr-FR", "fr-LU", "hu-HU", "it-IT", "nl-BE", "nl-NL", "pl-PL", "pt-PT", "sk-SK", "sv-SE" ], "type": "string", "x-stripeBypassValidation": true }, "reference": { "description": "A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID.", "maxLength": 127, "type": "string" }, "reference_id": { "description": "A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID.", "maxLength": 127, "type": "string" }, "risk_correlation_id": { "description": "The risk correlation ID for an on-session payment using a saved PayPal payment method.", "maxLength": 32, "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "", "none", "off_session" ], "type": "string" }, "subsellers": { "description": "The Stripe connected account IDs of the sellers on the platform for this transaction (optional). Only allowed when [separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers) are used.", "items": { "maxLength": 32, "type": "string" }, "type": "array" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "allow_delayed_notification", "capture_method", "line_items", "preferred_locale", "reference", "reference_id", "risk_correlation_id", "setup_future_usage", "subsellers" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `paypal` PaymentMethod, this sub-hash contains details about the PayPal payment method options." }, "paypay": { "anyOf": [ { "properties": { "capture_method": { "description": "Controls when the funds are captured from the customer's account.\n\nIf provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.", "enum": [ "", "manual" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "capture_method" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `paypay` PaymentMethod, this sub-hash contains details about the PayPay payment method options." }, "payto": { "anyOf": [ { "properties": { "mandate_options": { "description": "Additional fields for Mandate creation. Only `purpose` field is configurable for PayTo PaymentIntent with `setup_future_usage=none`. Other fields are only applicable to PayTo PaymentIntent with `setup_future_usage=off_session`", "properties": { "amount": { "description": "Amount that will be collected. It is required when `amount_type` is `fixed`.", "type": "integer" }, "amount_type": { "description": "The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively.", "enum": [ "fixed", "maximum" ], "type": "string" }, "end_date": { "description": "Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.", "maxLength": 5000, "type": "string" }, "payment_schedule": { "description": "The periodicity at which payments will be collected.", "enum": [ "adhoc", "annual", "daily", "fortnightly", "monthly", "quarterly", "semi_annual", "weekly" ], "type": "string" }, "payments_per_period": { "description": "The number of payments that will be made during a payment period. Defaults to 1 except for when `payment_schedule` is `adhoc`. In that case, it defaults to no limit.", "type": "integer" }, "purpose": { "description": "The purpose for which payments are made. Defaults to retail.", "enum": [ "dependant_support", "government", "loan", "mortgage", "other", "pension", "personal", "retail", "salary", "tax", "utility" ], "type": "string" } }, "title": "payment_intent_payment_method_options_mandate_options_param", "type": "object", "x-stripeMostCommon": [ "amount", "amount_type", "end_date", "payment_schedule", "payments_per_period", "purpose" ] }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "", "none", "off_session" ], "type": "string" } }, "title": "payment_intent_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "mandate_options", "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `payto` PaymentMethod, this sub-hash contains details about the PayTo payment method options." }, "pix": { "anyOf": [ { "properties": { "amount_includes_iof": { "description": "Determines if the amount includes the IOF tax. Defaults to `never`.", "enum": [ "always", "never" ], "type": "string" }, "expires_after_seconds": { "description": "The number of seconds (between 10 and 1209600) after which Pix payment will expire. Defaults to 86400 seconds.", "type": "integer" }, "expires_at": { "description": "The timestamp at which the Pix expires (between 10 and 1209600 seconds in the future). Defaults to 1 day in the future.", "format": "unix-time", "type": "integer" }, "mandate_options": { "description": "Additional fields for mandate creation. Only applicable when `setup_future_usage=off_session`.", "properties": { "amount": { "description": "Amount to be charged for future payments. Required when `amount_type=fixed`. If not provided for `amount_type=maximum`, defaults to 40000.", "type": "integer" }, "amount_includes_iof": { "description": "Determines if the amount includes the IOF tax. Defaults to `never`.", "enum": [ "always", "never" ], "type": "string" }, "amount_type": { "description": "Type of amount. Defaults to `maximum`.", "enum": [ "fixed", "maximum" ], "type": "string" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Only `brl` is supported currently.", "format": "currency", "type": "string" }, "end_date": { "description": "Date when the mandate expires and no further payments will be charged, in `YYYY-MM-DD`. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.", "maxLength": 5000, "type": "string" }, "payment_schedule": { "description": "Schedule at which the future payments will be charged. Defaults to `weekly`.", "enum": [ "halfyearly", "monthly", "quarterly", "weekly", "yearly" ], "type": "string" }, "reference": { "description": "Subscription name displayed to buyers in their bank app. Defaults to the displayable business name.", "maxLength": 35, "type": "string" }, "start_date": { "description": "Start date of the mandate, in `YYYY-MM-DD`. Start date should be at least 3 days in the future. Defaults to 3 days after the current date.", "maxLength": 5000, "type": "string" } }, "title": "payment_method_options_mandate_options_param", "type": "object", "x-stripeMostCommon": [ "amount", "amount_includes_iof", "amount_type", "currency", "end_date", "payment_schedule", "reference", "start_date" ] }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "none", "off_session" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "amount_includes_iof", "expires_after_seconds", "expires_at", "mandate_options", "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `pix` PaymentMethod, this sub-hash contains details about the Pix payment method options." }, "promptpay": { "anyOf": [ { "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `promptpay` PaymentMethod, this sub-hash contains details about the PromptPay payment method options." }, "qris": { "anyOf": [ { "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `qris` PaymentMethod, this sub-hash contains details about the QRIS payment method options." }, "rechnung": { "anyOf": [ { "properties": {}, "title": "payment_intent_payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `rechnung` PaymentMethod, this sub-hash contains details about the Rechnung payment method options." }, "revolut_pay": { "anyOf": [ { "properties": { "capture_method": { "description": "Controls when the funds are captured from the customer's account.\n\nIf provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.", "enum": [ "", "manual" ], "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "", "none", "off_session" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "capture_method", "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `revolut_pay` PaymentMethod, this sub-hash contains details about the Revolut Pay payment method options." }, "samsung_pay": { "anyOf": [ { "properties": { "capture_method": { "description": "Controls when the funds are captured from the customer's account.\n\nIf provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.", "enum": [ "", "manual" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "capture_method" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `samsung_pay` PaymentMethod, this sub-hash contains details about the Samsung Pay payment method options." }, "satispay": { "anyOf": [ { "properties": { "capture_method": { "description": "Controls when the funds are captured from the customer's account.\n\nIf provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.", "enum": [ "", "manual" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "capture_method", "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `satispay` PaymentMethod, this sub-hash contains details about the Satispay payment method options." }, "sepa_debit": { "anyOf": [ { "properties": { "mandate_options": { "description": "Additional fields for Mandate creation", "properties": { "reference_prefix": { "anyOf": [ { "maxLength": 12, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'." } }, "title": "payment_method_options_mandate_options_param", "type": "object", "x-stripeMostCommon": [ "reference", "reference_prefix" ] }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "", "none", "off_session", "on_session" ], "type": "string" }, "target_date": { "description": "Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.", "maxLength": 5000, "type": "string" } }, "title": "payment_intent_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "mandate_options", "setup_future_usage", "target_date", "verification_method" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `sepa_debit` PaymentIntent, this sub-hash contains details about the SEPA Debit payment method options." }, "shopeepay": { "anyOf": [ { "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `shopeepay` PaymentMethod, this sub-hash contains details about the ShopeePay payment method options." }, "sofort": { "anyOf": [ { "properties": { "preferred_language": { "description": "Language shown to the payer on redirect.", "enum": [ "", "de", "en", "es", "fr", "it", "nl", "pl" ], "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "", "none", "off_session" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "preferred_language", "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `sofort` PaymentMethod, this sub-hash contains details about the SOFORT payment method options." }, "stripe_balance": { "anyOf": [ { "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "", "none", "off_session" ], "type": "string" } }, "title": "payment_intent_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `stripe_balance` PaymentMethod, this sub-hash contains details about the Stripe Balance payment method options." }, "swish": { "anyOf": [ { "properties": { "reference": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "A reference for this payment to be displayed in the Swish app." }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "none" ], "type": "string" } }, "title": "payment_intent_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "authorization_method", "reference", "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `Swish` PaymentMethod, this sub-hash contains details about the Swish payment method options." }, "twint": { "anyOf": [ { "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `twint` PaymentMethod, this sub-hash contains details about the TWINT payment method options." }, "us_bank_account": { "anyOf": [ { "properties": { "financial_connections": { "description": "Additional fields for Financial Connections Session creation", "properties": { "filters": { "description": "Provide filters for the linked accounts that the customer can select for the payment method.", "properties": { "account_subcategories": { "description": "The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.", "items": { "enum": [ "checking", "savings" ], "maxLength": 5000, "type": "string" }, "type": "array" }, "institution": { "description": "ID of the institution to use to filter for selectable accounts.", "maxLength": 5000, "type": "string" } }, "title": "linked_account_options_filters_param", "type": "object", "x-stripeMostCommon": [ "account_subcategories", "institution" ] }, "manual_entry": { "description": "Customize manual entry behavior", "properties": { "mode": { "description": "Settings for configuring manual entry of account details.", "enum": [ "automatic", "custom" ], "type": "string" } }, "required": [ "mode" ], "title": "linked_account_options_manual_entry_param", "type": "object", "x-stripeMostCommon": [ "mode" ] }, "permissions": { "description": "The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.", "items": { "enum": [ "balances", "ownership", "payment_method", "transactions" ], "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true }, "type": "array" }, "prefetch": { "description": "List of data features that you would like to retrieve upon account creation.", "items": { "enum": [ "balances", "inferred_balances", "ownership", "transactions" ], "type": "string", "x-stripeBypassValidation": true }, "type": "array" }, "return_url": { "description": "For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.", "maxLength": 5000, "type": "string" } }, "title": "linked_account_options_param", "type": "object", "x-stripeMostCommon": [ "filters", "manual_entry", "permissions", "prefetch", "return_url" ] }, "mandate_options": { "description": "Additional fields for Mandate creation", "properties": { "collection_method": { "description": "The method used to collect offline mandate customer acceptance.", "enum": [ "", "paper" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "mandate_options_param", "type": "object", "x-stripeMostCommon": [ "collection_method" ] }, "networks": { "description": "Additional fields for network related functions", "properties": { "requested": { "description": "Triggers validations to run across the selected networks", "items": { "enum": [ "ach", "us_domestic_wire" ], "type": "string" }, "type": "array" } }, "title": "networks_options_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "preferred_settlement_speed": { "description": "Preferred transaction settlement speed", "enum": [ "", "fastest", "standard" ], "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "", "none", "off_session", "on_session" ], "type": "string" }, "target_date": { "description": "Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.", "maxLength": 5000, "type": "string" }, "verification_method": { "description": "Bank account verification method.", "enum": [ "automatic", "instant", "microdeposits" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "payment_intent_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "financial_connections", "mandate_options", "networks", "preferred_settlement_speed", "setup_future_usage", "target_date", "verification_method" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `us_bank_account` PaymentMethod, this sub-hash contains details about the US bank account payment method options." }, "wechat_pay": { "anyOf": [ { "properties": { "app_id": { "description": "The app ID registered with WeChat Pay. Only required when client is ios or android.", "maxLength": 5000, "type": "string" }, "client": { "description": "The client type that the end customer will pay from", "enum": [ "android", "ios", "web" ], "type": "string", "x-stripeBypassValidation": true }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "app_id", "client", "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `wechat_pay` PaymentMethod, this sub-hash contains details about the WeChat Pay payment method options." }, "zip": { "anyOf": [ { "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `zip` PaymentMethod, this sub-hash contains details about the Zip payment method options." } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "acss_debit", "affirm", "afterpay_clearpay", "alipay", "alma", "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", "billie", "blik", "boleto", "boleto_pilot", "card", "card_present", "cashapp", "crypto", "customer_balance", "demo_pay", "dummy_auth_push", "dummy_passthrough_card", "eps", "fpx", "getbalance", "giropay", "gopay", "grabpay", "id_bank_transfer", "ideal", "interac_present", "kakao_pay", "klarna", "knet", "konbini", "kr_card", "kr_market", "link", "mb_way", "mobilepay", "mondu", "multibanco", "naver_pay", "ng_bank", "ng_bank_transfer", "ng_card", "ng_market", "ng_ussd", "nz_bank_account", "oxxo", "p24", "pay_by_bank", "payco", "paynow", "paypal", "paypay", "payto", "pix", "promptpay", "qris", "rechnung", "revolut_pay", "samsung_pay", "satispay", "sepa_debit", "shopeepay", "sofort", "stripe_balance", "swish", "twint", "upi", "us_bank_account", "vipps", "wechat_pay", "zip" ] }, "payment_method_types": { "description": "The list of payment method types (for example, card) that this PaymentIntent can use. Use `automatic_payment_methods` to manage payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods). A list of valid payment method types can be found [here](https://docs.stripe.com/api/payment_methods/object#payment_method_object-type).", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "receipt_email": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Email address that the receipt for the resulting payment will be sent to. If `receipt_email` is specified for a payment in live mode, a receipt will be sent regardless of your [email settings](https://dashboard.stripe.com/account/emails)." }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "", "off_session", "on_session" ], "type": "string" }, "shipping": { "anyOf": [ { "properties": { "address": { "description": "Shipping address.", "properties": { "city": { "description": "City, district, suburb, town, or village.", "maxLength": 5000, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Address line 1 (e.g., street, PO Box, or company name).", "maxLength": 5000, "type": "string" }, "line2": { "description": "Address line 2 (e.g., apartment, suite, unit, or building).", "maxLength": 5000, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "State, county, province, or region.", "maxLength": 5000, "type": "string" } }, "title": "optional_fields_address", "type": "object", "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state" ] }, "carrier": { "description": "The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.", "maxLength": 5000, "type": "string" }, "name": { "description": "Recipient name.", "maxLength": 5000, "type": "string" }, "phone": { "description": "Recipient phone (including extension).", "maxLength": 5000, "type": "string" }, "tracking_number": { "description": "The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.", "maxLength": 5000, "type": "string" } }, "required": [ "address", "name" ], "title": "optional_fields_shipping", "type": "object", "x-stripeMostCommon": [ "address", "carrier", "name", "phone", "tracking_number" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Shipping information for this PaymentIntent." }, "statement_descriptor": { "description": "Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).\n\nSetting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead.", "maxLength": 22, "type": "string" }, "statement_descriptor_suffix": { "description": "Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement.", "maxLength": 22, "type": "string" }, "transfer_data": { "description": "Use this parameter to automatically create a Transfer when the payment succeeds. Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).", "properties": { "amount": { "description": "The amount that will be transferred automatically when a charge succeeds.", "type": "integer" } }, "title": "transfer_data_update_params", "type": "object", "x-stripeMostCommon": [ "amount", "description", "metadata", "payment_data" ] }, "transfer_group": { "description": "A string that identifies the resulting payment as part of a group. You can only provide `transfer_group` if it hasn't been set. Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).", "type": "string" } }, "type": "object", "x-stripeMostCommon": [ "amount", "currency", "customer", "description", "mandate_data", "metadata", "payment_method", "receipt_email", "setup_future_usage", "shipping", "statement_descriptor", "statement_descriptor_suffix" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_intent" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a PaymentIntent" } }, "/v1/payment_intents/{intent}/amount_details_line_items": { "get": { "description": "

Lists all LineItems of a given PaymentIntent.

", "operationId": "GetPaymentIntentsIntentAmountDetailsLineItems", "parameters": [ { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "intent", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/payment_intent_amount_details_line_item" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "PaymentFlowsAmountDetailsResourceLineItemsList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all PaymentIntent LineItems" } }, "/v1/payment_intents/{intent}/apply_customer_balance": { "post": { "description": "

Manually reconcile the remaining amount for a customer_balance PaymentIntent.

", "operationId": "PostPaymentIntentsIntentApplyCustomerBalance", "parameters": [ { "in": "path", "name": "intent", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "amount": { "description": "Amount that you intend to apply to this PaymentIntent from the customer’s cash balance. If the PaymentIntent was created by an Invoice, the full amount of the PaymentIntent is applied regardless of this parameter.\n\nA positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (for example, 100 cents to charge 1 USD or 100 to charge 100 JPY, a zero-decimal currency). The maximum amount is the amount of the PaymentIntent.\n\nWhen you omit the amount, it defaults to the remaining amount requested on the PaymentIntent.", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object", "x-stripeMostCommon": [ "amount", "currency" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_intent" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Reconcile a customer_balance PaymentIntent" } }, "/v1/payment_intents/{intent}/cancel": { "post": { "description": "

You can cancel a PaymentIntent object when it’s in one of these statuses: requires_payment_method, requires_capture, requires_confirmation, requires_action or, in rare cases, processing.

\n\n

After it’s canceled, no additional charges are made by the PaymentIntent and any operations on the PaymentIntent fail with an error. For PaymentIntents with a status of requires_capture, the remaining amount_capturable is automatically refunded.

\n\n

You can’t cancel the PaymentIntent for a Checkout Session. Expire the Checkout Session instead.

", "operationId": "PostPaymentIntentsIntentCancel", "parameters": [ { "in": "path", "name": "intent", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "cancellation_reason": { "description": "Reason for canceling this PaymentIntent. Possible values are: `duplicate`, `fraudulent`, `requested_by_customer`, or `abandoned`", "enum": [ "abandoned", "duplicate", "fraudulent", "requested_by_customer" ], "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object", "x-stripeMostCommon": [ "cancellation_reason" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_intent" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Cancel a PaymentIntent" } }, "/v1/payment_intents/{intent}/capture": { "post": { "description": "

Capture the funds of an existing uncaptured PaymentIntent when its status is requires_capture.

\n\n

Uncaptured PaymentIntents are cancelled a set number of days (7 by default) after their creation.

\n\n

Learn more about separate authorization and capture.

", "operationId": "PostPaymentIntentsIntentCapture", "parameters": [ { "in": "path", "name": "intent", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "amount_details": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "hooks": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "payment_details": { "explode": true, "style": "deepObject" }, "transfer_data": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "amount_details": { "description": "Provides industry-specific information about the amount.", "properties": { "discount_amount": { "anyOf": [ { "type": "integer" }, { "enum": [ "" ], "type": "string" } ], "description": "The amount an item was discounted for." }, "line_items": { "anyOf": [ { "items": { "properties": { "discount_amount": { "description": "The amount an item was discounted for. Positive integer.", "type": "integer" }, "payment_method_options": { "description": "Payment method-specific information for line items.", "properties": { "card": { "description": "This sub-hash contains line item details that are specific to `card` payment method.\"", "properties": { "commodity_code": { "description": "Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, etc.", "maxLength": 12, "type": "string" } }, "title": "payment_intent_amount_details_line_item_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "commodity_code" ] }, "card_present": { "description": "This sub-hash contains line item details that are specific to `card_present` payment method.\"", "properties": { "commodity_code": { "description": "Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, etc.", "maxLength": 12, "type": "string" } }, "title": "amount_details_line_item_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "commodity_code" ] }, "klarna": { "description": "This sub-hash contains line item details that are specific to `klarna` payment method.\"", "properties": { "image_url": { "description": "URL to an image for the product. Max length, 4096 characters.", "maxLength": 4096, "type": "string" }, "product_url": { "description": "URL to the product page. Max length, 4096 characters.", "maxLength": 4096, "type": "string" }, "subscription_reference": { "description": "Reference for the subscription this line item is for.", "maxLength": 255, "type": "string" } }, "title": "payment_intent_amount_details_line_item_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "image_url", "product_url", "subscription_reference" ] }, "paypal": { "description": "This sub-hash contains line item details that are specific to `paypal` payment method.\"", "properties": { "category": { "description": "Type of the line item.", "enum": [ "digital_goods", "donation", "physical_goods" ], "type": "string" }, "description": { "description": "Description of the line item.", "maxLength": 127, "type": "string" }, "sold_by": { "description": "The Stripe account ID of the connected account that sells the item.", "maxLength": 127, "type": "string" } }, "title": "amount_details_line_item_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "category", "description", "sold_by" ] } }, "title": "amount_details_line_item_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "card", "card_present", "dummy_auth_push", "klarna", "link", "paypal" ] }, "product_code": { "description": "Unique identifier of the product. At most 12 characters long.", "maxLength": 12, "type": "string" }, "product_name": { "description": "Name of the product. At most 100 characters long.", "maxLength": 1024, "type": "string" }, "quantity": { "description": "Number of items of the product. Positive integer.", "type": "integer" }, "tax": { "description": "Contains information about the tax on the item.", "properties": { "total_tax_amount": { "description": "The total tax on an item. Non-negative integer.", "type": "integer" } }, "required": [ "total_tax_amount" ], "title": "amount_details_line_item_tax_param", "type": "object", "x-stripeMostCommon": [ "total_tax_amount" ] }, "unit_cost": { "description": "Cost of the product. Non-negative integer.", "type": "integer" }, "unit_of_measure": { "description": "A unit of measure for the line item, such as gallons, feet, meters, etc.", "maxLength": 12, "type": "string" } }, "required": [ "product_name", "quantity", "unit_cost" ], "title": "amount_details_line_item_param", "type": "object", "x-stripeMostCommon": [ "discount_amount", "payment_method_options", "product_code", "product_name", "quantity", "tax", "unit_cost", "unit_of_measure" ] }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "A list of line items, each containing information about a product in the PaymentIntent. There is a maximum of 100 line items." }, "shipping": { "anyOf": [ { "properties": { "amount": { "anyOf": [ { "type": "integer" }, { "enum": [ "" ], "type": "string" } ], "description": "Portion of the amount that is for shipping." }, "from_postal_code": { "anyOf": [ { "maxLength": 10, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "The postal code that represents the shipping source." }, "to_postal_code": { "anyOf": [ { "maxLength": 10, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "The postal code that represents the shipping destination." } }, "title": "amount_details_shipping_param", "type": "object", "x-stripeMostCommon": [ "amount", "from_postal_code", "to_postal_code" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Contains information about the shipping portion of the amount." }, "tax": { "anyOf": [ { "properties": { "total_tax_amount": { "description": "Total portion of the amount that is for tax.", "type": "integer" } }, "required": [ "total_tax_amount" ], "title": "amount_details_tax_param", "type": "object", "x-stripeMostCommon": [ "total_tax_amount" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Contains information about the tax portion of the amount." } }, "title": "amount_details_param", "type": "object", "x-stripeMostCommon": [ "discount_amount", "line_items", "shipping", "tax" ] }, "amount_to_capture": { "description": "The amount to capture from the PaymentIntent, which must be less than or equal to the original amount. Defaults to the full `amount_capturable` if it's not provided.", "type": "integer" }, "application_fee_amount": { "description": "The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total amount captured. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).", "type": "integer" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "final_capture": { "description": "Defaults to `true`. When capturing a PaymentIntent, setting `final_capture` to `false` notifies Stripe to not release the remaining uncaptured funds to make sure that they're captured in future requests. You can only use this setting when [multicapture](https://stripe.com/docs/payments/multicapture) is available for PaymentIntents.", "type": "boolean" }, "hooks": { "description": "Automations to be run during the PaymentIntent lifecycle", "properties": { "inputs": { "description": "Arguments passed in automations", "properties": { "tax": { "description": "Tax arguments for automations", "properties": { "calculation": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "The [TaxCalculation](https://stripe.com/docs/api/tax/calculations) id" } }, "required": [ "calculation" ], "title": "async_workflows_inputs_tax_param", "type": "object", "x-stripeMostCommon": [ "calculation" ] } }, "title": "async_workflows_inputs_param", "type": "object", "x-stripeMostCommon": [ "tax" ] } }, "title": "async_workflows_param", "type": "object", "x-stripeMostCommon": [ "inputs" ] }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "payment_details": { "anyOf": [ { "properties": { "car_rental": { "description": "Car rental details for this PaymentIntent.", "properties": { "affiliate": { "description": "Affiliate details for this purchase.", "properties": { "name": { "description": "The name of the affiliate that originated the purchase.", "maxLength": 5000, "type": "string" } }, "required": [ "name" ], "title": "affiliate", "type": "object", "x-stripeMostCommon": [ "name" ] }, "booking_number": { "description": "The booking number associated with the car rental.", "maxLength": 100, "type": "string" }, "car_class_code": { "description": "Class code of the car.", "maxLength": 4, "type": "string" }, "car_make": { "description": "Make of the car.", "maxLength": 10, "type": "string" }, "car_model": { "description": "Model of the car.", "maxLength": 10, "type": "string" }, "company": { "description": "The name of the rental car company.", "maxLength": 26, "type": "string" }, "customer_service_phone_number": { "description": "The customer service phone number of the car rental company.", "maxLength": 16, "type": "string" }, "days_rented": { "description": "Number of days the car is being rented.", "type": "integer" }, "delivery": { "description": "Delivery details for this purchase.", "properties": { "mode": { "description": "The delivery method for the payment", "enum": [ "email", "phone", "pickup", "post" ], "type": "string" }, "recipient": { "description": "Details of the recipient.", "properties": { "email": { "description": "The email of the recipient the ticket is delivered to.", "maxLength": 5000, "type": "string" }, "name": { "description": "The name of the recipient the ticket is delivered to.", "maxLength": 5000, "type": "string" }, "phone": { "description": "The phone number of the recipient the ticket is delivered to.", "maxLength": 5000, "type": "string" } }, "title": "delivery_recipient", "type": "object", "x-stripeMostCommon": [ "email", "name", "phone" ] } }, "title": "delivery", "type": "object", "x-stripeMostCommon": [ "mode", "recipient" ] }, "distance": { "description": "The details of the distance traveled during the rental period.", "properties": { "amount": { "description": "Distance traveled.", "type": "integer" }, "unit": { "description": "Unit of measurement for the distance traveled. One of `miles` or `kilometers`.", "enum": [ "kilometers", "miles" ], "type": "string" } }, "title": "car_rental_distance", "type": "object", "x-stripeMostCommon": [ "amount", "unit" ] }, "drivers": { "description": "The details of the passengers in the travel reservation", "items": { "properties": { "driver_identification_number": { "description": "Driver's identification number.", "maxLength": 20, "type": "string" }, "driver_tax_number": { "description": "Driver's tax number.", "maxLength": 20, "type": "string" }, "name": { "description": "Full name of the person or entity on the car reservation.", "maxLength": 5000, "type": "string" } }, "required": [ "name" ], "title": "car_rental_driver", "type": "object", "x-stripeMostCommon": [ "driver_identification_number", "driver_tax_number", "name" ] }, "type": "array" }, "extra_charges": { "description": "List of additional charges being billed.", "items": { "enum": [ "extra_mileage", "gas", "late_return", "one_way_service", "parking_violation" ], "type": "string" }, "type": "array" }, "no_show": { "description": "Indicates if the customer did not keep nor cancel their booking.", "type": "boolean" }, "pickup_address": { "description": "Car pick-up address.", "properties": { "city": { "description": "City, district, suburb, town, or village.", "maxLength": 5000, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Address line 1 (e.g., street, PO Box, or company name).", "maxLength": 5000, "type": "string" }, "line2": { "description": "Address line 2 (e.g., apartment, suite, unit, or building).", "maxLength": 5000, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "State, county, province, or region.", "maxLength": 5000, "type": "string" } }, "title": "optional_fields_address", "type": "object", "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state" ] }, "pickup_at": { "description": "Car pick-up time. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "pickup_location_name": { "description": "Name of the pickup location.", "maxLength": 38, "type": "string" }, "rate_amount": { "description": "Rental rate.", "type": "integer" }, "rate_interval": { "description": "The frequency at which the rate amount is applied. One of `day`, `week` or `month`", "enum": [ "day", "month", "week" ], "type": "string" }, "renter_name": { "description": "The name of the person or entity renting the car.", "maxLength": 100, "type": "string" }, "return_address": { "description": "Car return address.", "properties": { "city": { "description": "City, district, suburb, town, or village.", "maxLength": 5000, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Address line 1 (e.g., street, PO Box, or company name).", "maxLength": 5000, "type": "string" }, "line2": { "description": "Address line 2 (e.g., apartment, suite, unit, or building).", "maxLength": 5000, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "State, county, province, or region.", "maxLength": 5000, "type": "string" } }, "title": "optional_fields_address", "type": "object", "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state" ] }, "return_at": { "description": "Car return time. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "return_location_name": { "description": "Name of the return location.", "maxLength": 38, "type": "string" }, "tax_exempt": { "description": "Indicates whether the goods or services are tax-exempt or tax is not collected.", "type": "boolean" }, "vehicle_identification_number": { "description": "The vehicle identification number.", "maxLength": 20, "type": "string" } }, "required": [ "booking_number", "days_rented", "pickup_at", "return_at" ], "title": "car_rental", "type": "object", "x-stripeMostCommon": [ "affiliate", "booking_number", "car_class_code", "car_make", "car_model", "company", "customer_service_phone_number", "days_rented", "delivery", "distance", "drivers", "extra_charges", "no_show", "pickup_address", "pickup_at", "pickup_location_name", "rate_amount", "rate_interval", "renter_name", "return_address", "return_at", "return_location_name", "tax_exempt", "vehicle_identification_number" ] }, "customer_reference": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Some customers might be required by their company or organization to provide this information. If so, provide this value. Otherwise you can ignore this field." }, "event_details": { "description": "Event details for this PaymentIntent", "properties": { "access_controlled_venue": { "description": "Indicates if the tickets are digitally checked when entering the venue.", "type": "boolean" }, "address": { "description": "The event location's address.", "properties": { "city": { "description": "City, district, suburb, town, or village.", "maxLength": 5000, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Address line 1 (e.g., street, PO Box, or company name).", "maxLength": 5000, "type": "string" }, "line2": { "description": "Address line 2 (e.g., apartment, suite, unit, or building).", "maxLength": 5000, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "State, county, province, or region.", "maxLength": 5000, "type": "string" } }, "title": "optional_fields_address", "type": "object", "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state" ] }, "affiliate": { "description": "Affiliate details for this purchase.", "properties": { "name": { "description": "The name of the affiliate that originated the purchase.", "maxLength": 5000, "type": "string" } }, "required": [ "name" ], "title": "affiliate", "type": "object", "x-stripeMostCommon": [ "name" ] }, "company": { "description": "The name of the company", "maxLength": 5000, "type": "string" }, "delivery": { "description": "Delivery details for this purchase.", "properties": { "mode": { "description": "The delivery method for the payment", "enum": [ "email", "phone", "pickup", "post" ], "type": "string" }, "recipient": { "description": "Details of the recipient.", "properties": { "email": { "description": "The email of the recipient the ticket is delivered to.", "maxLength": 5000, "type": "string" }, "name": { "description": "The name of the recipient the ticket is delivered to.", "maxLength": 5000, "type": "string" }, "phone": { "description": "The phone number of the recipient the ticket is delivered to.", "maxLength": 5000, "type": "string" } }, "title": "delivery_recipient", "type": "object", "x-stripeMostCommon": [ "email", "name", "phone" ] } }, "title": "delivery", "type": "object", "x-stripeMostCommon": [ "mode", "recipient" ] }, "ends_at": { "description": "Event end time. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "genre": { "description": "Type of the event entertainment (concert, sports event etc)", "maxLength": 5000, "type": "string" }, "name": { "description": "The name of the event.", "maxLength": 5000, "type": "string" }, "starts_at": { "description": "Event start time. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" } }, "required": [ "name" ], "title": "event", "type": "object", "x-stripeMostCommon": [ "access_controlled_venue", "address", "affiliate", "company", "delivery", "ends_at", "genre", "name", "starts_at" ] }, "flight": { "description": "Flight reservation details for this PaymentIntent", "properties": { "affiliate": { "description": "Affiliate details for this purchase.", "properties": { "name": { "description": "The name of the affiliate that originated the purchase.", "maxLength": 5000, "type": "string" } }, "required": [ "name" ], "title": "affiliate", "type": "object", "x-stripeMostCommon": [ "name" ] }, "agency_number": { "description": "The agency number (i.e. International Air Transport Association (IATA) agency number) of the travel agency that made the booking.", "maxLength": 8, "type": "string" }, "carrier": { "description": "The International Air Transport Association (IATA) carrier code of the carrier that issued the ticket.", "maxLength": 3, "type": "string" }, "delivery": { "description": "Delivery details for this purchase.", "properties": { "mode": { "description": "The delivery method for the payment", "enum": [ "email", "phone", "pickup", "post" ], "type": "string" }, "recipient": { "description": "Details of the recipient.", "properties": { "email": { "description": "The email of the recipient the ticket is delivered to.", "maxLength": 5000, "type": "string" }, "name": { "description": "The name of the recipient the ticket is delivered to.", "maxLength": 5000, "type": "string" }, "phone": { "description": "The phone number of the recipient the ticket is delivered to.", "maxLength": 5000, "type": "string" } }, "title": "delivery_recipient", "type": "object", "x-stripeMostCommon": [ "email", "name", "phone" ] } }, "title": "delivery", "type": "object", "x-stripeMostCommon": [ "mode", "recipient" ] }, "passenger_name": { "description": "The name of the person or entity on the reservation.", "maxLength": 26, "type": "string" }, "passengers": { "description": "The details of the passengers in the travel reservation.", "items": { "properties": { "name": { "description": "Full name of the person or entity on the flight reservation.", "maxLength": 5000, "type": "string" } }, "required": [ "name" ], "title": "flight_passenger", "type": "object", "x-stripeMostCommon": [ "name" ] }, "type": "array" }, "segments": { "description": "The individual flight segments associated with the trip.", "items": { "properties": { "amount": { "description": "The flight segment amount.", "type": "integer" }, "arrival_airport": { "description": "The International Air Transport Association (IATA) airport code for the arrival airport.", "maxLength": 3, "type": "string" }, "arrives_at": { "description": "The arrival time for the flight segment. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "carrier": { "description": "The International Air Transport Association (IATA) carrier code of the carrier operating the flight segment.", "maxLength": 2, "type": "string" }, "departs_at": { "description": "The departure time for the flight segment. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "departure_airport": { "description": "The International Air Transport Association (IATA) airport code for the departure airport.", "maxLength": 3, "type": "string" }, "flight_number": { "description": "The flight number associated with the segment", "maxLength": 4, "type": "string" }, "service_class": { "description": "The fare class for the segment.", "enum": [ "business", "economy", "first", "premium_economy" ], "type": "string" } }, "required": [ "departs_at" ], "title": "flight_segment", "type": "object", "x-stripeMostCommon": [ "amount", "arrival_airport", "arrives_at", "carrier", "departs_at", "departure_airport", "flight_number", "service_class" ] }, "type": "array" }, "ticket_number": { "description": "The ticket number associated with the travel reservation.", "maxLength": 14, "type": "string" } }, "required": [ "segments" ], "title": "flight", "type": "object", "x-stripeMostCommon": [ "affiliate", "agency_number", "carrier", "delivery", "passenger_name", "passengers", "segments", "ticket_number" ] }, "lodging": { "description": "Lodging reservation details for this PaymentIntent", "properties": { "address": { "description": "The lodging location's address.", "properties": { "city": { "description": "City, district, suburb, town, or village.", "maxLength": 5000, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Address line 1 (e.g., street, PO Box, or company name).", "maxLength": 5000, "type": "string" }, "line2": { "description": "Address line 2 (e.g., apartment, suite, unit, or building).", "maxLength": 5000, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "State, county, province, or region.", "maxLength": 5000, "type": "string" } }, "title": "optional_fields_address", "type": "object", "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state" ] }, "adults": { "description": "The number of adults on the booking", "type": "integer" }, "affiliate": { "description": "Affiliate details for this purchase.", "properties": { "name": { "description": "The name of the affiliate that originated the purchase.", "maxLength": 5000, "type": "string" } }, "required": [ "name" ], "title": "affiliate", "type": "object", "x-stripeMostCommon": [ "name" ] }, "booking_number": { "description": "The booking number associated with the lodging reservation.", "maxLength": 100, "type": "string" }, "category": { "description": "The lodging category", "enum": [ "hotel", "vacation_rental" ], "type": "string" }, "checkin_at": { "description": "Lodging check-in time. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "checkout_at": { "description": "Lodging check-out time. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "customer_service_phone_number": { "description": "The customer service phone number of the lodging company.", "type": "string" }, "daily_room_rate_amount": { "description": "The daily lodging room rate.", "type": "integer" }, "delivery": { "description": "Delivery details for this purchase.", "properties": { "mode": { "description": "The delivery method for the payment", "enum": [ "email", "phone", "pickup", "post" ], "type": "string" }, "recipient": { "description": "Details of the recipient.", "properties": { "email": { "description": "The email of the recipient the ticket is delivered to.", "maxLength": 5000, "type": "string" }, "name": { "description": "The name of the recipient the ticket is delivered to.", "maxLength": 5000, "type": "string" }, "phone": { "description": "The phone number of the recipient the ticket is delivered to.", "maxLength": 5000, "type": "string" } }, "title": "delivery_recipient", "type": "object", "x-stripeMostCommon": [ "email", "name", "phone" ] } }, "title": "delivery", "type": "object", "x-stripeMostCommon": [ "mode", "recipient" ] }, "extra_charges": { "description": "List of additional charges being billed.", "items": { "enum": [ "gift_shop", "laundry", "mini_bar", "other", "restaurant", "telephone" ], "type": "string" }, "type": "array" }, "fire_safety_act_compliance": { "description": "Indicates whether the lodging location is compliant with the Fire Safety Act.", "type": "boolean" }, "name": { "description": "The name of the lodging location.", "maxLength": 100, "type": "string" }, "no_show": { "description": "Indicates if the customer did not keep their booking while failing to cancel the reservation.", "type": "boolean" }, "number_of_rooms": { "description": "The number of rooms on the booking", "type": "integer" }, "passengers": { "description": "The details of the passengers in the travel reservation", "items": { "properties": { "name": { "description": "Full name of the person or entity on the lodging reservation.", "maxLength": 5000, "type": "string" } }, "required": [ "name" ], "title": "lodging_passenger", "type": "object", "x-stripeMostCommon": [ "name" ] }, "type": "array" }, "property_phone_number": { "description": "The phone number of the lodging location.", "type": "string" }, "room_class": { "description": "The room class for this purchase.", "maxLength": 5000, "type": "string" }, "room_nights": { "description": "The number of room nights", "type": "integer" }, "total_room_tax_amount": { "description": "The total tax amount associating with the room reservation.", "type": "integer" }, "total_tax_amount": { "description": "The total tax amount", "type": "integer" } }, "required": [ "checkin_at", "checkout_at" ], "title": "lodging", "type": "object", "x-stripeMostCommon": [ "address", "adults", "affiliate", "booking_number", "category", "checkin_at", "checkout_at", "customer_service_phone_number", "daily_room_rate_amount", "delivery", "extra_charges", "fire_safety_act_compliance", "name", "no_show", "number_of_rooms", "passengers", "property_phone_number", "room_class", "room_nights", "total_room_tax_amount", "total_tax_amount" ] }, "order_reference": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "A unique value assigned by the business to identify the transaction." }, "subscription": { "description": "Subscription details for this PaymentIntent", "properties": { "affiliate": { "description": "Affiliate details for this purchase.", "properties": { "name": { "description": "The name of the affiliate that originated the purchase.", "maxLength": 5000, "type": "string" } }, "required": [ "name" ], "title": "affiliate", "type": "object", "x-stripeMostCommon": [ "name" ] }, "auto_renewal": { "description": "Info whether the subscription will be auto renewed upon expiry.", "type": "boolean" }, "billing_interval": { "description": "Subscription billing details for this purchase.", "properties": { "count": { "description": "The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.", "type": "integer" }, "interval": { "description": "Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.", "enum": [ "day", "month", "week", "year" ], "type": "string" } }, "required": [ "count", "interval" ], "title": "subscription_billing_interval", "type": "object", "x-stripeMostCommon": [ "count", "interval" ] }, "ends_at": { "description": "Subscription end time. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "name": { "description": "Name of the product on subscription. e.g. Apple Music Subscription", "maxLength": 5000, "type": "string" }, "starts_at": { "description": "Subscription start time. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" } }, "required": [ "name" ], "title": "subscription", "type": "object", "x-stripeMostCommon": [ "affiliate", "auto_renewal", "billing_interval", "ends_at", "name", "starts_at" ] } }, "title": "payment_details", "type": "object", "x-stripeMostCommon": [ "benefit", "car_rental", "car_rental_data", "event_details", "flight", "healthcare", "lodging", "lodging_data", "subscription" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Provides industry-specific information about the charge." }, "statement_descriptor": { "description": "Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).\n\nSetting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead.", "maxLength": 22, "type": "string" }, "statement_descriptor_suffix": { "description": "Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement.", "maxLength": 22, "type": "string" }, "transfer_data": { "description": "The parameters that you can use to automatically create a transfer after the payment\nis captured. Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).", "properties": { "amount": { "description": "The amount that will be transferred automatically when a charge succeeds.", "type": "integer" } }, "title": "transfer_data_capture_params", "type": "object", "x-stripeMostCommon": [ "amount" ] } }, "type": "object", "x-stripeMostCommon": [ "amount_to_capture", "metadata" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_intent" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Capture a PaymentIntent" } }, "/v1/payment_intents/{intent}/confirm": { "post": { "description": "

Confirm that your customer intends to pay with current or provided\npayment method. Upon confirmation, the PaymentIntent will attempt to initiate\na payment.

\n\n

If the selected payment method requires additional authentication steps, the\nPaymentIntent will transition to the requires_action status and\nsuggest additional actions via next_action. If payment fails,\nthe PaymentIntent transitions to the requires_payment_method status or the\ncanceled status if the confirmation limit is reached. If\npayment succeeds, the PaymentIntent will transition to the succeeded\nstatus (or requires_capture, if capture_method is set to manual).

\n\n

If the confirmation_method is automatic, payment may be attempted\nusing our client SDKs\nand the PaymentIntent’s client_secret.\nAfter next_actions are handled by the client, no additional\nconfirmation is required to complete the payment.

\n\n

If the confirmation_method is manual, all payment attempts must be\ninitiated using a secret key.

\n\n

If any actions are required for the payment, the PaymentIntent will\nreturn to the requires_confirmation state\nafter those actions are completed. Your server needs to then\nexplicitly re-confirm the PaymentIntent to initiate the next payment\nattempt.

\n\n

There is a variable upper limit on how many times a PaymentIntent can be confirmed.\nAfter this limit is reached, any further calls to this endpoint will\ntransition the PaymentIntent to the canceled state.

", "operationId": "PostPaymentIntentsIntentConfirm", "parameters": [ { "in": "path", "name": "intent", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "amount_details": { "explode": true, "style": "deepObject" }, "application_fee_amount": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "hooks": { "explode": true, "style": "deepObject" }, "mandate_data": { "explode": true, "style": "deepObject" }, "off_session": { "explode": true, "style": "deepObject" }, "payment_details": { "explode": true, "style": "deepObject" }, "payment_method_data": { "explode": true, "style": "deepObject" }, "payment_method_options": { "explode": true, "style": "deepObject" }, "payment_method_types": { "explode": true, "style": "deepObject" }, "radar_options": { "explode": true, "style": "deepObject" }, "receipt_email": { "explode": true, "style": "deepObject" }, "shipping": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "amount_details": { "anyOf": [ { "properties": { "discount_amount": { "anyOf": [ { "type": "integer" }, { "enum": [ "" ], "type": "string" } ], "description": "The amount an item was discounted for." }, "line_items": { "anyOf": [ { "items": { "properties": { "discount_amount": { "description": "The amount an item was discounted for. Positive integer.", "type": "integer" }, "payment_method_options": { "description": "Payment method-specific information for line items.", "properties": { "card": { "description": "This sub-hash contains line item details that are specific to `card` payment method.\"", "properties": { "commodity_code": { "description": "Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, etc.", "maxLength": 12, "type": "string" } }, "title": "payment_intent_amount_details_line_item_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "commodity_code" ] }, "card_present": { "description": "This sub-hash contains line item details that are specific to `card_present` payment method.\"", "properties": { "commodity_code": { "description": "Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, etc.", "maxLength": 12, "type": "string" } }, "title": "amount_details_line_item_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "commodity_code" ] }, "klarna": { "description": "This sub-hash contains line item details that are specific to `klarna` payment method.\"", "properties": { "image_url": { "description": "URL to an image for the product. Max length, 4096 characters.", "maxLength": 4096, "type": "string" }, "product_url": { "description": "URL to the product page. Max length, 4096 characters.", "maxLength": 4096, "type": "string" }, "subscription_reference": { "description": "Reference for the subscription this line item is for.", "maxLength": 255, "type": "string" } }, "title": "payment_intent_amount_details_line_item_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "image_url", "product_url", "subscription_reference" ] }, "paypal": { "description": "This sub-hash contains line item details that are specific to `paypal` payment method.\"", "properties": { "category": { "description": "Type of the line item.", "enum": [ "digital_goods", "donation", "physical_goods" ], "type": "string" }, "description": { "description": "Description of the line item.", "maxLength": 127, "type": "string" }, "sold_by": { "description": "The Stripe account ID of the connected account that sells the item.", "maxLength": 127, "type": "string" } }, "title": "amount_details_line_item_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "category", "description", "sold_by" ] } }, "title": "amount_details_line_item_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "card", "card_present", "dummy_auth_push", "klarna", "link", "paypal" ] }, "product_code": { "description": "Unique identifier of the product. At most 12 characters long.", "maxLength": 12, "type": "string" }, "product_name": { "description": "Name of the product. At most 100 characters long.", "maxLength": 1024, "type": "string" }, "quantity": { "description": "Number of items of the product. Positive integer.", "type": "integer" }, "tax": { "description": "Contains information about the tax on the item.", "properties": { "total_tax_amount": { "description": "The total tax on an item. Non-negative integer.", "type": "integer" } }, "required": [ "total_tax_amount" ], "title": "amount_details_line_item_tax_param", "type": "object", "x-stripeMostCommon": [ "total_tax_amount" ] }, "unit_cost": { "description": "Cost of the product. Non-negative integer.", "type": "integer" }, "unit_of_measure": { "description": "A unit of measure for the line item, such as gallons, feet, meters, etc.", "maxLength": 12, "type": "string" } }, "required": [ "product_name", "quantity", "unit_cost" ], "title": "amount_details_line_item_param", "type": "object", "x-stripeMostCommon": [ "discount_amount", "payment_method_options", "product_code", "product_name", "quantity", "tax", "unit_cost", "unit_of_measure" ] }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "A list of line items, each containing information about a product in the PaymentIntent. There is a maximum of 100 line items." }, "shipping": { "anyOf": [ { "properties": { "amount": { "anyOf": [ { "type": "integer" }, { "enum": [ "" ], "type": "string" } ], "description": "Portion of the amount that is for shipping." }, "from_postal_code": { "anyOf": [ { "maxLength": 10, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "The postal code that represents the shipping source." }, "to_postal_code": { "anyOf": [ { "maxLength": 10, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "The postal code that represents the shipping destination." } }, "title": "amount_details_shipping_param", "type": "object", "x-stripeMostCommon": [ "amount", "from_postal_code", "to_postal_code" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Contains information about the shipping portion of the amount." }, "tax": { "anyOf": [ { "properties": { "total_tax_amount": { "description": "Total portion of the amount that is for tax.", "type": "integer" } }, "required": [ "total_tax_amount" ], "title": "amount_details_tax_param", "type": "object", "x-stripeMostCommon": [ "total_tax_amount" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Contains information about the tax portion of the amount." } }, "title": "amount_details_param", "type": "object", "x-stripeMostCommon": [ "discount_amount", "line_items", "shipping", "tax" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Provides industry-specific information about the amount." }, "application_fee_amount": { "anyOf": [ { "type": "integer" }, { "enum": [ "" ], "type": "string" } ], "description": "The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total amount captured. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts)." }, "capture_method": { "description": "Controls when the funds will be captured from the customer's account.", "enum": [ "automatic", "automatic_async", "manual" ], "type": "string" }, "confirmation_token": { "description": "ID of the ConfirmationToken used to confirm this PaymentIntent.\n\nIf the provided ConfirmationToken contains properties that are also being provided in this request, such as `payment_method`, then the values in this request will take precedence.", "maxLength": 5000, "type": "string" }, "error_on_requires_action": { "description": "Set to `true` to fail the payment attempt if the PaymentIntent transitions into `requires_action`. This parameter is intended for simpler integrations that do not handle customer actions, like [saving cards without authentication](https://stripe.com/docs/payments/save-card-without-authentication).", "type": "boolean" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "fx_quote": { "description": "The FX rate in the quote is validated and used to convert the presentment amount to the settlement amount.", "maxLength": 5000, "type": "string" }, "hooks": { "description": "Automations to be run during the PaymentIntent lifecycle", "properties": { "inputs": { "description": "Arguments passed in automations", "properties": { "tax": { "description": "Tax arguments for automations", "properties": { "calculation": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "The [TaxCalculation](https://stripe.com/docs/api/tax/calculations) id" } }, "required": [ "calculation" ], "title": "async_workflows_inputs_tax_param", "type": "object", "x-stripeMostCommon": [ "calculation" ] } }, "title": "async_workflows_inputs_param", "type": "object", "x-stripeMostCommon": [ "tax" ] } }, "title": "async_workflows_param", "type": "object", "x-stripeMostCommon": [ "inputs" ] }, "mandate": { "description": "ID of the mandate that's used for this payment.", "maxLength": 5000, "type": "string" }, "mandate_data": { "anyOf": [ { "properties": { "customer_acceptance": { "description": "This hash contains details about the customer acceptance of the Mandate.", "properties": { "accepted_at": { "description": "The time at which the customer accepted the Mandate.", "format": "unix-time", "type": "integer" }, "offline": { "description": "If this is a Mandate accepted offline, this hash contains details about the offline acceptance.", "properties": {}, "title": "offline_param", "type": "object" }, "online": { "description": "If this is a Mandate accepted online, this hash contains details about the online acceptance.", "properties": { "ip_address": { "description": "The IP address from which the Mandate was accepted by the customer.", "type": "string" }, "user_agent": { "description": "The user agent of the browser from which the Mandate was accepted by the customer.", "maxLength": 5000, "type": "string" } }, "required": [ "ip_address", "user_agent" ], "title": "online_param", "type": "object", "x-stripeMostCommon": [ "ip_address", "user_agent" ] }, "type": { "description": "The type of customer acceptance information included with the Mandate. One of `online` or `offline`.", "enum": [ "offline", "online" ], "maxLength": 5000, "type": "string" } }, "required": [ "type" ], "title": "customer_acceptance_param", "type": "object", "x-stripeMostCommon": [ "accepted_at", "offline", "online", "type" ] } }, "required": [ "customer_acceptance" ], "title": "secret_key_param", "type": "object", "x-stripeMostCommon": [ "customer_acceptance" ] }, { "enum": [ "" ], "type": "string" }, { "description": "This hash contains details about the Mandate to create", "properties": { "customer_acceptance": { "description": "This hash contains details about the customer acceptance of the Mandate.", "properties": { "online": { "description": "If this is a Mandate accepted online, this hash contains details about the online acceptance.", "properties": { "ip_address": { "description": "The IP address from which the Mandate was accepted by the customer.", "type": "string" }, "user_agent": { "description": "The user agent of the browser from which the Mandate was accepted by the customer.", "maxLength": 5000, "type": "string" } }, "title": "online_param", "type": "object", "x-stripeMostCommon": [ "ip_address", "user_agent" ] }, "type": { "description": "The type of customer acceptance information included with the Mandate.", "enum": [ "online" ], "maxLength": 5000, "type": "string" } }, "required": [ "online", "type" ], "title": "customer_acceptance_param", "type": "object", "x-stripeMostCommon": [ "online", "type" ] } }, "required": [ "customer_acceptance" ], "title": "client_key_param", "type": "object", "x-stripeMostCommon": [ "customer_acceptance" ], "x-stripeParam": { "class_name": "MandateDataPublishableKey" } } ] }, "off_session": { "anyOf": [ { "type": "boolean" }, { "enum": [ "one_off", "recurring" ], "maxLength": 5000, "type": "string" } ], "description": "Set to `true` to indicate that the customer isn't in your checkout flow during this payment attempt and can't authenticate. Use this parameter in scenarios where you collect card details and [charge them later](https://stripe.com/docs/payments/cards/charging-saved-cards)." }, "payment_details": { "anyOf": [ { "properties": { "car_rental": { "description": "Car rental details for this PaymentIntent.", "properties": { "affiliate": { "description": "Affiliate details for this purchase.", "properties": { "name": { "description": "The name of the affiliate that originated the purchase.", "maxLength": 5000, "type": "string" } }, "required": [ "name" ], "title": "affiliate", "type": "object", "x-stripeMostCommon": [ "name" ] }, "booking_number": { "description": "The booking number associated with the car rental.", "maxLength": 100, "type": "string" }, "car_class_code": { "description": "Class code of the car.", "maxLength": 4, "type": "string" }, "car_make": { "description": "Make of the car.", "maxLength": 10, "type": "string" }, "car_model": { "description": "Model of the car.", "maxLength": 10, "type": "string" }, "company": { "description": "The name of the rental car company.", "maxLength": 26, "type": "string" }, "customer_service_phone_number": { "description": "The customer service phone number of the car rental company.", "maxLength": 16, "type": "string" }, "days_rented": { "description": "Number of days the car is being rented.", "type": "integer" }, "delivery": { "description": "Delivery details for this purchase.", "properties": { "mode": { "description": "The delivery method for the payment", "enum": [ "email", "phone", "pickup", "post" ], "type": "string" }, "recipient": { "description": "Details of the recipient.", "properties": { "email": { "description": "The email of the recipient the ticket is delivered to.", "maxLength": 5000, "type": "string" }, "name": { "description": "The name of the recipient the ticket is delivered to.", "maxLength": 5000, "type": "string" }, "phone": { "description": "The phone number of the recipient the ticket is delivered to.", "maxLength": 5000, "type": "string" } }, "title": "delivery_recipient", "type": "object", "x-stripeMostCommon": [ "email", "name", "phone" ] } }, "title": "delivery", "type": "object", "x-stripeMostCommon": [ "mode", "recipient" ] }, "distance": { "description": "The details of the distance traveled during the rental period.", "properties": { "amount": { "description": "Distance traveled.", "type": "integer" }, "unit": { "description": "Unit of measurement for the distance traveled. One of `miles` or `kilometers`.", "enum": [ "kilometers", "miles" ], "type": "string" } }, "title": "car_rental_distance", "type": "object", "x-stripeMostCommon": [ "amount", "unit" ] }, "drivers": { "description": "The details of the passengers in the travel reservation", "items": { "properties": { "driver_identification_number": { "description": "Driver's identification number.", "maxLength": 20, "type": "string" }, "driver_tax_number": { "description": "Driver's tax number.", "maxLength": 20, "type": "string" }, "name": { "description": "Full name of the person or entity on the car reservation.", "maxLength": 5000, "type": "string" } }, "required": [ "name" ], "title": "car_rental_driver", "type": "object", "x-stripeMostCommon": [ "driver_identification_number", "driver_tax_number", "name" ] }, "type": "array" }, "extra_charges": { "description": "List of additional charges being billed.", "items": { "enum": [ "extra_mileage", "gas", "late_return", "one_way_service", "parking_violation" ], "type": "string" }, "type": "array" }, "no_show": { "description": "Indicates if the customer did not keep nor cancel their booking.", "type": "boolean" }, "pickup_address": { "description": "Car pick-up address.", "properties": { "city": { "description": "City, district, suburb, town, or village.", "maxLength": 5000, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Address line 1 (e.g., street, PO Box, or company name).", "maxLength": 5000, "type": "string" }, "line2": { "description": "Address line 2 (e.g., apartment, suite, unit, or building).", "maxLength": 5000, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "State, county, province, or region.", "maxLength": 5000, "type": "string" } }, "title": "optional_fields_address", "type": "object", "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state" ] }, "pickup_at": { "description": "Car pick-up time. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "pickup_location_name": { "description": "Name of the pickup location.", "maxLength": 38, "type": "string" }, "rate_amount": { "description": "Rental rate.", "type": "integer" }, "rate_interval": { "description": "The frequency at which the rate amount is applied. One of `day`, `week` or `month`", "enum": [ "day", "month", "week" ], "type": "string" }, "renter_name": { "description": "The name of the person or entity renting the car.", "maxLength": 100, "type": "string" }, "return_address": { "description": "Car return address.", "properties": { "city": { "description": "City, district, suburb, town, or village.", "maxLength": 5000, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Address line 1 (e.g., street, PO Box, or company name).", "maxLength": 5000, "type": "string" }, "line2": { "description": "Address line 2 (e.g., apartment, suite, unit, or building).", "maxLength": 5000, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "State, county, province, or region.", "maxLength": 5000, "type": "string" } }, "title": "optional_fields_address", "type": "object", "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state" ] }, "return_at": { "description": "Car return time. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "return_location_name": { "description": "Name of the return location.", "maxLength": 38, "type": "string" }, "tax_exempt": { "description": "Indicates whether the goods or services are tax-exempt or tax is not collected.", "type": "boolean" }, "vehicle_identification_number": { "description": "The vehicle identification number.", "maxLength": 20, "type": "string" } }, "required": [ "booking_number", "days_rented", "pickup_at", "return_at" ], "title": "car_rental", "type": "object", "x-stripeMostCommon": [ "affiliate", "booking_number", "car_class_code", "car_make", "car_model", "company", "customer_service_phone_number", "days_rented", "delivery", "distance", "drivers", "extra_charges", "no_show", "pickup_address", "pickup_at", "pickup_location_name", "rate_amount", "rate_interval", "renter_name", "return_address", "return_at", "return_location_name", "tax_exempt", "vehicle_identification_number" ] }, "customer_reference": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Some customers might be required by their company or organization to provide this information. If so, provide this value. Otherwise you can ignore this field." }, "event_details": { "description": "Event details for this PaymentIntent", "properties": { "access_controlled_venue": { "description": "Indicates if the tickets are digitally checked when entering the venue.", "type": "boolean" }, "address": { "description": "The event location's address.", "properties": { "city": { "description": "City, district, suburb, town, or village.", "maxLength": 5000, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Address line 1 (e.g., street, PO Box, or company name).", "maxLength": 5000, "type": "string" }, "line2": { "description": "Address line 2 (e.g., apartment, suite, unit, or building).", "maxLength": 5000, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "State, county, province, or region.", "maxLength": 5000, "type": "string" } }, "title": "optional_fields_address", "type": "object", "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state" ] }, "affiliate": { "description": "Affiliate details for this purchase.", "properties": { "name": { "description": "The name of the affiliate that originated the purchase.", "maxLength": 5000, "type": "string" } }, "required": [ "name" ], "title": "affiliate", "type": "object", "x-stripeMostCommon": [ "name" ] }, "company": { "description": "The name of the company", "maxLength": 5000, "type": "string" }, "delivery": { "description": "Delivery details for this purchase.", "properties": { "mode": { "description": "The delivery method for the payment", "enum": [ "email", "phone", "pickup", "post" ], "type": "string" }, "recipient": { "description": "Details of the recipient.", "properties": { "email": { "description": "The email of the recipient the ticket is delivered to.", "maxLength": 5000, "type": "string" }, "name": { "description": "The name of the recipient the ticket is delivered to.", "maxLength": 5000, "type": "string" }, "phone": { "description": "The phone number of the recipient the ticket is delivered to.", "maxLength": 5000, "type": "string" } }, "title": "delivery_recipient", "type": "object", "x-stripeMostCommon": [ "email", "name", "phone" ] } }, "title": "delivery", "type": "object", "x-stripeMostCommon": [ "mode", "recipient" ] }, "ends_at": { "description": "Event end time. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "genre": { "description": "Type of the event entertainment (concert, sports event etc)", "maxLength": 5000, "type": "string" }, "name": { "description": "The name of the event.", "maxLength": 5000, "type": "string" }, "starts_at": { "description": "Event start time. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" } }, "required": [ "name" ], "title": "event", "type": "object", "x-stripeMostCommon": [ "access_controlled_venue", "address", "affiliate", "company", "delivery", "ends_at", "genre", "name", "starts_at" ] }, "flight": { "description": "Flight reservation details for this PaymentIntent", "properties": { "affiliate": { "description": "Affiliate details for this purchase.", "properties": { "name": { "description": "The name of the affiliate that originated the purchase.", "maxLength": 5000, "type": "string" } }, "required": [ "name" ], "title": "affiliate", "type": "object", "x-stripeMostCommon": [ "name" ] }, "agency_number": { "description": "The agency number (i.e. International Air Transport Association (IATA) agency number) of the travel agency that made the booking.", "maxLength": 8, "type": "string" }, "carrier": { "description": "The International Air Transport Association (IATA) carrier code of the carrier that issued the ticket.", "maxLength": 3, "type": "string" }, "delivery": { "description": "Delivery details for this purchase.", "properties": { "mode": { "description": "The delivery method for the payment", "enum": [ "email", "phone", "pickup", "post" ], "type": "string" }, "recipient": { "description": "Details of the recipient.", "properties": { "email": { "description": "The email of the recipient the ticket is delivered to.", "maxLength": 5000, "type": "string" }, "name": { "description": "The name of the recipient the ticket is delivered to.", "maxLength": 5000, "type": "string" }, "phone": { "description": "The phone number of the recipient the ticket is delivered to.", "maxLength": 5000, "type": "string" } }, "title": "delivery_recipient", "type": "object", "x-stripeMostCommon": [ "email", "name", "phone" ] } }, "title": "delivery", "type": "object", "x-stripeMostCommon": [ "mode", "recipient" ] }, "passenger_name": { "description": "The name of the person or entity on the reservation.", "maxLength": 26, "type": "string" }, "passengers": { "description": "The details of the passengers in the travel reservation.", "items": { "properties": { "name": { "description": "Full name of the person or entity on the flight reservation.", "maxLength": 5000, "type": "string" } }, "required": [ "name" ], "title": "flight_passenger", "type": "object", "x-stripeMostCommon": [ "name" ] }, "type": "array" }, "segments": { "description": "The individual flight segments associated with the trip.", "items": { "properties": { "amount": { "description": "The flight segment amount.", "type": "integer" }, "arrival_airport": { "description": "The International Air Transport Association (IATA) airport code for the arrival airport.", "maxLength": 3, "type": "string" }, "arrives_at": { "description": "The arrival time for the flight segment. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "carrier": { "description": "The International Air Transport Association (IATA) carrier code of the carrier operating the flight segment.", "maxLength": 2, "type": "string" }, "departs_at": { "description": "The departure time for the flight segment. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "departure_airport": { "description": "The International Air Transport Association (IATA) airport code for the departure airport.", "maxLength": 3, "type": "string" }, "flight_number": { "description": "The flight number associated with the segment", "maxLength": 4, "type": "string" }, "service_class": { "description": "The fare class for the segment.", "enum": [ "business", "economy", "first", "premium_economy" ], "type": "string" } }, "required": [ "departs_at" ], "title": "flight_segment", "type": "object", "x-stripeMostCommon": [ "amount", "arrival_airport", "arrives_at", "carrier", "departs_at", "departure_airport", "flight_number", "service_class" ] }, "type": "array" }, "ticket_number": { "description": "The ticket number associated with the travel reservation.", "maxLength": 14, "type": "string" } }, "required": [ "segments" ], "title": "flight", "type": "object", "x-stripeMostCommon": [ "affiliate", "agency_number", "carrier", "delivery", "passenger_name", "passengers", "segments", "ticket_number" ] }, "lodging": { "description": "Lodging reservation details for this PaymentIntent", "properties": { "address": { "description": "The lodging location's address.", "properties": { "city": { "description": "City, district, suburb, town, or village.", "maxLength": 5000, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Address line 1 (e.g., street, PO Box, or company name).", "maxLength": 5000, "type": "string" }, "line2": { "description": "Address line 2 (e.g., apartment, suite, unit, or building).", "maxLength": 5000, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "State, county, province, or region.", "maxLength": 5000, "type": "string" } }, "title": "optional_fields_address", "type": "object", "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state" ] }, "adults": { "description": "The number of adults on the booking", "type": "integer" }, "affiliate": { "description": "Affiliate details for this purchase.", "properties": { "name": { "description": "The name of the affiliate that originated the purchase.", "maxLength": 5000, "type": "string" } }, "required": [ "name" ], "title": "affiliate", "type": "object", "x-stripeMostCommon": [ "name" ] }, "booking_number": { "description": "The booking number associated with the lodging reservation.", "maxLength": 100, "type": "string" }, "category": { "description": "The lodging category", "enum": [ "hotel", "vacation_rental" ], "type": "string" }, "checkin_at": { "description": "Lodging check-in time. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "checkout_at": { "description": "Lodging check-out time. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "customer_service_phone_number": { "description": "The customer service phone number of the lodging company.", "type": "string" }, "daily_room_rate_amount": { "description": "The daily lodging room rate.", "type": "integer" }, "delivery": { "description": "Delivery details for this purchase.", "properties": { "mode": { "description": "The delivery method for the payment", "enum": [ "email", "phone", "pickup", "post" ], "type": "string" }, "recipient": { "description": "Details of the recipient.", "properties": { "email": { "description": "The email of the recipient the ticket is delivered to.", "maxLength": 5000, "type": "string" }, "name": { "description": "The name of the recipient the ticket is delivered to.", "maxLength": 5000, "type": "string" }, "phone": { "description": "The phone number of the recipient the ticket is delivered to.", "maxLength": 5000, "type": "string" } }, "title": "delivery_recipient", "type": "object", "x-stripeMostCommon": [ "email", "name", "phone" ] } }, "title": "delivery", "type": "object", "x-stripeMostCommon": [ "mode", "recipient" ] }, "extra_charges": { "description": "List of additional charges being billed.", "items": { "enum": [ "gift_shop", "laundry", "mini_bar", "other", "restaurant", "telephone" ], "type": "string" }, "type": "array" }, "fire_safety_act_compliance": { "description": "Indicates whether the lodging location is compliant with the Fire Safety Act.", "type": "boolean" }, "name": { "description": "The name of the lodging location.", "maxLength": 100, "type": "string" }, "no_show": { "description": "Indicates if the customer did not keep their booking while failing to cancel the reservation.", "type": "boolean" }, "number_of_rooms": { "description": "The number of rooms on the booking", "type": "integer" }, "passengers": { "description": "The details of the passengers in the travel reservation", "items": { "properties": { "name": { "description": "Full name of the person or entity on the lodging reservation.", "maxLength": 5000, "type": "string" } }, "required": [ "name" ], "title": "lodging_passenger", "type": "object", "x-stripeMostCommon": [ "name" ] }, "type": "array" }, "property_phone_number": { "description": "The phone number of the lodging location.", "type": "string" }, "room_class": { "description": "The room class for this purchase.", "maxLength": 5000, "type": "string" }, "room_nights": { "description": "The number of room nights", "type": "integer" }, "total_room_tax_amount": { "description": "The total tax amount associating with the room reservation.", "type": "integer" }, "total_tax_amount": { "description": "The total tax amount", "type": "integer" } }, "required": [ "checkin_at", "checkout_at" ], "title": "lodging", "type": "object", "x-stripeMostCommon": [ "address", "adults", "affiliate", "booking_number", "category", "checkin_at", "checkout_at", "customer_service_phone_number", "daily_room_rate_amount", "delivery", "extra_charges", "fire_safety_act_compliance", "name", "no_show", "number_of_rooms", "passengers", "property_phone_number", "room_class", "room_nights", "total_room_tax_amount", "total_tax_amount" ] }, "order_reference": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "A unique value assigned by the business to identify the transaction." }, "subscription": { "description": "Subscription details for this PaymentIntent", "properties": { "affiliate": { "description": "Affiliate details for this purchase.", "properties": { "name": { "description": "The name of the affiliate that originated the purchase.", "maxLength": 5000, "type": "string" } }, "required": [ "name" ], "title": "affiliate", "type": "object", "x-stripeMostCommon": [ "name" ] }, "auto_renewal": { "description": "Info whether the subscription will be auto renewed upon expiry.", "type": "boolean" }, "billing_interval": { "description": "Subscription billing details for this purchase.", "properties": { "count": { "description": "The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.", "type": "integer" }, "interval": { "description": "Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.", "enum": [ "day", "month", "week", "year" ], "type": "string" } }, "required": [ "count", "interval" ], "title": "subscription_billing_interval", "type": "object", "x-stripeMostCommon": [ "count", "interval" ] }, "ends_at": { "description": "Subscription end time. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "name": { "description": "Name of the product on subscription. e.g. Apple Music Subscription", "maxLength": 5000, "type": "string" }, "starts_at": { "description": "Subscription start time. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" } }, "required": [ "name" ], "title": "subscription", "type": "object", "x-stripeMostCommon": [ "affiliate", "auto_renewal", "billing_interval", "ends_at", "name", "starts_at" ] } }, "title": "payment_details", "type": "object", "x-stripeMostCommon": [ "benefit", "car_rental", "car_rental_data", "event_details", "flight", "healthcare", "lodging", "lodging_data", "subscription" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Provides industry-specific information about the charge." }, "payment_method": { "description": "ID of the payment method (a PaymentMethod, Card, or [compatible Source](https://stripe.com/docs/payments/payment-methods/transitioning#compatibility) object) to attach to this PaymentIntent.\nIf the payment method is attached to a Customer, it must match the [customer](https://stripe.com/docs/api#create_payment_intent-customer) that is set on this PaymentIntent.", "maxLength": 5000, "type": "string" }, "payment_method_data": { "description": "If provided, this hash will be used to create a PaymentMethod. The new PaymentMethod will appear\nin the [payment_method](https://stripe.com/docs/api/payment_intents/object#payment_intent_object-payment_method)\nproperty on the PaymentIntent.", "properties": { "acss_debit": { "description": "If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method.", "properties": { "account_number": { "description": "Customer's bank account number.", "maxLength": 5000, "type": "string" }, "institution_number": { "description": "Institution number of the customer's bank.", "maxLength": 5000, "type": "string" }, "transit_number": { "description": "Transit number of the customer's bank.", "maxLength": 5000, "type": "string" } }, "required": [ "account_number", "institution_number", "transit_number" ], "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "account_number", "financial_connections_account", "institution_number", "transit_number" ] }, "affirm": { "description": "If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method.", "properties": {}, "title": "param", "type": "object" }, "afterpay_clearpay": { "description": "If this is an `AfterpayClearpay` PaymentMethod, this hash contains details about the AfterpayClearpay payment method.", "properties": {}, "title": "param", "type": "object" }, "alipay": { "description": "If this is an `Alipay` PaymentMethod, this hash contains details about the Alipay payment method.", "properties": {}, "title": "param", "type": "object" }, "allow_redisplay": { "description": "This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to `unspecified`.", "enum": [ "always", "limited", "unspecified" ], "type": "string" }, "alma": { "description": "If this is a Alma PaymentMethod, this hash contains details about the Alma payment method.", "properties": {}, "title": "param", "type": "object" }, "amazon_pay": { "description": "If this is a AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method.", "properties": {}, "title": "param", "type": "object" }, "au_becs_debit": { "description": "If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account.", "properties": { "account_number": { "description": "The account number for the bank account.", "maxLength": 5000, "type": "string" }, "bsb_number": { "description": "Bank-State-Branch number of the bank account.", "maxLength": 5000, "type": "string" } }, "required": [ "account_number", "bsb_number" ], "title": "param", "type": "object", "x-stripeMostCommon": [ "account_number", "bsb_number" ] }, "bacs_debit": { "description": "If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.", "properties": { "account_number": { "description": "Account number of the bank account that the funds will be debited from.", "maxLength": 5000, "type": "string" }, "sort_code": { "description": "Sort code of the bank account. (e.g., `10-20-30`)", "maxLength": 5000, "type": "string" } }, "title": "param", "type": "object", "x-stripeMostCommon": [ "account_number", "sort_code" ] }, "bancontact": { "description": "If this is a `bancontact` PaymentMethod, this hash contains details about the Bancontact payment method.", "properties": {}, "title": "param", "type": "object" }, "billie": { "description": "If this is a `billie` PaymentMethod, this hash contains details about the Billie payment method.", "properties": {}, "title": "param", "type": "object" }, "billing_details": { "description": "Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.", "properties": { "address": { "anyOf": [ { "properties": { "city": { "description": "City, district, suburb, town, or village.", "maxLength": 5000, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Address line 1 (e.g., street, PO Box, or company name).", "maxLength": 5000, "type": "string" }, "line2": { "description": "Address line 2 (e.g., apartment, suite, unit, or building).", "maxLength": 5000, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "State, county, province, or region.", "maxLength": 5000, "type": "string" } }, "title": "billing_details_address", "type": "object", "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Billing address." }, "email": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Email address." }, "name": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Full name." }, "phone": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Billing phone number (including extension)." }, "tax_id": { "description": "Taxpayer identification number. Used only for transactions between LATAM buyers and non-LATAM sellers.", "maxLength": 5000, "type": "string" } }, "title": "billing_details_inner_params", "type": "object", "x-stripeMostCommon": [ "address", "email", "name", "phone", "tax_id" ] }, "blik": { "description": "If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.", "properties": {}, "title": "param", "type": "object" }, "boleto": { "description": "If this is a `boleto` PaymentMethod, this hash contains details about the Boleto payment method.", "properties": { "tax_id": { "description": "The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers)", "maxLength": 5000, "type": "string" } }, "required": [ "tax_id" ], "title": "param", "type": "object", "x-stripeMostCommon": [ "tax_id" ] }, "cashapp": { "description": "If this is a `cashapp` PaymentMethod, this hash contains details about the Cash App Pay payment method.", "properties": {}, "title": "param", "type": "object" }, "crypto": { "description": "If this is a Crypto PaymentMethod, this hash contains details about the Crypto payment method.", "properties": {}, "title": "param", "type": "object" }, "customer_balance": { "description": "If this is a `customer_balance` PaymentMethod, this hash contains details about the CustomerBalance payment method.", "properties": {}, "title": "param", "type": "object" }, "eps": { "description": "If this is an `eps` PaymentMethod, this hash contains details about the EPS payment method.", "properties": { "bank": { "description": "The customer's bank.", "enum": [ "arzte_und_apotheker_bank", "austrian_anadi_bank_ag", "bank_austria", "bankhaus_carl_spangler", "bankhaus_schelhammer_und_schattera_ag", "bawag_psk_ag", "bks_bank_ag", "brull_kallmus_bank_ag", "btv_vier_lander_bank", "capital_bank_grawe_gruppe_ag", "deutsche_bank_ag", "dolomitenbank", "easybank_ag", "erste_bank_und_sparkassen", "hypo_alpeadriabank_international_ag", "hypo_bank_burgenland_aktiengesellschaft", "hypo_noe_lb_fur_niederosterreich_u_wien", "hypo_oberosterreich_salzburg_steiermark", "hypo_tirol_bank_ag", "hypo_vorarlberg_bank_ag", "marchfelder_bank", "oberbank_ag", "raiffeisen_bankengruppe_osterreich", "schoellerbank_ag", "sparda_bank_wien", "volksbank_gruppe", "volkskreditbank_ag", "vr_bank_braunau" ], "maxLength": 5000, "type": "string" } }, "title": "param", "type": "object", "x-stripeMostCommon": [ "bank" ] }, "fpx": { "description": "If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method.", "properties": { "account_holder_type": { "description": "Account holder type for FPX transaction", "enum": [ "company", "individual" ], "maxLength": 5000, "type": "string" }, "bank": { "description": "The customer's bank.", "enum": [ "affin_bank", "agrobank", "alliance_bank", "ambank", "bank_islam", "bank_muamalat", "bank_of_china", "bank_rakyat", "bsn", "cimb", "deutsche_bank", "hong_leong_bank", "hsbc", "kfh", "maybank2e", "maybank2u", "ocbc", "pb_enterprise", "public_bank", "rhb", "standard_chartered", "uob" ], "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true } }, "required": [ "bank" ], "title": "param", "type": "object", "x-stripeMostCommon": [ "account_holder_type", "bank" ] }, "giropay": { "description": "If this is a `giropay` PaymentMethod, this hash contains details about the Giropay payment method.", "properties": {}, "title": "param", "type": "object" }, "gopay": { "description": "If this is a Gopay PaymentMethod, this hash contains details about the Gopay payment method.", "properties": {}, "title": "param", "type": "object" }, "grabpay": { "description": "If this is a `grabpay` PaymentMethod, this hash contains details about the GrabPay payment method.", "properties": {}, "title": "param", "type": "object" }, "id_bank_transfer": { "description": "If this is an `IdBankTransfer` PaymentMethod, this hash contains details about the IdBankTransfer payment method.", "properties": { "bank": { "description": "Bank where the account is held.", "enum": [ "bca", "bni", "bri", "cimb", "permata" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "param", "type": "object", "x-stripeMostCommon": [ "bank" ] }, "ideal": { "description": "If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method.", "properties": { "bank": { "description": "The customer's bank. Only use this parameter for existing customers. Don't use it for new customers.", "enum": [ "abn_amro", "asn_bank", "bunq", "buut", "handelsbanken", "ing", "knab", "moneyou", "n26", "nn", "rabobank", "regiobank", "revolut", "sns_bank", "triodos_bank", "van_lanschot", "yoursafe" ], "maxLength": 5000, "type": "string" } }, "title": "param", "type": "object", "x-stripeMostCommon": [ "bank" ] }, "interac_present": { "description": "If this is an `interac_present` PaymentMethod, this hash contains details about the Interac Present payment method.", "properties": {}, "title": "param", "type": "object", "x-stripeMostCommon": [ "device_identifier", "device_type", "emv", "location" ] }, "kakao_pay": { "description": "If this is a `kakao_pay` PaymentMethod, this hash contains details about the Kakao Pay payment method.", "properties": {}, "title": "param", "type": "object" }, "klarna": { "description": "If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method.", "properties": { "dob": { "description": "Customer's date of birth", "properties": { "day": { "description": "The day of birth, between 1 and 31.", "type": "integer" }, "month": { "description": "The month of birth, between 1 and 12.", "type": "integer" }, "year": { "description": "The four-digit year of birth.", "type": "integer" } }, "required": [ "day", "month", "year" ], "title": "date_of_birth", "type": "object", "x-stripeMostCommon": [ "day", "month", "year" ] } }, "title": "param", "type": "object", "x-stripeMostCommon": [ "dob" ] }, "konbini": { "description": "If this is a `konbini` PaymentMethod, this hash contains details about the Konbini payment method.", "properties": {}, "title": "param", "type": "object" }, "kr_card": { "description": "If this is a `kr_card` PaymentMethod, this hash contains details about the Korean Card payment method.", "properties": {}, "title": "param", "type": "object" }, "link": { "description": "If this is an `Link` PaymentMethod, this hash contains details about the Link payment method.", "properties": {}, "title": "param", "type": "object" }, "mb_way": { "description": "If this is a MB WAY PaymentMethod, this hash contains details about the MB WAY payment method.", "properties": {}, "title": "param", "type": "object" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "mobilepay": { "description": "If this is a `mobilepay` PaymentMethod, this hash contains details about the MobilePay payment method.", "properties": {}, "title": "param", "type": "object" }, "multibanco": { "description": "If this is a `multibanco` PaymentMethod, this hash contains details about the Multibanco payment method.", "properties": {}, "title": "param", "type": "object" }, "naver_pay": { "description": "If this is a `naver_pay` PaymentMethod, this hash contains details about the Naver Pay payment method.", "properties": { "funding": { "description": "Whether to use Naver Pay points or a card to fund this transaction. If not provided, this defaults to `card`.", "enum": [ "card", "points" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "param", "type": "object", "x-stripeMostCommon": [ "funding" ] }, "nz_bank_account": { "description": "If this is an nz_bank_account PaymentMethod, this hash contains details about the nz_bank_account payment method.", "properties": { "account_holder_name": { "description": "The name on the bank account. Only required if the account holder name is different from the name of the authorized signatory collected in the PaymentMethod’s billing details.", "maxLength": 5000, "type": "string" }, "account_number": { "description": "The account number for the bank account.", "maxLength": 5000, "type": "string" }, "bank_code": { "description": "The numeric code for the bank account's bank.", "maxLength": 5000, "type": "string" }, "branch_code": { "description": "The numeric code for the bank account's bank branch.", "maxLength": 5000, "type": "string" }, "reference": { "maxLength": 128, "type": "string" }, "suffix": { "description": "The suffix of the bank account number.", "maxLength": 5000, "type": "string" } }, "required": [ "account_number", "bank_code", "branch_code", "suffix" ], "title": "param", "type": "object", "x-stripeMostCommon": [ "account_holder_name", "account_number", "bank_code", "branch_code", "reference", "suffix" ] }, "oxxo": { "description": "If this is an `oxxo` PaymentMethod, this hash contains details about the OXXO payment method.", "properties": {}, "title": "param", "type": "object" }, "p24": { "description": "If this is a `p24` PaymentMethod, this hash contains details about the P24 payment method.", "properties": { "bank": { "description": "The customer's bank.", "enum": [ "alior_bank", "bank_millennium", "bank_nowy_bfg_sa", "bank_pekao_sa", "banki_spbdzielcze", "blik", "bnp_paribas", "boz", "citi_handlowy", "credit_agricole", "envelobank", "etransfer_pocztowy24", "getin_bank", "ideabank", "ing", "inteligo", "mbank_mtransfer", "nest_przelew", "noble_pay", "pbac_z_ipko", "plus_bank", "santander_przelew24", "tmobile_usbugi_bankowe", "toyota_bank", "velobank", "volkswagen_bank" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "param", "type": "object", "x-stripeMostCommon": [ "bank" ] }, "pay_by_bank": { "description": "If this is a `pay_by_bank` PaymentMethod, this hash contains details about the PayByBank payment method.", "properties": {}, "title": "param", "type": "object" }, "payco": { "description": "If this is a `payco` PaymentMethod, this hash contains details about the PAYCO payment method.", "properties": {}, "title": "param", "type": "object" }, "paynow": { "description": "If this is a `paynow` PaymentMethod, this hash contains details about the PayNow payment method.", "properties": {}, "title": "param", "type": "object" }, "paypal": { "description": "If this is a `paypal` PaymentMethod, this hash contains details about the PayPal payment method.", "properties": {}, "title": "param", "type": "object" }, "paypay": { "description": "If this is a `paypay` PaymentMethod, this hash contains details about the PayPay payment method.", "properties": {}, "title": "param", "type": "object" }, "payto": { "description": "If this is a `payto` PaymentMethod, this hash contains details about the PayTo payment method.", "properties": { "account_number": { "description": "The account number for the bank account.", "maxLength": 5000, "type": "string" }, "bsb_number": { "description": "Bank-State-Branch number of the bank account.", "maxLength": 5000, "type": "string" }, "pay_id": { "description": "The PayID alias for the bank account.", "maxLength": 5000, "type": "string" } }, "title": "param", "type": "object", "x-stripeMostCommon": [ "account_number", "bsb_number", "pay_id" ] }, "pix": { "description": "If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.", "properties": {}, "title": "param", "type": "object", "x-stripeMostCommon": [ "tax_id" ] }, "promptpay": { "description": "If this is a `promptpay` PaymentMethod, this hash contains details about the PromptPay payment method.", "properties": {}, "title": "param", "type": "object" }, "qris": { "description": "If this is a `qris` PaymentMethod, this hash contains details about the QRIS payment method.", "properties": {}, "title": "param", "type": "object" }, "radar_options": { "description": "Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.", "properties": { "session": { "description": "A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.", "maxLength": 5000, "type": "string" } }, "title": "radar_options_with_hidden_options", "type": "object", "x-stripeMostCommon": [ "session", "skip_rules" ] }, "rechnung": { "description": "If this is a `rechnung` PaymentMethod, this hash contains details about the Rechnung payment method.", "properties": { "dob": { "description": "Customer's date of birth", "properties": { "day": { "description": "The day of birth, between 1 and 31.", "type": "integer" }, "month": { "description": "The month of birth, between 1 and 12.", "type": "integer" }, "year": { "description": "The four-digit year of birth.", "type": "integer" } }, "required": [ "day", "month", "year" ], "title": "date_of_birth", "type": "object", "x-stripeMostCommon": [ "day", "month", "year" ] } }, "required": [ "dob" ], "title": "param", "type": "object", "x-stripeMostCommon": [ "dob" ] }, "revolut_pay": { "description": "If this is a `revolut_pay` PaymentMethod, this hash contains details about the Revolut Pay payment method.", "properties": {}, "title": "param", "type": "object" }, "samsung_pay": { "description": "If this is a `samsung_pay` PaymentMethod, this hash contains details about the SamsungPay payment method.", "properties": {}, "title": "param", "type": "object" }, "satispay": { "description": "If this is a `satispay` PaymentMethod, this hash contains details about the Satispay payment method.", "properties": {}, "title": "param", "type": "object" }, "sepa_debit": { "description": "If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account.", "properties": { "iban": { "description": "IBAN of the bank account.", "maxLength": 5000, "type": "string" } }, "required": [ "iban" ], "title": "param", "type": "object", "x-stripeMostCommon": [ "iban" ] }, "shopeepay": { "description": "If this is a Shopeepay PaymentMethod, this hash contains details about the Shopeepay payment method.", "properties": {}, "title": "param", "type": "object" }, "sofort": { "description": "If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.", "properties": { "country": { "description": "Two-letter ISO code representing the country the bank account is located in.", "enum": [ "AT", "BE", "DE", "ES", "IT", "NL" ], "type": "string" } }, "required": [ "country" ], "title": "param", "type": "object", "x-stripeMostCommon": [ "country" ] }, "stripe_balance": { "description": "This hash contains details about the Stripe balance payment method.", "properties": { "account": { "description": "The connected account ID whose Stripe balance to use as the source of payment", "maxLength": 5000, "type": "string" }, "source_type": { "description": "The [source_type](https://docs.stripe.com/api/balance/balance_object#balance_object-available-source_types) of the balance", "enum": [ "bank_account", "card", "fpx" ], "type": "string" } }, "title": "param", "type": "object", "x-stripeMostCommon": [ "account", "source_type" ] }, "swish": { "description": "If this is a `swish` PaymentMethod, this hash contains details about the Swish payment method.", "properties": {}, "title": "param", "type": "object" }, "twint": { "description": "If this is a TWINT PaymentMethod, this hash contains details about the TWINT payment method.", "properties": {}, "title": "param", "type": "object" }, "type": { "description": "The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.", "enum": [ "acss_debit", "affirm", "afterpay_clearpay", "alipay", "alma", "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", "billie", "blik", "boleto", "cashapp", "crypto", "customer_balance", "eps", "fpx", "giropay", "gopay", "grabpay", "id_bank_transfer", "ideal", "kakao_pay", "klarna", "konbini", "kr_card", "link", "mb_way", "mobilepay", "multibanco", "naver_pay", "nz_bank_account", "oxxo", "p24", "pay_by_bank", "payco", "paynow", "paypal", "paypay", "payto", "pix", "promptpay", "qris", "rechnung", "revolut_pay", "samsung_pay", "satispay", "sepa_debit", "shopeepay", "sofort", "stripe_balance", "swish", "twint", "us_bank_account", "wechat_pay", "zip" ], "type": "string", "x-stripeBypassValidation": true }, "us_bank_account": { "description": "If this is an `us_bank_account` PaymentMethod, this hash contains details about the US bank account payment method.", "properties": { "account_holder_type": { "description": "Account holder type: individual or company.", "enum": [ "company", "individual" ], "type": "string" }, "account_number": { "description": "Account number of the bank account.", "maxLength": 5000, "type": "string" }, "account_type": { "description": "Account type: checkings or savings. Defaults to checking if omitted.", "enum": [ "checking", "savings" ], "type": "string" }, "financial_connections_account": { "description": "The ID of a Financial Connections Account to use as a payment method.", "maxLength": 5000, "type": "string" }, "routing_number": { "description": "Routing number of the bank account.", "maxLength": 5000, "type": "string" } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "account_holder_type", "account_number", "account_type", "financial_connections_account", "routing_number" ] }, "wechat_pay": { "description": "If this is an `wechat_pay` PaymentMethod, this hash contains details about the wechat_pay payment method.", "properties": {}, "title": "param", "type": "object" }, "zip": { "description": "If this is a `zip` PaymentMethod, this hash contains details about the Zip payment method.", "properties": {}, "title": "param", "type": "object" } }, "required": [ "type" ], "title": "payment_method_data_params", "type": "object", "x-stripeMostCommon": [ "billing_details", "metadata", "type" ] }, "payment_method_options": { "description": "Payment method-specific configuration for this PaymentIntent.", "properties": { "acss_debit": { "anyOf": [ { "properties": { "mandate_options": { "description": "Additional fields for Mandate creation", "properties": { "custom_mandate_url": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "A URL for custom mandate text to render during confirmation step.\nThe URL will be rendered with additional GET parameters `payment_intent` and `payment_intent_client_secret` when confirming a Payment Intent,\nor `setup_intent` and `setup_intent_client_secret` when confirming a Setup Intent." }, "interval_description": { "description": "Description of the mandate interval. Only required if 'payment_schedule' parameter is 'interval' or 'combined'.", "maxLength": 500, "type": "string" }, "payment_schedule": { "description": "Payment schedule for the mandate.", "enum": [ "combined", "interval", "sporadic" ], "type": "string" }, "transaction_type": { "description": "Transaction type of the mandate.", "enum": [ "business", "personal" ], "type": "string" } }, "title": "payment_intent_payment_method_options_mandate_options_param", "type": "object", "x-stripeMostCommon": [ "custom_mandate_url", "interval_description", "payment_schedule", "transaction_type" ] }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "", "none", "off_session", "on_session" ], "type": "string" }, "target_date": { "description": "Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.", "maxLength": 5000, "type": "string" }, "verification_method": { "description": "Bank account verification method.", "enum": [ "automatic", "instant", "microdeposits" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "payment_intent_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "financial_connections", "mandate_options", "setup_future_usage", "target_date", "verification_method" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `acss_debit` PaymentMethod, this sub-hash contains details about the ACSS Debit payment method options." }, "affirm": { "anyOf": [ { "properties": { "capture_method": { "description": "Controls when the funds are captured from the customer's account.\n\nIf provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.", "enum": [ "", "manual" ], "type": "string" }, "preferred_locale": { "description": "Preferred language of the Affirm authorization page that the customer is redirected to.", "maxLength": 30, "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "capture_method", "preferred_locale", "purchase_details", "request_multicapture", "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is an `affirm` PaymentMethod, this sub-hash contains details about the Affirm payment method options." }, "afterpay_clearpay": { "anyOf": [ { "properties": { "capture_method": { "description": "Controls when the funds are captured from the customer's account.\n\nIf provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.", "enum": [ "", "manual" ], "type": "string" }, "reference": { "description": "An internal identifier or reference that this payment corresponds to. You must limit the identifier to 128 characters, and it can only contain letters, numbers, underscores, backslashes, and dashes.\nThis field differs from the statement descriptor and item name.", "maxLength": 128, "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "none" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "capture_method", "reference", "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `afterpay_clearpay` PaymentMethod, this sub-hash contains details about the Afterpay Clearpay payment method options." }, "alipay": { "anyOf": [ { "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "", "none", "off_session" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `alipay` PaymentMethod, this sub-hash contains details about the Alipay payment method options." }, "alma": { "anyOf": [ { "properties": { "capture_method": { "description": "Controls when the funds are captured from the customer's account.\n\nIf provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.", "enum": [ "", "manual" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "capture_method" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `alma` PaymentMethod, this sub-hash contains details about the Alma payment method options." }, "amazon_pay": { "anyOf": [ { "properties": { "capture_method": { "description": "Controls when the funds are captured from the customer's account.\n\nIf provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.", "enum": [ "", "manual" ], "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "", "none", "off_session" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "capture_method", "charge_metadata", "charge_permission_id", "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `amazon_pay` PaymentMethod, this sub-hash contains details about the Amazon Pay payment method options." }, "au_becs_debit": { "anyOf": [ { "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "", "none", "off_session", "on_session" ], "type": "string" }, "target_date": { "description": "Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.", "maxLength": 5000, "type": "string" } }, "title": "payment_intent_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "setup_future_usage", "target_date" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `au_becs_debit` PaymentMethod, this sub-hash contains details about the AU BECS Direct Debit payment method options." }, "bacs_debit": { "anyOf": [ { "properties": { "mandate_options": { "description": "Additional fields for Mandate creation", "properties": { "reference_prefix": { "anyOf": [ { "maxLength": 12, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'." } }, "title": "payment_method_options_mandate_options_param", "type": "object", "x-stripeMostCommon": [ "reference_prefix" ] }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "", "none", "off_session", "on_session" ], "type": "string" }, "target_date": { "description": "Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.", "maxLength": 5000, "type": "string" } }, "title": "payment_intent_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "mandate_options", "setup_future_usage", "target_date" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `bacs_debit` PaymentMethod, this sub-hash contains details about the BACS Debit payment method options." }, "bancontact": { "anyOf": [ { "properties": { "preferred_language": { "description": "Preferred language of the Bancontact authorization page that the customer is redirected to.", "enum": [ "de", "en", "fr", "nl" ], "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "", "none", "off_session" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "preferred_language", "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `bancontact` PaymentMethod, this sub-hash contains details about the Bancontact payment method options." }, "billie": { "anyOf": [ { "properties": { "capture_method": { "description": "Controls when the funds are captured from the customer's account.\n\nIf provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.", "enum": [ "", "manual" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "capture_method", "company_details", "extra_merchant_data_blob", "reference", "request_extended_authorization", "request_multicapture", "request_overcapture" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `billie` PaymentMethod, this sub-hash contains details about the Billie payment method options." }, "blik": { "anyOf": [ { "properties": { "code": { "description": "The 6-digit BLIK code that a customer has generated using their banking application. Can only be set on confirmation.", "maxLength": 5000, "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "", "none" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "payment_intent_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "code", "mandate_options", "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `blik` PaymentMethod, this sub-hash contains details about the BLIK payment method options." }, "boleto": { "anyOf": [ { "properties": { "expires_after_days": { "description": "The number of calendar days before a Boleto voucher expires. For example, if you create a Boleto voucher on Monday and you set expires_after_days to 2, the Boleto invoice will expire on Wednesday at 23:59 America/Sao_Paulo time.", "type": "integer" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "", "none", "off_session", "on_session" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "expires_after_days", "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `boleto` PaymentMethod, this sub-hash contains details about the Boleto payment method options." }, "card": { "anyOf": [ { "properties": { "capture_method": { "description": "Controls when the funds are captured from the customer's account.\n\nIf provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.", "enum": [ "", "manual" ], "type": "string", "x-stripeBypassValidation": true }, "cvc_token": { "description": "A single-use `cvc_update` Token that represents a card CVC value. When provided, the CVC value will be verified during the card payment attempt. This parameter can only be provided during confirmation.", "maxLength": 5000, "type": "string" }, "installments": { "description": "Installment configuration for payments attempted on this PaymentIntent.\n\nFor more information, see the [installments integration guide](https://stripe.com/docs/payments/installments).", "properties": { "enabled": { "description": "Setting to true enables installments for this PaymentIntent.\nThis will cause the response to contain a list of available installment plans.\nSetting to false will prevent any selected plan from applying to a charge.", "type": "boolean" }, "plan": { "anyOf": [ { "properties": { "count": { "description": "For `fixed_count` installment plans, this is required. It represents the number of installment payments your customer will make to their credit card.", "type": "integer" }, "interval": { "description": "For `fixed_count` installment plans, this is required. It represents the interval between installment payments your customer will make to their credit card.\nOne of `month`.", "enum": [ "month" ], "type": "string" }, "type": { "description": "Type of installment plan, one of `fixed_count`, `bonus`, or `revolving`.", "enum": [ "bonus", "fixed_count", "revolving" ], "type": "string" } }, "required": [ "type" ], "title": "installment_plan", "type": "object", "x-stripeMostCommon": [ "count", "interval", "type" ] }, { "enum": [ "" ], "type": "string" } ], "description": "The selected installment plan to use for this payment attempt.\nThis parameter can only be provided during confirmation." } }, "title": "installments_param", "type": "object", "x-stripeMostCommon": [ "enabled", "plan" ] }, "mandate_options": { "description": "Configuration options for setting up an eMandate for cards issued in India.", "properties": { "amount": { "description": "Amount to be charged for future payments.", "type": "integer" }, "amount_type": { "description": "One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.", "enum": [ "fixed", "maximum" ], "type": "string" }, "description": { "description": "A description of the mandate or subscription that is meant to be displayed to the customer.", "maxLength": 200, "type": "string" }, "end_date": { "description": "End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.", "format": "unix-time", "type": "integer" }, "interval": { "description": "Specifies payment frequency. One of `day`, `week`, `month`, `year`, or `sporadic`.", "enum": [ "day", "month", "sporadic", "week", "year" ], "type": "string" }, "interval_count": { "description": "The number of intervals between payments. For example, `interval=month` and `interval_count=3` indicates one payment every three months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). This parameter is optional when `interval=sporadic`.", "type": "integer" }, "reference": { "description": "Unique identifier for the mandate or subscription.", "maxLength": 80, "type": "string" }, "start_date": { "description": "Start date of the mandate or subscription. Start date should not be lesser than yesterday.", "format": "unix-time", "type": "integer" }, "supported_types": { "description": "Specifies the type of mandates supported. Possible values are `india`.", "items": { "enum": [ "india" ], "type": "string" }, "type": "array" } }, "required": [ "amount", "amount_type", "interval", "reference", "start_date" ], "title": "mandate_options_param", "type": "object", "x-stripeMostCommon": [ "amount", "amount_type", "description", "end_date", "interval", "interval_count", "reference", "start_date", "supported_types" ] }, "moto": { "description": "When specified, this parameter indicates that a transaction will be marked\nas MOTO (Mail Order Telephone Order) and thus out of scope for SCA. This\nparameter can only be provided during confirmation.", "type": "boolean" }, "network": { "description": "Selected network to process this PaymentIntent on. Depends on the available networks of the card attached to the PaymentIntent. Can be only set confirm-time.", "enum": [ "amex", "cartes_bancaires", "diners", "discover", "eftpos_au", "girocard", "interac", "jcb", "link", "mastercard", "unionpay", "unknown", "visa" ], "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true }, "request_decremental_authorization": { "description": "Request ability to [decrement the authorization](https://stripe.com/docs/payments/decremental-authorization) for this PaymentIntent.", "enum": [ "if_available", "never" ], "type": "string" }, "request_extended_authorization": { "description": "Request ability to [capture beyond the standard authorization validity window](https://stripe.com/docs/payments/extended-authorization) for this PaymentIntent.", "enum": [ "if_available", "never" ], "type": "string" }, "request_incremental_authorization": { "description": "Request ability to [increment the authorization](https://stripe.com/docs/payments/incremental-authorization) for this PaymentIntent.", "enum": [ "if_available", "never" ], "type": "string" }, "request_multicapture": { "description": "Request ability to make [multiple captures](https://stripe.com/docs/payments/multicapture) for this PaymentIntent.", "enum": [ "if_available", "never" ], "type": "string" }, "request_overcapture": { "description": "Request ability to [overcapture](https://stripe.com/docs/payments/overcapture) for this PaymentIntent.", "enum": [ "if_available", "never" ], "type": "string" }, "request_partial_authorization": { "description": "Request partial authorization on this PaymentIntent.", "enum": [ "if_available", "never" ], "type": "string" }, "request_three_d_secure": { "description": "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.", "enum": [ "any", "automatic", "challenge" ], "type": "string", "x-stripeBypassValidation": true }, "require_cvc_recollection": { "description": "When enabled, using a card that is attached to a customer will require the CVC to be provided again (i.e. using the cvc_token parameter).", "type": "boolean" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "", "none", "off_session", "on_session" ], "type": "string" }, "statement_descriptor_suffix_kana": { "anyOf": [ { "maxLength": 22, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Provides information about a card payment that customers see on their statements. Concatenated with the Kana prefix (shortened Kana descriptor) or Kana statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 22 characters." }, "statement_descriptor_suffix_kanji": { "anyOf": [ { "maxLength": 17, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Provides information about a card payment that customers see on their statements. Concatenated with the Kanji prefix (shortened Kanji descriptor) or Kanji statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 17 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 17 characters." }, "statement_details": { "anyOf": [ { "properties": { "address": { "description": "Please pass in an address that is within your Stripe user account country", "properties": { "city": { "description": "City, district, suburb, town, or village.", "maxLength": 5000, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Address line 1 (e.g., street, PO Box, or company name).", "maxLength": 5000, "type": "string" }, "line2": { "description": "Address line 2 (e.g., apartment, suite, unit, or building).", "maxLength": 5000, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "State, county, province, or region.", "maxLength": 5000, "type": "string" } }, "title": "statement_details_address_param", "type": "object", "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state" ] }, "phone": { "description": "Phone number (e.g., a toll-free number that customers can call)", "maxLength": 5000, "type": "string" } }, "title": "statement_details_param", "type": "object", "x-stripeMostCommon": [ "address", "phone" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Statement details for this payment intent. You can use this to override the merchant details shown on your customers' statements." }, "three_d_secure": { "description": "If 3D Secure authentication was performed with a third-party provider,\nthe authentication details to use for this payment.", "properties": { "ares_trans_status": { "description": "The `transStatus` returned from the card Issuer’s ACS in the ARes.", "enum": [ "A", "C", "I", "N", "R", "U", "Y" ], "type": "string" }, "cryptogram": { "description": "The cryptogram, also known as the \"authentication value\" (AAV, CAVV or\nAEVV). This value is 20 bytes, base64-encoded into a 28-character string.\n(Most 3D Secure providers will return the base64-encoded version, which\nis what you should specify here.)", "maxLength": 5000, "type": "string" }, "electronic_commerce_indicator": { "description": "The Electronic Commerce Indicator (ECI) is returned by your 3D Secure\nprovider and indicates what degree of authentication was performed.", "enum": [ "01", "02", "05", "06", "07" ], "type": "string", "x-stripeBypassValidation": true }, "exemption_indicator": { "description": "The exemption requested via 3DS and accepted by the issuer at authentication time.", "enum": [ "low_risk", "none" ], "type": "string" }, "network_options": { "description": "Network specific 3DS fields. Network specific arguments require an\nexplicit card brand choice. The parameter `payment_method_options.card.network``\nmust be populated accordingly", "properties": { "cartes_bancaires": { "description": "Cartes Bancaires-specific 3DS fields.", "properties": { "cb_avalgo": { "description": "The cryptogram calculation algorithm used by the card Issuer's ACS\nto calculate the Authentication cryptogram. Also known as `cavvAlgorithm`.\nmessageExtension: CB-AVALGO", "enum": [ "0", "1", "2", "3", "4", "A" ], "type": "string" }, "cb_exemption": { "description": "The exemption indicator returned from Cartes Bancaires in the ARes.\nmessage extension: CB-EXEMPTION; string (4 characters)\nThis is a 3 byte bitmap (low significant byte first and most significant\nbit first) that has been Base64 encoded", "maxLength": 4, "type": "string" }, "cb_score": { "description": "The risk score returned from Cartes Bancaires in the ARes.\nmessage extension: CB-SCORE; numeric value 0-99", "type": "integer" } }, "required": [ "cb_avalgo" ], "title": "cartes_bancaires_network_options_param", "type": "object", "x-stripeMostCommon": [ "cb_avalgo", "cb_exemption", "cb_score" ] } }, "title": "network_options_param", "type": "object", "x-stripeMostCommon": [ "cartes_bancaires" ] }, "requestor_challenge_indicator": { "description": "The challenge indicator (`threeDSRequestorChallengeInd`) which was requested in the\nAReq sent to the card Issuer's ACS. A string containing 2 digits from 01-99.", "maxLength": 2, "type": "string" }, "transaction_id": { "description": "For 3D Secure 1, the XID. For 3D Secure 2, the Directory Server\nTransaction ID (dsTransID).", "maxLength": 5000, "type": "string" }, "version": { "description": "The version of 3D Secure that was performed.", "enum": [ "1.0.2", "2.1.0", "2.2.0" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "cryptogram", "transaction_id", "version" ], "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "ares_trans_status", "cryptogram", "electronic_commerce_indicator", "exemption_indicator", "network_options", "requestor_challenge_indicator", "transaction_id", "version" ] } }, "title": "payment_intent_param", "type": "object", "x-stripeMostCommon": [ "allow_partial_amount", "buy_now_pay_later_options", "capture_delay_days", "capture_method", "commerce_type", "cvc_token", "installments", "mandate_options", "mcc", "mit_exemption", "moto", "network", "network_options", "network_token", "recipient_details", "request_decremental_authorization", "request_extended_authorization", "request_flexible_extended_authorization", "request_incremental_authorization", "request_incremental_authorization_support", "request_multicapture", "request_overcapture", "request_partial_authorization", "request_reauthorization", "request_three_d_secure", "require_cvc_recollection", "sender_details", "setup_future_usage", "statement_descriptor_suffix_kana", "statement_descriptor_suffix_kanji", "statement_details", "stored_credential_transaction_type", "stored_credential_usage", "three_d_secure", "transaction_purpose" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Configuration for any card payments attempted on this PaymentIntent." }, "card_present": { "anyOf": [ { "properties": { "request_extended_authorization": { "description": "Request ability to capture this payment beyond the standard [authorization validity window](https://stripe.com/docs/terminal/features/extended-authorizations#authorization-validity)", "type": "boolean" }, "request_incremental_authorization_support": { "description": "Request ability to [increment](https://stripe.com/docs/terminal/features/incremental-authorizations) this PaymentIntent if the combination of MCC and card brand is eligible. Check [incremental_authorization_supported](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported) in the [Confirm](https://stripe.com/docs/api/payment_intents/confirm) response to verify support.", "type": "boolean" }, "routing": { "description": "Network routing priority on co-branded EMV cards supporting domestic debit and international card schemes.", "properties": { "requested_priority": { "description": "Routing requested priority", "enum": [ "domestic", "international" ], "type": "string" } }, "title": "routing_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "requested_priority" ] } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "buy_now_pay_later_options", "capture_method", "request_extended_authorization", "request_flexible_extended_authorization", "request_incremental_authorization", "request_incremental_authorization_support", "request_partial_authorization", "request_reauthorization", "routing" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `card_present` PaymentMethod, this sub-hash contains details about the Card Present payment method options." }, "cashapp": { "anyOf": [ { "properties": { "capture_method": { "description": "Controls when the funds are captured from the customer's account.\n\nIf provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.", "enum": [ "", "manual" ], "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "", "none", "off_session", "on_session" ], "type": "string" } }, "title": "payment_intent_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "capture_method", "request_incremental_authorization", "restricted_transaction_categories", "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `cashapp` PaymentMethod, this sub-hash contains details about the Cash App Pay payment method options." }, "crypto": { "anyOf": [ { "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "none" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "mode", "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `crypto` PaymentMethod, this sub-hash contains details about the Crypto payment method options." }, "customer_balance": { "anyOf": [ { "properties": { "bank_transfer": { "description": "Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`.", "properties": { "eu_bank_transfer": { "description": "Configuration for the eu_bank_transfer funding type.", "properties": { "country": { "description": "The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`.", "maxLength": 5000, "type": "string" } }, "required": [ "country" ], "title": "eu_bank_transfer_params", "type": "object", "x-stripeMostCommon": [ "country" ] }, "requested_address_types": { "description": "List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.\n\nPermitted values include: `sort_code`, `zengin`, `iban`, or `spei`.", "items": { "enum": [ "aba", "iban", "sepa", "sort_code", "spei", "swift", "zengin" ], "type": "string", "x-stripeBypassValidation": true }, "type": "array" }, "type": { "description": "The list of bank transfer types that this PaymentIntent is allowed to use for funding Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.", "enum": [ "eu_bank_transfer", "gb_bank_transfer", "jp_bank_transfer", "mx_bank_transfer", "us_bank_transfer" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "bank_transfer_param", "type": "object", "x-stripeMostCommon": [ "eu_bank_transfer", "id_bank_account", "id_bank_transfer", "requested_address_types", "type" ] }, "funding_type": { "description": "The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.", "enum": [ "bank_transfer" ], "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "none" ], "type": "string" } }, "title": "payment_intent_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "bank_transfer", "funding_type", "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `customer balance` PaymentMethod, this sub-hash contains details about the customer balance payment method options." }, "eps": { "anyOf": [ { "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "none" ], "type": "string" } }, "title": "payment_intent_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `eps` PaymentMethod, this sub-hash contains details about the EPS payment method options." }, "fpx": { "anyOf": [ { "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `fpx` PaymentMethod, this sub-hash contains details about the FPX payment method options." }, "giropay": { "anyOf": [ { "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `giropay` PaymentMethod, this sub-hash contains details about the Giropay payment method options." }, "gopay": { "anyOf": [ { "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "none", "off_session" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `gopay` PaymentMethod, this sub-hash contains details about the Gopay payment method options." }, "grabpay": { "anyOf": [ { "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `grabpay` PaymentMethod, this sub-hash contains details about the Grabpay payment method options." }, "id_bank_transfer": { "anyOf": [ { "properties": { "expires_after": { "description": "The UNIX timestamp until which the virtual bank account is valid. Permitted range is from 5 minutes from now until 31 days from now. If unset, it defaults to 3 days from now.", "type": "integer" }, "expires_at": { "description": "The UNIX timestamp until which the virtual bank account is valid. Permitted range is from now until 30 days from now. If unset, it defaults to 1 days from now.", "format": "unix-time", "type": "integer" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "none" ], "type": "string" } }, "title": "payment_intent_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "expires_after", "expires_at", "on_existing_payment_intent", "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `id_bank_transfer` PaymentMethod, this sub-hash contains details about the Indonesia Bank Transfer payment method options." }, "ideal": { "anyOf": [ { "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "", "none", "off_session" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `ideal` PaymentMethod, this sub-hash contains details about the Ideal payment method options." }, "interac_present": { "anyOf": [ { "properties": {}, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `interac_present` PaymentMethod, this sub-hash contains details about the Card Present payment method options." }, "kakao_pay": { "anyOf": [ { "properties": { "capture_method": { "description": "Controls when the funds are captured from the customer's account.\n\nIf provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.", "enum": [ "", "manual" ], "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "", "none", "off_session" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "capture_method", "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `kakao_pay` PaymentMethod, this sub-hash contains details about the Kakao Pay payment method options." }, "klarna": { "anyOf": [ { "properties": { "capture_method": { "description": "Controls when the funds are captured from the customer's account.\n\nIf provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.", "enum": [ "", "manual" ], "type": "string" }, "on_demand": { "description": "On-demand details if setting up or charging an on-demand payment.", "properties": { "average_amount": { "description": "Your average amount value. You can use a value across your customer base, or segment based on customer type, country, etc.", "type": "integer" }, "maximum_amount": { "description": "The maximum value you may charge a customer per purchase. You can use a value across your customer base, or segment based on customer type, country, etc.", "type": "integer" }, "minimum_amount": { "description": "The lowest or minimum value you may charge a customer per purchase. You can use a value across your customer base, or segment based on customer type, country, etc.", "type": "integer" }, "purchase_interval": { "description": "Interval at which the customer is making purchases", "enum": [ "day", "month", "week", "year" ], "type": "string" }, "purchase_interval_count": { "description": "The number of `purchase_interval` between charges", "type": "integer" } }, "title": "on_demand_param", "type": "object", "x-stripeMostCommon": [ "average_amount", "maximum_amount", "minimum_amount", "purchase_interval", "purchase_interval_count" ] }, "preferred_locale": { "description": "Preferred language of the Klarna authorization page that the customer is redirected to", "enum": [ "cs-CZ", "da-DK", "de-AT", "de-CH", "de-DE", "el-GR", "en-AT", "en-AU", "en-BE", "en-CA", "en-CH", "en-CZ", "en-DE", "en-DK", "en-ES", "en-FI", "en-FR", "en-GB", "en-GR", "en-IE", "en-IT", "en-NL", "en-NO", "en-NZ", "en-PL", "en-PT", "en-RO", "en-SE", "en-US", "es-ES", "es-US", "fi-FI", "fr-BE", "fr-CA", "fr-CH", "fr-FR", "it-CH", "it-IT", "nb-NO", "nl-BE", "nl-NL", "pl-PL", "pt-PT", "ro-RO", "sv-FI", "sv-SE" ], "type": "string", "x-stripeBypassValidation": true }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "none", "off_session", "on_session" ], "type": "string" }, "subscriptions": { "anyOf": [ { "items": { "properties": { "interval": { "description": "Unit of time between subscription charges.", "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "description": "The number of intervals (specified in the `interval` attribute) between subscription charges. For example, `interval=month` and `interval_count=3` charges every 3 months.", "type": "integer" }, "name": { "description": "Name for subscription.", "maxLength": 255, "type": "string" }, "next_billing": { "description": "Describes the upcoming charge for this subscription.", "properties": { "amount": { "description": "The amount of the next charge for the subscription.", "type": "integer" }, "date": { "description": "The date of the next charge for the subscription in YYYY-MM-DD format.", "maxLength": 5000, "type": "string" } }, "required": [ "amount", "date" ], "title": "subscription_next_billing_param", "type": "object", "x-stripeMostCommon": [ "amount", "date" ] }, "reference": { "description": "A non-customer-facing reference to correlate subscription charges in the Klarna app. Use a value that persists across subscription charges.", "maxLength": 255, "type": "string" } }, "required": [ "interval", "reference" ], "title": "subscription_param", "type": "object", "x-stripeMostCommon": [ "interval", "interval_count", "name", "next_billing", "reference" ] }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "Subscription details if setting up or charging a subscription." } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "capture_method", "extra_merchant_data_blob", "interoperability_token", "line_items", "on_demand", "partner_confirmation_token", "payment_details", "payment_method_category", "payment_option_id", "preferred_locale", "request_incremental_authorization", "request_multicapture", "setup_future_usage", "subscriptions", "supplementary_purchase_data" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `klarna` PaymentMethod, this sub-hash contains details about the Klarna payment method options." }, "konbini": { "anyOf": [ { "properties": { "confirmation_number": { "anyOf": [ { "maxLength": 11, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "An optional 10 to 11 digit numeric-only string determining the confirmation code at applicable convenience stores. Must not consist of only zeroes and could be rejected in case of insufficient uniqueness. We recommend to use the customer's phone number." }, "expires_after_days": { "anyOf": [ { "type": "integer" }, { "enum": [ "" ], "type": "string" } ], "description": "The number of calendar days (between 1 and 60) after which Konbini payment instructions will expire. For example, if a PaymentIntent is confirmed with Konbini and `expires_after_days` set to 2 on Monday JST, the instructions will expire on Wednesday 23:59:59 JST. Defaults to 3 days." }, "expires_at": { "anyOf": [ { "format": "unix-time", "type": "integer" }, { "enum": [ "" ], "type": "string" } ], "description": "The timestamp at which the Konbini payment instructions will expire. Only one of `expires_after_days` or `expires_at` may be set." }, "product_description": { "anyOf": [ { "maxLength": 22, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "A product descriptor of up to 22 characters, which will appear to customers at the convenience store." }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "confirmation_number", "expires_after_days", "expires_at", "fee_amount", "product_description", "setup_future_usage", "tax_amount" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `konbini` PaymentMethod, this sub-hash contains details about the Konbini payment method options." }, "kr_card": { "anyOf": [ { "properties": { "capture_method": { "description": "Controls when the funds are captured from the customer's account.\n\nIf provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.", "enum": [ "", "manual" ], "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "", "none", "off_session" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "capture_method", "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `kr_card` PaymentMethod, this sub-hash contains details about the KR Card payment method options." }, "link": { "anyOf": [ { "properties": { "capture_method": { "description": "Controls when the funds are captured from the customer's account.\n\nIf provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.", "enum": [ "", "manual" ], "type": "string" }, "persistent_token": { "description": "[Deprecated] This is a legacy parameter that no longer has any function.", "maxLength": 5000, "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "", "none", "off_session" ], "type": "string" } }, "title": "payment_intent_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "capture_method", "persistent_token", "request_multicapture", "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `link` PaymentMethod, this sub-hash contains details about the Link payment method options." }, "mb_way": { "anyOf": [ { "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `mb_way` PaymentMethod, this sub-hash contains details about the MB WAY payment method options." }, "mobilepay": { "anyOf": [ { "properties": { "capture_method": { "description": "Controls when the funds are captured from the customer's account.\n\nIf provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.", "enum": [ "", "manual" ], "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "capture_method", "reference", "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `MobilePay` PaymentMethod, this sub-hash contains details about the MobilePay payment method options." }, "multibanco": { "anyOf": [ { "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `multibanco` PaymentMethod, this sub-hash contains details about the Multibanco payment method options." }, "naver_pay": { "anyOf": [ { "properties": { "capture_method": { "description": "Controls when the funds are captured from the customer's account.\n\nIf provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.", "enum": [ "", "manual" ], "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "", "none", "off_session" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "capture_method", "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `naver_pay` PaymentMethod, this sub-hash contains details about the Naver Pay payment method options." }, "nz_bank_account": { "anyOf": [ { "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "", "none", "off_session", "on_session" ], "type": "string" }, "target_date": { "description": "Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.", "maxLength": 5000, "type": "string" } }, "title": "payment_intent_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "setup_future_usage", "target_date" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `nz_bank_account` PaymentMethod, this sub-hash contains details about the NZ BECS Direct Debit payment method options." }, "oxxo": { "anyOf": [ { "properties": { "expires_after_days": { "description": "The number of calendar days before an OXXO voucher expires. For example, if you create an OXXO voucher on Monday and you set expires_after_days to 2, the OXXO invoice will expire on Wednesday at 23:59 America/Mexico_City time.", "type": "integer" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "expires_after_days", "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `oxxo` PaymentMethod, this sub-hash contains details about the OXXO payment method options." }, "p24": { "anyOf": [ { "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "none" ], "type": "string" }, "tos_shown_and_accepted": { "description": "Confirm that the payer has accepted the P24 terms and conditions.", "type": "boolean" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "installments", "setup_future_usage", "tos_shown_and_accepted" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `p24` PaymentMethod, this sub-hash contains details about the Przelewy24 payment method options." }, "pay_by_bank": { "anyOf": [ { "properties": {}, "title": "payment_intent_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "allow_delayed_notification", "country", "locale", "statement_descriptor" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `pay_by_bank` PaymentMethod, this sub-hash contains details about the PayByBank payment method options." }, "payco": { "anyOf": [ { "properties": { "capture_method": { "description": "Controls when the funds are captured from the customer's account.\n\nIf provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.", "enum": [ "", "manual" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "capture_method" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `payco` PaymentMethod, this sub-hash contains details about the PAYCO payment method options." }, "paynow": { "anyOf": [ { "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `paynow` PaymentMethod, this sub-hash contains details about the PayNow payment method options." }, "paypal": { "anyOf": [ { "properties": { "capture_method": { "description": "Controls when the funds will be captured from the customer's account.", "enum": [ "", "manual" ], "type": "string" }, "line_items": { "description": "The line items purchased by the customer.", "items": { "properties": { "category": { "description": "Type of the line item.", "enum": [ "digital_goods", "donation", "physical_goods" ], "type": "string" }, "description": { "description": "Description of the line item.", "maxLength": 127, "type": "string" }, "name": { "description": "Descriptive name of the line item.", "maxLength": 127, "type": "string" }, "quantity": { "description": "Quantity of the line item. Must be a positive number.", "type": "integer" }, "sku": { "description": "Client facing stock keeping unit, article number or similar.", "maxLength": 127, "type": "string" }, "sold_by": { "description": "The Stripe account ID of the connected account that sells the item.", "maxLength": 5000, "type": "string" }, "tax": { "description": "The tax information for the line item.", "properties": { "amount": { "description": "The tax for a single unit of the line item in minor units. Cannot be a negative number.", "type": "integer" }, "behavior": { "description": "The tax behavior for the line item.", "enum": [ "exclusive", "inclusive" ], "type": "string" } }, "required": [ "amount", "behavior" ], "title": "line_item_tax_param", "type": "object", "x-stripeMostCommon": [ "amount", "behavior" ] }, "unit_amount": { "description": "Price for a single unit of the line item in minor units. Cannot be a negative number.", "type": "integer" } }, "required": [ "name", "quantity", "unit_amount" ], "title": "line_item_param", "type": "object", "x-stripeMostCommon": [ "category", "description", "name", "quantity", "sku", "sold_by", "tax", "unit_amount" ] }, "type": "array" }, "preferred_locale": { "description": "[Preferred locale](https://stripe.com/docs/payments/paypal/supported-locales) of the PayPal checkout page that the customer is redirected to.", "enum": [ "cs-CZ", "da-DK", "de-AT", "de-DE", "de-LU", "el-GR", "en-GB", "en-US", "es-ES", "fi-FI", "fr-BE", "fr-FR", "fr-LU", "hu-HU", "it-IT", "nl-BE", "nl-NL", "pl-PL", "pt-PT", "sk-SK", "sv-SE" ], "type": "string", "x-stripeBypassValidation": true }, "reference": { "description": "A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID.", "maxLength": 127, "type": "string" }, "reference_id": { "description": "A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID.", "maxLength": 127, "type": "string" }, "risk_correlation_id": { "description": "The risk correlation ID for an on-session payment using a saved PayPal payment method.", "maxLength": 32, "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "", "none", "off_session" ], "type": "string" }, "subsellers": { "description": "The Stripe connected account IDs of the sellers on the platform for this transaction (optional). Only allowed when [separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers) are used.", "items": { "maxLength": 32, "type": "string" }, "type": "array" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "allow_delayed_notification", "capture_method", "line_items", "preferred_locale", "reference", "reference_id", "risk_correlation_id", "setup_future_usage", "subsellers" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `paypal` PaymentMethod, this sub-hash contains details about the PayPal payment method options." }, "paypay": { "anyOf": [ { "properties": { "capture_method": { "description": "Controls when the funds are captured from the customer's account.\n\nIf provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.", "enum": [ "", "manual" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "capture_method" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `paypay` PaymentMethod, this sub-hash contains details about the PayPay payment method options." }, "payto": { "anyOf": [ { "properties": { "mandate_options": { "description": "Additional fields for Mandate creation. Only `purpose` field is configurable for PayTo PaymentIntent with `setup_future_usage=none`. Other fields are only applicable to PayTo PaymentIntent with `setup_future_usage=off_session`", "properties": { "amount": { "description": "Amount that will be collected. It is required when `amount_type` is `fixed`.", "type": "integer" }, "amount_type": { "description": "The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively.", "enum": [ "fixed", "maximum" ], "type": "string" }, "end_date": { "description": "Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.", "maxLength": 5000, "type": "string" }, "payment_schedule": { "description": "The periodicity at which payments will be collected.", "enum": [ "adhoc", "annual", "daily", "fortnightly", "monthly", "quarterly", "semi_annual", "weekly" ], "type": "string" }, "payments_per_period": { "description": "The number of payments that will be made during a payment period. Defaults to 1 except for when `payment_schedule` is `adhoc`. In that case, it defaults to no limit.", "type": "integer" }, "purpose": { "description": "The purpose for which payments are made. Defaults to retail.", "enum": [ "dependant_support", "government", "loan", "mortgage", "other", "pension", "personal", "retail", "salary", "tax", "utility" ], "type": "string" } }, "title": "payment_intent_payment_method_options_mandate_options_param", "type": "object", "x-stripeMostCommon": [ "amount", "amount_type", "end_date", "payment_schedule", "payments_per_period", "purpose" ] }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "", "none", "off_session" ], "type": "string" } }, "title": "payment_intent_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "mandate_options", "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `payto` PaymentMethod, this sub-hash contains details about the PayTo payment method options." }, "pix": { "anyOf": [ { "properties": { "amount_includes_iof": { "description": "Determines if the amount includes the IOF tax. Defaults to `never`.", "enum": [ "always", "never" ], "type": "string" }, "expires_after_seconds": { "description": "The number of seconds (between 10 and 1209600) after which Pix payment will expire. Defaults to 86400 seconds.", "type": "integer" }, "expires_at": { "description": "The timestamp at which the Pix expires (between 10 and 1209600 seconds in the future). Defaults to 1 day in the future.", "format": "unix-time", "type": "integer" }, "mandate_options": { "description": "Additional fields for mandate creation. Only applicable when `setup_future_usage=off_session`.", "properties": { "amount": { "description": "Amount to be charged for future payments. Required when `amount_type=fixed`. If not provided for `amount_type=maximum`, defaults to 40000.", "type": "integer" }, "amount_includes_iof": { "description": "Determines if the amount includes the IOF tax. Defaults to `never`.", "enum": [ "always", "never" ], "type": "string" }, "amount_type": { "description": "Type of amount. Defaults to `maximum`.", "enum": [ "fixed", "maximum" ], "type": "string" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Only `brl` is supported currently.", "format": "currency", "type": "string" }, "end_date": { "description": "Date when the mandate expires and no further payments will be charged, in `YYYY-MM-DD`. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.", "maxLength": 5000, "type": "string" }, "payment_schedule": { "description": "Schedule at which the future payments will be charged. Defaults to `weekly`.", "enum": [ "halfyearly", "monthly", "quarterly", "weekly", "yearly" ], "type": "string" }, "reference": { "description": "Subscription name displayed to buyers in their bank app. Defaults to the displayable business name.", "maxLength": 35, "type": "string" }, "start_date": { "description": "Start date of the mandate, in `YYYY-MM-DD`. Start date should be at least 3 days in the future. Defaults to 3 days after the current date.", "maxLength": 5000, "type": "string" } }, "title": "payment_method_options_mandate_options_param", "type": "object", "x-stripeMostCommon": [ "amount", "amount_includes_iof", "amount_type", "currency", "end_date", "payment_schedule", "reference", "start_date" ] }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "none", "off_session" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "amount_includes_iof", "expires_after_seconds", "expires_at", "mandate_options", "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `pix` PaymentMethod, this sub-hash contains details about the Pix payment method options." }, "promptpay": { "anyOf": [ { "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `promptpay` PaymentMethod, this sub-hash contains details about the PromptPay payment method options." }, "qris": { "anyOf": [ { "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `qris` PaymentMethod, this sub-hash contains details about the QRIS payment method options." }, "rechnung": { "anyOf": [ { "properties": {}, "title": "payment_intent_payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `rechnung` PaymentMethod, this sub-hash contains details about the Rechnung payment method options." }, "revolut_pay": { "anyOf": [ { "properties": { "capture_method": { "description": "Controls when the funds are captured from the customer's account.\n\nIf provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.", "enum": [ "", "manual" ], "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "", "none", "off_session" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "capture_method", "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `revolut_pay` PaymentMethod, this sub-hash contains details about the Revolut Pay payment method options." }, "samsung_pay": { "anyOf": [ { "properties": { "capture_method": { "description": "Controls when the funds are captured from the customer's account.\n\nIf provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.", "enum": [ "", "manual" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "capture_method" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `samsung_pay` PaymentMethod, this sub-hash contains details about the Samsung Pay payment method options." }, "satispay": { "anyOf": [ { "properties": { "capture_method": { "description": "Controls when the funds are captured from the customer's account.\n\nIf provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.", "enum": [ "", "manual" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "capture_method", "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `satispay` PaymentMethod, this sub-hash contains details about the Satispay payment method options." }, "sepa_debit": { "anyOf": [ { "properties": { "mandate_options": { "description": "Additional fields for Mandate creation", "properties": { "reference_prefix": { "anyOf": [ { "maxLength": 12, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'." } }, "title": "payment_method_options_mandate_options_param", "type": "object", "x-stripeMostCommon": [ "reference", "reference_prefix" ] }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "", "none", "off_session", "on_session" ], "type": "string" }, "target_date": { "description": "Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.", "maxLength": 5000, "type": "string" } }, "title": "payment_intent_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "mandate_options", "setup_future_usage", "target_date", "verification_method" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `sepa_debit` PaymentIntent, this sub-hash contains details about the SEPA Debit payment method options." }, "shopeepay": { "anyOf": [ { "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `shopeepay` PaymentMethod, this sub-hash contains details about the ShopeePay payment method options." }, "sofort": { "anyOf": [ { "properties": { "preferred_language": { "description": "Language shown to the payer on redirect.", "enum": [ "", "de", "en", "es", "fr", "it", "nl", "pl" ], "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "", "none", "off_session" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "preferred_language", "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `sofort` PaymentMethod, this sub-hash contains details about the SOFORT payment method options." }, "stripe_balance": { "anyOf": [ { "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "", "none", "off_session" ], "type": "string" } }, "title": "payment_intent_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `stripe_balance` PaymentMethod, this sub-hash contains details about the Stripe Balance payment method options." }, "swish": { "anyOf": [ { "properties": { "reference": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "A reference for this payment to be displayed in the Swish app." }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "none" ], "type": "string" } }, "title": "payment_intent_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "authorization_method", "reference", "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `Swish` PaymentMethod, this sub-hash contains details about the Swish payment method options." }, "twint": { "anyOf": [ { "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `twint` PaymentMethod, this sub-hash contains details about the TWINT payment method options." }, "us_bank_account": { "anyOf": [ { "properties": { "financial_connections": { "description": "Additional fields for Financial Connections Session creation", "properties": { "filters": { "description": "Provide filters for the linked accounts that the customer can select for the payment method.", "properties": { "account_subcategories": { "description": "The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.", "items": { "enum": [ "checking", "savings" ], "maxLength": 5000, "type": "string" }, "type": "array" }, "institution": { "description": "ID of the institution to use to filter for selectable accounts.", "maxLength": 5000, "type": "string" } }, "title": "linked_account_options_filters_param", "type": "object", "x-stripeMostCommon": [ "account_subcategories", "institution" ] }, "manual_entry": { "description": "Customize manual entry behavior", "properties": { "mode": { "description": "Settings for configuring manual entry of account details.", "enum": [ "automatic", "custom" ], "type": "string" } }, "required": [ "mode" ], "title": "linked_account_options_manual_entry_param", "type": "object", "x-stripeMostCommon": [ "mode" ] }, "permissions": { "description": "The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.", "items": { "enum": [ "balances", "ownership", "payment_method", "transactions" ], "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true }, "type": "array" }, "prefetch": { "description": "List of data features that you would like to retrieve upon account creation.", "items": { "enum": [ "balances", "inferred_balances", "ownership", "transactions" ], "type": "string", "x-stripeBypassValidation": true }, "type": "array" }, "return_url": { "description": "For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.", "maxLength": 5000, "type": "string" } }, "title": "linked_account_options_param", "type": "object", "x-stripeMostCommon": [ "filters", "manual_entry", "permissions", "prefetch", "return_url" ] }, "mandate_options": { "description": "Additional fields for Mandate creation", "properties": { "collection_method": { "description": "The method used to collect offline mandate customer acceptance.", "enum": [ "", "paper" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "mandate_options_param", "type": "object", "x-stripeMostCommon": [ "collection_method" ] }, "networks": { "description": "Additional fields for network related functions", "properties": { "requested": { "description": "Triggers validations to run across the selected networks", "items": { "enum": [ "ach", "us_domestic_wire" ], "type": "string" }, "type": "array" } }, "title": "networks_options_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "preferred_settlement_speed": { "description": "Preferred transaction settlement speed", "enum": [ "", "fastest", "standard" ], "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "", "none", "off_session", "on_session" ], "type": "string" }, "target_date": { "description": "Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.", "maxLength": 5000, "type": "string" }, "verification_method": { "description": "Bank account verification method.", "enum": [ "automatic", "instant", "microdeposits" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "payment_intent_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "financial_connections", "mandate_options", "networks", "preferred_settlement_speed", "setup_future_usage", "target_date", "verification_method" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `us_bank_account` PaymentMethod, this sub-hash contains details about the US bank account payment method options." }, "wechat_pay": { "anyOf": [ { "properties": { "app_id": { "description": "The app ID registered with WeChat Pay. Only required when client is ios or android.", "maxLength": 5000, "type": "string" }, "client": { "description": "The client type that the end customer will pay from", "enum": [ "android", "ios", "web" ], "type": "string", "x-stripeBypassValidation": true }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "app_id", "client", "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `wechat_pay` PaymentMethod, this sub-hash contains details about the WeChat Pay payment method options." }, "zip": { "anyOf": [ { "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "setup_future_usage" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If this is a `zip` PaymentMethod, this sub-hash contains details about the Zip payment method options." } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "acss_debit", "affirm", "afterpay_clearpay", "alipay", "alma", "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", "billie", "blik", "boleto", "boleto_pilot", "card", "card_present", "cashapp", "crypto", "customer_balance", "demo_pay", "dummy_auth_push", "dummy_passthrough_card", "eps", "fpx", "getbalance", "giropay", "gopay", "grabpay", "id_bank_transfer", "ideal", "interac_present", "kakao_pay", "klarna", "knet", "konbini", "kr_card", "kr_market", "link", "mb_way", "mobilepay", "mondu", "multibanco", "naver_pay", "ng_bank", "ng_bank_transfer", "ng_card", "ng_market", "ng_ussd", "nz_bank_account", "oxxo", "p24", "pay_by_bank", "payco", "paynow", "paypal", "paypay", "payto", "pix", "promptpay", "qris", "rechnung", "revolut_pay", "samsung_pay", "satispay", "sepa_debit", "shopeepay", "sofort", "stripe_balance", "swish", "twint", "upi", "us_bank_account", "vipps", "wechat_pay", "zip" ] }, "payment_method_types": { "description": "The list of payment method types (for example, a card) that this PaymentIntent can use. Use `automatic_payment_methods` to manage payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods). A list of valid payment method types can be found [here](https://docs.stripe.com/api/payment_methods/object#payment_method_object-type).", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "radar_options": { "description": "Options to configure Radar. Learn more about [Radar Sessions](https://stripe.com/docs/radar/radar-session).", "properties": { "session": { "description": "A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.", "maxLength": 5000, "type": "string" } }, "title": "radar_options_with_hidden_options", "type": "object", "x-stripeMostCommon": [ "session", "skip_rules" ] }, "receipt_email": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Email address that the receipt for the resulting payment will be sent to. If `receipt_email` is specified for a payment in live mode, a receipt will be sent regardless of your [email settings](https://dashboard.stripe.com/account/emails)." }, "return_url": { "description": "The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site.\nIf you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme.\nThis parameter is only used for cards and other redirect-based payment methods.", "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "", "off_session", "on_session" ], "type": "string" }, "shipping": { "anyOf": [ { "properties": { "address": { "description": "Shipping address.", "properties": { "city": { "description": "City, district, suburb, town, or village.", "maxLength": 5000, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Address line 1 (e.g., street, PO Box, or company name).", "maxLength": 5000, "type": "string" }, "line2": { "description": "Address line 2 (e.g., apartment, suite, unit, or building).", "maxLength": 5000, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "State, county, province, or region.", "maxLength": 5000, "type": "string" } }, "title": "optional_fields_address", "type": "object", "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state" ] }, "carrier": { "description": "The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.", "maxLength": 5000, "type": "string" }, "name": { "description": "Recipient name.", "maxLength": 5000, "type": "string" }, "phone": { "description": "Recipient phone (including extension).", "maxLength": 5000, "type": "string" }, "tracking_number": { "description": "The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.", "maxLength": 5000, "type": "string" } }, "required": [ "address", "name" ], "title": "optional_fields_shipping", "type": "object", "x-stripeMostCommon": [ "address", "carrier", "name", "phone", "tracking_number" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Shipping information for this PaymentIntent." }, "use_stripe_sdk": { "description": "Set to `true` when confirming server-side and using Stripe.js, iOS, or Android client-side SDKs to handle the next actions.", "type": "boolean" } }, "type": "object", "x-stripeMostCommon": [ "payment_method", "receipt_email", "setup_future_usage", "shipping" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_intent" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Confirm a PaymentIntent" } }, "/v1/payment_intents/{intent}/decrement_authorization": { "post": { "description": "

Perform a decremental authorization on an eligible\nPaymentIntent. To be eligible, the\nPaymentIntent’s status must be requires_capture and\ndecremental_authorization.status\nmust be available.

\n\n

Decremental authorizations decrease the authorized amount on your customer’s card\nto the new, lower amount provided. A single PaymentIntent can call this endpoint multiple times to further decrease the authorized amount.

\n\n

After decrement, the PaymentIntent object\nreturns with the updated\namount.\nThe PaymentIntent will now be capturable up to the new authorized amount.

\n\n

Each PaymentIntent can have a maximum of 10 decremental or incremental authorization attempts, including declines.\nAfter it’s fully captured, a PaymentIntent can no longer be decremented.

", "operationId": "PostPaymentIntentsIntentDecrementAuthorization", "parameters": [ { "in": "path", "name": "intent", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "hooks": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "transfer_data": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "amount": { "description": "The updated total amount that you intend to collect from the cardholder. This amount must be smaller than the currently authorized amount and greater than the already captured amount.", "type": "integer" }, "application_fee_amount": { "description": "The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total amount captured. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).", "type": "integer" }, "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users.", "maxLength": 1000, "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "hooks": { "description": "Automations to be run during the PaymentIntent lifecycle", "properties": { "inputs": { "description": "Arguments passed in automations", "properties": { "tax": { "description": "Tax arguments for automations", "properties": { "calculation": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "The [TaxCalculation](https://stripe.com/docs/api/tax/calculations) id" } }, "required": [ "calculation" ], "title": "async_workflows_inputs_tax_param", "type": "object", "x-stripeMostCommon": [ "calculation" ] } }, "title": "async_workflows_inputs_param", "type": "object", "x-stripeMostCommon": [ "tax" ] } }, "title": "async_workflows_param", "type": "object", "x-stripeMostCommon": [ "inputs" ] }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "transfer_data": { "description": "The parameters used to automatically create a transfer after the payment is captured.\nLearn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).", "properties": { "amount": { "description": "The amount that will be transferred automatically when a charge succeeds.", "type": "integer" } }, "title": "transfer_data_update_params", "type": "object", "x-stripeMostCommon": [ "amount", "description", "metadata", "payment_data" ] } }, "required": [ "amount" ], "type": "object", "x-stripeMostCommon": [ "amount", "description", "metadata" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_intent" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Decrement an authorization" } }, "/v1/payment_intents/{intent}/increment_authorization": { "post": { "description": "

Perform an incremental authorization on an eligible\nPaymentIntent. To be eligible, the\nPaymentIntent’s status must be requires_capture and\nincremental_authorization_supported\nmust be true.

\n\n

Incremental authorizations attempt to increase the authorized amount on\nyour customer’s card to the new, higher amount provided. Similar to the\ninitial authorization, incremental authorizations can be declined. A\nsingle PaymentIntent can call this endpoint multiple times to further\nincrease the authorized amount.

\n\n

If the incremental authorization succeeds, the PaymentIntent object\nreturns with the updated\namount.\nIf the incremental authorization fails, a\ncard_declined error returns, and no other\nfields on the PaymentIntent or Charge update. The PaymentIntent\nobject remains capturable for the previously authorized amount.

\n\n

Each PaymentIntent can have a maximum of 10 incremental authorization attempts, including declines.\nAfter it’s captured, a PaymentIntent can no longer be incremented.

\n\n

Learn more about incremental authorizations.

", "operationId": "PostPaymentIntentsIntentIncrementAuthorization", "parameters": [ { "in": "path", "name": "intent", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "amount_details": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "hooks": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "payment_details": { "explode": true, "style": "deepObject" }, "payment_method_options": { "explode": true, "style": "deepObject" }, "transfer_data": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "amount": { "description": "The updated total amount that you intend to collect from the cardholder. This amount must be greater than the currently authorized amount.", "type": "integer" }, "amount_details": { "description": "Provides industry-specific information about the amount.", "properties": { "discount_amount": { "anyOf": [ { "type": "integer" }, { "enum": [ "" ], "type": "string" } ], "description": "The amount an item was discounted for." }, "line_items": { "anyOf": [ { "items": { "properties": { "discount_amount": { "description": "The amount an item was discounted for. Positive integer.", "type": "integer" }, "payment_method_options": { "description": "Payment method-specific information for line items.", "properties": { "card": { "description": "This sub-hash contains line item details that are specific to `card` payment method.\"", "properties": { "commodity_code": { "description": "Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, etc.", "maxLength": 12, "type": "string" } }, "title": "payment_intent_amount_details_line_item_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "commodity_code" ] }, "card_present": { "description": "This sub-hash contains line item details that are specific to `card_present` payment method.\"", "properties": { "commodity_code": { "description": "Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, etc.", "maxLength": 12, "type": "string" } }, "title": "amount_details_line_item_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "commodity_code" ] }, "klarna": { "description": "This sub-hash contains line item details that are specific to `klarna` payment method.\"", "properties": { "image_url": { "description": "URL to an image for the product. Max length, 4096 characters.", "maxLength": 4096, "type": "string" }, "product_url": { "description": "URL to the product page. Max length, 4096 characters.", "maxLength": 4096, "type": "string" }, "subscription_reference": { "description": "Reference for the subscription this line item is for.", "maxLength": 255, "type": "string" } }, "title": "payment_intent_amount_details_line_item_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "image_url", "product_url", "subscription_reference" ] }, "paypal": { "description": "This sub-hash contains line item details that are specific to `paypal` payment method.\"", "properties": { "category": { "description": "Type of the line item.", "enum": [ "digital_goods", "donation", "physical_goods" ], "type": "string" }, "description": { "description": "Description of the line item.", "maxLength": 127, "type": "string" }, "sold_by": { "description": "The Stripe account ID of the connected account that sells the item.", "maxLength": 127, "type": "string" } }, "title": "amount_details_line_item_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "category", "description", "sold_by" ] } }, "title": "amount_details_line_item_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "card", "card_present", "dummy_auth_push", "klarna", "link", "paypal" ] }, "product_code": { "description": "Unique identifier of the product. At most 12 characters long.", "maxLength": 12, "type": "string" }, "product_name": { "description": "Name of the product. At most 100 characters long.", "maxLength": 1024, "type": "string" }, "quantity": { "description": "Number of items of the product. Positive integer.", "type": "integer" }, "tax": { "description": "Contains information about the tax on the item.", "properties": { "total_tax_amount": { "description": "The total tax on an item. Non-negative integer.", "type": "integer" } }, "required": [ "total_tax_amount" ], "title": "amount_details_line_item_tax_param", "type": "object", "x-stripeMostCommon": [ "total_tax_amount" ] }, "unit_cost": { "description": "Cost of the product. Non-negative integer.", "type": "integer" }, "unit_of_measure": { "description": "A unit of measure for the line item, such as gallons, feet, meters, etc.", "maxLength": 12, "type": "string" } }, "required": [ "product_name", "quantity", "unit_cost" ], "title": "amount_details_line_item_param", "type": "object", "x-stripeMostCommon": [ "discount_amount", "payment_method_options", "product_code", "product_name", "quantity", "tax", "unit_cost", "unit_of_measure" ] }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "A list of line items, each containing information about a product in the PaymentIntent. There is a maximum of 100 line items." }, "shipping": { "anyOf": [ { "properties": { "amount": { "anyOf": [ { "type": "integer" }, { "enum": [ "" ], "type": "string" } ], "description": "Portion of the amount that is for shipping." }, "from_postal_code": { "anyOf": [ { "maxLength": 10, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "The postal code that represents the shipping source." }, "to_postal_code": { "anyOf": [ { "maxLength": 10, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "The postal code that represents the shipping destination." } }, "title": "amount_details_shipping_param", "type": "object", "x-stripeMostCommon": [ "amount", "from_postal_code", "to_postal_code" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Contains information about the shipping portion of the amount." }, "tax": { "anyOf": [ { "properties": { "total_tax_amount": { "description": "Total portion of the amount that is for tax.", "type": "integer" } }, "required": [ "total_tax_amount" ], "title": "amount_details_tax_param", "type": "object", "x-stripeMostCommon": [ "total_tax_amount" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Contains information about the tax portion of the amount." } }, "title": "amount_details_param", "type": "object", "x-stripeMostCommon": [ "discount_amount", "line_items", "shipping", "tax" ] }, "application_fee_amount": { "description": "The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total amount captured. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).", "type": "integer" }, "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users.", "maxLength": 1000, "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "hooks": { "description": "Automations to be run during the PaymentIntent lifecycle", "properties": { "inputs": { "description": "Arguments passed in automations", "properties": { "tax": { "description": "Tax arguments for automations", "properties": { "calculation": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "The [TaxCalculation](https://stripe.com/docs/api/tax/calculations) id" } }, "required": [ "calculation" ], "title": "async_workflows_inputs_tax_param", "type": "object", "x-stripeMostCommon": [ "calculation" ] } }, "title": "async_workflows_inputs_param", "type": "object", "x-stripeMostCommon": [ "tax" ] } }, "title": "async_workflows_param", "type": "object", "x-stripeMostCommon": [ "inputs" ] }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "payment_details": { "description": "Provides industry-specific information about the charge.", "properties": { "customer_reference": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Some customers might be required by their company or organization to provide this information. If so, provide this value. Otherwise you can ignore this field." }, "order_reference": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "A unique value assigned by the business to identify the transaction." } }, "title": "payment_details_order_customer_reference_param", "type": "object" }, "payment_method_options": { "description": "Payment method-specific configuration for this PaymentIntent.", "properties": { "card": { "description": "Configuration for any card payments attempted on this PaymentIntent.", "properties": { "request_partial_authorization": { "description": "Request partial authorization on this PaymentIntent.", "enum": [ "if_available", "never" ], "type": "string" } }, "title": "payment_intent_increment_authorization_param", "type": "object", "x-stripeMostCommon": [ "request_partial_authorization" ] } }, "title": "payment_method_options_increment_authorization_param", "type": "object", "x-stripeMostCommon": [ "card" ] }, "statement_descriptor": { "description": "Text that appears on the customer's statement as the statement descriptor for a non-card or card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).", "maxLength": 22, "type": "string" }, "transfer_data": { "description": "The parameters used to automatically create a transfer after the payment is captured.\nLearn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).", "properties": { "amount": { "description": "The amount that will be transferred automatically when a charge succeeds.", "type": "integer" } }, "title": "transfer_data_update_params", "type": "object", "x-stripeMostCommon": [ "amount", "description", "metadata", "payment_data" ] } }, "required": [ "amount" ], "type": "object", "x-stripeMostCommon": [ "amount", "description", "metadata", "statement_descriptor" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_intent" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Increment an authorization" } }, "/v1/payment_intents/{intent}/verify_microdeposits": { "post": { "description": "

Verifies microdeposits on a PaymentIntent object.

", "operationId": "PostPaymentIntentsIntentVerifyMicrodeposits", "parameters": [ { "in": "path", "name": "intent", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "amounts": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "amounts": { "description": "Two positive integers, in *cents*, equal to the values of the microdeposits sent to the bank account.", "items": { "type": "integer" }, "type": "array" }, "descriptor_code": { "description": "A six-character code starting with SM present in the microdeposit sent to the bank account.", "maxLength": 5000, "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object", "x-stripeMostCommon": [ "amounts", "descriptor_code" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_intent" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Verify microdeposits on a PaymentIntent" } }, "/v1/payment_links": { "get": { "description": "

Returns a list of your payment links.

", "operationId": "GetPaymentLinks", "parameters": [ { "description": "Only return payment links that are active or inactive (e.g., pass `false` to list all inactive payment links).", "in": "query", "name": "active", "required": false, "schema": { "type": "boolean" }, "style": "form" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/payment_link" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/payment_links", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "PaymentLinksResourcePaymentLinkList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all payment links" }, "post": { "description": "

Creates a payment link.

", "operationId": "PostPaymentLinks", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "after_completion": { "explode": true, "style": "deepObject" }, "automatic_tax": { "explode": true, "style": "deepObject" }, "consent_collection": { "explode": true, "style": "deepObject" }, "custom_fields": { "explode": true, "style": "deepObject" }, "custom_text": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "invoice_creation": { "explode": true, "style": "deepObject" }, "line_items": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "optional_items": { "explode": true, "style": "deepObject" }, "payment_intent_data": { "explode": true, "style": "deepObject" }, "payment_method_types": { "explode": true, "style": "deepObject" }, "phone_number_collection": { "explode": true, "style": "deepObject" }, "restrictions": { "explode": true, "style": "deepObject" }, "shipping_address_collection": { "explode": true, "style": "deepObject" }, "shipping_options": { "explode": true, "style": "deepObject" }, "subscription_data": { "explode": true, "style": "deepObject" }, "tax_id_collection": { "explode": true, "style": "deepObject" }, "transfer_data": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "after_completion": { "description": "Behavior after the purchase is complete.", "properties": { "hosted_confirmation": { "description": "Configuration when `type=hosted_confirmation`.", "properties": { "custom_message": { "description": "A custom message to display to the customer after the purchase is complete.", "maxLength": 500, "type": "string" } }, "title": "after_completion_confirmation_page_params", "type": "object", "x-stripeMostCommon": [ "custom_message" ] }, "redirect": { "description": "Configuration when `type=redirect`.", "properties": { "url": { "description": "The URL the customer will be redirected to after the purchase is complete. You can embed `{CHECKOUT_SESSION_ID}` into the URL to have the `id` of the completed [checkout session](https://stripe.com/docs/api/checkout/sessions/object#checkout_session_object-id) included.", "type": "string" } }, "required": [ "url" ], "title": "after_completion_redirect_params", "type": "object", "x-stripeMostCommon": [ "url" ] }, "type": { "description": "The specified behavior after the purchase is complete. Either `redirect` or `hosted_confirmation`.", "enum": [ "hosted_confirmation", "redirect" ], "type": "string" } }, "required": [ "type" ], "title": "after_completion_params", "type": "object", "x-stripeMostCommon": [ "hosted_confirmation", "redirect", "type" ] }, "allow_promotion_codes": { "description": "Enables user redeemable promotion codes.", "type": "boolean" }, "application_fee_amount": { "description": "The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. Can only be applied when there are no line items with recurring prices.", "type": "integer" }, "application_fee_percent": { "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. There must be at least 1 line item with a recurring price to use this field.", "type": "number" }, "automatic_tax": { "description": "Configuration for automatic tax collection.", "properties": { "enabled": { "description": "Set to `true` to [calculate tax automatically](https://docs.stripe.com/tax) using the customer's location.\n\nEnabling this parameter causes the payment link to collect any billing address information necessary for tax calculation.", "type": "boolean" }, "liability": { "description": "The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.", "properties": { "account": { "description": "The connected account being referenced when `type` is `account`.", "type": "string" }, "type": { "description": "Type of the account referenced in the request.", "enum": [ "account", "self" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "param", "type": "object", "x-stripeMostCommon": [ "account", "type" ] } }, "required": [ "enabled" ], "title": "automatic_tax_params", "type": "object", "x-stripeMostCommon": [ "enabled", "liability" ] }, "billing_address_collection": { "description": "Configuration for collecting the customer's billing address. Defaults to `auto`.", "enum": [ "auto", "required" ], "type": "string" }, "consent_collection": { "description": "Configure fields to gather active consent from customers.", "properties": { "payment_method_reuse_agreement": { "description": "Determines the display of payment method reuse agreement text in the UI. If set to `hidden`, it will hide legal text related to the reuse of a payment method.", "properties": { "position": { "description": "Determines the position and visibility of the payment method reuse agreement in the UI. When set to `auto`, Stripe's\ndefaults will be used. When set to `hidden`, the payment method reuse agreement text will always be hidden in the UI.", "enum": [ "auto", "hidden" ], "type": "string" } }, "required": [ "position" ], "title": "payment_method_reuse_agreement_params", "type": "object", "x-stripeMostCommon": [ "position" ] }, "promotions": { "description": "If set to `auto`, enables the collection of customer consent for promotional communications. The Checkout\nSession will determine whether to display an option to opt into promotional communication\nfrom the merchant depending on the customer's locale. Only available to US merchants.", "enum": [ "auto", "none" ], "type": "string" }, "terms_of_service": { "description": "If set to `required`, it requires customers to check a terms of service checkbox before being able to pay.\nThere must be a valid terms of service URL set in your [Dashboard settings](https://dashboard.stripe.com/settings/public).", "enum": [ "none", "required" ], "type": "string" } }, "title": "consent_collection_params", "type": "object", "x-stripeMostCommon": [ "payment_method_reuse_agreement", "promotions", "terms_of_service" ] }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies) and supported by each line item's price.", "format": "currency", "type": "string" }, "custom_fields": { "description": "Collect additional information from your customer using custom fields. Up to 3 fields are supported.", "items": { "properties": { "dropdown": { "description": "Configuration for `type=dropdown` fields.", "properties": { "default_value": { "description": "The value that will pre-fill the field on the payment page.Must match a `value` in the `options` array.", "maxLength": 100, "type": "string" }, "options": { "description": "The options available for the customer to select. Up to 200 options allowed.", "items": { "properties": { "label": { "description": "The label for the option, displayed to the customer. Up to 100 characters.", "maxLength": 100, "type": "string" }, "value": { "description": "The value for this option, not displayed to the customer, used by your integration to reconcile the option selected by the customer. Must be unique to this option, alphanumeric, and up to 100 characters.", "maxLength": 100, "type": "string" } }, "required": [ "label", "value" ], "title": "custom_field_option_param", "type": "object", "x-stripeMostCommon": [ "label", "value" ] }, "type": "array" } }, "required": [ "options" ], "title": "custom_field_dropdown_param", "type": "object", "x-stripeMostCommon": [ "default_value", "options" ] }, "key": { "description": "String of your choice that your integration can use to reconcile this field. Must be unique to this field, alphanumeric, and up to 200 characters.", "maxLength": 200, "type": "string" }, "label": { "description": "The label for the field, displayed to the customer.", "properties": { "custom": { "description": "Custom text for the label, displayed to the customer. Up to 50 characters.", "maxLength": 50, "type": "string" }, "type": { "description": "The type of the label.", "enum": [ "custom" ], "type": "string" } }, "required": [ "custom", "type" ], "title": "custom_field_label_param", "type": "object", "x-stripeMostCommon": [ "custom", "type" ] }, "numeric": { "description": "Configuration for `type=numeric` fields.", "properties": { "default_value": { "description": "The value that will pre-fill the field on the payment page.", "maxLength": 255, "type": "string" }, "maximum_length": { "description": "The maximum character length constraint for the customer's input.", "type": "integer" }, "minimum_length": { "description": "The minimum character length requirement for the customer's input.", "type": "integer" } }, "title": "custom_field_numeric_param", "type": "object", "x-stripeMostCommon": [ "default_value", "maximum_length", "minimum_length" ] }, "optional": { "description": "Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`.", "type": "boolean" }, "text": { "description": "Configuration for `type=text` fields.", "properties": { "default_value": { "description": "The value that will pre-fill the field on the payment page.", "maxLength": 255, "type": "string" }, "maximum_length": { "description": "The maximum character length constraint for the customer's input.", "type": "integer" }, "minimum_length": { "description": "The minimum character length requirement for the customer's input.", "type": "integer" } }, "title": "custom_field_text_param", "type": "object", "x-stripeMostCommon": [ "default_value", "maximum_length", "minimum_length" ] }, "type": { "description": "The type of the field.", "enum": [ "dropdown", "numeric", "text" ], "type": "string" } }, "required": [ "key", "label", "type" ], "title": "custom_field_param", "type": "object", "x-stripeMostCommon": [ "dropdown", "key", "label", "numeric", "optional", "text", "type" ] }, "type": "array" }, "custom_text": { "description": "Display additional text for your customers using custom text.", "properties": { "after_submit": { "anyOf": [ { "properties": { "message": { "description": "Text may be up to 1200 characters in length.", "maxLength": 1200, "type": "string" } }, "required": [ "message" ], "title": "custom_text_position_param", "type": "object", "x-stripeMostCommon": [ "message" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Custom text that should be displayed after the payment confirmation button." }, "shipping_address": { "anyOf": [ { "properties": { "message": { "description": "Text may be up to 1200 characters in length.", "maxLength": 1200, "type": "string" } }, "required": [ "message" ], "title": "custom_text_position_param", "type": "object", "x-stripeMostCommon": [ "message" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Custom text that should be displayed alongside shipping address collection." }, "submit": { "anyOf": [ { "properties": { "message": { "description": "Text may be up to 1200 characters in length.", "maxLength": 1200, "type": "string" } }, "required": [ "message" ], "title": "custom_text_position_param", "type": "object", "x-stripeMostCommon": [ "message" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Custom text that should be displayed alongside the payment confirmation button." }, "terms_of_service_acceptance": { "anyOf": [ { "properties": { "message": { "description": "Text may be up to 1200 characters in length.", "maxLength": 1200, "type": "string" } }, "required": [ "message" ], "title": "custom_text_position_param", "type": "object", "x-stripeMostCommon": [ "message" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Custom text that should be displayed in place of the default terms of service agreement text." } }, "title": "custom_text_param", "type": "object", "x-stripeMostCommon": [ "after_submit", "shipping_address", "submit", "terms_of_service_acceptance" ] }, "customer_creation": { "description": "Configures whether [checkout sessions](https://stripe.com/docs/api/checkout/sessions) created by this payment link create a [Customer](https://stripe.com/docs/api/customers).", "enum": [ "always", "if_required" ], "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "inactive_message": { "description": "The custom message to be displayed to a customer when a payment link is no longer active.", "maxLength": 500, "type": "string" }, "invoice_creation": { "description": "Generate a post-purchase Invoice for one-time payments.", "properties": { "enabled": { "description": "Whether the feature is enabled", "type": "boolean" }, "invoice_data": { "description": "Invoice PDF configuration.", "properties": { "account_tax_ids": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The account tax IDs associated with the invoice." }, "custom_fields": { "anyOf": [ { "items": { "properties": { "name": { "description": "The name of the custom field. This may be up to 40 characters.", "maxLength": 40, "type": "string" }, "value": { "description": "The value of the custom field. This may be up to 140 characters.", "maxLength": 140, "type": "string" } }, "required": [ "name", "value" ], "title": "custom_field_params", "type": "object", "x-stripeMostCommon": [ "name", "value" ] }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "Default custom fields to be displayed on invoices for this customer." }, "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users.", "maxLength": 1500, "type": "string" }, "footer": { "description": "Default footer to be displayed on invoices for this customer.", "maxLength": 5000, "type": "string" }, "issuer": { "description": "The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.", "properties": { "account": { "description": "The connected account being referenced when `type` is `account`.", "type": "string" }, "type": { "description": "Type of the account referenced in the request.", "enum": [ "account", "self" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "param", "type": "object", "x-stripeMostCommon": [ "account", "type" ] }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "rendering_options": { "anyOf": [ { "properties": { "amount_tax_display": { "description": "How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. One of `exclude_tax` or `include_inclusive_tax`. `include_inclusive_tax` will include inclusive tax (and exclude exclusive tax) in invoice PDF amounts. `exclude_tax` will exclude all tax (inclusive and exclusive alike) from invoice PDF amounts.", "enum": [ "", "exclude_tax", "include_inclusive_tax" ], "type": "string" }, "template": { "description": "ID of the invoice rendering template to use for this invoice.", "maxLength": 5000, "type": "string" } }, "title": "checkout_rendering_options_param", "type": "object", "x-stripeMostCommon": [ "amount_tax_display", "invoice_title", "template" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Default options for invoice PDF rendering for this customer." } }, "title": "invoice_settings_params", "type": "object", "x-stripeMostCommon": [ "account_tax_ids", "custom_fields", "description", "footer", "issuer", "metadata", "rendering_options" ] } }, "required": [ "enabled" ], "title": "invoice_creation_create_params", "type": "object", "x-stripeMostCommon": [ "enabled", "invoice_data" ] }, "line_items": { "description": "The line items representing what is being sold. Each line item represents an item being sold. Up to 20 line items are supported.", "items": { "properties": { "adjustable_quantity": { "description": "When set, provides configuration for this item’s quantity to be adjusted by the customer during checkout.", "properties": { "enabled": { "description": "Set to true if the quantity can be adjusted to any non-negative Integer.", "type": "boolean" }, "maximum": { "description": "The maximum quantity the customer can purchase. By default this value is 99. You can specify a value up to 999999.", "type": "integer" }, "minimum": { "description": "The minimum quantity the customer can purchase. By default this value is 0. If there is only one item in the cart then that item's quantity cannot go down to 0.", "type": "integer" } }, "required": [ "enabled" ], "title": "adjustable_quantity_params", "type": "object", "x-stripeMostCommon": [ "enabled", "maximum", "minimum" ] }, "price": { "description": "The ID of the [Price](https://stripe.com/docs/api/prices) or [Plan](https://stripe.com/docs/api/plans) object. One of `price` or `price_data` is required.", "maxLength": 5000, "type": "string" }, "price_data": { "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.", "properties": { "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "product": { "description": "The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to. One of `product` or `product_data` is required.", "maxLength": 5000, "type": "string" }, "product_data": { "description": "Data used to generate a new [Product](https://docs.stripe.com/api/products) object inline. One of `product` or `product_data` is required.", "properties": { "description": { "description": "The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.", "maxLength": 40000, "type": "string" }, "images": { "description": "A list of up to 8 URLs of images for this product, meant to be displayable to the customer.", "items": { "type": "string" }, "type": "array" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "name": { "description": "The product's name, meant to be displayable to the customer.", "maxLength": 5000, "type": "string" }, "tax_code": { "description": "A [tax code](https://stripe.com/docs/tax/tax-categories) ID.", "maxLength": 5000, "type": "string" } }, "required": [ "name" ], "title": "product_data", "type": "object", "x-stripeMostCommon": [ "description", "images", "metadata", "name", "tax_code", "unit_label" ] }, "recurring": { "description": "The recurring components of a price such as `interval` and `interval_count`.", "properties": { "interval": { "description": "Specifies billing frequency. Either `day`, `week`, `month` or `year`.", "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "description": "The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).", "type": "integer" } }, "required": [ "interval" ], "title": "recurring_adhoc", "type": "object", "x-stripeMostCommon": [ "interval" ] }, "tax_behavior": { "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.", "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" }, "unit_amount": { "description": "A non-negative integer in cents (or local equivalent) representing how much to charge. One of `unit_amount` or `unit_amount_decimal` is required.", "type": "integer" }, "unit_amount_decimal": { "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", "format": "decimal", "type": "string" } }, "required": [ "currency" ], "title": "custom_amount_price_data_with_product_data", "type": "object", "x-stripeMostCommon": [ "currency", "product", "unit_amount" ] }, "quantity": { "description": "The quantity of the line item being purchased.", "type": "integer" } }, "required": [ "quantity" ], "title": "line_items_create_params", "type": "object", "x-stripeMostCommon": [ "adjustable_quantity", "price", "price_data", "quantity" ] }, "type": "array" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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](https://stripe.com/docs/api/checkout/sessions) created by this payment link.", "type": "object" }, "on_behalf_of": { "description": "The account on behalf of which to charge.", "type": "string" }, "optional_items": { "description": "A list of optional items the customer can add to their order at checkout. Use this parameter to pass one-time or recurring [Prices](https://stripe.com/docs/api/prices).\nThere is a maximum of 10 optional items allowed on a payment link, and the existing limits on the number of line items allowed on a payment link apply to the combined number of line items and optional items.\nThere is a maximum of 20 combined line items and optional items.", "items": { "properties": { "adjustable_quantity": { "description": "When set, provides configuration for the customer to adjust the quantity of the line item created when a customer chooses to add this optional item to their order.", "properties": { "enabled": { "description": "Set to true if the quantity can be adjusted to any non-negative integer.", "type": "boolean" }, "maximum": { "description": "The maximum quantity of this item the customer can purchase. By default this value is 99.", "type": "integer" }, "minimum": { "description": "The minimum quantity of this item the customer must purchase, if they choose to purchase it. Because this item is optional, the customer will always be able to remove it from their order, even if the `minimum` configured here is greater than 0. By default this value is 0.", "type": "integer" } }, "required": [ "enabled" ], "title": "optional_item_adjustable_quantity_params", "type": "object", "x-stripeMostCommon": [ "enabled", "maximum", "minimum" ] }, "price": { "description": "The ID of the [Price](https://stripe.com/docs/api/prices) or [Plan](https://stripe.com/docs/api/plans) object.", "maxLength": 5000, "type": "string" }, "quantity": { "description": "The initial quantity of the line item created when a customer chooses to add this optional item to their order.", "type": "integer" } }, "required": [ "price", "quantity" ], "title": "optional_item_params", "type": "object", "x-stripeMostCommon": [ "adjustable_quantity", "price", "quantity" ] }, "type": "array" }, "payment_intent_data": { "description": "A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in `payment` mode.", "properties": { "capture_method": { "description": "Controls when the funds will be captured from the customer's account.", "enum": [ "automatic", "automatic_async", "manual" ], "type": "string" }, "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users.", "maxLength": 1000, "type": "string" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will declaratively set metadata on [Payment Intents](https://stripe.com/docs/api/payment_intents) generated from this payment link. Unlike object-level metadata, this field is declarative. Updates will clear prior values.", "type": "object" }, "setup_future_usage": { "description": "Indicates that you intend to [make future payments](https://stripe.com/docs/payments/payment-intents#future-usage) with the payment method collected by this Checkout Session.\n\nWhen setting this to `on_session`, Checkout will show a notice to the customer that their payment details will be saved.\n\nWhen setting this to `off_session`, Checkout will show a notice to the customer that their payment details will be saved and used for future payments.\n\nIf a Customer has been provided or Checkout creates a new Customer,Checkout will attach the payment method to the Customer.\n\nIf Checkout does not create a Customer, the payment method is not attached to a Customer. To reuse the payment method, you can retrieve it from the Checkout Session's PaymentIntent.\n\nWhen processing card payments, Checkout also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as SCA.", "enum": [ "off_session", "on_session" ], "type": "string" }, "statement_descriptor": { "description": "Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).\n\nSetting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead.", "maxLength": 22, "type": "string" }, "statement_descriptor_suffix": { "description": "Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement.", "maxLength": 22, "type": "string" }, "transfer_group": { "description": "A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/connect/separate-charges-and-transfers) for details.", "maxLength": 5000, "type": "string" } }, "title": "payment_intent_data_params", "type": "object", "x-stripeMostCommon": [ "capture_method", "description", "metadata", "setup_future_usage", "statement_descriptor", "statement_descriptor_suffix", "transfer_group" ] }, "payment_method_collection": { "description": "Specify whether Checkout should collect a payment method. When set to `if_required`, Checkout will not collect a payment method when the total due for the session is 0.This may occur if the Checkout Session includes a free trial or a discount.\n\nCan only be set in `subscription` mode. Defaults to `always`.\n\nIf you'd like information on how to collect a payment method outside of Checkout, read the guide on [configuring subscriptions with a free trial](https://stripe.com/docs/payments/checkout/free-trials).", "enum": [ "always", "if_required" ], "type": "string" }, "payment_method_types": { "description": "The list of payment method types that customers can use. If no value is passed, Stripe will dynamically show relevant payment methods from your [payment method settings](https://dashboard.stripe.com/settings/payment_methods) (20+ payment methods [supported](https://stripe.com/docs/payments/payment-methods/integration-options#payment-method-product-support)).", "items": { "enum": [ "affirm", "afterpay_clearpay", "alipay", "alma", "au_becs_debit", "bacs_debit", "bancontact", "billie", "blik", "boleto", "card", "cashapp", "eps", "fpx", "giropay", "gopay", "grabpay", "ideal", "klarna", "konbini", "link", "mb_way", "mobilepay", "multibanco", "oxxo", "p24", "pay_by_bank", "paynow", "paypal", "paypay", "payto", "pix", "promptpay", "qris", "rechnung", "satispay", "sepa_debit", "shopeepay", "sofort", "swish", "twint", "us_bank_account", "wechat_pay", "zip" ], "type": "string", "x-stripeBypassValidation": true }, "type": "array" }, "phone_number_collection": { "description": "Controls phone number collection settings during checkout.\n\nWe recommend that you review your privacy policy and check with your legal contacts.", "properties": { "enabled": { "description": "Set to `true` to enable phone number collection.", "type": "boolean" } }, "required": [ "enabled" ], "title": "phone_number_collection_params", "type": "object", "x-stripeMostCommon": [ "enabled" ] }, "restrictions": { "description": "Settings that restrict the usage of a payment link.", "properties": { "completed_sessions": { "description": "Configuration for the `completed_sessions` restriction type.", "properties": { "limit": { "description": "The maximum number of checkout sessions that can be completed for the `completed_sessions` restriction to be met.", "type": "integer" } }, "required": [ "limit" ], "title": "completed_sessions_params", "type": "object", "x-stripeMostCommon": [ "limit" ] } }, "required": [ "completed_sessions" ], "title": "restrictions_params", "type": "object", "x-stripeMostCommon": [ "completed_sessions" ] }, "shipping_address_collection": { "description": "Configuration for collecting the customer's shipping address.", "properties": { "allowed_countries": { "description": "An array of two-letter ISO country codes representing which countries Checkout should provide as options for\nshipping locations.", "items": { "enum": [ "AC", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CV", "CW", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MK", "ML", "MM", "MN", "MO", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SZ", "TA", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VN", "VU", "WF", "WS", "XK", "YE", "YT", "ZA", "ZM", "ZW", "ZZ" ], "type": "string" }, "type": "array" } }, "required": [ "allowed_countries" ], "title": "shipping_address_collection_params", "type": "object", "x-stripeMostCommon": [ "allowed_countries" ] }, "shipping_options": { "description": "The shipping rate options to apply to [checkout sessions](https://stripe.com/docs/api/checkout/sessions) created by this payment link.", "items": { "properties": { "shipping_rate": { "description": "The ID of the Shipping Rate to use for this shipping option.", "maxLength": 5000, "type": "string" } }, "title": "shipping_option_params", "type": "object", "x-stripeMostCommon": [ "shipping_rate" ] }, "type": "array" }, "submit_type": { "description": "Describes the type of transaction being performed in order to customize relevant text on the page, such as the submit button. Changing this value will also affect the hostname in the [url](https://stripe.com/docs/api/payment_links/payment_links/object#url) property (example: `donate.stripe.com`).", "enum": [ "auto", "book", "donate", "pay", "subscribe" ], "type": "string" }, "subscription_data": { "description": "When creating a subscription, the specified configuration data will be used. There must be at least one line item with a recurring price to use `subscription_data`.", "properties": { "description": { "description": "The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.", "maxLength": 500, "type": "string" }, "invoice_settings": { "description": "All invoices will be billed using the specified settings.", "properties": { "issuer": { "description": "The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.", "properties": { "account": { "description": "The connected account being referenced when `type` is `account`.", "type": "string" }, "type": { "description": "Type of the account referenced in the request.", "enum": [ "account", "self" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "param", "type": "object", "x-stripeMostCommon": [ "account", "type" ] } }, "title": "subscription_data_invoice_settings_params", "type": "object", "x-stripeMostCommon": [ "issuer" ] }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will declaratively set metadata on [Subscriptions](https://stripe.com/docs/api/subscriptions) generated from this payment link. Unlike object-level metadata, this field is declarative. Updates will clear prior values.", "type": "object" }, "trial_period_days": { "description": "Integer representing the number of trial period days before the customer is charged for the first time. Has to be at least 1.", "type": "integer" }, "trial_settings": { "description": "Settings related to subscription trials.", "properties": { "end_behavior": { "description": "Defines how the subscription should behave when the user's free trial ends.", "properties": { "missing_payment_method": { "description": "Indicates how the subscription should change when the trial ends if the user did not provide a payment method.", "enum": [ "cancel", "create_invoice", "pause" ], "type": "string" } }, "required": [ "missing_payment_method" ], "title": "end_behavior", "type": "object", "x-stripeMostCommon": [ "missing_payment_method" ] } }, "required": [ "end_behavior" ], "title": "trial_settings_config", "type": "object", "x-stripeMostCommon": [ "end_behavior" ] } }, "title": "subscription_data_params", "type": "object", "x-stripeMostCommon": [ "description", "invoice_settings", "metadata", "trial_period_days", "trial_settings" ] }, "tax_id_collection": { "description": "Controls tax ID collection during checkout.", "properties": { "enabled": { "description": "Enable tax ID collection during checkout. Defaults to `false`.", "type": "boolean" }, "required": { "description": "Describes whether a tax ID is required during checkout. Defaults to `never`.", "enum": [ "if_supported", "never" ], "type": "string" } }, "required": [ "enabled" ], "title": "tax_id_collection_params", "type": "object", "x-stripeMostCommon": [ "enabled", "required" ] }, "transfer_data": { "description": "The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to.", "properties": { "amount": { "description": "The amount that will be transferred automatically when a charge succeeds.", "type": "integer" }, "destination": { "description": "If specified, successful charges will be attributed to the destination\naccount for tax reporting, and the funds from charges will be transferred\nto the destination account. The ID of the resulting transfer will be\nreturned on the successful charge's `transfer` field.", "type": "string" } }, "required": [ "destination" ], "title": "transfer_data_params", "type": "object", "x-stripeMostCommon": [ "amount", "destination" ] } }, "required": [ "line_items" ], "type": "object", "x-stripeMostCommon": [ "line_items", "metadata" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_link" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a payment link" } }, "/v1/payment_links/{payment_link}": { "get": { "description": "

Retrieve a payment link.

", "operationId": "GetPaymentLinksPaymentLink", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "payment_link", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_link" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve payment link" }, "post": { "description": "

Updates a payment link.

", "operationId": "PostPaymentLinksPaymentLink", "parameters": [ { "in": "path", "name": "payment_link", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "after_completion": { "explode": true, "style": "deepObject" }, "automatic_tax": { "explode": true, "style": "deepObject" }, "custom_fields": { "explode": true, "style": "deepObject" }, "custom_text": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "inactive_message": { "explode": true, "style": "deepObject" }, "invoice_creation": { "explode": true, "style": "deepObject" }, "line_items": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "payment_intent_data": { "explode": true, "style": "deepObject" }, "payment_method_types": { "explode": true, "style": "deepObject" }, "phone_number_collection": { "explode": true, "style": "deepObject" }, "restrictions": { "explode": true, "style": "deepObject" }, "shipping_address_collection": { "explode": true, "style": "deepObject" }, "subscription_data": { "explode": true, "style": "deepObject" }, "tax_id_collection": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "active": { "description": "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.", "type": "boolean" }, "after_completion": { "description": "Behavior after the purchase is complete.", "properties": { "hosted_confirmation": { "description": "Configuration when `type=hosted_confirmation`.", "properties": { "custom_message": { "description": "A custom message to display to the customer after the purchase is complete.", "maxLength": 500, "type": "string" } }, "title": "after_completion_confirmation_page_params", "type": "object", "x-stripeMostCommon": [ "custom_message" ] }, "redirect": { "description": "Configuration when `type=redirect`.", "properties": { "url": { "description": "The URL the customer will be redirected to after the purchase is complete. You can embed `{CHECKOUT_SESSION_ID}` into the URL to have the `id` of the completed [checkout session](https://stripe.com/docs/api/checkout/sessions/object#checkout_session_object-id) included.", "type": "string" } }, "required": [ "url" ], "title": "after_completion_redirect_params", "type": "object", "x-stripeMostCommon": [ "url" ] }, "type": { "description": "The specified behavior after the purchase is complete. Either `redirect` or `hosted_confirmation`.", "enum": [ "hosted_confirmation", "redirect" ], "type": "string" } }, "required": [ "type" ], "title": "after_completion_params", "type": "object", "x-stripeMostCommon": [ "hosted_confirmation", "redirect", "type" ] }, "allow_promotion_codes": { "description": "Enables user redeemable promotion codes.", "type": "boolean" }, "automatic_tax": { "description": "Configuration for automatic tax collection.", "properties": { "enabled": { "description": "Set to `true` to [calculate tax automatically](https://docs.stripe.com/tax) using the customer's location.\n\nEnabling this parameter causes the payment link to collect any billing address information necessary for tax calculation.", "type": "boolean" }, "liability": { "description": "The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.", "properties": { "account": { "description": "The connected account being referenced when `type` is `account`.", "type": "string" }, "type": { "description": "Type of the account referenced in the request.", "enum": [ "account", "self" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "param", "type": "object", "x-stripeMostCommon": [ "account", "type" ] } }, "required": [ "enabled" ], "title": "automatic_tax_params", "type": "object", "x-stripeMostCommon": [ "enabled", "liability" ] }, "billing_address_collection": { "description": "Configuration for collecting the customer's billing address. Defaults to `auto`.", "enum": [ "auto", "required" ], "type": "string" }, "custom_fields": { "anyOf": [ { "items": { "properties": { "dropdown": { "description": "Configuration for `type=dropdown` fields.", "properties": { "default_value": { "description": "The value that will pre-fill the field on the payment page.Must match a `value` in the `options` array.", "maxLength": 100, "type": "string" }, "options": { "description": "The options available for the customer to select. Up to 200 options allowed.", "items": { "properties": { "label": { "description": "The label for the option, displayed to the customer. Up to 100 characters.", "maxLength": 100, "type": "string" }, "value": { "description": "The value for this option, not displayed to the customer, used by your integration to reconcile the option selected by the customer. Must be unique to this option, alphanumeric, and up to 100 characters.", "maxLength": 100, "type": "string" } }, "required": [ "label", "value" ], "title": "custom_field_option_param", "type": "object", "x-stripeMostCommon": [ "label", "value" ] }, "type": "array" } }, "required": [ "options" ], "title": "custom_field_dropdown_param", "type": "object", "x-stripeMostCommon": [ "default_value", "options" ] }, "key": { "description": "String of your choice that your integration can use to reconcile this field. Must be unique to this field, alphanumeric, and up to 200 characters.", "maxLength": 200, "type": "string" }, "label": { "description": "The label for the field, displayed to the customer.", "properties": { "custom": { "description": "Custom text for the label, displayed to the customer. Up to 50 characters.", "maxLength": 50, "type": "string" }, "type": { "description": "The type of the label.", "enum": [ "custom" ], "type": "string" } }, "required": [ "custom", "type" ], "title": "custom_field_label_param", "type": "object", "x-stripeMostCommon": [ "custom", "type" ] }, "numeric": { "description": "Configuration for `type=numeric` fields.", "properties": { "default_value": { "description": "The value that will pre-fill the field on the payment page.", "maxLength": 255, "type": "string" }, "maximum_length": { "description": "The maximum character length constraint for the customer's input.", "type": "integer" }, "minimum_length": { "description": "The minimum character length requirement for the customer's input.", "type": "integer" } }, "title": "custom_field_numeric_param", "type": "object", "x-stripeMostCommon": [ "default_value", "maximum_length", "minimum_length" ] }, "optional": { "description": "Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`.", "type": "boolean" }, "text": { "description": "Configuration for `type=text` fields.", "properties": { "default_value": { "description": "The value that will pre-fill the field on the payment page.", "maxLength": 255, "type": "string" }, "maximum_length": { "description": "The maximum character length constraint for the customer's input.", "type": "integer" }, "minimum_length": { "description": "The minimum character length requirement for the customer's input.", "type": "integer" } }, "title": "custom_field_text_param", "type": "object", "x-stripeMostCommon": [ "default_value", "maximum_length", "minimum_length" ] }, "type": { "description": "The type of the field.", "enum": [ "dropdown", "numeric", "text" ], "type": "string" } }, "required": [ "key", "label", "type" ], "title": "custom_field_param", "type": "object", "x-stripeMostCommon": [ "dropdown", "key", "label", "numeric", "optional", "text", "type" ] }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "Collect additional information from your customer using custom fields. Up to 3 fields are supported." }, "custom_text": { "description": "Display additional text for your customers using custom text.", "properties": { "after_submit": { "anyOf": [ { "properties": { "message": { "description": "Text may be up to 1200 characters in length.", "maxLength": 1200, "type": "string" } }, "required": [ "message" ], "title": "custom_text_position_param", "type": "object", "x-stripeMostCommon": [ "message" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Custom text that should be displayed after the payment confirmation button." }, "shipping_address": { "anyOf": [ { "properties": { "message": { "description": "Text may be up to 1200 characters in length.", "maxLength": 1200, "type": "string" } }, "required": [ "message" ], "title": "custom_text_position_param", "type": "object", "x-stripeMostCommon": [ "message" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Custom text that should be displayed alongside shipping address collection." }, "submit": { "anyOf": [ { "properties": { "message": { "description": "Text may be up to 1200 characters in length.", "maxLength": 1200, "type": "string" } }, "required": [ "message" ], "title": "custom_text_position_param", "type": "object", "x-stripeMostCommon": [ "message" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Custom text that should be displayed alongside the payment confirmation button." }, "terms_of_service_acceptance": { "anyOf": [ { "properties": { "message": { "description": "Text may be up to 1200 characters in length.", "maxLength": 1200, "type": "string" } }, "required": [ "message" ], "title": "custom_text_position_param", "type": "object", "x-stripeMostCommon": [ "message" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Custom text that should be displayed in place of the default terms of service agreement text." } }, "title": "custom_text_param", "type": "object", "x-stripeMostCommon": [ "after_submit", "shipping_address", "submit", "terms_of_service_acceptance" ] }, "customer_creation": { "description": "Configures whether [checkout sessions](https://stripe.com/docs/api/checkout/sessions) created by this payment link create a [Customer](https://stripe.com/docs/api/customers).", "enum": [ "always", "if_required" ], "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "inactive_message": { "anyOf": [ { "maxLength": 500, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "The custom message to be displayed to a customer when a payment link is no longer active." }, "invoice_creation": { "description": "Generate a post-purchase Invoice for one-time payments.", "properties": { "enabled": { "description": "Whether the feature is enabled", "type": "boolean" }, "invoice_data": { "description": "Invoice PDF configuration.", "properties": { "account_tax_ids": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The account tax IDs associated with the invoice." }, "custom_fields": { "anyOf": [ { "items": { "properties": { "name": { "description": "The name of the custom field. This may be up to 40 characters.", "maxLength": 40, "type": "string" }, "value": { "description": "The value of the custom field. This may be up to 140 characters.", "maxLength": 140, "type": "string" } }, "required": [ "name", "value" ], "title": "custom_field_params", "type": "object", "x-stripeMostCommon": [ "name", "value" ] }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "Default custom fields to be displayed on invoices for this customer." }, "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users.", "maxLength": 1500, "type": "string" }, "footer": { "description": "Default footer to be displayed on invoices for this customer.", "maxLength": 5000, "type": "string" }, "issuer": { "description": "The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.", "properties": { "account": { "description": "The connected account being referenced when `type` is `account`.", "type": "string" }, "type": { "description": "Type of the account referenced in the request.", "enum": [ "account", "self" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "param", "type": "object", "x-stripeMostCommon": [ "account", "type" ] }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "rendering_options": { "anyOf": [ { "properties": { "amount_tax_display": { "description": "How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. One of `exclude_tax` or `include_inclusive_tax`. `include_inclusive_tax` will include inclusive tax (and exclude exclusive tax) in invoice PDF amounts. `exclude_tax` will exclude all tax (inclusive and exclusive alike) from invoice PDF amounts.", "enum": [ "", "exclude_tax", "include_inclusive_tax" ], "type": "string" }, "template": { "description": "ID of the invoice rendering template to use for this invoice.", "maxLength": 5000, "type": "string" } }, "title": "checkout_rendering_options_param", "type": "object", "x-stripeMostCommon": [ "amount_tax_display", "invoice_title", "template" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Default options for invoice PDF rendering for this customer." } }, "title": "invoice_settings_params", "type": "object", "x-stripeMostCommon": [ "account_tax_ids", "custom_fields", "description", "footer", "issuer", "metadata", "rendering_options" ] } }, "required": [ "enabled" ], "title": "invoice_creation_update_params", "type": "object", "x-stripeMostCommon": [ "enabled", "invoice_data" ] }, "line_items": { "description": "The line items representing what is being sold. Each line item represents an item being sold. Up to 20 line items are supported.", "items": { "properties": { "adjustable_quantity": { "description": "When set, provides configuration for this item’s quantity to be adjusted by the customer during checkout.", "properties": { "enabled": { "description": "Set to true if the quantity can be adjusted to any non-negative Integer.", "type": "boolean" }, "maximum": { "description": "The maximum quantity the customer can purchase. By default this value is 99. You can specify a value up to 999999.", "type": "integer" }, "minimum": { "description": "The minimum quantity the customer can purchase. By default this value is 0. If there is only one item in the cart then that item's quantity cannot go down to 0.", "type": "integer" } }, "required": [ "enabled" ], "title": "adjustable_quantity_params", "type": "object", "x-stripeMostCommon": [ "enabled", "maximum", "minimum" ] }, "id": { "description": "The ID of an existing line item on the payment link.", "maxLength": 5000, "type": "string" }, "quantity": { "description": "The quantity of the line item being purchased.", "type": "integer" } }, "required": [ "id" ], "title": "line_items_update_params", "type": "object", "x-stripeMostCommon": [ "adjustable_quantity", "id", "price", "quantity" ] }, "type": "array" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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](https://stripe.com/docs/api/checkout/sessions) created by this payment link.", "type": "object" }, "payment_intent_data": { "description": "A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in `payment` mode.", "properties": { "description": { "anyOf": [ { "maxLength": 1000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "An arbitrary string attached to the object. Often useful for displaying to users." }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will declaratively set metadata on [Payment Intents](https://stripe.com/docs/api/payment_intents) generated from this payment link. Unlike object-level metadata, this field is declarative. Updates will clear prior values." }, "statement_descriptor": { "anyOf": [ { "maxLength": 22, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).\n\nSetting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead." }, "statement_descriptor_suffix": { "anyOf": [ { "maxLength": 22, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement." }, "transfer_group": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/connect/separate-charges-and-transfers) for details." } }, "title": "payment_intent_data_update_params", "type": "object", "x-stripeMostCommon": [ "description", "metadata", "setup_future_usage", "statement_descriptor", "statement_descriptor_suffix", "transfer_group" ] }, "payment_method_collection": { "description": "Specify whether Checkout should collect a payment method. When set to `if_required`, Checkout will not collect a payment method when the total due for the session is 0.This may occur if the Checkout Session includes a free trial or a discount.\n\nCan only be set in `subscription` mode. Defaults to `always`.\n\nIf you'd like information on how to collect a payment method outside of Checkout, read the guide on [configuring subscriptions with a free trial](https://stripe.com/docs/payments/checkout/free-trials).", "enum": [ "always", "if_required" ], "type": "string" }, "payment_method_types": { "anyOf": [ { "items": { "enum": [ "affirm", "afterpay_clearpay", "alipay", "alma", "au_becs_debit", "bacs_debit", "bancontact", "billie", "blik", "boleto", "card", "cashapp", "eps", "fpx", "giropay", "gopay", "grabpay", "ideal", "klarna", "konbini", "link", "mb_way", "mobilepay", "multibanco", "oxxo", "p24", "pay_by_bank", "paynow", "paypal", "paypay", "payto", "pix", "promptpay", "qris", "rechnung", "satispay", "sepa_debit", "shopeepay", "sofort", "swish", "twint", "us_bank_account", "wechat_pay", "zip" ], "type": "string", "x-stripeBypassValidation": true }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The list of payment method types that customers can use. Pass an empty string to enable dynamic payment methods that use your [payment method settings](https://dashboard.stripe.com/settings/payment_methods)." }, "phone_number_collection": { "description": "Controls phone number collection settings during checkout.\n\nWe recommend that you review your privacy policy and check with your legal contacts.", "properties": { "enabled": { "description": "Set to `true` to enable phone number collection.", "type": "boolean" } }, "required": [ "enabled" ], "title": "phone_number_collection_params", "type": "object", "x-stripeMostCommon": [ "enabled" ] }, "restrictions": { "anyOf": [ { "properties": { "completed_sessions": { "description": "Configuration for the `completed_sessions` restriction type.", "properties": { "limit": { "description": "The maximum number of checkout sessions that can be completed for the `completed_sessions` restriction to be met.", "type": "integer" } }, "required": [ "limit" ], "title": "completed_sessions_params", "type": "object", "x-stripeMostCommon": [ "limit" ] } }, "required": [ "completed_sessions" ], "title": "restrictions_params", "type": "object", "x-stripeMostCommon": [ "completed_sessions" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Settings that restrict the usage of a payment link." }, "shipping_address_collection": { "anyOf": [ { "properties": { "allowed_countries": { "description": "An array of two-letter ISO country codes representing which countries Checkout should provide as options for\nshipping locations.", "items": { "enum": [ "AC", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CV", "CW", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MK", "ML", "MM", "MN", "MO", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SZ", "TA", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VN", "VU", "WF", "WS", "XK", "YE", "YT", "ZA", "ZM", "ZW", "ZZ" ], "type": "string" }, "type": "array" } }, "required": [ "allowed_countries" ], "title": "shipping_address_collection_params", "type": "object", "x-stripeMostCommon": [ "allowed_countries" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Configuration for collecting the customer's shipping address." }, "submit_type": { "description": "Describes the type of transaction being performed in order to customize relevant text on the page, such as the submit button. Changing this value will also affect the hostname in the [url](https://stripe.com/docs/api/payment_links/payment_links/object#url) property (example: `donate.stripe.com`).", "enum": [ "auto", "book", "donate", "pay", "subscribe" ], "type": "string" }, "subscription_data": { "description": "When creating a subscription, the specified configuration data will be used. There must be at least one line item with a recurring price to use `subscription_data`.", "properties": { "invoice_settings": { "description": "All invoices will be billed using the specified settings.", "properties": { "issuer": { "description": "The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.", "properties": { "account": { "description": "The connected account being referenced when `type` is `account`.", "type": "string" }, "type": { "description": "Type of the account referenced in the request.", "enum": [ "account", "self" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "param", "type": "object", "x-stripeMostCommon": [ "account", "type" ] } }, "title": "subscription_data_invoice_settings_params", "type": "object", "x-stripeMostCommon": [ "issuer" ] }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will declaratively set metadata on [Subscriptions](https://stripe.com/docs/api/subscriptions) generated from this payment link. Unlike object-level metadata, this field is declarative. Updates will clear prior values." }, "trial_period_days": { "anyOf": [ { "type": "integer" }, { "enum": [ "" ], "type": "string" } ], "description": "Integer representing the number of trial period days before the customer is charged for the first time. Has to be at least 1." }, "trial_settings": { "anyOf": [ { "properties": { "end_behavior": { "description": "Defines how the subscription should behave when the user's free trial ends.", "properties": { "missing_payment_method": { "description": "Indicates how the subscription should change when the trial ends if the user did not provide a payment method.", "enum": [ "cancel", "create_invoice", "pause" ], "type": "string" } }, "required": [ "missing_payment_method" ], "title": "end_behavior", "type": "object", "x-stripeMostCommon": [ "missing_payment_method" ] } }, "required": [ "end_behavior" ], "title": "trial_settings_config", "type": "object", "x-stripeMostCommon": [ "end_behavior" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Settings related to subscription trials." } }, "title": "subscription_data_update_params", "type": "object", "x-stripeMostCommon": [ "invoice_settings", "metadata", "trial_period_days", "trial_settings" ] }, "tax_id_collection": { "description": "Controls tax ID collection during checkout.", "properties": { "enabled": { "description": "Enable tax ID collection during checkout. Defaults to `false`.", "type": "boolean" }, "required": { "description": "Describes whether a tax ID is required during checkout. Defaults to `never`.", "enum": [ "if_supported", "never" ], "type": "string" } }, "required": [ "enabled" ], "title": "tax_id_collection_params", "type": "object", "x-stripeMostCommon": [ "enabled", "required" ] } }, "type": "object", "x-stripeMostCommon": [ "active", "line_items", "metadata" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_link" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a payment link" } }, "/v1/payment_links/{payment_link}/line_items": { "get": { "description": "

When retrieving a payment link, 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.

", "operationId": "GetPaymentLinksPaymentLinkLineItems", "parameters": [ { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "in": "path", "name": "payment_link", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/item" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "PaymentLinksResourceListLineItems", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a payment link's line items" } }, "/v1/payment_method_configurations": { "get": { "description": "

List payment method configurations

", "operationId": "GetPaymentMethodConfigurations", "parameters": [ { "description": "The Connect application to filter by.", "explode": true, "in": "query", "name": "application", "required": false, "schema": { "anyOf": [ { "maxLength": 100, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "style": "deepObject" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/payment_method_configuration" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/payment_method_configurations", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "PaymentMethodConfigResourcePaymentMethodConfigurationsList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List payment method configurations" }, "post": { "description": "

Creates a payment method configuration

", "operationId": "PostPaymentMethodConfigurations", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "acss_debit": { "explode": true, "style": "deepObject" }, "affirm": { "explode": true, "style": "deepObject" }, "afterpay_clearpay": { "explode": true, "style": "deepObject" }, "alipay": { "explode": true, "style": "deepObject" }, "alma": { "explode": true, "style": "deepObject" }, "amazon_pay": { "explode": true, "style": "deepObject" }, "apple_pay": { "explode": true, "style": "deepObject" }, "apple_pay_later": { "explode": true, "style": "deepObject" }, "au_becs_debit": { "explode": true, "style": "deepObject" }, "bacs_debit": { "explode": true, "style": "deepObject" }, "bancontact": { "explode": true, "style": "deepObject" }, "billie": { "explode": true, "style": "deepObject" }, "blik": { "explode": true, "style": "deepObject" }, "boleto": { "explode": true, "style": "deepObject" }, "card": { "explode": true, "style": "deepObject" }, "cartes_bancaires": { "explode": true, "style": "deepObject" }, "cashapp": { "explode": true, "style": "deepObject" }, "customer_balance": { "explode": true, "style": "deepObject" }, "eps": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "fpx": { "explode": true, "style": "deepObject" }, "fr_meal_voucher_conecs": { "explode": true, "style": "deepObject" }, "giropay": { "explode": true, "style": "deepObject" }, "google_pay": { "explode": true, "style": "deepObject" }, "gopay": { "explode": true, "style": "deepObject" }, "grabpay": { "explode": true, "style": "deepObject" }, "id_bank_transfer": { "explode": true, "style": "deepObject" }, "ideal": { "explode": true, "style": "deepObject" }, "jcb": { "explode": true, "style": "deepObject" }, "kakao_pay": { "explode": true, "style": "deepObject" }, "klarna": { "explode": true, "style": "deepObject" }, "konbini": { "explode": true, "style": "deepObject" }, "kr_card": { "explode": true, "style": "deepObject" }, "link": { "explode": true, "style": "deepObject" }, "mobilepay": { "explode": true, "style": "deepObject" }, "multibanco": { "explode": true, "style": "deepObject" }, "naver_pay": { "explode": true, "style": "deepObject" }, "nz_bank_account": { "explode": true, "style": "deepObject" }, "oxxo": { "explode": true, "style": "deepObject" }, "p24": { "explode": true, "style": "deepObject" }, "pay_by_bank": { "explode": true, "style": "deepObject" }, "payco": { "explode": true, "style": "deepObject" }, "paynow": { "explode": true, "style": "deepObject" }, "paypal": { "explode": true, "style": "deepObject" }, "paypay": { "explode": true, "style": "deepObject" }, "payto": { "explode": true, "style": "deepObject" }, "pix": { "explode": true, "style": "deepObject" }, "promptpay": { "explode": true, "style": "deepObject" }, "qris": { "explode": true, "style": "deepObject" }, "revolut_pay": { "explode": true, "style": "deepObject" }, "samsung_pay": { "explode": true, "style": "deepObject" }, "satispay": { "explode": true, "style": "deepObject" }, "sepa_debit": { "explode": true, "style": "deepObject" }, "shopeepay": { "explode": true, "style": "deepObject" }, "sofort": { "explode": true, "style": "deepObject" }, "swish": { "explode": true, "style": "deepObject" }, "twint": { "explode": true, "style": "deepObject" }, "us_bank_account": { "explode": true, "style": "deepObject" }, "wechat_pay": { "explode": true, "style": "deepObject" }, "zip": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "acss_debit": { "description": "Canadian pre-authorized debit payments, check this [page](https://stripe.com/docs/payments/acss-debit) for more details like country availability.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "affirm": { "description": "[Affirm](https://www.affirm.com/) gives your customers a way to split purchases over a series of payments. Depending on the purchase, they can pay with four interest-free payments (Split Pay) or pay over a longer term (Installments), which might include interest. Check this [page](https://stripe.com/docs/payments/affirm) for more details like country availability.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "afterpay_clearpay": { "description": "Afterpay gives your customers a way to pay for purchases in installments, check this [page](https://stripe.com/docs/payments/afterpay-clearpay) for more details like country availability. Afterpay is particularly popular among businesses selling fashion, beauty, and sports products.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "alipay": { "description": "Alipay is a digital wallet in China that has more than a billion active users worldwide. Alipay users can pay on the web or on a mobile device using login credentials or their Alipay app. Alipay has a low dispute rate and reduces fraud by authenticating payments using the customer's login credentials. Check this [page](https://stripe.com/docs/payments/alipay) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "alma": { "description": "Alma is a Buy Now, Pay Later payment method that offers customers the ability to pay in 2, 3, or 4 installments.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "amazon_pay": { "description": "Amazon Pay is a wallet payment method that lets your customers check out the same way as on Amazon.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "apple_pay": { "description": "Stripe users can accept [Apple Pay](https://stripe.com/payments/apple-pay) in iOS applications in iOS 9 and later, and on the web in Safari starting with iOS 10 or macOS Sierra. There are no additional fees to process Apple Pay payments, and the [pricing](https://stripe.com/pricing) is the same as other card transactions. Check this [page](https://stripe.com/docs/apple-pay) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "apple_pay_later": { "description": "Apple Pay Later, a payment method for customers to buy now and pay later, gives your customers a way to split purchases into four installments across six weeks.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "au_becs_debit": { "description": "Stripe users in Australia can accept Bulk Electronic Clearing System (BECS) direct debit payments from customers with an Australian bank account. Check this [page](https://stripe.com/docs/payments/au-becs-debit) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "bacs_debit": { "description": "Stripe users in the UK can accept Bacs Direct Debit payments from customers with a UK bank account, check this [page](https://stripe.com/docs/payments/payment-methods/bacs-debit) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "bancontact": { "description": "Bancontact is the most popular online payment method in Belgium, with over 15 million cards in circulation. [Customers](https://stripe.com/docs/api/customers) use a Bancontact card or mobile app linked to a Belgian bank account to make online payments that are secure, guaranteed, and confirmed immediately. Check this [page](https://stripe.com/docs/payments/bancontact) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "billie": { "description": "Billie is a [single-use](https://docs.stripe.com/payments/payment-methods#usage) payment method that offers businesses Pay by Invoice where they offer payment terms ranging from 7-120 days. Customers are redirected from your website or app, authorize the payment with Billie, then return to your website or app. You get [immediate notification](/payments/payment-methods#payment-notification) of whether the payment succeeded or failed.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "blik": { "description": "BLIK is a [single use](https://stripe.com/docs/payments/payment-methods#usage) payment method that requires customers to authenticate their payments. When customers want to pay online using BLIK, they request a six-digit code from their banking application and enter it into the payment collection form. Check this [page](https://stripe.com/docs/payments/blik) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "boleto": { "description": "Boleto is an official (regulated by the Central Bank of Brazil) payment method in Brazil. Check this [page](https://stripe.com/docs/payments/boleto) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "card": { "description": "Cards are a popular way for consumers and businesses to pay online or in person. Stripe supports global and local card networks.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "cartes_bancaires": { "description": "Cartes Bancaires is France's local card network. More than 95% of these cards are co-branded with either Visa or Mastercard, meaning you can process these cards over either Cartes Bancaires or the Visa or Mastercard networks. Check this [page](https://stripe.com/docs/payments/cartes-bancaires) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "cashapp": { "description": "Cash App is a popular consumer app in the US that allows customers to bank, invest, send, and receive money using their digital wallet. Check this [page](https://stripe.com/docs/payments/cash-app-pay) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "customer_balance": { "description": "Uses a customer’s [cash balance](https://stripe.com/docs/payments/customer-balance) for the payment. The cash balance can be funded via a bank transfer. Check this [page](https://stripe.com/docs/payments/bank-transfers) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "eps": { "description": "EPS is an Austria-based payment method that allows customers to complete transactions online using their bank credentials. EPS is supported by all Austrian banks and is accepted by over 80% of Austrian online retailers. Check this [page](https://stripe.com/docs/payments/eps) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "fpx": { "description": "Financial Process Exchange (FPX) is a Malaysia-based payment method that allows customers to complete transactions online using their bank credentials. Bank Negara Malaysia (BNM), the Central Bank of Malaysia, and eleven other major Malaysian financial institutions are members of the PayNet Group, which owns and operates FPX. It is one of the most popular online payment methods in Malaysia, with nearly 90 million transactions in 2018 according to BNM. Check this [page](https://stripe.com/docs/payments/fpx) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "fr_meal_voucher_conecs": { "description": "Meal vouchers in France, or “titres-restaurant”, is a local benefits program commonly offered by employers for their employees to purchase prepared food and beverages on working days. Check this [page](https://stripe.com/docs/payments/benefits/fr-meal-vouchers) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "giropay": { "description": "giropay is a German payment method based on online banking, introduced in 2006. It allows customers to complete transactions online using their online banking environment, with funds debited from their bank account. Depending on their bank, customers confirm payments on giropay using a second factor of authentication or a PIN. giropay accounts for 10% of online checkouts in Germany. Check this [page](https://stripe.com/docs/payments/giropay) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "google_pay": { "description": "Google Pay allows customers to make payments in your app or website using any credit or debit card saved to their Google Account, including those from Google Play, YouTube, Chrome, or an Android device. Use the Google Pay API to request any credit or debit card stored in your customer's Google account. Check this [page](https://stripe.com/docs/google-pay) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "gopay": { "description": "GoPay is a [single use](https://stripe.com/docs/payments/payment-methods#usage) digital wallet payment method popular in Indonesia. When paying with GoPay, customers authenticate and approve payments using the Gojek app. Desktop checkout is performed by scanning a QR code. When checking out on mobile, customers are redirected to the Gojek app to confirm payment.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "grabpay": { "description": "GrabPay is a payment method developed by [Grab](https://www.grab.com/sg/consumer/finance/pay/). GrabPay is a digital wallet - customers maintain a balance in their wallets that they pay out with. Check this [page](https://stripe.com/docs/payments/grabpay) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "id_bank_transfer": { "description": "Stripe users in Indonesia can receive bank transfers from customers in Indonesia. Bank transfers are a popular B2C and B2B payment method in Indonesia.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "ideal": { "description": "iDEAL is a Netherlands-based payment method that allows customers to complete transactions online using their bank credentials. All major Dutch banks are members of Currence, the scheme that operates iDEAL, making it the most popular online payment method in the Netherlands with a share of online transactions close to 55%. Check this [page](https://stripe.com/docs/payments/ideal) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "jcb": { "description": "JCB is a credit card company based in Japan. JCB is currently available in Japan to businesses approved by JCB, and available to all businesses in Australia, Canada, Hong Kong, Japan, New Zealand, Singapore, Switzerland, United Kingdom, United States, and all countries in the European Economic Area except Iceland. Check this [page](https://support.stripe.com/questions/accepting-japan-credit-bureau-%28jcb%29-payments) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "kakao_pay": { "description": "Kakao Pay is a popular local wallet available in South Korea.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "klarna": { "description": "Klarna gives customers a range of [payment options](https://stripe.com/docs/payments/klarna#payment-options) during checkout. Available payment options vary depending on the customer's billing address and the transaction amount. These payment options make it convenient for customers to purchase items in all price ranges. Check this [page](https://stripe.com/docs/payments/klarna) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "konbini": { "description": "Konbini allows customers in Japan to pay for bills and online purchases at convenience stores with cash. Check this [page](https://stripe.com/docs/payments/konbini) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "kr_card": { "description": "Korean cards let users pay using locally issued cards from South Korea.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "link": { "description": "[Link](https://stripe.com/docs/payments/link) is a payment method network. With Link, users save their payment details once, then reuse that information to pay with one click for any business on the network.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "mobilepay": { "description": "MobilePay is a [single-use](https://stripe.com/docs/payments/payment-methods#usage) card wallet payment method used in Denmark and Finland. It allows customers to [authenticate and approve](https://stripe.com/docs/payments/payment-methods#customer-actions) payments using the MobilePay app. Check this [page](https://stripe.com/docs/payments/mobilepay) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "multibanco": { "description": "Stripe users in Europe and the United States can accept Multibanco payments from customers in Portugal using [Sources](https://stripe.com/docs/sources)—a single integration path for creating payments using any supported method.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "name": { "description": "Configuration name.", "maxLength": 100, "type": "string" }, "naver_pay": { "description": "Naver Pay is a popular local wallet available in South Korea.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "nz_bank_account": { "description": "Stripe users in New Zealand can accept Bulk Electronic Clearing System (BECS) direct debit payments from customers with a New Zeland bank account. Check this [page](https://stripe.com/docs/payments/nz-bank-account) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "oxxo": { "description": "OXXO is a Mexican chain of convenience stores with thousands of locations across Latin America and represents nearly 20% of online transactions in Mexico. OXXO allows customers to pay bills and online purchases in-store with cash. Check this [page](https://stripe.com/docs/payments/oxxo) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "p24": { "description": "Przelewy24 is a Poland-based payment method aggregator that allows customers to complete transactions online using bank transfers and other methods. Bank transfers account for 30% of online payments in Poland and Przelewy24 provides a way for customers to pay with over 165 banks. Check this [page](https://stripe.com/docs/payments/p24) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "parent": { "description": "Configuration's parent configuration. Specify to create a child configuration.", "maxLength": 100, "type": "string" }, "pay_by_bank": { "description": "Pay by bank is a redirect payment method backed by bank transfers. A customer is redirected to their bank to authorize a bank transfer for a given amount. This removes a lot of the error risks inherent in waiting for the customer to initiate a transfer themselves, and is less expensive than card payments.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "payco": { "description": "PAYCO is a [single-use](https://docs.stripe.com/payments/payment-methods#usage local wallet available in South Korea.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "paynow": { "description": "PayNow is a Singapore-based payment method that allows customers to make a payment using their preferred app from participating banks and participating non-bank financial institutions. Check this [page](https://stripe.com/docs/payments/paynow) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "paypal": { "description": "PayPal, a digital wallet popular with customers in Europe, allows your customers worldwide to pay using their PayPal account. Check this [page](https://stripe.com/docs/payments/paypal) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "paypay": { "description": "Customers can pay with PayPay online or using the PayPay app.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "payto": { "description": "PayTo is a [real-time](https://docs.stripe.com/payments/real-time) payment method that enables customers in Australia to pay by providing their bank account details. Customers must accept a mandate authorizing you to debit their account. Check this [page](https://docs.stripe.com/payments/payto) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "pix": { "description": "Pix is a payment method popular in Brazil. When paying with Pix, customers authenticate and approve payments by scanning a QR code in their preferred banking app. Check this [page](https://docs.stripe.com/payments/pix) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "promptpay": { "description": "PromptPay is a Thailand-based payment method that allows customers to make a payment using their preferred app from participating banks. Check this [page](https://stripe.com/docs/payments/promptpay) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "qris": { "description": "QRIS is a [real-time](https://docs.stripe.com/payments/real-time) payment method popular in Indonesia. When paying with QRIS, customers authenticate and approve payments by scanning a QR code in their preferred digital wallet app.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "revolut_pay": { "description": "Revolut Pay, developed by Revolut, a global finance app, is a digital wallet payment method. Revolut Pay uses the customer’s stored balance or cards to fund the payment, and offers the option for non-Revolut customers to save their details after their first purchase.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "samsung_pay": { "description": "Samsung Pay is a [single-use](https://docs.stripe.com/payments/payment-methods#usage local wallet available in South Korea.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "satispay": { "description": "Satispay is a [single-use](https://docs.stripe.com/payments/payment-methods#usage) payment method where customers are required to [authenticate](/payments/payment-methods#customer-actions) their payment. Customers pay by being redirected from your website or app, authorizing the payment with Satispay, then returning to your website or app. You get [immediate notification](/payments/payment-methods#payment-notification) of whether the payment succeeded or failed.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "sepa_debit": { "description": "The [Single Euro Payments Area (SEPA)](https://en.wikipedia.org/wiki/Single_Euro_Payments_Area) is an initiative of the European Union to simplify payments within and across member countries. SEPA established and enforced banking standards to allow for the direct debiting of every EUR-denominated bank account within the SEPA region, check this [page](https://stripe.com/docs/payments/sepa-debit) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "shopeepay": { "description": "ShopeePay is a [single use](https://stripe.com/docs/payments/payment-methods#usage) digital wallet payment method popular in Indonesia. When paying with GoPay, customers authenticate and approve payments using the Shopee app. Desktop checkout is performed by scanning a QR code. When checking out on mobile, customers are redirected to the Shopee app to confirm payment.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "sofort": { "description": "Stripe users in Europe and the United States can use the [Payment Intents API](https://stripe.com/docs/payments/payment-intents)—a single integration path for creating payments using any supported method—to accept [Sofort](https://www.sofort.com/) payments from customers. Check this [page](https://stripe.com/docs/payments/sofort) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "swish": { "description": "Swish is a [real-time](https://stripe.com/docs/payments/real-time) payment method popular in Sweden. It allows customers to [authenticate and approve](https://stripe.com/docs/payments/payment-methods#customer-actions) payments using the Swish mobile app and the Swedish BankID mobile app. Check this [page](https://stripe.com/docs/payments/swish) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "twint": { "description": "Twint is a payment method popular in Switzerland. It allows customers to pay using their mobile phone. Check this [page](https://docs.stripe.com/payments/twint) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "us_bank_account": { "description": "Stripe users in the United States can accept ACH direct debit payments from customers with a US bank account using the Automated Clearing House (ACH) payments system operated by Nacha. Check this [page](https://stripe.com/docs/payments/ach-direct-debit) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "wechat_pay": { "description": "WeChat, owned by Tencent, is China's leading mobile app with over 1 billion monthly active users. Chinese consumers can use WeChat Pay to pay for goods and services inside of businesses' apps and websites. WeChat Pay users buy most frequently in gaming, e-commerce, travel, online education, and food/nutrition. Check this [page](https://stripe.com/docs/payments/wechat-pay) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "zip": { "description": "Zip gives your customers a way to split purchases over a series of payments. Check this [page](https://stripe.com/docs/payments/zip) for more details like country availability.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] } }, "type": "object", "x-stripeMostCommon": [ "name", "parent" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_method_configuration" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a payment method configuration" } }, "/v1/payment_method_configurations/{configuration}": { "get": { "description": "

Retrieve payment method configuration

", "operationId": "GetPaymentMethodConfigurationsConfiguration", "parameters": [ { "in": "path", "name": "configuration", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_method_configuration" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve payment method configuration" }, "post": { "description": "

Update payment method configuration

", "operationId": "PostPaymentMethodConfigurationsConfiguration", "parameters": [ { "in": "path", "name": "configuration", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "acss_debit": { "explode": true, "style": "deepObject" }, "affirm": { "explode": true, "style": "deepObject" }, "afterpay_clearpay": { "explode": true, "style": "deepObject" }, "alipay": { "explode": true, "style": "deepObject" }, "alma": { "explode": true, "style": "deepObject" }, "amazon_pay": { "explode": true, "style": "deepObject" }, "apple_pay": { "explode": true, "style": "deepObject" }, "apple_pay_later": { "explode": true, "style": "deepObject" }, "au_becs_debit": { "explode": true, "style": "deepObject" }, "bacs_debit": { "explode": true, "style": "deepObject" }, "bancontact": { "explode": true, "style": "deepObject" }, "billie": { "explode": true, "style": "deepObject" }, "blik": { "explode": true, "style": "deepObject" }, "boleto": { "explode": true, "style": "deepObject" }, "card": { "explode": true, "style": "deepObject" }, "cartes_bancaires": { "explode": true, "style": "deepObject" }, "cashapp": { "explode": true, "style": "deepObject" }, "customer_balance": { "explode": true, "style": "deepObject" }, "eps": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "fpx": { "explode": true, "style": "deepObject" }, "fr_meal_voucher_conecs": { "explode": true, "style": "deepObject" }, "giropay": { "explode": true, "style": "deepObject" }, "google_pay": { "explode": true, "style": "deepObject" }, "gopay": { "explode": true, "style": "deepObject" }, "grabpay": { "explode": true, "style": "deepObject" }, "id_bank_transfer": { "explode": true, "style": "deepObject" }, "ideal": { "explode": true, "style": "deepObject" }, "jcb": { "explode": true, "style": "deepObject" }, "kakao_pay": { "explode": true, "style": "deepObject" }, "klarna": { "explode": true, "style": "deepObject" }, "konbini": { "explode": true, "style": "deepObject" }, "kr_card": { "explode": true, "style": "deepObject" }, "link": { "explode": true, "style": "deepObject" }, "mobilepay": { "explode": true, "style": "deepObject" }, "multibanco": { "explode": true, "style": "deepObject" }, "naver_pay": { "explode": true, "style": "deepObject" }, "nz_bank_account": { "explode": true, "style": "deepObject" }, "oxxo": { "explode": true, "style": "deepObject" }, "p24": { "explode": true, "style": "deepObject" }, "pay_by_bank": { "explode": true, "style": "deepObject" }, "payco": { "explode": true, "style": "deepObject" }, "paynow": { "explode": true, "style": "deepObject" }, "paypal": { "explode": true, "style": "deepObject" }, "paypay": { "explode": true, "style": "deepObject" }, "payto": { "explode": true, "style": "deepObject" }, "pix": { "explode": true, "style": "deepObject" }, "promptpay": { "explode": true, "style": "deepObject" }, "qris": { "explode": true, "style": "deepObject" }, "revolut_pay": { "explode": true, "style": "deepObject" }, "samsung_pay": { "explode": true, "style": "deepObject" }, "satispay": { "explode": true, "style": "deepObject" }, "sepa_debit": { "explode": true, "style": "deepObject" }, "shopeepay": { "explode": true, "style": "deepObject" }, "sofort": { "explode": true, "style": "deepObject" }, "swish": { "explode": true, "style": "deepObject" }, "twint": { "explode": true, "style": "deepObject" }, "us_bank_account": { "explode": true, "style": "deepObject" }, "wechat_pay": { "explode": true, "style": "deepObject" }, "zip": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "acss_debit": { "description": "Canadian pre-authorized debit payments, check this [page](https://stripe.com/docs/payments/acss-debit) for more details like country availability.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "active": { "description": "Whether the configuration can be used for new payments.", "type": "boolean" }, "affirm": { "description": "[Affirm](https://www.affirm.com/) gives your customers a way to split purchases over a series of payments. Depending on the purchase, they can pay with four interest-free payments (Split Pay) or pay over a longer term (Installments), which might include interest. Check this [page](https://stripe.com/docs/payments/affirm) for more details like country availability.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "afterpay_clearpay": { "description": "Afterpay gives your customers a way to pay for purchases in installments, check this [page](https://stripe.com/docs/payments/afterpay-clearpay) for more details like country availability. Afterpay is particularly popular among businesses selling fashion, beauty, and sports products.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "alipay": { "description": "Alipay is a digital wallet in China that has more than a billion active users worldwide. Alipay users can pay on the web or on a mobile device using login credentials or their Alipay app. Alipay has a low dispute rate and reduces fraud by authenticating payments using the customer's login credentials. Check this [page](https://stripe.com/docs/payments/alipay) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "alma": { "description": "Alma is a Buy Now, Pay Later payment method that offers customers the ability to pay in 2, 3, or 4 installments.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "amazon_pay": { "description": "Amazon Pay is a wallet payment method that lets your customers check out the same way as on Amazon.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "apple_pay": { "description": "Stripe users can accept [Apple Pay](https://stripe.com/payments/apple-pay) in iOS applications in iOS 9 and later, and on the web in Safari starting with iOS 10 or macOS Sierra. There are no additional fees to process Apple Pay payments, and the [pricing](https://stripe.com/pricing) is the same as other card transactions. Check this [page](https://stripe.com/docs/apple-pay) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "apple_pay_later": { "description": "Apple Pay Later, a payment method for customers to buy now and pay later, gives your customers a way to split purchases into four installments across six weeks.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "au_becs_debit": { "description": "Stripe users in Australia can accept Bulk Electronic Clearing System (BECS) direct debit payments from customers with an Australian bank account. Check this [page](https://stripe.com/docs/payments/au-becs-debit) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "bacs_debit": { "description": "Stripe users in the UK can accept Bacs Direct Debit payments from customers with a UK bank account, check this [page](https://stripe.com/docs/payments/payment-methods/bacs-debit) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "bancontact": { "description": "Bancontact is the most popular online payment method in Belgium, with over 15 million cards in circulation. [Customers](https://stripe.com/docs/api/customers) use a Bancontact card or mobile app linked to a Belgian bank account to make online payments that are secure, guaranteed, and confirmed immediately. Check this [page](https://stripe.com/docs/payments/bancontact) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "billie": { "description": "Billie is a [single-use](https://docs.stripe.com/payments/payment-methods#usage) payment method that offers businesses Pay by Invoice where they offer payment terms ranging from 7-120 days. Customers are redirected from your website or app, authorize the payment with Billie, then return to your website or app. You get [immediate notification](/payments/payment-methods#payment-notification) of whether the payment succeeded or failed.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "blik": { "description": "BLIK is a [single use](https://stripe.com/docs/payments/payment-methods#usage) payment method that requires customers to authenticate their payments. When customers want to pay online using BLIK, they request a six-digit code from their banking application and enter it into the payment collection form. Check this [page](https://stripe.com/docs/payments/blik) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "boleto": { "description": "Boleto is an official (regulated by the Central Bank of Brazil) payment method in Brazil. Check this [page](https://stripe.com/docs/payments/boleto) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "card": { "description": "Cards are a popular way for consumers and businesses to pay online or in person. Stripe supports global and local card networks.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "cartes_bancaires": { "description": "Cartes Bancaires is France's local card network. More than 95% of these cards are co-branded with either Visa or Mastercard, meaning you can process these cards over either Cartes Bancaires or the Visa or Mastercard networks. Check this [page](https://stripe.com/docs/payments/cartes-bancaires) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "cashapp": { "description": "Cash App is a popular consumer app in the US that allows customers to bank, invest, send, and receive money using their digital wallet. Check this [page](https://stripe.com/docs/payments/cash-app-pay) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "customer_balance": { "description": "Uses a customer’s [cash balance](https://stripe.com/docs/payments/customer-balance) for the payment. The cash balance can be funded via a bank transfer. Check this [page](https://stripe.com/docs/payments/bank-transfers) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "eps": { "description": "EPS is an Austria-based payment method that allows customers to complete transactions online using their bank credentials. EPS is supported by all Austrian banks and is accepted by over 80% of Austrian online retailers. Check this [page](https://stripe.com/docs/payments/eps) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "fpx": { "description": "Financial Process Exchange (FPX) is a Malaysia-based payment method that allows customers to complete transactions online using their bank credentials. Bank Negara Malaysia (BNM), the Central Bank of Malaysia, and eleven other major Malaysian financial institutions are members of the PayNet Group, which owns and operates FPX. It is one of the most popular online payment methods in Malaysia, with nearly 90 million transactions in 2018 according to BNM. Check this [page](https://stripe.com/docs/payments/fpx) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "fr_meal_voucher_conecs": { "description": "Meal vouchers in France, or “titres-restaurant”, is a local benefits program commonly offered by employers for their employees to purchase prepared food and beverages on working days. Check this [page](https://stripe.com/docs/payments/benefits/fr-meal-vouchers) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "giropay": { "description": "giropay is a German payment method based on online banking, introduced in 2006. It allows customers to complete transactions online using their online banking environment, with funds debited from their bank account. Depending on their bank, customers confirm payments on giropay using a second factor of authentication or a PIN. giropay accounts for 10% of online checkouts in Germany. Check this [page](https://stripe.com/docs/payments/giropay) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "google_pay": { "description": "Google Pay allows customers to make payments in your app or website using any credit or debit card saved to their Google Account, including those from Google Play, YouTube, Chrome, or an Android device. Use the Google Pay API to request any credit or debit card stored in your customer's Google account. Check this [page](https://stripe.com/docs/google-pay) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "gopay": { "description": "GoPay is a [single use](https://stripe.com/docs/payments/payment-methods#usage) digital wallet payment method popular in Indonesia. When paying with GoPay, customers authenticate and approve payments using the Gojek app. Desktop checkout is performed by scanning a QR code. When checking out on mobile, customers are redirected to the Gojek app to confirm payment.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "grabpay": { "description": "GrabPay is a payment method developed by [Grab](https://www.grab.com/sg/consumer/finance/pay/). GrabPay is a digital wallet - customers maintain a balance in their wallets that they pay out with. Check this [page](https://stripe.com/docs/payments/grabpay) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "id_bank_transfer": { "description": "Stripe users in Indonesia can receive bank transfers from customers in Indonesia. Bank transfers are a popular B2C and B2B payment method in Indonesia.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "ideal": { "description": "iDEAL is a Netherlands-based payment method that allows customers to complete transactions online using their bank credentials. All major Dutch banks are members of Currence, the scheme that operates iDEAL, making it the most popular online payment method in the Netherlands with a share of online transactions close to 55%. Check this [page](https://stripe.com/docs/payments/ideal) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "jcb": { "description": "JCB is a credit card company based in Japan. JCB is currently available in Japan to businesses approved by JCB, and available to all businesses in Australia, Canada, Hong Kong, Japan, New Zealand, Singapore, Switzerland, United Kingdom, United States, and all countries in the European Economic Area except Iceland. Check this [page](https://support.stripe.com/questions/accepting-japan-credit-bureau-%28jcb%29-payments) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "kakao_pay": { "description": "Kakao Pay is a popular local wallet available in South Korea.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "klarna": { "description": "Klarna gives customers a range of [payment options](https://stripe.com/docs/payments/klarna#payment-options) during checkout. Available payment options vary depending on the customer's billing address and the transaction amount. These payment options make it convenient for customers to purchase items in all price ranges. Check this [page](https://stripe.com/docs/payments/klarna) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "konbini": { "description": "Konbini allows customers in Japan to pay for bills and online purchases at convenience stores with cash. Check this [page](https://stripe.com/docs/payments/konbini) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "kr_card": { "description": "Korean cards let users pay using locally issued cards from South Korea.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "link": { "description": "[Link](https://stripe.com/docs/payments/link) is a payment method network. With Link, users save their payment details once, then reuse that information to pay with one click for any business on the network.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "mobilepay": { "description": "MobilePay is a [single-use](https://stripe.com/docs/payments/payment-methods#usage) card wallet payment method used in Denmark and Finland. It allows customers to [authenticate and approve](https://stripe.com/docs/payments/payment-methods#customer-actions) payments using the MobilePay app. Check this [page](https://stripe.com/docs/payments/mobilepay) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "multibanco": { "description": "Stripe users in Europe and the United States can accept Multibanco payments from customers in Portugal using [Sources](https://stripe.com/docs/sources)—a single integration path for creating payments using any supported method.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "name": { "description": "Configuration name.", "maxLength": 100, "type": "string" }, "naver_pay": { "description": "Naver Pay is a popular local wallet available in South Korea.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "nz_bank_account": { "description": "Stripe users in New Zealand can accept Bulk Electronic Clearing System (BECS) direct debit payments from customers with a New Zeland bank account. Check this [page](https://stripe.com/docs/payments/nz-bank-account) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "oxxo": { "description": "OXXO is a Mexican chain of convenience stores with thousands of locations across Latin America and represents nearly 20% of online transactions in Mexico. OXXO allows customers to pay bills and online purchases in-store with cash. Check this [page](https://stripe.com/docs/payments/oxxo) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "p24": { "description": "Przelewy24 is a Poland-based payment method aggregator that allows customers to complete transactions online using bank transfers and other methods. Bank transfers account for 30% of online payments in Poland and Przelewy24 provides a way for customers to pay with over 165 banks. Check this [page](https://stripe.com/docs/payments/p24) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "pay_by_bank": { "description": "Pay by bank is a redirect payment method backed by bank transfers. A customer is redirected to their bank to authorize a bank transfer for a given amount. This removes a lot of the error risks inherent in waiting for the customer to initiate a transfer themselves, and is less expensive than card payments.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "payco": { "description": "PAYCO is a [single-use](https://docs.stripe.com/payments/payment-methods#usage local wallet available in South Korea.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "paynow": { "description": "PayNow is a Singapore-based payment method that allows customers to make a payment using their preferred app from participating banks and participating non-bank financial institutions. Check this [page](https://stripe.com/docs/payments/paynow) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "paypal": { "description": "PayPal, a digital wallet popular with customers in Europe, allows your customers worldwide to pay using their PayPal account. Check this [page](https://stripe.com/docs/payments/paypal) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "paypay": { "description": "Customers can pay with PayPay online or using the PayPay app.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "payto": { "description": "PayTo is a [real-time](https://docs.stripe.com/payments/real-time) payment method that enables customers in Australia to pay by providing their bank account details. Customers must accept a mandate authorizing you to debit their account. Check this [page](https://docs.stripe.com/payments/payto) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "pix": { "description": "Pix is a payment method popular in Brazil. When paying with Pix, customers authenticate and approve payments by scanning a QR code in their preferred banking app. Check this [page](https://docs.stripe.com/payments/pix) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "promptpay": { "description": "PromptPay is a Thailand-based payment method that allows customers to make a payment using their preferred app from participating banks. Check this [page](https://stripe.com/docs/payments/promptpay) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "qris": { "description": "QRIS is a [real-time](https://docs.stripe.com/payments/real-time) payment method popular in Indonesia. When paying with QRIS, customers authenticate and approve payments by scanning a QR code in their preferred digital wallet app.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "revolut_pay": { "description": "Revolut Pay, developed by Revolut, a global finance app, is a digital wallet payment method. Revolut Pay uses the customer’s stored balance or cards to fund the payment, and offers the option for non-Revolut customers to save their details after their first purchase.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "samsung_pay": { "description": "Samsung Pay is a [single-use](https://docs.stripe.com/payments/payment-methods#usage local wallet available in South Korea.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "satispay": { "description": "Satispay is a [single-use](https://docs.stripe.com/payments/payment-methods#usage) payment method where customers are required to [authenticate](/payments/payment-methods#customer-actions) their payment. Customers pay by being redirected from your website or app, authorizing the payment with Satispay, then returning to your website or app. You get [immediate notification](/payments/payment-methods#payment-notification) of whether the payment succeeded or failed.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "sepa_debit": { "description": "The [Single Euro Payments Area (SEPA)](https://en.wikipedia.org/wiki/Single_Euro_Payments_Area) is an initiative of the European Union to simplify payments within and across member countries. SEPA established and enforced banking standards to allow for the direct debiting of every EUR-denominated bank account within the SEPA region, check this [page](https://stripe.com/docs/payments/sepa-debit) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "shopeepay": { "description": "ShopeePay is a [single use](https://stripe.com/docs/payments/payment-methods#usage) digital wallet payment method popular in Indonesia. When paying with GoPay, customers authenticate and approve payments using the Shopee app. Desktop checkout is performed by scanning a QR code. When checking out on mobile, customers are redirected to the Shopee app to confirm payment.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "sofort": { "description": "Stripe users in Europe and the United States can use the [Payment Intents API](https://stripe.com/docs/payments/payment-intents)—a single integration path for creating payments using any supported method—to accept [Sofort](https://www.sofort.com/) payments from customers. Check this [page](https://stripe.com/docs/payments/sofort) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "swish": { "description": "Swish is a [real-time](https://stripe.com/docs/payments/real-time) payment method popular in Sweden. It allows customers to [authenticate and approve](https://stripe.com/docs/payments/payment-methods#customer-actions) payments using the Swish mobile app and the Swedish BankID mobile app. Check this [page](https://stripe.com/docs/payments/swish) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "twint": { "description": "Twint is a payment method popular in Switzerland. It allows customers to pay using their mobile phone. Check this [page](https://docs.stripe.com/payments/twint) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "us_bank_account": { "description": "Stripe users in the United States can accept ACH direct debit payments from customers with a US bank account using the Automated Clearing House (ACH) payments system operated by Nacha. Check this [page](https://stripe.com/docs/payments/ach-direct-debit) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "wechat_pay": { "description": "WeChat, owned by Tencent, is China's leading mobile app with over 1 billion monthly active users. Chinese consumers can use WeChat Pay to pay for goods and services inside of businesses' apps and websites. WeChat Pay users buy most frequently in gaming, e-commerce, travel, online education, and food/nutrition. Check this [page](https://stripe.com/docs/payments/wechat-pay) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] }, "zip": { "description": "Zip gives your customers a way to split purchases over a series of payments. Check this [page](https://stripe.com/docs/payments/zip) for more details like country availability.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", "properties": { "preference": { "description": "The account's preference for whether or not to display this payment method.", "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object", "x-stripeMostCommon": [ "preference" ] } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "display_preference" ] } }, "type": "object", "x-stripeMostCommon": [ "active", "name" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_method_configuration" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update payment method configuration" } }, "/v1/payment_method_domains": { "get": { "description": "

Lists the details of existing payment method domains.

", "operationId": "GetPaymentMethodDomains", "parameters": [ { "description": "The domain name that this payment method domain object represents.", "in": "query", "name": "domain_name", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Whether this payment method domain is enabled. If the domain is not enabled, payment methods will not appear in Elements or Embedded Checkout", "in": "query", "name": "enabled", "required": false, "schema": { "type": "boolean" }, "style": "form" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/payment_method_domain" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/payment_method_domains", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "PaymentMethodDomainResourcePaymentMethodDomainList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List payment method domains" }, "post": { "description": "

Creates a payment method domain.

", "operationId": "PostPaymentMethodDomains", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "domain_name": { "description": "The domain name that this payment method domain object represents.", "maxLength": 5000, "type": "string" }, "enabled": { "description": "Whether this payment method domain is enabled. If the domain is not enabled, payment methods that require a payment method domain will not appear in Elements or Embedded Checkout.", "type": "boolean" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "required": [ "domain_name" ], "type": "object", "x-stripeMostCommon": [ "domain_name", "enabled" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_method_domain" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a payment method domain" } }, "/v1/payment_method_domains/{payment_method_domain}": { "get": { "description": "

Retrieves the details of an existing payment method domain.

", "operationId": "GetPaymentMethodDomainsPaymentMethodDomain", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "payment_method_domain", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_method_domain" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a payment method domain" }, "post": { "description": "

Updates an existing payment method domain.

", "operationId": "PostPaymentMethodDomainsPaymentMethodDomain", "parameters": [ { "in": "path", "name": "payment_method_domain", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "enabled": { "description": "Whether this payment method domain is enabled. If the domain is not enabled, payment methods that require a payment method domain will not appear in Elements or Embedded Checkout.", "type": "boolean" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object", "x-stripeMostCommon": [ "enabled" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_method_domain" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a payment method domain" } }, "/v1/payment_method_domains/{payment_method_domain}/validate": { "post": { "description": "

Some payment methods might require additional steps to register a domain. If the requirements weren’t satisfied when the domain was created, the payment method will be inactive on the domain.\nThe payment method doesn’t appear in Elements or Embedded Checkout for this domain until it is active.

\n\n

To activate a payment method on an existing payment method domain, complete the required registration steps specific to the payment method, and then validate the payment method domain with this endpoint.

\n\n

Related guides: Payment method domains.

", "operationId": "PostPaymentMethodDomainsPaymentMethodDomainValidate", "parameters": [ { "in": "path", "name": "payment_method_domain", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_method_domain" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Validate an existing payment method domain" } }, "/v1/payment_methods": { "get": { "description": "

Returns a list of PaymentMethods for Treasury flows. If you want to list the PaymentMethods attached to a Customer for payments, you should use the List a Customer’s PaymentMethods API instead.

", "operationId": "GetPaymentMethods", "parameters": [ { "description": "The ID of the customer whose PaymentMethods will be retrieved.", "in": "query", "name": "customer", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "An optional filter on the list, based on the object `type` field. Without the filter, the list includes all current and future payment method types. If your integration expects only one type of payment method in the response, make sure to provide a type value in the request.", "in": "query", "name": "type", "required": false, "schema": { "enum": [ "acss_debit", "affirm", "afterpay_clearpay", "alipay", "alma", "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", "billie", "blik", "boleto", "card", "cashapp", "crypto", "customer_balance", "eps", "fpx", "giropay", "gopay", "grabpay", "id_bank_transfer", "ideal", "kakao_pay", "klarna", "konbini", "kr_card", "link", "mb_way", "mobilepay", "multibanco", "naver_pay", "nz_bank_account", "oxxo", "p24", "pay_by_bank", "payco", "paynow", "paypal", "paypay", "payto", "pix", "promptpay", "qris", "rechnung", "revolut_pay", "samsung_pay", "satispay", "sepa_debit", "shopeepay", "sofort", "stripe_balance", "swish", "twint", "us_bank_account", "wechat_pay", "zip" ], "type": "string", "x-stripeBypassValidation": true }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/payment_method" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/payment_methods", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "PaymentFlowsPaymentMethodList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List PaymentMethods" }, "post": { "description": "

Creates a PaymentMethod object. Read the Stripe.js reference to learn how to create PaymentMethods via Stripe.js.

\n\n

Instead of creating a PaymentMethod directly, we recommend using the PaymentIntents API to accept a payment immediately or the SetupIntent API to collect payment method details ahead of a future payment.

", "operationId": "PostPaymentMethods", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "acss_debit": { "explode": true, "style": "deepObject" }, "affirm": { "explode": true, "style": "deepObject" }, "afterpay_clearpay": { "explode": true, "style": "deepObject" }, "alipay": { "explode": true, "style": "deepObject" }, "alma": { "explode": true, "style": "deepObject" }, "amazon_pay": { "explode": true, "style": "deepObject" }, "au_becs_debit": { "explode": true, "style": "deepObject" }, "bacs_debit": { "explode": true, "style": "deepObject" }, "bancontact": { "explode": true, "style": "deepObject" }, "billie": { "explode": true, "style": "deepObject" }, "billing_details": { "explode": true, "style": "deepObject" }, "blik": { "explode": true, "style": "deepObject" }, "boleto": { "explode": true, "style": "deepObject" }, "card": { "explode": true, "style": "deepObject" }, "cashapp": { "explode": true, "style": "deepObject" }, "crypto": { "explode": true, "style": "deepObject" }, "customer_balance": { "explode": true, "style": "deepObject" }, "eps": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "fpx": { "explode": true, "style": "deepObject" }, "giropay": { "explode": true, "style": "deepObject" }, "gopay": { "explode": true, "style": "deepObject" }, "grabpay": { "explode": true, "style": "deepObject" }, "id_bank_transfer": { "explode": true, "style": "deepObject" }, "ideal": { "explode": true, "style": "deepObject" }, "interac_present": { "explode": true, "style": "deepObject" }, "kakao_pay": { "explode": true, "style": "deepObject" }, "klarna": { "explode": true, "style": "deepObject" }, "konbini": { "explode": true, "style": "deepObject" }, "kr_card": { "explode": true, "style": "deepObject" }, "link": { "explode": true, "style": "deepObject" }, "mb_way": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "mobilepay": { "explode": true, "style": "deepObject" }, "multibanco": { "explode": true, "style": "deepObject" }, "naver_pay": { "explode": true, "style": "deepObject" }, "nz_bank_account": { "explode": true, "style": "deepObject" }, "oxxo": { "explode": true, "style": "deepObject" }, "p24": { "explode": true, "style": "deepObject" }, "pay_by_bank": { "explode": true, "style": "deepObject" }, "payco": { "explode": true, "style": "deepObject" }, "paynow": { "explode": true, "style": "deepObject" }, "paypal": { "explode": true, "style": "deepObject" }, "paypay": { "explode": true, "style": "deepObject" }, "payto": { "explode": true, "style": "deepObject" }, "pix": { "explode": true, "style": "deepObject" }, "promptpay": { "explode": true, "style": "deepObject" }, "qris": { "explode": true, "style": "deepObject" }, "radar_options": { "explode": true, "style": "deepObject" }, "rechnung": { "explode": true, "style": "deepObject" }, "revolut_pay": { "explode": true, "style": "deepObject" }, "samsung_pay": { "explode": true, "style": "deepObject" }, "satispay": { "explode": true, "style": "deepObject" }, "sepa_debit": { "explode": true, "style": "deepObject" }, "shopeepay": { "explode": true, "style": "deepObject" }, "sofort": { "explode": true, "style": "deepObject" }, "stripe_balance": { "explode": true, "style": "deepObject" }, "swish": { "explode": true, "style": "deepObject" }, "twint": { "explode": true, "style": "deepObject" }, "us_bank_account": { "explode": true, "style": "deepObject" }, "wechat_pay": { "explode": true, "style": "deepObject" }, "zip": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "acss_debit": { "description": "If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method.", "properties": { "account_number": { "description": "Customer's bank account number.", "maxLength": 5000, "type": "string" }, "institution_number": { "description": "Institution number of the customer's bank.", "maxLength": 5000, "type": "string" }, "transit_number": { "description": "Transit number of the customer's bank.", "maxLength": 5000, "type": "string" } }, "required": [ "account_number", "institution_number", "transit_number" ], "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "account_number", "financial_connections_account", "institution_number", "transit_number" ] }, "affirm": { "description": "If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method.", "properties": {}, "title": "param", "type": "object" }, "afterpay_clearpay": { "description": "If this is an `AfterpayClearpay` PaymentMethod, this hash contains details about the AfterpayClearpay payment method.", "properties": {}, "title": "param", "type": "object" }, "alipay": { "description": "If this is an `Alipay` PaymentMethod, this hash contains details about the Alipay payment method.", "properties": {}, "title": "param", "type": "object" }, "allow_redisplay": { "description": "This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to `unspecified`.", "enum": [ "always", "limited", "unspecified" ], "type": "string" }, "alma": { "description": "If this is a Alma PaymentMethod, this hash contains details about the Alma payment method.", "properties": {}, "title": "param", "type": "object" }, "amazon_pay": { "description": "If this is a AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method.", "properties": {}, "title": "param", "type": "object" }, "au_becs_debit": { "description": "If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account.", "properties": { "account_number": { "description": "The account number for the bank account.", "maxLength": 5000, "type": "string" }, "bsb_number": { "description": "Bank-State-Branch number of the bank account.", "maxLength": 5000, "type": "string" } }, "required": [ "account_number", "bsb_number" ], "title": "param", "type": "object", "x-stripeMostCommon": [ "account_number", "bsb_number" ] }, "bacs_debit": { "description": "If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.", "properties": { "account_number": { "description": "Account number of the bank account that the funds will be debited from.", "maxLength": 5000, "type": "string" }, "sort_code": { "description": "Sort code of the bank account. (e.g., `10-20-30`)", "maxLength": 5000, "type": "string" } }, "title": "param", "type": "object", "x-stripeMostCommon": [ "account_number", "sort_code" ] }, "bancontact": { "description": "If this is a `bancontact` PaymentMethod, this hash contains details about the Bancontact payment method.", "properties": {}, "title": "param", "type": "object" }, "billie": { "description": "If this is a `billie` PaymentMethod, this hash contains details about the Billie payment method.", "properties": {}, "title": "param", "type": "object" }, "billing_details": { "description": "Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.", "properties": { "address": { "anyOf": [ { "properties": { "city": { "description": "City, district, suburb, town, or village.", "maxLength": 5000, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Address line 1 (e.g., street, PO Box, or company name).", "maxLength": 5000, "type": "string" }, "line2": { "description": "Address line 2 (e.g., apartment, suite, unit, or building).", "maxLength": 5000, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "State, county, province, or region.", "maxLength": 5000, "type": "string" } }, "title": "billing_details_address", "type": "object", "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Billing address." }, "email": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Email address." }, "name": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Full name." }, "phone": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Billing phone number (including extension)." }, "tax_id": { "description": "Taxpayer identification number. Used only for transactions between LATAM buyers and non-LATAM sellers.", "maxLength": 5000, "type": "string" } }, "title": "billing_details_inner_params", "type": "object", "x-stripeMostCommon": [ "address", "email", "name", "phone", "tax_id" ] }, "blik": { "description": "If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.", "properties": {}, "title": "param", "type": "object" }, "boleto": { "description": "If this is a `boleto` PaymentMethod, this hash contains details about the Boleto payment method.", "properties": { "tax_id": { "description": "The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers)", "maxLength": 5000, "type": "string" } }, "required": [ "tax_id" ], "title": "param", "type": "object", "x-stripeMostCommon": [ "tax_id" ] }, "card": { "anyOf": [ { "properties": { "cvc": { "description": "The card's CVC. It is highly recommended to always include this value.", "maxLength": 5000, "type": "string" }, "exp_month": { "description": "Two-digit number representing the card's expiration month.", "type": "integer" }, "exp_year": { "description": "Four-digit number representing the card's expiration year.", "type": "integer" }, "networks": { "description": "Contains information about card networks used to process the payment.", "properties": { "preferred": { "description": "The customer's preferred card network for co-branded cards. Supports `cartes_bancaires`, `mastercard`, or `visa`. Selection of a network that does not apply to the card will be stored as `invalid_preference` on the card.", "enum": [ "cartes_bancaires", "mastercard", "visa" ], "type": "string" } }, "title": "networks_params", "type": "object", "x-stripeMostCommon": [ "preferred" ] }, "number": { "description": "The card number, as a string without any separators.", "maxLength": 5000, "type": "string" } }, "required": [ "exp_month", "exp_year", "number" ], "title": "card_details_params", "type": "object", "x-stripeMostCommon": [ "cvc", "exp_month", "exp_year", "funding_options", "managed_credential", "networks", "number" ], "x-stripeParam": { "class_name": "CardDetails" } }, { "properties": { "token": { "description": "For backwards compatibility, you can alternatively provide a Stripe token (e.g., for Apple Pay, Amex Express Checkout, or legacy Checkout) into the card hash with format card: {token: \"tok_visa\"}.", "maxLength": 5000, "type": "string" } }, "required": [ "token" ], "title": "token_params", "type": "object", "x-stripeMostCommon": [ "token" ], "x-stripeParam": { "class_name": "Token" } } ], "description": "If this is a `card` PaymentMethod, this hash contains the user's card details. For backwards compatibility, you can alternatively provide a Stripe token (e.g., for Apple Pay, Amex Express Checkout, or legacy Checkout) into the card hash with format `card: {token: \"tok_visa\"}`. When providing a card number, you must meet the requirements for [PCI compliance](https://stripe.com/docs/security#validating-pci-compliance). We strongly recommend using Stripe.js instead of interacting with this API directly.", "x-stripeBypassValidation": true }, "cashapp": { "description": "If this is a `cashapp` PaymentMethod, this hash contains details about the Cash App Pay payment method.", "properties": {}, "title": "param", "type": "object" }, "crypto": { "description": "If this is a Crypto PaymentMethod, this hash contains details about the Crypto payment method.", "properties": {}, "title": "param", "type": "object" }, "customer": { "description": "The `Customer` to whom the original PaymentMethod is attached.", "maxLength": 5000, "type": "string" }, "customer_balance": { "description": "If this is a `customer_balance` PaymentMethod, this hash contains details about the CustomerBalance payment method.", "properties": {}, "title": "param", "type": "object" }, "eps": { "description": "If this is an `eps` PaymentMethod, this hash contains details about the EPS payment method.", "properties": { "bank": { "description": "The customer's bank.", "enum": [ "arzte_und_apotheker_bank", "austrian_anadi_bank_ag", "bank_austria", "bankhaus_carl_spangler", "bankhaus_schelhammer_und_schattera_ag", "bawag_psk_ag", "bks_bank_ag", "brull_kallmus_bank_ag", "btv_vier_lander_bank", "capital_bank_grawe_gruppe_ag", "deutsche_bank_ag", "dolomitenbank", "easybank_ag", "erste_bank_und_sparkassen", "hypo_alpeadriabank_international_ag", "hypo_bank_burgenland_aktiengesellschaft", "hypo_noe_lb_fur_niederosterreich_u_wien", "hypo_oberosterreich_salzburg_steiermark", "hypo_tirol_bank_ag", "hypo_vorarlberg_bank_ag", "marchfelder_bank", "oberbank_ag", "raiffeisen_bankengruppe_osterreich", "schoellerbank_ag", "sparda_bank_wien", "volksbank_gruppe", "volkskreditbank_ag", "vr_bank_braunau" ], "maxLength": 5000, "type": "string" } }, "title": "param", "type": "object", "x-stripeMostCommon": [ "bank" ] }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "fpx": { "description": "If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method.", "properties": { "account_holder_type": { "description": "Account holder type for FPX transaction", "enum": [ "company", "individual" ], "maxLength": 5000, "type": "string" }, "bank": { "description": "The customer's bank.", "enum": [ "affin_bank", "agrobank", "alliance_bank", "ambank", "bank_islam", "bank_muamalat", "bank_of_china", "bank_rakyat", "bsn", "cimb", "deutsche_bank", "hong_leong_bank", "hsbc", "kfh", "maybank2e", "maybank2u", "ocbc", "pb_enterprise", "public_bank", "rhb", "standard_chartered", "uob" ], "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true } }, "required": [ "bank" ], "title": "param", "type": "object", "x-stripeMostCommon": [ "account_holder_type", "bank" ] }, "giropay": { "description": "If this is a `giropay` PaymentMethod, this hash contains details about the Giropay payment method.", "properties": {}, "title": "param", "type": "object" }, "gopay": { "description": "If this is a Gopay PaymentMethod, this hash contains details about the Gopay payment method.", "properties": {}, "title": "param", "type": "object" }, "grabpay": { "description": "If this is a `grabpay` PaymentMethod, this hash contains details about the GrabPay payment method.", "properties": {}, "title": "param", "type": "object" }, "id_bank_transfer": { "description": "If this is an `IdBankTransfer` PaymentMethod, this hash contains details about the IdBankTransfer payment method.", "properties": { "bank": { "description": "Bank where the account is held.", "enum": [ "bca", "bni", "bri", "cimb", "permata" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "param", "type": "object", "x-stripeMostCommon": [ "bank" ] }, "ideal": { "description": "If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method.", "properties": { "bank": { "description": "The customer's bank. Only use this parameter for existing customers. Don't use it for new customers.", "enum": [ "abn_amro", "asn_bank", "bunq", "buut", "handelsbanken", "ing", "knab", "moneyou", "n26", "nn", "rabobank", "regiobank", "revolut", "sns_bank", "triodos_bank", "van_lanschot", "yoursafe" ], "maxLength": 5000, "type": "string" } }, "title": "param", "type": "object", "x-stripeMostCommon": [ "bank" ] }, "interac_present": { "description": "If this is an `interac_present` PaymentMethod, this hash contains details about the Interac Present payment method.", "properties": {}, "title": "param", "type": "object", "x-stripeMostCommon": [ "device_identifier", "device_type", "emv", "location" ] }, "kakao_pay": { "description": "If this is a `kakao_pay` PaymentMethod, this hash contains details about the Kakao Pay payment method.", "properties": {}, "title": "param", "type": "object" }, "klarna": { "description": "If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method.", "properties": { "dob": { "description": "Customer's date of birth", "properties": { "day": { "description": "The day of birth, between 1 and 31.", "type": "integer" }, "month": { "description": "The month of birth, between 1 and 12.", "type": "integer" }, "year": { "description": "The four-digit year of birth.", "type": "integer" } }, "required": [ "day", "month", "year" ], "title": "date_of_birth", "type": "object", "x-stripeMostCommon": [ "day", "month", "year" ] } }, "title": "param", "type": "object", "x-stripeMostCommon": [ "dob" ] }, "konbini": { "description": "If this is a `konbini` PaymentMethod, this hash contains details about the Konbini payment method.", "properties": {}, "title": "param", "type": "object" }, "kr_card": { "description": "If this is a `kr_card` PaymentMethod, this hash contains details about the Korean Card payment method.", "properties": {}, "title": "param", "type": "object" }, "link": { "description": "If this is an `Link` PaymentMethod, this hash contains details about the Link payment method.", "properties": {}, "title": "param", "type": "object" }, "mb_way": { "description": "If this is a MB WAY PaymentMethod, this hash contains details about the MB WAY payment method.", "properties": {}, "title": "param", "type": "object" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "mobilepay": { "description": "If this is a `mobilepay` PaymentMethod, this hash contains details about the MobilePay payment method.", "properties": {}, "title": "param", "type": "object" }, "multibanco": { "description": "If this is a `multibanco` PaymentMethod, this hash contains details about the Multibanco payment method.", "properties": {}, "title": "param", "type": "object" }, "naver_pay": { "description": "If this is a `naver_pay` PaymentMethod, this hash contains details about the Naver Pay payment method.", "properties": { "funding": { "description": "Whether to use Naver Pay points or a card to fund this transaction. If not provided, this defaults to `card`.", "enum": [ "card", "points" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "param", "type": "object", "x-stripeMostCommon": [ "funding" ] }, "nz_bank_account": { "description": "If this is an nz_bank_account PaymentMethod, this hash contains details about the nz_bank_account payment method.", "properties": { "account_holder_name": { "description": "The name on the bank account. Only required if the account holder name is different from the name of the authorized signatory collected in the PaymentMethod’s billing details.", "maxLength": 5000, "type": "string" }, "account_number": { "description": "The account number for the bank account.", "maxLength": 5000, "type": "string" }, "bank_code": { "description": "The numeric code for the bank account's bank.", "maxLength": 5000, "type": "string" }, "branch_code": { "description": "The numeric code for the bank account's bank branch.", "maxLength": 5000, "type": "string" }, "reference": { "maxLength": 128, "type": "string" }, "suffix": { "description": "The suffix of the bank account number.", "maxLength": 5000, "type": "string" } }, "required": [ "account_number", "bank_code", "branch_code", "suffix" ], "title": "param", "type": "object", "x-stripeMostCommon": [ "account_holder_name", "account_number", "bank_code", "branch_code", "reference", "suffix" ] }, "oxxo": { "description": "If this is an `oxxo` PaymentMethod, this hash contains details about the OXXO payment method.", "properties": {}, "title": "param", "type": "object" }, "p24": { "description": "If this is a `p24` PaymentMethod, this hash contains details about the P24 payment method.", "properties": { "bank": { "description": "The customer's bank.", "enum": [ "alior_bank", "bank_millennium", "bank_nowy_bfg_sa", "bank_pekao_sa", "banki_spbdzielcze", "blik", "bnp_paribas", "boz", "citi_handlowy", "credit_agricole", "envelobank", "etransfer_pocztowy24", "getin_bank", "ideabank", "ing", "inteligo", "mbank_mtransfer", "nest_przelew", "noble_pay", "pbac_z_ipko", "plus_bank", "santander_przelew24", "tmobile_usbugi_bankowe", "toyota_bank", "velobank", "volkswagen_bank" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "param", "type": "object", "x-stripeMostCommon": [ "bank" ] }, "pay_by_bank": { "description": "If this is a `pay_by_bank` PaymentMethod, this hash contains details about the PayByBank payment method.", "properties": {}, "title": "param", "type": "object" }, "payco": { "description": "If this is a `payco` PaymentMethod, this hash contains details about the PAYCO payment method.", "properties": {}, "title": "param", "type": "object" }, "payment_method": { "description": "The PaymentMethod to share.", "maxLength": 5000, "type": "string" }, "paynow": { "description": "If this is a `paynow` PaymentMethod, this hash contains details about the PayNow payment method.", "properties": {}, "title": "param", "type": "object" }, "paypal": { "description": "If this is a `paypal` PaymentMethod, this hash contains details about the PayPal payment method.", "properties": {}, "title": "param", "type": "object" }, "paypay": { "description": "If this is a `paypay` PaymentMethod, this hash contains details about the PayPay payment method.", "properties": {}, "title": "param", "type": "object" }, "payto": { "description": "If this is a `payto` PaymentMethod, this hash contains details about the PayTo payment method.", "properties": { "account_number": { "description": "The account number for the bank account.", "maxLength": 5000, "type": "string" }, "bsb_number": { "description": "Bank-State-Branch number of the bank account.", "maxLength": 5000, "type": "string" }, "pay_id": { "description": "The PayID alias for the bank account.", "maxLength": 5000, "type": "string" } }, "title": "param", "type": "object", "x-stripeMostCommon": [ "account_number", "bsb_number", "pay_id" ] }, "pix": { "description": "If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.", "properties": {}, "title": "param", "type": "object", "x-stripeMostCommon": [ "tax_id" ] }, "promptpay": { "description": "If this is a `promptpay` PaymentMethod, this hash contains details about the PromptPay payment method.", "properties": {}, "title": "param", "type": "object" }, "qris": { "description": "If this is a `qris` PaymentMethod, this hash contains details about the QRIS payment method.", "properties": {}, "title": "param", "type": "object" }, "radar_options": { "description": "Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.", "properties": { "session": { "description": "A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.", "maxLength": 5000, "type": "string" } }, "title": "radar_options_with_hidden_options", "type": "object", "x-stripeMostCommon": [ "session", "skip_rules" ] }, "rechnung": { "description": "If this is a `rechnung` PaymentMethod, this hash contains details about the Rechnung payment method.", "properties": { "dob": { "description": "Customer's date of birth", "properties": { "day": { "description": "The day of birth, between 1 and 31.", "type": "integer" }, "month": { "description": "The month of birth, between 1 and 12.", "type": "integer" }, "year": { "description": "The four-digit year of birth.", "type": "integer" } }, "required": [ "day", "month", "year" ], "title": "date_of_birth", "type": "object", "x-stripeMostCommon": [ "day", "month", "year" ] } }, "required": [ "dob" ], "title": "param", "type": "object", "x-stripeMostCommon": [ "dob" ] }, "revolut_pay": { "description": "If this is a `revolut_pay` PaymentMethod, this hash contains details about the Revolut Pay payment method.", "properties": {}, "title": "param", "type": "object" }, "samsung_pay": { "description": "If this is a `samsung_pay` PaymentMethod, this hash contains details about the SamsungPay payment method.", "properties": {}, "title": "param", "type": "object" }, "satispay": { "description": "If this is a `satispay` PaymentMethod, this hash contains details about the Satispay payment method.", "properties": {}, "title": "param", "type": "object" }, "sepa_debit": { "description": "If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account.", "properties": { "iban": { "description": "IBAN of the bank account.", "maxLength": 5000, "type": "string" } }, "required": [ "iban" ], "title": "param", "type": "object", "x-stripeMostCommon": [ "iban" ] }, "shopeepay": { "description": "If this is a Shopeepay PaymentMethod, this hash contains details about the Shopeepay payment method.", "properties": {}, "title": "param", "type": "object" }, "sofort": { "description": "If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.", "properties": { "country": { "description": "Two-letter ISO code representing the country the bank account is located in.", "enum": [ "AT", "BE", "DE", "ES", "IT", "NL" ], "type": "string" } }, "required": [ "country" ], "title": "param", "type": "object", "x-stripeMostCommon": [ "country" ] }, "stripe_balance": { "description": "This hash contains details about the Stripe balance payment method.", "properties": { "account": { "description": "The connected account ID whose Stripe balance to use as the source of payment", "maxLength": 5000, "type": "string" }, "source_type": { "description": "The [source_type](https://docs.stripe.com/api/balance/balance_object#balance_object-available-source_types) of the balance", "enum": [ "bank_account", "card", "fpx" ], "type": "string" } }, "title": "param", "type": "object", "x-stripeMostCommon": [ "account", "source_type" ] }, "swish": { "description": "If this is a `swish` PaymentMethod, this hash contains details about the Swish payment method.", "properties": {}, "title": "param", "type": "object" }, "twint": { "description": "If this is a TWINT PaymentMethod, this hash contains details about the TWINT payment method.", "properties": {}, "title": "param", "type": "object" }, "type": { "description": "The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.", "enum": [ "acss_debit", "affirm", "afterpay_clearpay", "alipay", "alma", "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", "billie", "blik", "boleto", "card", "cashapp", "crypto", "customer_balance", "eps", "fpx", "giropay", "gopay", "grabpay", "id_bank_transfer", "ideal", "kakao_pay", "klarna", "konbini", "kr_card", "link", "mb_way", "mobilepay", "multibanco", "naver_pay", "nz_bank_account", "oxxo", "p24", "pay_by_bank", "payco", "paynow", "paypal", "paypay", "payto", "pix", "promptpay", "qris", "rechnung", "revolut_pay", "samsung_pay", "satispay", "sepa_debit", "shopeepay", "sofort", "stripe_balance", "swish", "twint", "us_bank_account", "wechat_pay", "zip" ], "type": "string", "x-stripeBypassValidation": true }, "us_bank_account": { "description": "If this is an `us_bank_account` PaymentMethod, this hash contains details about the US bank account payment method.", "properties": { "account_holder_type": { "description": "Account holder type: individual or company.", "enum": [ "company", "individual" ], "type": "string" }, "account_number": { "description": "Account number of the bank account.", "maxLength": 5000, "type": "string" }, "account_type": { "description": "Account type: checkings or savings. Defaults to checking if omitted.", "enum": [ "checking", "savings" ], "type": "string" }, "financial_connections_account": { "description": "The ID of a Financial Connections Account to use as a payment method.", "maxLength": 5000, "type": "string" }, "routing_number": { "description": "Routing number of the bank account.", "maxLength": 5000, "type": "string" } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "account_holder_type", "account_number", "account_type", "financial_connections_account", "routing_number" ] }, "wechat_pay": { "description": "If this is an `wechat_pay` PaymentMethod, this hash contains details about the wechat_pay payment method.", "properties": {}, "title": "param", "type": "object" }, "zip": { "description": "If this is a `zip` PaymentMethod, this hash contains details about the Zip payment method.", "properties": {}, "title": "param", "type": "object" } }, "type": "object", "x-stripeMostCommon": [ "billing_details", "customer", "metadata", "payment_method", "type" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_method" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Shares a PaymentMethod" } }, "/v1/payment_methods/{payment_method}": { "get": { "description": "

Retrieves a PaymentMethod object attached to the StripeAccount. To retrieve a payment method attached to a Customer, you should use Retrieve a Customer’s PaymentMethods

", "operationId": "GetPaymentMethodsPaymentMethod", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "payment_method", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_method" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a PaymentMethod" }, "post": { "description": "

Updates a PaymentMethod object. A PaymentMethod must be attached to a customer to be updated.

", "operationId": "PostPaymentMethodsPaymentMethod", "parameters": [ { "in": "path", "name": "payment_method", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "billing_details": { "explode": true, "style": "deepObject" }, "card": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "payto": { "explode": true, "style": "deepObject" }, "us_bank_account": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "allow_redisplay": { "description": "This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to `unspecified`.", "enum": [ "always", "limited", "unspecified" ], "type": "string" }, "billing_details": { "description": "Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.", "properties": { "address": { "anyOf": [ { "properties": { "city": { "description": "City, district, suburb, town, or village.", "maxLength": 5000, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Address line 1 (e.g., street, PO Box, or company name).", "maxLength": 5000, "type": "string" }, "line2": { "description": "Address line 2 (e.g., apartment, suite, unit, or building).", "maxLength": 5000, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "State, county, province, or region.", "maxLength": 5000, "type": "string" } }, "title": "billing_details_address", "type": "object", "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Billing address." }, "email": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Email address." }, "name": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Full name." }, "phone": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Billing phone number (including extension)." }, "tax_id": { "description": "Taxpayer identification number. Used only for transactions between LATAM buyers and non-LATAM sellers.", "maxLength": 5000, "type": "string" } }, "title": "billing_details_inner_params", "type": "object", "x-stripeMostCommon": [ "address", "email", "name", "phone", "tax_id" ] }, "card": { "description": "If this is a `card` PaymentMethod, this hash contains the user's card details.", "properties": { "exp_month": { "description": "Two-digit number representing the card's expiration month.", "type": "integer" }, "exp_year": { "description": "Four-digit number representing the card's expiration year.", "type": "integer" }, "networks": { "description": "Contains information about card networks used to process the payment.", "properties": { "preferred": { "description": "The customer's preferred card network for co-branded cards. Supports `cartes_bancaires`, `mastercard`, or `visa`. Selection of a network that does not apply to the card will be stored as `invalid_preference` on the card.", "enum": [ "", "cartes_bancaires", "mastercard", "visa" ], "type": "string" } }, "title": "networks_update_api_param", "type": "object", "x-stripeMostCommon": [ "preferred" ] } }, "title": "update_api_param", "type": "object", "x-stripeMostCommon": [ "exp_month", "exp_year", "networks" ] }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "payto": { "description": "If this is a `payto` PaymentMethod, this hash contains details about the PayTo payment method.", "properties": { "account_number": { "description": "The account number for the bank account.", "maxLength": 5000, "type": "string" }, "bsb_number": { "description": "Bank-State-Branch number of the bank account.", "maxLength": 5000, "type": "string" }, "pay_id": { "description": "The PayID alias for the bank account.", "maxLength": 5000, "type": "string" } }, "title": "param", "type": "object", "x-stripeMostCommon": [ "account_number", "bsb_number", "pay_id" ] }, "us_bank_account": { "description": "If this is an `us_bank_account` PaymentMethod, this hash contains details about the US bank account payment method.", "properties": { "account_holder_type": { "description": "Bank account holder type.", "enum": [ "company", "individual" ], "type": "string" }, "account_type": { "description": "Bank account type.", "enum": [ "checking", "savings" ], "type": "string" } }, "title": "update_param", "type": "object", "x-stripeMostCommon": [ "account_holder_type", "account_type" ] } }, "type": "object", "x-stripeMostCommon": [ "billing_details", "metadata" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_method" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a PaymentMethod" } }, "/v1/payment_methods/{payment_method}/attach": { "post": { "description": "

Attaches a PaymentMethod object to a Customer.

\n\n

To attach a new PaymentMethod to a customer for future payments, we recommend you use a SetupIntent\nor a PaymentIntent with setup_future_usage.\nThese approaches will perform any necessary steps to set up the PaymentMethod for future payments. Using the /v1/payment_methods/:id/attach\nendpoint without first using a SetupIntent or PaymentIntent with setup_future_usage does not optimize the PaymentMethod for\nfuture use, which makes later declines and payment friction more likely.\nSee Optimizing cards for future payments for more information about setting up\nfuture payments.

\n\n

To use this PaymentMethod as the default for invoice or subscription payments,\nset invoice_settings.default_payment_method,\non the Customer to the PaymentMethod’s ID.

", "operationId": "PostPaymentMethodsPaymentMethodAttach", "parameters": [ { "in": "path", "name": "payment_method", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "customer": { "description": "The ID of the customer to which to attach the PaymentMethod.", "maxLength": 5000, "type": "string" }, "customer_account": { "description": "The ID of the account to which to attach the PaymentMethod.", "maxLength": 5000, "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object", "x-stripeMostCommon": [ "customer" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_method" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Attach a PaymentMethod to a Customer" } }, "/v1/payment_methods/{payment_method}/detach": { "post": { "description": "

Detaches a PaymentMethod object from a Customer. After a PaymentMethod is detached, it can no longer be used for a payment or re-attached to a Customer.

", "operationId": "PostPaymentMethodsPaymentMethodDetach", "parameters": [ { "in": "path", "name": "payment_method", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_method" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Detach a PaymentMethod from a Customer" } }, "/v1/payment_records/report_payment": { "post": { "description": "

Report a new Payment Record. You may report a Payment Record as it is\n initialized and later report updates through the other report_* methods, or report Payment\n Records in a terminal state directly, through this method.

", "operationId": "PostPaymentRecordsReportPayment", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "amount_requested": { "explode": true, "style": "deepObject" }, "customer_details": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "failed": { "explode": true, "style": "deepObject" }, "guaranteed": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "payment_method_details": { "explode": true, "style": "deepObject" }, "processor_details": { "explode": true, "style": "deepObject" }, "shipping_details": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "amount_requested": { "description": "The amount you initially requested for this payment.", "properties": { "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "value": { "description": "A positive integer representing the amount in the currency's [minor unit](https://stripe.com/docs/currencies#zero-decimal). For example, `100` can represent 1 USD or 100 JPY.", "type": "integer" } }, "required": [ "currency", "value" ], "title": "amount", "type": "object", "x-stripeMostCommon": [ "currency", "value" ] }, "customer_details": { "description": "Customer information for this payment.", "properties": { "customer": { "description": "The customer who made the payment.", "maxLength": 5000, "type": "string" }, "email": { "description": "The customer's phone number.", "type": "string" }, "name": { "description": "The customer's name.", "maxLength": 5000, "type": "string" }, "phone": { "description": "The customer's phone number.", "type": "string" } }, "title": "customer_details", "type": "object", "x-stripeMostCommon": [ "customer", "email", "name", "phone" ] }, "customer_presence": { "description": "Indicates whether the customer was present in your checkout flow during this payment.", "enum": [ "off_session", "on_session" ], "type": "string" }, "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users.", "maxLength": 5000, "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "failed": { "description": "Information about the payment attempt failure.", "properties": { "failed_at": { "description": "When the reported payment failed. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" } }, "required": [ "failed_at" ], "title": "failed", "type": "object", "x-stripeMostCommon": [ "failed_at" ] }, "guaranteed": { "description": "Information about the payment attempt guarantee.", "properties": { "guaranteed_at": { "description": "When the reported payment was guaranteed. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" } }, "required": [ "guaranteed_at" ], "title": "guaranteed", "type": "object", "x-stripeMostCommon": [ "amount", "final_capture", "guaranteed_at" ] }, "initiated_at": { "description": "When the reported payment was initiated. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "outcome": { "description": "The outcome of the reported payment.", "enum": [ "failed", "guaranteed" ], "type": "string" }, "payment_method_details": { "description": "Information about the Payment Method debited for this payment.", "properties": { "billing_details": { "description": "The billing details associated with the method of payment.", "properties": { "address": { "description": "The billing address associated with the method of payment.", "properties": { "city": { "description": "City, district, suburb, town, or village.", "maxLength": 5000, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Address line 1 (e.g., street, PO Box, or company name).", "maxLength": 5000, "type": "string" }, "line2": { "description": "Address line 2 (e.g., apartment, suite, unit, or building).", "maxLength": 5000, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "State, county, province, or region.", "maxLength": 5000, "type": "string" } }, "title": "address", "type": "object", "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state" ] }, "email": { "description": "The billing email associated with the method of payment.", "type": "string" }, "name": { "description": "The billing name associated with the method of payment.", "maxLength": 5000, "type": "string" }, "phone": { "description": "The billing phone number associated with the method of payment.", "type": "string" } }, "title": "billing_details", "type": "object", "x-stripeMostCommon": [ "address", "email", "name", "phone" ] }, "custom": { "description": "Information about the custom (user-defined) payment method used to make this payment.", "properties": { "display_name": { "description": "Display name for the custom (user-defined) payment method type used to make this payment.", "maxLength": 5000, "type": "string" }, "type": { "description": "The custom payment method type associated with this payment.", "maxLength": 5000, "type": "string" } }, "title": "custom", "type": "object", "x-stripeMostCommon": [ "display_name", "type" ] }, "payment_method": { "description": "ID of the Stripe Payment Method used to make this payment.", "maxLength": 5000, "type": "string" }, "type": { "description": "The type of the payment method details. An additional hash is included on the payment_method_details with a name matching this value. It contains additional information specific to the type.", "enum": [ "custom" ], "type": "string" } }, "title": "payment_method_details", "type": "object", "x-stripeMostCommon": [ "billing_details", "custom", "payment_method", "shared_payment_granted_token", "type" ] }, "processor_details": { "description": "Processor information for this payment.", "properties": { "custom": { "description": "Information about the custom processor used to make this payment.", "properties": { "payment_reference": { "description": "An opaque string for manual reconciliation of this payment, for example a check number or a payment processor ID.", "maxLength": 5000, "type": "string" } }, "required": [ "payment_reference" ], "title": "custom", "type": "object", "x-stripeMostCommon": [ "payment_reference" ] }, "type": { "description": "The type of the processor details. An additional hash is included on processor_details with a name matching this value. It contains additional information specific to the processor.", "enum": [ "custom" ], "type": "string" } }, "required": [ "type" ], "title": "processor_details", "type": "object", "x-stripeMostCommon": [ "custom", "type" ] }, "shipping_details": { "description": "Shipping information for this payment.", "properties": { "address": { "description": "The physical shipping address.", "properties": { "city": { "description": "City, district, suburb, town, or village.", "maxLength": 5000, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Address line 1 (e.g., street, PO Box, or company name).", "maxLength": 5000, "type": "string" }, "line2": { "description": "Address line 2 (e.g., apartment, suite, unit, or building).", "maxLength": 5000, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "State, county, province, or region.", "maxLength": 5000, "type": "string" } }, "title": "address", "type": "object", "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state" ] }, "name": { "description": "The shipping recipient's name.", "maxLength": 5000, "type": "string" }, "phone": { "description": "The shipping recipient's phone number.", "type": "string" } }, "title": "shipping_details", "type": "object", "x-stripeMostCommon": [ "address", "name", "phone" ] } }, "required": [ "amount_requested", "initiated_at", "payment_method_details" ], "type": "object", "x-stripeMostCommon": [ "amount_requested", "customer_details", "customer_presence", "description", "failed", "guaranteed", "initiated_at", "metadata", "outcome", "payment_method_details", "processor_details", "shipping_details" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_record" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Report a payment" } }, "/v1/payment_records/{id}": { "get": { "description": "

Retrieves a Payment Record with the given ID

", "operationId": "GetPaymentRecordsId", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "The ID of the Payment Record.", "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_record" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a Payment Record" } }, "/v1/payment_records/{id}/report_payment_attempt": { "post": { "description": "

Report a new payment attempt on the specified Payment Record. A new payment\n attempt can only be specified if all other payment attempts are canceled or failed.

", "operationId": "PostPaymentRecordsIdReportPaymentAttempt", "parameters": [ { "description": "The ID of the Payment Record.", "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "failed": { "explode": true, "style": "deepObject" }, "guaranteed": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "payment_method_details": { "explode": true, "style": "deepObject" }, "shipping_details": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users.", "maxLength": 5000, "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "failed": { "description": "Information about the payment attempt failure.", "properties": { "failed_at": { "description": "When the reported payment failed. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" } }, "required": [ "failed_at" ], "title": "failed", "type": "object", "x-stripeMostCommon": [ "failed_at" ] }, "guaranteed": { "description": "Information about the payment attempt guarantee.", "properties": { "guaranteed_at": { "description": "When the reported payment was guaranteed. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" } }, "required": [ "guaranteed_at" ], "title": "guaranteed", "type": "object", "x-stripeMostCommon": [ "amount", "final_capture", "guaranteed_at" ] }, "initiated_at": { "description": "When the reported payment was initiated. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "outcome": { "description": "The outcome of the reported payment.", "enum": [ "failed", "guaranteed" ], "type": "string" }, "payment_method_details": { "description": "Information about the Payment Method debited for this payment.", "properties": { "billing_details": { "description": "The billing details associated with the method of payment.", "properties": { "address": { "description": "The billing address associated with the method of payment.", "properties": { "city": { "description": "City, district, suburb, town, or village.", "maxLength": 5000, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Address line 1 (e.g., street, PO Box, or company name).", "maxLength": 5000, "type": "string" }, "line2": { "description": "Address line 2 (e.g., apartment, suite, unit, or building).", "maxLength": 5000, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "State, county, province, or region.", "maxLength": 5000, "type": "string" } }, "title": "address", "type": "object", "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state" ] }, "email": { "description": "The billing email associated with the method of payment.", "type": "string" }, "name": { "description": "The billing name associated with the method of payment.", "maxLength": 5000, "type": "string" }, "phone": { "description": "The billing phone number associated with the method of payment.", "type": "string" } }, "title": "billing_details", "type": "object", "x-stripeMostCommon": [ "address", "email", "name", "phone" ] }, "custom": { "description": "Information about the custom (user-defined) payment method used to make this payment.", "properties": { "display_name": { "description": "Display name for the custom (user-defined) payment method type used to make this payment.", "maxLength": 5000, "type": "string" }, "type": { "description": "The custom payment method type associated with this payment.", "maxLength": 5000, "type": "string" } }, "title": "custom", "type": "object", "x-stripeMostCommon": [ "display_name", "type" ] }, "payment_method": { "description": "ID of the Stripe Payment Method used to make this payment.", "maxLength": 5000, "type": "string" }, "type": { "description": "The type of the payment method details. An additional hash is included on the payment_method_details with a name matching this value. It contains additional information specific to the type.", "enum": [ "custom" ], "type": "string" } }, "title": "payment_method_details", "type": "object", "x-stripeMostCommon": [ "billing_details", "custom", "payment_method", "shared_payment_granted_token", "type" ] }, "shipping_details": { "description": "Shipping information for this payment.", "properties": { "address": { "description": "The physical shipping address.", "properties": { "city": { "description": "City, district, suburb, town, or village.", "maxLength": 5000, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Address line 1 (e.g., street, PO Box, or company name).", "maxLength": 5000, "type": "string" }, "line2": { "description": "Address line 2 (e.g., apartment, suite, unit, or building).", "maxLength": 5000, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "State, county, province, or region.", "maxLength": 5000, "type": "string" } }, "title": "address", "type": "object", "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state" ] }, "name": { "description": "The shipping recipient's name.", "maxLength": 5000, "type": "string" }, "phone": { "description": "The shipping recipient's phone number.", "type": "string" } }, "title": "shipping_details", "type": "object", "x-stripeMostCommon": [ "address", "name", "phone" ] } }, "required": [ "initiated_at" ], "type": "object", "x-stripeMostCommon": [ "description", "failed", "guaranteed", "initiated_at", "metadata", "outcome", "payment_method_details", "shipping_details" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_record" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Report a payment attempt" } }, "/v1/payment_records/{id}/report_payment_attempt_canceled": { "post": { "description": "

Report that the most recent payment attempt on the specified Payment Record\n was canceled.

", "operationId": "PostPaymentRecordsIdReportPaymentAttemptCanceled", "parameters": [ { "description": "The ID of the Payment Record.", "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "canceled_at": { "description": "When the reported payment was canceled. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ] } }, "required": [ "canceled_at" ], "type": "object", "x-stripeMostCommon": [ "canceled_at", "metadata" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_record" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Report payment attempt canceled" } }, "/v1/payment_records/{id}/report_payment_attempt_failed": { "post": { "description": "

Report that the most recent payment attempt on the specified Payment Record\n failed or errored.

", "operationId": "PostPaymentRecordsIdReportPaymentAttemptFailed", "parameters": [ { "description": "The ID of the Payment Record.", "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "failed_at": { "description": "When the reported payment failed. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ] } }, "required": [ "failed_at" ], "type": "object", "x-stripeMostCommon": [ "failed_at", "metadata" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_record" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Report payment attempt failed" } }, "/v1/payment_records/{id}/report_payment_attempt_guaranteed": { "post": { "description": "

Report that the most recent payment attempt on the specified Payment Record\n was guaranteed.

", "operationId": "PostPaymentRecordsIdReportPaymentAttemptGuaranteed", "parameters": [ { "description": "The ID of the Payment Record.", "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "guaranteed_at": { "description": "When the reported payment was guaranteed. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ] } }, "required": [ "guaranteed_at" ], "type": "object", "x-stripeMostCommon": [ "guaranteed_at", "metadata" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_record" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Report payment attempt guaranteed" } }, "/v1/payouts": { "get": { "description": "

Returns a list of existing payouts sent to third-party bank accounts or payouts that Stripe sent to you. The payouts return in sorted order, with the most recently created payouts appearing first.

", "operationId": "GetPayouts", "parameters": [ { "description": "Only return payouts that are expected to arrive during the given date interval.", "explode": true, "in": "query", "name": "arrival_date", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "description": "Minimum value to filter by (exclusive)", "type": "integer" }, "gte": { "description": "Minimum value to filter by (inclusive)", "type": "integer" }, "lt": { "description": "Maximum value to filter by (exclusive)", "type": "integer" }, "lte": { "description": "Maximum value to filter by (inclusive)", "type": "integer" } }, "title": "range_query_specs", "type": "object", "x-stripeMostCommon": [ "gt", "gte", "lt", "lte" ] }, { "type": "integer" } ] }, "style": "deepObject" }, { "description": "Only return payouts that were created during the given date interval.", "explode": true, "in": "query", "name": "created", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "description": "Minimum value to filter by (exclusive)", "type": "integer" }, "gte": { "description": "Minimum value to filter by (inclusive)", "type": "integer" }, "lt": { "description": "Maximum value to filter by (exclusive)", "type": "integer" }, "lte": { "description": "Maximum value to filter by (inclusive)", "type": "integer" } }, "title": "range_query_specs", "type": "object", "x-stripeMostCommon": [ "gt", "gte", "lt", "lte" ] }, { "type": "integer" } ] }, "style": "deepObject" }, { "description": "The ID of an external account - only return payouts sent to this external account.", "in": "query", "name": "destination", "required": false, "schema": { "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Only return payouts that have the given status: `pending`, `paid`, `failed`, or `canceled`.", "in": "query", "name": "status", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/payout" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/payouts", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "PayoutList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all payouts" }, "post": { "description": "

To send funds to your own bank account, create a new payout object. Your Stripe balance must cover the payout amount. If it doesn’t, you receive an “Insufficient Funds” error.

\n\n

If your API key is in test mode, money won’t actually be sent, though every other action occurs as if you’re in live mode.

\n\n

If you create a manual payout on a Stripe account that uses multiple payment source types, you need to specify the source type balance that the payout draws from. The balance object details available and pending amounts by source type.

", "operationId": "PostPayouts", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "amount": { "description": "A positive integer in cents representing how much to payout.", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users.", "maxLength": 5000, "type": "string" }, "destination": { "description": "The ID of a bank account or a card to send the payout to. If you don't provide a destination, we use the default external account for the specified currency.", "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "method": { "description": "The method used to send this payout, which is `standard` or `instant`. We support `instant` for payouts to debit cards and bank accounts in certain countries. Learn more about [bank support for Instant Payouts](https://stripe.com/docs/payouts/instant-payouts-banks).", "enum": [ "instant", "standard" ], "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true }, "payout_method": { "description": "The ID of a v2 FinancialAccount to send funds to.", "type": "string" }, "source_type": { "description": "The balance type of your Stripe balance to draw this payout from. Balances for different payment sources are kept separately. You can find the amounts with the Balances API. One of `bank_account`, `card`, or `fpx`.", "enum": [ "bank_account", "card", "fpx" ], "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true }, "statement_descriptor": { "description": "A string that displays on the recipient's bank or card statement (up to 22 characters). A `statement_descriptor` that's longer than 22 characters return an error. Most banks truncate this information and display it inconsistently. Some banks might not display it at all.", "maxLength": 22, "type": "string", "x-stripeBypassValidation": true } }, "required": [ "amount", "currency" ], "type": "object", "x-stripeMostCommon": [ "amount", "currency", "description", "metadata", "statement_descriptor" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payout" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a payout" } }, "/v1/payouts/{payout}": { "get": { "description": "

Retrieves the details of an existing payout. Supply the unique payout ID from either a payout creation request or the payout list. Stripe returns the corresponding payout information.

", "operationId": "GetPayoutsPayout", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "payout", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payout" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a payout" }, "post": { "description": "

Updates the specified payout by setting the values of the parameters you pass. We don’t change parameters that you don’t provide. This request only accepts the metadata as arguments.

", "operationId": "PostPayoutsPayout", "parameters": [ { "in": "path", "name": "payout", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." } }, "type": "object", "x-stripeMostCommon": [ "metadata" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payout" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a payout" } }, "/v1/payouts/{payout}/cancel": { "post": { "description": "

You can cancel a previously created payout if its status is pending. Stripe refunds the funds to your available balance. You can’t cancel automatic Stripe payouts.

", "operationId": "PostPayoutsPayoutCancel", "parameters": [ { "in": "path", "name": "payout", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payout" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Cancel a payout" } }, "/v1/payouts/{payout}/reverse": { "post": { "description": "

Reverses a payout by debiting the destination bank account. At this time, you can only reverse payouts for connected accounts to US bank accounts. If the payout is manual and in the pending status, use /v1/payouts/:id/cancel instead.

\n\n

By requesting a reversal through /v1/payouts/:id/reverse, you confirm that the authorized signatory of the selected bank account authorizes the debit on the bank account and that no other authorization is required.

", "operationId": "PostPayoutsPayoutReverse", "parameters": [ { "in": "path", "name": "payout", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" } }, "type": "object", "x-stripeMostCommon": [ "metadata" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payout" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Reverse a payout" } }, "/v1/plans": { "get": { "description": "

Returns a list of your plans.

", "operationId": "GetPlans", "parameters": [ { "description": "Only return plans that are active or inactive (e.g., pass `false` to list all inactive plans).", "in": "query", "name": "active", "required": false, "schema": { "type": "boolean" }, "style": "form" }, { "description": "A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.", "explode": true, "in": "query", "name": "created", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "description": "Minimum value to filter by (exclusive)", "type": "integer" }, "gte": { "description": "Minimum value to filter by (inclusive)", "type": "integer" }, "lt": { "description": "Maximum value to filter by (exclusive)", "type": "integer" }, "lte": { "description": "Maximum value to filter by (inclusive)", "type": "integer" } }, "title": "range_query_specs", "type": "object", "x-stripeMostCommon": [ "gt", "gte", "lt", "lte" ] }, { "type": "integer" } ] }, "style": "deepObject" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "Only return plans for the given product.", "in": "query", "name": "product", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/plan" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/plans", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "PlanList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all plans" }, "post": { "description": "

You can now model subscriptions more flexibly using the Prices API. It replaces the Plans API and is backwards compatible to simplify your migration.

", "operationId": "PostPlans", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "product": { "explode": true, "style": "deepObject" }, "tiers": { "explode": true, "style": "deepObject" }, "transform_usage": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "active": { "description": "Whether the plan is currently available for new subscriptions. Defaults to `true`.", "type": "boolean" }, "amount": { "description": "A positive integer in cents (or local equivalent) (or 0 for a free plan) representing how much to charge on a recurring basis.", "type": "integer" }, "amount_decimal": { "description": "Same as `amount`, but accepts a decimal value with at most 12 decimal places. Only one of `amount` and `amount_decimal` can be set.", "format": "decimal", "type": "string" }, "billing_scheme": { "description": "Describes how to compute the price per period. Either `per_unit` or `tiered`. `per_unit` indicates that the fixed amount (specified in `amount`) will be charged per unit in `quantity` (for plans with `usage_type=licensed`), or per unit of total usage (for plans with `usage_type=metered`). `tiered` indicates that the unit pricing will be computed using a tiering strategy as defined using the `tiers` and `tiers_mode` attributes.", "enum": [ "per_unit", "tiered" ], "type": "string" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "id": { "description": "An identifier randomly generated by Stripe. Used to identify this plan when subscribing a customer. You can optionally override this ID, but the ID must be unique across all plans in your Stripe account. You can, however, use the same plan ID in both live and test modes.", "maxLength": 5000, "type": "string" }, "interval": { "description": "Specifies billing frequency. Either `day`, `week`, `month` or `year`.", "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "description": "The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).", "type": "integer" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "meter": { "description": "The meter tracking the usage of a metered price", "maxLength": 5000, "type": "string" }, "nickname": { "description": "A brief description of the plan, hidden from customers.", "maxLength": 5000, "type": "string" }, "product": { "anyOf": [ { "description": "The product whose pricing the created plan will represent. This can either be the ID of an existing product, or a dictionary containing fields used to create a [service product](https://stripe.com/docs/api#product_object-type).", "properties": { "active": { "description": "Whether the product is currently available for purchase. Defaults to `true`.", "type": "boolean" }, "id": { "deprecated": true, "description": "The identifier for the product. Must be unique. If not provided, an identifier will be randomly generated.", "maxLength": 5000, "type": "string" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "name": { "description": "The product's name, meant to be displayable to the customer.", "maxLength": 5000, "type": "string" }, "statement_descriptor": { "description": "An arbitrary string to be displayed on your customer's credit card or bank statement. While most banks display this information consistently, some may display it incorrectly or not at all.\n\nThis may be up to 22 characters. The statement description may not include `<`, `>`, `\\`, `\"`, `'` characters, and will appear on your customer's statement in capital letters. Non-ASCII characters are automatically stripped.", "maxLength": 22, "type": "string" }, "tax_code": { "description": "A [tax code](https://stripe.com/docs/tax/tax-categories) ID.", "maxLength": 5000, "type": "string" }, "unit_label": { "description": "A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.", "maxLength": 12, "type": "string" } }, "required": [ "name" ], "title": "inline_product_params", "type": "object", "x-stripeMostCommon": [ "active", "id", "images", "metadata", "name", "statement_descriptor", "tax_code", "unit_label" ] }, { "description": "The ID of the product whose pricing the created plan will represent.", "maxLength": 5000, "type": "string" } ] }, "tiers": { "description": "Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.", "items": { "properties": { "flat_amount": { "description": "The flat billing amount for an entire tier, regardless of the number of units in the tier.", "type": "integer" }, "flat_amount_decimal": { "description": "Same as `flat_amount`, but accepts a decimal value representing an integer in the minor units of the currency. Only one of `flat_amount` and `flat_amount_decimal` can be set.", "format": "decimal", "type": "string" }, "unit_amount": { "description": "The per unit billing amount for each individual unit for which this tier applies.", "type": "integer" }, "unit_amount_decimal": { "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", "format": "decimal", "type": "string" }, "up_to": { "anyOf": [ { "enum": [ "inf" ], "maxLength": 5000, "type": "string" }, { "type": "integer" } ], "description": "Specifies the upper bound of this tier. The lower bound of a tier is the upper bound of the previous tier adding one. Use `inf` to define a fallback tier." } }, "required": [ "up_to" ], "title": "tier", "type": "object", "x-stripeMostCommon": [ "flat_amount", "flat_amount_decimal", "unit_amount", "unit_amount_decimal", "up_to" ] }, "type": "array" }, "tiers_mode": { "description": "Defines if the tiering price should be `graduated` or `volume` based. In `volume`-based tiering, the maximum quantity within a period determines the per unit price, in `graduated` tiering pricing can successively change as the quantity grows.", "enum": [ "graduated", "volume" ], "type": "string" }, "transform_usage": { "description": "Apply a transformation to the reported usage or set quantity before computing the billed price. Cannot be combined with `tiers`.", "properties": { "divide_by": { "description": "Divide usage by this number.", "type": "integer" }, "round": { "description": "After division, either round the result `up` or `down`.", "enum": [ "down", "up" ], "type": "string" } }, "required": [ "divide_by", "round" ], "title": "transform_usage_param", "type": "object", "x-stripeMostCommon": [ "divide_by", "round" ] }, "trial_period_days": { "description": "Default number of trial days when subscribing a customer to this plan using [`trial_from_plan=true`](https://stripe.com/docs/api#create_subscription-trial_from_plan).", "type": "integer" }, "usage_type": { "description": "Configures how the quantity per period should be determined. Can be either `metered` or `licensed`. `licensed` automatically bills the `quantity` set when adding it to a subscription. `metered` aggregates the total usage based on usage records. Defaults to `licensed`.", "enum": [ "licensed", "metered" ], "type": "string" } }, "required": [ "currency", "interval" ], "type": "object", "x-stripeMostCommon": [ "active", "amount", "currency", "interval", "metadata", "nickname", "product" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plan" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a plan" } }, "/v1/plans/{plan}": { "delete": { "description": "

Deleting plans means new subscribers can’t be added. Existing subscribers aren’t affected.

", "operationId": "DeletePlansPlan", "parameters": [ { "in": "path", "name": "plan", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted_plan" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Delete a plan" }, "get": { "description": "

Retrieves the plan with the given ID.

", "operationId": "GetPlansPlan", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "plan", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plan" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a plan" }, "post": { "description": "

Updates the specified plan by setting the values of the parameters passed. Any parameters not provided are left unchanged. By design, you cannot change a plan’s ID, amount, currency, or billing cycle.

", "operationId": "PostPlansPlan", "parameters": [ { "in": "path", "name": "plan", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "active": { "description": "Whether the plan is currently available for new subscriptions.", "type": "boolean" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "nickname": { "description": "A brief description of the plan, hidden from customers.", "maxLength": 5000, "type": "string" }, "product": { "description": "The product the plan belongs to. This cannot be changed once it has been used in a subscription or subscription schedule.", "maxLength": 5000, "type": "string" }, "trial_period_days": { "description": "Default number of trial days when subscribing a customer to this plan using [`trial_from_plan=true`](https://stripe.com/docs/api#create_subscription-trial_from_plan).", "type": "integer" } }, "type": "object", "x-stripeMostCommon": [ "active", "metadata", "nickname" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plan" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a plan" } }, "/v1/prices": { "get": { "description": "

Returns a list of your active prices, excluding inline prices. For the list of inactive prices, set active to false.

", "operationId": "GetPrices", "parameters": [ { "description": "Only return prices that are active or inactive (e.g., pass `false` to list all inactive prices).", "in": "query", "name": "active", "required": false, "schema": { "type": "boolean" }, "style": "form" }, { "description": "A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.", "explode": true, "in": "query", "name": "created", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "description": "Minimum value to filter by (exclusive)", "type": "integer" }, "gte": { "description": "Minimum value to filter by (inclusive)", "type": "integer" }, "lt": { "description": "Maximum value to filter by (exclusive)", "type": "integer" }, "lte": { "description": "Maximum value to filter by (inclusive)", "type": "integer" } }, "title": "range_query_specs", "type": "object", "x-stripeMostCommon": [ "gt", "gte", "lt", "lte" ] }, { "type": "integer" } ] }, "style": "deepObject" }, { "description": "Only return prices for the given currency.", "in": "query", "name": "currency", "required": false, "schema": { "format": "currency", "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "Only return the price with these lookup_keys, if any exist. You can specify up to 10 lookup_keys.", "explode": true, "in": "query", "name": "lookup_keys", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "Only return prices for the given product.", "in": "query", "name": "product", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Only return prices with these recurring fields.", "explode": true, "in": "query", "name": "recurring", "required": false, "schema": { "properties": { "interval": { "description": "Filter by billing frequency. Either `day`, `week`, `month` or `year`.", "enum": [ "day", "month", "week", "year" ], "type": "string" }, "meter": { "description": "Filter by the price's meter.", "maxLength": 5000, "type": "string" }, "usage_type": { "description": "Filter by the usage type for this price. Can be either `metered` or `licensed`.", "enum": [ "licensed", "metered" ], "type": "string" } }, "title": "all_prices_recurring_params", "type": "object", "x-stripeMostCommon": [ "interval", "meter", "usage_type" ] }, "style": "deepObject" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Only return prices of type `recurring` or `one_time`.", "in": "query", "name": "type", "required": false, "schema": { "enum": [ "one_time", "recurring" ], "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/price" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/prices", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "PriceList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all prices" }, "post": { "description": "

Creates a new Price for an existing Product. The Price can be recurring or one-time.

", "operationId": "PostPrices", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "currency_options": { "explode": true, "style": "deepObject" }, "custom_unit_amount": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "product_data": { "explode": true, "style": "deepObject" }, "recurring": { "explode": true, "style": "deepObject" }, "tiers": { "explode": true, "style": "deepObject" }, "transform_quantity": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "active": { "description": "Whether the price can be used for new purchases. Defaults to `true`.", "type": "boolean" }, "billing_scheme": { "description": "Describes how to compute the price per period. Either `per_unit` or `tiered`. `per_unit` indicates that the fixed amount (specified in `unit_amount` or `unit_amount_decimal`) will be charged per unit in `quantity` (for prices with `usage_type=licensed`), or per unit of total usage (for prices with `usage_type=metered`). `tiered` indicates that the unit pricing will be computed using a tiering strategy as defined using the `tiers` and `tiers_mode` attributes.", "enum": [ "per_unit", "tiered" ], "type": "string" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "currency_options": { "additionalProperties": { "properties": { "custom_unit_amount": { "description": "When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.", "properties": { "enabled": { "description": "Pass in `true` to enable `custom_unit_amount`, otherwise omit `custom_unit_amount`.", "type": "boolean" }, "maximum": { "description": "The maximum unit amount the customer can specify for this item.", "type": "integer" }, "minimum": { "description": "The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.", "type": "integer" }, "preset": { "description": "The starting unit amount which can be updated by the customer.", "type": "integer" } }, "required": [ "enabled" ], "title": "custom_unit_amount", "type": "object", "x-stripeMostCommon": [ "enabled", "preset" ] }, "tax_behavior": { "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.", "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" }, "tiers": { "description": "Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.", "items": { "properties": { "flat_amount": { "description": "The flat billing amount for an entire tier, regardless of the number of units in the tier.", "type": "integer" }, "flat_amount_decimal": { "description": "Same as `flat_amount`, but accepts a decimal value representing an integer in the minor units of the currency. Only one of `flat_amount` and `flat_amount_decimal` can be set.", "format": "decimal", "type": "string" }, "unit_amount": { "description": "The per unit billing amount for each individual unit for which this tier applies.", "type": "integer" }, "unit_amount_decimal": { "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", "format": "decimal", "type": "string" }, "up_to": { "anyOf": [ { "enum": [ "inf" ], "maxLength": 5000, "type": "string" }, { "type": "integer" } ], "description": "Specifies the upper bound of this tier. The lower bound of a tier is the upper bound of the previous tier adding one. Use `inf` to define a fallback tier." } }, "required": [ "up_to" ], "title": "tier", "type": "object", "x-stripeMostCommon": [ "flat_amount", "flat_amount_decimal", "unit_amount", "unit_amount_decimal", "up_to" ] }, "type": "array" }, "unit_amount": { "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.", "type": "integer" }, "unit_amount_decimal": { "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", "format": "decimal", "type": "string" } }, "title": "currency_option", "type": "object", "x-stripeMostCommon": [ "unit_amount" ] }, "description": "Prices defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).", "type": "object" }, "custom_unit_amount": { "description": "When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.", "properties": { "enabled": { "description": "Pass in `true` to enable `custom_unit_amount`, otherwise omit `custom_unit_amount`.", "type": "boolean" }, "maximum": { "description": "The maximum unit amount the customer can specify for this item.", "type": "integer" }, "minimum": { "description": "The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.", "type": "integer" }, "preset": { "description": "The starting unit amount which can be updated by the customer.", "type": "integer" } }, "required": [ "enabled" ], "title": "custom_unit_amount", "type": "object", "x-stripeMostCommon": [ "enabled", "preset" ] }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "lookup_key": { "description": "A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.", "maxLength": 200, "type": "string" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "nickname": { "description": "A brief description of the price, hidden from customers.", "maxLength": 5000, "type": "string" }, "product": { "description": "The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.", "maxLength": 5000, "type": "string" }, "product_data": { "description": "These fields can be used to create a new product that this price will belong to.", "properties": { "active": { "description": "Whether the product is currently available for purchase. Defaults to `true`.", "type": "boolean" }, "id": { "deprecated": true, "description": "The identifier for the product. Must be unique. If not provided, an identifier will be randomly generated.", "maxLength": 5000, "type": "string" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "name": { "description": "The product's name, meant to be displayable to the customer.", "maxLength": 5000, "type": "string" }, "statement_descriptor": { "description": "An arbitrary string to be displayed on your customer's credit card or bank statement. While most banks display this information consistently, some may display it incorrectly or not at all.\n\nThis may be up to 22 characters. The statement description may not include `<`, `>`, `\\`, `\"`, `'` characters, and will appear on your customer's statement in capital letters. Non-ASCII characters are automatically stripped.", "maxLength": 22, "type": "string" }, "tax_code": { "description": "A [tax code](https://stripe.com/docs/tax/tax-categories) ID.", "maxLength": 5000, "type": "string" }, "unit_label": { "description": "A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.", "maxLength": 12, "type": "string" } }, "required": [ "name" ], "title": "inline_product_params", "type": "object", "x-stripeMostCommon": [ "active", "id", "images", "metadata", "name", "statement_descriptor", "tax_code", "unit_label" ] }, "recurring": { "description": "The recurring components of a price such as `interval` and `usage_type`.", "properties": { "interval": { "description": "Specifies billing frequency. Either `day`, `week`, `month` or `year`.", "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "description": "The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).", "type": "integer" }, "meter": { "description": "The meter tracking the usage of a metered price", "maxLength": 5000, "type": "string" }, "trial_period_days": { "description": "Default number of trial days when subscribing a customer to this price using [`trial_from_plan=true`](https://stripe.com/docs/api#create_subscription-trial_from_plan).", "type": "integer" }, "usage_type": { "description": "Configures how the quantity per period should be determined. Can be either `metered` or `licensed`. `licensed` automatically bills the `quantity` set when adding it to a subscription. `metered` aggregates the total usage based on usage records. Defaults to `licensed`.", "enum": [ "licensed", "metered" ], "type": "string" } }, "required": [ "interval" ], "title": "recurring", "type": "object", "x-stripeMostCommon": [ "interval", "meter", "trial_period_days", "usage_type" ] }, "tax_behavior": { "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.", "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" }, "tiers": { "description": "Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.", "items": { "properties": { "flat_amount": { "description": "The flat billing amount for an entire tier, regardless of the number of units in the tier.", "type": "integer" }, "flat_amount_decimal": { "description": "Same as `flat_amount`, but accepts a decimal value representing an integer in the minor units of the currency. Only one of `flat_amount` and `flat_amount_decimal` can be set.", "format": "decimal", "type": "string" }, "unit_amount": { "description": "The per unit billing amount for each individual unit for which this tier applies.", "type": "integer" }, "unit_amount_decimal": { "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", "format": "decimal", "type": "string" }, "up_to": { "anyOf": [ { "enum": [ "inf" ], "maxLength": 5000, "type": "string" }, { "type": "integer" } ], "description": "Specifies the upper bound of this tier. The lower bound of a tier is the upper bound of the previous tier adding one. Use `inf` to define a fallback tier." } }, "required": [ "up_to" ], "title": "tier", "type": "object", "x-stripeMostCommon": [ "flat_amount", "flat_amount_decimal", "unit_amount", "unit_amount_decimal", "up_to" ] }, "type": "array" }, "tiers_mode": { "description": "Defines if the tiering price should be `graduated` or `volume` based. In `volume`-based tiering, the maximum quantity within a period determines the per unit price, in `graduated` tiering pricing can successively change as the quantity grows.", "enum": [ "graduated", "volume" ], "type": "string" }, "transfer_lookup_key": { "description": "If set to true, will atomically remove the lookup key from the existing price, and assign it to this price.", "type": "boolean" }, "transform_quantity": { "description": "Apply a transformation to the reported usage or set quantity before computing the billed price. Cannot be combined with `tiers`.", "properties": { "divide_by": { "description": "Divide usage by this number.", "type": "integer" }, "round": { "description": "After division, either round the result `up` or `down`.", "enum": [ "down", "up" ], "type": "string" } }, "required": [ "divide_by", "round" ], "title": "transform_usage_param", "type": "object", "x-stripeMostCommon": [ "divide_by", "round" ] }, "unit_amount": { "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. One of `unit_amount`, `unit_amount_decimal`, or `custom_unit_amount` is required, unless `billing_scheme=tiered`.", "type": "integer" }, "unit_amount_decimal": { "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", "format": "decimal", "type": "string" } }, "required": [ "currency" ], "type": "object", "x-stripeMostCommon": [ "active", "currency", "metadata", "nickname", "product", "recurring", "tax_behavior", "unit_amount" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/price" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a price" } }, "/v1/prices/search": { "get": { "description": "

Search for prices you’ve previously created using Stripe’s Search Query Language.\nDon’t use search in read-after-write flows where strict consistency is necessary. Under normal operating\nconditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up\nto an hour behind during outages. Search functionality is not available to merchants in India.

", "operationId": "GetPricesSearch", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.", "in": "query", "name": "page", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for prices](https://stripe.com/docs/search#query-fields-for-prices).", "in": "query", "name": "query", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/price" }, "type": "array" }, "has_more": { "type": "boolean" }, "next_page": { "maxLength": 5000, "nullable": true, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "search_result" ], "type": "string" }, "total_count": { "description": "The total number of objects that match the query, only accurate up to 10,000.", "type": "integer" }, "url": { "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "next_page", "object", "url" ], "title": "SearchResult", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "next_page", "object", "total_count", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Search prices" } }, "/v1/prices/{price}": { "get": { "description": "

Retrieves the price with the given ID.

", "operationId": "GetPricesPrice", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "price", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/price" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a price" }, "post": { "description": "

Updates the specified price by setting the values of the parameters passed. Any parameters not provided are left unchanged.

", "operationId": "PostPricesPrice", "parameters": [ { "in": "path", "name": "price", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "currency_options": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "migrate_to": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "active": { "description": "Whether the price can be used for new purchases. Defaults to `true`.", "type": "boolean" }, "currency_options": { "anyOf": [ { "additionalProperties": { "properties": { "custom_unit_amount": { "description": "When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.", "properties": { "enabled": { "description": "Pass in `true` to enable `custom_unit_amount`, otherwise omit `custom_unit_amount`.", "type": "boolean" }, "maximum": { "description": "The maximum unit amount the customer can specify for this item.", "type": "integer" }, "minimum": { "description": "The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.", "type": "integer" }, "preset": { "description": "The starting unit amount which can be updated by the customer.", "type": "integer" } }, "required": [ "enabled" ], "title": "custom_unit_amount", "type": "object", "x-stripeMostCommon": [ "enabled", "preset" ] }, "tax_behavior": { "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.", "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" }, "tiers": { "description": "Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.", "items": { "properties": { "flat_amount": { "description": "The flat billing amount for an entire tier, regardless of the number of units in the tier.", "type": "integer" }, "flat_amount_decimal": { "description": "Same as `flat_amount`, but accepts a decimal value representing an integer in the minor units of the currency. Only one of `flat_amount` and `flat_amount_decimal` can be set.", "format": "decimal", "type": "string" }, "unit_amount": { "description": "The per unit billing amount for each individual unit for which this tier applies.", "type": "integer" }, "unit_amount_decimal": { "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", "format": "decimal", "type": "string" }, "up_to": { "anyOf": [ { "enum": [ "inf" ], "maxLength": 5000, "type": "string" }, { "type": "integer" } ], "description": "Specifies the upper bound of this tier. The lower bound of a tier is the upper bound of the previous tier adding one. Use `inf` to define a fallback tier." } }, "required": [ "up_to" ], "title": "tier", "type": "object", "x-stripeMostCommon": [ "flat_amount", "flat_amount_decimal", "unit_amount", "unit_amount_decimal", "up_to" ] }, "type": "array" }, "unit_amount": { "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.", "type": "integer" }, "unit_amount_decimal": { "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", "format": "decimal", "type": "string" } }, "title": "currency_option", "type": "object", "x-stripeMostCommon": [ "unit_amount" ] }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Prices defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies)." }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "lookup_key": { "description": "A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.", "maxLength": 200, "type": "string" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "migrate_to": { "anyOf": [ { "properties": { "behavior": { "description": "The behavior controlling the point in the subscription lifecycle after which to migrate the price. Currently must be `at_cycle_end`.", "enum": [ "at_cycle_end" ], "type": "string" }, "effective_after": { "description": "The time after which subscriptions should start using the new price.", "format": "unix-time", "type": "integer" }, "price": { "description": "The ID of the price object.", "maxLength": 5000, "type": "string" } }, "required": [ "behavior", "price" ], "title": "migrate_to_specs", "type": "object", "x-stripeMostCommon": [ "behavior", "effective_after", "price" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If specified, subscriptions using this price will be updated to use the new referenced price." }, "nickname": { "description": "A brief description of the price, hidden from customers.", "maxLength": 5000, "type": "string" }, "tax_behavior": { "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.", "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" }, "transfer_lookup_key": { "description": "If set to true, will atomically remove the lookup key from the existing price, and assign it to this price.", "type": "boolean" } }, "type": "object", "x-stripeMostCommon": [ "active", "metadata", "nickname", "tax_behavior" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/price" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a price" } }, "/v1/privacy/redaction_jobs": { "get": { "description": "

Returns a list of redaction jobs.

", "operationId": "GetPrivacyRedactionJobs", "parameters": [ { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "in": "query", "name": "status", "required": false, "schema": { "enum": [ "canceled", "canceling", "created", "failed", "ready", "redacting", "succeeded", "validating" ], "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "A list of redaction jobs", "properties": { "data": { "items": { "$ref": "#/components/schemas/privacy.redaction_job" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/privacy/redaction_jobs", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "RedactionResourceRedactionJobList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all redaction jobs" }, "post": { "description": "

Creates a redaction job. When a job is created, it will start to validate.

", "operationId": "PostPrivacyRedactionJobs", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "objects": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "objects": { "description": "The objects to redact. These root objects and their related ones will be validated for redaction.", "properties": { "charges": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "checkout_sessions": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "customers": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "identity_verification_sessions": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "invoices": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "issuing_cardholders": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "issuing_cards": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "payment_intents": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "radar_value_list_items": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "setup_intents": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "title": "root_object_params", "type": "object", "x-stripeMostCommon": [ "charges", "checkout_sessions", "customers", "identity_verification_sessions", "invoices", "issuing_cardholders", "issuing_cards", "payment_intents", "radar_value_list_items", "setup_intents" ] }, "validation_behavior": { "description": "Determines the validation behavior of the job. Default is `error`.", "enum": [ "error", "fix" ], "type": "string" } }, "required": [ "objects" ], "type": "object", "x-stripeMostCommon": [ "objects", "validation_behavior" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/privacy.redaction_job" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a redaction job" } }, "/v1/privacy/redaction_jobs/{job}": { "get": { "description": "

Retrieves the details of a previously created redaction job.

", "operationId": "GetPrivacyRedactionJobsJob", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "RedactionJob object identifier", "in": "path", "name": "job", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/privacy.redaction_job" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a redaction job" }, "post": { "description": "

Updates the properties of a redaction job without running or canceling the job.

\n\n

If the job to update is in a failed status, it will not automatically start to validate. Once you applied all of the changes, use the validate API to start validation again.

", "operationId": "PostPrivacyRedactionJobsJob", "parameters": [ { "description": "RedactionJob object identifier", "in": "path", "name": "job", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "validation_behavior": { "description": "Determines the validation behavior of the job. Default is `error`.", "enum": [ "error", "fix" ], "type": "string" } }, "type": "object", "x-stripeMostCommon": [ "validation_behavior" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/privacy.redaction_job" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a redaction job" } }, "/v1/privacy/redaction_jobs/{job}/cancel": { "post": { "description": "

You can cancel a redaction job when it’s in one of these statuses: ready, failed.

\n\n

Canceling the redaction job will abandon its attempt to redact the configured objects. A canceled job cannot be used again.

", "operationId": "PostPrivacyRedactionJobsJobCancel", "parameters": [ { "description": "RedactionJob object identifier", "in": "path", "name": "job", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/privacy.redaction_job" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Cancel a redaction job" } }, "/v1/privacy/redaction_jobs/{job}/run": { "post": { "description": "

Run a redaction job in a ready status.

\n\n

When you run a job, the configured objects will be redacted asynchronously. This action is irreversible and cannot be canceled once started.

\n\n

The status of the job will move to redacting. Once all of the objects are redacted, the status will become succeeded. If the job’s validation_behavior is set to fix, the automatic fixes will be applied to objects at this step.

", "operationId": "PostPrivacyRedactionJobsJobRun", "parameters": [ { "description": "RedactionJob object identifier", "in": "path", "name": "job", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/privacy.redaction_job" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Run a redaction job" } }, "/v1/privacy/redaction_jobs/{job}/validate": { "post": { "description": "

Validate a redaction job when it is in a failed status.

\n\n

When a job is created, it automatically begins to validate on the configured objects’ eligibility for redaction. Use this to validate the job again after its validation errors are resolved or the job’s validation_behavior is changed.

\n\n

The status of the job will move to validating. Once all of the objects are validated, the status of the job will become ready. If there are any validation errors preventing the job from running, the status will become failed.

", "operationId": "PostPrivacyRedactionJobsJobValidate", "parameters": [ { "description": "RedactionJob object identifier", "in": "path", "name": "job", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/privacy.redaction_job" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Validate a redaction job" } }, "/v1/privacy/redaction_jobs/{job}/validation_errors": { "get": { "description": "

Returns a list of validation errors for the specified redaction job.

", "operationId": "GetPrivacyRedactionJobsJobValidationErrors", "parameters": [ { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "RedactionJob object identifier", "in": "path", "name": "job", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "A list of redaction job validation errors", "properties": { "data": { "items": { "$ref": "#/components/schemas/privacy.redaction_job_validation_error" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/privacy/redaction_jobs/[^/]+/validation_errors", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "RedactionResourceValidationErrorList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all validation errors" } }, "/v1/products": { "get": { "description": "

Returns a list of your products. The products are returned sorted by creation date, with the most recently created products appearing first.

", "operationId": "GetProducts", "parameters": [ { "description": "Only return products that are active or inactive (e.g., pass `false` to list all inactive products).", "in": "query", "name": "active", "required": false, "schema": { "type": "boolean" }, "style": "form" }, { "description": "Only return products that were created during the given date interval.", "explode": true, "in": "query", "name": "created", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "description": "Minimum value to filter by (exclusive)", "type": "integer" }, "gte": { "description": "Minimum value to filter by (inclusive)", "type": "integer" }, "lt": { "description": "Maximum value to filter by (exclusive)", "type": "integer" }, "lte": { "description": "Maximum value to filter by (inclusive)", "type": "integer" } }, "title": "range_query_specs", "type": "object", "x-stripeMostCommon": [ "gt", "gte", "lt", "lte" ] }, { "type": "integer" } ] }, "style": "deepObject" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "Only return products with the given IDs. Cannot be used with [starting_after](https://stripe.com/docs/api#list_products-starting_after) or [ending_before](https://stripe.com/docs/api#list_products-ending_before).", "explode": true, "in": "query", "name": "ids", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "Only return products that can be shipped (i.e., physical, not digital products).", "in": "query", "name": "shippable", "required": false, "schema": { "type": "boolean" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Only return products of this type.", "in": "query", "name": "type", "required": false, "schema": { "enum": [ "good", "service" ], "type": "string" }, "style": "form" }, { "description": "Only return products with the given url.", "in": "query", "name": "url", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/product" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/products", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "ProductList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all products" }, "post": { "description": "

Creates a new product object.

", "operationId": "PostProducts", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "default_price_data": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "images": { "explode": true, "style": "deepObject" }, "marketing_features": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "package_dimensions": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "active": { "description": "Whether the product is currently available for purchase. Defaults to `true`.", "type": "boolean" }, "default_price_data": { "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object. This Price will be set as the default price for this product.", "properties": { "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "currency_options": { "additionalProperties": { "properties": { "custom_unit_amount": { "description": "When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.", "properties": { "enabled": { "description": "Pass in `true` to enable `custom_unit_amount`, otherwise omit `custom_unit_amount`.", "type": "boolean" }, "maximum": { "description": "The maximum unit amount the customer can specify for this item.", "type": "integer" }, "minimum": { "description": "The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.", "type": "integer" }, "preset": { "description": "The starting unit amount which can be updated by the customer.", "type": "integer" } }, "required": [ "enabled" ], "title": "custom_unit_amount", "type": "object", "x-stripeMostCommon": [ "enabled", "preset" ] }, "tax_behavior": { "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.", "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" }, "tiers": { "description": "Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.", "items": { "properties": { "flat_amount": { "description": "The flat billing amount for an entire tier, regardless of the number of units in the tier.", "type": "integer" }, "flat_amount_decimal": { "description": "Same as `flat_amount`, but accepts a decimal value representing an integer in the minor units of the currency. Only one of `flat_amount` and `flat_amount_decimal` can be set.", "format": "decimal", "type": "string" }, "unit_amount": { "description": "The per unit billing amount for each individual unit for which this tier applies.", "type": "integer" }, "unit_amount_decimal": { "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", "format": "decimal", "type": "string" }, "up_to": { "anyOf": [ { "enum": [ "inf" ], "maxLength": 5000, "type": "string" }, { "type": "integer" } ], "description": "Specifies the upper bound of this tier. The lower bound of a tier is the upper bound of the previous tier adding one. Use `inf` to define a fallback tier." } }, "required": [ "up_to" ], "title": "tier", "type": "object", "x-stripeMostCommon": [ "flat_amount", "flat_amount_decimal", "unit_amount", "unit_amount_decimal", "up_to" ] }, "type": "array" }, "unit_amount": { "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.", "type": "integer" }, "unit_amount_decimal": { "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", "format": "decimal", "type": "string" } }, "title": "currency_option", "type": "object", "x-stripeMostCommon": [ "unit_amount" ] }, "description": "Prices defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).", "type": "object" }, "custom_unit_amount": { "description": "When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.", "properties": { "enabled": { "description": "Pass in `true` to enable `custom_unit_amount`, otherwise omit `custom_unit_amount`.", "type": "boolean" }, "maximum": { "description": "The maximum unit amount the customer can specify for this item.", "type": "integer" }, "minimum": { "description": "The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.", "type": "integer" }, "preset": { "description": "The starting unit amount which can be updated by the customer.", "type": "integer" } }, "required": [ "enabled" ], "title": "custom_unit_amount", "type": "object", "x-stripeMostCommon": [ "enabled", "preset" ] }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "recurring": { "description": "The recurring components of a price such as `interval` and `interval_count`.", "properties": { "interval": { "description": "Specifies billing frequency. Either `day`, `week`, `month` or `year`.", "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "description": "The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).", "type": "integer" } }, "required": [ "interval" ], "title": "recurring_adhoc", "type": "object", "x-stripeMostCommon": [ "interval" ] }, "tax_behavior": { "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.", "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" }, "unit_amount": { "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. One of `unit_amount`, `unit_amount_decimal`, or `custom_unit_amount` is required.", "type": "integer" }, "unit_amount_decimal": { "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", "format": "decimal", "type": "string" } }, "required": [ "currency" ], "title": "price_data_without_product_with_metadata", "type": "object", "x-stripeMostCommon": [ "currency", "unit_amount" ] }, "description": { "description": "The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.", "maxLength": 40000, "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "id": { "description": "An identifier will be randomly generated by Stripe. You can optionally override this ID, but the ID must be unique across all products in your Stripe account.", "maxLength": 5000, "type": "string" }, "images": { "description": "A list of up to 8 URLs of images for this product, meant to be displayable to the customer.", "items": { "type": "string" }, "type": "array" }, "marketing_features": { "description": "A list of up to 15 marketing features for this product. These are displayed in [pricing tables](https://stripe.com/docs/payments/checkout/pricing-table).", "items": { "properties": { "name": { "description": "The marketing feature name. Up to 80 characters long.", "maxLength": 5000, "type": "string" } }, "required": [ "name" ], "title": "features", "type": "object", "x-stripeMostCommon": [ "name" ] }, "type": "array" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "name": { "description": "The product's name, meant to be displayable to the customer.", "maxLength": 5000, "type": "string" }, "package_dimensions": { "description": "The dimensions of this product for shipping purposes.", "properties": { "height": { "description": "Height, in inches. Maximum precision is 2 decimal places.", "type": "number" }, "length": { "description": "Length, in inches. Maximum precision is 2 decimal places.", "type": "number" }, "weight": { "description": "Weight, in ounces. Maximum precision is 2 decimal places.", "type": "number" }, "width": { "description": "Width, in inches. Maximum precision is 2 decimal places.", "type": "number" } }, "required": [ "height", "length", "weight", "width" ], "title": "package_dimensions_specs", "type": "object", "x-stripeMostCommon": [ "height", "length", "weight", "width" ] }, "shippable": { "description": "Whether this product is shipped (i.e., physical goods).", "type": "boolean" }, "statement_descriptor": { "description": "An arbitrary string to be displayed on your customer's credit card or bank statement. While most banks display this information consistently, some may display it incorrectly or not at all.\n\nThis may be up to 22 characters. The statement description may not include `<`, `>`, `\\`, `\"`, `'` characters, and will appear on your customer's statement in capital letters. Non-ASCII characters are automatically stripped.\n It must contain at least one letter. Only used for subscription payments.", "maxLength": 22, "type": "string" }, "tax_code": { "description": "A [tax code](https://stripe.com/docs/tax/tax-categories) ID.", "type": "string" }, "type": { "description": "The type of the product. Defaults to `service` if not explicitly specified, enabling use of this product with Subscriptions and Plans. Set this parameter to `good` to use this product with Orders and SKUs. On API versions before `2018-02-05`, this field defaults to `good` for compatibility reasons.", "enum": [ "good", "service" ], "type": "string" }, "unit_label": { "description": "A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.", "maxLength": 12, "type": "string" }, "url": { "description": "A URL of a publicly-accessible webpage for this product.", "maxLength": 5000, "type": "string" } }, "required": [ "name" ], "type": "object", "x-stripeMostCommon": [ "active", "description", "id", "metadata", "name", "tax_code" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a product" } }, "/v1/products/search": { "get": { "description": "

Search for products you’ve previously created using Stripe’s Search Query Language.\nDon’t use search in read-after-write flows where strict consistency is necessary. Under normal operating\nconditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up\nto an hour behind during outages. Search functionality is not available to merchants in India.

", "operationId": "GetProductsSearch", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.", "in": "query", "name": "page", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for products](https://stripe.com/docs/search#query-fields-for-products).", "in": "query", "name": "query", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/product" }, "type": "array" }, "has_more": { "type": "boolean" }, "next_page": { "maxLength": 5000, "nullable": true, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "search_result" ], "type": "string" }, "total_count": { "description": "The total number of objects that match the query, only accurate up to 10,000.", "type": "integer" }, "url": { "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "next_page", "object", "url" ], "title": "SearchResult", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "next_page", "object", "total_count", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Search products" } }, "/v1/products/{id}": { "delete": { "description": "

Delete a product. Deleting a product is only possible if it has no prices associated with it. Additionally, deleting a product with type=good is only possible if it has no SKUs associated with it.

", "operationId": "DeleteProductsId", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted_product" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Delete a product" }, "get": { "description": "

Retrieves the details of an existing product. Supply the unique product ID from either a product creation request or the product list, and Stripe will return the corresponding product information.

", "operationId": "GetProductsId", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a product" }, "post": { "description": "

Updates the specific product by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

", "operationId": "PostProductsId", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "description": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "images": { "explode": true, "style": "deepObject" }, "marketing_features": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "package_dimensions": { "explode": true, "style": "deepObject" }, "tax_code": { "explode": true, "style": "deepObject" }, "unit_label": { "explode": true, "style": "deepObject" }, "url": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "active": { "description": "Whether the product is available for purchase.", "type": "boolean" }, "default_price": { "description": "The ID of the [Price](https://stripe.com/docs/api/prices) object that is the default price for this product.", "maxLength": 5000, "type": "string" }, "description": { "anyOf": [ { "maxLength": 40000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes." }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "images": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "A list of up to 8 URLs of images for this product, meant to be displayable to the customer." }, "marketing_features": { "anyOf": [ { "items": { "properties": { "name": { "description": "The marketing feature name. Up to 80 characters long.", "maxLength": 5000, "type": "string" } }, "required": [ "name" ], "title": "features", "type": "object", "x-stripeMostCommon": [ "name" ] }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "A list of up to 15 marketing features for this product. These are displayed in [pricing tables](https://stripe.com/docs/payments/checkout/pricing-table)." }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "name": { "description": "The product's name, meant to be displayable to the customer.", "maxLength": 5000, "type": "string" }, "package_dimensions": { "anyOf": [ { "properties": { "height": { "description": "Height, in inches. Maximum precision is 2 decimal places.", "type": "number" }, "length": { "description": "Length, in inches. Maximum precision is 2 decimal places.", "type": "number" }, "weight": { "description": "Weight, in ounces. Maximum precision is 2 decimal places.", "type": "number" }, "width": { "description": "Width, in inches. Maximum precision is 2 decimal places.", "type": "number" } }, "required": [ "height", "length", "weight", "width" ], "title": "package_dimensions_specs", "type": "object", "x-stripeMostCommon": [ "height", "length", "weight", "width" ] }, { "enum": [ "" ], "type": "string" } ], "description": "The dimensions of this product for shipping purposes." }, "shippable": { "description": "Whether this product is shipped (i.e., physical goods).", "type": "boolean" }, "statement_descriptor": { "description": "An arbitrary string to be displayed on your customer's credit card or bank statement. While most banks display this information consistently, some may display it incorrectly or not at all.\n\nThis may be up to 22 characters. The statement description may not include `<`, `>`, `\\`, `\"`, `'` characters, and will appear on your customer's statement in capital letters. Non-ASCII characters are automatically stripped.\n It must contain at least one letter. May only be set if `type=service`. Only used for subscription payments.", "maxLength": 22, "type": "string" }, "tax_code": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "A [tax code](https://stripe.com/docs/tax/tax-categories) ID." }, "unit_label": { "anyOf": [ { "maxLength": 12, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal. May only be set if `type=service`." }, "url": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "A URL of a publicly-accessible webpage for this product." } }, "type": "object", "x-stripeMostCommon": [ "active", "default_price", "description", "metadata", "name", "tax_code" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a product" } }, "/v1/products/{product}/features": { "get": { "description": "

Retrieve a list of features for a product

", "operationId": "GetProductsProductFeatures", "parameters": [ { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "in": "path", "name": "product", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/product_feature" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "EntitlementsResourceProductFeatureList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all features attached to a product" }, "post": { "description": "

Creates a product_feature, which represents a feature attachment to a product

", "operationId": "PostProductsProductFeatures", "parameters": [ { "in": "path", "name": "product", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "entitlement_feature": { "description": "The ID of the [Feature](https://stripe.com/docs/api/entitlements/feature) object attached to this product.", "maxLength": 5000, "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "required": [ "entitlement_feature" ], "type": "object", "x-stripeMostCommon": [ "entitlement_feature" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_feature" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Attach a feature to a product" } }, "/v1/products/{product}/features/{id}": { "delete": { "description": "

Deletes the feature attachment to a product

", "operationId": "DeleteProductsProductFeaturesId", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "in": "path", "name": "product", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted_product_feature" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Remove a feature from a product" }, "get": { "description": "

Retrieves a product_feature, which represents a feature attachment to a product

", "operationId": "GetProductsProductFeaturesId", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "The ID of the product_feature.", "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "description": "The ID of the product.", "in": "path", "name": "product", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_feature" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a product_feature" } }, "/v1/promotion_codes": { "get": { "description": "

Returns a list of your promotion codes.

", "operationId": "GetPromotionCodes", "parameters": [ { "description": "Filter promotion codes by whether they are active.", "in": "query", "name": "active", "required": false, "schema": { "type": "boolean" }, "style": "form" }, { "description": "Only return promotion codes that have this case-insensitive code.", "in": "query", "name": "code", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Only return promotion codes for this coupon.", "in": "query", "name": "coupon", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.", "explode": true, "in": "query", "name": "created", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "description": "Minimum value to filter by (exclusive)", "type": "integer" }, "gte": { "description": "Minimum value to filter by (inclusive)", "type": "integer" }, "lt": { "description": "Maximum value to filter by (exclusive)", "type": "integer" }, "lte": { "description": "Maximum value to filter by (inclusive)", "type": "integer" } }, "title": "range_query_specs", "type": "object", "x-stripeMostCommon": [ "gt", "gte", "lt", "lte" ] }, { "type": "integer" } ] }, "style": "deepObject" }, { "description": "Only return promotion codes that are restricted to this customer.", "in": "query", "name": "customer", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Only return promotion codes that are restricted to this account.", "in": "query", "name": "customer_account", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/promotion_code" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/promotion_codes", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "PromotionCodesResourcePromotionCodeList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all promotion codes" }, "post": { "description": "

A promotion code points to a coupon. You can optionally restrict the code to a specific customer, redemption limit, and expiration date.

", "operationId": "PostPromotionCodes", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "restrictions": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "active": { "description": "Whether the promotion code is currently active.", "type": "boolean" }, "code": { "description": "The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for a specific customer. Valid characters are lower case letters (a-z), upper case letters (A-Z), and digits (0-9).\n\nIf left blank, we will generate one automatically.", "maxLength": 500, "type": "string" }, "coupon": { "description": "The coupon for this promotion code.", "maxLength": 5000, "type": "string" }, "customer": { "description": "The customer that this promotion code can be used by. If not set, the promotion code can be used by all customers.", "maxLength": 5000, "type": "string" }, "customer_account": { "description": "The account that this promotion code can be used by. If not set, the promotion code can be used by all accounts.", "maxLength": 5000, "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "expires_at": { "description": "The timestamp at which this promotion code will expire. If the coupon has specified a `redeems_by`, then this value cannot be after the coupon's `redeems_by`.", "format": "unix-time", "type": "integer" }, "max_redemptions": { "description": "A positive integer specifying the number of times the promotion code can be redeemed. If the coupon has specified a `max_redemptions`, then this value cannot be greater than the coupon's `max_redemptions`.", "type": "integer" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "restrictions": { "description": "Settings that restrict the redemption of the promotion code.", "properties": { "currency_options": { "additionalProperties": { "properties": { "minimum_amount": { "description": "Minimum amount required to redeem this Promotion Code into a Coupon (e.g., a purchase must be $100 or more to work).", "type": "integer" } }, "title": "currency_option", "type": "object", "x-stripeMostCommon": [ "minimum_amount" ] }, "description": "Promotion codes defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).", "type": "object" }, "first_time_transaction": { "description": "A Boolean indicating if the Promotion Code should only be redeemed for Customers without any successful payments or invoices", "type": "boolean" }, "minimum_amount": { "description": "Minimum amount required to redeem this Promotion Code into a Coupon (e.g., a purchase must be $100 or more to work).", "type": "integer" }, "minimum_amount_currency": { "description": "Three-letter [ISO code](https://stripe.com/docs/currencies) for minimum_amount", "format": "currency", "type": "string" } }, "title": "restrictions_params", "type": "object", "x-stripeMostCommon": [ "currency_options", "first_time_transaction", "minimum_amount", "minimum_amount_currency" ] } }, "required": [ "coupon" ], "type": "object", "x-stripeMostCommon": [ "code", "coupon", "metadata" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/promotion_code" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a promotion code" } }, "/v1/promotion_codes/{promotion_code}": { "get": { "description": "

Retrieves the promotion code with the given ID. In order to retrieve a promotion code by the customer-facing code use list with the desired code.

", "operationId": "GetPromotionCodesPromotionCode", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "promotion_code", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/promotion_code" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a promotion code" }, "post": { "description": "

Updates the specified promotion code by setting the values of the parameters passed. Most fields are, by design, not editable.

", "operationId": "PostPromotionCodesPromotionCode", "parameters": [ { "in": "path", "name": "promotion_code", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "restrictions": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "active": { "description": "Whether the promotion code is currently active. A promotion code can only be reactivated when the coupon is still valid and the promotion code is otherwise redeemable.", "type": "boolean" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "restrictions": { "description": "Settings that restrict the redemption of the promotion code.", "properties": { "currency_options": { "additionalProperties": { "properties": { "minimum_amount": { "description": "Minimum amount required to redeem this Promotion Code into a Coupon (e.g., a purchase must be $100 or more to work).", "type": "integer" } }, "title": "currency_option", "type": "object", "x-stripeMostCommon": [ "minimum_amount" ] }, "description": "Promotion codes defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).", "type": "object" } }, "title": "restrictions_params", "type": "object", "x-stripeMostCommon": [ "currency_options" ] } }, "type": "object", "x-stripeMostCommon": [ "metadata" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/promotion_code" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a promotion code" } }, "/v1/quotes": { "get": { "description": "

Returns a list of your quotes.

", "operationId": "GetQuotes", "parameters": [ { "description": "The ID of the customer whose quotes will be retrieved.", "in": "query", "name": "customer", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "The ID of the account whose quotes will be retrieved.", "in": "query", "name": "customer_account", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "The subscription which the quote updates.", "in": "query", "name": "from_subscription", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "The status of the quote.", "in": "query", "name": "status", "required": false, "schema": { "enum": [ "accepted", "accepting", "canceled", "draft", "open", "stale" ], "type": "string" }, "style": "form" }, { "description": "Provides a list of quotes that are associated with the specified test clock. The response will not include quotes with test clocks if this and the customer parameter is not set.", "in": "query", "name": "test_clock", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/quote" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/quotes", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "QuotesResourceQuoteList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all quotes" }, "post": { "description": "

A quote models prices and services for a customer. Default options for header, description, footer, and expires_at can be set in the dashboard via the quote template.

", "operationId": "PostQuotes", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "application_fee_amount": { "explode": true, "style": "deepObject" }, "application_fee_percent": { "explode": true, "style": "deepObject" }, "automatic_tax": { "explode": true, "style": "deepObject" }, "default_tax_rates": { "explode": true, "style": "deepObject" }, "description": { "explode": true, "style": "deepObject" }, "discounts": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "footer": { "explode": true, "style": "deepObject" }, "from_quote": { "explode": true, "style": "deepObject" }, "header": { "explode": true, "style": "deepObject" }, "invoice_settings": { "explode": true, "style": "deepObject" }, "line_items": { "explode": true, "style": "deepObject" }, "lines": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "on_behalf_of": { "explode": true, "style": "deepObject" }, "subscription_data": { "explode": true, "style": "deepObject" }, "subscription_data_overrides": { "explode": true, "style": "deepObject" }, "transfer_data": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "allow_backdated_lines": { "description": "Set to true to allow quote lines to have `starts_at` in the past if collection is paused between `starts_at` and now.", "type": "boolean" }, "application_fee_amount": { "anyOf": [ { "type": "integer" }, { "enum": [ "" ], "type": "string" } ], "description": "The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. There cannot be any line items with recurring prices when using this field." }, "application_fee_percent": { "anyOf": [ { "type": "number" }, { "enum": [ "" ], "type": "string" } ], "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. There must be at least 1 line item with a recurring price to use this field." }, "automatic_tax": { "description": "Settings for automatic tax lookup for this quote and resulting invoices and subscriptions.", "properties": { "enabled": { "description": "Controls whether Stripe will automatically compute tax on the resulting invoices or subscriptions as well as the quote itself.", "type": "boolean" }, "liability": { "description": "The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.", "properties": { "account": { "description": "The connected account being referenced when `type` is `account`.", "type": "string" }, "type": { "description": "Type of the account referenced in the request.", "enum": [ "account", "self" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "param", "type": "object", "x-stripeMostCommon": [ "account", "type" ] } }, "required": [ "enabled" ], "title": "automatic_tax_param", "type": "object", "x-stripeMostCommon": [ "enabled", "liability" ] }, "collection_method": { "description": "Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay invoices at the end of the subscription cycle or at invoice finalization using the default payment method attached to the subscription or customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically`.", "enum": [ "charge_automatically", "send_invoice" ], "type": "string" }, "customer": { "description": "The customer for which this quote belongs to. A customer is required before finalizing the quote. Once specified, it cannot be changed.", "maxLength": 5000, "type": "string" }, "customer_account": { "description": "The account for which this quote belongs to. A customer or account is required before finalizing the quote. Once specified, it cannot be changed.", "maxLength": 5000, "type": "string" }, "default_tax_rates": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The tax rates that will apply to any line item that does not have `tax_rates` set." }, "description": { "anyOf": [ { "maxLength": 500, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "A description that will be displayed on the quote PDF. If no value is passed, the default description configured in your [quote template settings](https://dashboard.stripe.com/settings/billing/quote) will be used." }, "discounts": { "anyOf": [ { "items": { "properties": { "coupon": { "description": "ID of the coupon to create a new discount for.", "maxLength": 5000, "type": "string" }, "discount": { "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", "maxLength": 5000, "type": "string" }, "discount_end": { "description": "Details to determine how long the discount should be applied for.", "properties": { "duration": { "description": "Time span for the redeemed discount.", "properties": { "interval": { "description": "Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.", "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "description": "The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.", "type": "integer" } }, "required": [ "interval", "interval_count" ], "title": "discount_end_duration_specs", "type": "object", "x-stripeMostCommon": [ "interval", "interval_count" ] }, "timestamp": { "description": "A precise Unix timestamp for the discount to end. Must be in the future.", "format": "unix-time", "type": "integer" }, "type": { "description": "The type of calculation made to determine when the discount ends.", "enum": [ "duration", "timestamp" ], "type": "string" } }, "required": [ "type" ], "title": "discount_end", "type": "object", "x-stripeMostCommon": [ "duration", "timestamp", "type" ] }, "promotion_code": { "description": "ID of the promotion code to create a new discount for.", "maxLength": 5000, "type": "string" } }, "title": "discounts_data_param", "type": "object", "x-stripeMostCommon": [ "coupon" ] }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The discounts applied to the quote." }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "expires_at": { "description": "A future timestamp on which the quote will be canceled if in `open` or `draft` status. Measured in seconds since the Unix epoch. If no value is passed, the default expiration date configured in your [quote template settings](https://dashboard.stripe.com/settings/billing/quote) will be used.", "format": "unix-time", "type": "integer" }, "footer": { "anyOf": [ { "maxLength": 500, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "A footer that will be displayed on the quote PDF. If no value is passed, the default footer configured in your [quote template settings](https://dashboard.stripe.com/settings/billing/quote) will be used." }, "from_quote": { "description": "Clone an existing quote. The new quote will be created in `status=draft`. When using this parameter, you cannot specify any other parameters except for `expires_at`.", "properties": { "is_revision": { "description": "Whether this quote is a revision of the previous quote.", "type": "boolean" }, "quote": { "description": "The `id` of the quote that will be cloned.", "maxLength": 5000, "type": "string" } }, "required": [ "quote" ], "title": "from_quote_params", "type": "object", "x-stripeMostCommon": [ "is_revision", "quote" ] }, "header": { "anyOf": [ { "maxLength": 50, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "A header that will be displayed on the quote PDF. If no value is passed, the default header configured in your [quote template settings](https://dashboard.stripe.com/settings/billing/quote) will be used." }, "invoice_settings": { "description": "All invoices will be billed using the specified settings.", "properties": { "days_until_due": { "description": "Number of days within which a customer must pay the invoice generated by this quote. This value will be `null` for quotes where `collection_method=charge_automatically`.", "type": "integer" }, "issuer": { "description": "The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.", "properties": { "account": { "description": "The connected account being referenced when `type` is `account`.", "type": "string" }, "type": { "description": "Type of the account referenced in the request.", "enum": [ "account", "self" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "param", "type": "object", "x-stripeMostCommon": [ "account", "type" ] } }, "title": "quote_param", "type": "object", "x-stripeMostCommon": [ "custom_fields", "days_until_due", "description", "footer", "issuer" ] }, "line_items": { "description": "A list of line items the customer is being quoted for. Each line item includes information about the product, the quantity, and the resulting cost.", "items": { "properties": { "discounts": { "anyOf": [ { "items": { "properties": { "coupon": { "description": "ID of the coupon to create a new discount for.", "maxLength": 5000, "type": "string" }, "discount": { "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", "maxLength": 5000, "type": "string" }, "discount_end": { "description": "Details to determine how long the discount should be applied for.", "properties": { "duration": { "description": "Time span for the redeemed discount.", "properties": { "interval": { "description": "Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.", "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "description": "The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.", "type": "integer" } }, "required": [ "interval", "interval_count" ], "title": "discount_end_duration_specs", "type": "object", "x-stripeMostCommon": [ "interval", "interval_count" ] }, "timestamp": { "description": "A precise Unix timestamp for the discount to end. Must be in the future.", "format": "unix-time", "type": "integer" }, "type": { "description": "The type of calculation made to determine when the discount ends.", "enum": [ "duration", "timestamp" ], "type": "string" } }, "required": [ "type" ], "title": "discount_end", "type": "object", "x-stripeMostCommon": [ "duration", "timestamp", "type" ] }, "promotion_code": { "description": "ID of the promotion code to create a new discount for.", "maxLength": 5000, "type": "string" } }, "title": "discounts_data_param", "type": "object", "x-stripeMostCommon": [ "coupon" ] }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The discounts applied to this line item." }, "price": { "description": "The ID of the price object. One of `price` or `price_data` is required.", "maxLength": 5000, "type": "string" }, "price_data": { "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.", "properties": { "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "product": { "description": "The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.", "maxLength": 5000, "type": "string" }, "recurring": { "description": "The recurring components of a price such as `interval` and `interval_count`.", "properties": { "interval": { "description": "Specifies billing frequency. Either `day`, `week`, `month` or `year`.", "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "description": "The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).", "type": "integer" } }, "required": [ "interval" ], "title": "recurring_adhoc", "type": "object", "x-stripeMostCommon": [ "interval" ] }, "tax_behavior": { "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.", "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" }, "unit_amount": { "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.", "type": "integer" }, "unit_amount_decimal": { "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", "format": "decimal", "type": "string" } }, "required": [ "currency", "product" ], "title": "price_data", "type": "object", "x-stripeMostCommon": [ "currency", "product", "unit_amount" ] }, "quantity": { "description": "The quantity of the line item.", "type": "integer" }, "tax_rates": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The tax rates which apply to the line item. When set, the `default_tax_rates` on the quote do not apply to this line item." } }, "title": "line_item_create_params", "type": "object", "x-stripeMostCommon": [ "price", "quantity" ] }, "type": "array" }, "lines": { "description": "A list of [quote lines](https://docs.stripe.com/api/quote_lines) on the quote. These lines describe changes, in the order provided, that will be used to create new subscription schedules or update existing subscription schedules when the quote is accepted.", "items": { "properties": { "actions": { "description": "An array of operations the quote line performs.", "items": { "properties": { "add_discount": { "description": "Details for the `add_discount` type.", "properties": { "coupon": { "description": "The coupon code to redeem.", "maxLength": 5000, "type": "string" }, "discount": { "description": "An ID of an existing discount for a coupon that was already redeemed.", "maxLength": 5000, "type": "string" }, "discount_end": { "description": "Details to determine how long the discount should be applied for.", "properties": { "type": { "description": "The type of calculation made to determine when the discount ends.", "enum": [ "line_ends_at" ], "type": "string" } }, "required": [ "type" ], "title": "line_discount_end_specs", "type": "object", "x-stripeMostCommon": [ "type" ] }, "index": { "description": "The index, starting at 0, at which to position the new discount. When not supplied, Stripe defaults to appending the discount to the end of the `discounts` array.", "type": "integer" }, "promotion_code": { "description": "The promotion code to redeem.", "maxLength": 5000, "type": "string" } }, "title": "add_discount_specs", "type": "object", "x-stripeMostCommon": [ "coupon", "discount", "discount_end", "index", "promotion_code" ] }, "add_item": { "description": "Details for the `add_item` type.", "properties": { "discounts": { "description": "The discounts applied to the item. Subscription item discounts are applied before subscription discounts.", "items": { "properties": { "coupon": { "description": "ID of the coupon to create a new discount for.", "maxLength": 5000, "type": "string" }, "discount": { "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", "maxLength": 5000, "type": "string" }, "discount_end": { "description": "Details to determine how long the discount should be applied for.", "properties": { "duration": { "description": "Time span for the redeemed discount.", "properties": { "interval": { "description": "Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.", "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "description": "The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.", "type": "integer" } }, "required": [ "interval", "interval_count" ], "title": "discount_end_duration_specs", "type": "object", "x-stripeMostCommon": [ "interval", "interval_count" ] }, "timestamp": { "description": "A precise Unix timestamp for the discount to end. Must be in the future.", "format": "unix-time", "type": "integer" }, "type": { "description": "The type of calculation made to determine when the discount ends.", "enum": [ "duration", "timestamp" ], "type": "string" } }, "required": [ "type" ], "title": "discount_end", "type": "object", "x-stripeMostCommon": [ "duration", "timestamp", "type" ] }, "promotion_code": { "description": "ID of the promotion code to create a new discount for.", "maxLength": 5000, "type": "string" } }, "title": "discounts_data_param", "type": "object", "x-stripeMostCommon": [ "coupon" ] }, "type": "array" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "price": { "description": "The ID of the price object.", "maxLength": 5000, "type": "string" }, "quantity": { "description": "Quantity for this item.", "type": "integer" }, "tax_rates": { "description": "The tax rates that apply to this subscription item. When set, the `default_tax_rates` on the subscription do not apply to this `subscription_item`.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "trial": { "description": "Options that configure the trial on the subscription item.", "properties": { "converts_to": { "description": "List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. Currently only supports at most 1 price ID.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "type": { "description": "Determines the type of trial for this item.", "enum": [ "free", "paid" ], "type": "string" } }, "required": [ "type" ], "title": "trial_specs", "type": "object", "x-stripeMostCommon": [ "converts_to", "type" ] } }, "required": [ "price" ], "title": "add_item_specs", "type": "object", "x-stripeMostCommon": [ "discounts", "metadata", "price", "quantity", "tax_rates", "trial" ] }, "add_metadata": { "additionalProperties": { "type": "string" }, "description": "Details for the `add_metadata` type: specify a hash of key-value pairs.", "type": "object" }, "remove_discount": { "description": "Details for the `remove_discount` type.", "properties": { "coupon": { "description": "The coupon code to remove from the `discounts` array.", "maxLength": 5000, "type": "string" }, "discount": { "description": "The ID of a discount to remove from the `discounts` array.", "maxLength": 5000, "type": "string" }, "promotion_code": { "description": "The ID of a promotion code to remove from the `discounts` array.", "maxLength": 5000, "type": "string" } }, "title": "remove_discount_specs", "type": "object", "x-stripeMostCommon": [ "coupon", "discount", "promotion_code" ] }, "remove_item": { "description": "Details for the `remove_item` type.", "properties": { "price": { "description": "ID of a price to remove.", "maxLength": 5000, "type": "string" } }, "required": [ "price" ], "title": "remove_item_specs", "type": "object", "x-stripeMostCommon": [ "price" ] }, "remove_metadata": { "description": "Details for the `remove_metadata` type: specify an array of metadata keys.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "set_discounts": { "description": "Details for the `set_discounts` type.", "items": { "properties": { "coupon": { "description": "The coupon code to replace the `discounts` array with.", "maxLength": 5000, "type": "string" }, "discount": { "description": "An ID of an existing discount to replace the `discounts` array with.", "maxLength": 5000, "type": "string" }, "promotion_code": { "description": "An ID of an existing promotion code to replace the `discounts` array with.", "maxLength": 5000, "type": "string" } }, "title": "set_discount_specs", "type": "object", "x-stripeMostCommon": [ "coupon", "discount", "promotion_code" ] }, "type": "array" }, "set_items": { "description": "Details for the `set_items` type.", "items": { "properties": { "discounts": { "description": "If an item with the `price` already exists, passing this will override the `discounts` array on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `discounts`.", "items": { "properties": { "coupon": { "description": "ID of the coupon to create a new discount for.", "maxLength": 5000, "type": "string" }, "discount": { "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", "maxLength": 5000, "type": "string" }, "discount_end": { "description": "Details to determine how long the discount should be applied for.", "properties": { "duration": { "description": "Time span for the redeemed discount.", "properties": { "interval": { "description": "Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.", "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "description": "The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.", "type": "integer" } }, "required": [ "interval", "interval_count" ], "title": "discount_end_duration_specs", "type": "object", "x-stripeMostCommon": [ "interval", "interval_count" ] }, "timestamp": { "description": "A precise Unix timestamp for the discount to end. Must be in the future.", "format": "unix-time", "type": "integer" }, "type": { "description": "The type of calculation made to determine when the discount ends.", "enum": [ "duration", "timestamp" ], "type": "string" } }, "required": [ "type" ], "title": "discount_end", "type": "object", "x-stripeMostCommon": [ "duration", "timestamp", "type" ] }, "promotion_code": { "description": "ID of the promotion code to create a new discount for.", "maxLength": 5000, "type": "string" } }, "title": "discounts_data_param", "type": "object", "x-stripeMostCommon": [ "coupon" ] }, "type": "array" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "If an item with the `price` already exists, passing this will override the `metadata` on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `metadata`.", "type": "object" }, "price": { "description": "The ID of the price object.", "maxLength": 5000, "type": "string" }, "quantity": { "description": "If an item with the `price` already exists, passing this will override the quantity on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `quantity`.", "type": "integer" }, "tax_rates": { "description": "If an item with the `price` already exists, passing this will override the `tax_rates` array on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `tax_rates`.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "trial": { "description": "If an item with the `price` already exists, passing this will override the `trial` configuration on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `trial`.", "properties": { "converts_to": { "description": "List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. Currently only supports at most 1 price ID.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "type": { "description": "Determines the type of trial for this item.", "enum": [ "free", "paid" ], "type": "string" } }, "required": [ "type" ], "title": "trial_specs", "type": "object", "x-stripeMostCommon": [ "converts_to", "type" ] } }, "required": [ "price" ], "title": "set_item_specs", "type": "object", "x-stripeMostCommon": [ "discounts", "metadata", "price", "quantity", "tax_rates", "trial" ] }, "type": "array" }, "set_metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Details for the `set_metadata` type: specify an array of key-value pairs." }, "type": { "description": "The type of action the quote line performs.", "enum": [ "add_discount", "add_item", "add_metadata", "clear_discounts", "clear_metadata", "remove_discount", "remove_item", "remove_metadata", "set_discounts", "set_items", "set_metadata" ], "type": "string" } }, "required": [ "type" ], "title": "action_specs", "type": "object", "x-stripeMostCommon": [ "add_discount", "add_item", "add_metadata", "remove_discount", "remove_item", "remove_metadata", "set_discounts", "set_items", "set_metadata", "type" ] }, "type": "array" }, "applies_to": { "description": "Details to identify the subscription schedule the quote line applies to.", "properties": { "new_reference": { "description": "A custom string that identifies a new subscription schedule being created upon quote acceptance. All quote lines with the same `new_reference` field will be applied to the creation of a new subscription schedule.", "maxLength": 50, "type": "string" }, "subscription_schedule": { "description": "The ID of the schedule the line applies to.", "maxLength": 5000, "type": "string" }, "type": { "description": "Describes whether the quote line is affecting a new schedule or an existing schedule.", "enum": [ "new_reference", "subscription_schedule" ], "type": "string" } }, "required": [ "type" ], "title": "applies_to_specs", "type": "object", "x-stripeMostCommon": [ "new_reference", "subscription_schedule", "type" ] }, "billing_cycle_anchor": { "description": "For point-in-time quote lines (having no `ends_at` timestamp), this attribute lets you set or remove whether the subscription's billing cycle anchor is reset at the Quote Line `starts_at` timestamp.For time-span based quote lines (having both `starts_at` and `ends_at`), the only valid value is `automatic`, which removes any previously configured billing cycle anchor resets during the window of time spanning the quote line.", "enum": [ "automatic", "line_starts_at" ], "type": "string" }, "cancel_subscription_schedule": { "description": "A point-in-time operation that cancels an existing subscription schedule at the line's starts_at timestamp. Currently only compatible with `quote_acceptance_date` for `starts_at`. When using cancel_subscription_schedule, the subscription schedule on the quote remains unalterable, except for modifications to the metadata, collection_method or invoice_settings.", "properties": { "cancel_at": { "description": "Timestamp helper to cancel the underlying schedule on the accompanying line's start date. Must be set to `line_starts_at`.", "enum": [ "line_starts_at" ], "type": "string" }, "invoice_now": { "description": "If the subscription schedule is `active`, indicates if a final invoice will be generated that contains any un-invoiced metered usage and new/pending proration invoice items. Boolean that defaults to `true`.", "type": "boolean" }, "prorate": { "description": "If the subscription schedule is `active`, indicates if the cancellation should be prorated. Boolean that defaults to `true`.", "type": "boolean" } }, "required": [ "cancel_at" ], "title": "cancel_subscription_schedule_specs", "type": "object", "x-stripeMostCommon": [ "cancel_at", "invoice_now", "prorate" ] }, "ends_at": { "description": "Details to identify the end of the time range modified by the proposed change. If not supplied, the quote line is considered a point-in-time operation that only affects the exact timestamp at `starts_at`, and a restricted set of attributes is supported on the quote line.", "properties": { "discount_end": { "description": "Use the `end` time of a given discount.", "properties": { "discount": { "description": "The ID of a specific discount.", "maxLength": 5000, "type": "string" } }, "required": [ "discount" ], "title": "discount_end_specs", "type": "object", "x-stripeMostCommon": [ "discount" ] }, "duration": { "description": "Time span for the quote line starting from the `starts_at` date.", "properties": { "interval": { "description": "Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.", "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "description": "The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.", "type": "integer" } }, "required": [ "interval", "interval_count" ], "title": "duration_specs", "type": "object", "x-stripeMostCommon": [ "interval", "interval_count" ] }, "timestamp": { "description": "A precise Unix timestamp.", "format": "unix-time", "type": "integer" }, "type": { "description": "Select a way to pass in `ends_at`.", "enum": [ "billing_period_end", "discount_end", "duration", "quote_acceptance_date", "schedule_end", "timestamp", "upcoming_invoice" ], "type": "string" } }, "required": [ "type" ], "title": "ends_at_specs", "type": "object", "x-stripeMostCommon": [ "discount_end", "duration", "timestamp", "type" ] }, "proration_behavior": { "description": "Changes to how Stripe handles prorations during the quote line's time span. Affects if and how prorations are created when a future phase starts.", "enum": [ "always_invoice", "create_prorations", "none" ], "type": "string" }, "set_pause_collection": { "description": "Defines how to pause collection for the underlying subscription throughout the duration of the amendment.", "properties": { "set": { "description": "Details of the pause_collection behavior to apply to the amendment.", "properties": { "behavior": { "description": "The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.", "enum": [ "keep_as_draft", "mark_uncollectible", "void" ], "type": "string" } }, "required": [ "behavior" ], "title": "pause_collection_params", "type": "object", "x-stripeMostCommon": [ "behavior" ] }, "type": { "description": "Determines the type of the pause_collection amendment.", "enum": [ "remove", "set" ], "type": "string" } }, "required": [ "type" ], "title": "specs", "type": "object", "x-stripeMostCommon": [ "set", "type" ] }, "set_schedule_end": { "description": "Timestamp helper to end the underlying schedule early, based on the acompanying line's start or end date.", "enum": [ "line_ends_at", "line_starts_at" ], "type": "string" }, "starts_at": { "description": "Details to identify the earliest timestamp where the proposed change should take effect.", "properties": { "discount_end": { "description": "Use the `end` time of a given discount.", "properties": { "discount": { "description": "The ID of a specific discount.", "maxLength": 5000, "type": "string" } }, "required": [ "discount" ], "title": "discount_end_specs", "type": "object", "x-stripeMostCommon": [ "discount" ] }, "line_ends_at": { "description": "The timestamp the given line ends at.", "properties": { "index": { "description": "The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array.", "type": "integer" } }, "title": "line_id_specs", "type": "object", "x-stripeMostCommon": [ "index" ] }, "timestamp": { "description": "A precise Unix timestamp.", "format": "unix-time", "type": "integer" }, "type": { "description": "Select a way to pass in `starts_at`.", "enum": [ "discount_end", "line_ends_at", "now", "quote_acceptance_date", "schedule_end", "timestamp", "upcoming_invoice" ], "type": "string" } }, "required": [ "type" ], "title": "starts_at_specs", "type": "object", "x-stripeMostCommon": [ "discount_end", "line_ends_at", "timestamp", "type" ] }, "trial_settings": { "description": "Settings related to subscription trials.", "properties": { "end_behavior": { "description": "Defines how the subscription should behave when a trial ends.", "properties": { "prorate_up_front": { "description": "Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.", "enum": [ "defer", "include" ], "type": "string" } }, "title": "end_behavior_specs", "type": "object", "x-stripeMostCommon": [ "prorate_up_front" ] } }, "title": "trial_settings_specs", "type": "object", "x-stripeMostCommon": [ "end_behavior" ] } }, "title": "quote_line_create_specs", "type": "object", "x-stripeMostCommon": [ "actions", "applies_to", "billing_cycle_anchor", "cancel_subscription_schedule", "ends_at", "proration_behavior", "set_pause_collection", "set_schedule_end", "starts_at", "trial_settings" ] }, "type": "array" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "on_behalf_of": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "The account on behalf of which to charge." }, "subscription_data": { "description": "When creating a subscription or subscription schedule, the specified configuration data will be used. There must be at least one line item with a recurring price for a subscription or subscription schedule to be created. A subscription schedule is created if `subscription_data[effective_date]` is present and in the future, otherwise a subscription is created.", "properties": { "bill_on_acceptance": { "description": "Describes the period to bill for upon accepting the quote.", "properties": { "bill_from": { "description": "The start of the period to bill from when the Quote is accepted.", "properties": { "line_starts_at": { "description": "Details of a Quote line to start the bill period from.", "properties": { "id": { "description": "The ID of a quote line.", "maxLength": 5000, "type": "string" }, "index": { "description": "The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array.", "type": "integer" } }, "title": "line_index_id_specs", "type": "object", "x-stripeMostCommon": [ "id", "index" ] }, "timestamp": { "description": "A precise Unix timestamp.", "format": "unix-time", "type": "integer" }, "type": { "description": "The type of method to specify the `bill_from` time.", "enum": [ "line_starts_at", "now", "pause_collection_start", "quote_acceptance_date", "timestamp" ], "type": "string" } }, "required": [ "type" ], "title": "bill_from_specs", "type": "object", "x-stripeMostCommon": [ "line_starts_at", "timestamp", "type" ] }, "bill_until": { "description": "The end of the period to bill until when the Quote is accepted.", "properties": { "duration": { "description": "Details of the duration over which to bill.", "properties": { "interval": { "description": "Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.", "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "description": "The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.", "type": "integer" } }, "required": [ "interval", "interval_count" ], "title": "duration_specs", "type": "object", "x-stripeMostCommon": [ "interval", "interval_count" ] }, "line_ends_at": { "description": "Details of a Quote line item from which to bill until.", "properties": { "id": { "description": "The ID of a quote line.", "maxLength": 5000, "type": "string" }, "index": { "description": "The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array.", "type": "integer" } }, "title": "line_index_id_specs", "type": "object", "x-stripeMostCommon": [ "id", "index" ] }, "timestamp": { "description": "A precise Unix timestamp.", "format": "unix-time", "type": "integer" }, "type": { "description": "The type of method to specify the `bill_until` time.", "enum": [ "duration", "line_ends_at", "schedule_end", "timestamp", "upcoming_invoice" ], "type": "string" } }, "required": [ "type" ], "title": "bill_until_specs", "type": "object", "x-stripeMostCommon": [ "duration", "line_ends_at", "timestamp", "type" ] } }, "title": "bill_on_acceptance_specs", "type": "object", "x-stripeMostCommon": [ "bill_from", "bill_until" ] }, "billing_behavior": { "description": "Configures when the subscription schedule generates prorations for phase transitions. Possible values are `prorate_on_next_phase` or `prorate_up_front` with the default being `prorate_on_next_phase`. `prorate_on_next_phase` will apply phase changes and generate prorations at transition time. `prorate_up_front` will bill for all phases within the current billing cycle up front.", "enum": [ "prorate_on_next_phase", "prorate_up_front" ], "type": "string" }, "billing_cycle_anchor": { "description": "When specified as `reset`, the subscription will always start a new billing period when the quote is accepted.", "enum": [ "", "reset" ], "type": "string" }, "billing_mode": { "description": "Controls how prorations and invoices for subscriptions are calculated and orchestrated.", "properties": { "type": { "description": "Controls the calculation and orchestration of prorations and invoices for subscriptions.", "enum": [ "classic", "flexible" ], "type": "string" } }, "required": [ "type" ], "title": "billing_mode", "type": "object", "x-stripeMostCommon": [ "flexible", "type" ] }, "description": { "description": "The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.", "maxLength": 500, "type": "string" }, "effective_date": { "anyOf": [ { "enum": [ "current_period_end" ], "maxLength": 5000, "type": "string" }, { "format": "unix-time", "type": "integer" }, { "enum": [ "" ], "type": "string" } ], "description": "When creating a new subscription, the date of which the subscription schedule will start after the quote is accepted. When updating a subscription, the date of which the subscription will be updated using a subscription schedule. The special value `current_period_end` can be provided to update a subscription at the end of its current period. The `effective_date` is ignored if it is in the past when the quote is accepted." }, "end_behavior": { "description": "Behavior of the subscription schedule and underlying subscription when it ends.", "enum": [ "cancel", "release" ], "type": "string" }, "from_subscription": { "description": "The id of a subscription that the quote will update. By default, the quote will contain the state of the subscription (such as line items, collection method and billing thresholds) unless overridden.", "maxLength": 5000, "type": "string" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will set metadata on the subscription or subscription schedule when the quote is accepted. If a recurring price is included in `line_items`, this field will be passed to the resulting subscription's `metadata` field. If `subscription_data.effective_date` is used, this field will be passed to the resulting subscription schedule's `phases.metadata` field. Unlike object-level metadata, this field is declarative. Updates will clear prior values.", "type": "object" }, "prebilling": { "anyOf": [ { "properties": { "iterations": { "description": "This is used to determine the number of billing cycles to prebill.", "type": "integer" } }, "required": [ "iterations" ], "title": "prebilling_preview_params", "type": "object", "x-stripeMostCommon": [ "iterations" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If specified, the invoicing for the given billing cycle iterations will be processed when the quote is accepted. Cannot be used with `effective_date`." }, "proration_behavior": { "description": "Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations). When creating a subscription, valid values are `create_prorations` or `none`.\n\nWhen updating a subscription, valid values are `create_prorations`, `none`, or `always_invoice`.\n\nPassing `create_prorations` will cause proration invoice items to be created when applicable. These proration items will only be invoiced immediately under [certain conditions](https://stripe.com/docs/subscriptions/upgrading-downgrading#immediate-payment). In order to always invoice immediately for prorations, pass `always_invoice`.\n\nProrations can be disabled by passing `none`.", "enum": [ "always_invoice", "create_prorations", "none" ], "type": "string" }, "trial_period_days": { "anyOf": [ { "type": "integer" }, { "enum": [ "" ], "type": "string" } ], "description": "Integer representing the number of trial period days before the customer is charged for the first time." } }, "title": "subscription_data_create_params", "type": "object", "x-stripeMostCommon": [ "bill_on_acceptance", "billing_behavior", "billing_cycle_anchor", "billing_mode", "description", "effective_date", "end_behavior", "from_subscription", "metadata", "prebilling", "proration_behavior", "subscription_engine_version", "trial_period_days" ] }, "subscription_data_overrides": { "description": "List representing overrides for `subscription_data` configurations for specific subscription schedules.", "items": { "properties": { "applies_to": { "description": "Whether the override applies to an existing Subscription Schedule or a new Subscription Schedule.", "properties": { "new_reference": { "description": "A custom string that identifies a new subscription schedule being created upon quote acceptance. All quote lines with the same `new_reference` field will be applied to the creation of a new subscription schedule.", "maxLength": 50, "type": "string" }, "subscription_schedule": { "description": "The ID of the schedule the line applies to.", "maxLength": 5000, "type": "string" }, "type": { "description": "Describes whether the quote line is affecting a new schedule or an existing schedule.", "enum": [ "new_reference", "subscription_schedule" ], "type": "string" } }, "required": [ "type" ], "title": "applies_to_specs", "type": "object", "x-stripeMostCommon": [ "new_reference", "subscription_schedule", "type" ] }, "bill_on_acceptance": { "description": "Describes the period to bill for upon accepting the quote.", "properties": { "bill_from": { "description": "The start of the period to bill from when the Quote is accepted.", "properties": { "line_starts_at": { "description": "Details of a Quote line to start the bill period from.", "properties": { "id": { "description": "The ID of a quote line.", "maxLength": 5000, "type": "string" }, "index": { "description": "The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array.", "type": "integer" } }, "title": "line_index_id_specs", "type": "object", "x-stripeMostCommon": [ "id", "index" ] }, "timestamp": { "description": "A precise Unix timestamp.", "format": "unix-time", "type": "integer" }, "type": { "description": "The type of method to specify the `bill_from` time.", "enum": [ "line_starts_at", "now", "pause_collection_start", "quote_acceptance_date", "timestamp" ], "type": "string" } }, "required": [ "type" ], "title": "bill_from_specs", "type": "object", "x-stripeMostCommon": [ "line_starts_at", "timestamp", "type" ] }, "bill_until": { "description": "The end of the period to bill until when the Quote is accepted.", "properties": { "duration": { "description": "Details of the duration over which to bill.", "properties": { "interval": { "description": "Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.", "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "description": "The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.", "type": "integer" } }, "required": [ "interval", "interval_count" ], "title": "duration_specs", "type": "object", "x-stripeMostCommon": [ "interval", "interval_count" ] }, "line_ends_at": { "description": "Details of a Quote line item from which to bill until.", "properties": { "id": { "description": "The ID of a quote line.", "maxLength": 5000, "type": "string" }, "index": { "description": "The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array.", "type": "integer" } }, "title": "line_index_id_specs", "type": "object", "x-stripeMostCommon": [ "id", "index" ] }, "timestamp": { "description": "A precise Unix timestamp.", "format": "unix-time", "type": "integer" }, "type": { "description": "The type of method to specify the `bill_until` time.", "enum": [ "duration", "line_ends_at", "schedule_end", "timestamp", "upcoming_invoice" ], "type": "string" } }, "required": [ "type" ], "title": "bill_until_specs", "type": "object", "x-stripeMostCommon": [ "duration", "line_ends_at", "timestamp", "type" ] } }, "title": "bill_on_acceptance_specs", "type": "object", "x-stripeMostCommon": [ "bill_from", "bill_until" ] }, "billing_behavior": { "description": "Configures when the subscription schedule generates prorations for phase transitions. Possible values are `prorate_on_next_phase` or `prorate_up_front` with the default being `prorate_on_next_phase`. `prorate_on_next_phase` will apply phase changes and generate prorations at transition time. `prorate_up_front` will bill for all phases within the current billing cycle up front.", "enum": [ "prorate_on_next_phase", "prorate_up_front" ], "type": "string" }, "customer": { "description": "The customer the Subscription Data override applies to. This is only relevant when `applies_to.type=new_reference`.", "maxLength": 5000, "type": "string" }, "description": { "description": "The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.", "maxLength": 500, "type": "string" }, "end_behavior": { "description": "Behavior of the subscription schedule and underlying subscription when it ends.", "enum": [ "cancel", "release" ], "type": "string" }, "proration_behavior": { "description": "Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations). When creating a subscription, valid values are `create_prorations` or `none`.\n\nWhen updating a subscription, valid values are `create_prorations`, `none`, or `always_invoice`.\n\nPassing `create_prorations` will cause proration invoice items to be created when applicable. These proration items will only be invoiced immediately under [certain conditions](https://stripe.com/docs/subscriptions/upgrading-downgrading#immediate-payment). In order to always invoice immediately for prorations, pass `always_invoice`.\n\nProrations can be disabled by passing `none`.", "enum": [ "always_invoice", "create_prorations", "none" ], "type": "string" } }, "required": [ "applies_to" ], "title": "create_specs", "type": "object", "x-stripeMostCommon": [ "applies_to", "bill_on_acceptance", "billing_behavior", "customer", "description", "end_behavior", "proration_behavior" ] }, "type": "array" }, "test_clock": { "description": "ID of the test clock to attach to the quote.", "maxLength": 5000, "type": "string" }, "transfer_data": { "anyOf": [ { "properties": { "amount": { "description": "The amount that will be transferred automatically when the invoice is paid. If no amount is set, the full amount is transferred. There cannot be any line items with recurring prices when using this field.", "type": "integer" }, "amount_percent": { "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination. There must be at least 1 line item with a recurring price to use this field.", "type": "number" }, "destination": { "description": "ID of an existing, connected Stripe account.", "type": "string" } }, "required": [ "destination" ], "title": "transfer_data_specs", "type": "object", "x-stripeMostCommon": [ "amount", "amount_percent", "destination" ] }, { "enum": [ "" ], "type": "string" } ], "description": "The data with which to automatically create a Transfer for each of the invoices." } }, "type": "object", "x-stripeMostCommon": [ "line_items", "metadata" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/quote" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a quote" } }, "/v1/quotes/{quote}": { "get": { "description": "

Retrieves the quote with the given ID.

", "operationId": "GetQuotesQuote", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "quote", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/quote" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a quote" }, "post": { "description": "

A quote models prices and services for a customer.

", "operationId": "PostQuotesQuote", "parameters": [ { "in": "path", "name": "quote", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "application_fee_amount": { "explode": true, "style": "deepObject" }, "application_fee_percent": { "explode": true, "style": "deepObject" }, "automatic_tax": { "explode": true, "style": "deepObject" }, "default_tax_rates": { "explode": true, "style": "deepObject" }, "description": { "explode": true, "style": "deepObject" }, "discounts": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "footer": { "explode": true, "style": "deepObject" }, "header": { "explode": true, "style": "deepObject" }, "invoice_settings": { "explode": true, "style": "deepObject" }, "line_items": { "explode": true, "style": "deepObject" }, "lines": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "on_behalf_of": { "explode": true, "style": "deepObject" }, "subscription_data": { "explode": true, "style": "deepObject" }, "subscription_data_overrides": { "explode": true, "style": "deepObject" }, "transfer_data": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "allow_backdated_lines": { "description": "Set to true to allow quote lines to have `starts_at` in the past if collection is paused between `starts_at` and now.", "type": "boolean" }, "application_fee_amount": { "anyOf": [ { "type": "integer" }, { "enum": [ "" ], "type": "string" } ], "description": "The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. There cannot be any line items with recurring prices when using this field." }, "application_fee_percent": { "anyOf": [ { "type": "number" }, { "enum": [ "" ], "type": "string" } ], "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. There must be at least 1 line item with a recurring price to use this field." }, "automatic_tax": { "description": "Settings for automatic tax lookup for this quote and resulting invoices and subscriptions.", "properties": { "enabled": { "description": "Controls whether Stripe will automatically compute tax on the resulting invoices or subscriptions as well as the quote itself.", "type": "boolean" }, "liability": { "description": "The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.", "properties": { "account": { "description": "The connected account being referenced when `type` is `account`.", "type": "string" }, "type": { "description": "Type of the account referenced in the request.", "enum": [ "account", "self" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "param", "type": "object", "x-stripeMostCommon": [ "account", "type" ] } }, "required": [ "enabled" ], "title": "automatic_tax_param", "type": "object", "x-stripeMostCommon": [ "enabled", "liability" ] }, "collection_method": { "description": "Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay invoices at the end of the subscription cycle or at invoice finalization using the default payment method attached to the subscription or customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically`.", "enum": [ "charge_automatically", "send_invoice" ], "type": "string" }, "customer": { "description": "The customer for which this quote belongs to. A customer is required before finalizing the quote. Once specified, it cannot be changed.", "maxLength": 5000, "type": "string" }, "customer_account": { "description": "The account for which this quote belongs to. A customer or account is required before finalizing the quote. Once specified, it cannot be changed.", "maxLength": 5000, "type": "string" }, "default_tax_rates": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The tax rates that will apply to any line item that does not have `tax_rates` set." }, "description": { "anyOf": [ { "maxLength": 500, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "A description that will be displayed on the quote PDF." }, "discounts": { "anyOf": [ { "items": { "properties": { "coupon": { "description": "ID of the coupon to create a new discount for.", "maxLength": 5000, "type": "string" }, "discount": { "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", "maxLength": 5000, "type": "string" }, "discount_end": { "description": "Details to determine how long the discount should be applied for.", "properties": { "duration": { "description": "Time span for the redeemed discount.", "properties": { "interval": { "description": "Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.", "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "description": "The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.", "type": "integer" } }, "required": [ "interval", "interval_count" ], "title": "discount_end_duration_specs", "type": "object", "x-stripeMostCommon": [ "interval", "interval_count" ] }, "timestamp": { "description": "A precise Unix timestamp for the discount to end. Must be in the future.", "format": "unix-time", "type": "integer" }, "type": { "description": "The type of calculation made to determine when the discount ends.", "enum": [ "duration", "timestamp" ], "type": "string" } }, "required": [ "type" ], "title": "discount_end", "type": "object", "x-stripeMostCommon": [ "duration", "timestamp", "type" ] }, "promotion_code": { "description": "ID of the promotion code to create a new discount for.", "maxLength": 5000, "type": "string" } }, "title": "discounts_data_param", "type": "object", "x-stripeMostCommon": [ "coupon" ] }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The discounts applied to the quote." }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "expires_at": { "description": "A future timestamp on which the quote will be canceled if in `open` or `draft` status. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "footer": { "anyOf": [ { "maxLength": 500, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "A footer that will be displayed on the quote PDF." }, "header": { "anyOf": [ { "maxLength": 50, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "A header that will be displayed on the quote PDF." }, "invoice_settings": { "description": "All invoices will be billed using the specified settings.", "properties": { "days_until_due": { "description": "Number of days within which a customer must pay the invoice generated by this quote. This value will be `null` for quotes where `collection_method=charge_automatically`.", "type": "integer" }, "issuer": { "description": "The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.", "properties": { "account": { "description": "The connected account being referenced when `type` is `account`.", "type": "string" }, "type": { "description": "Type of the account referenced in the request.", "enum": [ "account", "self" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "param", "type": "object", "x-stripeMostCommon": [ "account", "type" ] } }, "title": "quote_param", "type": "object", "x-stripeMostCommon": [ "custom_fields", "days_until_due", "description", "footer", "issuer" ] }, "line_items": { "description": "A list of line items the customer is being quoted for. Each line item includes information about the product, the quantity, and the resulting cost.", "items": { "properties": { "discounts": { "anyOf": [ { "items": { "properties": { "coupon": { "description": "ID of the coupon to create a new discount for.", "maxLength": 5000, "type": "string" }, "discount": { "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", "maxLength": 5000, "type": "string" }, "discount_end": { "description": "Details to determine how long the discount should be applied for.", "properties": { "duration": { "description": "Time span for the redeemed discount.", "properties": { "interval": { "description": "Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.", "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "description": "The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.", "type": "integer" } }, "required": [ "interval", "interval_count" ], "title": "discount_end_duration_specs", "type": "object", "x-stripeMostCommon": [ "interval", "interval_count" ] }, "timestamp": { "description": "A precise Unix timestamp for the discount to end. Must be in the future.", "format": "unix-time", "type": "integer" }, "type": { "description": "The type of calculation made to determine when the discount ends.", "enum": [ "duration", "timestamp" ], "type": "string" } }, "required": [ "type" ], "title": "discount_end", "type": "object", "x-stripeMostCommon": [ "duration", "timestamp", "type" ] }, "promotion_code": { "description": "ID of the promotion code to create a new discount for.", "maxLength": 5000, "type": "string" } }, "title": "discounts_data_param", "type": "object", "x-stripeMostCommon": [ "coupon" ] }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The discounts applied to this line item." }, "id": { "description": "The ID of an existing line item on the quote.", "maxLength": 5000, "type": "string" }, "price": { "description": "The ID of the price object. One of `price` or `price_data` is required.", "maxLength": 5000, "type": "string" }, "price_data": { "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.", "properties": { "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "product": { "description": "The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.", "maxLength": 5000, "type": "string" }, "recurring": { "description": "The recurring components of a price such as `interval` and `interval_count`.", "properties": { "interval": { "description": "Specifies billing frequency. Either `day`, `week`, `month` or `year`.", "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "description": "The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).", "type": "integer" } }, "required": [ "interval" ], "title": "recurring_adhoc", "type": "object", "x-stripeMostCommon": [ "interval" ] }, "tax_behavior": { "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.", "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" }, "unit_amount": { "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.", "type": "integer" }, "unit_amount_decimal": { "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", "format": "decimal", "type": "string" } }, "required": [ "currency", "product" ], "title": "price_data", "type": "object", "x-stripeMostCommon": [ "currency", "product", "unit_amount" ] }, "quantity": { "description": "The quantity of the line item.", "type": "integer" }, "tax_rates": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The tax rates which apply to the line item. When set, the `default_tax_rates` on the quote do not apply to this line item." } }, "title": "line_item_update_params", "type": "object", "x-stripeMostCommon": [ "id", "price", "quantity" ] }, "type": "array" }, "lines": { "description": "A list of [quote lines](https://docs.stripe.com/api/quote_lines) on the quote. These lines describe changes, in the order provided, that will be used to create new subscription schedules or update existing subscription schedules when the quote is accepted.", "items": { "properties": { "actions": { "description": "An array of operations the quote line performs.", "items": { "properties": { "add_discount": { "description": "Details for the `add_discount` type.", "properties": { "coupon": { "description": "The coupon code to redeem.", "maxLength": 5000, "type": "string" }, "discount": { "description": "An ID of an existing discount for a coupon that was already redeemed.", "maxLength": 5000, "type": "string" }, "discount_end": { "description": "Details to determine how long the discount should be applied for.", "properties": { "type": { "description": "The type of calculation made to determine when the discount ends.", "enum": [ "line_ends_at" ], "type": "string" } }, "required": [ "type" ], "title": "line_discount_end_specs", "type": "object", "x-stripeMostCommon": [ "type" ] }, "index": { "description": "The index, starting at 0, at which to position the new discount. When not supplied, Stripe defaults to appending the discount to the end of the `discounts` array.", "type": "integer" }, "promotion_code": { "description": "The promotion code to redeem.", "maxLength": 5000, "type": "string" } }, "title": "add_discount_specs", "type": "object", "x-stripeMostCommon": [ "coupon", "discount", "discount_end", "index", "promotion_code" ] }, "add_item": { "description": "Details for the `add_item` type.", "properties": { "discounts": { "description": "The discounts applied to the item. Subscription item discounts are applied before subscription discounts.", "items": { "properties": { "coupon": { "description": "ID of the coupon to create a new discount for.", "maxLength": 5000, "type": "string" }, "discount": { "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", "maxLength": 5000, "type": "string" }, "discount_end": { "description": "Details to determine how long the discount should be applied for.", "properties": { "duration": { "description": "Time span for the redeemed discount.", "properties": { "interval": { "description": "Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.", "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "description": "The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.", "type": "integer" } }, "required": [ "interval", "interval_count" ], "title": "discount_end_duration_specs", "type": "object", "x-stripeMostCommon": [ "interval", "interval_count" ] }, "timestamp": { "description": "A precise Unix timestamp for the discount to end. Must be in the future.", "format": "unix-time", "type": "integer" }, "type": { "description": "The type of calculation made to determine when the discount ends.", "enum": [ "duration", "timestamp" ], "type": "string" } }, "required": [ "type" ], "title": "discount_end", "type": "object", "x-stripeMostCommon": [ "duration", "timestamp", "type" ] }, "promotion_code": { "description": "ID of the promotion code to create a new discount for.", "maxLength": 5000, "type": "string" } }, "title": "discounts_data_param", "type": "object", "x-stripeMostCommon": [ "coupon" ] }, "type": "array" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "price": { "description": "The ID of the price object.", "maxLength": 5000, "type": "string" }, "quantity": { "description": "Quantity for this item.", "type": "integer" }, "tax_rates": { "description": "The tax rates that apply to this subscription item. When set, the `default_tax_rates` on the subscription do not apply to this `subscription_item`.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "trial": { "description": "Options that configure the trial on the subscription item.", "properties": { "converts_to": { "description": "List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. Currently only supports at most 1 price ID.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "type": { "description": "Determines the type of trial for this item.", "enum": [ "free", "paid" ], "type": "string" } }, "required": [ "type" ], "title": "trial_specs", "type": "object", "x-stripeMostCommon": [ "converts_to", "type" ] } }, "required": [ "price" ], "title": "add_item_specs", "type": "object", "x-stripeMostCommon": [ "discounts", "metadata", "price", "quantity", "tax_rates", "trial" ] }, "add_metadata": { "additionalProperties": { "type": "string" }, "description": "Details for the `add_metadata` type: specify a hash of key-value pairs.", "type": "object" }, "remove_discount": { "description": "Details for the `remove_discount` type.", "properties": { "coupon": { "description": "The coupon code to remove from the `discounts` array.", "maxLength": 5000, "type": "string" }, "discount": { "description": "The ID of a discount to remove from the `discounts` array.", "maxLength": 5000, "type": "string" }, "promotion_code": { "description": "The ID of a promotion code to remove from the `discounts` array.", "maxLength": 5000, "type": "string" } }, "title": "remove_discount_specs", "type": "object", "x-stripeMostCommon": [ "coupon", "discount", "promotion_code" ] }, "remove_item": { "description": "Details for the `remove_item` type.", "properties": { "price": { "description": "ID of a price to remove.", "maxLength": 5000, "type": "string" } }, "required": [ "price" ], "title": "remove_item_specs", "type": "object", "x-stripeMostCommon": [ "price" ] }, "remove_metadata": { "description": "Details for the `remove_metadata` type: specify an array of metadata keys.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "set_discounts": { "description": "Details for the `set_discounts` type.", "items": { "properties": { "coupon": { "description": "The coupon code to replace the `discounts` array with.", "maxLength": 5000, "type": "string" }, "discount": { "description": "An ID of an existing discount to replace the `discounts` array with.", "maxLength": 5000, "type": "string" }, "promotion_code": { "description": "An ID of an existing promotion code to replace the `discounts` array with.", "maxLength": 5000, "type": "string" } }, "title": "set_discount_specs", "type": "object", "x-stripeMostCommon": [ "coupon", "discount", "promotion_code" ] }, "type": "array" }, "set_items": { "description": "Details for the `set_items` type.", "items": { "properties": { "discounts": { "description": "If an item with the `price` already exists, passing this will override the `discounts` array on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `discounts`.", "items": { "properties": { "coupon": { "description": "ID of the coupon to create a new discount for.", "maxLength": 5000, "type": "string" }, "discount": { "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", "maxLength": 5000, "type": "string" }, "discount_end": { "description": "Details to determine how long the discount should be applied for.", "properties": { "duration": { "description": "Time span for the redeemed discount.", "properties": { "interval": { "description": "Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.", "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "description": "The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.", "type": "integer" } }, "required": [ "interval", "interval_count" ], "title": "discount_end_duration_specs", "type": "object", "x-stripeMostCommon": [ "interval", "interval_count" ] }, "timestamp": { "description": "A precise Unix timestamp for the discount to end. Must be in the future.", "format": "unix-time", "type": "integer" }, "type": { "description": "The type of calculation made to determine when the discount ends.", "enum": [ "duration", "timestamp" ], "type": "string" } }, "required": [ "type" ], "title": "discount_end", "type": "object", "x-stripeMostCommon": [ "duration", "timestamp", "type" ] }, "promotion_code": { "description": "ID of the promotion code to create a new discount for.", "maxLength": 5000, "type": "string" } }, "title": "discounts_data_param", "type": "object", "x-stripeMostCommon": [ "coupon" ] }, "type": "array" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "If an item with the `price` already exists, passing this will override the `metadata` on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `metadata`.", "type": "object" }, "price": { "description": "The ID of the price object.", "maxLength": 5000, "type": "string" }, "quantity": { "description": "If an item with the `price` already exists, passing this will override the quantity on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `quantity`.", "type": "integer" }, "tax_rates": { "description": "If an item with the `price` already exists, passing this will override the `tax_rates` array on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `tax_rates`.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "trial": { "description": "If an item with the `price` already exists, passing this will override the `trial` configuration on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `trial`.", "properties": { "converts_to": { "description": "List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. Currently only supports at most 1 price ID.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "type": { "description": "Determines the type of trial for this item.", "enum": [ "free", "paid" ], "type": "string" } }, "required": [ "type" ], "title": "trial_specs", "type": "object", "x-stripeMostCommon": [ "converts_to", "type" ] } }, "required": [ "price" ], "title": "set_item_specs", "type": "object", "x-stripeMostCommon": [ "discounts", "metadata", "price", "quantity", "tax_rates", "trial" ] }, "type": "array" }, "set_metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Details for the `set_metadata` type: specify an array of key-value pairs." }, "type": { "description": "The type of action the quote line performs.", "enum": [ "add_discount", "add_item", "add_metadata", "clear_discounts", "clear_metadata", "remove_discount", "remove_item", "remove_metadata", "set_discounts", "set_items", "set_metadata" ], "type": "string" } }, "required": [ "type" ], "title": "action_specs", "type": "object", "x-stripeMostCommon": [ "add_discount", "add_item", "add_metadata", "remove_discount", "remove_item", "remove_metadata", "set_discounts", "set_items", "set_metadata", "type" ] }, "type": "array" }, "applies_to": { "description": "Details to identify the subscription schedule the quote line applies to.", "properties": { "new_reference": { "description": "A custom string that identifies a new subscription schedule being created upon quote acceptance. All quote lines with the same `new_reference` field will be applied to the creation of a new subscription schedule.", "maxLength": 50, "type": "string" }, "subscription_schedule": { "description": "The ID of the schedule the line applies to.", "maxLength": 5000, "type": "string" }, "type": { "description": "Describes whether the quote line is affecting a new schedule or an existing schedule.", "enum": [ "new_reference", "subscription_schedule" ], "type": "string" } }, "required": [ "type" ], "title": "applies_to_specs", "type": "object", "x-stripeMostCommon": [ "new_reference", "subscription_schedule", "type" ] }, "billing_cycle_anchor": { "description": "For point-in-time quote lines (having no `ends_at` timestamp), this attribute lets you set or remove whether the subscription's billing cycle anchor is reset at the Quote Line `starts_at` timestamp.For time-span based quote lines (having both `starts_at` and `ends_at`), the only valid value is `automatic`, which removes any previously configured billing cycle anchor resets during the window of time spanning the quote line.", "enum": [ "automatic", "line_starts_at" ], "type": "string" }, "cancel_subscription_schedule": { "description": "A point-in-time operation that cancels an existing subscription schedule at the line's starts_at timestamp. Currently only compatible with `quote_acceptance_date` for `starts_at`. When using cancel_subscription_schedule, the subscription schedule on the quote remains unalterable, except for modifications to the metadata, collection_method or invoice_settings.", "properties": { "cancel_at": { "description": "Timestamp helper to cancel the underlying schedule on the accompanying line's start date. Must be set to `line_starts_at`.", "enum": [ "line_starts_at" ], "type": "string" }, "invoice_now": { "description": "If the subscription schedule is `active`, indicates if a final invoice will be generated that contains any un-invoiced metered usage and new/pending proration invoice items. Boolean that defaults to `true`.", "type": "boolean" }, "prorate": { "description": "If the subscription schedule is `active`, indicates if the cancellation should be prorated. Boolean that defaults to `true`.", "type": "boolean" } }, "required": [ "cancel_at" ], "title": "cancel_subscription_schedule_specs", "type": "object", "x-stripeMostCommon": [ "cancel_at", "invoice_now", "prorate" ] }, "ends_at": { "description": "Details to identify the end of the time range modified by the proposed change. If not supplied, the quote line is considered a point-in-time operation that only affects the exact timestamp at `starts_at`, and a restricted set of attributes is supported on the quote line.", "properties": { "discount_end": { "description": "Use the `end` time of a given discount.", "properties": { "discount": { "description": "The ID of a specific discount.", "maxLength": 5000, "type": "string" } }, "required": [ "discount" ], "title": "discount_end_specs", "type": "object", "x-stripeMostCommon": [ "discount" ] }, "duration": { "description": "Time span for the quote line starting from the `starts_at` date.", "properties": { "interval": { "description": "Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.", "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "description": "The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.", "type": "integer" } }, "required": [ "interval", "interval_count" ], "title": "duration_specs", "type": "object", "x-stripeMostCommon": [ "interval", "interval_count" ] }, "timestamp": { "description": "A precise Unix timestamp.", "format": "unix-time", "type": "integer" }, "type": { "description": "Select a way to pass in `ends_at`.", "enum": [ "billing_period_end", "discount_end", "duration", "quote_acceptance_date", "schedule_end", "timestamp", "upcoming_invoice" ], "type": "string" } }, "required": [ "type" ], "title": "ends_at_specs", "type": "object", "x-stripeMostCommon": [ "discount_end", "duration", "timestamp", "type" ] }, "id": { "description": "The ID of an existing line on the quote.", "maxLength": 5000, "type": "string" }, "proration_behavior": { "description": "Changes to how Stripe handles prorations during the quote line's time span. Affects if and how prorations are created when a future phase starts.", "enum": [ "always_invoice", "create_prorations", "none" ], "type": "string" }, "set_pause_collection": { "description": "Defines how to pause collection for the underlying subscription throughout the duration of the amendment.", "properties": { "set": { "description": "Details of the pause_collection behavior to apply to the amendment.", "properties": { "behavior": { "description": "The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.", "enum": [ "keep_as_draft", "mark_uncollectible", "void" ], "type": "string" } }, "required": [ "behavior" ], "title": "pause_collection_params", "type": "object", "x-stripeMostCommon": [ "behavior" ] }, "type": { "description": "Determines the type of the pause_collection amendment.", "enum": [ "remove", "set" ], "type": "string" } }, "required": [ "type" ], "title": "specs", "type": "object", "x-stripeMostCommon": [ "set", "type" ] }, "set_schedule_end": { "description": "Timestamp helper to end the underlying schedule early, based on the acompanying line's start or end date.", "enum": [ "line_ends_at", "line_starts_at" ], "type": "string" }, "starts_at": { "description": "Details to identify the earliest timestamp where the proposed change should take effect.", "properties": { "discount_end": { "description": "Use the `end` time of a given discount.", "properties": { "discount": { "description": "The ID of a specific discount.", "maxLength": 5000, "type": "string" } }, "required": [ "discount" ], "title": "discount_end_specs", "type": "object", "x-stripeMostCommon": [ "discount" ] }, "line_ends_at": { "description": "The timestamp the given line ends at.", "properties": { "id": { "description": "The ID of a quote line.", "maxLength": 5000, "type": "string" }, "index": { "description": "The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array.", "type": "integer" } }, "title": "line_index_id_specs", "type": "object", "x-stripeMostCommon": [ "id", "index" ] }, "timestamp": { "description": "A precise Unix timestamp.", "format": "unix-time", "type": "integer" }, "type": { "description": "Select a way to pass in `starts_at`.", "enum": [ "discount_end", "line_ends_at", "now", "quote_acceptance_date", "schedule_end", "timestamp", "upcoming_invoice" ], "type": "string" } }, "required": [ "type" ], "title": "starts_at_specs", "type": "object", "x-stripeMostCommon": [ "discount_end", "line_ends_at", "timestamp", "type" ] }, "trial_settings": { "description": "Settings related to subscription trials.", "properties": { "end_behavior": { "description": "Defines how the subscription should behave when a trial ends.", "properties": { "prorate_up_front": { "description": "Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.", "enum": [ "defer", "include" ], "type": "string" } }, "title": "end_behavior_specs", "type": "object", "x-stripeMostCommon": [ "prorate_up_front" ] } }, "title": "trial_settings_specs", "type": "object", "x-stripeMostCommon": [ "end_behavior" ] } }, "title": "quote_line_update_specs", "type": "object", "x-stripeMostCommon": [ "actions", "applies_to", "billing_cycle_anchor", "cancel_subscription_schedule", "ends_at", "id", "proration_behavior", "set_pause_collection", "set_schedule_end", "starts_at", "trial_settings" ] }, "type": "array" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "on_behalf_of": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "The account on behalf of which to charge." }, "subscription_data": { "description": "When creating a subscription or subscription schedule, the specified configuration data will be used. There must be at least one line item with a recurring price for a subscription or subscription schedule to be created. A subscription schedule is created if `subscription_data[effective_date]` is present and in the future, otherwise a subscription is created.", "properties": { "bill_on_acceptance": { "anyOf": [ { "properties": { "bill_from": { "description": "The start of the period to bill from when the Quote is accepted.", "properties": { "line_starts_at": { "description": "Details of a Quote line to start the bill period from.", "properties": { "id": { "description": "The ID of a quote line.", "maxLength": 5000, "type": "string" }, "index": { "description": "The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array.", "type": "integer" } }, "title": "line_index_id_specs", "type": "object", "x-stripeMostCommon": [ "id", "index" ] }, "timestamp": { "description": "A precise Unix timestamp.", "format": "unix-time", "type": "integer" }, "type": { "description": "The type of method to specify the `bill_from` time.", "enum": [ "line_starts_at", "now", "pause_collection_start", "quote_acceptance_date", "timestamp" ], "type": "string" } }, "required": [ "type" ], "title": "bill_from_specs", "type": "object", "x-stripeMostCommon": [ "line_starts_at", "timestamp", "type" ] }, "bill_until": { "description": "The end of the period to bill until when the Quote is accepted.", "properties": { "duration": { "description": "Details of the duration over which to bill.", "properties": { "interval": { "description": "Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.", "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "description": "The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.", "type": "integer" } }, "required": [ "interval", "interval_count" ], "title": "duration_specs", "type": "object", "x-stripeMostCommon": [ "interval", "interval_count" ] }, "line_ends_at": { "description": "Details of a Quote line item from which to bill until.", "properties": { "id": { "description": "The ID of a quote line.", "maxLength": 5000, "type": "string" }, "index": { "description": "The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array.", "type": "integer" } }, "title": "line_index_id_specs", "type": "object", "x-stripeMostCommon": [ "id", "index" ] }, "timestamp": { "description": "A precise Unix timestamp.", "format": "unix-time", "type": "integer" }, "type": { "description": "The type of method to specify the `bill_until` time.", "enum": [ "duration", "line_ends_at", "schedule_end", "timestamp", "upcoming_invoice" ], "type": "string" } }, "required": [ "type" ], "title": "bill_until_specs", "type": "object", "x-stripeMostCommon": [ "duration", "line_ends_at", "timestamp", "type" ] } }, "title": "bill_on_acceptance_specs", "type": "object", "x-stripeMostCommon": [ "bill_from", "bill_until" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Describes the period to bill for upon accepting the quote." }, "billing_behavior": { "description": "Configures when the subscription schedule generates prorations for phase transitions. Possible values are `prorate_on_next_phase` or `prorate_up_front` with the default being `prorate_on_next_phase`. `prorate_on_next_phase` will apply phase changes and generate prorations at transition time. `prorate_up_front` will bill for all phases within the current billing cycle up front.", "enum": [ "prorate_on_next_phase", "prorate_up_front" ], "type": "string" }, "billing_cycle_anchor": { "description": "When specified as `reset`, the subscription will always start a new billing period when the quote is accepted.", "enum": [ "", "reset" ], "type": "string" }, "description": { "anyOf": [ { "maxLength": 500, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs." }, "effective_date": { "anyOf": [ { "enum": [ "current_period_end" ], "maxLength": 5000, "type": "string" }, { "format": "unix-time", "type": "integer" }, { "enum": [ "" ], "type": "string" } ], "description": "When creating a new subscription, the date of which the subscription schedule will start after the quote is accepted. When updating a subscription, the date of which the subscription will be updated using a subscription schedule. The special value `current_period_end` can be provided to update a subscription at the end of its current period. The `effective_date` is ignored if it is in the past when the quote is accepted." }, "end_behavior": { "description": "Behavior of the subscription schedule and underlying subscription when it ends.", "enum": [ "cancel", "release" ], "type": "string" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will set metadata on the subscription or subscription schedule when the quote is accepted. If a recurring price is included in `line_items`, this field will be passed to the resulting subscription's `metadata` field. If `subscription_data.effective_date` is used, this field will be passed to the resulting subscription schedule's `phases.metadata` field. Unlike object-level metadata, this field is declarative. Updates will clear prior values.", "type": "object" }, "prebilling": { "anyOf": [ { "properties": { "iterations": { "description": "This is used to determine the number of billing cycles to prebill.", "type": "integer" } }, "required": [ "iterations" ], "title": "prebilling_preview_params", "type": "object", "x-stripeMostCommon": [ "iterations" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If specified, the invoicing for the given billing cycle iterations will be processed when the quote is accepted. Cannot be used with `effective_date`." }, "proration_behavior": { "description": "Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations). When creating a subscription, valid values are `create_prorations` or `none`.\n\nWhen updating a subscription, valid values are `create_prorations`, `none`, or `always_invoice`.\n\nPassing `create_prorations` will cause proration invoice items to be created when applicable. These proration items will only be invoiced immediately under [certain conditions](https://stripe.com/docs/subscriptions/upgrading-downgrading#immediate-payment). In order to always invoice immediately for prorations, pass `always_invoice`.\n\nProrations can be disabled by passing `none`.", "enum": [ "always_invoice", "create_prorations", "none" ], "type": "string" }, "trial_period_days": { "anyOf": [ { "type": "integer" }, { "enum": [ "" ], "type": "string" } ], "description": "Integer representing the number of trial period days before the customer is charged for the first time." } }, "title": "subscription_data_update_params", "type": "object", "x-stripeMostCommon": [ "bill_on_acceptance", "billing_behavior", "billing_cycle_anchor", "description", "effective_date", "end_behavior", "metadata", "prebilling", "proration_behavior", "trial_period_days" ] }, "subscription_data_overrides": { "anyOf": [ { "items": { "properties": { "applies_to": { "description": "Whether the override applies to an existing Subscription Schedule or a new Subscription Schedule.", "properties": { "new_reference": { "description": "A custom string that identifies a new subscription schedule being created upon quote acceptance. All quote lines with the same `new_reference` field will be applied to the creation of a new subscription schedule.", "maxLength": 50, "type": "string" }, "subscription_schedule": { "description": "The ID of the schedule the line applies to.", "maxLength": 5000, "type": "string" }, "type": { "description": "Describes whether the quote line is affecting a new schedule or an existing schedule.", "enum": [ "new_reference", "subscription_schedule" ], "type": "string" } }, "required": [ "type" ], "title": "applies_to_specs", "type": "object", "x-stripeMostCommon": [ "new_reference", "subscription_schedule", "type" ] }, "bill_on_acceptance": { "anyOf": [ { "properties": { "bill_from": { "description": "The start of the period to bill from when the Quote is accepted.", "properties": { "line_starts_at": { "description": "Details of a Quote line to start the bill period from.", "properties": { "id": { "description": "The ID of a quote line.", "maxLength": 5000, "type": "string" }, "index": { "description": "The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array.", "type": "integer" } }, "title": "line_index_id_specs", "type": "object", "x-stripeMostCommon": [ "id", "index" ] }, "timestamp": { "description": "A precise Unix timestamp.", "format": "unix-time", "type": "integer" }, "type": { "description": "The type of method to specify the `bill_from` time.", "enum": [ "line_starts_at", "now", "pause_collection_start", "quote_acceptance_date", "timestamp" ], "type": "string" } }, "required": [ "type" ], "title": "bill_from_specs", "type": "object", "x-stripeMostCommon": [ "line_starts_at", "timestamp", "type" ] }, "bill_until": { "description": "The end of the period to bill until when the Quote is accepted.", "properties": { "duration": { "description": "Details of the duration over which to bill.", "properties": { "interval": { "description": "Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.", "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "description": "The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.", "type": "integer" } }, "required": [ "interval", "interval_count" ], "title": "duration_specs", "type": "object", "x-stripeMostCommon": [ "interval", "interval_count" ] }, "line_ends_at": { "description": "Details of a Quote line item from which to bill until.", "properties": { "id": { "description": "The ID of a quote line.", "maxLength": 5000, "type": "string" }, "index": { "description": "The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array.", "type": "integer" } }, "title": "line_index_id_specs", "type": "object", "x-stripeMostCommon": [ "id", "index" ] }, "timestamp": { "description": "A precise Unix timestamp.", "format": "unix-time", "type": "integer" }, "type": { "description": "The type of method to specify the `bill_until` time.", "enum": [ "duration", "line_ends_at", "schedule_end", "timestamp", "upcoming_invoice" ], "type": "string" } }, "required": [ "type" ], "title": "bill_until_specs", "type": "object", "x-stripeMostCommon": [ "duration", "line_ends_at", "timestamp", "type" ] } }, "title": "bill_on_acceptance_specs", "type": "object", "x-stripeMostCommon": [ "bill_from", "bill_until" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Describes the period to bill for upon accepting the quote." }, "billing_behavior": { "description": "Configures when the subscription schedule generates prorations for phase transitions. Possible values are `prorate_on_next_phase` or `prorate_up_front` with the default being `prorate_on_next_phase`. `prorate_on_next_phase` will apply phase changes and generate prorations at transition time. `prorate_up_front` will bill for all phases within the current billing cycle up front.", "enum": [ "prorate_on_next_phase", "prorate_up_front" ], "type": "string" }, "customer": { "description": "The customer the Subscription Data override applies to.", "maxLength": 5000, "type": "string" }, "description": { "anyOf": [ { "maxLength": 500, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs." }, "end_behavior": { "description": "Behavior of the subscription schedule and underlying subscription when it ends.", "enum": [ "cancel", "release" ], "type": "string" }, "proration_behavior": { "description": "Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations). When creating a subscription, valid values are `create_prorations` or `none`.\n\nWhen updating a subscription, valid values are `create_prorations`, `none`, or `always_invoice`.\n\nPassing `create_prorations` will cause proration invoice items to be created when applicable. These proration items will only be invoiced immediately under [certain conditions](https://stripe.com/docs/subscriptions/upgrading-downgrading#immediate-payment). In order to always invoice immediately for prorations, pass `always_invoice`.\n\nProrations can be disabled by passing `none`.", "enum": [ "always_invoice", "create_prorations", "none" ], "type": "string" } }, "required": [ "applies_to" ], "title": "update_specs", "type": "object", "x-stripeMostCommon": [ "applies_to", "bill_on_acceptance", "billing_behavior", "customer", "description", "end_behavior", "proration_behavior" ] }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "List representing overrides for `subscription_data` configurations for specific subscription schedules." }, "transfer_data": { "anyOf": [ { "properties": { "amount": { "description": "The amount that will be transferred automatically when the invoice is paid. If no amount is set, the full amount is transferred. There cannot be any line items with recurring prices when using this field.", "type": "integer" }, "amount_percent": { "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination. There must be at least 1 line item with a recurring price to use this field.", "type": "number" }, "destination": { "description": "ID of an existing, connected Stripe account.", "type": "string" } }, "required": [ "destination" ], "title": "transfer_data_specs", "type": "object", "x-stripeMostCommon": [ "amount", "amount_percent", "destination" ] }, { "enum": [ "" ], "type": "string" } ], "description": "The data with which to automatically create a Transfer for each of the invoices." } }, "type": "object", "x-stripeMostCommon": [ "line_items", "metadata" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/quote" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a quote" } }, "/v1/quotes/{quote}/accept": { "post": { "description": "

Accepts the specified quote.

", "operationId": "PostQuotesQuoteAccept", "parameters": [ { "in": "path", "name": "quote", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/quote" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Accept a quote" } }, "/v1/quotes/{quote}/cancel": { "post": { "description": "

Cancels the quote.

", "operationId": "PostQuotesQuoteCancel", "parameters": [ { "in": "path", "name": "quote", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/quote" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Cancel a quote" } }, "/v1/quotes/{quote}/computed_upfront_line_items": { "get": { "description": "

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

", "operationId": "GetQuotesQuoteComputedUpfrontLineItems", "parameters": [ { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "in": "path", "name": "quote", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/item" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "QuotesResourceListLineItems", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a quote's upfront line items" } }, "/v1/quotes/{quote}/finalize": { "post": { "description": "

Finalizes the quote.

", "operationId": "PostQuotesQuoteFinalize", "parameters": [ { "in": "path", "name": "quote", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "expires_at": { "description": "A future timestamp on which the quote will be canceled if in `open` or `draft` status. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/quote" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Finalize a quote" } }, "/v1/quotes/{quote}/line_items": { "get": { "description": "

When retrieving a quote, 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.

", "operationId": "GetQuotesQuoteLineItems", "parameters": [ { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "in": "path", "name": "quote", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/item" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "QuotesResourceListLineItems", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a quote's line items" } }, "/v1/quotes/{quote}/lines": { "get": { "description": "

Retrieves a paginated list of lines for a quote. These lines describe changes that will be used to create new subscription schedules or update existing subscription schedules when the quote is accepted.

", "operationId": "GetQuotesQuoteLines", "parameters": [ { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "in": "path", "name": "quote", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/quote_line" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "QuotesResourceListLines", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a quote's lines" } }, "/v1/quotes/{quote}/mark_draft": { "post": { "description": "

Converts a stale quote to draft.

", "operationId": "PostQuotesQuoteMarkDraft", "parameters": [ { "in": "path", "name": "quote", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/quote" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Convert a quote to draft" } }, "/v1/quotes/{quote}/mark_stale": { "post": { "description": "

Converts a draft or open quote to stale.

", "operationId": "PostQuotesQuoteMarkStale", "parameters": [ { "in": "path", "name": "quote", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "reason": { "description": "Reason the Quote is being marked stale.", "maxLength": 500, "type": "string" } }, "type": "object", "x-stripeMostCommon": [ "reason" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/quote" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Convert a quote to stale" } }, "/v1/quotes/{quote}/pdf": { "get": { "description": "

Download the PDF for a finalized quote. Explanation for special handling can be found here

", "operationId": "GetQuotesQuotePdf", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "quote", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/pdf": { "schema": { "format": "binary", "type": "string" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "servers": [ { "url": "https://files.stripe.com/" } ], "summary": "Download quote PDF" } }, "/v1/quotes/{quote}/preview_invoices": { "get": { "description": "

Preview the invoices that would be generated by accepting the quote.

", "operationId": "GetQuotesQuotePreviewInvoices", "parameters": [ { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "in": "path", "name": "quote", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/quote_preview_invoice" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "QuotesResourcePreviewInvoiceList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a quote's preview invoices" } }, "/v1/quotes/{quote}/preview_invoices/{preview_invoice}/lines": { "get": { "description": "

Preview the invoice line items that would be generated by accepting the quote.

", "operationId": "GetQuotesQuotePreviewInvoicesPreviewInvoiceLines", "parameters": [ { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "in": "path", "name": "preview_invoice", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "in": "path", "name": "quote", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/line_item" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "QuotesResourcePreviewInvoiceLineItemsList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a quote's preview invoice line items" } }, "/v1/quotes/{quote}/preview_subscription_schedules": { "get": { "description": "

Preview the schedules that would be generated by accepting the quote

", "operationId": "GetQuotesQuotePreviewSubscriptionSchedules", "parameters": [ { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "in": "path", "name": "quote", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/quote_preview_subscription_schedule" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "QuotesResourcePreviewsSchedulesScheduleList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a quote's preview schedules" } }, "/v1/quotes/{quote}/reestimate": { "post": { "description": "

Recompute the upcoming invoice estimate for the quote.

", "operationId": "PostQuotesQuoteReestimate", "parameters": [ { "in": "path", "name": "quote", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/quote" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Reestimate a quote" } }, "/v1/radar/early_fraud_warnings": { "get": { "description": "

Returns a list of early fraud warnings.

", "operationId": "GetRadarEarlyFraudWarnings", "parameters": [ { "description": "Only return early fraud warnings for the charge specified by this charge ID.", "in": "query", "name": "charge", "required": false, "schema": { "type": "string" }, "style": "form" }, { "description": "Only return early fraud warnings that were created during the given date interval.", "explode": true, "in": "query", "name": "created", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "description": "Minimum value to filter by (exclusive)", "type": "integer" }, "gte": { "description": "Minimum value to filter by (inclusive)", "type": "integer" }, "lt": { "description": "Maximum value to filter by (exclusive)", "type": "integer" }, "lte": { "description": "Maximum value to filter by (inclusive)", "type": "integer" } }, "title": "range_query_specs", "type": "object", "x-stripeMostCommon": [ "gt", "gte", "lt", "lte" ] }, { "type": "integer" } ] }, "style": "deepObject" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "Only return early fraud warnings for charges that were created by the PaymentIntent specified by this PaymentIntent ID.", "in": "query", "name": "payment_intent", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/radar.early_fraud_warning" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/radar/early_fraud_warnings", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "RadarEarlyFraudWarningList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all early fraud warnings" } }, "/v1/radar/early_fraud_warnings/{early_fraud_warning}": { "get": { "description": "

Retrieves the details of an early fraud warning that has previously been created.

\n\n

Please refer to the early fraud warning object reference for more details.

", "operationId": "GetRadarEarlyFraudWarningsEarlyFraudWarning", "parameters": [ { "in": "path", "name": "early_fraud_warning", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/radar.early_fraud_warning" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve an early fraud warning" } }, "/v1/radar/value_list_items": { "get": { "description": "

Returns a list of ValueListItem objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

", "operationId": "GetRadarValueListItems", "parameters": [ { "description": "Only return items that were created during the given date interval.", "explode": true, "in": "query", "name": "created", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "description": "Minimum value to filter by (exclusive)", "type": "integer" }, "gte": { "description": "Minimum value to filter by (inclusive)", "type": "integer" }, "lt": { "description": "Maximum value to filter by (exclusive)", "type": "integer" }, "lte": { "description": "Maximum value to filter by (inclusive)", "type": "integer" } }, "title": "range_query_specs", "type": "object", "x-stripeMostCommon": [ "gt", "gte", "lt", "lte" ] }, { "type": "integer" } ] }, "style": "deepObject" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Return items belonging to the parent list whose value matches the specified value (using an \"is like\" match).", "in": "query", "name": "value", "required": false, "schema": { "maxLength": 800, "type": "string" }, "style": "form" }, { "description": "Identifier for the parent value list this item belongs to.", "in": "query", "name": "value_list", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/radar.value_list_item" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/radar/value_list_items", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "RadarListListItemList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all value list items" }, "post": { "description": "

Creates a new ValueListItem object, which is added to the specified parent value list.

", "operationId": "PostRadarValueListItems", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "value": { "description": "The value of the item (whose type must match the type of the parent value list).", "maxLength": 800, "type": "string" }, "value_list": { "description": "The identifier of the value list which the created item will be added to.", "maxLength": 5000, "type": "string" } }, "required": [ "value", "value_list" ], "type": "object", "x-stripeMostCommon": [ "value", "value_list" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/radar.value_list_item" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a value list item" } }, "/v1/radar/value_list_items/{item}": { "delete": { "description": "

Deletes a ValueListItem object, removing it from its parent value list.

", "operationId": "DeleteRadarValueListItemsItem", "parameters": [ { "in": "path", "name": "item", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted_radar.value_list_item" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Delete a value list item" }, "get": { "description": "

Retrieves a ValueListItem object.

", "operationId": "GetRadarValueListItemsItem", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "item", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/radar.value_list_item" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a value list item" } }, "/v1/radar/value_lists": { "get": { "description": "

Returns a list of ValueList objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

", "operationId": "GetRadarValueLists", "parameters": [ { "description": "The alias used to reference the value list when writing rules.", "in": "query", "name": "alias", "required": false, "schema": { "maxLength": 100, "type": "string" }, "style": "form" }, { "description": "A value contained within a value list - returns all value lists containing this value.", "in": "query", "name": "contains", "required": false, "schema": { "maxLength": 800, "type": "string" }, "style": "form" }, { "description": "Only return value lists that were created during the given date interval.", "explode": true, "in": "query", "name": "created", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "description": "Minimum value to filter by (exclusive)", "type": "integer" }, "gte": { "description": "Minimum value to filter by (inclusive)", "type": "integer" }, "lt": { "description": "Maximum value to filter by (exclusive)", "type": "integer" }, "lte": { "description": "Maximum value to filter by (inclusive)", "type": "integer" } }, "title": "range_query_specs", "type": "object", "x-stripeMostCommon": [ "gt", "gte", "lt", "lte" ] }, { "type": "integer" } ] }, "style": "deepObject" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/radar.value_list" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/radar/value_lists", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "RadarListListList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all value lists" }, "post": { "description": "

Creates a new ValueList object, which can then be referenced in rules.

", "operationId": "PostRadarValueLists", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "alias": { "description": "The name of the value list for use in rules.", "maxLength": 100, "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "item_type": { "description": "Type of the items in the value list. One of `card_fingerprint`, `card_bin`, `email`, `ip_address`, `country`, `string`, `case_sensitive_string`, `customer_id`, `sepa_debit_fingerprint`, or `us_bank_account_fingerprint`. Use `string` if the item type is unknown or mixed.", "enum": [ "card_bin", "card_fingerprint", "case_sensitive_string", "country", "customer_id", "email", "ip_address", "sepa_debit_fingerprint", "string", "us_bank_account_fingerprint" ], "maxLength": 5000, "type": "string" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "name": { "description": "The human-readable name of the value list.", "maxLength": 100, "type": "string" } }, "required": [ "alias", "name" ], "type": "object", "x-stripeMostCommon": [ "alias", "item_type", "metadata", "name" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/radar.value_list" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a value list" } }, "/v1/radar/value_lists/{value_list}": { "delete": { "description": "

Deletes a ValueList object, also deleting any items contained within the value list. To be deleted, a value list must not be referenced in any rules.

", "operationId": "DeleteRadarValueListsValueList", "parameters": [ { "in": "path", "name": "value_list", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted_radar.value_list" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Delete a value list" }, "get": { "description": "

Retrieves a ValueList object.

", "operationId": "GetRadarValueListsValueList", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "value_list", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/radar.value_list" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a value list" }, "post": { "description": "

Updates a ValueList object by setting the values of the parameters passed. Any parameters not provided will be left unchanged. Note that item_type is immutable.

", "operationId": "PostRadarValueListsValueList", "parameters": [ { "in": "path", "name": "value_list", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "alias": { "description": "The name of the value list for use in rules.", "maxLength": 100, "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "name": { "description": "The human-readable name of the value list.", "maxLength": 100, "type": "string" } }, "type": "object", "x-stripeMostCommon": [ "alias", "metadata", "name" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/radar.value_list" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a value list" } }, "/v1/refunds": { "get": { "description": "

Returns a list of all refunds you created. We return the refunds in sorted order, with the most recent refunds appearing first. The 10 most recent refunds are always available by default on the Charge object.

", "operationId": "GetRefunds", "parameters": [ { "description": "Only return refunds for the charge specified by this charge ID.", "in": "query", "name": "charge", "required": false, "schema": { "type": "string" }, "style": "form" }, { "description": "Only return refunds that were created during the given date interval.", "explode": true, "in": "query", "name": "created", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "description": "Minimum value to filter by (exclusive)", "type": "integer" }, "gte": { "description": "Minimum value to filter by (inclusive)", "type": "integer" }, "lt": { "description": "Maximum value to filter by (exclusive)", "type": "integer" }, "lte": { "description": "Maximum value to filter by (inclusive)", "type": "integer" } }, "title": "range_query_specs", "type": "object", "x-stripeMostCommon": [ "gt", "gte", "lt", "lte" ] }, { "type": "integer" } ] }, "style": "deepObject" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "Only return refunds for the PaymentIntent specified by this ID.", "in": "query", "name": "payment_intent", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/refund" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/refunds", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "APIMethodRefundList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all refunds" }, "post": { "description": "

When you create a new refund, you must specify a Charge or a PaymentIntent object on which to create it.

\n\n

Creating a new refund will refund a charge that has previously been created but not yet refunded.\nFunds will be refunded to the credit or debit card that was originally charged.

\n\n

You can optionally refund only part of a charge.\nYou can do so multiple times, until the entire charge has been refunded.

\n\n

Once entirely refunded, a charge can’t be refunded again.\nThis method will raise an error when called on an already-refunded charge,\nor when trying to refund more money than is left on a charge.

", "operationId": "PostRefunds", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "amount": { "type": "integer" }, "charge": { "description": "The identifier of the charge to refund.", "maxLength": 5000, "type": "string" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "customer": { "description": "Customer whose customer balance to refund from.", "maxLength": 5000, "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "instructions_email": { "description": "For payment methods without native refund support (e.g., Konbini, PromptPay), use this email from the customer to receive refund instructions.", "type": "string" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "origin": { "description": "Origin of the refund", "enum": [ "customer_balance" ], "type": "string" }, "payment_intent": { "description": "The identifier of the PaymentIntent to refund.", "maxLength": 5000, "type": "string" }, "reason": { "description": "String indicating the reason for the refund. If set, possible values are `duplicate`, `fraudulent`, and `requested_by_customer`. If you believe the charge to be fraudulent, specifying `fraudulent` as the reason will add the associated card and email to your [block lists](https://stripe.com/docs/radar/lists), and will also help us improve our fraud detection algorithms.", "enum": [ "duplicate", "fraudulent", "requested_by_customer" ], "maxLength": 5000, "type": "string" }, "refund_application_fee": { "description": "Boolean indicating whether the application fee should be refunded when refunding this charge. If a full charge refund is given, the full application fee will be refunded. Otherwise, the application fee will be refunded in an amount proportional to the amount of the charge refunded. An application fee can be refunded only by the application that created the charge.", "type": "boolean" }, "reverse_transfer": { "description": "Boolean indicating whether the transfer should be reversed when refunding this charge. The transfer will be reversed proportionally to the amount being refunded (either the entire or partial amount).

A transfer can be reversed only by the application that created the charge.", "type": "boolean" } }, "type": "object", "x-stripeMostCommon": [ "amount", "charge", "currency", "customer", "instructions_email", "metadata", "origin", "payment_intent", "reason" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/refund" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create customer balance refund" } }, "/v1/refunds/{refund}": { "get": { "description": "

Retrieves the details of an existing refund.

", "operationId": "GetRefundsRefund", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "refund", "required": true, "schema": { "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/refund" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a refund" }, "post": { "description": "

Updates the refund that you specify by setting the values of the passed parameters. Any parameters that you don’t provide remain unchanged.

\n\n

This request only accepts metadata as an argument.

", "operationId": "PostRefundsRefund", "parameters": [ { "in": "path", "name": "refund", "required": true, "schema": { "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." } }, "type": "object", "x-stripeMostCommon": [ "metadata" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/refund" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a refund" } }, "/v1/refunds/{refund}/cancel": { "post": { "description": "

Cancels a refund with a status of requires_action.

\n\n

You can’t cancel refunds in other states. Only refunds for payment methods that require customer action can enter the requires_action state.

", "operationId": "PostRefundsRefundCancel", "parameters": [ { "in": "path", "name": "refund", "required": true, "schema": { "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/refund" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Cancel a refund" } }, "/v1/reporting/report_runs": { "get": { "description": "

Returns a list of Report Runs, with the most recent appearing first.

", "operationId": "GetReportingReportRuns", "parameters": [ { "description": "Only return Report Runs that were created during the given date interval.", "explode": true, "in": "query", "name": "created", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "description": "Minimum value to filter by (exclusive)", "type": "integer" }, "gte": { "description": "Minimum value to filter by (inclusive)", "type": "integer" }, "lt": { "description": "Maximum value to filter by (exclusive)", "type": "integer" }, "lte": { "description": "Maximum value to filter by (inclusive)", "type": "integer" } }, "title": "range_query_specs", "type": "object", "x-stripeMostCommon": [ "gt", "gte", "lt", "lte" ] }, { "type": "integer" } ] }, "style": "deepObject" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/reporting.report_run" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/reporting/report_runs", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "FinancialReportingFinanceReportRunList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all Report Runs" }, "post": { "description": "

Creates a new object and begin running the report. (Certain report types require a live-mode API key.)

", "operationId": "PostReportingReportRuns", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "parameters": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "parameters": { "description": "Parameters specifying how the report should be run. Different Report Types have different required and optional parameters, listed in the [API Access to Reports](https://stripe.com/docs/reporting/statements/api) documentation.", "properties": { "columns": { "description": "The set of report columns to include in the report output. If omitted, the Report Type is run with its default column set.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "connected_account": { "description": "Connected account ID to filter for in the report run.", "type": "string" }, "currency": { "description": "Currency of objects to be included in the report run.", "format": "currency", "type": "string" }, "interval_end": { "description": "Ending timestamp of data to be included in the report run (exclusive).", "format": "unix-time", "type": "integer" }, "interval_start": { "description": "Starting timestamp of data to be included in the report run.", "format": "unix-time", "type": "integer" }, "payout": { "description": "Payout ID by which to filter the report run.", "type": "string" }, "reporting_category": { "description": "Category of balance transactions to be included in the report run.", "enum": [ "advance", "advance_funding", "anticipation_repayment", "charge", "charge_failure", "climate_order_purchase", "climate_order_refund", "connect_collection_transfer", "connect_reserved_funds", "contribution", "dispute", "dispute_reversal", "fee", "financing_paydown", "financing_paydown_reversal", "financing_payout", "financing_payout_reversal", "issuing_authorization_hold", "issuing_authorization_release", "issuing_dispute", "issuing_transaction", "network_cost", "other_adjustment", "partial_capture_reversal", "payout", "payout_reversal", "platform_earning", "platform_earning_refund", "refund", "refund_failure", "risk_reserved_funds", "tax", "topup", "topup_reversal", "transfer", "transfer_reversal", "unreconciled_customer_funds" ], "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true }, "timezone": { "description": "Defaults to `Etc/UTC`. The output timezone for all timestamps in the report. A list of possible time zone values is maintained at the [IANA Time Zone Database](http://www.iana.org/time-zones). Has no effect on `interval_start` or `interval_end`.", "enum": [ "Africa/Abidjan", "Africa/Accra", "Africa/Addis_Ababa", "Africa/Algiers", "Africa/Asmara", "Africa/Asmera", "Africa/Bamako", "Africa/Bangui", "Africa/Banjul", "Africa/Bissau", "Africa/Blantyre", "Africa/Brazzaville", "Africa/Bujumbura", "Africa/Cairo", "Africa/Casablanca", "Africa/Ceuta", "Africa/Conakry", "Africa/Dakar", "Africa/Dar_es_Salaam", "Africa/Djibouti", "Africa/Douala", "Africa/El_Aaiun", "Africa/Freetown", "Africa/Gaborone", "Africa/Harare", "Africa/Johannesburg", "Africa/Juba", "Africa/Kampala", "Africa/Khartoum", "Africa/Kigali", "Africa/Kinshasa", "Africa/Lagos", "Africa/Libreville", "Africa/Lome", "Africa/Luanda", "Africa/Lubumbashi", "Africa/Lusaka", "Africa/Malabo", "Africa/Maputo", "Africa/Maseru", "Africa/Mbabane", "Africa/Mogadishu", "Africa/Monrovia", "Africa/Nairobi", "Africa/Ndjamena", "Africa/Niamey", "Africa/Nouakchott", "Africa/Ouagadougou", "Africa/Porto-Novo", "Africa/Sao_Tome", "Africa/Timbuktu", "Africa/Tripoli", "Africa/Tunis", "Africa/Windhoek", "America/Adak", "America/Anchorage", "America/Anguilla", "America/Antigua", "America/Araguaina", "America/Argentina/Buenos_Aires", "America/Argentina/Catamarca", "America/Argentina/ComodRivadavia", "America/Argentina/Cordoba", "America/Argentina/Jujuy", "America/Argentina/La_Rioja", "America/Argentina/Mendoza", "America/Argentina/Rio_Gallegos", "America/Argentina/Salta", "America/Argentina/San_Juan", "America/Argentina/San_Luis", "America/Argentina/Tucuman", "America/Argentina/Ushuaia", "America/Aruba", "America/Asuncion", "America/Atikokan", "America/Atka", "America/Bahia", "America/Bahia_Banderas", "America/Barbados", "America/Belem", "America/Belize", "America/Blanc-Sablon", "America/Boa_Vista", "America/Bogota", "America/Boise", "America/Buenos_Aires", "America/Cambridge_Bay", "America/Campo_Grande", "America/Cancun", "America/Caracas", "America/Catamarca", "America/Cayenne", "America/Cayman", "America/Chicago", "America/Chihuahua", "America/Ciudad_Juarez", "America/Coral_Harbour", "America/Cordoba", "America/Costa_Rica", "America/Coyhaique", "America/Creston", "America/Cuiaba", "America/Curacao", "America/Danmarkshavn", "America/Dawson", "America/Dawson_Creek", "America/Denver", "America/Detroit", "America/Dominica", "America/Edmonton", "America/Eirunepe", "America/El_Salvador", "America/Ensenada", "America/Fort_Nelson", "America/Fort_Wayne", "America/Fortaleza", "America/Glace_Bay", "America/Godthab", "America/Goose_Bay", "America/Grand_Turk", "America/Grenada", "America/Guadeloupe", "America/Guatemala", "America/Guayaquil", "America/Guyana", "America/Halifax", "America/Havana", "America/Hermosillo", "America/Indiana/Indianapolis", "America/Indiana/Knox", "America/Indiana/Marengo", "America/Indiana/Petersburg", "America/Indiana/Tell_City", "America/Indiana/Vevay", "America/Indiana/Vincennes", "America/Indiana/Winamac", "America/Indianapolis", "America/Inuvik", "America/Iqaluit", "America/Jamaica", "America/Jujuy", "America/Juneau", "America/Kentucky/Louisville", "America/Kentucky/Monticello", "America/Knox_IN", "America/Kralendijk", "America/La_Paz", "America/Lima", "America/Los_Angeles", "America/Louisville", "America/Lower_Princes", "America/Maceio", "America/Managua", "America/Manaus", "America/Marigot", "America/Martinique", "America/Matamoros", "America/Mazatlan", "America/Mendoza", "America/Menominee", "America/Merida", "America/Metlakatla", "America/Mexico_City", "America/Miquelon", "America/Moncton", "America/Monterrey", "America/Montevideo", "America/Montreal", "America/Montserrat", "America/Nassau", "America/New_York", "America/Nipigon", "America/Nome", "America/Noronha", "America/North_Dakota/Beulah", "America/North_Dakota/Center", "America/North_Dakota/New_Salem", "America/Nuuk", "America/Ojinaga", "America/Panama", "America/Pangnirtung", "America/Paramaribo", "America/Phoenix", "America/Port-au-Prince", "America/Port_of_Spain", "America/Porto_Acre", "America/Porto_Velho", "America/Puerto_Rico", "America/Punta_Arenas", "America/Rainy_River", "America/Rankin_Inlet", "America/Recife", "America/Regina", "America/Resolute", "America/Rio_Branco", "America/Rosario", "America/Santa_Isabel", "America/Santarem", "America/Santiago", "America/Santo_Domingo", "America/Sao_Paulo", "America/Scoresbysund", "America/Shiprock", "America/Sitka", "America/St_Barthelemy", "America/St_Johns", "America/St_Kitts", "America/St_Lucia", "America/St_Thomas", "America/St_Vincent", "America/Swift_Current", "America/Tegucigalpa", "America/Thule", "America/Thunder_Bay", "America/Tijuana", "America/Toronto", "America/Tortola", "America/Vancouver", "America/Virgin", "America/Whitehorse", "America/Winnipeg", "America/Yakutat", "America/Yellowknife", "Antarctica/Casey", "Antarctica/Davis", "Antarctica/DumontDUrville", "Antarctica/Macquarie", "Antarctica/Mawson", "Antarctica/McMurdo", "Antarctica/Palmer", "Antarctica/Rothera", "Antarctica/South_Pole", "Antarctica/Syowa", "Antarctica/Troll", "Antarctica/Vostok", "Arctic/Longyearbyen", "Asia/Aden", "Asia/Almaty", "Asia/Amman", "Asia/Anadyr", "Asia/Aqtau", "Asia/Aqtobe", "Asia/Ashgabat", "Asia/Ashkhabad", "Asia/Atyrau", "Asia/Baghdad", "Asia/Bahrain", "Asia/Baku", "Asia/Bangkok", "Asia/Barnaul", "Asia/Beirut", "Asia/Bishkek", "Asia/Brunei", "Asia/Calcutta", "Asia/Chita", "Asia/Choibalsan", "Asia/Chongqing", "Asia/Chungking", "Asia/Colombo", "Asia/Dacca", "Asia/Damascus", "Asia/Dhaka", "Asia/Dili", "Asia/Dubai", "Asia/Dushanbe", "Asia/Famagusta", "Asia/Gaza", "Asia/Harbin", "Asia/Hebron", "Asia/Ho_Chi_Minh", "Asia/Hong_Kong", "Asia/Hovd", "Asia/Irkutsk", "Asia/Istanbul", "Asia/Jakarta", "Asia/Jayapura", "Asia/Jerusalem", "Asia/Kabul", "Asia/Kamchatka", "Asia/Karachi", "Asia/Kashgar", "Asia/Kathmandu", "Asia/Katmandu", "Asia/Khandyga", "Asia/Kolkata", "Asia/Krasnoyarsk", "Asia/Kuala_Lumpur", "Asia/Kuching", "Asia/Kuwait", "Asia/Macao", "Asia/Macau", "Asia/Magadan", "Asia/Makassar", "Asia/Manila", "Asia/Muscat", "Asia/Nicosia", "Asia/Novokuznetsk", "Asia/Novosibirsk", "Asia/Omsk", "Asia/Oral", "Asia/Phnom_Penh", "Asia/Pontianak", "Asia/Pyongyang", "Asia/Qatar", "Asia/Qostanay", "Asia/Qyzylorda", "Asia/Rangoon", "Asia/Riyadh", "Asia/Saigon", "Asia/Sakhalin", "Asia/Samarkand", "Asia/Seoul", "Asia/Shanghai", "Asia/Singapore", "Asia/Srednekolymsk", "Asia/Taipei", "Asia/Tashkent", "Asia/Tbilisi", "Asia/Tehran", "Asia/Tel_Aviv", "Asia/Thimbu", "Asia/Thimphu", "Asia/Tokyo", "Asia/Tomsk", "Asia/Ujung_Pandang", "Asia/Ulaanbaatar", "Asia/Ulan_Bator", "Asia/Urumqi", "Asia/Ust-Nera", "Asia/Vientiane", "Asia/Vladivostok", "Asia/Yakutsk", "Asia/Yangon", "Asia/Yekaterinburg", "Asia/Yerevan", "Atlantic/Azores", "Atlantic/Bermuda", "Atlantic/Canary", "Atlantic/Cape_Verde", "Atlantic/Faeroe", "Atlantic/Faroe", "Atlantic/Jan_Mayen", "Atlantic/Madeira", "Atlantic/Reykjavik", "Atlantic/South_Georgia", "Atlantic/St_Helena", "Atlantic/Stanley", "Australia/ACT", "Australia/Adelaide", "Australia/Brisbane", "Australia/Broken_Hill", "Australia/Canberra", "Australia/Currie", "Australia/Darwin", "Australia/Eucla", "Australia/Hobart", "Australia/LHI", "Australia/Lindeman", "Australia/Lord_Howe", "Australia/Melbourne", "Australia/NSW", "Australia/North", "Australia/Perth", "Australia/Queensland", "Australia/South", "Australia/Sydney", "Australia/Tasmania", "Australia/Victoria", "Australia/West", "Australia/Yancowinna", "Brazil/Acre", "Brazil/DeNoronha", "Brazil/East", "Brazil/West", "CET", "CST6CDT", "Canada/Atlantic", "Canada/Central", "Canada/Eastern", "Canada/Mountain", "Canada/Newfoundland", "Canada/Pacific", "Canada/Saskatchewan", "Canada/Yukon", "Chile/Continental", "Chile/EasterIsland", "Cuba", "EET", "EST", "EST5EDT", "Egypt", "Eire", "Etc/GMT", "Etc/GMT+0", "Etc/GMT+1", "Etc/GMT+10", "Etc/GMT+11", "Etc/GMT+12", "Etc/GMT+2", "Etc/GMT+3", "Etc/GMT+4", "Etc/GMT+5", "Etc/GMT+6", "Etc/GMT+7", "Etc/GMT+8", "Etc/GMT+9", "Etc/GMT-0", "Etc/GMT-1", "Etc/GMT-10", "Etc/GMT-11", "Etc/GMT-12", "Etc/GMT-13", "Etc/GMT-14", "Etc/GMT-2", "Etc/GMT-3", "Etc/GMT-4", "Etc/GMT-5", "Etc/GMT-6", "Etc/GMT-7", "Etc/GMT-8", "Etc/GMT-9", "Etc/GMT0", "Etc/Greenwich", "Etc/UCT", "Etc/UTC", "Etc/Universal", "Etc/Zulu", "Europe/Amsterdam", "Europe/Andorra", "Europe/Astrakhan", "Europe/Athens", "Europe/Belfast", "Europe/Belgrade", "Europe/Berlin", "Europe/Bratislava", "Europe/Brussels", "Europe/Bucharest", "Europe/Budapest", "Europe/Busingen", "Europe/Chisinau", "Europe/Copenhagen", "Europe/Dublin", "Europe/Gibraltar", "Europe/Guernsey", "Europe/Helsinki", "Europe/Isle_of_Man", "Europe/Istanbul", "Europe/Jersey", "Europe/Kaliningrad", "Europe/Kiev", "Europe/Kirov", "Europe/Kyiv", "Europe/Lisbon", "Europe/Ljubljana", "Europe/London", "Europe/Luxembourg", "Europe/Madrid", "Europe/Malta", "Europe/Mariehamn", "Europe/Minsk", "Europe/Monaco", "Europe/Moscow", "Europe/Nicosia", "Europe/Oslo", "Europe/Paris", "Europe/Podgorica", "Europe/Prague", "Europe/Riga", "Europe/Rome", "Europe/Samara", "Europe/San_Marino", "Europe/Sarajevo", "Europe/Saratov", "Europe/Simferopol", "Europe/Skopje", "Europe/Sofia", "Europe/Stockholm", "Europe/Tallinn", "Europe/Tirane", "Europe/Tiraspol", "Europe/Ulyanovsk", "Europe/Uzhgorod", "Europe/Vaduz", "Europe/Vatican", "Europe/Vienna", "Europe/Vilnius", "Europe/Volgograd", "Europe/Warsaw", "Europe/Zagreb", "Europe/Zaporozhye", "Europe/Zurich", "Factory", "GB", "GB-Eire", "GMT", "GMT+0", "GMT-0", "GMT0", "Greenwich", "HST", "Hongkong", "Iceland", "Indian/Antananarivo", "Indian/Chagos", "Indian/Christmas", "Indian/Cocos", "Indian/Comoro", "Indian/Kerguelen", "Indian/Mahe", "Indian/Maldives", "Indian/Mauritius", "Indian/Mayotte", "Indian/Reunion", "Iran", "Israel", "Jamaica", "Japan", "Kwajalein", "Libya", "MET", "MST", "MST7MDT", "Mexico/BajaNorte", "Mexico/BajaSur", "Mexico/General", "NZ", "NZ-CHAT", "Navajo", "PRC", "PST8PDT", "Pacific/Apia", "Pacific/Auckland", "Pacific/Bougainville", "Pacific/Chatham", "Pacific/Chuuk", "Pacific/Easter", "Pacific/Efate", "Pacific/Enderbury", "Pacific/Fakaofo", "Pacific/Fiji", "Pacific/Funafuti", "Pacific/Galapagos", "Pacific/Gambier", "Pacific/Guadalcanal", "Pacific/Guam", "Pacific/Honolulu", "Pacific/Johnston", "Pacific/Kanton", "Pacific/Kiritimati", "Pacific/Kosrae", "Pacific/Kwajalein", "Pacific/Majuro", "Pacific/Marquesas", "Pacific/Midway", "Pacific/Nauru", "Pacific/Niue", "Pacific/Norfolk", "Pacific/Noumea", "Pacific/Pago_Pago", "Pacific/Palau", "Pacific/Pitcairn", "Pacific/Pohnpei", "Pacific/Ponape", "Pacific/Port_Moresby", "Pacific/Rarotonga", "Pacific/Saipan", "Pacific/Samoa", "Pacific/Tahiti", "Pacific/Tarawa", "Pacific/Tongatapu", "Pacific/Truk", "Pacific/Wake", "Pacific/Wallis", "Pacific/Yap", "Poland", "Portugal", "ROC", "ROK", "Singapore", "Turkey", "UCT", "US/Alaska", "US/Aleutian", "US/Arizona", "US/Central", "US/East-Indiana", "US/Eastern", "US/Hawaii", "US/Indiana-Starke", "US/Michigan", "US/Mountain", "US/Pacific", "US/Pacific-New", "US/Samoa", "UTC", "Universal", "W-SU", "WET", "Zulu" ], "maxLength": 5000, "type": "string" } }, "title": "run_parameter_specs", "type": "object", "x-stripeMostCommon": [ "account", "account_type", "accounts", "action", "actions", "age_bucket", "aggregate", "aggregation_type", "all", "amount", "amount_filter", "amount_max", "amount_min", "apple_subscriber", "application_id", "async_fees", "authentication_outcome_detailed", "billable_item_ids", "billing_analytics_metric", "bucket_size", "calculation_type", "capability_type", "card_bin", "card_brand", "card_brands", "card_country", "card_fingerprint", "card_funding", "card_number", "card_type", "card_types", "cau_correction_factor", "charge", "chart_detail_page_id", "cluster_table_suffix", "cof", "columns", "compare_to_end", "compare_to_start", "connect_charge_type", "connected_account", "connected_accounts", "contract", "conversion_currency", "countries", "country", "credit_ids", "currency", "cursor", "cursor_created_at", "cursor_forward_direction", "cursor_payment_attempt_id", "customer", "customer_filters", "customers", "dataset_id", "date_format", "days_to_use", "decimal_separator", "digital_wallet", "direction", "dispute_reasons", "download", "dynamic_reporting_params", "entity_type", "exchange_rate", "exchange_rates", "experiment_id", "fee_category", "filter_column", "filter_columns", "filter_currency", "filter_topics", "filter_value", "filter_values", "filters", "filters_by_meter", "financial_account", "first_day_of_week_offset", "gateway_conversation_avs_outcome", "gateway_conversation_cvc_outcome", "gateway_country", "gl_code", "google_order", "granularity", "group_by", "group_by_key", "group_by_keys", "group_by_keys_by_meter", "group_id", "group_type", "grouped_column", "grouped_columns", "grouped_metadata_column", "groups", "include_blocked_payments", "include_connect_charges", "include_efw", "interaction_type", "interval_end", "interval_end_date_as_string", "interval_start", "interval_start_date_as_string", "intervention_type", "invoice", "invoice_line_item", "ip_address", "ip_country", "is_backtest", "is_eu_vat_moss", "is_latam", "is_link_in_pmm_supported", "is_on_session_toggled", "is_top_fraudy_attributes", "is_unbilled", "jurisdiction_key", "last_activity_timeframe", "limit", "list_item", "list_items", "livemode", "location_ids", "match_mode", "match_status", "max_churn", "meter_id", "meter_ids", "min_trim_size", "nci_filter_for", "nci_mcc", "network_types", "numeric_filters", "offset", "outcome", "override_artificial_delay", "payment_link_id", "payment_method_type", "payment_method_types", "payment_methods", "payment_processors", "payout", "payout_date_end", "payout_date_start", "payout_status", "payout_type", "platform", "platform_id", "price_filters", "product", "product_feature_description", "product_features", "product_filters", "query_options", "radar_bad_outcome_configuration", "radar_fraud_outcomes", "radar_good_outcomes", "rate", "rate_card_ids", "recognition_end", "recognition_start", "recon_party_name", "recon_space", "recon_space_type", "reconciliation_status", "reference_id", "reporting_category", "reporting_string_filters", "retries_correction_factor", "retry_status", "rev_rec_month_summary_line_item", "risk_score", "rule_action", "rule_attribute", "rule_attribute_case_insensitive", "rule_attribute_name_value", "rule_id", "rule_predicate_sql", "search_params", "secondary_cursor", "seconds_since_card_first_seen", "segment_id", "serial_numbers", "sort_order", "sorted_column", "states", "string_filters", "sync_fees", "table_name", "tax_form_id", "tax_type", "taxable", "tds_result", "tds_triggered", "tenant_filters", "tenant_filters_by_meter", "three_d_s_outcome", "timezone", "top_connected_accounts", "total_charges_per_card_number_daily", "total_fraud_volume", "total_legitimate_volume", "tracking_load_type", "transaction_age_max", "transaction_age_min", "transaction_initiators", "transaction_type", "unit", "ur", "usage_id", "use_dispute_creation_date", "use_minerva", "used_network_tokens", "view_type" ] }, "report_type": { "description": "The ID of the [report type](https://stripe.com/docs/reporting/statements/api#report-types) to run, such as `\"balance.summary.1\"`.", "type": "string" } }, "required": [ "report_type" ], "type": "object", "x-stripeMostCommon": [ "parameters", "report_type" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reporting.report_run" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a Report Run" } }, "/v1/reporting/report_runs/{report_run}": { "get": { "description": "

Retrieves the details of an existing Report Run.

", "operationId": "GetReportingReportRunsReportRun", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "report_run", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reporting.report_run" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a Report Run" } }, "/v1/reporting/report_types": { "get": { "description": "

Returns a full list of Report Types.

", "operationId": "GetReportingReportTypes", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/reporting.report_type" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "FinancialReportingFinanceReportTypeList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all Report Types" } }, "/v1/reporting/report_types/{report_type}": { "get": { "description": "

Retrieves the details of a Report Type. (Certain report types require a live-mode API key.)

", "operationId": "GetReportingReportTypesReportType", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "report_type", "required": true, "schema": { "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reporting.report_type" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a Report Type" } }, "/v1/reviews": { "get": { "description": "

Returns a list of Review objects that have open set to true. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

", "operationId": "GetReviews", "parameters": [ { "description": "Only return reviews that were created during the given date interval.", "explode": true, "in": "query", "name": "created", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "description": "Minimum value to filter by (exclusive)", "type": "integer" }, "gte": { "description": "Minimum value to filter by (inclusive)", "type": "integer" }, "lt": { "description": "Maximum value to filter by (exclusive)", "type": "integer" }, "lte": { "description": "Maximum value to filter by (inclusive)", "type": "integer" } }, "title": "range_query_specs", "type": "object", "x-stripeMostCommon": [ "gt", "gte", "lt", "lte" ] }, { "type": "integer" } ] }, "style": "deepObject" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/review" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "RadarReviewList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all open reviews" } }, "/v1/reviews/{review}": { "get": { "description": "

Retrieves a Review object.

", "operationId": "GetReviewsReview", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "review", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/review" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a review" } }, "/v1/reviews/{review}/approve": { "post": { "description": "

Approves a Review object, closing it and removing it from the list of reviews.

", "operationId": "PostReviewsReviewApprove", "parameters": [ { "in": "path", "name": "review", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/review" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Approve a review" } }, "/v1/setup_attempts": { "get": { "description": "

Returns a list of SetupAttempts that associate with a provided SetupIntent.

", "operationId": "GetSetupAttempts", "parameters": [ { "description": "A filter on the list, based on the object `created` field. The value\ncan be a string with an integer Unix timestamp or a\ndictionary with a number of different query options.", "explode": true, "in": "query", "name": "created", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "description": "Minimum value to filter by (exclusive)", "type": "integer" }, "gte": { "description": "Minimum value to filter by (inclusive)", "type": "integer" }, "lt": { "description": "Maximum value to filter by (exclusive)", "type": "integer" }, "lte": { "description": "Maximum value to filter by (inclusive)", "type": "integer" } }, "title": "range_query_specs", "type": "object", "x-stripeMostCommon": [ "gt", "gte", "lt", "lte" ] }, { "type": "integer" } ] }, "style": "deepObject" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "Only return SetupAttempts created by the SetupIntent specified by\nthis ID.", "in": "query", "name": "setup_intent", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/setup_attempt" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/setup_attempts", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "PaymentFlowsSetupIntentSetupAttemptList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all SetupAttempts" } }, "/v1/setup_intents": { "get": { "description": "

Returns a list of SetupIntents.

", "operationId": "GetSetupIntents", "parameters": [ { "description": "If present, the SetupIntent's payment method will be attached to the in-context Stripe Account.\n\nIt can only be used for this Stripe Account’s own money movement flows like InboundTransfer and OutboundTransfers. It cannot be set to true when setting up a PaymentMethod for a Customer, and defaults to false when attaching a PaymentMethod to a Customer.", "in": "query", "name": "attach_to_self", "required": false, "schema": { "type": "boolean" }, "style": "form" }, { "description": "A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.", "explode": true, "in": "query", "name": "created", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "description": "Minimum value to filter by (exclusive)", "type": "integer" }, "gte": { "description": "Minimum value to filter by (inclusive)", "type": "integer" }, "lt": { "description": "Maximum value to filter by (exclusive)", "type": "integer" }, "lte": { "description": "Maximum value to filter by (inclusive)", "type": "integer" } }, "title": "range_query_specs", "type": "object", "x-stripeMostCommon": [ "gt", "gte", "lt", "lte" ] }, { "type": "integer" } ] }, "style": "deepObject" }, { "description": "Only return SetupIntents for the customer specified by this customer ID.", "in": "query", "name": "customer", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Only return SetupIntents for the account specified by this customer ID.", "in": "query", "name": "customer_account", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "Only return SetupIntents that associate with the specified payment method.", "in": "query", "name": "payment_method", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/setup_intent" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/setup_intents", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "PaymentFlowsSetupIntentList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all SetupIntents" }, "post": { "description": "

Creates a SetupIntent object.

\n\n

After you create the SetupIntent, attach a payment method and confirm\nit to collect any required permissions to charge the payment method later.

", "operationId": "PostSetupIntents", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "automatic_payment_methods": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "flow_directions": { "explode": true, "style": "deepObject" }, "mandate_data": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "payment_method_data": { "explode": true, "style": "deepObject" }, "payment_method_options": { "explode": true, "style": "deepObject" }, "payment_method_types": { "explode": true, "style": "deepObject" }, "single_use": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "attach_to_self": { "description": "If present, the SetupIntent's payment method will be attached to the in-context Stripe Account.\n\nIt can only be used for this Stripe Account’s own money movement flows like InboundTransfer and OutboundTransfers. It cannot be set to true when setting up a PaymentMethod for a Customer, and defaults to false when attaching a PaymentMethod to a Customer.", "type": "boolean" }, "automatic_payment_methods": { "description": "When you enable this parameter, this SetupIntent accepts payment methods that you enable in the Dashboard and that are compatible with its other parameters.", "properties": { "allow_redirects": { "description": "Controls whether this SetupIntent will accept redirect-based payment methods.\n\nRedirect-based payment methods may require your customer to be redirected to a payment method's app or site for authentication or additional steps. To [confirm](https://stripe.com/docs/api/setup_intents/confirm) this SetupIntent, you may be required to provide a `return_url` to redirect customers back to your site after they authenticate or complete the setup.", "enum": [ "always", "never" ], "type": "string" }, "enabled": { "description": "Whether this feature is enabled.", "type": "boolean" } }, "required": [ "enabled" ], "title": "automatic_payment_methods_param", "type": "object", "x-stripeMostCommon": [ "allow_redirects", "enabled" ] }, "confirm": { "description": "Set to `true` to attempt to confirm this SetupIntent immediately. This parameter defaults to `false`. If a card is the attached payment method, you can provide a `return_url` in case further authentication is necessary.", "type": "boolean" }, "confirmation_token": { "description": "ID of the ConfirmationToken used to confirm this SetupIntent.\n\nIf the provided ConfirmationToken contains properties that are also being provided in this request, such as `payment_method`, then the values in this request will take precedence.", "maxLength": 5000, "type": "string" }, "customer": { "description": "ID of the Customer this SetupIntent belongs to, if one exists.\n\nIf present, the SetupIntent's payment method will be attached to the Customer on successful setup. Payment methods attached to other Customers cannot be used with this SetupIntent.", "maxLength": 5000, "type": "string" }, "customer_account": { "description": "ID of the Account this SetupIntent belongs to, if one exists.\n\nIf present, the SetupIntent's payment method will be attached to the Account on successful setup. Payment methods attached to other Accounts cannot be used with this SetupIntent.", "maxLength": 5000, "type": "string" }, "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users.", "maxLength": 1000, "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "flow_directions": { "description": "Indicates the directions of money movement for which this payment method is intended to be used.\n\nInclude `inbound` if you intend to use the payment method as the origin to pull funds from. Include `outbound` if you intend to use the payment method as the destination to send funds to. You can include both if you intend to use the payment method for both purposes.", "items": { "enum": [ "inbound", "outbound" ], "type": "string" }, "type": "array" }, "mandate_data": { "anyOf": [ { "properties": { "customer_acceptance": { "description": "This hash contains details about the customer acceptance of the Mandate.", "properties": { "accepted_at": { "description": "The time at which the customer accepted the Mandate.", "format": "unix-time", "type": "integer" }, "offline": { "description": "If this is a Mandate accepted offline, this hash contains details about the offline acceptance.", "properties": {}, "title": "offline_param", "type": "object" }, "online": { "description": "If this is a Mandate accepted online, this hash contains details about the online acceptance.", "properties": { "ip_address": { "description": "The IP address from which the Mandate was accepted by the customer.", "type": "string" }, "user_agent": { "description": "The user agent of the browser from which the Mandate was accepted by the customer.", "maxLength": 5000, "type": "string" } }, "required": [ "ip_address", "user_agent" ], "title": "online_param", "type": "object", "x-stripeMostCommon": [ "ip_address", "user_agent" ] }, "type": { "description": "The type of customer acceptance information included with the Mandate. One of `online` or `offline`.", "enum": [ "offline", "online" ], "maxLength": 5000, "type": "string" } }, "required": [ "type" ], "title": "customer_acceptance_param", "type": "object", "x-stripeMostCommon": [ "accepted_at", "offline", "online", "type" ] } }, "required": [ "customer_acceptance" ], "title": "secret_key_param", "type": "object", "x-stripeMostCommon": [ "customer_acceptance" ] }, { "enum": [ "" ], "type": "string" } ], "description": "This hash contains details about the mandate to create. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/setup_intents/create#create_setup_intent-confirm)." }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "on_behalf_of": { "description": "The Stripe account ID created for this SetupIntent.", "type": "string" }, "payment_method": { "description": "ID of the payment method (a PaymentMethod, Card, or saved Source object) to attach to this SetupIntent.", "maxLength": 5000, "type": "string" }, "payment_method_configuration": { "description": "The ID of the [payment method configuration](https://stripe.com/docs/api/payment_method_configurations) to use with this SetupIntent.", "maxLength": 100, "type": "string" }, "payment_method_data": { "description": "When included, this hash creates a PaymentMethod that is set as the [`payment_method`](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-payment_method)\nvalue in the SetupIntent.", "properties": { "acss_debit": { "description": "If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method.", "properties": { "account_number": { "description": "Customer's bank account number.", "maxLength": 5000, "type": "string" }, "institution_number": { "description": "Institution number of the customer's bank.", "maxLength": 5000, "type": "string" }, "transit_number": { "description": "Transit number of the customer's bank.", "maxLength": 5000, "type": "string" } }, "required": [ "account_number", "institution_number", "transit_number" ], "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "account_number", "financial_connections_account", "institution_number", "transit_number" ] }, "affirm": { "description": "If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method.", "properties": {}, "title": "param", "type": "object" }, "afterpay_clearpay": { "description": "If this is an `AfterpayClearpay` PaymentMethod, this hash contains details about the AfterpayClearpay payment method.", "properties": {}, "title": "param", "type": "object" }, "alipay": { "description": "If this is an `Alipay` PaymentMethod, this hash contains details about the Alipay payment method.", "properties": {}, "title": "param", "type": "object" }, "allow_redisplay": { "description": "This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to `unspecified`.", "enum": [ "always", "limited", "unspecified" ], "type": "string" }, "alma": { "description": "If this is a Alma PaymentMethod, this hash contains details about the Alma payment method.", "properties": {}, "title": "param", "type": "object" }, "amazon_pay": { "description": "If this is a AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method.", "properties": {}, "title": "param", "type": "object" }, "au_becs_debit": { "description": "If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account.", "properties": { "account_number": { "description": "The account number for the bank account.", "maxLength": 5000, "type": "string" }, "bsb_number": { "description": "Bank-State-Branch number of the bank account.", "maxLength": 5000, "type": "string" } }, "required": [ "account_number", "bsb_number" ], "title": "param", "type": "object", "x-stripeMostCommon": [ "account_number", "bsb_number" ] }, "bacs_debit": { "description": "If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.", "properties": { "account_number": { "description": "Account number of the bank account that the funds will be debited from.", "maxLength": 5000, "type": "string" }, "sort_code": { "description": "Sort code of the bank account. (e.g., `10-20-30`)", "maxLength": 5000, "type": "string" } }, "title": "param", "type": "object", "x-stripeMostCommon": [ "account_number", "sort_code" ] }, "bancontact": { "description": "If this is a `bancontact` PaymentMethod, this hash contains details about the Bancontact payment method.", "properties": {}, "title": "param", "type": "object" }, "billie": { "description": "If this is a `billie` PaymentMethod, this hash contains details about the Billie payment method.", "properties": {}, "title": "param", "type": "object" }, "billing_details": { "description": "Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.", "properties": { "address": { "anyOf": [ { "properties": { "city": { "description": "City, district, suburb, town, or village.", "maxLength": 5000, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Address line 1 (e.g., street, PO Box, or company name).", "maxLength": 5000, "type": "string" }, "line2": { "description": "Address line 2 (e.g., apartment, suite, unit, or building).", "maxLength": 5000, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "State, county, province, or region.", "maxLength": 5000, "type": "string" } }, "title": "billing_details_address", "type": "object", "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Billing address." }, "email": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Email address." }, "name": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Full name." }, "phone": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Billing phone number (including extension)." }, "tax_id": { "description": "Taxpayer identification number. Used only for transactions between LATAM buyers and non-LATAM sellers.", "maxLength": 5000, "type": "string" } }, "title": "billing_details_inner_params", "type": "object", "x-stripeMostCommon": [ "address", "email", "name", "phone", "tax_id" ] }, "blik": { "description": "If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.", "properties": {}, "title": "param", "type": "object" }, "boleto": { "description": "If this is a `boleto` PaymentMethod, this hash contains details about the Boleto payment method.", "properties": { "tax_id": { "description": "The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers)", "maxLength": 5000, "type": "string" } }, "required": [ "tax_id" ], "title": "param", "type": "object", "x-stripeMostCommon": [ "tax_id" ] }, "cashapp": { "description": "If this is a `cashapp` PaymentMethod, this hash contains details about the Cash App Pay payment method.", "properties": {}, "title": "param", "type": "object" }, "crypto": { "description": "If this is a Crypto PaymentMethod, this hash contains details about the Crypto payment method.", "properties": {}, "title": "param", "type": "object" }, "customer_balance": { "description": "If this is a `customer_balance` PaymentMethod, this hash contains details about the CustomerBalance payment method.", "properties": {}, "title": "param", "type": "object" }, "eps": { "description": "If this is an `eps` PaymentMethod, this hash contains details about the EPS payment method.", "properties": { "bank": { "description": "The customer's bank.", "enum": [ "arzte_und_apotheker_bank", "austrian_anadi_bank_ag", "bank_austria", "bankhaus_carl_spangler", "bankhaus_schelhammer_und_schattera_ag", "bawag_psk_ag", "bks_bank_ag", "brull_kallmus_bank_ag", "btv_vier_lander_bank", "capital_bank_grawe_gruppe_ag", "deutsche_bank_ag", "dolomitenbank", "easybank_ag", "erste_bank_und_sparkassen", "hypo_alpeadriabank_international_ag", "hypo_bank_burgenland_aktiengesellschaft", "hypo_noe_lb_fur_niederosterreich_u_wien", "hypo_oberosterreich_salzburg_steiermark", "hypo_tirol_bank_ag", "hypo_vorarlberg_bank_ag", "marchfelder_bank", "oberbank_ag", "raiffeisen_bankengruppe_osterreich", "schoellerbank_ag", "sparda_bank_wien", "volksbank_gruppe", "volkskreditbank_ag", "vr_bank_braunau" ], "maxLength": 5000, "type": "string" } }, "title": "param", "type": "object", "x-stripeMostCommon": [ "bank" ] }, "fpx": { "description": "If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method.", "properties": { "account_holder_type": { "description": "Account holder type for FPX transaction", "enum": [ "company", "individual" ], "maxLength": 5000, "type": "string" }, "bank": { "description": "The customer's bank.", "enum": [ "affin_bank", "agrobank", "alliance_bank", "ambank", "bank_islam", "bank_muamalat", "bank_of_china", "bank_rakyat", "bsn", "cimb", "deutsche_bank", "hong_leong_bank", "hsbc", "kfh", "maybank2e", "maybank2u", "ocbc", "pb_enterprise", "public_bank", "rhb", "standard_chartered", "uob" ], "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true } }, "required": [ "bank" ], "title": "param", "type": "object", "x-stripeMostCommon": [ "account_holder_type", "bank" ] }, "giropay": { "description": "If this is a `giropay` PaymentMethod, this hash contains details about the Giropay payment method.", "properties": {}, "title": "param", "type": "object" }, "gopay": { "description": "If this is a Gopay PaymentMethod, this hash contains details about the Gopay payment method.", "properties": {}, "title": "param", "type": "object" }, "grabpay": { "description": "If this is a `grabpay` PaymentMethod, this hash contains details about the GrabPay payment method.", "properties": {}, "title": "param", "type": "object" }, "id_bank_transfer": { "description": "If this is an `IdBankTransfer` PaymentMethod, this hash contains details about the IdBankTransfer payment method.", "properties": { "bank": { "description": "Bank where the account is held.", "enum": [ "bca", "bni", "bri", "cimb", "permata" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "param", "type": "object", "x-stripeMostCommon": [ "bank" ] }, "ideal": { "description": "If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method.", "properties": { "bank": { "description": "The customer's bank. Only use this parameter for existing customers. Don't use it for new customers.", "enum": [ "abn_amro", "asn_bank", "bunq", "buut", "handelsbanken", "ing", "knab", "moneyou", "n26", "nn", "rabobank", "regiobank", "revolut", "sns_bank", "triodos_bank", "van_lanschot", "yoursafe" ], "maxLength": 5000, "type": "string" } }, "title": "param", "type": "object", "x-stripeMostCommon": [ "bank" ] }, "interac_present": { "description": "If this is an `interac_present` PaymentMethod, this hash contains details about the Interac Present payment method.", "properties": {}, "title": "param", "type": "object", "x-stripeMostCommon": [ "device_identifier", "device_type", "emv", "location" ] }, "kakao_pay": { "description": "If this is a `kakao_pay` PaymentMethod, this hash contains details about the Kakao Pay payment method.", "properties": {}, "title": "param", "type": "object" }, "klarna": { "description": "If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method.", "properties": { "dob": { "description": "Customer's date of birth", "properties": { "day": { "description": "The day of birth, between 1 and 31.", "type": "integer" }, "month": { "description": "The month of birth, between 1 and 12.", "type": "integer" }, "year": { "description": "The four-digit year of birth.", "type": "integer" } }, "required": [ "day", "month", "year" ], "title": "date_of_birth", "type": "object", "x-stripeMostCommon": [ "day", "month", "year" ] } }, "title": "param", "type": "object", "x-stripeMostCommon": [ "dob" ] }, "konbini": { "description": "If this is a `konbini` PaymentMethod, this hash contains details about the Konbini payment method.", "properties": {}, "title": "param", "type": "object" }, "kr_card": { "description": "If this is a `kr_card` PaymentMethod, this hash contains details about the Korean Card payment method.", "properties": {}, "title": "param", "type": "object" }, "link": { "description": "If this is an `Link` PaymentMethod, this hash contains details about the Link payment method.", "properties": {}, "title": "param", "type": "object" }, "mb_way": { "description": "If this is a MB WAY PaymentMethod, this hash contains details about the MB WAY payment method.", "properties": {}, "title": "param", "type": "object" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "mobilepay": { "description": "If this is a `mobilepay` PaymentMethod, this hash contains details about the MobilePay payment method.", "properties": {}, "title": "param", "type": "object" }, "multibanco": { "description": "If this is a `multibanco` PaymentMethod, this hash contains details about the Multibanco payment method.", "properties": {}, "title": "param", "type": "object" }, "naver_pay": { "description": "If this is a `naver_pay` PaymentMethod, this hash contains details about the Naver Pay payment method.", "properties": { "funding": { "description": "Whether to use Naver Pay points or a card to fund this transaction. If not provided, this defaults to `card`.", "enum": [ "card", "points" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "param", "type": "object", "x-stripeMostCommon": [ "funding" ] }, "nz_bank_account": { "description": "If this is an nz_bank_account PaymentMethod, this hash contains details about the nz_bank_account payment method.", "properties": { "account_holder_name": { "description": "The name on the bank account. Only required if the account holder name is different from the name of the authorized signatory collected in the PaymentMethod’s billing details.", "maxLength": 5000, "type": "string" }, "account_number": { "description": "The account number for the bank account.", "maxLength": 5000, "type": "string" }, "bank_code": { "description": "The numeric code for the bank account's bank.", "maxLength": 5000, "type": "string" }, "branch_code": { "description": "The numeric code for the bank account's bank branch.", "maxLength": 5000, "type": "string" }, "reference": { "maxLength": 128, "type": "string" }, "suffix": { "description": "The suffix of the bank account number.", "maxLength": 5000, "type": "string" } }, "required": [ "account_number", "bank_code", "branch_code", "suffix" ], "title": "param", "type": "object", "x-stripeMostCommon": [ "account_holder_name", "account_number", "bank_code", "branch_code", "reference", "suffix" ] }, "oxxo": { "description": "If this is an `oxxo` PaymentMethod, this hash contains details about the OXXO payment method.", "properties": {}, "title": "param", "type": "object" }, "p24": { "description": "If this is a `p24` PaymentMethod, this hash contains details about the P24 payment method.", "properties": { "bank": { "description": "The customer's bank.", "enum": [ "alior_bank", "bank_millennium", "bank_nowy_bfg_sa", "bank_pekao_sa", "banki_spbdzielcze", "blik", "bnp_paribas", "boz", "citi_handlowy", "credit_agricole", "envelobank", "etransfer_pocztowy24", "getin_bank", "ideabank", "ing", "inteligo", "mbank_mtransfer", "nest_przelew", "noble_pay", "pbac_z_ipko", "plus_bank", "santander_przelew24", "tmobile_usbugi_bankowe", "toyota_bank", "velobank", "volkswagen_bank" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "param", "type": "object", "x-stripeMostCommon": [ "bank" ] }, "pay_by_bank": { "description": "If this is a `pay_by_bank` PaymentMethod, this hash contains details about the PayByBank payment method.", "properties": {}, "title": "param", "type": "object" }, "payco": { "description": "If this is a `payco` PaymentMethod, this hash contains details about the PAYCO payment method.", "properties": {}, "title": "param", "type": "object" }, "paynow": { "description": "If this is a `paynow` PaymentMethod, this hash contains details about the PayNow payment method.", "properties": {}, "title": "param", "type": "object" }, "paypal": { "description": "If this is a `paypal` PaymentMethod, this hash contains details about the PayPal payment method.", "properties": {}, "title": "param", "type": "object" }, "paypay": { "description": "If this is a `paypay` PaymentMethod, this hash contains details about the PayPay payment method.", "properties": {}, "title": "param", "type": "object" }, "payto": { "description": "If this is a `payto` PaymentMethod, this hash contains details about the PayTo payment method.", "properties": { "account_number": { "description": "The account number for the bank account.", "maxLength": 5000, "type": "string" }, "bsb_number": { "description": "Bank-State-Branch number of the bank account.", "maxLength": 5000, "type": "string" }, "pay_id": { "description": "The PayID alias for the bank account.", "maxLength": 5000, "type": "string" } }, "title": "param", "type": "object", "x-stripeMostCommon": [ "account_number", "bsb_number", "pay_id" ] }, "pix": { "description": "If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.", "properties": {}, "title": "param", "type": "object", "x-stripeMostCommon": [ "tax_id" ] }, "promptpay": { "description": "If this is a `promptpay` PaymentMethod, this hash contains details about the PromptPay payment method.", "properties": {}, "title": "param", "type": "object" }, "qris": { "description": "If this is a `qris` PaymentMethod, this hash contains details about the QRIS payment method.", "properties": {}, "title": "param", "type": "object" }, "radar_options": { "description": "Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.", "properties": { "session": { "description": "A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.", "maxLength": 5000, "type": "string" } }, "title": "radar_options_with_hidden_options", "type": "object", "x-stripeMostCommon": [ "session", "skip_rules" ] }, "rechnung": { "description": "If this is a `rechnung` PaymentMethod, this hash contains details about the Rechnung payment method.", "properties": { "dob": { "description": "Customer's date of birth", "properties": { "day": { "description": "The day of birth, between 1 and 31.", "type": "integer" }, "month": { "description": "The month of birth, between 1 and 12.", "type": "integer" }, "year": { "description": "The four-digit year of birth.", "type": "integer" } }, "required": [ "day", "month", "year" ], "title": "date_of_birth", "type": "object", "x-stripeMostCommon": [ "day", "month", "year" ] } }, "required": [ "dob" ], "title": "param", "type": "object", "x-stripeMostCommon": [ "dob" ] }, "revolut_pay": { "description": "If this is a `revolut_pay` PaymentMethod, this hash contains details about the Revolut Pay payment method.", "properties": {}, "title": "param", "type": "object" }, "samsung_pay": { "description": "If this is a `samsung_pay` PaymentMethod, this hash contains details about the SamsungPay payment method.", "properties": {}, "title": "param", "type": "object" }, "satispay": { "description": "If this is a `satispay` PaymentMethod, this hash contains details about the Satispay payment method.", "properties": {}, "title": "param", "type": "object" }, "sepa_debit": { "description": "If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account.", "properties": { "iban": { "description": "IBAN of the bank account.", "maxLength": 5000, "type": "string" } }, "required": [ "iban" ], "title": "param", "type": "object", "x-stripeMostCommon": [ "iban" ] }, "shopeepay": { "description": "If this is a Shopeepay PaymentMethod, this hash contains details about the Shopeepay payment method.", "properties": {}, "title": "param", "type": "object" }, "sofort": { "description": "If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.", "properties": { "country": { "description": "Two-letter ISO code representing the country the bank account is located in.", "enum": [ "AT", "BE", "DE", "ES", "IT", "NL" ], "type": "string" } }, "required": [ "country" ], "title": "param", "type": "object", "x-stripeMostCommon": [ "country" ] }, "stripe_balance": { "description": "This hash contains details about the Stripe balance payment method.", "properties": { "account": { "description": "The connected account ID whose Stripe balance to use as the source of payment", "maxLength": 5000, "type": "string" }, "source_type": { "description": "The [source_type](https://docs.stripe.com/api/balance/balance_object#balance_object-available-source_types) of the balance", "enum": [ "bank_account", "card", "fpx" ], "type": "string" } }, "title": "param", "type": "object", "x-stripeMostCommon": [ "account", "source_type" ] }, "swish": { "description": "If this is a `swish` PaymentMethod, this hash contains details about the Swish payment method.", "properties": {}, "title": "param", "type": "object" }, "twint": { "description": "If this is a TWINT PaymentMethod, this hash contains details about the TWINT payment method.", "properties": {}, "title": "param", "type": "object" }, "type": { "description": "The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.", "enum": [ "acss_debit", "affirm", "afterpay_clearpay", "alipay", "alma", "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", "billie", "blik", "boleto", "cashapp", "crypto", "customer_balance", "eps", "fpx", "giropay", "gopay", "grabpay", "id_bank_transfer", "ideal", "kakao_pay", "klarna", "konbini", "kr_card", "link", "mb_way", "mobilepay", "multibanco", "naver_pay", "nz_bank_account", "oxxo", "p24", "pay_by_bank", "payco", "paynow", "paypal", "paypay", "payto", "pix", "promptpay", "qris", "rechnung", "revolut_pay", "samsung_pay", "satispay", "sepa_debit", "shopeepay", "sofort", "stripe_balance", "swish", "twint", "us_bank_account", "wechat_pay", "zip" ], "type": "string", "x-stripeBypassValidation": true }, "us_bank_account": { "description": "If this is an `us_bank_account` PaymentMethod, this hash contains details about the US bank account payment method.", "properties": { "account_holder_type": { "description": "Account holder type: individual or company.", "enum": [ "company", "individual" ], "type": "string" }, "account_number": { "description": "Account number of the bank account.", "maxLength": 5000, "type": "string" }, "account_type": { "description": "Account type: checkings or savings. Defaults to checking if omitted.", "enum": [ "checking", "savings" ], "type": "string" }, "financial_connections_account": { "description": "The ID of a Financial Connections Account to use as a payment method.", "maxLength": 5000, "type": "string" }, "routing_number": { "description": "Routing number of the bank account.", "maxLength": 5000, "type": "string" } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "account_holder_type", "account_number", "account_type", "financial_connections_account", "routing_number" ] }, "wechat_pay": { "description": "If this is an `wechat_pay` PaymentMethod, this hash contains details about the wechat_pay payment method.", "properties": {}, "title": "param", "type": "object" }, "zip": { "description": "If this is a `zip` PaymentMethod, this hash contains details about the Zip payment method.", "properties": {}, "title": "param", "type": "object" } }, "required": [ "type" ], "title": "payment_method_data_params", "type": "object", "x-stripeMostCommon": [ "billing_details", "metadata", "type" ] }, "payment_method_options": { "description": "Payment method-specific configuration for this SetupIntent.", "properties": { "acss_debit": { "description": "If this is a `acss_debit` SetupIntent, this sub-hash contains details about the ACSS Debit payment method options.", "properties": { "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "enum": [ "cad", "usd" ], "type": "string" }, "mandate_options": { "description": "Additional fields for Mandate creation", "properties": { "custom_mandate_url": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "A URL for custom mandate text to render during confirmation step.\nThe URL will be rendered with additional GET parameters `payment_intent` and `payment_intent_client_secret` when confirming a Payment Intent,\nor `setup_intent` and `setup_intent_client_secret` when confirming a Setup Intent." }, "default_for": { "description": "List of Stripe products where this mandate can be selected automatically.", "items": { "enum": [ "invoice", "subscription" ], "type": "string" }, "type": "array" }, "interval_description": { "description": "Description of the mandate interval. Only required if 'payment_schedule' parameter is 'interval' or 'combined'.", "maxLength": 500, "type": "string" }, "payment_schedule": { "description": "Payment schedule for the mandate.", "enum": [ "combined", "interval", "sporadic" ], "type": "string" }, "transaction_type": { "description": "Transaction type of the mandate.", "enum": [ "business", "personal" ], "type": "string" } }, "title": "setup_intent_payment_method_options_mandate_options_param", "type": "object", "x-stripeMostCommon": [ "custom_mandate_url", "default_for", "interval_description", "payment_schedule", "transaction_type" ] }, "verification_method": { "description": "Bank account verification method.", "enum": [ "automatic", "instant", "microdeposits" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "setup_intent_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "currency", "financial_connections", "mandate_options", "verification_method" ] }, "amazon_pay": { "description": "If this is a `amazon_pay` SetupIntent, this sub-hash contains details about the AmazonPay payment method options.", "properties": {}, "title": "setup_intent_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "charge_permission_id" ] }, "bacs_debit": { "description": "If this is a `bacs_debit` SetupIntent, this sub-hash contains details about the Bacs Debit payment method options.", "properties": { "mandate_options": { "description": "Additional fields for Mandate creation", "properties": { "reference_prefix": { "anyOf": [ { "maxLength": 12, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'." } }, "title": "payment_method_options_mandate_options_param", "type": "object", "x-stripeMostCommon": [ "reference_prefix" ] } }, "title": "setup_intent_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "mandate_options" ] }, "card": { "description": "Configuration for any card setup attempted on this SetupIntent.", "properties": { "mandate_options": { "description": "Configuration options for setting up an eMandate for cards issued in India.", "properties": { "amount": { "description": "Amount to be charged for future payments.", "type": "integer" }, "amount_type": { "description": "One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.", "enum": [ "fixed", "maximum" ], "type": "string" }, "currency": { "description": "Currency in which future payments will be charged. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "description": { "description": "A description of the mandate or subscription that is meant to be displayed to the customer.", "maxLength": 200, "type": "string" }, "end_date": { "description": "End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.", "format": "unix-time", "type": "integer" }, "interval": { "description": "Specifies payment frequency. One of `day`, `week`, `month`, `year`, or `sporadic`.", "enum": [ "day", "month", "sporadic", "week", "year" ], "type": "string" }, "interval_count": { "description": "The number of intervals between payments. For example, `interval=month` and `interval_count=3` indicates one payment every three months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). This parameter is optional when `interval=sporadic`.", "type": "integer" }, "reference": { "description": "Unique identifier for the mandate or subscription.", "maxLength": 80, "type": "string" }, "start_date": { "description": "Start date of the mandate or subscription. Start date should not be lesser than yesterday.", "format": "unix-time", "type": "integer" }, "supported_types": { "description": "Specifies the type of mandates supported. Possible values are `india`.", "items": { "enum": [ "india" ], "type": "string" }, "type": "array" } }, "required": [ "amount", "amount_type", "currency", "interval", "reference", "start_date" ], "title": "setup_intent_mandate_options_param", "type": "object", "x-stripeMostCommon": [ "amount", "amount_type", "currency", "description", "end_date", "interval", "interval_count", "reference", "start_date", "supported_types" ] }, "moto": { "description": "When specified, this parameter signals that a card has been collected\nas MOTO (Mail Order Telephone Order) and thus out of scope for SCA. This\nparameter can only be provided during confirmation.", "type": "boolean" }, "network": { "description": "Selected network to process this SetupIntent on. Depends on the available networks of the card attached to the SetupIntent. Can be only set confirm-time.", "enum": [ "amex", "cartes_bancaires", "diners", "discover", "eftpos_au", "girocard", "interac", "jcb", "link", "mastercard", "unionpay", "unknown", "visa" ], "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true }, "request_three_d_secure": { "description": "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.", "enum": [ "any", "automatic", "challenge" ], "type": "string", "x-stripeBypassValidation": true }, "three_d_secure": { "description": "If 3D Secure authentication was performed with a third-party provider,\nthe authentication details to use for this setup.", "properties": { "ares_trans_status": { "description": "The `transStatus` returned from the card Issuer’s ACS in the ARes.", "enum": [ "A", "C", "I", "N", "R", "U", "Y" ], "type": "string" }, "cryptogram": { "description": "The cryptogram, also known as the \"authentication value\" (AAV, CAVV or\nAEVV). This value is 20 bytes, base64-encoded into a 28-character string.\n(Most 3D Secure providers will return the base64-encoded version, which\nis what you should specify here.)", "maxLength": 5000, "type": "string" }, "electronic_commerce_indicator": { "description": "The Electronic Commerce Indicator (ECI) is returned by your 3D Secure\nprovider and indicates what degree of authentication was performed.", "enum": [ "01", "02", "05", "06", "07" ], "type": "string", "x-stripeBypassValidation": true }, "network_options": { "description": "Network specific 3DS fields. Network specific arguments require an\nexplicit card brand choice. The parameter `payment_method_options.card.network``\nmust be populated accordingly", "properties": { "cartes_bancaires": { "description": "Cartes Bancaires-specific 3DS fields.", "properties": { "cb_avalgo": { "description": "The cryptogram calculation algorithm used by the card Issuer's ACS\nto calculate the Authentication cryptogram. Also known as `cavvAlgorithm`.\nmessageExtension: CB-AVALGO", "enum": [ "0", "1", "2", "3", "4", "A" ], "type": "string" }, "cb_exemption": { "description": "The exemption indicator returned from Cartes Bancaires in the ARes.\nmessage extension: CB-EXEMPTION; string (4 characters)\nThis is a 3 byte bitmap (low significant byte first and most significant\nbit first) that has been Base64 encoded", "maxLength": 4, "type": "string" }, "cb_score": { "description": "The risk score returned from Cartes Bancaires in the ARes.\nmessage extension: CB-SCORE; numeric value 0-99", "type": "integer" } }, "required": [ "cb_avalgo" ], "title": "cartes_bancaires_network_options_param", "type": "object", "x-stripeMostCommon": [ "cb_avalgo", "cb_exemption", "cb_score" ] } }, "title": "network_options_param", "type": "object", "x-stripeMostCommon": [ "cartes_bancaires" ] }, "requestor_challenge_indicator": { "description": "The challenge indicator (`threeDSRequestorChallengeInd`) which was requested in the\nAReq sent to the card Issuer's ACS. A string containing 2 digits from 01-99.", "maxLength": 2, "type": "string" }, "transaction_id": { "description": "For 3D Secure 1, the XID. For 3D Secure 2, the Directory Server\nTransaction ID (dsTransID).", "maxLength": 5000, "type": "string" }, "version": { "description": "The version of 3D Secure that was performed.", "enum": [ "1.0.2", "2.1.0", "2.2.0" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "setup_intent_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "ares_trans_status", "cryptogram", "electronic_commerce_indicator", "exemption_preferred", "gateway", "network_options", "requestor_challenge_indicator", "transaction_id", "version" ] } }, "title": "setup_intent_param", "type": "object", "x-stripeMostCommon": [ "commerce_type", "mandate_options", "moto", "network", "network_token", "request_name_verification", "request_three_d_secure", "three_d_secure", "verify_card_account" ] }, "card_present": { "description": "If this is a `card_present` PaymentMethod, this sub-hash contains details about the card-present payment method options.", "properties": {}, "title": "setup_intent_payment_method_options_param", "type": "object" }, "klarna": { "description": "If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method options.", "properties": { "currency": { "description": "The currency of the SetupIntent. Three letter ISO currency code.", "format": "currency", "type": "string" }, "on_demand": { "description": "On-demand details if setting up a payment method for on-demand payments.", "properties": { "average_amount": { "description": "Your average amount value. You can use a value across your customer base, or segment based on customer type, country, etc.", "type": "integer" }, "maximum_amount": { "description": "The maximum value you may charge a customer per purchase. You can use a value across your customer base, or segment based on customer type, country, etc.", "type": "integer" }, "minimum_amount": { "description": "The lowest or minimum value you may charge a customer per purchase. You can use a value across your customer base, or segment based on customer type, country, etc.", "type": "integer" }, "purchase_interval": { "description": "Interval at which the customer is making purchases", "enum": [ "day", "month", "week", "year" ], "type": "string" }, "purchase_interval_count": { "description": "The number of `purchase_interval` between charges", "type": "integer" } }, "title": "on_demand_param", "type": "object", "x-stripeMostCommon": [ "average_amount", "maximum_amount", "minimum_amount", "purchase_interval", "purchase_interval_count" ] }, "preferred_locale": { "description": "Preferred language of the Klarna authorization page that the customer is redirected to", "enum": [ "cs-CZ", "da-DK", "de-AT", "de-CH", "de-DE", "el-GR", "en-AT", "en-AU", "en-BE", "en-CA", "en-CH", "en-CZ", "en-DE", "en-DK", "en-ES", "en-FI", "en-FR", "en-GB", "en-GR", "en-IE", "en-IT", "en-NL", "en-NO", "en-NZ", "en-PL", "en-PT", "en-RO", "en-SE", "en-US", "es-ES", "es-US", "fi-FI", "fr-BE", "fr-CA", "fr-CH", "fr-FR", "it-CH", "it-IT", "nb-NO", "nl-BE", "nl-NL", "pl-PL", "pt-PT", "ro-RO", "sv-FI", "sv-SE" ], "type": "string", "x-stripeBypassValidation": true }, "subscriptions": { "anyOf": [ { "items": { "properties": { "interval": { "description": "Unit of time between subscription charges.", "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "description": "The number of intervals (specified in the `interval` attribute) between subscription charges. For example, `interval=month` and `interval_count=3` charges every 3 months.", "type": "integer" }, "name": { "description": "Name for subscription.", "maxLength": 255, "type": "string" }, "next_billing": { "description": "Describes the upcoming charge for this subscription.", "properties": { "amount": { "description": "The amount of the next charge for the subscription.", "type": "integer" }, "date": { "description": "The date of the next charge for the subscription in YYYY-MM-DD format.", "maxLength": 5000, "type": "string" } }, "required": [ "amount", "date" ], "title": "subscription_next_billing_param", "type": "object", "x-stripeMostCommon": [ "amount", "date" ] }, "reference": { "description": "A non-customer-facing reference to correlate subscription charges in the Klarna app. Use a value that persists across subscription charges.", "maxLength": 255, "type": "string" } }, "required": [ "interval", "next_billing", "reference" ], "title": "setup_intent_subscription_param", "type": "object", "x-stripeMostCommon": [ "interval", "interval_count", "name", "next_billing", "reference" ] }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "Subscription details if setting up or charging a subscription" } }, "title": "setup_intent_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "currency", "interoperability_token", "on_demand", "payment_option_id", "preferred_locale", "subscriptions" ] }, "link": { "description": "If this is a `link` PaymentMethod, this sub-hash contains details about the Link payment method options.", "properties": { "persistent_token": { "description": "[Deprecated] This is a legacy parameter that no longer has any function.", "maxLength": 5000, "type": "string" } }, "title": "setup_intent_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "persistent_token" ] }, "paypal": { "description": "If this is a `paypal` PaymentMethod, this sub-hash contains details about the PayPal payment method options.", "properties": { "billing_agreement_id": { "description": "The PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer.", "maxLength": 5000, "type": "string" }, "currency": { "format": "currency", "type": "string" }, "subsellers": { "description": "The Stripe connected account IDs of the sellers on the platform for this transaction (optional). Only allowed when [separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers) are used.", "items": { "maxLength": 32, "type": "string" }, "type": "array" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "billing_agreement_id", "currency", "subsellers" ] }, "payto": { "description": "If this is a `payto` SetupIntent, this sub-hash contains details about the PayTo payment method options.", "properties": { "mandate_options": { "description": "Additional fields for Mandate creation.", "properties": { "amount": { "description": "Amount that will be collected. It is required when `amount_type` is `fixed`.", "type": "integer" }, "amount_type": { "description": "The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively.", "enum": [ "fixed", "maximum" ], "type": "string" }, "end_date": { "description": "Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.", "maxLength": 5000, "type": "string" }, "payment_schedule": { "description": "The periodicity at which payments will be collected.", "enum": [ "adhoc", "annual", "daily", "fortnightly", "monthly", "quarterly", "semi_annual", "weekly" ], "type": "string" }, "payments_per_period": { "description": "The number of payments that will be made during a payment period. Defaults to 1 except for when `payment_schedule` is `adhoc`. In that case, it defaults to no limit.", "type": "integer" }, "purpose": { "description": "The purpose for which payments are made. Defaults to retail.", "enum": [ "dependant_support", "government", "loan", "mortgage", "other", "pension", "personal", "retail", "salary", "tax", "utility" ], "type": "string" }, "start_date": { "description": "Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time.", "maxLength": 5000, "type": "string" } }, "title": "setup_intent_payment_method_options_mandate_options_param", "type": "object", "x-stripeMostCommon": [ "amount", "amount_type", "end_date", "payment_schedule", "payments_per_period", "purpose", "start_date" ] } }, "title": "setup_intent_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "mandate_options" ] }, "pix": { "description": "If this is a `pix` SetupIntent, this sub-hash contains details about the Pix payment method options.", "properties": { "mandate_options": { "description": "Additional fields for mandate creation.", "properties": { "amount": { "description": "Amount to be charged for future payments. Required when `amount_type=fixed`. If not provided for `amount_type=maximum`, defaults to 40000.", "type": "integer" }, "amount_includes_iof": { "description": "Determines if the amount includes the IOF tax. Defaults to `never`.", "enum": [ "always", "never" ], "type": "string" }, "amount_type": { "description": "Type of amount. Defaults to `maximum`.", "enum": [ "fixed", "maximum" ], "type": "string" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Only `brl` is supported currently.", "format": "currency", "type": "string" }, "end_date": { "description": "Date when the mandate expires and no further payments will be charged, in `YYYY-MM-DD`. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.", "maxLength": 5000, "type": "string" }, "payment_schedule": { "description": "Schedule at which the future payments will be charged. Defaults to `weekly`.", "enum": [ "halfyearly", "monthly", "quarterly", "weekly", "yearly" ], "type": "string" }, "reference": { "description": "Subscription name displayed to buyers in their bank app. Defaults to the displayable business name.", "maxLength": 35, "type": "string" }, "start_date": { "description": "Start date of the mandate, in `YYYY-MM-DD`. Start date should be at least 3 days in the future. Defaults to 3 days after the current date.", "maxLength": 5000, "type": "string" } }, "title": "payment_method_options_mandate_options_param", "type": "object", "x-stripeMostCommon": [ "amount", "amount_includes_iof", "amount_type", "currency", "end_date", "payment_schedule", "reference", "start_date" ] } }, "title": "setup_intent_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "mandate_options" ] }, "sepa_debit": { "description": "If this is a `sepa_debit` SetupIntent, this sub-hash contains details about the SEPA Debit payment method options.", "properties": { "mandate_options": { "description": "Additional fields for Mandate creation", "properties": { "reference_prefix": { "anyOf": [ { "maxLength": 12, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'." } }, "title": "payment_method_options_mandate_options_param", "type": "object", "x-stripeMostCommon": [ "reference", "reference_prefix" ] } }, "title": "setup_intent_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "mandate_options", "verification_method" ] }, "us_bank_account": { "description": "If this is a `us_bank_account` SetupIntent, this sub-hash contains details about the US bank account payment method options.", "properties": { "financial_connections": { "description": "Additional fields for Financial Connections Session creation", "properties": { "filters": { "description": "Provide filters for the linked accounts that the customer can select for the payment method.", "properties": { "account_subcategories": { "description": "The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.", "items": { "enum": [ "checking", "savings" ], "maxLength": 5000, "type": "string" }, "type": "array" }, "institution": { "description": "ID of the institution to use to filter for selectable accounts.", "maxLength": 5000, "type": "string" } }, "title": "linked_account_options_filters_param", "type": "object", "x-stripeMostCommon": [ "account_subcategories", "institution" ] }, "manual_entry": { "description": "Customize manual entry behavior", "properties": { "mode": { "description": "Settings for configuring manual entry of account details.", "enum": [ "automatic", "custom" ], "type": "string" } }, "required": [ "mode" ], "title": "linked_account_options_manual_entry_param", "type": "object", "x-stripeMostCommon": [ "mode" ] }, "permissions": { "description": "The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.", "items": { "enum": [ "balances", "ownership", "payment_method", "transactions" ], "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true }, "type": "array" }, "prefetch": { "description": "List of data features that you would like to retrieve upon account creation.", "items": { "enum": [ "balances", "inferred_balances", "ownership", "transactions" ], "type": "string", "x-stripeBypassValidation": true }, "type": "array" }, "return_url": { "description": "For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.", "maxLength": 5000, "type": "string" } }, "title": "linked_account_options_param", "type": "object", "x-stripeMostCommon": [ "filters", "manual_entry", "permissions", "prefetch", "return_url" ] }, "mandate_options": { "description": "Additional fields for Mandate creation", "properties": { "collection_method": { "description": "The method used to collect offline mandate customer acceptance.", "enum": [ "", "paper" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "mandate_options_param", "type": "object", "x-stripeMostCommon": [ "collection_method" ] }, "networks": { "description": "Additional fields for network related functions", "properties": { "requested": { "description": "Triggers validations to run across the selected networks", "items": { "enum": [ "ach", "us_domestic_wire" ], "type": "string" }, "type": "array" } }, "title": "networks_options_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "verification_method": { "description": "Bank account verification method.", "enum": [ "automatic", "instant", "microdeposits" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "setup_intent_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "financial_connections", "mandate_options", "networks", "verification_method" ] } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "acss_debit", "alipay", "amazon_pay", "bacs_debit", "blik", "card", "card_present", "demo_pay", "dummy_auth_push", "klarna", "link", "paypal", "payto", "pix", "sepa_debit", "upi", "us_bank_account", "wechat_pay" ] }, "payment_method_types": { "description": "The list of payment method types (for example, card) that this SetupIntent can use. If you don't provide this, Stripe will dynamically show relevant payment methods from your [payment method settings](https://dashboard.stripe.com/settings/payment_methods). A list of valid payment method types can be found [here](https://docs.stripe.com/api/payment_methods/object#payment_method_object-type).", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "return_url": { "description": "The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. To redirect to a mobile application, you can alternatively supply an application URI scheme. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/setup_intents/create#create_setup_intent-confirm).", "type": "string" }, "single_use": { "description": "If you populate this hash, this SetupIntent generates a `single_use` mandate after successful completion.\n\nSingle-use mandates are only valid for the following payment methods: `acss_debit`, `alipay`, `au_becs_debit`, `bacs_debit`, `bancontact`, `boleto`, `ideal`, `link`, `sepa_debit`, and `us_bank_account`.", "properties": { "amount": { "description": "Amount the customer is granting permission to collect later. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" } }, "required": [ "amount", "currency" ], "title": "setup_intent_single_use_params", "type": "object", "x-stripeMostCommon": [ "amount", "currency" ] }, "usage": { "description": "Indicates how the payment method is intended to be used in the future. If not provided, this value defaults to `off_session`.", "enum": [ "off_session", "on_session" ], "type": "string" }, "use_stripe_sdk": { "description": "Set to `true` when confirming server-side and using Stripe.js, iOS, or Android client-side SDKs to handle the next actions.", "type": "boolean" } }, "type": "object", "x-stripeMostCommon": [ "automatic_payment_methods", "confirm", "customer", "description", "metadata", "payment_method", "usage" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setup_intent" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a SetupIntent" } }, "/v1/setup_intents/{intent}": { "get": { "description": "

Retrieves the details of a SetupIntent that has previously been created.

\n\n

Client-side retrieval using a publishable key is allowed when the client_secret is provided in the query string.

\n\n

When retrieved with a publishable key, only a subset of properties will be returned. Please refer to the SetupIntent object reference for more details.

", "operationId": "GetSetupIntentsIntent", "parameters": [ { "description": "The client secret of the SetupIntent. We require this string if you use a publishable key to retrieve the SetupIntent.", "in": "query", "name": "client_secret", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "intent", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setup_intent" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a SetupIntent" }, "post": { "description": "

Updates a SetupIntent object.

", "operationId": "PostSetupIntentsIntent", "parameters": [ { "in": "path", "name": "intent", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "flow_directions": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "payment_method_data": { "explode": true, "style": "deepObject" }, "payment_method_options": { "explode": true, "style": "deepObject" }, "payment_method_types": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "attach_to_self": { "description": "If present, the SetupIntent's payment method will be attached to the in-context Stripe Account.\n\nIt can only be used for this Stripe Account’s own money movement flows like InboundTransfer and OutboundTransfers. It cannot be set to true when setting up a PaymentMethod for a Customer, and defaults to false when attaching a PaymentMethod to a Customer.", "type": "boolean" }, "customer": { "description": "ID of the Customer this SetupIntent belongs to, if one exists.\n\nIf present, the SetupIntent's payment method will be attached to the Customer on successful setup. Payment methods attached to other Customers cannot be used with this SetupIntent.", "maxLength": 5000, "type": "string" }, "customer_account": { "description": "ID of the Account this SetupIntent belongs to, if one exists.\n\nIf present, the SetupIntent's payment method will be attached to the Account on successful setup. Payment methods attached to other Accounts cannot be used with this SetupIntent.", "maxLength": 5000, "type": "string" }, "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users.", "maxLength": 1000, "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "flow_directions": { "description": "Indicates the directions of money movement for which this payment method is intended to be used.\n\nInclude `inbound` if you intend to use the payment method as the origin to pull funds from. Include `outbound` if you intend to use the payment method as the destination to send funds to. You can include both if you intend to use the payment method for both purposes.", "items": { "enum": [ "inbound", "outbound" ], "type": "string" }, "type": "array" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "payment_method": { "description": "ID of the payment method (a PaymentMethod, Card, or saved Source object) to attach to this SetupIntent. To unset this field to null, pass in an empty string.", "maxLength": 5000, "type": "string" }, "payment_method_configuration": { "description": "The ID of the [payment method configuration](https://stripe.com/docs/api/payment_method_configurations) to use with this SetupIntent.", "maxLength": 100, "type": "string" }, "payment_method_data": { "description": "When included, this hash creates a PaymentMethod that is set as the [`payment_method`](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-payment_method)\nvalue in the SetupIntent.", "properties": { "acss_debit": { "description": "If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method.", "properties": { "account_number": { "description": "Customer's bank account number.", "maxLength": 5000, "type": "string" }, "institution_number": { "description": "Institution number of the customer's bank.", "maxLength": 5000, "type": "string" }, "transit_number": { "description": "Transit number of the customer's bank.", "maxLength": 5000, "type": "string" } }, "required": [ "account_number", "institution_number", "transit_number" ], "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "account_number", "financial_connections_account", "institution_number", "transit_number" ] }, "affirm": { "description": "If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method.", "properties": {}, "title": "param", "type": "object" }, "afterpay_clearpay": { "description": "If this is an `AfterpayClearpay` PaymentMethod, this hash contains details about the AfterpayClearpay payment method.", "properties": {}, "title": "param", "type": "object" }, "alipay": { "description": "If this is an `Alipay` PaymentMethod, this hash contains details about the Alipay payment method.", "properties": {}, "title": "param", "type": "object" }, "allow_redisplay": { "description": "This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to `unspecified`.", "enum": [ "always", "limited", "unspecified" ], "type": "string" }, "alma": { "description": "If this is a Alma PaymentMethod, this hash contains details about the Alma payment method.", "properties": {}, "title": "param", "type": "object" }, "amazon_pay": { "description": "If this is a AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method.", "properties": {}, "title": "param", "type": "object" }, "au_becs_debit": { "description": "If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account.", "properties": { "account_number": { "description": "The account number for the bank account.", "maxLength": 5000, "type": "string" }, "bsb_number": { "description": "Bank-State-Branch number of the bank account.", "maxLength": 5000, "type": "string" } }, "required": [ "account_number", "bsb_number" ], "title": "param", "type": "object", "x-stripeMostCommon": [ "account_number", "bsb_number" ] }, "bacs_debit": { "description": "If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.", "properties": { "account_number": { "description": "Account number of the bank account that the funds will be debited from.", "maxLength": 5000, "type": "string" }, "sort_code": { "description": "Sort code of the bank account. (e.g., `10-20-30`)", "maxLength": 5000, "type": "string" } }, "title": "param", "type": "object", "x-stripeMostCommon": [ "account_number", "sort_code" ] }, "bancontact": { "description": "If this is a `bancontact` PaymentMethod, this hash contains details about the Bancontact payment method.", "properties": {}, "title": "param", "type": "object" }, "billie": { "description": "If this is a `billie` PaymentMethod, this hash contains details about the Billie payment method.", "properties": {}, "title": "param", "type": "object" }, "billing_details": { "description": "Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.", "properties": { "address": { "anyOf": [ { "properties": { "city": { "description": "City, district, suburb, town, or village.", "maxLength": 5000, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Address line 1 (e.g., street, PO Box, or company name).", "maxLength": 5000, "type": "string" }, "line2": { "description": "Address line 2 (e.g., apartment, suite, unit, or building).", "maxLength": 5000, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "State, county, province, or region.", "maxLength": 5000, "type": "string" } }, "title": "billing_details_address", "type": "object", "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Billing address." }, "email": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Email address." }, "name": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Full name." }, "phone": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Billing phone number (including extension)." }, "tax_id": { "description": "Taxpayer identification number. Used only for transactions between LATAM buyers and non-LATAM sellers.", "maxLength": 5000, "type": "string" } }, "title": "billing_details_inner_params", "type": "object", "x-stripeMostCommon": [ "address", "email", "name", "phone", "tax_id" ] }, "blik": { "description": "If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.", "properties": {}, "title": "param", "type": "object" }, "boleto": { "description": "If this is a `boleto` PaymentMethod, this hash contains details about the Boleto payment method.", "properties": { "tax_id": { "description": "The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers)", "maxLength": 5000, "type": "string" } }, "required": [ "tax_id" ], "title": "param", "type": "object", "x-stripeMostCommon": [ "tax_id" ] }, "cashapp": { "description": "If this is a `cashapp` PaymentMethod, this hash contains details about the Cash App Pay payment method.", "properties": {}, "title": "param", "type": "object" }, "crypto": { "description": "If this is a Crypto PaymentMethod, this hash contains details about the Crypto payment method.", "properties": {}, "title": "param", "type": "object" }, "customer_balance": { "description": "If this is a `customer_balance` PaymentMethod, this hash contains details about the CustomerBalance payment method.", "properties": {}, "title": "param", "type": "object" }, "eps": { "description": "If this is an `eps` PaymentMethod, this hash contains details about the EPS payment method.", "properties": { "bank": { "description": "The customer's bank.", "enum": [ "arzte_und_apotheker_bank", "austrian_anadi_bank_ag", "bank_austria", "bankhaus_carl_spangler", "bankhaus_schelhammer_und_schattera_ag", "bawag_psk_ag", "bks_bank_ag", "brull_kallmus_bank_ag", "btv_vier_lander_bank", "capital_bank_grawe_gruppe_ag", "deutsche_bank_ag", "dolomitenbank", "easybank_ag", "erste_bank_und_sparkassen", "hypo_alpeadriabank_international_ag", "hypo_bank_burgenland_aktiengesellschaft", "hypo_noe_lb_fur_niederosterreich_u_wien", "hypo_oberosterreich_salzburg_steiermark", "hypo_tirol_bank_ag", "hypo_vorarlberg_bank_ag", "marchfelder_bank", "oberbank_ag", "raiffeisen_bankengruppe_osterreich", "schoellerbank_ag", "sparda_bank_wien", "volksbank_gruppe", "volkskreditbank_ag", "vr_bank_braunau" ], "maxLength": 5000, "type": "string" } }, "title": "param", "type": "object", "x-stripeMostCommon": [ "bank" ] }, "fpx": { "description": "If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method.", "properties": { "account_holder_type": { "description": "Account holder type for FPX transaction", "enum": [ "company", "individual" ], "maxLength": 5000, "type": "string" }, "bank": { "description": "The customer's bank.", "enum": [ "affin_bank", "agrobank", "alliance_bank", "ambank", "bank_islam", "bank_muamalat", "bank_of_china", "bank_rakyat", "bsn", "cimb", "deutsche_bank", "hong_leong_bank", "hsbc", "kfh", "maybank2e", "maybank2u", "ocbc", "pb_enterprise", "public_bank", "rhb", "standard_chartered", "uob" ], "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true } }, "required": [ "bank" ], "title": "param", "type": "object", "x-stripeMostCommon": [ "account_holder_type", "bank" ] }, "giropay": { "description": "If this is a `giropay` PaymentMethod, this hash contains details about the Giropay payment method.", "properties": {}, "title": "param", "type": "object" }, "gopay": { "description": "If this is a Gopay PaymentMethod, this hash contains details about the Gopay payment method.", "properties": {}, "title": "param", "type": "object" }, "grabpay": { "description": "If this is a `grabpay` PaymentMethod, this hash contains details about the GrabPay payment method.", "properties": {}, "title": "param", "type": "object" }, "id_bank_transfer": { "description": "If this is an `IdBankTransfer` PaymentMethod, this hash contains details about the IdBankTransfer payment method.", "properties": { "bank": { "description": "Bank where the account is held.", "enum": [ "bca", "bni", "bri", "cimb", "permata" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "param", "type": "object", "x-stripeMostCommon": [ "bank" ] }, "ideal": { "description": "If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method.", "properties": { "bank": { "description": "The customer's bank. Only use this parameter for existing customers. Don't use it for new customers.", "enum": [ "abn_amro", "asn_bank", "bunq", "buut", "handelsbanken", "ing", "knab", "moneyou", "n26", "nn", "rabobank", "regiobank", "revolut", "sns_bank", "triodos_bank", "van_lanschot", "yoursafe" ], "maxLength": 5000, "type": "string" } }, "title": "param", "type": "object", "x-stripeMostCommon": [ "bank" ] }, "interac_present": { "description": "If this is an `interac_present` PaymentMethod, this hash contains details about the Interac Present payment method.", "properties": {}, "title": "param", "type": "object", "x-stripeMostCommon": [ "device_identifier", "device_type", "emv", "location" ] }, "kakao_pay": { "description": "If this is a `kakao_pay` PaymentMethod, this hash contains details about the Kakao Pay payment method.", "properties": {}, "title": "param", "type": "object" }, "klarna": { "description": "If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method.", "properties": { "dob": { "description": "Customer's date of birth", "properties": { "day": { "description": "The day of birth, between 1 and 31.", "type": "integer" }, "month": { "description": "The month of birth, between 1 and 12.", "type": "integer" }, "year": { "description": "The four-digit year of birth.", "type": "integer" } }, "required": [ "day", "month", "year" ], "title": "date_of_birth", "type": "object", "x-stripeMostCommon": [ "day", "month", "year" ] } }, "title": "param", "type": "object", "x-stripeMostCommon": [ "dob" ] }, "konbini": { "description": "If this is a `konbini` PaymentMethod, this hash contains details about the Konbini payment method.", "properties": {}, "title": "param", "type": "object" }, "kr_card": { "description": "If this is a `kr_card` PaymentMethod, this hash contains details about the Korean Card payment method.", "properties": {}, "title": "param", "type": "object" }, "link": { "description": "If this is an `Link` PaymentMethod, this hash contains details about the Link payment method.", "properties": {}, "title": "param", "type": "object" }, "mb_way": { "description": "If this is a MB WAY PaymentMethod, this hash contains details about the MB WAY payment method.", "properties": {}, "title": "param", "type": "object" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "mobilepay": { "description": "If this is a `mobilepay` PaymentMethod, this hash contains details about the MobilePay payment method.", "properties": {}, "title": "param", "type": "object" }, "multibanco": { "description": "If this is a `multibanco` PaymentMethod, this hash contains details about the Multibanco payment method.", "properties": {}, "title": "param", "type": "object" }, "naver_pay": { "description": "If this is a `naver_pay` PaymentMethod, this hash contains details about the Naver Pay payment method.", "properties": { "funding": { "description": "Whether to use Naver Pay points or a card to fund this transaction. If not provided, this defaults to `card`.", "enum": [ "card", "points" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "param", "type": "object", "x-stripeMostCommon": [ "funding" ] }, "nz_bank_account": { "description": "If this is an nz_bank_account PaymentMethod, this hash contains details about the nz_bank_account payment method.", "properties": { "account_holder_name": { "description": "The name on the bank account. Only required if the account holder name is different from the name of the authorized signatory collected in the PaymentMethod’s billing details.", "maxLength": 5000, "type": "string" }, "account_number": { "description": "The account number for the bank account.", "maxLength": 5000, "type": "string" }, "bank_code": { "description": "The numeric code for the bank account's bank.", "maxLength": 5000, "type": "string" }, "branch_code": { "description": "The numeric code for the bank account's bank branch.", "maxLength": 5000, "type": "string" }, "reference": { "maxLength": 128, "type": "string" }, "suffix": { "description": "The suffix of the bank account number.", "maxLength": 5000, "type": "string" } }, "required": [ "account_number", "bank_code", "branch_code", "suffix" ], "title": "param", "type": "object", "x-stripeMostCommon": [ "account_holder_name", "account_number", "bank_code", "branch_code", "reference", "suffix" ] }, "oxxo": { "description": "If this is an `oxxo` PaymentMethod, this hash contains details about the OXXO payment method.", "properties": {}, "title": "param", "type": "object" }, "p24": { "description": "If this is a `p24` PaymentMethod, this hash contains details about the P24 payment method.", "properties": { "bank": { "description": "The customer's bank.", "enum": [ "alior_bank", "bank_millennium", "bank_nowy_bfg_sa", "bank_pekao_sa", "banki_spbdzielcze", "blik", "bnp_paribas", "boz", "citi_handlowy", "credit_agricole", "envelobank", "etransfer_pocztowy24", "getin_bank", "ideabank", "ing", "inteligo", "mbank_mtransfer", "nest_przelew", "noble_pay", "pbac_z_ipko", "plus_bank", "santander_przelew24", "tmobile_usbugi_bankowe", "toyota_bank", "velobank", "volkswagen_bank" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "param", "type": "object", "x-stripeMostCommon": [ "bank" ] }, "pay_by_bank": { "description": "If this is a `pay_by_bank` PaymentMethod, this hash contains details about the PayByBank payment method.", "properties": {}, "title": "param", "type": "object" }, "payco": { "description": "If this is a `payco` PaymentMethod, this hash contains details about the PAYCO payment method.", "properties": {}, "title": "param", "type": "object" }, "paynow": { "description": "If this is a `paynow` PaymentMethod, this hash contains details about the PayNow payment method.", "properties": {}, "title": "param", "type": "object" }, "paypal": { "description": "If this is a `paypal` PaymentMethod, this hash contains details about the PayPal payment method.", "properties": {}, "title": "param", "type": "object" }, "paypay": { "description": "If this is a `paypay` PaymentMethod, this hash contains details about the PayPay payment method.", "properties": {}, "title": "param", "type": "object" }, "payto": { "description": "If this is a `payto` PaymentMethod, this hash contains details about the PayTo payment method.", "properties": { "account_number": { "description": "The account number for the bank account.", "maxLength": 5000, "type": "string" }, "bsb_number": { "description": "Bank-State-Branch number of the bank account.", "maxLength": 5000, "type": "string" }, "pay_id": { "description": "The PayID alias for the bank account.", "maxLength": 5000, "type": "string" } }, "title": "param", "type": "object", "x-stripeMostCommon": [ "account_number", "bsb_number", "pay_id" ] }, "pix": { "description": "If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.", "properties": {}, "title": "param", "type": "object", "x-stripeMostCommon": [ "tax_id" ] }, "promptpay": { "description": "If this is a `promptpay` PaymentMethod, this hash contains details about the PromptPay payment method.", "properties": {}, "title": "param", "type": "object" }, "qris": { "description": "If this is a `qris` PaymentMethod, this hash contains details about the QRIS payment method.", "properties": {}, "title": "param", "type": "object" }, "radar_options": { "description": "Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.", "properties": { "session": { "description": "A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.", "maxLength": 5000, "type": "string" } }, "title": "radar_options_with_hidden_options", "type": "object", "x-stripeMostCommon": [ "session", "skip_rules" ] }, "rechnung": { "description": "If this is a `rechnung` PaymentMethod, this hash contains details about the Rechnung payment method.", "properties": { "dob": { "description": "Customer's date of birth", "properties": { "day": { "description": "The day of birth, between 1 and 31.", "type": "integer" }, "month": { "description": "The month of birth, between 1 and 12.", "type": "integer" }, "year": { "description": "The four-digit year of birth.", "type": "integer" } }, "required": [ "day", "month", "year" ], "title": "date_of_birth", "type": "object", "x-stripeMostCommon": [ "day", "month", "year" ] } }, "required": [ "dob" ], "title": "param", "type": "object", "x-stripeMostCommon": [ "dob" ] }, "revolut_pay": { "description": "If this is a `revolut_pay` PaymentMethod, this hash contains details about the Revolut Pay payment method.", "properties": {}, "title": "param", "type": "object" }, "samsung_pay": { "description": "If this is a `samsung_pay` PaymentMethod, this hash contains details about the SamsungPay payment method.", "properties": {}, "title": "param", "type": "object" }, "satispay": { "description": "If this is a `satispay` PaymentMethod, this hash contains details about the Satispay payment method.", "properties": {}, "title": "param", "type": "object" }, "sepa_debit": { "description": "If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account.", "properties": { "iban": { "description": "IBAN of the bank account.", "maxLength": 5000, "type": "string" } }, "required": [ "iban" ], "title": "param", "type": "object", "x-stripeMostCommon": [ "iban" ] }, "shopeepay": { "description": "If this is a Shopeepay PaymentMethod, this hash contains details about the Shopeepay payment method.", "properties": {}, "title": "param", "type": "object" }, "sofort": { "description": "If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.", "properties": { "country": { "description": "Two-letter ISO code representing the country the bank account is located in.", "enum": [ "AT", "BE", "DE", "ES", "IT", "NL" ], "type": "string" } }, "required": [ "country" ], "title": "param", "type": "object", "x-stripeMostCommon": [ "country" ] }, "stripe_balance": { "description": "This hash contains details about the Stripe balance payment method.", "properties": { "account": { "description": "The connected account ID whose Stripe balance to use as the source of payment", "maxLength": 5000, "type": "string" }, "source_type": { "description": "The [source_type](https://docs.stripe.com/api/balance/balance_object#balance_object-available-source_types) of the balance", "enum": [ "bank_account", "card", "fpx" ], "type": "string" } }, "title": "param", "type": "object", "x-stripeMostCommon": [ "account", "source_type" ] }, "swish": { "description": "If this is a `swish` PaymentMethod, this hash contains details about the Swish payment method.", "properties": {}, "title": "param", "type": "object" }, "twint": { "description": "If this is a TWINT PaymentMethod, this hash contains details about the TWINT payment method.", "properties": {}, "title": "param", "type": "object" }, "type": { "description": "The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.", "enum": [ "acss_debit", "affirm", "afterpay_clearpay", "alipay", "alma", "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", "billie", "blik", "boleto", "cashapp", "crypto", "customer_balance", "eps", "fpx", "giropay", "gopay", "grabpay", "id_bank_transfer", "ideal", "kakao_pay", "klarna", "konbini", "kr_card", "link", "mb_way", "mobilepay", "multibanco", "naver_pay", "nz_bank_account", "oxxo", "p24", "pay_by_bank", "payco", "paynow", "paypal", "paypay", "payto", "pix", "promptpay", "qris", "rechnung", "revolut_pay", "samsung_pay", "satispay", "sepa_debit", "shopeepay", "sofort", "stripe_balance", "swish", "twint", "us_bank_account", "wechat_pay", "zip" ], "type": "string", "x-stripeBypassValidation": true }, "us_bank_account": { "description": "If this is an `us_bank_account` PaymentMethod, this hash contains details about the US bank account payment method.", "properties": { "account_holder_type": { "description": "Account holder type: individual or company.", "enum": [ "company", "individual" ], "type": "string" }, "account_number": { "description": "Account number of the bank account.", "maxLength": 5000, "type": "string" }, "account_type": { "description": "Account type: checkings or savings. Defaults to checking if omitted.", "enum": [ "checking", "savings" ], "type": "string" }, "financial_connections_account": { "description": "The ID of a Financial Connections Account to use as a payment method.", "maxLength": 5000, "type": "string" }, "routing_number": { "description": "Routing number of the bank account.", "maxLength": 5000, "type": "string" } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "account_holder_type", "account_number", "account_type", "financial_connections_account", "routing_number" ] }, "wechat_pay": { "description": "If this is an `wechat_pay` PaymentMethod, this hash contains details about the wechat_pay payment method.", "properties": {}, "title": "param", "type": "object" }, "zip": { "description": "If this is a `zip` PaymentMethod, this hash contains details about the Zip payment method.", "properties": {}, "title": "param", "type": "object" } }, "required": [ "type" ], "title": "payment_method_data_params", "type": "object", "x-stripeMostCommon": [ "billing_details", "metadata", "type" ] }, "payment_method_options": { "description": "Payment method-specific configuration for this SetupIntent.", "properties": { "acss_debit": { "description": "If this is a `acss_debit` SetupIntent, this sub-hash contains details about the ACSS Debit payment method options.", "properties": { "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "enum": [ "cad", "usd" ], "type": "string" }, "mandate_options": { "description": "Additional fields for Mandate creation", "properties": { "custom_mandate_url": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "A URL for custom mandate text to render during confirmation step.\nThe URL will be rendered with additional GET parameters `payment_intent` and `payment_intent_client_secret` when confirming a Payment Intent,\nor `setup_intent` and `setup_intent_client_secret` when confirming a Setup Intent." }, "default_for": { "description": "List of Stripe products where this mandate can be selected automatically.", "items": { "enum": [ "invoice", "subscription" ], "type": "string" }, "type": "array" }, "interval_description": { "description": "Description of the mandate interval. Only required if 'payment_schedule' parameter is 'interval' or 'combined'.", "maxLength": 500, "type": "string" }, "payment_schedule": { "description": "Payment schedule for the mandate.", "enum": [ "combined", "interval", "sporadic" ], "type": "string" }, "transaction_type": { "description": "Transaction type of the mandate.", "enum": [ "business", "personal" ], "type": "string" } }, "title": "setup_intent_payment_method_options_mandate_options_param", "type": "object", "x-stripeMostCommon": [ "custom_mandate_url", "default_for", "interval_description", "payment_schedule", "transaction_type" ] }, "verification_method": { "description": "Bank account verification method.", "enum": [ "automatic", "instant", "microdeposits" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "setup_intent_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "currency", "financial_connections", "mandate_options", "verification_method" ] }, "amazon_pay": { "description": "If this is a `amazon_pay` SetupIntent, this sub-hash contains details about the AmazonPay payment method options.", "properties": {}, "title": "setup_intent_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "charge_permission_id" ] }, "bacs_debit": { "description": "If this is a `bacs_debit` SetupIntent, this sub-hash contains details about the Bacs Debit payment method options.", "properties": { "mandate_options": { "description": "Additional fields for Mandate creation", "properties": { "reference_prefix": { "anyOf": [ { "maxLength": 12, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'." } }, "title": "payment_method_options_mandate_options_param", "type": "object", "x-stripeMostCommon": [ "reference_prefix" ] } }, "title": "setup_intent_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "mandate_options" ] }, "card": { "description": "Configuration for any card setup attempted on this SetupIntent.", "properties": { "mandate_options": { "description": "Configuration options for setting up an eMandate for cards issued in India.", "properties": { "amount": { "description": "Amount to be charged for future payments.", "type": "integer" }, "amount_type": { "description": "One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.", "enum": [ "fixed", "maximum" ], "type": "string" }, "currency": { "description": "Currency in which future payments will be charged. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "description": { "description": "A description of the mandate or subscription that is meant to be displayed to the customer.", "maxLength": 200, "type": "string" }, "end_date": { "description": "End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.", "format": "unix-time", "type": "integer" }, "interval": { "description": "Specifies payment frequency. One of `day`, `week`, `month`, `year`, or `sporadic`.", "enum": [ "day", "month", "sporadic", "week", "year" ], "type": "string" }, "interval_count": { "description": "The number of intervals between payments. For example, `interval=month` and `interval_count=3` indicates one payment every three months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). This parameter is optional when `interval=sporadic`.", "type": "integer" }, "reference": { "description": "Unique identifier for the mandate or subscription.", "maxLength": 80, "type": "string" }, "start_date": { "description": "Start date of the mandate or subscription. Start date should not be lesser than yesterday.", "format": "unix-time", "type": "integer" }, "supported_types": { "description": "Specifies the type of mandates supported. Possible values are `india`.", "items": { "enum": [ "india" ], "type": "string" }, "type": "array" } }, "required": [ "amount", "amount_type", "currency", "interval", "reference", "start_date" ], "title": "setup_intent_mandate_options_param", "type": "object", "x-stripeMostCommon": [ "amount", "amount_type", "currency", "description", "end_date", "interval", "interval_count", "reference", "start_date", "supported_types" ] }, "moto": { "description": "When specified, this parameter signals that a card has been collected\nas MOTO (Mail Order Telephone Order) and thus out of scope for SCA. This\nparameter can only be provided during confirmation.", "type": "boolean" }, "network": { "description": "Selected network to process this SetupIntent on. Depends on the available networks of the card attached to the SetupIntent. Can be only set confirm-time.", "enum": [ "amex", "cartes_bancaires", "diners", "discover", "eftpos_au", "girocard", "interac", "jcb", "link", "mastercard", "unionpay", "unknown", "visa" ], "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true }, "request_three_d_secure": { "description": "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.", "enum": [ "any", "automatic", "challenge" ], "type": "string", "x-stripeBypassValidation": true }, "three_d_secure": { "description": "If 3D Secure authentication was performed with a third-party provider,\nthe authentication details to use for this setup.", "properties": { "ares_trans_status": { "description": "The `transStatus` returned from the card Issuer’s ACS in the ARes.", "enum": [ "A", "C", "I", "N", "R", "U", "Y" ], "type": "string" }, "cryptogram": { "description": "The cryptogram, also known as the \"authentication value\" (AAV, CAVV or\nAEVV). This value is 20 bytes, base64-encoded into a 28-character string.\n(Most 3D Secure providers will return the base64-encoded version, which\nis what you should specify here.)", "maxLength": 5000, "type": "string" }, "electronic_commerce_indicator": { "description": "The Electronic Commerce Indicator (ECI) is returned by your 3D Secure\nprovider and indicates what degree of authentication was performed.", "enum": [ "01", "02", "05", "06", "07" ], "type": "string", "x-stripeBypassValidation": true }, "network_options": { "description": "Network specific 3DS fields. Network specific arguments require an\nexplicit card brand choice. The parameter `payment_method_options.card.network``\nmust be populated accordingly", "properties": { "cartes_bancaires": { "description": "Cartes Bancaires-specific 3DS fields.", "properties": { "cb_avalgo": { "description": "The cryptogram calculation algorithm used by the card Issuer's ACS\nto calculate the Authentication cryptogram. Also known as `cavvAlgorithm`.\nmessageExtension: CB-AVALGO", "enum": [ "0", "1", "2", "3", "4", "A" ], "type": "string" }, "cb_exemption": { "description": "The exemption indicator returned from Cartes Bancaires in the ARes.\nmessage extension: CB-EXEMPTION; string (4 characters)\nThis is a 3 byte bitmap (low significant byte first and most significant\nbit first) that has been Base64 encoded", "maxLength": 4, "type": "string" }, "cb_score": { "description": "The risk score returned from Cartes Bancaires in the ARes.\nmessage extension: CB-SCORE; numeric value 0-99", "type": "integer" } }, "required": [ "cb_avalgo" ], "title": "cartes_bancaires_network_options_param", "type": "object", "x-stripeMostCommon": [ "cb_avalgo", "cb_exemption", "cb_score" ] } }, "title": "network_options_param", "type": "object", "x-stripeMostCommon": [ "cartes_bancaires" ] }, "requestor_challenge_indicator": { "description": "The challenge indicator (`threeDSRequestorChallengeInd`) which was requested in the\nAReq sent to the card Issuer's ACS. A string containing 2 digits from 01-99.", "maxLength": 2, "type": "string" }, "transaction_id": { "description": "For 3D Secure 1, the XID. For 3D Secure 2, the Directory Server\nTransaction ID (dsTransID).", "maxLength": 5000, "type": "string" }, "version": { "description": "The version of 3D Secure that was performed.", "enum": [ "1.0.2", "2.1.0", "2.2.0" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "setup_intent_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "ares_trans_status", "cryptogram", "electronic_commerce_indicator", "exemption_preferred", "gateway", "network_options", "requestor_challenge_indicator", "transaction_id", "version" ] } }, "title": "setup_intent_param", "type": "object", "x-stripeMostCommon": [ "commerce_type", "mandate_options", "moto", "network", "network_token", "request_name_verification", "request_three_d_secure", "three_d_secure", "verify_card_account" ] }, "card_present": { "description": "If this is a `card_present` PaymentMethod, this sub-hash contains details about the card-present payment method options.", "properties": {}, "title": "setup_intent_payment_method_options_param", "type": "object" }, "klarna": { "description": "If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method options.", "properties": { "currency": { "description": "The currency of the SetupIntent. Three letter ISO currency code.", "format": "currency", "type": "string" }, "on_demand": { "description": "On-demand details if setting up a payment method for on-demand payments.", "properties": { "average_amount": { "description": "Your average amount value. You can use a value across your customer base, or segment based on customer type, country, etc.", "type": "integer" }, "maximum_amount": { "description": "The maximum value you may charge a customer per purchase. You can use a value across your customer base, or segment based on customer type, country, etc.", "type": "integer" }, "minimum_amount": { "description": "The lowest or minimum value you may charge a customer per purchase. You can use a value across your customer base, or segment based on customer type, country, etc.", "type": "integer" }, "purchase_interval": { "description": "Interval at which the customer is making purchases", "enum": [ "day", "month", "week", "year" ], "type": "string" }, "purchase_interval_count": { "description": "The number of `purchase_interval` between charges", "type": "integer" } }, "title": "on_demand_param", "type": "object", "x-stripeMostCommon": [ "average_amount", "maximum_amount", "minimum_amount", "purchase_interval", "purchase_interval_count" ] }, "preferred_locale": { "description": "Preferred language of the Klarna authorization page that the customer is redirected to", "enum": [ "cs-CZ", "da-DK", "de-AT", "de-CH", "de-DE", "el-GR", "en-AT", "en-AU", "en-BE", "en-CA", "en-CH", "en-CZ", "en-DE", "en-DK", "en-ES", "en-FI", "en-FR", "en-GB", "en-GR", "en-IE", "en-IT", "en-NL", "en-NO", "en-NZ", "en-PL", "en-PT", "en-RO", "en-SE", "en-US", "es-ES", "es-US", "fi-FI", "fr-BE", "fr-CA", "fr-CH", "fr-FR", "it-CH", "it-IT", "nb-NO", "nl-BE", "nl-NL", "pl-PL", "pt-PT", "ro-RO", "sv-FI", "sv-SE" ], "type": "string", "x-stripeBypassValidation": true }, "subscriptions": { "anyOf": [ { "items": { "properties": { "interval": { "description": "Unit of time between subscription charges.", "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "description": "The number of intervals (specified in the `interval` attribute) between subscription charges. For example, `interval=month` and `interval_count=3` charges every 3 months.", "type": "integer" }, "name": { "description": "Name for subscription.", "maxLength": 255, "type": "string" }, "next_billing": { "description": "Describes the upcoming charge for this subscription.", "properties": { "amount": { "description": "The amount of the next charge for the subscription.", "type": "integer" }, "date": { "description": "The date of the next charge for the subscription in YYYY-MM-DD format.", "maxLength": 5000, "type": "string" } }, "required": [ "amount", "date" ], "title": "subscription_next_billing_param", "type": "object", "x-stripeMostCommon": [ "amount", "date" ] }, "reference": { "description": "A non-customer-facing reference to correlate subscription charges in the Klarna app. Use a value that persists across subscription charges.", "maxLength": 255, "type": "string" } }, "required": [ "interval", "next_billing", "reference" ], "title": "setup_intent_subscription_param", "type": "object", "x-stripeMostCommon": [ "interval", "interval_count", "name", "next_billing", "reference" ] }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "Subscription details if setting up or charging a subscription" } }, "title": "setup_intent_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "currency", "interoperability_token", "on_demand", "payment_option_id", "preferred_locale", "subscriptions" ] }, "link": { "description": "If this is a `link` PaymentMethod, this sub-hash contains details about the Link payment method options.", "properties": { "persistent_token": { "description": "[Deprecated] This is a legacy parameter that no longer has any function.", "maxLength": 5000, "type": "string" } }, "title": "setup_intent_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "persistent_token" ] }, "paypal": { "description": "If this is a `paypal` PaymentMethod, this sub-hash contains details about the PayPal payment method options.", "properties": { "billing_agreement_id": { "description": "The PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer.", "maxLength": 5000, "type": "string" }, "currency": { "format": "currency", "type": "string" }, "subsellers": { "description": "The Stripe connected account IDs of the sellers on the platform for this transaction (optional). Only allowed when [separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers) are used.", "items": { "maxLength": 32, "type": "string" }, "type": "array" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "billing_agreement_id", "currency", "subsellers" ] }, "payto": { "description": "If this is a `payto` SetupIntent, this sub-hash contains details about the PayTo payment method options.", "properties": { "mandate_options": { "description": "Additional fields for Mandate creation.", "properties": { "amount": { "description": "Amount that will be collected. It is required when `amount_type` is `fixed`.", "type": "integer" }, "amount_type": { "description": "The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively.", "enum": [ "fixed", "maximum" ], "type": "string" }, "end_date": { "description": "Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.", "maxLength": 5000, "type": "string" }, "payment_schedule": { "description": "The periodicity at which payments will be collected.", "enum": [ "adhoc", "annual", "daily", "fortnightly", "monthly", "quarterly", "semi_annual", "weekly" ], "type": "string" }, "payments_per_period": { "description": "The number of payments that will be made during a payment period. Defaults to 1 except for when `payment_schedule` is `adhoc`. In that case, it defaults to no limit.", "type": "integer" }, "purpose": { "description": "The purpose for which payments are made. Defaults to retail.", "enum": [ "dependant_support", "government", "loan", "mortgage", "other", "pension", "personal", "retail", "salary", "tax", "utility" ], "type": "string" }, "start_date": { "description": "Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time.", "maxLength": 5000, "type": "string" } }, "title": "setup_intent_payment_method_options_mandate_options_param", "type": "object", "x-stripeMostCommon": [ "amount", "amount_type", "end_date", "payment_schedule", "payments_per_period", "purpose", "start_date" ] } }, "title": "setup_intent_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "mandate_options" ] }, "pix": { "description": "If this is a `pix` SetupIntent, this sub-hash contains details about the Pix payment method options.", "properties": { "mandate_options": { "description": "Additional fields for mandate creation.", "properties": { "amount": { "description": "Amount to be charged for future payments. Required when `amount_type=fixed`. If not provided for `amount_type=maximum`, defaults to 40000.", "type": "integer" }, "amount_includes_iof": { "description": "Determines if the amount includes the IOF tax. Defaults to `never`.", "enum": [ "always", "never" ], "type": "string" }, "amount_type": { "description": "Type of amount. Defaults to `maximum`.", "enum": [ "fixed", "maximum" ], "type": "string" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Only `brl` is supported currently.", "format": "currency", "type": "string" }, "end_date": { "description": "Date when the mandate expires and no further payments will be charged, in `YYYY-MM-DD`. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.", "maxLength": 5000, "type": "string" }, "payment_schedule": { "description": "Schedule at which the future payments will be charged. Defaults to `weekly`.", "enum": [ "halfyearly", "monthly", "quarterly", "weekly", "yearly" ], "type": "string" }, "reference": { "description": "Subscription name displayed to buyers in their bank app. Defaults to the displayable business name.", "maxLength": 35, "type": "string" }, "start_date": { "description": "Start date of the mandate, in `YYYY-MM-DD`. Start date should be at least 3 days in the future. Defaults to 3 days after the current date.", "maxLength": 5000, "type": "string" } }, "title": "payment_method_options_mandate_options_param", "type": "object", "x-stripeMostCommon": [ "amount", "amount_includes_iof", "amount_type", "currency", "end_date", "payment_schedule", "reference", "start_date" ] } }, "title": "setup_intent_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "mandate_options" ] }, "sepa_debit": { "description": "If this is a `sepa_debit` SetupIntent, this sub-hash contains details about the SEPA Debit payment method options.", "properties": { "mandate_options": { "description": "Additional fields for Mandate creation", "properties": { "reference_prefix": { "anyOf": [ { "maxLength": 12, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'." } }, "title": "payment_method_options_mandate_options_param", "type": "object", "x-stripeMostCommon": [ "reference", "reference_prefix" ] } }, "title": "setup_intent_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "mandate_options", "verification_method" ] }, "us_bank_account": { "description": "If this is a `us_bank_account` SetupIntent, this sub-hash contains details about the US bank account payment method options.", "properties": { "financial_connections": { "description": "Additional fields for Financial Connections Session creation", "properties": { "filters": { "description": "Provide filters for the linked accounts that the customer can select for the payment method.", "properties": { "account_subcategories": { "description": "The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.", "items": { "enum": [ "checking", "savings" ], "maxLength": 5000, "type": "string" }, "type": "array" }, "institution": { "description": "ID of the institution to use to filter for selectable accounts.", "maxLength": 5000, "type": "string" } }, "title": "linked_account_options_filters_param", "type": "object", "x-stripeMostCommon": [ "account_subcategories", "institution" ] }, "manual_entry": { "description": "Customize manual entry behavior", "properties": { "mode": { "description": "Settings for configuring manual entry of account details.", "enum": [ "automatic", "custom" ], "type": "string" } }, "required": [ "mode" ], "title": "linked_account_options_manual_entry_param", "type": "object", "x-stripeMostCommon": [ "mode" ] }, "permissions": { "description": "The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.", "items": { "enum": [ "balances", "ownership", "payment_method", "transactions" ], "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true }, "type": "array" }, "prefetch": { "description": "List of data features that you would like to retrieve upon account creation.", "items": { "enum": [ "balances", "inferred_balances", "ownership", "transactions" ], "type": "string", "x-stripeBypassValidation": true }, "type": "array" }, "return_url": { "description": "For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.", "maxLength": 5000, "type": "string" } }, "title": "linked_account_options_param", "type": "object", "x-stripeMostCommon": [ "filters", "manual_entry", "permissions", "prefetch", "return_url" ] }, "mandate_options": { "description": "Additional fields for Mandate creation", "properties": { "collection_method": { "description": "The method used to collect offline mandate customer acceptance.", "enum": [ "", "paper" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "mandate_options_param", "type": "object", "x-stripeMostCommon": [ "collection_method" ] }, "networks": { "description": "Additional fields for network related functions", "properties": { "requested": { "description": "Triggers validations to run across the selected networks", "items": { "enum": [ "ach", "us_domestic_wire" ], "type": "string" }, "type": "array" } }, "title": "networks_options_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "verification_method": { "description": "Bank account verification method.", "enum": [ "automatic", "instant", "microdeposits" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "setup_intent_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "financial_connections", "mandate_options", "networks", "verification_method" ] } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "acss_debit", "alipay", "amazon_pay", "bacs_debit", "blik", "card", "card_present", "demo_pay", "dummy_auth_push", "klarna", "link", "paypal", "payto", "pix", "sepa_debit", "upi", "us_bank_account", "wechat_pay" ] }, "payment_method_types": { "description": "The list of payment method types (for example, card) that this SetupIntent can set up. If you don't provide this, Stripe will dynamically show relevant payment methods from your [payment method settings](https://dashboard.stripe.com/settings/payment_methods). A list of valid payment method types can be found [here](https://docs.stripe.com/api/payment_methods/object#payment_method_object-type).", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object", "x-stripeMostCommon": [ "customer", "description", "metadata", "payment_method" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setup_intent" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a SetupIntent" } }, "/v1/setup_intents/{intent}/cancel": { "post": { "description": "

You can cancel a SetupIntent object when it’s in one of these statuses: requires_payment_method, requires_confirmation, or requires_action.

\n\n

After you cancel it, setup is abandoned and any operations on the SetupIntent fail with an error. You can’t cancel the SetupIntent for a Checkout Session. Expire the Checkout Session instead.

", "operationId": "PostSetupIntentsIntentCancel", "parameters": [ { "in": "path", "name": "intent", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "cancellation_reason": { "description": "Reason for canceling this SetupIntent. Possible values are: `abandoned`, `requested_by_customer`, or `duplicate`", "enum": [ "abandoned", "duplicate", "requested_by_customer" ], "maxLength": 5000, "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object", "x-stripeMostCommon": [ "cancellation_reason" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setup_intent" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Cancel a SetupIntent" } }, "/v1/setup_intents/{intent}/confirm": { "post": { "description": "

Confirm that your customer intends to set up the current or\nprovided payment method. For example, you would confirm a SetupIntent\nwhen a customer hits the “Save” button on a payment method management\npage on your website.

\n\n

If the selected payment method does not require any additional\nsteps from the customer, the SetupIntent will transition to the\nsucceeded status.

\n\n

Otherwise, it will transition to the requires_action status and\nsuggest additional actions via next_action. If setup fails,\nthe SetupIntent will transition to the\nrequires_payment_method status or the canceled status if the\nconfirmation limit is reached.

", "operationId": "PostSetupIntentsIntentConfirm", "parameters": [ { "in": "path", "name": "intent", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "mandate_data": { "explode": true, "style": "deepObject" }, "payment_method_data": { "explode": true, "style": "deepObject" }, "payment_method_options": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "confirmation_token": { "description": "ID of the ConfirmationToken used to confirm this SetupIntent.\n\nIf the provided ConfirmationToken contains properties that are also being provided in this request, such as `payment_method`, then the values in this request will take precedence.", "maxLength": 5000, "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "mandate_data": { "anyOf": [ { "properties": { "customer_acceptance": { "description": "This hash contains details about the customer acceptance of the Mandate.", "properties": { "accepted_at": { "description": "The time at which the customer accepted the Mandate.", "format": "unix-time", "type": "integer" }, "offline": { "description": "If this is a Mandate accepted offline, this hash contains details about the offline acceptance.", "properties": {}, "title": "offline_param", "type": "object" }, "online": { "description": "If this is a Mandate accepted online, this hash contains details about the online acceptance.", "properties": { "ip_address": { "description": "The IP address from which the Mandate was accepted by the customer.", "type": "string" }, "user_agent": { "description": "The user agent of the browser from which the Mandate was accepted by the customer.", "maxLength": 5000, "type": "string" } }, "required": [ "ip_address", "user_agent" ], "title": "online_param", "type": "object", "x-stripeMostCommon": [ "ip_address", "user_agent" ] }, "type": { "description": "The type of customer acceptance information included with the Mandate. One of `online` or `offline`.", "enum": [ "offline", "online" ], "maxLength": 5000, "type": "string" } }, "required": [ "type" ], "title": "customer_acceptance_param", "type": "object", "x-stripeMostCommon": [ "accepted_at", "offline", "online", "type" ] } }, "required": [ "customer_acceptance" ], "title": "secret_key_param", "type": "object", "x-stripeMostCommon": [ "customer_acceptance" ] }, { "enum": [ "" ], "type": "string" }, { "description": "This hash contains details about the Mandate to create", "properties": { "customer_acceptance": { "description": "This hash contains details about the customer acceptance of the Mandate.", "properties": { "online": { "description": "If this is a Mandate accepted online, this hash contains details about the online acceptance.", "properties": { "ip_address": { "description": "The IP address from which the Mandate was accepted by the customer.", "type": "string" }, "user_agent": { "description": "The user agent of the browser from which the Mandate was accepted by the customer.", "maxLength": 5000, "type": "string" } }, "title": "online_param", "type": "object", "x-stripeMostCommon": [ "ip_address", "user_agent" ] }, "type": { "description": "The type of customer acceptance information included with the Mandate.", "enum": [ "online" ], "maxLength": 5000, "type": "string" } }, "required": [ "online", "type" ], "title": "customer_acceptance_param", "type": "object", "x-stripeMostCommon": [ "online", "type" ] } }, "required": [ "customer_acceptance" ], "title": "client_key_param", "type": "object", "x-stripeMostCommon": [ "customer_acceptance" ], "x-stripeParam": { "class_name": "MandateDataPublishableKey" } } ] }, "payment_method": { "description": "ID of the payment method (a PaymentMethod, Card, or saved Source object) to attach to this SetupIntent.", "maxLength": 5000, "type": "string" }, "payment_method_data": { "description": "When included, this hash creates a PaymentMethod that is set as the [`payment_method`](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-payment_method)\nvalue in the SetupIntent.", "properties": { "acss_debit": { "description": "If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method.", "properties": { "account_number": { "description": "Customer's bank account number.", "maxLength": 5000, "type": "string" }, "institution_number": { "description": "Institution number of the customer's bank.", "maxLength": 5000, "type": "string" }, "transit_number": { "description": "Transit number of the customer's bank.", "maxLength": 5000, "type": "string" } }, "required": [ "account_number", "institution_number", "transit_number" ], "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "account_number", "financial_connections_account", "institution_number", "transit_number" ] }, "affirm": { "description": "If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method.", "properties": {}, "title": "param", "type": "object" }, "afterpay_clearpay": { "description": "If this is an `AfterpayClearpay` PaymentMethod, this hash contains details about the AfterpayClearpay payment method.", "properties": {}, "title": "param", "type": "object" }, "alipay": { "description": "If this is an `Alipay` PaymentMethod, this hash contains details about the Alipay payment method.", "properties": {}, "title": "param", "type": "object" }, "allow_redisplay": { "description": "This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to `unspecified`.", "enum": [ "always", "limited", "unspecified" ], "type": "string" }, "alma": { "description": "If this is a Alma PaymentMethod, this hash contains details about the Alma payment method.", "properties": {}, "title": "param", "type": "object" }, "amazon_pay": { "description": "If this is a AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method.", "properties": {}, "title": "param", "type": "object" }, "au_becs_debit": { "description": "If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account.", "properties": { "account_number": { "description": "The account number for the bank account.", "maxLength": 5000, "type": "string" }, "bsb_number": { "description": "Bank-State-Branch number of the bank account.", "maxLength": 5000, "type": "string" } }, "required": [ "account_number", "bsb_number" ], "title": "param", "type": "object", "x-stripeMostCommon": [ "account_number", "bsb_number" ] }, "bacs_debit": { "description": "If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.", "properties": { "account_number": { "description": "Account number of the bank account that the funds will be debited from.", "maxLength": 5000, "type": "string" }, "sort_code": { "description": "Sort code of the bank account. (e.g., `10-20-30`)", "maxLength": 5000, "type": "string" } }, "title": "param", "type": "object", "x-stripeMostCommon": [ "account_number", "sort_code" ] }, "bancontact": { "description": "If this is a `bancontact` PaymentMethod, this hash contains details about the Bancontact payment method.", "properties": {}, "title": "param", "type": "object" }, "billie": { "description": "If this is a `billie` PaymentMethod, this hash contains details about the Billie payment method.", "properties": {}, "title": "param", "type": "object" }, "billing_details": { "description": "Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.", "properties": { "address": { "anyOf": [ { "properties": { "city": { "description": "City, district, suburb, town, or village.", "maxLength": 5000, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Address line 1 (e.g., street, PO Box, or company name).", "maxLength": 5000, "type": "string" }, "line2": { "description": "Address line 2 (e.g., apartment, suite, unit, or building).", "maxLength": 5000, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "State, county, province, or region.", "maxLength": 5000, "type": "string" } }, "title": "billing_details_address", "type": "object", "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Billing address." }, "email": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Email address." }, "name": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Full name." }, "phone": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Billing phone number (including extension)." }, "tax_id": { "description": "Taxpayer identification number. Used only for transactions between LATAM buyers and non-LATAM sellers.", "maxLength": 5000, "type": "string" } }, "title": "billing_details_inner_params", "type": "object", "x-stripeMostCommon": [ "address", "email", "name", "phone", "tax_id" ] }, "blik": { "description": "If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.", "properties": {}, "title": "param", "type": "object" }, "boleto": { "description": "If this is a `boleto` PaymentMethod, this hash contains details about the Boleto payment method.", "properties": { "tax_id": { "description": "The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers)", "maxLength": 5000, "type": "string" } }, "required": [ "tax_id" ], "title": "param", "type": "object", "x-stripeMostCommon": [ "tax_id" ] }, "cashapp": { "description": "If this is a `cashapp` PaymentMethod, this hash contains details about the Cash App Pay payment method.", "properties": {}, "title": "param", "type": "object" }, "crypto": { "description": "If this is a Crypto PaymentMethod, this hash contains details about the Crypto payment method.", "properties": {}, "title": "param", "type": "object" }, "customer_balance": { "description": "If this is a `customer_balance` PaymentMethod, this hash contains details about the CustomerBalance payment method.", "properties": {}, "title": "param", "type": "object" }, "eps": { "description": "If this is an `eps` PaymentMethod, this hash contains details about the EPS payment method.", "properties": { "bank": { "description": "The customer's bank.", "enum": [ "arzte_und_apotheker_bank", "austrian_anadi_bank_ag", "bank_austria", "bankhaus_carl_spangler", "bankhaus_schelhammer_und_schattera_ag", "bawag_psk_ag", "bks_bank_ag", "brull_kallmus_bank_ag", "btv_vier_lander_bank", "capital_bank_grawe_gruppe_ag", "deutsche_bank_ag", "dolomitenbank", "easybank_ag", "erste_bank_und_sparkassen", "hypo_alpeadriabank_international_ag", "hypo_bank_burgenland_aktiengesellschaft", "hypo_noe_lb_fur_niederosterreich_u_wien", "hypo_oberosterreich_salzburg_steiermark", "hypo_tirol_bank_ag", "hypo_vorarlberg_bank_ag", "marchfelder_bank", "oberbank_ag", "raiffeisen_bankengruppe_osterreich", "schoellerbank_ag", "sparda_bank_wien", "volksbank_gruppe", "volkskreditbank_ag", "vr_bank_braunau" ], "maxLength": 5000, "type": "string" } }, "title": "param", "type": "object", "x-stripeMostCommon": [ "bank" ] }, "fpx": { "description": "If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method.", "properties": { "account_holder_type": { "description": "Account holder type for FPX transaction", "enum": [ "company", "individual" ], "maxLength": 5000, "type": "string" }, "bank": { "description": "The customer's bank.", "enum": [ "affin_bank", "agrobank", "alliance_bank", "ambank", "bank_islam", "bank_muamalat", "bank_of_china", "bank_rakyat", "bsn", "cimb", "deutsche_bank", "hong_leong_bank", "hsbc", "kfh", "maybank2e", "maybank2u", "ocbc", "pb_enterprise", "public_bank", "rhb", "standard_chartered", "uob" ], "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true } }, "required": [ "bank" ], "title": "param", "type": "object", "x-stripeMostCommon": [ "account_holder_type", "bank" ] }, "giropay": { "description": "If this is a `giropay` PaymentMethod, this hash contains details about the Giropay payment method.", "properties": {}, "title": "param", "type": "object" }, "gopay": { "description": "If this is a Gopay PaymentMethod, this hash contains details about the Gopay payment method.", "properties": {}, "title": "param", "type": "object" }, "grabpay": { "description": "If this is a `grabpay` PaymentMethod, this hash contains details about the GrabPay payment method.", "properties": {}, "title": "param", "type": "object" }, "id_bank_transfer": { "description": "If this is an `IdBankTransfer` PaymentMethod, this hash contains details about the IdBankTransfer payment method.", "properties": { "bank": { "description": "Bank where the account is held.", "enum": [ "bca", "bni", "bri", "cimb", "permata" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "param", "type": "object", "x-stripeMostCommon": [ "bank" ] }, "ideal": { "description": "If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method.", "properties": { "bank": { "description": "The customer's bank. Only use this parameter for existing customers. Don't use it for new customers.", "enum": [ "abn_amro", "asn_bank", "bunq", "buut", "handelsbanken", "ing", "knab", "moneyou", "n26", "nn", "rabobank", "regiobank", "revolut", "sns_bank", "triodos_bank", "van_lanschot", "yoursafe" ], "maxLength": 5000, "type": "string" } }, "title": "param", "type": "object", "x-stripeMostCommon": [ "bank" ] }, "interac_present": { "description": "If this is an `interac_present` PaymentMethod, this hash contains details about the Interac Present payment method.", "properties": {}, "title": "param", "type": "object", "x-stripeMostCommon": [ "device_identifier", "device_type", "emv", "location" ] }, "kakao_pay": { "description": "If this is a `kakao_pay` PaymentMethod, this hash contains details about the Kakao Pay payment method.", "properties": {}, "title": "param", "type": "object" }, "klarna": { "description": "If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method.", "properties": { "dob": { "description": "Customer's date of birth", "properties": { "day": { "description": "The day of birth, between 1 and 31.", "type": "integer" }, "month": { "description": "The month of birth, between 1 and 12.", "type": "integer" }, "year": { "description": "The four-digit year of birth.", "type": "integer" } }, "required": [ "day", "month", "year" ], "title": "date_of_birth", "type": "object", "x-stripeMostCommon": [ "day", "month", "year" ] } }, "title": "param", "type": "object", "x-stripeMostCommon": [ "dob" ] }, "konbini": { "description": "If this is a `konbini` PaymentMethod, this hash contains details about the Konbini payment method.", "properties": {}, "title": "param", "type": "object" }, "kr_card": { "description": "If this is a `kr_card` PaymentMethod, this hash contains details about the Korean Card payment method.", "properties": {}, "title": "param", "type": "object" }, "link": { "description": "If this is an `Link` PaymentMethod, this hash contains details about the Link payment method.", "properties": {}, "title": "param", "type": "object" }, "mb_way": { "description": "If this is a MB WAY PaymentMethod, this hash contains details about the MB WAY payment method.", "properties": {}, "title": "param", "type": "object" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "mobilepay": { "description": "If this is a `mobilepay` PaymentMethod, this hash contains details about the MobilePay payment method.", "properties": {}, "title": "param", "type": "object" }, "multibanco": { "description": "If this is a `multibanco` PaymentMethod, this hash contains details about the Multibanco payment method.", "properties": {}, "title": "param", "type": "object" }, "naver_pay": { "description": "If this is a `naver_pay` PaymentMethod, this hash contains details about the Naver Pay payment method.", "properties": { "funding": { "description": "Whether to use Naver Pay points or a card to fund this transaction. If not provided, this defaults to `card`.", "enum": [ "card", "points" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "param", "type": "object", "x-stripeMostCommon": [ "funding" ] }, "nz_bank_account": { "description": "If this is an nz_bank_account PaymentMethod, this hash contains details about the nz_bank_account payment method.", "properties": { "account_holder_name": { "description": "The name on the bank account. Only required if the account holder name is different from the name of the authorized signatory collected in the PaymentMethod’s billing details.", "maxLength": 5000, "type": "string" }, "account_number": { "description": "The account number for the bank account.", "maxLength": 5000, "type": "string" }, "bank_code": { "description": "The numeric code for the bank account's bank.", "maxLength": 5000, "type": "string" }, "branch_code": { "description": "The numeric code for the bank account's bank branch.", "maxLength": 5000, "type": "string" }, "reference": { "maxLength": 128, "type": "string" }, "suffix": { "description": "The suffix of the bank account number.", "maxLength": 5000, "type": "string" } }, "required": [ "account_number", "bank_code", "branch_code", "suffix" ], "title": "param", "type": "object", "x-stripeMostCommon": [ "account_holder_name", "account_number", "bank_code", "branch_code", "reference", "suffix" ] }, "oxxo": { "description": "If this is an `oxxo` PaymentMethod, this hash contains details about the OXXO payment method.", "properties": {}, "title": "param", "type": "object" }, "p24": { "description": "If this is a `p24` PaymentMethod, this hash contains details about the P24 payment method.", "properties": { "bank": { "description": "The customer's bank.", "enum": [ "alior_bank", "bank_millennium", "bank_nowy_bfg_sa", "bank_pekao_sa", "banki_spbdzielcze", "blik", "bnp_paribas", "boz", "citi_handlowy", "credit_agricole", "envelobank", "etransfer_pocztowy24", "getin_bank", "ideabank", "ing", "inteligo", "mbank_mtransfer", "nest_przelew", "noble_pay", "pbac_z_ipko", "plus_bank", "santander_przelew24", "tmobile_usbugi_bankowe", "toyota_bank", "velobank", "volkswagen_bank" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "param", "type": "object", "x-stripeMostCommon": [ "bank" ] }, "pay_by_bank": { "description": "If this is a `pay_by_bank` PaymentMethod, this hash contains details about the PayByBank payment method.", "properties": {}, "title": "param", "type": "object" }, "payco": { "description": "If this is a `payco` PaymentMethod, this hash contains details about the PAYCO payment method.", "properties": {}, "title": "param", "type": "object" }, "paynow": { "description": "If this is a `paynow` PaymentMethod, this hash contains details about the PayNow payment method.", "properties": {}, "title": "param", "type": "object" }, "paypal": { "description": "If this is a `paypal` PaymentMethod, this hash contains details about the PayPal payment method.", "properties": {}, "title": "param", "type": "object" }, "paypay": { "description": "If this is a `paypay` PaymentMethod, this hash contains details about the PayPay payment method.", "properties": {}, "title": "param", "type": "object" }, "payto": { "description": "If this is a `payto` PaymentMethod, this hash contains details about the PayTo payment method.", "properties": { "account_number": { "description": "The account number for the bank account.", "maxLength": 5000, "type": "string" }, "bsb_number": { "description": "Bank-State-Branch number of the bank account.", "maxLength": 5000, "type": "string" }, "pay_id": { "description": "The PayID alias for the bank account.", "maxLength": 5000, "type": "string" } }, "title": "param", "type": "object", "x-stripeMostCommon": [ "account_number", "bsb_number", "pay_id" ] }, "pix": { "description": "If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.", "properties": {}, "title": "param", "type": "object", "x-stripeMostCommon": [ "tax_id" ] }, "promptpay": { "description": "If this is a `promptpay` PaymentMethod, this hash contains details about the PromptPay payment method.", "properties": {}, "title": "param", "type": "object" }, "qris": { "description": "If this is a `qris` PaymentMethod, this hash contains details about the QRIS payment method.", "properties": {}, "title": "param", "type": "object" }, "radar_options": { "description": "Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.", "properties": { "session": { "description": "A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.", "maxLength": 5000, "type": "string" } }, "title": "radar_options_with_hidden_options", "type": "object", "x-stripeMostCommon": [ "session", "skip_rules" ] }, "rechnung": { "description": "If this is a `rechnung` PaymentMethod, this hash contains details about the Rechnung payment method.", "properties": { "dob": { "description": "Customer's date of birth", "properties": { "day": { "description": "The day of birth, between 1 and 31.", "type": "integer" }, "month": { "description": "The month of birth, between 1 and 12.", "type": "integer" }, "year": { "description": "The four-digit year of birth.", "type": "integer" } }, "required": [ "day", "month", "year" ], "title": "date_of_birth", "type": "object", "x-stripeMostCommon": [ "day", "month", "year" ] } }, "required": [ "dob" ], "title": "param", "type": "object", "x-stripeMostCommon": [ "dob" ] }, "revolut_pay": { "description": "If this is a `revolut_pay` PaymentMethod, this hash contains details about the Revolut Pay payment method.", "properties": {}, "title": "param", "type": "object" }, "samsung_pay": { "description": "If this is a `samsung_pay` PaymentMethod, this hash contains details about the SamsungPay payment method.", "properties": {}, "title": "param", "type": "object" }, "satispay": { "description": "If this is a `satispay` PaymentMethod, this hash contains details about the Satispay payment method.", "properties": {}, "title": "param", "type": "object" }, "sepa_debit": { "description": "If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account.", "properties": { "iban": { "description": "IBAN of the bank account.", "maxLength": 5000, "type": "string" } }, "required": [ "iban" ], "title": "param", "type": "object", "x-stripeMostCommon": [ "iban" ] }, "shopeepay": { "description": "If this is a Shopeepay PaymentMethod, this hash contains details about the Shopeepay payment method.", "properties": {}, "title": "param", "type": "object" }, "sofort": { "description": "If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.", "properties": { "country": { "description": "Two-letter ISO code representing the country the bank account is located in.", "enum": [ "AT", "BE", "DE", "ES", "IT", "NL" ], "type": "string" } }, "required": [ "country" ], "title": "param", "type": "object", "x-stripeMostCommon": [ "country" ] }, "stripe_balance": { "description": "This hash contains details about the Stripe balance payment method.", "properties": { "account": { "description": "The connected account ID whose Stripe balance to use as the source of payment", "maxLength": 5000, "type": "string" }, "source_type": { "description": "The [source_type](https://docs.stripe.com/api/balance/balance_object#balance_object-available-source_types) of the balance", "enum": [ "bank_account", "card", "fpx" ], "type": "string" } }, "title": "param", "type": "object", "x-stripeMostCommon": [ "account", "source_type" ] }, "swish": { "description": "If this is a `swish` PaymentMethod, this hash contains details about the Swish payment method.", "properties": {}, "title": "param", "type": "object" }, "twint": { "description": "If this is a TWINT PaymentMethod, this hash contains details about the TWINT payment method.", "properties": {}, "title": "param", "type": "object" }, "type": { "description": "The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.", "enum": [ "acss_debit", "affirm", "afterpay_clearpay", "alipay", "alma", "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", "billie", "blik", "boleto", "cashapp", "crypto", "customer_balance", "eps", "fpx", "giropay", "gopay", "grabpay", "id_bank_transfer", "ideal", "kakao_pay", "klarna", "konbini", "kr_card", "link", "mb_way", "mobilepay", "multibanco", "naver_pay", "nz_bank_account", "oxxo", "p24", "pay_by_bank", "payco", "paynow", "paypal", "paypay", "payto", "pix", "promptpay", "qris", "rechnung", "revolut_pay", "samsung_pay", "satispay", "sepa_debit", "shopeepay", "sofort", "stripe_balance", "swish", "twint", "us_bank_account", "wechat_pay", "zip" ], "type": "string", "x-stripeBypassValidation": true }, "us_bank_account": { "description": "If this is an `us_bank_account` PaymentMethod, this hash contains details about the US bank account payment method.", "properties": { "account_holder_type": { "description": "Account holder type: individual or company.", "enum": [ "company", "individual" ], "type": "string" }, "account_number": { "description": "Account number of the bank account.", "maxLength": 5000, "type": "string" }, "account_type": { "description": "Account type: checkings or savings. Defaults to checking if omitted.", "enum": [ "checking", "savings" ], "type": "string" }, "financial_connections_account": { "description": "The ID of a Financial Connections Account to use as a payment method.", "maxLength": 5000, "type": "string" }, "routing_number": { "description": "Routing number of the bank account.", "maxLength": 5000, "type": "string" } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "account_holder_type", "account_number", "account_type", "financial_connections_account", "routing_number" ] }, "wechat_pay": { "description": "If this is an `wechat_pay` PaymentMethod, this hash contains details about the wechat_pay payment method.", "properties": {}, "title": "param", "type": "object" }, "zip": { "description": "If this is a `zip` PaymentMethod, this hash contains details about the Zip payment method.", "properties": {}, "title": "param", "type": "object" } }, "required": [ "type" ], "title": "payment_method_data_params", "type": "object", "x-stripeMostCommon": [ "billing_details", "metadata", "type" ] }, "payment_method_options": { "description": "Payment method-specific configuration for this SetupIntent.", "properties": { "acss_debit": { "description": "If this is a `acss_debit` SetupIntent, this sub-hash contains details about the ACSS Debit payment method options.", "properties": { "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "enum": [ "cad", "usd" ], "type": "string" }, "mandate_options": { "description": "Additional fields for Mandate creation", "properties": { "custom_mandate_url": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "A URL for custom mandate text to render during confirmation step.\nThe URL will be rendered with additional GET parameters `payment_intent` and `payment_intent_client_secret` when confirming a Payment Intent,\nor `setup_intent` and `setup_intent_client_secret` when confirming a Setup Intent." }, "default_for": { "description": "List of Stripe products where this mandate can be selected automatically.", "items": { "enum": [ "invoice", "subscription" ], "type": "string" }, "type": "array" }, "interval_description": { "description": "Description of the mandate interval. Only required if 'payment_schedule' parameter is 'interval' or 'combined'.", "maxLength": 500, "type": "string" }, "payment_schedule": { "description": "Payment schedule for the mandate.", "enum": [ "combined", "interval", "sporadic" ], "type": "string" }, "transaction_type": { "description": "Transaction type of the mandate.", "enum": [ "business", "personal" ], "type": "string" } }, "title": "setup_intent_payment_method_options_mandate_options_param", "type": "object", "x-stripeMostCommon": [ "custom_mandate_url", "default_for", "interval_description", "payment_schedule", "transaction_type" ] }, "verification_method": { "description": "Bank account verification method.", "enum": [ "automatic", "instant", "microdeposits" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "setup_intent_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "currency", "financial_connections", "mandate_options", "verification_method" ] }, "amazon_pay": { "description": "If this is a `amazon_pay` SetupIntent, this sub-hash contains details about the AmazonPay payment method options.", "properties": {}, "title": "setup_intent_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "charge_permission_id" ] }, "bacs_debit": { "description": "If this is a `bacs_debit` SetupIntent, this sub-hash contains details about the Bacs Debit payment method options.", "properties": { "mandate_options": { "description": "Additional fields for Mandate creation", "properties": { "reference_prefix": { "anyOf": [ { "maxLength": 12, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'." } }, "title": "payment_method_options_mandate_options_param", "type": "object", "x-stripeMostCommon": [ "reference_prefix" ] } }, "title": "setup_intent_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "mandate_options" ] }, "card": { "description": "Configuration for any card setup attempted on this SetupIntent.", "properties": { "mandate_options": { "description": "Configuration options for setting up an eMandate for cards issued in India.", "properties": { "amount": { "description": "Amount to be charged for future payments.", "type": "integer" }, "amount_type": { "description": "One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.", "enum": [ "fixed", "maximum" ], "type": "string" }, "currency": { "description": "Currency in which future payments will be charged. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "description": { "description": "A description of the mandate or subscription that is meant to be displayed to the customer.", "maxLength": 200, "type": "string" }, "end_date": { "description": "End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.", "format": "unix-time", "type": "integer" }, "interval": { "description": "Specifies payment frequency. One of `day`, `week`, `month`, `year`, or `sporadic`.", "enum": [ "day", "month", "sporadic", "week", "year" ], "type": "string" }, "interval_count": { "description": "The number of intervals between payments. For example, `interval=month` and `interval_count=3` indicates one payment every three months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). This parameter is optional when `interval=sporadic`.", "type": "integer" }, "reference": { "description": "Unique identifier for the mandate or subscription.", "maxLength": 80, "type": "string" }, "start_date": { "description": "Start date of the mandate or subscription. Start date should not be lesser than yesterday.", "format": "unix-time", "type": "integer" }, "supported_types": { "description": "Specifies the type of mandates supported. Possible values are `india`.", "items": { "enum": [ "india" ], "type": "string" }, "type": "array" } }, "required": [ "amount", "amount_type", "currency", "interval", "reference", "start_date" ], "title": "setup_intent_mandate_options_param", "type": "object", "x-stripeMostCommon": [ "amount", "amount_type", "currency", "description", "end_date", "interval", "interval_count", "reference", "start_date", "supported_types" ] }, "moto": { "description": "When specified, this parameter signals that a card has been collected\nas MOTO (Mail Order Telephone Order) and thus out of scope for SCA. This\nparameter can only be provided during confirmation.", "type": "boolean" }, "network": { "description": "Selected network to process this SetupIntent on. Depends on the available networks of the card attached to the SetupIntent. Can be only set confirm-time.", "enum": [ "amex", "cartes_bancaires", "diners", "discover", "eftpos_au", "girocard", "interac", "jcb", "link", "mastercard", "unionpay", "unknown", "visa" ], "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true }, "request_three_d_secure": { "description": "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.", "enum": [ "any", "automatic", "challenge" ], "type": "string", "x-stripeBypassValidation": true }, "three_d_secure": { "description": "If 3D Secure authentication was performed with a third-party provider,\nthe authentication details to use for this setup.", "properties": { "ares_trans_status": { "description": "The `transStatus` returned from the card Issuer’s ACS in the ARes.", "enum": [ "A", "C", "I", "N", "R", "U", "Y" ], "type": "string" }, "cryptogram": { "description": "The cryptogram, also known as the \"authentication value\" (AAV, CAVV or\nAEVV). This value is 20 bytes, base64-encoded into a 28-character string.\n(Most 3D Secure providers will return the base64-encoded version, which\nis what you should specify here.)", "maxLength": 5000, "type": "string" }, "electronic_commerce_indicator": { "description": "The Electronic Commerce Indicator (ECI) is returned by your 3D Secure\nprovider and indicates what degree of authentication was performed.", "enum": [ "01", "02", "05", "06", "07" ], "type": "string", "x-stripeBypassValidation": true }, "network_options": { "description": "Network specific 3DS fields. Network specific arguments require an\nexplicit card brand choice. The parameter `payment_method_options.card.network``\nmust be populated accordingly", "properties": { "cartes_bancaires": { "description": "Cartes Bancaires-specific 3DS fields.", "properties": { "cb_avalgo": { "description": "The cryptogram calculation algorithm used by the card Issuer's ACS\nto calculate the Authentication cryptogram. Also known as `cavvAlgorithm`.\nmessageExtension: CB-AVALGO", "enum": [ "0", "1", "2", "3", "4", "A" ], "type": "string" }, "cb_exemption": { "description": "The exemption indicator returned from Cartes Bancaires in the ARes.\nmessage extension: CB-EXEMPTION; string (4 characters)\nThis is a 3 byte bitmap (low significant byte first and most significant\nbit first) that has been Base64 encoded", "maxLength": 4, "type": "string" }, "cb_score": { "description": "The risk score returned from Cartes Bancaires in the ARes.\nmessage extension: CB-SCORE; numeric value 0-99", "type": "integer" } }, "required": [ "cb_avalgo" ], "title": "cartes_bancaires_network_options_param", "type": "object", "x-stripeMostCommon": [ "cb_avalgo", "cb_exemption", "cb_score" ] } }, "title": "network_options_param", "type": "object", "x-stripeMostCommon": [ "cartes_bancaires" ] }, "requestor_challenge_indicator": { "description": "The challenge indicator (`threeDSRequestorChallengeInd`) which was requested in the\nAReq sent to the card Issuer's ACS. A string containing 2 digits from 01-99.", "maxLength": 2, "type": "string" }, "transaction_id": { "description": "For 3D Secure 1, the XID. For 3D Secure 2, the Directory Server\nTransaction ID (dsTransID).", "maxLength": 5000, "type": "string" }, "version": { "description": "The version of 3D Secure that was performed.", "enum": [ "1.0.2", "2.1.0", "2.2.0" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "setup_intent_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "ares_trans_status", "cryptogram", "electronic_commerce_indicator", "exemption_preferred", "gateway", "network_options", "requestor_challenge_indicator", "transaction_id", "version" ] } }, "title": "setup_intent_param", "type": "object", "x-stripeMostCommon": [ "commerce_type", "mandate_options", "moto", "network", "network_token", "request_name_verification", "request_three_d_secure", "three_d_secure", "verify_card_account" ] }, "card_present": { "description": "If this is a `card_present` PaymentMethod, this sub-hash contains details about the card-present payment method options.", "properties": {}, "title": "setup_intent_payment_method_options_param", "type": "object" }, "klarna": { "description": "If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method options.", "properties": { "currency": { "description": "The currency of the SetupIntent. Three letter ISO currency code.", "format": "currency", "type": "string" }, "on_demand": { "description": "On-demand details if setting up a payment method for on-demand payments.", "properties": { "average_amount": { "description": "Your average amount value. You can use a value across your customer base, or segment based on customer type, country, etc.", "type": "integer" }, "maximum_amount": { "description": "The maximum value you may charge a customer per purchase. You can use a value across your customer base, or segment based on customer type, country, etc.", "type": "integer" }, "minimum_amount": { "description": "The lowest or minimum value you may charge a customer per purchase. You can use a value across your customer base, or segment based on customer type, country, etc.", "type": "integer" }, "purchase_interval": { "description": "Interval at which the customer is making purchases", "enum": [ "day", "month", "week", "year" ], "type": "string" }, "purchase_interval_count": { "description": "The number of `purchase_interval` between charges", "type": "integer" } }, "title": "on_demand_param", "type": "object", "x-stripeMostCommon": [ "average_amount", "maximum_amount", "minimum_amount", "purchase_interval", "purchase_interval_count" ] }, "preferred_locale": { "description": "Preferred language of the Klarna authorization page that the customer is redirected to", "enum": [ "cs-CZ", "da-DK", "de-AT", "de-CH", "de-DE", "el-GR", "en-AT", "en-AU", "en-BE", "en-CA", "en-CH", "en-CZ", "en-DE", "en-DK", "en-ES", "en-FI", "en-FR", "en-GB", "en-GR", "en-IE", "en-IT", "en-NL", "en-NO", "en-NZ", "en-PL", "en-PT", "en-RO", "en-SE", "en-US", "es-ES", "es-US", "fi-FI", "fr-BE", "fr-CA", "fr-CH", "fr-FR", "it-CH", "it-IT", "nb-NO", "nl-BE", "nl-NL", "pl-PL", "pt-PT", "ro-RO", "sv-FI", "sv-SE" ], "type": "string", "x-stripeBypassValidation": true }, "subscriptions": { "anyOf": [ { "items": { "properties": { "interval": { "description": "Unit of time between subscription charges.", "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "description": "The number of intervals (specified in the `interval` attribute) between subscription charges. For example, `interval=month` and `interval_count=3` charges every 3 months.", "type": "integer" }, "name": { "description": "Name for subscription.", "maxLength": 255, "type": "string" }, "next_billing": { "description": "Describes the upcoming charge for this subscription.", "properties": { "amount": { "description": "The amount of the next charge for the subscription.", "type": "integer" }, "date": { "description": "The date of the next charge for the subscription in YYYY-MM-DD format.", "maxLength": 5000, "type": "string" } }, "required": [ "amount", "date" ], "title": "subscription_next_billing_param", "type": "object", "x-stripeMostCommon": [ "amount", "date" ] }, "reference": { "description": "A non-customer-facing reference to correlate subscription charges in the Klarna app. Use a value that persists across subscription charges.", "maxLength": 255, "type": "string" } }, "required": [ "interval", "next_billing", "reference" ], "title": "setup_intent_subscription_param", "type": "object", "x-stripeMostCommon": [ "interval", "interval_count", "name", "next_billing", "reference" ] }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "Subscription details if setting up or charging a subscription" } }, "title": "setup_intent_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "currency", "interoperability_token", "on_demand", "payment_option_id", "preferred_locale", "subscriptions" ] }, "link": { "description": "If this is a `link` PaymentMethod, this sub-hash contains details about the Link payment method options.", "properties": { "persistent_token": { "description": "[Deprecated] This is a legacy parameter that no longer has any function.", "maxLength": 5000, "type": "string" } }, "title": "setup_intent_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "persistent_token" ] }, "paypal": { "description": "If this is a `paypal` PaymentMethod, this sub-hash contains details about the PayPal payment method options.", "properties": { "billing_agreement_id": { "description": "The PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer.", "maxLength": 5000, "type": "string" }, "currency": { "format": "currency", "type": "string" }, "subsellers": { "description": "The Stripe connected account IDs of the sellers on the platform for this transaction (optional). Only allowed when [separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers) are used.", "items": { "maxLength": 32, "type": "string" }, "type": "array" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "billing_agreement_id", "currency", "subsellers" ] }, "payto": { "description": "If this is a `payto` SetupIntent, this sub-hash contains details about the PayTo payment method options.", "properties": { "mandate_options": { "description": "Additional fields for Mandate creation.", "properties": { "amount": { "description": "Amount that will be collected. It is required when `amount_type` is `fixed`.", "type": "integer" }, "amount_type": { "description": "The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively.", "enum": [ "fixed", "maximum" ], "type": "string" }, "end_date": { "description": "Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.", "maxLength": 5000, "type": "string" }, "payment_schedule": { "description": "The periodicity at which payments will be collected.", "enum": [ "adhoc", "annual", "daily", "fortnightly", "monthly", "quarterly", "semi_annual", "weekly" ], "type": "string" }, "payments_per_period": { "description": "The number of payments that will be made during a payment period. Defaults to 1 except for when `payment_schedule` is `adhoc`. In that case, it defaults to no limit.", "type": "integer" }, "purpose": { "description": "The purpose for which payments are made. Defaults to retail.", "enum": [ "dependant_support", "government", "loan", "mortgage", "other", "pension", "personal", "retail", "salary", "tax", "utility" ], "type": "string" }, "start_date": { "description": "Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time.", "maxLength": 5000, "type": "string" } }, "title": "setup_intent_payment_method_options_mandate_options_param", "type": "object", "x-stripeMostCommon": [ "amount", "amount_type", "end_date", "payment_schedule", "payments_per_period", "purpose", "start_date" ] } }, "title": "setup_intent_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "mandate_options" ] }, "pix": { "description": "If this is a `pix` SetupIntent, this sub-hash contains details about the Pix payment method options.", "properties": { "mandate_options": { "description": "Additional fields for mandate creation.", "properties": { "amount": { "description": "Amount to be charged for future payments. Required when `amount_type=fixed`. If not provided for `amount_type=maximum`, defaults to 40000.", "type": "integer" }, "amount_includes_iof": { "description": "Determines if the amount includes the IOF tax. Defaults to `never`.", "enum": [ "always", "never" ], "type": "string" }, "amount_type": { "description": "Type of amount. Defaults to `maximum`.", "enum": [ "fixed", "maximum" ], "type": "string" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Only `brl` is supported currently.", "format": "currency", "type": "string" }, "end_date": { "description": "Date when the mandate expires and no further payments will be charged, in `YYYY-MM-DD`. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.", "maxLength": 5000, "type": "string" }, "payment_schedule": { "description": "Schedule at which the future payments will be charged. Defaults to `weekly`.", "enum": [ "halfyearly", "monthly", "quarterly", "weekly", "yearly" ], "type": "string" }, "reference": { "description": "Subscription name displayed to buyers in their bank app. Defaults to the displayable business name.", "maxLength": 35, "type": "string" }, "start_date": { "description": "Start date of the mandate, in `YYYY-MM-DD`. Start date should be at least 3 days in the future. Defaults to 3 days after the current date.", "maxLength": 5000, "type": "string" } }, "title": "payment_method_options_mandate_options_param", "type": "object", "x-stripeMostCommon": [ "amount", "amount_includes_iof", "amount_type", "currency", "end_date", "payment_schedule", "reference", "start_date" ] } }, "title": "setup_intent_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "mandate_options" ] }, "sepa_debit": { "description": "If this is a `sepa_debit` SetupIntent, this sub-hash contains details about the SEPA Debit payment method options.", "properties": { "mandate_options": { "description": "Additional fields for Mandate creation", "properties": { "reference_prefix": { "anyOf": [ { "maxLength": 12, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'." } }, "title": "payment_method_options_mandate_options_param", "type": "object", "x-stripeMostCommon": [ "reference", "reference_prefix" ] } }, "title": "setup_intent_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "mandate_options", "verification_method" ] }, "us_bank_account": { "description": "If this is a `us_bank_account` SetupIntent, this sub-hash contains details about the US bank account payment method options.", "properties": { "financial_connections": { "description": "Additional fields for Financial Connections Session creation", "properties": { "filters": { "description": "Provide filters for the linked accounts that the customer can select for the payment method.", "properties": { "account_subcategories": { "description": "The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.", "items": { "enum": [ "checking", "savings" ], "maxLength": 5000, "type": "string" }, "type": "array" }, "institution": { "description": "ID of the institution to use to filter for selectable accounts.", "maxLength": 5000, "type": "string" } }, "title": "linked_account_options_filters_param", "type": "object", "x-stripeMostCommon": [ "account_subcategories", "institution" ] }, "manual_entry": { "description": "Customize manual entry behavior", "properties": { "mode": { "description": "Settings for configuring manual entry of account details.", "enum": [ "automatic", "custom" ], "type": "string" } }, "required": [ "mode" ], "title": "linked_account_options_manual_entry_param", "type": "object", "x-stripeMostCommon": [ "mode" ] }, "permissions": { "description": "The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.", "items": { "enum": [ "balances", "ownership", "payment_method", "transactions" ], "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true }, "type": "array" }, "prefetch": { "description": "List of data features that you would like to retrieve upon account creation.", "items": { "enum": [ "balances", "inferred_balances", "ownership", "transactions" ], "type": "string", "x-stripeBypassValidation": true }, "type": "array" }, "return_url": { "description": "For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.", "maxLength": 5000, "type": "string" } }, "title": "linked_account_options_param", "type": "object", "x-stripeMostCommon": [ "filters", "manual_entry", "permissions", "prefetch", "return_url" ] }, "mandate_options": { "description": "Additional fields for Mandate creation", "properties": { "collection_method": { "description": "The method used to collect offline mandate customer acceptance.", "enum": [ "", "paper" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "mandate_options_param", "type": "object", "x-stripeMostCommon": [ "collection_method" ] }, "networks": { "description": "Additional fields for network related functions", "properties": { "requested": { "description": "Triggers validations to run across the selected networks", "items": { "enum": [ "ach", "us_domestic_wire" ], "type": "string" }, "type": "array" } }, "title": "networks_options_param", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "verification_method": { "description": "Bank account verification method.", "enum": [ "automatic", "instant", "microdeposits" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "setup_intent_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "financial_connections", "mandate_options", "networks", "verification_method" ] } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "acss_debit", "alipay", "amazon_pay", "bacs_debit", "blik", "card", "card_present", "demo_pay", "dummy_auth_push", "klarna", "link", "paypal", "payto", "pix", "sepa_debit", "upi", "us_bank_account", "wechat_pay" ] }, "return_url": { "description": "The URL to redirect your customer back to after they authenticate on the payment method's app or site.\nIf you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme.\nThis parameter is only used for cards and other redirect-based payment methods.", "type": "string" }, "use_stripe_sdk": { "description": "Set to `true` when confirming server-side and using Stripe.js, iOS, or Android client-side SDKs to handle the next actions.", "type": "boolean" } }, "type": "object", "x-stripeMostCommon": [ "payment_method" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setup_intent" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Confirm a SetupIntent" } }, "/v1/setup_intents/{intent}/verify_microdeposits": { "post": { "description": "

Verifies microdeposits on a SetupIntent object.

", "operationId": "PostSetupIntentsIntentVerifyMicrodeposits", "parameters": [ { "in": "path", "name": "intent", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "amounts": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "amounts": { "description": "Two positive integers, in *cents*, equal to the values of the microdeposits sent to the bank account.", "items": { "type": "integer" }, "type": "array" }, "descriptor_code": { "description": "A six-character code starting with SM present in the microdeposit sent to the bank account.", "maxLength": 5000, "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object", "x-stripeMostCommon": [ "amounts", "descriptor_code" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setup_intent" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Verify microdeposits on a SetupIntent" } }, "/v1/shipping_rates": { "get": { "description": "

Returns a list of your shipping rates.

", "operationId": "GetShippingRates", "parameters": [ { "description": "Only return shipping rates that are active or inactive.", "in": "query", "name": "active", "required": false, "schema": { "type": "boolean" }, "style": "form" }, { "description": "A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.", "explode": true, "in": "query", "name": "created", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "description": "Minimum value to filter by (exclusive)", "type": "integer" }, "gte": { "description": "Minimum value to filter by (inclusive)", "type": "integer" }, "lt": { "description": "Maximum value to filter by (exclusive)", "type": "integer" }, "lte": { "description": "Maximum value to filter by (inclusive)", "type": "integer" } }, "title": "range_query_specs", "type": "object", "x-stripeMostCommon": [ "gt", "gte", "lt", "lte" ] }, { "type": "integer" } ] }, "style": "deepObject" }, { "description": "Only return shipping rates for the given currency.", "in": "query", "name": "currency", "required": false, "schema": { "format": "currency", "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/shipping_rate" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/shipping_rates", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "ShippingResourcesShippingRateList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all shipping rates" }, "post": { "description": "

Creates a new shipping rate object.

", "operationId": "PostShippingRates", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "delivery_estimate": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "fixed_amount": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "delivery_estimate": { "description": "The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.", "properties": { "maximum": { "description": "The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.", "properties": { "unit": { "description": "A unit of time.", "enum": [ "business_day", "day", "hour", "month", "week" ], "type": "string" }, "value": { "description": "Must be greater than 0.", "type": "integer" } }, "required": [ "unit", "value" ], "title": "delivery_estimate_bound", "type": "object", "x-stripeMostCommon": [ "unit", "value" ] }, "minimum": { "description": "The lower bound of the estimated range. If empty, represents no lower bound.", "properties": { "unit": { "description": "A unit of time.", "enum": [ "business_day", "day", "hour", "month", "week" ], "type": "string" }, "value": { "description": "Must be greater than 0.", "type": "integer" } }, "required": [ "unit", "value" ], "title": "delivery_estimate_bound", "type": "object", "x-stripeMostCommon": [ "unit", "value" ] } }, "title": "delivery_estimate", "type": "object", "x-stripeMostCommon": [ "maximum", "minimum" ] }, "display_name": { "description": "The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.", "maxLength": 100, "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "fixed_amount": { "description": "Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`.", "properties": { "amount": { "description": "A non-negative integer in cents representing how much to charge.", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "currency_options": { "additionalProperties": { "properties": { "amount": { "description": "A non-negative integer in cents representing how much to charge.", "type": "integer" }, "tax_behavior": { "description": "Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.", "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" } }, "required": [ "amount" ], "title": "currency_option", "type": "object", "x-stripeMostCommon": [ "amount", "tax_behavior" ] }, "description": "Shipping rates defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).", "type": "object" } }, "required": [ "amount", "currency" ], "title": "fixed_amount", "type": "object", "x-stripeMostCommon": [ "amount", "currency", "currency_options" ] }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "tax_behavior": { "description": "Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.", "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" }, "tax_code": { "description": "A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`.", "type": "string" }, "type": { "description": "The type of calculation to use on the shipping rate.", "enum": [ "fixed_amount" ], "type": "string" } }, "required": [ "display_name" ], "type": "object", "x-stripeMostCommon": [ "display_name", "fixed_amount", "metadata", "tax_behavior", "tax_code", "type" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_rate" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a shipping rate" } }, "/v1/shipping_rates/{shipping_rate_token}": { "get": { "description": "

Returns the shipping rate object with the given ID.

", "operationId": "GetShippingRatesShippingRateToken", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "shipping_rate_token", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_rate" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a shipping rate" }, "post": { "description": "

Updates an existing shipping rate object.

", "operationId": "PostShippingRatesShippingRateToken", "parameters": [ { "in": "path", "name": "shipping_rate_token", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "fixed_amount": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "active": { "description": "Whether the shipping rate can be used for new purchases. Defaults to `true`.", "type": "boolean" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "fixed_amount": { "description": "Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`.", "properties": { "currency_options": { "additionalProperties": { "properties": { "amount": { "description": "A non-negative integer in cents representing how much to charge.", "type": "integer" }, "tax_behavior": { "description": "Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.", "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" } }, "title": "currency_option_update", "type": "object", "x-stripeMostCommon": [ "amount", "tax_behavior" ] }, "description": "Shipping rates defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).", "type": "object" } }, "title": "fixed_amount_update", "type": "object", "x-stripeMostCommon": [ "currency_options" ] }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "tax_behavior": { "description": "Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.", "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" } }, "type": "object", "x-stripeMostCommon": [ "active", "fixed_amount", "metadata", "tax_behavior" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_rate" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a shipping rate" } }, "/v1/sigma/scheduled_query_runs": { "get": { "description": "

Returns a list of scheduled query runs.

", "operationId": "GetSigmaScheduledQueryRuns", "parameters": [ { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/scheduled_query_run" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/sigma/scheduled_query_runs", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "SigmaScheduledQueryRunList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all scheduled query runs" } }, "/v1/sigma/scheduled_query_runs/{scheduled_query_run}": { "get": { "description": "

Retrieves the details of an scheduled query run.

", "operationId": "GetSigmaScheduledQueryRunsScheduledQueryRun", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "scheduled_query_run", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scheduled_query_run" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a scheduled query run" } }, "/v1/sources": { "post": { "description": "

Creates a new source object.

", "operationId": "PostSources", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "mandate": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "owner": { "explode": true, "style": "deepObject" }, "receiver": { "explode": true, "style": "deepObject" }, "redirect": { "explode": true, "style": "deepObject" }, "source_order": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "amount": { "description": "Amount associated with the source. This is the amount for which the source will be chargeable once ready. Required for `single_use` sources. Not supported for `receiver` type sources, where charge amount may not be specified until funds land.", "type": "integer" }, "currency": { "description": "Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) associated with the source. This is the currency for which the source will be chargeable once ready.", "format": "currency", "type": "string" }, "customer": { "description": "The `Customer` to whom the original source is attached to. Must be set when the original source is not a `Source` (e.g., `Card`).", "maxLength": 500, "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "flow": { "description": "The authentication `flow` of the source to create. `flow` is one of `redirect`, `receiver`, `code_verification`, `none`. It is generally inferred unless a type supports multiple flows.", "enum": [ "code_verification", "none", "receiver", "redirect" ], "maxLength": 5000, "type": "string" }, "mandate": { "description": "Information about a mandate possibility attached to a source object (generally for bank debits) as well as its acceptance status.", "properties": { "acceptance": { "description": "The parameters required to notify Stripe of a mandate acceptance or refusal by the customer.", "properties": { "date": { "description": "The Unix timestamp (in seconds) when the mandate was accepted or refused by the customer.", "format": "unix-time", "type": "integer" }, "ip": { "description": "The IP address from which the mandate was accepted or refused by the customer.", "type": "string" }, "offline": { "description": "The parameters required to store a mandate accepted offline. Should only be set if `mandate[type]` is `offline`", "properties": { "contact_email": { "description": "An email to contact you with if a copy of the mandate is requested, required if `type` is `offline`.", "type": "string" } }, "required": [ "contact_email" ], "title": "mandate_offline_acceptance_params", "type": "object", "x-stripeMostCommon": [ "contact_email" ] }, "online": { "description": "The parameters required to store a mandate accepted online. Should only be set if `mandate[type]` is `online`", "properties": { "date": { "description": "The Unix timestamp (in seconds) when the mandate was accepted or refused by the customer.", "format": "unix-time", "type": "integer" }, "ip": { "description": "The IP address from which the mandate was accepted or refused by the customer.", "type": "string" }, "user_agent": { "description": "The user agent of the browser from which the mandate was accepted or refused by the customer.", "maxLength": 5000, "type": "string" } }, "title": "mandate_online_acceptance_params", "type": "object", "x-stripeMostCommon": [ "date", "ip", "user_agent" ] }, "status": { "description": "The status of the mandate acceptance. Either `accepted` (the mandate was accepted) or `refused` (the mandate was refused).", "enum": [ "accepted", "pending", "refused", "revoked" ], "maxLength": 5000, "type": "string" }, "type": { "description": "The type of acceptance information included with the mandate. Either `online` or `offline`", "enum": [ "offline", "online" ], "maxLength": 5000, "type": "string" }, "user_agent": { "description": "The user agent of the browser from which the mandate was accepted or refused by the customer.", "maxLength": 5000, "type": "string" } }, "required": [ "status" ], "title": "mandate_acceptance_params", "type": "object", "x-stripeMostCommon": [ "date", "ip", "offline", "online", "status", "type", "user_agent" ] }, "amount": { "anyOf": [ { "type": "integer" }, { "enum": [ "" ], "type": "string" } ], "description": "The amount specified by the mandate. (Leave null for a mandate covering all amounts)" }, "currency": { "description": "The currency specified by the mandate. (Must match `currency` of the source)", "format": "currency", "type": "string" }, "interval": { "description": "The interval of debits permitted by the mandate. Either `one_time` (just permitting a single debit), `scheduled` (with debits on an agreed schedule or for clearly-defined events), or `variable`(for debits with any frequency)", "enum": [ "one_time", "scheduled", "variable" ], "maxLength": 5000, "type": "string" }, "notification_method": { "description": "The method Stripe should use to notify the customer of upcoming debit instructions and/or mandate confirmation as required by the underlying debit network. Either `email` (an email is sent directly to the customer), `manual` (a `source.mandate_notification` event is sent to your webhooks endpoint and you should handle the notification) or `none` (the underlying debit network does not require any notification).", "enum": [ "deprecated_none", "email", "manual", "none", "stripe_email" ], "maxLength": 5000, "type": "string" } }, "title": "mandate_params", "type": "object", "x-stripeMostCommon": [ "acceptance", "amount", "currency", "interval", "notification_method" ] }, "metadata": { "additionalProperties": { "type": "string" }, "type": "object" }, "original_source": { "description": "The source to share.", "maxLength": 5000, "type": "string" }, "owner": { "description": "Information about the owner of the payment instrument that may be used or required by particular source types.", "properties": { "address": { "description": "Owner's address.", "properties": { "city": { "description": "City, district, suburb, town, or village.", "maxLength": 5000, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Address line 1 (e.g., street, PO Box, or company name).", "maxLength": 5000, "type": "string" }, "line2": { "description": "Address line 2 (e.g., apartment, suite, unit, or building).", "maxLength": 5000, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "State, county, province, or region.", "maxLength": 5000, "type": "string" } }, "title": "source_address", "type": "object", "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state" ] }, "email": { "description": "Owner's email address.", "type": "string" }, "name": { "description": "Owner's full name.", "maxLength": 5000, "type": "string" }, "phone": { "description": "Owner's phone number.", "maxLength": 5000, "type": "string" } }, "title": "owner", "type": "object", "x-stripeMostCommon": [ "address", "email", "name", "phone" ] }, "receiver": { "description": "Optional parameters for the receiver flow. Can be set only if the source is a receiver (`flow` is `receiver`).", "properties": { "refund_attributes_method": { "description": "The method Stripe should use to request information needed to process a refund or mispayment. Either `email` (an email is sent directly to the customer) or `manual` (a `source.refund_attributes_required` event is sent to your webhooks endpoint). Refer to each payment method's documentation to learn which refund attributes may be required.", "enum": [ "email", "manual", "none" ], "maxLength": 5000, "type": "string" } }, "title": "receiver_params", "type": "object", "x-stripeMostCommon": [ "refund_attributes_method" ] }, "redirect": { "description": "Parameters required for the redirect flow. Required if the source is authenticated by a redirect (`flow` is `redirect`).", "properties": { "return_url": { "description": "The URL you provide to redirect the customer back to you after they authenticated their payment. It can use your application URI scheme in the context of a mobile application.", "type": "string" } }, "required": [ "return_url" ], "title": "redirect_params", "type": "object", "x-stripeMostCommon": [ "return_url" ] }, "source_order": { "description": "Information about the items and shipping associated with the source. Required for transactional credit (for example Klarna) sources before you can charge it.", "properties": { "items": { "description": "List of items constituting the order.", "items": { "properties": { "amount": { "type": "integer" }, "currency": { "format": "currency", "type": "string" }, "description": { "maxLength": 1000, "type": "string" }, "parent": { "description": "The ID of the SKU being ordered.", "maxLength": 5000, "type": "string" }, "quantity": { "description": "The quantity of this order item. When type is `sku`, this is the number of instances of the SKU to be ordered.", "type": "integer" }, "type": { "enum": [ "discount", "shipping", "sku", "tax" ], "maxLength": 5000, "type": "string" } }, "title": "order_item_specs", "type": "object", "x-stripeMostCommon": [ "amount", "currency", "description", "parent", "quantity", "type" ] }, "type": "array" }, "shipping": { "description": "Shipping address for the order. Required if any of the SKUs are for products that have `shippable` set to true.", "properties": { "address": { "description": "Shipping address.", "properties": { "city": { "description": "City, district, suburb, town, or village.", "maxLength": 5000, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Address line 1 (e.g., street, PO Box, or company name).", "maxLength": 5000, "type": "string" }, "line2": { "description": "Address line 2 (e.g., apartment, suite, unit, or building).", "maxLength": 5000, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "State, county, province, or region.", "maxLength": 5000, "type": "string" } }, "required": [ "line1" ], "title": "address", "type": "object", "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state" ] }, "carrier": { "description": "The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.", "maxLength": 5000, "type": "string" }, "name": { "description": "Recipient name.", "maxLength": 5000, "type": "string" }, "phone": { "description": "Recipient phone (including extension).", "maxLength": 5000, "type": "string" }, "tracking_number": { "description": "The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.", "maxLength": 5000, "type": "string" } }, "required": [ "address" ], "title": "order_shipping", "type": "object", "x-stripeMostCommon": [ "address", "carrier", "name", "phone", "tracking_number" ] } }, "title": "shallow_order_specs", "type": "object", "x-stripeMostCommon": [ "items", "shipping" ] }, "statement_descriptor": { "description": "An arbitrary string to be displayed on your customer's statement. As an example, if your website is `RunClub` and the item you're charging for is a race ticket, you may want to specify a `statement_descriptor` of `RunClub 5K race ticket.` While many payment types will display this information, some may not display it at all.", "maxLength": 5000, "type": "string" }, "token": { "description": "An optional token used to create the source. When passed, token properties will override source parameters.", "maxLength": 5000, "type": "string" }, "type": { "description": "The `type` of the source to create. Required unless `customer` and `original_source` are specified (see the [Cloning card Sources](https://stripe.com/docs/sources/connect#cloning-card-sources) guide)", "maxLength": 5000, "type": "string" }, "usage": { "enum": [ "reusable", "single_use" ], "maxLength": 5000, "type": "string" } }, "type": "object", "x-stripeMostCommon": [ "amount", "currency", "customer", "metadata", "original_source", "owner", "redirect", "statement_descriptor", "type" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/source" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Shares a source" } }, "/v1/sources/{source}": { "get": { "description": "

Retrieves an existing source object. Supply the unique source ID from a source creation request and Stripe will return the corresponding up-to-date source object information.

", "operationId": "GetSourcesSource", "parameters": [ { "description": "The client secret of the source. Required if a publishable key is used to retrieve the source.", "in": "query", "name": "client_secret", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "source", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/source" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a source" }, "post": { "description": "

Updates the specified source by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

\n\n

This request accepts the metadata and owner as arguments. It is also possible to update type specific information for selected payment methods. Please refer to our payment method guides for more detail.

", "operationId": "PostSourcesSource", "parameters": [ { "in": "path", "name": "source", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "mandate": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "owner": { "explode": true, "style": "deepObject" }, "source_order": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "amount": { "description": "Amount associated with the source.", "type": "integer" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "mandate": { "description": "Information about a mandate possibility attached to a source object (generally for bank debits) as well as its acceptance status.", "properties": { "acceptance": { "description": "The parameters required to notify Stripe of a mandate acceptance or refusal by the customer.", "properties": { "date": { "description": "The Unix timestamp (in seconds) when the mandate was accepted or refused by the customer.", "format": "unix-time", "type": "integer" }, "ip": { "description": "The IP address from which the mandate was accepted or refused by the customer.", "type": "string" }, "offline": { "description": "The parameters required to store a mandate accepted offline. Should only be set if `mandate[type]` is `offline`", "properties": { "contact_email": { "description": "An email to contact you with if a copy of the mandate is requested, required if `type` is `offline`.", "type": "string" } }, "required": [ "contact_email" ], "title": "mandate_offline_acceptance_params", "type": "object", "x-stripeMostCommon": [ "contact_email" ] }, "online": { "description": "The parameters required to store a mandate accepted online. Should only be set if `mandate[type]` is `online`", "properties": { "date": { "description": "The Unix timestamp (in seconds) when the mandate was accepted or refused by the customer.", "format": "unix-time", "type": "integer" }, "ip": { "description": "The IP address from which the mandate was accepted or refused by the customer.", "type": "string" }, "user_agent": { "description": "The user agent of the browser from which the mandate was accepted or refused by the customer.", "maxLength": 5000, "type": "string" } }, "title": "mandate_online_acceptance_params", "type": "object", "x-stripeMostCommon": [ "date", "ip", "user_agent" ] }, "status": { "description": "The status of the mandate acceptance. Either `accepted` (the mandate was accepted) or `refused` (the mandate was refused).", "enum": [ "accepted", "pending", "refused", "revoked" ], "maxLength": 5000, "type": "string" }, "type": { "description": "The type of acceptance information included with the mandate. Either `online` or `offline`", "enum": [ "offline", "online" ], "maxLength": 5000, "type": "string" }, "user_agent": { "description": "The user agent of the browser from which the mandate was accepted or refused by the customer.", "maxLength": 5000, "type": "string" } }, "required": [ "status" ], "title": "mandate_acceptance_params", "type": "object", "x-stripeMostCommon": [ "date", "ip", "offline", "online", "status", "type", "user_agent" ] }, "amount": { "anyOf": [ { "type": "integer" }, { "enum": [ "" ], "type": "string" } ], "description": "The amount specified by the mandate. (Leave null for a mandate covering all amounts)" }, "currency": { "description": "The currency specified by the mandate. (Must match `currency` of the source)", "format": "currency", "type": "string" }, "interval": { "description": "The interval of debits permitted by the mandate. Either `one_time` (just permitting a single debit), `scheduled` (with debits on an agreed schedule or for clearly-defined events), or `variable`(for debits with any frequency)", "enum": [ "one_time", "scheduled", "variable" ], "maxLength": 5000, "type": "string" }, "notification_method": { "description": "The method Stripe should use to notify the customer of upcoming debit instructions and/or mandate confirmation as required by the underlying debit network. Either `email` (an email is sent directly to the customer), `manual` (a `source.mandate_notification` event is sent to your webhooks endpoint and you should handle the notification) or `none` (the underlying debit network does not require any notification).", "enum": [ "deprecated_none", "email", "manual", "none", "stripe_email" ], "maxLength": 5000, "type": "string" } }, "title": "mandate_params", "type": "object", "x-stripeMostCommon": [ "acceptance", "amount", "currency", "interval", "notification_method" ] }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "owner": { "description": "Information about the owner of the payment instrument that may be used or required by particular source types.", "properties": { "address": { "description": "Owner's address.", "properties": { "city": { "description": "City, district, suburb, town, or village.", "maxLength": 5000, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Address line 1 (e.g., street, PO Box, or company name).", "maxLength": 5000, "type": "string" }, "line2": { "description": "Address line 2 (e.g., apartment, suite, unit, or building).", "maxLength": 5000, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "State, county, province, or region.", "maxLength": 5000, "type": "string" } }, "title": "source_address", "type": "object", "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state" ] }, "email": { "description": "Owner's email address.", "type": "string" }, "name": { "description": "Owner's full name.", "maxLength": 5000, "type": "string" }, "phone": { "description": "Owner's phone number.", "maxLength": 5000, "type": "string" } }, "title": "owner", "type": "object", "x-stripeMostCommon": [ "address", "email", "name", "phone" ] }, "source_order": { "description": "Information about the items and shipping associated with the source. Required for transactional credit (for example Klarna) sources before you can charge it.", "properties": { "items": { "description": "List of items constituting the order.", "items": { "properties": { "amount": { "type": "integer" }, "currency": { "format": "currency", "type": "string" }, "description": { "maxLength": 1000, "type": "string" }, "parent": { "description": "The ID of the SKU being ordered.", "maxLength": 5000, "type": "string" }, "quantity": { "description": "The quantity of this order item. When type is `sku`, this is the number of instances of the SKU to be ordered.", "type": "integer" }, "type": { "enum": [ "discount", "shipping", "sku", "tax" ], "maxLength": 5000, "type": "string" } }, "title": "order_item_specs", "type": "object", "x-stripeMostCommon": [ "amount", "currency", "description", "parent", "quantity", "type" ] }, "type": "array" }, "shipping": { "description": "Shipping address for the order. Required if any of the SKUs are for products that have `shippable` set to true.", "properties": { "address": { "description": "Shipping address.", "properties": { "city": { "description": "City, district, suburb, town, or village.", "maxLength": 5000, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Address line 1 (e.g., street, PO Box, or company name).", "maxLength": 5000, "type": "string" }, "line2": { "description": "Address line 2 (e.g., apartment, suite, unit, or building).", "maxLength": 5000, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "State, county, province, or region.", "maxLength": 5000, "type": "string" } }, "required": [ "line1" ], "title": "address", "type": "object", "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state" ] }, "carrier": { "description": "The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.", "maxLength": 5000, "type": "string" }, "name": { "description": "Recipient name.", "maxLength": 5000, "type": "string" }, "phone": { "description": "Recipient phone (including extension).", "maxLength": 5000, "type": "string" }, "tracking_number": { "description": "The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.", "maxLength": 5000, "type": "string" } }, "required": [ "address" ], "title": "order_shipping", "type": "object", "x-stripeMostCommon": [ "address", "carrier", "name", "phone", "tracking_number" ] } }, "title": "order_params", "type": "object", "x-stripeMostCommon": [ "items", "shipping" ] } }, "type": "object", "x-stripeMostCommon": [ "amount", "metadata", "owner" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/source" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a source" } }, "/v1/sources/{source}/source_transactions": { "get": { "description": "

List source transactions for a given source.

", "operationId": "GetSourcesSourceSourceTransactions", "parameters": [ { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "in": "path", "name": "source", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/source_transaction" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "ApmsSourcesSourceTransactionList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } } } }, "/v1/sources/{source}/verify": { "post": { "description": "

Verify a given source.

", "operationId": "PostSourcesSourceVerify", "parameters": [ { "in": "path", "name": "source", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "values": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "values": { "description": "The values needed to verify the source.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "required": [ "values" ], "type": "object", "x-stripeMostCommon": [ "values" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/source" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } } } }, "/v1/subscription_items": { "get": { "description": "

Returns a list of your subscription items for a given subscription.

", "operationId": "GetSubscriptionItems", "parameters": [ { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "type": "string" }, "style": "form" }, { "description": "The ID of the subscription whose items will be retrieved.", "in": "query", "name": "subscription", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/subscription_item" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/subscription_items", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "SubscriptionsItemsSubscriptionItemList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all subscription items" }, "post": { "description": "

Adds a new item to an existing subscription. No existing items will be changed or replaced.

", "operationId": "PostSubscriptionItems", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "billing_thresholds": { "explode": true, "style": "deepObject" }, "discounts": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "price_data": { "explode": true, "style": "deepObject" }, "tax_rates": { "explode": true, "style": "deepObject" }, "trial": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "billing_thresholds": { "anyOf": [ { "properties": { "usage_gte": { "description": "Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte))", "type": "integer" } }, "required": [ "usage_gte" ], "title": "item_billing_thresholds_param", "type": "object", "x-stripeMostCommon": [ "usage_gte" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds." }, "discounts": { "anyOf": [ { "items": { "properties": { "coupon": { "description": "ID of the coupon to create a new discount for.", "maxLength": 5000, "type": "string" }, "discount": { "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", "maxLength": 5000, "type": "string" }, "discount_end": { "description": "Details to determine how long the discount should be applied for.", "properties": { "duration": { "description": "Time span for the redeemed discount.", "properties": { "interval": { "description": "Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.", "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "description": "The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.", "type": "integer" } }, "required": [ "interval", "interval_count" ], "title": "discount_end_duration_specs", "type": "object", "x-stripeMostCommon": [ "interval", "interval_count" ] }, "timestamp": { "description": "A precise Unix timestamp for the discount to end. Must be in the future.", "format": "unix-time", "type": "integer" }, "type": { "description": "The type of calculation made to determine when the discount ends.", "enum": [ "duration", "timestamp" ], "type": "string" } }, "required": [ "type" ], "title": "discount_end", "type": "object", "x-stripeMostCommon": [ "duration", "timestamp", "type" ] }, "promotion_code": { "description": "ID of the promotion code to create a new discount for.", "maxLength": 5000, "type": "string" } }, "title": "discounts_data_param", "type": "object", "x-stripeMostCommon": [ "coupon", "settings" ] }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The coupons to redeem into discounts for the subscription item." }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "payment_behavior": { "description": "Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior.\n\nUse `default_incomplete` to transition the subscription to `status=past_due` when payment is required and await explicit confirmation of the invoice's payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription’s invoice. Such as failed payments, [SCA regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method.\n\nUse `pending_if_incomplete` to update the subscription using [pending updates](https://stripe.com/docs/billing/subscriptions/pending-updates). When you use `pending_if_incomplete` you can only pass the parameters [supported by pending updates](https://stripe.com/docs/billing/pending-updates-reference#supported-attributes).\n\nUse `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://docs.stripe.com/changelog/2019-03-14) to learn more.", "enum": [ "allow_incomplete", "default_incomplete", "error_if_incomplete", "pending_if_incomplete" ], "type": "string" }, "plan": { "description": "The identifier of the plan to add to the subscription.", "maxLength": 5000, "type": "string" }, "price": { "description": "The ID of the price object.", "maxLength": 5000, "type": "string" }, "price_data": { "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.", "properties": { "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "product": { "description": "The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.", "maxLength": 5000, "type": "string" }, "recurring": { "description": "The recurring components of a price such as `interval` and `interval_count`.", "properties": { "interval": { "description": "Specifies billing frequency. Either `day`, `week`, `month` or `year`.", "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "description": "The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).", "type": "integer" } }, "required": [ "interval" ], "title": "recurring_adhoc", "type": "object", "x-stripeMostCommon": [ "interval" ] }, "tax_behavior": { "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.", "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" }, "unit_amount": { "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.", "type": "integer" }, "unit_amount_decimal": { "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", "format": "decimal", "type": "string" } }, "required": [ "currency", "product", "recurring" ], "title": "recurring_price_data", "type": "object", "x-stripeMostCommon": [ "currency", "product", "recurring", "unit_amount" ] }, "proration_behavior": { "description": "Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.", "enum": [ "always_invoice", "create_prorations", "none" ], "type": "string" }, "proration_date": { "description": "If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint.", "format": "unix-time", "type": "integer" }, "quantity": { "description": "The quantity you'd like to apply to the subscription item you're creating.", "type": "integer" }, "subscription": { "description": "The identifier of the subscription to modify.", "maxLength": 5000, "type": "string" }, "tax_rates": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates." }, "trial": { "description": "Options that configure the trial on the subscription item.", "properties": { "converts_to": { "description": "List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. Currently only supports at most 1 price ID.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "type": { "description": "Determines the type of trial for this item.", "enum": [ "free", "paid" ], "type": "string" } }, "required": [ "type" ], "title": "trial_specs", "type": "object", "x-stripeMostCommon": [ "converts_to", "type" ] } }, "required": [ "subscription" ], "type": "object", "x-stripeMostCommon": [ "metadata", "payment_behavior", "price", "proration_behavior", "quantity", "subscription" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/subscription_item" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a subscription item" } }, "/v1/subscription_items/{item}": { "delete": { "description": "

Deletes an item from the subscription. Removing a subscription item from a subscription will not cancel the subscription.

", "operationId": "DeleteSubscriptionItemsItem", "parameters": [ { "in": "path", "name": "item", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": { "clear_usage": { "description": "Delete all usage for the given subscription item. Allowed only when the current plan's `usage_type` is `metered`.", "type": "boolean" }, "proration_behavior": { "description": "Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.", "enum": [ "always_invoice", "create_prorations", "none" ], "type": "string" }, "proration_date": { "description": "If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint.", "format": "unix-time", "type": "integer" } }, "type": "object", "x-stripeMostCommon": [ "proration_behavior" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted_subscription_item" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Delete a subscription item" }, "get": { "description": "

Retrieves the subscription item with the given ID.

", "operationId": "GetSubscriptionItemsItem", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "item", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/subscription_item" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a subscription item" }, "post": { "description": "

Updates the plan or quantity of an item on a current subscription.

", "operationId": "PostSubscriptionItemsItem", "parameters": [ { "in": "path", "name": "item", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "billing_thresholds": { "explode": true, "style": "deepObject" }, "discounts": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "price_data": { "explode": true, "style": "deepObject" }, "tax_rates": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "billing_thresholds": { "anyOf": [ { "properties": { "usage_gte": { "description": "Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte))", "type": "integer" } }, "required": [ "usage_gte" ], "title": "item_billing_thresholds_param", "type": "object", "x-stripeMostCommon": [ "usage_gte" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds." }, "discounts": { "anyOf": [ { "items": { "properties": { "coupon": { "description": "ID of the coupon to create a new discount for.", "maxLength": 5000, "type": "string" }, "discount": { "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", "maxLength": 5000, "type": "string" }, "discount_end": { "description": "Details to determine how long the discount should be applied for.", "properties": { "duration": { "description": "Time span for the redeemed discount.", "properties": { "interval": { "description": "Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.", "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "description": "The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.", "type": "integer" } }, "required": [ "interval", "interval_count" ], "title": "discount_end_duration_specs", "type": "object", "x-stripeMostCommon": [ "interval", "interval_count" ] }, "timestamp": { "description": "A precise Unix timestamp for the discount to end. Must be in the future.", "format": "unix-time", "type": "integer" }, "type": { "description": "The type of calculation made to determine when the discount ends.", "enum": [ "duration", "timestamp" ], "type": "string" } }, "required": [ "type" ], "title": "discount_end", "type": "object", "x-stripeMostCommon": [ "duration", "timestamp", "type" ] }, "promotion_code": { "description": "ID of the promotion code to create a new discount for.", "maxLength": 5000, "type": "string" } }, "title": "discounts_data_param", "type": "object", "x-stripeMostCommon": [ "coupon", "settings" ] }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The coupons to redeem into discounts for the subscription item." }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "off_session": { "description": "Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to `false` (on-session).", "type": "boolean" }, "payment_behavior": { "description": "Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior.\n\nUse `default_incomplete` to transition the subscription to `status=past_due` when payment is required and await explicit confirmation of the invoice's payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription’s invoice. Such as failed payments, [SCA regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method.\n\nUse `pending_if_incomplete` to update the subscription using [pending updates](https://stripe.com/docs/billing/subscriptions/pending-updates). When you use `pending_if_incomplete` you can only pass the parameters [supported by pending updates](https://stripe.com/docs/billing/pending-updates-reference#supported-attributes).\n\nUse `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://docs.stripe.com/changelog/2019-03-14) to learn more.", "enum": [ "allow_incomplete", "default_incomplete", "error_if_incomplete", "pending_if_incomplete" ], "type": "string" }, "plan": { "description": "The identifier of the new plan for this subscription item.", "maxLength": 5000, "type": "string" }, "price": { "description": "The ID of the price object. One of `price` or `price_data` is required. When changing a subscription item's price, `quantity` is set to 1 unless a `quantity` parameter is provided.", "maxLength": 5000, "type": "string" }, "price_data": { "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.", "properties": { "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "product": { "description": "The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.", "maxLength": 5000, "type": "string" }, "recurring": { "description": "The recurring components of a price such as `interval` and `interval_count`.", "properties": { "interval": { "description": "Specifies billing frequency. Either `day`, `week`, `month` or `year`.", "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "description": "The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).", "type": "integer" } }, "required": [ "interval" ], "title": "recurring_adhoc", "type": "object", "x-stripeMostCommon": [ "interval" ] }, "tax_behavior": { "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.", "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" }, "unit_amount": { "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.", "type": "integer" }, "unit_amount_decimal": { "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", "format": "decimal", "type": "string" } }, "required": [ "currency", "product", "recurring" ], "title": "recurring_price_data", "type": "object", "x-stripeMostCommon": [ "currency", "product", "recurring", "unit_amount" ] }, "proration_behavior": { "description": "Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.", "enum": [ "always_invoice", "create_prorations", "none" ], "type": "string" }, "proration_date": { "description": "If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint.", "format": "unix-time", "type": "integer" }, "quantity": { "description": "The quantity you'd like to apply to the subscription item you're creating.", "type": "integer" }, "tax_rates": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates." } }, "type": "object", "x-stripeMostCommon": [ "metadata", "payment_behavior", "price", "proration_behavior", "quantity" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/subscription_item" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a subscription item" } }, "/v1/subscription_schedules": { "get": { "description": "

Retrieves the list of your subscription schedules.

", "operationId": "GetSubscriptionSchedules", "parameters": [ { "description": "Only return subscription schedules that were created canceled the given date interval.", "explode": true, "in": "query", "name": "canceled_at", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "description": "Minimum value to filter by (exclusive)", "type": "integer" }, "gte": { "description": "Minimum value to filter by (inclusive)", "type": "integer" }, "lt": { "description": "Maximum value to filter by (exclusive)", "type": "integer" }, "lte": { "description": "Maximum value to filter by (inclusive)", "type": "integer" } }, "title": "range_query_specs", "type": "object", "x-stripeMostCommon": [ "gt", "gte", "lt", "lte" ] }, { "type": "integer" } ] }, "style": "deepObject" }, { "description": "Only return subscription schedules that completed during the given date interval.", "explode": true, "in": "query", "name": "completed_at", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "description": "Minimum value to filter by (exclusive)", "type": "integer" }, "gte": { "description": "Minimum value to filter by (inclusive)", "type": "integer" }, "lt": { "description": "Maximum value to filter by (exclusive)", "type": "integer" }, "lte": { "description": "Maximum value to filter by (inclusive)", "type": "integer" } }, "title": "range_query_specs", "type": "object", "x-stripeMostCommon": [ "gt", "gte", "lt", "lte" ] }, { "type": "integer" } ] }, "style": "deepObject" }, { "description": "Only return subscription schedules that were created during the given date interval.", "explode": true, "in": "query", "name": "created", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "description": "Minimum value to filter by (exclusive)", "type": "integer" }, "gte": { "description": "Minimum value to filter by (inclusive)", "type": "integer" }, "lt": { "description": "Maximum value to filter by (exclusive)", "type": "integer" }, "lte": { "description": "Maximum value to filter by (inclusive)", "type": "integer" } }, "title": "range_query_specs", "type": "object", "x-stripeMostCommon": [ "gt", "gte", "lt", "lte" ] }, { "type": "integer" } ] }, "style": "deepObject" }, { "description": "Only return subscription schedules for the given customer.", "in": "query", "name": "customer", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Only return subscription schedules for the given account.", "in": "query", "name": "customer_account", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "Only return subscription schedules that were released during the given date interval.", "explode": true, "in": "query", "name": "released_at", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "description": "Minimum value to filter by (exclusive)", "type": "integer" }, "gte": { "description": "Minimum value to filter by (inclusive)", "type": "integer" }, "lt": { "description": "Maximum value to filter by (exclusive)", "type": "integer" }, "lte": { "description": "Maximum value to filter by (inclusive)", "type": "integer" } }, "title": "range_query_specs", "type": "object", "x-stripeMostCommon": [ "gt", "gte", "lt", "lte" ] }, { "type": "integer" } ] }, "style": "deepObject" }, { "description": "Only return subscription schedules that have not started yet.", "in": "query", "name": "scheduled", "required": false, "schema": { "type": "boolean" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/subscription_schedule" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/subscription_schedules", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "SubscriptionSchedulesResourceScheduleList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all schedules" }, "post": { "description": "

Creates a new subscription schedule object. Each customer can have up to 500 active or scheduled subscriptions.

", "operationId": "PostSubscriptionSchedules", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "billing_mode": { "explode": true, "style": "deepObject" }, "default_settings": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "phases": { "explode": true, "style": "deepObject" }, "prebilling": { "explode": true, "style": "deepObject" }, "start_date": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "billing_behavior": { "description": "Configures when the subscription schedule generates prorations for phase transitions. Possible values are `prorate_on_next_phase` or `prorate_up_front` with the default being `prorate_on_next_phase`. `prorate_on_next_phase` will apply phase changes and generate prorations at transition time. `prorate_up_front` will bill for all phases within the current billing cycle up front.", "enum": [ "prorate_on_next_phase", "prorate_up_front" ], "type": "string" }, "billing_mode": { "description": "Controls how prorations and invoices for subscriptions are calculated and orchestrated.", "properties": { "type": { "description": "Controls the calculation and orchestration of prorations and invoices for subscriptions.", "enum": [ "classic", "flexible" ], "type": "string" } }, "required": [ "type" ], "title": "billing_mode", "type": "object", "x-stripeMostCommon": [ "flexible", "type" ] }, "customer": { "description": "The identifier of the customer to create the subscription schedule for.", "maxLength": 5000, "type": "string" }, "customer_account": { "description": "The identifier of the account to create the subscription schedule for.", "maxLength": 5000, "type": "string" }, "default_settings": { "description": "Object representing the subscription schedule's default settings.", "properties": { "application_fee_percent": { "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).", "type": "number" }, "automatic_tax": { "description": "Default settings for automatic tax computation.", "properties": { "enabled": { "description": "Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription.", "type": "boolean" }, "liability": { "description": "The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.", "properties": { "account": { "description": "The connected account being referenced when `type` is `account`.", "type": "string" }, "type": { "description": "Type of the account referenced in the request.", "enum": [ "account", "self" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "param", "type": "object", "x-stripeMostCommon": [ "account", "type" ] } }, "required": [ "enabled" ], "title": "automatic_tax_config", "type": "object", "x-stripeMostCommon": [ "enabled", "liability" ] }, "billing_cycle_anchor": { "description": "Can be set to `phase_start` to set the anchor to the start of the phase or `automatic` to automatically change it if needed. Cannot be set to `phase_start` if this phase specifies a trial. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).", "enum": [ "automatic", "phase_start" ], "type": "string" }, "billing_thresholds": { "anyOf": [ { "properties": { "amount_gte": { "description": "Monetary threshold that triggers the subscription to advance to a new billing period", "type": "integer" }, "reset_billing_cycle_anchor": { "description": "Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged.", "type": "boolean" } }, "title": "billing_thresholds_param", "type": "object", "x-stripeMostCommon": [ "amount_gte", "reset_billing_cycle_anchor" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds." }, "collection_method": { "description": "Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically` on creation.", "enum": [ "charge_automatically", "send_invoice" ], "type": "string" }, "default_payment_method": { "description": "ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings.", "maxLength": 5000, "type": "string" }, "description": { "anyOf": [ { "maxLength": 500, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs." }, "invoice_settings": { "description": "All invoices will be billed using the specified settings.", "properties": { "account_tax_ids": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The account tax IDs associated with the subscription schedule. Will be set on invoices generated by the subscription schedule." }, "days_until_due": { "description": "Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `collection_method=charge_automatically`.", "type": "integer" }, "issuer": { "description": "The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.", "properties": { "account": { "description": "The connected account being referenced when `type` is `account`.", "type": "string" }, "type": { "description": "Type of the account referenced in the request.", "enum": [ "account", "self" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "param", "type": "object", "x-stripeMostCommon": [ "account", "type" ] } }, "title": "subscription_schedule_default_settings_param", "type": "object", "x-stripeMostCommon": [ "account_tax_ids", "custom_fields", "days_until_due", "description", "footer", "issuer", "rendering", "send_hosted_payment_email", "supported_payment_methods" ] }, "on_behalf_of": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "The account on behalf of which to charge, for each of the associated subscription's invoices." }, "transfer_data": { "anyOf": [ { "properties": { "amount_percent": { "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination.", "type": "number" }, "destination": { "description": "ID of an existing, connected Stripe account.", "type": "string" } }, "required": [ "destination" ], "title": "transfer_data_specs", "type": "object", "x-stripeMostCommon": [ "amount_percent", "destination" ] }, { "enum": [ "" ], "type": "string" } ], "description": "The data with which to automatically create a Transfer for each of the associated subscription's invoices." } }, "title": "default_settings_params", "type": "object", "x-stripeMostCommon": [ "application_fee_percent", "automatic_tax", "billing_cycle_anchor", "billing_thresholds", "collection_method", "default_payment_method", "description", "invoice_settings", "on_behalf_of", "transfer_data" ] }, "end_behavior": { "description": "Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running. `cancel` will end the subscription schedule and cancel the underlying subscription.", "enum": [ "cancel", "none", "release", "renew" ], "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "from_subscription": { "description": "Migrate an existing subscription to be managed by a subscription schedule. If this parameter is set, a subscription schedule will be created using the subscription's item(s), set to auto-renew using the subscription's interval. When using this parameter, other parameters (such as phase values) cannot be set. To create a subscription schedule with other modifications, we recommend making two separate API calls.", "maxLength": 5000, "type": "string" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "phases": { "description": "List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the `end_date` of one phase will always equal the `start_date` of the next phase.", "items": { "properties": { "add_invoice_items": { "description": "A list of prices and quantities that will generate invoice items appended to the next invoice for this phase. You may pass up to 20 items.", "items": { "properties": { "discounts": { "description": "The coupons to redeem into discounts for the item.", "items": { "properties": { "coupon": { "description": "ID of the coupon to create a new discount for.", "maxLength": 5000, "type": "string" }, "discount": { "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", "maxLength": 5000, "type": "string" }, "discount_end": { "description": "Details to determine how long the discount should be applied for.", "properties": { "duration": { "description": "Time span for the redeemed discount.", "properties": { "interval": { "description": "Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.", "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "description": "The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.", "type": "integer" } }, "required": [ "interval", "interval_count" ], "title": "discount_end_duration_specs", "type": "object", "x-stripeMostCommon": [ "interval", "interval_count" ] }, "timestamp": { "description": "A precise Unix timestamp for the discount to end. Must be in the future.", "format": "unix-time", "type": "integer" }, "type": { "description": "The type of calculation made to determine when the discount ends.", "enum": [ "duration", "timestamp" ], "type": "string" } }, "required": [ "type" ], "title": "discount_end", "type": "object", "x-stripeMostCommon": [ "duration", "timestamp", "type" ] }, "promotion_code": { "description": "ID of the promotion code to create a new discount for.", "maxLength": 5000, "type": "string" } }, "title": "discounts_data_param", "type": "object", "x-stripeMostCommon": [ "coupon" ] }, "type": "array" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "period": { "description": "The period associated with this invoice item. If not set, `period.start.type` defaults to `max_item_period_start` and `period.end.type` defaults to `min_item_period_end`.", "properties": { "end": { "description": "End of the invoice item period.", "properties": { "timestamp": { "description": "A precise Unix timestamp for the end of the invoice item period. Must be greater than or equal to `period.start`.", "format": "unix-time", "type": "integer" }, "type": { "description": "Select how to calculate the end of the invoice item period.", "enum": [ "min_item_period_end", "phase_end", "timestamp" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "invoice_item_period_end", "type": "object", "x-stripeMostCommon": [ "timestamp", "type" ] }, "start": { "description": "Start of the invoice item period.", "properties": { "timestamp": { "description": "A precise Unix timestamp for the start of the invoice item period. Must be less than or equal to `period.end`.", "format": "unix-time", "type": "integer" }, "type": { "description": "Select how to calculate the start of the invoice item period.", "enum": [ "max_item_period_start", "phase_start", "timestamp" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "invoice_item_period_start", "type": "object", "x-stripeMostCommon": [ "timestamp", "type" ] } }, "required": [ "end", "start" ], "title": "invoice_item_period", "type": "object", "x-stripeMostCommon": [ "end", "start" ] }, "price": { "description": "The ID of the price object. One of `price` or `price_data` is required.", "maxLength": 5000, "type": "string" }, "price_data": { "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.", "properties": { "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "product": { "description": "The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.", "maxLength": 5000, "type": "string" }, "tax_behavior": { "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.", "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" }, "unit_amount": { "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge or a negative integer representing the amount to credit to the customer.", "type": "integer" }, "unit_amount_decimal": { "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", "format": "decimal", "type": "string" } }, "required": [ "currency", "product" ], "title": "one_time_price_data_with_negative_amounts", "type": "object", "x-stripeMostCommon": [ "currency", "product", "unit_amount" ] }, "quantity": { "description": "Quantity for this item. Defaults to 1.", "type": "integer" }, "tax_rates": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The tax rates which apply to the item. When set, the `default_tax_rates` do not apply to this item." } }, "title": "add_invoice_item_entry", "type": "object", "x-stripeMostCommon": [ "price", "quantity" ], "x-stripeParam": { "class_name": "AddInvoiceItem" } }, "type": "array" }, "application_fee_percent": { "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).", "type": "number" }, "automatic_tax": { "description": "Automatic tax settings for this phase.", "properties": { "enabled": { "description": "Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription.", "type": "boolean" }, "liability": { "description": "The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.", "properties": { "account": { "description": "The connected account being referenced when `type` is `account`.", "type": "string" }, "type": { "description": "Type of the account referenced in the request.", "enum": [ "account", "self" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "param", "type": "object", "x-stripeMostCommon": [ "account", "type" ] } }, "required": [ "enabled" ], "title": "automatic_tax_config", "type": "object", "x-stripeMostCommon": [ "enabled", "liability" ] }, "billing_cycle_anchor": { "description": "Can be set to `phase_start` to set the anchor to the start of the phase or `automatic` to automatically change it if needed. Cannot be set to `phase_start` if this phase specifies a trial. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).", "enum": [ "automatic", "phase_start" ], "type": "string" }, "billing_thresholds": { "anyOf": [ { "properties": { "amount_gte": { "description": "Monetary threshold that triggers the subscription to advance to a new billing period", "type": "integer" }, "reset_billing_cycle_anchor": { "description": "Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged.", "type": "boolean" } }, "title": "billing_thresholds_param", "type": "object", "x-stripeMostCommon": [ "amount_gte", "reset_billing_cycle_anchor" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds." }, "collection_method": { "description": "Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically` on creation.", "enum": [ "charge_automatically", "send_invoice" ], "type": "string" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "default_payment_method": { "description": "ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings.", "maxLength": 5000, "type": "string" }, "default_tax_rates": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will set the Subscription's [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates), which means they will be the Invoice's [`default_tax_rates`](https://stripe.com/docs/api/invoices/create#create_invoice-default_tax_rates) for any Invoices issued by the Subscription during this Phase." }, "description": { "anyOf": [ { "maxLength": 500, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs." }, "discounts": { "anyOf": [ { "items": { "properties": { "coupon": { "description": "ID of the coupon to create a new discount for.", "maxLength": 5000, "type": "string" }, "discount": { "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", "maxLength": 5000, "type": "string" }, "discount_end": { "description": "Details to determine how long the discount should be applied for.", "properties": { "duration": { "description": "Time span for the redeemed discount.", "properties": { "interval": { "description": "Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.", "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "description": "The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.", "type": "integer" } }, "required": [ "interval", "interval_count" ], "title": "discount_end_duration_specs", "type": "object", "x-stripeMostCommon": [ "interval", "interval_count" ] }, "timestamp": { "description": "A precise Unix timestamp for the discount to end. Must be in the future.", "format": "unix-time", "type": "integer" }, "type": { "description": "The type of calculation made to determine when the discount ends.", "enum": [ "duration", "timestamp" ], "type": "string" } }, "required": [ "type" ], "title": "discount_end", "type": "object", "x-stripeMostCommon": [ "duration", "timestamp", "type" ] }, "promotion_code": { "description": "ID of the promotion code to create a new discount for.", "maxLength": 5000, "type": "string" } }, "title": "discounts_data_param", "type": "object", "x-stripeMostCommon": [ "coupon" ] }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The coupons to redeem into discounts for the schedule phase. If not specified, inherits the discount from the subscription's customer. Pass an empty string to avoid inheriting any discounts." }, "duration": { "description": "The number of intervals the phase should last. If set, `end_date` must not be set.", "properties": { "interval": { "description": "Specifies phase duration. Either `day`, `week`, `month` or `year`.", "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "description": "The multiplier applied to the interval.", "type": "integer" } }, "required": [ "interval" ], "title": "duration_params", "type": "object", "x-stripeMostCommon": [ "interval", "interval_count" ] }, "end_date": { "description": "The date at which this phase of the subscription schedule ends. If set, `iterations` must not be set.", "format": "unix-time", "type": "integer" }, "invoice_settings": { "description": "All invoices will be billed using the specified settings.", "properties": { "account_tax_ids": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule." }, "days_until_due": { "description": "Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`.", "type": "integer" }, "issuer": { "description": "The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.", "properties": { "account": { "description": "The connected account being referenced when `type` is `account`.", "type": "string" }, "type": { "description": "Type of the account referenced in the request.", "enum": [ "account", "self" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "param", "type": "object", "x-stripeMostCommon": [ "account", "type" ] } }, "title": "invoice_settings", "type": "object", "x-stripeMostCommon": [ "account_tax_ids", "custom_fields", "days_until_due", "description", "footer", "issuer", "send_hosted_payment_email", "supported_payment_methods" ] }, "items": { "description": "List of configuration items, each with an attached price, to apply during this phase of the subscription schedule.", "items": { "properties": { "billing_thresholds": { "anyOf": [ { "properties": { "usage_gte": { "description": "Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte))", "type": "integer" } }, "required": [ "usage_gte" ], "title": "item_billing_thresholds_param", "type": "object", "x-stripeMostCommon": [ "usage_gte" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds." }, "discounts": { "anyOf": [ { "items": { "properties": { "coupon": { "description": "ID of the coupon to create a new discount for.", "maxLength": 5000, "type": "string" }, "discount": { "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", "maxLength": 5000, "type": "string" }, "discount_end": { "description": "Details to determine how long the discount should be applied for.", "properties": { "duration": { "description": "Time span for the redeemed discount.", "properties": { "interval": { "description": "Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.", "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "description": "The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.", "type": "integer" } }, "required": [ "interval", "interval_count" ], "title": "discount_end_duration_specs", "type": "object", "x-stripeMostCommon": [ "interval", "interval_count" ] }, "timestamp": { "description": "A precise Unix timestamp for the discount to end. Must be in the future.", "format": "unix-time", "type": "integer" }, "type": { "description": "The type of calculation made to determine when the discount ends.", "enum": [ "duration", "timestamp" ], "type": "string" } }, "required": [ "type" ], "title": "discount_end", "type": "object", "x-stripeMostCommon": [ "duration", "timestamp", "type" ] }, "promotion_code": { "description": "ID of the promotion code to create a new discount for.", "maxLength": 5000, "type": "string" } }, "title": "discounts_data_param", "type": "object", "x-stripeMostCommon": [ "coupon" ] }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The coupons to redeem into discounts for the subscription item." }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a configuration item. Metadata on a configuration item will update the underlying subscription item's `metadata` when the phase is entered, adding new keys and replacing existing keys. Individual keys in the subscription item's `metadata` can be unset by posting an empty value to them in the configuration item's `metadata`. To unset all keys in the subscription item's `metadata`, update the subscription item directly or unset every key individually from the configuration item's `metadata`.", "type": "object" }, "plan": { "description": "The plan ID to subscribe to. You may specify the same ID in `plan` and `price`.", "maxLength": 5000, "type": "string" }, "price": { "description": "The ID of the price object.", "maxLength": 5000, "type": "string" }, "price_data": { "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.", "properties": { "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "product": { "description": "The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.", "maxLength": 5000, "type": "string" }, "recurring": { "description": "The recurring components of a price such as `interval` and `interval_count`.", "properties": { "interval": { "description": "Specifies billing frequency. Either `day`, `week`, `month` or `year`.", "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "description": "The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).", "type": "integer" } }, "required": [ "interval" ], "title": "recurring_adhoc", "type": "object", "x-stripeMostCommon": [ "interval" ] }, "tax_behavior": { "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.", "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" }, "unit_amount": { "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.", "type": "integer" }, "unit_amount_decimal": { "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", "format": "decimal", "type": "string" } }, "required": [ "currency", "product", "recurring" ], "title": "recurring_price_data", "type": "object", "x-stripeMostCommon": [ "currency", "product", "recurring", "unit_amount" ] }, "quantity": { "description": "Quantity for the given price. Can be set only if the price's `usage_type` is `licensed` and not `metered`.", "type": "integer" }, "tax_rates": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates." }, "trial": { "description": "Options that configure the trial on the subscription item.", "properties": { "converts_to": { "description": "List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. Currently only supports at most 1 price ID.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "type": { "description": "Determines the type of trial for this item.", "enum": [ "free", "paid" ], "type": "string" } }, "required": [ "type" ], "title": "trial_specs", "type": "object", "x-stripeMostCommon": [ "converts_to", "type" ] } }, "title": "configuration_item_params", "type": "object", "x-stripeMostCommon": [ "billing_thresholds", "current_trial", "discounts", "metadata", "plan", "price", "quantity", "tax_rates", "trial" ] }, "type": "array" }, "iterations": { "description": "Integer representing the multiplier applied to the price interval. For example, `iterations=2` applied to a price with `interval=month` and `interval_count=3` results in a phase of duration `2 * 3 months = 6 months`. If set, `end_date` must not be set. This parameter is deprecated and will be removed in a future version. Use `duration` instead.", "type": "integer" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a phase. Metadata on a schedule's phase will update the underlying subscription's `metadata` when the phase is entered, adding new keys and replacing existing keys in the subscription's `metadata`. Individual keys in the subscription's `metadata` can be unset by posting an empty value to them in the phase's `metadata`. To unset all keys in the subscription's `metadata`, update the subscription directly or unset every key individually from the phase's `metadata`.", "type": "object" }, "on_behalf_of": { "description": "The account on behalf of which to charge, for each of the associated subscription's invoices.", "type": "string" }, "pause_collection": { "description": "If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://stripe.com/docs/billing/subscriptions/pause-payment).", "properties": { "behavior": { "description": "The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.", "enum": [ "keep_as_draft", "mark_uncollectible", "void" ], "type": "string" } }, "required": [ "behavior" ], "title": "pause_collection_params", "type": "object", "x-stripeMostCommon": [ "behavior" ] }, "proration_behavior": { "description": "Controls whether the subscription schedule should create [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when transitioning to this phase if there is a difference in billing configuration. It's different from the request-level [proration_behavior](https://stripe.com/docs/api/subscription_schedules/update#update_subscription_schedule-proration_behavior) parameter which controls what happens if the update request affects the billing configuration (item price, quantity, etc.) of the current phase.", "enum": [ "always_invoice", "create_prorations", "none" ], "type": "string" }, "transfer_data": { "description": "The data with which to automatically create a Transfer for each of the associated subscription's invoices.", "properties": { "amount_percent": { "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination.", "type": "number" }, "destination": { "description": "ID of an existing, connected Stripe account.", "type": "string" } }, "required": [ "destination" ], "title": "transfer_data_specs", "type": "object", "x-stripeMostCommon": [ "amount_percent", "destination" ] }, "trial": { "description": "If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.", "type": "boolean" }, "trial_continuation": { "description": "Specify trial behavior when crossing phase boundaries", "enum": [ "continue", "none" ], "type": "string" }, "trial_end": { "description": "Sets the phase to trialing from the start date to this date. Must be before the phase end date, can not be combined with `trial`", "format": "unix-time", "type": "integer" }, "trial_settings": { "description": "Settings related to subscription trials.", "properties": { "end_behavior": { "description": "Defines how the subscription should behave when a trial ends.", "properties": { "prorate_up_front": { "description": "Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.", "enum": [ "defer", "include" ], "type": "string" } }, "title": "end_behavior_specs", "type": "object", "x-stripeMostCommon": [ "prorate_up_front" ] } }, "title": "trial_settings_specs", "type": "object", "x-stripeMostCommon": [ "end_behavior" ] } }, "required": [ "items" ], "title": "phase_configuration_params", "type": "object", "x-stripeMostCommon": [ "add_invoice_items", "application_fee_percent", "automatic_tax", "billing_cycle_anchor", "billing_thresholds", "cancel_at_period_end", "collection_method", "currency", "default_payment_method", "default_tax_rates", "description", "discounts", "duration", "end_date", "invoice_settings", "items", "iterations", "metadata", "on_behalf_of", "pause_collection", "proration_behavior", "tax_filing_currency", "transfer_data", "trial", "trial_continuation", "trial_end", "trial_settings" ] }, "type": "array" }, "prebilling": { "description": "If specified, the invoicing for the given billing cycle iterations will be processed now.", "properties": { "iterations": { "description": "This is used to determine the number of billing cycles to prebill.", "type": "integer" }, "update_behavior": { "description": "Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period. The default value is `reset`.", "enum": [ "prebill", "reset" ], "type": "string" } }, "required": [ "iterations" ], "title": "prebilling_specs", "type": "object", "x-stripeMostCommon": [ "iterations", "update_behavior" ] }, "start_date": { "anyOf": [ { "format": "unix-time", "type": "integer" }, { "enum": [ "now" ], "maxLength": 5000, "type": "string" } ], "description": "When the subscription schedule starts. We recommend using `now` so that it starts the subscription immediately. You can also use a Unix timestamp to backdate the subscription so that it starts on a past date, or set a future date for the subscription to start on." } }, "type": "object", "x-stripeMostCommon": [ "customer", "metadata", "phases", "start_date" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/subscription_schedule" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a schedule" } }, "/v1/subscription_schedules/{schedule}": { "get": { "description": "

Retrieves the details of an existing subscription schedule. You only need to supply the unique subscription schedule identifier that was returned upon subscription schedule creation.

", "operationId": "GetSubscriptionSchedulesSchedule", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "schedule", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/subscription_schedule" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a schedule" }, "post": { "description": "

Updates an existing subscription schedule.

", "operationId": "PostSubscriptionSchedulesSchedule", "parameters": [ { "in": "path", "name": "schedule", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "default_settings": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "phases": { "explode": true, "style": "deepObject" }, "prebilling": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "billing_behavior": { "description": "Configures when the subscription schedule generates prorations for phase transitions. Possible values are `prorate_on_next_phase` or `prorate_up_front` with the default being `prorate_on_next_phase`. `prorate_on_next_phase` will apply phase changes and generate prorations at transition time. `prorate_up_front` will bill for all phases within the current billing cycle up front.", "enum": [ "prorate_on_next_phase", "prorate_up_front" ], "type": "string" }, "default_settings": { "description": "Object representing the subscription schedule's default settings.", "properties": { "application_fee_percent": { "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).", "type": "number" }, "automatic_tax": { "description": "Default settings for automatic tax computation.", "properties": { "enabled": { "description": "Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription.", "type": "boolean" }, "liability": { "description": "The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.", "properties": { "account": { "description": "The connected account being referenced when `type` is `account`.", "type": "string" }, "type": { "description": "Type of the account referenced in the request.", "enum": [ "account", "self" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "param", "type": "object", "x-stripeMostCommon": [ "account", "type" ] } }, "required": [ "enabled" ], "title": "automatic_tax_config", "type": "object", "x-stripeMostCommon": [ "enabled", "liability" ] }, "billing_cycle_anchor": { "description": "Can be set to `phase_start` to set the anchor to the start of the phase or `automatic` to automatically change it if needed. Cannot be set to `phase_start` if this phase specifies a trial. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).", "enum": [ "automatic", "phase_start" ], "type": "string" }, "billing_thresholds": { "anyOf": [ { "properties": { "amount_gte": { "description": "Monetary threshold that triggers the subscription to advance to a new billing period", "type": "integer" }, "reset_billing_cycle_anchor": { "description": "Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged.", "type": "boolean" } }, "title": "billing_thresholds_param", "type": "object", "x-stripeMostCommon": [ "amount_gte", "reset_billing_cycle_anchor" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds." }, "collection_method": { "description": "Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically` on creation.", "enum": [ "charge_automatically", "send_invoice" ], "type": "string" }, "default_payment_method": { "description": "ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings.", "maxLength": 5000, "type": "string" }, "description": { "anyOf": [ { "maxLength": 500, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs." }, "invoice_settings": { "description": "All invoices will be billed using the specified settings.", "properties": { "account_tax_ids": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The account tax IDs associated with the subscription schedule. Will be set on invoices generated by the subscription schedule." }, "days_until_due": { "description": "Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `collection_method=charge_automatically`.", "type": "integer" }, "issuer": { "description": "The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.", "properties": { "account": { "description": "The connected account being referenced when `type` is `account`.", "type": "string" }, "type": { "description": "Type of the account referenced in the request.", "enum": [ "account", "self" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "param", "type": "object", "x-stripeMostCommon": [ "account", "type" ] } }, "title": "subscription_schedule_default_settings_param", "type": "object", "x-stripeMostCommon": [ "account_tax_ids", "custom_fields", "days_until_due", "description", "footer", "issuer", "rendering", "send_hosted_payment_email", "supported_payment_methods" ] }, "on_behalf_of": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "The account on behalf of which to charge, for each of the associated subscription's invoices." }, "transfer_data": { "anyOf": [ { "properties": { "amount_percent": { "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination.", "type": "number" }, "destination": { "description": "ID of an existing, connected Stripe account.", "type": "string" } }, "required": [ "destination" ], "title": "transfer_data_specs", "type": "object", "x-stripeMostCommon": [ "amount_percent", "destination" ] }, { "enum": [ "" ], "type": "string" } ], "description": "The data with which to automatically create a Transfer for each of the associated subscription's invoices." } }, "title": "default_settings_params", "type": "object", "x-stripeMostCommon": [ "application_fee_percent", "automatic_tax", "billing_cycle_anchor", "billing_thresholds", "collection_method", "default_payment_method", "description", "invoice_settings", "on_behalf_of", "transfer_data" ] }, "end_behavior": { "description": "Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running. `cancel` will end the subscription schedule and cancel the underlying subscription.", "enum": [ "cancel", "none", "release", "renew" ], "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "phases": { "description": "List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the `end_date` of one phase will always equal the `start_date` of the next phase. Note that past phases can be omitted.", "items": { "properties": { "add_invoice_items": { "description": "A list of prices and quantities that will generate invoice items appended to the next invoice for this phase. You may pass up to 20 items.", "items": { "properties": { "discounts": { "description": "The coupons to redeem into discounts for the item.", "items": { "properties": { "coupon": { "description": "ID of the coupon to create a new discount for.", "maxLength": 5000, "type": "string" }, "discount": { "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", "maxLength": 5000, "type": "string" }, "discount_end": { "description": "Details to determine how long the discount should be applied for.", "properties": { "duration": { "description": "Time span for the redeemed discount.", "properties": { "interval": { "description": "Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.", "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "description": "The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.", "type": "integer" } }, "required": [ "interval", "interval_count" ], "title": "discount_end_duration_specs", "type": "object", "x-stripeMostCommon": [ "interval", "interval_count" ] }, "timestamp": { "description": "A precise Unix timestamp for the discount to end. Must be in the future.", "format": "unix-time", "type": "integer" }, "type": { "description": "The type of calculation made to determine when the discount ends.", "enum": [ "duration", "timestamp" ], "type": "string" } }, "required": [ "type" ], "title": "discount_end", "type": "object", "x-stripeMostCommon": [ "duration", "timestamp", "type" ] }, "promotion_code": { "description": "ID of the promotion code to create a new discount for.", "maxLength": 5000, "type": "string" } }, "title": "discounts_data_param", "type": "object", "x-stripeMostCommon": [ "coupon" ] }, "type": "array" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "period": { "description": "The period associated with this invoice item. If not set, `period.start.type` defaults to `max_item_period_start` and `period.end.type` defaults to `min_item_period_end`.", "properties": { "end": { "description": "End of the invoice item period.", "properties": { "timestamp": { "description": "A precise Unix timestamp for the end of the invoice item period. Must be greater than or equal to `period.start`.", "format": "unix-time", "type": "integer" }, "type": { "description": "Select how to calculate the end of the invoice item period.", "enum": [ "min_item_period_end", "phase_end", "timestamp" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "invoice_item_period_end", "type": "object", "x-stripeMostCommon": [ "timestamp", "type" ] }, "start": { "description": "Start of the invoice item period.", "properties": { "timestamp": { "description": "A precise Unix timestamp for the start of the invoice item period. Must be less than or equal to `period.end`.", "format": "unix-time", "type": "integer" }, "type": { "description": "Select how to calculate the start of the invoice item period.", "enum": [ "max_item_period_start", "phase_start", "timestamp" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "invoice_item_period_start", "type": "object", "x-stripeMostCommon": [ "timestamp", "type" ] } }, "required": [ "end", "start" ], "title": "invoice_item_period", "type": "object", "x-stripeMostCommon": [ "end", "start" ] }, "price": { "description": "The ID of the price object. One of `price` or `price_data` is required.", "maxLength": 5000, "type": "string" }, "price_data": { "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.", "properties": { "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "product": { "description": "The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.", "maxLength": 5000, "type": "string" }, "tax_behavior": { "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.", "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" }, "unit_amount": { "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge or a negative integer representing the amount to credit to the customer.", "type": "integer" }, "unit_amount_decimal": { "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", "format": "decimal", "type": "string" } }, "required": [ "currency", "product" ], "title": "one_time_price_data_with_negative_amounts", "type": "object", "x-stripeMostCommon": [ "currency", "product", "unit_amount" ] }, "quantity": { "description": "Quantity for this item. Defaults to 1.", "type": "integer" }, "tax_rates": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The tax rates which apply to the item. When set, the `default_tax_rates` do not apply to this item." } }, "title": "add_invoice_item_entry", "type": "object", "x-stripeMostCommon": [ "price", "quantity" ], "x-stripeParam": { "class_name": "AddInvoiceItem" } }, "type": "array" }, "application_fee_percent": { "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).", "type": "number" }, "automatic_tax": { "description": "Automatic tax settings for this phase.", "properties": { "enabled": { "description": "Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription.", "type": "boolean" }, "liability": { "description": "The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.", "properties": { "account": { "description": "The connected account being referenced when `type` is `account`.", "type": "string" }, "type": { "description": "Type of the account referenced in the request.", "enum": [ "account", "self" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "param", "type": "object", "x-stripeMostCommon": [ "account", "type" ] } }, "required": [ "enabled" ], "title": "automatic_tax_config", "type": "object", "x-stripeMostCommon": [ "enabled", "liability" ] }, "billing_cycle_anchor": { "description": "Can be set to `phase_start` to set the anchor to the start of the phase or `automatic` to automatically change it if needed. Cannot be set to `phase_start` if this phase specifies a trial. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).", "enum": [ "automatic", "phase_start" ], "type": "string" }, "billing_thresholds": { "anyOf": [ { "properties": { "amount_gte": { "description": "Monetary threshold that triggers the subscription to advance to a new billing period", "type": "integer" }, "reset_billing_cycle_anchor": { "description": "Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged.", "type": "boolean" } }, "title": "billing_thresholds_param", "type": "object", "x-stripeMostCommon": [ "amount_gte", "reset_billing_cycle_anchor" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds." }, "collection_method": { "description": "Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically` on creation.", "enum": [ "charge_automatically", "send_invoice" ], "type": "string" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "default_payment_method": { "description": "ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings.", "maxLength": 5000, "type": "string" }, "default_tax_rates": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will set the Subscription's [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates), which means they will be the Invoice's [`default_tax_rates`](https://stripe.com/docs/api/invoices/create#create_invoice-default_tax_rates) for any Invoices issued by the Subscription during this Phase." }, "description": { "anyOf": [ { "maxLength": 500, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs." }, "discounts": { "anyOf": [ { "items": { "properties": { "coupon": { "description": "ID of the coupon to create a new discount for.", "maxLength": 5000, "type": "string" }, "discount": { "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", "maxLength": 5000, "type": "string" }, "discount_end": { "description": "Details to determine how long the discount should be applied for.", "properties": { "duration": { "description": "Time span for the redeemed discount.", "properties": { "interval": { "description": "Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.", "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "description": "The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.", "type": "integer" } }, "required": [ "interval", "interval_count" ], "title": "discount_end_duration_specs", "type": "object", "x-stripeMostCommon": [ "interval", "interval_count" ] }, "timestamp": { "description": "A precise Unix timestamp for the discount to end. Must be in the future.", "format": "unix-time", "type": "integer" }, "type": { "description": "The type of calculation made to determine when the discount ends.", "enum": [ "duration", "timestamp" ], "type": "string" } }, "required": [ "type" ], "title": "discount_end", "type": "object", "x-stripeMostCommon": [ "duration", "timestamp", "type" ] }, "promotion_code": { "description": "ID of the promotion code to create a new discount for.", "maxLength": 5000, "type": "string" } }, "title": "discounts_data_param", "type": "object", "x-stripeMostCommon": [ "coupon" ] }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The coupons to redeem into discounts for the schedule phase. If not specified, inherits the discount from the subscription's customer. Pass an empty string to avoid inheriting any discounts." }, "duration": { "description": "The number of intervals the phase should last. If set, `end_date` must not be set.", "properties": { "interval": { "description": "Specifies phase duration. Either `day`, `week`, `month` or `year`.", "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "description": "The multiplier applied to the interval.", "type": "integer" } }, "required": [ "interval" ], "title": "duration_params", "type": "object", "x-stripeMostCommon": [ "interval", "interval_count" ] }, "end_date": { "anyOf": [ { "format": "unix-time", "type": "integer" }, { "enum": [ "now" ], "maxLength": 5000, "type": "string" } ], "description": "The date at which this phase of the subscription schedule ends. If set, `iterations` must not be set." }, "invoice_settings": { "description": "All invoices will be billed using the specified settings.", "properties": { "account_tax_ids": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule." }, "days_until_due": { "description": "Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`.", "type": "integer" }, "issuer": { "description": "The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.", "properties": { "account": { "description": "The connected account being referenced when `type` is `account`.", "type": "string" }, "type": { "description": "Type of the account referenced in the request.", "enum": [ "account", "self" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "param", "type": "object", "x-stripeMostCommon": [ "account", "type" ] } }, "title": "invoice_settings", "type": "object", "x-stripeMostCommon": [ "account_tax_ids", "custom_fields", "days_until_due", "description", "footer", "issuer", "send_hosted_payment_email", "supported_payment_methods" ] }, "items": { "description": "List of configuration items, each with an attached price, to apply during this phase of the subscription schedule.", "items": { "properties": { "billing_thresholds": { "anyOf": [ { "properties": { "usage_gte": { "description": "Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte))", "type": "integer" } }, "required": [ "usage_gte" ], "title": "item_billing_thresholds_param", "type": "object", "x-stripeMostCommon": [ "usage_gte" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds." }, "discounts": { "anyOf": [ { "items": { "properties": { "coupon": { "description": "ID of the coupon to create a new discount for.", "maxLength": 5000, "type": "string" }, "discount": { "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", "maxLength": 5000, "type": "string" }, "discount_end": { "description": "Details to determine how long the discount should be applied for.", "properties": { "duration": { "description": "Time span for the redeemed discount.", "properties": { "interval": { "description": "Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.", "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "description": "The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.", "type": "integer" } }, "required": [ "interval", "interval_count" ], "title": "discount_end_duration_specs", "type": "object", "x-stripeMostCommon": [ "interval", "interval_count" ] }, "timestamp": { "description": "A precise Unix timestamp for the discount to end. Must be in the future.", "format": "unix-time", "type": "integer" }, "type": { "description": "The type of calculation made to determine when the discount ends.", "enum": [ "duration", "timestamp" ], "type": "string" } }, "required": [ "type" ], "title": "discount_end", "type": "object", "x-stripeMostCommon": [ "duration", "timestamp", "type" ] }, "promotion_code": { "description": "ID of the promotion code to create a new discount for.", "maxLength": 5000, "type": "string" } }, "title": "discounts_data_param", "type": "object", "x-stripeMostCommon": [ "coupon" ] }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The coupons to redeem into discounts for the subscription item." }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a configuration item. Metadata on a configuration item will update the underlying subscription item's `metadata` when the phase is entered, adding new keys and replacing existing keys. Individual keys in the subscription item's `metadata` can be unset by posting an empty value to them in the configuration item's `metadata`. To unset all keys in the subscription item's `metadata`, update the subscription item directly or unset every key individually from the configuration item's `metadata`.", "type": "object" }, "plan": { "description": "The plan ID to subscribe to. You may specify the same ID in `plan` and `price`.", "maxLength": 5000, "type": "string" }, "price": { "description": "The ID of the price object.", "maxLength": 5000, "type": "string" }, "price_data": { "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.", "properties": { "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "product": { "description": "The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.", "maxLength": 5000, "type": "string" }, "recurring": { "description": "The recurring components of a price such as `interval` and `interval_count`.", "properties": { "interval": { "description": "Specifies billing frequency. Either `day`, `week`, `month` or `year`.", "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "description": "The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).", "type": "integer" } }, "required": [ "interval" ], "title": "recurring_adhoc", "type": "object", "x-stripeMostCommon": [ "interval" ] }, "tax_behavior": { "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.", "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" }, "unit_amount": { "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.", "type": "integer" }, "unit_amount_decimal": { "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", "format": "decimal", "type": "string" } }, "required": [ "currency", "product", "recurring" ], "title": "recurring_price_data", "type": "object", "x-stripeMostCommon": [ "currency", "product", "recurring", "unit_amount" ] }, "quantity": { "description": "Quantity for the given price. Can be set only if the price's `usage_type` is `licensed` and not `metered`.", "type": "integer" }, "tax_rates": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates." }, "trial": { "description": "Options that configure the trial on the subscription item.", "properties": { "converts_to": { "description": "List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. Currently only supports at most 1 price ID.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "type": { "description": "Determines the type of trial for this item.", "enum": [ "free", "paid" ], "type": "string" } }, "required": [ "type" ], "title": "trial_specs", "type": "object", "x-stripeMostCommon": [ "converts_to", "type" ] } }, "title": "configuration_item_params", "type": "object", "x-stripeMostCommon": [ "billing_thresholds", "current_trial", "discounts", "metadata", "plan", "price", "quantity", "tax_rates", "trial" ] }, "type": "array" }, "iterations": { "description": "Integer representing the multiplier applied to the price interval. For example, `iterations=2` applied to a price with `interval=month` and `interval_count=3` results in a phase of duration `2 * 3 months = 6 months`. If set, `end_date` must not be set. This parameter is deprecated and will be removed in a future version. Use `duration` instead.", "type": "integer" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a phase. Metadata on a schedule's phase will update the underlying subscription's `metadata` when the phase is entered, adding new keys and replacing existing keys in the subscription's `metadata`. Individual keys in the subscription's `metadata` can be unset by posting an empty value to them in the phase's `metadata`. To unset all keys in the subscription's `metadata`, update the subscription directly or unset every key individually from the phase's `metadata`.", "type": "object" }, "on_behalf_of": { "description": "The account on behalf of which to charge, for each of the associated subscription's invoices.", "type": "string" }, "pause_collection": { "description": "If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://stripe.com/docs/billing/subscriptions/pause-payment).", "properties": { "behavior": { "description": "The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.", "enum": [ "keep_as_draft", "mark_uncollectible", "void" ], "type": "string" } }, "required": [ "behavior" ], "title": "pause_collection_params", "type": "object", "x-stripeMostCommon": [ "behavior" ] }, "proration_behavior": { "description": "Controls whether the subscription schedule should create [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when transitioning to this phase if there is a difference in billing configuration. It's different from the request-level [proration_behavior](https://stripe.com/docs/api/subscription_schedules/update#update_subscription_schedule-proration_behavior) parameter which controls what happens if the update request affects the billing configuration (item price, quantity, etc.) of the current phase.", "enum": [ "always_invoice", "create_prorations", "none" ], "type": "string" }, "start_date": { "anyOf": [ { "format": "unix-time", "type": "integer" }, { "enum": [ "now" ], "maxLength": 5000, "type": "string" } ], "description": "The date at which this phase of the subscription schedule starts or `now`. Must be set on the first phase." }, "transfer_data": { "description": "The data with which to automatically create a Transfer for each of the associated subscription's invoices.", "properties": { "amount_percent": { "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination.", "type": "number" }, "destination": { "description": "ID of an existing, connected Stripe account.", "type": "string" } }, "required": [ "destination" ], "title": "transfer_data_specs", "type": "object", "x-stripeMostCommon": [ "amount_percent", "destination" ] }, "trial": { "description": "If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.", "type": "boolean" }, "trial_continuation": { "description": "Specify trial behavior when crossing phase boundaries", "enum": [ "continue", "none" ], "type": "string" }, "trial_end": { "anyOf": [ { "format": "unix-time", "type": "integer" }, { "enum": [ "now" ], "maxLength": 5000, "type": "string" } ], "description": "Sets the phase to trialing from the start date to this date. Must be before the phase end date, can not be combined with `trial`" }, "trial_settings": { "description": "Settings related to subscription trials.", "properties": { "end_behavior": { "description": "Defines how the subscription should behave when a trial ends.", "properties": { "prorate_up_front": { "description": "Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.", "enum": [ "defer", "include" ], "type": "string" } }, "title": "end_behavior_specs", "type": "object", "x-stripeMostCommon": [ "prorate_up_front" ] } }, "title": "trial_settings_specs", "type": "object", "x-stripeMostCommon": [ "end_behavior" ] } }, "required": [ "items" ], "title": "phase_configuration_params", "type": "object", "x-stripeMostCommon": [ "add_invoice_items", "application_fee_percent", "automatic_tax", "billing_cycle_anchor", "billing_thresholds", "collection_method", "currency", "default_payment_method", "default_tax_rates", "description", "discounts", "duration", "end_date", "invoice_settings", "items", "iterations", "metadata", "on_behalf_of", "pause_collection", "proration_behavior", "start_date", "tax_filing_currency", "transfer_data", "trial", "trial_continuation", "trial_end", "trial_settings" ] }, "type": "array" }, "prebilling": { "description": "If specified, the invoicing for the given billing cycle iterations will be processed now.", "properties": { "iterations": { "description": "This is used to determine the number of billing cycles to prebill.", "type": "integer" }, "update_behavior": { "description": "Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period. The default value is `reset`.", "enum": [ "prebill", "reset" ], "type": "string" } }, "required": [ "iterations" ], "title": "prebilling_specs", "type": "object", "x-stripeMostCommon": [ "iterations", "update_behavior" ] }, "proration_behavior": { "description": "If the update changes the billing configuration (item price, quantity, etc.) of the current phase, indicates how prorations from this change should be handled. The default value is `create_prorations`.", "enum": [ "always_invoice", "create_prorations", "none" ], "type": "string" } }, "type": "object", "x-stripeMostCommon": [ "metadata", "phases", "proration_behavior" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/subscription_schedule" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a schedule" } }, "/v1/subscription_schedules/{schedule}/amend": { "post": { "description": "

Amends an existing subscription schedule.

", "operationId": "PostSubscriptionSchedulesScheduleAmend", "parameters": [ { "in": "path", "name": "schedule", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "amendments": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "prebilling": { "explode": true, "style": "deepObject" }, "schedule_settings": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "amendments": { "description": "Changes to apply to the phases of the subscription schedule, in the order provided.", "items": { "properties": { "amendment_end": { "description": "Details to identify the end of the time range modified by the proposed change. If not supplied, the amendment is considered a point-in-time operation that only affects the exact timestamp at `amendment_start`, and a restricted set of attributes is supported on the amendment.", "properties": { "discount_end": { "description": "Use the `end` time of a given discount.", "properties": { "discount": { "description": "The ID of a specific discount.", "maxLength": 5000, "type": "string" } }, "required": [ "discount" ], "title": "discount_end_specs", "type": "object", "x-stripeMostCommon": [ "discount" ] }, "duration": { "description": "Time span for the amendment starting from the `amendment_start`.", "properties": { "interval": { "description": "Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.", "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "description": "The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.", "type": "integer" } }, "required": [ "interval", "interval_count" ], "title": "duration_specs", "type": "object", "x-stripeMostCommon": [ "interval", "interval_count" ] }, "timestamp": { "description": "A precise Unix timestamp for the amendment to end. Must be after the `amendment_start`.", "format": "unix-time", "type": "integer" }, "type": { "description": "Select one of three ways to pass the `amendment_end`.", "enum": [ "discount_end", "duration", "schedule_end", "timestamp", "trial_end", "trial_start", "upcoming_invoice" ], "type": "string" } }, "required": [ "type" ], "title": "specs", "type": "object", "x-stripeMostCommon": [ "discount_end", "duration", "timestamp", "type" ] }, "amendment_start": { "description": "Details to identify the earliest timestamp where the proposed change should take effect.", "properties": { "amendment_end": { "description": "Details of another amendment in the same array, immediately after which this amendment should begin.", "properties": { "index": { "description": "The position of the previous amendment in the `amendments` array after which this amendment should begin. Indexes start from 0 and must be less than the index of the current amendment in the array.", "type": "integer" } }, "required": [ "index" ], "title": "amendment_end_index_specs", "type": "object", "x-stripeMostCommon": [ "index" ] }, "discount_end": { "description": "Use the `end` time of a given discount.", "properties": { "discount": { "description": "The ID of a specific discount.", "maxLength": 5000, "type": "string" } }, "required": [ "discount" ], "title": "discount_end_specs", "type": "object", "x-stripeMostCommon": [ "discount" ] }, "timestamp": { "description": "A precise Unix timestamp for the amendment to start.", "format": "unix-time", "type": "integer" }, "type": { "description": "Select one of three ways to pass the `amendment_start`.", "enum": [ "amendment_end", "discount_end", "now", "schedule_end", "timestamp", "trial_end", "trial_start", "upcoming_invoice" ], "type": "string" } }, "required": [ "type" ], "title": "specs", "type": "object", "x-stripeMostCommon": [ "amendment_end", "discount_end", "timestamp", "type" ] }, "billing_cycle_anchor": { "description": "For point-in-time amendments (having no `amendment_end`), this attribute lets you set or remove whether the subscription's billing cycle anchor is reset at the `amendment_start` timestamp.For time-span based amendments (having both `amendment_start` and `amendment_end`), the only value valid is `automatic`, which removes any previously configured billing cycle anchor resets scheduled to occur during the window of time spanned by the amendment.", "enum": [ "amendment_start", "automatic" ], "type": "string" }, "discount_actions": { "description": "Changes to the coupons being redeemed or discounts being applied during the amendment time span.", "items": { "properties": { "add": { "description": "Details of the discount to add.", "properties": { "coupon": { "description": "The coupon code to redeem.", "maxLength": 5000, "type": "string" }, "discount": { "description": "An ID of an existing discount for a coupon that was already redeemed.", "maxLength": 5000, "type": "string" }, "discount_end": { "description": "Details to determine how long the discount should be applied for.", "properties": { "type": { "description": "The type of calculation made to determine when the discount ends.", "enum": [ "amendment_end" ], "type": "string" } }, "required": [ "type" ], "title": "amendment_discount_end", "type": "object", "x-stripeMostCommon": [ "type" ] }, "index": { "description": "The index, starting at 0, at which to position the new discount. When not supplied, Stripe defaults to appending the discount to the end of the `discounts` array.", "type": "integer" }, "promotion_code": { "description": "The promotion code to redeem.", "maxLength": 5000, "type": "string" } }, "title": "add_discount_specs", "type": "object", "x-stripeMostCommon": [ "coupon", "discount", "discount_end", "index", "promotion_code" ] }, "remove": { "description": "Details of the discount to remove.", "properties": { "coupon": { "description": "The coupon code to remove from the `discounts` array.", "maxLength": 5000, "type": "string" }, "discount": { "description": "The ID of a discount to remove from the `discounts` array.", "maxLength": 5000, "type": "string" }, "promotion_code": { "description": "The ID of a promotion code to remove from the `discounts` array.", "maxLength": 5000, "type": "string" } }, "title": "remove_discount_specs", "type": "object", "x-stripeMostCommon": [ "coupon", "discount", "promotion_code" ] }, "set": { "description": "Details of the discount to replace the existing discounts with.", "properties": { "coupon": { "description": "The coupon code to replace the `discounts` array with.", "maxLength": 5000, "type": "string" }, "discount": { "description": "An ID of an existing discount to replace the `discounts` array with.", "maxLength": 5000, "type": "string" }, "promotion_code": { "description": "An ID of an existing promotion code to replace the `discounts` array with.", "maxLength": 5000, "type": "string" } }, "title": "set_discount_specs", "type": "object", "x-stripeMostCommon": [ "coupon", "discount", "promotion_code" ] }, "type": { "description": "Determines the type of discount action.", "enum": [ "add", "remove", "set" ], "type": "string" } }, "required": [ "type" ], "title": "specs", "type": "object", "x-stripeMostCommon": [ "add", "remove", "set", "type" ] }, "type": "array" }, "item_actions": { "description": "Changes to the subscription items during the amendment time span.", "items": { "properties": { "add": { "description": "Details of the subscription item to add. If an item with the same `price` exists, it will be replaced by this new item. Otherwise, it adds the new item.", "properties": { "discounts": { "description": "The discounts applied to the item. Subscription item discounts are applied before subscription discounts.", "items": { "properties": { "coupon": { "description": "ID of the coupon to create a new discount for.", "maxLength": 5000, "type": "string" }, "discount": { "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", "maxLength": 5000, "type": "string" }, "discount_end": { "description": "Details to determine how long the discount should be applied for.", "properties": { "duration": { "description": "Time span for the redeemed discount.", "properties": { "interval": { "description": "Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.", "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "description": "The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.", "type": "integer" } }, "required": [ "interval", "interval_count" ], "title": "discount_end_duration_specs", "type": "object", "x-stripeMostCommon": [ "interval", "interval_count" ] }, "timestamp": { "description": "A precise Unix timestamp for the discount to end. Must be in the future.", "format": "unix-time", "type": "integer" }, "type": { "description": "The type of calculation made to determine when the discount ends.", "enum": [ "duration", "timestamp" ], "type": "string" } }, "required": [ "type" ], "title": "discount_end", "type": "object", "x-stripeMostCommon": [ "duration", "timestamp", "type" ] }, "promotion_code": { "description": "ID of the promotion code to create a new discount for.", "maxLength": 5000, "type": "string" } }, "title": "discounts_data_param", "type": "object", "x-stripeMostCommon": [ "coupon" ] }, "type": "array" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "price": { "description": "The ID of the price object.", "maxLength": 5000, "type": "string" }, "quantity": { "description": "Quantity for this item.", "type": "integer" }, "tax_rates": { "description": "The tax rates that apply to this subscription item. When set, the `default_tax_rates` on the subscription do not apply to this `subscription_item`.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "trial": { "description": "Options that configure the trial on the subscription item.", "properties": { "converts_to": { "description": "List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. Currently only supports at most 1 price ID.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "type": { "description": "Determines the type of trial for this item.", "enum": [ "free", "paid" ], "type": "string" } }, "required": [ "type" ], "title": "trial_specs", "type": "object", "x-stripeMostCommon": [ "converts_to", "type" ] } }, "required": [ "price" ], "title": "add_item_specs", "type": "object", "x-stripeMostCommon": [ "discounts", "metadata", "price", "quantity", "tax_rates", "trial" ] }, "remove": { "description": "Details of the subscription item to remove.", "properties": { "price": { "description": "ID of a price to remove.", "maxLength": 5000, "type": "string" } }, "required": [ "price" ], "title": "remove_item_specs", "type": "object", "x-stripeMostCommon": [ "price" ] }, "set": { "description": "Details of the subscription item to replace the existing items with. If an item with the `set[price]` already exists, the `items` array is not cleared. Instead, all of the other `set` properties that are passed in this request will replace the existing values for the configuration item.", "properties": { "discounts": { "description": "If an item with the `price` already exists, passing this will override the `discounts` array on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `discounts`.", "items": { "properties": { "coupon": { "description": "ID of the coupon to create a new discount for.", "maxLength": 5000, "type": "string" }, "discount": { "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", "maxLength": 5000, "type": "string" }, "discount_end": { "description": "Details to determine how long the discount should be applied for.", "properties": { "duration": { "description": "Time span for the redeemed discount.", "properties": { "interval": { "description": "Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.", "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "description": "The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.", "type": "integer" } }, "required": [ "interval", "interval_count" ], "title": "discount_end_duration_specs", "type": "object", "x-stripeMostCommon": [ "interval", "interval_count" ] }, "timestamp": { "description": "A precise Unix timestamp for the discount to end. Must be in the future.", "format": "unix-time", "type": "integer" }, "type": { "description": "The type of calculation made to determine when the discount ends.", "enum": [ "duration", "timestamp" ], "type": "string" } }, "required": [ "type" ], "title": "discount_end", "type": "object", "x-stripeMostCommon": [ "duration", "timestamp", "type" ] }, "promotion_code": { "description": "ID of the promotion code to create a new discount for.", "maxLength": 5000, "type": "string" } }, "title": "discounts_data_param", "type": "object", "x-stripeMostCommon": [ "coupon" ] }, "type": "array" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "If an item with the `price` already exists, passing this will override the `metadata` on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `metadata`.", "type": "object" }, "price": { "description": "The ID of the price object.", "maxLength": 5000, "type": "string" }, "quantity": { "description": "If an item with the `price` already exists, passing this will override the quantity on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `quantity`.", "type": "integer" }, "tax_rates": { "description": "If an item with the `price` already exists, passing this will override the `tax_rates` array on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `tax_rates`.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "trial": { "description": "If an item with the `price` already exists, passing this will override the `trial` configuration on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `trial`.", "properties": { "converts_to": { "description": "List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. Currently only supports at most 1 price ID.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "type": { "description": "Determines the type of trial for this item.", "enum": [ "free", "paid" ], "type": "string" } }, "required": [ "type" ], "title": "trial_specs", "type": "object", "x-stripeMostCommon": [ "converts_to", "type" ] } }, "required": [ "price" ], "title": "set_item_specs", "type": "object", "x-stripeMostCommon": [ "discounts", "metadata", "price", "quantity", "tax_rates", "trial" ] }, "type": { "description": "Determines the type of item action.", "enum": [ "add", "remove", "set" ], "type": "string" } }, "required": [ "type" ], "title": "specs", "type": "object", "x-stripeMostCommon": [ "add", "remove", "set", "type" ] }, "type": "array" }, "metadata_actions": { "description": "Instructions for how to modify phase metadata", "items": { "properties": { "add": { "additionalProperties": { "type": "string" }, "description": "Key-value pairs to add to schedule phase metadata. These values will merge with existing schedule phase metadata.", "type": "object" }, "remove": { "description": "Keys to remove from schedule phase metadata.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "set": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Key-value pairs to set as schedule phase metadata. Existing schedule phase metadata will be overwritten." }, "type": { "description": "Select one of three ways to update phase-level `metadata` on subscription schedules.", "enum": [ "add", "remove", "set" ], "type": "string" } }, "required": [ "type" ], "title": "specs", "type": "object", "x-stripeMostCommon": [ "add", "remove", "set", "type" ] }, "type": "array" }, "proration_behavior": { "description": "Changes to how Stripe handles prorations during the amendment time span. Affects if and how prorations are created when a future phase starts. In cases where the amendment changes the currently active phase, it is used to determine whether or how to prorate now, at the time of the request. Also supported as a point-in-time operation when `amendment_end` is `null`.", "enum": [ "always_invoice", "create_prorations", "none" ], "type": "string" }, "set_pause_collection": { "description": "Defines how to pause collection for the underlying subscription throughout the duration of the amendment.", "properties": { "set": { "description": "Details of the pause_collection behavior to apply to the amendment.", "properties": { "behavior": { "description": "The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.", "enum": [ "keep_as_draft", "mark_uncollectible", "void" ], "type": "string" } }, "required": [ "behavior" ], "title": "pause_collection_params", "type": "object", "x-stripeMostCommon": [ "behavior" ] }, "type": { "description": "Determines the type of the pause_collection amendment.", "enum": [ "remove", "set" ], "type": "string" } }, "required": [ "type" ], "title": "specs", "type": "object", "x-stripeMostCommon": [ "set", "type" ] }, "set_schedule_end": { "description": "Ends the subscription schedule early as dictated by either the accompanying amendment's start or end.", "enum": [ "amendment_end", "amendment_start" ], "type": "string" }, "trial_settings": { "description": "Settings related to subscription trials.", "properties": { "end_behavior": { "description": "Defines how the subscription should behave when a trial ends.", "properties": { "prorate_up_front": { "description": "Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.", "enum": [ "defer", "include" ], "type": "string" } }, "title": "end_behavior_specs", "type": "object", "x-stripeMostCommon": [ "prorate_up_front" ] } }, "title": "trial_settings_specs", "type": "object", "x-stripeMostCommon": [ "end_behavior" ] } }, "required": [ "amendment_start" ], "title": "amendment_specs", "type": "object", "x-stripeMostCommon": [ "amendment_end", "amendment_start", "billing_cycle_anchor", "discount_actions", "item_actions", "metadata_actions", "proration_behavior", "set_pause_collection", "set_schedule_end", "trial_settings" ] }, "type": "array" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "prebilling": { "anyOf": [ { "items": { "properties": { "bill_from": { "description": "The beginning of the prebilled time period. The default value is `now`.", "properties": { "amendment_start": { "description": "Start the prebilled period when a specified amendment begins.", "properties": { "index": { "description": "The position of the amendment in the `amendments` array with which prebilling should begin. Indexes start from 0 and must be less than the total number of supplied amendments.", "type": "integer" } }, "required": [ "index" ], "title": "amendment_start_specs", "type": "object", "x-stripeMostCommon": [ "index" ] }, "timestamp": { "description": "Start the prebilled period at a precise integer timestamp, starting from the Unix epoch.", "format": "unix-time", "type": "integer" }, "type": { "description": "Select one of several ways to pass the `bill_from` value.", "enum": [ "amendment_start", "now", "timestamp" ], "type": "string" } }, "required": [ "type" ], "title": "specs", "type": "object", "x-stripeMostCommon": [ "amendment_start", "timestamp", "type" ] }, "bill_until": { "description": "The end of the prebilled time period.", "properties": { "amendment_end": { "description": "End the prebilled period when a specified amendment ends.", "properties": { "index": { "description": "The position of the amendment in the `amendments` array at which prebilling should end. Indexes start from 0 and must be less than the total number of supplied amendments.", "type": "integer" } }, "required": [ "index" ], "title": "amendment_end_specs", "type": "object", "x-stripeMostCommon": [ "index" ] }, "duration": { "description": "Time span for prebilling, starting from `bill_from`.", "properties": { "interval": { "description": "Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.", "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "description": "The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.", "type": "integer" } }, "required": [ "interval", "interval_count" ], "title": "duration_specs", "type": "object", "x-stripeMostCommon": [ "interval", "interval_count" ] }, "timestamp": { "description": "End the prebilled period at a precise integer timestamp, starting from the Unix epoch.", "format": "unix-time", "type": "integer" }, "type": { "description": "Select one of several ways to pass the `bill_until` value.", "enum": [ "amendment_end", "duration", "schedule_end", "timestamp" ], "type": "string" } }, "required": [ "type" ], "title": "specs", "type": "object", "x-stripeMostCommon": [ "amendment_end", "duration", "timestamp", "type" ] }, "invoice_at": { "description": "When the prebilling invoice should be created. The default value is `now`.", "enum": [ "now" ], "type": "string" }, "update_behavior": { "description": "Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period. The default value is `reset`.", "enum": [ "prebill", "reset" ], "type": "string" } }, "title": "specs", "type": "object", "x-stripeMostCommon": [ "bill_from", "bill_until", "invoice_at", "update_behavior" ] }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "Provide any time periods to bill in advance." }, "proration_behavior": { "description": "In cases where the amendment changes the currently active phase,\n specifies if and how to prorate at the time of the request.", "enum": [ "always_invoice", "create_prorations", "none" ], "type": "string" }, "schedule_settings": { "description": "Changes to apply to the subscription schedule.", "properties": { "end_behavior": { "description": "Behavior of the subscription schedule and underlying subscription when it ends.", "enum": [ "cancel", "release" ], "type": "string" } }, "title": "specs", "type": "object", "x-stripeMostCommon": [ "end_behavior" ] } }, "type": "object", "x-stripeMostCommon": [ "amendments", "proration_behavior", "schedule_settings" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/subscription_schedule" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Amend a schedule" } }, "/v1/subscription_schedules/{schedule}/cancel": { "post": { "description": "

Cancels a subscription schedule and its associated subscription immediately (if the subscription schedule has an active subscription). A subscription schedule can only be canceled if its status is not_started or active.

", "operationId": "PostSubscriptionSchedulesScheduleCancel", "parameters": [ { "in": "path", "name": "schedule", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "invoice_now": { "description": "If the subscription schedule is `active`, indicates if a final invoice will be generated that contains any un-invoiced metered usage and new/pending proration invoice items. Defaults to `true`.", "type": "boolean" }, "prorate": { "description": "If the subscription schedule is `active`, indicates if the cancellation should be prorated. Defaults to `true`.", "type": "boolean" } }, "type": "object", "x-stripeMostCommon": [ "invoice_now" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/subscription_schedule" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Cancel a schedule" } }, "/v1/subscription_schedules/{schedule}/release": { "post": { "description": "

Releases the subscription schedule immediately, which will stop scheduling of its phases, but leave any existing subscription in place. A schedule can only be released if its status is not_started or active. If the subscription schedule is currently associated with a subscription, releasing it will remove its subscription property and set the subscription’s ID to the released_subscription property.

", "operationId": "PostSubscriptionSchedulesScheduleRelease", "parameters": [ { "in": "path", "name": "schedule", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "preserve_cancel_date": { "description": "Keep any cancellation on the subscription that the schedule has set", "type": "boolean" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/subscription_schedule" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Release a schedule" } }, "/v1/subscriptions": { "get": { "description": "

By default, returns a list of subscriptions that have not been canceled. In order to list canceled subscriptions, specify status=canceled.

", "operationId": "GetSubscriptions", "parameters": [ { "description": "Filter subscriptions by their automatic tax settings.", "explode": true, "in": "query", "name": "automatic_tax", "required": false, "schema": { "properties": { "enabled": { "description": "Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription.", "type": "boolean" } }, "required": [ "enabled" ], "title": "automatic_tax_filter_params", "type": "object", "x-stripeMostCommon": [ "enabled" ] }, "style": "deepObject" }, { "description": "The collection method of the subscriptions to retrieve. Either `charge_automatically` or `send_invoice`.", "in": "query", "name": "collection_method", "required": false, "schema": { "enum": [ "charge_automatically", "send_invoice" ], "type": "string" }, "style": "form" }, { "description": "Only return subscriptions that were created during the given date interval.", "explode": true, "in": "query", "name": "created", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "description": "Minimum value to filter by (exclusive)", "type": "integer" }, "gte": { "description": "Minimum value to filter by (inclusive)", "type": "integer" }, "lt": { "description": "Maximum value to filter by (exclusive)", "type": "integer" }, "lte": { "description": "Maximum value to filter by (inclusive)", "type": "integer" } }, "title": "range_query_specs", "type": "object", "x-stripeMostCommon": [ "gt", "gte", "lt", "lte" ] }, { "type": "integer" } ] }, "style": "deepObject" }, { "description": "Only return subscriptions whose minimum item current_period_end falls within the given date interval.", "explode": true, "in": "query", "name": "current_period_end", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "description": "Minimum value to filter by (exclusive)", "type": "integer" }, "gte": { "description": "Minimum value to filter by (inclusive)", "type": "integer" }, "lt": { "description": "Maximum value to filter by (exclusive)", "type": "integer" }, "lte": { "description": "Maximum value to filter by (inclusive)", "type": "integer" } }, "title": "range_query_specs", "type": "object", "x-stripeMostCommon": [ "gt", "gte", "lt", "lte" ] }, { "type": "integer" } ] }, "style": "deepObject" }, { "description": "Only return subscriptions whose maximum item current_period_start falls within the given date interval.", "explode": true, "in": "query", "name": "current_period_start", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "description": "Minimum value to filter by (exclusive)", "type": "integer" }, "gte": { "description": "Minimum value to filter by (inclusive)", "type": "integer" }, "lt": { "description": "Maximum value to filter by (exclusive)", "type": "integer" }, "lte": { "description": "Maximum value to filter by (inclusive)", "type": "integer" } }, "title": "range_query_specs", "type": "object", "x-stripeMostCommon": [ "gt", "gte", "lt", "lte" ] }, { "type": "integer" } ] }, "style": "deepObject" }, { "description": "The ID of the customer whose subscriptions will be retrieved.", "in": "query", "name": "customer", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "The ID of the account whose subscriptions will be retrieved.", "in": "query", "name": "customer_account", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "The ID of the plan whose subscriptions will be retrieved.", "in": "query", "name": "plan", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Filter for subscriptions that contain this recurring price ID.", "in": "query", "name": "price", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "The status of the subscriptions to retrieve. Passing in a value of `canceled` will return all canceled subscriptions, including those belonging to deleted customers. Pass `ended` to find subscriptions that are canceled and subscriptions that are expired due to [incomplete payment](https://stripe.com/docs/billing/subscriptions/overview#subscription-statuses). Passing in a value of `all` will return subscriptions of all statuses. If no value is supplied, all subscriptions that have not been canceled are returned.", "in": "query", "name": "status", "required": false, "schema": { "enum": [ "active", "all", "canceled", "ended", "incomplete", "incomplete_expired", "past_due", "paused", "trialing", "unpaid" ], "type": "string" }, "style": "form" }, { "description": "Filter for subscriptions that are associated with the specified test clock. The response will not include subscriptions with test clocks if this and the customer parameter is not set.", "in": "query", "name": "test_clock", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/subscription" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/subscriptions", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "SubscriptionsSubscriptionList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List subscriptions" }, "post": { "description": "

Creates a new subscription on an existing customer. Each customer can have up to 500 active or scheduled subscriptions.

\n\n

When you create a subscription with collection_method=charge_automatically, the first invoice is finalized as part of the request.\nThe payment_behavior parameter determines the exact behavior of the initial payment.

\n\n

To start subscriptions where the first invoice always begins in a draft status, use subscription schedules instead.\nSchedules provide the flexibility to model more complex billing configurations that change over time.

", "operationId": "PostSubscriptions", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "add_invoice_items": { "explode": true, "style": "deepObject" }, "application_fee_percent": { "explode": true, "style": "deepObject" }, "automatic_tax": { "explode": true, "style": "deepObject" }, "billing_cycle_anchor_config": { "explode": true, "style": "deepObject" }, "billing_mode": { "explode": true, "style": "deepObject" }, "billing_thresholds": { "explode": true, "style": "deepObject" }, "cancel_at": { "explode": true, "style": "deepObject" }, "default_tax_rates": { "explode": true, "style": "deepObject" }, "discounts": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "invoice_settings": { "explode": true, "style": "deepObject" }, "items": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "on_behalf_of": { "explode": true, "style": "deepObject" }, "payment_settings": { "explode": true, "style": "deepObject" }, "pending_invoice_item_interval": { "explode": true, "style": "deepObject" }, "prebilling": { "explode": true, "style": "deepObject" }, "transfer_data": { "explode": true, "style": "deepObject" }, "trial_end": { "explode": true, "style": "deepObject" }, "trial_settings": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "add_invoice_items": { "description": "A list of prices and quantities that will generate invoice items appended to the next invoice for this subscription. You may pass up to 20 items.", "items": { "properties": { "discounts": { "description": "The coupons to redeem into discounts for the item.", "items": { "properties": { "coupon": { "description": "ID of the coupon to create a new discount for.", "maxLength": 5000, "type": "string" }, "discount": { "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", "maxLength": 5000, "type": "string" }, "discount_end": { "description": "Details to determine how long the discount should be applied for.", "properties": { "duration": { "description": "Time span for the redeemed discount.", "properties": { "interval": { "description": "Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.", "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "description": "The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.", "type": "integer" } }, "required": [ "interval", "interval_count" ], "title": "discount_end_duration_specs", "type": "object", "x-stripeMostCommon": [ "interval", "interval_count" ] }, "timestamp": { "description": "A precise Unix timestamp for the discount to end. Must be in the future.", "format": "unix-time", "type": "integer" }, "type": { "description": "The type of calculation made to determine when the discount ends.", "enum": [ "duration", "timestamp" ], "type": "string" } }, "required": [ "type" ], "title": "discount_end", "type": "object", "x-stripeMostCommon": [ "duration", "timestamp", "type" ] }, "promotion_code": { "description": "ID of the promotion code to create a new discount for.", "maxLength": 5000, "type": "string" } }, "title": "discounts_data_param", "type": "object", "x-stripeMostCommon": [ "coupon" ] }, "type": "array" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "period": { "description": "The period associated with this invoice item. If not set, `period.start.type` defaults to `max_item_period_start` and `period.end.type` defaults to `min_item_period_end`.", "properties": { "end": { "description": "End of the invoice item period.", "properties": { "timestamp": { "description": "A precise Unix timestamp for the end of the invoice item period. Must be greater than or equal to `period.start`.", "format": "unix-time", "type": "integer" }, "type": { "description": "Select how to calculate the end of the invoice item period.", "enum": [ "min_item_period_end", "timestamp" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "invoice_item_period_end", "type": "object", "x-stripeMostCommon": [ "timestamp", "type" ] }, "start": { "description": "Start of the invoice item period.", "properties": { "timestamp": { "description": "A precise Unix timestamp for the start of the invoice item period. Must be less than or equal to `period.end`.", "format": "unix-time", "type": "integer" }, "type": { "description": "Select how to calculate the start of the invoice item period.", "enum": [ "max_item_period_start", "now", "timestamp" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "invoice_item_period_start", "type": "object", "x-stripeMostCommon": [ "timestamp", "type" ] } }, "required": [ "end", "start" ], "title": "invoice_item_period", "type": "object", "x-stripeMostCommon": [ "end", "start" ] }, "price": { "description": "The ID of the price object. One of `price` or `price_data` is required.", "maxLength": 5000, "type": "string" }, "price_data": { "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.", "properties": { "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "product": { "description": "The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.", "maxLength": 5000, "type": "string" }, "tax_behavior": { "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.", "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" }, "unit_amount": { "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge or a negative integer representing the amount to credit to the customer.", "type": "integer" }, "unit_amount_decimal": { "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", "format": "decimal", "type": "string" } }, "required": [ "currency", "product" ], "title": "one_time_price_data_with_negative_amounts", "type": "object", "x-stripeMostCommon": [ "currency", "product", "unit_amount" ] }, "quantity": { "description": "Quantity for this item. Defaults to 1.", "type": "integer" }, "tax_rates": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The tax rates which apply to the item. When set, the `default_tax_rates` do not apply to this item." } }, "title": "add_invoice_item_entry", "type": "object", "x-stripeMostCommon": [ "price", "quantity" ], "x-stripeParam": { "class_name": "AddInvoiceItem" } }, "type": "array" }, "application_fee_percent": { "anyOf": [ { "type": "number" }, { "enum": [ "" ], "type": "string" } ], "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions)." }, "automatic_tax": { "description": "Automatic tax settings for this subscription.", "properties": { "enabled": { "description": "Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription.", "type": "boolean" }, "liability": { "description": "The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.", "properties": { "account": { "description": "The connected account being referenced when `type` is `account`.", "type": "string" }, "type": { "description": "Type of the account referenced in the request.", "enum": [ "account", "self" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "param", "type": "object", "x-stripeMostCommon": [ "account", "type" ] } }, "required": [ "enabled" ], "title": "automatic_tax_config", "type": "object", "x-stripeMostCommon": [ "enabled", "liability" ] }, "backdate_start_date": { "description": "A past timestamp to backdate the subscription's start date to. If set, the first invoice will contain line items for the timespan between the start date and the current time. Can be combined with trials and the billing cycle anchor.", "format": "unix-time", "type": "integer" }, "billing_cycle_anchor": { "description": "A future timestamp in UTC format to anchor the subscription's [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle). The anchor is the reference point that aligns future billing cycle dates. It sets the day of week for `week` intervals, the day of month for `month` and `year` intervals, and the month of year for `year` intervals.", "format": "unix-time", "type": "integer", "x-stripeBypassValidation": true }, "billing_cycle_anchor_config": { "description": "Mutually exclusive with billing_cycle_anchor and only valid with monthly and yearly price intervals. When provided, the billing_cycle_anchor is set to the next occurence of the day_of_month at the hour, minute, and second UTC.", "properties": { "day_of_month": { "description": "The day of the month the anchor should be. Ranges from 1 to 31.", "type": "integer" }, "hour": { "description": "The hour of the day the anchor should be. Ranges from 0 to 23.", "type": "integer" }, "minute": { "description": "The minute of the hour the anchor should be. Ranges from 0 to 59.", "type": "integer" }, "month": { "description": "The month to start full cycle periods. Ranges from 1 to 12.", "type": "integer" }, "second": { "description": "The second of the minute the anchor should be. Ranges from 0 to 59.", "type": "integer" } }, "required": [ "day_of_month" ], "title": "cycle_anchor_config_param", "type": "object", "x-stripeMostCommon": [ "day_of_month", "hour", "minute", "month", "second" ] }, "billing_mode": { "description": "Controls how prorations and invoices for subscriptions are calculated and orchestrated.", "properties": { "type": { "description": "Controls the calculation and orchestration of prorations and invoices for subscriptions.", "enum": [ "classic", "flexible" ], "type": "string" } }, "required": [ "type" ], "title": "billing_mode", "type": "object", "x-stripeMostCommon": [ "flexible", "type" ] }, "billing_thresholds": { "anyOf": [ { "properties": { "amount_gte": { "description": "Monetary threshold that triggers the subscription to advance to a new billing period", "type": "integer" }, "reset_billing_cycle_anchor": { "description": "Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged.", "type": "boolean" } }, "title": "billing_thresholds_param", "type": "object", "x-stripeMostCommon": [ "amount_gte", "reset_billing_cycle_anchor" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds." }, "cancel_at": { "anyOf": [ { "format": "unix-time", "type": "integer" }, { "enum": [ "max_period_end", "min_period_end" ], "type": "string" } ], "description": "A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period." }, "cancel_at_period_end": { "description": "Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`.", "type": "boolean" }, "collection_method": { "description": "Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically`.", "enum": [ "charge_automatically", "send_invoice" ], "type": "string" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "customer": { "description": "The identifier of the customer to subscribe.", "maxLength": 5000, "type": "string" }, "customer_account": { "description": "The identifier of the account to subscribe.", "maxLength": 5000, "type": "string" }, "days_until_due": { "description": "Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where `collection_method` is set to `send_invoice`.", "type": "integer" }, "default_payment_method": { "description": "ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).", "maxLength": 5000, "type": "string" }, "default_source": { "description": "ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).", "maxLength": 5000, "type": "string" }, "default_tax_rates": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The tax rates that will apply to any subscription item that does not have `tax_rates` set. Invoices created will have their `default_tax_rates` populated from the subscription." }, "description": { "description": "The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.", "maxLength": 500, "type": "string" }, "discounts": { "anyOf": [ { "items": { "properties": { "coupon": { "description": "ID of the coupon to create a new discount for.", "maxLength": 5000, "type": "string" }, "discount": { "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", "maxLength": 5000, "type": "string" }, "discount_end": { "description": "Details to determine how long the discount should be applied for.", "properties": { "duration": { "description": "Time span for the redeemed discount.", "properties": { "interval": { "description": "Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.", "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "description": "The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.", "type": "integer" } }, "required": [ "interval", "interval_count" ], "title": "discount_end_duration_specs", "type": "object", "x-stripeMostCommon": [ "interval", "interval_count" ] }, "timestamp": { "description": "A precise Unix timestamp for the discount to end. Must be in the future.", "format": "unix-time", "type": "integer" }, "type": { "description": "The type of calculation made to determine when the discount ends.", "enum": [ "duration", "timestamp" ], "type": "string" } }, "required": [ "type" ], "title": "discount_end", "type": "object", "x-stripeMostCommon": [ "duration", "timestamp", "type" ] }, "promotion_code": { "description": "ID of the promotion code to create a new discount for.", "maxLength": 5000, "type": "string" } }, "title": "discounts_data_param", "type": "object", "x-stripeMostCommon": [ "coupon", "settings" ] }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The coupons to redeem into discounts for the subscription. If not specified or empty, inherits the discount from the subscription's customer." }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "invoice_settings": { "description": "All invoices will be billed using the specified settings.", "properties": { "account_tax_ids": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The account tax IDs associated with the subscription. Will be set on invoices generated by the subscription." }, "issuer": { "description": "The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.", "properties": { "account": { "description": "The connected account being referenced when `type` is `account`.", "type": "string" }, "type": { "description": "Type of the account referenced in the request.", "enum": [ "account", "self" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "param", "type": "object", "x-stripeMostCommon": [ "account", "type" ] } }, "title": "invoice_settings_param", "type": "object", "x-stripeMostCommon": [ "account_tax_ids", "custom_fields", "description", "footer", "issuer", "rendering", "send_hosted_payment_email", "supported_payment_methods" ] }, "items": { "description": "A list of up to 20 subscription items, each with an attached price.", "items": { "properties": { "billing_thresholds": { "anyOf": [ { "properties": { "usage_gte": { "description": "Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte))", "type": "integer" } }, "required": [ "usage_gte" ], "title": "item_billing_thresholds_param", "type": "object", "x-stripeMostCommon": [ "usage_gte" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds." }, "discounts": { "anyOf": [ { "items": { "properties": { "coupon": { "description": "ID of the coupon to create a new discount for.", "maxLength": 5000, "type": "string" }, "discount": { "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", "maxLength": 5000, "type": "string" }, "discount_end": { "description": "Details to determine how long the discount should be applied for.", "properties": { "duration": { "description": "Time span for the redeemed discount.", "properties": { "interval": { "description": "Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.", "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "description": "The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.", "type": "integer" } }, "required": [ "interval", "interval_count" ], "title": "discount_end_duration_specs", "type": "object", "x-stripeMostCommon": [ "interval", "interval_count" ] }, "timestamp": { "description": "A precise Unix timestamp for the discount to end. Must be in the future.", "format": "unix-time", "type": "integer" }, "type": { "description": "The type of calculation made to determine when the discount ends.", "enum": [ "duration", "timestamp" ], "type": "string" } }, "required": [ "type" ], "title": "discount_end", "type": "object", "x-stripeMostCommon": [ "duration", "timestamp", "type" ] }, "promotion_code": { "description": "ID of the promotion code to create a new discount for.", "maxLength": 5000, "type": "string" } }, "title": "discounts_data_param", "type": "object", "x-stripeMostCommon": [ "coupon", "settings" ] }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The coupons to redeem into discounts for the subscription item." }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "plan": { "description": "Plan ID for this item, as a string.", "maxLength": 5000, "type": "string" }, "price": { "description": "The ID of the price object.", "maxLength": 5000, "type": "string" }, "price_data": { "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.", "properties": { "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "product": { "description": "The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.", "maxLength": 5000, "type": "string" }, "recurring": { "description": "The recurring components of a price such as `interval` and `interval_count`.", "properties": { "interval": { "description": "Specifies billing frequency. Either `day`, `week`, `month` or `year`.", "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "description": "The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).", "type": "integer" } }, "required": [ "interval" ], "title": "recurring_adhoc", "type": "object", "x-stripeMostCommon": [ "interval" ] }, "tax_behavior": { "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.", "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" }, "unit_amount": { "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.", "type": "integer" }, "unit_amount_decimal": { "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", "format": "decimal", "type": "string" } }, "required": [ "currency", "product", "recurring" ], "title": "recurring_price_data", "type": "object", "x-stripeMostCommon": [ "currency", "product", "recurring", "unit_amount" ] }, "quantity": { "description": "Quantity for this item.", "type": "integer" }, "tax_rates": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates." }, "trial": { "description": "Define options to configure the trial on the subscription item.", "properties": { "converts_to": { "description": "List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. Currently only supports at most 1 price ID.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "type": { "description": "Determines the type of trial for this item.", "enum": [ "free", "paid" ], "type": "string" } }, "required": [ "type" ], "title": "trial_specs", "type": "object", "x-stripeMostCommon": [ "converts_to", "type" ] } }, "title": "subscription_item_create_params", "type": "object", "x-stripeMostCommon": [ "billing_thresholds", "current_trial", "discounts", "metadata", "plan", "price", "quantity", "tax_rates", "trial" ] }, "type": "array" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "off_session": { "description": "Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to `false` (on-session).", "type": "boolean" }, "on_behalf_of": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "The account on behalf of which to charge, for each of the subscription's invoices." }, "payment_behavior": { "description": "Only applies to subscriptions with `collection_method=charge_automatically`.\n\nUse `allow_incomplete` to create Subscriptions with `status=incomplete` if the first invoice can't be paid. Creating Subscriptions with this status allows you to manage scenarios where additional customer actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior.\n\nUse `default_incomplete` to create Subscriptions with `status=incomplete` when the first invoice requires payment, otherwise start as active. Subscriptions transition to `status=active` when successfully confirming the PaymentIntent on the first invoice. This allows simpler management of scenarios where additional customer actions are needed to pay a subscription’s invoice, such as failed payments, [SCA regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method. If the PaymentIntent is not confirmed within 23 hours Subscriptions transition to `status=incomplete_expired`, which is a terminal state.\n\nUse `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's first invoice can't be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further customer action is needed, this parameter doesn't create a Subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more.\n\n`pending_if_incomplete` is only used with updates and cannot be passed when creating a Subscription.\n\nSubscriptions with `collection_method=send_invoice` are automatically activated regardless of the first Invoice status.", "enum": [ "allow_incomplete", "default_incomplete", "error_if_incomplete", "pending_if_incomplete" ], "type": "string" }, "payment_settings": { "description": "Payment settings to pass to invoices created by the subscription.", "properties": { "payment_method_options": { "description": "Payment-method-specific configuration to provide to invoices created by the subscription.", "properties": { "acss_debit": { "anyOf": [ { "properties": { "mandate_options": { "description": "Additional fields for Mandate creation", "properties": { "transaction_type": { "description": "Transaction type of the mandate.", "enum": [ "business", "personal" ], "type": "string" } }, "title": "mandate_options_param", "type": "object", "x-stripeMostCommon": [ "transaction_type" ] }, "verification_method": { "description": "Verification method for the intent", "enum": [ "automatic", "instant", "microdeposits" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "invoice_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "mandate_options", "verification_method" ] }, { "enum": [ "" ], "type": "string" } ], "description": "This sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to the invoice’s PaymentIntent." }, "bancontact": { "anyOf": [ { "properties": { "preferred_language": { "description": "Preferred language of the Bancontact authorization page that the customer is redirected to.", "enum": [ "de", "en", "fr", "nl" ], "type": "string" } }, "title": "invoice_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "preferred_language" ] }, { "enum": [ "" ], "type": "string" } ], "description": "This sub-hash contains details about the Bancontact payment method options to pass to the invoice’s PaymentIntent." }, "card": { "anyOf": [ { "properties": { "mandate_options": { "description": "Configuration options for setting up an eMandate for cards issued in India.", "properties": { "amount": { "description": "Amount to be charged for future payments.", "type": "integer" }, "amount_type": { "description": "One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.", "enum": [ "fixed", "maximum" ], "type": "string" }, "description": { "description": "A description of the mandate or subscription that is meant to be displayed to the customer.", "maxLength": 200, "type": "string" } }, "title": "mandate_options_param", "type": "object", "x-stripeMostCommon": [ "amount", "amount_type", "description" ] }, "network": { "description": "Selected network to process this Subscription on. Depends on the available networks of the card attached to the Subscription. Can be only set confirm-time.", "enum": [ "amex", "cartes_bancaires", "diners", "discover", "eftpos_au", "girocard", "interac", "jcb", "link", "mastercard", "unionpay", "unknown", "visa" ], "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true }, "request_three_d_secure": { "description": "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.", "enum": [ "any", "automatic", "challenge" ], "type": "string" } }, "title": "subscription_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "mandate_options", "mit_exemption", "network", "request_three_d_secure" ] }, { "enum": [ "" ], "type": "string" } ], "description": "This sub-hash contains details about the Card payment method options to pass to the invoice’s PaymentIntent." }, "customer_balance": { "anyOf": [ { "properties": { "bank_transfer": { "description": "Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`.", "properties": { "eu_bank_transfer": { "description": "Configuration for eu_bank_transfer funding type.", "properties": { "country": { "description": "The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`.", "maxLength": 5000, "type": "string" } }, "required": [ "country" ], "title": "eu_bank_transfer_param", "type": "object", "x-stripeMostCommon": [ "country" ] }, "type": { "description": "The bank transfer type that can be used for funding. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.", "type": "string" } }, "title": "bank_transfer_param", "type": "object", "x-stripeMostCommon": [ "eu_bank_transfer", "id_bank_transfer", "type" ] }, "funding_type": { "description": "The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.", "type": "string" } }, "title": "invoice_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "bank_transfer", "funding_type" ] }, { "enum": [ "" ], "type": "string" } ], "description": "This sub-hash contains details about the Bank transfer payment method options to pass to the invoice’s PaymentIntent." }, "id_bank_transfer": { "anyOf": [ { "properties": {}, "title": "invoice_payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "This sub-hash contains details about the Indonesia bank transfer payment method options to pass to the invoice’s PaymentIntent." }, "konbini": { "anyOf": [ { "properties": {}, "title": "invoice_payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "This sub-hash contains details about the Konbini payment method options to pass to the invoice’s PaymentIntent." }, "pix": { "anyOf": [ { "properties": { "mandate_options": { "description": "Configuration options for setting up a mandate", "properties": { "amount": { "description": "Amount to be charged for future payments. If not provided, defaults to 40000.", "type": "integer" }, "amount_includes_iof": { "description": "Determines if the amount includes the IOF tax. Defaults to `never`.", "enum": [ "always", "never" ], "type": "string" }, "end_date": { "description": "Date when the mandate expires and no further payments will be charged, in `YYYY-MM-DD`. If not provided, the mandate will be active until canceled.", "maxLength": 5000, "type": "string" }, "payment_schedule": { "description": "Schedule at which the future payments will be charged. Defaults to `weekly`.", "enum": [ "halfyearly", "monthly", "quarterly", "weekly", "yearly" ], "type": "string" } }, "title": "subscription_payment_method_options_mandate_options_param", "type": "object", "x-stripeMostCommon": [ "amount", "amount_includes_iof", "end_date", "payment_schedule" ] } }, "title": "subscription_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "mandate_options" ] }, { "enum": [ "" ], "type": "string" } ], "description": "This sub-hash contains details about the Pix payment method options to pass to the invoice’s PaymentIntent." }, "sepa_debit": { "anyOf": [ { "properties": {}, "title": "invoice_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "verification_method" ] }, { "enum": [ "" ], "type": "string" } ], "description": "This sub-hash contains details about the SEPA Direct Debit payment method options to pass to the invoice’s PaymentIntent." }, "upi": { "anyOf": [ { "properties": { "mandate_options": { "description": "Configuration options for setting up an eMandate", "properties": { "amount": { "description": "Amount to be charged for future payments.", "type": "integer" }, "amount_type": { "description": "One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.", "enum": [ "fixed", "maximum" ], "type": "string" }, "description": { "description": "A description of the mandate or subscription that is meant to be displayed to the customer.", "maxLength": 20, "type": "string" }, "end_date": { "description": "End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.", "format": "unix-time", "type": "integer" } }, "title": "invoice_payment_method_options_mandate_options_param", "type": "object", "x-stripeMostCommon": [ "amount", "amount_type", "description", "end_date" ] } }, "title": "invoice_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "mandate_options" ] }, { "enum": [ "" ], "type": "string" } ], "description": "This sub-hash contains details about the UPI payment method options to pass to the invoice’s PaymentIntent." }, "us_bank_account": { "anyOf": [ { "properties": { "financial_connections": { "description": "Additional fields for Financial Connections Session creation", "properties": { "filters": { "description": "Provide filters for the linked accounts that the customer can select for the payment method.", "properties": { "account_subcategories": { "description": "The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.", "items": { "enum": [ "checking", "savings" ], "type": "string" }, "type": "array" }, "institution": { "description": "ID of the institution to use to filter for selectable accounts.", "maxLength": 5000, "type": "string" } }, "title": "invoice_linked_account_options_filters_param", "type": "object", "x-stripeMostCommon": [ "account_subcategories", "institution" ] }, "permissions": { "description": "The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.", "items": { "enum": [ "balances", "ownership", "payment_method", "transactions" ], "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true }, "type": "array" }, "prefetch": { "description": "List of data features that you would like to retrieve upon account creation.", "items": { "enum": [ "balances", "inferred_balances", "ownership", "transactions" ], "type": "string", "x-stripeBypassValidation": true }, "type": "array" } }, "title": "invoice_linked_account_options_param", "type": "object", "x-stripeMostCommon": [ "filters", "permissions", "prefetch" ] }, "verification_method": { "description": "Verification method for the intent", "enum": [ "automatic", "instant", "microdeposits" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "invoice_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "financial_connections", "verification_method" ] }, { "enum": [ "" ], "type": "string" } ], "description": "This sub-hash contains details about the ACH direct debit payment method options to pass to the invoice’s PaymentIntent." } }, "title": "payment_method_options", "type": "object", "x-stripeMostCommon": [ "acss_debit", "bancontact", "card", "customer_balance", "id_bank_transfer", "konbini", "pix", "sepa_debit", "upi", "us_bank_account" ] }, "payment_method_types": { "anyOf": [ { "items": { "enum": [ "ach_credit_transfer", "ach_debit", "acss_debit", "affirm", "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", "boleto", "card", "cashapp", "crypto", "custom", "customer_balance", "eps", "fpx", "giropay", "grabpay", "id_bank_transfer", "ideal", "jp_credit_transfer", "kakao_pay", "klarna", "konbini", "kr_card", "link", "multibanco", "naver_pay", "nz_bank_account", "p24", "payco", "paynow", "paypal", "pix", "promptpay", "revolut_pay", "sepa_credit_transfer", "sepa_debit", "sofort", "stripe_balance", "swish", "upi", "us_bank_account", "wechat_pay" ], "type": "string", "x-stripeBypassValidation": true }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The list of payment method types (e.g. card) to provide to the invoice’s PaymentIntent. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your [invoice template settings](https://dashboard.stripe.com/settings/billing/invoice). Should not be specified with payment_method_configuration" }, "save_default_payment_method": { "description": "Configure whether Stripe updates `subscription.default_payment_method` when payment succeeds. Defaults to `off` if unspecified.", "enum": [ "off", "on_subscription" ], "type": "string" } }, "title": "payment_settings", "type": "object", "x-stripeMostCommon": [ "payment_method_configuration", "payment_method_options", "payment_method_types", "save_default_payment_method" ] }, "pending_invoice_item_interval": { "anyOf": [ { "properties": { "interval": { "description": "Specifies invoicing frequency. Either `day`, `week`, `month` or `year`.", "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "description": "The number of intervals between invoices. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks).", "type": "integer" } }, "required": [ "interval" ], "title": "pending_invoice_item_interval_params", "type": "object", "x-stripeMostCommon": [ "interval", "interval_count" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://stripe.com/docs/api#create_invoice) for the given subscription at the specified interval." }, "prebilling": { "description": "If specified, the invoicing for the given billing cycle iterations will be processed now.", "properties": { "iterations": { "description": "This is used to determine the number of billing cycles to prebill.", "type": "integer" }, "update_behavior": { "description": "Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period. The default value is `reset`.", "enum": [ "prebill", "reset" ], "type": "string" } }, "required": [ "iterations" ], "title": "prebilling_specs", "type": "object", "x-stripeMostCommon": [ "iterations", "update_behavior" ] }, "proration_behavior": { "description": "Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) resulting from the `billing_cycle_anchor`. If no value is passed, the default is `create_prorations`.", "enum": [ "always_invoice", "create_prorations", "none" ], "type": "string" }, "transfer_data": { "description": "If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges.", "properties": { "amount_percent": { "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination.", "type": "number" }, "destination": { "description": "ID of an existing, connected Stripe account.", "type": "string" } }, "required": [ "destination" ], "title": "transfer_data_specs", "type": "object", "x-stripeMostCommon": [ "amount_percent", "destination" ] }, "trial_end": { "anyOf": [ { "enum": [ "now" ], "maxLength": 5000, "type": "string" }, { "format": "unix-time", "type": "integer" } ], "description": "Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more." }, "trial_from_plan": { "description": "Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more.", "type": "boolean" }, "trial_period_days": { "description": "Integer representing the number of trial period days before the customer is charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more.", "type": "integer" }, "trial_settings": { "description": "Settings related to subscription trials.", "properties": { "end_behavior": { "description": "Defines how the subscription should behave when the user's free trial ends.", "properties": { "missing_payment_method": { "description": "Indicates how the subscription should change when the trial ends if the user did not provide a payment method.", "enum": [ "cancel", "create_invoice", "pause" ], "type": "string" } }, "required": [ "missing_payment_method" ], "title": "end_behavior", "type": "object", "x-stripeMostCommon": [ "missing_payment_method" ] } }, "required": [ "end_behavior" ], "title": "trial_settings_config", "type": "object", "x-stripeMostCommon": [ "end_behavior" ] } }, "type": "object", "x-stripeMostCommon": [ "automatic_tax", "currency", "customer", "default_payment_method", "description", "items", "metadata", "payment_behavior" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/subscription" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a subscription" } }, "/v1/subscriptions/search": { "get": { "description": "

Search for subscriptions you’ve previously created using Stripe’s Search Query Language.\nDon’t use search in read-after-write flows where strict consistency is necessary. Under normal operating\nconditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up\nto an hour behind during outages. Search functionality is not available to merchants in India.

", "operationId": "GetSubscriptionsSearch", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.", "in": "query", "name": "page", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for subscriptions](https://stripe.com/docs/search#query-fields-for-subscriptions).", "in": "query", "name": "query", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/subscription" }, "type": "array" }, "has_more": { "type": "boolean" }, "next_page": { "maxLength": 5000, "nullable": true, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "search_result" ], "type": "string" }, "total_count": { "description": "The total number of objects that match the query, only accurate up to 10,000.", "type": "integer" }, "url": { "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "next_page", "object", "url" ], "title": "SearchResult", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "next_page", "object", "total_count", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Search subscriptions" } }, "/v1/subscriptions/{subscription_exposed_id}": { "delete": { "description": "

Cancels a customer’s subscription immediately. The customer won’t be charged again for the subscription. After it’s canceled, you can no longer update the subscription or its metadata.

\n\n

Any pending invoice items that you’ve created are still charged at the end of the period, unless manually deleted. If you’ve set the subscription to cancel at the end of the period, any pending prorations are also left in place and collected at the end of the period. But if the subscription is set to cancel immediately, pending prorations are removed if invoice_now and prorate are both set to true.

\n\n

By default, upon subscription cancellation, Stripe stops automatic collection of all finalized invoices for the customer. This is intended to prevent unexpected payment attempts after the customer has canceled a subscription. However, you can resume automatic collection of the invoices manually after subscription cancellation to have us proceed. Or, you could check for unpaid invoices before allowing the customer to cancel the subscription at all.

", "operationId": "DeleteSubscriptionsSubscriptionExposedId", "parameters": [ { "in": "path", "name": "subscription_exposed_id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "cancellation_details": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "cancellation_details": { "description": "Details about why this subscription was cancelled", "properties": { "comment": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Additional comments about why the user canceled the subscription, if the subscription was canceled explicitly by the user." }, "feedback": { "description": "The customer submitted reason for why they canceled, if the subscription was canceled explicitly by the user.", "enum": [ "", "customer_service", "low_quality", "missing_features", "other", "switched_service", "too_complex", "too_expensive", "unused" ], "type": "string" } }, "title": "cancellation_details_param", "type": "object", "x-stripeMostCommon": [ "comment", "feedback", "feedback_option" ] }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "invoice_now": { "description": "Will generate a final invoice that invoices for any un-invoiced metered usage and new/pending proration invoice items. Defaults to `false`.", "type": "boolean" }, "prorate": { "description": "Will generate a proration invoice item that credits remaining unused time until the subscription period end. Defaults to `false`.", "type": "boolean" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/subscription" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Cancel a subscription" }, "get": { "description": "

Retrieves the subscription with the given ID.

", "operationId": "GetSubscriptionsSubscriptionExposedId", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "subscription_exposed_id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/subscription" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a subscription" }, "post": { "description": "

Updates an existing subscription to match the specified parameters.\nWhen changing prices or quantities, we optionally prorate the price we charge next month to make up for any price changes.\nTo preview how the proration is calculated, use the create preview endpoint.

\n\n

By default, we prorate subscription changes. For example, if a customer signs up on May 1 for a 100 price, they’ll be billed 100 immediately. If on May 15 they switch to a 200 price, then on June 1 they’ll be billed 250 (200 for a renewal of her subscription, plus a 50 prorating adjustment for half of the previous month’s 100 difference). Similarly, a downgrade generates a credit that is applied to the next invoice. We also prorate when you make quantity changes.

\n\n

Switching prices does not normally change the billing date or generate an immediate charge unless:

\n\n
    \n
  • The billing interval is changed (for example, from monthly to yearly).
    • \n
  • The subscription moves from free to paid.
    • \n
  • A trial starts or ends.
    • \n
\n\n

In these cases, we apply a credit for the unused time on the previous price, immediately charge the customer using the new price, and reset the billing date. Learn about how Stripe immediately attempts payment for subscription changes.

\n\n

If you want to charge for an upgrade immediately, pass proration_behavior as always_invoice to create prorations, automatically invoice the customer for those proration adjustments, and attempt to collect payment. If you pass create_prorations, the prorations are created but not automatically invoiced. If you want to bill the customer for the prorations before the subscription’s renewal date, you need to manually invoice the customer.

\n\n

If you don’t want to prorate, set the proration_behavior option to none. With this option, the customer is billed 100 on May 1 and 200 on June 1. Similarly, if you set proration_behavior to none when switching between different billing intervals (for example, from monthly to yearly), we don’t generate any credits for the old subscription’s unused time. We still reset the billing date and bill immediately for the new subscription.

\n\n

Updating the quantity on a subscription many times in an hour may result in rate limiting. If you need to bill for a frequently changing quantity, consider integrating usage-based billing instead.

", "operationId": "PostSubscriptionsSubscriptionExposedId", "parameters": [ { "in": "path", "name": "subscription_exposed_id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "add_invoice_items": { "explode": true, "style": "deepObject" }, "application_fee_percent": { "explode": true, "style": "deepObject" }, "automatic_tax": { "explode": true, "style": "deepObject" }, "billing_thresholds": { "explode": true, "style": "deepObject" }, "cancel_at": { "explode": true, "style": "deepObject" }, "cancellation_details": { "explode": true, "style": "deepObject" }, "default_source": { "explode": true, "style": "deepObject" }, "default_tax_rates": { "explode": true, "style": "deepObject" }, "description": { "explode": true, "style": "deepObject" }, "discounts": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "invoice_settings": { "explode": true, "style": "deepObject" }, "items": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "on_behalf_of": { "explode": true, "style": "deepObject" }, "pause_collection": { "explode": true, "style": "deepObject" }, "payment_settings": { "explode": true, "style": "deepObject" }, "pending_invoice_item_interval": { "explode": true, "style": "deepObject" }, "prebilling": { "explode": true, "style": "deepObject" }, "transfer_data": { "explode": true, "style": "deepObject" }, "trial_end": { "explode": true, "style": "deepObject" }, "trial_settings": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "add_invoice_items": { "description": "A list of prices and quantities that will generate invoice items appended to the next invoice for this subscription. You may pass up to 20 items.", "items": { "properties": { "discounts": { "description": "The coupons to redeem into discounts for the item.", "items": { "properties": { "coupon": { "description": "ID of the coupon to create a new discount for.", "maxLength": 5000, "type": "string" }, "discount": { "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", "maxLength": 5000, "type": "string" }, "discount_end": { "description": "Details to determine how long the discount should be applied for.", "properties": { "duration": { "description": "Time span for the redeemed discount.", "properties": { "interval": { "description": "Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.", "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "description": "The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.", "type": "integer" } }, "required": [ "interval", "interval_count" ], "title": "discount_end_duration_specs", "type": "object", "x-stripeMostCommon": [ "interval", "interval_count" ] }, "timestamp": { "description": "A precise Unix timestamp for the discount to end. Must be in the future.", "format": "unix-time", "type": "integer" }, "type": { "description": "The type of calculation made to determine when the discount ends.", "enum": [ "duration", "timestamp" ], "type": "string" } }, "required": [ "type" ], "title": "discount_end", "type": "object", "x-stripeMostCommon": [ "duration", "timestamp", "type" ] }, "promotion_code": { "description": "ID of the promotion code to create a new discount for.", "maxLength": 5000, "type": "string" } }, "title": "discounts_data_param", "type": "object", "x-stripeMostCommon": [ "coupon" ] }, "type": "array" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "period": { "description": "The period associated with this invoice item. If not set, `period.start.type` defaults to `max_item_period_start` and `period.end.type` defaults to `min_item_period_end`.", "properties": { "end": { "description": "End of the invoice item period.", "properties": { "timestamp": { "description": "A precise Unix timestamp for the end of the invoice item period. Must be greater than or equal to `period.start`.", "format": "unix-time", "type": "integer" }, "type": { "description": "Select how to calculate the end of the invoice item period.", "enum": [ "min_item_period_end", "timestamp" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "invoice_item_period_end", "type": "object", "x-stripeMostCommon": [ "timestamp", "type" ] }, "start": { "description": "Start of the invoice item period.", "properties": { "timestamp": { "description": "A precise Unix timestamp for the start of the invoice item period. Must be less than or equal to `period.end`.", "format": "unix-time", "type": "integer" }, "type": { "description": "Select how to calculate the start of the invoice item period.", "enum": [ "max_item_period_start", "now", "timestamp" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "invoice_item_period_start", "type": "object", "x-stripeMostCommon": [ "timestamp", "type" ] } }, "required": [ "end", "start" ], "title": "invoice_item_period", "type": "object", "x-stripeMostCommon": [ "end", "start" ] }, "price": { "description": "The ID of the price object. One of `price` or `price_data` is required.", "maxLength": 5000, "type": "string" }, "price_data": { "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.", "properties": { "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "product": { "description": "The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.", "maxLength": 5000, "type": "string" }, "tax_behavior": { "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.", "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" }, "unit_amount": { "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge or a negative integer representing the amount to credit to the customer.", "type": "integer" }, "unit_amount_decimal": { "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", "format": "decimal", "type": "string" } }, "required": [ "currency", "product" ], "title": "one_time_price_data_with_negative_amounts", "type": "object", "x-stripeMostCommon": [ "currency", "product", "unit_amount" ] }, "quantity": { "description": "Quantity for this item. Defaults to 1.", "type": "integer" }, "tax_rates": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The tax rates which apply to the item. When set, the `default_tax_rates` do not apply to this item." } }, "title": "add_invoice_item_entry", "type": "object", "x-stripeMostCommon": [ "price", "quantity" ], "x-stripeParam": { "class_name": "AddInvoiceItem" } }, "type": "array" }, "application_fee_percent": { "anyOf": [ { "type": "number" }, { "enum": [ "" ], "type": "string" } ], "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions)." }, "automatic_tax": { "description": "Automatic tax settings for this subscription. We recommend you only include this parameter when the existing value is being changed.", "properties": { "enabled": { "description": "Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription.", "type": "boolean" }, "liability": { "description": "The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.", "properties": { "account": { "description": "The connected account being referenced when `type` is `account`.", "type": "string" }, "type": { "description": "Type of the account referenced in the request.", "enum": [ "account", "self" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "param", "type": "object", "x-stripeMostCommon": [ "account", "type" ] } }, "required": [ "enabled" ], "title": "automatic_tax_config", "type": "object", "x-stripeMostCommon": [ "enabled", "liability" ] }, "billing_cycle_anchor": { "description": "Either `now` or `unchanged`. Setting the value to `now` resets the subscription's billing cycle anchor to the current time (in UTC). For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).", "enum": [ "now", "unchanged" ], "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true }, "billing_thresholds": { "anyOf": [ { "properties": { "amount_gte": { "description": "Monetary threshold that triggers the subscription to advance to a new billing period", "type": "integer" }, "reset_billing_cycle_anchor": { "description": "Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged.", "type": "boolean" } }, "title": "billing_thresholds_param", "type": "object", "x-stripeMostCommon": [ "amount_gte", "reset_billing_cycle_anchor" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds." }, "cancel_at": { "anyOf": [ { "format": "unix-time", "type": "integer" }, { "enum": [ "" ], "type": "string" }, { "enum": [ "max_period_end", "min_period_end" ], "type": "string" } ], "description": "A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period." }, "cancel_at_period_end": { "description": "Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`.", "type": "boolean" }, "cancellation_details": { "description": "Details about why this subscription was cancelled", "properties": { "comment": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Additional comments about why the user canceled the subscription, if the subscription was canceled explicitly by the user." }, "feedback": { "description": "The customer submitted reason for why they canceled, if the subscription was canceled explicitly by the user.", "enum": [ "", "customer_service", "low_quality", "missing_features", "other", "switched_service", "too_complex", "too_expensive", "unused" ], "type": "string" } }, "title": "cancellation_details_param", "type": "object", "x-stripeMostCommon": [ "comment", "feedback", "feedback_option" ] }, "collection_method": { "description": "Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically`.", "enum": [ "charge_automatically", "send_invoice" ], "type": "string" }, "days_until_due": { "description": "Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where `collection_method` is set to `send_invoice`.", "type": "integer" }, "default_payment_method": { "description": "ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).", "maxLength": 5000, "type": "string" }, "default_source": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source)." }, "default_tax_rates": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The tax rates that will apply to any subscription item that does not have `tax_rates` set. Invoices created will have their `default_tax_rates` populated from the subscription. Pass an empty string to remove previously-defined tax rates." }, "description": { "anyOf": [ { "maxLength": 500, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs." }, "discounts": { "anyOf": [ { "items": { "properties": { "coupon": { "description": "ID of the coupon to create a new discount for.", "maxLength": 5000, "type": "string" }, "discount": { "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", "maxLength": 5000, "type": "string" }, "discount_end": { "description": "Details to determine how long the discount should be applied for.", "properties": { "duration": { "description": "Time span for the redeemed discount.", "properties": { "interval": { "description": "Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.", "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "description": "The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.", "type": "integer" } }, "required": [ "interval", "interval_count" ], "title": "discount_end_duration_specs", "type": "object", "x-stripeMostCommon": [ "interval", "interval_count" ] }, "timestamp": { "description": "A precise Unix timestamp for the discount to end. Must be in the future.", "format": "unix-time", "type": "integer" }, "type": { "description": "The type of calculation made to determine when the discount ends.", "enum": [ "duration", "timestamp" ], "type": "string" } }, "required": [ "type" ], "title": "discount_end", "type": "object", "x-stripeMostCommon": [ "duration", "timestamp", "type" ] }, "promotion_code": { "description": "ID of the promotion code to create a new discount for.", "maxLength": 5000, "type": "string" } }, "title": "discounts_data_param", "type": "object", "x-stripeMostCommon": [ "coupon", "settings" ] }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The coupons to redeem into discounts for the subscription. If not specified or empty, inherits the discount from the subscription's customer." }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "invoice_settings": { "description": "All invoices will be billed using the specified settings.", "properties": { "account_tax_ids": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The account tax IDs associated with the subscription. Will be set on invoices generated by the subscription." }, "issuer": { "description": "The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.", "properties": { "account": { "description": "The connected account being referenced when `type` is `account`.", "type": "string" }, "type": { "description": "Type of the account referenced in the request.", "enum": [ "account", "self" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "param", "type": "object", "x-stripeMostCommon": [ "account", "type" ] } }, "title": "invoice_settings_param", "type": "object", "x-stripeMostCommon": [ "account_tax_ids", "custom_fields", "description", "footer", "issuer", "rendering", "send_hosted_payment_email", "supported_payment_methods" ] }, "items": { "description": "A list of up to 20 subscription items, each with an attached price.", "items": { "properties": { "billing_thresholds": { "anyOf": [ { "properties": { "usage_gte": { "description": "Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte))", "type": "integer" } }, "required": [ "usage_gte" ], "title": "item_billing_thresholds_param", "type": "object", "x-stripeMostCommon": [ "usage_gte" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds." }, "clear_usage": { "description": "Delete all usage for a given subscription item. You must pass this when deleting a usage records subscription item. `clear_usage` has no effect if the plan has a billing meter attached.", "type": "boolean" }, "deleted": { "description": "A flag that, if set to `true`, will delete the specified item.", "type": "boolean" }, "discounts": { "anyOf": [ { "items": { "properties": { "coupon": { "description": "ID of the coupon to create a new discount for.", "maxLength": 5000, "type": "string" }, "discount": { "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", "maxLength": 5000, "type": "string" }, "discount_end": { "description": "Details to determine how long the discount should be applied for.", "properties": { "duration": { "description": "Time span for the redeemed discount.", "properties": { "interval": { "description": "Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.", "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "description": "The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.", "type": "integer" } }, "required": [ "interval", "interval_count" ], "title": "discount_end_duration_specs", "type": "object", "x-stripeMostCommon": [ "interval", "interval_count" ] }, "timestamp": { "description": "A precise Unix timestamp for the discount to end. Must be in the future.", "format": "unix-time", "type": "integer" }, "type": { "description": "The type of calculation made to determine when the discount ends.", "enum": [ "duration", "timestamp" ], "type": "string" } }, "required": [ "type" ], "title": "discount_end", "type": "object", "x-stripeMostCommon": [ "duration", "timestamp", "type" ] }, "promotion_code": { "description": "ID of the promotion code to create a new discount for.", "maxLength": 5000, "type": "string" } }, "title": "discounts_data_param", "type": "object", "x-stripeMostCommon": [ "coupon", "settings" ] }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The coupons to redeem into discounts for the subscription item." }, "id": { "description": "Subscription item to update.", "maxLength": 5000, "type": "string" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "plan": { "description": "Plan ID for this item, as a string.", "maxLength": 5000, "type": "string" }, "price": { "description": "The ID of the price object. One of `price` or `price_data` is required. When changing a subscription item's price, `quantity` is set to 1 unless a `quantity` parameter is provided.", "maxLength": 5000, "type": "string" }, "price_data": { "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.", "properties": { "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "product": { "description": "The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.", "maxLength": 5000, "type": "string" }, "recurring": { "description": "The recurring components of a price such as `interval` and `interval_count`.", "properties": { "interval": { "description": "Specifies billing frequency. Either `day`, `week`, `month` or `year`.", "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "description": "The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).", "type": "integer" } }, "required": [ "interval" ], "title": "recurring_adhoc", "type": "object", "x-stripeMostCommon": [ "interval" ] }, "tax_behavior": { "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.", "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" }, "unit_amount": { "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.", "type": "integer" }, "unit_amount_decimal": { "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", "format": "decimal", "type": "string" } }, "required": [ "currency", "product", "recurring" ], "title": "recurring_price_data", "type": "object", "x-stripeMostCommon": [ "currency", "product", "recurring", "unit_amount" ] }, "quantity": { "description": "Quantity for this item.", "type": "integer" }, "tax_rates": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates." } }, "title": "subscription_item_update_params", "type": "object", "x-stripeMostCommon": [ "billing_thresholds", "clear_usage", "current_trial", "deleted", "discounts", "id", "metadata", "plan", "price", "quantity", "service_starts_at", "tax_rates" ] }, "type": "array" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "off_session": { "description": "Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to `false` (on-session).", "type": "boolean" }, "on_behalf_of": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "The account on behalf of which to charge, for each of the subscription's invoices." }, "pause_collection": { "anyOf": [ { "properties": { "behavior": { "description": "The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.", "enum": [ "keep_as_draft", "mark_uncollectible", "void" ], "type": "string" }, "resumes_at": { "description": "The time after which the subscription will resume collecting payments.", "format": "unix-time", "type": "integer" } }, "required": [ "behavior" ], "title": "pause_collection_param", "type": "object", "x-stripeMostCommon": [ "behavior", "resumes_at" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://stripe.com/docs/billing/subscriptions/pause-payment)." }, "payment_behavior": { "description": "Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior.\n\nUse `default_incomplete` to transition the subscription to `status=past_due` when payment is required and await explicit confirmation of the invoice's payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription’s invoice. Such as failed payments, [SCA regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method.\n\nUse `pending_if_incomplete` to update the subscription using [pending updates](https://stripe.com/docs/billing/subscriptions/pending-updates). When you use `pending_if_incomplete` you can only pass the parameters [supported by pending updates](https://stripe.com/docs/billing/pending-updates-reference#supported-attributes).\n\nUse `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://docs.stripe.com/changelog/2019-03-14) to learn more.", "enum": [ "allow_incomplete", "default_incomplete", "error_if_incomplete", "pending_if_incomplete" ], "type": "string" }, "payment_settings": { "description": "Payment settings to pass to invoices created by the subscription.", "properties": { "payment_method_options": { "description": "Payment-method-specific configuration to provide to invoices created by the subscription.", "properties": { "acss_debit": { "anyOf": [ { "properties": { "mandate_options": { "description": "Additional fields for Mandate creation", "properties": { "transaction_type": { "description": "Transaction type of the mandate.", "enum": [ "business", "personal" ], "type": "string" } }, "title": "mandate_options_param", "type": "object", "x-stripeMostCommon": [ "transaction_type" ] }, "verification_method": { "description": "Verification method for the intent", "enum": [ "automatic", "instant", "microdeposits" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "invoice_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "mandate_options", "verification_method" ] }, { "enum": [ "" ], "type": "string" } ], "description": "This sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to the invoice’s PaymentIntent." }, "bancontact": { "anyOf": [ { "properties": { "preferred_language": { "description": "Preferred language of the Bancontact authorization page that the customer is redirected to.", "enum": [ "de", "en", "fr", "nl" ], "type": "string" } }, "title": "invoice_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "preferred_language" ] }, { "enum": [ "" ], "type": "string" } ], "description": "This sub-hash contains details about the Bancontact payment method options to pass to the invoice’s PaymentIntent." }, "card": { "anyOf": [ { "properties": { "mandate_options": { "description": "Configuration options for setting up an eMandate for cards issued in India.", "properties": { "amount": { "description": "Amount to be charged for future payments.", "type": "integer" }, "amount_type": { "description": "One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.", "enum": [ "fixed", "maximum" ], "type": "string" }, "description": { "description": "A description of the mandate or subscription that is meant to be displayed to the customer.", "maxLength": 200, "type": "string" } }, "title": "mandate_options_param", "type": "object", "x-stripeMostCommon": [ "amount", "amount_type", "description" ] }, "network": { "description": "Selected network to process this Subscription on. Depends on the available networks of the card attached to the Subscription. Can be only set confirm-time.", "enum": [ "amex", "cartes_bancaires", "diners", "discover", "eftpos_au", "girocard", "interac", "jcb", "link", "mastercard", "unionpay", "unknown", "visa" ], "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true }, "request_three_d_secure": { "description": "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.", "enum": [ "any", "automatic", "challenge" ], "type": "string" } }, "title": "subscription_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "mandate_options", "mit_exemption", "network", "request_three_d_secure" ] }, { "enum": [ "" ], "type": "string" } ], "description": "This sub-hash contains details about the Card payment method options to pass to the invoice’s PaymentIntent." }, "customer_balance": { "anyOf": [ { "properties": { "bank_transfer": { "description": "Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`.", "properties": { "eu_bank_transfer": { "description": "Configuration for eu_bank_transfer funding type.", "properties": { "country": { "description": "The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`.", "maxLength": 5000, "type": "string" } }, "required": [ "country" ], "title": "eu_bank_transfer_param", "type": "object", "x-stripeMostCommon": [ "country" ] }, "type": { "description": "The bank transfer type that can be used for funding. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.", "type": "string" } }, "title": "bank_transfer_param", "type": "object", "x-stripeMostCommon": [ "eu_bank_transfer", "id_bank_transfer", "type" ] }, "funding_type": { "description": "The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.", "type": "string" } }, "title": "invoice_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "bank_transfer", "funding_type" ] }, { "enum": [ "" ], "type": "string" } ], "description": "This sub-hash contains details about the Bank transfer payment method options to pass to the invoice’s PaymentIntent." }, "id_bank_transfer": { "anyOf": [ { "properties": {}, "title": "invoice_payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "This sub-hash contains details about the Indonesia bank transfer payment method options to pass to the invoice’s PaymentIntent." }, "konbini": { "anyOf": [ { "properties": {}, "title": "invoice_payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "This sub-hash contains details about the Konbini payment method options to pass to the invoice’s PaymentIntent." }, "pix": { "anyOf": [ { "properties": { "mandate_options": { "description": "Configuration options for setting up a mandate", "properties": { "amount": { "description": "Amount to be charged for future payments. If not provided, defaults to 40000.", "type": "integer" }, "amount_includes_iof": { "description": "Determines if the amount includes the IOF tax. Defaults to `never`.", "enum": [ "always", "never" ], "type": "string" }, "end_date": { "description": "Date when the mandate expires and no further payments will be charged, in `YYYY-MM-DD`. If not provided, the mandate will be active until canceled.", "maxLength": 5000, "type": "string" }, "payment_schedule": { "description": "Schedule at which the future payments will be charged. Defaults to `weekly`.", "enum": [ "halfyearly", "monthly", "quarterly", "weekly", "yearly" ], "type": "string" } }, "title": "subscription_payment_method_options_mandate_options_param", "type": "object", "x-stripeMostCommon": [ "amount", "amount_includes_iof", "end_date", "payment_schedule" ] } }, "title": "subscription_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "mandate_options" ] }, { "enum": [ "" ], "type": "string" } ], "description": "This sub-hash contains details about the Pix payment method options to pass to the invoice’s PaymentIntent." }, "sepa_debit": { "anyOf": [ { "properties": {}, "title": "invoice_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "verification_method" ] }, { "enum": [ "" ], "type": "string" } ], "description": "This sub-hash contains details about the SEPA Direct Debit payment method options to pass to the invoice’s PaymentIntent." }, "upi": { "anyOf": [ { "properties": { "mandate_options": { "description": "Configuration options for setting up an eMandate", "properties": { "amount": { "description": "Amount to be charged for future payments.", "type": "integer" }, "amount_type": { "description": "One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.", "enum": [ "fixed", "maximum" ], "type": "string" }, "description": { "description": "A description of the mandate or subscription that is meant to be displayed to the customer.", "maxLength": 20, "type": "string" }, "end_date": { "description": "End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.", "format": "unix-time", "type": "integer" } }, "title": "invoice_payment_method_options_mandate_options_param", "type": "object", "x-stripeMostCommon": [ "amount", "amount_type", "description", "end_date" ] } }, "title": "invoice_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "mandate_options" ] }, { "enum": [ "" ], "type": "string" } ], "description": "This sub-hash contains details about the UPI payment method options to pass to the invoice’s PaymentIntent." }, "us_bank_account": { "anyOf": [ { "properties": { "financial_connections": { "description": "Additional fields for Financial Connections Session creation", "properties": { "filters": { "description": "Provide filters for the linked accounts that the customer can select for the payment method.", "properties": { "account_subcategories": { "description": "The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.", "items": { "enum": [ "checking", "savings" ], "type": "string" }, "type": "array" }, "institution": { "description": "ID of the institution to use to filter for selectable accounts.", "maxLength": 5000, "type": "string" } }, "title": "invoice_linked_account_options_filters_param", "type": "object", "x-stripeMostCommon": [ "account_subcategories", "institution" ] }, "permissions": { "description": "The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.", "items": { "enum": [ "balances", "ownership", "payment_method", "transactions" ], "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true }, "type": "array" }, "prefetch": { "description": "List of data features that you would like to retrieve upon account creation.", "items": { "enum": [ "balances", "inferred_balances", "ownership", "transactions" ], "type": "string", "x-stripeBypassValidation": true }, "type": "array" } }, "title": "invoice_linked_account_options_param", "type": "object", "x-stripeMostCommon": [ "filters", "permissions", "prefetch" ] }, "verification_method": { "description": "Verification method for the intent", "enum": [ "automatic", "instant", "microdeposits" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "invoice_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "financial_connections", "verification_method" ] }, { "enum": [ "" ], "type": "string" } ], "description": "This sub-hash contains details about the ACH direct debit payment method options to pass to the invoice’s PaymentIntent." } }, "title": "payment_method_options", "type": "object", "x-stripeMostCommon": [ "acss_debit", "bancontact", "card", "customer_balance", "id_bank_transfer", "konbini", "pix", "sepa_debit", "upi", "us_bank_account" ] }, "payment_method_types": { "anyOf": [ { "items": { "enum": [ "ach_credit_transfer", "ach_debit", "acss_debit", "affirm", "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", "boleto", "card", "cashapp", "crypto", "custom", "customer_balance", "eps", "fpx", "giropay", "grabpay", "id_bank_transfer", "ideal", "jp_credit_transfer", "kakao_pay", "klarna", "konbini", "kr_card", "link", "multibanco", "naver_pay", "nz_bank_account", "p24", "payco", "paynow", "paypal", "pix", "promptpay", "revolut_pay", "sepa_credit_transfer", "sepa_debit", "sofort", "stripe_balance", "swish", "upi", "us_bank_account", "wechat_pay" ], "type": "string", "x-stripeBypassValidation": true }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The list of payment method types (e.g. card) to provide to the invoice’s PaymentIntent. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your [invoice template settings](https://dashboard.stripe.com/settings/billing/invoice). Should not be specified with payment_method_configuration" }, "save_default_payment_method": { "description": "Configure whether Stripe updates `subscription.default_payment_method` when payment succeeds. Defaults to `off` if unspecified.", "enum": [ "off", "on_subscription" ], "type": "string" } }, "title": "payment_settings", "type": "object", "x-stripeMostCommon": [ "payment_method_configuration", "payment_method_options", "payment_method_types", "save_default_payment_method" ] }, "pending_invoice_item_interval": { "anyOf": [ { "properties": { "interval": { "description": "Specifies invoicing frequency. Either `day`, `week`, `month` or `year`.", "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "description": "The number of intervals between invoices. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks).", "type": "integer" } }, "required": [ "interval" ], "title": "pending_invoice_item_interval_params", "type": "object", "x-stripeMostCommon": [ "interval", "interval_count" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://stripe.com/docs/api#create_invoice) for the given subscription at the specified interval." }, "prebilling": { "description": "If specified, the invoicing for the given billing cycle iterations will be processed now.", "properties": { "iterations": { "description": "This is used to determine the number of billing cycles to prebill.", "type": "integer" }, "update_behavior": { "description": "Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period. The default value is `reset`.", "enum": [ "prebill", "reset" ], "type": "string" } }, "required": [ "iterations" ], "title": "prebilling_specs", "type": "object", "x-stripeMostCommon": [ "iterations", "update_behavior" ] }, "proration_behavior": { "description": "Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.", "enum": [ "always_invoice", "create_prorations", "none" ], "type": "string" }, "proration_date": { "description": "If set, prorations will be calculated as though the subscription was updated at the given time. This can be used to apply exactly the same prorations that were previewed with the [create preview](https://stripe.com/docs/api/invoices/create_preview) endpoint. `proration_date` can also be used to implement custom proration logic, such as prorating by day instead of by second, by providing the time that you wish to use for proration calculations.", "format": "unix-time", "type": "integer" }, "transfer_data": { "anyOf": [ { "properties": { "amount_percent": { "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination.", "type": "number" }, "destination": { "description": "ID of an existing, connected Stripe account.", "type": "string" } }, "required": [ "destination" ], "title": "transfer_data_specs", "type": "object", "x-stripeMostCommon": [ "amount_percent", "destination" ] }, { "enum": [ "" ], "type": "string" } ], "description": "If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges. This will be unset if you POST an empty value." }, "trial_end": { "anyOf": [ { "enum": [ "now" ], "maxLength": 5000, "type": "string" }, { "format": "unix-time", "type": "integer" } ], "description": "Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. If set, `trial_end` will override the default trial period of the plan the customer is being subscribed to. The `billing_cycle_anchor` will be updated to the `trial_end` value. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`." }, "trial_from_plan": { "description": "Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more.", "type": "boolean" }, "trial_settings": { "description": "Settings related to subscription trials.", "properties": { "end_behavior": { "description": "Defines how the subscription should behave when the user's free trial ends.", "properties": { "missing_payment_method": { "description": "Indicates how the subscription should change when the trial ends if the user did not provide a payment method.", "enum": [ "cancel", "create_invoice", "pause" ], "type": "string" } }, "required": [ "missing_payment_method" ], "title": "end_behavior", "type": "object", "x-stripeMostCommon": [ "missing_payment_method" ] } }, "required": [ "end_behavior" ], "title": "trial_settings_config", "type": "object", "x-stripeMostCommon": [ "end_behavior" ] } }, "type": "object", "x-stripeMostCommon": [ "automatic_tax", "default_payment_method", "description", "items", "metadata", "payment_behavior", "proration_behavior" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/subscription" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a subscription" } }, "/v1/subscriptions/{subscription_exposed_id}/discount": { "delete": { "description": "

Removes the currently applied discount on a subscription.

", "operationId": "DeleteSubscriptionsSubscriptionExposedIdDiscount", "parameters": [ { "in": "path", "name": "subscription_exposed_id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted_discount" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Delete a subscription discount" } }, "/v1/subscriptions/{subscription}/migrate": { "post": { "description": "

Upgrade the billing_mode of an existing subscription.

", "operationId": "PostSubscriptionsSubscriptionMigrate", "parameters": [ { "in": "path", "name": "subscription", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "billing_mode": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "billing_mode": { "description": "Controls how prorations and invoices for subscriptions are calculated and orchestrated.", "properties": { "type": { "enum": [ "flexible" ], "type": "string" } }, "required": [ "type" ], "title": "billing_mode_migrate", "type": "object", "x-stripeMostCommon": [ "type" ] }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "required": [ "billing_mode" ], "type": "object", "x-stripeMostCommon": [ "billing_mode" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/subscription" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Migrate a subscription" } }, "/v1/subscriptions/{subscription}/resume": { "post": { "description": "

Initiates resumption of a paused subscription, optionally resetting the billing cycle anchor and creating prorations. If a resumption invoice is generated, it must be paid or marked uncollectible before the subscription will be unpaused. If payment succeeds the subscription will become active, and if payment fails the subscription will be past_due. The resumption invoice will void automatically if not paid by the expiration date.

", "operationId": "PostSubscriptionsSubscriptionResume", "parameters": [ { "in": "path", "name": "subscription", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "billing_cycle_anchor": { "description": "The billing cycle anchor that applies when the subscription is resumed. Either `now` or `unchanged`. The default is `now`. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).", "enum": [ "now", "unchanged" ], "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "proration_behavior": { "description": "Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) resulting from the `billing_cycle_anchor` being `unchanged`. When the `billing_cycle_anchor` is set to `now` (default value), no prorations are generated. If no value is passed, the default is `create_prorations`.", "enum": [ "always_invoice", "create_prorations", "none" ], "type": "string" }, "proration_date": { "description": "If set, prorations will be calculated as though the subscription was resumed at the given time. This can be used to apply exactly the same prorations that were previewed with the [create preview](https://stripe.com/docs/api/invoices/create_preview) endpoint.", "format": "unix-time", "type": "integer" } }, "type": "object", "x-stripeMostCommon": [ "billing_cycle_anchor", "proration_behavior" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/subscription" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Resume a subscription" } }, "/v1/tax/associations/find": { "get": { "description": "

Finds a tax association object by PaymentIntent id.

", "operationId": "GetTaxAssociationsFind", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "Valid [PaymentIntent](https://stripe.com/docs/api/payment_intents/object) id", "in": "query", "name": "payment_intent", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax.association" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Find a Tax Association" } }, "/v1/tax/calculations": { "post": { "description": "

Calculates tax based on the input and returns a Tax Calculation object.

", "operationId": "PostTaxCalculations", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "customer_details": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "line_items": { "explode": true, "style": "deepObject" }, "ship_from_details": { "explode": true, "style": "deepObject" }, "shipping_cost": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "customer": { "description": "The ID of an existing customer to use for this calculation. If provided, the customer's address and tax IDs are copied to `customer_details`.", "maxLength": 5000, "type": "string" }, "customer_details": { "description": "Details about the customer, including address and tax IDs.", "properties": { "address": { "description": "The customer's postal address (for example, home or business location).", "properties": { "city": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "City, district, suburb, town, or village." }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Address line 1 (e.g., street, PO Box, or company name)." }, "line2": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Address line 2 (e.g., apartment, suite, unit, or building)." }, "postal_code": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "ZIP or postal code." }, "state": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "State, county, province, or region. We recommend sending [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) subdivision code value when possible." } }, "required": [ "country" ], "title": "postal_address", "type": "object", "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state" ] }, "address_source": { "description": "The type of customer address provided.", "enum": [ "billing", "shipping" ], "type": "string" }, "ip_address": { "description": "The customer's IP address (IPv4 or IPv6).", "type": "string" }, "tax_ids": { "description": "The customer's tax IDs. Stripe Tax might consider a transaction with applicable tax IDs to be B2B, which might affect the tax calculation result. Stripe Tax doesn't validate tax IDs for correctness.", "items": { "properties": { "type": { "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `aw_tin`, `az_tin`, `ba_tin`, `bb_tin`, `bd_bin`, `bf_ifu`, `bg_uic`, `bh_vat`, `bj_ifu`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cm_niu`, `cn_tin`, `co_nit`, `cr_tin`, `cv_nif`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `et_tin`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kg_tin`, `kh_tin`, `kr_brn`, `kz_bin`, `la_tin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin`", "enum": [ "ad_nrt", "ae_trn", "al_tin", "am_tin", "ao_tin", "ar_cuit", "au_abn", "au_arn", "aw_tin", "az_tin", "ba_tin", "bb_tin", "bd_bin", "bf_ifu", "bg_uic", "bh_vat", "bj_ifu", "bo_tin", "br_cnpj", "br_cpf", "bs_tin", "by_tin", "ca_bn", "ca_gst_hst", "ca_pst_bc", "ca_pst_mb", "ca_pst_sk", "ca_qst", "cd_nif", "ch_uid", "ch_vat", "cl_tin", "cm_niu", "cn_tin", "co_nit", "cr_tin", "cv_nif", "de_stn", "do_rcn", "ec_ruc", "eg_tin", "es_cif", "et_tin", "eu_oss_vat", "eu_vat", "gb_vat", "ge_vat", "gn_nif", "hk_br", "hr_oib", "hu_tin", "id_npwp", "il_vat", "in_gst", "is_vat", "jp_cn", "jp_rn", "jp_trn", "ke_pin", "kg_tin", "kh_tin", "kr_brn", "kz_bin", "la_tin", "li_uid", "li_vat", "ma_vat", "md_vat", "me_pib", "mk_vat", "mr_nif", "mx_rfc", "my_frp", "my_itn", "my_sst", "ng_tin", "no_vat", "no_voec", "np_pan", "nz_gst", "om_vat", "pe_ruc", "ph_tin", "ro_tin", "rs_pib", "ru_inn", "ru_kpp", "sa_vat", "sg_gst", "sg_uen", "si_tin", "sn_ninea", "sr_fin", "sv_nit", "th_vat", "tj_tin", "tr_tin", "tw_vat", "tz_vat", "ua_vat", "ug_tin", "us_ein", "uy_ruc", "uz_tin", "uz_vat", "ve_rif", "vn_tin", "za_vat", "zm_tin", "zw_tin" ], "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true }, "value": { "description": "Value of the tax ID.", "type": "string" } }, "required": [ "type", "value" ], "title": "data_params", "type": "object", "x-stripeMostCommon": [ "type", "value" ] }, "type": "array" }, "taxability_override": { "description": "Overrides the tax calculation result to allow you to not collect tax from your customer. Use this if you've manually checked your customer's tax exemptions. Prefer providing the customer's `tax_ids` where possible, which automatically determines whether `reverse_charge` applies.", "enum": [ "customer_exempt", "none", "reverse_charge" ], "type": "string" } }, "title": "customer_details", "type": "object", "x-stripeMostCommon": [ "address", "address_source", "ip_address", "tax_ids", "taxability_override" ] }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "line_items": { "description": "A list of items the customer is purchasing.", "items": { "properties": { "amount": { "description": "A positive integer representing the line item's total price in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).\nIf `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes are calculated on top of this amount.", "type": "integer" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "type": "object" }, "product": { "description": "If provided, the product's `tax_code` will be used as the line item's `tax_code`.", "maxLength": 5000, "type": "string" }, "quantity": { "description": "The number of units of the item being purchased. Used to calculate the per-unit price from the total `amount` for the line. For example, if `amount=100` and `quantity=4`, the calculated unit price is 25.", "type": "integer" }, "reference": { "description": "A custom identifier for this line item, which must be unique across the line items in the calculation. The reference helps identify each line item in exported [tax reports](https://stripe.com/docs/tax/reports).", "maxLength": 500, "type": "string" }, "tax_behavior": { "description": "Specifies whether the `amount` includes taxes. Defaults to `exclusive`.", "enum": [ "exclusive", "inclusive" ], "type": "string" }, "tax_code": { "description": "A [tax code](https://stripe.com/docs/tax/tax-categories) ID to use for this line item. If not provided, we will use the tax code from the provided `product` param. If neither `tax_code` nor `product` is provided, we will use the default tax code from your Tax Settings.", "type": "string" } }, "required": [ "amount" ], "title": "calculation_line_item", "type": "object", "x-stripeMostCommon": [ "amount", "metadata", "performance_location", "product", "quantity", "reference", "tax_behavior", "tax_code" ] }, "type": "array" }, "ship_from_details": { "description": "Details about the address from which the goods are being shipped.", "properties": { "address": { "description": "The address from which the goods are being shipped from.", "properties": { "city": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "City, district, suburb, town, or village." }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Address line 1 (e.g., street, PO Box, or company name)." }, "line2": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Address line 2 (e.g., apartment, suite, unit, or building)." }, "postal_code": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "ZIP or postal code." }, "state": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "State/province as an [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) subdivision code, without country prefix. Example: \"NY\" or \"TX\"." } }, "required": [ "country" ], "title": "merchant_postal_address", "type": "object", "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state" ] } }, "required": [ "address" ], "title": "ship_from_details", "type": "object", "x-stripeMostCommon": [ "address" ] }, "shipping_cost": { "description": "Shipping cost details to be used for the calculation.", "properties": { "amount": { "description": "A positive integer in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) representing the shipping charge. If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes are calculated on top of this amount.", "type": "integer" }, "shipping_rate": { "description": "If provided, the [shipping rate](https://stripe.com/docs/api/shipping_rates/object)'s `amount`, `tax_code` and `tax_behavior` are used. If you provide a shipping rate, then you cannot pass the `amount`, `tax_code`, or `tax_behavior` parameters.", "maxLength": 5000, "type": "string" }, "tax_behavior": { "description": "Specifies whether the `amount` includes taxes. If `tax_behavior=inclusive`, then the amount includes taxes. Defaults to `exclusive`.", "enum": [ "exclusive", "inclusive" ], "type": "string" }, "tax_code": { "description": "The [tax code](https://stripe.com/docs/tax/tax-categories) used to calculate tax on shipping. If not provided, the default shipping tax code from your [Tax Settings](https://dashboard.stripe.com/settings/tax) is used.", "type": "string" } }, "title": "shipping_cost", "type": "object", "x-stripeMostCommon": [ "amount", "shipping_rate", "tax_behavior", "tax_code" ] }, "tax_date": { "description": "Timestamp of date at which the tax rules and rates in effect applies for the calculation. Measured in seconds since the Unix epoch. Can be up to 48 hours in the past, and up to 48 hours in the future.", "type": "integer" } }, "required": [ "currency", "line_items" ], "type": "object", "x-stripeMostCommon": [ "currency", "customer_details", "line_items", "shipping_cost" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax.calculation" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a Tax Calculation" } }, "/v1/tax/calculations/{calculation}": { "get": { "description": "

Retrieves a Tax Calculation object, if the calculation hasn’t expired.

", "operationId": "GetTaxCalculationsCalculation", "parameters": [ { "in": "path", "name": "calculation", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax.calculation" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a Tax Calculation" } }, "/v1/tax/calculations/{calculation}/line_items": { "get": { "description": "

Retrieves the line items of a tax calculation as a collection, if the calculation hasn’t expired.

", "operationId": "GetTaxCalculationsCalculationLineItems", "parameters": [ { "in": "path", "name": "calculation", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 500, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 500, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/tax.calculation_line_item" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/tax/calculations/[^/]+/line_items", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "TaxProductResourceTaxCalculationLineItemList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a calculation's line items" } }, "/v1/tax/forms": { "get": { "description": "

Returns a list of tax forms which were previously created. The tax forms are returned in sorted order, with the oldest tax forms appearing first.

", "operationId": "GetTaxForms", "parameters": [ { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "The payee whose volume is represented on the tax form.", "explode": true, "in": "query", "name": "payee", "required": true, "schema": { "properties": { "account": { "description": "The ID of the Stripe account whose forms will be retrieved.", "maxLength": 5000, "type": "string" }, "external_reference": { "description": "The external reference to the payee whose forms will be retrieved.", "maxLength": 5000, "type": "string" }, "type": { "description": "Specifies the payee type. Either `account` or `external_reference`.", "enum": [ "account", "external_reference" ], "type": "string" } }, "title": "payee_params", "type": "object", "x-stripeMostCommon": [ "account", "external_reference", "type" ] }, "style": "deepObject" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "An optional filter on the list, based on the object `type` field. Without the filter, the list includes all current and future tax form types. If your integration expects only one type of tax form in the response, make sure to provide a type value in the request.", "in": "query", "name": "type", "required": false, "schema": { "enum": [ "au_serr", "ca_mrdp", "eu_dac7", "gb_mrdp", "nz_mrdp", "us_1099_k", "us_1099_misc", "us_1099_nec" ], "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/tax.form" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "TaxReportingResourceTaxFormList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all tax forms" } }, "/v1/tax/forms/{id}": { "get": { "description": "

Retrieves the details of a tax form that has previously been created. Supply the unique tax form ID that was returned from your previous request, and Stripe will return the corresponding tax form information.

", "operationId": "GetTaxFormsId", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax.form" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a tax form" } }, "/v1/tax/forms/{id}/pdf": { "get": { "description": "

Download the PDF for a tax form.

", "operationId": "GetTaxFormsIdPdf", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/pdf": { "schema": { "format": "binary", "type": "string" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "servers": [ { "url": "https://files.stripe.com/" } ], "summary": "Download tax form PDF" } }, "/v1/tax/registrations": { "get": { "description": "

Returns a list of Tax Registration objects.

", "operationId": "GetTaxRegistrations", "parameters": [ { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "The status of the Tax Registration.", "in": "query", "name": "status", "required": false, "schema": { "enum": [ "active", "all", "expired", "scheduled" ], "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/tax.registration" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/tax/registrations", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "TaxProductRegistrationsResourceTaxRegistrationList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List registrations" }, "post": { "description": "

Creates a new Tax Registration object.

", "operationId": "PostTaxRegistrations", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "active_from": { "explode": true, "style": "deepObject" }, "country_options": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "active_from": { "anyOf": [ { "enum": [ "now" ], "maxLength": 5000, "type": "string" }, { "format": "unix-time", "type": "integer" } ], "description": "Time at which the Tax Registration becomes active. It can be either `now` to indicate the current time, or a future timestamp measured in seconds since the Unix epoch." }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "country_options": { "description": "Specific options for a registration in the specified `country`.", "properties": { "ae": { "description": "Options for the registration in AE.", "properties": { "standard": { "description": "Options for the standard registration.", "properties": { "place_of_supply_scheme": { "description": "Place of supply scheme used in an standard registration.", "enum": [ "inbound_goods", "standard" ], "type": "string" } }, "title": "standard", "type": "object", "x-stripeMostCommon": [ "place_of_supply_scheme" ] }, "type": { "description": "Type of registration to be created in `country`.", "enum": [ "standard" ], "type": "string" } }, "required": [ "type" ], "title": "default", "type": "object", "x-stripeMostCommon": [ "standard", "type" ] }, "al": { "description": "Options for the registration in AL.", "properties": { "standard": { "description": "Options for the standard registration.", "properties": { "place_of_supply_scheme": { "description": "Place of supply scheme used in an standard registration.", "enum": [ "inbound_goods", "standard" ], "type": "string" } }, "title": "standard", "type": "object", "x-stripeMostCommon": [ "place_of_supply_scheme" ] }, "type": { "description": "Type of registration to be created in `country`.", "enum": [ "standard" ], "type": "string" } }, "required": [ "type" ], "title": "default", "type": "object", "x-stripeMostCommon": [ "standard", "type" ] }, "am": { "description": "Options for the registration in AM.", "properties": { "type": { "description": "Type of registration to be created in `country`.", "enum": [ "simplified" ], "type": "string" } }, "required": [ "type" ], "title": "simplified", "type": "object", "x-stripeMostCommon": [ "type" ] }, "ao": { "description": "Options for the registration in AO.", "properties": { "standard": { "description": "Options for the standard registration.", "properties": { "place_of_supply_scheme": { "description": "Place of supply scheme used in an standard registration.", "enum": [ "inbound_goods", "standard" ], "type": "string" } }, "title": "standard", "type": "object", "x-stripeMostCommon": [ "place_of_supply_scheme" ] }, "type": { "description": "Type of registration to be created in `country`.", "enum": [ "standard" ], "type": "string" } }, "required": [ "type" ], "title": "default", "type": "object", "x-stripeMostCommon": [ "standard", "type" ] }, "at": { "description": "Options for the registration in AT.", "properties": { "standard": { "description": "Options for the standard registration.", "properties": { "place_of_supply_scheme": { "description": "Place of supply scheme used in an EU standard registration.", "enum": [ "inbound_goods", "small_seller", "standard" ], "type": "string" } }, "required": [ "place_of_supply_scheme" ], "title": "standard", "type": "object", "x-stripeMostCommon": [ "place_of_supply_scheme" ] }, "type": { "description": "Type of registration to be created in an EU country.", "enum": [ "ioss", "oss_non_union", "oss_union", "standard" ], "type": "string" } }, "required": [ "type" ], "title": "europe", "type": "object", "x-stripeMostCommon": [ "standard", "type" ] }, "au": { "description": "Options for the registration in AU.", "properties": { "standard": { "description": "Options for the standard registration.", "properties": { "place_of_supply_scheme": { "description": "Place of supply scheme used in an standard registration.", "enum": [ "inbound_goods", "standard" ], "type": "string" } }, "title": "standard", "type": "object", "x-stripeMostCommon": [ "place_of_supply_scheme" ] }, "type": { "description": "Type of registration to be created in `country`.", "enum": [ "standard" ], "type": "string" } }, "required": [ "type" ], "title": "default", "type": "object", "x-stripeMostCommon": [ "standard", "type" ] }, "aw": { "description": "Options for the registration in AW.", "properties": { "standard": { "description": "Options for the standard registration.", "properties": { "place_of_supply_scheme": { "description": "Place of supply scheme used in an standard registration.", "enum": [ "inbound_goods", "standard" ], "type": "string" } }, "title": "standard", "type": "object", "x-stripeMostCommon": [ "place_of_supply_scheme" ] }, "type": { "description": "Type of registration to be created in `country`.", "enum": [ "standard" ], "type": "string" } }, "required": [ "type" ], "title": "default", "type": "object", "x-stripeMostCommon": [ "standard", "type" ] }, "az": { "description": "Options for the registration in AZ.", "properties": { "type": { "description": "Type of registration to be created in `country`.", "enum": [ "simplified" ], "type": "string" } }, "required": [ "type" ], "title": "simplified", "type": "object", "x-stripeMostCommon": [ "type" ] }, "ba": { "description": "Options for the registration in BA.", "properties": { "standard": { "description": "Options for the standard registration.", "properties": { "place_of_supply_scheme": { "description": "Place of supply scheme used in an standard registration.", "enum": [ "inbound_goods", "standard" ], "type": "string" } }, "title": "standard", "type": "object", "x-stripeMostCommon": [ "place_of_supply_scheme" ] }, "type": { "description": "Type of registration to be created in `country`.", "enum": [ "standard" ], "type": "string" } }, "required": [ "type" ], "title": "default", "type": "object", "x-stripeMostCommon": [ "standard", "type" ] }, "bb": { "description": "Options for the registration in BB.", "properties": { "standard": { "description": "Options for the standard registration.", "properties": { "place_of_supply_scheme": { "description": "Place of supply scheme used in an standard registration.", "enum": [ "inbound_goods", "standard" ], "type": "string" } }, "title": "standard", "type": "object", "x-stripeMostCommon": [ "place_of_supply_scheme" ] }, "type": { "description": "Type of registration to be created in `country`.", "enum": [ "standard" ], "type": "string" } }, "required": [ "type" ], "title": "default", "type": "object", "x-stripeMostCommon": [ "standard", "type" ] }, "bd": { "description": "Options for the registration in BD.", "properties": { "standard": { "description": "Options for the standard registration.", "properties": { "place_of_supply_scheme": { "description": "Place of supply scheme used in an standard registration.", "enum": [ "inbound_goods", "standard" ], "type": "string" } }, "title": "standard", "type": "object", "x-stripeMostCommon": [ "place_of_supply_scheme" ] }, "type": { "description": "Type of registration to be created in `country`.", "enum": [ "standard" ], "type": "string" } }, "required": [ "type" ], "title": "default", "type": "object", "x-stripeMostCommon": [ "standard", "type" ] }, "be": { "description": "Options for the registration in BE.", "properties": { "standard": { "description": "Options for the standard registration.", "properties": { "place_of_supply_scheme": { "description": "Place of supply scheme used in an EU standard registration.", "enum": [ "inbound_goods", "small_seller", "standard" ], "type": "string" } }, "required": [ "place_of_supply_scheme" ], "title": "standard", "type": "object", "x-stripeMostCommon": [ "place_of_supply_scheme" ] }, "type": { "description": "Type of registration to be created in an EU country.", "enum": [ "ioss", "oss_non_union", "oss_union", "standard" ], "type": "string" } }, "required": [ "type" ], "title": "europe", "type": "object", "x-stripeMostCommon": [ "standard", "type" ] }, "bf": { "description": "Options for the registration in BF.", "properties": { "standard": { "description": "Options for the standard registration.", "properties": { "place_of_supply_scheme": { "description": "Place of supply scheme used in an standard registration.", "enum": [ "inbound_goods", "standard" ], "type": "string" } }, "title": "standard", "type": "object", "x-stripeMostCommon": [ "place_of_supply_scheme" ] }, "type": { "description": "Type of registration to be created in `country`.", "enum": [ "standard" ], "type": "string" } }, "required": [ "type" ], "title": "default", "type": "object", "x-stripeMostCommon": [ "standard", "type" ] }, "bg": { "description": "Options for the registration in BG.", "properties": { "standard": { "description": "Options for the standard registration.", "properties": { "place_of_supply_scheme": { "description": "Place of supply scheme used in an EU standard registration.", "enum": [ "inbound_goods", "small_seller", "standard" ], "type": "string" } }, "required": [ "place_of_supply_scheme" ], "title": "standard", "type": "object", "x-stripeMostCommon": [ "place_of_supply_scheme" ] }, "type": { "description": "Type of registration to be created in an EU country.", "enum": [ "ioss", "oss_non_union", "oss_union", "standard" ], "type": "string" } }, "required": [ "type" ], "title": "europe", "type": "object", "x-stripeMostCommon": [ "standard", "type" ] }, "bh": { "description": "Options for the registration in BH.", "properties": { "standard": { "description": "Options for the standard registration.", "properties": { "place_of_supply_scheme": { "description": "Place of supply scheme used in an standard registration.", "enum": [ "inbound_goods", "standard" ], "type": "string" } }, "title": "standard", "type": "object", "x-stripeMostCommon": [ "place_of_supply_scheme" ] }, "type": { "description": "Type of registration to be created in `country`.", "enum": [ "standard" ], "type": "string" } }, "required": [ "type" ], "title": "default", "type": "object", "x-stripeMostCommon": [ "standard", "type" ] }, "bj": { "description": "Options for the registration in BJ.", "properties": { "type": { "description": "Type of registration to be created in `country`.", "enum": [ "simplified" ], "type": "string" } }, "required": [ "type" ], "title": "simplified", "type": "object", "x-stripeMostCommon": [ "type" ] }, "bs": { "description": "Options for the registration in BS.", "properties": { "standard": { "description": "Options for the standard registration.", "properties": { "place_of_supply_scheme": { "description": "Place of supply scheme used in an standard registration.", "enum": [ "inbound_goods", "standard" ], "type": "string" } }, "title": "standard", "type": "object", "x-stripeMostCommon": [ "place_of_supply_scheme" ] }, "type": { "description": "Type of registration to be created in `country`.", "enum": [ "standard" ], "type": "string" } }, "required": [ "type" ], "title": "default", "type": "object", "x-stripeMostCommon": [ "standard", "type" ] }, "by": { "description": "Options for the registration in BY.", "properties": { "type": { "description": "Type of registration to be created in `country`.", "enum": [ "simplified" ], "type": "string" } }, "required": [ "type" ], "title": "simplified", "type": "object", "x-stripeMostCommon": [ "type" ] }, "ca": { "description": "Options for the registration in CA.", "properties": { "province_standard": { "description": "Options for the provincial tax registration.", "properties": { "province": { "description": "Two-letter CA province code ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).", "maxLength": 5000, "type": "string" } }, "required": [ "province" ], "title": "province_standard", "type": "object", "x-stripeMostCommon": [ "province" ] }, "type": { "description": "Type of registration to be created in Canada.", "enum": [ "province_standard", "simplified", "standard" ], "type": "string" } }, "required": [ "type" ], "title": "canada", "type": "object", "x-stripeMostCommon": [ "province_standard", "type" ] }, "cd": { "description": "Options for the registration in CD.", "properties": { "standard": { "description": "Options for the standard registration.", "properties": { "place_of_supply_scheme": { "description": "Place of supply scheme used in an standard registration.", "enum": [ "inbound_goods", "standard" ], "type": "string" } }, "title": "standard", "type": "object", "x-stripeMostCommon": [ "place_of_supply_scheme" ] }, "type": { "description": "Type of registration to be created in `country`.", "enum": [ "standard" ], "type": "string" } }, "required": [ "type" ], "title": "default", "type": "object", "x-stripeMostCommon": [ "standard", "type" ] }, "ch": { "description": "Options for the registration in CH.", "properties": { "standard": { "description": "Options for the standard registration.", "properties": { "place_of_supply_scheme": { "description": "Place of supply scheme used in an standard registration.", "enum": [ "inbound_goods", "standard" ], "type": "string" } }, "title": "standard", "type": "object", "x-stripeMostCommon": [ "place_of_supply_scheme" ] }, "type": { "description": "Type of registration to be created in `country`.", "enum": [ "standard" ], "type": "string" } }, "required": [ "type" ], "title": "default", "type": "object", "x-stripeMostCommon": [ "standard", "type" ] }, "cl": { "description": "Options for the registration in CL.", "properties": { "type": { "description": "Type of registration to be created in `country`.", "enum": [ "simplified" ], "type": "string" } }, "required": [ "type" ], "title": "simplified", "type": "object", "x-stripeMostCommon": [ "type" ] }, "cm": { "description": "Options for the registration in CM.", "properties": { "type": { "description": "Type of registration to be created in `country`.", "enum": [ "simplified" ], "type": "string" } }, "required": [ "type" ], "title": "simplified", "type": "object", "x-stripeMostCommon": [ "type" ] }, "co": { "description": "Options for the registration in CO.", "properties": { "type": { "description": "Type of registration to be created in `country`.", "enum": [ "simplified" ], "type": "string" } }, "required": [ "type" ], "title": "simplified", "type": "object", "x-stripeMostCommon": [ "type" ] }, "cr": { "description": "Options for the registration in CR.", "properties": { "type": { "description": "Type of registration to be created in `country`.", "enum": [ "simplified" ], "type": "string" } }, "required": [ "type" ], "title": "simplified", "type": "object", "x-stripeMostCommon": [ "type" ] }, "cv": { "description": "Options for the registration in CV.", "properties": { "type": { "description": "Type of registration to be created in `country`.", "enum": [ "simplified" ], "type": "string" } }, "required": [ "type" ], "title": "simplified", "type": "object", "x-stripeMostCommon": [ "type" ] }, "cy": { "description": "Options for the registration in CY.", "properties": { "standard": { "description": "Options for the standard registration.", "properties": { "place_of_supply_scheme": { "description": "Place of supply scheme used in an EU standard registration.", "enum": [ "inbound_goods", "small_seller", "standard" ], "type": "string" } }, "required": [ "place_of_supply_scheme" ], "title": "standard", "type": "object", "x-stripeMostCommon": [ "place_of_supply_scheme" ] }, "type": { "description": "Type of registration to be created in an EU country.", "enum": [ "ioss", "oss_non_union", "oss_union", "standard" ], "type": "string" } }, "required": [ "type" ], "title": "europe", "type": "object", "x-stripeMostCommon": [ "standard", "type" ] }, "cz": { "description": "Options for the registration in CZ.", "properties": { "standard": { "description": "Options for the standard registration.", "properties": { "place_of_supply_scheme": { "description": "Place of supply scheme used in an EU standard registration.", "enum": [ "inbound_goods", "small_seller", "standard" ], "type": "string" } }, "required": [ "place_of_supply_scheme" ], "title": "standard", "type": "object", "x-stripeMostCommon": [ "place_of_supply_scheme" ] }, "type": { "description": "Type of registration to be created in an EU country.", "enum": [ "ioss", "oss_non_union", "oss_union", "standard" ], "type": "string" } }, "required": [ "type" ], "title": "europe", "type": "object", "x-stripeMostCommon": [ "standard", "type" ] }, "de": { "description": "Options for the registration in DE.", "properties": { "standard": { "description": "Options for the standard registration.", "properties": { "place_of_supply_scheme": { "description": "Place of supply scheme used in an EU standard registration.", "enum": [ "inbound_goods", "small_seller", "standard" ], "type": "string" } }, "required": [ "place_of_supply_scheme" ], "title": "standard", "type": "object", "x-stripeMostCommon": [ "place_of_supply_scheme" ] }, "type": { "description": "Type of registration to be created in an EU country.", "enum": [ "ioss", "oss_non_union", "oss_union", "standard" ], "type": "string" } }, "required": [ "type" ], "title": "europe", "type": "object", "x-stripeMostCommon": [ "standard", "type" ] }, "dk": { "description": "Options for the registration in DK.", "properties": { "standard": { "description": "Options for the standard registration.", "properties": { "place_of_supply_scheme": { "description": "Place of supply scheme used in an EU standard registration.", "enum": [ "inbound_goods", "small_seller", "standard" ], "type": "string" } }, "required": [ "place_of_supply_scheme" ], "title": "standard", "type": "object", "x-stripeMostCommon": [ "place_of_supply_scheme" ] }, "type": { "description": "Type of registration to be created in an EU country.", "enum": [ "ioss", "oss_non_union", "oss_union", "standard" ], "type": "string" } }, "required": [ "type" ], "title": "europe", "type": "object", "x-stripeMostCommon": [ "standard", "type" ] }, "ec": { "description": "Options for the registration in EC.", "properties": { "type": { "description": "Type of registration to be created in `country`.", "enum": [ "simplified" ], "type": "string" } }, "required": [ "type" ], "title": "simplified", "type": "object", "x-stripeMostCommon": [ "type" ] }, "ee": { "description": "Options for the registration in EE.", "properties": { "standard": { "description": "Options for the standard registration.", "properties": { "place_of_supply_scheme": { "description": "Place of supply scheme used in an EU standard registration.", "enum": [ "inbound_goods", "small_seller", "standard" ], "type": "string" } }, "required": [ "place_of_supply_scheme" ], "title": "standard", "type": "object", "x-stripeMostCommon": [ "place_of_supply_scheme" ] }, "type": { "description": "Type of registration to be created in an EU country.", "enum": [ "ioss", "oss_non_union", "oss_union", "standard" ], "type": "string" } }, "required": [ "type" ], "title": "europe", "type": "object", "x-stripeMostCommon": [ "standard", "type" ] }, "eg": { "description": "Options for the registration in EG.", "properties": { "type": { "description": "Type of registration to be created in `country`.", "enum": [ "simplified" ], "type": "string" } }, "required": [ "type" ], "title": "simplified", "type": "object", "x-stripeMostCommon": [ "type" ] }, "es": { "description": "Options for the registration in ES.", "properties": { "standard": { "description": "Options for the standard registration.", "properties": { "place_of_supply_scheme": { "description": "Place of supply scheme used in an EU standard registration.", "enum": [ "inbound_goods", "small_seller", "standard" ], "type": "string" } }, "required": [ "place_of_supply_scheme" ], "title": "standard", "type": "object", "x-stripeMostCommon": [ "place_of_supply_scheme" ] }, "type": { "description": "Type of registration to be created in an EU country.", "enum": [ "ioss", "oss_non_union", "oss_union", "standard" ], "type": "string" } }, "required": [ "type" ], "title": "europe", "type": "object", "x-stripeMostCommon": [ "standard", "type" ] }, "et": { "description": "Options for the registration in ET.", "properties": { "standard": { "description": "Options for the standard registration.", "properties": { "place_of_supply_scheme": { "description": "Place of supply scheme used in an standard registration.", "enum": [ "inbound_goods", "standard" ], "type": "string" } }, "title": "standard", "type": "object", "x-stripeMostCommon": [ "place_of_supply_scheme" ] }, "type": { "description": "Type of registration to be created in `country`.", "enum": [ "standard" ], "type": "string" } }, "required": [ "type" ], "title": "default", "type": "object", "x-stripeMostCommon": [ "standard", "type" ] }, "fi": { "description": "Options for the registration in FI.", "properties": { "standard": { "description": "Options for the standard registration.", "properties": { "place_of_supply_scheme": { "description": "Place of supply scheme used in an EU standard registration.", "enum": [ "inbound_goods", "small_seller", "standard" ], "type": "string" } }, "required": [ "place_of_supply_scheme" ], "title": "standard", "type": "object", "x-stripeMostCommon": [ "place_of_supply_scheme" ] }, "type": { "description": "Type of registration to be created in an EU country.", "enum": [ "ioss", "oss_non_union", "oss_union", "standard" ], "type": "string" } }, "required": [ "type" ], "title": "europe", "type": "object", "x-stripeMostCommon": [ "standard", "type" ] }, "fr": { "description": "Options for the registration in FR.", "properties": { "standard": { "description": "Options for the standard registration.", "properties": { "place_of_supply_scheme": { "description": "Place of supply scheme used in an EU standard registration.", "enum": [ "inbound_goods", "small_seller", "standard" ], "type": "string" } }, "required": [ "place_of_supply_scheme" ], "title": "standard", "type": "object", "x-stripeMostCommon": [ "place_of_supply_scheme" ] }, "type": { "description": "Type of registration to be created in an EU country.", "enum": [ "ioss", "oss_non_union", "oss_union", "standard" ], "type": "string" } }, "required": [ "type" ], "title": "europe", "type": "object", "x-stripeMostCommon": [ "standard", "type" ] }, "gb": { "description": "Options for the registration in GB.", "properties": { "standard": { "description": "Options for the standard registration.", "properties": { "place_of_supply_scheme": { "description": "Place of supply scheme used in an standard registration.", "enum": [ "inbound_goods", "standard" ], "type": "string" } }, "title": "standard", "type": "object", "x-stripeMostCommon": [ "place_of_supply_scheme" ] }, "type": { "description": "Type of registration to be created in `country`.", "enum": [ "standard" ], "type": "string" } }, "required": [ "type" ], "title": "default", "type": "object", "x-stripeMostCommon": [ "standard", "type" ] }, "ge": { "description": "Options for the registration in GE.", "properties": { "type": { "description": "Type of registration to be created in `country`.", "enum": [ "simplified" ], "type": "string" } }, "required": [ "type" ], "title": "simplified", "type": "object", "x-stripeMostCommon": [ "type" ] }, "gn": { "description": "Options for the registration in GN.", "properties": { "standard": { "description": "Options for the standard registration.", "properties": { "place_of_supply_scheme": { "description": "Place of supply scheme used in an standard registration.", "enum": [ "inbound_goods", "standard" ], "type": "string" } }, "title": "standard", "type": "object", "x-stripeMostCommon": [ "place_of_supply_scheme" ] }, "type": { "description": "Type of registration to be created in `country`.", "enum": [ "standard" ], "type": "string" } }, "required": [ "type" ], "title": "default", "type": "object", "x-stripeMostCommon": [ "standard", "type" ] }, "gr": { "description": "Options for the registration in GR.", "properties": { "standard": { "description": "Options for the standard registration.", "properties": { "place_of_supply_scheme": { "description": "Place of supply scheme used in an EU standard registration.", "enum": [ "inbound_goods", "small_seller", "standard" ], "type": "string" } }, "required": [ "place_of_supply_scheme" ], "title": "standard", "type": "object", "x-stripeMostCommon": [ "place_of_supply_scheme" ] }, "type": { "description": "Type of registration to be created in an EU country.", "enum": [ "ioss", "oss_non_union", "oss_union", "standard" ], "type": "string" } }, "required": [ "type" ], "title": "europe", "type": "object", "x-stripeMostCommon": [ "standard", "type" ] }, "hr": { "description": "Options for the registration in HR.", "properties": { "standard": { "description": "Options for the standard registration.", "properties": { "place_of_supply_scheme": { "description": "Place of supply scheme used in an EU standard registration.", "enum": [ "inbound_goods", "small_seller", "standard" ], "type": "string" } }, "required": [ "place_of_supply_scheme" ], "title": "standard", "type": "object", "x-stripeMostCommon": [ "place_of_supply_scheme" ] }, "type": { "description": "Type of registration to be created in an EU country.", "enum": [ "ioss", "oss_non_union", "oss_union", "standard" ], "type": "string" } }, "required": [ "type" ], "title": "europe", "type": "object", "x-stripeMostCommon": [ "standard", "type" ] }, "hu": { "description": "Options for the registration in HU.", "properties": { "standard": { "description": "Options for the standard registration.", "properties": { "place_of_supply_scheme": { "description": "Place of supply scheme used in an EU standard registration.", "enum": [ "inbound_goods", "small_seller", "standard" ], "type": "string" } }, "required": [ "place_of_supply_scheme" ], "title": "standard", "type": "object", "x-stripeMostCommon": [ "place_of_supply_scheme" ] }, "type": { "description": "Type of registration to be created in an EU country.", "enum": [ "ioss", "oss_non_union", "oss_union", "standard" ], "type": "string" } }, "required": [ "type" ], "title": "europe", "type": "object", "x-stripeMostCommon": [ "standard", "type" ] }, "id": { "description": "Options for the registration in ID.", "properties": { "type": { "description": "Type of registration to be created in `country`.", "enum": [ "simplified" ], "type": "string" } }, "required": [ "type" ], "title": "simplified", "type": "object", "x-stripeMostCommon": [ "type" ] }, "ie": { "description": "Options for the registration in IE.", "properties": { "standard": { "description": "Options for the standard registration.", "properties": { "place_of_supply_scheme": { "description": "Place of supply scheme used in an EU standard registration.", "enum": [ "inbound_goods", "small_seller", "standard" ], "type": "string" } }, "required": [ "place_of_supply_scheme" ], "title": "standard", "type": "object", "x-stripeMostCommon": [ "place_of_supply_scheme" ] }, "type": { "description": "Type of registration to be created in an EU country.", "enum": [ "ioss", "oss_non_union", "oss_union", "standard" ], "type": "string" } }, "required": [ "type" ], "title": "europe", "type": "object", "x-stripeMostCommon": [ "standard", "type" ] }, "in": { "description": "Options for the registration in IN.", "properties": { "type": { "description": "Type of registration to be created in `country`.", "enum": [ "simplified" ], "type": "string" } }, "required": [ "type" ], "title": "simplified", "type": "object", "x-stripeMostCommon": [ "type" ] }, "is": { "description": "Options for the registration in IS.", "properties": { "standard": { "description": "Options for the standard registration.", "properties": { "place_of_supply_scheme": { "description": "Place of supply scheme used in an standard registration.", "enum": [ "inbound_goods", "standard" ], "type": "string" } }, "title": "standard", "type": "object", "x-stripeMostCommon": [ "place_of_supply_scheme" ] }, "type": { "description": "Type of registration to be created in `country`.", "enum": [ "standard" ], "type": "string" } }, "required": [ "type" ], "title": "default", "type": "object", "x-stripeMostCommon": [ "standard", "type" ] }, "it": { "description": "Options for the registration in IT.", "properties": { "standard": { "description": "Options for the standard registration.", "properties": { "place_of_supply_scheme": { "description": "Place of supply scheme used in an EU standard registration.", "enum": [ "inbound_goods", "small_seller", "standard" ], "type": "string" } }, "required": [ "place_of_supply_scheme" ], "title": "standard", "type": "object", "x-stripeMostCommon": [ "place_of_supply_scheme" ] }, "type": { "description": "Type of registration to be created in an EU country.", "enum": [ "ioss", "oss_non_union", "oss_union", "standard" ], "type": "string" } }, "required": [ "type" ], "title": "europe", "type": "object", "x-stripeMostCommon": [ "standard", "type" ] }, "jp": { "description": "Options for the registration in JP.", "properties": { "standard": { "description": "Options for the standard registration.", "properties": { "place_of_supply_scheme": { "description": "Place of supply scheme used in an standard registration.", "enum": [ "inbound_goods", "standard" ], "type": "string" } }, "title": "standard", "type": "object", "x-stripeMostCommon": [ "place_of_supply_scheme" ] }, "type": { "description": "Type of registration to be created in `country`.", "enum": [ "standard" ], "type": "string" } }, "required": [ "type" ], "title": "default", "type": "object", "x-stripeMostCommon": [ "standard", "type" ] }, "ke": { "description": "Options for the registration in KE.", "properties": { "type": { "description": "Type of registration to be created in `country`.", "enum": [ "simplified" ], "type": "string" } }, "required": [ "type" ], "title": "simplified", "type": "object", "x-stripeMostCommon": [ "type" ] }, "kg": { "description": "Options for the registration in KG.", "properties": { "type": { "description": "Type of registration to be created in `country`.", "enum": [ "simplified" ], "type": "string" } }, "required": [ "type" ], "title": "simplified", "type": "object", "x-stripeMostCommon": [ "type" ] }, "kh": { "description": "Options for the registration in KH.", "properties": { "type": { "description": "Type of registration to be created in `country`.", "enum": [ "simplified" ], "type": "string" } }, "required": [ "type" ], "title": "simplified", "type": "object", "x-stripeMostCommon": [ "type" ] }, "kr": { "description": "Options for the registration in KR.", "properties": { "type": { "description": "Type of registration to be created in `country`.", "enum": [ "simplified" ], "type": "string" } }, "required": [ "type" ], "title": "simplified", "type": "object", "x-stripeMostCommon": [ "type" ] }, "kz": { "description": "Options for the registration in KZ.", "properties": { "type": { "description": "Type of registration to be created in `country`.", "enum": [ "simplified" ], "type": "string" } }, "required": [ "type" ], "title": "simplified", "type": "object", "x-stripeMostCommon": [ "type" ] }, "la": { "description": "Options for the registration in LA.", "properties": { "type": { "description": "Type of registration to be created in `country`.", "enum": [ "simplified" ], "type": "string" } }, "required": [ "type" ], "title": "simplified", "type": "object", "x-stripeMostCommon": [ "type" ] }, "lt": { "description": "Options for the registration in LT.", "properties": { "standard": { "description": "Options for the standard registration.", "properties": { "place_of_supply_scheme": { "description": "Place of supply scheme used in an EU standard registration.", "enum": [ "inbound_goods", "small_seller", "standard" ], "type": "string" } }, "required": [ "place_of_supply_scheme" ], "title": "standard", "type": "object", "x-stripeMostCommon": [ "place_of_supply_scheme" ] }, "type": { "description": "Type of registration to be created in an EU country.", "enum": [ "ioss", "oss_non_union", "oss_union", "standard" ], "type": "string" } }, "required": [ "type" ], "title": "europe", "type": "object", "x-stripeMostCommon": [ "standard", "type" ] }, "lu": { "description": "Options for the registration in LU.", "properties": { "standard": { "description": "Options for the standard registration.", "properties": { "place_of_supply_scheme": { "description": "Place of supply scheme used in an EU standard registration.", "enum": [ "inbound_goods", "small_seller", "standard" ], "type": "string" } }, "required": [ "place_of_supply_scheme" ], "title": "standard", "type": "object", "x-stripeMostCommon": [ "place_of_supply_scheme" ] }, "type": { "description": "Type of registration to be created in an EU country.", "enum": [ "ioss", "oss_non_union", "oss_union", "standard" ], "type": "string" } }, "required": [ "type" ], "title": "europe", "type": "object", "x-stripeMostCommon": [ "standard", "type" ] }, "lv": { "description": "Options for the registration in LV.", "properties": { "standard": { "description": "Options for the standard registration.", "properties": { "place_of_supply_scheme": { "description": "Place of supply scheme used in an EU standard registration.", "enum": [ "inbound_goods", "small_seller", "standard" ], "type": "string" } }, "required": [ "place_of_supply_scheme" ], "title": "standard", "type": "object", "x-stripeMostCommon": [ "place_of_supply_scheme" ] }, "type": { "description": "Type of registration to be created in an EU country.", "enum": [ "ioss", "oss_non_union", "oss_union", "standard" ], "type": "string" } }, "required": [ "type" ], "title": "europe", "type": "object", "x-stripeMostCommon": [ "standard", "type" ] }, "ma": { "description": "Options for the registration in MA.", "properties": { "type": { "description": "Type of registration to be created in `country`.", "enum": [ "simplified" ], "type": "string" } }, "required": [ "type" ], "title": "simplified", "type": "object", "x-stripeMostCommon": [ "type" ] }, "md": { "description": "Options for the registration in MD.", "properties": { "type": { "description": "Type of registration to be created in `country`.", "enum": [ "simplified" ], "type": "string" } }, "required": [ "type" ], "title": "simplified", "type": "object", "x-stripeMostCommon": [ "type" ] }, "me": { "description": "Options for the registration in ME.", "properties": { "standard": { "description": "Options for the standard registration.", "properties": { "place_of_supply_scheme": { "description": "Place of supply scheme used in an standard registration.", "enum": [ "inbound_goods", "standard" ], "type": "string" } }, "title": "standard", "type": "object", "x-stripeMostCommon": [ "place_of_supply_scheme" ] }, "type": { "description": "Type of registration to be created in `country`.", "enum": [ "standard" ], "type": "string" } }, "required": [ "type" ], "title": "default", "type": "object", "x-stripeMostCommon": [ "standard", "type" ] }, "mk": { "description": "Options for the registration in MK.", "properties": { "standard": { "description": "Options for the standard registration.", "properties": { "place_of_supply_scheme": { "description": "Place of supply scheme used in an standard registration.", "enum": [ "inbound_goods", "standard" ], "type": "string" } }, "title": "standard", "type": "object", "x-stripeMostCommon": [ "place_of_supply_scheme" ] }, "type": { "description": "Type of registration to be created in `country`.", "enum": [ "standard" ], "type": "string" } }, "required": [ "type" ], "title": "default", "type": "object", "x-stripeMostCommon": [ "standard", "type" ] }, "mr": { "description": "Options for the registration in MR.", "properties": { "standard": { "description": "Options for the standard registration.", "properties": { "place_of_supply_scheme": { "description": "Place of supply scheme used in an standard registration.", "enum": [ "inbound_goods", "standard" ], "type": "string" } }, "title": "standard", "type": "object", "x-stripeMostCommon": [ "place_of_supply_scheme" ] }, "type": { "description": "Type of registration to be created in `country`.", "enum": [ "standard" ], "type": "string" } }, "required": [ "type" ], "title": "default", "type": "object", "x-stripeMostCommon": [ "standard", "type" ] }, "mt": { "description": "Options for the registration in MT.", "properties": { "standard": { "description": "Options for the standard registration.", "properties": { "place_of_supply_scheme": { "description": "Place of supply scheme used in an EU standard registration.", "enum": [ "inbound_goods", "small_seller", "standard" ], "type": "string" } }, "required": [ "place_of_supply_scheme" ], "title": "standard", "type": "object", "x-stripeMostCommon": [ "place_of_supply_scheme" ] }, "type": { "description": "Type of registration to be created in an EU country.", "enum": [ "ioss", "oss_non_union", "oss_union", "standard" ], "type": "string" } }, "required": [ "type" ], "title": "europe", "type": "object", "x-stripeMostCommon": [ "standard", "type" ] }, "mx": { "description": "Options for the registration in MX.", "properties": { "type": { "description": "Type of registration to be created in `country`.", "enum": [ "simplified" ], "type": "string" } }, "required": [ "type" ], "title": "simplified", "type": "object", "x-stripeMostCommon": [ "type" ] }, "my": { "description": "Options for the registration in MY.", "properties": { "type": { "description": "Type of registration to be created in `country`.", "enum": [ "simplified" ], "type": "string" } }, "required": [ "type" ], "title": "simplified", "type": "object", "x-stripeMostCommon": [ "type" ] }, "ng": { "description": "Options for the registration in NG.", "properties": { "type": { "description": "Type of registration to be created in `country`.", "enum": [ "simplified" ], "type": "string" } }, "required": [ "type" ], "title": "simplified", "type": "object", "x-stripeMostCommon": [ "type" ] }, "nl": { "description": "Options for the registration in NL.", "properties": { "standard": { "description": "Options for the standard registration.", "properties": { "place_of_supply_scheme": { "description": "Place of supply scheme used in an EU standard registration.", "enum": [ "inbound_goods", "small_seller", "standard" ], "type": "string" } }, "required": [ "place_of_supply_scheme" ], "title": "standard", "type": "object", "x-stripeMostCommon": [ "place_of_supply_scheme" ] }, "type": { "description": "Type of registration to be created in an EU country.", "enum": [ "ioss", "oss_non_union", "oss_union", "standard" ], "type": "string" } }, "required": [ "type" ], "title": "europe", "type": "object", "x-stripeMostCommon": [ "standard", "type" ] }, "no": { "description": "Options for the registration in NO.", "properties": { "standard": { "description": "Options for the standard registration.", "properties": { "place_of_supply_scheme": { "description": "Place of supply scheme used in an standard registration.", "enum": [ "inbound_goods", "standard" ], "type": "string" } }, "title": "standard", "type": "object", "x-stripeMostCommon": [ "place_of_supply_scheme" ] }, "type": { "description": "Type of registration to be created in `country`.", "enum": [ "standard" ], "type": "string" } }, "required": [ "type" ], "title": "default", "type": "object", "x-stripeMostCommon": [ "standard", "type" ] }, "np": { "description": "Options for the registration in NP.", "properties": { "type": { "description": "Type of registration to be created in `country`.", "enum": [ "simplified" ], "type": "string" } }, "required": [ "type" ], "title": "simplified", "type": "object", "x-stripeMostCommon": [ "type" ] }, "nz": { "description": "Options for the registration in NZ.", "properties": { "standard": { "description": "Options for the standard registration.", "properties": { "place_of_supply_scheme": { "description": "Place of supply scheme used in an standard registration.", "enum": [ "inbound_goods", "standard" ], "type": "string" } }, "title": "standard", "type": "object", "x-stripeMostCommon": [ "place_of_supply_scheme" ] }, "type": { "description": "Type of registration to be created in `country`.", "enum": [ "standard" ], "type": "string" } }, "required": [ "type" ], "title": "default", "type": "object", "x-stripeMostCommon": [ "standard", "type" ] }, "om": { "description": "Options for the registration in OM.", "properties": { "standard": { "description": "Options for the standard registration.", "properties": { "place_of_supply_scheme": { "description": "Place of supply scheme used in an standard registration.", "enum": [ "inbound_goods", "standard" ], "type": "string" } }, "title": "standard", "type": "object", "x-stripeMostCommon": [ "place_of_supply_scheme" ] }, "type": { "description": "Type of registration to be created in `country`.", "enum": [ "standard" ], "type": "string" } }, "required": [ "type" ], "title": "default", "type": "object", "x-stripeMostCommon": [ "standard", "type" ] }, "pe": { "description": "Options for the registration in PE.", "properties": { "type": { "description": "Type of registration to be created in `country`.", "enum": [ "simplified" ], "type": "string" } }, "required": [ "type" ], "title": "simplified", "type": "object", "x-stripeMostCommon": [ "type" ] }, "ph": { "description": "Options for the registration in PH.", "properties": { "type": { "description": "Type of registration to be created in `country`.", "enum": [ "simplified" ], "type": "string" } }, "required": [ "type" ], "title": "simplified", "type": "object", "x-stripeMostCommon": [ "type" ] }, "pl": { "description": "Options for the registration in PL.", "properties": { "standard": { "description": "Options for the standard registration.", "properties": { "place_of_supply_scheme": { "description": "Place of supply scheme used in an EU standard registration.", "enum": [ "inbound_goods", "small_seller", "standard" ], "type": "string" } }, "required": [ "place_of_supply_scheme" ], "title": "standard", "type": "object", "x-stripeMostCommon": [ "place_of_supply_scheme" ] }, "type": { "description": "Type of registration to be created in an EU country.", "enum": [ "ioss", "oss_non_union", "oss_union", "standard" ], "type": "string" } }, "required": [ "type" ], "title": "europe", "type": "object", "x-stripeMostCommon": [ "standard", "type" ] }, "pt": { "description": "Options for the registration in PT.", "properties": { "standard": { "description": "Options for the standard registration.", "properties": { "place_of_supply_scheme": { "description": "Place of supply scheme used in an EU standard registration.", "enum": [ "inbound_goods", "small_seller", "standard" ], "type": "string" } }, "required": [ "place_of_supply_scheme" ], "title": "standard", "type": "object", "x-stripeMostCommon": [ "place_of_supply_scheme" ] }, "type": { "description": "Type of registration to be created in an EU country.", "enum": [ "ioss", "oss_non_union", "oss_union", "standard" ], "type": "string" } }, "required": [ "type" ], "title": "europe", "type": "object", "x-stripeMostCommon": [ "standard", "type" ] }, "ro": { "description": "Options for the registration in RO.", "properties": { "standard": { "description": "Options for the standard registration.", "properties": { "place_of_supply_scheme": { "description": "Place of supply scheme used in an EU standard registration.", "enum": [ "inbound_goods", "small_seller", "standard" ], "type": "string" } }, "required": [ "place_of_supply_scheme" ], "title": "standard", "type": "object", "x-stripeMostCommon": [ "place_of_supply_scheme" ] }, "type": { "description": "Type of registration to be created in an EU country.", "enum": [ "ioss", "oss_non_union", "oss_union", "standard" ], "type": "string" } }, "required": [ "type" ], "title": "europe", "type": "object", "x-stripeMostCommon": [ "standard", "type" ] }, "rs": { "description": "Options for the registration in RS.", "properties": { "standard": { "description": "Options for the standard registration.", "properties": { "place_of_supply_scheme": { "description": "Place of supply scheme used in an standard registration.", "enum": [ "inbound_goods", "standard" ], "type": "string" } }, "title": "standard", "type": "object", "x-stripeMostCommon": [ "place_of_supply_scheme" ] }, "type": { "description": "Type of registration to be created in `country`.", "enum": [ "standard" ], "type": "string" } }, "required": [ "type" ], "title": "default", "type": "object", "x-stripeMostCommon": [ "standard", "type" ] }, "ru": { "description": "Options for the registration in RU.", "properties": { "type": { "description": "Type of registration to be created in `country`.", "enum": [ "simplified" ], "type": "string" } }, "required": [ "type" ], "title": "simplified", "type": "object", "x-stripeMostCommon": [ "type" ] }, "sa": { "description": "Options for the registration in SA.", "properties": { "type": { "description": "Type of registration to be created in `country`.", "enum": [ "simplified" ], "type": "string" } }, "required": [ "type" ], "title": "simplified", "type": "object", "x-stripeMostCommon": [ "type" ] }, "se": { "description": "Options for the registration in SE.", "properties": { "standard": { "description": "Options for the standard registration.", "properties": { "place_of_supply_scheme": { "description": "Place of supply scheme used in an EU standard registration.", "enum": [ "inbound_goods", "small_seller", "standard" ], "type": "string" } }, "required": [ "place_of_supply_scheme" ], "title": "standard", "type": "object", "x-stripeMostCommon": [ "place_of_supply_scheme" ] }, "type": { "description": "Type of registration to be created in an EU country.", "enum": [ "ioss", "oss_non_union", "oss_union", "standard" ], "type": "string" } }, "required": [ "type" ], "title": "europe", "type": "object", "x-stripeMostCommon": [ "standard", "type" ] }, "sg": { "description": "Options for the registration in SG.", "properties": { "standard": { "description": "Options for the standard registration.", "properties": { "place_of_supply_scheme": { "description": "Place of supply scheme used in an standard registration.", "enum": [ "inbound_goods", "standard" ], "type": "string" } }, "title": "standard", "type": "object", "x-stripeMostCommon": [ "place_of_supply_scheme" ] }, "type": { "description": "Type of registration to be created in `country`.", "enum": [ "standard" ], "type": "string" } }, "required": [ "type" ], "title": "default", "type": "object", "x-stripeMostCommon": [ "standard", "type" ] }, "si": { "description": "Options for the registration in SI.", "properties": { "standard": { "description": "Options for the standard registration.", "properties": { "place_of_supply_scheme": { "description": "Place of supply scheme used in an EU standard registration.", "enum": [ "inbound_goods", "small_seller", "standard" ], "type": "string" } }, "required": [ "place_of_supply_scheme" ], "title": "standard", "type": "object", "x-stripeMostCommon": [ "place_of_supply_scheme" ] }, "type": { "description": "Type of registration to be created in an EU country.", "enum": [ "ioss", "oss_non_union", "oss_union", "standard" ], "type": "string" } }, "required": [ "type" ], "title": "europe", "type": "object", "x-stripeMostCommon": [ "standard", "type" ] }, "sk": { "description": "Options for the registration in SK.", "properties": { "standard": { "description": "Options for the standard registration.", "properties": { "place_of_supply_scheme": { "description": "Place of supply scheme used in an EU standard registration.", "enum": [ "inbound_goods", "small_seller", "standard" ], "type": "string" } }, "required": [ "place_of_supply_scheme" ], "title": "standard", "type": "object", "x-stripeMostCommon": [ "place_of_supply_scheme" ] }, "type": { "description": "Type of registration to be created in an EU country.", "enum": [ "ioss", "oss_non_union", "oss_union", "standard" ], "type": "string" } }, "required": [ "type" ], "title": "europe", "type": "object", "x-stripeMostCommon": [ "standard", "type" ] }, "sn": { "description": "Options for the registration in SN.", "properties": { "type": { "description": "Type of registration to be created in `country`.", "enum": [ "simplified" ], "type": "string" } }, "required": [ "type" ], "title": "simplified", "type": "object", "x-stripeMostCommon": [ "type" ] }, "sr": { "description": "Options for the registration in SR.", "properties": { "standard": { "description": "Options for the standard registration.", "properties": { "place_of_supply_scheme": { "description": "Place of supply scheme used in an standard registration.", "enum": [ "inbound_goods", "standard" ], "type": "string" } }, "title": "standard", "type": "object", "x-stripeMostCommon": [ "place_of_supply_scheme" ] }, "type": { "description": "Type of registration to be created in `country`.", "enum": [ "standard" ], "type": "string" } }, "required": [ "type" ], "title": "default", "type": "object", "x-stripeMostCommon": [ "standard", "type" ] }, "th": { "description": "Options for the registration in TH.", "properties": { "type": { "description": "Type of registration to be created in `country`.", "enum": [ "simplified" ], "type": "string" } }, "required": [ "type" ], "title": "simplified", "type": "object", "x-stripeMostCommon": [ "type" ] }, "tj": { "description": "Options for the registration in TJ.", "properties": { "type": { "description": "Type of registration to be created in `country`.", "enum": [ "simplified" ], "type": "string" } }, "required": [ "type" ], "title": "simplified", "type": "object", "x-stripeMostCommon": [ "type" ] }, "tr": { "description": "Options for the registration in TR.", "properties": { "type": { "description": "Type of registration to be created in `country`.", "enum": [ "simplified" ], "type": "string" } }, "required": [ "type" ], "title": "simplified", "type": "object", "x-stripeMostCommon": [ "type" ] }, "tz": { "description": "Options for the registration in TZ.", "properties": { "type": { "description": "Type of registration to be created in `country`.", "enum": [ "simplified" ], "type": "string" } }, "required": [ "type" ], "title": "simplified", "type": "object", "x-stripeMostCommon": [ "type" ] }, "ua": { "description": "Options for the registration in UA.", "properties": { "type": { "description": "Type of registration to be created in `country`.", "enum": [ "simplified" ], "type": "string" } }, "required": [ "type" ], "title": "simplified", "type": "object", "x-stripeMostCommon": [ "type" ] }, "ug": { "description": "Options for the registration in UG.", "properties": { "type": { "description": "Type of registration to be created in `country`.", "enum": [ "simplified" ], "type": "string" } }, "required": [ "type" ], "title": "simplified", "type": "object", "x-stripeMostCommon": [ "type" ] }, "us": { "description": "Options for the registration in US.", "properties": { "local_amusement_tax": { "description": "Options for the local amusement tax registration.", "properties": { "jurisdiction": { "description": "A [FIPS code](https://www.census.gov/library/reference/code-lists/ansi.html) representing the local jurisdiction. Supported FIPS codes are: `14000` (Chicago), `06613` (Bloomington), `21696` (East Dundee), `24582` (Evanston), `45421` (Lynwood), `48892` (Midlothian), `64343` (River Grove), and `68081` (Schiller Park).", "maxLength": 5000, "type": "string" } }, "required": [ "jurisdiction" ], "title": "local_amusement_tax", "type": "object", "x-stripeMostCommon": [ "jurisdiction" ] }, "local_lease_tax": { "description": "Options for the local lease tax registration.", "properties": { "jurisdiction": { "description": "A [FIPS code](https://www.census.gov/library/reference/code-lists/ansi.html) representing the local jurisdiction. Supported FIPS codes are: `14000` (Chicago).", "maxLength": 5000, "type": "string" } }, "required": [ "jurisdiction" ], "title": "local_lease_tax", "type": "object", "x-stripeMostCommon": [ "jurisdiction" ] }, "state": { "description": "Two-letter US state code ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).", "maxLength": 5000, "type": "string" }, "state_sales_tax": { "description": "Options for the state sales tax registration.", "properties": { "elections": { "description": "Elections for the state sales tax registration.", "items": { "properties": { "jurisdiction": { "description": "A [FIPS code](https://www.census.gov/library/reference/code-lists/ansi.html) representing the local jurisdiction. Supported FIPS codes are: `003` (Allegheny County) and `60000` (Philadelphia City).", "maxLength": 5000, "type": "string" }, "type": { "description": "The type of the election for the state sales tax registration.", "enum": [ "local_use_tax", "simplified_sellers_use_tax", "single_local_use_tax" ], "type": "string" } }, "required": [ "type" ], "title": "state_sales_tax_election", "type": "object", "x-stripeMostCommon": [ "jurisdiction", "type" ] }, "type": "array" } }, "required": [ "elections" ], "title": "state_sales_tax", "type": "object", "x-stripeMostCommon": [ "elections" ] }, "type": { "description": "Type of registration to be created in the US.", "enum": [ "local_amusement_tax", "local_lease_tax", "state_communications_tax", "state_retail_delivery_fee", "state_sales_tax" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "state", "type" ], "title": "united_states", "type": "object", "x-stripeMostCommon": [ "local_amusement_tax", "local_lease_tax", "state", "state_sales_tax", "type" ] }, "uy": { "description": "Options for the registration in UY.", "properties": { "standard": { "description": "Options for the standard registration.", "properties": { "place_of_supply_scheme": { "description": "Place of supply scheme used in an standard registration.", "enum": [ "inbound_goods", "standard" ], "type": "string" } }, "title": "standard", "type": "object", "x-stripeMostCommon": [ "place_of_supply_scheme" ] }, "type": { "description": "Type of registration to be created in `country`.", "enum": [ "standard" ], "type": "string" } }, "required": [ "type" ], "title": "default", "type": "object", "x-stripeMostCommon": [ "standard", "type" ] }, "uz": { "description": "Options for the registration in UZ.", "properties": { "type": { "description": "Type of registration to be created in `country`.", "enum": [ "simplified" ], "type": "string" } }, "required": [ "type" ], "title": "simplified", "type": "object", "x-stripeMostCommon": [ "type" ] }, "vn": { "description": "Options for the registration in VN.", "properties": { "type": { "description": "Type of registration to be created in `country`.", "enum": [ "simplified" ], "type": "string" } }, "required": [ "type" ], "title": "simplified", "type": "object", "x-stripeMostCommon": [ "type" ] }, "za": { "description": "Options for the registration in ZA.", "properties": { "standard": { "description": "Options for the standard registration.", "properties": { "place_of_supply_scheme": { "description": "Place of supply scheme used in an standard registration.", "enum": [ "inbound_goods", "standard" ], "type": "string" } }, "title": "standard", "type": "object", "x-stripeMostCommon": [ "place_of_supply_scheme" ] }, "type": { "description": "Type of registration to be created in `country`.", "enum": [ "standard" ], "type": "string" } }, "required": [ "type" ], "title": "default", "type": "object", "x-stripeMostCommon": [ "standard", "type" ] }, "zm": { "description": "Options for the registration in ZM.", "properties": { "type": { "description": "Type of registration to be created in `country`.", "enum": [ "simplified" ], "type": "string" } }, "required": [ "type" ], "title": "simplified", "type": "object", "x-stripeMostCommon": [ "type" ] }, "zw": { "description": "Options for the registration in ZW.", "properties": { "standard": { "description": "Options for the standard registration.", "properties": { "place_of_supply_scheme": { "description": "Place of supply scheme used in an standard registration.", "enum": [ "inbound_goods", "standard" ], "type": "string" } }, "title": "standard", "type": "object", "x-stripeMostCommon": [ "place_of_supply_scheme" ] }, "type": { "description": "Type of registration to be created in `country`.", "enum": [ "standard" ], "type": "string" } }, "required": [ "type" ], "title": "default", "type": "object", "x-stripeMostCommon": [ "standard", "type" ] } }, "title": "country_options", "type": "object", "x-stripeMostCommon": [ "ae", "al", "am", "ao", "at", "au", "aw", "az", "ba", "bb", "bd", "be", "bf", "bg", "bh", "bj", "bs", "by", "ca", "cd", "ch", "cl", "cm", "co", "cr", "cv", "cy", "cz", "de", "dk", "ec", "ee", "eg", "es", "et", "fi", "fr", "gb", "ge", "gn", "gr", "hr", "hu", "id", "ie", "in", "is", "it", "jp", "ke", "kg", "kh", "kr", "kz", "la", "lt", "lu", "lv", "ma", "md", "me", "mk", "mr", "mt", "mx", "my", "ng", "nl", "no", "np", "nz", "om", "pe", "ph", "pl", "pt", "ro", "rs", "ru", "sa", "se", "sg", "si", "sk", "sn", "sr", "th", "tj", "tr", "tw", "tz", "ua", "ug", "us", "uy", "uz", "vn", "za", "zm", "zw" ] }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "expires_at": { "description": "If set, the Tax Registration stops being active at this time. If not set, the Tax Registration will be active indefinitely. Timestamp measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" } }, "required": [ "active_from", "country", "country_options" ], "type": "object", "x-stripeMostCommon": [ "active_from", "country", "country_options", "expires_at" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax.registration" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a registration" } }, "/v1/tax/registrations/{id}": { "get": { "description": "

Returns a Tax Registration object.

", "operationId": "GetTaxRegistrationsId", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax.registration" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a registration" }, "post": { "description": "

Updates an existing Tax Registration object.

\n\n

A registration cannot be deleted after it has been created. If you wish to end a registration you may do so by setting expires_at.

", "operationId": "PostTaxRegistrationsId", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "active_from": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "expires_at": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "active_from": { "anyOf": [ { "enum": [ "now" ], "maxLength": 5000, "type": "string" }, { "format": "unix-time", "type": "integer" } ], "description": "Time at which the registration becomes active. It can be either `now` to indicate the current time, or a timestamp measured in seconds since the Unix epoch." }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "expires_at": { "anyOf": [ { "enum": [ "now" ], "maxLength": 5000, "type": "string" }, { "format": "unix-time", "type": "integer" }, { "enum": [ "" ], "type": "string" } ], "description": "If set, the registration stops being active at this time. If not set, the registration will be active indefinitely. It can be either `now` to indicate the current time, or a timestamp measured in seconds since the Unix epoch." } }, "type": "object", "x-stripeMostCommon": [ "active_from", "expires_at" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax.registration" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a registration" } }, "/v1/tax/settings": { "get": { "description": "

Retrieves Tax Settings for a merchant.

", "operationId": "GetTaxSettings", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax.settings" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve settings" }, "post": { "description": "

Updates Tax Settings parameters used in tax calculations. All parameters are editable but none can be removed once set.

", "operationId": "PostTaxSettings", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "defaults": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "head_office": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "defaults": { "description": "Default configuration to be used on Stripe Tax calculations.", "properties": { "tax_behavior": { "description": "Specifies the default [tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#tax-behavior) to be used when the item's price has unspecified tax behavior. One of inclusive, exclusive, or inferred_by_currency. Once specified, it cannot be changed back to null.", "enum": [ "exclusive", "inclusive", "inferred_by_currency" ], "type": "string" }, "tax_code": { "description": "A [tax code](https://stripe.com/docs/tax/tax-categories) ID.", "type": "string" } }, "title": "defaults_param", "type": "object", "x-stripeMostCommon": [ "tax_behavior", "tax_code" ] }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "head_office": { "description": "The place where your business is located.", "properties": { "address": { "description": "The location of the business for tax purposes.", "properties": { "city": { "description": "City, district, suburb, town, or village.", "maxLength": 5000, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Address line 1 (e.g., street, PO Box, or company name).", "maxLength": 5000, "type": "string" }, "line2": { "description": "Address line 2 (e.g., apartment, suite, unit, or building).", "maxLength": 5000, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "State/province as an [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) subdivision code, without country prefix. Example: \"NY\" or \"TX\".", "maxLength": 5000, "type": "string" } }, "title": "validated_country_address", "type": "object", "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state" ] } }, "required": [ "address" ], "title": "head_office_param", "type": "object", "x-stripeMostCommon": [ "address" ] } }, "type": "object", "x-stripeMostCommon": [ "defaults", "head_office" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax.settings" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update settings" } }, "/v1/tax/transactions/create_from_calculation": { "post": { "description": "

Creates a Tax Transaction from a calculation, if that calculation hasn’t expired. Calculations expire after 90 days.

", "operationId": "PostTaxTransactionsCreateFromCalculation", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "calculation": { "description": "Tax Calculation ID to be used as input when creating the transaction.", "maxLength": 5000, "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "posted_at": { "description": "The Unix timestamp representing when the tax liability is assumed or reduced, which determines the liability posting period and handling in tax liability reports. The timestamp must fall within the `tax_date` and the current time, unless the `tax_date` is scheduled in advance. Defaults to the current time.", "format": "unix-time", "type": "integer" }, "reference": { "description": "A custom order or sale identifier, such as 'myOrder_123'. Must be unique across all transactions, including reversals.", "maxLength": 500, "type": "string" } }, "required": [ "calculation", "reference" ], "type": "object", "x-stripeMostCommon": [ "calculation", "metadata", "reference" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax.transaction" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a transaction from a calculation" } }, "/v1/tax/transactions/create_reversal": { "post": { "description": "

Partially or fully reverses a previously created Transaction.

", "operationId": "PostTaxTransactionsCreateReversal", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "line_items": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "shipping_cost": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "flat_amount": { "description": "A flat amount to reverse across the entire transaction, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) in negative. This value represents the total amount to refund from the transaction, including taxes.", "type": "integer" }, "line_items": { "description": "The line item amounts to reverse.", "items": { "properties": { "amount": { "description": "The amount to reverse, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) in negative.", "type": "integer" }, "amount_tax": { "description": "The amount of tax to reverse, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) in negative.", "type": "integer" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "type": "object" }, "original_line_item": { "description": "The `id` of the line item to reverse in the original transaction.", "maxLength": 5000, "type": "string" }, "quantity": { "description": "The quantity reversed. Appears in [tax exports](https://stripe.com/docs/tax/reports), but does not affect the amount of tax reversed.", "type": "integer" }, "reference": { "description": "A custom identifier for this line item in the reversal transaction, such as 'L1-refund'.", "maxLength": 500, "type": "string" } }, "required": [ "amount", "amount_tax", "original_line_item", "reference" ], "title": "transaction_line_item_reversal", "type": "object", "x-stripeMostCommon": [ "amount", "amount_tax", "metadata", "original_line_item", "quantity", "reference" ] }, "type": "array" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "mode": { "description": "If `partial`, the provided line item or shipping cost amounts are reversed. If `full`, the original transaction is fully reversed.", "enum": [ "full", "partial" ], "type": "string" }, "original_transaction": { "description": "The ID of the Transaction to partially or fully reverse.", "maxLength": 5000, "type": "string" }, "reference": { "description": "A custom identifier for this reversal, such as `myOrder_123-refund_1`, which must be unique across all transactions. The reference helps identify this reversal transaction in exported [tax reports](https://stripe.com/docs/tax/reports).", "maxLength": 500, "type": "string" }, "shipping_cost": { "description": "The shipping cost to reverse.", "properties": { "amount": { "description": "The amount to reverse, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) in negative.", "type": "integer" }, "amount_tax": { "description": "The amount of tax to reverse, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) in negative.", "type": "integer" } }, "required": [ "amount", "amount_tax" ], "title": "transaction_shipping_cost_reversal", "type": "object", "x-stripeMostCommon": [ "amount", "amount_tax" ] } }, "required": [ "mode", "original_transaction", "reference" ], "type": "object", "x-stripeMostCommon": [ "flat_amount", "line_items", "metadata", "mode", "original_transaction", "reference" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax.transaction" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a reversal transaction" } }, "/v1/tax/transactions/{transaction}": { "get": { "description": "

Retrieves a Tax Transaction object.

", "operationId": "GetTaxTransactionsTransaction", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "transaction", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax.transaction" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a transaction" } }, "/v1/tax/transactions/{transaction}/line_items": { "get": { "description": "

Retrieves the line items of a committed standalone transaction as a collection.

", "operationId": "GetTaxTransactionsTransactionLineItems", "parameters": [ { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 500, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 500, "type": "string" }, "style": "form" }, { "in": "path", "name": "transaction", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/tax.transaction_line_item" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/tax/transactions/[^/]+/line_items", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "TaxProductResourceTaxTransactionLineItemList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a transaction's line items" } }, "/v1/tax_codes": { "get": { "description": "

A list of all tax codes available to add to Products in order to allow specific tax calculations.

", "operationId": "GetTaxCodes", "parameters": [ { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/tax_code" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "TaxProductResourceTaxCodeList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all tax codes" } }, "/v1/tax_codes/{id}": { "get": { "description": "

Retrieves the details of an existing tax code. Supply the unique tax code ID and Stripe will return the corresponding tax code information.

", "operationId": "GetTaxCodesId", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax_code" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a tax code" } }, "/v1/tax_ids": { "get": { "description": "

Returns a list of tax IDs.

", "operationId": "GetTaxIds", "parameters": [ { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "The account or customer the tax ID belongs to. Defaults to `owner[type]=self`.", "explode": true, "in": "query", "name": "owner", "required": false, "schema": { "properties": { "account": { "description": "Account the tax ID belongs to. Required when `type=account`", "type": "string" }, "customer": { "description": "Customer the tax ID belongs to. Required when `type=customer`", "maxLength": 5000, "type": "string" }, "customer_account": { "description": "v2 Account the tax ID belongs to. Can be used in place of `customer` when `type=customer`", "maxLength": 5000, "type": "string" }, "type": { "description": "Type of owner referenced.", "enum": [ "account", "application", "customer", "self" ], "type": "string" } }, "required": [ "type" ], "title": "owner_params", "type": "object", "x-stripeMostCommon": [ "account", "customer", "customer_account", "type" ] }, "style": "deepObject" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/tax_id" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "TaxIDsList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all tax IDs" }, "post": { "description": "

Creates a new account or customer tax_id object.

", "operationId": "PostTaxIds", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "owner": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "owner": { "description": "The account or customer the tax ID belongs to. Defaults to `owner[type]=self`.", "properties": { "account": { "description": "Account the tax ID belongs to. Required when `type=account`", "type": "string" }, "customer": { "description": "Customer the tax ID belongs to. Required when `type=customer`", "maxLength": 5000, "type": "string" }, "customer_account": { "description": "v2 Account the tax ID belongs to. Can be used in place of `customer` when `type=customer`", "maxLength": 5000, "type": "string" }, "type": { "description": "Type of owner referenced.", "enum": [ "account", "application", "customer", "self" ], "type": "string" } }, "required": [ "type" ], "title": "owner_params", "type": "object", "x-stripeMostCommon": [ "account", "customer", "customer_account", "type" ] }, "type": { "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `aw_tin`, `az_tin`, `ba_tin`, `bb_tin`, `bd_bin`, `bf_ifu`, `bg_uic`, `bh_vat`, `bj_ifu`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cm_niu`, `cn_tin`, `co_nit`, `cr_tin`, `cv_nif`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `et_tin`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kg_tin`, `kh_tin`, `kr_brn`, `kz_bin`, `la_tin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin`", "enum": [ "ad_nrt", "ae_trn", "al_tin", "am_tin", "ao_tin", "ar_cuit", "au_abn", "au_arn", "aw_tin", "az_tin", "ba_tin", "bb_tin", "bd_bin", "bf_ifu", "bg_uic", "bh_vat", "bj_ifu", "bo_tin", "br_cnpj", "br_cpf", "bs_tin", "by_tin", "ca_bn", "ca_gst_hst", "ca_pst_bc", "ca_pst_mb", "ca_pst_sk", "ca_qst", "cd_nif", "ch_uid", "ch_vat", "cl_tin", "cm_niu", "cn_tin", "co_nit", "cr_tin", "cv_nif", "de_stn", "do_rcn", "ec_ruc", "eg_tin", "es_cif", "et_tin", "eu_oss_vat", "eu_vat", "gb_vat", "ge_vat", "gn_nif", "hk_br", "hr_oib", "hu_tin", "id_npwp", "il_vat", "in_gst", "is_vat", "jp_cn", "jp_rn", "jp_trn", "ke_pin", "kg_tin", "kh_tin", "kr_brn", "kz_bin", "la_tin", "li_uid", "li_vat", "ma_vat", "md_vat", "me_pib", "mk_vat", "mr_nif", "mx_rfc", "my_frp", "my_itn", "my_sst", "ng_tin", "no_vat", "no_voec", "np_pan", "nz_gst", "om_vat", "pe_ruc", "ph_tin", "ro_tin", "rs_pib", "ru_inn", "ru_kpp", "sa_vat", "sg_gst", "sg_uen", "si_tin", "sn_ninea", "sr_fin", "sv_nit", "th_vat", "tj_tin", "tr_tin", "tw_vat", "tz_vat", "ua_vat", "ug_tin", "us_ein", "uy_ruc", "uz_tin", "uz_vat", "ve_rif", "vn_tin", "za_vat", "zm_tin", "zw_tin" ], "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true }, "value": { "description": "Value of the tax ID.", "type": "string" } }, "required": [ "type", "value" ], "type": "object", "x-stripeMostCommon": [ "type", "value" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax_id" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a tax ID" } }, "/v1/tax_ids/{id}": { "delete": { "description": "

Deletes an existing account or customer tax_id object.

", "operationId": "DeleteTaxIdsId", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted_tax_id" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Delete a tax ID" }, "get": { "description": "

Retrieves an account or customer tax_id object.

", "operationId": "GetTaxIdsId", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax_id" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a tax ID" } }, "/v1/tax_rates": { "get": { "description": "

Returns a list of your tax rates. Tax rates are returned sorted by creation date, with the most recently created tax rates appearing first.

", "operationId": "GetTaxRates", "parameters": [ { "description": "Optional flag to filter by tax rates that are either active or inactive (archived).", "in": "query", "name": "active", "required": false, "schema": { "type": "boolean" }, "style": "form" }, { "description": "Optional range for filtering created date.", "explode": true, "in": "query", "name": "created", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "description": "Minimum value to filter by (exclusive)", "type": "integer" }, "gte": { "description": "Minimum value to filter by (inclusive)", "type": "integer" }, "lt": { "description": "Maximum value to filter by (exclusive)", "type": "integer" }, "lte": { "description": "Maximum value to filter by (inclusive)", "type": "integer" } }, "title": "range_query_specs", "type": "object", "x-stripeMostCommon": [ "gt", "gte", "lt", "lte" ] }, { "type": "integer" } ] }, "style": "deepObject" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "Optional flag to filter by tax rates that are inclusive (or those that are not inclusive).", "in": "query", "name": "inclusive", "required": false, "schema": { "type": "boolean" }, "style": "form" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/tax_rate" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/tax_rates", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "TaxRatesList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all tax rates" }, "post": { "description": "

Creates a new tax rate.

", "operationId": "PostTaxRates", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "active": { "description": "Flag determining whether the tax rate is active or inactive (archived). Inactive tax rates cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set.", "type": "boolean" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "description": { "description": "An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.", "maxLength": 5000, "type": "string" }, "display_name": { "description": "The display name of the tax rate, which will be shown to users.", "maxLength": 50, "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "inclusive": { "description": "This specifies if the tax rate is inclusive or exclusive.", "type": "boolean" }, "jurisdiction": { "description": "The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.", "maxLength": 50, "type": "string" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "percentage": { "description": "This represents the tax rate percent out of 100.", "type": "number" }, "state": { "description": "[ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2), without country prefix. For example, \"NY\" for New York, United States.", "maxLength": 5000, "type": "string" }, "tax_type": { "description": "The high-level tax type, such as `vat` or `sales_tax`.", "enum": [ "amusement_tax", "communications_tax", "gst", "hst", "igst", "jct", "lease_tax", "pst", "qst", "retail_delivery_fee", "rst", "sales_tax", "service_tax", "vat" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "display_name", "inclusive", "percentage" ], "type": "object", "x-stripeMostCommon": [ "active", "country", "description", "display_name", "inclusive", "jurisdiction", "metadata", "percentage", "state" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax_rate" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a tax rate" } }, "/v1/tax_rates/{tax_rate}": { "get": { "description": "

Retrieves a tax rate with the given ID

", "operationId": "GetTaxRatesTaxRate", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "tax_rate", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax_rate" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a tax rate" }, "post": { "description": "

Updates an existing tax rate.

", "operationId": "PostTaxRatesTaxRate", "parameters": [ { "in": "path", "name": "tax_rate", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "active": { "description": "Flag determining whether the tax rate is active or inactive (archived). Inactive tax rates cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set.", "type": "boolean" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "description": { "description": "An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.", "maxLength": 5000, "type": "string" }, "display_name": { "description": "The display name of the tax rate, which will be shown to users.", "maxLength": 50, "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "jurisdiction": { "description": "The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.", "maxLength": 50, "type": "string" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "state": { "description": "[ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2), without country prefix. For example, \"NY\" for New York, United States.", "maxLength": 5000, "type": "string" }, "tax_type": { "description": "The high-level tax type, such as `vat` or `sales_tax`.", "enum": [ "amusement_tax", "communications_tax", "gst", "hst", "igst", "jct", "lease_tax", "pst", "qst", "retail_delivery_fee", "rst", "sales_tax", "service_tax", "vat" ], "type": "string", "x-stripeBypassValidation": true } }, "type": "object", "x-stripeMostCommon": [ "active", "country", "description", "display_name", "jurisdiction", "metadata", "state" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax_rate" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a tax rate" } }, "/v1/terminal/configurations": { "get": { "description": "

Returns a list of Configuration objects.

", "operationId": "GetTerminalConfigurations", "parameters": [ { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "if present, only return the account default or non-default configurations.", "in": "query", "name": "is_account_default", "required": false, "schema": { "type": "boolean" }, "style": "form" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/terminal.configuration" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/terminal/configurations", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "TerminalConfigurationConfigurationList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all Configurations" }, "post": { "description": "

Creates a new Configuration object.

", "operationId": "PostTerminalConfigurations", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "bbpos_wisepos_e": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "offline": { "explode": true, "style": "deepObject" }, "reader_security": { "explode": true, "style": "deepObject" }, "reboot_window": { "explode": true, "style": "deepObject" }, "stripe_s700": { "explode": true, "style": "deepObject" }, "tipping": { "explode": true, "style": "deepObject" }, "verifone_p400": { "explode": true, "style": "deepObject" }, "wifi": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "bbpos_wisepos_e": { "description": "An object containing device type specific settings for BBPOS WisePOS E readers", "properties": { "splashscreen": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "A File ID representing an image to display on the reader" } }, "title": "bbpos_wise_pose", "type": "object", "x-stripeMostCommon": [ "splashscreen" ] }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "name": { "description": "Name of the configuration", "maxLength": 100, "type": "string" }, "offline": { "anyOf": [ { "properties": { "enabled": { "description": "Determines whether to allow transactions to be collected while reader is offline. Defaults to false.", "type": "boolean" } }, "required": [ "enabled" ], "title": "offline", "type": "object", "x-stripeMostCommon": [ "enabled" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Configurations for collecting transactions offline." }, "reader_security": { "anyOf": [ { "properties": { "admin_menu_passcode": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Passcode used to access a reader's admin menu." } }, "title": "reader_security", "type": "object", "x-stripeMostCommon": [ "admin_menu_passcode" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Configurations for reader security settings." }, "reboot_window": { "description": "Reboot time settings for readers that support customized reboot time configuration.", "properties": { "end_hour": { "description": "Integer between 0 to 23 that represents the end hour of the reboot time window. The value must be different than the start_hour.", "type": "integer" }, "start_hour": { "description": "Integer between 0 to 23 that represents the start hour of the reboot time window.", "type": "integer" } }, "required": [ "end_hour", "start_hour" ], "title": "reboot_window", "type": "object", "x-stripeMostCommon": [ "end_hour", "start_hour" ] }, "stripe_s700": { "description": "An object containing device type specific settings for Stripe S700 readers", "properties": { "splashscreen": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "A File ID representing an image you would like displayed on the reader." } }, "title": "stripe_s700", "type": "object", "x-stripeMostCommon": [ "splashscreen" ] }, "tipping": { "anyOf": [ { "properties": { "aed": { "description": "Tipping configuration for AED", "properties": { "fixed_amounts": { "description": "Fixed amounts displayed when collecting a tip", "items": { "type": "integer" }, "type": "array" }, "percentages": { "description": "Percentages displayed when collecting a tip", "items": { "type": "integer" }, "type": "array" }, "smart_tip_threshold": { "description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed", "type": "integer" } }, "title": "currency_specific_config", "type": "object", "x-stripeMostCommon": [ "fixed_amounts", "percentages", "smart_tip_threshold" ] }, "aud": { "description": "Tipping configuration for AUD", "properties": { "fixed_amounts": { "description": "Fixed amounts displayed when collecting a tip", "items": { "type": "integer" }, "type": "array" }, "percentages": { "description": "Percentages displayed when collecting a tip", "items": { "type": "integer" }, "type": "array" }, "smart_tip_threshold": { "description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed", "type": "integer" } }, "title": "currency_specific_config", "type": "object", "x-stripeMostCommon": [ "fixed_amounts", "percentages", "smart_tip_threshold" ] }, "bgn": { "description": "Tipping configuration for BGN", "properties": { "fixed_amounts": { "description": "Fixed amounts displayed when collecting a tip", "items": { "type": "integer" }, "type": "array" }, "percentages": { "description": "Percentages displayed when collecting a tip", "items": { "type": "integer" }, "type": "array" }, "smart_tip_threshold": { "description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed", "type": "integer" } }, "title": "currency_specific_config", "type": "object", "x-stripeMostCommon": [ "fixed_amounts", "percentages", "smart_tip_threshold" ] }, "cad": { "description": "Tipping configuration for CAD", "properties": { "fixed_amounts": { "description": "Fixed amounts displayed when collecting a tip", "items": { "type": "integer" }, "type": "array" }, "percentages": { "description": "Percentages displayed when collecting a tip", "items": { "type": "integer" }, "type": "array" }, "smart_tip_threshold": { "description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed", "type": "integer" } }, "title": "currency_specific_config", "type": "object", "x-stripeMostCommon": [ "fixed_amounts", "percentages", "smart_tip_threshold" ] }, "chf": { "description": "Tipping configuration for CHF", "properties": { "fixed_amounts": { "description": "Fixed amounts displayed when collecting a tip", "items": { "type": "integer" }, "type": "array" }, "percentages": { "description": "Percentages displayed when collecting a tip", "items": { "type": "integer" }, "type": "array" }, "smart_tip_threshold": { "description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed", "type": "integer" } }, "title": "currency_specific_config", "type": "object", "x-stripeMostCommon": [ "fixed_amounts", "percentages", "smart_tip_threshold" ] }, "czk": { "description": "Tipping configuration for CZK", "properties": { "fixed_amounts": { "description": "Fixed amounts displayed when collecting a tip", "items": { "type": "integer" }, "type": "array" }, "percentages": { "description": "Percentages displayed when collecting a tip", "items": { "type": "integer" }, "type": "array" }, "smart_tip_threshold": { "description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed", "type": "integer" } }, "title": "currency_specific_config", "type": "object", "x-stripeMostCommon": [ "fixed_amounts", "percentages", "smart_tip_threshold" ] }, "dkk": { "description": "Tipping configuration for DKK", "properties": { "fixed_amounts": { "description": "Fixed amounts displayed when collecting a tip", "items": { "type": "integer" }, "type": "array" }, "percentages": { "description": "Percentages displayed when collecting a tip", "items": { "type": "integer" }, "type": "array" }, "smart_tip_threshold": { "description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed", "type": "integer" } }, "title": "currency_specific_config", "type": "object", "x-stripeMostCommon": [ "fixed_amounts", "percentages", "smart_tip_threshold" ] }, "eur": { "description": "Tipping configuration for EUR", "properties": { "fixed_amounts": { "description": "Fixed amounts displayed when collecting a tip", "items": { "type": "integer" }, "type": "array" }, "percentages": { "description": "Percentages displayed when collecting a tip", "items": { "type": "integer" }, "type": "array" }, "smart_tip_threshold": { "description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed", "type": "integer" } }, "title": "currency_specific_config", "type": "object", "x-stripeMostCommon": [ "fixed_amounts", "percentages", "smart_tip_threshold" ] }, "gbp": { "description": "Tipping configuration for GBP", "properties": { "fixed_amounts": { "description": "Fixed amounts displayed when collecting a tip", "items": { "type": "integer" }, "type": "array" }, "percentages": { "description": "Percentages displayed when collecting a tip", "items": { "type": "integer" }, "type": "array" }, "smart_tip_threshold": { "description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed", "type": "integer" } }, "title": "currency_specific_config", "type": "object", "x-stripeMostCommon": [ "fixed_amounts", "percentages", "smart_tip_threshold" ] }, "hkd": { "description": "Tipping configuration for HKD", "properties": { "fixed_amounts": { "description": "Fixed amounts displayed when collecting a tip", "items": { "type": "integer" }, "type": "array" }, "percentages": { "description": "Percentages displayed when collecting a tip", "items": { "type": "integer" }, "type": "array" }, "smart_tip_threshold": { "description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed", "type": "integer" } }, "title": "currency_specific_config", "type": "object", "x-stripeMostCommon": [ "fixed_amounts", "percentages", "smart_tip_threshold" ] }, "huf": { "description": "Tipping configuration for HUF", "properties": { "fixed_amounts": { "description": "Fixed amounts displayed when collecting a tip", "items": { "type": "integer" }, "type": "array" }, "percentages": { "description": "Percentages displayed when collecting a tip", "items": { "type": "integer" }, "type": "array" }, "smart_tip_threshold": { "description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed", "type": "integer" } }, "title": "currency_specific_config", "type": "object", "x-stripeMostCommon": [ "fixed_amounts", "percentages", "smart_tip_threshold" ] }, "jpy": { "description": "Tipping configuration for JPY", "properties": { "fixed_amounts": { "description": "Fixed amounts displayed when collecting a tip", "items": { "type": "integer" }, "type": "array" }, "percentages": { "description": "Percentages displayed when collecting a tip", "items": { "type": "integer" }, "type": "array" }, "smart_tip_threshold": { "description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed", "type": "integer" } }, "title": "currency_specific_config", "type": "object", "x-stripeMostCommon": [ "fixed_amounts", "percentages", "smart_tip_threshold" ] }, "mxn": { "description": "Tipping configuration for MXN", "properties": { "fixed_amounts": { "description": "Fixed amounts displayed when collecting a tip", "items": { "type": "integer" }, "type": "array" }, "percentages": { "description": "Percentages displayed when collecting a tip", "items": { "type": "integer" }, "type": "array" }, "smart_tip_threshold": { "description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed", "type": "integer" } }, "title": "currency_specific_config", "type": "object", "x-stripeMostCommon": [ "fixed_amounts", "percentages", "smart_tip_threshold" ] }, "myr": { "description": "Tipping configuration for MYR", "properties": { "fixed_amounts": { "description": "Fixed amounts displayed when collecting a tip", "items": { "type": "integer" }, "type": "array" }, "percentages": { "description": "Percentages displayed when collecting a tip", "items": { "type": "integer" }, "type": "array" }, "smart_tip_threshold": { "description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed", "type": "integer" } }, "title": "currency_specific_config", "type": "object", "x-stripeMostCommon": [ "fixed_amounts", "percentages", "smart_tip_threshold" ] }, "nok": { "description": "Tipping configuration for NOK", "properties": { "fixed_amounts": { "description": "Fixed amounts displayed when collecting a tip", "items": { "type": "integer" }, "type": "array" }, "percentages": { "description": "Percentages displayed when collecting a tip", "items": { "type": "integer" }, "type": "array" }, "smart_tip_threshold": { "description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed", "type": "integer" } }, "title": "currency_specific_config", "type": "object", "x-stripeMostCommon": [ "fixed_amounts", "percentages", "smart_tip_threshold" ] }, "nzd": { "description": "Tipping configuration for NZD", "properties": { "fixed_amounts": { "description": "Fixed amounts displayed when collecting a tip", "items": { "type": "integer" }, "type": "array" }, "percentages": { "description": "Percentages displayed when collecting a tip", "items": { "type": "integer" }, "type": "array" }, "smart_tip_threshold": { "description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed", "type": "integer" } }, "title": "currency_specific_config", "type": "object", "x-stripeMostCommon": [ "fixed_amounts", "percentages", "smart_tip_threshold" ] }, "pln": { "description": "Tipping configuration for PLN", "properties": { "fixed_amounts": { "description": "Fixed amounts displayed when collecting a tip", "items": { "type": "integer" }, "type": "array" }, "percentages": { "description": "Percentages displayed when collecting a tip", "items": { "type": "integer" }, "type": "array" }, "smart_tip_threshold": { "description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed", "type": "integer" } }, "title": "currency_specific_config", "type": "object", "x-stripeMostCommon": [ "fixed_amounts", "percentages", "smart_tip_threshold" ] }, "ron": { "description": "Tipping configuration for RON", "properties": { "fixed_amounts": { "description": "Fixed amounts displayed when collecting a tip", "items": { "type": "integer" }, "type": "array" }, "percentages": { "description": "Percentages displayed when collecting a tip", "items": { "type": "integer" }, "type": "array" }, "smart_tip_threshold": { "description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed", "type": "integer" } }, "title": "currency_specific_config", "type": "object", "x-stripeMostCommon": [ "fixed_amounts", "percentages", "smart_tip_threshold" ] }, "sek": { "description": "Tipping configuration for SEK", "properties": { "fixed_amounts": { "description": "Fixed amounts displayed when collecting a tip", "items": { "type": "integer" }, "type": "array" }, "percentages": { "description": "Percentages displayed when collecting a tip", "items": { "type": "integer" }, "type": "array" }, "smart_tip_threshold": { "description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed", "type": "integer" } }, "title": "currency_specific_config", "type": "object", "x-stripeMostCommon": [ "fixed_amounts", "percentages", "smart_tip_threshold" ] }, "sgd": { "description": "Tipping configuration for SGD", "properties": { "fixed_amounts": { "description": "Fixed amounts displayed when collecting a tip", "items": { "type": "integer" }, "type": "array" }, "percentages": { "description": "Percentages displayed when collecting a tip", "items": { "type": "integer" }, "type": "array" }, "smart_tip_threshold": { "description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed", "type": "integer" } }, "title": "currency_specific_config", "type": "object", "x-stripeMostCommon": [ "fixed_amounts", "percentages", "smart_tip_threshold" ] }, "usd": { "description": "Tipping configuration for USD", "properties": { "fixed_amounts": { "description": "Fixed amounts displayed when collecting a tip", "items": { "type": "integer" }, "type": "array" }, "percentages": { "description": "Percentages displayed when collecting a tip", "items": { "type": "integer" }, "type": "array" }, "smart_tip_threshold": { "description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed", "type": "integer" } }, "title": "currency_specific_config", "type": "object", "x-stripeMostCommon": [ "fixed_amounts", "percentages", "smart_tip_threshold" ] } }, "title": "tipping", "type": "object", "x-stripeMostCommon": [ "aed", "aud", "bgn", "cad", "chf", "czk", "dkk", "eur", "gbp", "hkd", "huf", "jpy", "mxn", "myr", "nok", "nzd", "pln", "ron", "sek", "sgd", "usd" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Tipping configurations for readers supporting on-reader tips" }, "verifone_p400": { "description": "An object containing device type specific settings for Verifone P400 readers", "properties": { "splashscreen": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "A File ID representing an image you would like displayed on the reader." } }, "title": "verifone_p400", "type": "object", "x-stripeMostCommon": [ "splashscreen" ] }, "wifi": { "anyOf": [ { "properties": { "enterprise_eap_peap": { "description": "Credentials for a WPA-Enterprise WiFi network using the EAP-PEAP authentication method.", "properties": { "ca_certificate_file": { "description": "A File ID representing a PEM file containing the server certificate", "type": "string" }, "password": { "description": "Password for connecting to the WiFi network", "maxLength": 5000, "type": "string" }, "ssid": { "description": "Name of the WiFi network", "maxLength": 5000, "type": "string" }, "username": { "description": "Username for connecting to the WiFi network", "maxLength": 5000, "type": "string" } }, "required": [ "password", "ssid", "username" ], "title": "enterprise_peap_config", "type": "object", "x-stripeMostCommon": [ "ca_certificate_file", "password", "ssid", "username" ] }, "enterprise_eap_tls": { "description": "Credentials for a WPA-Enterprise WiFi network using the EAP-TLS authentication method.", "properties": { "ca_certificate_file": { "description": "A File ID representing a PEM file containing the server certificate", "type": "string" }, "client_certificate_file": { "description": "A File ID representing a PEM file containing the client certificate", "type": "string" }, "private_key_file": { "description": "A File ID representing a PEM file containing the client RSA private key", "type": "string" }, "private_key_file_password": { "description": "Password for the private key file", "maxLength": 5000, "type": "string" }, "ssid": { "description": "Name of the WiFi network", "maxLength": 5000, "type": "string" } }, "required": [ "client_certificate_file", "private_key_file", "ssid" ], "title": "enterprise_tls_config", "type": "object", "x-stripeMostCommon": [ "ca_certificate_file", "client_certificate_file", "private_key_file", "private_key_file_password", "ssid" ] }, "personal_psk": { "description": "Credentials for a WPA-Personal WiFi network.", "properties": { "password": { "description": "Password for connecting to the WiFi network", "maxLength": 63, "type": "string" }, "ssid": { "description": "Name of the WiFi network", "maxLength": 5000, "type": "string" } }, "required": [ "password", "ssid" ], "title": "personal_psk_config", "type": "object", "x-stripeMostCommon": [ "password", "ssid" ] }, "type": { "description": "Security type of the WiFi network. Fill out the hash with the corresponding name to provide the set of credentials for this security type.", "enum": [ "enterprise_eap_peap", "enterprise_eap_tls", "personal_psk" ], "type": "string" } }, "required": [ "type" ], "title": "wifi", "type": "object", "x-stripeMostCommon": [ "enterprise_eap_peap", "enterprise_eap_tls", "personal_psk", "type" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Configurations for connecting to a WiFi network." } }, "type": "object", "x-stripeMostCommon": [ "bbpos_wisepos_e", "stripe_s700", "tipping", "verifone_p400" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/terminal.configuration" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a Configuration" } }, "/v1/terminal/configurations/{configuration}": { "delete": { "description": "

Deletes a Configuration object.

", "operationId": "DeleteTerminalConfigurationsConfiguration", "parameters": [ { "in": "path", "name": "configuration", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted_terminal.configuration" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Delete a Configuration" }, "get": { "description": "

Retrieves a Configuration object.

", "operationId": "GetTerminalConfigurationsConfiguration", "parameters": [ { "in": "path", "name": "configuration", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/terminal.configuration" }, { "$ref": "#/components/schemas/deleted_terminal.configuration" } ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a Configuration" }, "post": { "description": "

Updates a new Configuration object.

", "operationId": "PostTerminalConfigurationsConfiguration", "parameters": [ { "in": "path", "name": "configuration", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "bbpos_wisepos_e": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "offline": { "explode": true, "style": "deepObject" }, "reader_security": { "explode": true, "style": "deepObject" }, "reboot_window": { "explode": true, "style": "deepObject" }, "stripe_s700": { "explode": true, "style": "deepObject" }, "tipping": { "explode": true, "style": "deepObject" }, "verifone_p400": { "explode": true, "style": "deepObject" }, "wifi": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "bbpos_wisepos_e": { "anyOf": [ { "properties": { "splashscreen": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "A File ID representing an image to display on the reader" } }, "title": "bbpos_wise_pose", "type": "object", "x-stripeMostCommon": [ "splashscreen" ] }, { "enum": [ "" ], "type": "string" } ], "description": "An object containing device type specific settings for BBPOS WisePOS E readers" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "name": { "description": "Name of the configuration", "maxLength": 100, "type": "string" }, "offline": { "anyOf": [ { "properties": { "enabled": { "description": "Determines whether to allow transactions to be collected while reader is offline. Defaults to false.", "type": "boolean" } }, "required": [ "enabled" ], "title": "offline", "type": "object", "x-stripeMostCommon": [ "enabled" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Configurations for collecting transactions offline." }, "reader_security": { "anyOf": [ { "properties": { "admin_menu_passcode": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Passcode used to access a reader's admin menu." } }, "title": "reader_security", "type": "object", "x-stripeMostCommon": [ "admin_menu_passcode" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Configurations for reader security settings." }, "reboot_window": { "anyOf": [ { "properties": { "end_hour": { "description": "Integer between 0 to 23 that represents the end hour of the reboot time window. The value must be different than the start_hour.", "type": "integer" }, "start_hour": { "description": "Integer between 0 to 23 that represents the start hour of the reboot time window.", "type": "integer" } }, "required": [ "end_hour", "start_hour" ], "title": "reboot_window", "type": "object", "x-stripeMostCommon": [ "end_hour", "start_hour" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Reboot time settings for readers that support customized reboot time configuration." }, "stripe_s700": { "anyOf": [ { "properties": { "splashscreen": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "A File ID representing an image you would like displayed on the reader." } }, "title": "stripe_s700", "type": "object", "x-stripeMostCommon": [ "splashscreen" ] }, { "enum": [ "" ], "type": "string" } ], "description": "An object containing device type specific settings for Stripe S700 readers" }, "tipping": { "anyOf": [ { "properties": { "aed": { "description": "Tipping configuration for AED", "properties": { "fixed_amounts": { "description": "Fixed amounts displayed when collecting a tip", "items": { "type": "integer" }, "type": "array" }, "percentages": { "description": "Percentages displayed when collecting a tip", "items": { "type": "integer" }, "type": "array" }, "smart_tip_threshold": { "description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed", "type": "integer" } }, "title": "currency_specific_config", "type": "object", "x-stripeMostCommon": [ "fixed_amounts", "percentages", "smart_tip_threshold" ] }, "aud": { "description": "Tipping configuration for AUD", "properties": { "fixed_amounts": { "description": "Fixed amounts displayed when collecting a tip", "items": { "type": "integer" }, "type": "array" }, "percentages": { "description": "Percentages displayed when collecting a tip", "items": { "type": "integer" }, "type": "array" }, "smart_tip_threshold": { "description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed", "type": "integer" } }, "title": "currency_specific_config", "type": "object", "x-stripeMostCommon": [ "fixed_amounts", "percentages", "smart_tip_threshold" ] }, "bgn": { "description": "Tipping configuration for BGN", "properties": { "fixed_amounts": { "description": "Fixed amounts displayed when collecting a tip", "items": { "type": "integer" }, "type": "array" }, "percentages": { "description": "Percentages displayed when collecting a tip", "items": { "type": "integer" }, "type": "array" }, "smart_tip_threshold": { "description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed", "type": "integer" } }, "title": "currency_specific_config", "type": "object", "x-stripeMostCommon": [ "fixed_amounts", "percentages", "smart_tip_threshold" ] }, "cad": { "description": "Tipping configuration for CAD", "properties": { "fixed_amounts": { "description": "Fixed amounts displayed when collecting a tip", "items": { "type": "integer" }, "type": "array" }, "percentages": { "description": "Percentages displayed when collecting a tip", "items": { "type": "integer" }, "type": "array" }, "smart_tip_threshold": { "description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed", "type": "integer" } }, "title": "currency_specific_config", "type": "object", "x-stripeMostCommon": [ "fixed_amounts", "percentages", "smart_tip_threshold" ] }, "chf": { "description": "Tipping configuration for CHF", "properties": { "fixed_amounts": { "description": "Fixed amounts displayed when collecting a tip", "items": { "type": "integer" }, "type": "array" }, "percentages": { "description": "Percentages displayed when collecting a tip", "items": { "type": "integer" }, "type": "array" }, "smart_tip_threshold": { "description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed", "type": "integer" } }, "title": "currency_specific_config", "type": "object", "x-stripeMostCommon": [ "fixed_amounts", "percentages", "smart_tip_threshold" ] }, "czk": { "description": "Tipping configuration for CZK", "properties": { "fixed_amounts": { "description": "Fixed amounts displayed when collecting a tip", "items": { "type": "integer" }, "type": "array" }, "percentages": { "description": "Percentages displayed when collecting a tip", "items": { "type": "integer" }, "type": "array" }, "smart_tip_threshold": { "description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed", "type": "integer" } }, "title": "currency_specific_config", "type": "object", "x-stripeMostCommon": [ "fixed_amounts", "percentages", "smart_tip_threshold" ] }, "dkk": { "description": "Tipping configuration for DKK", "properties": { "fixed_amounts": { "description": "Fixed amounts displayed when collecting a tip", "items": { "type": "integer" }, "type": "array" }, "percentages": { "description": "Percentages displayed when collecting a tip", "items": { "type": "integer" }, "type": "array" }, "smart_tip_threshold": { "description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed", "type": "integer" } }, "title": "currency_specific_config", "type": "object", "x-stripeMostCommon": [ "fixed_amounts", "percentages", "smart_tip_threshold" ] }, "eur": { "description": "Tipping configuration for EUR", "properties": { "fixed_amounts": { "description": "Fixed amounts displayed when collecting a tip", "items": { "type": "integer" }, "type": "array" }, "percentages": { "description": "Percentages displayed when collecting a tip", "items": { "type": "integer" }, "type": "array" }, "smart_tip_threshold": { "description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed", "type": "integer" } }, "title": "currency_specific_config", "type": "object", "x-stripeMostCommon": [ "fixed_amounts", "percentages", "smart_tip_threshold" ] }, "gbp": { "description": "Tipping configuration for GBP", "properties": { "fixed_amounts": { "description": "Fixed amounts displayed when collecting a tip", "items": { "type": "integer" }, "type": "array" }, "percentages": { "description": "Percentages displayed when collecting a tip", "items": { "type": "integer" }, "type": "array" }, "smart_tip_threshold": { "description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed", "type": "integer" } }, "title": "currency_specific_config", "type": "object", "x-stripeMostCommon": [ "fixed_amounts", "percentages", "smart_tip_threshold" ] }, "hkd": { "description": "Tipping configuration for HKD", "properties": { "fixed_amounts": { "description": "Fixed amounts displayed when collecting a tip", "items": { "type": "integer" }, "type": "array" }, "percentages": { "description": "Percentages displayed when collecting a tip", "items": { "type": "integer" }, "type": "array" }, "smart_tip_threshold": { "description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed", "type": "integer" } }, "title": "currency_specific_config", "type": "object", "x-stripeMostCommon": [ "fixed_amounts", "percentages", "smart_tip_threshold" ] }, "huf": { "description": "Tipping configuration for HUF", "properties": { "fixed_amounts": { "description": "Fixed amounts displayed when collecting a tip", "items": { "type": "integer" }, "type": "array" }, "percentages": { "description": "Percentages displayed when collecting a tip", "items": { "type": "integer" }, "type": "array" }, "smart_tip_threshold": { "description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed", "type": "integer" } }, "title": "currency_specific_config", "type": "object", "x-stripeMostCommon": [ "fixed_amounts", "percentages", "smart_tip_threshold" ] }, "jpy": { "description": "Tipping configuration for JPY", "properties": { "fixed_amounts": { "description": "Fixed amounts displayed when collecting a tip", "items": { "type": "integer" }, "type": "array" }, "percentages": { "description": "Percentages displayed when collecting a tip", "items": { "type": "integer" }, "type": "array" }, "smart_tip_threshold": { "description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed", "type": "integer" } }, "title": "currency_specific_config", "type": "object", "x-stripeMostCommon": [ "fixed_amounts", "percentages", "smart_tip_threshold" ] }, "mxn": { "description": "Tipping configuration for MXN", "properties": { "fixed_amounts": { "description": "Fixed amounts displayed when collecting a tip", "items": { "type": "integer" }, "type": "array" }, "percentages": { "description": "Percentages displayed when collecting a tip", "items": { "type": "integer" }, "type": "array" }, "smart_tip_threshold": { "description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed", "type": "integer" } }, "title": "currency_specific_config", "type": "object", "x-stripeMostCommon": [ "fixed_amounts", "percentages", "smart_tip_threshold" ] }, "myr": { "description": "Tipping configuration for MYR", "properties": { "fixed_amounts": { "description": "Fixed amounts displayed when collecting a tip", "items": { "type": "integer" }, "type": "array" }, "percentages": { "description": "Percentages displayed when collecting a tip", "items": { "type": "integer" }, "type": "array" }, "smart_tip_threshold": { "description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed", "type": "integer" } }, "title": "currency_specific_config", "type": "object", "x-stripeMostCommon": [ "fixed_amounts", "percentages", "smart_tip_threshold" ] }, "nok": { "description": "Tipping configuration for NOK", "properties": { "fixed_amounts": { "description": "Fixed amounts displayed when collecting a tip", "items": { "type": "integer" }, "type": "array" }, "percentages": { "description": "Percentages displayed when collecting a tip", "items": { "type": "integer" }, "type": "array" }, "smart_tip_threshold": { "description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed", "type": "integer" } }, "title": "currency_specific_config", "type": "object", "x-stripeMostCommon": [ "fixed_amounts", "percentages", "smart_tip_threshold" ] }, "nzd": { "description": "Tipping configuration for NZD", "properties": { "fixed_amounts": { "description": "Fixed amounts displayed when collecting a tip", "items": { "type": "integer" }, "type": "array" }, "percentages": { "description": "Percentages displayed when collecting a tip", "items": { "type": "integer" }, "type": "array" }, "smart_tip_threshold": { "description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed", "type": "integer" } }, "title": "currency_specific_config", "type": "object", "x-stripeMostCommon": [ "fixed_amounts", "percentages", "smart_tip_threshold" ] }, "pln": { "description": "Tipping configuration for PLN", "properties": { "fixed_amounts": { "description": "Fixed amounts displayed when collecting a tip", "items": { "type": "integer" }, "type": "array" }, "percentages": { "description": "Percentages displayed when collecting a tip", "items": { "type": "integer" }, "type": "array" }, "smart_tip_threshold": { "description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed", "type": "integer" } }, "title": "currency_specific_config", "type": "object", "x-stripeMostCommon": [ "fixed_amounts", "percentages", "smart_tip_threshold" ] }, "ron": { "description": "Tipping configuration for RON", "properties": { "fixed_amounts": { "description": "Fixed amounts displayed when collecting a tip", "items": { "type": "integer" }, "type": "array" }, "percentages": { "description": "Percentages displayed when collecting a tip", "items": { "type": "integer" }, "type": "array" }, "smart_tip_threshold": { "description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed", "type": "integer" } }, "title": "currency_specific_config", "type": "object", "x-stripeMostCommon": [ "fixed_amounts", "percentages", "smart_tip_threshold" ] }, "sek": { "description": "Tipping configuration for SEK", "properties": { "fixed_amounts": { "description": "Fixed amounts displayed when collecting a tip", "items": { "type": "integer" }, "type": "array" }, "percentages": { "description": "Percentages displayed when collecting a tip", "items": { "type": "integer" }, "type": "array" }, "smart_tip_threshold": { "description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed", "type": "integer" } }, "title": "currency_specific_config", "type": "object", "x-stripeMostCommon": [ "fixed_amounts", "percentages", "smart_tip_threshold" ] }, "sgd": { "description": "Tipping configuration for SGD", "properties": { "fixed_amounts": { "description": "Fixed amounts displayed when collecting a tip", "items": { "type": "integer" }, "type": "array" }, "percentages": { "description": "Percentages displayed when collecting a tip", "items": { "type": "integer" }, "type": "array" }, "smart_tip_threshold": { "description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed", "type": "integer" } }, "title": "currency_specific_config", "type": "object", "x-stripeMostCommon": [ "fixed_amounts", "percentages", "smart_tip_threshold" ] }, "usd": { "description": "Tipping configuration for USD", "properties": { "fixed_amounts": { "description": "Fixed amounts displayed when collecting a tip", "items": { "type": "integer" }, "type": "array" }, "percentages": { "description": "Percentages displayed when collecting a tip", "items": { "type": "integer" }, "type": "array" }, "smart_tip_threshold": { "description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed", "type": "integer" } }, "title": "currency_specific_config", "type": "object", "x-stripeMostCommon": [ "fixed_amounts", "percentages", "smart_tip_threshold" ] } }, "title": "tipping", "type": "object", "x-stripeMostCommon": [ "aed", "aud", "bgn", "cad", "chf", "czk", "dkk", "eur", "gbp", "hkd", "huf", "jpy", "mxn", "myr", "nok", "nzd", "pln", "ron", "sek", "sgd", "usd" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Tipping configurations for readers supporting on-reader tips" }, "verifone_p400": { "anyOf": [ { "properties": { "splashscreen": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "A File ID representing an image you would like displayed on the reader." } }, "title": "verifone_p400", "type": "object", "x-stripeMostCommon": [ "splashscreen" ] }, { "enum": [ "" ], "type": "string" } ], "description": "An object containing device type specific settings for Verifone P400 readers" }, "wifi": { "anyOf": [ { "properties": { "enterprise_eap_peap": { "description": "Credentials for a WPA-Enterprise WiFi network using the EAP-PEAP authentication method.", "properties": { "ca_certificate_file": { "description": "A File ID representing a PEM file containing the server certificate", "type": "string" }, "password": { "description": "Password for connecting to the WiFi network", "maxLength": 5000, "type": "string" }, "ssid": { "description": "Name of the WiFi network", "maxLength": 5000, "type": "string" }, "username": { "description": "Username for connecting to the WiFi network", "maxLength": 5000, "type": "string" } }, "required": [ "password", "ssid", "username" ], "title": "enterprise_peap_config", "type": "object", "x-stripeMostCommon": [ "ca_certificate_file", "password", "ssid", "username" ] }, "enterprise_eap_tls": { "description": "Credentials for a WPA-Enterprise WiFi network using the EAP-TLS authentication method.", "properties": { "ca_certificate_file": { "description": "A File ID representing a PEM file containing the server certificate", "type": "string" }, "client_certificate_file": { "description": "A File ID representing a PEM file containing the client certificate", "type": "string" }, "private_key_file": { "description": "A File ID representing a PEM file containing the client RSA private key", "type": "string" }, "private_key_file_password": { "description": "Password for the private key file", "maxLength": 5000, "type": "string" }, "ssid": { "description": "Name of the WiFi network", "maxLength": 5000, "type": "string" } }, "required": [ "client_certificate_file", "private_key_file", "ssid" ], "title": "enterprise_tls_config", "type": "object", "x-stripeMostCommon": [ "ca_certificate_file", "client_certificate_file", "private_key_file", "private_key_file_password", "ssid" ] }, "personal_psk": { "description": "Credentials for a WPA-Personal WiFi network.", "properties": { "password": { "description": "Password for connecting to the WiFi network", "maxLength": 63, "type": "string" }, "ssid": { "description": "Name of the WiFi network", "maxLength": 5000, "type": "string" } }, "required": [ "password", "ssid" ], "title": "personal_psk_config", "type": "object", "x-stripeMostCommon": [ "password", "ssid" ] }, "type": { "description": "Security type of the WiFi network. Fill out the hash with the corresponding name to provide the set of credentials for this security type.", "enum": [ "enterprise_eap_peap", "enterprise_eap_tls", "personal_psk" ], "type": "string" } }, "required": [ "type" ], "title": "wifi", "type": "object", "x-stripeMostCommon": [ "enterprise_eap_peap", "enterprise_eap_tls", "personal_psk", "type" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Configurations for connecting to a WiFi network." } }, "type": "object", "x-stripeMostCommon": [ "bbpos_wisepos_e", "stripe_s700", "tipping", "verifone_p400" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/terminal.configuration" }, { "$ref": "#/components/schemas/deleted_terminal.configuration" } ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a Configuration" } }, "/v1/terminal/connection_tokens": { "post": { "description": "

To connect to a reader the Stripe Terminal SDK needs to retrieve a short-lived connection token from Stripe, proxied through your server. On your backend, add an endpoint that creates and returns a connection token.

", "operationId": "PostTerminalConnectionTokens", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "location": { "description": "The id of the location that this connection token is scoped to. If specified the connection token will only be usable with readers assigned to that location, otherwise the connection token will be usable with all readers. Note that location scoping only applies to internet-connected readers. For more details, see [the docs on scoping connection tokens](https://docs.stripe.com/terminal/fleet/locations-and-zones?dashboard-or-api=api#connection-tokens).", "maxLength": 5000, "type": "string" } }, "type": "object", "x-stripeMostCommon": [ "location" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/terminal.connection_token" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a Connection Token" } }, "/v1/terminal/locations": { "get": { "description": "

Returns a list of Location objects.

", "operationId": "GetTerminalLocations", "parameters": [ { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/terminal.location" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/terminal/locations", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "TerminalLocationLocationList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all Locations" }, "post": { "description": "

Creates a new Location object.\nFor further details, including which address fields are required in each country, see the Manage locations guide.

", "operationId": "PostTerminalLocations", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "address": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "address": { "description": "The full address of the location.", "properties": { "city": { "description": "City, district, suburb, town, or village.", "maxLength": 5000, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Address line 1 (e.g., street, PO Box, or company name).", "maxLength": 5000, "type": "string" }, "line2": { "description": "Address line 2 (e.g., apartment, suite, unit, or building).", "maxLength": 5000, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "State, county, province, or region.", "maxLength": 5000, "type": "string" } }, "required": [ "country" ], "title": "create_location_address_param", "type": "object", "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state" ] }, "configuration_overrides": { "description": "The ID of a configuration that will be used to customize all readers in this location.", "maxLength": 500, "type": "string" }, "display_name": { "description": "A name for the location. Maximum length is 1000 characters.", "maxLength": 1000, "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." } }, "required": [ "address", "display_name" ], "type": "object", "x-stripeMostCommon": [ "address", "display_name", "metadata" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/terminal.location" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a Location" } }, "/v1/terminal/locations/{location}": { "delete": { "description": "

Deletes a Location object.

", "operationId": "DeleteTerminalLocationsLocation", "parameters": [ { "in": "path", "name": "location", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted_terminal.location" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Delete a Location" }, "get": { "description": "

Retrieves a Location object.

", "operationId": "GetTerminalLocationsLocation", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "location", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/terminal.location" }, { "$ref": "#/components/schemas/deleted_terminal.location" } ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a Location" }, "post": { "description": "

Updates a Location object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

", "operationId": "PostTerminalLocationsLocation", "parameters": [ { "in": "path", "name": "location", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "address": { "explode": true, "style": "deepObject" }, "configuration_overrides": { "explode": true, "style": "deepObject" }, "display_name": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "address": { "description": "The full address of the location. You can't change the location's `country`. If you need to modify the `country` field, create a new `Location` object and re-register any existing readers to that location.", "properties": { "city": { "description": "City, district, suburb, town, or village.", "maxLength": 5000, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Address line 1 (e.g., street, PO Box, or company name).", "maxLength": 5000, "type": "string" }, "line2": { "description": "Address line 2 (e.g., apartment, suite, unit, or building).", "maxLength": 5000, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "State, county, province, or region.", "maxLength": 5000, "type": "string" } }, "title": "optional_fields_address", "type": "object", "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state" ] }, "configuration_overrides": { "anyOf": [ { "maxLength": 1000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "The ID of a configuration that will be used to customize all readers in this location." }, "display_name": { "anyOf": [ { "maxLength": 1000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "A name for the location." }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." } }, "type": "object", "x-stripeMostCommon": [ "address", "display_name", "metadata" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/terminal.location" }, { "$ref": "#/components/schemas/deleted_terminal.location" } ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a Location" } }, "/v1/terminal/onboarding_links": { "post": { "description": "

Creates a new OnboardingLink object that contains a redirect_url used for onboarding onto Tap to Pay on iPhone.

", "operationId": "PostTerminalOnboardingLinks", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "link_options": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "link_options": { "description": "Specific fields needed to generate the desired link type.", "properties": { "apple_terms_and_conditions": { "description": "The options associated with the Apple Terms and Conditions link type.", "properties": { "allow_relinking": { "description": "Whether the link should also support users relinking their Apple account.", "type": "boolean" }, "merchant_display_name": { "description": "The business name of the merchant accepting Apple's Terms and Conditions.", "maxLength": 5000, "type": "string" } }, "required": [ "merchant_display_name" ], "title": "apple_terms_and_conditions_params", "type": "object", "x-stripeMostCommon": [ "allow_relinking", "merchant_display_name" ] } }, "title": "link_options_params", "type": "object", "x-stripeMostCommon": [ "apple_terms_and_conditions" ] }, "link_type": { "description": "The type of link being generated.", "enum": [ "apple_terms_and_conditions" ], "type": "string" }, "on_behalf_of": { "description": "Stripe account ID to generate the link for.", "maxLength": 5000, "type": "string" } }, "required": [ "link_options", "link_type" ], "type": "object", "x-stripeMostCommon": [ "link_options", "link_type", "on_behalf_of" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/terminal.onboarding_link" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create an Onboarding Link" } }, "/v1/terminal/reader_collected_data/{reader_collected_data}": { "get": { "description": "

Retrieve data collected using Reader hardware.

", "operationId": "GetTerminalReaderCollectedDataReaderCollectedData", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "The ID of the ReaderCollectedData to retrieve.", "in": "path", "name": "reader_collected_data", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/terminal.reader_collected_data" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve ReaderCollectedData" } }, "/v1/terminal/readers": { "get": { "description": "

Returns a list of Reader objects.

", "operationId": "GetTerminalReaders", "parameters": [ { "description": "Filters readers by device type", "in": "query", "name": "device_type", "required": false, "schema": { "enum": [ "bbpos_chipper2x", "bbpos_wisepad3", "bbpos_wisepos_e", "mobile_phone_reader", "simulated_stripe_s700", "simulated_wisepos_e", "stripe_m2", "stripe_s700", "verifone_P400" ], "type": "string", "x-stripeBypassValidation": true }, "style": "form" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "A location ID to filter the response list to only readers at the specific location", "in": "query", "name": "location", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Filters readers by serial number", "in": "query", "name": "serial_number", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "A status filter to filter readers to only offline or online readers", "in": "query", "name": "status", "required": false, "schema": { "enum": [ "offline", "online" ], "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "description": "A list of readers", "items": { "$ref": "#/components/schemas/terminal.reader" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "TerminalReaderRetrieveReader", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all Readers" }, "post": { "description": "

Creates a new Reader object.

", "operationId": "PostTerminalReaders", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "label": { "description": "Custom label given to the reader for easier identification. If no label is specified, the registration code will be used.", "maxLength": 5000, "type": "string" }, "location": { "description": "The location to assign the reader to.", "maxLength": 5000, "type": "string" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "registration_code": { "description": "A code generated by the reader used for registering to an account.", "maxLength": 5000, "type": "string" } }, "required": [ "registration_code" ], "type": "object", "x-stripeMostCommon": [ "label", "location", "metadata", "registration_code" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/terminal.reader" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a Reader" } }, "/v1/terminal/readers/{reader}": { "delete": { "description": "

Deletes a Reader object.

", "operationId": "DeleteTerminalReadersReader", "parameters": [ { "in": "path", "name": "reader", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted_terminal.reader" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Delete a Reader" }, "get": { "description": "

Retrieves a Reader object.

", "operationId": "GetTerminalReadersReader", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "reader", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/terminal.reader" }, { "$ref": "#/components/schemas/deleted_terminal.reader" } ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a Reader" }, "post": { "description": "

Updates a Reader object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

", "operationId": "PostTerminalReadersReader", "parameters": [ { "in": "path", "name": "reader", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "label": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "label": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "The new label of the reader." }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." } }, "type": "object", "x-stripeMostCommon": [ "label", "metadata" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/terminal.reader" }, { "$ref": "#/components/schemas/deleted_terminal.reader" } ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a Reader" } }, "/v1/terminal/readers/{reader}/cancel_action": { "post": { "description": "

Cancels the current reader action.

", "operationId": "PostTerminalReadersReaderCancelAction", "parameters": [ { "in": "path", "name": "reader", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/terminal.reader" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Cancel the current reader action" } }, "/v1/terminal/readers/{reader}/collect_inputs": { "post": { "description": "

Initiates an input collection flow on a Reader.

", "operationId": "PostTerminalReadersReaderCollectInputs", "parameters": [ { "in": "path", "name": "reader", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "inputs": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "inputs": { "description": "List of inputs to be collected using the Reader", "items": { "properties": { "custom_text": { "description": "Customize the text which will be displayed while collecting this input", "properties": { "description": { "description": "The description which will be displayed when collecting this input", "maxLength": 500, "type": "string" }, "skip_button": { "description": "The skip button text", "maxLength": 14, "type": "string" }, "submit_button": { "description": "The submit button text", "maxLength": 30, "type": "string" }, "title": { "description": "The title which will be displayed when collecting this input", "maxLength": 40, "type": "string" } }, "required": [ "title" ], "title": "custom_text_params", "type": "object", "x-stripeMostCommon": [ "description", "skip_button", "submit_button", "title" ] }, "required": { "description": "Indicate that this input is required, disabling the skip button", "type": "boolean" }, "selection": { "description": "Options for the `selection` input", "properties": { "choices": { "description": "List of choices for the `selection` input", "items": { "properties": { "id": { "description": "The unique identifier for this choice", "maxLength": 50, "type": "string" }, "style": { "description": "The style of the button which will be shown for this choice", "enum": [ "primary", "secondary" ], "type": "string" }, "text": { "description": "The text which will be shown on the button for this choice", "maxLength": 30, "type": "string" } }, "required": [ "id", "text" ], "title": "choice_params", "type": "object", "x-stripeMostCommon": [ "id", "style", "text" ] }, "type": "array" } }, "required": [ "choices" ], "title": "selection_params", "type": "object", "x-stripeMostCommon": [ "choices" ] }, "toggles": { "description": "List of toggles to be displayed and customization for the toggles", "items": { "properties": { "default_value": { "description": "The default value of the toggle", "enum": [ "disabled", "enabled" ], "type": "string" }, "description": { "description": "The description which will be displayed for the toggle", "maxLength": 50, "type": "string" }, "title": { "description": "The title which will be displayed for the toggle", "maxLength": 50, "type": "string" } }, "title": "toggle_params", "type": "object", "x-stripeMostCommon": [ "default_value", "description", "title" ] }, "type": "array" }, "type": { "description": "The type of input to collect", "enum": [ "email", "numeric", "phone", "selection", "signature", "text" ], "type": "string" } }, "required": [ "custom_text", "type" ], "title": "input_params", "type": "object", "x-stripeMostCommon": [ "custom_text", "required", "type" ] }, "type": "array" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" } }, "required": [ "inputs" ], "type": "object", "x-stripeMostCommon": [ "inputs", "metadata" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/terminal.reader" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Collect inputs using a Reader" } }, "/v1/terminal/readers/{reader}/collect_payment_method": { "post": { "description": "

Initiates a payment flow on a Reader and updates the PaymentIntent with card details before manual confirmation.

", "operationId": "PostTerminalReadersReaderCollectPaymentMethod", "parameters": [ { "in": "path", "name": "reader", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "collect_config": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "collect_config": { "description": "Configuration overrides.", "properties": { "allow_redisplay": { "description": "This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow.", "enum": [ "always", "limited", "unspecified" ], "type": "string" }, "enable_customer_cancellation": { "description": "Enables cancel button on transaction screens.", "type": "boolean" }, "skip_tipping": { "description": "Override showing a tipping selection screen on this transaction.", "type": "boolean" }, "tipping": { "description": "Tipping configuration for this transaction.", "properties": { "amount_eligible": { "description": "Amount used to calculate tip suggestions on tipping selection screen for this transaction. Must be a positive integer in the smallest currency unit (e.g., 100 cents to represent $1.00 or 100 to represent ¥100, a zero-decimal currency).", "type": "integer" } }, "title": "tipping_config", "type": "object", "x-stripeMostCommon": [ "amount_eligible" ] } }, "title": "collect_config", "type": "object", "x-stripeMostCommon": [ "allow_redisplay", "enable_customer_cancellation", "moto", "moto_config", "request_dynamic_currency_conversion", "skip_tipping", "surcharge_notice", "tipping" ] }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "payment_intent": { "description": "PaymentIntent ID.", "maxLength": 5000, "type": "string" } }, "required": [ "payment_intent" ], "type": "object", "x-stripeMostCommon": [ "payment_intent" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/terminal.reader" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Hand off a PaymentIntent to a Reader and collect card details" } }, "/v1/terminal/readers/{reader}/confirm_payment_intent": { "post": { "description": "

Finalizes a payment on a Reader.

", "operationId": "PostTerminalReadersReaderConfirmPaymentIntent", "parameters": [ { "in": "path", "name": "reader", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "confirm_config": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "confirm_config": { "description": "Configuration overrides.", "properties": { "return_url": { "description": "The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. If you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme.", "type": "string" } }, "title": "confirm_config", "type": "object", "x-stripeMostCommon": [ "amount_surcharge", "return_url", "surcharge" ] }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "payment_intent": { "description": "PaymentIntent ID.", "maxLength": 5000, "type": "string" } }, "required": [ "payment_intent" ], "type": "object", "x-stripeMostCommon": [ "payment_intent" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/terminal.reader" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Confirm a PaymentIntent on the Reader" } }, "/v1/terminal/readers/{reader}/process_payment_intent": { "post": { "description": "

Initiates a payment flow on a Reader.

", "operationId": "PostTerminalReadersReaderProcessPaymentIntent", "parameters": [ { "in": "path", "name": "reader", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "process_config": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "payment_intent": { "description": "PaymentIntent ID", "maxLength": 5000, "type": "string" }, "process_config": { "description": "Configuration overrides", "properties": { "allow_redisplay": { "description": "This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow.", "enum": [ "always", "limited", "unspecified" ], "type": "string" }, "enable_customer_cancellation": { "description": "Enables cancel button on transaction screens.", "type": "boolean" }, "return_url": { "description": "The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. If you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme.", "type": "string" }, "skip_tipping": { "description": "Override showing a tipping selection screen on this transaction.", "type": "boolean" }, "tipping": { "description": "Tipping configuration for this transaction.", "properties": { "amount_eligible": { "description": "Amount used to calculate tip suggestions on tipping selection screen for this transaction. Must be a positive integer in the smallest currency unit (e.g., 100 cents to represent $1.00 or 100 to represent ¥100, a zero-decimal currency).", "type": "integer" } }, "title": "tipping_config", "type": "object", "x-stripeMostCommon": [ "amount_eligible" ] } }, "title": "process_config", "type": "object", "x-stripeMostCommon": [ "allow_redisplay", "enable_customer_cancellation", "moto", "moto_config", "return_url", "skip_tipping", "tipping" ] } }, "required": [ "payment_intent" ], "type": "object", "x-stripeMostCommon": [ "payment_intent" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/terminal.reader" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Hand-off a PaymentIntent to a Reader" } }, "/v1/terminal/readers/{reader}/process_setup_intent": { "post": { "description": "

Initiates a setup intent flow on a Reader.

", "operationId": "PostTerminalReadersReaderProcessSetupIntent", "parameters": [ { "in": "path", "name": "reader", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "process_config": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "allow_redisplay": { "description": "This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow.", "enum": [ "always", "limited", "unspecified" ], "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "process_config": { "description": "Configuration overrides", "properties": { "enable_customer_cancellation": { "description": "Enables cancel button on transaction screens.", "type": "boolean" } }, "title": "process_setup_config", "type": "object", "x-stripeMostCommon": [ "enable_customer_cancellation", "moto", "moto_config" ] }, "setup_intent": { "description": "SetupIntent ID", "maxLength": 5000, "type": "string" } }, "required": [ "allow_redisplay", "setup_intent" ], "type": "object", "x-stripeMostCommon": [ "allow_redisplay", "setup_intent" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/terminal.reader" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Hand-off a SetupIntent to a Reader" } }, "/v1/terminal/readers/{reader}/refund_payment": { "post": { "description": "

Initiates a refund on a Reader

", "operationId": "PostTerminalReadersReaderRefundPayment", "parameters": [ { "in": "path", "name": "reader", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "refund_payment_config": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "amount": { "description": "A positive integer in __cents__ representing how much of this charge to refund.", "type": "integer" }, "charge": { "description": "ID of the Charge to refund.", "maxLength": 5000, "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "payment_intent": { "description": "ID of the PaymentIntent to refund.", "maxLength": 5000, "type": "string" }, "refund_application_fee": { "description": "Boolean indicating whether the application fee should be refunded when refunding this charge. If a full charge refund is given, the full application fee will be refunded. Otherwise, the application fee will be refunded in an amount proportional to the amount of the charge refunded. An application fee can be refunded only by the application that created the charge.", "type": "boolean" }, "refund_payment_config": { "description": "Configuration overrides", "properties": { "enable_customer_cancellation": { "description": "Enables cancel button on transaction screens.", "type": "boolean" } }, "title": "refund_payment_config", "type": "object", "x-stripeMostCommon": [ "enable_customer_cancellation" ] }, "reverse_transfer": { "description": "Boolean indicating whether the transfer should be reversed when refunding this charge. The transfer will be reversed proportionally to the amount being refunded (either the entire or partial amount). A transfer can be reversed only by the application that created the charge.", "type": "boolean" } }, "type": "object", "x-stripeMostCommon": [ "amount", "charge", "metadata", "payment_intent", "refund_application_fee", "reverse_transfer" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/terminal.reader" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Refund a Charge or a PaymentIntent in-person" } }, "/v1/terminal/readers/{reader}/set_reader_display": { "post": { "description": "

Sets reader display to show cart details.

", "operationId": "PostTerminalReadersReaderSetReaderDisplay", "parameters": [ { "in": "path", "name": "reader", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "cart": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "cart": { "description": "Cart", "properties": { "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "line_items": { "description": "Array of line items that were purchased.", "items": { "properties": { "amount": { "description": "The price of the item in cents.", "type": "integer" }, "description": { "description": "The description or name of the item.", "maxLength": 5000, "type": "string" }, "quantity": { "description": "The quantity of the line item being purchased.", "type": "integer" } }, "required": [ "amount", "description", "quantity" ], "title": "line_item", "type": "object", "x-stripeMostCommon": [ "amount", "description", "quantity" ] }, "type": "array" }, "tax": { "description": "The amount of tax in cents.", "type": "integer" }, "total": { "description": "Total balance of cart due in cents.", "type": "integer" } }, "required": [ "currency", "line_items", "total" ], "title": "cart", "type": "object", "x-stripeMostCommon": [ "currency", "line_items", "tax", "total" ] }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "type": { "description": "Type", "enum": [ "cart" ], "type": "string" } }, "required": [ "type" ], "type": "object", "x-stripeMostCommon": [ "cart", "type" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/terminal.reader" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Set reader display" } }, "/v1/test/payment_intents/{intent}/trigger_action": { "post": { "description": "

Trigger an external action on a PaymentIntent.

", "operationId": "PostTestPaymentIntentsIntentTriggerAction", "parameters": [ { "in": "path", "name": "intent", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "scan_qr_code": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "scan_qr_code": { "description": "True to simulate success, false to simulate failure.", "properties": { "result": { "description": "Whether the QR Code scan's payment should succeed or fail.", "enum": [ "failure", "success" ], "type": "string" } }, "title": "scan_qr_code_params", "type": "object", "x-stripeMostCommon": [ "result" ] }, "type": { "description": "The type of action to be simulated.", "enum": [ "expire", "fund" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "type": "object", "x-stripeMostCommon": [ "scan_qr_code", "type" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_intent" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Trigger an external action on a PaymentIntent." } }, "/v1/test_helpers/confirmation_tokens": { "post": { "description": "

Creates a test mode Confirmation Token server side for your integration tests.

", "operationId": "PostTestHelpersConfirmationTokens", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "payment_method_data": { "explode": true, "style": "deepObject" }, "payment_method_options": { "explode": true, "style": "deepObject" }, "shipping": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "payment_method": { "description": "ID of an existing PaymentMethod.", "maxLength": 5000, "type": "string" }, "payment_method_data": { "description": "If provided, this hash will be used to create a PaymentMethod.", "properties": { "acss_debit": { "description": "If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method.", "properties": { "account_number": { "description": "Customer's bank account number.", "maxLength": 5000, "type": "string" }, "institution_number": { "description": "Institution number of the customer's bank.", "maxLength": 5000, "type": "string" }, "transit_number": { "description": "Transit number of the customer's bank.", "maxLength": 5000, "type": "string" } }, "required": [ "account_number", "institution_number", "transit_number" ], "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "account_number", "financial_connections_account", "institution_number", "transit_number" ] }, "affirm": { "description": "If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method.", "properties": {}, "title": "param", "type": "object" }, "afterpay_clearpay": { "description": "If this is an `AfterpayClearpay` PaymentMethod, this hash contains details about the AfterpayClearpay payment method.", "properties": {}, "title": "param", "type": "object" }, "alipay": { "description": "If this is an `Alipay` PaymentMethod, this hash contains details about the Alipay payment method.", "properties": {}, "title": "param", "type": "object" }, "allow_redisplay": { "description": "This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to `unspecified`.", "enum": [ "always", "limited", "unspecified" ], "type": "string" }, "alma": { "description": "If this is a Alma PaymentMethod, this hash contains details about the Alma payment method.", "properties": {}, "title": "param", "type": "object" }, "amazon_pay": { "description": "If this is a AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method.", "properties": {}, "title": "param", "type": "object" }, "au_becs_debit": { "description": "If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account.", "properties": { "account_number": { "description": "The account number for the bank account.", "maxLength": 5000, "type": "string" }, "bsb_number": { "description": "Bank-State-Branch number of the bank account.", "maxLength": 5000, "type": "string" } }, "required": [ "account_number", "bsb_number" ], "title": "param", "type": "object", "x-stripeMostCommon": [ "account_number", "bsb_number" ] }, "bacs_debit": { "description": "If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.", "properties": { "account_number": { "description": "Account number of the bank account that the funds will be debited from.", "maxLength": 5000, "type": "string" }, "sort_code": { "description": "Sort code of the bank account. (e.g., `10-20-30`)", "maxLength": 5000, "type": "string" } }, "title": "param", "type": "object", "x-stripeMostCommon": [ "account_number", "sort_code" ] }, "bancontact": { "description": "If this is a `bancontact` PaymentMethod, this hash contains details about the Bancontact payment method.", "properties": {}, "title": "param", "type": "object" }, "billie": { "description": "If this is a `billie` PaymentMethod, this hash contains details about the Billie payment method.", "properties": {}, "title": "param", "type": "object" }, "billing_details": { "description": "Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.", "properties": { "address": { "anyOf": [ { "properties": { "city": { "description": "City, district, suburb, town, or village.", "maxLength": 5000, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Address line 1 (e.g., street, PO Box, or company name).", "maxLength": 5000, "type": "string" }, "line2": { "description": "Address line 2 (e.g., apartment, suite, unit, or building).", "maxLength": 5000, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "State, county, province, or region.", "maxLength": 5000, "type": "string" } }, "title": "billing_details_address", "type": "object", "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Billing address." }, "email": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Email address." }, "name": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Full name." }, "phone": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Billing phone number (including extension)." }, "tax_id": { "description": "Taxpayer identification number. Used only for transactions between LATAM buyers and non-LATAM sellers.", "maxLength": 5000, "type": "string" } }, "title": "billing_details_inner_params", "type": "object", "x-stripeMostCommon": [ "address", "email", "name", "phone", "tax_id" ] }, "blik": { "description": "If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.", "properties": {}, "title": "param", "type": "object" }, "boleto": { "description": "If this is a `boleto` PaymentMethod, this hash contains details about the Boleto payment method.", "properties": { "tax_id": { "description": "The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers)", "maxLength": 5000, "type": "string" } }, "required": [ "tax_id" ], "title": "param", "type": "object", "x-stripeMostCommon": [ "tax_id" ] }, "cashapp": { "description": "If this is a `cashapp` PaymentMethod, this hash contains details about the Cash App Pay payment method.", "properties": {}, "title": "param", "type": "object" }, "crypto": { "description": "If this is a Crypto PaymentMethod, this hash contains details about the Crypto payment method.", "properties": {}, "title": "param", "type": "object" }, "customer_balance": { "description": "If this is a `customer_balance` PaymentMethod, this hash contains details about the CustomerBalance payment method.", "properties": {}, "title": "param", "type": "object" }, "eps": { "description": "If this is an `eps` PaymentMethod, this hash contains details about the EPS payment method.", "properties": { "bank": { "description": "The customer's bank.", "enum": [ "arzte_und_apotheker_bank", "austrian_anadi_bank_ag", "bank_austria", "bankhaus_carl_spangler", "bankhaus_schelhammer_und_schattera_ag", "bawag_psk_ag", "bks_bank_ag", "brull_kallmus_bank_ag", "btv_vier_lander_bank", "capital_bank_grawe_gruppe_ag", "deutsche_bank_ag", "dolomitenbank", "easybank_ag", "erste_bank_und_sparkassen", "hypo_alpeadriabank_international_ag", "hypo_bank_burgenland_aktiengesellschaft", "hypo_noe_lb_fur_niederosterreich_u_wien", "hypo_oberosterreich_salzburg_steiermark", "hypo_tirol_bank_ag", "hypo_vorarlberg_bank_ag", "marchfelder_bank", "oberbank_ag", "raiffeisen_bankengruppe_osterreich", "schoellerbank_ag", "sparda_bank_wien", "volksbank_gruppe", "volkskreditbank_ag", "vr_bank_braunau" ], "maxLength": 5000, "type": "string" } }, "title": "param", "type": "object", "x-stripeMostCommon": [ "bank" ] }, "fpx": { "description": "If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method.", "properties": { "account_holder_type": { "description": "Account holder type for FPX transaction", "enum": [ "company", "individual" ], "maxLength": 5000, "type": "string" }, "bank": { "description": "The customer's bank.", "enum": [ "affin_bank", "agrobank", "alliance_bank", "ambank", "bank_islam", "bank_muamalat", "bank_of_china", "bank_rakyat", "bsn", "cimb", "deutsche_bank", "hong_leong_bank", "hsbc", "kfh", "maybank2e", "maybank2u", "ocbc", "pb_enterprise", "public_bank", "rhb", "standard_chartered", "uob" ], "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true } }, "required": [ "bank" ], "title": "param", "type": "object", "x-stripeMostCommon": [ "account_holder_type", "bank" ] }, "giropay": { "description": "If this is a `giropay` PaymentMethod, this hash contains details about the Giropay payment method.", "properties": {}, "title": "param", "type": "object" }, "gopay": { "description": "If this is a Gopay PaymentMethod, this hash contains details about the Gopay payment method.", "properties": {}, "title": "param", "type": "object" }, "grabpay": { "description": "If this is a `grabpay` PaymentMethod, this hash contains details about the GrabPay payment method.", "properties": {}, "title": "param", "type": "object" }, "id_bank_transfer": { "description": "If this is an `IdBankTransfer` PaymentMethod, this hash contains details about the IdBankTransfer payment method.", "properties": { "bank": { "description": "Bank where the account is held.", "enum": [ "bca", "bni", "bri", "cimb", "permata" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "param", "type": "object", "x-stripeMostCommon": [ "bank" ] }, "ideal": { "description": "If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method.", "properties": { "bank": { "description": "The customer's bank. Only use this parameter for existing customers. Don't use it for new customers.", "enum": [ "abn_amro", "asn_bank", "bunq", "buut", "handelsbanken", "ing", "knab", "moneyou", "n26", "nn", "rabobank", "regiobank", "revolut", "sns_bank", "triodos_bank", "van_lanschot", "yoursafe" ], "maxLength": 5000, "type": "string" } }, "title": "param", "type": "object", "x-stripeMostCommon": [ "bank" ] }, "interac_present": { "description": "If this is an `interac_present` PaymentMethod, this hash contains details about the Interac Present payment method.", "properties": {}, "title": "param", "type": "object", "x-stripeMostCommon": [ "device_identifier", "device_type", "emv", "location" ] }, "kakao_pay": { "description": "If this is a `kakao_pay` PaymentMethod, this hash contains details about the Kakao Pay payment method.", "properties": {}, "title": "param", "type": "object" }, "klarna": { "description": "If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method.", "properties": { "dob": { "description": "Customer's date of birth", "properties": { "day": { "description": "The day of birth, between 1 and 31.", "type": "integer" }, "month": { "description": "The month of birth, between 1 and 12.", "type": "integer" }, "year": { "description": "The four-digit year of birth.", "type": "integer" } }, "required": [ "day", "month", "year" ], "title": "date_of_birth", "type": "object", "x-stripeMostCommon": [ "day", "month", "year" ] } }, "title": "param", "type": "object", "x-stripeMostCommon": [ "dob" ] }, "konbini": { "description": "If this is a `konbini` PaymentMethod, this hash contains details about the Konbini payment method.", "properties": {}, "title": "param", "type": "object" }, "kr_card": { "description": "If this is a `kr_card` PaymentMethod, this hash contains details about the Korean Card payment method.", "properties": {}, "title": "param", "type": "object" }, "link": { "description": "If this is an `Link` PaymentMethod, this hash contains details about the Link payment method.", "properties": {}, "title": "param", "type": "object" }, "mb_way": { "description": "If this is a MB WAY PaymentMethod, this hash contains details about the MB WAY payment method.", "properties": {}, "title": "param", "type": "object" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "mobilepay": { "description": "If this is a `mobilepay` PaymentMethod, this hash contains details about the MobilePay payment method.", "properties": {}, "title": "param", "type": "object" }, "multibanco": { "description": "If this is a `multibanco` PaymentMethod, this hash contains details about the Multibanco payment method.", "properties": {}, "title": "param", "type": "object" }, "naver_pay": { "description": "If this is a `naver_pay` PaymentMethod, this hash contains details about the Naver Pay payment method.", "properties": { "funding": { "description": "Whether to use Naver Pay points or a card to fund this transaction. If not provided, this defaults to `card`.", "enum": [ "card", "points" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "param", "type": "object", "x-stripeMostCommon": [ "funding" ] }, "nz_bank_account": { "description": "If this is an nz_bank_account PaymentMethod, this hash contains details about the nz_bank_account payment method.", "properties": { "account_holder_name": { "description": "The name on the bank account. Only required if the account holder name is different from the name of the authorized signatory collected in the PaymentMethod’s billing details.", "maxLength": 5000, "type": "string" }, "account_number": { "description": "The account number for the bank account.", "maxLength": 5000, "type": "string" }, "bank_code": { "description": "The numeric code for the bank account's bank.", "maxLength": 5000, "type": "string" }, "branch_code": { "description": "The numeric code for the bank account's bank branch.", "maxLength": 5000, "type": "string" }, "reference": { "maxLength": 128, "type": "string" }, "suffix": { "description": "The suffix of the bank account number.", "maxLength": 5000, "type": "string" } }, "required": [ "account_number", "bank_code", "branch_code", "suffix" ], "title": "param", "type": "object", "x-stripeMostCommon": [ "account_holder_name", "account_number", "bank_code", "branch_code", "reference", "suffix" ] }, "oxxo": { "description": "If this is an `oxxo` PaymentMethod, this hash contains details about the OXXO payment method.", "properties": {}, "title": "param", "type": "object" }, "p24": { "description": "If this is a `p24` PaymentMethod, this hash contains details about the P24 payment method.", "properties": { "bank": { "description": "The customer's bank.", "enum": [ "alior_bank", "bank_millennium", "bank_nowy_bfg_sa", "bank_pekao_sa", "banki_spbdzielcze", "blik", "bnp_paribas", "boz", "citi_handlowy", "credit_agricole", "envelobank", "etransfer_pocztowy24", "getin_bank", "ideabank", "ing", "inteligo", "mbank_mtransfer", "nest_przelew", "noble_pay", "pbac_z_ipko", "plus_bank", "santander_przelew24", "tmobile_usbugi_bankowe", "toyota_bank", "velobank", "volkswagen_bank" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "param", "type": "object", "x-stripeMostCommon": [ "bank" ] }, "pay_by_bank": { "description": "If this is a `pay_by_bank` PaymentMethod, this hash contains details about the PayByBank payment method.", "properties": {}, "title": "param", "type": "object" }, "payco": { "description": "If this is a `payco` PaymentMethod, this hash contains details about the PAYCO payment method.", "properties": {}, "title": "param", "type": "object" }, "paynow": { "description": "If this is a `paynow` PaymentMethod, this hash contains details about the PayNow payment method.", "properties": {}, "title": "param", "type": "object" }, "paypal": { "description": "If this is a `paypal` PaymentMethod, this hash contains details about the PayPal payment method.", "properties": {}, "title": "param", "type": "object" }, "paypay": { "description": "If this is a `paypay` PaymentMethod, this hash contains details about the PayPay payment method.", "properties": {}, "title": "param", "type": "object" }, "payto": { "description": "If this is a `payto` PaymentMethod, this hash contains details about the PayTo payment method.", "properties": { "account_number": { "description": "The account number for the bank account.", "maxLength": 5000, "type": "string" }, "bsb_number": { "description": "Bank-State-Branch number of the bank account.", "maxLength": 5000, "type": "string" }, "pay_id": { "description": "The PayID alias for the bank account.", "maxLength": 5000, "type": "string" } }, "title": "param", "type": "object", "x-stripeMostCommon": [ "account_number", "bsb_number", "pay_id" ] }, "pix": { "description": "If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.", "properties": {}, "title": "param", "type": "object", "x-stripeMostCommon": [ "tax_id" ] }, "promptpay": { "description": "If this is a `promptpay` PaymentMethod, this hash contains details about the PromptPay payment method.", "properties": {}, "title": "param", "type": "object" }, "qris": { "description": "If this is a `qris` PaymentMethod, this hash contains details about the QRIS payment method.", "properties": {}, "title": "param", "type": "object" }, "radar_options": { "description": "Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.", "properties": { "session": { "description": "A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.", "maxLength": 5000, "type": "string" } }, "title": "radar_options_with_hidden_options", "type": "object", "x-stripeMostCommon": [ "session", "skip_rules" ] }, "rechnung": { "description": "If this is a `rechnung` PaymentMethod, this hash contains details about the Rechnung payment method.", "properties": { "dob": { "description": "Customer's date of birth", "properties": { "day": { "description": "The day of birth, between 1 and 31.", "type": "integer" }, "month": { "description": "The month of birth, between 1 and 12.", "type": "integer" }, "year": { "description": "The four-digit year of birth.", "type": "integer" } }, "required": [ "day", "month", "year" ], "title": "date_of_birth", "type": "object", "x-stripeMostCommon": [ "day", "month", "year" ] } }, "required": [ "dob" ], "title": "param", "type": "object", "x-stripeMostCommon": [ "dob" ] }, "revolut_pay": { "description": "If this is a `revolut_pay` PaymentMethod, this hash contains details about the Revolut Pay payment method.", "properties": {}, "title": "param", "type": "object" }, "samsung_pay": { "description": "If this is a `samsung_pay` PaymentMethod, this hash contains details about the SamsungPay payment method.", "properties": {}, "title": "param", "type": "object" }, "satispay": { "description": "If this is a `satispay` PaymentMethod, this hash contains details about the Satispay payment method.", "properties": {}, "title": "param", "type": "object" }, "sepa_debit": { "description": "If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account.", "properties": { "iban": { "description": "IBAN of the bank account.", "maxLength": 5000, "type": "string" } }, "required": [ "iban" ], "title": "param", "type": "object", "x-stripeMostCommon": [ "iban" ] }, "shopeepay": { "description": "If this is a Shopeepay PaymentMethod, this hash contains details about the Shopeepay payment method.", "properties": {}, "title": "param", "type": "object" }, "sofort": { "description": "If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.", "properties": { "country": { "description": "Two-letter ISO code representing the country the bank account is located in.", "enum": [ "AT", "BE", "DE", "ES", "IT", "NL" ], "type": "string" } }, "required": [ "country" ], "title": "param", "type": "object", "x-stripeMostCommon": [ "country" ] }, "stripe_balance": { "description": "This hash contains details about the Stripe balance payment method.", "properties": { "account": { "description": "The connected account ID whose Stripe balance to use as the source of payment", "maxLength": 5000, "type": "string" }, "source_type": { "description": "The [source_type](https://docs.stripe.com/api/balance/balance_object#balance_object-available-source_types) of the balance", "enum": [ "bank_account", "card", "fpx" ], "type": "string" } }, "title": "param", "type": "object", "x-stripeMostCommon": [ "account", "source_type" ] }, "swish": { "description": "If this is a `swish` PaymentMethod, this hash contains details about the Swish payment method.", "properties": {}, "title": "param", "type": "object" }, "twint": { "description": "If this is a TWINT PaymentMethod, this hash contains details about the TWINT payment method.", "properties": {}, "title": "param", "type": "object" }, "type": { "description": "The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.", "enum": [ "acss_debit", "affirm", "afterpay_clearpay", "alipay", "alma", "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", "billie", "blik", "boleto", "cashapp", "crypto", "customer_balance", "eps", "fpx", "giropay", "gopay", "grabpay", "id_bank_transfer", "ideal", "kakao_pay", "klarna", "konbini", "kr_card", "link", "mb_way", "mobilepay", "multibanco", "naver_pay", "nz_bank_account", "oxxo", "p24", "pay_by_bank", "payco", "paynow", "paypal", "paypay", "payto", "pix", "promptpay", "qris", "rechnung", "revolut_pay", "samsung_pay", "satispay", "sepa_debit", "shopeepay", "sofort", "stripe_balance", "swish", "twint", "us_bank_account", "wechat_pay", "zip" ], "type": "string", "x-stripeBypassValidation": true }, "us_bank_account": { "description": "If this is an `us_bank_account` PaymentMethod, this hash contains details about the US bank account payment method.", "properties": { "account_holder_type": { "description": "Account holder type: individual or company.", "enum": [ "company", "individual" ], "type": "string" }, "account_number": { "description": "Account number of the bank account.", "maxLength": 5000, "type": "string" }, "account_type": { "description": "Account type: checkings or savings. Defaults to checking if omitted.", "enum": [ "checking", "savings" ], "type": "string" }, "financial_connections_account": { "description": "The ID of a Financial Connections Account to use as a payment method.", "maxLength": 5000, "type": "string" }, "routing_number": { "description": "Routing number of the bank account.", "maxLength": 5000, "type": "string" } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "account_holder_type", "account_number", "account_type", "financial_connections_account", "routing_number" ] }, "wechat_pay": { "description": "If this is an `wechat_pay` PaymentMethod, this hash contains details about the wechat_pay payment method.", "properties": {}, "title": "param", "type": "object" }, "zip": { "description": "If this is a `zip` PaymentMethod, this hash contains details about the Zip payment method.", "properties": {}, "title": "param", "type": "object" } }, "required": [ "type" ], "title": "payment_method_data_params", "type": "object", "x-stripeMostCommon": [ "billing_details", "metadata", "type" ] }, "payment_method_options": { "description": "Payment-method-specific configuration for this ConfirmationToken.", "properties": { "card": { "description": "Configuration for any card payments confirmed using this ConfirmationToken.", "properties": { "installments": { "description": "Installment configuration for payments confirmed using this ConfirmationToken.", "properties": { "plan": { "description": "The selected installment plan to use for this payment attempt.\nThis parameter can only be provided during confirmation.", "properties": { "count": { "description": "For `fixed_count` installment plans, this is required. It represents the number of installment payments your customer will make to their credit card.", "type": "integer" }, "interval": { "description": "For `fixed_count` installment plans, this is required. It represents the interval between installment payments your customer will make to their credit card.\nOne of `month`.", "enum": [ "month" ], "type": "string" }, "type": { "description": "Type of installment plan, one of `fixed_count`, `bonus`, or `revolving`.", "enum": [ "bonus", "fixed_count", "revolving" ], "type": "string" } }, "required": [ "type" ], "title": "installment_plan", "type": "object", "x-stripeMostCommon": [ "count", "interval", "type" ] } }, "required": [ "plan" ], "title": "installments_param", "type": "object", "x-stripeMostCommon": [ "plan" ] } }, "title": "card_param", "type": "object", "x-stripeMostCommon": [ "installments" ] } }, "title": "test_payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "card" ] }, "return_url": { "description": "Return URL used to confirm the Intent.", "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this ConfirmationToken's payment method.\n\nThe presence of this property will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete.", "enum": [ "off_session", "on_session" ], "type": "string" }, "shipping": { "description": "Shipping information for this ConfirmationToken.", "properties": { "address": { "description": "Shipping address", "properties": { "city": { "description": "City, district, suburb, town, or village.", "maxLength": 5000, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Address line 1 (e.g., street, PO Box, or company name).", "maxLength": 5000, "type": "string" }, "line2": { "description": "Address line 2 (e.g., apartment, suite, unit, or building).", "maxLength": 5000, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "State, county, province, or region.", "maxLength": 5000, "type": "string" } }, "title": "optional_fields_address", "type": "object", "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state" ] }, "name": { "description": "Recipient name.", "maxLength": 5000, "type": "string" }, "phone": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Recipient phone (including extension)" } }, "required": [ "address", "name" ], "title": "recipient_shipping_with_optional_fields_address", "type": "object", "x-stripeMostCommon": [ "address", "name", "phone" ] } }, "type": "object", "x-stripeMostCommon": [ "payment_method", "payment_method_data", "payment_method_options", "return_url", "setup_future_usage", "shipping" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/confirmation_token" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a test Confirmation Token" } }, "/v1/test_helpers/customers/{customer}/fund_cash_balance": { "post": { "description": "

Create an incoming testmode bank transfer

", "operationId": "PostTestHelpersCustomersCustomerFundCashBalance", "parameters": [ { "in": "path", "name": "customer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "amount": { "description": "Amount to be used for this test cash balance transaction. A positive integer representing how much to fund in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to fund $1.00 or 100 to fund ¥100, a zero-decimal currency).", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "reference": { "description": "A description of the test funding. This simulates free-text references supplied by customers when making bank transfers to their cash balance. You can use this to test how Stripe's [reconciliation algorithm](https://stripe.com/docs/payments/customer-balance/reconciliation) applies to different user inputs.", "maxLength": 5000, "type": "string" } }, "required": [ "amount", "currency" ], "type": "object", "x-stripeMostCommon": [ "amount", "currency" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer_cash_balance_transaction" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Fund a test mode cash balance" } }, "/v1/test_helpers/issuing/authorizations": { "post": { "description": "

Create a test-mode authorization.

", "operationId": "PostTestHelpersIssuingAuthorizations", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "amount_details": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "fleet": { "explode": true, "style": "deepObject" }, "fuel": { "explode": true, "style": "deepObject" }, "merchant_data": { "explode": true, "style": "deepObject" }, "network_data": { "explode": true, "style": "deepObject" }, "verification_data": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "amount": { "description": "The total amount to attempt to authorize. This amount is in the provided currency, or defaults to the card's currency, and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", "type": "integer" }, "amount_details": { "description": "Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", "properties": { "atm_fee": { "description": "The ATM withdrawal fee.", "type": "integer" }, "cashback_amount": { "description": "The amount of cash requested by the cardholder.", "type": "integer" } }, "title": "amount_details_specs", "type": "object", "x-stripeMostCommon": [ "atm_fee", "cashback_amount" ] }, "authorization_method": { "description": "How the card details were provided. Defaults to online.", "enum": [ "chip", "contactless", "keyed_in", "online", "swipe" ], "type": "string" }, "card": { "description": "Card associated with this authorization.", "maxLength": 5000, "type": "string" }, "currency": { "description": "The currency of the authorization. If not provided, defaults to the currency of the card. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "fleet": { "description": "Fleet-specific information for authorizations using Fleet cards.", "properties": { "cardholder_prompt_data": { "description": "Answers to prompts presented to the cardholder at the point of sale. Prompted fields vary depending on the configuration of your physical fleet cards. Typical points of sale support only numeric entry.", "properties": { "driver_id": { "description": "Driver ID.", "maxLength": 5000, "type": "string" }, "odometer": { "description": "Odometer reading.", "type": "integer" }, "unspecified_id": { "description": "An alphanumeric ID. This field is used when a vehicle ID, driver ID, or generic ID is entered by the cardholder, but the merchant or card network did not specify the prompt type.", "maxLength": 5000, "type": "string" }, "user_id": { "description": "User ID.", "maxLength": 5000, "type": "string" }, "vehicle_number": { "description": "Vehicle number.", "maxLength": 5000, "type": "string" } }, "title": "fleet_cardholder_prompt_data_specs", "type": "object", "x-stripeMostCommon": [ "driver_id", "odometer", "unspecified_id", "user_id", "vehicle_number" ] }, "purchase_type": { "description": "The type of purchase. One of `fuel_purchase`, `non_fuel_purchase`, or `fuel_and_non_fuel_purchase`.", "enum": [ "fuel_and_non_fuel_purchase", "fuel_purchase", "non_fuel_purchase" ], "maxLength": 5000, "type": "string" }, "reported_breakdown": { "description": "More information about the total amount. This information is not guaranteed to be accurate as some merchants may provide unreliable data.", "properties": { "fuel": { "description": "Breakdown of fuel portion of the purchase.", "properties": { "gross_amount_decimal": { "description": "Gross fuel amount that should equal Fuel Volume multipled by Fuel Unit Cost, inclusive of taxes.", "format": "decimal", "type": "string" } }, "title": "fleet_reported_breakdown_fuel_specs", "type": "object", "x-stripeMostCommon": [ "gross_amount_decimal" ] }, "non_fuel": { "description": "Breakdown of non-fuel portion of the purchase.", "properties": { "gross_amount_decimal": { "description": "Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes.", "format": "decimal", "type": "string" } }, "title": "fleet_reported_breakdown_non_fuel_specs", "type": "object", "x-stripeMostCommon": [ "gross_amount_decimal" ] }, "tax": { "description": "Information about tax included in this transaction.", "properties": { "local_amount_decimal": { "description": "Amount of state or provincial Sales Tax included in the transaction amount. Null if not reported by merchant or not subject to tax.", "format": "decimal", "type": "string" }, "national_amount_decimal": { "description": "Amount of national Sales Tax or VAT included in the transaction amount. Null if not reported by merchant or not subject to tax.", "format": "decimal", "type": "string" } }, "title": "fleet_reported_breakdown_tax_specs", "type": "object", "x-stripeMostCommon": [ "local_amount_decimal", "national_amount_decimal" ] } }, "title": "fleet_reported_breakdown_specs", "type": "object", "x-stripeMostCommon": [ "fuel", "non_fuel", "tax" ] }, "service_type": { "description": "The type of fuel service. One of `non_fuel_transaction`, `full_service`, or `self_service`.", "enum": [ "full_service", "non_fuel_transaction", "self_service" ], "maxLength": 5000, "type": "string" } }, "title": "fleet_testmode_authorization_specs", "type": "object", "x-stripeMostCommon": [ "cardholder_prompt_data", "dynamic_purchase_controls_supported", "purchase_type", "reported_breakdown", "service_type" ] }, "fuel": { "description": "Information about fuel that was purchased with this transaction.", "properties": { "industry_product_code": { "description": "[Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased.", "maxLength": 5000, "type": "string" }, "quantity_decimal": { "description": "The quantity of `unit`s of fuel that was dispensed, represented as a decimal string with at most 12 decimal places.", "format": "decimal", "type": "string" }, "type": { "description": "The type of fuel that was purchased. One of `diesel`, `unleaded_plus`, `unleaded_regular`, `unleaded_super`, or `other`.", "enum": [ "diesel", "other", "unleaded_plus", "unleaded_regular", "unleaded_super" ], "maxLength": 5000, "type": "string" }, "unit": { "description": "The units for `quantity_decimal`. One of `charging_minute`, `imperial_gallon`, `kilogram`, `kilowatt_hour`, `liter`, `pound`, `us_gallon`, or `other`.", "enum": [ "charging_minute", "imperial_gallon", "kilogram", "kilowatt_hour", "liter", "other", "pound", "us_gallon" ], "maxLength": 5000, "type": "string" }, "unit_cost_decimal": { "description": "The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places.", "format": "decimal", "type": "string" } }, "title": "fuel_specs", "type": "object", "x-stripeMostCommon": [ "industry_product_code", "quantity_decimal", "type", "unit", "unit_cost_decimal" ] }, "is_amount_controllable": { "description": "If set `true`, you may provide [amount](https://stripe.com/docs/api/issuing/authorizations/approve#approve_issuing_authorization-amount) to control how much to hold for the authorization.", "type": "boolean" }, "merchant_amount": { "description": "The total amount to attempt to authorize. This amount is in the provided merchant currency, and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", "type": "integer" }, "merchant_currency": { "description": "The currency of the authorization. If not provided, defaults to the currency of the card. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "merchant_data": { "description": "Details about the seller (grocery store, e-commerce website, etc.) where the card authorization happened.", "properties": { "category": { "description": "A categorization of the seller's type of business. See our [merchant categories guide](https://stripe.com/docs/issuing/merchant-categories) for a list of possible values.", "enum": [ "ac_refrigeration_repair", "accounting_bookkeeping_services", "advertising_services", "agricultural_cooperative", "airlines_air_carriers", "airports_flying_fields", "ambulance_services", "amusement_parks_carnivals", "antique_reproductions", "antique_shops", "aquariums", "architectural_surveying_services", "art_dealers_and_galleries", "artists_supply_and_craft_shops", "auto_and_home_supply_stores", "auto_body_repair_shops", "auto_paint_shops", "auto_service_shops", "automated_cash_disburse", "automated_fuel_dispensers", "automobile_associations", "automotive_parts_and_accessories_stores", "automotive_tire_stores", "bail_and_bond_payments", "bakeries", "bands_orchestras", "barber_and_beauty_shops", "betting_casino_gambling", "bicycle_shops", "billiard_pool_establishments", "boat_dealers", "boat_rentals_and_leases", "book_stores", "books_periodicals_and_newspapers", "bowling_alleys", "bus_lines", "business_secretarial_schools", "buying_shopping_services", "cable_satellite_and_other_pay_television_and_radio", "camera_and_photographic_supply_stores", "candy_nut_and_confectionery_stores", "car_and_truck_dealers_new_used", "car_and_truck_dealers_used_only", "car_rental_agencies", "car_washes", "carpentry_services", "carpet_upholstery_cleaning", "caterers", "charitable_and_social_service_organizations_fundraising", "chemicals_and_allied_products", "child_care_services", "childrens_and_infants_wear_stores", "chiropodists_podiatrists", "chiropractors", "cigar_stores_and_stands", "civic_social_fraternal_associations", "cleaning_and_maintenance", "clothing_rental", "colleges_universities", "commercial_equipment", "commercial_footwear", "commercial_photography_art_and_graphics", "commuter_transport_and_ferries", "computer_network_services", "computer_programming", "computer_repair", "computer_software_stores", "computers_peripherals_and_software", "concrete_work_services", "construction_materials", "consulting_public_relations", "correspondence_schools", "cosmetic_stores", "counseling_services", "country_clubs", "courier_services", "court_costs", "credit_reporting_agencies", "cruise_lines", "dairy_products_stores", "dance_hall_studios_schools", "dating_escort_services", "dentists_orthodontists", "department_stores", "detective_agencies", "digital_goods_applications", "digital_goods_games", "digital_goods_large_volume", "digital_goods_media", "direct_marketing_catalog_merchant", "direct_marketing_combination_catalog_and_retail_merchant", "direct_marketing_inbound_telemarketing", "direct_marketing_insurance_services", "direct_marketing_other", "direct_marketing_outbound_telemarketing", "direct_marketing_subscription", "direct_marketing_travel", "discount_stores", "doctors", "door_to_door_sales", "drapery_window_covering_and_upholstery_stores", "drinking_places", "drug_stores_and_pharmacies", "drugs_drug_proprietaries_and_druggist_sundries", "dry_cleaners", "durable_goods", "duty_free_stores", "eating_places_restaurants", "educational_services", "electric_razor_stores", "electric_vehicle_charging", "electrical_parts_and_equipment", "electrical_services", "electronics_repair_shops", "electronics_stores", "elementary_secondary_schools", "emergency_services_gcas_visa_use_only", "employment_temp_agencies", "equipment_rental", "exterminating_services", "family_clothing_stores", "fast_food_restaurants", "financial_institutions", "fines_government_administrative_entities", "fireplace_fireplace_screens_and_accessories_stores", "floor_covering_stores", "florists", "florists_supplies_nursery_stock_and_flowers", "freezer_and_locker_meat_provisioners", "fuel_dealers_non_automotive", "funeral_services_crematories", "furniture_home_furnishings_and_equipment_stores_except_appliances", "furniture_repair_refinishing", "furriers_and_fur_shops", "general_services", "gift_card_novelty_and_souvenir_shops", "glass_paint_and_wallpaper_stores", "glassware_crystal_stores", "golf_courses_public", "government_licensed_horse_dog_racing_us_region_only", "government_licensed_online_casions_online_gambling_us_region_only", "government_owned_lotteries_non_us_region", "government_owned_lotteries_us_region_only", "government_services", "grocery_stores_supermarkets", "hardware_equipment_and_supplies", "hardware_stores", "health_and_beauty_spas", "hearing_aids_sales_and_supplies", "heating_plumbing_a_c", "hobby_toy_and_game_shops", "home_supply_warehouse_stores", "hospitals", "hotels_motels_and_resorts", "household_appliance_stores", "industrial_supplies", "information_retrieval_services", "insurance_default", "insurance_underwriting_premiums", "intra_company_purchases", "jewelry_stores_watches_clocks_and_silverware_stores", "landscaping_services", "laundries", "laundry_cleaning_services", "legal_services_attorneys", "luggage_and_leather_goods_stores", "lumber_building_materials_stores", "manual_cash_disburse", "marinas_service_and_supplies", "marketplaces", "masonry_stonework_and_plaster", "massage_parlors", "medical_and_dental_labs", "medical_dental_ophthalmic_and_hospital_equipment_and_supplies", "medical_services", "membership_organizations", "mens_and_boys_clothing_and_accessories_stores", "mens_womens_clothing_stores", "metal_service_centers", "miscellaneous_apparel_and_accessory_shops", "miscellaneous_auto_dealers", "miscellaneous_business_services", "miscellaneous_food_stores", "miscellaneous_general_merchandise", "miscellaneous_general_services", "miscellaneous_home_furnishing_specialty_stores", "miscellaneous_publishing_and_printing", "miscellaneous_recreation_services", "miscellaneous_repair_shops", "miscellaneous_specialty_retail", "mobile_home_dealers", "motion_picture_theaters", "motor_freight_carriers_and_trucking", "motor_homes_dealers", "motor_vehicle_supplies_and_new_parts", "motorcycle_shops_and_dealers", "motorcycle_shops_dealers", "music_stores_musical_instruments_pianos_and_sheet_music", "news_dealers_and_newsstands", "non_fi_money_orders", "non_fi_stored_value_card_purchase_load", "nondurable_goods", "nurseries_lawn_and_garden_supply_stores", "nursing_personal_care", "office_and_commercial_furniture", "opticians_eyeglasses", "optometrists_ophthalmologist", "orthopedic_goods_prosthetic_devices", "osteopaths", "package_stores_beer_wine_and_liquor", "paints_varnishes_and_supplies", "parking_lots_garages", "passenger_railways", "pawn_shops", "pet_shops_pet_food_and_supplies", "petroleum_and_petroleum_products", "photo_developing", "photographic_photocopy_microfilm_equipment_and_supplies", "photographic_studios", "picture_video_production", "piece_goods_notions_and_other_dry_goods", "plumbing_heating_equipment_and_supplies", "political_organizations", "postal_services_government_only", "precious_stones_and_metals_watches_and_jewelry", "professional_services", "public_warehousing_and_storage", "quick_copy_repro_and_blueprint", "railroads", "real_estate_agents_and_managers_rentals", "record_stores", "recreational_vehicle_rentals", "religious_goods_stores", "religious_organizations", "roofing_siding_sheet_metal", "secretarial_support_services", "security_brokers_dealers", "service_stations", "sewing_needlework_fabric_and_piece_goods_stores", "shoe_repair_hat_cleaning", "shoe_stores", "small_appliance_repair", "snowmobile_dealers", "special_trade_services", "specialty_cleaning", "sporting_goods_stores", "sporting_recreation_camps", "sports_and_riding_apparel_stores", "sports_clubs_fields", "stamp_and_coin_stores", "stationary_office_supplies_printing_and_writing_paper", "stationery_stores_office_and_school_supply_stores", "swimming_pools_sales", "t_ui_travel_germany", "tailors_alterations", "tax_payments_government_agencies", "tax_preparation_services", "taxicabs_limousines", "telecommunication_equipment_and_telephone_sales", "telecommunication_services", "telegraph_services", "tent_and_awning_shops", "testing_laboratories", "theatrical_ticket_agencies", "timeshares", "tire_retreading_and_repair", "tolls_bridge_fees", "tourist_attractions_and_exhibits", "towing_services", "trailer_parks_campgrounds", "transportation_services", "travel_agencies_tour_operators", "truck_stop_iteration", "truck_utility_trailer_rentals", "typesetting_plate_making_and_related_services", "typewriter_stores", "u_s_federal_government_agencies_or_departments", "uniforms_commercial_clothing", "used_merchandise_and_secondhand_stores", "utilities", "variety_stores", "veterinary_services", "video_amusement_game_supplies", "video_game_arcades", "video_tape_rental_stores", "vocational_trade_schools", "watch_jewelry_repair", "welding_repair", "wholesale_clubs", "wig_and_toupee_stores", "wires_money_orders", "womens_accessory_and_specialty_shops", "womens_ready_to_wear_stores", "wrecking_and_salvage_yards" ], "maxLength": 5000, "type": "string" }, "city": { "description": "City where the seller is located", "maxLength": 5000, "type": "string" }, "country": { "description": "Country where the seller is located", "maxLength": 5000, "type": "string" }, "name": { "description": "Name of the seller", "maxLength": 5000, "type": "string" }, "network_id": { "description": "Identifier assigned to the seller by the card network. Different card networks may assign different network_id fields to the same merchant.", "maxLength": 5000, "type": "string" }, "postal_code": { "description": "Postal code where the seller is located", "maxLength": 5000, "type": "string" }, "state": { "description": "State where the seller is located", "maxLength": 5000, "type": "string" }, "terminal_id": { "description": "An ID assigned by the seller to the location of the sale.", "maxLength": 5000, "type": "string" }, "url": { "description": "URL provided by the merchant on a 3DS request", "maxLength": 5000, "type": "string" } }, "title": "merchant_data_specs", "type": "object", "x-stripeMostCommon": [ "category", "city", "country", "name", "network_id", "postal_code", "state", "terminal_id", "url" ] }, "network_data": { "description": "Details about the authorization, such as identifiers, set by the card network.", "properties": { "acquiring_institution_id": { "description": "Identifier assigned to the acquirer by the card network.", "maxLength": 5000, "type": "string" } }, "title": "network_data_specs", "type": "object", "x-stripeMostCommon": [ "acquiring_institution_id", "routed_network" ] }, "verification_data": { "description": "Verifications that Stripe performed on information that the cardholder provided to the merchant.", "properties": { "address_line1_check": { "description": "Whether the cardholder provided an address first line and if it matched the cardholder’s `billing.address.line1`.", "enum": [ "match", "mismatch", "not_provided" ], "type": "string" }, "address_postal_code_check": { "description": "Whether the cardholder provided a postal code and if it matched the cardholder’s `billing.address.postal_code`.", "enum": [ "match", "mismatch", "not_provided" ], "type": "string" }, "authentication_exemption": { "description": "The exemption applied to this authorization.", "properties": { "claimed_by": { "description": "The entity that requested the exemption, either the acquiring merchant or the Issuing user.", "enum": [ "acquirer", "issuer" ], "type": "string" }, "type": { "description": "The specific exemption claimed for this authorization.", "enum": [ "low_value_transaction", "transaction_risk_analysis", "unknown" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "claimed_by", "type" ], "title": "authentication_exemption_specs", "type": "object", "x-stripeMostCommon": [ "claimed_by", "type" ] }, "cvc_check": { "description": "Whether the cardholder provided a CVC and if it matched Stripe’s record.", "enum": [ "match", "mismatch", "not_provided" ], "type": "string" }, "expiry_check": { "description": "Whether the cardholder provided an expiry date and if it matched Stripe’s record.", "enum": [ "match", "mismatch", "not_provided" ], "type": "string" }, "three_d_secure": { "description": "3D Secure details.", "properties": { "result": { "description": "The outcome of the 3D Secure authentication request.", "enum": [ "attempt_acknowledged", "authenticated", "failed", "required" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "result" ], "title": "three_d_secure_specs", "type": "object", "x-stripeMostCommon": [ "result" ] } }, "title": "verification_data_specs", "type": "object", "x-stripeMostCommon": [ "address_line1_check", "address_postal_code_check", "authentication_exemption", "cvc_check", "expiry_check", "three_d_secure" ] }, "wallet": { "description": "The digital wallet used for this transaction. One of `apple_pay`, `google_pay`, or `samsung_pay`. Will populate as `null` when no digital wallet was utilized.", "enum": [ "apple_pay", "google_pay", "samsung_pay" ], "type": "string" } }, "required": [ "card" ], "type": "object", "x-stripeMostCommon": [ "amount", "card", "currency" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issuing.authorization" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a test-mode authorization" } }, "/v1/test_helpers/issuing/authorizations/{authorization}/capture": { "post": { "description": "

Capture a test-mode authorization.

", "operationId": "PostTestHelpersIssuingAuthorizationsAuthorizationCapture", "parameters": [ { "in": "path", "name": "authorization", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "purchase_details": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "capture_amount": { "description": "The amount to capture from the authorization. If not provided, the full amount of the authorization will be captured. This amount is in the authorization currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", "type": "integer" }, "close_authorization": { "description": "Whether to close the authorization after capture. Defaults to true. Set to false to enable multi-capture flows.", "type": "boolean" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "purchase_details": { "description": "Additional purchase information that is optionally provided by the merchant.", "properties": { "fleet": { "description": "Fleet-specific information for transactions using Fleet cards.", "properties": { "cardholder_prompt_data": { "description": "Answers to prompts presented to the cardholder at the point of sale. Prompted fields vary depending on the configuration of your physical fleet cards. Typical points of sale support only numeric entry.", "properties": { "driver_id": { "description": "Driver ID.", "maxLength": 5000, "type": "string" }, "odometer": { "description": "Odometer reading.", "type": "integer" }, "unspecified_id": { "description": "An alphanumeric ID. This field is used when a vehicle ID, driver ID, or generic ID is entered by the cardholder, but the merchant or card network did not specify the prompt type.", "maxLength": 5000, "type": "string" }, "user_id": { "description": "User ID.", "maxLength": 5000, "type": "string" }, "vehicle_number": { "description": "Vehicle number.", "maxLength": 5000, "type": "string" } }, "title": "fleet_cardholder_prompt_data_specs", "type": "object", "x-stripeMostCommon": [ "driver_id", "odometer", "unspecified_id", "user_id", "vehicle_number" ] }, "purchase_type": { "description": "The type of purchase. One of `fuel_purchase`, `non_fuel_purchase`, or `fuel_and_non_fuel_purchase`.", "enum": [ "fuel_and_non_fuel_purchase", "fuel_purchase", "non_fuel_purchase" ], "maxLength": 5000, "type": "string" }, "reported_breakdown": { "description": "More information about the total amount. This information is not guaranteed to be accurate as some merchants may provide unreliable data.", "properties": { "fuel": { "description": "Breakdown of fuel portion of the purchase.", "properties": { "gross_amount_decimal": { "description": "Gross fuel amount that should equal Fuel Volume multipled by Fuel Unit Cost, inclusive of taxes.", "format": "decimal", "type": "string" } }, "title": "fleet_reported_breakdown_fuel_specs", "type": "object", "x-stripeMostCommon": [ "gross_amount_decimal" ] }, "non_fuel": { "description": "Breakdown of non-fuel portion of the purchase.", "properties": { "gross_amount_decimal": { "description": "Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes.", "format": "decimal", "type": "string" } }, "title": "fleet_reported_breakdown_non_fuel_specs", "type": "object", "x-stripeMostCommon": [ "gross_amount_decimal" ] }, "tax": { "description": "Information about tax included in this transaction.", "properties": { "local_amount_decimal": { "description": "Amount of state or provincial Sales Tax included in the transaction amount. Null if not reported by merchant or not subject to tax.", "format": "decimal", "type": "string" }, "national_amount_decimal": { "description": "Amount of national Sales Tax or VAT included in the transaction amount. Null if not reported by merchant or not subject to tax.", "format": "decimal", "type": "string" } }, "title": "fleet_reported_breakdown_tax_specs", "type": "object", "x-stripeMostCommon": [ "local_amount_decimal", "national_amount_decimal" ] } }, "title": "fleet_reported_breakdown_specs", "type": "object", "x-stripeMostCommon": [ "fuel", "non_fuel", "tax" ] }, "service_type": { "description": "The type of fuel service. One of `non_fuel_transaction`, `full_service`, or `self_service`.", "enum": [ "full_service", "non_fuel_transaction", "self_service" ], "maxLength": 5000, "type": "string" } }, "title": "fleet_specs", "type": "object", "x-stripeMostCommon": [ "cardholder_prompt_data", "purchase_type", "reported_breakdown", "service_type" ] }, "flight": { "description": "Information about the flight that was purchased with this transaction.", "properties": { "departure_at": { "description": "The time that the flight departed.", "format": "unix-time", "type": "integer" }, "passenger_name": { "description": "The name of the passenger.", "maxLength": 5000, "type": "string" }, "refundable": { "description": "Whether the ticket is refundable.", "type": "boolean" }, "segments": { "description": "The legs of the trip.", "items": { "properties": { "arrival_airport_code": { "description": "The three-letter IATA airport code of the flight's destination.", "maxLength": 3, "type": "string" }, "carrier": { "description": "The airline carrier code.", "maxLength": 5000, "type": "string" }, "departure_airport_code": { "description": "The three-letter IATA airport code that the flight departed from.", "maxLength": 3, "type": "string" }, "flight_number": { "description": "The flight number.", "maxLength": 5000, "type": "string" }, "service_class": { "description": "The flight's service class.", "maxLength": 5000, "type": "string" }, "stopover_allowed": { "description": "Whether a stopover is allowed on this flight.", "type": "boolean" } }, "title": "flight_segment_specs", "type": "object", "x-stripeMostCommon": [ "arrival_airport_code", "carrier", "departure_airport_code", "flight_number", "service_class", "stopover_allowed" ] }, "type": "array" }, "travel_agency": { "description": "The travel agency that issued the ticket.", "maxLength": 5000, "type": "string" } }, "title": "flight_specs", "type": "object", "x-stripeMostCommon": [ "departure_at", "passenger_name", "refundable", "segments", "travel_agency" ] }, "fuel": { "description": "Information about fuel that was purchased with this transaction.", "properties": { "industry_product_code": { "description": "[Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased.", "maxLength": 5000, "type": "string" }, "quantity_decimal": { "description": "The quantity of `unit`s of fuel that was dispensed, represented as a decimal string with at most 12 decimal places.", "format": "decimal", "type": "string" }, "type": { "description": "The type of fuel that was purchased. One of `diesel`, `unleaded_plus`, `unleaded_regular`, `unleaded_super`, or `other`.", "enum": [ "diesel", "other", "unleaded_plus", "unleaded_regular", "unleaded_super" ], "maxLength": 5000, "type": "string" }, "unit": { "description": "The units for `quantity_decimal`. One of `charging_minute`, `imperial_gallon`, `kilogram`, `kilowatt_hour`, `liter`, `pound`, `us_gallon`, or `other`.", "enum": [ "charging_minute", "imperial_gallon", "kilogram", "kilowatt_hour", "liter", "other", "pound", "us_gallon" ], "maxLength": 5000, "type": "string" }, "unit_cost_decimal": { "description": "The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places.", "format": "decimal", "type": "string" } }, "title": "fuel_specs", "type": "object", "x-stripeMostCommon": [ "industry_product_code", "quantity_decimal", "type", "unit", "unit_cost_decimal" ] }, "lodging": { "description": "Information about lodging that was purchased with this transaction.", "properties": { "check_in_at": { "description": "The time of checking into the lodging.", "format": "unix-time", "type": "integer" }, "nights": { "description": "The number of nights stayed at the lodging.", "type": "integer" } }, "title": "lodging_specs", "type": "object", "x-stripeMostCommon": [ "check_in_at", "nights" ] }, "receipt": { "description": "The line items in the purchase.", "items": { "properties": { "description": { "maxLength": 26, "type": "string" }, "quantity": { "format": "decimal", "type": "string" }, "total": { "type": "integer" }, "unit_cost": { "type": "integer" } }, "title": "receipt_specs", "type": "object", "x-stripeMostCommon": [ "description", "quantity", "total", "unit_cost" ] }, "type": "array" }, "reference": { "description": "A merchant-specific order number.", "maxLength": 5000, "type": "string" } }, "title": "purchase_details_specs", "type": "object", "x-stripeMostCommon": [ "fleet", "flight", "fuel", "lodging", "receipt", "reference" ] } }, "type": "object", "x-stripeMostCommon": [ "capture_amount", "close_authorization", "purchase_details" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issuing.authorization" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Capture a test-mode authorization" } }, "/v1/test_helpers/issuing/authorizations/{authorization}/expire": { "post": { "description": "

Expire a test-mode Authorization.

", "operationId": "PostTestHelpersIssuingAuthorizationsAuthorizationExpire", "parameters": [ { "in": "path", "name": "authorization", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issuing.authorization" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Expire a test-mode authorization" } }, "/v1/test_helpers/issuing/authorizations/{authorization}/finalize_amount": { "post": { "description": "

Finalize the amount on an Authorization prior to capture, when the initial authorization was for an estimated amount.

", "operationId": "PostTestHelpersIssuingAuthorizationsAuthorizationFinalizeAmount", "parameters": [ { "in": "path", "name": "authorization", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "fleet": { "explode": true, "style": "deepObject" }, "fuel": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "final_amount": { "description": "The final authorization amount that will be captured by the merchant. This amount is in the authorization currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", "type": "integer" }, "fleet": { "description": "Fleet-specific information for authorizations using Fleet cards.", "properties": { "cardholder_prompt_data": { "description": "Answers to prompts presented to the cardholder at the point of sale. Prompted fields vary depending on the configuration of your physical fleet cards. Typical points of sale support only numeric entry.", "properties": { "driver_id": { "description": "Driver ID.", "maxLength": 5000, "type": "string" }, "odometer": { "description": "Odometer reading.", "type": "integer" }, "unspecified_id": { "description": "An alphanumeric ID. This field is used when a vehicle ID, driver ID, or generic ID is entered by the cardholder, but the merchant or card network did not specify the prompt type.", "maxLength": 5000, "type": "string" }, "user_id": { "description": "User ID.", "maxLength": 5000, "type": "string" }, "vehicle_number": { "description": "Vehicle number.", "maxLength": 5000, "type": "string" } }, "title": "fleet_cardholder_prompt_data_specs", "type": "object", "x-stripeMostCommon": [ "driver_id", "odometer", "unspecified_id", "user_id", "vehicle_number" ] }, "purchase_type": { "description": "The type of purchase. One of `fuel_purchase`, `non_fuel_purchase`, or `fuel_and_non_fuel_purchase`.", "enum": [ "fuel_and_non_fuel_purchase", "fuel_purchase", "non_fuel_purchase" ], "maxLength": 5000, "type": "string" }, "reported_breakdown": { "description": "More information about the total amount. This information is not guaranteed to be accurate as some merchants may provide unreliable data.", "properties": { "fuel": { "description": "Breakdown of fuel portion of the purchase.", "properties": { "gross_amount_decimal": { "description": "Gross fuel amount that should equal Fuel Volume multipled by Fuel Unit Cost, inclusive of taxes.", "format": "decimal", "type": "string" } }, "title": "fleet_reported_breakdown_fuel_specs", "type": "object", "x-stripeMostCommon": [ "gross_amount_decimal" ] }, "non_fuel": { "description": "Breakdown of non-fuel portion of the purchase.", "properties": { "gross_amount_decimal": { "description": "Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes.", "format": "decimal", "type": "string" } }, "title": "fleet_reported_breakdown_non_fuel_specs", "type": "object", "x-stripeMostCommon": [ "gross_amount_decimal" ] }, "tax": { "description": "Information about tax included in this transaction.", "properties": { "local_amount_decimal": { "description": "Amount of state or provincial Sales Tax included in the transaction amount. Null if not reported by merchant or not subject to tax.", "format": "decimal", "type": "string" }, "national_amount_decimal": { "description": "Amount of national Sales Tax or VAT included in the transaction amount. Null if not reported by merchant or not subject to tax.", "format": "decimal", "type": "string" } }, "title": "fleet_reported_breakdown_tax_specs", "type": "object", "x-stripeMostCommon": [ "local_amount_decimal", "national_amount_decimal" ] } }, "title": "fleet_reported_breakdown_specs", "type": "object", "x-stripeMostCommon": [ "fuel", "non_fuel", "tax" ] }, "service_type": { "description": "The type of fuel service. One of `non_fuel_transaction`, `full_service`, or `self_service`.", "enum": [ "full_service", "non_fuel_transaction", "self_service" ], "maxLength": 5000, "type": "string" } }, "title": "fleet_specs", "type": "object", "x-stripeMostCommon": [ "cardholder_prompt_data", "purchase_type", "reported_breakdown", "service_type" ] }, "fuel": { "description": "Information about fuel that was purchased with this transaction.", "properties": { "industry_product_code": { "description": "[Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased.", "maxLength": 5000, "type": "string" }, "quantity_decimal": { "description": "The quantity of `unit`s of fuel that was dispensed, represented as a decimal string with at most 12 decimal places.", "format": "decimal", "type": "string" }, "type": { "description": "The type of fuel that was purchased. One of `diesel`, `unleaded_plus`, `unleaded_regular`, `unleaded_super`, or `other`.", "enum": [ "diesel", "other", "unleaded_plus", "unleaded_regular", "unleaded_super" ], "maxLength": 5000, "type": "string" }, "unit": { "description": "The units for `quantity_decimal`. One of `charging_minute`, `imperial_gallon`, `kilogram`, `kilowatt_hour`, `liter`, `pound`, `us_gallon`, or `other`.", "enum": [ "charging_minute", "imperial_gallon", "kilogram", "kilowatt_hour", "liter", "other", "pound", "us_gallon" ], "maxLength": 5000, "type": "string" }, "unit_cost_decimal": { "description": "The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places.", "format": "decimal", "type": "string" } }, "title": "fuel_specs", "type": "object", "x-stripeMostCommon": [ "industry_product_code", "quantity_decimal", "type", "unit", "unit_cost_decimal" ] } }, "required": [ "final_amount" ], "type": "object", "x-stripeMostCommon": [ "final_amount" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issuing.authorization" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Finalize a test-mode authorization's amount" } }, "/v1/test_helpers/issuing/authorizations/{authorization}/fraud_challenges/respond": { "post": { "description": "

Respond to a fraud challenge on a testmode Issuing authorization, simulating either a confirmation of fraud or a correction of legitimacy.

", "operationId": "PostTestHelpersIssuingAuthorizationsAuthorizationFraudChallengesRespond", "parameters": [ { "in": "path", "name": "authorization", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "confirmed": { "description": "Whether to simulate the user confirming that the transaction was legitimate (true) or telling Stripe that it was fraudulent (false).", "type": "boolean" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "required": [ "confirmed" ], "type": "object", "x-stripeMostCommon": [ "confirmed" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issuing.authorization" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Respond to fraud challenge" } }, "/v1/test_helpers/issuing/authorizations/{authorization}/increment": { "post": { "description": "

Increment a test-mode Authorization.

", "operationId": "PostTestHelpersIssuingAuthorizationsAuthorizationIncrement", "parameters": [ { "in": "path", "name": "authorization", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "increment_amount": { "description": "The amount to increment the authorization by. This amount is in the authorization currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", "type": "integer" }, "is_amount_controllable": { "description": "If set `true`, you may provide [amount](https://stripe.com/docs/api/issuing/authorizations/approve#approve_issuing_authorization-amount) to control how much to hold for the authorization.", "type": "boolean" } }, "required": [ "increment_amount" ], "type": "object", "x-stripeMostCommon": [ "increment_amount", "is_amount_controllable" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issuing.authorization" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Increment a test-mode authorization" } }, "/v1/test_helpers/issuing/authorizations/{authorization}/reverse": { "post": { "description": "

Reverse a test-mode Authorization.

", "operationId": "PostTestHelpersIssuingAuthorizationsAuthorizationReverse", "parameters": [ { "in": "path", "name": "authorization", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "reverse_amount": { "description": "The amount to reverse from the authorization. If not provided, the full amount of the authorization will be reversed. This amount is in the authorization currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", "type": "integer" } }, "type": "object", "x-stripeMostCommon": [ "reverse_amount" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issuing.authorization" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Reverse a test-mode authorization" } }, "/v1/test_helpers/issuing/cards/{card}/shipping/deliver": { "post": { "description": "

Updates the shipping status of the specified Issuing Card object to delivered.

", "operationId": "PostTestHelpersIssuingCardsCardShippingDeliver", "parameters": [ { "in": "path", "name": "card", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issuing.card" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Deliver a testmode card" } }, "/v1/test_helpers/issuing/cards/{card}/shipping/fail": { "post": { "description": "

Updates the shipping status of the specified Issuing Card object to failure.

", "operationId": "PostTestHelpersIssuingCardsCardShippingFail", "parameters": [ { "in": "path", "name": "card", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issuing.card" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Fail a testmode card" } }, "/v1/test_helpers/issuing/cards/{card}/shipping/return": { "post": { "description": "

Updates the shipping status of the specified Issuing Card object to returned.

", "operationId": "PostTestHelpersIssuingCardsCardShippingReturn", "parameters": [ { "in": "path", "name": "card", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issuing.card" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Return a testmode card" } }, "/v1/test_helpers/issuing/cards/{card}/shipping/ship": { "post": { "description": "

Updates the shipping status of the specified Issuing Card object to shipped.

", "operationId": "PostTestHelpersIssuingCardsCardShippingShip", "parameters": [ { "in": "path", "name": "card", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issuing.card" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Ship a testmode card" } }, "/v1/test_helpers/issuing/cards/{card}/shipping/submit": { "post": { "description": "

Updates the shipping status of the specified Issuing Card object to submitted. This method requires Stripe Version ‘2024-09-30.acacia’ or later.

", "operationId": "PostTestHelpersIssuingCardsCardShippingSubmit", "parameters": [ { "in": "path", "name": "card", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issuing.card" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Submit a testmode card" } }, "/v1/test_helpers/issuing/personalization_designs/{personalization_design}/activate": { "post": { "description": "

Updates the status of the specified testmode personalization design object to active.

", "operationId": "PostTestHelpersIssuingPersonalizationDesignsPersonalizationDesignActivate", "parameters": [ { "in": "path", "name": "personalization_design", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issuing.personalization_design" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Activate a testmode personalization design" } }, "/v1/test_helpers/issuing/personalization_designs/{personalization_design}/deactivate": { "post": { "description": "

Updates the status of the specified testmode personalization design object to inactive.

", "operationId": "PostTestHelpersIssuingPersonalizationDesignsPersonalizationDesignDeactivate", "parameters": [ { "in": "path", "name": "personalization_design", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issuing.personalization_design" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Deactivate a testmode personalization design" } }, "/v1/test_helpers/issuing/personalization_designs/{personalization_design}/reject": { "post": { "description": "

Updates the status of the specified testmode personalization design object to rejected.

", "operationId": "PostTestHelpersIssuingPersonalizationDesignsPersonalizationDesignReject", "parameters": [ { "in": "path", "name": "personalization_design", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "rejection_reasons": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "rejection_reasons": { "description": "The reason(s) the personalization design was rejected.", "properties": { "card_logo": { "description": "The reason(s) the card logo was rejected.", "items": { "enum": [ "geographic_location", "inappropriate", "network_name", "non_binary_image", "non_fiat_currency", "other", "other_entity", "promotional_material" ], "type": "string" }, "type": "array" }, "carrier_text": { "description": "The reason(s) the carrier text was rejected.", "items": { "enum": [ "geographic_location", "inappropriate", "network_name", "non_fiat_currency", "other", "other_entity", "promotional_material" ], "type": "string" }, "type": "array" } }, "title": "rejection_reasons_param", "type": "object", "x-stripeMostCommon": [ "card_logo", "carrier_text" ] } }, "required": [ "rejection_reasons" ], "type": "object", "x-stripeMostCommon": [ "rejection_reasons" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issuing.personalization_design" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Reject a testmode personalization design" } }, "/v1/test_helpers/issuing/transactions/create_force_capture": { "post": { "description": "

Allows the user to capture an arbitrary amount, also known as a forced capture.

", "operationId": "PostTestHelpersIssuingTransactionsCreateForceCapture", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "merchant_data": { "explode": true, "style": "deepObject" }, "purchase_details": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "amount": { "description": "The total amount to attempt to capture. This amount is in the provided currency, or defaults to the cards currency, and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", "type": "integer" }, "card": { "description": "Card associated with this transaction.", "maxLength": 5000, "type": "string" }, "currency": { "description": "The currency of the capture. If not provided, defaults to the currency of the card. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "merchant_data": { "description": "Details about the seller (grocery store, e-commerce website, etc.) where the card authorization happened.", "properties": { "category": { "description": "A categorization of the seller's type of business. See our [merchant categories guide](https://stripe.com/docs/issuing/merchant-categories) for a list of possible values.", "enum": [ "ac_refrigeration_repair", "accounting_bookkeeping_services", "advertising_services", "agricultural_cooperative", "airlines_air_carriers", "airports_flying_fields", "ambulance_services", "amusement_parks_carnivals", "antique_reproductions", "antique_shops", "aquariums", "architectural_surveying_services", "art_dealers_and_galleries", "artists_supply_and_craft_shops", "auto_and_home_supply_stores", "auto_body_repair_shops", "auto_paint_shops", "auto_service_shops", "automated_cash_disburse", "automated_fuel_dispensers", "automobile_associations", "automotive_parts_and_accessories_stores", "automotive_tire_stores", "bail_and_bond_payments", "bakeries", "bands_orchestras", "barber_and_beauty_shops", "betting_casino_gambling", "bicycle_shops", "billiard_pool_establishments", "boat_dealers", "boat_rentals_and_leases", "book_stores", "books_periodicals_and_newspapers", "bowling_alleys", "bus_lines", "business_secretarial_schools", "buying_shopping_services", "cable_satellite_and_other_pay_television_and_radio", "camera_and_photographic_supply_stores", "candy_nut_and_confectionery_stores", "car_and_truck_dealers_new_used", "car_and_truck_dealers_used_only", "car_rental_agencies", "car_washes", "carpentry_services", "carpet_upholstery_cleaning", "caterers", "charitable_and_social_service_organizations_fundraising", "chemicals_and_allied_products", "child_care_services", "childrens_and_infants_wear_stores", "chiropodists_podiatrists", "chiropractors", "cigar_stores_and_stands", "civic_social_fraternal_associations", "cleaning_and_maintenance", "clothing_rental", "colleges_universities", "commercial_equipment", "commercial_footwear", "commercial_photography_art_and_graphics", "commuter_transport_and_ferries", "computer_network_services", "computer_programming", "computer_repair", "computer_software_stores", "computers_peripherals_and_software", "concrete_work_services", "construction_materials", "consulting_public_relations", "correspondence_schools", "cosmetic_stores", "counseling_services", "country_clubs", "courier_services", "court_costs", "credit_reporting_agencies", "cruise_lines", "dairy_products_stores", "dance_hall_studios_schools", "dating_escort_services", "dentists_orthodontists", "department_stores", "detective_agencies", "digital_goods_applications", "digital_goods_games", "digital_goods_large_volume", "digital_goods_media", "direct_marketing_catalog_merchant", "direct_marketing_combination_catalog_and_retail_merchant", "direct_marketing_inbound_telemarketing", "direct_marketing_insurance_services", "direct_marketing_other", "direct_marketing_outbound_telemarketing", "direct_marketing_subscription", "direct_marketing_travel", "discount_stores", "doctors", "door_to_door_sales", "drapery_window_covering_and_upholstery_stores", "drinking_places", "drug_stores_and_pharmacies", "drugs_drug_proprietaries_and_druggist_sundries", "dry_cleaners", "durable_goods", "duty_free_stores", "eating_places_restaurants", "educational_services", "electric_razor_stores", "electric_vehicle_charging", "electrical_parts_and_equipment", "electrical_services", "electronics_repair_shops", "electronics_stores", "elementary_secondary_schools", "emergency_services_gcas_visa_use_only", "employment_temp_agencies", "equipment_rental", "exterminating_services", "family_clothing_stores", "fast_food_restaurants", "financial_institutions", "fines_government_administrative_entities", "fireplace_fireplace_screens_and_accessories_stores", "floor_covering_stores", "florists", "florists_supplies_nursery_stock_and_flowers", "freezer_and_locker_meat_provisioners", "fuel_dealers_non_automotive", "funeral_services_crematories", "furniture_home_furnishings_and_equipment_stores_except_appliances", "furniture_repair_refinishing", "furriers_and_fur_shops", "general_services", "gift_card_novelty_and_souvenir_shops", "glass_paint_and_wallpaper_stores", "glassware_crystal_stores", "golf_courses_public", "government_licensed_horse_dog_racing_us_region_only", "government_licensed_online_casions_online_gambling_us_region_only", "government_owned_lotteries_non_us_region", "government_owned_lotteries_us_region_only", "government_services", "grocery_stores_supermarkets", "hardware_equipment_and_supplies", "hardware_stores", "health_and_beauty_spas", "hearing_aids_sales_and_supplies", "heating_plumbing_a_c", "hobby_toy_and_game_shops", "home_supply_warehouse_stores", "hospitals", "hotels_motels_and_resorts", "household_appliance_stores", "industrial_supplies", "information_retrieval_services", "insurance_default", "insurance_underwriting_premiums", "intra_company_purchases", "jewelry_stores_watches_clocks_and_silverware_stores", "landscaping_services", "laundries", "laundry_cleaning_services", "legal_services_attorneys", "luggage_and_leather_goods_stores", "lumber_building_materials_stores", "manual_cash_disburse", "marinas_service_and_supplies", "marketplaces", "masonry_stonework_and_plaster", "massage_parlors", "medical_and_dental_labs", "medical_dental_ophthalmic_and_hospital_equipment_and_supplies", "medical_services", "membership_organizations", "mens_and_boys_clothing_and_accessories_stores", "mens_womens_clothing_stores", "metal_service_centers", "miscellaneous_apparel_and_accessory_shops", "miscellaneous_auto_dealers", "miscellaneous_business_services", "miscellaneous_food_stores", "miscellaneous_general_merchandise", "miscellaneous_general_services", "miscellaneous_home_furnishing_specialty_stores", "miscellaneous_publishing_and_printing", "miscellaneous_recreation_services", "miscellaneous_repair_shops", "miscellaneous_specialty_retail", "mobile_home_dealers", "motion_picture_theaters", "motor_freight_carriers_and_trucking", "motor_homes_dealers", "motor_vehicle_supplies_and_new_parts", "motorcycle_shops_and_dealers", "motorcycle_shops_dealers", "music_stores_musical_instruments_pianos_and_sheet_music", "news_dealers_and_newsstands", "non_fi_money_orders", "non_fi_stored_value_card_purchase_load", "nondurable_goods", "nurseries_lawn_and_garden_supply_stores", "nursing_personal_care", "office_and_commercial_furniture", "opticians_eyeglasses", "optometrists_ophthalmologist", "orthopedic_goods_prosthetic_devices", "osteopaths", "package_stores_beer_wine_and_liquor", "paints_varnishes_and_supplies", "parking_lots_garages", "passenger_railways", "pawn_shops", "pet_shops_pet_food_and_supplies", "petroleum_and_petroleum_products", "photo_developing", "photographic_photocopy_microfilm_equipment_and_supplies", "photographic_studios", "picture_video_production", "piece_goods_notions_and_other_dry_goods", "plumbing_heating_equipment_and_supplies", "political_organizations", "postal_services_government_only", "precious_stones_and_metals_watches_and_jewelry", "professional_services", "public_warehousing_and_storage", "quick_copy_repro_and_blueprint", "railroads", "real_estate_agents_and_managers_rentals", "record_stores", "recreational_vehicle_rentals", "religious_goods_stores", "religious_organizations", "roofing_siding_sheet_metal", "secretarial_support_services", "security_brokers_dealers", "service_stations", "sewing_needlework_fabric_and_piece_goods_stores", "shoe_repair_hat_cleaning", "shoe_stores", "small_appliance_repair", "snowmobile_dealers", "special_trade_services", "specialty_cleaning", "sporting_goods_stores", "sporting_recreation_camps", "sports_and_riding_apparel_stores", "sports_clubs_fields", "stamp_and_coin_stores", "stationary_office_supplies_printing_and_writing_paper", "stationery_stores_office_and_school_supply_stores", "swimming_pools_sales", "t_ui_travel_germany", "tailors_alterations", "tax_payments_government_agencies", "tax_preparation_services", "taxicabs_limousines", "telecommunication_equipment_and_telephone_sales", "telecommunication_services", "telegraph_services", "tent_and_awning_shops", "testing_laboratories", "theatrical_ticket_agencies", "timeshares", "tire_retreading_and_repair", "tolls_bridge_fees", "tourist_attractions_and_exhibits", "towing_services", "trailer_parks_campgrounds", "transportation_services", "travel_agencies_tour_operators", "truck_stop_iteration", "truck_utility_trailer_rentals", "typesetting_plate_making_and_related_services", "typewriter_stores", "u_s_federal_government_agencies_or_departments", "uniforms_commercial_clothing", "used_merchandise_and_secondhand_stores", "utilities", "variety_stores", "veterinary_services", "video_amusement_game_supplies", "video_game_arcades", "video_tape_rental_stores", "vocational_trade_schools", "watch_jewelry_repair", "welding_repair", "wholesale_clubs", "wig_and_toupee_stores", "wires_money_orders", "womens_accessory_and_specialty_shops", "womens_ready_to_wear_stores", "wrecking_and_salvage_yards" ], "maxLength": 5000, "type": "string" }, "city": { "description": "City where the seller is located", "maxLength": 5000, "type": "string" }, "country": { "description": "Country where the seller is located", "maxLength": 5000, "type": "string" }, "name": { "description": "Name of the seller", "maxLength": 5000, "type": "string" }, "network_id": { "description": "Identifier assigned to the seller by the card network. Different card networks may assign different network_id fields to the same merchant.", "maxLength": 5000, "type": "string" }, "postal_code": { "description": "Postal code where the seller is located", "maxLength": 5000, "type": "string" }, "state": { "description": "State where the seller is located", "maxLength": 5000, "type": "string" }, "terminal_id": { "description": "An ID assigned by the seller to the location of the sale.", "maxLength": 5000, "type": "string" }, "url": { "description": "URL provided by the merchant on a 3DS request", "maxLength": 5000, "type": "string" } }, "title": "merchant_data_specs", "type": "object", "x-stripeMostCommon": [ "category", "city", "country", "name", "network_id", "postal_code", "state", "terminal_id", "url" ] }, "purchase_details": { "description": "Additional purchase information that is optionally provided by the merchant.", "properties": { "fleet": { "description": "Fleet-specific information for transactions using Fleet cards.", "properties": { "cardholder_prompt_data": { "description": "Answers to prompts presented to the cardholder at the point of sale. Prompted fields vary depending on the configuration of your physical fleet cards. Typical points of sale support only numeric entry.", "properties": { "driver_id": { "description": "Driver ID.", "maxLength": 5000, "type": "string" }, "odometer": { "description": "Odometer reading.", "type": "integer" }, "unspecified_id": { "description": "An alphanumeric ID. This field is used when a vehicle ID, driver ID, or generic ID is entered by the cardholder, but the merchant or card network did not specify the prompt type.", "maxLength": 5000, "type": "string" }, "user_id": { "description": "User ID.", "maxLength": 5000, "type": "string" }, "vehicle_number": { "description": "Vehicle number.", "maxLength": 5000, "type": "string" } }, "title": "fleet_cardholder_prompt_data_specs", "type": "object", "x-stripeMostCommon": [ "driver_id", "odometer", "unspecified_id", "user_id", "vehicle_number" ] }, "purchase_type": { "description": "The type of purchase. One of `fuel_purchase`, `non_fuel_purchase`, or `fuel_and_non_fuel_purchase`.", "enum": [ "fuel_and_non_fuel_purchase", "fuel_purchase", "non_fuel_purchase" ], "maxLength": 5000, "type": "string" }, "reported_breakdown": { "description": "More information about the total amount. This information is not guaranteed to be accurate as some merchants may provide unreliable data.", "properties": { "fuel": { "description": "Breakdown of fuel portion of the purchase.", "properties": { "gross_amount_decimal": { "description": "Gross fuel amount that should equal Fuel Volume multipled by Fuel Unit Cost, inclusive of taxes.", "format": "decimal", "type": "string" } }, "title": "fleet_reported_breakdown_fuel_specs", "type": "object", "x-stripeMostCommon": [ "gross_amount_decimal" ] }, "non_fuel": { "description": "Breakdown of non-fuel portion of the purchase.", "properties": { "gross_amount_decimal": { "description": "Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes.", "format": "decimal", "type": "string" } }, "title": "fleet_reported_breakdown_non_fuel_specs", "type": "object", "x-stripeMostCommon": [ "gross_amount_decimal" ] }, "tax": { "description": "Information about tax included in this transaction.", "properties": { "local_amount_decimal": { "description": "Amount of state or provincial Sales Tax included in the transaction amount. Null if not reported by merchant or not subject to tax.", "format": "decimal", "type": "string" }, "national_amount_decimal": { "description": "Amount of national Sales Tax or VAT included in the transaction amount. Null if not reported by merchant or not subject to tax.", "format": "decimal", "type": "string" } }, "title": "fleet_reported_breakdown_tax_specs", "type": "object", "x-stripeMostCommon": [ "local_amount_decimal", "national_amount_decimal" ] } }, "title": "fleet_reported_breakdown_specs", "type": "object", "x-stripeMostCommon": [ "fuel", "non_fuel", "tax" ] }, "service_type": { "description": "The type of fuel service. One of `non_fuel_transaction`, `full_service`, or `self_service`.", "enum": [ "full_service", "non_fuel_transaction", "self_service" ], "maxLength": 5000, "type": "string" } }, "title": "fleet_specs", "type": "object", "x-stripeMostCommon": [ "cardholder_prompt_data", "purchase_type", "reported_breakdown", "service_type" ] }, "flight": { "description": "Information about the flight that was purchased with this transaction.", "properties": { "departure_at": { "description": "The time that the flight departed.", "format": "unix-time", "type": "integer" }, "passenger_name": { "description": "The name of the passenger.", "maxLength": 5000, "type": "string" }, "refundable": { "description": "Whether the ticket is refundable.", "type": "boolean" }, "segments": { "description": "The legs of the trip.", "items": { "properties": { "arrival_airport_code": { "description": "The three-letter IATA airport code of the flight's destination.", "maxLength": 3, "type": "string" }, "carrier": { "description": "The airline carrier code.", "maxLength": 5000, "type": "string" }, "departure_airport_code": { "description": "The three-letter IATA airport code that the flight departed from.", "maxLength": 3, "type": "string" }, "flight_number": { "description": "The flight number.", "maxLength": 5000, "type": "string" }, "service_class": { "description": "The flight's service class.", "maxLength": 5000, "type": "string" }, "stopover_allowed": { "description": "Whether a stopover is allowed on this flight.", "type": "boolean" } }, "title": "flight_segment_specs", "type": "object", "x-stripeMostCommon": [ "arrival_airport_code", "carrier", "departure_airport_code", "flight_number", "service_class", "stopover_allowed" ] }, "type": "array" }, "travel_agency": { "description": "The travel agency that issued the ticket.", "maxLength": 5000, "type": "string" } }, "title": "flight_specs", "type": "object", "x-stripeMostCommon": [ "departure_at", "passenger_name", "refundable", "segments", "travel_agency" ] }, "fuel": { "description": "Information about fuel that was purchased with this transaction.", "properties": { "industry_product_code": { "description": "[Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased.", "maxLength": 5000, "type": "string" }, "quantity_decimal": { "description": "The quantity of `unit`s of fuel that was dispensed, represented as a decimal string with at most 12 decimal places.", "format": "decimal", "type": "string" }, "type": { "description": "The type of fuel that was purchased. One of `diesel`, `unleaded_plus`, `unleaded_regular`, `unleaded_super`, or `other`.", "enum": [ "diesel", "other", "unleaded_plus", "unleaded_regular", "unleaded_super" ], "maxLength": 5000, "type": "string" }, "unit": { "description": "The units for `quantity_decimal`. One of `charging_minute`, `imperial_gallon`, `kilogram`, `kilowatt_hour`, `liter`, `pound`, `us_gallon`, or `other`.", "enum": [ "charging_minute", "imperial_gallon", "kilogram", "kilowatt_hour", "liter", "other", "pound", "us_gallon" ], "maxLength": 5000, "type": "string" }, "unit_cost_decimal": { "description": "The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places.", "format": "decimal", "type": "string" } }, "title": "fuel_specs", "type": "object", "x-stripeMostCommon": [ "industry_product_code", "quantity_decimal", "type", "unit", "unit_cost_decimal" ] }, "lodging": { "description": "Information about lodging that was purchased with this transaction.", "properties": { "check_in_at": { "description": "The time of checking into the lodging.", "format": "unix-time", "type": "integer" }, "nights": { "description": "The number of nights stayed at the lodging.", "type": "integer" } }, "title": "lodging_specs", "type": "object", "x-stripeMostCommon": [ "check_in_at", "nights" ] }, "receipt": { "description": "The line items in the purchase.", "items": { "properties": { "description": { "maxLength": 26, "type": "string" }, "quantity": { "format": "decimal", "type": "string" }, "total": { "type": "integer" }, "unit_cost": { "type": "integer" } }, "title": "receipt_specs", "type": "object", "x-stripeMostCommon": [ "description", "quantity", "total", "unit_cost" ] }, "type": "array" }, "reference": { "description": "A merchant-specific order number.", "maxLength": 5000, "type": "string" } }, "title": "purchase_details_specs", "type": "object", "x-stripeMostCommon": [ "fleet", "flight", "fuel", "lodging", "receipt", "reference" ] } }, "required": [ "amount", "card" ], "type": "object", "x-stripeMostCommon": [ "amount", "card", "currency" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issuing.transaction" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a test-mode force capture" } }, "/v1/test_helpers/issuing/transactions/create_unlinked_refund": { "post": { "description": "

Allows the user to refund an arbitrary amount, also known as a unlinked refund.

", "operationId": "PostTestHelpersIssuingTransactionsCreateUnlinkedRefund", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "merchant_data": { "explode": true, "style": "deepObject" }, "purchase_details": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "amount": { "description": "The total amount to attempt to refund. This amount is in the provided currency, or defaults to the cards currency, and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", "type": "integer" }, "card": { "description": "Card associated with this unlinked refund transaction.", "maxLength": 5000, "type": "string" }, "currency": { "description": "The currency of the unlinked refund. If not provided, defaults to the currency of the card. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "merchant_data": { "description": "Details about the seller (grocery store, e-commerce website, etc.) where the card authorization happened.", "properties": { "category": { "description": "A categorization of the seller's type of business. See our [merchant categories guide](https://stripe.com/docs/issuing/merchant-categories) for a list of possible values.", "enum": [ "ac_refrigeration_repair", "accounting_bookkeeping_services", "advertising_services", "agricultural_cooperative", "airlines_air_carriers", "airports_flying_fields", "ambulance_services", "amusement_parks_carnivals", "antique_reproductions", "antique_shops", "aquariums", "architectural_surveying_services", "art_dealers_and_galleries", "artists_supply_and_craft_shops", "auto_and_home_supply_stores", "auto_body_repair_shops", "auto_paint_shops", "auto_service_shops", "automated_cash_disburse", "automated_fuel_dispensers", "automobile_associations", "automotive_parts_and_accessories_stores", "automotive_tire_stores", "bail_and_bond_payments", "bakeries", "bands_orchestras", "barber_and_beauty_shops", "betting_casino_gambling", "bicycle_shops", "billiard_pool_establishments", "boat_dealers", "boat_rentals_and_leases", "book_stores", "books_periodicals_and_newspapers", "bowling_alleys", "bus_lines", "business_secretarial_schools", "buying_shopping_services", "cable_satellite_and_other_pay_television_and_radio", "camera_and_photographic_supply_stores", "candy_nut_and_confectionery_stores", "car_and_truck_dealers_new_used", "car_and_truck_dealers_used_only", "car_rental_agencies", "car_washes", "carpentry_services", "carpet_upholstery_cleaning", "caterers", "charitable_and_social_service_organizations_fundraising", "chemicals_and_allied_products", "child_care_services", "childrens_and_infants_wear_stores", "chiropodists_podiatrists", "chiropractors", "cigar_stores_and_stands", "civic_social_fraternal_associations", "cleaning_and_maintenance", "clothing_rental", "colleges_universities", "commercial_equipment", "commercial_footwear", "commercial_photography_art_and_graphics", "commuter_transport_and_ferries", "computer_network_services", "computer_programming", "computer_repair", "computer_software_stores", "computers_peripherals_and_software", "concrete_work_services", "construction_materials", "consulting_public_relations", "correspondence_schools", "cosmetic_stores", "counseling_services", "country_clubs", "courier_services", "court_costs", "credit_reporting_agencies", "cruise_lines", "dairy_products_stores", "dance_hall_studios_schools", "dating_escort_services", "dentists_orthodontists", "department_stores", "detective_agencies", "digital_goods_applications", "digital_goods_games", "digital_goods_large_volume", "digital_goods_media", "direct_marketing_catalog_merchant", "direct_marketing_combination_catalog_and_retail_merchant", "direct_marketing_inbound_telemarketing", "direct_marketing_insurance_services", "direct_marketing_other", "direct_marketing_outbound_telemarketing", "direct_marketing_subscription", "direct_marketing_travel", "discount_stores", "doctors", "door_to_door_sales", "drapery_window_covering_and_upholstery_stores", "drinking_places", "drug_stores_and_pharmacies", "drugs_drug_proprietaries_and_druggist_sundries", "dry_cleaners", "durable_goods", "duty_free_stores", "eating_places_restaurants", "educational_services", "electric_razor_stores", "electric_vehicle_charging", "electrical_parts_and_equipment", "electrical_services", "electronics_repair_shops", "electronics_stores", "elementary_secondary_schools", "emergency_services_gcas_visa_use_only", "employment_temp_agencies", "equipment_rental", "exterminating_services", "family_clothing_stores", "fast_food_restaurants", "financial_institutions", "fines_government_administrative_entities", "fireplace_fireplace_screens_and_accessories_stores", "floor_covering_stores", "florists", "florists_supplies_nursery_stock_and_flowers", "freezer_and_locker_meat_provisioners", "fuel_dealers_non_automotive", "funeral_services_crematories", "furniture_home_furnishings_and_equipment_stores_except_appliances", "furniture_repair_refinishing", "furriers_and_fur_shops", "general_services", "gift_card_novelty_and_souvenir_shops", "glass_paint_and_wallpaper_stores", "glassware_crystal_stores", "golf_courses_public", "government_licensed_horse_dog_racing_us_region_only", "government_licensed_online_casions_online_gambling_us_region_only", "government_owned_lotteries_non_us_region", "government_owned_lotteries_us_region_only", "government_services", "grocery_stores_supermarkets", "hardware_equipment_and_supplies", "hardware_stores", "health_and_beauty_spas", "hearing_aids_sales_and_supplies", "heating_plumbing_a_c", "hobby_toy_and_game_shops", "home_supply_warehouse_stores", "hospitals", "hotels_motels_and_resorts", "household_appliance_stores", "industrial_supplies", "information_retrieval_services", "insurance_default", "insurance_underwriting_premiums", "intra_company_purchases", "jewelry_stores_watches_clocks_and_silverware_stores", "landscaping_services", "laundries", "laundry_cleaning_services", "legal_services_attorneys", "luggage_and_leather_goods_stores", "lumber_building_materials_stores", "manual_cash_disburse", "marinas_service_and_supplies", "marketplaces", "masonry_stonework_and_plaster", "massage_parlors", "medical_and_dental_labs", "medical_dental_ophthalmic_and_hospital_equipment_and_supplies", "medical_services", "membership_organizations", "mens_and_boys_clothing_and_accessories_stores", "mens_womens_clothing_stores", "metal_service_centers", "miscellaneous_apparel_and_accessory_shops", "miscellaneous_auto_dealers", "miscellaneous_business_services", "miscellaneous_food_stores", "miscellaneous_general_merchandise", "miscellaneous_general_services", "miscellaneous_home_furnishing_specialty_stores", "miscellaneous_publishing_and_printing", "miscellaneous_recreation_services", "miscellaneous_repair_shops", "miscellaneous_specialty_retail", "mobile_home_dealers", "motion_picture_theaters", "motor_freight_carriers_and_trucking", "motor_homes_dealers", "motor_vehicle_supplies_and_new_parts", "motorcycle_shops_and_dealers", "motorcycle_shops_dealers", "music_stores_musical_instruments_pianos_and_sheet_music", "news_dealers_and_newsstands", "non_fi_money_orders", "non_fi_stored_value_card_purchase_load", "nondurable_goods", "nurseries_lawn_and_garden_supply_stores", "nursing_personal_care", "office_and_commercial_furniture", "opticians_eyeglasses", "optometrists_ophthalmologist", "orthopedic_goods_prosthetic_devices", "osteopaths", "package_stores_beer_wine_and_liquor", "paints_varnishes_and_supplies", "parking_lots_garages", "passenger_railways", "pawn_shops", "pet_shops_pet_food_and_supplies", "petroleum_and_petroleum_products", "photo_developing", "photographic_photocopy_microfilm_equipment_and_supplies", "photographic_studios", "picture_video_production", "piece_goods_notions_and_other_dry_goods", "plumbing_heating_equipment_and_supplies", "political_organizations", "postal_services_government_only", "precious_stones_and_metals_watches_and_jewelry", "professional_services", "public_warehousing_and_storage", "quick_copy_repro_and_blueprint", "railroads", "real_estate_agents_and_managers_rentals", "record_stores", "recreational_vehicle_rentals", "religious_goods_stores", "religious_organizations", "roofing_siding_sheet_metal", "secretarial_support_services", "security_brokers_dealers", "service_stations", "sewing_needlework_fabric_and_piece_goods_stores", "shoe_repair_hat_cleaning", "shoe_stores", "small_appliance_repair", "snowmobile_dealers", "special_trade_services", "specialty_cleaning", "sporting_goods_stores", "sporting_recreation_camps", "sports_and_riding_apparel_stores", "sports_clubs_fields", "stamp_and_coin_stores", "stationary_office_supplies_printing_and_writing_paper", "stationery_stores_office_and_school_supply_stores", "swimming_pools_sales", "t_ui_travel_germany", "tailors_alterations", "tax_payments_government_agencies", "tax_preparation_services", "taxicabs_limousines", "telecommunication_equipment_and_telephone_sales", "telecommunication_services", "telegraph_services", "tent_and_awning_shops", "testing_laboratories", "theatrical_ticket_agencies", "timeshares", "tire_retreading_and_repair", "tolls_bridge_fees", "tourist_attractions_and_exhibits", "towing_services", "trailer_parks_campgrounds", "transportation_services", "travel_agencies_tour_operators", "truck_stop_iteration", "truck_utility_trailer_rentals", "typesetting_plate_making_and_related_services", "typewriter_stores", "u_s_federal_government_agencies_or_departments", "uniforms_commercial_clothing", "used_merchandise_and_secondhand_stores", "utilities", "variety_stores", "veterinary_services", "video_amusement_game_supplies", "video_game_arcades", "video_tape_rental_stores", "vocational_trade_schools", "watch_jewelry_repair", "welding_repair", "wholesale_clubs", "wig_and_toupee_stores", "wires_money_orders", "womens_accessory_and_specialty_shops", "womens_ready_to_wear_stores", "wrecking_and_salvage_yards" ], "maxLength": 5000, "type": "string" }, "city": { "description": "City where the seller is located", "maxLength": 5000, "type": "string" }, "country": { "description": "Country where the seller is located", "maxLength": 5000, "type": "string" }, "name": { "description": "Name of the seller", "maxLength": 5000, "type": "string" }, "network_id": { "description": "Identifier assigned to the seller by the card network. Different card networks may assign different network_id fields to the same merchant.", "maxLength": 5000, "type": "string" }, "postal_code": { "description": "Postal code where the seller is located", "maxLength": 5000, "type": "string" }, "state": { "description": "State where the seller is located", "maxLength": 5000, "type": "string" }, "terminal_id": { "description": "An ID assigned by the seller to the location of the sale.", "maxLength": 5000, "type": "string" }, "url": { "description": "URL provided by the merchant on a 3DS request", "maxLength": 5000, "type": "string" } }, "title": "merchant_data_specs", "type": "object", "x-stripeMostCommon": [ "category", "city", "country", "name", "network_id", "postal_code", "state", "terminal_id", "url" ] }, "purchase_details": { "description": "Additional purchase information that is optionally provided by the merchant.", "properties": { "fleet": { "description": "Fleet-specific information for transactions using Fleet cards.", "properties": { "cardholder_prompt_data": { "description": "Answers to prompts presented to the cardholder at the point of sale. Prompted fields vary depending on the configuration of your physical fleet cards. Typical points of sale support only numeric entry.", "properties": { "driver_id": { "description": "Driver ID.", "maxLength": 5000, "type": "string" }, "odometer": { "description": "Odometer reading.", "type": "integer" }, "unspecified_id": { "description": "An alphanumeric ID. This field is used when a vehicle ID, driver ID, or generic ID is entered by the cardholder, but the merchant or card network did not specify the prompt type.", "maxLength": 5000, "type": "string" }, "user_id": { "description": "User ID.", "maxLength": 5000, "type": "string" }, "vehicle_number": { "description": "Vehicle number.", "maxLength": 5000, "type": "string" } }, "title": "fleet_cardholder_prompt_data_specs", "type": "object", "x-stripeMostCommon": [ "driver_id", "odometer", "unspecified_id", "user_id", "vehicle_number" ] }, "purchase_type": { "description": "The type of purchase. One of `fuel_purchase`, `non_fuel_purchase`, or `fuel_and_non_fuel_purchase`.", "enum": [ "fuel_and_non_fuel_purchase", "fuel_purchase", "non_fuel_purchase" ], "maxLength": 5000, "type": "string" }, "reported_breakdown": { "description": "More information about the total amount. This information is not guaranteed to be accurate as some merchants may provide unreliable data.", "properties": { "fuel": { "description": "Breakdown of fuel portion of the purchase.", "properties": { "gross_amount_decimal": { "description": "Gross fuel amount that should equal Fuel Volume multipled by Fuel Unit Cost, inclusive of taxes.", "format": "decimal", "type": "string" } }, "title": "fleet_reported_breakdown_fuel_specs", "type": "object", "x-stripeMostCommon": [ "gross_amount_decimal" ] }, "non_fuel": { "description": "Breakdown of non-fuel portion of the purchase.", "properties": { "gross_amount_decimal": { "description": "Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes.", "format": "decimal", "type": "string" } }, "title": "fleet_reported_breakdown_non_fuel_specs", "type": "object", "x-stripeMostCommon": [ "gross_amount_decimal" ] }, "tax": { "description": "Information about tax included in this transaction.", "properties": { "local_amount_decimal": { "description": "Amount of state or provincial Sales Tax included in the transaction amount. Null if not reported by merchant or not subject to tax.", "format": "decimal", "type": "string" }, "national_amount_decimal": { "description": "Amount of national Sales Tax or VAT included in the transaction amount. Null if not reported by merchant or not subject to tax.", "format": "decimal", "type": "string" } }, "title": "fleet_reported_breakdown_tax_specs", "type": "object", "x-stripeMostCommon": [ "local_amount_decimal", "national_amount_decimal" ] } }, "title": "fleet_reported_breakdown_specs", "type": "object", "x-stripeMostCommon": [ "fuel", "non_fuel", "tax" ] }, "service_type": { "description": "The type of fuel service. One of `non_fuel_transaction`, `full_service`, or `self_service`.", "enum": [ "full_service", "non_fuel_transaction", "self_service" ], "maxLength": 5000, "type": "string" } }, "title": "fleet_specs", "type": "object", "x-stripeMostCommon": [ "cardholder_prompt_data", "purchase_type", "reported_breakdown", "service_type" ] }, "flight": { "description": "Information about the flight that was purchased with this transaction.", "properties": { "departure_at": { "description": "The time that the flight departed.", "format": "unix-time", "type": "integer" }, "passenger_name": { "description": "The name of the passenger.", "maxLength": 5000, "type": "string" }, "refundable": { "description": "Whether the ticket is refundable.", "type": "boolean" }, "segments": { "description": "The legs of the trip.", "items": { "properties": { "arrival_airport_code": { "description": "The three-letter IATA airport code of the flight's destination.", "maxLength": 3, "type": "string" }, "carrier": { "description": "The airline carrier code.", "maxLength": 5000, "type": "string" }, "departure_airport_code": { "description": "The three-letter IATA airport code that the flight departed from.", "maxLength": 3, "type": "string" }, "flight_number": { "description": "The flight number.", "maxLength": 5000, "type": "string" }, "service_class": { "description": "The flight's service class.", "maxLength": 5000, "type": "string" }, "stopover_allowed": { "description": "Whether a stopover is allowed on this flight.", "type": "boolean" } }, "title": "flight_segment_specs", "type": "object", "x-stripeMostCommon": [ "arrival_airport_code", "carrier", "departure_airport_code", "flight_number", "service_class", "stopover_allowed" ] }, "type": "array" }, "travel_agency": { "description": "The travel agency that issued the ticket.", "maxLength": 5000, "type": "string" } }, "title": "flight_specs", "type": "object", "x-stripeMostCommon": [ "departure_at", "passenger_name", "refundable", "segments", "travel_agency" ] }, "fuel": { "description": "Information about fuel that was purchased with this transaction.", "properties": { "industry_product_code": { "description": "[Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased.", "maxLength": 5000, "type": "string" }, "quantity_decimal": { "description": "The quantity of `unit`s of fuel that was dispensed, represented as a decimal string with at most 12 decimal places.", "format": "decimal", "type": "string" }, "type": { "description": "The type of fuel that was purchased. One of `diesel`, `unleaded_plus`, `unleaded_regular`, `unleaded_super`, or `other`.", "enum": [ "diesel", "other", "unleaded_plus", "unleaded_regular", "unleaded_super" ], "maxLength": 5000, "type": "string" }, "unit": { "description": "The units for `quantity_decimal`. One of `charging_minute`, `imperial_gallon`, `kilogram`, `kilowatt_hour`, `liter`, `pound`, `us_gallon`, or `other`.", "enum": [ "charging_minute", "imperial_gallon", "kilogram", "kilowatt_hour", "liter", "other", "pound", "us_gallon" ], "maxLength": 5000, "type": "string" }, "unit_cost_decimal": { "description": "The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places.", "format": "decimal", "type": "string" } }, "title": "fuel_specs", "type": "object", "x-stripeMostCommon": [ "industry_product_code", "quantity_decimal", "type", "unit", "unit_cost_decimal" ] }, "lodging": { "description": "Information about lodging that was purchased with this transaction.", "properties": { "check_in_at": { "description": "The time of checking into the lodging.", "format": "unix-time", "type": "integer" }, "nights": { "description": "The number of nights stayed at the lodging.", "type": "integer" } }, "title": "lodging_specs", "type": "object", "x-stripeMostCommon": [ "check_in_at", "nights" ] }, "receipt": { "description": "The line items in the purchase.", "items": { "properties": { "description": { "maxLength": 26, "type": "string" }, "quantity": { "format": "decimal", "type": "string" }, "total": { "type": "integer" }, "unit_cost": { "type": "integer" } }, "title": "receipt_specs", "type": "object", "x-stripeMostCommon": [ "description", "quantity", "total", "unit_cost" ] }, "type": "array" }, "reference": { "description": "A merchant-specific order number.", "maxLength": 5000, "type": "string" } }, "title": "purchase_details_specs", "type": "object", "x-stripeMostCommon": [ "fleet", "flight", "fuel", "lodging", "receipt", "reference" ] } }, "required": [ "amount", "card" ], "type": "object", "x-stripeMostCommon": [ "amount", "card", "currency" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issuing.transaction" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a test-mode unlinked refund" } }, "/v1/test_helpers/issuing/transactions/{transaction}/refund": { "post": { "description": "

Refund a test-mode Transaction.

", "operationId": "PostTestHelpersIssuingTransactionsTransactionRefund", "parameters": [ { "in": "path", "name": "transaction", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "refund_amount": { "description": "The total amount to attempt to refund. This amount is in the provided currency, or defaults to the cards currency, and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", "type": "integer" } }, "type": "object", "x-stripeMostCommon": [ "refund_amount" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issuing.transaction" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Refund a test-mode transaction" } }, "/v1/test_helpers/refunds/{refund}/expire": { "post": { "description": "

Expire a refund with a status of requires_action.

", "operationId": "PostTestHelpersRefundsRefundExpire", "parameters": [ { "in": "path", "name": "refund", "required": true, "schema": { "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/refund" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Expire a pending refund." } }, "/v1/test_helpers/terminal/readers/{reader}/present_payment_method": { "post": { "description": "

Presents a payment method on a simulated reader. Can be used to simulate accepting a payment, saving a card or refunding a transaction.

", "operationId": "PostTestHelpersTerminalReadersReaderPresentPaymentMethod", "parameters": [ { "in": "path", "name": "reader", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "card": { "explode": true, "style": "deepObject" }, "card_present": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "interac_present": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "amount_tip": { "description": "Simulated on-reader tip amount.", "type": "integer" }, "card": { "description": "Simulated data for the card payment method.", "properties": { "cvc": { "description": "Card security code.", "maxLength": 5000, "type": "string" }, "exp_month": { "description": "Two-digit number representing the card's expiration month.", "type": "integer" }, "exp_year": { "description": "Two- or four-digit number representing the card's expiration year.", "type": "integer" }, "number": { "description": "The card number, as a string without any separators.", "maxLength": 5000, "type": "string" } }, "required": [ "exp_month", "exp_year", "number" ], "title": "card", "type": "object", "x-stripeMostCommon": [ "cvc", "exp_month", "exp_year", "number" ] }, "card_present": { "description": "Simulated data for the card_present payment method.", "properties": { "number": { "description": "The card number, as a string without any separators.", "maxLength": 5000, "type": "string" } }, "title": "card_present", "type": "object", "x-stripeMostCommon": [ "number" ] }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "interac_present": { "description": "Simulated data for the interac_present payment method.", "properties": { "number": { "description": "Card Number", "maxLength": 5000, "type": "string" } }, "title": "interac_present", "type": "object", "x-stripeMostCommon": [ "number" ] }, "type": { "description": "Simulated payment type.", "enum": [ "card", "card_present", "interac_present" ], "type": "string" } }, "type": "object", "x-stripeMostCommon": [ "card_present", "type" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/terminal.reader" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Simulate presenting a payment method" } }, "/v1/test_helpers/terminal/readers/{reader}/succeed_input_collection": { "post": { "description": "

Use this endpoint to trigger a successful input collection on a simulated reader.

", "operationId": "PostTestHelpersTerminalReadersReaderSucceedInputCollection", "parameters": [ { "in": "path", "name": "reader", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "skip_non_required_inputs": { "description": "This parameter defines the skip behavior for input collection.", "enum": [ "all", "none" ], "type": "string" } }, "type": "object", "x-stripeMostCommon": [ "skip_non_required_inputs" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/terminal.reader" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Simulate a successful input collection" } }, "/v1/test_helpers/terminal/readers/{reader}/timeout_input_collection": { "post": { "description": "

Use this endpoint to complete an input collection with a timeout error on a simulated reader.

", "operationId": "PostTestHelpersTerminalReadersReaderTimeoutInputCollection", "parameters": [ { "in": "path", "name": "reader", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/terminal.reader" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Simulate an input collection timeout" } }, "/v1/test_helpers/test_clocks": { "get": { "description": "

Returns a list of your test clocks.

", "operationId": "GetTestHelpersTestClocks", "parameters": [ { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/test_helpers.test_clock" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/test_helpers/test_clocks", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "BillingClocksResourceBillingClockList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all test clocks" }, "post": { "description": "

Creates a new test clock that can be attached to new customers and quotes.

", "operationId": "PostTestHelpersTestClocks", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "frozen_time": { "description": "The initial frozen time for this test clock.", "format": "unix-time", "type": "integer" }, "name": { "description": "The name for this test clock.", "maxLength": 300, "type": "string" } }, "required": [ "frozen_time" ], "type": "object", "x-stripeMostCommon": [ "frozen_time", "name" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/test_helpers.test_clock" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a test clock" } }, "/v1/test_helpers/test_clocks/{test_clock}": { "delete": { "description": "

Deletes a test clock.

", "operationId": "DeleteTestHelpersTestClocksTestClock", "parameters": [ { "in": "path", "name": "test_clock", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted_test_helpers.test_clock" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Delete a test clock" }, "get": { "description": "

Retrieves a test clock.

", "operationId": "GetTestHelpersTestClocksTestClock", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "test_clock", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/test_helpers.test_clock" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a test clock" } }, "/v1/test_helpers/test_clocks/{test_clock}/advance": { "post": { "description": "

Starts advancing a test clock to a specified time in the future. Advancement is done when status changes to Ready.

", "operationId": "PostTestHelpersTestClocksTestClockAdvance", "parameters": [ { "in": "path", "name": "test_clock", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "frozen_time": { "description": "The time to advance the test clock. Must be after the test clock's current frozen time. Cannot be more than two intervals in the future from the shortest subscription in this test clock. If there are no subscriptions in this test clock, it cannot be more than two years in the future.", "format": "unix-time", "type": "integer" } }, "required": [ "frozen_time" ], "type": "object", "x-stripeMostCommon": [ "frozen_time" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/test_helpers.test_clock" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Advance a test clock" } }, "/v1/test_helpers/treasury/inbound_transfers/{id}/fail": { "post": { "description": "

Transitions a test mode created InboundTransfer to the failed status. The InboundTransfer must already be in the processing state.

", "operationId": "PostTestHelpersTreasuryInboundTransfersIdFail", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "failure_details": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "failure_details": { "description": "Details about a failed InboundTransfer.", "properties": { "code": { "description": "Reason for the failure.", "enum": [ "account_closed", "account_frozen", "bank_account_restricted", "bank_ownership_changed", "debit_not_authorized", "incorrect_account_holder_address", "incorrect_account_holder_name", "incorrect_account_holder_tax_id", "insufficient_funds", "invalid_account_number", "invalid_currency", "no_account", "other" ], "type": "string" } }, "title": "failure_details_param", "type": "object", "x-stripeMostCommon": [ "code", "network_details" ] } }, "type": "object", "x-stripeMostCommon": [ "failure_details" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/treasury.inbound_transfer" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Test mode: Fail an InboundTransfer" } }, "/v1/test_helpers/treasury/inbound_transfers/{id}/return": { "post": { "description": "

Marks the test mode InboundTransfer object as returned and links the InboundTransfer to a ReceivedDebit. The InboundTransfer must already be in the succeeded state.

", "operationId": "PostTestHelpersTreasuryInboundTransfersIdReturn", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/treasury.inbound_transfer" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Test mode: Return an InboundTransfer" } }, "/v1/test_helpers/treasury/inbound_transfers/{id}/succeed": { "post": { "description": "

Transitions a test mode created InboundTransfer to the succeeded status. The InboundTransfer must already be in the processing state.

", "operationId": "PostTestHelpersTreasuryInboundTransfersIdSucceed", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/treasury.inbound_transfer" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Test mode: Succeed an InboundTransfer" } }, "/v1/test_helpers/treasury/outbound_payments/{id}": { "post": { "description": "

Updates a test mode created OutboundPayment with tracking details. The OutboundPayment must not be cancelable, and cannot be in the canceled or failed states.

", "operationId": "PostTestHelpersTreasuryOutboundPaymentsId", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "tracking_details": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "tracking_details": { "description": "Details about network-specific tracking information.", "properties": { "ach": { "description": "ACH network tracking details.", "properties": { "trace_id": { "description": "ACH trace ID for funds sent over the `ach` network.", "maxLength": 5000, "type": "string" } }, "required": [ "trace_id" ], "title": "ach_tracking_details_params", "type": "object", "x-stripeMostCommon": [ "trace_id" ] }, "type": { "description": "The US bank account network used to send funds.", "enum": [ "ach", "us_domestic_wire" ], "type": "string" }, "us_domestic_wire": { "description": "US domestic wire network tracking details.", "properties": { "chips": { "description": "CHIPS System Sequence Number (SSN) for funds sent over the `us_domestic_wire` network.", "maxLength": 5000, "type": "string" }, "imad": { "description": "IMAD for funds sent over the `us_domestic_wire` network.", "maxLength": 5000, "type": "string" }, "omad": { "description": "OMAD for funds sent over the `us_domestic_wire` network.", "maxLength": 5000, "type": "string" } }, "title": "us_domestic_wire_tracking_details_params", "type": "object", "x-stripeMostCommon": [ "chips", "imad", "omad" ] } }, "required": [ "type" ], "title": "tracking_details_params", "type": "object", "x-stripeMostCommon": [ "ach", "type", "us_domestic_wire" ] } }, "required": [ "tracking_details" ], "type": "object", "x-stripeMostCommon": [ "tracking_details" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/treasury.outbound_payment" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Test mode: Update an OutboundPayment" } }, "/v1/test_helpers/treasury/outbound_payments/{id}/fail": { "post": { "description": "

Transitions a test mode created OutboundPayment to the failed status. The OutboundPayment must already be in the processing state.

", "operationId": "PostTestHelpersTreasuryOutboundPaymentsIdFail", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/treasury.outbound_payment" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Test mode: Fail an OutboundPayment" } }, "/v1/test_helpers/treasury/outbound_payments/{id}/post": { "post": { "description": "

Transitions a test mode created OutboundPayment to the posted status. The OutboundPayment must already be in the processing state.

", "operationId": "PostTestHelpersTreasuryOutboundPaymentsIdPost", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/treasury.outbound_payment" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Test mode: Post an OutboundPayment" } }, "/v1/test_helpers/treasury/outbound_payments/{id}/return": { "post": { "description": "

Transitions a test mode created OutboundPayment to the returned status. The OutboundPayment must already be in the processing state.

", "operationId": "PostTestHelpersTreasuryOutboundPaymentsIdReturn", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "returned_details": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "returned_details": { "description": "Optional hash to set the return code.", "properties": { "code": { "description": "The return code to be set on the OutboundPayment object.", "enum": [ "account_closed", "account_frozen", "bank_account_restricted", "bank_ownership_changed", "declined", "incorrect_account_holder_name", "invalid_account_number", "invalid_currency", "no_account", "other" ], "type": "string" } }, "title": "returned_details_params", "type": "object", "x-stripeMostCommon": [ "code" ] } }, "type": "object", "x-stripeMostCommon": [ "returned_details" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/treasury.outbound_payment" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Test mode: Return an OutboundPayment" } }, "/v1/test_helpers/treasury/outbound_transfers/{outbound_transfer}": { "post": { "description": "

Updates a test mode created OutboundTransfer with tracking details. The OutboundTransfer must not be cancelable, and cannot be in the canceled or failed states.

", "operationId": "PostTestHelpersTreasuryOutboundTransfersOutboundTransfer", "parameters": [ { "in": "path", "name": "outbound_transfer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "tracking_details": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "tracking_details": { "description": "Details about network-specific tracking information.", "properties": { "ach": { "description": "ACH network tracking details.", "properties": { "trace_id": { "description": "ACH trace ID for funds sent over the `ach` network.", "maxLength": 5000, "type": "string" } }, "required": [ "trace_id" ], "title": "ach_tracking_details_params", "type": "object", "x-stripeMostCommon": [ "trace_id" ] }, "type": { "description": "The US bank account network used to send funds.", "enum": [ "ach", "us_domestic_wire" ], "type": "string" }, "us_domestic_wire": { "description": "US domestic wire network tracking details.", "properties": { "chips": { "description": "CHIPS System Sequence Number (SSN) for funds sent over the `us_domestic_wire` network.", "maxLength": 5000, "type": "string" }, "imad": { "description": "IMAD for funds sent over the `us_domestic_wire` network.", "maxLength": 5000, "type": "string" }, "omad": { "description": "OMAD for funds sent over the `us_domestic_wire` network.", "maxLength": 5000, "type": "string" } }, "title": "us_domestic_wire_tracking_details_params", "type": "object", "x-stripeMostCommon": [ "chips", "imad", "omad" ] } }, "required": [ "type" ], "title": "tracking_details_params", "type": "object", "x-stripeMostCommon": [ "ach", "type", "us_domestic_wire" ] } }, "required": [ "tracking_details" ], "type": "object", "x-stripeMostCommon": [ "tracking_details" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/treasury.outbound_transfer" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Test mode: Update an OutboundTransfer" } }, "/v1/test_helpers/treasury/outbound_transfers/{outbound_transfer}/fail": { "post": { "description": "

Transitions a test mode created OutboundTransfer to the failed status. The OutboundTransfer must already be in the processing state.

", "operationId": "PostTestHelpersTreasuryOutboundTransfersOutboundTransferFail", "parameters": [ { "in": "path", "name": "outbound_transfer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/treasury.outbound_transfer" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Test mode: Fail an OutboundTransfer" } }, "/v1/test_helpers/treasury/outbound_transfers/{outbound_transfer}/post": { "post": { "description": "

Transitions a test mode created OutboundTransfer to the posted status. The OutboundTransfer must already be in the processing state.

", "operationId": "PostTestHelpersTreasuryOutboundTransfersOutboundTransferPost", "parameters": [ { "in": "path", "name": "outbound_transfer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/treasury.outbound_transfer" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Test mode: Post an OutboundTransfer" } }, "/v1/test_helpers/treasury/outbound_transfers/{outbound_transfer}/return": { "post": { "description": "

Transitions a test mode created OutboundTransfer to the returned status. The OutboundTransfer must already be in the processing state.

", "operationId": "PostTestHelpersTreasuryOutboundTransfersOutboundTransferReturn", "parameters": [ { "in": "path", "name": "outbound_transfer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "returned_details": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "returned_details": { "description": "Details about a returned OutboundTransfer.", "properties": { "code": { "description": "Reason for the return.", "enum": [ "account_closed", "account_frozen", "bank_account_restricted", "bank_ownership_changed", "declined", "incorrect_account_holder_name", "invalid_account_number", "invalid_currency", "no_account", "other" ], "type": "string" } }, "title": "returned_details_params", "type": "object", "x-stripeMostCommon": [ "code" ] } }, "type": "object", "x-stripeMostCommon": [ "returned_details" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/treasury.outbound_transfer" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Test mode: Return an OutboundTransfer" } }, "/v1/test_helpers/treasury/received_credits": { "post": { "description": "

Use this endpoint to simulate a test mode ReceivedCredit initiated by a third party. In live mode, you can’t directly create ReceivedCredits initiated by third parties.

", "operationId": "PostTestHelpersTreasuryReceivedCredits", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "initiating_payment_method_details": { "explode": true, "style": "deepObject" }, "network_details": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "amount": { "description": "Amount (in cents) to be transferred.", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users.", "maxLength": 5000, "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "financial_account": { "description": "The FinancialAccount to send funds to.", "type": "string" }, "initiating_payment_method_details": { "description": "Initiating payment method details for the object.", "properties": { "type": { "description": "The source type.", "enum": [ "us_bank_account" ], "type": "string" }, "us_bank_account": { "description": "Optional fields for `us_bank_account`.", "properties": { "account_holder_name": { "description": "The bank account holder's name.", "maxLength": 5000, "type": "string" }, "account_number": { "description": "The bank account number.", "maxLength": 5000, "type": "string" }, "routing_number": { "description": "The bank account's routing number.", "maxLength": 5000, "type": "string" } }, "title": "us_bank_account_source_params", "type": "object", "x-stripeMostCommon": [ "account_holder_name", "account_number", "routing_number" ] } }, "required": [ "type" ], "title": "source_params", "type": "object", "x-stripeMostCommon": [ "type", "us_bank_account" ] }, "network": { "description": "Specifies the network rails to be used. If not set, will default to the PaymentMethod's preferred network. See the [docs](https://stripe.com/docs/treasury/money-movement/timelines) to learn more about money movement timelines for each network type.", "enum": [ "ach", "us_domestic_wire" ], "type": "string" }, "network_details": { "description": "Details about the network used for the ReceivedCredit.", "properties": { "ach": { "description": "Optional fields for `ach`.", "properties": { "addenda": { "description": "ACH Addenda record", "maxLength": 5000, "type": "string" } }, "title": "ach_network_details_source", "type": "object", "x-stripeMostCommon": [ "addenda" ] }, "type": { "description": "The type of flow that originated the ReceivedCredit.", "enum": [ "ach" ], "type": "string" } }, "required": [ "type" ], "title": "network_details_source", "type": "object", "x-stripeMostCommon": [ "ach", "type" ] } }, "required": [ "amount", "currency", "financial_account", "network" ], "type": "object", "x-stripeMostCommon": [ "amount", "currency", "description", "financial_account", "initiating_payment_method_details", "network", "network_details" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/treasury.received_credit" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Test mode: Create a ReceivedCredit" } }, "/v1/test_helpers/treasury/received_debits": { "post": { "description": "

Use this endpoint to simulate a test mode ReceivedDebit initiated by a third party. In live mode, you can’t directly create ReceivedDebits initiated by third parties.

", "operationId": "PostTestHelpersTreasuryReceivedDebits", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "initiating_payment_method_details": { "explode": true, "style": "deepObject" }, "network_details": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "amount": { "description": "Amount (in cents) to be transferred.", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users.", "maxLength": 5000, "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "financial_account": { "description": "The FinancialAccount to pull funds from.", "type": "string" }, "initiating_payment_method_details": { "description": "Initiating payment method details for the object.", "properties": { "type": { "description": "The source type.", "enum": [ "us_bank_account" ], "type": "string" }, "us_bank_account": { "description": "Optional fields for `us_bank_account`.", "properties": { "account_holder_name": { "description": "The bank account holder's name.", "maxLength": 5000, "type": "string" }, "account_number": { "description": "The bank account number.", "maxLength": 5000, "type": "string" }, "routing_number": { "description": "The bank account's routing number.", "maxLength": 5000, "type": "string" } }, "title": "us_bank_account_source_params", "type": "object", "x-stripeMostCommon": [ "account_holder_name", "account_number", "routing_number" ] } }, "required": [ "type" ], "title": "source_params", "type": "object", "x-stripeMostCommon": [ "type", "us_bank_account" ] }, "network": { "description": "Specifies the network rails to be used. If not set, will default to the PaymentMethod's preferred network. See the [docs](https://stripe.com/docs/treasury/money-movement/timelines) to learn more about money movement timelines for each network type.", "enum": [ "ach" ], "type": "string" }, "network_details": { "description": "Details about the network used for the ReceivedDebit.", "properties": { "ach": { "description": "Optional fields for `ach`.", "properties": { "addenda": { "description": "Addenda record data associated with this ReceivedDebit.", "maxLength": 5000, "type": "string" } }, "title": "ach_network_details_source", "type": "object", "x-stripeMostCommon": [ "addenda" ] }, "type": { "description": "The type of flow that originated the ReceivedDebit.", "enum": [ "ach" ], "type": "string" } }, "required": [ "type" ], "title": "network_details_source", "type": "object", "x-stripeMostCommon": [ "ach", "type" ] } }, "required": [ "amount", "currency", "financial_account", "network" ], "type": "object", "x-stripeMostCommon": [ "amount", "currency", "description", "financial_account", "initiating_payment_method_details", "network", "network_details" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/treasury.received_debit" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Test mode: Create a ReceivedDebit" } }, "/v1/tokens": { "post": { "description": "

Creates a single-use token that represents a bank account’s details.\nYou can use this token with any v1 API method in place of a bank account dictionary. You can only use this token once. To do so, attach it to a connected account where controller.requirement_collection is application, which includes Custom accounts.

", "operationId": "PostTokens", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "account": { "explode": true, "style": "deepObject" }, "bank_account": { "explode": true, "style": "deepObject" }, "card": { "explode": true, "style": "deepObject" }, "cvc_update": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "person": { "explode": true, "style": "deepObject" }, "pii": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "account": { "description": "Information for the account this token represents.", "properties": { "business_type": { "description": "The business type.", "enum": [ "company", "government_entity", "individual", "non_profit" ], "type": "string", "x-stripeBypassValidation": true }, "company": { "description": "Information about the company or business.", "properties": { "address": { "description": "The company's primary address.", "properties": { "city": { "description": "City, district, suburb, town, or village.", "maxLength": 100, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Address line 1 (e.g., street, PO Box, or company name).", "maxLength": 200, "type": "string" }, "line2": { "description": "Address line 2 (e.g., apartment, suite, unit, or building).", "maxLength": 200, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "State, county, province, or region.", "maxLength": 5000, "type": "string" } }, "title": "legal_entity_and_kyc_address_specs", "type": "object", "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state" ] }, "address_kana": { "description": "The Kana variation of the company's primary address (Japan only).", "properties": { "city": { "description": "City or ward.", "maxLength": 5000, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Block or building number.", "maxLength": 5000, "type": "string" }, "line2": { "description": "Building details.", "maxLength": 5000, "type": "string" }, "postal_code": { "description": "Postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "Prefecture.", "maxLength": 5000, "type": "string" }, "town": { "description": "Town or cho-me.", "maxLength": 5000, "type": "string" } }, "title": "japan_address_kana_specs", "type": "object", "x-stripeMostCommon": [ "city", "country", "db_code", "line1", "line2", "postal_code", "state", "town" ] }, "address_kanji": { "description": "The Kanji variation of the company's primary address (Japan only).", "properties": { "city": { "description": "City or ward.", "maxLength": 5000, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Block or building number.", "maxLength": 5000, "type": "string" }, "line2": { "description": "Building details.", "maxLength": 5000, "type": "string" }, "postal_code": { "description": "Postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "Prefecture.", "maxLength": 5000, "type": "string" }, "town": { "description": "Town or cho-me.", "maxLength": 5000, "type": "string" } }, "title": "japan_address_kanji_specs", "type": "object", "x-stripeMostCommon": [ "city", "country", "db_code", "line1", "line2", "postal_code", "state", "town" ] }, "directors_provided": { "description": "Whether the company's directors have been provided. Set this Boolean to `true` after creating all the company's directors with [the Persons API](/api/persons) for accounts with a `relationship.director` requirement. This value is not automatically set to `true` after creating directors, so it needs to be updated to indicate all directors have been provided.", "type": "boolean" }, "directorship_declaration": { "description": "This hash is used to attest that the directors information provided to Stripe is both current and correct.", "properties": { "date": { "description": "The Unix timestamp marking when the directorship declaration attestation was made.", "format": "unix-time", "type": "integer" }, "ip": { "description": "The IP address from which the directorship declaration attestation was made.", "type": "string" }, "user_agent": { "description": "The user agent of the browser from which the directorship declaration attestation was made.", "maxLength": 5000, "type": "string" } }, "title": "company_directorship_declaration", "type": "object", "x-stripeMostCommon": [ "date", "ip", "user_agent" ] }, "executives_provided": { "description": "Whether the company's executives have been provided. Set this Boolean to `true` after creating all the company's executives with [the Persons API](/api/persons) for accounts with a `relationship.executive` requirement.", "type": "boolean" }, "export_license_id": { "description": "The export license ID number of the company, also referred as Import Export Code (India only).", "maxLength": 5000, "type": "string" }, "export_purpose_code": { "description": "The purpose code to use for export transactions (India only).", "maxLength": 5000, "type": "string" }, "name": { "description": "The company's legal name.", "maxLength": 100, "type": "string" }, "name_kana": { "description": "The Kana variation of the company's legal name (Japan only).", "maxLength": 100, "type": "string" }, "name_kanji": { "description": "The Kanji variation of the company's legal name (Japan only).", "maxLength": 100, "type": "string" }, "owners_provided": { "description": "Whether the company's owners have been provided. Set this Boolean to `true` after creating all the company's owners with [the Persons API](/api/persons) for accounts with a `relationship.owner` requirement.", "type": "boolean" }, "ownership_declaration": { "description": "This hash is used to attest that the beneficial owner information provided to Stripe is both current and correct.", "properties": { "date": { "description": "The Unix timestamp marking when the beneficial owner attestation was made.", "format": "unix-time", "type": "integer" }, "ip": { "description": "The IP address from which the beneficial owner attestation was made.", "type": "string" }, "user_agent": { "description": "The user agent of the browser from which the beneficial owner attestation was made.", "maxLength": 5000, "type": "string" } }, "title": "company_ownership_declaration", "type": "object", "x-stripeMostCommon": [ "date", "ip", "user_agent" ] }, "ownership_declaration_shown_and_signed": { "description": "Whether the user described by the data in the token has been shown the Ownership Declaration and indicated that it is correct.", "type": "boolean" }, "ownership_exemption_reason": { "description": "This value is used to determine if a business is exempt from providing ultimate beneficial owners. See [this support article](https://support.stripe.com/questions/exemption-from-providing-ownership-details) and [changelog](https://docs.stripe.com/changelog/acacia/2025-01-27/ownership-exemption-reason-accounts-api) for more details.", "enum": [ "", "qualified_entity_exceeds_ownership_threshold", "qualifies_as_financial_institution" ], "type": "string" }, "phone": { "description": "The company's phone number (used for verification).", "maxLength": 5000, "type": "string" }, "registration_date": { "anyOf": [ { "properties": { "day": { "description": "The day of registration, between 1 and 31.", "type": "integer" }, "month": { "description": "The month of registration, between 1 and 12.", "type": "integer" }, "year": { "description": "The four-digit year of registration.", "type": "integer" } }, "required": [ "day", "month", "year" ], "title": "registration_date_specs", "type": "object", "x-stripeMostCommon": [ "day", "month", "year" ] }, { "enum": [ "" ], "type": "string" } ], "description": "When the business was incorporated or registered." }, "registration_number": { "description": "The identification number given to a company when it is registered or incorporated, if distinct from the identification number used for filing taxes. (Examples are the CIN for companies and LLP IN for partnerships in India, and the Company Registration Number in Hong Kong).", "maxLength": 5000, "type": "string" }, "structure": { "description": "The category identifying the legal structure of the company or legal entity. See [Business structure](/connect/identity-verification#business-structure) for more details. Pass an empty string to unset this value.", "enum": [ "", "free_zone_establishment", "free_zone_llc", "government_instrumentality", "governmental_unit", "incorporated_non_profit", "incorporated_partnership", "limited_liability_partnership", "llc", "multi_member_llc", "private_company", "private_corporation", "private_partnership", "public_company", "public_corporation", "public_partnership", "registered_charity", "single_member_llc", "sole_establishment", "sole_proprietorship", "tax_exempt_government_instrumentality", "unincorporated_association", "unincorporated_non_profit", "unincorporated_partnership" ], "type": "string", "x-stripeBypassValidation": true }, "tax_id": { "description": "The business ID number of the company, as appropriate for the company’s country. (Examples are an Employer ID Number in the U.S., a Business Number in Canada, or a Company Number in the UK.)", "maxLength": 5000, "type": "string" }, "tax_id_registrar": { "description": "The jurisdiction in which the `tax_id` is registered (Germany-based companies only).", "maxLength": 5000, "type": "string" }, "vat_id": { "description": "The VAT number of the company.", "maxLength": 5000, "type": "string" }, "verification": { "description": "Information on the verification state of the company.", "properties": { "document": { "description": "A document verifying the business.", "properties": { "back": { "description": "The back of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `additional_verification`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.", "maxLength": 500, "type": "string" }, "front": { "description": "The front of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `additional_verification`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.", "maxLength": 500, "type": "string" } }, "title": "verification_document_specs", "type": "object", "x-stripeMostCommon": [ "back", "front" ] } }, "title": "verification_specs", "type": "object", "x-stripeMostCommon": [ "document" ] } }, "title": "connect_js_account_token_company_specs", "type": "object", "x-stripeMostCommon": [ "address", "address_kana", "address_kanji", "contact_point_verification_address", "cross_border_transaction_classifications", "directors_provided", "directorship_declaration", "executives_provided", "export_license_id", "export_purpose_code", "fiscal_code", "invoicing_recipient_code", "name", "name_kana", "name_kanji", "owners_provided", "ownership_declaration", "ownership_declaration_shown_and_signed", "ownership_exemption_reason", "pan", "phone", "registered_email", "registration_date", "registration_number", "stock_data", "structure", "tax_deduction_account_number", "tax_id", "tax_id_registrar", "trust_owned", "vat_id", "vat_registration_status", "verification" ] }, "individual": { "description": "Information about the person represented by the account.", "properties": { "address": { "description": "The individual's primary address.", "properties": { "city": { "description": "City, district, suburb, town, or village.", "maxLength": 100, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Address line 1 (e.g., street, PO Box, or company name).", "maxLength": 200, "type": "string" }, "line2": { "description": "Address line 2 (e.g., apartment, suite, unit, or building).", "maxLength": 200, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "State, county, province, or region.", "maxLength": 5000, "type": "string" } }, "title": "address_specs", "type": "object", "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state" ] }, "address_kana": { "description": "The Kana variation of the individual's primary address (Japan only).", "properties": { "city": { "description": "City or ward.", "maxLength": 5000, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Block or building number.", "maxLength": 5000, "type": "string" }, "line2": { "description": "Building details.", "maxLength": 5000, "type": "string" }, "postal_code": { "description": "Postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "Prefecture.", "maxLength": 5000, "type": "string" }, "town": { "description": "Town or cho-me.", "maxLength": 5000, "type": "string" } }, "title": "japan_address_kana_specs", "type": "object", "x-stripeMostCommon": [ "city", "country", "db_code", "line1", "line2", "postal_code", "state", "town" ] }, "address_kanji": { "description": "The Kanji variation of the individual's primary address (Japan only).", "properties": { "city": { "description": "City or ward.", "maxLength": 5000, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Block or building number.", "maxLength": 5000, "type": "string" }, "line2": { "description": "Building details.", "maxLength": 5000, "type": "string" }, "postal_code": { "description": "Postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "Prefecture.", "maxLength": 5000, "type": "string" }, "town": { "description": "Town or cho-me.", "maxLength": 5000, "type": "string" } }, "title": "japan_address_kanji_specs", "type": "object", "x-stripeMostCommon": [ "city", "country", "db_code", "line1", "line2", "postal_code", "state", "town" ] }, "dob": { "anyOf": [ { "properties": { "day": { "description": "The day of birth, between 1 and 31.", "type": "integer" }, "month": { "description": "The month of birth, between 1 and 12.", "type": "integer" }, "year": { "description": "The four-digit year of birth.", "type": "integer" } }, "required": [ "day", "month", "year" ], "title": "date_of_birth_specs", "type": "object", "x-stripeMostCommon": [ "day", "month", "year" ] }, { "enum": [ "" ], "type": "string" } ], "description": "The individual's date of birth." }, "email": { "description": "The individual's email address.", "type": "string" }, "first_name": { "description": "The individual's first name.", "maxLength": 100, "type": "string" }, "first_name_kana": { "description": "The Kana variation of the individual's first name (Japan only).", "maxLength": 5000, "type": "string" }, "first_name_kanji": { "description": "The Kanji variation of the individual's first name (Japan only).", "maxLength": 5000, "type": "string" }, "full_name_aliases": { "anyOf": [ { "items": { "maxLength": 300, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "A list of alternate names or aliases that the individual is known by." }, "gender": { "description": "The individual's gender", "type": "string" }, "id_number": { "description": "The government-issued ID number of the individual, as appropriate for the representative's country. (Examples are a Social Security Number in the U.S., or a Social Insurance Number in Canada). Instead of the number itself, you can also provide a [PII token created with Stripe.js](/js/tokens/create_token?type=pii).", "maxLength": 5000, "type": "string" }, "id_number_secondary": { "description": "The government-issued secondary ID number of the individual, as appropriate for the representative's country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token created with Stripe.js](/js/tokens/create_token?type=pii).", "maxLength": 5000, "type": "string" }, "last_name": { "description": "The individual's last name.", "maxLength": 100, "type": "string" }, "last_name_kana": { "description": "The Kana variation of the individual's last name (Japan only).", "maxLength": 5000, "type": "string" }, "last_name_kanji": { "description": "The Kanji variation of the individual's last name (Japan only).", "maxLength": 5000, "type": "string" }, "maiden_name": { "description": "The individual's maiden name.", "maxLength": 5000, "type": "string" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "phone": { "description": "The individual's phone number.", "type": "string" }, "political_exposure": { "description": "Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction.", "enum": [ "existing", "none" ], "type": "string" }, "registered_address": { "description": "The individual's registered address.", "properties": { "city": { "description": "City, district, suburb, town, or village.", "maxLength": 100, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Address line 1 (e.g., street, PO Box, or company name).", "maxLength": 200, "type": "string" }, "line2": { "description": "Address line 2 (e.g., apartment, suite, unit, or building).", "maxLength": 200, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "State, county, province, or region.", "maxLength": 5000, "type": "string" } }, "title": "address_specs", "type": "object", "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state" ] }, "relationship": { "description": "Describes the person’s relationship to the account.", "properties": { "director": { "description": "Whether the person is a director of the account's legal entity. Directors are typically members of the governing board of the company, or responsible for ensuring the company meets its regulatory obligations.", "type": "boolean" }, "executive": { "description": "Whether the person has significant responsibility to control, manage, or direct the organization.", "type": "boolean" }, "owner": { "description": "Whether the person is an owner of the account’s legal entity.", "type": "boolean" }, "percent_ownership": { "anyOf": [ { "type": "number" }, { "enum": [ "" ], "type": "string" } ], "description": "The percent owned by the person of the account's legal entity." }, "title": { "description": "The person's title (e.g., CEO, Support Engineer).", "maxLength": 5000, "type": "string" } }, "title": "individual_relationship_specs", "type": "object", "x-stripeMostCommon": [ "controller", "director", "executive", "officer", "owner", "partner", "percent_ownership", "title" ] }, "ssn_last_4": { "description": "The last four digits of the individual's Social Security Number (U.S. only).", "maxLength": 5000, "type": "string" }, "verification": { "description": "The individual's verification document information.", "properties": { "additional_document": { "description": "A document showing address, either a passport, local ID card, or utility bill from a well-known utility company.", "properties": { "back": { "description": "The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.", "maxLength": 500, "type": "string" }, "front": { "description": "The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.", "maxLength": 500, "type": "string" } }, "title": "person_verification_document_specs", "type": "object", "x-stripeMostCommon": [ "back", "electronic_id", "front" ] }, "document": { "description": "An identifying document, either a passport or local ID card.", "properties": { "back": { "description": "The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.", "maxLength": 500, "type": "string" }, "front": { "description": "The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.", "maxLength": 500, "type": "string" } }, "title": "person_verification_document_specs", "type": "object", "x-stripeMostCommon": [ "back", "electronic_id", "front" ] } }, "title": "person_verification_specs", "type": "object", "x-stripeMostCommon": [ "additional_document", "document", "proof_of_liveness" ] } }, "title": "individual_specs", "type": "object", "x-stripeMostCommon": [ "address", "address_kana", "address_kanji", "birth_city", "birth_country", "dob", "email", "first_name", "first_name_kana", "first_name_kanji", "full_name_aliases", "gender", "id_number", "id_number_secondary", "last_name", "last_name_kana", "last_name_kanji", "maiden_name", "metadata", "phone", "political_exposure", "registered_address", "relationship", "ssn_last_4", "verification" ] }, "tos_shown_and_accepted": { "description": "Whether the user described by the data in the token has been shown [the Stripe Connected Account Agreement](/connect/account-tokens#stripe-connected-account-agreement). When creating an account token to create a new Connect account, this value must be `true`.", "type": "boolean" } }, "title": "connect_js_account_token_specs", "type": "object", "x-stripeMostCommon": [ "business_type", "company", "individual", "tos_shown_and_accepted" ] }, "bank_account": { "description": "The bank account this token will represent.", "properties": { "account_holder_name": { "description": "The name of the person or business that owns the bank account. This field is required when attaching the bank account to a `Customer` object.", "maxLength": 5000, "type": "string" }, "account_holder_type": { "description": "The type of entity that holds the account. It can be `company` or `individual`. This field is required when attaching the bank account to a `Customer` object.", "enum": [ "company", "individual" ], "maxLength": 5000, "type": "string" }, "account_number": { "description": "The account number for the bank account, in string form. Must be a checking account.", "maxLength": 5000, "type": "string" }, "account_type": { "description": "The bank account type. This can only be `checking` or `savings` in most countries. In Japan, this can only be `futsu` or `toza`.", "enum": [ "checking", "futsu", "savings", "toza" ], "maxLength": 5000, "type": "string" }, "country": { "description": "The country in which the bank account is located.", "maxLength": 5000, "type": "string" }, "currency": { "description": "The currency the bank account is in. This must be a country/currency pairing that [Stripe supports.](https://stripe.com/docs/payouts)", "format": "currency", "type": "string" }, "payment_method": { "description": "The ID of a Payment Method with a `type` of `us_bank_account`. The Payment Method's bank account information will be copied and returned as a Bank Account Token. This parameter is exclusive with respect to all other parameters in the `bank_account` hash. You must include the top-level `customer` parameter if the Payment Method is attached to a `Customer` object. If the Payment Method is not attached to a `Customer` object, it will be consumed and cannot be used again. You may not use Payment Methods which were created by a Setup Intent with `attach_to_self=true`.", "maxLength": 5000, "type": "string" }, "routing_number": { "description": "The routing number, sort code, or other country-appropriate institution number for the bank account. For US bank accounts, this is required and should be the ACH routing number, not the wire routing number. If you are providing an IBAN for `account_number`, this field is not required.", "maxLength": 5000, "type": "string" } }, "required": [ "account_number", "country" ], "title": "token_create_bank_account", "type": "object", "x-stripeBypassValidation": true, "x-stripeMostCommon": [ "account_holder_name", "account_holder_type", "account_number", "account_type", "country", "currency", "debit_agreement_shown_and_accepted", "debit_agreement_type", "payment_method", "routing_number" ] }, "card": { "anyOf": [ { "properties": { "address_city": { "description": "City / District / Suburb / Town / Village.", "maxLength": 5000, "type": "string" }, "address_country": { "description": "Billing address country, if provided.", "maxLength": 5000, "type": "string" }, "address_line1": { "description": "Address line 1 (Street address / PO Box / Company name).", "maxLength": 5000, "type": "string" }, "address_line2": { "description": "Address line 2 (Apartment / Suite / Unit / Building).", "maxLength": 5000, "type": "string" }, "address_state": { "description": "State / County / Province / Region.", "maxLength": 5000, "type": "string" }, "address_zip": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "currency": { "description": "Required in order to add the card to an account; in all other cases, this parameter is not used. When added to an account, the card (which must be a debit card) can be used as a transfer destination for funds in this currency.", "maxLength": 5000, "type": "string" }, "cvc": { "description": "Card security code. Highly recommended to always include this value.", "maxLength": 5000, "type": "string" }, "exp_month": { "description": "Two-digit number representing the card's expiration month.", "maxLength": 5000, "type": "string" }, "exp_year": { "description": "Two- or four-digit number representing the card's expiration year.", "maxLength": 5000, "type": "string" }, "name": { "description": "Cardholder's full name.", "maxLength": 5000, "type": "string" }, "networks": { "description": "Contains information about card networks used to process the payment.", "properties": { "preferred": { "description": "The customer's preferred card network for co-branded cards. Supports `cartes_bancaires`, `mastercard`, or `visa`. Selection of a network that does not apply to the card will be stored as `invalid_preference` on the card.", "enum": [ "cartes_bancaires", "mastercard", "visa" ], "type": "string" } }, "title": "networks_param_specs", "type": "object", "x-stripeMostCommon": [ "preferred" ] }, "number": { "description": "The card number, as a string without any separators.", "maxLength": 5000, "type": "string" } }, "required": [ "exp_month", "exp_year", "number" ], "title": "credit_card_specs", "type": "object", "x-stripeMostCommon": [ "address_city", "address_country", "address_line1", "address_line2", "address_state", "address_zip", "currency", "cvc", "exp_month", "exp_year", "name", "networks", "number" ], "x-stripeParam": { "class_name": "Card" } }, { "maxLength": 5000, "type": "string" } ], "description": "The card this token will represent. If you also pass in a customer, the card must be the ID of a card belonging to the customer. Otherwise, if you do not pass in a customer, this is a dictionary containing a user's credit card details, with the options described below.", "x-stripeBypassValidation": true }, "customer": { "description": "Create a token for the customer, which is owned by the application's account. You can only use this with an [OAuth access token](https://stripe.com/docs/connect/standard-accounts) or [Stripe-Account header](https://stripe.com/docs/connect/authentication). Learn more about [cloning saved payment methods](https://stripe.com/docs/connect/cloning-saved-payment-methods).", "maxLength": 5000, "type": "string" }, "cvc_update": { "description": "The updated CVC value this token represents.", "properties": { "cvc": { "description": "The CVC value, in string form.", "maxLength": 5000, "type": "string" } }, "required": [ "cvc" ], "title": "cvc_params", "type": "object", "x-stripeMostCommon": [ "cvc" ] }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "person": { "description": "Information for the person this token represents.", "properties": { "additional_tos_acceptances": { "description": "Details on the legal guardian's or authorizer's acceptance of the required Stripe agreements.", "properties": { "account": { "description": "Details on the legal guardian's acceptance of the main Stripe service agreement.", "properties": { "date": { "description": "The Unix timestamp marking when the account representative accepted the service agreement.", "format": "unix-time", "type": "integer" }, "ip": { "description": "The IP address from which the account representative accepted the service agreement.", "type": "string" }, "user_agent": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "The user agent of the browser from which the account representative accepted the service agreement." } }, "title": "settings_terms_of_service_specs", "type": "object", "x-stripeMostCommon": [ "date", "ip", "user_agent" ] } }, "title": "person_additional_tos_acceptances_specs", "type": "object", "x-stripeMostCommon": [ "account", "representative" ] }, "address": { "description": "The person's address.", "properties": { "city": { "description": "City, district, suburb, town, or village.", "maxLength": 100, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Address line 1 (e.g., street, PO Box, or company name).", "maxLength": 200, "type": "string" }, "line2": { "description": "Address line 2 (e.g., apartment, suite, unit, or building).", "maxLength": 200, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "State, county, province, or region.", "maxLength": 5000, "type": "string" } }, "title": "legal_entity_and_kyc_address_specs", "type": "object", "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state" ] }, "address_kana": { "description": "The Kana variation of the person's address (Japan only).", "properties": { "city": { "description": "City or ward.", "maxLength": 5000, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Block or building number.", "maxLength": 5000, "type": "string" }, "line2": { "description": "Building details.", "maxLength": 5000, "type": "string" }, "postal_code": { "description": "Postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "Prefecture.", "maxLength": 5000, "type": "string" }, "town": { "description": "Town or cho-me.", "maxLength": 5000, "type": "string" } }, "title": "japan_address_kana_specs", "type": "object", "x-stripeMostCommon": [ "city", "country", "db_code", "line1", "line2", "postal_code", "state", "town" ] }, "address_kanji": { "description": "The Kanji variation of the person's address (Japan only).", "properties": { "city": { "description": "City or ward.", "maxLength": 5000, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Block or building number.", "maxLength": 5000, "type": "string" }, "line2": { "description": "Building details.", "maxLength": 5000, "type": "string" }, "postal_code": { "description": "Postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "Prefecture.", "maxLength": 5000, "type": "string" }, "town": { "description": "Town or cho-me.", "maxLength": 5000, "type": "string" } }, "title": "japan_address_kanji_specs", "type": "object", "x-stripeMostCommon": [ "city", "country", "db_code", "line1", "line2", "postal_code", "state", "town" ] }, "dob": { "anyOf": [ { "properties": { "day": { "description": "The day of birth, between 1 and 31.", "type": "integer" }, "month": { "description": "The month of birth, between 1 and 12.", "type": "integer" }, "year": { "description": "The four-digit year of birth.", "type": "integer" } }, "required": [ "day", "month", "year" ], "title": "date_of_birth_specs", "type": "object", "x-stripeMostCommon": [ "day", "month", "year" ] }, { "enum": [ "" ], "type": "string" } ], "description": "The person's date of birth." }, "documents": { "description": "Documents that may be submitted to satisfy various informational requests.", "properties": { "company_authorization": { "description": "One or more documents that demonstrate proof that this person is authorized to represent the company.", "properties": { "files": { "description": "One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.", "items": { "anyOf": [ { "maxLength": 500, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "type": "array" } }, "title": "documents_param", "type": "object", "x-stripeMostCommon": [ "files" ] }, "passport": { "description": "One or more documents showing the person's passport page with photo and personal data.", "properties": { "files": { "description": "One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.", "items": { "anyOf": [ { "maxLength": 500, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "type": "array" } }, "title": "documents_param", "type": "object", "x-stripeMostCommon": [ "files" ] }, "visa": { "description": "One or more documents showing the person's visa required for living in the country where they are residing.", "properties": { "files": { "description": "One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.", "items": { "anyOf": [ { "maxLength": 500, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "type": "array" } }, "title": "documents_param", "type": "object", "x-stripeMostCommon": [ "files" ] } }, "title": "person_documents_specs", "type": "object", "x-stripeMostCommon": [ "DASHBOARD_proof_of_liveness", "company_authorization", "passport", "visa" ] }, "email": { "description": "The person's email address.", "type": "string" }, "first_name": { "description": "The person's first name.", "maxLength": 5000, "type": "string" }, "first_name_kana": { "description": "The Kana variation of the person's first name (Japan only).", "maxLength": 5000, "type": "string" }, "first_name_kanji": { "description": "The Kanji variation of the person's first name (Japan only).", "maxLength": 5000, "type": "string" }, "full_name_aliases": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "A list of alternate names or aliases that the person is known by." }, "gender": { "description": "The person's gender (International regulations require either \"male\" or \"female\").", "type": "string" }, "id_number": { "description": "The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii).", "maxLength": 5000, "type": "string" }, "id_number_secondary": { "description": "The person's secondary ID number, as appropriate for their country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii).", "maxLength": 5000, "type": "string" }, "last_name": { "description": "The person's last name.", "maxLength": 5000, "type": "string" }, "last_name_kana": { "description": "The Kana variation of the person's last name (Japan only).", "maxLength": 5000, "type": "string" }, "last_name_kanji": { "description": "The Kanji variation of the person's last name (Japan only).", "maxLength": 5000, "type": "string" }, "maiden_name": { "description": "The person's maiden name.", "maxLength": 5000, "type": "string" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "nationality": { "description": "The country where the person is a national. Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)), or \"XX\" if unavailable.", "maxLength": 5000, "type": "string" }, "phone": { "description": "The person's phone number.", "type": "string" }, "political_exposure": { "description": "Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction.", "enum": [ "existing", "none" ], "type": "string" }, "registered_address": { "description": "The person's registered address.", "properties": { "city": { "description": "City, district, suburb, town, or village.", "maxLength": 100, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Address line 1 (e.g., street, PO Box, or company name).", "maxLength": 200, "type": "string" }, "line2": { "description": "Address line 2 (e.g., apartment, suite, unit, or building).", "maxLength": 200, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "State, county, province, or region.", "maxLength": 5000, "type": "string" } }, "title": "address_specs", "type": "object", "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state" ] }, "relationship": { "description": "The relationship that this person has with the account's legal entity.", "properties": { "authorizer": { "description": "Whether the person is the authorizer of the account's representative.", "type": "boolean" }, "director": { "description": "Whether the person is a director of the account's legal entity. Directors are typically members of the governing board of the company, or responsible for ensuring the company meets its regulatory obligations.", "type": "boolean" }, "executive": { "description": "Whether the person has significant responsibility to control, manage, or direct the organization.", "type": "boolean" }, "legal_guardian": { "description": "Whether the person is the legal guardian of the account's representative.", "type": "boolean" }, "owner": { "description": "Whether the person is an owner of the account’s legal entity.", "type": "boolean" }, "percent_ownership": { "anyOf": [ { "type": "number" }, { "enum": [ "" ], "type": "string" } ], "description": "The percent owned by the person of the account's legal entity." }, "representative": { "description": "Whether the person is authorized as the primary representative of the account. This is the person nominated by the business to provide information about themselves, and general information about the account. There can only be one representative at any given time. At the time the account is created, this person should be set to the person responsible for opening the account.", "type": "boolean" }, "title": { "description": "The person's title (e.g., CEO, Support Engineer).", "maxLength": 5000, "type": "string" } }, "title": "relationship_specs", "type": "object", "x-stripeMostCommon": [ "authorizer", "controller", "director", "executive", "legal_guardian", "officer", "owner", "partner", "percent_ownership", "representative", "title" ] }, "ssn_last_4": { "description": "The last four digits of the person's Social Security number (U.S. only).", "type": "string" }, "us_cfpb_data": { "description": "Demographic data related to the person.", "properties": { "ethnicity_details": { "description": "The persons ethnicity details", "properties": { "ethnicity": { "description": "The persons ethnicity", "items": { "enum": [ "cuban", "hispanic_or_latino", "mexican", "not_hispanic_or_latino", "other_hispanic_or_latino", "prefer_not_to_answer", "puerto_rican" ], "type": "string" }, "type": "array" }, "ethnicity_other": { "description": "Please specify your origin, when other is selected.", "maxLength": 5000, "type": "string" } }, "title": "us_cfpb_ethnicity_details_specs", "type": "object", "x-stripeMostCommon": [ "ethnicity", "ethnicity_other" ] }, "race_details": { "description": "The persons race details", "properties": { "race": { "description": "The persons race.", "items": { "enum": [ "african_american", "american_indian_or_alaska_native", "asian", "asian_indian", "black_or_african_american", "chinese", "ethiopian", "filipino", "guamanian_or_chamorro", "haitian", "jamaican", "japanese", "korean", "native_hawaiian", "native_hawaiian_or_other_pacific_islander", "nigerian", "other_asian", "other_black_or_african_american", "other_pacific_islander", "prefer_not_to_answer", "samoan", "somali", "vietnamese", "white" ], "type": "string" }, "type": "array" }, "race_other": { "description": "Please specify your race, when other is selected.", "maxLength": 5000, "type": "string" } }, "title": "us_cfpb_race_details_specs", "type": "object", "x-stripeMostCommon": [ "race", "race_other" ] }, "self_identified_gender": { "description": "The persons self-identified gender", "maxLength": 5000, "type": "string" } }, "title": "us_cfpb_data_specs", "type": "object", "x-stripeMostCommon": [ "ethnicity_details", "race_details", "self_identified_gender" ] }, "verification": { "description": "The person's verification status.", "properties": { "additional_document": { "description": "A document showing address, either a passport, local ID card, or utility bill from a well-known utility company.", "properties": { "back": { "description": "The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.", "maxLength": 500, "type": "string" }, "front": { "description": "The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.", "maxLength": 500, "type": "string" } }, "title": "person_verification_document_specs", "type": "object", "x-stripeMostCommon": [ "back", "electronic_id", "front" ] }, "document": { "description": "An identifying document, either a passport or local ID card.", "properties": { "back": { "description": "The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.", "maxLength": 500, "type": "string" }, "front": { "description": "The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.", "maxLength": 500, "type": "string" } }, "title": "person_verification_document_specs", "type": "object", "x-stripeMostCommon": [ "back", "electronic_id", "front" ] } }, "title": "person_verification_specs", "type": "object", "x-stripeMostCommon": [ "additional_document", "document", "proof_of_liveness" ] } }, "title": "person_token_specs", "type": "object", "x-stripeMostCommon": [ "address", "dob", "email", "first_name", "id_number", "last_name", "metadata", "phone", "relationship", "ssn_last_4" ] }, "pii": { "description": "The PII this token represents.", "properties": { "id_number": { "description": "The `id_number` for the PII, in string form.", "maxLength": 5000, "type": "string" } }, "title": "pii_token_specs", "type": "object", "x-stripeMostCommon": [ "id_number" ] } }, "type": "object", "x-stripeMostCommon": [ "account", "bank_account", "card", "cvc_update", "person", "pii" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/token" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a CVC update token" } }, "/v1/tokens/{token}": { "get": { "description": "

Retrieves the token with the given ID.

", "operationId": "GetTokensToken", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "token", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/token" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a token" } }, "/v1/topups": { "get": { "description": "

Returns a list of top-ups.

", "operationId": "GetTopups", "parameters": [ { "description": "A positive integer representing how much to transfer.", "explode": true, "in": "query", "name": "amount", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "description": "Minimum value to filter by (exclusive)", "type": "integer" }, "gte": { "description": "Minimum value to filter by (inclusive)", "type": "integer" }, "lt": { "description": "Maximum value to filter by (exclusive)", "type": "integer" }, "lte": { "description": "Maximum value to filter by (inclusive)", "type": "integer" } }, "title": "range_query_specs", "type": "object", "x-stripeMostCommon": [ "gt", "gte", "lt", "lte" ] }, { "type": "integer" } ] }, "style": "deepObject" }, { "description": "A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.", "explode": true, "in": "query", "name": "created", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "description": "Minimum value to filter by (exclusive)", "type": "integer" }, "gte": { "description": "Minimum value to filter by (inclusive)", "type": "integer" }, "lt": { "description": "Maximum value to filter by (exclusive)", "type": "integer" }, "lte": { "description": "Maximum value to filter by (inclusive)", "type": "integer" } }, "title": "range_query_specs", "type": "object", "x-stripeMostCommon": [ "gt", "gte", "lt", "lte" ] }, { "type": "integer" } ] }, "style": "deepObject" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Only return top-ups that have the given status. One of `canceled`, `failed`, `pending` or `succeeded`.", "in": "query", "name": "status", "required": false, "schema": { "enum": [ "canceled", "failed", "pending", "succeeded" ], "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/topup" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/topups", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "TopupList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all top-ups" }, "post": { "description": "

Top up the balance of an account

", "operationId": "PostTopups", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "amount": { "description": "A positive integer representing how much to transfer.", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "type": "string" }, "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users.", "maxLength": 5000, "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "source": { "description": "The ID of a source to transfer funds from. For most users, this should be left unspecified which will use the bank account that was set up in the dashboard for the specified currency. In test mode, this can be a test bank token (see [Testing Top-ups](https://stripe.com/docs/connect/testing#testing-top-ups)).", "maxLength": 5000, "type": "string" }, "statement_descriptor": { "description": "Extra information about a top-up for the source's bank statement. Limited to 15 ASCII characters.", "maxLength": 15, "type": "string" }, "transfer_group": { "description": "A string that identifies this top-up as part of a group.", "type": "string" } }, "required": [ "amount", "currency" ], "type": "object", "x-stripeMostCommon": [ "amount", "currency", "description", "metadata" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/topup" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a top-up" } }, "/v1/topups/{topup}": { "get": { "description": "

Retrieves the details of a top-up that has previously been created. Supply the unique top-up ID that was returned from your previous request, and Stripe will return the corresponding top-up information.

", "operationId": "GetTopupsTopup", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "topup", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/topup" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a top-up" }, "post": { "description": "

Updates the metadata of a top-up. Other top-up details are not editable by design.

", "operationId": "PostTopupsTopup", "parameters": [ { "in": "path", "name": "topup", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users.", "maxLength": 5000, "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." } }, "type": "object", "x-stripeMostCommon": [ "description", "metadata" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/topup" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a top-up" } }, "/v1/topups/{topup}/cancel": { "post": { "description": "

Cancels a top-up. Only pending top-ups can be canceled.

", "operationId": "PostTopupsTopupCancel", "parameters": [ { "in": "path", "name": "topup", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/topup" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Cancel a top-up" } }, "/v1/transfers": { "get": { "description": "

Returns a list of existing transfers sent to connected accounts. The transfers are returned in sorted order, with the most recently created transfers appearing first.

", "operationId": "GetTransfers", "parameters": [ { "description": "Only return transfers that were created during the given date interval.", "explode": true, "in": "query", "name": "created", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "description": "Minimum value to filter by (exclusive)", "type": "integer" }, "gte": { "description": "Minimum value to filter by (inclusive)", "type": "integer" }, "lt": { "description": "Maximum value to filter by (exclusive)", "type": "integer" }, "lte": { "description": "Maximum value to filter by (inclusive)", "type": "integer" } }, "title": "range_query_specs", "type": "object", "x-stripeMostCommon": [ "gt", "gte", "lt", "lte" ] }, { "type": "integer" } ] }, "style": "deepObject" }, { "description": "Only return transfers for the destination specified by this account ID.", "in": "query", "name": "destination", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Only return transfers with the specified transfer group.", "in": "query", "name": "transfer_group", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/transfer" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/transfers", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "TransferList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all transfers" }, "post": { "description": "

To send funds from your Stripe account to a connected account, you create a new transfer object. Your Stripe balance must be able to cover the transfer amount, or you’ll receive an “Insufficient Funds” error.

", "operationId": "PostTransfers", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "amount": { "description": "A positive integer in cents (or local equivalent) representing how much to transfer.", "type": "integer" }, "currency": { "description": "Three-letter [ISO code for currency](https://www.iso.org/iso-4217-currency-codes.html) in lowercase. Must be a [supported currency](https://docs.stripe.com/currencies).", "format": "currency", "type": "string" }, "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users.", "maxLength": 5000, "type": "string" }, "destination": { "description": "The ID of a connected Stripe account. See the Connect documentation for details.", "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "fx_quote": { "description": "The FX rate in the quote is validated and used to convert the transfer amount to the destination currency.", "maxLength": 5000, "type": "string" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "source_transaction": { "description": "You can use this parameter to transfer funds from a charge before they are added to your available balance. A pending balance will transfer immediately but the funds will not become available until the original charge becomes available. [See the Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-availability) for details.", "type": "string" }, "source_type": { "description": "The source balance to use for this transfer. One of `bank_account`, `card`, or `fpx`. For most users, this will default to `card`.", "enum": [ "bank_account", "card", "fpx" ], "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true }, "transfer_group": { "description": "A string that identifies this transaction as part of a group. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) for details.", "type": "string" } }, "required": [ "currency", "destination" ], "type": "object", "x-stripeMostCommon": [ "amount", "currency", "description", "destination", "metadata" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/transfer" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a transfer" } }, "/v1/transfers/{id}/reversals": { "get": { "description": "

You can see a list of the reversals belonging to a specific transfer. Note that the 10 most recent reversals are always available by default on the transfer object. If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional reversals.

", "operationId": "GetTransfersIdReversals", "parameters": [ { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/transfer_reversal" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "TransferReversalList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all reversals" }, "post": { "description": "

When you create a new reversal, you must specify a transfer to create it on.

\n\n

When reversing transfers, you can optionally reverse part of the transfer. You can do so as many times as you wish until the entire transfer has been reversed.

\n\n

Once entirely reversed, a transfer can’t be reversed again. This method will return an error when called on an already-reversed transfer, or when trying to reverse more money than is left on a transfer.

", "operationId": "PostTransfersIdReversals", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "amount": { "description": "A positive integer in cents (or local equivalent) representing how much of this transfer to reverse. Can only reverse up to the unreversed amount remaining of the transfer. Partial transfer reversals are only allowed for transfers to Stripe Accounts. Defaults to the entire transfer amount.", "type": "integer" }, "description": { "description": "An arbitrary string which you can attach to a reversal object. This will be unset if you POST an empty value.", "maxLength": 5000, "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "refund_application_fee": { "description": "Boolean indicating whether the application fee should be refunded when reversing this transfer. If a full transfer reversal is given, the full application fee will be refunded. Otherwise, the application fee will be refunded with an amount proportional to the amount of the transfer reversed.", "type": "boolean" } }, "type": "object", "x-stripeMostCommon": [ "amount", "description", "metadata" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/transfer_reversal" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a transfer reversal" } }, "/v1/transfers/{transfer}": { "get": { "description": "

Retrieves the details of an existing transfer. Supply the unique transfer ID from either a transfer creation request or the transfer list, and Stripe will return the corresponding transfer information.

", "operationId": "GetTransfersTransfer", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "transfer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/transfer" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a transfer" }, "post": { "description": "

Updates the specified transfer by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

\n\n

This request accepts only metadata as an argument.

", "operationId": "PostTransfersTransfer", "parameters": [ { "in": "path", "name": "transfer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users.", "maxLength": 5000, "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." } }, "type": "object", "x-stripeMostCommon": [ "description", "metadata" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/transfer" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a transfer" } }, "/v1/transfers/{transfer}/reversals/{id}": { "get": { "description": "

By default, you can see the 10 most recent reversals stored directly on the transfer object, but you can also retrieve details about a specific reversal stored on the transfer.

", "operationId": "GetTransfersTransferReversalsId", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "in": "path", "name": "transfer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/transfer_reversal" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a reversal" }, "post": { "description": "

Updates the specified reversal by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

\n\n

This request only accepts metadata and description as arguments.

", "operationId": "PostTransfersTransferReversalsId", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "in": "path", "name": "transfer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." } }, "type": "object", "x-stripeMostCommon": [ "metadata" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/transfer_reversal" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a reversal" } }, "/v1/treasury/credit_reversals": { "get": { "description": "

Returns a list of CreditReversals.

", "operationId": "GetTreasuryCreditReversals", "parameters": [ { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "Returns objects associated with this FinancialAccount.", "in": "query", "name": "financial_account", "required": true, "schema": { "type": "string" }, "style": "form" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "Only return CreditReversals for the ReceivedCredit ID.", "in": "query", "name": "received_credit", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Only return CreditReversals for a given status.", "in": "query", "name": "status", "required": false, "schema": { "enum": [ "canceled", "posted", "processing" ], "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/treasury.credit_reversal" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "TreasuryReceivedCreditsResourceCreditReversalList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all CreditReversals" }, "post": { "description": "

Reverses a ReceivedCredit and creates a CreditReversal object.

", "operationId": "PostTreasuryCreditReversals", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "received_credit": { "description": "The ReceivedCredit to reverse.", "maxLength": 5000, "type": "string" } }, "required": [ "received_credit" ], "type": "object", "x-stripeMostCommon": [ "metadata", "received_credit" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/treasury.credit_reversal" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a CreditReversal" } }, "/v1/treasury/credit_reversals/{credit_reversal}": { "get": { "description": "

Retrieves the details of an existing CreditReversal by passing the unique CreditReversal ID from either the CreditReversal creation request or CreditReversal list

", "operationId": "GetTreasuryCreditReversalsCreditReversal", "parameters": [ { "in": "path", "name": "credit_reversal", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/treasury.credit_reversal" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a CreditReversal" } }, "/v1/treasury/debit_reversals": { "get": { "description": "

Returns a list of DebitReversals.

", "operationId": "GetTreasuryDebitReversals", "parameters": [ { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "Returns objects associated with this FinancialAccount.", "in": "query", "name": "financial_account", "required": true, "schema": { "type": "string" }, "style": "form" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "Only return DebitReversals for the ReceivedDebit ID.", "in": "query", "name": "received_debit", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Only return DebitReversals for a given resolution.", "in": "query", "name": "resolution", "required": false, "schema": { "enum": [ "lost", "won" ], "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Only return DebitReversals for a given status.", "in": "query", "name": "status", "required": false, "schema": { "enum": [ "canceled", "completed", "processing" ], "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/treasury.debit_reversal" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "TreasuryReceivedDebitsResourceDebitReversalList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all DebitReversals" }, "post": { "description": "

Reverses a ReceivedDebit and creates a DebitReversal object.

", "operationId": "PostTreasuryDebitReversals", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "received_debit": { "description": "The ReceivedDebit to reverse.", "maxLength": 5000, "type": "string" } }, "required": [ "received_debit" ], "type": "object", "x-stripeMostCommon": [ "metadata", "received_debit" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/treasury.debit_reversal" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a DebitReversal" } }, "/v1/treasury/debit_reversals/{debit_reversal}": { "get": { "description": "

Retrieves a DebitReversal object.

", "operationId": "GetTreasuryDebitReversalsDebitReversal", "parameters": [ { "in": "path", "name": "debit_reversal", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/treasury.debit_reversal" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a DebitReversal" } }, "/v1/treasury/financial_accounts": { "get": { "description": "

Returns a list of FinancialAccounts.

", "operationId": "GetTreasuryFinancialAccounts", "parameters": [ { "description": "Only return FinancialAccounts that were created during the given date interval.", "explode": true, "in": "query", "name": "created", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "description": "Minimum value to filter by (exclusive)", "type": "integer" }, "gte": { "description": "Minimum value to filter by (inclusive)", "type": "integer" }, "lt": { "description": "Maximum value to filter by (exclusive)", "type": "integer" }, "lte": { "description": "Maximum value to filter by (inclusive)", "type": "integer" } }, "title": "range_query_specs", "type": "object", "x-stripeMostCommon": [ "gt", "gte", "lt", "lte" ] }, { "type": "integer" } ] }, "style": "deepObject" }, { "description": "An object ID cursor for use in pagination.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit ranging from 1 to 100 (defaults to 10).", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "An object ID cursor for use in pagination.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Only return FinancialAccounts that have the given status: `open` or `closed`", "in": "query", "name": "status", "required": false, "schema": { "enum": [ "closed", "open" ], "type": "string", "x-stripeBypassValidation": true }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/treasury.financial_account" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/treasury/financial_accounts", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "TreasuryFinancialAccountsResourceFinancialAccountList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all FinancialAccounts" }, "post": { "description": "

Creates a new FinancialAccount. Each connected account can have up to three FinancialAccounts by default.

", "operationId": "PostTreasuryFinancialAccounts", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "display_name": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "features": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "nickname": { "explode": true, "style": "deepObject" }, "platform_restrictions": { "explode": true, "style": "deepObject" }, "supported_currencies": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "display_name": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "The display name for the FinancialAccount. Use this field to customize the names of the FinancialAccounts for your connected accounts. Unlike the `nickname` field, `display_name` is not internal metadata and will be exposed to connected accounts." }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "features": { "description": "Encodes whether a FinancialAccount has access to a particular feature. Stripe or the platform can control features via the requested field.", "properties": { "card_issuing": { "description": "Encodes the FinancialAccount's ability to be used with the Issuing product, including attaching cards to and drawing funds from the FinancialAccount.", "properties": { "requested": { "description": "Whether the FinancialAccount should have the Feature.", "type": "boolean" } }, "required": [ "requested" ], "title": "access", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "deposit_insurance": { "description": "Represents whether this FinancialAccount is eligible for deposit insurance. Various factors determine the insurance amount.", "properties": { "requested": { "description": "Whether the FinancialAccount should have the Feature.", "type": "boolean" } }, "required": [ "requested" ], "title": "access", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "financial_addresses": { "description": "Contains Features that add FinancialAddresses to the FinancialAccount.", "properties": { "aba": { "description": "Adds an ABA FinancialAddress to the FinancialAccount.", "properties": { "bank": { "description": "Requested bank partner", "enum": [ "evolve", "fifth_third", "goldman_sachs" ], "type": "string" }, "requested": { "description": "Whether the FinancialAccount should have the Feature.", "type": "boolean" } }, "required": [ "requested" ], "title": "aba_access", "type": "object", "x-stripeMostCommon": [ "bank", "forwarding", "requested" ] } }, "title": "financial_addresses", "type": "object", "x-stripeMostCommon": [ "aba" ] }, "inbound_transfers": { "description": "Contains settings related to adding funds to a FinancialAccount from another Account with the same owner.", "properties": { "ach": { "description": "Enables ACH Debits via the InboundTransfers API.", "properties": { "requested": { "description": "Whether the FinancialAccount should have the Feature.", "type": "boolean" } }, "required": [ "requested" ], "title": "access_with_ach_details", "type": "object", "x-stripeMostCommon": [ "platform_review", "requested", "same_day" ] } }, "title": "inbound_transfers", "type": "object", "x-stripeMostCommon": [ "ach", "us_check" ] }, "intra_stripe_flows": { "description": "Represents the ability for the FinancialAccount to send money to, or receive money from other FinancialAccounts (for example, via OutboundPayment).", "properties": { "requested": { "description": "Whether the FinancialAccount should have the Feature.", "type": "boolean" } }, "required": [ "requested" ], "title": "access", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "outbound_payments": { "description": "Includes Features related to initiating money movement out of the FinancialAccount to someone else's bucket of money.", "properties": { "ach": { "description": "Enables ACH transfers via the OutboundPayments API.", "properties": { "requested": { "description": "Whether the FinancialAccount should have the Feature.", "type": "boolean" } }, "required": [ "requested" ], "title": "access_with_ach_details", "type": "object", "x-stripeMostCommon": [ "platform_review", "requested", "same_day" ] }, "us_domestic_wire": { "description": "Enables US domestic wire transfers via the OutboundPayments API.", "properties": { "requested": { "description": "Whether the FinancialAccount should have the Feature.", "type": "boolean" } }, "required": [ "requested" ], "title": "access", "type": "object", "x-stripeMostCommon": [ "requested" ] } }, "title": "outbound_payments", "type": "object", "x-stripeMostCommon": [ "ach", "us_check", "us_domestic_wire" ] }, "outbound_transfers": { "description": "Contains a Feature and settings related to moving money out of the FinancialAccount into another Account with the same owner.", "properties": { "ach": { "description": "Enables ACH transfers via the OutboundTransfers API.", "properties": { "requested": { "description": "Whether the FinancialAccount should have the Feature.", "type": "boolean" } }, "required": [ "requested" ], "title": "access_with_ach_details", "type": "object", "x-stripeMostCommon": [ "platform_review", "requested", "same_day" ] }, "us_domestic_wire": { "description": "Enables US domestic wire transfers via the OutboundTransfers API.", "properties": { "requested": { "description": "Whether the FinancialAccount should have the Feature.", "type": "boolean" } }, "required": [ "requested" ], "title": "access", "type": "object", "x-stripeMostCommon": [ "requested" ] } }, "title": "outbound_transfers", "type": "object", "x-stripeMostCommon": [ "ach", "us_domestic_wire" ] } }, "title": "feature_access", "type": "object", "x-stripeMostCommon": [ "card_issuing", "deposit_insurance", "financial_addresses", "inbound_transfers", "intra_stripe_flows", "outbound_payments", "outbound_transfers" ] }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "nickname": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "The nickname for the FinancialAccount." }, "platform_restrictions": { "description": "The set of functionalities that the platform can restrict on the FinancialAccount.", "properties": { "inbound_flows": { "description": "Restricts all inbound money movement.", "enum": [ "restricted", "unrestricted" ], "type": "string" }, "outbound_flows": { "description": "Restricts all outbound money movement.", "enum": [ "restricted", "unrestricted" ], "type": "string" } }, "title": "platform_restrictions", "type": "object", "x-stripeMostCommon": [ "inbound_flows", "outbound_flows", "received_credits", "received_debits" ] }, "supported_currencies": { "description": "The currencies the FinancialAccount can hold a balance in.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "required": [ "supported_currencies" ], "type": "object", "x-stripeMostCommon": [ "display_name", "features", "metadata", "nickname", "platform_restrictions", "supported_currencies" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/treasury.financial_account" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a FinancialAccount" } }, "/v1/treasury/financial_accounts/{financial_account}": { "get": { "description": "

Retrieves the details of a FinancialAccount.

", "operationId": "GetTreasuryFinancialAccountsFinancialAccount", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "financial_account", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/treasury.financial_account" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a FinancialAccount" }, "post": { "description": "

Updates the details of a FinancialAccount.

", "operationId": "PostTreasuryFinancialAccountsFinancialAccount", "parameters": [ { "in": "path", "name": "financial_account", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "display_name": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "features": { "explode": true, "style": "deepObject" }, "forwarding_settings": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "nickname": { "explode": true, "style": "deepObject" }, "platform_restrictions": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "display_name": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "The display name for the FinancialAccount. Use this field to customize the names of the FinancialAccounts for your connected accounts. Unlike the `nickname` field, `display_name` is not internal metadata and will be exposed to connected accounts." }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "features": { "description": "Encodes whether a FinancialAccount has access to a particular feature, with a status enum and associated `status_details`. Stripe or the platform may control features via the requested field.", "properties": { "card_issuing": { "description": "Encodes the FinancialAccount's ability to be used with the Issuing product, including attaching cards to and drawing funds from the FinancialAccount.", "properties": { "requested": { "description": "Whether the FinancialAccount should have the Feature.", "type": "boolean" } }, "required": [ "requested" ], "title": "access", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "deposit_insurance": { "description": "Represents whether this FinancialAccount is eligible for deposit insurance. Various factors determine the insurance amount.", "properties": { "requested": { "description": "Whether the FinancialAccount should have the Feature.", "type": "boolean" } }, "required": [ "requested" ], "title": "access", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "financial_addresses": { "description": "Contains Features that add FinancialAddresses to the FinancialAccount.", "properties": { "aba": { "description": "Adds an ABA FinancialAddress to the FinancialAccount.", "properties": { "bank": { "description": "Requested bank partner", "enum": [ "evolve", "fifth_third", "goldman_sachs" ], "type": "string" }, "requested": { "description": "Whether the FinancialAccount should have the Feature.", "type": "boolean" } }, "required": [ "requested" ], "title": "aba_access", "type": "object", "x-stripeMostCommon": [ "bank", "forwarding", "requested" ] } }, "title": "financial_addresses", "type": "object", "x-stripeMostCommon": [ "aba" ] }, "inbound_transfers": { "description": "Contains settings related to adding funds to a FinancialAccount from another Account with the same owner.", "properties": { "ach": { "description": "Enables ACH Debits via the InboundTransfers API.", "properties": { "requested": { "description": "Whether the FinancialAccount should have the Feature.", "type": "boolean" } }, "required": [ "requested" ], "title": "access_with_ach_details", "type": "object", "x-stripeMostCommon": [ "platform_review", "requested", "same_day" ] } }, "title": "inbound_transfers", "type": "object", "x-stripeMostCommon": [ "ach", "us_check" ] }, "intra_stripe_flows": { "description": "Represents the ability for the FinancialAccount to send money to, or receive money from other FinancialAccounts (for example, via OutboundPayment).", "properties": { "requested": { "description": "Whether the FinancialAccount should have the Feature.", "type": "boolean" } }, "required": [ "requested" ], "title": "access", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "outbound_payments": { "description": "Includes Features related to initiating money movement out of the FinancialAccount to someone else's bucket of money.", "properties": { "ach": { "description": "Enables ACH transfers via the OutboundPayments API.", "properties": { "requested": { "description": "Whether the FinancialAccount should have the Feature.", "type": "boolean" } }, "required": [ "requested" ], "title": "access_with_ach_details", "type": "object", "x-stripeMostCommon": [ "platform_review", "requested", "same_day" ] }, "us_domestic_wire": { "description": "Enables US domestic wire transfers via the OutboundPayments API.", "properties": { "requested": { "description": "Whether the FinancialAccount should have the Feature.", "type": "boolean" } }, "required": [ "requested" ], "title": "access", "type": "object", "x-stripeMostCommon": [ "requested" ] } }, "title": "outbound_payments", "type": "object", "x-stripeMostCommon": [ "ach", "us_check", "us_domestic_wire" ] }, "outbound_transfers": { "description": "Contains a Feature and settings related to moving money out of the FinancialAccount into another Account with the same owner.", "properties": { "ach": { "description": "Enables ACH transfers via the OutboundTransfers API.", "properties": { "requested": { "description": "Whether the FinancialAccount should have the Feature.", "type": "boolean" } }, "required": [ "requested" ], "title": "access_with_ach_details", "type": "object", "x-stripeMostCommon": [ "platform_review", "requested", "same_day" ] }, "us_domestic_wire": { "description": "Enables US domestic wire transfers via the OutboundTransfers API.", "properties": { "requested": { "description": "Whether the FinancialAccount should have the Feature.", "type": "boolean" } }, "required": [ "requested" ], "title": "access", "type": "object", "x-stripeMostCommon": [ "requested" ] } }, "title": "outbound_transfers", "type": "object", "x-stripeMostCommon": [ "ach", "us_domestic_wire" ] } }, "title": "feature_access", "type": "object", "x-stripeMostCommon": [ "card_issuing", "deposit_insurance", "financial_addresses", "inbound_transfers", "intra_stripe_flows", "outbound_payments", "outbound_transfers" ] }, "forwarding_settings": { "description": "A different bank account where funds can be deposited/debited in order to get the closing FA's balance to $0", "properties": { "financial_account": { "description": "The financial_account id", "type": "string" }, "payment_method": { "description": "The payment_method or bank account id. This needs to be a verified bank account.", "maxLength": 5000, "type": "string" }, "type": { "description": "The type of the bank account provided. This can be either \"financial_account\" or \"payment_method\"", "enum": [ "financial_account", "payment_method" ], "type": "string" } }, "required": [ "type" ], "title": "forwarding_settings", "type": "object", "x-stripeMostCommon": [ "financial_account", "payment_method", "type" ] }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "nickname": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "The nickname for the FinancialAccount." }, "platform_restrictions": { "description": "The set of functionalities that the platform can restrict on the FinancialAccount.", "properties": { "inbound_flows": { "description": "Restricts all inbound money movement.", "enum": [ "restricted", "unrestricted" ], "type": "string" }, "outbound_flows": { "description": "Restricts all outbound money movement.", "enum": [ "restricted", "unrestricted" ], "type": "string" } }, "title": "platform_restrictions", "type": "object", "x-stripeMostCommon": [ "inbound_flows", "outbound_flows", "received_credits", "received_debits" ] } }, "type": "object", "x-stripeMostCommon": [ "display_name", "features", "forwarding_settings", "metadata", "nickname", "platform_restrictions" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/treasury.financial_account" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a FinancialAccount" } }, "/v1/treasury/financial_accounts/{financial_account}/close": { "post": { "description": "

Closes a FinancialAccount. A FinancialAccount can only be closed if it has a zero balance, has no pending InboundTransfers, and has canceled all attached Issuing cards.

", "operationId": "PostTreasuryFinancialAccountsFinancialAccountClose", "parameters": [ { "in": "path", "name": "financial_account", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "forwarding_settings": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "forwarding_settings": { "description": "A different bank account where funds can be deposited/debited in order to get the closing FA's balance to $0", "properties": { "financial_account": { "description": "The financial_account id", "type": "string" }, "payment_method": { "description": "The payment_method or bank account id. This needs to be a verified bank account.", "maxLength": 5000, "type": "string" }, "type": { "description": "The type of the bank account provided. This can be either \"financial_account\" or \"payment_method\"", "enum": [ "financial_account", "payment_method" ], "type": "string" } }, "required": [ "type" ], "title": "forwarding_settings", "type": "object", "x-stripeMostCommon": [ "financial_account", "payment_method", "type" ] } }, "type": "object", "x-stripeMostCommon": [ "forwarding_settings" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/treasury.financial_account" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Close a FinancialAccount" } }, "/v1/treasury/financial_accounts/{financial_account}/features": { "get": { "description": "

Retrieves Features information associated with the FinancialAccount.

", "operationId": "GetTreasuryFinancialAccountsFinancialAccountFeatures", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "financial_account", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/treasury.financial_account_features" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve FinancialAccount Features" }, "post": { "description": "

Updates the Features associated with a FinancialAccount.

", "operationId": "PostTreasuryFinancialAccountsFinancialAccountFeatures", "parameters": [ { "in": "path", "name": "financial_account", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "card_issuing": { "explode": true, "style": "deepObject" }, "deposit_insurance": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "financial_addresses": { "explode": true, "style": "deepObject" }, "inbound_transfers": { "explode": true, "style": "deepObject" }, "intra_stripe_flows": { "explode": true, "style": "deepObject" }, "outbound_payments": { "explode": true, "style": "deepObject" }, "outbound_transfers": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "card_issuing": { "description": "Encodes the FinancialAccount's ability to be used with the Issuing product, including attaching cards to and drawing funds from the FinancialAccount.", "properties": { "requested": { "description": "Whether the FinancialAccount should have the Feature.", "type": "boolean" } }, "required": [ "requested" ], "title": "access", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "deposit_insurance": { "description": "Represents whether this FinancialAccount is eligible for deposit insurance. Various factors determine the insurance amount.", "properties": { "requested": { "description": "Whether the FinancialAccount should have the Feature.", "type": "boolean" } }, "required": [ "requested" ], "title": "access", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "financial_addresses": { "description": "Contains Features that add FinancialAddresses to the FinancialAccount.", "properties": { "aba": { "description": "Adds an ABA FinancialAddress to the FinancialAccount.", "properties": { "bank": { "description": "Requested bank partner", "enum": [ "evolve", "fifth_third", "goldman_sachs" ], "type": "string" }, "requested": { "description": "Whether the FinancialAccount should have the Feature.", "type": "boolean" } }, "required": [ "requested" ], "title": "aba_access", "type": "object", "x-stripeMostCommon": [ "bank", "forwarding", "requested" ] } }, "title": "financial_addresses", "type": "object", "x-stripeMostCommon": [ "aba" ] }, "inbound_transfers": { "description": "Contains settings related to adding funds to a FinancialAccount from another Account with the same owner.", "properties": { "ach": { "description": "Enables ACH Debits via the InboundTransfers API.", "properties": { "requested": { "description": "Whether the FinancialAccount should have the Feature.", "type": "boolean" } }, "required": [ "requested" ], "title": "access_with_ach_details", "type": "object", "x-stripeMostCommon": [ "platform_review", "requested", "same_day" ] } }, "title": "inbound_transfers", "type": "object", "x-stripeMostCommon": [ "ach", "us_check" ] }, "intra_stripe_flows": { "description": "Represents the ability for the FinancialAccount to send money to, or receive money from other FinancialAccounts (for example, via OutboundPayment).", "properties": { "requested": { "description": "Whether the FinancialAccount should have the Feature.", "type": "boolean" } }, "required": [ "requested" ], "title": "access", "type": "object", "x-stripeMostCommon": [ "requested" ] }, "outbound_payments": { "description": "Includes Features related to initiating money movement out of the FinancialAccount to someone else's bucket of money.", "properties": { "ach": { "description": "Enables ACH transfers via the OutboundPayments API.", "properties": { "requested": { "description": "Whether the FinancialAccount should have the Feature.", "type": "boolean" } }, "required": [ "requested" ], "title": "access_with_ach_details", "type": "object", "x-stripeMostCommon": [ "platform_review", "requested", "same_day" ] }, "us_domestic_wire": { "description": "Enables US domestic wire transfers via the OutboundPayments API.", "properties": { "requested": { "description": "Whether the FinancialAccount should have the Feature.", "type": "boolean" } }, "required": [ "requested" ], "title": "access", "type": "object", "x-stripeMostCommon": [ "requested" ] } }, "title": "outbound_payments", "type": "object", "x-stripeMostCommon": [ "ach", "us_check", "us_domestic_wire" ] }, "outbound_transfers": { "description": "Contains a Feature and settings related to moving money out of the FinancialAccount into another Account with the same owner.", "properties": { "ach": { "description": "Enables ACH transfers via the OutboundTransfers API.", "properties": { "requested": { "description": "Whether the FinancialAccount should have the Feature.", "type": "boolean" } }, "required": [ "requested" ], "title": "access_with_ach_details", "type": "object", "x-stripeMostCommon": [ "platform_review", "requested", "same_day" ] }, "us_domestic_wire": { "description": "Enables US domestic wire transfers via the OutboundTransfers API.", "properties": { "requested": { "description": "Whether the FinancialAccount should have the Feature.", "type": "boolean" } }, "required": [ "requested" ], "title": "access", "type": "object", "x-stripeMostCommon": [ "requested" ] } }, "title": "outbound_transfers", "type": "object", "x-stripeMostCommon": [ "ach", "us_domestic_wire" ] } }, "type": "object", "x-stripeMostCommon": [ "card_issuing", "deposit_insurance", "financial_addresses", "inbound_transfers", "intra_stripe_flows", "outbound_payments", "outbound_transfers" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/treasury.financial_account_features" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update FinancialAccount Features" } }, "/v1/treasury/inbound_transfers": { "get": { "description": "

Returns a list of InboundTransfers sent from the specified FinancialAccount.

", "operationId": "GetTreasuryInboundTransfers", "parameters": [ { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "Returns objects associated with this FinancialAccount.", "in": "query", "name": "financial_account", "required": true, "schema": { "type": "string" }, "style": "form" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Only return InboundTransfers that have the given status: `processing`, `succeeded`, `failed` or `canceled`.", "in": "query", "name": "status", "required": false, "schema": { "enum": [ "canceled", "failed", "processing", "succeeded" ], "type": "string", "x-stripeBypassValidation": true }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/treasury.inbound_transfer" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "TreasuryInboundTransfersResourceInboundTransferList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all InboundTransfers" }, "post": { "description": "

Creates an InboundTransfer.

", "operationId": "PostTreasuryInboundTransfers", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "amount": { "description": "Amount (in cents) to be transferred.", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users.", "maxLength": 5000, "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "financial_account": { "description": "The FinancialAccount to send funds to.", "type": "string" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "origin_payment_method": { "description": "The origin payment method to be debited for the InboundTransfer.", "maxLength": 5000, "type": "string" }, "statement_descriptor": { "description": "The complete description that appears on your customers' statements. Maximum 10 characters.", "maxLength": 10, "type": "string" } }, "required": [ "amount", "currency", "financial_account", "origin_payment_method" ], "type": "object", "x-stripeMostCommon": [ "amount", "currency", "description", "financial_account", "metadata", "origin_payment_method", "statement_descriptor" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/treasury.inbound_transfer" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create an InboundTransfer" } }, "/v1/treasury/inbound_transfers/{id}": { "get": { "description": "

Retrieves the details of an existing InboundTransfer.

", "operationId": "GetTreasuryInboundTransfersId", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/treasury.inbound_transfer" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve an InboundTransfer" } }, "/v1/treasury/inbound_transfers/{inbound_transfer}/cancel": { "post": { "description": "

Cancels an InboundTransfer.

", "operationId": "PostTreasuryInboundTransfersInboundTransferCancel", "parameters": [ { "in": "path", "name": "inbound_transfer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/treasury.inbound_transfer" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Cancel an InboundTransfer" } }, "/v1/treasury/outbound_payments": { "get": { "description": "

Returns a list of OutboundPayments sent from the specified FinancialAccount.

", "operationId": "GetTreasuryOutboundPayments", "parameters": [ { "description": "Only return OutboundPayments that were created during the given date interval.", "explode": true, "in": "query", "name": "created", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "description": "Minimum value to filter by (exclusive)", "type": "integer" }, "gte": { "description": "Minimum value to filter by (inclusive)", "type": "integer" }, "lt": { "description": "Maximum value to filter by (exclusive)", "type": "integer" }, "lte": { "description": "Maximum value to filter by (inclusive)", "type": "integer" } }, "title": "range_query_specs", "type": "object", "x-stripeMostCommon": [ "gt", "gte", "lt", "lte" ] }, { "type": "integer" } ] }, "style": "deepObject" }, { "description": "Only return OutboundPayments sent to this customer.", "in": "query", "name": "customer", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "Returns objects associated with this FinancialAccount.", "in": "query", "name": "financial_account", "required": true, "schema": { "type": "string" }, "style": "form" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Only return OutboundPayments that have the given status: `processing`, `failed`, `posted`, `returned`, or `canceled`.", "in": "query", "name": "status", "required": false, "schema": { "enum": [ "canceled", "failed", "posted", "processing", "returned" ], "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/treasury.outbound_payment" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/treasury/outbound_payments", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "TreasuryOutboundPaymentsResourceOutboundPaymentList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all OutboundPayments" }, "post": { "description": "

Creates an OutboundPayment.

", "operationId": "PostTreasuryOutboundPayments", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "destination_payment_method_data": { "explode": true, "style": "deepObject" }, "destination_payment_method_options": { "explode": true, "style": "deepObject" }, "end_user_details": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "amount": { "description": "Amount (in cents) to be transferred.", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "customer": { "description": "ID of the customer to whom the OutboundPayment is sent. Must match the Customer attached to the `destination_payment_method` passed in.", "maxLength": 5000, "type": "string" }, "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users.", "maxLength": 5000, "type": "string" }, "destination_payment_method": { "description": "The PaymentMethod to use as the payment instrument for the OutboundPayment. Exclusive with `destination_payment_method_data`.", "maxLength": 5000, "type": "string" }, "destination_payment_method_data": { "description": "Hash used to generate the PaymentMethod to be used for this OutboundPayment. Exclusive with `destination_payment_method`.", "properties": { "billing_details": { "description": "Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.", "properties": { "address": { "anyOf": [ { "properties": { "city": { "description": "City, district, suburb, town, or village.", "maxLength": 5000, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Address line 1 (e.g., street, PO Box, or company name).", "maxLength": 5000, "type": "string" }, "line2": { "description": "Address line 2 (e.g., apartment, suite, unit, or building).", "maxLength": 5000, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "state": { "description": "State, county, province, or region.", "maxLength": 5000, "type": "string" } }, "title": "billing_details_address", "type": "object", "x-stripeMostCommon": [ "city", "country", "line1", "line2", "postal_code", "state" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Billing address." }, "email": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Email address." }, "name": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Full name." }, "phone": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Billing phone number (including extension)." } }, "title": "billing_details_inner_params", "type": "object", "x-stripeMostCommon": [ "address", "email", "name", "phone" ] }, "financial_account": { "description": "Required if type is set to `financial_account`. The FinancialAccount ID to send funds to.", "type": "string" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "type": { "description": "The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.", "enum": [ "financial_account", "us_bank_account" ], "type": "string", "x-stripeBypassValidation": true }, "us_bank_account": { "description": "Required hash if type is set to `us_bank_account`.", "properties": { "account_holder_type": { "description": "Account holder type: individual or company.", "enum": [ "company", "individual" ], "type": "string" }, "account_number": { "description": "Account number of the bank account.", "maxLength": 5000, "type": "string" }, "account_type": { "description": "Account type: checkings or savings. Defaults to checking if omitted.", "enum": [ "checking", "savings" ], "type": "string" }, "financial_connections_account": { "description": "The ID of a Financial Connections Account to use as a payment method.", "maxLength": 5000, "type": "string" }, "routing_number": { "description": "Routing number of the bank account.", "maxLength": 5000, "type": "string" } }, "title": "payment_method_param", "type": "object", "x-stripeMostCommon": [ "account_holder_type", "account_number", "account_type", "financial_connections_account", "routing_number" ] } }, "required": [ "type" ], "title": "payment_method_data", "type": "object", "x-stripeMostCommon": [ "billing_details", "metadata", "type" ] }, "destination_payment_method_options": { "description": "Payment method-specific configuration for this OutboundPayment.", "properties": { "us_bank_account": { "anyOf": [ { "properties": { "network": { "description": "Specifies the network rails to be used. If not set, will default to the PaymentMethod's preferred network. See the [docs](https://stripe.com/docs/treasury/money-movement/timelines) to learn more about money movement timelines for each network type.", "enum": [ "ach", "us_domestic_wire" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "ach", "network" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Optional fields for `us_bank_account`." } }, "title": "payment_method_options", "type": "object", "x-stripeMostCommon": [ "us_bank_account" ] }, "end_user_details": { "description": "End user details.", "properties": { "ip_address": { "description": "IP address of the user initiating the OutboundPayment. Must be supplied if `present` is set to `true`.", "type": "string" }, "present": { "description": "`True` if the OutboundPayment creation request is being made on behalf of an end user by a platform. Otherwise, `false`.", "type": "boolean" } }, "required": [ "present" ], "title": "end_user_details_params", "type": "object", "x-stripeMostCommon": [ "ip_address", "present" ] }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "financial_account": { "description": "The FinancialAccount to pull funds from.", "type": "string" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "statement_descriptor": { "description": "The description that appears on the receiving end for this OutboundPayment (for example, bank statement for external bank transfer). Maximum 10 characters for `ach` payments, 140 characters for `us_domestic_wire` payments, or 500 characters for `stripe` network transfers. The default value is \"payment\".", "maxLength": 5000, "type": "string" } }, "required": [ "amount", "currency", "financial_account" ], "type": "object", "x-stripeMostCommon": [ "amount", "currency", "customer", "description", "destination_payment_method", "destination_payment_method_data", "destination_payment_method_options", "end_user_details", "financial_account", "metadata", "statement_descriptor" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/treasury.outbound_payment" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create an OutboundPayment" } }, "/v1/treasury/outbound_payments/{id}": { "get": { "description": "

Retrieves the details of an existing OutboundPayment by passing the unique OutboundPayment ID from either the OutboundPayment creation request or OutboundPayment list.

", "operationId": "GetTreasuryOutboundPaymentsId", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/treasury.outbound_payment" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve an OutboundPayment" } }, "/v1/treasury/outbound_payments/{id}/cancel": { "post": { "description": "

Cancel an OutboundPayment.

", "operationId": "PostTreasuryOutboundPaymentsIdCancel", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/treasury.outbound_payment" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Cancel an OutboundPayment" } }, "/v1/treasury/outbound_transfers": { "get": { "description": "

Returns a list of OutboundTransfers sent from the specified FinancialAccount.

", "operationId": "GetTreasuryOutboundTransfers", "parameters": [ { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "Returns objects associated with this FinancialAccount.", "in": "query", "name": "financial_account", "required": true, "schema": { "type": "string" }, "style": "form" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Only return OutboundTransfers that have the given status: `processing`, `canceled`, `failed`, `posted`, or `returned`.", "in": "query", "name": "status", "required": false, "schema": { "enum": [ "canceled", "failed", "posted", "processing", "returned" ], "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/treasury.outbound_transfer" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "TreasuryOutboundTransfersResourceOutboundTransferList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all OutboundTransfers" }, "post": { "description": "

Creates an OutboundTransfer.

", "operationId": "PostTreasuryOutboundTransfers", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "destination_payment_method_data": { "explode": true, "style": "deepObject" }, "destination_payment_method_options": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "network_details": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "amount": { "description": "Amount (in cents) to be transferred.", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users.", "maxLength": 5000, "type": "string" }, "destination_payment_method": { "description": "The PaymentMethod to use as the payment instrument for the OutboundTransfer.", "maxLength": 5000, "type": "string" }, "destination_payment_method_data": { "description": "Hash used to generate the PaymentMethod to be used for this OutboundTransfer. Exclusive with `destination_payment_method`.", "properties": { "financial_account": { "description": "Required if type is set to `financial_account`. The FinancialAccount ID to send funds to.", "type": "string" }, "type": { "description": "The type of the destination.", "enum": [ "financial_account" ], "type": "string" } }, "required": [ "type" ], "title": "payment_method_data", "type": "object", "x-stripeMostCommon": [ "type" ] }, "destination_payment_method_options": { "description": "Hash describing payment method configuration details.", "properties": { "us_bank_account": { "anyOf": [ { "properties": { "network": { "description": "Specifies the network rails to be used. If not set, will default to the PaymentMethod's preferred network. See the [docs](https://stripe.com/docs/treasury/money-movement/timelines) to learn more about money movement timelines for each network type.", "enum": [ "ach", "us_domestic_wire" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object", "x-stripeMostCommon": [ "ach", "network" ] }, { "enum": [ "" ], "type": "string" } ], "description": "Optional fields for `us_bank_account`." } }, "title": "payment_method_options", "type": "object", "x-stripeMostCommon": [ "us_bank_account" ] }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "financial_account": { "description": "The FinancialAccount to pull funds from.", "type": "string" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "network_details": { "description": "Details about the network used for the OutboundTransfer.", "properties": { "ach": { "description": "Optional fields for `ach`.", "properties": { "addenda": { "description": "Addenda record data associated with this OutboundTransfer.", "maxLength": 5000, "type": "string" } }, "title": "ach_network_details_source", "type": "object", "x-stripeMostCommon": [ "addenda" ] }, "type": { "description": "The type of flow that originated the OutboundTransfer.", "enum": [ "ach" ], "type": "string" } }, "required": [ "type" ], "title": "network_details_source", "type": "object", "x-stripeMostCommon": [ "ach", "type" ] }, "statement_descriptor": { "description": "Statement descriptor to be shown on the receiving end of an OutboundTransfer. Maximum 10 characters for `ach` transfers or 140 characters for `us_domestic_wire` transfers. The default value is \"transfer\".", "maxLength": 5000, "type": "string" } }, "required": [ "amount", "currency", "financial_account" ], "type": "object", "x-stripeMostCommon": [ "amount", "currency", "description", "destination_payment_method", "destination_payment_method_data", "destination_payment_method_options", "financial_account", "metadata", "network_details", "statement_descriptor" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/treasury.outbound_transfer" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create an OutboundTransfer" } }, "/v1/treasury/outbound_transfers/{outbound_transfer}": { "get": { "description": "

Retrieves the details of an existing OutboundTransfer by passing the unique OutboundTransfer ID from either the OutboundTransfer creation request or OutboundTransfer list.

", "operationId": "GetTreasuryOutboundTransfersOutboundTransfer", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "outbound_transfer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/treasury.outbound_transfer" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve an OutboundTransfer" } }, "/v1/treasury/outbound_transfers/{outbound_transfer}/cancel": { "post": { "description": "

An OutboundTransfer can be canceled if the funds have not yet been paid out.

", "operationId": "PostTreasuryOutboundTransfersOutboundTransferCancel", "parameters": [ { "in": "path", "name": "outbound_transfer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/treasury.outbound_transfer" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Cancel an OutboundTransfer" } }, "/v1/treasury/received_credits": { "get": { "description": "

Returns a list of ReceivedCredits.

", "operationId": "GetTreasuryReceivedCredits", "parameters": [ { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "The FinancialAccount that received the funds.", "in": "query", "name": "financial_account", "required": true, "schema": { "type": "string" }, "style": "form" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "Only return ReceivedCredits described by the flow.", "explode": true, "in": "query", "name": "linked_flows", "required": false, "schema": { "properties": { "source_flow_type": { "description": "The source flow type.", "enum": [ "credit_reversal", "other", "outbound_payment", "outbound_transfer", "payout" ], "type": "string" } }, "required": [ "source_flow_type" ], "title": "linked_flows_param", "type": "object", "x-stripeMostCommon": [ "source_flow_type" ] }, "style": "deepObject" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Only return ReceivedCredits that have the given status: `succeeded` or `failed`.", "in": "query", "name": "status", "required": false, "schema": { "enum": [ "failed", "succeeded" ], "type": "string", "x-stripeBypassValidation": true }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/treasury.received_credit" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "TreasuryReceivedCreditsResourceReceivedCreditList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all ReceivedCredits" } }, "/v1/treasury/received_credits/{id}": { "get": { "description": "

Retrieves the details of an existing ReceivedCredit by passing the unique ReceivedCredit ID from the ReceivedCredit list.

", "operationId": "GetTreasuryReceivedCreditsId", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/treasury.received_credit" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a ReceivedCredit" } }, "/v1/treasury/received_debits": { "get": { "description": "

Returns a list of ReceivedDebits.

", "operationId": "GetTreasuryReceivedDebits", "parameters": [ { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "The FinancialAccount that funds were pulled from.", "in": "query", "name": "financial_account", "required": true, "schema": { "type": "string" }, "style": "form" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Only return ReceivedDebits that have the given status: `succeeded` or `failed`.", "in": "query", "name": "status", "required": false, "schema": { "enum": [ "failed", "succeeded" ], "type": "string", "x-stripeBypassValidation": true }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/treasury.received_debit" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "TreasuryReceivedDebitsResourceReceivedDebitList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all ReceivedDebits" } }, "/v1/treasury/received_debits/{id}": { "get": { "description": "

Retrieves the details of an existing ReceivedDebit by passing the unique ReceivedDebit ID from the ReceivedDebit list

", "operationId": "GetTreasuryReceivedDebitsId", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/treasury.received_debit" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a ReceivedDebit" } }, "/v1/treasury/transaction_entries": { "get": { "description": "

Retrieves a list of TransactionEntry objects.

", "operationId": "GetTreasuryTransactionEntries", "parameters": [ { "description": "Only return TransactionEntries that were created during the given date interval.", "explode": true, "in": "query", "name": "created", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "description": "Minimum value to filter by (exclusive)", "type": "integer" }, "gte": { "description": "Minimum value to filter by (inclusive)", "type": "integer" }, "lt": { "description": "Maximum value to filter by (exclusive)", "type": "integer" }, "lte": { "description": "Maximum value to filter by (inclusive)", "type": "integer" } }, "title": "range_query_specs", "type": "object", "x-stripeMostCommon": [ "gt", "gte", "lt", "lte" ] }, { "type": "integer" } ] }, "style": "deepObject" }, { "explode": true, "in": "query", "name": "effective_at", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "description": "Minimum value to filter by (exclusive)", "type": "integer" }, "gte": { "description": "Minimum value to filter by (inclusive)", "type": "integer" }, "lt": { "description": "Maximum value to filter by (exclusive)", "type": "integer" }, "lte": { "description": "Maximum value to filter by (inclusive)", "type": "integer" } }, "title": "range_query_specs", "type": "object", "x-stripeMostCommon": [ "gt", "gte", "lt", "lte" ] }, { "type": "integer" } ] }, "style": "deepObject" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "Returns objects associated with this FinancialAccount.", "in": "query", "name": "financial_account", "required": true, "schema": { "type": "string" }, "style": "form" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "The results are in reverse chronological order by `created` or `effective_at`. The default is `created`.", "in": "query", "name": "order_by", "required": false, "schema": { "enum": [ "created", "effective_at" ], "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Only return TransactionEntries associated with this Transaction.", "in": "query", "name": "transaction", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/treasury.transaction_entry" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/treasury/transaction_entries", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "TreasuryTransactionsResourceTransactionEntryList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all TransactionEntries" } }, "/v1/treasury/transaction_entries/{id}": { "get": { "description": "

Retrieves a TransactionEntry object.

", "operationId": "GetTreasuryTransactionEntriesId", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/treasury.transaction_entry" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a TransactionEntry" } }, "/v1/treasury/transactions": { "get": { "description": "

Retrieves a list of Transaction objects.

", "operationId": "GetTreasuryTransactions", "parameters": [ { "description": "Only return Transactions that were created during the given date interval.", "explode": true, "in": "query", "name": "created", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "description": "Minimum value to filter by (exclusive)", "type": "integer" }, "gte": { "description": "Minimum value to filter by (inclusive)", "type": "integer" }, "lt": { "description": "Maximum value to filter by (exclusive)", "type": "integer" }, "lte": { "description": "Maximum value to filter by (inclusive)", "type": "integer" } }, "title": "range_query_specs", "type": "object", "x-stripeMostCommon": [ "gt", "gte", "lt", "lte" ] }, { "type": "integer" } ] }, "style": "deepObject" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "Returns objects associated with this FinancialAccount.", "in": "query", "name": "financial_account", "required": true, "schema": { "type": "string" }, "style": "form" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "The results are in reverse chronological order by `created` or `posted_at`. The default is `created`.", "in": "query", "name": "order_by", "required": false, "schema": { "enum": [ "created", "posted_at" ], "type": "string", "x-stripeBypassValidation": true }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Only return Transactions that have the given status: `open`, `posted`, or `void`.", "in": "query", "name": "status", "required": false, "schema": { "enum": [ "open", "posted", "void" ], "type": "string" }, "style": "form" }, { "description": "A filter for the `status_transitions.posted_at` timestamp. When using this filter, `status=posted` and `order_by=posted_at` must also be specified.", "explode": true, "in": "query", "name": "status_transitions", "required": false, "schema": { "properties": { "posted_at": { "anyOf": [ { "properties": { "gt": { "description": "Minimum value to filter by (exclusive)", "type": "integer" }, "gte": { "description": "Minimum value to filter by (inclusive)", "type": "integer" }, "lt": { "description": "Maximum value to filter by (exclusive)", "type": "integer" }, "lte": { "description": "Maximum value to filter by (inclusive)", "type": "integer" } }, "title": "range_query_specs", "type": "object", "x-stripeMostCommon": [ "gt", "gte", "lt", "lte" ] }, { "type": "integer" } ], "description": "Returns Transactions with `posted_at` within the specified range." } }, "title": "status_transition_timestamp_specs", "type": "object", "x-stripeMostCommon": [ "posted_at" ] }, "style": "deepObject" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/treasury.transaction" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "TreasuryTransactionsResourceTransactionList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all Transactions" } }, "/v1/treasury/transactions/{id}": { "get": { "description": "

Retrieves the details of an existing Transaction.

", "operationId": "GetTreasuryTransactionsId", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/treasury.transaction" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a Transaction" } }, "/v1/webhook_endpoints": { "get": { "description": "

Returns a list of your webhook endpoints.

", "operationId": "GetWebhookEndpoints", "parameters": [ { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/webhook_endpoint" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/webhook_endpoints", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "NotificationWebhookEndpointList", "type": "object", "x-expandableFields": [ "data" ], "x-stripeMostCommon": [ "data", "has_more", "object", "url" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all webhook endpoints" }, "post": { "description": "

A webhook endpoint must have a url and a list of enabled_events. You may optionally specify the Boolean connect parameter. If set to true, then a Connect webhook endpoint that notifies the specified url about events from all connected accounts is created; otherwise an account webhook endpoint that notifies the specified url only about events from your account is created. You can also create webhook endpoints in the webhooks settings section of the Dashboard.

", "operationId": "PostWebhookEndpoints", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "description": { "explode": true, "style": "deepObject" }, "enabled_events": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "api_version": { "description": "Events sent to this endpoint will be generated with this Stripe Version instead of your account's default Stripe Version.", "enum": [ "2011-01-01", "2011-06-21", "2011-06-28", "2011-08-01", "2011-09-15", "2011-11-17", "2012-02-23", "2012-03-25", "2012-06-18", "2012-06-28", "2012-07-09", "2012-09-24", "2012-10-26", "2012-11-07", "2013-02-11", "2013-02-13", "2013-07-05", "2013-08-12", "2013-08-13", "2013-10-29", "2013-12-03", "2014-01-31", "2014-03-13", "2014-03-28", "2014-05-19", "2014-06-13", "2014-06-17", "2014-07-22", "2014-07-26", "2014-08-04", "2014-08-20", "2014-09-08", "2014-10-07", "2014-11-05", "2014-11-20", "2014-12-08", "2014-12-17", "2014-12-22", "2015-01-11", "2015-01-26", "2015-02-10", "2015-02-16", "2015-02-18", "2015-03-24", "2015-04-07", "2015-06-15", "2015-07-07", "2015-07-13", "2015-07-28", "2015-08-07", "2015-08-19", "2015-09-03", "2015-09-08", "2015-09-23", "2015-10-01", "2015-10-12", "2015-10-16", "2016-02-03", "2016-02-19", "2016-02-22", "2016-02-23", "2016-02-29", "2016-03-07", "2016-06-15", "2016-07-06", "2016-10-19", "2017-01-27", "2017-02-14", "2017-04-06", "2017-05-25", "2017-06-05", "2017-08-15", "2017-12-14", "2018-01-23", "2018-02-05", "2018-02-06", "2018-02-28", "2018-05-21", "2018-07-27", "2018-08-23", "2018-09-06", "2018-09-24", "2018-10-31", "2018-11-08", "2019-02-11", "2019-02-19", "2019-03-14", "2019-05-16", "2019-08-14", "2019-09-09", "2019-10-08", "2019-10-17", "2019-11-05", "2019-12-03", "2020-03-02", "2020-08-27", "2022-08-01", "2022-11-15", "2023-08-16", "2023-10-16", "2024-04-10", "2024-06-20", "2024-09-30.acacia", "2024-10-28.acacia", "2024-11-20.acacia", "2024-12-18.acacia", "2025-01-27.acacia", "2025-02-24.acacia", "2025-03-01.dashboard", "2025-03-31.basil", "2025-04-30.basil", "2025-05-28.basil", "2025-06-30.basil", "2025-07-30.basil", "2025-08-27.basil", "2025-09-30.clover" ], "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true }, "connect": { "description": "Whether this endpoint should receive events from connected accounts (`true`), or from your account (`false`). Defaults to `false`.", "type": "boolean" }, "description": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "An optional description of what the webhook is used for." }, "enabled_events": { "description": "The list of events to enable for this endpoint. You may specify `['*']` to enable all events, except those that require explicit selection.", "items": { "enum": [ "*", "account.application.authorized", "account.application.deauthorized", "account.external_account.created", "account.external_account.deleted", "account.external_account.updated", "account.updated", "account_notice.created", "account_notice.updated", "application_fee.created", "application_fee.refund.updated", "application_fee.refunded", "balance.available", "balance_settings.updated", "billing.alert.triggered", "billing_portal.configuration.created", "billing_portal.configuration.updated", "billing_portal.session.created", "capability.updated", "capital.financing_offer.accepted", "capital.financing_offer.canceled", "capital.financing_offer.created", "capital.financing_offer.expired", "capital.financing_offer.fully_repaid", "capital.financing_offer.paid_out", "capital.financing_offer.rejected", "capital.financing_offer.replacement_created", "capital.financing_transaction.created", "cash_balance.funds_available", "charge.captured", "charge.dispute.closed", "charge.dispute.created", "charge.dispute.funds_reinstated", "charge.dispute.funds_withdrawn", "charge.dispute.updated", "charge.expired", "charge.failed", "charge.pending", "charge.refund.updated", "charge.refunded", "charge.succeeded", "charge.updated", "checkout.session.async_payment_failed", "checkout.session.async_payment_succeeded", "checkout.session.completed", "checkout.session.expired", "climate.order.canceled", "climate.order.created", "climate.order.delayed", "climate.order.delivered", "climate.order.product_substituted", "climate.product.created", "climate.product.pricing_updated", "coupon.created", "coupon.deleted", "coupon.updated", "credit_note.created", "credit_note.updated", "credit_note.voided", "customer.created", "customer.deleted", "customer.discount.created", "customer.discount.deleted", "customer.discount.updated", "customer.source.created", "customer.source.deleted", "customer.source.expiring", "customer.source.updated", "customer.subscription.collection_paused", "customer.subscription.collection_resumed", "customer.subscription.created", "customer.subscription.custom_event", "customer.subscription.deleted", "customer.subscription.paused", "customer.subscription.pending_update_applied", "customer.subscription.pending_update_expired", "customer.subscription.price_migration_failed", "customer.subscription.resumed", "customer.subscription.trial_will_end", "customer.subscription.updated", "customer.tax_id.created", "customer.tax_id.deleted", "customer.tax_id.updated", "customer.updated", "customer_cash_balance_transaction.created", "entitlements.active_entitlement_summary.updated", "file.created", "financial_connections.account.created", "financial_connections.account.deactivated", "financial_connections.account.disconnected", "financial_connections.account.reactivated", "financial_connections.account.refreshed_balance", "financial_connections.account.refreshed_inferred_balances", "financial_connections.account.refreshed_ownership", "financial_connections.account.refreshed_transactions", "financial_connections.session.updated", "fx_quote.expired", "identity.verification_session.canceled", "identity.verification_session.created", "identity.verification_session.processing", "identity.verification_session.redacted", "identity.verification_session.requires_input", "identity.verification_session.verified", "invoice.created", "invoice.deleted", "invoice.finalization_failed", "invoice.finalized", "invoice.marked_uncollectible", "invoice.overdue", "invoice.overpaid", "invoice.paid", "invoice.payment.overpaid", "invoice.payment_action_required", "invoice.payment_attempt_required", "invoice.payment_failed", "invoice.payment_succeeded", "invoice.sent", "invoice.upcoming", "invoice.updated", "invoice.voided", "invoice.will_be_due", "invoice_payment.paid", "invoiceitem.created", "invoiceitem.deleted", "issuing_authorization.created", "issuing_authorization.request", "issuing_authorization.updated", "issuing_card.created", "issuing_card.updated", "issuing_cardholder.created", "issuing_cardholder.updated", "issuing_dispute.closed", "issuing_dispute.created", "issuing_dispute.funds_reinstated", "issuing_dispute.funds_rescinded", "issuing_dispute.submitted", "issuing_dispute.updated", "issuing_dispute_settlement_detail.created", "issuing_dispute_settlement_detail.updated", "issuing_fraud_liability_debit.created", "issuing_personalization_design.activated", "issuing_personalization_design.deactivated", "issuing_personalization_design.rejected", "issuing_personalization_design.updated", "issuing_settlement.created", "issuing_settlement.updated", "issuing_token.created", "issuing_token.updated", "issuing_transaction.created", "issuing_transaction.purchase_details_receipt_updated", "issuing_transaction.updated", "mandate.updated", "payment_intent.amount_capturable_updated", "payment_intent.canceled", "payment_intent.created", "payment_intent.partially_funded", "payment_intent.payment_failed", "payment_intent.processing", "payment_intent.requires_action", "payment_intent.succeeded", "payment_link.created", "payment_link.updated", "payment_method.attached", "payment_method.automatically_updated", "payment_method.detached", "payment_method.updated", "payout.canceled", "payout.created", "payout.failed", "payout.paid", "payout.reconciliation_completed", "payout.updated", "person.created", "person.deleted", "person.updated", "plan.created", "plan.deleted", "plan.updated", "price.created", "price.deleted", "price.updated", "privacy.redaction_job.canceled", "privacy.redaction_job.created", "privacy.redaction_job.ready", "privacy.redaction_job.succeeded", "privacy.redaction_job.validation_error", "product.created", "product.deleted", "product.updated", "promotion_code.created", "promotion_code.updated", "quote.accept_failed", "quote.accepted", "quote.accepting", "quote.canceled", "quote.created", "quote.draft", "quote.finalized", "quote.reestimate_failed", "quote.reestimated", "quote.stale", "radar.early_fraud_warning.created", "radar.early_fraud_warning.updated", "refund.created", "refund.failed", "refund.updated", "reporting.report_run.failed", "reporting.report_run.succeeded", "reporting.report_type.updated", "review.closed", "review.opened", "setup_intent.canceled", "setup_intent.created", "setup_intent.requires_action", "setup_intent.setup_failed", "setup_intent.succeeded", "sigma.scheduled_query_run.created", "source.canceled", "source.chargeable", "source.failed", "source.mandate_notification", "source.refund_attributes_required", "source.transaction.created", "source.transaction.updated", "subscription_schedule.aborted", "subscription_schedule.canceled", "subscription_schedule.completed", "subscription_schedule.created", "subscription_schedule.expiring", "subscription_schedule.price_migration_failed", "subscription_schedule.released", "subscription_schedule.updated", "tax.form.updated", "tax.settings.updated", "tax_rate.created", "tax_rate.updated", "terminal.reader.action_failed", "terminal.reader.action_succeeded", "terminal.reader.action_updated", "test_helpers.test_clock.advancing", "test_helpers.test_clock.created", "test_helpers.test_clock.deleted", "test_helpers.test_clock.internal_failure", "test_helpers.test_clock.ready", "topup.canceled", "topup.created", "topup.failed", "topup.reversed", "topup.succeeded", "transfer.created", "transfer.reversed", "transfer.updated", "treasury.credit_reversal.created", "treasury.credit_reversal.posted", "treasury.debit_reversal.completed", "treasury.debit_reversal.created", "treasury.debit_reversal.initial_credit_granted", "treasury.financial_account.closed", "treasury.financial_account.created", "treasury.financial_account.features_status_updated", "treasury.inbound_transfer.canceled", "treasury.inbound_transfer.created", "treasury.inbound_transfer.failed", "treasury.inbound_transfer.succeeded", "treasury.outbound_payment.canceled", "treasury.outbound_payment.created", "treasury.outbound_payment.expected_arrival_date_updated", "treasury.outbound_payment.failed", "treasury.outbound_payment.posted", "treasury.outbound_payment.returned", "treasury.outbound_payment.tracking_details_updated", "treasury.outbound_transfer.canceled", "treasury.outbound_transfer.created", "treasury.outbound_transfer.expected_arrival_date_updated", "treasury.outbound_transfer.failed", "treasury.outbound_transfer.posted", "treasury.outbound_transfer.returned", "treasury.outbound_transfer.tracking_details_updated", "treasury.received_credit.created", "treasury.received_credit.failed", "treasury.received_credit.succeeded", "treasury.received_debit.created" ], "type": "string", "x-stripeBypassValidation": true }, "type": "array" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "url": { "description": "The URL of the webhook endpoint.", "type": "string" } }, "required": [ "enabled_events", "url" ], "type": "object", "x-stripeMostCommon": [ "api_version", "description", "enabled_events", "metadata", "url" ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_endpoint" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a webhook endpoint" } }, "/v1/webhook_endpoints/{webhook_endpoint}": { "delete": { "description": "

You can also delete webhook endpoints via the webhook endpoint management page of the Stripe dashboard.

", "operationId": "DeleteWebhookEndpointsWebhookEndpoint", "parameters": [ { "in": "path", "name": "webhook_endpoint", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted_webhook_endpoint" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Delete a webhook endpoint" }, "get": { "description": "

Retrieves the webhook endpoint with the given ID.

", "operationId": "GetWebhookEndpointsWebhookEndpoint", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "webhook_endpoint", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_endpoint" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a webhook endpoint" }, "post": { "description": "

Updates the webhook endpoint. You may edit the url, the list of enabled_events, and the status of your endpoint.

", "operationId": "PostWebhookEndpointsWebhookEndpoint", "parameters": [ { "in": "path", "name": "webhook_endpoint", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "description": { "explode": true, "style": "deepObject" }, "enabled_events": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "description": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "An optional description of what the webhook is used for." }, "disabled": { "description": "Disable the webhook endpoint if set to true.", "type": "boolean" }, "enabled_events": { "description": "The list of events to enable for this endpoint. You may specify `['*']` to enable all events, except those that require explicit selection.", "items": { "enum": [ "*", "account.application.authorized", "account.application.deauthorized", "account.external_account.created", "account.external_account.deleted", "account.external_account.updated", "account.updated", "account_notice.created", "account_notice.updated", "application_fee.created", "application_fee.refund.updated", "application_fee.refunded", "balance.available", "balance_settings.updated", "billing.alert.triggered", "billing_portal.configuration.created", "billing_portal.configuration.updated", "billing_portal.session.created", "capability.updated", "capital.financing_offer.accepted", "capital.financing_offer.canceled", "capital.financing_offer.created", "capital.financing_offer.expired", "capital.financing_offer.fully_repaid", "capital.financing_offer.paid_out", "capital.financing_offer.rejected", "capital.financing_offer.replacement_created", "capital.financing_transaction.created", "cash_balance.funds_available", "charge.captured", "charge.dispute.closed", "charge.dispute.created", "charge.dispute.funds_reinstated", "charge.dispute.funds_withdrawn", "charge.dispute.updated", "charge.expired", "charge.failed", "charge.pending", "charge.refund.updated", "charge.refunded", "charge.succeeded", "charge.updated", "checkout.session.async_payment_failed", "checkout.session.async_payment_succeeded", "checkout.session.completed", "checkout.session.expired", "climate.order.canceled", "climate.order.created", "climate.order.delayed", "climate.order.delivered", "climate.order.product_substituted", "climate.product.created", "climate.product.pricing_updated", "coupon.created", "coupon.deleted", "coupon.updated", "credit_note.created", "credit_note.updated", "credit_note.voided", "customer.created", "customer.deleted", "customer.discount.created", "customer.discount.deleted", "customer.discount.updated", "customer.source.created", "customer.source.deleted", "customer.source.expiring", "customer.source.updated", "customer.subscription.collection_paused", "customer.subscription.collection_resumed", "customer.subscription.created", "customer.subscription.custom_event", "customer.subscription.deleted", "customer.subscription.paused", "customer.subscription.pending_update_applied", "customer.subscription.pending_update_expired", "customer.subscription.price_migration_failed", "customer.subscription.resumed", "customer.subscription.trial_will_end", "customer.subscription.updated", "customer.tax_id.created", "customer.tax_id.deleted", "customer.tax_id.updated", "customer.updated", "customer_cash_balance_transaction.created", "entitlements.active_entitlement_summary.updated", "file.created", "financial_connections.account.created", "financial_connections.account.deactivated", "financial_connections.account.disconnected", "financial_connections.account.reactivated", "financial_connections.account.refreshed_balance", "financial_connections.account.refreshed_inferred_balances", "financial_connections.account.refreshed_ownership", "financial_connections.account.refreshed_transactions", "financial_connections.session.updated", "fx_quote.expired", "identity.verification_session.canceled", "identity.verification_session.created", "identity.verification_session.processing", "identity.verification_session.redacted", "identity.verification_session.requires_input", "identity.verification_session.verified", "invoice.created", "invoice.deleted", "invoice.finalization_failed", "invoice.finalized", "invoice.marked_uncollectible", "invoice.overdue", "invoice.overpaid", "invoice.paid", "invoice.payment.overpaid", "invoice.payment_action_required", "invoice.payment_attempt_required", "invoice.payment_failed", "invoice.payment_succeeded", "invoice.sent", "invoice.upcoming", "invoice.updated", "invoice.voided", "invoice.will_be_due", "invoice_payment.paid", "invoiceitem.created", "invoiceitem.deleted", "issuing_authorization.created", "issuing_authorization.request", "issuing_authorization.updated", "issuing_card.created", "issuing_card.updated", "issuing_cardholder.created", "issuing_cardholder.updated", "issuing_dispute.closed", "issuing_dispute.created", "issuing_dispute.funds_reinstated", "issuing_dispute.funds_rescinded", "issuing_dispute.submitted", "issuing_dispute.updated", "issuing_dispute_settlement_detail.created", "issuing_dispute_settlement_detail.updated", "issuing_fraud_liability_debit.created", "issuing_personalization_design.activated", "issuing_personalization_design.deactivated", "issuing_personalization_design.rejected", "issuing_personalization_design.updated", "issuing_settlement.created", "issuing_settlement.updated", "issuing_token.created", "issuing_token.updated", "issuing_transaction.created", "issuing_transaction.purchase_details_receipt_updated", "issuing_transaction.updated", "mandate.updated", "payment_intent.amount_capturable_updated", "payment_intent.canceled", "payment_intent.created", "payment_intent.partially_funded", "payment_intent.payment_failed", "payment_intent.processing", "payment_intent.requires_action", "payment_intent.succeeded", "payment_link.created", "payment_link.updated", "payment_method.attached", "payment_method.automatically_updated", "payment_method.detached", "payment_method.updated", "payout.canceled", "payout.created", "payout.failed", "payout.paid", "payout.reconciliation_completed", "payout.updated", "person.created", "person.deleted", "person.updated", "plan.created", "plan.deleted", "plan.updated", "price.created", "price.deleted", "price.updated", "privacy.redaction_job.canceled", "privacy.redaction_job.created", "privacy.redaction_job.ready", "privacy.redaction_job.succeeded", "privacy.redaction_job.validation_error", "product.created", "product.deleted", "product.updated", "promotion_code.created", "promotion_code.updated", "quote.accept_failed", "quote.accepted", "quote.accepting", "quote.canceled", "quote.created", "quote.draft", "quote.finalized", "quote.reestimate_failed", "quote.reestimated", "quote.stale", "radar.early_fraud_warning.created", "radar.early_fraud_warning.updated", "refund.created", "refund.failed", "refund.updated", "reporting.report_run.failed", "reporting.report_run.succeeded", "reporting.report_type.updated", "review.closed", "review.opened", "setup_intent.canceled", "setup_intent.created", "setup_intent.requires_action", "setup_intent.setup_failed", "setup_intent.succeeded", "sigma.scheduled_query_run.created", "source.canceled", "source.chargeable", "source.failed", "source.mandate_notification", "source.refund_attributes_required", "source.transaction.created", "source.transaction.updated", "subscription_schedule.aborted", "subscription_schedule.canceled", "subscription_schedule.completed", "subscription_schedule.created", "subscription_schedule.expiring", "subscription_schedule.price_migration_failed", "subscription_schedule.released", "subscription_schedule.updated", "tax.form.updated", "tax.settings.updated", "tax_rate.created", "tax_rate.updated", "terminal.reader.action_failed", "terminal.reader.action_succeeded", "terminal.reader.action_updated", "test_helpers.test_clock.advancing", "test_helpers.test_clock.created", "test_helpers.test_clock.deleted", "test_helpers.test_clock.internal_failure", "test_helpers.test_clock.ready", "topup.canceled", "topup.created", "topup.failed", "topup.reversed", "topup.succeeded", "transfer.created", "transfer.reversed", "transfer.updated", "treasury.credit_reversal.created", "treasury.credit_reversal.posted", "treasury.debit_reversal.completed", "treasury.debit_reversal.created", "treasury.debit_reversal.initial_credit_granted", "treasury.financial_account.closed", "treasury.financial_account.created", "treasury.financial_account.features_status_updated", "treasury.inbound_transfer.canceled", "treasury.inbound_transfer.created", "treasury.inbound_transfer.failed", "treasury.inbound_transfer.succeeded", "treasury.outbound_payment.canceled", "treasury.outbound_payment.created", "treasury.outbound_payment.expected_arrival_date_updated", "treasury.outbound_payment.failed", "treasury.outbound_payment.posted", "treasury.outbound_payment.returned", "treasury.outbound_payment.tracking_details_updated", "treasury.outbound_transfer.canceled", "treasury.outbound_transfer.created", "treasury.outbound_transfer.expected_arrival_date_updated", "treasury.outbound_transfer.failed", "treasury.outbound_transfer.posted", "treasury.outbound_transfer.returned", "treasury.outbound_transfer.tracking_details_updated", "treasury.received_credit.created", "treasury.received_credit.failed", "treasury.received_credit.succeeded", "treasury.received_debit.created" ], "type": "string", "x-stripeBypassValidation": true }, "type": "array" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "url": { "description": "The URL of the webhook endpoint.", "type": "string" } }, "type": "object", "x-stripeMostCommon": [ "description", "enabled_events", "metadata", "url" ] } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_endpoint" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a webhook endpoint" } } }, "security": [ { "basicAuth": [] }, { "bearerAuth": [] } ], "servers": [ { "url": "https://api.stripe.com/" } ] }stripe-mock-0.196.0/embedded/openapi/spec3.json000066400000000000000000327140011506013555700212370ustar00rootroot00000000000000{ "components": { "schemas": { "account": { "description": "This is an object representing a Stripe account. You can retrieve it to see\nproperties on the account like its current requirements or if the account is\nenabled to make live charges or receive payouts.\n\nFor accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection)\nis `application`, which includes Custom accounts, the properties below are always\nreturned.\n\nFor accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection)\nis `stripe`, which includes Standard and Express accounts, some properties are only returned\nuntil you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions)\nto start Connect Onboarding. Learn about the [differences between accounts](/connect/accounts).", "properties": { "business_profile": { "anyOf": [ { "$ref": "#/components/schemas/account_business_profile" } ], "description": "Business information about the account.", "nullable": true }, "business_type": { "description": "The business type.", "enum": [ "company", "government_entity", "individual", "non_profit" ], "nullable": true, "type": "string", "x-stripeBypassValidation": true }, "capabilities": { "$ref": "#/components/schemas/account_capabilities" }, "charges_enabled": { "description": "Whether the account can process charges.", "type": "boolean" }, "company": { "$ref": "#/components/schemas/legal_entity_company" }, "controller": { "$ref": "#/components/schemas/account_unification_account_controller" }, "country": { "description": "The account's country.", "maxLength": 5000, "type": "string" }, "created": { "description": "Time at which the account was connected. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "default_currency": { "description": "Three-letter ISO currency code representing the default currency for the account. This must be a currency that [Stripe supports in the account's country](https://stripe.com/docs/payouts).", "maxLength": 5000, "type": "string" }, "details_submitted": { "description": "Whether account details have been submitted. Accounts with Stripe Dashboard access, which includes Standard accounts, cannot receive payouts before this is true. Accounts where this is false should be directed to [an onboarding flow](/connect/onboarding) to finish submitting account details.", "type": "boolean" }, "email": { "description": "An email address associated with the account. It's not used for authentication and Stripe doesn't market to this field without explicit approval from the platform.", "maxLength": 5000, "nullable": true, "type": "string" }, "external_accounts": { "description": "External accounts (bank accounts and debit cards) currently attached to this account. External accounts are only returned for requests where `controller[is_controller]` is true.", "properties": { "data": { "description": "The list contains all external accounts that have been attached to the Stripe account. These may be bank accounts or cards.", "items": { "anyOf": [ { "$ref": "#/components/schemas/bank_account" }, { "$ref": "#/components/schemas/card" } ], "title": "Polymorphic", "x-stripeBypassValidation": true }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "ExternalAccountList", "type": "object", "x-expandableFields": [ "data" ] }, "future_requirements": { "$ref": "#/components/schemas/account_future_requirements" }, "groups": { "anyOf": [ { "$ref": "#/components/schemas/account_group_membership" } ], "description": "The groups associated with the account.", "nullable": true }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "individual": { "$ref": "#/components/schemas/person" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "type": "object" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "account" ], "type": "string" }, "payouts_enabled": { "description": "Whether the funds in this account can be paid out.", "type": "boolean" }, "requirements": { "$ref": "#/components/schemas/account_requirements" }, "settings": { "anyOf": [ { "$ref": "#/components/schemas/account_settings" } ], "description": "Options for customizing how the account functions within Stripe.", "nullable": true }, "tos_acceptance": { "$ref": "#/components/schemas/account_tos_acceptance" }, "type": { "description": "The Stripe account type. Can be `standard`, `express`, `custom`, or `none`.", "enum": [ "custom", "express", "none", "standard" ], "type": "string" } }, "required": [ "id", "object" ], "title": "Account", "type": "object", "x-expandableFields": [ "business_profile", "capabilities", "company", "controller", "external_accounts", "future_requirements", "groups", "individual", "requirements", "settings", "tos_acceptance" ], "x-resourceId": "account" }, "account_annual_revenue": { "description": "", "properties": { "amount": { "description": "A non-negative integer representing the amount in the [smallest currency unit](/currencies#zero-decimal).", "nullable": true, "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "nullable": true, "type": "string" }, "fiscal_year_end": { "description": "The close-out date of the preceding fiscal year in ISO 8601 format. E.g. 2023-12-31 for the 31st of December, 2023.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "AccountAnnualRevenue", "type": "object", "x-expandableFields": [] }, "account_bacs_debit_payments_settings": { "description": "", "properties": { "display_name": { "description": "The Bacs Direct Debit display name for this account. For payments made with Bacs Direct Debit, this name appears on the mandate as the statement descriptor. Mobile banking apps display it as the name of the business. To use custom branding, set the Bacs Direct Debit Display Name during or right after creation. Custom branding incurs an additional monthly fee for the platform. The fee appears 5 business days after requesting Bacs. If you don't set the display name before requesting Bacs capability, it's automatically set as \"Stripe\" and the account is onboarded to Stripe branding, which is free.", "maxLength": 5000, "nullable": true, "type": "string" }, "service_user_number": { "description": "The Bacs Direct Debit Service user number for this account. For payments made with Bacs Direct Debit, this number is a unique identifier of the account with our banking partners.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "AccountBacsDebitPaymentsSettings", "type": "object", "x-expandableFields": [] }, "account_branding_settings": { "description": "", "properties": { "icon": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/file" } ], "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) An icon for the account. Must be square and at least 128px x 128px.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/file" } ] } }, "logo": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/file" } ], "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) A logo for the account that will be used in Checkout instead of the icon and without the account's name next to it if provided. Must be at least 128px x 128px.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/file" } ] } }, "primary_color": { "description": "A CSS hex color value representing the primary branding color for this account", "maxLength": 5000, "nullable": true, "type": "string" }, "secondary_color": { "description": "A CSS hex color value representing the secondary branding color for this account", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "AccountBrandingSettings", "type": "object", "x-expandableFields": [ "icon", "logo" ] }, "account_business_profile": { "description": "", "properties": { "annual_revenue": { "anyOf": [ { "$ref": "#/components/schemas/account_annual_revenue" } ], "description": "The applicant's gross annual revenue for its preceding fiscal year.", "nullable": true }, "estimated_worker_count": { "description": "An estimated upper bound of employees, contractors, vendors, etc. currently working for the business.", "nullable": true, "type": "integer" }, "mcc": { "description": "[The merchant category code for the account](/connect/setting-mcc). MCCs are used to classify businesses based on the goods or services they provide.", "maxLength": 5000, "nullable": true, "type": "string" }, "minority_owned_business_designation": { "description": "Whether the business is a minority-owned, women-owned, and/or LGBTQI+ -owned business.", "items": { "enum": [ "lgbtqi_owned_business", "minority_owned_business", "none_of_these_apply", "prefer_not_to_answer", "women_owned_business" ], "type": "string" }, "nullable": true, "type": "array" }, "monthly_estimated_revenue": { "$ref": "#/components/schemas/account_monthly_estimated_revenue" }, "name": { "description": "The customer-facing business name.", "maxLength": 5000, "nullable": true, "type": "string" }, "product_description": { "description": "Internal-only description of the product sold or service provided by the business. It's used by Stripe for risk and underwriting purposes.", "maxLength": 40000, "nullable": true, "type": "string" }, "support_address": { "anyOf": [ { "$ref": "#/components/schemas/address" } ], "description": "A publicly available mailing address for sending support issues to.", "nullable": true }, "support_email": { "description": "A publicly available email address for sending support issues to.", "maxLength": 5000, "nullable": true, "type": "string" }, "support_phone": { "description": "A publicly available phone number to call with support issues.", "maxLength": 5000, "nullable": true, "type": "string" }, "support_url": { "description": "A publicly available website for handling support issues.", "maxLength": 5000, "nullable": true, "type": "string" }, "url": { "description": "The business's publicly available website.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "AccountBusinessProfile", "type": "object", "x-expandableFields": [ "annual_revenue", "monthly_estimated_revenue", "support_address" ] }, "account_capabilities": { "description": "", "properties": { "acss_debit_payments": { "description": "The status of the Canadian pre-authorized debits payments capability of the account, or whether the account can directly process Canadian pre-authorized debits charges.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "affirm_payments": { "description": "The status of the Affirm capability of the account, or whether the account can directly process Affirm charges.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "afterpay_clearpay_payments": { "description": "The status of the Afterpay Clearpay capability of the account, or whether the account can directly process Afterpay Clearpay charges.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "alma_payments": { "description": "The status of the Alma capability of the account, or whether the account can directly process Alma payments.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "amazon_pay_payments": { "description": "The status of the AmazonPay capability of the account, or whether the account can directly process AmazonPay payments.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "au_becs_debit_payments": { "description": "The status of the BECS Direct Debit (AU) payments capability of the account, or whether the account can directly process BECS Direct Debit (AU) charges.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "bacs_debit_payments": { "description": "The status of the Bacs Direct Debits payments capability of the account, or whether the account can directly process Bacs Direct Debits charges.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "bancontact_payments": { "description": "The status of the Bancontact payments capability of the account, or whether the account can directly process Bancontact charges.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "bank_transfer_payments": { "description": "The status of the customer_balance payments capability of the account, or whether the account can directly process customer_balance charges.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "billie_payments": { "description": "The status of the Billie capability of the account, or whether the account can directly process Billie payments.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "blik_payments": { "description": "The status of the blik payments capability of the account, or whether the account can directly process blik charges.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "boleto_payments": { "description": "The status of the boleto payments capability of the account, or whether the account can directly process boleto charges.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "card_issuing": { "description": "The status of the card issuing capability of the account, or whether you can use Issuing to distribute funds on cards", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "card_payments": { "description": "The status of the card payments capability of the account, or whether the account can directly process credit and debit card charges.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "cartes_bancaires_payments": { "description": "The status of the Cartes Bancaires payments capability of the account, or whether the account can directly process Cartes Bancaires card charges in EUR currency.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "cashapp_payments": { "description": "The status of the Cash App Pay capability of the account, or whether the account can directly process Cash App Pay payments.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "crypto_payments": { "description": "The status of the Crypto capability of the account, or whether the account can directly process Crypto payments.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "eps_payments": { "description": "The status of the EPS payments capability of the account, or whether the account can directly process EPS charges.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "fpx_payments": { "description": "The status of the FPX payments capability of the account, or whether the account can directly process FPX charges.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "gb_bank_transfer_payments": { "description": "The status of the GB customer_balance payments (GBP currency) capability of the account, or whether the account can directly process GB customer_balance charges.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "giropay_payments": { "description": "The status of the giropay payments capability of the account, or whether the account can directly process giropay charges.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "grabpay_payments": { "description": "The status of the GrabPay payments capability of the account, or whether the account can directly process GrabPay charges.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "ideal_payments": { "description": "The status of the iDEAL payments capability of the account, or whether the account can directly process iDEAL charges.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "india_international_payments": { "description": "The status of the india_international_payments capability of the account, or whether the account can process international charges (non INR) in India.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "jcb_payments": { "description": "The status of the JCB payments capability of the account, or whether the account (Japan only) can directly process JCB credit card charges in JPY currency.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "jp_bank_transfer_payments": { "description": "The status of the Japanese customer_balance payments (JPY currency) capability of the account, or whether the account can directly process Japanese customer_balance charges.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "kakao_pay_payments": { "description": "The status of the KakaoPay capability of the account, or whether the account can directly process KakaoPay payments.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "klarna_payments": { "description": "The status of the Klarna payments capability of the account, or whether the account can directly process Klarna charges.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "konbini_payments": { "description": "The status of the konbini payments capability of the account, or whether the account can directly process konbini charges.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "kr_card_payments": { "description": "The status of the KrCard capability of the account, or whether the account can directly process KrCard payments.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "legacy_payments": { "description": "The status of the legacy payments capability of the account.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "link_payments": { "description": "The status of the link_payments capability of the account, or whether the account can directly process Link charges.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "mobilepay_payments": { "description": "The status of the MobilePay capability of the account, or whether the account can directly process MobilePay charges.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "multibanco_payments": { "description": "The status of the Multibanco payments capability of the account, or whether the account can directly process Multibanco charges.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "mx_bank_transfer_payments": { "description": "The status of the Mexican customer_balance payments (MXN currency) capability of the account, or whether the account can directly process Mexican customer_balance charges.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "naver_pay_payments": { "description": "The status of the NaverPay capability of the account, or whether the account can directly process NaverPay payments.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "nz_bank_account_becs_debit_payments": { "description": "The status of the New Zealand BECS Direct Debit payments capability of the account, or whether the account can directly process New Zealand BECS Direct Debit charges.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "oxxo_payments": { "description": "The status of the OXXO payments capability of the account, or whether the account can directly process OXXO charges.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "p24_payments": { "description": "The status of the P24 payments capability of the account, or whether the account can directly process P24 charges.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "pay_by_bank_payments": { "description": "The status of the pay_by_bank payments capability of the account, or whether the account can directly process pay_by_bank charges.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "payco_payments": { "description": "The status of the Payco capability of the account, or whether the account can directly process Payco payments.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "paynow_payments": { "description": "The status of the paynow payments capability of the account, or whether the account can directly process paynow charges.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "pix_payments": { "description": "The status of the pix payments capability of the account, or whether the account can directly process pix charges.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "promptpay_payments": { "description": "The status of the promptpay payments capability of the account, or whether the account can directly process promptpay charges.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "revolut_pay_payments": { "description": "The status of the RevolutPay capability of the account, or whether the account can directly process RevolutPay payments.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "samsung_pay_payments": { "description": "The status of the SamsungPay capability of the account, or whether the account can directly process SamsungPay payments.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "satispay_payments": { "description": "The status of the Satispay capability of the account, or whether the account can directly process Satispay payments.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "sepa_bank_transfer_payments": { "description": "The status of the SEPA customer_balance payments (EUR currency) capability of the account, or whether the account can directly process SEPA customer_balance charges.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "sepa_debit_payments": { "description": "The status of the SEPA Direct Debits payments capability of the account, or whether the account can directly process SEPA Direct Debits charges.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "sofort_payments": { "description": "The status of the Sofort payments capability of the account, or whether the account can directly process Sofort charges.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "swish_payments": { "description": "The status of the Swish capability of the account, or whether the account can directly process Swish payments.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "tax_reporting_us_1099_k": { "description": "The status of the tax reporting 1099-K (US) capability of the account.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "tax_reporting_us_1099_misc": { "description": "The status of the tax reporting 1099-MISC (US) capability of the account.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "transfers": { "description": "The status of the transfers capability of the account, or whether your platform can transfer funds to the account.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "treasury": { "description": "The status of the banking capability, or whether the account can have bank accounts.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "twint_payments": { "description": "The status of the TWINT capability of the account, or whether the account can directly process TWINT charges.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "us_bank_account_ach_payments": { "description": "The status of the US bank account ACH payments capability of the account, or whether the account can directly process US bank account charges.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "us_bank_transfer_payments": { "description": "The status of the US customer_balance payments (USD currency) capability of the account, or whether the account can directly process US customer_balance charges.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "zip_payments": { "description": "The status of the Zip capability of the account, or whether the account can directly process Zip charges.", "enum": [ "active", "inactive", "pending" ], "type": "string" } }, "title": "AccountCapabilities", "type": "object", "x-expandableFields": [] }, "account_capability_future_requirements": { "description": "", "properties": { "alternatives": { "description": "Fields that are due and can be satisfied by providing the corresponding alternative fields instead.", "items": { "$ref": "#/components/schemas/account_requirements_alternative" }, "nullable": true, "type": "array" }, "current_deadline": { "description": "Date on which `future_requirements` becomes the main `requirements` hash and `future_requirements` becomes empty. After the transition, `currently_due` requirements may immediately become `past_due`, but the account may also be given a grace period depending on the capability's enablement state prior to transitioning.", "format": "unix-time", "nullable": true, "type": "integer" }, "currently_due": { "description": "Fields that need to be collected to keep the capability enabled. If not collected by `future_requirements[current_deadline]`, these fields will transition to the main `requirements` hash.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "disabled_reason": { "description": "This is typed as an enum for consistency with `requirements.disabled_reason`, but it safe to assume `future_requirements.disabled_reason` is null because fields in `future_requirements` will never disable the account.", "enum": [ "other", "paused.inactivity", "pending.onboarding", "pending.review", "platform_disabled", "platform_paused", "rejected.inactivity", "rejected.other", "rejected.unsupported_business", "requirements.fields_needed" ], "nullable": true, "type": "string" }, "errors": { "description": "Fields that are `currently_due` and need to be collected again because validation or verification failed.", "items": { "$ref": "#/components/schemas/account_requirements_error" }, "type": "array" }, "eventually_due": { "description": "Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "past_due": { "description": "Fields that weren't collected by `requirements.current_deadline`. These fields need to be collected to enable the capability on the account. New fields will never appear here; `future_requirements.past_due` will always be a subset of `requirements.past_due`.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "pending_verification": { "description": "Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due` or `currently_due`. Fields might appear in `eventually_due` or `currently_due` and in `pending_verification` if verification fails but another verification is still pending.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "required": [ "currently_due", "errors", "eventually_due", "past_due", "pending_verification" ], "title": "AccountCapabilityFutureRequirements", "type": "object", "x-expandableFields": [ "alternatives", "errors" ] }, "account_capability_requirements": { "description": "", "properties": { "alternatives": { "description": "Fields that are due and can be satisfied by providing the corresponding alternative fields instead.", "items": { "$ref": "#/components/schemas/account_requirements_alternative" }, "nullable": true, "type": "array" }, "current_deadline": { "description": "The date by which all required account information must be both submitted and verified. This includes fields listed in `currently_due` as well as those in `pending_verification`. If any required information is missing or unverified by this date, the account may be disabled. Note that `current_deadline` may change if additional `currently_due` requirements are requested.", "format": "unix-time", "nullable": true, "type": "integer" }, "currently_due": { "description": "Fields that need to be collected to keep the capability enabled. If not collected by `current_deadline`, these fields appear in `past_due` as well, and the capability is disabled.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "disabled_reason": { "description": "Description of why the capability is disabled. [Learn more about handling verification issues](https://stripe.com/docs/connect/handling-api-verification).", "enum": [ "other", "paused.inactivity", "pending.onboarding", "pending.review", "platform_disabled", "platform_paused", "rejected.inactivity", "rejected.other", "rejected.unsupported_business", "requirements.fields_needed" ], "nullable": true, "type": "string" }, "errors": { "description": "Fields that are `currently_due` and need to be collected again because validation or verification failed.", "items": { "$ref": "#/components/schemas/account_requirements_error" }, "type": "array" }, "eventually_due": { "description": "Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well, and `current_deadline` becomes set.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "past_due": { "description": "Fields that weren't collected by `current_deadline`. These fields need to be collected to enable the capability on the account.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "pending_verification": { "description": "Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. Fields might appear in `eventually_due`, `currently_due`, or `past_due` and in `pending_verification` if verification fails but another verification is still pending.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "required": [ "currently_due", "errors", "eventually_due", "past_due", "pending_verification" ], "title": "AccountCapabilityRequirements", "type": "object", "x-expandableFields": [ "alternatives", "errors" ] }, "account_card_issuing_settings": { "description": "", "properties": { "tos_acceptance": { "$ref": "#/components/schemas/card_issuing_account_terms_of_service" } }, "title": "AccountCardIssuingSettings", "type": "object", "x-expandableFields": [ "tos_acceptance" ] }, "account_card_payments_settings": { "description": "", "properties": { "decline_on": { "$ref": "#/components/schemas/account_decline_charge_on" }, "statement_descriptor_prefix": { "description": "The default text that appears on credit card statements when a charge is made. This field prefixes any dynamic `statement_descriptor` specified on the charge. `statement_descriptor_prefix` is useful for maximizing descriptor space for the dynamic portion.", "maxLength": 5000, "nullable": true, "type": "string" }, "statement_descriptor_prefix_kana": { "description": "The Kana variation of the default text that appears on credit card statements when a charge is made (Japan only). This field prefixes any dynamic `statement_descriptor_suffix_kana` specified on the charge. `statement_descriptor_prefix_kana` is useful for maximizing descriptor space for the dynamic portion.", "maxLength": 5000, "nullable": true, "type": "string" }, "statement_descriptor_prefix_kanji": { "description": "The Kanji variation of the default text that appears on credit card statements when a charge is made (Japan only). This field prefixes any dynamic `statement_descriptor_suffix_kanji` specified on the charge. `statement_descriptor_prefix_kanji` is useful for maximizing descriptor space for the dynamic portion.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "AccountCardPaymentsSettings", "type": "object", "x-expandableFields": [ "decline_on" ] }, "account_dashboard_settings": { "description": "", "properties": { "display_name": { "description": "The display name for this account. This is used on the Stripe Dashboard to differentiate between accounts.", "maxLength": 5000, "nullable": true, "type": "string" }, "timezone": { "description": "The timezone used in the Stripe Dashboard for this account. A list of possible time zone values is maintained at the [IANA Time Zone Database](http://www.iana.org/time-zones).", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "AccountDashboardSettings", "type": "object", "x-expandableFields": [] }, "account_decline_charge_on": { "description": "", "properties": { "avs_failure": { "description": "Whether Stripe automatically declines charges with an incorrect ZIP or postal code. This setting only applies when a ZIP or postal code is provided and they fail bank verification.", "type": "boolean" }, "cvc_failure": { "description": "Whether Stripe automatically declines charges with an incorrect CVC. This setting only applies when a CVC is provided and it fails bank verification.", "type": "boolean" } }, "required": [ "avs_failure", "cvc_failure" ], "title": "AccountDeclineChargeOn", "type": "object", "x-expandableFields": [] }, "account_future_requirements": { "description": "", "properties": { "alternatives": { "description": "Fields that are due and can be satisfied by providing the corresponding alternative fields instead.", "items": { "$ref": "#/components/schemas/account_requirements_alternative" }, "nullable": true, "type": "array" }, "current_deadline": { "description": "Date on which `future_requirements` becomes the main `requirements` hash and `future_requirements` becomes empty. After the transition, `currently_due` requirements may immediately become `past_due`, but the account may also be given a grace period depending on its enablement state prior to transitioning.", "format": "unix-time", "nullable": true, "type": "integer" }, "currently_due": { "description": "Fields that need to be collected to keep the account enabled. If not collected by `future_requirements[current_deadline]`, these fields will transition to the main `requirements` hash.", "items": { "maxLength": 5000, "type": "string" }, "nullable": true, "type": "array" }, "disabled_reason": { "description": "This is typed as an enum for consistency with `requirements.disabled_reason`.", "enum": [ "action_required.requested_capabilities", "listed", "other", "platform_paused", "rejected.fraud", "rejected.incomplete_verification", "rejected.listed", "rejected.other", "rejected.platform_fraud", "rejected.platform_other", "rejected.platform_terms_of_service", "rejected.terms_of_service", "requirements.past_due", "requirements.pending_verification", "under_review" ], "nullable": true, "type": "string" }, "errors": { "description": "Fields that are `currently_due` and need to be collected again because validation or verification failed.", "items": { "$ref": "#/components/schemas/account_requirements_error" }, "nullable": true, "type": "array" }, "eventually_due": { "description": "Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well.", "items": { "maxLength": 5000, "type": "string" }, "nullable": true, "type": "array" }, "past_due": { "description": "Fields that weren't collected by `requirements.current_deadline`. These fields need to be collected to enable the capability on the account. New fields will never appear here; `future_requirements.past_due` will always be a subset of `requirements.past_due`.", "items": { "maxLength": 5000, "type": "string" }, "nullable": true, "type": "array" }, "pending_verification": { "description": "Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due` or `currently_due`. Fields might appear in `eventually_due` or `currently_due` and in `pending_verification` if verification fails but another verification is still pending.", "items": { "maxLength": 5000, "type": "string" }, "nullable": true, "type": "array" } }, "title": "AccountFutureRequirements", "type": "object", "x-expandableFields": [ "alternatives", "errors" ] }, "account_group_membership": { "description": "", "properties": { "payments_pricing": { "description": "The group the account is in to determine their payments pricing, and null if the account is on customized pricing. [See the Platform pricing tool documentation](https://stripe.com/docs/connect/platform-pricing-tools) for details.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "AccountGroupMembership", "type": "object", "x-expandableFields": [] }, "account_invoices_settings": { "description": "", "properties": { "default_account_tax_ids": { "description": "The list of default Account Tax IDs to automatically include on invoices. Account Tax IDs get added when an invoice is finalized.", "items": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/tax_id" } ], "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/tax_id" } ] } }, "nullable": true, "type": "array" }, "hosted_payment_method_save": { "description": "Whether payment methods should be saved when a payment is completed for a one-time invoices on a hosted invoice page.", "enum": [ "always", "never", "offer" ], "nullable": true, "type": "string" } }, "title": "AccountInvoicesSettings", "type": "object", "x-expandableFields": [ "default_account_tax_ids" ] }, "account_link": { "description": "Account Links are the means by which a Connect platform grants a connected account permission to access\nStripe-hosted applications, such as Connect Onboarding.\n\nRelated guide: [Connect Onboarding](https://stripe.com/docs/connect/custom/hosted-onboarding)", "properties": { "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "expires_at": { "description": "The timestamp at which this account link will expire.", "format": "unix-time", "type": "integer" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "account_link" ], "type": "string" }, "url": { "description": "The URL for the account link.", "maxLength": 5000, "type": "string" } }, "required": [ "created", "expires_at", "object", "url" ], "title": "AccountLink", "type": "object", "x-expandableFields": [], "x-resourceId": "account_link" }, "account_monthly_estimated_revenue": { "description": "", "properties": { "amount": { "description": "A non-negative integer representing how much to charge in the [smallest currency unit](/currencies#zero-decimal).", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" } }, "required": [ "amount", "currency" ], "title": "AccountMonthlyEstimatedRevenue", "type": "object", "x-expandableFields": [] }, "account_payments_settings": { "description": "", "properties": { "statement_descriptor": { "description": "The default text that appears on credit card statements when a charge is made. This field prefixes any dynamic `statement_descriptor` specified on the charge.", "maxLength": 5000, "nullable": true, "type": "string" }, "statement_descriptor_kana": { "description": "The Kana variation of `statement_descriptor` used for charges in Japan. Japanese statement descriptors have [special requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors).", "maxLength": 5000, "nullable": true, "type": "string" }, "statement_descriptor_kanji": { "description": "The Kanji variation of `statement_descriptor` used for charges in Japan. Japanese statement descriptors have [special requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors).", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "AccountPaymentsSettings", "type": "object", "x-expandableFields": [] }, "account_payout_settings": { "description": "", "properties": { "debit_negative_balances": { "description": "A Boolean indicating if Stripe should try to reclaim negative balances from an attached bank account. See [Understanding Connect account balances](/connect/account-balances) for details. The default value is `false` when [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts, otherwise `true`.", "type": "boolean" }, "schedule": { "$ref": "#/components/schemas/transfer_schedule" }, "statement_descriptor": { "description": "The text that appears on the bank account statement for payouts. If not set, this defaults to the platform's bank descriptor as set in the Dashboard.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "debit_negative_balances", "schedule" ], "title": "AccountPayoutSettings", "type": "object", "x-expandableFields": [ "schedule" ] }, "account_requirements": { "description": "", "properties": { "alternatives": { "description": "Fields that are due and can be satisfied by providing the corresponding alternative fields instead.", "items": { "$ref": "#/components/schemas/account_requirements_alternative" }, "nullable": true, "type": "array" }, "current_deadline": { "description": "Date by which the fields in `currently_due` must be collected to keep the account enabled. These fields may disable the account sooner if the next threshold is reached before they are collected.", "format": "unix-time", "nullable": true, "type": "integer" }, "currently_due": { "description": "Fields that need to be collected to keep the account enabled. If not collected by `current_deadline`, these fields appear in `past_due` as well, and the account is disabled.", "items": { "maxLength": 5000, "type": "string" }, "nullable": true, "type": "array" }, "disabled_reason": { "description": "If the account is disabled, this enum describes why. [Learn more about handling verification issues](https://stripe.com/docs/connect/handling-api-verification).", "enum": [ "action_required.requested_capabilities", "listed", "other", "platform_paused", "rejected.fraud", "rejected.incomplete_verification", "rejected.listed", "rejected.other", "rejected.platform_fraud", "rejected.platform_other", "rejected.platform_terms_of_service", "rejected.terms_of_service", "requirements.past_due", "requirements.pending_verification", "under_review" ], "nullable": true, "type": "string" }, "errors": { "description": "Fields that are `currently_due` and need to be collected again because validation or verification failed.", "items": { "$ref": "#/components/schemas/account_requirements_error" }, "nullable": true, "type": "array" }, "eventually_due": { "description": "Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well, and `current_deadline` becomes set.", "items": { "maxLength": 5000, "type": "string" }, "nullable": true, "type": "array" }, "past_due": { "description": "Fields that weren't collected by `current_deadline`. These fields need to be collected to enable the account.", "items": { "maxLength": 5000, "type": "string" }, "nullable": true, "type": "array" }, "pending_verification": { "description": "Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. Fields might appear in `eventually_due`, `currently_due`, or `past_due` and in `pending_verification` if verification fails but another verification is still pending.", "items": { "maxLength": 5000, "type": "string" }, "nullable": true, "type": "array" } }, "title": "AccountRequirements", "type": "object", "x-expandableFields": [ "alternatives", "errors" ] }, "account_requirements_alternative": { "description": "", "properties": { "alternative_fields_due": { "description": "Fields that can be provided to satisfy all fields in `original_fields_due`.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "original_fields_due": { "description": "Fields that are due and can be satisfied by providing all fields in `alternative_fields_due`.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "required": [ "alternative_fields_due", "original_fields_due" ], "title": "AccountRequirementsAlternative", "type": "object", "x-expandableFields": [] }, "account_requirements_error": { "description": "", "properties": { "code": { "description": "The code for the type of error.", "enum": [ "information_missing", "invalid_address_city_state_postal_code", "invalid_address_highway_contract_box", "invalid_address_private_mailbox", "invalid_business_profile_name", "invalid_business_profile_name_denylisted", "invalid_company_name_denylisted", "invalid_dob_age_over_maximum", "invalid_dob_age_under_18", "invalid_dob_age_under_minimum", "invalid_product_description_length", "invalid_product_description_url_match", "invalid_representative_country", "invalid_signator", "invalid_statement_descriptor_business_mismatch", "invalid_statement_descriptor_denylisted", "invalid_statement_descriptor_length", "invalid_statement_descriptor_prefix_denylisted", "invalid_statement_descriptor_prefix_mismatch", "invalid_street_address", "invalid_tax_id", "invalid_tax_id_format", "invalid_tos_acceptance", "invalid_url_denylisted", "invalid_url_format", "invalid_url_web_presence_detected", "invalid_url_website_business_information_mismatch", "invalid_url_website_empty", "invalid_url_website_inaccessible", "invalid_url_website_inaccessible_geoblocked", "invalid_url_website_inaccessible_password_protected", "invalid_url_website_incomplete", "invalid_url_website_incomplete_cancellation_policy", "invalid_url_website_incomplete_customer_service_details", "invalid_url_website_incomplete_legal_restrictions", "invalid_url_website_incomplete_refund_policy", "invalid_url_website_incomplete_return_policy", "invalid_url_website_incomplete_terms_and_conditions", "invalid_url_website_incomplete_under_construction", "invalid_url_website_other", "invalid_value_other", "verification_directors_mismatch", "verification_document_address_mismatch", "verification_document_address_missing", "verification_document_corrupt", "verification_document_country_not_supported", "verification_document_directors_mismatch", "verification_document_dob_mismatch", "verification_document_duplicate_type", "verification_document_expired", "verification_document_failed_copy", "verification_document_failed_greyscale", "verification_document_failed_other", "verification_document_failed_test_mode", "verification_document_fraudulent", "verification_document_id_number_mismatch", "verification_document_id_number_missing", "verification_document_incomplete", "verification_document_invalid", "verification_document_issue_or_expiry_date_missing", "verification_document_manipulated", "verification_document_missing_back", "verification_document_missing_front", "verification_document_name_mismatch", "verification_document_name_missing", "verification_document_nationality_mismatch", "verification_document_not_readable", "verification_document_not_signed", "verification_document_not_uploaded", "verification_document_photo_mismatch", "verification_document_too_large", "verification_document_type_not_supported", "verification_extraneous_directors", "verification_failed_address_match", "verification_failed_authorizer_authority", "verification_failed_business_iec_number", "verification_failed_document_match", "verification_failed_id_number_match", "verification_failed_keyed_identity", "verification_failed_keyed_match", "verification_failed_name_match", "verification_failed_other", "verification_failed_representative_authority", "verification_failed_residential_address", "verification_failed_tax_id_match", "verification_failed_tax_id_not_issued", "verification_legal_entity_structure_mismatch", "verification_missing_directors", "verification_missing_executives", "verification_missing_owners", "verification_rejected_ownership_exemption_reason", "verification_requires_additional_memorandum_of_associations", "verification_requires_additional_proof_of_registration", "verification_supportability" ], "type": "string", "x-stripeBypassValidation": true }, "reason": { "description": "An informative message that indicates the error type and provides additional details about the error.", "maxLength": 5000, "type": "string" }, "requirement": { "description": "The specific user onboarding requirement field (in the requirements hash) that needs to be resolved.", "maxLength": 5000, "type": "string" } }, "required": [ "code", "reason", "requirement" ], "title": "AccountRequirementsError", "type": "object", "x-expandableFields": [] }, "account_sepa_debit_payments_settings": { "description": "", "properties": { "creditor_id": { "description": "SEPA creditor identifier that identifies the company making the payment.", "maxLength": 5000, "type": "string" } }, "title": "AccountSepaDebitPaymentsSettings", "type": "object", "x-expandableFields": [] }, "account_session": { "description": "An AccountSession allows a Connect platform to grant access to a connected account in Connect embedded components.\n\nWe recommend that you create an AccountSession each time you need to display an embedded component\nto your user. Do not save AccountSessions to your database as they expire relatively\nquickly, and cannot be used more than once.\n\nRelated guide: [Connect embedded components](https://stripe.com/docs/connect/get-started-connect-embedded-components)", "properties": { "account": { "description": "The ID of the account the AccountSession was created for", "maxLength": 5000, "type": "string" }, "client_secret": { "description": "The client secret of this AccountSession. Used on the client to set up secure access to the given `account`.\n\nThe client secret can be used to provide access to `account` from your frontend. It should not be stored, logged, or exposed to anyone other than the connected account. Make sure that you have TLS enabled on any page that includes the client secret.\n\nRefer to our docs to [setup Connect embedded components](https://stripe.com/docs/connect/get-started-connect-embedded-components) and learn about how `client_secret` should be handled.", "maxLength": 5000, "type": "string" }, "components": { "$ref": "#/components/schemas/connect_embedded_account_session_create_components" }, "expires_at": { "description": "The timestamp at which this AccountSession will expire.", "format": "unix-time", "type": "integer" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "account_session" ], "type": "string" } }, "required": [ "account", "client_secret", "components", "expires_at", "livemode", "object" ], "title": "ConnectEmbeddedMethodAccountSessionCreateMethodAccountSession", "type": "object", "x-expandableFields": [ "components" ], "x-resourceId": "account_session" }, "account_settings": { "description": "", "properties": { "bacs_debit_payments": { "$ref": "#/components/schemas/account_bacs_debit_payments_settings" }, "branding": { "$ref": "#/components/schemas/account_branding_settings" }, "card_issuing": { "$ref": "#/components/schemas/account_card_issuing_settings" }, "card_payments": { "$ref": "#/components/schemas/account_card_payments_settings" }, "dashboard": { "$ref": "#/components/schemas/account_dashboard_settings" }, "invoices": { "$ref": "#/components/schemas/account_invoices_settings" }, "payments": { "$ref": "#/components/schemas/account_payments_settings" }, "payouts": { "$ref": "#/components/schemas/account_payout_settings" }, "sepa_debit_payments": { "$ref": "#/components/schemas/account_sepa_debit_payments_settings" }, "treasury": { "$ref": "#/components/schemas/account_treasury_settings" } }, "required": [ "branding", "card_payments", "dashboard", "payments" ], "title": "AccountSettings", "type": "object", "x-expandableFields": [ "bacs_debit_payments", "branding", "card_issuing", "card_payments", "dashboard", "invoices", "payments", "payouts", "sepa_debit_payments", "treasury" ] }, "account_terms_of_service": { "description": "", "properties": { "date": { "description": "The Unix timestamp marking when the account representative accepted the service agreement.", "nullable": true, "type": "integer" }, "ip": { "description": "The IP address from which the account representative accepted the service agreement.", "maxLength": 5000, "nullable": true, "type": "string" }, "user_agent": { "description": "The user agent of the browser from which the account representative accepted the service agreement.", "maxLength": 5000, "type": "string" } }, "title": "AccountTermsOfService", "type": "object", "x-expandableFields": [] }, "account_tos_acceptance": { "description": "", "properties": { "date": { "description": "The Unix timestamp marking when the account representative accepted their service agreement", "format": "unix-time", "nullable": true, "type": "integer" }, "ip": { "description": "The IP address from which the account representative accepted their service agreement", "maxLength": 5000, "nullable": true, "type": "string" }, "service_agreement": { "description": "The user's service agreement type", "maxLength": 5000, "type": "string" }, "user_agent": { "description": "The user agent of the browser from which the account representative accepted their service agreement", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "AccountTOSAcceptance", "type": "object", "x-expandableFields": [] }, "account_treasury_settings": { "description": "", "properties": { "tos_acceptance": { "$ref": "#/components/schemas/account_terms_of_service" } }, "title": "AccountTreasurySettings", "type": "object", "x-expandableFields": [ "tos_acceptance" ] }, "account_unification_account_controller": { "description": "", "properties": { "fees": { "$ref": "#/components/schemas/account_unification_account_controller_fees" }, "is_controller": { "description": "`true` if the Connect application retrieving the resource controls the account and can therefore exercise [platform controls](https://stripe.com/docs/connect/platform-controls-for-standard-accounts). Otherwise, this field is null.", "type": "boolean" }, "losses": { "$ref": "#/components/schemas/account_unification_account_controller_losses" }, "requirement_collection": { "description": "A value indicating responsibility for collecting requirements on this account. Only returned when the Connect application retrieving the resource controls the account.", "enum": [ "application", "stripe" ], "type": "string" }, "stripe_dashboard": { "$ref": "#/components/schemas/account_unification_account_controller_stripe_dashboard" }, "type": { "description": "The controller type. Can be `application`, if a Connect application controls the account, or `account`, if the account controls itself.", "enum": [ "account", "application" ], "type": "string" } }, "required": [ "type" ], "title": "AccountUnificationAccountController", "type": "object", "x-expandableFields": [ "fees", "losses", "stripe_dashboard" ] }, "account_unification_account_controller_fees": { "description": "", "properties": { "payer": { "description": "A value indicating the responsible payer of a bundle of Stripe fees for pricing-control eligible products on this account. Learn more about [fee behavior on connected accounts](https://docs.stripe.com/connect/direct-charges-fee-payer-behavior).", "enum": [ "account", "application", "application_custom", "application_express" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "payer" ], "title": "AccountUnificationAccountControllerFees", "type": "object", "x-expandableFields": [] }, "account_unification_account_controller_losses": { "description": "", "properties": { "payments": { "description": "A value indicating who is liable when this account can't pay back negative balances from payments.", "enum": [ "application", "stripe" ], "type": "string" } }, "required": [ "payments" ], "title": "AccountUnificationAccountControllerLosses", "type": "object", "x-expandableFields": [] }, "account_unification_account_controller_stripe_dashboard": { "description": "", "properties": { "type": { "description": "A value indicating the Stripe dashboard this account has access to independent of the Connect application.", "enum": [ "express", "full", "none" ], "type": "string" } }, "required": [ "type" ], "title": "AccountUnificationAccountControllerStripeDashboard", "type": "object", "x-expandableFields": [] }, "address": { "description": "", "properties": { "city": { "description": "City, district, suburb, town, or village.", "maxLength": 5000, "nullable": true, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "nullable": true, "type": "string" }, "line1": { "description": "Address line 1 (e.g., street, PO Box, or company name).", "maxLength": 5000, "nullable": true, "type": "string" }, "line2": { "description": "Address line 2 (e.g., apartment, suite, unit, or building).", "maxLength": 5000, "nullable": true, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "nullable": true, "type": "string" }, "state": { "description": "State, county, province, or region.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "Address", "type": "object", "x-expandableFields": [] }, "alma_installments": { "description": "", "properties": { "count": { "description": "The number of installments.", "type": "integer" } }, "required": [ "count" ], "title": "alma_installments", "type": "object", "x-expandableFields": [] }, "amazon_pay_underlying_payment_method_funding_details": { "description": "", "properties": { "card": { "$ref": "#/components/schemas/payment_method_details_passthrough_card" }, "type": { "description": "funding type of the underlying payment method.", "enum": [ "card" ], "nullable": true, "type": "string" } }, "title": "amazon_pay_underlying_payment_method_funding_details", "type": "object", "x-expandableFields": [ "card" ] }, "api_errors": { "description": "", "properties": { "advice_code": { "description": "For card errors resulting from a card issuer decline, a short string indicating [how to proceed with an error](https://stripe.com/docs/declines#retrying-issuer-declines) if they provide one.", "maxLength": 5000, "type": "string" }, "charge": { "description": "For card errors, the ID of the failed charge.", "maxLength": 5000, "type": "string" }, "code": { "description": "For some errors that could be handled programmatically, a short string indicating the [error code](https://stripe.com/docs/error-codes) reported.", "maxLength": 5000, "type": "string" }, "decline_code": { "description": "For card errors resulting from a card issuer decline, a short string indicating the [card issuer's reason for the decline](https://stripe.com/docs/declines#issuer-declines) if they provide one.", "maxLength": 5000, "type": "string" }, "doc_url": { "description": "A URL to more information about the [error code](https://stripe.com/docs/error-codes) reported.", "maxLength": 5000, "type": "string" }, "message": { "description": "A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.", "maxLength": 40000, "type": "string" }, "network_advice_code": { "description": "For card errors resulting from a card issuer decline, a 2 digit code which indicates the advice given to merchant by the card network on how to proceed with an error.", "maxLength": 5000, "type": "string" }, "network_decline_code": { "description": "For payments declined by the network, an alphanumeric code which indicates the reason the payment failed.", "maxLength": 5000, "type": "string" }, "param": { "description": "If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field.", "maxLength": 5000, "type": "string" }, "payment_intent": { "$ref": "#/components/schemas/payment_intent" }, "payment_method": { "$ref": "#/components/schemas/payment_method" }, "payment_method_type": { "description": "If the error is specific to the type of payment method, the payment method type that had a problem. This field is only populated for invoice-related errors.", "maxLength": 5000, "type": "string" }, "request_log_url": { "description": "A URL to the request log entry in your dashboard.", "maxLength": 5000, "type": "string" }, "setup_intent": { "$ref": "#/components/schemas/setup_intent" }, "source": { "anyOf": [ { "$ref": "#/components/schemas/bank_account" }, { "$ref": "#/components/schemas/card" }, { "$ref": "#/components/schemas/source" } ], "description": "The [source object](https://stripe.com/docs/api/sources/object) for errors returned on a request involving a source.", "x-stripeBypassValidation": true }, "type": { "description": "The type of error returned. One of `api_error`, `card_error`, `idempotency_error`, or `invalid_request_error`", "enum": [ "api_error", "card_error", "idempotency_error", "invalid_request_error" ], "type": "string" } }, "required": [ "type" ], "title": "APIErrors", "type": "object", "x-expandableFields": [ "payment_intent", "payment_method", "setup_intent", "source" ] }, "apple_pay_domain": { "description": "", "properties": { "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "domain_name": { "maxLength": 5000, "type": "string" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "apple_pay_domain" ], "type": "string" } }, "required": [ "created", "domain_name", "id", "livemode", "object" ], "title": "ApplePayDomain", "type": "object", "x-expandableFields": [], "x-resourceId": "apple_pay_domain" }, "application": { "description": "", "properties": { "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "name": { "description": "The name of the application.", "maxLength": 5000, "nullable": true, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "application" ], "type": "string" } }, "required": [ "id", "object" ], "title": "Application", "type": "object", "x-expandableFields": [] }, "application_fee": { "description": "", "properties": { "account": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/account" } ], "description": "ID of the Stripe account this fee was taken from.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/account" } ] } }, "amount": { "description": "Amount earned, in cents (or local equivalent).", "type": "integer" }, "amount_refunded": { "description": "Amount in cents (or local equivalent) refunded (can be less than the amount attribute on the fee if a partial refund was issued)", "type": "integer" }, "application": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/application" } ], "description": "ID of the Connect application that earned the fee.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/application" } ] } }, "balance_transaction": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/balance_transaction" } ], "description": "Balance transaction that describes the impact of this collected application fee on your account balance (not including refunds).", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/balance_transaction" } ] } }, "charge": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/charge" } ], "description": "ID of the charge that the application fee was taken from.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/charge" } ] } }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "fee_source": { "anyOf": [ { "$ref": "#/components/schemas/platform_earning_fee_source" } ], "description": "Polymorphic source of the application fee. Includes the ID of the object the application fee was created from.", "nullable": true }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "application_fee" ], "type": "string" }, "originating_transaction": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/charge" } ], "description": "ID of the corresponding charge on the platform account, if this fee was the result of a charge using the `destination` parameter.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/charge" } ] } }, "refunded": { "description": "Whether the fee has been fully refunded. If the fee is only partially refunded, this attribute will still be false.", "type": "boolean" }, "refunds": { "description": "A list of refunds that have been applied to the fee.", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/fee_refund" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "FeeRefundList", "type": "object", "x-expandableFields": [ "data" ] } }, "required": [ "account", "amount", "amount_refunded", "application", "charge", "created", "currency", "id", "livemode", "object", "refunded", "refunds" ], "title": "PlatformFee", "type": "object", "x-expandableFields": [ "account", "application", "balance_transaction", "charge", "fee_source", "originating_transaction", "refunds" ], "x-resourceId": "application_fee" }, "apps.secret": { "description": "Secret Store is an API that allows Stripe Apps developers to securely persist secrets for use by UI Extensions and app backends.\n\nThe primary resource in Secret Store is a `secret`. Other apps can't view secrets created by an app. Additionally, secrets are scoped to provide further permission control.\n\nAll Dashboard users and the app backend share `account` scoped secrets. Use the `account` scope for secrets that don't change per-user, like a third-party API key.\n\nA `user` scoped secret is accessible by the app backend and one specific Dashboard user. Use the `user` scope for per-user secrets like per-user OAuth tokens, where different users might have different permissions.\n\nRelated guide: [Store data between page reloads](https://stripe.com/docs/stripe-apps/store-auth-data-custom-objects)", "properties": { "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "deleted": { "description": "If true, indicates that this secret has been deleted", "type": "boolean" }, "expires_at": { "description": "The Unix timestamp for the expiry time of the secret, after which the secret deletes.", "format": "unix-time", "nullable": true, "type": "integer" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "name": { "description": "A name for the secret that's unique within the scope.", "maxLength": 5000, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "apps.secret" ], "type": "string" }, "payload": { "description": "The plaintext secret value to be stored.", "maxLength": 5000, "nullable": true, "type": "string" }, "scope": { "$ref": "#/components/schemas/secret_service_resource_scope" } }, "required": [ "created", "id", "livemode", "name", "object", "scope" ], "title": "SecretServiceResourceSecret", "type": "object", "x-expandableFields": [ "scope" ], "x-resourceId": "apps.secret" }, "automatic_tax": { "description": "", "properties": { "disabled_reason": { "description": "If Stripe disabled automatic tax, this enum describes why.", "enum": [ "finalization_requires_location_inputs", "finalization_system_error" ], "nullable": true, "type": "string" }, "enabled": { "description": "Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified [tax rates](https://stripe.com/docs/api/tax_rates), negative amounts, or `tax_behavior=unspecified`) cannot be added to automatic tax invoices.", "type": "boolean" }, "liability": { "anyOf": [ { "$ref": "#/components/schemas/connect_account_reference" } ], "description": "The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.", "nullable": true }, "provider": { "description": "The tax provider powering automatic tax.", "maxLength": 5000, "nullable": true, "type": "string" }, "status": { "description": "The status of the most recent automated tax calculation for this invoice.", "enum": [ "complete", "failed", "requires_location_inputs" ], "nullable": true, "type": "string" } }, "required": [ "enabled" ], "title": "AutomaticTax", "type": "object", "x-expandableFields": [ "liability" ] }, "balance": { "description": "This is an object representing your Stripe balance. You can retrieve it to see\nthe balance currently on your Stripe account.\n\nThe top-level `available` and `pending` comprise your \"payments balance.\"\n\nRelated guide: [Balances and settlement time](https://stripe.com/docs/payments/balances), [Understanding Connect account balances](https://stripe.com/docs/connect/account-balances)", "properties": { "available": { "description": "Available funds that you can transfer or pay out automatically by Stripe or explicitly through the [Transfers API](https://stripe.com/docs/api#transfers) or [Payouts API](https://stripe.com/docs/api#payouts). You can find the available balance for each currency and payment type in the `source_types` property.", "items": { "$ref": "#/components/schemas/balance_amount" }, "type": "array" }, "connect_reserved": { "description": "Funds held due to negative balances on connected accounts where [account.controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. You can find the connect reserve balance for each currency and payment type in the `source_types` property.", "items": { "$ref": "#/components/schemas/balance_amount" }, "type": "array" }, "instant_available": { "description": "Funds that you can pay out using Instant Payouts.", "items": { "$ref": "#/components/schemas/balance_amount_net" }, "type": "array" }, "issuing": { "$ref": "#/components/schemas/balance_detail" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "balance" ], "type": "string" }, "pending": { "description": "Funds that aren't available in the balance yet. You can find the pending balance for each currency and each payment type in the `source_types` property.", "items": { "$ref": "#/components/schemas/balance_amount" }, "type": "array" }, "refund_and_dispute_prefunding": { "$ref": "#/components/schemas/balance_detail_ungated" } }, "required": [ "available", "livemode", "object", "pending" ], "title": "Balance", "type": "object", "x-expandableFields": [ "available", "connect_reserved", "instant_available", "issuing", "pending", "refund_and_dispute_prefunding" ], "x-resourceId": "balance" }, "balance_amount": { "description": "", "properties": { "amount": { "description": "Balance amount.", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "source_types": { "$ref": "#/components/schemas/balance_amount_by_source_type" } }, "required": [ "amount", "currency" ], "title": "BalanceAmount", "type": "object", "x-expandableFields": [ "source_types" ] }, "balance_amount_by_source_type": { "description": "", "properties": { "bank_account": { "description": "Amount coming from [legacy US ACH payments](https://docs.stripe.com/ach-deprecated).", "type": "integer" }, "card": { "description": "Amount coming from most payment methods, including cards as well as [non-legacy bank debits](https://docs.stripe.com/payments/bank-debits).", "type": "integer" }, "fpx": { "description": "Amount coming from [FPX](https://docs.stripe.com/payments/fpx), a Malaysian payment method.", "type": "integer" } }, "title": "BalanceAmountBySourceType", "type": "object", "x-expandableFields": [] }, "balance_amount_net": { "description": "", "properties": { "amount": { "description": "Balance amount.", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "net_available": { "description": "Breakdown of balance by destination.", "items": { "$ref": "#/components/schemas/balance_net_available" }, "type": "array" }, "source_types": { "$ref": "#/components/schemas/balance_amount_by_source_type" } }, "required": [ "amount", "currency" ], "title": "BalanceAmountNet", "type": "object", "x-expandableFields": [ "net_available", "source_types" ] }, "balance_detail": { "description": "", "properties": { "available": { "description": "Funds that are available for use.", "items": { "$ref": "#/components/schemas/balance_amount" }, "type": "array" } }, "required": [ "available" ], "title": "BalanceDetail", "type": "object", "x-expandableFields": [ "available" ] }, "balance_detail_ungated": { "description": "", "properties": { "available": { "description": "Funds that are available for use.", "items": { "$ref": "#/components/schemas/balance_amount" }, "type": "array" }, "pending": { "description": "Funds that are pending", "items": { "$ref": "#/components/schemas/balance_amount" }, "type": "array" } }, "required": [ "available", "pending" ], "title": "BalanceDetailUngated", "type": "object", "x-expandableFields": [ "available", "pending" ] }, "balance_net_available": { "description": "", "properties": { "amount": { "description": "Net balance amount, subtracting fees from platform-set pricing.", "type": "integer" }, "destination": { "description": "ID of the external account for this net balance (not expandable).", "maxLength": 5000, "type": "string" }, "source_types": { "$ref": "#/components/schemas/balance_amount_by_source_type" } }, "required": [ "amount", "destination" ], "title": "BalanceNetAvailable", "type": "object", "x-expandableFields": [ "source_types" ] }, "balance_transaction": { "description": "Balance transactions represent funds moving through your Stripe account.\nStripe creates them for every type of transaction that enters or leaves your Stripe account balance.\n\nRelated guide: [Balance transaction types](https://stripe.com/docs/reports/balance-transaction-types)", "properties": { "amount": { "description": "Gross amount of this transaction (in cents (or local equivalent)). A positive value represents funds charged to another party, and a negative value represents funds sent to another party.", "type": "integer" }, "available_on": { "description": "The date that the transaction's net funds become available in the Stripe balance.", "format": "unix-time", "type": "integer" }, "balance_type": { "description": "The balance that this transaction impacts.", "enum": [ "issuing", "payments", "refund_and_dispute_prefunding" ], "type": "string", "x-stripeBypassValidation": true }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users.", "maxLength": 5000, "nullable": true, "type": "string" }, "exchange_rate": { "description": "If applicable, this transaction uses an exchange rate. If money converts from currency A to currency B, then the `amount` in currency A, multipled by the `exchange_rate`, equals the `amount` in currency B. For example, if you charge a customer 10.00 EUR, the PaymentIntent's `amount` is `1000` and `currency` is `eur`. If this converts to 12.34 USD in your Stripe account, the BalanceTransaction's `amount` is `1234`, its `currency` is `usd`, and the `exchange_rate` is `1.234`.", "nullable": true, "type": "number" }, "fee": { "description": "Fees (in cents (or local equivalent)) paid for this transaction. Represented as a positive integer when assessed.", "type": "integer" }, "fee_details": { "description": "Detailed breakdown of fees (in cents (or local equivalent)) paid for this transaction.", "items": { "$ref": "#/components/schemas/fee" }, "type": "array" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "net": { "description": "Net impact to a Stripe balance (in cents (or local equivalent)). A positive value represents incrementing a Stripe balance, and a negative value decrementing a Stripe balance. You can calculate the net impact of a transaction on a balance by `amount` - `fee`", "type": "integer" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "balance_transaction" ], "type": "string" }, "reporting_category": { "description": "Learn more about how [reporting categories](https://stripe.com/docs/reports/reporting-categories) can help you understand balance transactions from an accounting perspective.", "maxLength": 5000, "type": "string" }, "source": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/application_fee" }, { "$ref": "#/components/schemas/charge" }, { "$ref": "#/components/schemas/connect_collection_transfer" }, { "$ref": "#/components/schemas/customer_cash_balance_transaction" }, { "$ref": "#/components/schemas/dispute" }, { "$ref": "#/components/schemas/fee_refund" }, { "$ref": "#/components/schemas/issuing.authorization" }, { "$ref": "#/components/schemas/issuing.dispute" }, { "$ref": "#/components/schemas/issuing.transaction" }, { "$ref": "#/components/schemas/payout" }, { "$ref": "#/components/schemas/refund" }, { "$ref": "#/components/schemas/reserve_transaction" }, { "$ref": "#/components/schemas/tax_deducted_at_source" }, { "$ref": "#/components/schemas/topup" }, { "$ref": "#/components/schemas/transfer" }, { "$ref": "#/components/schemas/transfer_reversal" } ], "description": "This transaction relates to the Stripe object.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/application_fee" }, { "$ref": "#/components/schemas/charge" }, { "$ref": "#/components/schemas/connect_collection_transfer" }, { "$ref": "#/components/schemas/customer_cash_balance_transaction" }, { "$ref": "#/components/schemas/dispute" }, { "$ref": "#/components/schemas/fee_refund" }, { "$ref": "#/components/schemas/issuing.authorization" }, { "$ref": "#/components/schemas/issuing.dispute" }, { "$ref": "#/components/schemas/issuing.transaction" }, { "$ref": "#/components/schemas/payout" }, { "$ref": "#/components/schemas/refund" }, { "$ref": "#/components/schemas/reserve_transaction" }, { "$ref": "#/components/schemas/tax_deducted_at_source" }, { "$ref": "#/components/schemas/topup" }, { "$ref": "#/components/schemas/transfer" }, { "$ref": "#/components/schemas/transfer_reversal" } ] }, "x-stripeBypassValidation": true }, "status": { "description": "The transaction's net funds status in the Stripe balance, which are either `available` or `pending`.", "maxLength": 5000, "type": "string" }, "type": { "description": "Transaction type: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `climate_order_purchase`, `climate_order_refund`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_outbound`, `obligation_reversal_inbound`, `payment`, `payment_failure_refund`, `payment_network_reserve_hold`, `payment_network_reserve_release`, `payment_refund`, `payment_reversal`, `payment_unreconciled`, `payout`, `payout_cancel`, `payout_failure`, `payout_minimum_balance_hold`, `payout_minimum_balance_release`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `stripe_balance_payment_debit`, `stripe_balance_payment_debit_reversal`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`. Learn more about [balance transaction types and what they represent](https://stripe.com/docs/reports/balance-transaction-types). To classify transactions for accounting purposes, consider `reporting_category` instead.", "enum": [ "adjustment", "advance", "advance_funding", "anticipation_repayment", "application_fee", "application_fee_refund", "charge", "climate_order_purchase", "climate_order_refund", "connect_collection_transfer", "contribution", "issuing_authorization_hold", "issuing_authorization_release", "issuing_dispute", "issuing_transaction", "obligation_outbound", "obligation_reversal_inbound", "payment", "payment_failure_refund", "payment_network_reserve_hold", "payment_network_reserve_release", "payment_refund", "payment_reversal", "payment_unreconciled", "payout", "payout_cancel", "payout_failure", "payout_minimum_balance_hold", "payout_minimum_balance_release", "refund", "refund_failure", "reserve_transaction", "reserved_funds", "stripe_balance_payment_debit", "stripe_balance_payment_debit_reversal", "stripe_fee", "stripe_fx_fee", "tax_fee", "topup", "topup_reversal", "transfer", "transfer_cancel", "transfer_failure", "transfer_refund" ], "type": "string" } }, "required": [ "amount", "available_on", "created", "currency", "fee", "fee_details", "id", "net", "object", "reporting_category", "status", "type" ], "title": "BalanceTransaction", "type": "object", "x-expandableFields": [ "fee_details", "source" ], "x-resourceId": "balance_transaction" }, "bank_account": { "description": "These bank accounts are payment methods on `Customer` objects.\n\nOn the other hand [External Accounts](/api#external_accounts) are transfer\ndestinations on `Account` objects for connected accounts.\nThey can be bank accounts or debit cards as well, and are documented in the links above.\n\nRelated guide: [Bank debits and transfers](/payments/bank-debits-transfers)", "properties": { "account": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/account" } ], "description": "The account this bank account belongs to. Only applicable on Accounts (not customers or recipients) This property is only available when returned as an [External Account](/api/external_account_bank_accounts/object) where [controller.is_controller](/api/accounts/object#account_object-controller-is_controller) is `true`.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/account" } ] } }, "account_holder_name": { "description": "The name of the person or business that owns the bank account.", "maxLength": 5000, "nullable": true, "type": "string" }, "account_holder_type": { "description": "The type of entity that holds the account. This can be either `individual` or `company`.", "maxLength": 5000, "nullable": true, "type": "string" }, "account_type": { "description": "The bank account type. This can only be `checking` or `savings` in most countries. In Japan, this can only be `futsu` or `toza`.", "maxLength": 5000, "nullable": true, "type": "string" }, "available_payout_methods": { "description": "A set of available payout methods for this bank account. Only values from this set should be passed as the `method` when creating a payout.", "items": { "enum": [ "instant", "standard" ], "type": "string" }, "nullable": true, "type": "array" }, "bank_name": { "description": "Name of the bank associated with the routing number (e.g., `WELLS FARGO`).", "maxLength": 5000, "nullable": true, "type": "string" }, "country": { "description": "Two-letter ISO code representing the country the bank account is located in.", "maxLength": 5000, "type": "string" }, "currency": { "description": "Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account.", "format": "currency", "type": "string" }, "customer": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/customer" }, { "$ref": "#/components/schemas/deleted_customer" } ], "description": "The ID of the customer that the bank account is associated with.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/customer" }, { "$ref": "#/components/schemas/deleted_customer" } ] } }, "default_for_currency": { "description": "Whether this bank account is the default external account for its currency.", "nullable": true, "type": "boolean" }, "fingerprint": { "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.", "maxLength": 5000, "nullable": true, "type": "string" }, "future_requirements": { "anyOf": [ { "$ref": "#/components/schemas/external_account_requirements" } ], "description": "Information about the [upcoming new requirements for the bank account](https://stripe.com/docs/connect/custom-accounts/future-requirements), including what information needs to be collected, and by when.", "nullable": true }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "last4": { "description": "The last four digits of the bank account number.", "maxLength": 5000, "type": "string" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "nullable": true, "type": "object" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "bank_account" ], "type": "string" }, "requirements": { "anyOf": [ { "$ref": "#/components/schemas/external_account_requirements" } ], "description": "Information about the requirements for the bank account, including what information needs to be collected.", "nullable": true }, "routing_number": { "description": "The routing transit number for the bank account.", "maxLength": 5000, "nullable": true, "type": "string" }, "status": { "description": "For bank accounts, possible values are `new`, `validated`, `verified`, `verification_failed`, or `errored`. A bank account that hasn't had any activity or validation performed is `new`. If Stripe can determine that the bank account exists, its status will be `validated`. Note that there often isn’t enough information to know (e.g., for smaller credit unions), and the validation is not always run. If customer bank account verification has succeeded, the bank account status will be `verified`. If the verification failed for any reason, such as microdeposit failure, the status will be `verification_failed`. If a payout sent to this bank account fails, we'll set the status to `errored` and will not continue to send [scheduled payouts](https://stripe.com/docs/payouts#payout-schedule) until the bank details are updated.\n\nFor external accounts, possible values are `new`, `errored` and `verification_failed`. If a payout fails, the status is set to `errored` and scheduled payouts are stopped until account details are updated. In the US and India, if we can't [verify the owner of the bank account](https://support.stripe.com/questions/bank-account-ownership-verification), we'll set the status to `verification_failed`. Other validations aren't run against external accounts because they're only used for payouts. This means the other statuses don't apply.", "maxLength": 5000, "type": "string" } }, "required": [ "country", "currency", "id", "last4", "object", "status" ], "title": "BankAccount", "type": "object", "x-expandableFields": [ "account", "customer", "future_requirements", "requirements" ], "x-resourceId": "bank_account" }, "bank_connections_resource_accountholder": { "description": "", "properties": { "account": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/account" } ], "description": "The ID of the Stripe account this account belongs to. Should only be present if `account_holder.type` is `account`.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/account" } ] } }, "customer": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/customer" } ], "description": "ID of the Stripe customer this account belongs to. Present if and only if `account_holder.type` is `customer`.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/customer" } ] } }, "type": { "description": "Type of account holder that this account belongs to.", "enum": [ "account", "customer" ], "type": "string" } }, "required": [ "type" ], "title": "BankConnectionsResourceAccountholder", "type": "object", "x-expandableFields": [ "account", "customer" ] }, "bank_connections_resource_balance": { "description": "", "properties": { "as_of": { "description": "The time that the external institution calculated this balance. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "cash": { "$ref": "#/components/schemas/bank_connections_resource_balance_api_resource_cash_balance" }, "credit": { "$ref": "#/components/schemas/bank_connections_resource_balance_api_resource_credit_balance" }, "current": { "additionalProperties": { "type": "integer" }, "description": "The balances owed to (or by) the account holder, before subtracting any outbound pending transactions or adding any inbound pending transactions.\n\nEach key is a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.\n\nEach value is a integer amount. A positive amount indicates money owed to the account holder. A negative amount indicates money owed by the account holder.", "type": "object" }, "type": { "description": "The `type` of the balance. An additional hash is included on the balance with a name matching this value.", "enum": [ "cash", "credit" ], "type": "string" } }, "required": [ "as_of", "current", "type" ], "title": "BankConnectionsResourceBalance", "type": "object", "x-expandableFields": [ "cash", "credit" ] }, "bank_connections_resource_balance_api_resource_cash_balance": { "description": "", "properties": { "available": { "additionalProperties": { "type": "integer" }, "description": "The funds available to the account holder. Typically this is the current balance after subtracting any outbound pending transactions and adding any inbound pending transactions.\n\nEach key is a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.\n\nEach value is a integer amount. A positive amount indicates money owed to the account holder. A negative amount indicates money owed by the account holder.", "nullable": true, "type": "object" } }, "title": "BankConnectionsResourceBalanceAPIResourceCashBalance", "type": "object", "x-expandableFields": [] }, "bank_connections_resource_balance_api_resource_credit_balance": { "description": "", "properties": { "used": { "additionalProperties": { "type": "integer" }, "description": "The credit that has been used by the account holder.\n\nEach key is a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.\n\nEach value is a integer amount. A positive amount indicates money owed to the account holder. A negative amount indicates money owed by the account holder.", "nullable": true, "type": "object" } }, "title": "BankConnectionsResourceBalanceAPIResourceCreditBalance", "type": "object", "x-expandableFields": [] }, "bank_connections_resource_balance_refresh": { "description": "", "properties": { "last_attempted_at": { "description": "The time at which the last refresh attempt was initiated. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "next_refresh_available_at": { "description": "Time at which the next balance refresh can be initiated. This value will be `null` when `status` is `pending`. Measured in seconds since the Unix epoch.", "format": "unix-time", "nullable": true, "type": "integer" }, "status": { "description": "The status of the last refresh attempt.", "enum": [ "failed", "pending", "succeeded" ], "type": "string" } }, "required": [ "last_attempted_at", "status" ], "title": "BankConnectionsResourceBalanceRefresh", "type": "object", "x-expandableFields": [] }, "bank_connections_resource_link_account_session_filters": { "description": "", "properties": { "account_subcategories": { "description": "Restricts the Session to subcategories of accounts that can be linked. Valid subcategories are: `checking`, `savings`, `mortgage`, `line_of_credit`, `credit_card`.", "items": { "enum": [ "checking", "credit_card", "line_of_credit", "mortgage", "savings" ], "type": "string" }, "nullable": true, "type": "array" }, "countries": { "description": "List of countries from which to filter accounts.", "items": { "maxLength": 5000, "type": "string" }, "nullable": true, "type": "array" } }, "title": "BankConnectionsResourceLinkAccountSessionFilters", "type": "object", "x-expandableFields": [] }, "bank_connections_resource_ownership_refresh": { "description": "", "properties": { "last_attempted_at": { "description": "The time at which the last refresh attempt was initiated. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "next_refresh_available_at": { "description": "Time at which the next ownership refresh can be initiated. This value will be `null` when `status` is `pending`. Measured in seconds since the Unix epoch.", "format": "unix-time", "nullable": true, "type": "integer" }, "status": { "description": "The status of the last refresh attempt.", "enum": [ "failed", "pending", "succeeded" ], "type": "string" } }, "required": [ "last_attempted_at", "status" ], "title": "BankConnectionsResourceOwnershipRefresh", "type": "object", "x-expandableFields": [] }, "bank_connections_resource_transaction_refresh": { "description": "", "properties": { "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "last_attempted_at": { "description": "The time at which the last refresh attempt was initiated. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "next_refresh_available_at": { "description": "Time at which the next transaction refresh can be initiated. This value will be `null` when `status` is `pending`. Measured in seconds since the Unix epoch.", "format": "unix-time", "nullable": true, "type": "integer" }, "status": { "description": "The status of the last refresh attempt.", "enum": [ "failed", "pending", "succeeded" ], "type": "string" } }, "required": [ "id", "last_attempted_at", "status" ], "title": "BankConnectionsResourceTransactionRefresh", "type": "object", "x-expandableFields": [] }, "bank_connections_resource_transaction_resource_status_transitions": { "description": "", "properties": { "posted_at": { "description": "Time at which this transaction posted. Measured in seconds since the Unix epoch.", "format": "unix-time", "nullable": true, "type": "integer" }, "void_at": { "description": "Time at which this transaction was voided. Measured in seconds since the Unix epoch.", "format": "unix-time", "nullable": true, "type": "integer" } }, "title": "BankConnectionsResourceTransactionResourceStatusTransitions", "type": "object", "x-expandableFields": [] }, "billing.alert": { "description": "A billing alert is a resource that notifies you when a certain usage threshold on a meter is crossed. For example, you might create a billing alert to notify you when a certain user made 100 API requests.", "properties": { "alert_type": { "description": "Defines the type of the alert.", "enum": [ "usage_threshold" ], "type": "string", "x-stripeBypassValidation": true }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "billing.alert" ], "type": "string" }, "status": { "description": "Status of the alert. This can be active, inactive or archived.", "enum": [ "active", "archived", "inactive" ], "nullable": true, "type": "string" }, "title": { "description": "Title of the alert.", "maxLength": 5000, "type": "string" }, "usage_threshold": { "anyOf": [ { "$ref": "#/components/schemas/thresholds_resource_usage_threshold_config" } ], "description": "Encapsulates configuration of the alert to monitor usage on a specific [Billing Meter](https://stripe.com/docs/api/billing/meter).", "nullable": true } }, "required": [ "alert_type", "id", "livemode", "object", "title" ], "title": "ThresholdsResourceAlert", "type": "object", "x-expandableFields": [ "usage_threshold" ], "x-resourceId": "billing.alert" }, "billing.credit_balance_summary": { "description": "Indicates the billing credit balance for billing credits granted to a customer.", "properties": { "balances": { "description": "The billing credit balances. One entry per credit grant currency. If a customer only has credit grants in a single currency, then this will have a single balance entry.", "items": { "$ref": "#/components/schemas/credit_balance" }, "type": "array" }, "customer": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/customer" }, { "$ref": "#/components/schemas/deleted_customer" } ], "description": "The customer the balance is for.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/customer" }, { "$ref": "#/components/schemas/deleted_customer" } ] } }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "billing.credit_balance_summary" ], "type": "string" } }, "required": [ "balances", "customer", "livemode", "object" ], "title": "CreditBalanceSummary", "type": "object", "x-expandableFields": [ "balances", "customer" ], "x-resourceId": "billing.credit_balance_summary" }, "billing.credit_balance_transaction": { "description": "A credit balance transaction is a resource representing a transaction (either a credit or a debit) against an existing credit grant.", "properties": { "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "credit": { "anyOf": [ { "$ref": "#/components/schemas/billing_credit_grants_resource_balance_credit" } ], "description": "Credit details for this credit balance transaction. Only present if type is `credit`.", "nullable": true }, "credit_grant": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/billing.credit_grant" } ], "description": "The credit grant associated with this credit balance transaction.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/billing.credit_grant" } ] } }, "debit": { "anyOf": [ { "$ref": "#/components/schemas/billing_credit_grants_resource_balance_debit" } ], "description": "Debit details for this credit balance transaction. Only present if type is `debit`.", "nullable": true }, "effective_at": { "description": "The effective time of this credit balance transaction.", "format": "unix-time", "type": "integer" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "billing.credit_balance_transaction" ], "type": "string" }, "test_clock": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/test_helpers.test_clock" } ], "description": "ID of the test clock this credit balance transaction belongs to.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/test_helpers.test_clock" } ] } }, "type": { "description": "The type of credit balance transaction (credit or debit).", "enum": [ "credit", "debit" ], "nullable": true, "type": "string" } }, "required": [ "created", "credit_grant", "effective_at", "id", "livemode", "object" ], "title": "CreditBalanceTransaction", "type": "object", "x-expandableFields": [ "credit", "credit_grant", "debit", "test_clock" ], "x-resourceId": "billing.credit_balance_transaction" }, "billing.credit_grant": { "description": "A credit grant is an API resource that documents the allocation of some billing credits to a customer.\n\nRelated guide: [Billing credits](https://docs.stripe.com/billing/subscriptions/usage-based/billing-credits)", "properties": { "amount": { "$ref": "#/components/schemas/billing_credit_grants_resource_amount" }, "applicability_config": { "$ref": "#/components/schemas/billing_credit_grants_resource_applicability_config" }, "category": { "description": "The category of this credit grant. This is for tracking purposes and isn't displayed to the customer.", "enum": [ "paid", "promotional" ], "type": "string" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "customer": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/customer" }, { "$ref": "#/components/schemas/deleted_customer" } ], "description": "ID of the customer receiving the billing credits.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/customer" }, { "$ref": "#/components/schemas/deleted_customer" } ] } }, "effective_at": { "description": "The time when the billing credits become effective-when they're eligible for use.", "format": "unix-time", "nullable": true, "type": "integer" }, "expires_at": { "description": "The time when the billing credits expire. If not present, the billing credits don't expire.", "format": "unix-time", "nullable": true, "type": "integer" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "type": "object" }, "name": { "description": "A descriptive name shown in dashboard.", "maxLength": 5000, "nullable": true, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "billing.credit_grant" ], "type": "string" }, "priority": { "description": "The priority for applying this credit grant. The highest priority is 0 and the lowest is 100.", "nullable": true, "type": "integer" }, "test_clock": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/test_helpers.test_clock" } ], "description": "ID of the test clock this credit grant belongs to.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/test_helpers.test_clock" } ] } }, "updated": { "description": "Time at which the object was last updated. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "voided_at": { "description": "The time when this credit grant was voided. If not present, the credit grant hasn't been voided.", "format": "unix-time", "nullable": true, "type": "integer" } }, "required": [ "amount", "applicability_config", "category", "created", "customer", "id", "livemode", "metadata", "object", "updated" ], "title": "CreditGrant", "type": "object", "x-expandableFields": [ "amount", "applicability_config", "customer", "test_clock" ], "x-resourceId": "billing.credit_grant" }, "billing.meter": { "description": "Meters specify how to aggregate meter events over a billing period. Meter events represent the actions that customers take in your system. Meters attach to prices and form the basis of the bill.\n\nRelated guide: [Usage based billing](https://docs.stripe.com/billing/subscriptions/usage-based)", "properties": { "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "customer_mapping": { "$ref": "#/components/schemas/billing_meter_resource_customer_mapping_settings" }, "default_aggregation": { "$ref": "#/components/schemas/billing_meter_resource_aggregation_settings" }, "display_name": { "description": "The meter's name.", "maxLength": 5000, "type": "string" }, "event_name": { "description": "The name of the meter event to record usage for. Corresponds with the `event_name` field on meter events.", "maxLength": 5000, "type": "string" }, "event_time_window": { "description": "The time window which meter events have been pre-aggregated for, if any.", "enum": [ "day", "hour" ], "nullable": true, "type": "string" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "billing.meter" ], "type": "string" }, "status": { "description": "The meter's status.", "enum": [ "active", "inactive" ], "type": "string" }, "status_transitions": { "$ref": "#/components/schemas/billing_meter_resource_billing_meter_status_transitions" }, "updated": { "description": "Time at which the object was last updated. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "value_settings": { "$ref": "#/components/schemas/billing_meter_resource_billing_meter_value" } }, "required": [ "created", "customer_mapping", "default_aggregation", "display_name", "event_name", "id", "livemode", "object", "status", "status_transitions", "updated", "value_settings" ], "title": "BillingMeter", "type": "object", "x-expandableFields": [ "customer_mapping", "default_aggregation", "status_transitions", "value_settings" ], "x-resourceId": "billing.meter" }, "billing.meter_event": { "description": "Meter events represent actions that customers take in your system. You can use meter events to bill a customer based on their usage. Meter events are associated with billing meters, which define both the contents of the event’s payload and how to aggregate those events.", "properties": { "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "event_name": { "description": "The name of the meter event. Corresponds with the `event_name` field on a meter.", "maxLength": 100, "type": "string" }, "identifier": { "description": "A unique identifier for the event.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "billing.meter_event" ], "type": "string" }, "payload": { "additionalProperties": { "maxLength": 100, "type": "string" }, "description": "The payload of the event. This contains the fields corresponding to a meter's `customer_mapping.event_payload_key` (default is `stripe_customer_id`) and `value_settings.event_payload_key` (default is `value`). Read more about the [payload](https://stripe.com/docs/billing/subscriptions/usage-based/recording-usage#payload-key-overrides).", "type": "object" }, "timestamp": { "description": "The timestamp passed in when creating the event. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" } }, "required": [ "created", "event_name", "identifier", "livemode", "object", "payload", "timestamp" ], "title": "BillingMeterEvent", "type": "object", "x-expandableFields": [], "x-resourceId": "billing.meter_event" }, "billing.meter_event_adjustment": { "description": "A billing meter event adjustment is a resource that allows you to cancel a meter event. For example, you might create a billing meter event adjustment to cancel a meter event that was created in error or attached to the wrong customer.", "properties": { "cancel": { "anyOf": [ { "$ref": "#/components/schemas/billing_meter_resource_billing_meter_event_adjustment_cancel" } ], "description": "Specifies which event to cancel.", "nullable": true }, "event_name": { "description": "The name of the meter event. Corresponds with the `event_name` field on a meter.", "maxLength": 100, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "billing.meter_event_adjustment" ], "type": "string" }, "status": { "description": "The meter event adjustment's status.", "enum": [ "complete", "pending" ], "type": "string" }, "type": { "description": "Specifies whether to cancel a single event or a range of events for a time period. Time period cancellation is not supported yet.", "enum": [ "cancel" ], "type": "string" } }, "required": [ "event_name", "livemode", "object", "status", "type" ], "title": "BillingMeterEventAdjustment", "type": "object", "x-expandableFields": [ "cancel" ], "x-resourceId": "billing.meter_event_adjustment" }, "billing.meter_event_summary": { "description": "A billing meter event summary represents an aggregated view of a customer's billing meter events within a specified timeframe. It indicates how much\nusage was accrued by a customer for that period.\n\nNote: Meters events are aggregated asynchronously so the meter event summaries provide an eventually consistent view of the reported usage.", "properties": { "aggregated_value": { "description": "Aggregated value of all the events within `start_time` (inclusive) and `end_time` (inclusive). The aggregation strategy is defined on meter via `default_aggregation`.", "type": "number" }, "end_time": { "description": "End timestamp for this event summary (exclusive). Must be aligned with minute boundaries.", "format": "unix-time", "type": "integer" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "meter": { "description": "The meter associated with this event summary.", "maxLength": 5000, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "billing.meter_event_summary" ], "type": "string" }, "start_time": { "description": "Start timestamp for this event summary (inclusive). Must be aligned with minute boundaries.", "format": "unix-time", "type": "integer" } }, "required": [ "aggregated_value", "end_time", "id", "livemode", "meter", "object", "start_time" ], "title": "BillingMeterEventSummary", "type": "object", "x-expandableFields": [], "x-resourceId": "billing.meter_event_summary" }, "billing_bill_resource_invoice_item_parents_invoice_item_parent": { "description": "", "properties": { "subscription_details": { "anyOf": [ { "$ref": "#/components/schemas/billing_bill_resource_invoice_item_parents_invoice_item_subscription_parent" } ], "description": "Details about the subscription that generated this invoice item", "nullable": true }, "type": { "description": "The type of parent that generated this invoice item", "enum": [ "subscription_details" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "BillingBillResourceInvoiceItemParentsInvoiceItemParent", "type": "object", "x-expandableFields": [ "subscription_details" ] }, "billing_bill_resource_invoice_item_parents_invoice_item_subscription_parent": { "description": "", "properties": { "subscription": { "description": "The subscription that generated this invoice item", "maxLength": 5000, "type": "string" }, "subscription_item": { "description": "The subscription item that generated this invoice item", "maxLength": 5000, "type": "string" } }, "required": [ "subscription" ], "title": "BillingBillResourceInvoiceItemParentsInvoiceItemSubscriptionParent", "type": "object", "x-expandableFields": [] }, "billing_bill_resource_invoicing_lines_common_credited_items": { "description": "", "properties": { "invoice": { "description": "Invoice containing the credited invoice line items", "maxLength": 5000, "type": "string" }, "invoice_line_items": { "description": "Credited invoice line items", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "required": [ "invoice", "invoice_line_items" ], "title": "BillingBillResourceInvoicingLinesCommonCreditedItems", "type": "object", "x-expandableFields": [] }, "billing_bill_resource_invoicing_lines_common_proration_details": { "description": "", "properties": { "credited_items": { "anyOf": [ { "$ref": "#/components/schemas/billing_bill_resource_invoicing_lines_common_credited_items" } ], "description": "For a credit proration `line_item`, the original debit line_items to which the credit proration applies.", "nullable": true } }, "title": "BillingBillResourceInvoicingLinesCommonProrationDetails", "type": "object", "x-expandableFields": [ "credited_items" ] }, "billing_bill_resource_invoicing_lines_parents_invoice_line_item_invoice_item_parent": { "description": "", "properties": { "invoice_item": { "description": "The invoice item that generated this line item", "maxLength": 5000, "type": "string" }, "proration": { "description": "Whether this is a proration", "type": "boolean" }, "proration_details": { "anyOf": [ { "$ref": "#/components/schemas/billing_bill_resource_invoicing_lines_common_proration_details" } ], "description": "Additional details for proration line items", "nullable": true }, "subscription": { "description": "The subscription that the invoice item belongs to", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "invoice_item", "proration" ], "title": "BillingBillResourceInvoicingLinesParentsInvoiceLineItemInvoiceItemParent", "type": "object", "x-expandableFields": [ "proration_details" ] }, "billing_bill_resource_invoicing_lines_parents_invoice_line_item_parent": { "description": "", "properties": { "invoice_item_details": { "anyOf": [ { "$ref": "#/components/schemas/billing_bill_resource_invoicing_lines_parents_invoice_line_item_invoice_item_parent" } ], "description": "Details about the invoice item that generated this line item", "nullable": true }, "subscription_item_details": { "anyOf": [ { "$ref": "#/components/schemas/billing_bill_resource_invoicing_lines_parents_invoice_line_item_subscription_item_parent" } ], "description": "Details about the subscription item that generated this line item", "nullable": true }, "type": { "description": "The type of parent that generated this line item", "enum": [ "invoice_item_details", "subscription_item_details" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "BillingBillResourceInvoicingLinesParentsInvoiceLineItemParent", "type": "object", "x-expandableFields": [ "invoice_item_details", "subscription_item_details" ] }, "billing_bill_resource_invoicing_lines_parents_invoice_line_item_subscription_item_parent": { "description": "", "properties": { "invoice_item": { "description": "The invoice item that generated this line item", "maxLength": 5000, "nullable": true, "type": "string" }, "proration": { "description": "Whether this is a proration", "type": "boolean" }, "proration_details": { "anyOf": [ { "$ref": "#/components/schemas/billing_bill_resource_invoicing_lines_common_proration_details" } ], "description": "Additional details for proration line items", "nullable": true }, "subscription": { "description": "The subscription that the subscription item belongs to", "maxLength": 5000, "nullable": true, "type": "string" }, "subscription_item": { "description": "The subscription item that generated this line item", "maxLength": 5000, "type": "string" } }, "required": [ "proration", "subscription_item" ], "title": "BillingBillResourceInvoicingLinesParentsInvoiceLineItemSubscriptionItemParent", "type": "object", "x-expandableFields": [ "proration_details" ] }, "billing_bill_resource_invoicing_parents_invoice_parent": { "description": "", "properties": { "quote_details": { "anyOf": [ { "$ref": "#/components/schemas/billing_bill_resource_invoicing_parents_invoice_quote_parent" } ], "description": "Details about the quote that generated this invoice", "nullable": true }, "subscription_details": { "anyOf": [ { "$ref": "#/components/schemas/billing_bill_resource_invoicing_parents_invoice_subscription_parent" } ], "description": "Details about the subscription that generated this invoice", "nullable": true }, "type": { "description": "The type of parent that generated this invoice", "enum": [ "quote_details", "subscription_details" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "BillingBillResourceInvoicingParentsInvoiceParent", "type": "object", "x-expandableFields": [ "quote_details", "subscription_details" ] }, "billing_bill_resource_invoicing_parents_invoice_quote_parent": { "description": "", "properties": { "quote": { "description": "The quote that generated this invoice", "maxLength": 5000, "type": "string" } }, "required": [ "quote" ], "title": "BillingBillResourceInvoicingParentsInvoiceQuoteParent", "type": "object", "x-expandableFields": [] }, "billing_bill_resource_invoicing_parents_invoice_subscription_parent": { "description": "", "properties": { "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) defined as subscription metadata when an invoice is created. Becomes an immutable snapshot of the subscription metadata at the time of invoice finalization.\n *Note: This attribute is populated only for invoices created on or after June 29, 2023.*", "nullable": true, "type": "object" }, "subscription": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/subscription" } ], "description": "The subscription that generated this invoice", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/subscription" } ] } }, "subscription_proration_date": { "description": "Only set for upcoming invoices that preview prorations. The time used to calculate prorations.", "format": "unix-time", "type": "integer" } }, "required": [ "subscription" ], "title": "BillingBillResourceInvoicingParentsInvoiceSubscriptionParent", "type": "object", "x-expandableFields": [ "subscription" ] }, "billing_bill_resource_invoicing_pricing_pricing": { "description": "", "properties": { "price_details": { "$ref": "#/components/schemas/billing_bill_resource_invoicing_pricing_pricing_price_details" }, "type": { "description": "The type of the pricing details.", "enum": [ "price_details" ], "type": "string", "x-stripeBypassValidation": true }, "unit_amount_decimal": { "description": "The unit amount (in the `currency` specified) of the item which contains a decimal value with at most 12 decimal places.", "format": "decimal", "nullable": true, "type": "string" } }, "required": [ "type" ], "title": "BillingBillResourceInvoicingPricingPricing", "type": "object", "x-expandableFields": [ "price_details" ] }, "billing_bill_resource_invoicing_pricing_pricing_price_details": { "description": "", "properties": { "price": { "description": "The ID of the price this item is associated with.", "maxLength": 5000, "type": "string" }, "product": { "description": "The ID of the product this item is associated with.", "maxLength": 5000, "type": "string" } }, "required": [ "price", "product" ], "title": "BillingBillResourceInvoicingPricingPricingPriceDetails", "type": "object", "x-expandableFields": [] }, "billing_bill_resource_invoicing_taxes_tax": { "description": "", "properties": { "amount": { "description": "The amount of the tax, in cents (or local equivalent).", "type": "integer" }, "tax_behavior": { "description": "Whether this tax is inclusive or exclusive.", "enum": [ "exclusive", "inclusive" ], "type": "string" }, "tax_rate_details": { "anyOf": [ { "$ref": "#/components/schemas/billing_bill_resource_invoicing_taxes_tax_rate_details" } ], "description": "Additional details about the tax rate. Only present when `type` is `tax_rate_details`.", "nullable": true }, "taxability_reason": { "description": "The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.", "enum": [ "customer_exempt", "not_available", "not_collecting", "not_subject_to_tax", "not_supported", "portion_product_exempt", "portion_reduced_rated", "portion_standard_rated", "product_exempt", "product_exempt_holiday", "proportionally_rated", "reduced_rated", "reverse_charge", "standard_rated", "taxable_basis_reduced", "zero_rated" ], "type": "string", "x-stripeBypassValidation": true }, "taxable_amount": { "description": "The amount on which tax is calculated, in cents (or local equivalent).", "nullable": true, "type": "integer" }, "type": { "description": "The type of tax information.", "enum": [ "tax_rate_details" ], "type": "string" } }, "required": [ "amount", "tax_behavior", "taxability_reason", "type" ], "title": "BillingBillResourceInvoicingTaxesTax", "type": "object", "x-expandableFields": [ "tax_rate_details" ] }, "billing_bill_resource_invoicing_taxes_tax_rate_details": { "description": "", "properties": { "tax_rate": { "maxLength": 5000, "type": "string" } }, "required": [ "tax_rate" ], "title": "BillingBillResourceInvoicingTaxesTaxRateDetails", "type": "object", "x-expandableFields": [] }, "billing_clocks_resource_status_details_advancing_status_details": { "description": "", "properties": { "target_frozen_time": { "description": "The `frozen_time` that the Test Clock is advancing towards.", "format": "unix-time", "type": "integer" } }, "required": [ "target_frozen_time" ], "title": "BillingClocksResourceStatusDetailsAdvancingStatusDetails", "type": "object", "x-expandableFields": [] }, "billing_clocks_resource_status_details_status_details": { "description": "", "properties": { "advancing": { "$ref": "#/components/schemas/billing_clocks_resource_status_details_advancing_status_details" } }, "title": "BillingClocksResourceStatusDetailsStatusDetails", "type": "object", "x-expandableFields": [ "advancing" ] }, "billing_credit_grants_resource_amount": { "description": "", "properties": { "monetary": { "anyOf": [ { "$ref": "#/components/schemas/billing_credit_grants_resource_monetary_amount" } ], "description": "The monetary amount.", "nullable": true }, "type": { "description": "The type of this amount. We currently only support `monetary` billing credits.", "enum": [ "monetary" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "BillingCreditGrantsResourceAmount", "type": "object", "x-expandableFields": [ "monetary" ] }, "billing_credit_grants_resource_applicability_config": { "description": "", "properties": { "scope": { "$ref": "#/components/schemas/billing_credit_grants_resource_scope" } }, "required": [ "scope" ], "title": "BillingCreditGrantsResourceApplicabilityConfig", "type": "object", "x-expandableFields": [ "scope" ] }, "billing_credit_grants_resource_applicable_price": { "description": "", "properties": { "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "BillingCreditGrantsResourceApplicablePrice", "type": "object", "x-expandableFields": [] }, "billing_credit_grants_resource_balance_credit": { "description": "", "properties": { "amount": { "$ref": "#/components/schemas/billing_credit_grants_resource_amount" }, "credits_application_invoice_voided": { "anyOf": [ { "$ref": "#/components/schemas/billing_credit_grants_resource_balance_credits_application_invoice_voided" } ], "description": "Details of the invoice to which the reinstated credits were originally applied. Only present if `type` is `credits_application_invoice_voided`.", "nullable": true }, "type": { "description": "The type of credit transaction.", "enum": [ "credits_application_invoice_voided", "credits_granted" ], "type": "string" } }, "required": [ "amount", "type" ], "title": "BillingCreditGrantsResourceBalanceCredit", "type": "object", "x-expandableFields": [ "amount", "credits_application_invoice_voided" ] }, "billing_credit_grants_resource_balance_credits_application_invoice_voided": { "description": "", "properties": { "invoice": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/invoice" } ], "description": "The invoice to which the reinstated billing credits were originally applied.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/invoice" } ] } }, "invoice_line_item": { "description": "The invoice line item to which the reinstated billing credits were originally applied.", "maxLength": 5000, "type": "string" } }, "required": [ "invoice", "invoice_line_item" ], "title": "BillingCreditGrantsResourceBalanceCreditsApplicationInvoiceVoided", "type": "object", "x-expandableFields": [ "invoice" ] }, "billing_credit_grants_resource_balance_credits_applied": { "description": "", "properties": { "invoice": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/invoice" } ], "description": "The invoice to which the billing credits were applied.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/invoice" } ] } }, "invoice_line_item": { "description": "The invoice line item to which the billing credits were applied.", "maxLength": 5000, "type": "string" } }, "required": [ "invoice", "invoice_line_item" ], "title": "BillingCreditGrantsResourceBalanceCreditsApplied", "type": "object", "x-expandableFields": [ "invoice" ] }, "billing_credit_grants_resource_balance_debit": { "description": "", "properties": { "amount": { "$ref": "#/components/schemas/billing_credit_grants_resource_amount" }, "credits_applied": { "anyOf": [ { "$ref": "#/components/schemas/billing_credit_grants_resource_balance_credits_applied" } ], "description": "Details of how the billing credits were applied to an invoice. Only present if `type` is `credits_applied`.", "nullable": true }, "type": { "description": "The type of debit transaction.", "enum": [ "credits_applied", "credits_expired", "credits_voided" ], "type": "string" } }, "required": [ "amount", "type" ], "title": "BillingCreditGrantsResourceBalanceDebit", "type": "object", "x-expandableFields": [ "amount", "credits_applied" ] }, "billing_credit_grants_resource_monetary_amount": { "description": "", "properties": { "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "maxLength": 5000, "type": "string" }, "value": { "description": "A positive integer representing the amount.", "type": "integer" } }, "required": [ "currency", "value" ], "title": "BillingCreditGrantsResourceMonetaryAmount", "type": "object", "x-expandableFields": [] }, "billing_credit_grants_resource_scope": { "description": "", "properties": { "price_type": { "description": "The price type that credit grants can apply to. We currently only support the `metered` price type. This refers to prices that have a [Billing Meter](https://docs.stripe.com/api/billing/meter) attached to them. Cannot be used in combination with `prices`.", "enum": [ "metered" ], "type": "string" }, "prices": { "description": "The prices that credit grants can apply to. We currently only support `metered` prices. This refers to prices that have a [Billing Meter](https://docs.stripe.com/api/billing/meter) attached to them. Cannot be used in combination with `price_type`.", "items": { "$ref": "#/components/schemas/billing_credit_grants_resource_applicable_price" }, "type": "array" } }, "title": "BillingCreditGrantsResourceScope", "type": "object", "x-expandableFields": [ "prices" ] }, "billing_details": { "description": "", "properties": { "address": { "anyOf": [ { "$ref": "#/components/schemas/address" } ], "description": "Billing address.", "nullable": true }, "email": { "description": "Email address.", "maxLength": 5000, "nullable": true, "type": "string" }, "name": { "description": "Full name.", "maxLength": 5000, "nullable": true, "type": "string" }, "phone": { "description": "Billing phone number (including extension).", "maxLength": 5000, "nullable": true, "type": "string" }, "tax_id": { "description": "Taxpayer identification number. Used only for transactions between LATAM buyers and non-LATAM sellers.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "billing_details", "type": "object", "x-expandableFields": [ "address" ] }, "billing_meter_resource_aggregation_settings": { "description": "", "properties": { "formula": { "description": "Specifies how events are aggregated.", "enum": [ "count", "last", "sum" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "formula" ], "title": "BillingMeterResourceAggregationSettings", "type": "object", "x-expandableFields": [] }, "billing_meter_resource_billing_meter_event_adjustment_cancel": { "description": "", "properties": { "identifier": { "description": "Unique identifier for the event.", "maxLength": 100, "nullable": true, "type": "string" } }, "title": "BillingMeterResourceBillingMeterEventAdjustmentCancel", "type": "object", "x-expandableFields": [] }, "billing_meter_resource_billing_meter_status_transitions": { "description": "", "properties": { "deactivated_at": { "description": "The time the meter was deactivated, if any. Measured in seconds since Unix epoch.", "format": "unix-time", "nullable": true, "type": "integer" } }, "title": "BillingMeterResourceBillingMeterStatusTransitions", "type": "object", "x-expandableFields": [] }, "billing_meter_resource_billing_meter_value": { "description": "", "properties": { "event_payload_key": { "description": "The key in the meter event payload to use as the value for this meter.", "maxLength": 5000, "type": "string" } }, "required": [ "event_payload_key" ], "title": "BillingMeterResourceBillingMeterValue", "type": "object", "x-expandableFields": [] }, "billing_meter_resource_customer_mapping_settings": { "description": "", "properties": { "event_payload_key": { "description": "The key in the meter event payload to use for mapping the event to a customer.", "maxLength": 5000, "type": "string" }, "type": { "description": "The method for mapping a meter event to a customer.", "enum": [ "by_id" ], "type": "string" } }, "required": [ "event_payload_key", "type" ], "title": "BillingMeterResourceCustomerMappingSettings", "type": "object", "x-expandableFields": [] }, "billing_portal.configuration": { "description": "A portal configuration describes the functionality and behavior of a portal session.", "properties": { "active": { "description": "Whether the configuration is active and can be used to create portal sessions.", "type": "boolean" }, "application": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/application" }, { "$ref": "#/components/schemas/deleted_application" } ], "description": "ID of the Connect Application that created the configuration.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/application" }, { "$ref": "#/components/schemas/deleted_application" } ] } }, "business_profile": { "$ref": "#/components/schemas/portal_business_profile" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "default_return_url": { "description": "The default URL to redirect customers to when they click on the portal's link to return to your website. This can be [overriden](https://stripe.com/docs/api/customer_portal/sessions/create#create_portal_session-return_url) when creating the session.", "maxLength": 5000, "nullable": true, "type": "string" }, "features": { "$ref": "#/components/schemas/portal_features" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "is_default": { "description": "Whether the configuration is the default. If `true`, this configuration can be managed in the Dashboard and portal sessions will use this configuration unless it is overriden when creating the session.", "type": "boolean" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "login_page": { "$ref": "#/components/schemas/portal_login_page" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "nullable": true, "type": "object" }, "name": { "description": "The name of the configuration.", "maxLength": 5000, "nullable": true, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "billing_portal.configuration" ], "type": "string" }, "updated": { "description": "Time at which the object was last updated. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" } }, "required": [ "active", "business_profile", "created", "features", "id", "is_default", "livemode", "login_page", "object", "updated" ], "title": "PortalConfiguration", "type": "object", "x-expandableFields": [ "application", "business_profile", "features", "login_page" ], "x-resourceId": "billing_portal.configuration" }, "billing_portal.session": { "description": "The Billing customer portal is a Stripe-hosted UI for subscription and\nbilling management.\n\nA portal configuration describes the functionality and features that you\nwant to provide to your customers through the portal.\n\nA portal session describes the instantiation of the customer portal for\na particular customer. By visiting the session's URL, the customer\ncan manage their subscriptions and billing details. For security reasons,\nsessions are short-lived and will expire if the customer does not visit the URL.\nCreate sessions on-demand when customers intend to manage their subscriptions\nand billing details.\n\nRelated guide: [Customer management](/customer-management)", "properties": { "configuration": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/billing_portal.configuration" } ], "description": "The configuration used by this session, describing the features available.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/billing_portal.configuration" } ] } }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "customer": { "description": "The ID of the customer for this session.", "maxLength": 5000, "type": "string" }, "flow": { "anyOf": [ { "$ref": "#/components/schemas/portal_flows_flow" } ], "description": "Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows.", "nullable": true }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "locale": { "description": "The IETF language tag of the locale Customer Portal is displayed in. If blank or auto, the customer’s `preferred_locales` or browser’s locale is used.", "enum": [ "auto", "bg", "cs", "da", "de", "el", "en", "en-AU", "en-CA", "en-GB", "en-IE", "en-IN", "en-NZ", "en-SG", "es", "es-419", "et", "fi", "fil", "fr", "fr-CA", "hr", "hu", "id", "it", "ja", "ko", "lt", "lv", "ms", "mt", "nb", "nl", "pl", "pt", "pt-BR", "ro", "ru", "sk", "sl", "sv", "th", "tr", "vi", "zh", "zh-HK", "zh-TW" ], "nullable": true, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "billing_portal.session" ], "type": "string" }, "on_behalf_of": { "description": "The account for which the session was created on behalf of. When specified, only subscriptions and invoices with this `on_behalf_of` account appear in the portal. For more information, see the [docs](https://stripe.com/docs/connect/separate-charges-and-transfers#settlement-merchant). Use the [Accounts API](https://stripe.com/docs/api/accounts/object#account_object-settings-branding) to modify the `on_behalf_of` account's branding settings, which the portal displays.", "maxLength": 5000, "nullable": true, "type": "string" }, "return_url": { "description": "The URL to redirect customers to when they click on the portal's link to return to your website.", "maxLength": 5000, "nullable": true, "type": "string" }, "url": { "description": "The short-lived URL of the session that gives customers access to the customer portal.", "maxLength": 5000, "type": "string" } }, "required": [ "configuration", "created", "customer", "id", "livemode", "object", "url" ], "title": "PortalSession", "type": "object", "x-expandableFields": [ "configuration", "flow" ], "x-resourceId": "billing_portal.session" }, "cancellation_details": { "description": "", "properties": { "comment": { "description": "Additional comments about why the user canceled the subscription, if the subscription was canceled explicitly by the user.", "maxLength": 5000, "nullable": true, "type": "string" }, "feedback": { "description": "The customer submitted reason for why they canceled, if the subscription was canceled explicitly by the user.", "enum": [ "customer_service", "low_quality", "missing_features", "other", "switched_service", "too_complex", "too_expensive", "unused" ], "nullable": true, "type": "string" }, "reason": { "description": "Why this subscription was canceled.", "enum": [ "cancellation_requested", "payment_disputed", "payment_failed" ], "nullable": true, "type": "string" } }, "title": "CancellationDetails", "type": "object", "x-expandableFields": [] }, "capability": { "description": "This is an object representing a capability for a Stripe account.\n\nRelated guide: [Account capabilities](https://stripe.com/docs/connect/account-capabilities)", "properties": { "account": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/account" } ], "description": "The account for which the capability enables functionality.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/account" } ] } }, "future_requirements": { "$ref": "#/components/schemas/account_capability_future_requirements" }, "id": { "description": "The identifier for the capability.", "maxLength": 5000, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "capability" ], "type": "string" }, "requested": { "description": "Whether the capability has been requested.", "type": "boolean" }, "requested_at": { "description": "Time at which the capability was requested. Measured in seconds since the Unix epoch.", "format": "unix-time", "nullable": true, "type": "integer" }, "requirements": { "$ref": "#/components/schemas/account_capability_requirements" }, "status": { "description": "The status of the capability.", "enum": [ "active", "inactive", "pending", "unrequested" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "account", "id", "object", "requested", "status" ], "title": "AccountCapability", "type": "object", "x-expandableFields": [ "account", "future_requirements", "requirements" ], "x-resourceId": "capability" }, "card": { "description": "You can store multiple cards on a customer in order to charge the customer\nlater. You can also store multiple debit cards on a recipient in order to\ntransfer to those cards later.\n\nRelated guide: [Card payments with Sources](https://stripe.com/docs/sources/cards)", "properties": { "account": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/account" } ], "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/account" } ] } }, "address_city": { "description": "City/District/Suburb/Town/Village.", "maxLength": 5000, "nullable": true, "type": "string" }, "address_country": { "description": "Billing address country, if provided when creating card.", "maxLength": 5000, "nullable": true, "type": "string" }, "address_line1": { "description": "Address line 1 (Street address/PO Box/Company name).", "maxLength": 5000, "nullable": true, "type": "string" }, "address_line1_check": { "description": "If `address_line1` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.", "maxLength": 5000, "nullable": true, "type": "string" }, "address_line2": { "description": "Address line 2 (Apartment/Suite/Unit/Building).", "maxLength": 5000, "nullable": true, "type": "string" }, "address_state": { "description": "State/County/Province/Region.", "maxLength": 5000, "nullable": true, "type": "string" }, "address_zip": { "description": "ZIP or postal code.", "maxLength": 5000, "nullable": true, "type": "string" }, "address_zip_check": { "description": "If `address_zip` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.", "maxLength": 5000, "nullable": true, "type": "string" }, "allow_redisplay": { "description": "This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to “unspecified”.", "enum": [ "always", "limited", "unspecified" ], "nullable": true, "type": "string" }, "available_payout_methods": { "description": "A set of available payout methods for this card. Only values from this set should be passed as the `method` when creating a payout.", "items": { "enum": [ "instant", "standard" ], "type": "string" }, "nullable": true, "type": "array" }, "brand": { "description": "Card brand. Can be `American Express`, `Diners Club`, `Discover`, `Eftpos Australia`, `Girocard`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`.", "maxLength": 5000, "type": "string" }, "country": { "description": "Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.", "maxLength": 5000, "nullable": true, "type": "string" }, "currency": { "description": "Three-letter [ISO code for currency](https://www.iso.org/iso-4217-currency-codes.html) in lowercase. Must be a [supported currency](https://docs.stripe.com/currencies). Only applicable on accounts (not customers or recipients). The card can be used as a transfer destination for funds in this currency. This property is only available when returned as an [External Account](/api/external_account_cards/object) where [controller.is_controller](/api/accounts/object#account_object-controller-is_controller) is `true`.", "format": "currency", "nullable": true, "type": "string" }, "customer": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/customer" }, { "$ref": "#/components/schemas/deleted_customer" } ], "description": "The customer that this card belongs to. This attribute will not be in the card object if the card belongs to an account or recipient instead.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/customer" }, { "$ref": "#/components/schemas/deleted_customer" } ] } }, "cvc_check": { "description": "If a CVC was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`. A result of unchecked indicates that CVC was provided but hasn't been checked yet. Checks are typically performed when attaching a card to a Customer object, or when creating a charge. For more details, see [Check if a card is valid without a charge](https://support.stripe.com/questions/check-if-a-card-is-valid-without-a-charge).", "maxLength": 5000, "nullable": true, "type": "string" }, "default_for_currency": { "description": "Whether this card is the default external account for its currency. This property is only available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.", "nullable": true, "type": "boolean" }, "dynamic_last4": { "description": "(For tokenized numbers only.) The last four digits of the device account number.", "maxLength": 5000, "nullable": true, "type": "string" }, "exp_month": { "description": "Two-digit number representing the card's expiration month.", "type": "integer" }, "exp_year": { "description": "Four-digit number representing the card's expiration year.", "type": "integer" }, "fingerprint": { "description": "Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.\n\n*As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*", "maxLength": 5000, "nullable": true, "type": "string" }, "funding": { "description": "Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.", "maxLength": 5000, "type": "string" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "iin": { "description": "Issuer identification number of the card.", "maxLength": 5000, "type": "string" }, "last4": { "description": "The last four digits of the card.", "maxLength": 5000, "type": "string" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "nullable": true, "type": "object" }, "name": { "description": "Cardholder name.", "maxLength": 5000, "nullable": true, "type": "string" }, "networks": { "$ref": "#/components/schemas/token_card_networks" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "card" ], "type": "string" }, "regulated_status": { "description": "Status of a card based on the card issuer.", "enum": [ "regulated", "unregulated" ], "nullable": true, "type": "string" }, "status": { "description": "For external accounts that are cards, possible values are `new` and `errored`. If a payout fails, the status is set to `errored` and [scheduled payouts](https://stripe.com/docs/payouts#payout-schedule) are stopped until account details are updated.", "maxLength": 5000, "nullable": true, "type": "string" }, "tokenization_method": { "description": "If the card number is tokenized, this is the method that was used. Can be `android_pay` (includes Google Pay), `apple_pay`, `masterpass`, `visa_checkout`, or null.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "brand", "exp_month", "exp_year", "funding", "id", "last4", "object" ], "title": "Card", "type": "object", "x-expandableFields": [ "account", "customer", "networks" ], "x-resourceId": "card" }, "card_generated_from_payment_method_details": { "description": "", "properties": { "card_present": { "$ref": "#/components/schemas/payment_method_details_card_present" }, "type": { "description": "The type of payment method transaction-specific details from the transaction that generated this `card` payment method. Always `card_present`.", "maxLength": 5000, "type": "string" } }, "required": [ "type" ], "title": "card_generated_from_payment_method_details", "type": "object", "x-expandableFields": [ "card_present" ] }, "card_issuing_account_terms_of_service": { "description": "", "properties": { "date": { "description": "The Unix timestamp marking when the account representative accepted the service agreement.", "nullable": true, "type": "integer" }, "ip": { "description": "The IP address from which the account representative accepted the service agreement.", "maxLength": 5000, "nullable": true, "type": "string" }, "user_agent": { "description": "The user agent of the browser from which the account representative accepted the service agreement.", "maxLength": 5000, "type": "string" } }, "title": "CardIssuingAccountTermsOfService", "type": "object", "x-expandableFields": [] }, "card_mandate_payment_method_details": { "description": "", "properties": {}, "title": "card_mandate_payment_method_details", "type": "object", "x-expandableFields": [] }, "cash_balance": { "description": "A customer's `Cash balance` represents real funds. Customers can add funds to their cash balance by sending a bank transfer. These funds can be used for payment and can eventually be paid out to your bank account.", "properties": { "available": { "additionalProperties": { "type": "integer" }, "description": "A hash of all cash balances available to this customer. You cannot delete a customer with any cash balances, even if the balance is 0. Amounts are represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", "nullable": true, "type": "object" }, "customer": { "description": "The ID of the customer whose cash balance this object represents.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "cash_balance" ], "type": "string" }, "settings": { "$ref": "#/components/schemas/customer_balance_customer_balance_settings" } }, "required": [ "customer", "livemode", "object", "settings" ], "title": "cash_balance", "type": "object", "x-expandableFields": [ "settings" ], "x-resourceId": "cash_balance" }, "charge": { "description": "The `Charge` object represents a single attempt to move money into your Stripe account.\nPaymentIntent confirmation is the most common way to create Charges, but transferring\nmoney to a different Stripe account through Connect also creates Charges.\nSome legacy payment flows create Charges directly, which is not recommended for new integrations.", "properties": { "amount": { "description": "Amount intended to be collected by this payment. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).", "type": "integer" }, "amount_captured": { "description": "Amount in cents (or local equivalent) captured (can be less than the amount attribute on the charge if a partial capture was made).", "type": "integer" }, "amount_refunded": { "description": "Amount in cents (or local equivalent) refunded (can be less than the amount attribute on the charge if a partial refund was issued).", "type": "integer" }, "application": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/application" } ], "description": "ID of the Connect application that created the charge.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/application" } ] } }, "application_fee": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/application_fee" } ], "description": "The application fee (if any) for the charge. [See the Connect documentation](https://stripe.com/docs/connect/direct-charges#collect-fees) for details.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/application_fee" } ] } }, "application_fee_amount": { "description": "The amount of the application fee (if any) requested for the charge. [See the Connect documentation](https://stripe.com/docs/connect/direct-charges#collect-fees) for details.", "nullable": true, "type": "integer" }, "balance_transaction": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/balance_transaction" } ], "description": "ID of the balance transaction that describes the impact of this charge on your account balance (not including refunds or disputes).", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/balance_transaction" } ] } }, "billing_details": { "$ref": "#/components/schemas/billing_details" }, "calculated_statement_descriptor": { "description": "The full statement descriptor that is passed to card networks, and that is displayed on your customers' credit card and bank statements. Allows you to see what the statement descriptor looks like after the static and dynamic portions are combined. This value only exists for card payments.", "maxLength": 5000, "nullable": true, "type": "string" }, "captured": { "description": "If the charge was created without capturing, this Boolean represents whether it is still uncaptured or has since been captured.", "type": "boolean" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "customer": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/customer" }, { "$ref": "#/components/schemas/deleted_customer" } ], "description": "ID of the customer this charge is for if one exists.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/customer" }, { "$ref": "#/components/schemas/deleted_customer" } ] } }, "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users.", "maxLength": 40000, "nullable": true, "type": "string" }, "disputed": { "description": "Whether the charge has been disputed.", "type": "boolean" }, "failure_balance_transaction": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/balance_transaction" } ], "description": "ID of the balance transaction that describes the reversal of the balance on your account due to payment failure.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/balance_transaction" } ] } }, "failure_code": { "description": "Error code explaining reason for charge failure if available (see [the errors section](https://stripe.com/docs/error-codes) for a list of codes).", "maxLength": 5000, "nullable": true, "type": "string" }, "failure_message": { "description": "Message to user further explaining reason for charge failure if available.", "maxLength": 5000, "nullable": true, "type": "string" }, "fraud_details": { "anyOf": [ { "$ref": "#/components/schemas/charge_fraud_details" } ], "description": "Information on fraud assessments for the charge.", "nullable": true }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "type": "object" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "charge" ], "type": "string" }, "on_behalf_of": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/account" } ], "description": "The account (if any) the charge was made on behalf of without triggering an automatic transfer. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers) for details.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/account" } ] } }, "outcome": { "anyOf": [ { "$ref": "#/components/schemas/charge_outcome" } ], "description": "Details about whether the payment was accepted, and why. See [understanding declines](https://stripe.com/docs/declines) for details.", "nullable": true }, "paid": { "description": "`true` if the charge succeeded, or was successfully authorized for later capture.", "type": "boolean" }, "payment_intent": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/payment_intent" } ], "description": "ID of the PaymentIntent associated with this charge, if one exists.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/payment_intent" } ] } }, "payment_method": { "description": "ID of the payment method used in this charge.", "maxLength": 5000, "nullable": true, "type": "string" }, "payment_method_details": { "anyOf": [ { "$ref": "#/components/schemas/payment_method_details" } ], "description": "Details about the payment method at the time of the transaction.", "nullable": true }, "presentment_details": { "$ref": "#/components/schemas/payment_flows_payment_intent_presentment_details" }, "radar_options": { "$ref": "#/components/schemas/radar_radar_options" }, "receipt_email": { "description": "This is the email address that the receipt for this charge was sent to.", "maxLength": 5000, "nullable": true, "type": "string" }, "receipt_number": { "description": "This is the transaction number that appears on email receipts sent for this charge. This attribute will be `null` until a receipt has been sent.", "maxLength": 5000, "nullable": true, "type": "string" }, "receipt_url": { "description": "This is the URL to view the receipt for this charge. The receipt is kept up-to-date to the latest state of the charge, including any refunds. If the charge is for an Invoice, the receipt will be stylized as an Invoice receipt.", "maxLength": 5000, "nullable": true, "type": "string" }, "refunded": { "description": "Whether the charge has been fully refunded. If the charge is only partially refunded, this attribute will still be false.", "type": "boolean" }, "refunds": { "description": "A list of refunds that have been applied to the charge.", "nullable": true, "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/refund" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "RefundList", "type": "object", "x-expandableFields": [ "data" ] }, "review": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/review" } ], "description": "ID of the review associated with this charge if one exists.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/review" } ] } }, "shipping": { "anyOf": [ { "$ref": "#/components/schemas/shipping" } ], "description": "Shipping information for the charge.", "nullable": true }, "source_transfer": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/transfer" } ], "description": "The transfer ID which created this charge. Only present if the charge came from another Stripe account. [See the Connect documentation](https://docs.stripe.com/connect/destination-charges) for details.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/transfer" } ] } }, "statement_descriptor": { "description": "For a non-card charge, text that appears on the customer's statement as the statement descriptor. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).\n\nFor a card charge, this value is ignored unless you don't specify a `statement_descriptor_suffix`, in which case this value is used as the suffix.", "maxLength": 5000, "nullable": true, "type": "string" }, "statement_descriptor_suffix": { "description": "Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement. If the account has no prefix value, the suffix is concatenated to the account's statement descriptor.", "maxLength": 5000, "nullable": true, "type": "string" }, "status": { "description": "The status of the payment is either `succeeded`, `pending`, or `failed`.", "enum": [ "failed", "pending", "succeeded" ], "type": "string" }, "transfer": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/transfer" } ], "description": "ID of the transfer to the `destination` account (only applicable if the charge was created using the `destination` parameter).", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/transfer" } ] } }, "transfer_data": { "anyOf": [ { "$ref": "#/components/schemas/charge_transfer_data" } ], "description": "An optional dictionary including the account to automatically transfer to as part of a destination charge. [See the Connect documentation](https://stripe.com/docs/connect/destination-charges) for details.", "nullable": true }, "transfer_group": { "description": "A string that identifies this transaction as part of a group. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) for details.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "amount", "amount_captured", "amount_refunded", "billing_details", "captured", "created", "currency", "disputed", "id", "livemode", "metadata", "object", "paid", "refunded", "status" ], "title": "Charge", "type": "object", "x-expandableFields": [ "application", "application_fee", "balance_transaction", "billing_details", "customer", "failure_balance_transaction", "fraud_details", "on_behalf_of", "outcome", "payment_intent", "payment_method_details", "presentment_details", "radar_options", "refunds", "review", "shipping", "source_transfer", "transfer", "transfer_data" ], "x-resourceId": "charge" }, "charge_fraud_details": { "description": "", "properties": { "stripe_report": { "description": "Assessments from Stripe. If set, the value is `fraudulent`.", "maxLength": 5000, "type": "string" }, "user_report": { "description": "Assessments reported by you. If set, possible values of are `safe` and `fraudulent`.", "maxLength": 5000, "type": "string" } }, "title": "ChargeFraudDetails", "type": "object", "x-expandableFields": [] }, "charge_outcome": { "description": "", "properties": { "advice_code": { "description": "An enumerated value providing a more detailed explanation on [how to proceed with an error](https://stripe.com/docs/declines#retrying-issuer-declines).", "enum": [ "confirm_card_data", "do_not_try_again", "try_again_later" ], "nullable": true, "type": "string" }, "network_advice_code": { "description": "For charges declined by the network, a 2 digit code which indicates the advice returned by the network on how to proceed with an error.", "maxLength": 5000, "nullable": true, "type": "string" }, "network_decline_code": { "description": "For charges declined by the network, an alphanumeric code which indicates the reason the charge failed.", "maxLength": 5000, "nullable": true, "type": "string" }, "network_status": { "description": "Possible values are `approved_by_network`, `declined_by_network`, `not_sent_to_network`, and `reversed_after_approval`. The value `reversed_after_approval` indicates the payment was [blocked by Stripe](https://stripe.com/docs/declines#blocked-payments) after bank authorization, and may temporarily appear as \"pending\" on a cardholder's statement.", "maxLength": 5000, "nullable": true, "type": "string" }, "reason": { "description": "An enumerated value providing a more detailed explanation of the outcome's `type`. Charges blocked by Radar's default block rule have the value `highest_risk_level`. Charges placed in review by Radar's default review rule have the value `elevated_risk_level`. Charges blocked because the payment is unlikely to be authorized have the value `low_probability_of_authorization`. Charges authorized, blocked, or placed in review by custom rules have the value `rule`. See [understanding declines](https://stripe.com/docs/declines) for more details.", "maxLength": 5000, "nullable": true, "type": "string" }, "risk_level": { "description": "Stripe Radar's evaluation of the riskiness of the payment. Possible values for evaluated payments are `normal`, `elevated`, `highest`. For non-card payments, and card-based payments predating the public assignment of risk levels, this field will have the value `not_assessed`. In the event of an error in the evaluation, this field will have the value `unknown`. This field is only available with Radar.", "maxLength": 5000, "type": "string" }, "risk_score": { "description": "Stripe Radar's evaluation of the riskiness of the payment. Possible values for evaluated payments are between 0 and 100. For non-card payments, card-based payments predating the public assignment of risk scores, or in the event of an error during evaluation, this field will not be present. This field is only available with Radar for Fraud Teams.", "type": "integer" }, "rule": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/rule" } ], "description": "The ID of the Radar rule that matched the payment, if applicable.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/rule" } ] } }, "seller_message": { "description": "A human-readable description of the outcome type and reason, designed for you (the recipient of the payment), not your customer.", "maxLength": 5000, "nullable": true, "type": "string" }, "type": { "description": "Possible values are `authorized`, `manual_review`, `issuer_declined`, `blocked`, and `invalid`. See [understanding declines](https://stripe.com/docs/declines) and [Radar reviews](https://stripe.com/docs/radar/reviews) for details.", "maxLength": 5000, "type": "string" } }, "required": [ "type" ], "title": "ChargeOutcome", "type": "object", "x-expandableFields": [ "rule" ] }, "charge_transfer_data": { "description": "", "properties": { "amount": { "description": "The amount transferred to the destination account, if specified. By default, the entire charge amount is transferred to the destination account.", "nullable": true, "type": "integer" }, "destination": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/account" } ], "description": "ID of an existing, connected Stripe account to transfer funds to if `transfer_data` was specified in the charge request.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/account" } ] } } }, "required": [ "destination" ], "title": "ChargeTransferData", "type": "object", "x-expandableFields": [ "destination" ] }, "checkout.session": { "description": "A Checkout Session represents your customer's session as they pay for\none-time purchases or subscriptions through [Checkout](https://stripe.com/docs/payments/checkout)\nor [Payment Links](https://stripe.com/docs/payments/payment-links). We recommend creating a\nnew Session each time your customer attempts to pay.\n\nOnce payment is successful, the Checkout Session will contain a reference\nto the [Customer](https://stripe.com/docs/api/customers), and either the successful\n[PaymentIntent](https://stripe.com/docs/api/payment_intents) or an active\n[Subscription](https://stripe.com/docs/api/subscriptions).\n\nYou can create a Checkout Session on your server and redirect to its URL\nto begin Checkout.\n\nRelated guide: [Checkout quickstart](https://stripe.com/docs/checkout/quickstart)", "properties": { "adaptive_pricing": { "anyOf": [ { "$ref": "#/components/schemas/payment_pages_checkout_session_adaptive_pricing" } ], "description": "Settings for price localization with [Adaptive Pricing](https://docs.stripe.com/payments/checkout/adaptive-pricing).", "nullable": true }, "after_expiration": { "anyOf": [ { "$ref": "#/components/schemas/payment_pages_checkout_session_after_expiration" } ], "description": "When set, provides configuration for actions to take if this Checkout Session expires.", "nullable": true }, "allow_promotion_codes": { "description": "Enables user redeemable promotion codes.", "nullable": true, "type": "boolean" }, "amount_subtotal": { "description": "Total of all items before discounts or taxes are applied.", "nullable": true, "type": "integer" }, "amount_total": { "description": "Total of all items after discounts and taxes are applied.", "nullable": true, "type": "integer" }, "automatic_tax": { "$ref": "#/components/schemas/payment_pages_checkout_session_automatic_tax" }, "billing_address_collection": { "description": "Describes whether Checkout should collect the customer's billing address. Defaults to `auto`.", "enum": [ "auto", "required" ], "nullable": true, "type": "string" }, "cancel_url": { "description": "If set, Checkout displays a back button and customers will be directed to this URL if they decide to cancel payment and return to your website.", "maxLength": 5000, "nullable": true, "type": "string" }, "client_reference_id": { "description": "A unique string to reference the Checkout Session. This can be a\ncustomer ID, a cart ID, or similar, and can be used to reconcile the\nSession with your internal systems.", "maxLength": 5000, "nullable": true, "type": "string" }, "client_secret": { "description": "The client secret of your Checkout Session. Applies to Checkout Sessions with `ui_mode: embedded` or `ui_mode: custom`. For `ui_mode: embedded`, the client secret is to be used when initializing Stripe.js embedded checkout.\n For `ui_mode: custom`, use the client secret with [initCheckout](https://stripe.com/docs/js/custom_checkout/init) on your front end.", "maxLength": 5000, "nullable": true, "type": "string" }, "collected_information": { "anyOf": [ { "$ref": "#/components/schemas/payment_pages_checkout_session_collected_information" } ], "description": "Information about the customer collected within the Checkout Session.", "nullable": true }, "consent": { "anyOf": [ { "$ref": "#/components/schemas/payment_pages_checkout_session_consent" } ], "description": "Results of `consent_collection` for this session.", "nullable": true }, "consent_collection": { "anyOf": [ { "$ref": "#/components/schemas/payment_pages_checkout_session_consent_collection" } ], "description": "When set, provides configuration for the Checkout Session to gather active consent from customers.", "nullable": true }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "nullable": true, "type": "string" }, "currency_conversion": { "anyOf": [ { "$ref": "#/components/schemas/payment_pages_checkout_session_currency_conversion" } ], "description": "Currency conversion details for [Adaptive Pricing](https://docs.stripe.com/payments/checkout/adaptive-pricing) sessions created before 2025-03-31.", "nullable": true }, "custom_fields": { "description": "Collect additional information from your customer using custom fields. Up to 3 fields are supported.", "items": { "$ref": "#/components/schemas/payment_pages_checkout_session_custom_fields" }, "type": "array" }, "custom_text": { "$ref": "#/components/schemas/payment_pages_checkout_session_custom_text" }, "customer": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/customer" }, { "$ref": "#/components/schemas/deleted_customer" } ], "description": "The ID of the customer for this Session.\nFor Checkout Sessions in `subscription` mode or Checkout Sessions with `customer_creation` set as `always` in `payment` mode, Checkout\nwill create a new customer object based on information provided\nduring the payment flow unless an existing customer was provided when\nthe Session was created.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/customer" }, { "$ref": "#/components/schemas/deleted_customer" } ] } }, "customer_creation": { "description": "Configure whether a Checkout Session creates a Customer when the Checkout Session completes.", "enum": [ "always", "if_required" ], "nullable": true, "type": "string" }, "customer_details": { "anyOf": [ { "$ref": "#/components/schemas/payment_pages_checkout_session_customer_details" } ], "description": "The customer details including the customer's tax exempt status and the customer's tax IDs. Customer's address details are not present on Sessions in `setup` mode.", "nullable": true }, "customer_email": { "description": "If provided, this value will be used when the Customer object is created.\nIf not provided, customers will be asked to enter their email address.\nUse this parameter to prefill customer data if you already have an email\non file. To access information about the customer once the payment flow is\ncomplete, use the `customer` attribute.", "maxLength": 5000, "nullable": true, "type": "string" }, "discounts": { "description": "List of coupons and promotion codes attached to the Checkout Session.", "items": { "$ref": "#/components/schemas/payment_pages_checkout_session_discount" }, "nullable": true, "type": "array" }, "expires_at": { "description": "The timestamp at which the Checkout Session will expire.", "format": "unix-time", "type": "integer" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "invoice": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/invoice" } ], "description": "ID of the invoice created by the Checkout Session, if it exists.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/invoice" } ] } }, "invoice_creation": { "anyOf": [ { "$ref": "#/components/schemas/payment_pages_checkout_session_invoice_creation" } ], "description": "Details on the state of invoice creation for the Checkout Session.", "nullable": true }, "line_items": { "description": "The line items purchased by the customer.", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/item" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "PaymentPagesCheckoutSessionListLineItems", "type": "object", "x-expandableFields": [ "data" ] }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "locale": { "description": "The IETF language tag of the locale Checkout is displayed in. If blank or `auto`, the browser's locale is used.", "enum": [ "auto", "bg", "cs", "da", "de", "el", "en", "en-GB", "es", "es-419", "et", "fi", "fil", "fr", "fr-CA", "hr", "hu", "id", "it", "ja", "ko", "lt", "lv", "ms", "mt", "nb", "nl", "pl", "pt", "pt-BR", "ro", "ru", "sk", "sl", "sv", "th", "tr", "vi", "zh", "zh-HK", "zh-TW" ], "nullable": true, "type": "string", "x-stripeBypassValidation": true }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "nullable": true, "type": "object" }, "mode": { "description": "The mode of the Checkout Session.", "enum": [ "payment", "setup", "subscription" ], "type": "string", "x-stripeBypassValidation": true }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "checkout.session" ], "type": "string" }, "optional_items": { "description": "The optional items presented to the customer at checkout.", "items": { "$ref": "#/components/schemas/payment_pages_checkout_session_optional_item" }, "nullable": true, "type": "array" }, "origin_context": { "description": "Where the user is coming from. This informs the optimizations that are applied to the session.", "enum": [ "mobile_app", "web" ], "nullable": true, "type": "string" }, "payment_intent": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/payment_intent" } ], "description": "The ID of the PaymentIntent for Checkout Sessions in `payment` mode. You can't confirm or cancel the PaymentIntent for a Checkout Session. To cancel, [expire the Checkout Session](https://stripe.com/docs/api/checkout/sessions/expire) instead.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/payment_intent" } ] } }, "payment_link": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/payment_link" } ], "description": "The ID of the Payment Link that created this Session.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/payment_link" } ] } }, "payment_method_collection": { "description": "Configure whether a Checkout Session should collect a payment method. Defaults to `always`.", "enum": [ "always", "if_required" ], "nullable": true, "type": "string" }, "payment_method_configuration_details": { "anyOf": [ { "$ref": "#/components/schemas/payment_method_config_biz_payment_method_configuration_details" } ], "description": "Information about the payment method configuration used for this Checkout session if using dynamic payment methods.", "nullable": true }, "payment_method_options": { "anyOf": [ { "$ref": "#/components/schemas/checkout_session_payment_method_options" } ], "description": "Payment-method-specific configuration for the PaymentIntent or SetupIntent of this CheckoutSession.", "nullable": true }, "payment_method_types": { "description": "A list of the types of payment methods (e.g. card) this Checkout\nSession is allowed to accept.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "payment_status": { "description": "The payment status of the Checkout Session, one of `paid`, `unpaid`, or `no_payment_required`.\nYou can use this value to decide when to fulfill your customer's order.", "enum": [ "no_payment_required", "paid", "unpaid" ], "type": "string" }, "permissions": { "anyOf": [ { "$ref": "#/components/schemas/payment_pages_checkout_session_permissions" } ], "description": "This property is used to set up permissions for various actions (e.g., update) on the CheckoutSession object.\n\nFor specific permissions, please refer to their dedicated subsections, such as `permissions.update_shipping_details`.", "nullable": true }, "phone_number_collection": { "$ref": "#/components/schemas/payment_pages_checkout_session_phone_number_collection" }, "presentment_details": { "$ref": "#/components/schemas/payment_flows_payment_intent_presentment_details" }, "recovered_from": { "description": "The ID of the original expired Checkout Session that triggered the recovery flow.", "maxLength": 5000, "nullable": true, "type": "string" }, "redirect_on_completion": { "description": "This parameter applies to `ui_mode: embedded`. Learn more about the [redirect behavior](https://stripe.com/docs/payments/checkout/custom-success-page?payment-ui=embedded-form) of embedded sessions. Defaults to `always`.", "enum": [ "always", "if_required", "never" ], "type": "string" }, "return_url": { "description": "Applies to Checkout Sessions with `ui_mode: embedded` or `ui_mode: custom`. The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site.", "maxLength": 5000, "type": "string" }, "saved_payment_method_options": { "anyOf": [ { "$ref": "#/components/schemas/payment_pages_checkout_session_saved_payment_method_options" } ], "description": "Controls saved payment method settings for the session. Only available in `payment` and `subscription` mode.", "nullable": true }, "setup_intent": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/setup_intent" } ], "description": "The ID of the SetupIntent for Checkout Sessions in `setup` mode. You can't confirm or cancel the SetupIntent for a Checkout Session. To cancel, [expire the Checkout Session](https://stripe.com/docs/api/checkout/sessions/expire) instead.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/setup_intent" } ] } }, "shipping_address_collection": { "anyOf": [ { "$ref": "#/components/schemas/payment_pages_checkout_session_shipping_address_collection" } ], "description": "When set, provides configuration for Checkout to collect a shipping address from a customer.", "nullable": true }, "shipping_cost": { "anyOf": [ { "$ref": "#/components/schemas/payment_pages_checkout_session_shipping_cost" } ], "description": "The details of the customer cost of shipping, including the customer chosen ShippingRate.", "nullable": true }, "shipping_options": { "description": "The shipping rate options applied to this Session.", "items": { "$ref": "#/components/schemas/payment_pages_checkout_session_shipping_option" }, "type": "array" }, "status": { "description": "The status of the Checkout Session, one of `open`, `complete`, or `expired`.", "enum": [ "complete", "expired", "open" ], "nullable": true, "type": "string" }, "submit_type": { "description": "Describes the type of transaction being performed by Checkout in order to customize\nrelevant text on the page, such as the submit button. `submit_type` can only be\nspecified on Checkout Sessions in `payment` mode. If blank or `auto`, `pay` is used.", "enum": [ "auto", "book", "donate", "pay", "subscribe" ], "nullable": true, "type": "string" }, "subscription": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/subscription" } ], "description": "The ID of the [Subscription](https://stripe.com/docs/api/subscriptions) for Checkout Sessions in `subscription` mode.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/subscription" } ] } }, "success_url": { "description": "The URL the customer will be directed to after the payment or\nsubscription creation is successful.", "maxLength": 5000, "nullable": true, "type": "string" }, "tax_id_collection": { "$ref": "#/components/schemas/payment_pages_checkout_session_tax_id_collection" }, "total_details": { "anyOf": [ { "$ref": "#/components/schemas/payment_pages_checkout_session_total_details" } ], "description": "Tax and discount details for the computed total amount.", "nullable": true }, "ui_mode": { "description": "The UI mode of the Session. Defaults to `hosted`.", "enum": [ "custom", "embedded", "hosted" ], "nullable": true, "type": "string" }, "url": { "description": "The URL to the Checkout Session. Applies to Checkout Sessions with `ui_mode: hosted`. Redirect customers to this URL to take them to Checkout. If you’re using [Custom Domains](https://stripe.com/docs/payments/checkout/custom-domains), the URL will use your subdomain. Otherwise, it’ll use `checkout.stripe.com.`\nThis value is only present when the session is active.", "maxLength": 5000, "nullable": true, "type": "string" }, "wallet_options": { "anyOf": [ { "$ref": "#/components/schemas/checkout_session_wallet_options" } ], "description": "Wallet-specific configuration for this Checkout Session.", "nullable": true } }, "required": [ "automatic_tax", "created", "custom_fields", "custom_text", "expires_at", "id", "livemode", "mode", "object", "payment_method_types", "payment_status", "shipping_options" ], "title": "Session", "type": "object", "x-expandableFields": [ "adaptive_pricing", "after_expiration", "automatic_tax", "collected_information", "consent", "consent_collection", "currency_conversion", "custom_fields", "custom_text", "customer", "customer_details", "discounts", "invoice", "invoice_creation", "line_items", "optional_items", "payment_intent", "payment_link", "payment_method_configuration_details", "payment_method_options", "permissions", "phone_number_collection", "presentment_details", "saved_payment_method_options", "setup_intent", "shipping_address_collection", "shipping_cost", "shipping_options", "subscription", "tax_id_collection", "total_details", "wallet_options" ], "x-resourceId": "checkout.session" }, "checkout_acss_debit_mandate_options": { "description": "", "properties": { "custom_mandate_url": { "description": "A URL for custom mandate text", "maxLength": 5000, "type": "string" }, "default_for": { "description": "List of Stripe products where this mandate can be selected automatically. Returned when the Session is in `setup` mode.", "items": { "enum": [ "invoice", "subscription" ], "type": "string" }, "type": "array" }, "interval_description": { "description": "Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'.", "maxLength": 5000, "nullable": true, "type": "string" }, "payment_schedule": { "description": "Payment schedule for the mandate.", "enum": [ "combined", "interval", "sporadic" ], "nullable": true, "type": "string" }, "transaction_type": { "description": "Transaction type of the mandate.", "enum": [ "business", "personal" ], "nullable": true, "type": "string" } }, "title": "CheckoutAcssDebitMandateOptions", "type": "object", "x-expandableFields": [] }, "checkout_acss_debit_payment_method_options": { "description": "", "properties": { "currency": { "description": "Currency supported by the bank account. Returned when the Session is in `setup` mode.", "enum": [ "cad", "usd" ], "type": "string" }, "mandate_options": { "$ref": "#/components/schemas/checkout_acss_debit_mandate_options" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none", "off_session", "on_session" ], "type": "string" }, "target_date": { "description": "Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.", "maxLength": 5000, "type": "string" }, "verification_method": { "description": "Bank account verification method.", "enum": [ "automatic", "instant", "microdeposits" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "CheckoutAcssDebitPaymentMethodOptions", "type": "object", "x-expandableFields": [ "mandate_options" ] }, "checkout_affirm_payment_method_options": { "description": "", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string" } }, "title": "CheckoutAffirmPaymentMethodOptions", "type": "object", "x-expandableFields": [] }, "checkout_afterpay_clearpay_payment_method_options": { "description": "", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string" } }, "title": "CheckoutAfterpayClearpayPaymentMethodOptions", "type": "object", "x-expandableFields": [] }, "checkout_alipay_payment_method_options": { "description": "", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string" } }, "title": "CheckoutAlipayPaymentMethodOptions", "type": "object", "x-expandableFields": [] }, "checkout_amazon_pay_payment_method_options": { "description": "", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none", "off_session" ], "type": "string" } }, "title": "CheckoutAmazonPayPaymentMethodOptions", "type": "object", "x-expandableFields": [] }, "checkout_au_becs_debit_payment_method_options": { "description": "", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string" }, "target_date": { "description": "Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.", "maxLength": 5000, "type": "string" } }, "title": "CheckoutAuBecsDebitPaymentMethodOptions", "type": "object", "x-expandableFields": [] }, "checkout_bacs_debit_payment_method_options": { "description": "", "properties": { "mandate_options": { "$ref": "#/components/schemas/checkout_payment_method_options_mandate_options_bacs_debit" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none", "off_session", "on_session" ], "type": "string" }, "target_date": { "description": "Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.", "maxLength": 5000, "type": "string" } }, "title": "CheckoutBacsDebitPaymentMethodOptions", "type": "object", "x-expandableFields": [ "mandate_options" ] }, "checkout_bancontact_payment_method_options": { "description": "", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string" } }, "title": "CheckoutBancontactPaymentMethodOptions", "type": "object", "x-expandableFields": [] }, "checkout_boleto_payment_method_options": { "description": "", "properties": { "expires_after_days": { "description": "The number of calendar days before a Boleto voucher expires. For example, if you create a Boleto voucher on Monday and you set expires_after_days to 2, the Boleto voucher will expire on Wednesday at 23:59 America/Sao_Paulo time.", "type": "integer" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none", "off_session", "on_session" ], "type": "string" } }, "required": [ "expires_after_days" ], "title": "CheckoutBoletoPaymentMethodOptions", "type": "object", "x-expandableFields": [] }, "checkout_card_installments_options": { "description": "", "properties": { "enabled": { "description": "Indicates if installments are enabled", "type": "boolean" } }, "title": "CheckoutCardInstallmentsOptions", "type": "object", "x-expandableFields": [] }, "checkout_card_payment_method_options": { "description": "", "properties": { "installments": { "$ref": "#/components/schemas/checkout_card_installments_options" }, "request_extended_authorization": { "description": "Request ability to [capture beyond the standard authorization validity window](/payments/extended-authorization) for this CheckoutSession.", "enum": [ "if_available", "never" ], "type": "string" }, "request_incremental_authorization": { "description": "Request ability to [increment the authorization](/payments/incremental-authorization) for this CheckoutSession.", "enum": [ "if_available", "never" ], "type": "string" }, "request_multicapture": { "description": "Request ability to make [multiple captures](/payments/multicapture) for this CheckoutSession.", "enum": [ "if_available", "never" ], "type": "string" }, "request_overcapture": { "description": "Request ability to [overcapture](/payments/overcapture) for this CheckoutSession.", "enum": [ "if_available", "never" ], "type": "string" }, "request_three_d_secure": { "description": "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.", "enum": [ "any", "automatic", "challenge" ], "type": "string", "x-stripeBypassValidation": true }, "restrictions": { "$ref": "#/components/schemas/payment_pages_private_card_payment_method_options_resource_restrictions" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none", "off_session", "on_session" ], "type": "string" }, "statement_descriptor_suffix_kana": { "description": "Provides information about a card payment that customers see on their statements. Concatenated with the Kana prefix (shortened Kana descriptor) or Kana statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 22 characters.", "maxLength": 5000, "type": "string" }, "statement_descriptor_suffix_kanji": { "description": "Provides information about a card payment that customers see on their statements. Concatenated with the Kanji prefix (shortened Kanji descriptor) or Kanji statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 17 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 17 characters.", "maxLength": 5000, "type": "string" } }, "required": [ "request_three_d_secure" ], "title": "CheckoutCardPaymentMethodOptions", "type": "object", "x-expandableFields": [ "installments", "restrictions" ] }, "checkout_cashapp_payment_method_options": { "description": "", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string" } }, "title": "CheckoutCashappPaymentMethodOptions", "type": "object", "x-expandableFields": [] }, "checkout_customer_balance_bank_transfer_payment_method_options": { "description": "", "properties": { "eu_bank_transfer": { "$ref": "#/components/schemas/payment_method_options_customer_balance_eu_bank_account" }, "requested_address_types": { "description": "List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.\n\nPermitted values include: `sort_code`, `zengin`, `iban`, or `spei`.", "items": { "enum": [ "aba", "iban", "sepa", "sort_code", "spei", "swift", "zengin" ], "type": "string", "x-stripeBypassValidation": true }, "type": "array" }, "type": { "description": "The bank transfer type that this PaymentIntent is allowed to use for funding Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.", "enum": [ "eu_bank_transfer", "gb_bank_transfer", "jp_bank_transfer", "mx_bank_transfer", "us_bank_transfer" ], "nullable": true, "type": "string", "x-stripeBypassValidation": true } }, "title": "CheckoutCustomerBalanceBankTransferPaymentMethodOptions", "type": "object", "x-expandableFields": [ "eu_bank_transfer" ] }, "checkout_customer_balance_payment_method_options": { "description": "", "properties": { "bank_transfer": { "$ref": "#/components/schemas/checkout_customer_balance_bank_transfer_payment_method_options" }, "funding_type": { "description": "The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.", "enum": [ "bank_transfer" ], "nullable": true, "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string" } }, "title": "CheckoutCustomerBalancePaymentMethodOptions", "type": "object", "x-expandableFields": [ "bank_transfer" ] }, "checkout_eps_payment_method_options": { "description": "", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string" } }, "title": "CheckoutEpsPaymentMethodOptions", "type": "object", "x-expandableFields": [] }, "checkout_fpx_payment_method_options": { "description": "", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string" } }, "title": "CheckoutFpxPaymentMethodOptions", "type": "object", "x-expandableFields": [] }, "checkout_giropay_payment_method_options": { "description": "", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string" } }, "title": "CheckoutGiropayPaymentMethodOptions", "type": "object", "x-expandableFields": [] }, "checkout_grab_pay_payment_method_options": { "description": "", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string" } }, "title": "CheckoutGrabPayPaymentMethodOptions", "type": "object", "x-expandableFields": [] }, "checkout_ideal_payment_method_options": { "description": "", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string" } }, "title": "CheckoutIdealPaymentMethodOptions", "type": "object", "x-expandableFields": [] }, "checkout_kakao_pay_payment_method_options": { "description": "", "properties": { "capture_method": { "description": "Controls when the funds will be captured from the customer's account.", "enum": [ "manual" ], "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none", "off_session" ], "type": "string" } }, "title": "CheckoutKakaoPayPaymentMethodOptions", "type": "object", "x-expandableFields": [] }, "checkout_klarna_payment_method_options": { "description": "", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none", "off_session", "on_session" ], "type": "string" } }, "title": "CheckoutKlarnaPaymentMethodOptions", "type": "object", "x-expandableFields": [] }, "checkout_konbini_payment_method_options": { "description": "", "properties": { "expires_after_days": { "description": "The number of calendar days (between 1 and 60) after which Konbini payment instructions will expire. For example, if a PaymentIntent is confirmed with Konbini and `expires_after_days` set to 2 on Monday JST, the instructions will expire on Wednesday 23:59:59 JST.", "nullable": true, "type": "integer" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string" } }, "title": "CheckoutKonbiniPaymentMethodOptions", "type": "object", "x-expandableFields": [] }, "checkout_kr_card_payment_method_options": { "description": "", "properties": { "capture_method": { "description": "Controls when the funds will be captured from the customer's account.", "enum": [ "manual" ], "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none", "off_session" ], "type": "string" } }, "title": "CheckoutKrCardPaymentMethodOptions", "type": "object", "x-expandableFields": [] }, "checkout_link_payment_method_options": { "description": "", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none", "off_session" ], "type": "string" } }, "title": "CheckoutLinkPaymentMethodOptions", "type": "object", "x-expandableFields": [] }, "checkout_link_wallet_options": { "description": "", "properties": { "display": { "description": "Describes whether Checkout should display Link. Defaults to `auto`.", "enum": [ "auto", "never" ], "type": "string" } }, "title": "CheckoutLinkWalletOptions", "type": "object", "x-expandableFields": [] }, "checkout_mobilepay_payment_method_options": { "description": "", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string" } }, "title": "CheckoutMobilepayPaymentMethodOptions", "type": "object", "x-expandableFields": [] }, "checkout_multibanco_payment_method_options": { "description": "", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string" } }, "title": "CheckoutMultibancoPaymentMethodOptions", "type": "object", "x-expandableFields": [] }, "checkout_naver_pay_payment_method_options": { "description": "", "properties": { "capture_method": { "description": "Controls when the funds will be captured from the customer's account.", "enum": [ "manual" ], "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none", "off_session" ], "type": "string" } }, "title": "CheckoutNaverPayPaymentMethodOptions", "type": "object", "x-expandableFields": [] }, "checkout_oxxo_payment_method_options": { "description": "", "properties": { "expires_after_days": { "description": "The number of calendar days before an OXXO invoice expires. For example, if you create an OXXO invoice on Monday and you set expires_after_days to 2, the OXXO invoice will expire on Wednesday at 23:59 America/Mexico_City time.", "type": "integer" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string" } }, "required": [ "expires_after_days" ], "title": "CheckoutOxxoPaymentMethodOptions", "type": "object", "x-expandableFields": [] }, "checkout_p24_payment_method_options": { "description": "", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string" } }, "title": "CheckoutP24PaymentMethodOptions", "type": "object", "x-expandableFields": [] }, "checkout_payco_payment_method_options": { "description": "", "properties": { "capture_method": { "description": "Controls when the funds will be captured from the customer's account.", "enum": [ "manual" ], "type": "string" } }, "title": "CheckoutPaycoPaymentMethodOptions", "type": "object", "x-expandableFields": [] }, "checkout_payment_method_options_mandate_options_bacs_debit": { "description": "", "properties": { "reference_prefix": { "description": "Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'.", "maxLength": 5000, "type": "string" } }, "title": "checkout_payment_method_options_mandate_options_bacs_debit", "type": "object", "x-expandableFields": [] }, "checkout_payment_method_options_mandate_options_sepa_debit": { "description": "", "properties": { "reference_prefix": { "description": "Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'.", "maxLength": 5000, "type": "string" } }, "title": "checkout_payment_method_options_mandate_options_sepa_debit", "type": "object", "x-expandableFields": [] }, "checkout_paynow_payment_method_options": { "description": "", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string" } }, "title": "CheckoutPaynowPaymentMethodOptions", "type": "object", "x-expandableFields": [] }, "checkout_paypal_payment_method_options": { "description": "", "properties": { "capture_method": { "description": "Controls when the funds will be captured from the customer's account.", "enum": [ "manual" ], "type": "string" }, "preferred_locale": { "description": "Preferred locale of the PayPal checkout page that the customer is redirected to.", "maxLength": 5000, "nullable": true, "type": "string" }, "reference": { "description": "A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID.", "maxLength": 5000, "nullable": true, "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none", "off_session" ], "type": "string" } }, "title": "CheckoutPaypalPaymentMethodOptions", "type": "object", "x-expandableFields": [] }, "checkout_pix_payment_method_options": { "description": "", "properties": { "amount_includes_iof": { "description": "Determines if the amount includes the IOF tax.", "enum": [ "always", "never" ], "type": "string" }, "expires_after_seconds": { "description": "The number of seconds after which Pix payment will expire.", "nullable": true, "type": "integer" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "CheckoutPixPaymentMethodOptions", "type": "object", "x-expandableFields": [] }, "checkout_revolut_pay_payment_method_options": { "description": "", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none", "off_session" ], "type": "string" } }, "title": "CheckoutRevolutPayPaymentMethodOptions", "type": "object", "x-expandableFields": [] }, "checkout_samsung_pay_payment_method_options": { "description": "", "properties": { "capture_method": { "description": "Controls when the funds will be captured from the customer's account.", "enum": [ "manual" ], "type": "string" } }, "title": "CheckoutSamsungPayPaymentMethodOptions", "type": "object", "x-expandableFields": [] }, "checkout_sepa_debit_payment_method_options": { "description": "", "properties": { "mandate_options": { "$ref": "#/components/schemas/checkout_payment_method_options_mandate_options_sepa_debit" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none", "off_session", "on_session" ], "type": "string" }, "target_date": { "description": "Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.", "maxLength": 5000, "type": "string" } }, "title": "CheckoutSepaDebitPaymentMethodOptions", "type": "object", "x-expandableFields": [ "mandate_options" ] }, "checkout_session_payment_method_options": { "description": "", "properties": { "acss_debit": { "$ref": "#/components/schemas/checkout_acss_debit_payment_method_options" }, "affirm": { "$ref": "#/components/schemas/checkout_affirm_payment_method_options" }, "afterpay_clearpay": { "$ref": "#/components/schemas/checkout_afterpay_clearpay_payment_method_options" }, "alipay": { "$ref": "#/components/schemas/checkout_alipay_payment_method_options" }, "amazon_pay": { "$ref": "#/components/schemas/checkout_amazon_pay_payment_method_options" }, "au_becs_debit": { "$ref": "#/components/schemas/checkout_au_becs_debit_payment_method_options" }, "bacs_debit": { "$ref": "#/components/schemas/checkout_bacs_debit_payment_method_options" }, "bancontact": { "$ref": "#/components/schemas/checkout_bancontact_payment_method_options" }, "boleto": { "$ref": "#/components/schemas/checkout_boleto_payment_method_options" }, "card": { "$ref": "#/components/schemas/checkout_card_payment_method_options" }, "cashapp": { "$ref": "#/components/schemas/checkout_cashapp_payment_method_options" }, "customer_balance": { "$ref": "#/components/schemas/checkout_customer_balance_payment_method_options" }, "eps": { "$ref": "#/components/schemas/checkout_eps_payment_method_options" }, "fpx": { "$ref": "#/components/schemas/checkout_fpx_payment_method_options" }, "giropay": { "$ref": "#/components/schemas/checkout_giropay_payment_method_options" }, "grabpay": { "$ref": "#/components/schemas/checkout_grab_pay_payment_method_options" }, "ideal": { "$ref": "#/components/schemas/checkout_ideal_payment_method_options" }, "kakao_pay": { "$ref": "#/components/schemas/checkout_kakao_pay_payment_method_options" }, "klarna": { "$ref": "#/components/schemas/checkout_klarna_payment_method_options" }, "konbini": { "$ref": "#/components/schemas/checkout_konbini_payment_method_options" }, "kr_card": { "$ref": "#/components/schemas/checkout_kr_card_payment_method_options" }, "link": { "$ref": "#/components/schemas/checkout_link_payment_method_options" }, "mobilepay": { "$ref": "#/components/schemas/checkout_mobilepay_payment_method_options" }, "multibanco": { "$ref": "#/components/schemas/checkout_multibanco_payment_method_options" }, "naver_pay": { "$ref": "#/components/schemas/checkout_naver_pay_payment_method_options" }, "oxxo": { "$ref": "#/components/schemas/checkout_oxxo_payment_method_options" }, "p24": { "$ref": "#/components/schemas/checkout_p24_payment_method_options" }, "payco": { "$ref": "#/components/schemas/checkout_payco_payment_method_options" }, "paynow": { "$ref": "#/components/schemas/checkout_paynow_payment_method_options" }, "paypal": { "$ref": "#/components/schemas/checkout_paypal_payment_method_options" }, "pix": { "$ref": "#/components/schemas/checkout_pix_payment_method_options" }, "revolut_pay": { "$ref": "#/components/schemas/checkout_revolut_pay_payment_method_options" }, "samsung_pay": { "$ref": "#/components/schemas/checkout_samsung_pay_payment_method_options" }, "sepa_debit": { "$ref": "#/components/schemas/checkout_sepa_debit_payment_method_options" }, "sofort": { "$ref": "#/components/schemas/checkout_sofort_payment_method_options" }, "swish": { "$ref": "#/components/schemas/checkout_swish_payment_method_options" }, "us_bank_account": { "$ref": "#/components/schemas/checkout_us_bank_account_payment_method_options" } }, "title": "CheckoutSessionPaymentMethodOptions", "type": "object", "x-expandableFields": [ "acss_debit", "affirm", "afterpay_clearpay", "alipay", "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", "boleto", "card", "cashapp", "customer_balance", "eps", "fpx", "giropay", "grabpay", "ideal", "kakao_pay", "klarna", "konbini", "kr_card", "link", "mobilepay", "multibanco", "naver_pay", "oxxo", "p24", "payco", "paynow", "paypal", "pix", "revolut_pay", "samsung_pay", "sepa_debit", "sofort", "swish", "us_bank_account" ] }, "checkout_session_wallet_options": { "description": "", "properties": { "link": { "$ref": "#/components/schemas/checkout_link_wallet_options" } }, "title": "CheckoutSessionWalletOptions", "type": "object", "x-expandableFields": [ "link" ] }, "checkout_sofort_payment_method_options": { "description": "", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string" } }, "title": "CheckoutSofortPaymentMethodOptions", "type": "object", "x-expandableFields": [] }, "checkout_swish_payment_method_options": { "description": "", "properties": { "reference": { "description": "The order reference that will be displayed to customers in the Swish application. Defaults to the `id` of the Payment Intent.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "CheckoutSwishPaymentMethodOptions", "type": "object", "x-expandableFields": [] }, "checkout_us_bank_account_payment_method_options": { "description": "", "properties": { "financial_connections": { "$ref": "#/components/schemas/linked_account_options_common" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none", "off_session", "on_session" ], "type": "string" }, "target_date": { "description": "Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.", "maxLength": 5000, "type": "string" }, "verification_method": { "description": "Bank account verification method.", "enum": [ "automatic", "instant" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "CheckoutUsBankAccountPaymentMethodOptions", "type": "object", "x-expandableFields": [ "financial_connections" ] }, "climate.order": { "description": "Orders represent your intent to purchase a particular Climate product. When you create an order, the\npayment is deducted from your merchant balance.", "properties": { "amount_fees": { "description": "Total amount of [Frontier](https://frontierclimate.com/)'s service fees in the currency's smallest unit.", "type": "integer" }, "amount_subtotal": { "description": "Total amount of the carbon removal in the currency's smallest unit.", "type": "integer" }, "amount_total": { "description": "Total amount of the order including fees in the currency's smallest unit.", "type": "integer" }, "beneficiary": { "$ref": "#/components/schemas/climate_removals_beneficiary" }, "canceled_at": { "description": "Time at which the order was canceled. Measured in seconds since the Unix epoch.", "format": "unix-time", "nullable": true, "type": "integer" }, "cancellation_reason": { "description": "Reason for the cancellation of this order.", "enum": [ "expired", "product_unavailable", "requested" ], "nullable": true, "type": "string", "x-stripeBypassValidation": true }, "certificate": { "description": "For delivered orders, a URL to a delivery certificate for the order.", "maxLength": 5000, "nullable": true, "type": "string" }, "confirmed_at": { "description": "Time at which the order was confirmed. Measured in seconds since the Unix epoch.", "format": "unix-time", "nullable": true, "type": "integer" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase, representing the currency for this order.", "maxLength": 5000, "type": "string" }, "delayed_at": { "description": "Time at which the order's expected_delivery_year was delayed. Measured in seconds since the Unix epoch.", "format": "unix-time", "nullable": true, "type": "integer" }, "delivered_at": { "description": "Time at which the order was delivered. Measured in seconds since the Unix epoch.", "format": "unix-time", "nullable": true, "type": "integer" }, "delivery_details": { "description": "Details about the delivery of carbon removal for this order.", "items": { "$ref": "#/components/schemas/climate_removals_order_deliveries" }, "type": "array" }, "expected_delivery_year": { "description": "The year this order is expected to be delivered.", "type": "integer" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "type": "object" }, "metric_tons": { "description": "Quantity of carbon removal that is included in this order.", "format": "decimal", "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "climate.order" ], "type": "string" }, "product": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/climate.product" } ], "description": "Unique ID for the Climate `Product` this order is purchasing.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/climate.product" } ] } }, "product_substituted_at": { "description": "Time at which the order's product was substituted for a different product. Measured in seconds since the Unix epoch.", "format": "unix-time", "nullable": true, "type": "integer" }, "status": { "description": "The current status of this order.", "enum": [ "awaiting_funds", "canceled", "confirmed", "delivered", "open" ], "type": "string" } }, "required": [ "amount_fees", "amount_subtotal", "amount_total", "created", "currency", "delivery_details", "expected_delivery_year", "id", "livemode", "metadata", "metric_tons", "object", "product", "status" ], "title": "ClimateRemovalsOrders", "type": "object", "x-expandableFields": [ "beneficiary", "delivery_details", "product" ], "x-resourceId": "climate.order" }, "climate.product": { "description": "A Climate product represents a type of carbon removal unit available for reservation.\nYou can retrieve it to see the current price and availability.", "properties": { "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "current_prices_per_metric_ton": { "additionalProperties": { "$ref": "#/components/schemas/climate_removals_products_price" }, "description": "Current prices for a metric ton of carbon removal in a currency's smallest unit.", "type": "object" }, "delivery_year": { "description": "The year in which the carbon removal is expected to be delivered.", "nullable": true, "type": "integer" }, "id": { "description": "Unique identifier for the object. For convenience, Climate product IDs are human-readable strings\nthat start with `climsku_`. See [carbon removal inventory](https://stripe.com/docs/climate/orders/carbon-removal-inventory)\nfor a list of available carbon removal products.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "metric_tons_available": { "description": "The quantity of metric tons available for reservation.", "format": "decimal", "type": "string" }, "name": { "description": "The Climate product's name.", "maxLength": 5000, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "climate.product" ], "type": "string" }, "suppliers": { "description": "The carbon removal suppliers that fulfill orders for this Climate product.", "items": { "$ref": "#/components/schemas/climate.supplier" }, "type": "array" } }, "required": [ "created", "current_prices_per_metric_ton", "id", "livemode", "metric_tons_available", "name", "object", "suppliers" ], "title": "ClimateRemovalsProducts", "type": "object", "x-expandableFields": [ "current_prices_per_metric_ton", "suppliers" ], "x-resourceId": "climate.product" }, "climate.supplier": { "description": "A supplier of carbon removal.", "properties": { "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "info_url": { "description": "Link to a webpage to learn more about the supplier.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "locations": { "description": "The locations in which this supplier operates.", "items": { "$ref": "#/components/schemas/climate_removals_location" }, "type": "array" }, "name": { "description": "Name of this carbon removal supplier.", "maxLength": 5000, "type": "string" }, "object": { "description": "String representing the object’s type. Objects of the same type share the same value.", "enum": [ "climate.supplier" ], "type": "string" }, "removal_pathway": { "description": "The scientific pathway used for carbon removal.", "enum": [ "biomass_carbon_removal_and_storage", "direct_air_capture", "enhanced_weathering" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "id", "info_url", "livemode", "locations", "name", "object", "removal_pathway" ], "title": "ClimateRemovalsSuppliers", "type": "object", "x-expandableFields": [ "locations" ], "x-resourceId": "climate.supplier" }, "climate_removals_beneficiary": { "description": "", "properties": { "public_name": { "description": "Publicly displayable name for the end beneficiary of carbon removal.", "maxLength": 5000, "type": "string" } }, "required": [ "public_name" ], "title": "ClimateRemovalsBeneficiary", "type": "object", "x-expandableFields": [] }, "climate_removals_location": { "description": "", "properties": { "city": { "description": "The city where the supplier is located.", "maxLength": 5000, "nullable": true, "type": "string" }, "country": { "description": "Two-letter ISO code representing the country where the supplier is located.", "maxLength": 5000, "type": "string" }, "latitude": { "description": "The geographic latitude where the supplier is located.", "nullable": true, "type": "number" }, "longitude": { "description": "The geographic longitude where the supplier is located.", "nullable": true, "type": "number" }, "region": { "description": "The state/county/province/region where the supplier is located.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "country" ], "title": "ClimateRemovalsLocation", "type": "object", "x-expandableFields": [] }, "climate_removals_order_deliveries": { "description": "The delivery of a specified quantity of carbon for an order.", "properties": { "delivered_at": { "description": "Time at which the delivery occurred. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "location": { "anyOf": [ { "$ref": "#/components/schemas/climate_removals_location" } ], "description": "Specific location of this delivery.", "nullable": true }, "metric_tons": { "description": "Quantity of carbon removal supplied by this delivery.", "maxLength": 5000, "type": "string" }, "registry_url": { "description": "Once retired, a URL to the registry entry for the tons from this delivery.", "maxLength": 5000, "nullable": true, "type": "string" }, "supplier": { "$ref": "#/components/schemas/climate.supplier" } }, "required": [ "delivered_at", "metric_tons", "supplier" ], "title": "ClimateRemovalsOrderDeliveries", "type": "object", "x-expandableFields": [ "location", "supplier" ] }, "climate_removals_products_price": { "description": "", "properties": { "amount_fees": { "description": "Fees for one metric ton of carbon removal in the currency's smallest unit.", "type": "integer" }, "amount_subtotal": { "description": "Subtotal for one metric ton of carbon removal (excluding fees) in the currency's smallest unit.", "type": "integer" }, "amount_total": { "description": "Total for one metric ton of carbon removal (including fees) in the currency's smallest unit.", "type": "integer" } }, "required": [ "amount_fees", "amount_subtotal", "amount_total" ], "title": "ClimateRemovalsProductsPrice", "type": "object", "x-expandableFields": [] }, "confirmation_token": { "description": "ConfirmationTokens help transport client side data collected by Stripe JS over\nto your server for confirming a PaymentIntent or SetupIntent. If the confirmation\nis successful, values present on the ConfirmationToken are written onto the Intent.\n\nTo learn more about how to use ConfirmationToken, visit the related guides:\n- [Finalize payments on the server](https://stripe.com/docs/payments/finalize-payments-on-the-server)\n- [Build two-step confirmation](https://stripe.com/docs/payments/build-a-two-step-confirmation).", "properties": { "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "expires_at": { "description": "Time at which this ConfirmationToken expires and can no longer be used to confirm a PaymentIntent or SetupIntent.", "format": "unix-time", "nullable": true, "type": "integer" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "mandate_data": { "anyOf": [ { "$ref": "#/components/schemas/confirmation_tokens_resource_mandate_data" } ], "description": "Data used for generating a Mandate.", "nullable": true }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "confirmation_token" ], "type": "string" }, "payment_intent": { "description": "ID of the PaymentIntent that this ConfirmationToken was used to confirm, or null if this ConfirmationToken has not yet been used.", "maxLength": 5000, "nullable": true, "type": "string" }, "payment_method_options": { "anyOf": [ { "$ref": "#/components/schemas/confirmation_tokens_resource_payment_method_options" } ], "description": "Payment-method-specific configuration for this ConfirmationToken.", "nullable": true }, "payment_method_preview": { "anyOf": [ { "$ref": "#/components/schemas/confirmation_tokens_resource_payment_method_preview" } ], "description": "Payment details collected by the Payment Element, used to create a PaymentMethod when a PaymentIntent or SetupIntent is confirmed with this ConfirmationToken.", "nullable": true }, "return_url": { "description": "Return URL used to confirm the Intent.", "maxLength": 5000, "nullable": true, "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this ConfirmationToken's payment method.\n\nThe presence of this property will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete.", "enum": [ "off_session", "on_session" ], "nullable": true, "type": "string" }, "setup_intent": { "description": "ID of the SetupIntent that this ConfirmationToken was used to confirm, or null if this ConfirmationToken has not yet been used.", "maxLength": 5000, "nullable": true, "type": "string" }, "shipping": { "anyOf": [ { "$ref": "#/components/schemas/confirmation_tokens_resource_shipping" } ], "description": "Shipping information collected on this ConfirmationToken.", "nullable": true }, "use_stripe_sdk": { "description": "Indicates whether the Stripe SDK is used to handle confirmation flow. Defaults to `true` on ConfirmationToken.", "type": "boolean" } }, "required": [ "created", "id", "livemode", "object", "use_stripe_sdk" ], "title": "ConfirmationTokensResourceConfirmationToken", "type": "object", "x-expandableFields": [ "mandate_data", "payment_method_options", "payment_method_preview", "shipping" ], "x-resourceId": "confirmation_token" }, "confirmation_tokens_resource_mandate_data": { "description": "Data used for generating a Mandate.", "properties": { "customer_acceptance": { "$ref": "#/components/schemas/confirmation_tokens_resource_mandate_data_resource_customer_acceptance" } }, "required": [ "customer_acceptance" ], "title": "ConfirmationTokensResourceMandateData", "type": "object", "x-expandableFields": [ "customer_acceptance" ] }, "confirmation_tokens_resource_mandate_data_resource_customer_acceptance": { "description": "This hash contains details about the customer acceptance of the Mandate.", "properties": { "online": { "anyOf": [ { "$ref": "#/components/schemas/confirmation_tokens_resource_mandate_data_resource_customer_acceptance_resource_online" } ], "description": "If this is a Mandate accepted online, this hash contains details about the online acceptance.", "nullable": true }, "type": { "description": "The type of customer acceptance information included with the Mandate.", "maxLength": 5000, "type": "string" } }, "required": [ "type" ], "title": "ConfirmationTokensResourceMandateDataResourceCustomerAcceptance", "type": "object", "x-expandableFields": [ "online" ] }, "confirmation_tokens_resource_mandate_data_resource_customer_acceptance_resource_online": { "description": "This hash contains details about the online acceptance.", "properties": { "ip_address": { "description": "The IP address from which the Mandate was accepted by the customer.", "maxLength": 5000, "nullable": true, "type": "string" }, "user_agent": { "description": "The user agent of the browser from which the Mandate was accepted by the customer.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "ConfirmationTokensResourceMandateDataResourceCustomerAcceptanceResourceOnline", "type": "object", "x-expandableFields": [] }, "confirmation_tokens_resource_payment_method_options": { "description": "Payment-method-specific configuration", "properties": { "card": { "anyOf": [ { "$ref": "#/components/schemas/confirmation_tokens_resource_payment_method_options_resource_card" } ], "description": "This hash contains the card payment method options.", "nullable": true } }, "title": "ConfirmationTokensResourcePaymentMethodOptions", "type": "object", "x-expandableFields": [ "card" ] }, "confirmation_tokens_resource_payment_method_options_resource_card": { "description": "This hash contains the card payment method options.", "properties": { "cvc_token": { "description": "The `cvc_update` Token collected from the Payment Element.", "maxLength": 5000, "nullable": true, "type": "string" }, "installments": { "$ref": "#/components/schemas/confirmation_tokens_resource_payment_method_options_resource_card_resource_installment" } }, "title": "ConfirmationTokensResourcePaymentMethodOptionsResourceCard", "type": "object", "x-expandableFields": [ "installments" ] }, "confirmation_tokens_resource_payment_method_options_resource_card_resource_installment": { "description": "Installment configuration for payments.", "properties": { "plan": { "$ref": "#/components/schemas/payment_method_details_card_installments_plan" } }, "title": "ConfirmationTokensResourcePaymentMethodOptionsResourceCardResourceInstallment", "type": "object", "x-expandableFields": [ "plan" ] }, "confirmation_tokens_resource_payment_method_preview": { "description": "Details of the PaymentMethod collected by Payment Element", "properties": { "acss_debit": { "$ref": "#/components/schemas/payment_method_acss_debit" }, "affirm": { "$ref": "#/components/schemas/payment_method_affirm" }, "afterpay_clearpay": { "$ref": "#/components/schemas/payment_method_afterpay_clearpay" }, "alipay": { "$ref": "#/components/schemas/payment_flows_private_payment_methods_alipay" }, "allow_redisplay": { "description": "This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to “unspecified”.", "enum": [ "always", "limited", "unspecified" ], "type": "string" }, "alma": { "$ref": "#/components/schemas/payment_method_alma" }, "amazon_pay": { "$ref": "#/components/schemas/payment_method_amazon_pay" }, "au_becs_debit": { "$ref": "#/components/schemas/payment_method_au_becs_debit" }, "bacs_debit": { "$ref": "#/components/schemas/payment_method_bacs_debit" }, "bancontact": { "$ref": "#/components/schemas/payment_method_bancontact" }, "billie": { "$ref": "#/components/schemas/payment_method_billie" }, "billing_details": { "$ref": "#/components/schemas/billing_details" }, "blik": { "$ref": "#/components/schemas/payment_method_blik" }, "boleto": { "$ref": "#/components/schemas/payment_method_boleto" }, "card": { "$ref": "#/components/schemas/payment_method_card" }, "card_present": { "$ref": "#/components/schemas/payment_method_card_present" }, "cashapp": { "$ref": "#/components/schemas/payment_method_cashapp" }, "crypto": { "$ref": "#/components/schemas/payment_method_crypto" }, "customer": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/customer" } ], "description": "The ID of the Customer to which this PaymentMethod is saved. This will not be set when the PaymentMethod has not been saved to a Customer.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/customer" } ] } }, "customer_balance": { "$ref": "#/components/schemas/payment_method_customer_balance" }, "eps": { "$ref": "#/components/schemas/payment_method_eps" }, "fpx": { "$ref": "#/components/schemas/payment_method_fpx" }, "giropay": { "$ref": "#/components/schemas/payment_method_giropay" }, "grabpay": { "$ref": "#/components/schemas/payment_method_grabpay" }, "ideal": { "$ref": "#/components/schemas/payment_method_ideal" }, "interac_present": { "$ref": "#/components/schemas/payment_method_interac_present" }, "kakao_pay": { "$ref": "#/components/schemas/payment_method_kakao_pay" }, "klarna": { "$ref": "#/components/schemas/payment_method_klarna" }, "konbini": { "$ref": "#/components/schemas/payment_method_konbini" }, "kr_card": { "$ref": "#/components/schemas/payment_method_kr_card" }, "link": { "$ref": "#/components/schemas/payment_method_link" }, "mobilepay": { "$ref": "#/components/schemas/payment_method_mobilepay" }, "multibanco": { "$ref": "#/components/schemas/payment_method_multibanco" }, "naver_pay": { "$ref": "#/components/schemas/payment_method_naver_pay" }, "nz_bank_account": { "$ref": "#/components/schemas/payment_method_nz_bank_account" }, "oxxo": { "$ref": "#/components/schemas/payment_method_oxxo" }, "p24": { "$ref": "#/components/schemas/payment_method_p24" }, "pay_by_bank": { "$ref": "#/components/schemas/payment_method_pay_by_bank" }, "payco": { "$ref": "#/components/schemas/payment_method_payco" }, "paynow": { "$ref": "#/components/schemas/payment_method_paynow" }, "paypal": { "$ref": "#/components/schemas/payment_method_paypal" }, "pix": { "$ref": "#/components/schemas/payment_method_pix" }, "promptpay": { "$ref": "#/components/schemas/payment_method_promptpay" }, "revolut_pay": { "$ref": "#/components/schemas/payment_method_revolut_pay" }, "samsung_pay": { "$ref": "#/components/schemas/payment_method_samsung_pay" }, "satispay": { "$ref": "#/components/schemas/payment_method_satispay" }, "sepa_debit": { "$ref": "#/components/schemas/payment_method_sepa_debit" }, "sofort": { "$ref": "#/components/schemas/payment_method_sofort" }, "swish": { "$ref": "#/components/schemas/payment_method_swish" }, "twint": { "$ref": "#/components/schemas/payment_method_twint" }, "type": { "description": "The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.", "enum": [ "acss_debit", "affirm", "afterpay_clearpay", "alipay", "alma", "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", "billie", "blik", "boleto", "card", "card_present", "cashapp", "crypto", "customer_balance", "eps", "fpx", "giropay", "grabpay", "ideal", "interac_present", "kakao_pay", "klarna", "konbini", "kr_card", "link", "mobilepay", "multibanco", "naver_pay", "nz_bank_account", "oxxo", "p24", "pay_by_bank", "payco", "paynow", "paypal", "pix", "promptpay", "revolut_pay", "samsung_pay", "satispay", "sepa_debit", "sofort", "swish", "twint", "us_bank_account", "wechat_pay", "zip" ], "type": "string", "x-stripeBypassValidation": true }, "us_bank_account": { "$ref": "#/components/schemas/payment_method_us_bank_account" }, "wechat_pay": { "$ref": "#/components/schemas/payment_method_wechat_pay" }, "zip": { "$ref": "#/components/schemas/payment_method_zip" } }, "required": [ "billing_details", "type" ], "title": "ConfirmationTokensResourcePaymentMethodPreview", "type": "object", "x-expandableFields": [ "acss_debit", "affirm", "afterpay_clearpay", "alipay", "alma", "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", "billie", "billing_details", "blik", "boleto", "card", "card_present", "cashapp", "crypto", "customer", "customer_balance", "eps", "fpx", "giropay", "grabpay", "ideal", "interac_present", "kakao_pay", "klarna", "konbini", "kr_card", "link", "mobilepay", "multibanco", "naver_pay", "nz_bank_account", "oxxo", "p24", "pay_by_bank", "payco", "paynow", "paypal", "pix", "promptpay", "revolut_pay", "samsung_pay", "satispay", "sepa_debit", "sofort", "swish", "twint", "us_bank_account", "wechat_pay", "zip" ] }, "confirmation_tokens_resource_shipping": { "description": "", "properties": { "address": { "$ref": "#/components/schemas/address" }, "name": { "description": "Recipient name.", "maxLength": 5000, "type": "string" }, "phone": { "description": "Recipient phone (including extension).", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "address", "name" ], "title": "ConfirmationTokensResourceShipping", "type": "object", "x-expandableFields": [ "address" ] }, "connect_account_reference": { "description": "", "properties": { "account": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/account" } ], "description": "The connected account being referenced when `type` is `account`.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/account" } ] } }, "type": { "description": "Type of the account referenced.", "enum": [ "account", "self" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "ConnectAccountReference", "type": "object", "x-expandableFields": [ "account" ] }, "connect_collection_transfer": { "description": "", "properties": { "amount": { "description": "Amount transferred, in cents (or local equivalent).", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "destination": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/account" } ], "description": "ID of the account that funds are being collected for.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/account" } ] } }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "connect_collection_transfer" ], "type": "string" } }, "required": [ "amount", "currency", "destination", "id", "livemode", "object" ], "title": "ConnectCollectionTransfer", "type": "object", "x-expandableFields": [ "destination" ] }, "connect_embedded_account_config_claim": { "description": "", "properties": { "enabled": { "description": "Whether the embedded component is enabled.", "type": "boolean" }, "features": { "$ref": "#/components/schemas/connect_embedded_account_features_claim" } }, "required": [ "enabled", "features" ], "title": "ConnectEmbeddedAccountConfigClaim", "type": "object", "x-expandableFields": [ "features" ] }, "connect_embedded_account_features_claim": { "description": "", "properties": { "disable_stripe_user_authentication": { "description": "Whether Stripe user authentication is disabled. This value can only be `true` for accounts where `controller.requirement_collection` is `application` for the account. The default value is the opposite of the `external_account_collection` value. For example, if you don't set `external_account_collection`, it defaults to `true` and `disable_stripe_user_authentication` defaults to `false`.", "type": "boolean" }, "external_account_collection": { "description": "Whether external account collection is enabled. This feature can only be `false` for accounts where you’re responsible for collecting updated information when requirements are due or change, like Custom accounts. The default value for this feature is `true`.", "type": "boolean" } }, "required": [ "disable_stripe_user_authentication", "external_account_collection" ], "title": "ConnectEmbeddedAccountFeaturesClaim", "type": "object", "x-expandableFields": [] }, "connect_embedded_account_session_create_components": { "description": "", "properties": { "account_management": { "$ref": "#/components/schemas/connect_embedded_account_config_claim" }, "account_onboarding": { "$ref": "#/components/schemas/connect_embedded_account_config_claim" }, "balance_report": { "$ref": "#/components/schemas/connect_embedded_base_config_claim" }, "balances": { "$ref": "#/components/schemas/connect_embedded_payouts_config" }, "disputes_list": { "$ref": "#/components/schemas/connect_embedded_disputes_list_config" }, "documents": { "$ref": "#/components/schemas/connect_embedded_base_config_claim" }, "financial_account": { "$ref": "#/components/schemas/connect_embedded_financial_account_config_claim" }, "financial_account_transactions": { "$ref": "#/components/schemas/connect_embedded_financial_account_transactions_config_claim" }, "instant_payouts_promotion": { "$ref": "#/components/schemas/connect_embedded_instant_payouts_promotion_config" }, "issuing_card": { "$ref": "#/components/schemas/connect_embedded_issuing_card_config_claim" }, "issuing_cards_list": { "$ref": "#/components/schemas/connect_embedded_issuing_cards_list_config_claim" }, "notification_banner": { "$ref": "#/components/schemas/connect_embedded_account_config_claim" }, "payment_details": { "$ref": "#/components/schemas/connect_embedded_payments_config_claim" }, "payment_disputes": { "$ref": "#/components/schemas/connect_embedded_payment_disputes_config" }, "payments": { "$ref": "#/components/schemas/connect_embedded_payments_config_claim" }, "payout_details": { "$ref": "#/components/schemas/connect_embedded_base_config_claim" }, "payout_reconciliation_report": { "$ref": "#/components/schemas/connect_embedded_base_config_claim" }, "payouts": { "$ref": "#/components/schemas/connect_embedded_payouts_config" }, "payouts_list": { "$ref": "#/components/schemas/connect_embedded_base_config_claim" }, "tax_registrations": { "$ref": "#/components/schemas/connect_embedded_base_config_claim" }, "tax_settings": { "$ref": "#/components/schemas/connect_embedded_base_config_claim" } }, "required": [ "account_management", "account_onboarding", "balance_report", "balances", "disputes_list", "documents", "financial_account", "financial_account_transactions", "instant_payouts_promotion", "issuing_card", "issuing_cards_list", "notification_banner", "payment_details", "payment_disputes", "payments", "payout_details", "payout_reconciliation_report", "payouts", "payouts_list", "tax_registrations", "tax_settings" ], "title": "ConnectEmbeddedAccountSessionCreateComponents", "type": "object", "x-expandableFields": [ "account_management", "account_onboarding", "balance_report", "balances", "disputes_list", "documents", "financial_account", "financial_account_transactions", "instant_payouts_promotion", "issuing_card", "issuing_cards_list", "notification_banner", "payment_details", "payment_disputes", "payments", "payout_details", "payout_reconciliation_report", "payouts", "payouts_list", "tax_registrations", "tax_settings" ] }, "connect_embedded_base_config_claim": { "description": "", "properties": { "enabled": { "description": "Whether the embedded component is enabled.", "type": "boolean" }, "features": { "$ref": "#/components/schemas/connect_embedded_base_features" } }, "required": [ "enabled", "features" ], "title": "ConnectEmbeddedBaseConfigClaim", "type": "object", "x-expandableFields": [ "features" ] }, "connect_embedded_base_features": { "description": "", "properties": {}, "title": "ConnectEmbeddedBaseFeatures", "type": "object", "x-expandableFields": [] }, "connect_embedded_disputes_list_config": { "description": "", "properties": { "enabled": { "description": "Whether the embedded component is enabled.", "type": "boolean" }, "features": { "$ref": "#/components/schemas/connect_embedded_disputes_list_features" } }, "required": [ "enabled", "features" ], "title": "ConnectEmbeddedDisputesListConfig", "type": "object", "x-expandableFields": [ "features" ] }, "connect_embedded_disputes_list_features": { "description": "", "properties": { "capture_payments": { "description": "Whether to allow capturing and cancelling payment intents. This is `true` by default.", "type": "boolean" }, "destination_on_behalf_of_charge_management": { "description": "Whether connected accounts can manage destination charges that are created on behalf of them. This is `false` by default.", "type": "boolean" }, "dispute_management": { "description": "Whether responding to disputes is enabled, including submitting evidence and accepting disputes. This is `true` by default.", "type": "boolean" }, "refund_management": { "description": "Whether sending refunds is enabled. This is `true` by default.", "type": "boolean" } }, "required": [ "capture_payments", "destination_on_behalf_of_charge_management", "dispute_management", "refund_management" ], "title": "ConnectEmbeddedDisputesListFeatures", "type": "object", "x-expandableFields": [] }, "connect_embedded_financial_account_config_claim": { "description": "", "properties": { "enabled": { "description": "Whether the embedded component is enabled.", "type": "boolean" }, "features": { "$ref": "#/components/schemas/connect_embedded_financial_account_features" } }, "required": [ "enabled", "features" ], "title": "ConnectEmbeddedFinancialAccountConfigClaim", "type": "object", "x-expandableFields": [ "features" ] }, "connect_embedded_financial_account_features": { "description": "", "properties": { "disable_stripe_user_authentication": { "description": "Whether Stripe user authentication is disabled. This value can only be `true` for accounts where `controller.requirement_collection` is `application` for the account. The default value is the opposite of the `external_account_collection` value. For example, if you don't set `external_account_collection`, it defaults to `true` and `disable_stripe_user_authentication` defaults to `false`.", "type": "boolean" }, "external_account_collection": { "description": "Whether external account collection is enabled. This feature can only be `false` for accounts where you’re responsible for collecting updated information when requirements are due or change, like Custom accounts. The default value for this feature is `true`.", "type": "boolean" }, "send_money": { "description": "Whether to allow sending money.", "type": "boolean" }, "transfer_balance": { "description": "Whether to allow transferring balance.", "type": "boolean" } }, "required": [ "disable_stripe_user_authentication", "external_account_collection", "send_money", "transfer_balance" ], "title": "ConnectEmbeddedFinancialAccountFeatures", "type": "object", "x-expandableFields": [] }, "connect_embedded_financial_account_transactions_config_claim": { "description": "", "properties": { "enabled": { "description": "Whether the embedded component is enabled.", "type": "boolean" }, "features": { "$ref": "#/components/schemas/connect_embedded_financial_account_transactions_features" } }, "required": [ "enabled", "features" ], "title": "ConnectEmbeddedFinancialAccountTransactionsConfigClaim", "type": "object", "x-expandableFields": [ "features" ] }, "connect_embedded_financial_account_transactions_features": { "description": "", "properties": { "card_spend_dispute_management": { "description": "Whether to allow card spend dispute management features.", "type": "boolean" } }, "required": [ "card_spend_dispute_management" ], "title": "ConnectEmbeddedFinancialAccountTransactionsFeatures", "type": "object", "x-expandableFields": [] }, "connect_embedded_instant_payouts_promotion_config": { "description": "", "properties": { "enabled": { "description": "Whether the embedded component is enabled.", "type": "boolean" }, "features": { "$ref": "#/components/schemas/connect_embedded_instant_payouts_promotion_features" } }, "required": [ "enabled", "features" ], "title": "ConnectEmbeddedInstantPayoutsPromotionConfig", "type": "object", "x-expandableFields": [ "features" ] }, "connect_embedded_instant_payouts_promotion_features": { "description": "", "properties": { "disable_stripe_user_authentication": { "description": "Whether Stripe user authentication is disabled. This value can only be `true` for accounts where `controller.requirement_collection` is `application` for the account. The default value is the opposite of the `external_account_collection` value. For example, if you don't set `external_account_collection`, it defaults to `true` and `disable_stripe_user_authentication` defaults to `false`.", "type": "boolean" }, "external_account_collection": { "description": "Whether external account collection is enabled. This feature can only be `false` for accounts where you’re responsible for collecting updated information when requirements are due or change, like Custom accounts. The default value for this feature is `true`.", "type": "boolean" }, "instant_payouts": { "description": "Whether to allow creation of instant payouts. Defaults to `true` when `controller.losses.payments` is set to `stripe` for the account, otherwise `false`.", "type": "boolean" } }, "required": [ "disable_stripe_user_authentication", "external_account_collection", "instant_payouts" ], "title": "ConnectEmbeddedInstantPayoutsPromotionFeatures", "type": "object", "x-expandableFields": [] }, "connect_embedded_issuing_card_config_claim": { "description": "", "properties": { "enabled": { "description": "Whether the embedded component is enabled.", "type": "boolean" }, "features": { "$ref": "#/components/schemas/connect_embedded_issuing_card_features" } }, "required": [ "enabled", "features" ], "title": "ConnectEmbeddedIssuingCardConfigClaim", "type": "object", "x-expandableFields": [ "features" ] }, "connect_embedded_issuing_card_features": { "description": "", "properties": { "card_management": { "description": "Whether to allow card management features.", "type": "boolean" }, "card_spend_dispute_management": { "description": "Whether to allow card spend dispute management features.", "type": "boolean" }, "cardholder_management": { "description": "Whether to allow cardholder management features.", "type": "boolean" }, "spend_control_management": { "description": "Whether to allow spend control management features.", "type": "boolean" } }, "required": [ "card_management", "card_spend_dispute_management", "cardholder_management", "spend_control_management" ], "title": "ConnectEmbeddedIssuingCardFeatures", "type": "object", "x-expandableFields": [] }, "connect_embedded_issuing_cards_list_config_claim": { "description": "", "properties": { "enabled": { "description": "Whether the embedded component is enabled.", "type": "boolean" }, "features": { "$ref": "#/components/schemas/connect_embedded_issuing_cards_list_features" } }, "required": [ "enabled", "features" ], "title": "ConnectEmbeddedIssuingCardsListConfigClaim", "type": "object", "x-expandableFields": [ "features" ] }, "connect_embedded_issuing_cards_list_features": { "description": "", "properties": { "card_management": { "description": "Whether to allow card management features.", "type": "boolean" }, "card_spend_dispute_management": { "description": "Whether to allow card spend dispute management features.", "type": "boolean" }, "cardholder_management": { "description": "Whether to allow cardholder management features.", "type": "boolean" }, "disable_stripe_user_authentication": { "description": "Whether Stripe user authentication is disabled. This value can only be `true` for accounts where `controller.requirement_collection` is `application` for the account. The default value is the opposite of the `external_account_collection` value. For example, if you don't set `external_account_collection`, it defaults to `true` and `disable_stripe_user_authentication` defaults to `false`.", "type": "boolean" }, "spend_control_management": { "description": "Whether to allow spend control management features.", "type": "boolean" } }, "required": [ "card_management", "card_spend_dispute_management", "cardholder_management", "disable_stripe_user_authentication", "spend_control_management" ], "title": "ConnectEmbeddedIssuingCardsListFeatures", "type": "object", "x-expandableFields": [] }, "connect_embedded_payment_disputes_config": { "description": "", "properties": { "enabled": { "description": "Whether the embedded component is enabled.", "type": "boolean" }, "features": { "$ref": "#/components/schemas/connect_embedded_payment_disputes_features" } }, "required": [ "enabled", "features" ], "title": "ConnectEmbeddedPaymentDisputesConfig", "type": "object", "x-expandableFields": [ "features" ] }, "connect_embedded_payment_disputes_features": { "description": "", "properties": { "destination_on_behalf_of_charge_management": { "description": "Whether connected accounts can manage destination charges that are created on behalf of them. This is `false` by default.", "type": "boolean" }, "dispute_management": { "description": "Whether responding to disputes is enabled, including submitting evidence and accepting disputes. This is `true` by default.", "type": "boolean" }, "refund_management": { "description": "Whether sending refunds is enabled. This is `true` by default.", "type": "boolean" } }, "required": [ "destination_on_behalf_of_charge_management", "dispute_management", "refund_management" ], "title": "ConnectEmbeddedPaymentDisputesFeatures", "type": "object", "x-expandableFields": [] }, "connect_embedded_payments_config_claim": { "description": "", "properties": { "enabled": { "description": "Whether the embedded component is enabled.", "type": "boolean" }, "features": { "$ref": "#/components/schemas/connect_embedded_payments_features" } }, "required": [ "enabled", "features" ], "title": "ConnectEmbeddedPaymentsConfigClaim", "type": "object", "x-expandableFields": [ "features" ] }, "connect_embedded_payments_features": { "description": "", "properties": { "capture_payments": { "description": "Whether to allow capturing and cancelling payment intents. This is `true` by default.", "type": "boolean" }, "destination_on_behalf_of_charge_management": { "description": "Whether connected accounts can manage destination charges that are created on behalf of them. This is `false` by default.", "type": "boolean" }, "dispute_management": { "description": "Whether responding to disputes is enabled, including submitting evidence and accepting disputes. This is `true` by default.", "type": "boolean" }, "refund_management": { "description": "Whether sending refunds is enabled. This is `true` by default.", "type": "boolean" } }, "required": [ "capture_payments", "destination_on_behalf_of_charge_management", "dispute_management", "refund_management" ], "title": "ConnectEmbeddedPaymentsFeatures", "type": "object", "x-expandableFields": [] }, "connect_embedded_payouts_config": { "description": "", "properties": { "enabled": { "description": "Whether the embedded component is enabled.", "type": "boolean" }, "features": { "$ref": "#/components/schemas/connect_embedded_payouts_features" } }, "required": [ "enabled", "features" ], "title": "ConnectEmbeddedPayoutsConfig", "type": "object", "x-expandableFields": [ "features" ] }, "connect_embedded_payouts_features": { "description": "", "properties": { "disable_stripe_user_authentication": { "description": "Whether Stripe user authentication is disabled. This value can only be `true` for accounts where `controller.requirement_collection` is `application` for the account. The default value is the opposite of the `external_account_collection` value. For example, if you don't set `external_account_collection`, it defaults to `true` and `disable_stripe_user_authentication` defaults to `false`.", "type": "boolean" }, "edit_payout_schedule": { "description": "Whether to allow payout schedule to be changed. Defaults to `true` when `controller.losses.payments` is set to `stripe` for the account, otherwise `false`.", "type": "boolean" }, "external_account_collection": { "description": "Whether external account collection is enabled. This feature can only be `false` for accounts where you’re responsible for collecting updated information when requirements are due or change, like Custom accounts. The default value for this feature is `true`.", "type": "boolean" }, "instant_payouts": { "description": "Whether to allow creation of instant payouts. Defaults to `true` when `controller.losses.payments` is set to `stripe` for the account, otherwise `false`.", "type": "boolean" }, "standard_payouts": { "description": "Whether to allow creation of standard payouts. Defaults to `true` when `controller.losses.payments` is set to `stripe` for the account, otherwise `false`.", "type": "boolean" } }, "required": [ "disable_stripe_user_authentication", "edit_payout_schedule", "external_account_collection", "instant_payouts", "standard_payouts" ], "title": "ConnectEmbeddedPayoutsFeatures", "type": "object", "x-expandableFields": [] }, "country_spec": { "description": "Stripe needs to collect certain pieces of information about each account\ncreated. These requirements can differ depending on the account's country. The\nCountry Specs API makes these rules available to your integration.\n\nYou can also view the information from this API call as [an online\nguide](/docs/connect/required-verification-information).", "properties": { "default_currency": { "description": "The default currency for this country. This applies to both payment methods and bank accounts.", "maxLength": 5000, "type": "string" }, "id": { "description": "Unique identifier for the object. Represented as the ISO country code for this country.", "maxLength": 5000, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "country_spec" ], "type": "string" }, "supported_bank_account_currencies": { "additionalProperties": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "description": "Currencies that can be accepted in the specific country (for transfers).", "type": "object" }, "supported_payment_currencies": { "description": "Currencies that can be accepted in the specified country (for payments).", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "supported_payment_methods": { "description": "Payment methods available in the specified country. You may need to enable some payment methods (e.g., [ACH](https://stripe.com/docs/ach)) on your account before they appear in this list. The `stripe` payment method refers to [charging through your platform](https://stripe.com/docs/connect/destination-charges).", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "supported_transfer_countries": { "description": "Countries that can accept transfers from the specified country.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "verification_fields": { "$ref": "#/components/schemas/country_spec_verification_fields" } }, "required": [ "default_currency", "id", "object", "supported_bank_account_currencies", "supported_payment_currencies", "supported_payment_methods", "supported_transfer_countries", "verification_fields" ], "title": "CountrySpec", "type": "object", "x-expandableFields": [ "verification_fields" ], "x-resourceId": "country_spec" }, "country_spec_verification_field_details": { "description": "", "properties": { "additional": { "description": "Additional fields which are only required for some users.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "minimum": { "description": "Fields which every account must eventually provide.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "required": [ "additional", "minimum" ], "title": "CountrySpecVerificationFieldDetails", "type": "object", "x-expandableFields": [] }, "country_spec_verification_fields": { "description": "", "properties": { "company": { "$ref": "#/components/schemas/country_spec_verification_field_details" }, "individual": { "$ref": "#/components/schemas/country_spec_verification_field_details" } }, "required": [ "company", "individual" ], "title": "CountrySpecVerificationFields", "type": "object", "x-expandableFields": [ "company", "individual" ] }, "coupon": { "description": "A coupon contains information about a percent-off or amount-off discount you\nmight want to apply to a customer. Coupons may be applied to [subscriptions](https://stripe.com/docs/api#subscriptions), [invoices](https://stripe.com/docs/api#invoices),\n[checkout sessions](https://stripe.com/docs/api/checkout/sessions), [quotes](https://stripe.com/docs/api#quotes), and more. Coupons do not work with conventional one-off [charges](https://stripe.com/docs/api#create_charge) or [payment intents](https://stripe.com/docs/api/payment_intents).", "properties": { "amount_off": { "description": "Amount (in the `currency` specified) that will be taken off the subtotal of any invoices for this customer.", "nullable": true, "type": "integer" }, "applies_to": { "$ref": "#/components/schemas/coupon_applies_to" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "currency": { "description": "If `amount_off` has been set, the three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the amount to take off.", "format": "currency", "nullable": true, "type": "string" }, "currency_options": { "additionalProperties": { "$ref": "#/components/schemas/coupon_currency_option" }, "description": "Coupons defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).", "type": "object" }, "duration": { "description": "One of `forever`, `once`, or `repeating`. Describes how long a customer who applies this coupon will get the discount.", "enum": [ "forever", "once", "repeating" ], "type": "string", "x-stripeBypassValidation": true }, "duration_in_months": { "description": "If `duration` is `repeating`, the number of months the coupon applies. Null if coupon `duration` is `forever` or `once`.", "nullable": true, "type": "integer" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "max_redemptions": { "description": "Maximum number of times this coupon can be redeemed, in total, across all customers, before it is no longer valid.", "nullable": true, "type": "integer" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "nullable": true, "type": "object" }, "name": { "description": "Name of the coupon displayed to customers on for instance invoices or receipts.", "maxLength": 5000, "nullable": true, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "coupon" ], "type": "string" }, "percent_off": { "description": "Percent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon. For example, a coupon with percent_off of 50 will make a $ (or local equivalent)100 invoice $ (or local equivalent)50 instead.", "nullable": true, "type": "number" }, "redeem_by": { "description": "Date after which the coupon can no longer be redeemed.", "format": "unix-time", "nullable": true, "type": "integer" }, "times_redeemed": { "description": "Number of times this coupon has been applied to a customer.", "type": "integer" }, "valid": { "description": "Taking account of the above properties, whether this coupon can still be applied to a customer.", "type": "boolean" } }, "required": [ "created", "duration", "id", "livemode", "object", "times_redeemed", "valid" ], "title": "Coupon", "type": "object", "x-expandableFields": [ "applies_to", "currency_options" ], "x-resourceId": "coupon" }, "coupon_applies_to": { "description": "", "properties": { "products": { "description": "A list of product IDs this coupon applies to", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "required": [ "products" ], "title": "CouponAppliesTo", "type": "object", "x-expandableFields": [] }, "coupon_currency_option": { "description": "", "properties": { "amount_off": { "description": "Amount (in the `currency` specified) that will be taken off the subtotal of any invoices for this customer.", "type": "integer" } }, "required": [ "amount_off" ], "title": "CouponCurrencyOption", "type": "object", "x-expandableFields": [] }, "credit_balance": { "description": "", "properties": { "available_balance": { "$ref": "#/components/schemas/billing_credit_grants_resource_amount" }, "ledger_balance": { "$ref": "#/components/schemas/billing_credit_grants_resource_amount" } }, "required": [ "available_balance", "ledger_balance" ], "title": "CreditBalance", "type": "object", "x-expandableFields": [ "available_balance", "ledger_balance" ] }, "credit_note": { "description": "Issue a credit note to adjust an invoice's amount after the invoice is finalized.\n\nRelated guide: [Credit notes](https://stripe.com/docs/billing/invoices/credit-notes)", "properties": { "amount": { "description": "The integer amount in cents (or local equivalent) representing the total amount of the credit note, including tax.", "type": "integer" }, "amount_shipping": { "description": "This is the sum of all the shipping amounts.", "type": "integer" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "customer": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/customer" }, { "$ref": "#/components/schemas/deleted_customer" } ], "description": "ID of the customer.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/customer" }, { "$ref": "#/components/schemas/deleted_customer" } ] } }, "customer_balance_transaction": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/customer_balance_transaction" } ], "description": "Customer balance transaction related to this credit note.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/customer_balance_transaction" } ] } }, "discount_amount": { "description": "The integer amount in cents (or local equivalent) representing the total amount of discount that was credited.", "type": "integer" }, "discount_amounts": { "description": "The aggregate amounts calculated per discount for all line items.", "items": { "$ref": "#/components/schemas/discounts_resource_discount_amount" }, "type": "array" }, "effective_at": { "description": "The date when this credit note is in effect. Same as `created` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the credit note PDF.", "format": "unix-time", "nullable": true, "type": "integer" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "invoice": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/invoice" } ], "description": "ID of the invoice.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/invoice" } ] } }, "lines": { "description": "Line items that make up the credit note", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/credit_note_line_item" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "CreditNoteLinesList", "type": "object", "x-expandableFields": [ "data" ] }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "memo": { "description": "Customer-facing text that appears on the credit note PDF.", "maxLength": 5000, "nullable": true, "type": "string" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "nullable": true, "type": "object" }, "number": { "description": "A unique number that identifies this particular credit note and appears on the PDF of the credit note and its associated invoice.", "maxLength": 5000, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "credit_note" ], "type": "string" }, "out_of_band_amount": { "description": "Amount that was credited outside of Stripe.", "nullable": true, "type": "integer" }, "pdf": { "description": "The link to download the PDF of the credit note.", "maxLength": 5000, "type": "string" }, "post_payment_amount": { "description": "The amount of the credit note that was refunded to the customer, credited to the customer's balance, credited outside of Stripe, or any combination thereof.", "type": "integer" }, "pre_payment_amount": { "description": "The amount of the credit note by which the invoice's `amount_remaining` and `amount_due` were reduced.", "type": "integer" }, "pretax_credit_amounts": { "description": "The pretax credit amounts (ex: discount, credit grants, etc) for all line items.", "items": { "$ref": "#/components/schemas/credit_notes_pretax_credit_amount" }, "type": "array" }, "reason": { "description": "Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory`", "enum": [ "duplicate", "fraudulent", "order_change", "product_unsatisfactory" ], "nullable": true, "type": "string" }, "refunds": { "description": "Refunds related to this credit note.", "items": { "$ref": "#/components/schemas/credit_note_refund" }, "type": "array" }, "shipping_cost": { "anyOf": [ { "$ref": "#/components/schemas/invoices_resource_shipping_cost" } ], "description": "The details of the cost of shipping, including the ShippingRate applied to the invoice.", "nullable": true }, "status": { "description": "Status of this credit note, one of `issued` or `void`. Learn more about [voiding credit notes](https://stripe.com/docs/billing/invoices/credit-notes#voiding).", "enum": [ "issued", "void" ], "type": "string", "x-stripeBypassValidation": true }, "subtotal": { "description": "The integer amount in cents (or local equivalent) representing the amount of the credit note, excluding exclusive tax and invoice level discounts.", "type": "integer" }, "subtotal_excluding_tax": { "description": "The integer amount in cents (or local equivalent) representing the amount of the credit note, excluding all tax and invoice level discounts.", "nullable": true, "type": "integer" }, "total": { "description": "The integer amount in cents (or local equivalent) representing the total amount of the credit note, including tax and all discount.", "type": "integer" }, "total_excluding_tax": { "description": "The integer amount in cents (or local equivalent) representing the total amount of the credit note, excluding tax, but including discounts.", "nullable": true, "type": "integer" }, "total_taxes": { "description": "The aggregate tax information for all line items.", "items": { "$ref": "#/components/schemas/billing_bill_resource_invoicing_taxes_tax" }, "nullable": true, "type": "array" }, "type": { "description": "Type of this credit note, one of `pre_payment` or `post_payment`. A `pre_payment` credit note means it was issued when the invoice was open. A `post_payment` credit note means it was issued when the invoice was paid.", "enum": [ "mixed", "post_payment", "pre_payment" ], "type": "string" }, "voided_at": { "description": "The time that the credit note was voided.", "format": "unix-time", "nullable": true, "type": "integer" } }, "required": [ "amount", "amount_shipping", "created", "currency", "customer", "discount_amount", "discount_amounts", "id", "invoice", "lines", "livemode", "number", "object", "pdf", "post_payment_amount", "pre_payment_amount", "pretax_credit_amounts", "refunds", "status", "subtotal", "total", "type" ], "title": "CreditNote", "type": "object", "x-expandableFields": [ "customer", "customer_balance_transaction", "discount_amounts", "invoice", "lines", "pretax_credit_amounts", "refunds", "shipping_cost", "total_taxes" ], "x-resourceId": "credit_note" }, "credit_note_line_item": { "description": "The credit note line item object", "properties": { "amount": { "description": "The integer amount in cents (or local equivalent) representing the gross amount being credited for this line item, excluding (exclusive) tax and discounts.", "type": "integer" }, "description": { "description": "Description of the item being credited.", "maxLength": 5000, "nullable": true, "type": "string" }, "discount_amount": { "description": "The integer amount in cents (or local equivalent) representing the discount being credited for this line item.", "type": "integer" }, "discount_amounts": { "description": "The amount of discount calculated per discount for this line item", "items": { "$ref": "#/components/schemas/discounts_resource_discount_amount" }, "type": "array" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "invoice_line_item": { "description": "ID of the invoice line item being credited", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "credit_note_line_item" ], "type": "string" }, "pretax_credit_amounts": { "description": "The pretax credit amounts (ex: discount, credit grants, etc) for this line item.", "items": { "$ref": "#/components/schemas/credit_notes_pretax_credit_amount" }, "type": "array" }, "quantity": { "description": "The number of units of product being credited.", "nullable": true, "type": "integer" }, "tax_rates": { "description": "The tax rates which apply to the line item.", "items": { "$ref": "#/components/schemas/tax_rate" }, "type": "array" }, "taxes": { "description": "The tax information of the line item.", "items": { "$ref": "#/components/schemas/billing_bill_resource_invoicing_taxes_tax" }, "nullable": true, "type": "array" }, "type": { "description": "The type of the credit note line item, one of `invoice_line_item` or `custom_line_item`. When the type is `invoice_line_item` there is an additional `invoice_line_item` property on the resource the value of which is the id of the credited line item on the invoice.", "enum": [ "custom_line_item", "invoice_line_item" ], "type": "string" }, "unit_amount": { "description": "The cost of each unit of product being credited.", "nullable": true, "type": "integer" }, "unit_amount_decimal": { "description": "Same as `unit_amount`, but contains a decimal value with at most 12 decimal places.", "format": "decimal", "nullable": true, "type": "string" } }, "required": [ "amount", "discount_amount", "discount_amounts", "id", "livemode", "object", "pretax_credit_amounts", "tax_rates", "type" ], "title": "CreditNoteLineItem", "type": "object", "x-expandableFields": [ "discount_amounts", "pretax_credit_amounts", "tax_rates", "taxes" ], "x-resourceId": "credit_note_line_item" }, "credit_note_refund": { "description": "", "properties": { "amount_refunded": { "description": "Amount of the refund that applies to this credit note, in cents (or local equivalent).", "type": "integer" }, "refund": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/refund" } ], "description": "ID of the refund.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/refund" } ] } } }, "required": [ "amount_refunded", "refund" ], "title": "CreditNoteRefund", "type": "object", "x-expandableFields": [ "refund" ] }, "credit_notes_pretax_credit_amount": { "description": "", "properties": { "amount": { "description": "The amount, in cents (or local equivalent), of the pretax credit amount.", "type": "integer" }, "credit_balance_transaction": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/billing.credit_balance_transaction" } ], "description": "The credit balance transaction that was applied to get this pretax credit amount.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/billing.credit_balance_transaction" } ] } }, "discount": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/discount" }, { "$ref": "#/components/schemas/deleted_discount" } ], "description": "The discount that was applied to get this pretax credit amount.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/discount" }, { "$ref": "#/components/schemas/deleted_discount" } ] } }, "type": { "description": "Type of the pretax credit amount referenced.", "enum": [ "credit_balance_transaction", "discount" ], "type": "string" } }, "required": [ "amount", "type" ], "title": "CreditNotesPretaxCreditAmount", "type": "object", "x-expandableFields": [ "credit_balance_transaction", "discount" ] }, "currency_option": { "description": "", "properties": { "custom_unit_amount": { "anyOf": [ { "$ref": "#/components/schemas/custom_unit_amount" } ], "description": "When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.", "nullable": true }, "tax_behavior": { "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.", "enum": [ "exclusive", "inclusive", "unspecified" ], "nullable": true, "type": "string" }, "tiers": { "description": "Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.", "items": { "$ref": "#/components/schemas/price_tier" }, "type": "array" }, "unit_amount": { "description": "The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`.", "nullable": true, "type": "integer" }, "unit_amount_decimal": { "description": "The unit amount in cents (or local equivalent) to be charged, represented as a decimal string with at most 12 decimal places. Only set if `billing_scheme=per_unit`.", "format": "decimal", "nullable": true, "type": "string" } }, "title": "CurrencyOption", "type": "object", "x-expandableFields": [ "custom_unit_amount", "tiers" ] }, "custom_unit_amount": { "description": "", "properties": { "maximum": { "description": "The maximum unit amount the customer can specify for this item.", "nullable": true, "type": "integer" }, "minimum": { "description": "The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.", "nullable": true, "type": "integer" }, "preset": { "description": "The starting unit amount which can be updated by the customer.", "nullable": true, "type": "integer" } }, "title": "CustomUnitAmount", "type": "object", "x-expandableFields": [] }, "customer": { "description": "This object represents a customer of your business. Use it to [create recurring charges](https://stripe.com/docs/invoicing/customer), [save payment](https://stripe.com/docs/payments/save-during-payment) and contact information,\nand track payments that belong to the same customer.", "properties": { "address": { "anyOf": [ { "$ref": "#/components/schemas/address" } ], "description": "The customer's address.", "nullable": true }, "balance": { "description": "The current balance, if any, that's stored on the customer in their default currency. If negative, the customer has credit to apply to their next invoice. If positive, the customer has an amount owed that's added to their next invoice. The balance only considers amounts that Stripe hasn't successfully applied to any invoice. It doesn't reflect unpaid invoices. This balance is only taken into account after invoices finalize. For multi-currency balances, see [invoice_credit_balance](https://stripe.com/docs/api/customers/object#customer_object-invoice_credit_balance).", "type": "integer" }, "cash_balance": { "anyOf": [ { "$ref": "#/components/schemas/cash_balance" } ], "description": "The current funds being held by Stripe on behalf of the customer. You can apply these funds towards payment intents when the source is \"cash_balance\". The `settings[reconciliation_mode]` field describes if these funds apply to these payment intents manually or automatically.", "nullable": true }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "currency": { "description": "Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) the customer can be charged in for recurring billing purposes.", "maxLength": 5000, "nullable": true, "type": "string" }, "default_source": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/bank_account" }, { "$ref": "#/components/schemas/card" }, { "$ref": "#/components/schemas/source" } ], "description": "ID of the default payment source for the customer.\n\nIf you use payment methods created through the PaymentMethods API, see the [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) field instead.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/bank_account" }, { "$ref": "#/components/schemas/card" }, { "$ref": "#/components/schemas/source" } ] }, "x-stripeBypassValidation": true }, "delinquent": { "description": "Tracks the most recent state change on any invoice belonging to the customer. Paying an invoice or marking it uncollectible via the API will set this field to false. An automatic payment failure or passing the `invoice.due_date` will set this field to `true`.\n\nIf an invoice becomes uncollectible by [dunning](https://stripe.com/docs/billing/automatic-collection), `delinquent` doesn't reset to `false`.\n\nIf you care whether the customer has paid their most recent subscription invoice, use `subscription.status` instead. Paying or marking uncollectible any customer invoice regardless of whether it is the latest invoice for a subscription will always set this field to `false`.", "nullable": true, "type": "boolean" }, "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users.", "maxLength": 5000, "nullable": true, "type": "string" }, "discount": { "anyOf": [ { "$ref": "#/components/schemas/discount" } ], "description": "Describes the current discount active on the customer, if there is one.", "nullable": true }, "email": { "description": "The customer's email address.", "maxLength": 5000, "nullable": true, "type": "string" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "invoice_credit_balance": { "additionalProperties": { "type": "integer" }, "description": "The current multi-currency balances, if any, that's stored on the customer. If positive in a currency, the customer has a credit to apply to their next invoice denominated in that currency. If negative, the customer has an amount owed that's added to their next invoice denominated in that currency. These balances don't apply to unpaid invoices. They solely track amounts that Stripe hasn't successfully applied to any invoice. Stripe only applies a balance in a specific currency to an invoice after that invoice (which is in the same currency) finalizes.", "type": "object" }, "invoice_prefix": { "description": "The prefix for the customer used to generate unique invoice numbers.", "maxLength": 5000, "nullable": true, "type": "string" }, "invoice_settings": { "$ref": "#/components/schemas/invoice_setting_customer_setting" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "type": "object" }, "name": { "description": "The customer's full name or business name.", "maxLength": 5000, "nullable": true, "type": "string" }, "next_invoice_sequence": { "description": "The suffix of the customer's next invoice number (for example, 0001). When the account uses account level sequencing, this parameter is ignored in API requests and the field omitted in API responses.", "type": "integer" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "customer" ], "type": "string" }, "phone": { "description": "The customer's phone number.", "maxLength": 5000, "nullable": true, "type": "string" }, "preferred_locales": { "description": "The customer's preferred locales (languages), ordered by preference.", "items": { "maxLength": 5000, "type": "string" }, "nullable": true, "type": "array" }, "shipping": { "anyOf": [ { "$ref": "#/components/schemas/shipping" } ], "description": "Mailing and shipping address for the customer. Appears on invoices emailed to this customer.", "nullable": true }, "sources": { "description": "The customer's payment sources, if any.", "properties": { "data": { "description": "Details about each object.", "items": { "anyOf": [ { "$ref": "#/components/schemas/bank_account" }, { "$ref": "#/components/schemas/card" }, { "$ref": "#/components/schemas/source" } ], "title": "Polymorphic", "x-stripeBypassValidation": true }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "ApmsSourcesSourceList", "type": "object", "x-expandableFields": [ "data" ] }, "subscriptions": { "description": "The customer's current subscriptions, if any.", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/subscription" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "SubscriptionList", "type": "object", "x-expandableFields": [ "data" ] }, "tax": { "$ref": "#/components/schemas/customer_tax" }, "tax_exempt": { "description": "Describes the customer's tax exemption status, which is `none`, `exempt`, or `reverse`. When set to `reverse`, invoice and receipt PDFs include the following text: **\"Reverse charge\"**.", "enum": [ "exempt", "none", "reverse" ], "nullable": true, "type": "string" }, "tax_ids": { "description": "The customer's tax IDs.", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/tax_id" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "TaxIDsList", "type": "object", "x-expandableFields": [ "data" ] }, "test_clock": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/test_helpers.test_clock" } ], "description": "ID of the test clock that this customer belongs to.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/test_helpers.test_clock" } ] } } }, "required": [ "created", "id", "livemode", "object" ], "title": "Customer", "type": "object", "x-expandableFields": [ "address", "cash_balance", "default_source", "discount", "invoice_settings", "shipping", "sources", "subscriptions", "tax", "tax_ids", "test_clock" ], "x-resourceId": "customer" }, "customer_acceptance": { "description": "", "properties": { "accepted_at": { "description": "The time that the customer accepts the mandate.", "format": "unix-time", "nullable": true, "type": "integer" }, "offline": { "$ref": "#/components/schemas/offline_acceptance" }, "online": { "$ref": "#/components/schemas/online_acceptance" }, "type": { "description": "The mandate includes the type of customer acceptance information, such as: `online` or `offline`.", "enum": [ "offline", "online" ], "type": "string" } }, "required": [ "type" ], "title": "customer_acceptance", "type": "object", "x-expandableFields": [ "offline", "online" ] }, "customer_balance_customer_balance_settings": { "description": "", "properties": { "reconciliation_mode": { "description": "The configuration for how funds that land in the customer cash balance are reconciled.", "enum": [ "automatic", "manual" ], "type": "string" }, "using_merchant_default": { "description": "A flag to indicate if reconciliation mode returned is the user's default or is specific to this customer cash balance", "type": "boolean" } }, "required": [ "reconciliation_mode", "using_merchant_default" ], "title": "CustomerBalanceCustomerBalanceSettings", "type": "object", "x-expandableFields": [] }, "customer_balance_resource_cash_balance_transaction_resource_adjusted_for_overdraft": { "description": "", "properties": { "balance_transaction": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/balance_transaction" } ], "description": "The [Balance Transaction](https://stripe.com/docs/api/balance_transactions/object) that corresponds to funds taken out of your Stripe balance.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/balance_transaction" } ] } }, "linked_transaction": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/customer_cash_balance_transaction" } ], "description": "The [Cash Balance Transaction](https://stripe.com/docs/api/cash_balance_transactions/object) that brought the customer balance negative, triggering the clawback of funds.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/customer_cash_balance_transaction" } ] } } }, "required": [ "balance_transaction", "linked_transaction" ], "title": "CustomerBalanceResourceCashBalanceTransactionResourceAdjustedForOverdraft", "type": "object", "x-expandableFields": [ "balance_transaction", "linked_transaction" ] }, "customer_balance_resource_cash_balance_transaction_resource_applied_to_payment_transaction": { "description": "", "properties": { "payment_intent": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/payment_intent" } ], "description": "The [Payment Intent](https://stripe.com/docs/api/payment_intents/object) that funds were applied to.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/payment_intent" } ] } } }, "required": [ "payment_intent" ], "title": "CustomerBalanceResourceCashBalanceTransactionResourceAppliedToPaymentTransaction", "type": "object", "x-expandableFields": [ "payment_intent" ] }, "customer_balance_resource_cash_balance_transaction_resource_funded_transaction": { "description": "", "properties": { "bank_transfer": { "$ref": "#/components/schemas/customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer" } }, "required": [ "bank_transfer" ], "title": "CustomerBalanceResourceCashBalanceTransactionResourceFundedTransaction", "type": "object", "x-expandableFields": [ "bank_transfer" ] }, "customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer": { "description": "", "properties": { "eu_bank_transfer": { "$ref": "#/components/schemas/customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_eu_bank_transfer" }, "gb_bank_transfer": { "$ref": "#/components/schemas/customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_gb_bank_transfer" }, "jp_bank_transfer": { "$ref": "#/components/schemas/customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_jp_bank_transfer" }, "reference": { "description": "The user-supplied reference field on the bank transfer.", "maxLength": 5000, "nullable": true, "type": "string" }, "type": { "description": "The funding method type used to fund the customer balance. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.", "enum": [ "eu_bank_transfer", "gb_bank_transfer", "jp_bank_transfer", "mx_bank_transfer", "us_bank_transfer" ], "type": "string", "x-stripeBypassValidation": true }, "us_bank_transfer": { "$ref": "#/components/schemas/customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_us_bank_transfer" } }, "required": [ "type" ], "title": "CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransfer", "type": "object", "x-expandableFields": [ "eu_bank_transfer", "gb_bank_transfer", "jp_bank_transfer", "us_bank_transfer" ] }, "customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_eu_bank_transfer": { "description": "", "properties": { "bic": { "description": "The BIC of the bank of the sender of the funding.", "maxLength": 5000, "nullable": true, "type": "string" }, "iban_last4": { "description": "The last 4 digits of the IBAN of the sender of the funding.", "maxLength": 5000, "nullable": true, "type": "string" }, "sender_name": { "description": "The full name of the sender, as supplied by the sending bank.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransferResourceEuBankTransfer", "type": "object", "x-expandableFields": [] }, "customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_gb_bank_transfer": { "description": "", "properties": { "account_number_last4": { "description": "The last 4 digits of the account number of the sender of the funding.", "maxLength": 5000, "nullable": true, "type": "string" }, "sender_name": { "description": "The full name of the sender, as supplied by the sending bank.", "maxLength": 5000, "nullable": true, "type": "string" }, "sort_code": { "description": "The sort code of the bank of the sender of the funding", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransferResourceGbBankTransfer", "type": "object", "x-expandableFields": [] }, "customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_jp_bank_transfer": { "description": "", "properties": { "sender_bank": { "description": "The name of the bank of the sender of the funding.", "maxLength": 5000, "nullable": true, "type": "string" }, "sender_branch": { "description": "The name of the bank branch of the sender of the funding.", "maxLength": 5000, "nullable": true, "type": "string" }, "sender_name": { "description": "The full name of the sender, as supplied by the sending bank.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransferResourceJpBankTransfer", "type": "object", "x-expandableFields": [] }, "customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_us_bank_transfer": { "description": "", "properties": { "network": { "description": "The banking network used for this funding.", "enum": [ "ach", "domestic_wire_us", "swift" ], "type": "string" }, "sender_name": { "description": "The full name of the sender, as supplied by the sending bank.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransferResourceUsBankTransfer", "type": "object", "x-expandableFields": [] }, "customer_balance_resource_cash_balance_transaction_resource_refunded_from_payment_transaction": { "description": "", "properties": { "refund": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/refund" } ], "description": "The [Refund](https://stripe.com/docs/api/refunds/object) that moved these funds into the customer's cash balance.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/refund" } ] } } }, "required": [ "refund" ], "title": "CustomerBalanceResourceCashBalanceTransactionResourceRefundedFromPaymentTransaction", "type": "object", "x-expandableFields": [ "refund" ] }, "customer_balance_resource_cash_balance_transaction_resource_transferred_to_balance": { "description": "", "properties": { "balance_transaction": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/balance_transaction" } ], "description": "The [Balance Transaction](https://stripe.com/docs/api/balance_transactions/object) that corresponds to funds transferred to your Stripe balance.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/balance_transaction" } ] } } }, "required": [ "balance_transaction" ], "title": "CustomerBalanceResourceCashBalanceTransactionResourceTransferredToBalance", "type": "object", "x-expandableFields": [ "balance_transaction" ] }, "customer_balance_resource_cash_balance_transaction_resource_unapplied_from_payment_transaction": { "description": "", "properties": { "payment_intent": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/payment_intent" } ], "description": "The [Payment Intent](https://stripe.com/docs/api/payment_intents/object) that funds were unapplied from.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/payment_intent" } ] } } }, "required": [ "payment_intent" ], "title": "CustomerBalanceResourceCashBalanceTransactionResourceUnappliedFromPaymentTransaction", "type": "object", "x-expandableFields": [ "payment_intent" ] }, "customer_balance_transaction": { "description": "Each customer has a [Balance](https://stripe.com/docs/api/customers/object#customer_object-balance) value,\nwhich denotes a debit or credit that's automatically applied to their next invoice upon finalization.\nYou may modify the value directly by using the [update customer API](https://stripe.com/docs/api/customers/update),\nor by creating a Customer Balance Transaction, which increments or decrements the customer's `balance` by the specified `amount`.\n\nRelated guide: [Customer balance](https://stripe.com/docs/billing/customer/balance)", "properties": { "amount": { "description": "The amount of the transaction. A negative value is a credit for the customer's balance, and a positive value is a debit to the customer's `balance`.", "type": "integer" }, "checkout_session": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/checkout.session" } ], "description": "The ID of the checkout session (if any) that created the transaction.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/checkout.session" } ] } }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "credit_note": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/credit_note" } ], "description": "The ID of the credit note (if any) related to the transaction.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/credit_note" } ] } }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "customer": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/customer" } ], "description": "The ID of the customer the transaction belongs to.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/customer" } ] } }, "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users.", "maxLength": 5000, "nullable": true, "type": "string" }, "ending_balance": { "description": "The customer's `balance` after the transaction was applied. A negative value decreases the amount due on the customer's next invoice. A positive value increases the amount due on the customer's next invoice.", "type": "integer" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "invoice": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/invoice" } ], "description": "The ID of the invoice (if any) related to the transaction.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/invoice" } ] } }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "nullable": true, "type": "object" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "customer_balance_transaction" ], "type": "string" }, "type": { "description": "Transaction type: `adjustment`, `applied_to_invoice`, `credit_note`, `initial`, `invoice_overpaid`, `invoice_too_large`, `invoice_too_small`, `unspent_receiver_credit`, `unapplied_from_invoice`, `checkout_session_subscription_payment`, or `checkout_session_subscription_payment_canceled`. See the [Customer Balance page](https://stripe.com/docs/billing/customer/balance#types) to learn more about transaction types.", "enum": [ "adjustment", "applied_to_invoice", "checkout_session_subscription_payment", "checkout_session_subscription_payment_canceled", "credit_note", "initial", "invoice_overpaid", "invoice_too_large", "invoice_too_small", "migration", "unapplied_from_invoice", "unspent_receiver_credit" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "amount", "created", "currency", "customer", "ending_balance", "id", "livemode", "object", "type" ], "title": "CustomerBalanceTransaction", "type": "object", "x-expandableFields": [ "checkout_session", "credit_note", "customer", "invoice" ], "x-resourceId": "customer_balance_transaction" }, "customer_cash_balance_transaction": { "description": "Customers with certain payments enabled have a cash balance, representing funds that were paid\nby the customer to a merchant, but have not yet been allocated to a payment. Cash Balance Transactions\nrepresent when funds are moved into or out of this balance. This includes funding by the customer, allocation\nto payments, and refunds to the customer.", "properties": { "adjusted_for_overdraft": { "$ref": "#/components/schemas/customer_balance_resource_cash_balance_transaction_resource_adjusted_for_overdraft" }, "applied_to_payment": { "$ref": "#/components/schemas/customer_balance_resource_cash_balance_transaction_resource_applied_to_payment_transaction" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "maxLength": 5000, "type": "string" }, "customer": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/customer" } ], "description": "The customer whose available cash balance changed as a result of this transaction.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/customer" } ] } }, "ending_balance": { "description": "The total available cash balance for the specified currency after this transaction was applied. Represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", "type": "integer" }, "funded": { "$ref": "#/components/schemas/customer_balance_resource_cash_balance_transaction_resource_funded_transaction" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "net_amount": { "description": "The amount by which the cash balance changed, represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). A positive value represents funds being added to the cash balance, a negative value represents funds being removed from the cash balance.", "type": "integer" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "customer_cash_balance_transaction" ], "type": "string" }, "refunded_from_payment": { "$ref": "#/components/schemas/customer_balance_resource_cash_balance_transaction_resource_refunded_from_payment_transaction" }, "transferred_to_balance": { "$ref": "#/components/schemas/customer_balance_resource_cash_balance_transaction_resource_transferred_to_balance" }, "type": { "description": "The type of the cash balance transaction. New types may be added in future. See [Customer Balance](https://stripe.com/docs/payments/customer-balance#types) to learn more about these types.", "enum": [ "adjusted_for_overdraft", "applied_to_payment", "funded", "funding_reversed", "refunded_from_payment", "return_canceled", "return_initiated", "transferred_to_balance", "unapplied_from_payment" ], "type": "string" }, "unapplied_from_payment": { "$ref": "#/components/schemas/customer_balance_resource_cash_balance_transaction_resource_unapplied_from_payment_transaction" } }, "required": [ "created", "currency", "customer", "ending_balance", "id", "livemode", "net_amount", "object", "type" ], "title": "CustomerCashBalanceTransaction", "type": "object", "x-expandableFields": [ "adjusted_for_overdraft", "applied_to_payment", "customer", "funded", "refunded_from_payment", "transferred_to_balance", "unapplied_from_payment" ], "x-resourceId": "customer_cash_balance_transaction" }, "customer_session": { "description": "A Customer Session allows you to grant Stripe's frontend SDKs (like Stripe.js) client-side access\ncontrol over a Customer.\n\nRelated guides: [Customer Session with the Payment Element](/payments/accept-a-payment-deferred?platform=web&type=payment#save-payment-methods),\n[Customer Session with the Pricing Table](/payments/checkout/pricing-table#customer-session),\n[Customer Session with the Buy Button](/payment-links/buy-button#pass-an-existing-customer).", "properties": { "client_secret": { "description": "The client secret of this Customer Session. Used on the client to set up secure access to the given `customer`.\n\nThe client secret can be used to provide access to `customer` from your frontend. It should not be stored, logged, or exposed to anyone other than the relevant customer. Make sure that you have TLS enabled on any page that includes the client secret.", "maxLength": 5000, "type": "string" }, "components": { "$ref": "#/components/schemas/customer_session_resource_components" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "customer": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/customer" } ], "description": "The Customer the Customer Session was created for.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/customer" } ] } }, "expires_at": { "description": "The timestamp at which this Customer Session will expire.", "format": "unix-time", "type": "integer" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "customer_session" ], "type": "string" } }, "required": [ "client_secret", "created", "customer", "expires_at", "livemode", "object" ], "title": "CustomerSessionResourceCustomerSession", "type": "object", "x-expandableFields": [ "components", "customer" ], "x-resourceId": "customer_session" }, "customer_session_resource_components": { "description": "Configuration for the components supported by this Customer Session.", "properties": { "buy_button": { "$ref": "#/components/schemas/customer_session_resource_components_resource_buy_button" }, "payment_element": { "$ref": "#/components/schemas/customer_session_resource_components_resource_payment_element" }, "pricing_table": { "$ref": "#/components/schemas/customer_session_resource_components_resource_pricing_table" } }, "required": [ "buy_button", "payment_element", "pricing_table" ], "title": "CustomerSessionResourceComponents", "type": "object", "x-expandableFields": [ "buy_button", "payment_element", "pricing_table" ] }, "customer_session_resource_components_resource_buy_button": { "description": "This hash contains whether the buy button is enabled.", "properties": { "enabled": { "description": "Whether the buy button is enabled.", "type": "boolean" } }, "required": [ "enabled" ], "title": "CustomerSessionResourceComponentsResourceBuyButton", "type": "object", "x-expandableFields": [] }, "customer_session_resource_components_resource_payment_element": { "description": "This hash contains whether the Payment Element is enabled and the features it supports.", "properties": { "enabled": { "description": "Whether the Payment Element is enabled.", "type": "boolean" }, "features": { "anyOf": [ { "$ref": "#/components/schemas/customer_session_resource_components_resource_payment_element_resource_features" } ], "description": "This hash defines whether the Payment Element supports certain features.", "nullable": true } }, "required": [ "enabled" ], "title": "CustomerSessionResourceComponentsResourcePaymentElement", "type": "object", "x-expandableFields": [ "features" ] }, "customer_session_resource_components_resource_payment_element_resource_features": { "description": "This hash contains the features the Payment Element supports.", "properties": { "payment_method_allow_redisplay_filters": { "description": "A list of [`allow_redisplay`](https://docs.stripe.com/api/payment_methods/object#payment_method_object-allow_redisplay) values that controls which saved payment methods the Payment Element displays by filtering to only show payment methods with an `allow_redisplay` value that is present in this list.\n\nIf not specified, defaults to [\"always\"]. In order to display all saved payment methods, specify [\"always\", \"limited\", \"unspecified\"].", "items": { "enum": [ "always", "limited", "unspecified" ], "type": "string" }, "type": "array" }, "payment_method_redisplay": { "description": "Controls whether or not the Payment Element shows saved payment methods. This parameter defaults to `disabled`.", "enum": [ "disabled", "enabled" ], "type": "string", "x-stripeBypassValidation": true }, "payment_method_redisplay_limit": { "description": "Determines the max number of saved payment methods for the Payment Element to display. This parameter defaults to `3`. The maximum redisplay limit is `10`.", "nullable": true, "type": "integer" }, "payment_method_remove": { "description": "Controls whether the Payment Element displays the option to remove a saved payment method. This parameter defaults to `disabled`.\n\nAllowing buyers to remove their saved payment methods impacts subscriptions that depend on that payment method. Removing the payment method detaches the [`customer` object](https://docs.stripe.com/api/payment_methods/object#payment_method_object-customer) from that [PaymentMethod](https://docs.stripe.com/api/payment_methods).", "enum": [ "disabled", "enabled" ], "type": "string", "x-stripeBypassValidation": true }, "payment_method_save": { "description": "Controls whether the Payment Element displays a checkbox offering to save a new payment method. This parameter defaults to `disabled`.\n\nIf a customer checks the box, the [`allow_redisplay`](https://docs.stripe.com/api/payment_methods/object#payment_method_object-allow_redisplay) value on the PaymentMethod is set to `'always'` at confirmation time. For PaymentIntents, the [`setup_future_usage`](https://docs.stripe.com/api/payment_intents/object#payment_intent_object-setup_future_usage) value is also set to the value defined in `payment_method_save_usage`.", "enum": [ "disabled", "enabled" ], "type": "string", "x-stripeBypassValidation": true }, "payment_method_save_usage": { "description": "When using PaymentIntents and the customer checks the save checkbox, this field determines the [`setup_future_usage`](https://docs.stripe.com/api/payment_intents/object#payment_intent_object-setup_future_usage) value used to confirm the PaymentIntent.\n\nWhen using SetupIntents, directly configure the [`usage`](https://docs.stripe.com/api/setup_intents/object#setup_intent_object-usage) value on SetupIntent creation.", "enum": [ "off_session", "on_session" ], "nullable": true, "type": "string" } }, "required": [ "payment_method_allow_redisplay_filters", "payment_method_redisplay", "payment_method_remove", "payment_method_save" ], "title": "CustomerSessionResourceComponentsResourcePaymentElementResourceFeatures", "type": "object", "x-expandableFields": [] }, "customer_session_resource_components_resource_pricing_table": { "description": "This hash contains whether the pricing table is enabled.", "properties": { "enabled": { "description": "Whether the pricing table is enabled.", "type": "boolean" } }, "required": [ "enabled" ], "title": "CustomerSessionResourceComponentsResourcePricingTable", "type": "object", "x-expandableFields": [] }, "customer_tax": { "description": "", "properties": { "automatic_tax": { "description": "Surfaces if automatic tax computation is possible given the current customer location information.", "enum": [ "failed", "not_collecting", "supported", "unrecognized_location" ], "type": "string" }, "ip_address": { "description": "A recent IP address of the customer used for tax reporting and tax location inference.", "maxLength": 5000, "nullable": true, "type": "string" }, "location": { "anyOf": [ { "$ref": "#/components/schemas/customer_tax_location" } ], "description": "The identified tax location of the customer.", "nullable": true } }, "required": [ "automatic_tax" ], "title": "CustomerTax", "type": "object", "x-expandableFields": [ "location" ] }, "customer_tax_location": { "description": "", "properties": { "country": { "description": "The identified tax country of the customer.", "maxLength": 5000, "type": "string" }, "source": { "description": "The data source used to infer the customer's location.", "enum": [ "billing_address", "ip_address", "payment_method", "shipping_destination" ], "type": "string" }, "state": { "description": "The identified tax state, county, province, or region of the customer.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "country", "source" ], "title": "CustomerTaxLocation", "type": "object", "x-expandableFields": [] }, "deleted_account": { "description": "", "properties": { "deleted": { "description": "Always true for a deleted object", "enum": [ true ], "type": "boolean" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "account" ], "type": "string" } }, "required": [ "deleted", "id", "object" ], "title": "DeletedAccount", "type": "object", "x-expandableFields": [], "x-resourceId": "deleted_account" }, "deleted_apple_pay_domain": { "description": "", "properties": { "deleted": { "description": "Always true for a deleted object", "enum": [ true ], "type": "boolean" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "apple_pay_domain" ], "type": "string" } }, "required": [ "deleted", "id", "object" ], "title": "DeletedApplePayDomain", "type": "object", "x-expandableFields": [], "x-resourceId": "deleted_apple_pay_domain" }, "deleted_application": { "description": "", "properties": { "deleted": { "description": "Always true for a deleted object", "enum": [ true ], "type": "boolean" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "name": { "description": "The name of the application.", "maxLength": 5000, "nullable": true, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "application" ], "type": "string" } }, "required": [ "deleted", "id", "object" ], "title": "DeletedApplication", "type": "object", "x-expandableFields": [] }, "deleted_bank_account": { "description": "", "properties": { "currency": { "description": "Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account.", "maxLength": 5000, "nullable": true, "type": "string" }, "deleted": { "description": "Always true for a deleted object", "enum": [ true ], "type": "boolean" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "bank_account" ], "type": "string" } }, "required": [ "deleted", "id", "object" ], "title": "DeletedBankAccount", "type": "object", "x-expandableFields": [] }, "deleted_card": { "description": "", "properties": { "currency": { "description": "Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account.", "maxLength": 5000, "nullable": true, "type": "string" }, "deleted": { "description": "Always true for a deleted object", "enum": [ true ], "type": "boolean" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "card" ], "type": "string" } }, "required": [ "deleted", "id", "object" ], "title": "DeletedCard", "type": "object", "x-expandableFields": [] }, "deleted_coupon": { "description": "", "properties": { "deleted": { "description": "Always true for a deleted object", "enum": [ true ], "type": "boolean" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "coupon" ], "type": "string" } }, "required": [ "deleted", "id", "object" ], "title": "DeletedCoupon", "type": "object", "x-expandableFields": [], "x-resourceId": "deleted_coupon" }, "deleted_customer": { "description": "", "properties": { "deleted": { "description": "Always true for a deleted object", "enum": [ true ], "type": "boolean" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "customer" ], "type": "string" } }, "required": [ "deleted", "id", "object" ], "title": "DeletedCustomer", "type": "object", "x-expandableFields": [], "x-resourceId": "deleted_customer" }, "deleted_discount": { "description": "", "properties": { "checkout_session": { "description": "The Checkout session that this coupon is applied to, if it is applied to a particular session in payment mode. Will not be present for subscription mode.", "maxLength": 5000, "nullable": true, "type": "string" }, "coupon": { "$ref": "#/components/schemas/coupon" }, "customer": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/customer" }, { "$ref": "#/components/schemas/deleted_customer" } ], "description": "The ID of the customer associated with this discount.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/customer" }, { "$ref": "#/components/schemas/deleted_customer" } ] } }, "deleted": { "description": "Always true for a deleted object", "enum": [ true ], "type": "boolean" }, "id": { "description": "The ID of the discount object. Discounts cannot be fetched by ID. Use `expand[]=discounts` in API calls to expand discount IDs in an array.", "maxLength": 5000, "type": "string" }, "invoice": { "description": "The invoice that the discount's coupon was applied to, if it was applied directly to a particular invoice.", "maxLength": 5000, "nullable": true, "type": "string" }, "invoice_item": { "description": "The invoice item `id` (or invoice line item `id` for invoice line items of type='subscription') that the discount's coupon was applied to, if it was applied directly to a particular invoice item or invoice line item.", "maxLength": 5000, "nullable": true, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "discount" ], "type": "string" }, "promotion_code": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/promotion_code" } ], "description": "The promotion code applied to create this discount.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/promotion_code" } ] } }, "start": { "description": "Date that the coupon was applied.", "format": "unix-time", "type": "integer" }, "subscription": { "description": "The subscription that this coupon is applied to, if it is applied to a particular subscription.", "maxLength": 5000, "nullable": true, "type": "string" }, "subscription_item": { "description": "The subscription item that this coupon is applied to, if it is applied to a particular subscription item.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "coupon", "deleted", "id", "object", "start" ], "title": "DeletedDiscount", "type": "object", "x-expandableFields": [ "coupon", "customer", "promotion_code" ], "x-resourceId": "deleted_discount" }, "deleted_external_account": { "anyOf": [ { "$ref": "#/components/schemas/deleted_bank_account" }, { "$ref": "#/components/schemas/deleted_card" } ], "title": "Polymorphic", "x-resourceId": "deleted_external_account", "x-stripeBypassValidation": true }, "deleted_invoice": { "description": "", "properties": { "deleted": { "description": "Always true for a deleted object", "enum": [ true ], "type": "boolean" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "invoice" ], "type": "string" } }, "required": [ "deleted", "id", "object" ], "title": "DeletedInvoice", "type": "object", "x-expandableFields": [], "x-resourceId": "deleted_invoice" }, "deleted_invoiceitem": { "description": "", "properties": { "deleted": { "description": "Always true for a deleted object", "enum": [ true ], "type": "boolean" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "invoiceitem" ], "type": "string" } }, "required": [ "deleted", "id", "object" ], "title": "DeletedInvoiceItem", "type": "object", "x-expandableFields": [], "x-resourceId": "deleted_invoiceitem" }, "deleted_payment_source": { "anyOf": [ { "$ref": "#/components/schemas/deleted_bank_account" }, { "$ref": "#/components/schemas/deleted_card" } ], "title": "Polymorphic", "x-resourceId": "deleted_payment_source", "x-stripeBypassValidation": true }, "deleted_person": { "description": "", "properties": { "deleted": { "description": "Always true for a deleted object", "enum": [ true ], "type": "boolean" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "person" ], "type": "string" } }, "required": [ "deleted", "id", "object" ], "title": "DeletedPerson", "type": "object", "x-expandableFields": [], "x-resourceId": "deleted_person" }, "deleted_plan": { "description": "", "properties": { "deleted": { "description": "Always true for a deleted object", "enum": [ true ], "type": "boolean" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "plan" ], "type": "string" } }, "required": [ "deleted", "id", "object" ], "title": "DeletedPlan", "type": "object", "x-expandableFields": [], "x-resourceId": "deleted_plan" }, "deleted_price": { "description": "", "properties": { "deleted": { "description": "Always true for a deleted object", "enum": [ true ], "type": "boolean" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "price" ], "type": "string" } }, "required": [ "deleted", "id", "object" ], "title": "DeletedPrice", "type": "object", "x-expandableFields": [] }, "deleted_product": { "description": "", "properties": { "deleted": { "description": "Always true for a deleted object", "enum": [ true ], "type": "boolean" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "product" ], "type": "string" } }, "required": [ "deleted", "id", "object" ], "title": "DeletedProduct", "type": "object", "x-expandableFields": [], "x-resourceId": "deleted_product" }, "deleted_product_feature": { "description": "", "properties": { "deleted": { "description": "Always true for a deleted object", "enum": [ true ], "type": "boolean" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "product_feature" ], "type": "string" } }, "required": [ "deleted", "id", "object" ], "title": "DeletedProductFeature", "type": "object", "x-expandableFields": [], "x-resourceId": "deleted_product_feature" }, "deleted_radar.value_list": { "description": "", "properties": { "deleted": { "description": "Always true for a deleted object", "enum": [ true ], "type": "boolean" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "radar.value_list" ], "type": "string" } }, "required": [ "deleted", "id", "object" ], "title": "RadarListDeletedList", "type": "object", "x-expandableFields": [], "x-resourceId": "deleted_radar.value_list" }, "deleted_radar.value_list_item": { "description": "", "properties": { "deleted": { "description": "Always true for a deleted object", "enum": [ true ], "type": "boolean" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "radar.value_list_item" ], "type": "string" } }, "required": [ "deleted", "id", "object" ], "title": "RadarListDeletedListItem", "type": "object", "x-expandableFields": [], "x-resourceId": "deleted_radar.value_list_item" }, "deleted_subscription_item": { "description": "", "properties": { "deleted": { "description": "Always true for a deleted object", "enum": [ true ], "type": "boolean" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "subscription_item" ], "type": "string" } }, "required": [ "deleted", "id", "object" ], "title": "DeletedSubscriptionItem", "type": "object", "x-expandableFields": [], "x-resourceId": "deleted_subscription_item" }, "deleted_tax_id": { "description": "", "properties": { "deleted": { "description": "Always true for a deleted object", "enum": [ true ], "type": "boolean" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "tax_id" ], "type": "string" } }, "required": [ "deleted", "id", "object" ], "title": "deleted_tax_id", "type": "object", "x-expandableFields": [], "x-resourceId": "deleted_tax_id" }, "deleted_terminal.configuration": { "description": "", "properties": { "deleted": { "description": "Always true for a deleted object", "enum": [ true ], "type": "boolean" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "terminal.configuration" ], "type": "string" } }, "required": [ "deleted", "id", "object" ], "title": "TerminalConfigurationDeletedConfiguration", "type": "object", "x-expandableFields": [], "x-resourceId": "deleted_terminal.configuration" }, "deleted_terminal.location": { "description": "", "properties": { "deleted": { "description": "Always true for a deleted object", "enum": [ true ], "type": "boolean" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "terminal.location" ], "type": "string" } }, "required": [ "deleted", "id", "object" ], "title": "TerminalLocationDeletedLocation", "type": "object", "x-expandableFields": [], "x-resourceId": "deleted_terminal.location" }, "deleted_terminal.reader": { "description": "", "properties": { "deleted": { "description": "Always true for a deleted object", "enum": [ true ], "type": "boolean" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "terminal.reader" ], "type": "string" } }, "required": [ "deleted", "id", "object" ], "title": "TerminalReaderDeletedReader", "type": "object", "x-expandableFields": [], "x-resourceId": "deleted_terminal.reader" }, "deleted_test_helpers.test_clock": { "description": "", "properties": { "deleted": { "description": "Always true for a deleted object", "enum": [ true ], "type": "boolean" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "test_helpers.test_clock" ], "type": "string" } }, "required": [ "deleted", "id", "object" ], "title": "DeletedTestClock", "type": "object", "x-expandableFields": [], "x-resourceId": "deleted_test_helpers.test_clock" }, "deleted_webhook_endpoint": { "description": "", "properties": { "deleted": { "description": "Always true for a deleted object", "enum": [ true ], "type": "boolean" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "webhook_endpoint" ], "type": "string" } }, "required": [ "deleted", "id", "object" ], "title": "NotificationWebhookEndpointDeleted", "type": "object", "x-expandableFields": [], "x-resourceId": "deleted_webhook_endpoint" }, "destination_details_unimplemented": { "description": "", "properties": {}, "title": "destination_details_unimplemented", "type": "object", "x-expandableFields": [] }, "discount": { "description": "A discount represents the actual application of a [coupon](https://stripe.com/docs/api#coupons) or [promotion code](https://stripe.com/docs/api#promotion_codes).\nIt contains information about when the discount began, when it will end, and what it is applied to.\n\nRelated guide: [Applying discounts to subscriptions](https://stripe.com/docs/billing/subscriptions/discounts)", "properties": { "checkout_session": { "description": "The Checkout session that this coupon is applied to, if it is applied to a particular session in payment mode. Will not be present for subscription mode.", "maxLength": 5000, "nullable": true, "type": "string" }, "coupon": { "$ref": "#/components/schemas/coupon" }, "customer": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/customer" }, { "$ref": "#/components/schemas/deleted_customer" } ], "description": "The ID of the customer associated with this discount.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/customer" }, { "$ref": "#/components/schemas/deleted_customer" } ] } }, "end": { "description": "If the coupon has a duration of `repeating`, the date that this discount will end. If the coupon has a duration of `once` or `forever`, this attribute will be null.", "format": "unix-time", "nullable": true, "type": "integer" }, "id": { "description": "The ID of the discount object. Discounts cannot be fetched by ID. Use `expand[]=discounts` in API calls to expand discount IDs in an array.", "maxLength": 5000, "type": "string" }, "invoice": { "description": "The invoice that the discount's coupon was applied to, if it was applied directly to a particular invoice.", "maxLength": 5000, "nullable": true, "type": "string" }, "invoice_item": { "description": "The invoice item `id` (or invoice line item `id` for invoice line items of type='subscription') that the discount's coupon was applied to, if it was applied directly to a particular invoice item or invoice line item.", "maxLength": 5000, "nullable": true, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "discount" ], "type": "string" }, "promotion_code": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/promotion_code" } ], "description": "The promotion code applied to create this discount.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/promotion_code" } ] } }, "start": { "description": "Date that the coupon was applied.", "format": "unix-time", "type": "integer" }, "subscription": { "description": "The subscription that this coupon is applied to, if it is applied to a particular subscription.", "maxLength": 5000, "nullable": true, "type": "string" }, "subscription_item": { "description": "The subscription item that this coupon is applied to, if it is applied to a particular subscription item.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "coupon", "id", "object", "start" ], "title": "Discount", "type": "object", "x-expandableFields": [ "coupon", "customer", "promotion_code" ], "x-resourceId": "discount" }, "discounts_resource_discount_amount": { "description": "", "properties": { "amount": { "description": "The amount, in cents (or local equivalent), of the discount.", "type": "integer" }, "discount": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/discount" }, { "$ref": "#/components/schemas/deleted_discount" } ], "description": "The discount that was applied to get this discount amount.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/discount" }, { "$ref": "#/components/schemas/deleted_discount" } ] } } }, "required": [ "amount", "discount" ], "title": "DiscountsResourceDiscountAmount", "type": "object", "x-expandableFields": [ "discount" ] }, "discounts_resource_stackable_discount": { "description": "", "properties": { "coupon": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/coupon" } ], "description": "ID of the coupon to create a new discount for.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/coupon" } ] } }, "discount": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/discount" } ], "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/discount" } ] } }, "promotion_code": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/promotion_code" } ], "description": "ID of the promotion code to create a new discount for.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/promotion_code" } ] } } }, "title": "DiscountsResourceStackableDiscount", "type": "object", "x-expandableFields": [ "coupon", "discount", "promotion_code" ] }, "dispute": { "description": "A dispute occurs when a customer questions your charge with their card issuer.\nWhen this happens, you have the opportunity to respond to the dispute with\nevidence that shows that the charge is legitimate.\n\nRelated guide: [Disputes and fraud](https://stripe.com/docs/disputes)", "properties": { "amount": { "description": "Disputed amount. Usually the amount of the charge, but it can differ (usually because of currency fluctuation or because only part of the order is disputed).", "type": "integer" }, "balance_transactions": { "description": "List of zero, one, or two balance transactions that show funds withdrawn and reinstated to your Stripe account as a result of this dispute.", "items": { "$ref": "#/components/schemas/balance_transaction" }, "type": "array" }, "charge": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/charge" } ], "description": "ID of the charge that's disputed.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/charge" } ] } }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "enhanced_eligibility_types": { "description": "List of eligibility types that are included in `enhanced_evidence`.", "items": { "enum": [ "visa_compelling_evidence_3", "visa_compliance" ], "type": "string" }, "type": "array" }, "evidence": { "$ref": "#/components/schemas/dispute_evidence" }, "evidence_details": { "$ref": "#/components/schemas/dispute_evidence_details" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "is_charge_refundable": { "description": "If true, it's still possible to refund the disputed payment. After the payment has been fully refunded, no further funds are withdrawn from your Stripe account as a result of this dispute.", "type": "boolean" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "type": "object" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "dispute" ], "type": "string" }, "payment_intent": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/payment_intent" } ], "description": "ID of the PaymentIntent that's disputed.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/payment_intent" } ] } }, "payment_method_details": { "$ref": "#/components/schemas/dispute_payment_method_details" }, "reason": { "description": "Reason given by cardholder for dispute. Possible values are `bank_cannot_process`, `check_returned`, `credit_not_processed`, `customer_initiated`, `debit_not_authorized`, `duplicate`, `fraudulent`, `general`, `incorrect_account_details`, `insufficient_funds`, `noncompliant`, `product_not_received`, `product_unacceptable`, `subscription_canceled`, or `unrecognized`. Learn more about [dispute reasons](https://stripe.com/docs/disputes/categories).", "maxLength": 5000, "type": "string" }, "status": { "description": "The current status of a dispute. Possible values include:`warning_needs_response`, `warning_under_review`, `warning_closed`, `needs_response`, `under_review`, `won`, `lost`, or `prevented`.", "enum": [ "lost", "needs_response", "under_review", "warning_closed", "warning_needs_response", "warning_under_review", "won" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "amount", "balance_transactions", "charge", "created", "currency", "enhanced_eligibility_types", "evidence", "evidence_details", "id", "is_charge_refundable", "livemode", "metadata", "object", "reason", "status" ], "title": "Dispute", "type": "object", "x-expandableFields": [ "balance_transactions", "charge", "evidence", "evidence_details", "payment_intent", "payment_method_details" ], "x-resourceId": "dispute" }, "dispute_enhanced_eligibility": { "description": "", "properties": { "visa_compelling_evidence_3": { "$ref": "#/components/schemas/dispute_enhanced_eligibility_visa_compelling_evidence3" }, "visa_compliance": { "$ref": "#/components/schemas/dispute_enhanced_eligibility_visa_compliance" } }, "title": "DisputeEnhancedEligibility", "type": "object", "x-expandableFields": [ "visa_compelling_evidence_3", "visa_compliance" ] }, "dispute_enhanced_eligibility_visa_compelling_evidence3": { "description": "", "properties": { "required_actions": { "description": "List of actions required to qualify dispute for Visa Compelling Evidence 3.0 evidence submission.", "items": { "enum": [ "missing_customer_identifiers", "missing_disputed_transaction_description", "missing_merchandise_or_services", "missing_prior_undisputed_transaction_description", "missing_prior_undisputed_transactions" ], "type": "string" }, "type": "array" }, "status": { "description": "Visa Compelling Evidence 3.0 eligibility status.", "enum": [ "not_qualified", "qualified", "requires_action" ], "type": "string" } }, "required": [ "required_actions", "status" ], "title": "DisputeEnhancedEligibilityVisaCompellingEvidence3", "type": "object", "x-expandableFields": [] }, "dispute_enhanced_eligibility_visa_compliance": { "description": "", "properties": { "status": { "description": "Visa compliance eligibility status.", "enum": [ "fee_acknowledged", "requires_fee_acknowledgement" ], "type": "string" } }, "required": [ "status" ], "title": "DisputeEnhancedEligibilityVisaCompliance", "type": "object", "x-expandableFields": [] }, "dispute_enhanced_evidence": { "description": "", "properties": { "visa_compelling_evidence_3": { "$ref": "#/components/schemas/dispute_enhanced_evidence_visa_compelling_evidence3" }, "visa_compliance": { "$ref": "#/components/schemas/dispute_enhanced_evidence_visa_compliance" } }, "title": "DisputeEnhancedEvidence", "type": "object", "x-expandableFields": [ "visa_compelling_evidence_3", "visa_compliance" ] }, "dispute_enhanced_evidence_visa_compelling_evidence3": { "description": "", "properties": { "disputed_transaction": { "anyOf": [ { "$ref": "#/components/schemas/dispute_visa_compelling_evidence3_disputed_transaction" } ], "description": "Disputed transaction details for Visa Compelling Evidence 3.0 evidence submission.", "nullable": true }, "prior_undisputed_transactions": { "description": "List of exactly two prior undisputed transaction objects for Visa Compelling Evidence 3.0 evidence submission.", "items": { "$ref": "#/components/schemas/dispute_visa_compelling_evidence3_prior_undisputed_transaction" }, "type": "array" } }, "required": [ "prior_undisputed_transactions" ], "title": "DisputeEnhancedEvidenceVisaCompellingEvidence3", "type": "object", "x-expandableFields": [ "disputed_transaction", "prior_undisputed_transactions" ] }, "dispute_enhanced_evidence_visa_compliance": { "description": "", "properties": { "fee_acknowledged": { "description": "A field acknowledging the fee incurred when countering a Visa compliance dispute. If this field is set to true, evidence can be submitted for the compliance dispute. Stripe collects a 500 USD (or local equivalent) amount to cover the network costs associated with resolving compliance disputes. Stripe refunds the 500 USD network fee if you win the dispute.", "type": "boolean" } }, "required": [ "fee_acknowledged" ], "title": "DisputeEnhancedEvidenceVisaCompliance", "type": "object", "x-expandableFields": [] }, "dispute_evidence": { "description": "", "properties": { "access_activity_log": { "description": "Any server or activity logs showing proof that the customer accessed or downloaded the purchased digital product. This information should include IP addresses, corresponding timestamps, and any detailed recorded activity.", "maxLength": 150000, "nullable": true, "type": "string" }, "billing_address": { "description": "The billing address provided by the customer.", "maxLength": 5000, "nullable": true, "type": "string" }, "cancellation_policy": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/file" } ], "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Your subscription cancellation policy, as shown to the customer.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/file" } ] } }, "cancellation_policy_disclosure": { "description": "An explanation of how and when the customer was shown your refund policy prior to purchase.", "maxLength": 150000, "nullable": true, "type": "string" }, "cancellation_rebuttal": { "description": "A justification for why the customer's subscription was not canceled.", "maxLength": 150000, "nullable": true, "type": "string" }, "customer_communication": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/file" } ], "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any communication with the customer that you feel is relevant to your case. Examples include emails proving that the customer received the product or service, or demonstrating their use of or satisfaction with the product or service.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/file" } ] } }, "customer_email_address": { "description": "The email address of the customer.", "maxLength": 5000, "nullable": true, "type": "string" }, "customer_name": { "description": "The name of the customer.", "maxLength": 5000, "nullable": true, "type": "string" }, "customer_purchase_ip": { "description": "The IP address that the customer used when making the purchase.", "maxLength": 5000, "nullable": true, "type": "string" }, "customer_signature": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/file" } ], "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) A relevant document or contract showing the customer's signature.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/file" } ] } }, "duplicate_charge_documentation": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/file" } ], "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Documentation for the prior charge that can uniquely identify the charge, such as a receipt, shipping label, work order, etc. This document should be paired with a similar document from the disputed payment that proves the two payments are separate.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/file" } ] } }, "duplicate_charge_explanation": { "description": "An explanation of the difference between the disputed charge versus the prior charge that appears to be a duplicate.", "maxLength": 150000, "nullable": true, "type": "string" }, "duplicate_charge_id": { "description": "The Stripe ID for the prior charge which appears to be a duplicate of the disputed charge.", "maxLength": 5000, "nullable": true, "type": "string" }, "enhanced_evidence": { "$ref": "#/components/schemas/dispute_enhanced_evidence" }, "product_description": { "description": "A description of the product or service that was sold.", "maxLength": 150000, "nullable": true, "type": "string" }, "receipt": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/file" } ], "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any receipt or message sent to the customer notifying them of the charge.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/file" } ] } }, "refund_policy": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/file" } ], "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Your refund policy, as shown to the customer.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/file" } ] } }, "refund_policy_disclosure": { "description": "Documentation demonstrating that the customer was shown your refund policy prior to purchase.", "maxLength": 150000, "nullable": true, "type": "string" }, "refund_refusal_explanation": { "description": "A justification for why the customer is not entitled to a refund.", "maxLength": 150000, "nullable": true, "type": "string" }, "service_date": { "description": "The date on which the customer received or began receiving the purchased service, in a clear human-readable format.", "maxLength": 5000, "nullable": true, "type": "string" }, "service_documentation": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/file" } ], "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Documentation showing proof that a service was provided to the customer. This could include a copy of a signed contract, work order, or other form of written agreement.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/file" } ] } }, "shipping_address": { "description": "The address to which a physical product was shipped. You should try to include as complete address information as possible.", "maxLength": 5000, "nullable": true, "type": "string" }, "shipping_carrier": { "description": "The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc. If multiple carriers were used for this purchase, please separate them with commas.", "maxLength": 5000, "nullable": true, "type": "string" }, "shipping_date": { "description": "The date on which a physical product began its route to the shipping address, in a clear human-readable format.", "maxLength": 5000, "nullable": true, "type": "string" }, "shipping_documentation": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/file" } ], "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Documentation showing proof that a product was shipped to the customer at the same address the customer provided to you. This could include a copy of the shipment receipt, shipping label, etc. It should show the customer's full shipping address, if possible.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/file" } ] } }, "shipping_tracking_number": { "description": "The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.", "maxLength": 5000, "nullable": true, "type": "string" }, "uncategorized_file": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/file" } ], "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any additional evidence or statements.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/file" } ] } }, "uncategorized_text": { "description": "Any additional evidence or statements.", "maxLength": 150000, "nullable": true, "type": "string" } }, "required": [ "enhanced_evidence" ], "title": "DisputeEvidence", "type": "object", "x-expandableFields": [ "cancellation_policy", "customer_communication", "customer_signature", "duplicate_charge_documentation", "enhanced_evidence", "receipt", "refund_policy", "service_documentation", "shipping_documentation", "uncategorized_file" ] }, "dispute_evidence_details": { "description": "", "properties": { "due_by": { "description": "Date by which evidence must be submitted in order to successfully challenge dispute. Will be 0 if the customer's bank or credit card company doesn't allow a response for this particular dispute.", "format": "unix-time", "nullable": true, "type": "integer" }, "enhanced_eligibility": { "$ref": "#/components/schemas/dispute_enhanced_eligibility" }, "has_evidence": { "description": "Whether evidence has been staged for this dispute.", "type": "boolean" }, "past_due": { "description": "Whether the last evidence submission was submitted past the due date. Defaults to `false` if no evidence submissions have occurred. If `true`, then delivery of the latest evidence is *not* guaranteed.", "type": "boolean" }, "submission_count": { "description": "The number of times evidence has been submitted. Typically, you may only submit evidence once.", "type": "integer" } }, "required": [ "enhanced_eligibility", "has_evidence", "past_due", "submission_count" ], "title": "DisputeEvidenceDetails", "type": "object", "x-expandableFields": [ "enhanced_eligibility" ] }, "dispute_payment_method_details": { "description": "", "properties": { "amazon_pay": { "$ref": "#/components/schemas/dispute_payment_method_details_amazon_pay" }, "card": { "$ref": "#/components/schemas/dispute_payment_method_details_card" }, "klarna": { "$ref": "#/components/schemas/dispute_payment_method_details_klarna" }, "paypal": { "$ref": "#/components/schemas/dispute_payment_method_details_paypal" }, "type": { "description": "Payment method type.", "enum": [ "amazon_pay", "card", "klarna", "paypal" ], "type": "string" } }, "required": [ "type" ], "title": "DisputePaymentMethodDetails", "type": "object", "x-expandableFields": [ "amazon_pay", "card", "klarna", "paypal" ] }, "dispute_payment_method_details_amazon_pay": { "description": "", "properties": { "dispute_type": { "description": "The AmazonPay dispute type, chargeback or claim", "enum": [ "chargeback", "claim" ], "nullable": true, "type": "string" } }, "title": "DisputePaymentMethodDetailsAmazonPay", "type": "object", "x-expandableFields": [] }, "dispute_payment_method_details_card": { "description": "", "properties": { "brand": { "description": "Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`.", "maxLength": 5000, "type": "string" }, "case_type": { "description": "The type of dispute opened. Different case types may have varying fees and financial impact.", "enum": [ "block", "chargeback", "compliance", "inquiry", "resolution" ], "type": "string" }, "network_reason_code": { "description": "The card network's specific dispute reason code, which maps to one of Stripe's primary dispute categories to simplify response guidance. The [Network code map](https://stripe.com/docs/disputes/categories#network-code-map) lists all available dispute reason codes by network.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "brand", "case_type" ], "title": "DisputePaymentMethodDetailsCard", "type": "object", "x-expandableFields": [] }, "dispute_payment_method_details_klarna": { "description": "", "properties": { "reason_code": { "description": "The reason for the dispute as defined by Klarna", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "DisputePaymentMethodDetailsKlarna", "type": "object", "x-expandableFields": [] }, "dispute_payment_method_details_paypal": { "description": "", "properties": { "case_id": { "description": "The ID of the dispute in PayPal.", "maxLength": 5000, "nullable": true, "type": "string" }, "reason_code": { "description": "The reason for the dispute as defined by PayPal", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "DisputePaymentMethodDetailsPaypal", "type": "object", "x-expandableFields": [] }, "dispute_transaction_shipping_address": { "description": "", "properties": { "city": { "description": "City, district, suburb, town, or village.", "maxLength": 5000, "nullable": true, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "nullable": true, "type": "string" }, "line1": { "description": "Address line 1 (e.g., street, PO Box, or company name).", "maxLength": 5000, "nullable": true, "type": "string" }, "line2": { "description": "Address line 2 (e.g., apartment, suite, unit, or building).", "maxLength": 5000, "nullable": true, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "nullable": true, "type": "string" }, "state": { "description": "State, county, province, or region.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "DisputeTransactionShippingAddress", "type": "object", "x-expandableFields": [] }, "dispute_visa_compelling_evidence3_disputed_transaction": { "description": "", "properties": { "customer_account_id": { "description": "User Account ID used to log into business platform. Must be recognizable by the user.", "maxLength": 5000, "nullable": true, "type": "string" }, "customer_device_fingerprint": { "description": "Unique identifier of the cardholder’s device derived from a combination of at least two hardware and software attributes. Must be at least 20 characters.", "maxLength": 5000, "nullable": true, "type": "string" }, "customer_device_id": { "description": "Unique identifier of the cardholder’s device such as a device serial number (e.g., International Mobile Equipment Identity [IMEI]). Must be at least 15 characters.", "maxLength": 5000, "nullable": true, "type": "string" }, "customer_email_address": { "description": "The email address of the customer.", "maxLength": 5000, "nullable": true, "type": "string" }, "customer_purchase_ip": { "description": "The IP address that the customer used when making the purchase.", "maxLength": 5000, "nullable": true, "type": "string" }, "merchandise_or_services": { "description": "Categorization of disputed payment.", "enum": [ "merchandise", "services" ], "nullable": true, "type": "string" }, "product_description": { "description": "A description of the product or service that was sold.", "maxLength": 150000, "nullable": true, "type": "string" }, "shipping_address": { "anyOf": [ { "$ref": "#/components/schemas/dispute_transaction_shipping_address" } ], "description": "The address to which a physical product was shipped. All fields are required for Visa Compelling Evidence 3.0 evidence submission.", "nullable": true } }, "title": "DisputeVisaCompellingEvidence3DisputedTransaction", "type": "object", "x-expandableFields": [ "shipping_address" ] }, "dispute_visa_compelling_evidence3_prior_undisputed_transaction": { "description": "", "properties": { "charge": { "description": "Stripe charge ID for the Visa Compelling Evidence 3.0 eligible prior charge.", "maxLength": 5000, "type": "string" }, "customer_account_id": { "description": "User Account ID used to log into business platform. Must be recognizable by the user.", "maxLength": 5000, "nullable": true, "type": "string" }, "customer_device_fingerprint": { "description": "Unique identifier of the cardholder’s device derived from a combination of at least two hardware and software attributes. Must be at least 20 characters.", "maxLength": 5000, "nullable": true, "type": "string" }, "customer_device_id": { "description": "Unique identifier of the cardholder’s device such as a device serial number (e.g., International Mobile Equipment Identity [IMEI]). Must be at least 15 characters.", "maxLength": 5000, "nullable": true, "type": "string" }, "customer_email_address": { "description": "The email address of the customer.", "maxLength": 5000, "nullable": true, "type": "string" }, "customer_purchase_ip": { "description": "The IP address that the customer used when making the purchase.", "maxLength": 5000, "nullable": true, "type": "string" }, "product_description": { "description": "A description of the product or service that was sold.", "maxLength": 150000, "nullable": true, "type": "string" }, "shipping_address": { "anyOf": [ { "$ref": "#/components/schemas/dispute_transaction_shipping_address" } ], "description": "The address to which a physical product was shipped. All fields are required for Visa Compelling Evidence 3.0 evidence submission.", "nullable": true } }, "required": [ "charge" ], "title": "DisputeVisaCompellingEvidence3PriorUndisputedTransaction", "type": "object", "x-expandableFields": [ "shipping_address" ] }, "email_sent": { "description": "", "properties": { "email_sent_at": { "description": "The timestamp when the email was sent.", "format": "unix-time", "type": "integer" }, "email_sent_to": { "description": "The recipient's email address.", "maxLength": 5000, "type": "string" } }, "required": [ "email_sent_at", "email_sent_to" ], "title": "EmailSent", "type": "object", "x-expandableFields": [] }, "entitlements.active_entitlement": { "description": "An active entitlement describes access to a feature for a customer.", "properties": { "feature": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/entitlements.feature" } ], "description": "The [Feature](https://stripe.com/docs/api/entitlements/feature) that the customer is entitled to.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/entitlements.feature" } ] } }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "lookup_key": { "description": "A unique key you provide as your own system identifier. This may be up to 80 characters.", "maxLength": 5000, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "entitlements.active_entitlement" ], "type": "string" } }, "required": [ "feature", "id", "livemode", "lookup_key", "object" ], "title": "ActiveEntitlement", "type": "object", "x-expandableFields": [ "feature" ], "x-resourceId": "entitlements.active_entitlement" }, "entitlements.feature": { "description": "A feature represents a monetizable ability or functionality in your system.\nFeatures can be assigned to products, and when those products are purchased, Stripe will create an entitlement to the feature for the purchasing customer.", "properties": { "active": { "description": "Inactive features cannot be attached to new products and will not be returned from the features list endpoint.", "type": "boolean" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "lookup_key": { "description": "A unique key you provide as your own system identifier. This may be up to 80 characters.", "maxLength": 5000, "type": "string" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "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.", "type": "object" }, "name": { "description": "The feature's name, for your own purpose, not meant to be displayable to the customer.", "maxLength": 80, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "entitlements.feature" ], "type": "string" } }, "required": [ "active", "id", "livemode", "lookup_key", "metadata", "name", "object" ], "title": "Feature", "type": "object", "x-expandableFields": [], "x-resourceId": "entitlements.feature" }, "ephemeral_key": { "description": "", "properties": { "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "expires": { "description": "Time at which the key will expire. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "ephemeral_key" ], "type": "string" }, "secret": { "description": "The key's secret. You can use this value to make authorized requests to the Stripe API.", "maxLength": 5000, "type": "string" } }, "required": [ "created", "expires", "id", "livemode", "object" ], "title": "EphemeralKey", "type": "object", "x-expandableFields": [], "x-resourceId": "ephemeral_key" }, "error": { "description": "An error response from the Stripe API", "properties": { "error": { "$ref": "#/components/schemas/api_errors" } }, "required": [ "error" ], "type": "object" }, "event": { "description": "Snapshot events allow you to track and react to activity in your Stripe integration. When\nthe state of another API resource changes, Stripe creates an `Event` object that contains\nall the relevant information associated with that action, including the affected API\nresource. For example, a successful payment triggers a `charge.succeeded` event, which\ncontains the `Charge` in the event's data property. Some actions trigger multiple events.\nFor example, if you create a new subscription for a customer, it triggers both a\n`customer.subscription.created` event and a `charge.succeeded` event.\n\nConfigure an event destination in your account to listen for events that represent actions\nyour integration needs to respond to. Additionally, you can retrieve an individual event or\na list of events from the API.\n\n[Connect](https://docs.stripe.com/connect) platforms can also receive event notifications\nthat occur in their connected accounts. These events include an account attribute that\nidentifies the relevant connected account.\n\nYou can access events through the [Retrieve Event API](https://docs.stripe.com/api/events#retrieve_event)\nfor 30 days.", "properties": { "account": { "description": "The connected account that originates the event.", "maxLength": 5000, "type": "string" }, "api_version": { "description": "The Stripe API version used to render `data` when the event was created. The contents of `data` never change, so this value remains static regardless of the API version currently in use. This property is populated only for events created on or after October 31, 2014.", "maxLength": 5000, "nullable": true, "type": "string" }, "context": { "description": "Authentication context needed to fetch the event or related object.", "maxLength": 5000, "type": "string" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "data": { "$ref": "#/components/schemas/notification_event_data" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "event" ], "type": "string" }, "pending_webhooks": { "description": "Number of webhooks that haven't been successfully delivered (for example, to return a 20x response) to the URLs you specify.", "type": "integer" }, "request": { "anyOf": [ { "$ref": "#/components/schemas/notification_event_request" } ], "description": "Information on the API request that triggers the event.", "nullable": true }, "type": { "description": "Description of the event (for example, `invoice.created` or `charge.refunded`).", "maxLength": 5000, "type": "string" } }, "required": [ "created", "data", "id", "livemode", "object", "pending_webhooks", "type" ], "title": "NotificationEvent", "type": "object", "x-expandableFields": [ "data", "request" ], "x-resourceId": "event" }, "exchange_rate": { "description": "`ExchangeRate` objects allow you to determine the rates that Stripe is currently\nusing to convert from one currency to another. Since this number is variable\nthroughout the day, there are various reasons why you might want to know the current\nrate (for example, to dynamically price an item for a user with a default\npayment in a foreign currency).\n\nPlease refer to our [Exchange Rates API](https://stripe.com/docs/fx-rates) guide for more details.\n\n*[Note: this integration path is supported but no longer recommended]* Additionally,\nyou can guarantee that a charge is made with an exchange rate that you expect is\ncurrent. To do so, you must pass in the exchange_rate to charges endpoints. If the\nvalue is no longer up to date, the charge won't go through. Please refer to our\n[Using with charges](https://stripe.com/docs/exchange-rates) guide for more details.\n\n-----\n\n \n\n*This Exchange Rates API is a Beta Service and is subject to Stripe's terms of service. You may use the API solely for the purpose of transacting on Stripe. For example, the API may be queried in order to:*\n\n- *localize prices for processing payments on Stripe*\n- *reconcile Stripe transactions*\n- *determine how much money to send to a connected account*\n- *determine app fees to charge a connected account*\n\n*Using this Exchange Rates API beta for any purpose other than to transact on Stripe is strictly prohibited and constitutes a violation of Stripe's terms of service.*", "properties": { "id": { "description": "Unique identifier for the object. Represented as the three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) in lowercase.", "maxLength": 5000, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "exchange_rate" ], "type": "string" }, "rates": { "additionalProperties": { "type": "number" }, "description": "Hash where the keys are supported currencies and the values are the exchange rate at which the base id currency converts to the key currency.", "type": "object" } }, "required": [ "id", "object", "rates" ], "title": "ExchangeRate", "type": "object", "x-expandableFields": [], "x-resourceId": "exchange_rate" }, "external_account": { "anyOf": [ { "$ref": "#/components/schemas/bank_account" }, { "$ref": "#/components/schemas/card" } ], "title": "Polymorphic", "x-resourceId": "external_account", "x-stripeBypassValidation": true }, "external_account_requirements": { "description": "", "properties": { "currently_due": { "description": "Fields that need to be collected to keep the external account enabled. If not collected by `current_deadline`, these fields appear in `past_due` as well, and the account is disabled.", "items": { "maxLength": 5000, "type": "string" }, "nullable": true, "type": "array" }, "errors": { "description": "Fields that are `currently_due` and need to be collected again because validation or verification failed.", "items": { "$ref": "#/components/schemas/account_requirements_error" }, "nullable": true, "type": "array" }, "past_due": { "description": "Fields that weren't collected by `current_deadline`. These fields need to be collected to enable the external account.", "items": { "maxLength": 5000, "type": "string" }, "nullable": true, "type": "array" }, "pending_verification": { "description": "Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. Fields might appear in `eventually_due`, `currently_due`, or `past_due` and in `pending_verification` if verification fails but another verification is still pending.", "items": { "maxLength": 5000, "type": "string" }, "nullable": true, "type": "array" } }, "title": "ExternalAccountRequirements", "type": "object", "x-expandableFields": [ "errors" ] }, "fee": { "description": "", "properties": { "amount": { "description": "Amount of the fee, in cents.", "type": "integer" }, "application": { "description": "ID of the Connect application that earned the fee.", "maxLength": 5000, "nullable": true, "type": "string" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users.", "maxLength": 5000, "nullable": true, "type": "string" }, "type": { "description": "Type of the fee, one of: `application_fee`, `payment_method_passthrough_fee`, `stripe_fee` or `tax`.", "maxLength": 5000, "type": "string" } }, "required": [ "amount", "currency", "type" ], "title": "Fee", "type": "object", "x-expandableFields": [] }, "fee_refund": { "description": "`Application Fee Refund` objects allow you to refund an application fee that\nhas previously been created but not yet refunded. Funds will be refunded to\nthe Stripe account from which the fee was originally collected.\n\nRelated guide: [Refunding application fees](https://stripe.com/docs/connect/destination-charges#refunding-app-fee)", "properties": { "amount": { "description": "Amount, in cents (or local equivalent).", "type": "integer" }, "balance_transaction": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/balance_transaction" } ], "description": "Balance transaction that describes the impact on your account balance.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/balance_transaction" } ] } }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "fee": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/application_fee" } ], "description": "ID of the application fee that was refunded.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/application_fee" } ] } }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "nullable": true, "type": "object" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "fee_refund" ], "type": "string" } }, "required": [ "amount", "created", "currency", "fee", "id", "object" ], "title": "FeeRefund", "type": "object", "x-expandableFields": [ "balance_transaction", "fee" ], "x-resourceId": "fee_refund" }, "file": { "description": "This object represents files hosted on Stripe's servers. You can upload\nfiles with the [create file](https://stripe.com/docs/api#create_file) request\n(for example, when uploading dispute evidence). Stripe also\ncreates files independently (for example, the results of a [Sigma scheduled\nquery](#scheduled_queries)).\n\nRelated guide: [File upload guide](https://stripe.com/docs/file-upload)", "properties": { "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "expires_at": { "description": "The file expires and isn't available at this time in epoch seconds.", "format": "unix-time", "nullable": true, "type": "integer" }, "filename": { "description": "The suitable name for saving the file to a filesystem.", "maxLength": 5000, "nullable": true, "type": "string" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "links": { "description": "A list of [file links](https://stripe.com/docs/api#file_links) that point at this file.", "nullable": true, "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/file_link" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/file_links", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "FileResourceFileLinkList", "type": "object", "x-expandableFields": [ "data" ] }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "file" ], "type": "string" }, "purpose": { "description": "The [purpose](https://stripe.com/docs/file-upload#uploading-a-file) of the uploaded file.", "enum": [ "account_requirement", "additional_verification", "business_icon", "business_logo", "customer_signature", "dispute_evidence", "document_provider_identity_document", "finance_report_run", "financial_account_statement", "identity_document", "identity_document_downloadable", "issuing_regulatory_reporting", "pci_document", "selfie", "sigma_scheduled_query", "tax_document_user_upload", "terminal_android_apk", "terminal_reader_splashscreen" ], "type": "string", "x-stripeBypassValidation": true }, "size": { "description": "The size of the file object in bytes.", "type": "integer" }, "title": { "description": "A suitable title for the document.", "maxLength": 5000, "nullable": true, "type": "string" }, "type": { "description": "The returned file type (for example, `csv`, `pdf`, `jpg`, or `png`).", "maxLength": 5000, "nullable": true, "type": "string" }, "url": { "description": "Use your live secret API key to download the file from this URL.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "created", "id", "object", "purpose", "size" ], "title": "File", "type": "object", "x-expandableFields": [ "links" ], "x-resourceId": "file" }, "file_link": { "description": "To share the contents of a `File` object with non-Stripe users, you can\ncreate a `FileLink`. `FileLink`s contain a URL that you can use to\nretrieve the contents of the file without authentication.", "properties": { "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "expired": { "description": "Returns if the link is already expired.", "type": "boolean" }, "expires_at": { "description": "Time that the link expires.", "format": "unix-time", "nullable": true, "type": "integer" }, "file": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/file" } ], "description": "The file object this link points to.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/file" } ] } }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "type": "object" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "file_link" ], "type": "string" }, "url": { "description": "The publicly accessible URL to download the file.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "created", "expired", "file", "id", "livemode", "metadata", "object" ], "title": "FileLink", "type": "object", "x-expandableFields": [ "file" ], "x-resourceId": "file_link" }, "financial_connections.account": { "description": "A Financial Connections Account represents an account that exists outside of Stripe, to which you have been granted some degree of access.", "properties": { "account_holder": { "anyOf": [ { "$ref": "#/components/schemas/bank_connections_resource_accountholder" } ], "description": "The account holder that this account belongs to.", "nullable": true }, "balance": { "anyOf": [ { "$ref": "#/components/schemas/bank_connections_resource_balance" } ], "description": "The most recent information about the account's balance.", "nullable": true }, "balance_refresh": { "anyOf": [ { "$ref": "#/components/schemas/bank_connections_resource_balance_refresh" } ], "description": "The state of the most recent attempt to refresh the account balance.", "nullable": true }, "category": { "description": "The type of the account. Account category is further divided in `subcategory`.", "enum": [ "cash", "credit", "investment", "other" ], "type": "string" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "display_name": { "description": "A human-readable name that has been assigned to this account, either by the account holder or by the institution.", "maxLength": 5000, "nullable": true, "type": "string" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "institution_name": { "description": "The name of the institution that holds this account.", "maxLength": 5000, "type": "string" }, "last4": { "description": "The last 4 digits of the account number. If present, this will be 4 numeric characters.", "maxLength": 5000, "nullable": true, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "financial_connections.account" ], "type": "string" }, "ownership": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/financial_connections.account_ownership" } ], "description": "The most recent information about the account's owners.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/financial_connections.account_ownership" } ] } }, "ownership_refresh": { "anyOf": [ { "$ref": "#/components/schemas/bank_connections_resource_ownership_refresh" } ], "description": "The state of the most recent attempt to refresh the account owners.", "nullable": true }, "permissions": { "description": "The list of permissions granted by this account.", "items": { "enum": [ "balances", "ownership", "payment_method", "transactions" ], "type": "string" }, "nullable": true, "type": "array" }, "status": { "description": "The status of the link to the account.", "enum": [ "active", "disconnected", "inactive" ], "type": "string" }, "subcategory": { "description": "If `category` is `cash`, one of:\n\n - `checking`\n - `savings`\n - `other`\n\nIf `category` is `credit`, one of:\n\n - `mortgage`\n - `line_of_credit`\n - `credit_card`\n - `other`\n\nIf `category` is `investment` or `other`, this will be `other`.", "enum": [ "checking", "credit_card", "line_of_credit", "mortgage", "other", "savings" ], "type": "string" }, "subscriptions": { "description": "The list of data refresh subscriptions requested on this account.", "items": { "enum": [ "transactions" ], "type": "string", "x-stripeBypassValidation": true }, "nullable": true, "type": "array" }, "supported_payment_method_types": { "description": "The [PaymentMethod type](https://stripe.com/docs/api/payment_methods/object#payment_method_object-type)(s) that can be created from this account.", "items": { "enum": [ "link", "us_bank_account" ], "type": "string", "x-stripeBypassValidation": true }, "type": "array" }, "transaction_refresh": { "anyOf": [ { "$ref": "#/components/schemas/bank_connections_resource_transaction_refresh" } ], "description": "The state of the most recent attempt to refresh the account transactions.", "nullable": true } }, "required": [ "category", "created", "id", "institution_name", "livemode", "object", "status", "subcategory", "supported_payment_method_types" ], "title": "BankConnectionsResourceLinkedAccount", "type": "object", "x-expandableFields": [ "account_holder", "balance", "balance_refresh", "ownership", "ownership_refresh", "transaction_refresh" ], "x-resourceId": "financial_connections.account" }, "financial_connections.account_owner": { "description": "Describes an owner of an account.", "properties": { "email": { "description": "The email address of the owner.", "maxLength": 5000, "nullable": true, "type": "string" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "name": { "description": "The full name of the owner.", "maxLength": 5000, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "financial_connections.account_owner" ], "type": "string" }, "ownership": { "description": "The ownership object that this owner belongs to.", "maxLength": 5000, "type": "string" }, "phone": { "description": "The raw phone number of the owner.", "maxLength": 5000, "nullable": true, "type": "string" }, "raw_address": { "description": "The raw physical address of the owner.", "maxLength": 5000, "nullable": true, "type": "string" }, "refreshed_at": { "description": "The timestamp of the refresh that updated this owner.", "format": "unix-time", "nullable": true, "type": "integer" } }, "required": [ "id", "name", "object", "ownership" ], "title": "BankConnectionsResourceOwner", "type": "object", "x-expandableFields": [], "x-resourceId": "financial_connections.account_owner" }, "financial_connections.account_ownership": { "description": "Describes a snapshot of the owners of an account at a particular point in time.", "properties": { "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "financial_connections.account_ownership" ], "type": "string" }, "owners": { "description": "A paginated list of owners for this account.", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/financial_connections.account_owner" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "BankConnectionsResourceOwnerList", "type": "object", "x-expandableFields": [ "data" ] } }, "required": [ "created", "id", "object", "owners" ], "title": "BankConnectionsResourceOwnership", "type": "object", "x-expandableFields": [ "owners" ] }, "financial_connections.session": { "description": "A Financial Connections Session is the secure way to programmatically launch the client-side Stripe.js modal that lets your users link their accounts.", "properties": { "account_holder": { "anyOf": [ { "$ref": "#/components/schemas/bank_connections_resource_accountholder" } ], "description": "The account holder for whom accounts are collected in this session.", "nullable": true }, "accounts": { "description": "The accounts that were collected as part of this Session.", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/financial_connections.account" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/financial_connections/accounts", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "BankConnectionsResourceLinkedAccountList", "type": "object", "x-expandableFields": [ "data" ] }, "client_secret": { "description": "A value that will be passed to the client to launch the authentication flow.", "maxLength": 5000, "type": "string" }, "filters": { "$ref": "#/components/schemas/bank_connections_resource_link_account_session_filters" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "financial_connections.session" ], "type": "string" }, "permissions": { "description": "Permissions requested for accounts collected during this session.", "items": { "enum": [ "balances", "ownership", "payment_method", "transactions" ], "type": "string", "x-stripeBypassValidation": true }, "type": "array" }, "prefetch": { "description": "Data features requested to be retrieved upon account creation.", "items": { "enum": [ "balances", "ownership", "transactions" ], "type": "string", "x-stripeBypassValidation": true }, "nullable": true, "type": "array" }, "return_url": { "description": "For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.", "maxLength": 5000, "type": "string" } }, "required": [ "accounts", "client_secret", "id", "livemode", "object", "permissions" ], "title": "BankConnectionsResourceLinkAccountSession", "type": "object", "x-expandableFields": [ "account_holder", "accounts", "filters" ], "x-resourceId": "financial_connections.session" }, "financial_connections.transaction": { "description": "A Transaction represents a real transaction that affects a Financial Connections Account balance.", "properties": { "account": { "description": "The ID of the Financial Connections Account this transaction belongs to.", "maxLength": 5000, "type": "string" }, "amount": { "description": "The amount of this transaction, in cents (or local equivalent).", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "maxLength": 5000, "type": "string" }, "description": { "description": "The description of this transaction.", "maxLength": 5000, "type": "string" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "financial_connections.transaction" ], "type": "string" }, "status": { "description": "The status of the transaction.", "enum": [ "pending", "posted", "void" ], "type": "string" }, "status_transitions": { "$ref": "#/components/schemas/bank_connections_resource_transaction_resource_status_transitions" }, "transacted_at": { "description": "Time at which the transaction was transacted. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "transaction_refresh": { "description": "The token of the transaction refresh that last updated or created this transaction.", "maxLength": 5000, "type": "string" }, "updated": { "description": "Time at which the object was last updated. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" } }, "required": [ "account", "amount", "currency", "description", "id", "livemode", "object", "status", "status_transitions", "transacted_at", "transaction_refresh", "updated" ], "title": "BankConnectionsResourceTransaction", "type": "object", "x-expandableFields": [ "status_transitions" ], "x-resourceId": "financial_connections.transaction" }, "financial_reporting_finance_report_run_run_parameters": { "description": "", "properties": { "columns": { "description": "The set of output columns requested for inclusion in the report run.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "connected_account": { "description": "Connected account ID by which to filter the report run.", "maxLength": 5000, "type": "string" }, "currency": { "description": "Currency of objects to be included in the report run.", "format": "currency", "type": "string" }, "interval_end": { "description": "Ending timestamp of data to be included in the report run. Can be any UTC timestamp between 1 second after the user specified `interval_start` and 1 second before this report's last `data_available_end` value.", "format": "unix-time", "type": "integer" }, "interval_start": { "description": "Starting timestamp of data to be included in the report run. Can be any UTC timestamp between 1 second after this report's `data_available_start` and 1 second before the user specified `interval_end` value.", "format": "unix-time", "type": "integer" }, "payout": { "description": "Payout ID by which to filter the report run.", "maxLength": 5000, "type": "string" }, "reporting_category": { "description": "Category of balance transactions to be included in the report run.", "maxLength": 5000, "type": "string" }, "timezone": { "description": "Defaults to `Etc/UTC`. The output timezone for all timestamps in the report. A list of possible time zone values is maintained at the [IANA Time Zone Database](http://www.iana.org/time-zones). Has no effect on `interval_start` or `interval_end`.", "maxLength": 5000, "type": "string" } }, "title": "FinancialReportingFinanceReportRunRunParameters", "type": "object", "x-expandableFields": [] }, "forwarded_request_context": { "description": "Metadata about the forwarded request.", "properties": { "destination_duration": { "description": "The time it took in milliseconds for the destination endpoint to respond.", "type": "integer" }, "destination_ip_address": { "description": "The IP address of the destination.", "maxLength": 5000, "type": "string" } }, "required": [ "destination_duration", "destination_ip_address" ], "title": "ForwardedRequestContext", "type": "object", "x-expandableFields": [] }, "forwarded_request_details": { "description": "Details about the request forwarded to the destination endpoint.", "properties": { "body": { "description": "The body payload to send to the destination endpoint.", "maxLength": 5000, "type": "string" }, "headers": { "description": "The headers to include in the forwarded request. Can be omitted if no additional headers (excluding Stripe-generated ones such as the Content-Type header) should be included.", "items": { "$ref": "#/components/schemas/forwarded_request_header" }, "type": "array" }, "http_method": { "description": "The HTTP method used to call the destination endpoint.", "enum": [ "POST" ], "type": "string" } }, "required": [ "body", "headers", "http_method" ], "title": "ForwardedRequestDetails", "type": "object", "x-expandableFields": [ "headers" ] }, "forwarded_request_header": { "description": "Header data.", "properties": { "name": { "description": "The header name.", "maxLength": 5000, "type": "string" }, "value": { "description": "The header value.", "maxLength": 5000, "type": "string" } }, "required": [ "name", "value" ], "title": "ForwardedRequestHeader", "type": "object", "x-expandableFields": [] }, "forwarded_response_details": { "description": "Details about the response from the destination endpoint.", "properties": { "body": { "description": "The response body from the destination endpoint to Stripe.", "maxLength": 5000, "type": "string" }, "headers": { "description": "HTTP headers that the destination endpoint returned.", "items": { "$ref": "#/components/schemas/forwarded_request_header" }, "type": "array" }, "status": { "description": "The HTTP status code that the destination endpoint returned.", "type": "integer" } }, "required": [ "body", "headers", "status" ], "title": "ForwardedResponseDetails", "type": "object", "x-expandableFields": [ "headers" ] }, "forwarding.request": { "description": "Instructs Stripe to make a request on your behalf using the destination URL. The destination URL\nis activated by Stripe at the time of onboarding. Stripe verifies requests with your credentials\nprovided during onboarding, and injects card details from the payment_method into the request.\n\nStripe redacts all sensitive fields and headers, including authentication credentials and card numbers,\nbefore storing the request and response data in the forwarding Request object, which are subject to a\n30-day retention period.\n\nYou can provide a Stripe idempotency key to make sure that requests with the same key result in only one\noutbound request. The Stripe idempotency key provided should be unique and different from any idempotency\nkeys provided on the underlying third-party request.\n\nForwarding Requests are synchronous requests that return a response or time out according to\nStripe’s limits.\n\nRelated guide: [Forward card details to third-party API endpoints](https://docs.stripe.com/payments/forwarding).", "properties": { "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "nullable": true, "type": "object" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "forwarding.request" ], "type": "string" }, "payment_method": { "description": "The PaymentMethod to insert into the forwarded request. Forwarding previously consumed PaymentMethods is allowed.", "maxLength": 5000, "type": "string" }, "replacements": { "description": "The field kinds to be replaced in the forwarded request.", "items": { "enum": [ "card_cvc", "card_expiry", "card_number", "cardholder_name", "request_signature" ], "type": "string", "x-stripeBypassValidation": true }, "type": "array" }, "request_context": { "anyOf": [ { "$ref": "#/components/schemas/forwarded_request_context" } ], "description": "Context about the request from Stripe's servers to the destination endpoint.", "nullable": true }, "request_details": { "anyOf": [ { "$ref": "#/components/schemas/forwarded_request_details" } ], "description": "The request that was sent to the destination endpoint. We redact any sensitive fields.", "nullable": true }, "response_details": { "anyOf": [ { "$ref": "#/components/schemas/forwarded_response_details" } ], "description": "The response that the destination endpoint returned to us. We redact any sensitive fields.", "nullable": true }, "url": { "description": "The destination URL for the forwarded request. Must be supported by the config.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "created", "id", "livemode", "object", "payment_method", "replacements" ], "title": "ForwardingRequest", "type": "object", "x-expandableFields": [ "request_context", "request_details", "response_details" ], "x-resourceId": "forwarding.request" }, "funding_instructions": { "description": "Each customer has a [`balance`](https://stripe.com/docs/api/customers/object#customer_object-balance) that is\nautomatically applied to future invoices and payments using the `customer_balance` payment method.\nCustomers can fund this balance by initiating a bank transfer to any account in the\n`financial_addresses` field.\nRelated guide: [Customer balance funding instructions](https://stripe.com/docs/payments/customer-balance/funding-instructions)", "properties": { "bank_transfer": { "$ref": "#/components/schemas/funding_instructions_bank_transfer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "maxLength": 5000, "type": "string" }, "funding_type": { "description": "The `funding_type` of the returned instructions", "enum": [ "bank_transfer" ], "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "funding_instructions" ], "type": "string" } }, "required": [ "bank_transfer", "currency", "funding_type", "livemode", "object" ], "title": "CustomerBalanceFundingInstructionsCustomerBalanceFundingInstructions", "type": "object", "x-expandableFields": [ "bank_transfer" ], "x-resourceId": "funding_instructions" }, "funding_instructions_bank_transfer": { "description": "", "properties": { "country": { "description": "The country of the bank account to fund", "maxLength": 5000, "type": "string" }, "financial_addresses": { "description": "A list of financial addresses that can be used to fund a particular balance", "items": { "$ref": "#/components/schemas/funding_instructions_bank_transfer_financial_address" }, "type": "array" }, "type": { "description": "The bank_transfer type", "enum": [ "eu_bank_transfer", "jp_bank_transfer" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "country", "financial_addresses", "type" ], "title": "FundingInstructionsBankTransfer", "type": "object", "x-expandableFields": [ "financial_addresses" ] }, "funding_instructions_bank_transfer_aba_record": { "description": "ABA Records contain U.S. bank account details per the ABA format.", "properties": { "account_holder_address": { "$ref": "#/components/schemas/address" }, "account_holder_name": { "description": "The account holder name", "maxLength": 5000, "type": "string" }, "account_number": { "description": "The ABA account number", "maxLength": 5000, "type": "string" }, "account_type": { "description": "The account type", "maxLength": 5000, "type": "string" }, "bank_address": { "$ref": "#/components/schemas/address" }, "bank_name": { "description": "The bank name", "maxLength": 5000, "type": "string" }, "routing_number": { "description": "The ABA routing number", "maxLength": 5000, "type": "string" } }, "required": [ "account_holder_address", "account_holder_name", "account_number", "account_type", "bank_address", "bank_name", "routing_number" ], "title": "FundingInstructionsBankTransferABARecord", "type": "object", "x-expandableFields": [ "account_holder_address", "bank_address" ] }, "funding_instructions_bank_transfer_financial_address": { "description": "FinancialAddresses contain identifying information that resolves to a FinancialAccount.", "properties": { "aba": { "$ref": "#/components/schemas/funding_instructions_bank_transfer_aba_record" }, "iban": { "$ref": "#/components/schemas/funding_instructions_bank_transfer_iban_record" }, "sort_code": { "$ref": "#/components/schemas/funding_instructions_bank_transfer_sort_code_record" }, "spei": { "$ref": "#/components/schemas/funding_instructions_bank_transfer_spei_record" }, "supported_networks": { "description": "The payment networks supported by this FinancialAddress", "items": { "enum": [ "ach", "bacs", "domestic_wire_us", "fps", "sepa", "spei", "swift", "zengin" ], "type": "string", "x-stripeBypassValidation": true }, "type": "array" }, "swift": { "$ref": "#/components/schemas/funding_instructions_bank_transfer_swift_record" }, "type": { "description": "The type of financial address", "enum": [ "aba", "iban", "sort_code", "spei", "swift", "zengin" ], "type": "string", "x-stripeBypassValidation": true }, "zengin": { "$ref": "#/components/schemas/funding_instructions_bank_transfer_zengin_record" } }, "required": [ "type" ], "title": "FundingInstructionsBankTransferFinancialAddress", "type": "object", "x-expandableFields": [ "aba", "iban", "sort_code", "spei", "swift", "zengin" ] }, "funding_instructions_bank_transfer_iban_record": { "description": "Iban Records contain E.U. bank account details per the SEPA format.", "properties": { "account_holder_address": { "$ref": "#/components/schemas/address" }, "account_holder_name": { "description": "The name of the person or business that owns the bank account", "maxLength": 5000, "type": "string" }, "bank_address": { "$ref": "#/components/schemas/address" }, "bic": { "description": "The BIC/SWIFT code of the account.", "maxLength": 5000, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "iban": { "description": "The IBAN of the account.", "maxLength": 5000, "type": "string" } }, "required": [ "account_holder_address", "account_holder_name", "bank_address", "bic", "country", "iban" ], "title": "FundingInstructionsBankTransferIbanRecord", "type": "object", "x-expandableFields": [ "account_holder_address", "bank_address" ] }, "funding_instructions_bank_transfer_sort_code_record": { "description": "Sort Code Records contain U.K. bank account details per the sort code format.", "properties": { "account_holder_address": { "$ref": "#/components/schemas/address" }, "account_holder_name": { "description": "The name of the person or business that owns the bank account", "maxLength": 5000, "type": "string" }, "account_number": { "description": "The account number", "maxLength": 5000, "type": "string" }, "bank_address": { "$ref": "#/components/schemas/address" }, "sort_code": { "description": "The six-digit sort code", "maxLength": 5000, "type": "string" } }, "required": [ "account_holder_address", "account_holder_name", "account_number", "bank_address", "sort_code" ], "title": "FundingInstructionsBankTransferSortCodeRecord", "type": "object", "x-expandableFields": [ "account_holder_address", "bank_address" ] }, "funding_instructions_bank_transfer_spei_record": { "description": "SPEI Records contain Mexico bank account details per the SPEI format.", "properties": { "account_holder_address": { "$ref": "#/components/schemas/address" }, "account_holder_name": { "description": "The account holder name", "maxLength": 5000, "type": "string" }, "bank_address": { "$ref": "#/components/schemas/address" }, "bank_code": { "description": "The three-digit bank code", "maxLength": 5000, "type": "string" }, "bank_name": { "description": "The short banking institution name", "maxLength": 5000, "type": "string" }, "clabe": { "description": "The CLABE number", "maxLength": 5000, "type": "string" } }, "required": [ "account_holder_address", "account_holder_name", "bank_address", "bank_code", "bank_name", "clabe" ], "title": "FundingInstructionsBankTransferSpeiRecord", "type": "object", "x-expandableFields": [ "account_holder_address", "bank_address" ] }, "funding_instructions_bank_transfer_swift_record": { "description": "SWIFT Records contain U.S. bank account details per the SWIFT format.", "properties": { "account_holder_address": { "$ref": "#/components/schemas/address" }, "account_holder_name": { "description": "The account holder name", "maxLength": 5000, "type": "string" }, "account_number": { "description": "The account number", "maxLength": 5000, "type": "string" }, "account_type": { "description": "The account type", "maxLength": 5000, "type": "string" }, "bank_address": { "$ref": "#/components/schemas/address" }, "bank_name": { "description": "The bank name", "maxLength": 5000, "type": "string" }, "swift_code": { "description": "The SWIFT code", "maxLength": 5000, "type": "string" } }, "required": [ "account_holder_address", "account_holder_name", "account_number", "account_type", "bank_address", "bank_name", "swift_code" ], "title": "FundingInstructionsBankTransferSwiftRecord", "type": "object", "x-expandableFields": [ "account_holder_address", "bank_address" ] }, "funding_instructions_bank_transfer_zengin_record": { "description": "Zengin Records contain Japan bank account details per the Zengin format.", "properties": { "account_holder_address": { "$ref": "#/components/schemas/address" }, "account_holder_name": { "description": "The account holder name", "maxLength": 5000, "nullable": true, "type": "string" }, "account_number": { "description": "The account number", "maxLength": 5000, "nullable": true, "type": "string" }, "account_type": { "description": "The bank account type. In Japan, this can only be `futsu` or `toza`.", "maxLength": 5000, "nullable": true, "type": "string" }, "bank_address": { "$ref": "#/components/schemas/address" }, "bank_code": { "description": "The bank code of the account", "maxLength": 5000, "nullable": true, "type": "string" }, "bank_name": { "description": "The bank name of the account", "maxLength": 5000, "nullable": true, "type": "string" }, "branch_code": { "description": "The branch code of the account", "maxLength": 5000, "nullable": true, "type": "string" }, "branch_name": { "description": "The branch name of the account", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "account_holder_address", "bank_address" ], "title": "FundingInstructionsBankTransferZenginRecord", "type": "object", "x-expandableFields": [ "account_holder_address", "bank_address" ] }, "gelato_data_document_report_date_of_birth": { "description": "Point in Time", "properties": { "day": { "description": "Numerical day between 1 and 31.", "nullable": true, "type": "integer" }, "month": { "description": "Numerical month between 1 and 12.", "nullable": true, "type": "integer" }, "year": { "description": "The four-digit year.", "nullable": true, "type": "integer" } }, "title": "GelatoDataDocumentReportDateOfBirth", "type": "object", "x-expandableFields": [] }, "gelato_data_document_report_expiration_date": { "description": "Point in Time", "properties": { "day": { "description": "Numerical day between 1 and 31.", "nullable": true, "type": "integer" }, "month": { "description": "Numerical month between 1 and 12.", "nullable": true, "type": "integer" }, "year": { "description": "The four-digit year.", "nullable": true, "type": "integer" } }, "title": "GelatoDataDocumentReportExpirationDate", "type": "object", "x-expandableFields": [] }, "gelato_data_document_report_issued_date": { "description": "Point in Time", "properties": { "day": { "description": "Numerical day between 1 and 31.", "nullable": true, "type": "integer" }, "month": { "description": "Numerical month between 1 and 12.", "nullable": true, "type": "integer" }, "year": { "description": "The four-digit year.", "nullable": true, "type": "integer" } }, "title": "GelatoDataDocumentReportIssuedDate", "type": "object", "x-expandableFields": [] }, "gelato_data_id_number_report_date": { "description": "Point in Time", "properties": { "day": { "description": "Numerical day between 1 and 31.", "nullable": true, "type": "integer" }, "month": { "description": "Numerical month between 1 and 12.", "nullable": true, "type": "integer" }, "year": { "description": "The four-digit year.", "nullable": true, "type": "integer" } }, "title": "GelatoDataIdNumberReportDate", "type": "object", "x-expandableFields": [] }, "gelato_data_verified_outputs_date": { "description": "Point in Time", "properties": { "day": { "description": "Numerical day between 1 and 31.", "nullable": true, "type": "integer" }, "month": { "description": "Numerical month between 1 and 12.", "nullable": true, "type": "integer" }, "year": { "description": "The four-digit year.", "nullable": true, "type": "integer" } }, "title": "GelatoDataVerifiedOutputsDate", "type": "object", "x-expandableFields": [] }, "gelato_document_report": { "description": "Result from a document check", "properties": { "address": { "anyOf": [ { "$ref": "#/components/schemas/address" } ], "description": "Address as it appears in the document.", "nullable": true }, "dob": { "anyOf": [ { "$ref": "#/components/schemas/gelato_data_document_report_date_of_birth" } ], "description": "Date of birth as it appears in the document.", "nullable": true }, "error": { "anyOf": [ { "$ref": "#/components/schemas/gelato_document_report_error" } ], "description": "Details on the verification error. Present when status is `unverified`.", "nullable": true }, "expiration_date": { "anyOf": [ { "$ref": "#/components/schemas/gelato_data_document_report_expiration_date" } ], "description": "Expiration date of the document.", "nullable": true }, "files": { "description": "Array of [File](https://stripe.com/docs/api/files) ids containing images for this document.", "items": { "maxLength": 5000, "type": "string" }, "nullable": true, "type": "array" }, "first_name": { "description": "First name as it appears in the document.", "maxLength": 5000, "nullable": true, "type": "string" }, "issued_date": { "anyOf": [ { "$ref": "#/components/schemas/gelato_data_document_report_issued_date" } ], "description": "Issued date of the document.", "nullable": true }, "issuing_country": { "description": "Issuing country of the document.", "maxLength": 5000, "nullable": true, "type": "string" }, "last_name": { "description": "Last name as it appears in the document.", "maxLength": 5000, "nullable": true, "type": "string" }, "number": { "description": "Document ID number.", "maxLength": 5000, "nullable": true, "type": "string" }, "sex": { "description": "Sex of the person in the document.", "enum": [ "[redacted]", "female", "male", "unknown" ], "nullable": true, "type": "string" }, "status": { "description": "Status of this `document` check.", "enum": [ "unverified", "verified" ], "type": "string", "x-stripeBypassValidation": true }, "type": { "description": "Type of the document.", "enum": [ "driving_license", "id_card", "passport" ], "nullable": true, "type": "string" }, "unparsed_place_of_birth": { "description": "Place of birth as it appears in the document.", "maxLength": 5000, "nullable": true, "type": "string" }, "unparsed_sex": { "description": "Sex as it appears in the document.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "status" ], "title": "GelatoDocumentReport", "type": "object", "x-expandableFields": [ "address", "dob", "error", "expiration_date", "issued_date" ] }, "gelato_document_report_error": { "description": "", "properties": { "code": { "description": "A short machine-readable string giving the reason for the verification failure.", "enum": [ "document_expired", "document_type_not_supported", "document_unverified_other" ], "nullable": true, "type": "string", "x-stripeBypassValidation": true }, "reason": { "description": "A human-readable message giving the reason for the failure. These messages can be shown to your users.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "GelatoDocumentReportError", "type": "object", "x-expandableFields": [] }, "gelato_email_report": { "description": "Result from a email check", "properties": { "email": { "description": "Email to be verified.", "maxLength": 5000, "nullable": true, "type": "string" }, "error": { "anyOf": [ { "$ref": "#/components/schemas/gelato_email_report_error" } ], "description": "Details on the verification error. Present when status is `unverified`.", "nullable": true }, "status": { "description": "Status of this `email` check.", "enum": [ "unverified", "verified" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "status" ], "title": "GelatoEmailReport", "type": "object", "x-expandableFields": [ "error" ] }, "gelato_email_report_error": { "description": "", "properties": { "code": { "description": "A short machine-readable string giving the reason for the verification failure.", "enum": [ "email_unverified_other", "email_verification_declined" ], "nullable": true, "type": "string" }, "reason": { "description": "A human-readable message giving the reason for the failure. These messages can be shown to your users.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "GelatoEmailReportError", "type": "object", "x-expandableFields": [] }, "gelato_id_number_report": { "description": "Result from an id_number check", "properties": { "dob": { "anyOf": [ { "$ref": "#/components/schemas/gelato_data_id_number_report_date" } ], "description": "Date of birth.", "nullable": true }, "error": { "anyOf": [ { "$ref": "#/components/schemas/gelato_id_number_report_error" } ], "description": "Details on the verification error. Present when status is `unverified`.", "nullable": true }, "first_name": { "description": "First name.", "maxLength": 5000, "nullable": true, "type": "string" }, "id_number": { "description": "ID number. When `id_number_type` is `us_ssn`, only the last 4 digits are present.", "maxLength": 5000, "nullable": true, "type": "string" }, "id_number_type": { "description": "Type of ID number.", "enum": [ "br_cpf", "sg_nric", "us_ssn" ], "nullable": true, "type": "string" }, "last_name": { "description": "Last name.", "maxLength": 5000, "nullable": true, "type": "string" }, "status": { "description": "Status of this `id_number` check.", "enum": [ "unverified", "verified" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "status" ], "title": "GelatoIdNumberReport", "type": "object", "x-expandableFields": [ "dob", "error" ] }, "gelato_id_number_report_error": { "description": "", "properties": { "code": { "description": "A short machine-readable string giving the reason for the verification failure.", "enum": [ "id_number_insufficient_document_data", "id_number_mismatch", "id_number_unverified_other" ], "nullable": true, "type": "string" }, "reason": { "description": "A human-readable message giving the reason for the failure. These messages can be shown to your users.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "GelatoIdNumberReportError", "type": "object", "x-expandableFields": [] }, "gelato_phone_report": { "description": "Result from a phone check", "properties": { "error": { "anyOf": [ { "$ref": "#/components/schemas/gelato_phone_report_error" } ], "description": "Details on the verification error. Present when status is `unverified`.", "nullable": true }, "phone": { "description": "Phone to be verified.", "maxLength": 5000, "nullable": true, "type": "string" }, "status": { "description": "Status of this `phone` check.", "enum": [ "unverified", "verified" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "status" ], "title": "GelatoPhoneReport", "type": "object", "x-expandableFields": [ "error" ] }, "gelato_phone_report_error": { "description": "", "properties": { "code": { "description": "A short machine-readable string giving the reason for the verification failure.", "enum": [ "phone_unverified_other", "phone_verification_declined" ], "nullable": true, "type": "string" }, "reason": { "description": "A human-readable message giving the reason for the failure. These messages can be shown to your users.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "GelatoPhoneReportError", "type": "object", "x-expandableFields": [] }, "gelato_provided_details": { "description": "", "properties": { "email": { "description": "Email of user being verified", "maxLength": 5000, "type": "string" }, "phone": { "description": "Phone number of user being verified", "maxLength": 5000, "type": "string" } }, "title": "GelatoProvidedDetails", "type": "object", "x-expandableFields": [] }, "gelato_related_person": { "description": "", "properties": { "account": { "description": "Token referencing the associated Account of the related Person resource.", "maxLength": 5000, "type": "string" }, "person": { "description": "Token referencing the related Person resource.", "maxLength": 5000, "type": "string" } }, "required": [ "account", "person" ], "title": "GelatoRelatedPerson", "type": "object", "x-expandableFields": [] }, "gelato_report_document_options": { "description": "", "properties": { "allowed_types": { "description": "Array of strings of allowed identity document types. If the provided identity document isn’t one of the allowed types, the verification check will fail with a document_type_not_allowed error code.", "items": { "enum": [ "driving_license", "id_card", "passport" ], "type": "string" }, "type": "array" }, "require_id_number": { "description": "Collect an ID number and perform an [ID number check](https://stripe.com/docs/identity/verification-checks?type=id-number) with the document’s extracted name and date of birth.", "type": "boolean" }, "require_live_capture": { "description": "Disable image uploads, identity document images have to be captured using the device’s camera.", "type": "boolean" }, "require_matching_selfie": { "description": "Capture a face image and perform a [selfie check](https://stripe.com/docs/identity/verification-checks?type=selfie) comparing a photo ID and a picture of your user’s face. [Learn more](https://stripe.com/docs/identity/selfie).", "type": "boolean" } }, "title": "GelatoReportDocumentOptions", "type": "object", "x-expandableFields": [] }, "gelato_report_id_number_options": { "description": "", "properties": {}, "title": "GelatoReportIdNumberOptions", "type": "object", "x-expandableFields": [] }, "gelato_selfie_report": { "description": "Result from a selfie check", "properties": { "document": { "description": "ID of the [File](https://stripe.com/docs/api/files) holding the image of the identity document used in this check.", "maxLength": 5000, "nullable": true, "type": "string" }, "error": { "anyOf": [ { "$ref": "#/components/schemas/gelato_selfie_report_error" } ], "description": "Details on the verification error. Present when status is `unverified`.", "nullable": true }, "selfie": { "description": "ID of the [File](https://stripe.com/docs/api/files) holding the image of the selfie used in this check.", "maxLength": 5000, "nullable": true, "type": "string" }, "status": { "description": "Status of this `selfie` check.", "enum": [ "unverified", "verified" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "status" ], "title": "GelatoSelfieReport", "type": "object", "x-expandableFields": [ "error" ] }, "gelato_selfie_report_error": { "description": "", "properties": { "code": { "description": "A short machine-readable string giving the reason for the verification failure.", "enum": [ "selfie_document_missing_photo", "selfie_face_mismatch", "selfie_manipulated", "selfie_unverified_other" ], "nullable": true, "type": "string" }, "reason": { "description": "A human-readable message giving the reason for the failure. These messages can be shown to your users.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "GelatoSelfieReportError", "type": "object", "x-expandableFields": [] }, "gelato_session_document_options": { "description": "", "properties": { "allowed_types": { "description": "Array of strings of allowed identity document types. If the provided identity document isn’t one of the allowed types, the verification check will fail with a document_type_not_allowed error code.", "items": { "enum": [ "driving_license", "id_card", "passport" ], "type": "string" }, "type": "array" }, "require_id_number": { "description": "Collect an ID number and perform an [ID number check](https://stripe.com/docs/identity/verification-checks?type=id-number) with the document’s extracted name and date of birth.", "type": "boolean" }, "require_live_capture": { "description": "Disable image uploads, identity document images have to be captured using the device’s camera.", "type": "boolean" }, "require_matching_selfie": { "description": "Capture a face image and perform a [selfie check](https://stripe.com/docs/identity/verification-checks?type=selfie) comparing a photo ID and a picture of your user’s face. [Learn more](https://stripe.com/docs/identity/selfie).", "type": "boolean" } }, "title": "GelatoSessionDocumentOptions", "type": "object", "x-expandableFields": [] }, "gelato_session_email_options": { "description": "", "properties": { "require_verification": { "description": "Request one time password verification of `provided_details.email`.", "type": "boolean" } }, "title": "GelatoSessionEmailOptions", "type": "object", "x-expandableFields": [] }, "gelato_session_id_number_options": { "description": "", "properties": {}, "title": "GelatoSessionIdNumberOptions", "type": "object", "x-expandableFields": [] }, "gelato_session_last_error": { "description": "Shows last VerificationSession error", "properties": { "code": { "description": "A short machine-readable string giving the reason for the verification or user-session failure.", "enum": [ "abandoned", "consent_declined", "country_not_supported", "device_not_supported", "document_expired", "document_type_not_supported", "document_unverified_other", "email_unverified_other", "email_verification_declined", "id_number_insufficient_document_data", "id_number_mismatch", "id_number_unverified_other", "phone_unverified_other", "phone_verification_declined", "selfie_document_missing_photo", "selfie_face_mismatch", "selfie_manipulated", "selfie_unverified_other", "under_supported_age" ], "nullable": true, "type": "string", "x-stripeBypassValidation": true }, "reason": { "description": "A message that explains the reason for verification or user-session failure.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "GelatoSessionLastError", "type": "object", "x-expandableFields": [] }, "gelato_session_matching_options": { "description": "", "properties": { "dob": { "description": "Strictness of the DOB matching policy to apply.", "enum": [ "none", "similar" ], "type": "string" }, "name": { "description": "Strictness of the name matching policy to apply.", "enum": [ "none", "similar" ], "type": "string" } }, "title": "GelatoSessionMatchingOptions", "type": "object", "x-expandableFields": [] }, "gelato_session_phone_options": { "description": "", "properties": { "require_verification": { "description": "Request one time password verification of `provided_details.phone`.", "type": "boolean" } }, "title": "GelatoSessionPhoneOptions", "type": "object", "x-expandableFields": [] }, "gelato_verification_report_options": { "description": "", "properties": { "document": { "$ref": "#/components/schemas/gelato_report_document_options" }, "id_number": { "$ref": "#/components/schemas/gelato_report_id_number_options" } }, "title": "GelatoVerificationReportOptions", "type": "object", "x-expandableFields": [ "document", "id_number" ] }, "gelato_verification_session_options": { "description": "", "properties": { "document": { "$ref": "#/components/schemas/gelato_session_document_options" }, "email": { "$ref": "#/components/schemas/gelato_session_email_options" }, "id_number": { "$ref": "#/components/schemas/gelato_session_id_number_options" }, "matching": { "$ref": "#/components/schemas/gelato_session_matching_options" }, "phone": { "$ref": "#/components/schemas/gelato_session_phone_options" } }, "title": "GelatoVerificationSessionOptions", "type": "object", "x-expandableFields": [ "document", "email", "id_number", "matching", "phone" ] }, "gelato_verified_outputs": { "description": "", "properties": { "address": { "anyOf": [ { "$ref": "#/components/schemas/address" } ], "description": "The user's verified address.", "nullable": true }, "dob": { "anyOf": [ { "$ref": "#/components/schemas/gelato_data_verified_outputs_date" } ], "description": "The user’s verified date of birth.", "nullable": true }, "email": { "description": "The user's verified email address", "maxLength": 5000, "nullable": true, "type": "string" }, "first_name": { "description": "The user's verified first name.", "maxLength": 5000, "nullable": true, "type": "string" }, "id_number": { "description": "The user's verified id number.", "maxLength": 5000, "nullable": true, "type": "string" }, "id_number_type": { "description": "The user's verified id number type.", "enum": [ "br_cpf", "sg_nric", "us_ssn" ], "nullable": true, "type": "string" }, "last_name": { "description": "The user's verified last name.", "maxLength": 5000, "nullable": true, "type": "string" }, "phone": { "description": "The user's verified phone number", "maxLength": 5000, "nullable": true, "type": "string" }, "sex": { "description": "The user's verified sex.", "enum": [ "[redacted]", "female", "male", "unknown" ], "nullable": true, "type": "string" }, "unparsed_place_of_birth": { "description": "The user's verified place of birth as it appears in the document.", "maxLength": 5000, "nullable": true, "type": "string" }, "unparsed_sex": { "description": "The user's verified sex as it appears in the document.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "GelatoVerifiedOutputs", "type": "object", "x-expandableFields": [ "address", "dob" ] }, "identity.verification_report": { "description": "A VerificationReport is the result of an attempt to collect and verify data from a user.\nThe collection of verification checks performed is determined from the `type` and `options`\nparameters used. You can find the result of each verification check performed in the\nappropriate sub-resource: `document`, `id_number`, `selfie`.\n\nEach VerificationReport contains a copy of any data collected by the user as well as\nreference IDs which can be used to access collected images through the [FileUpload](https://stripe.com/docs/api/files)\nAPI. To configure and create VerificationReports, use the\n[VerificationSession](https://stripe.com/docs/api/identity/verification_sessions) API.\n\nRelated guide: [Accessing verification results](https://stripe.com/docs/identity/verification-sessions#results).", "properties": { "client_reference_id": { "description": "A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems.", "maxLength": 5000, "nullable": true, "type": "string" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "document": { "$ref": "#/components/schemas/gelato_document_report" }, "email": { "$ref": "#/components/schemas/gelato_email_report" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "id_number": { "$ref": "#/components/schemas/gelato_id_number_report" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "identity.verification_report" ], "type": "string" }, "options": { "$ref": "#/components/schemas/gelato_verification_report_options" }, "phone": { "$ref": "#/components/schemas/gelato_phone_report" }, "selfie": { "$ref": "#/components/schemas/gelato_selfie_report" }, "type": { "description": "Type of report.", "enum": [ "document", "id_number", "verification_flow" ], "type": "string", "x-stripeBypassValidation": true }, "verification_flow": { "description": "The configuration token of a verification flow from the dashboard.", "maxLength": 5000, "type": "string" }, "verification_session": { "description": "ID of the VerificationSession that created this report.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "created", "id", "livemode", "object", "type" ], "title": "GelatoVerificationReport", "type": "object", "x-expandableFields": [ "document", "email", "id_number", "options", "phone", "selfie" ], "x-resourceId": "identity.verification_report" }, "identity.verification_session": { "description": "A VerificationSession guides you through the process of collecting and verifying the identities\nof your users. It contains details about the type of verification, such as what [verification\ncheck](/docs/identity/verification-checks) to perform. Only create one VerificationSession for\neach verification in your system.\n\nA VerificationSession transitions through [multiple\nstatuses](/docs/identity/how-sessions-work) throughout its lifetime as it progresses through\nthe verification flow. The VerificationSession contains the user's verified data after\nverification checks are complete.\n\nRelated guide: [The Verification Sessions API](https://stripe.com/docs/identity/verification-sessions)", "properties": { "client_reference_id": { "description": "A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems.", "maxLength": 5000, "nullable": true, "type": "string" }, "client_secret": { "description": "The short-lived client secret used by Stripe.js to [show a verification modal](https://stripe.com/docs/js/identity/modal) inside your app. This client secret expires after 24 hours and can only be used once. Don’t store it, log it, embed it in a URL, or expose it to anyone other than the user. Make sure that you have TLS enabled on any page that includes the client secret. Refer to our docs on [passing the client secret to the frontend](https://stripe.com/docs/identity/verification-sessions#client-secret) to learn more.", "maxLength": 5000, "nullable": true, "type": "string" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "last_error": { "anyOf": [ { "$ref": "#/components/schemas/gelato_session_last_error" } ], "description": "If present, this property tells you the last error encountered when processing the verification.", "nullable": true }, "last_verification_report": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/identity.verification_report" } ], "description": "ID of the most recent VerificationReport. [Learn more about accessing detailed verification results.](https://stripe.com/docs/identity/verification-sessions#results)", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/identity.verification_report" } ] } }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "type": "object" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "identity.verification_session" ], "type": "string" }, "options": { "anyOf": [ { "$ref": "#/components/schemas/gelato_verification_session_options" } ], "description": "A set of options for the session’s verification checks.", "nullable": true }, "provided_details": { "anyOf": [ { "$ref": "#/components/schemas/gelato_provided_details" } ], "description": "Details provided about the user being verified. These details may be shown to the user.", "nullable": true }, "redaction": { "anyOf": [ { "$ref": "#/components/schemas/verification_session_redaction" } ], "description": "Redaction status of this VerificationSession. If the VerificationSession is not redacted, this field will be null.", "nullable": true }, "related_customer": { "description": "Customer ID", "maxLength": 5000, "nullable": true, "type": "string" }, "related_person": { "$ref": "#/components/schemas/gelato_related_person" }, "status": { "description": "Status of this VerificationSession. [Learn more about the lifecycle of sessions](https://stripe.com/docs/identity/how-sessions-work).", "enum": [ "canceled", "processing", "requires_input", "verified" ], "type": "string" }, "type": { "description": "The type of [verification check](https://stripe.com/docs/identity/verification-checks) to be performed.", "enum": [ "document", "id_number", "verification_flow" ], "type": "string", "x-stripeBypassValidation": true }, "url": { "description": "The short-lived URL that you use to redirect a user to Stripe to submit their identity information. This URL expires after 48 hours and can only be used once. Don’t store it, log it, send it in emails or expose it to anyone other than the user. Refer to our docs on [verifying identity documents](https://stripe.com/docs/identity/verify-identity-documents?platform=web&type=redirect) to learn how to redirect users to Stripe.", "maxLength": 5000, "nullable": true, "type": "string" }, "verification_flow": { "description": "The configuration token of a verification flow from the dashboard.", "maxLength": 5000, "type": "string" }, "verified_outputs": { "anyOf": [ { "$ref": "#/components/schemas/gelato_verified_outputs" } ], "description": "The user’s verified data.", "nullable": true } }, "required": [ "created", "id", "livemode", "metadata", "object", "status", "type" ], "title": "GelatoVerificationSession", "type": "object", "x-expandableFields": [ "last_error", "last_verification_report", "options", "provided_details", "redaction", "related_person", "verified_outputs" ], "x-resourceId": "identity.verification_session" }, "inbound_transfers": { "description": "", "properties": { "billing_details": { "$ref": "#/components/schemas/treasury_shared_resource_billing_details" }, "type": { "description": "The type of the payment method used in the InboundTransfer.", "enum": [ "us_bank_account" ], "type": "string", "x-stripeBypassValidation": true }, "us_bank_account": { "$ref": "#/components/schemas/inbound_transfers_payment_method_details_us_bank_account" } }, "required": [ "billing_details", "type" ], "title": "InboundTransfers", "type": "object", "x-expandableFields": [ "billing_details", "us_bank_account" ] }, "inbound_transfers_payment_method_details_us_bank_account": { "description": "", "properties": { "account_holder_type": { "description": "Account holder type: individual or company.", "enum": [ "company", "individual" ], "nullable": true, "type": "string" }, "account_type": { "description": "Account type: checkings or savings. Defaults to checking if omitted.", "enum": [ "checking", "savings" ], "nullable": true, "type": "string" }, "bank_name": { "description": "Name of the bank associated with the bank account.", "maxLength": 5000, "nullable": true, "type": "string" }, "fingerprint": { "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.", "maxLength": 5000, "nullable": true, "type": "string" }, "last4": { "description": "Last four digits of the bank account number.", "maxLength": 5000, "nullable": true, "type": "string" }, "mandate": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/mandate" } ], "description": "ID of the mandate used to make this payment.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/mandate" } ] } }, "network": { "description": "The network rails used. See the [docs](https://stripe.com/docs/treasury/money-movement/timelines) to learn more about money movement timelines for each network type.", "enum": [ "ach" ], "type": "string" }, "routing_number": { "description": "Routing number of the bank account.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "network" ], "title": "inbound_transfers_payment_method_details_us_bank_account", "type": "object", "x-expandableFields": [ "mandate" ] }, "internal_card": { "description": "", "properties": { "brand": { "description": "Brand of the card used in the transaction", "maxLength": 5000, "nullable": true, "type": "string" }, "country": { "description": "Two-letter ISO code representing the country of the card", "maxLength": 5000, "nullable": true, "type": "string" }, "exp_month": { "description": "Two digit number representing the card's expiration month", "nullable": true, "type": "integer" }, "exp_year": { "description": "Two digit number representing the card's expiration year", "nullable": true, "type": "integer" }, "last4": { "description": "The last 4 digits of the card", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "internal_card", "type": "object", "x-expandableFields": [] }, "invoice": { "description": "Invoices are statements of amounts owed by a customer, and are either\ngenerated one-off, or generated periodically from a subscription.\n\nThey contain [invoice items](https://stripe.com/docs/api#invoiceitems), and proration adjustments\nthat may be caused by subscription upgrades/downgrades (if necessary).\n\nIf your invoice is configured to be billed through automatic charges,\nStripe automatically finalizes your invoice and attempts payment. Note\nthat finalizing the invoice,\n[when automatic](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection), does\nnot happen immediately as the invoice is created. Stripe waits\nuntil one hour after the last webhook was successfully sent (or the last\nwebhook timed out after failing). If you (and the platforms you may have\nconnected to) have no webhooks configured, Stripe waits one hour after\ncreation to finalize the invoice.\n\nIf your invoice is configured to be billed by sending an email, then based on your\n[email settings](https://dashboard.stripe.com/account/billing/automatic),\nStripe will email the invoice to your customer and await payment. These\nemails can contain a link to a hosted page to pay the invoice.\n\nStripe applies any customer credit on the account before determining the\namount due for the invoice (i.e., the amount that will be actually\ncharged). If the amount due for the invoice is less than Stripe's [minimum allowed charge\nper currency](/docs/currencies#minimum-and-maximum-charge-amounts), the\ninvoice is automatically marked paid, and we add the amount due to the\ncustomer's credit balance which is applied to the next invoice.\n\nMore details on the customer's credit balance are\n[here](https://stripe.com/docs/billing/customer/balance).\n\nRelated guide: [Send invoices to customers](https://stripe.com/docs/billing/invoices/sending)", "properties": { "account_country": { "description": "The country of the business associated with this invoice, most often the business creating the invoice.", "maxLength": 5000, "nullable": true, "type": "string" }, "account_name": { "description": "The public name of the business associated with this invoice, most often the business creating the invoice.", "maxLength": 5000, "nullable": true, "type": "string" }, "account_tax_ids": { "description": "The account tax IDs associated with the invoice. Only editable when the invoice is a draft.", "items": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/tax_id" }, { "$ref": "#/components/schemas/deleted_tax_id" } ], "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/tax_id" }, { "$ref": "#/components/schemas/deleted_tax_id" } ] } }, "nullable": true, "type": "array" }, "amount_due": { "description": "Final amount due at this time for this invoice. If the invoice's total is smaller than the minimum charge amount, for example, or if there is account credit that can be applied to the invoice, the `amount_due` may be 0. If there is a positive `starting_balance` for the invoice (the customer owes money), the `amount_due` will also take that into account. The charge that gets generated for the invoice will be for the amount specified in `amount_due`.", "type": "integer" }, "amount_overpaid": { "description": "Amount that was overpaid on the invoice. The amount overpaid is credited to the customer's credit balance.", "type": "integer" }, "amount_paid": { "description": "The amount, in cents (or local equivalent), that was paid.", "type": "integer" }, "amount_remaining": { "description": "The difference between amount_due and amount_paid, in cents (or local equivalent).", "type": "integer" }, "amount_shipping": { "description": "This is the sum of all the shipping amounts.", "type": "integer" }, "application": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/application" }, { "$ref": "#/components/schemas/deleted_application" } ], "description": "ID of the Connect Application that created the invoice.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/application" }, { "$ref": "#/components/schemas/deleted_application" } ] } }, "attempt_count": { "description": "Number of payment attempts made for this invoice, from the perspective of the payment retry schedule. Any payment attempt counts as the first attempt, and subsequently only automatic retries increment the attempt count. In other words, manual payment attempts after the first attempt do not affect the retry schedule. If a failure is returned with a non-retryable return code, the invoice can no longer be retried unless a new payment method is obtained. Retries will continue to be scheduled, and attempt_count will continue to increment, but retries will only be executed if a new payment method is obtained.", "type": "integer" }, "attempted": { "description": "Whether an attempt has been made to pay the invoice. An invoice is not attempted until 1 hour after the `invoice.created` webhook, for example, so you might not want to display that invoice as unpaid to your users.", "type": "boolean" }, "auto_advance": { "description": "Controls whether Stripe performs [automatic collection](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection) of the invoice. If `false`, the invoice's state doesn't automatically advance without an explicit action.", "type": "boolean" }, "automatic_tax": { "$ref": "#/components/schemas/automatic_tax" }, "automatically_finalizes_at": { "description": "The time when this invoice is currently scheduled to be automatically finalized. The field will be `null` if the invoice is not scheduled to finalize in the future. If the invoice is not in the draft state, this field will always be `null` - see `finalized_at` for the time when an already-finalized invoice was finalized.", "format": "unix-time", "nullable": true, "type": "integer" }, "billing_reason": { "description": "Indicates the reason why the invoice was created.\n\n* `manual`: Unrelated to a subscription, for example, created via the invoice editor.\n* `subscription`: No longer in use. Applies to subscriptions from before May 2018 where no distinction was made between updates, cycles, and thresholds.\n* `subscription_create`: A new subscription was created.\n* `subscription_cycle`: A subscription advanced into a new period.\n* `subscription_threshold`: A subscription reached a billing threshold.\n* `subscription_update`: A subscription was updated.\n* `upcoming`: Reserved for simulated invoices, per the upcoming invoice endpoint.", "enum": [ "automatic_pending_invoice_item_invoice", "manual", "quote_accept", "subscription", "subscription_create", "subscription_cycle", "subscription_threshold", "subscription_update", "upcoming" ], "nullable": true, "type": "string" }, "collection_method": { "description": "Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this invoice using the default source attached to the customer. When sending an invoice, Stripe will email this invoice to the customer with payment instructions.", "enum": [ "charge_automatically", "send_invoice" ], "type": "string" }, "confirmation_secret": { "anyOf": [ { "$ref": "#/components/schemas/invoices_resource_confirmation_secret" } ], "description": "The confirmation secret associated with this invoice. Currently, this contains the client_secret of the PaymentIntent that Stripe creates during invoice finalization.", "nullable": true }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "custom_fields": { "description": "Custom fields displayed on the invoice.", "items": { "$ref": "#/components/schemas/invoice_setting_custom_field" }, "nullable": true, "type": "array" }, "customer": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/customer" }, { "$ref": "#/components/schemas/deleted_customer" } ], "description": "The ID of the customer who will be billed.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/customer" }, { "$ref": "#/components/schemas/deleted_customer" } ] } }, "customer_address": { "anyOf": [ { "$ref": "#/components/schemas/address" } ], "description": "The customer's address. Until the invoice is finalized, this field will equal `customer.address`. Once the invoice is finalized, this field will no longer be updated.", "nullable": true }, "customer_email": { "description": "The customer's email. Until the invoice is finalized, this field will equal `customer.email`. Once the invoice is finalized, this field will no longer be updated.", "maxLength": 5000, "nullable": true, "type": "string" }, "customer_name": { "description": "The customer's name. Until the invoice is finalized, this field will equal `customer.name`. Once the invoice is finalized, this field will no longer be updated.", "maxLength": 5000, "nullable": true, "type": "string" }, "customer_phone": { "description": "The customer's phone number. Until the invoice is finalized, this field will equal `customer.phone`. Once the invoice is finalized, this field will no longer be updated.", "maxLength": 5000, "nullable": true, "type": "string" }, "customer_shipping": { "anyOf": [ { "$ref": "#/components/schemas/shipping" } ], "description": "The customer's shipping information. Until the invoice is finalized, this field will equal `customer.shipping`. Once the invoice is finalized, this field will no longer be updated.", "nullable": true }, "customer_tax_exempt": { "description": "The customer's tax exempt status. Until the invoice is finalized, this field will equal `customer.tax_exempt`. Once the invoice is finalized, this field will no longer be updated.", "enum": [ "exempt", "none", "reverse" ], "nullable": true, "type": "string" }, "customer_tax_ids": { "description": "The customer's tax IDs. Until the invoice is finalized, this field will contain the same tax IDs as `customer.tax_ids`. Once the invoice is finalized, this field will no longer be updated.", "items": { "$ref": "#/components/schemas/invoices_resource_invoice_tax_id" }, "nullable": true, "type": "array" }, "default_payment_method": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/payment_method" } ], "description": "ID of the default payment method for the invoice. It must belong to the customer associated with the invoice. If not set, defaults to the subscription's default payment method, if any, or to the default payment method in the customer's invoice settings.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/payment_method" } ] } }, "default_source": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/bank_account" }, { "$ref": "#/components/schemas/card" }, { "$ref": "#/components/schemas/source" } ], "description": "ID of the default payment source for the invoice. It must belong to the customer associated with the invoice and be in a chargeable state. If not set, defaults to the subscription's default source, if any, or to the customer's default source.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/bank_account" }, { "$ref": "#/components/schemas/card" }, { "$ref": "#/components/schemas/source" } ] }, "x-stripeBypassValidation": true }, "default_tax_rates": { "description": "The tax rates applied to this invoice, if any.", "items": { "$ref": "#/components/schemas/tax_rate" }, "type": "array" }, "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard.", "maxLength": 5000, "nullable": true, "type": "string" }, "discounts": { "description": "The discounts applied to the invoice. Line item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount.", "items": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/discount" }, { "$ref": "#/components/schemas/deleted_discount" } ], "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/discount" }, { "$ref": "#/components/schemas/deleted_discount" } ] } }, "type": "array" }, "due_date": { "description": "The date on which payment for this invoice is due. This value will be `null` for invoices where `collection_method=charge_automatically`.", "format": "unix-time", "nullable": true, "type": "integer" }, "effective_at": { "description": "The date when this invoice is in effect. Same as `finalized_at` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the invoice PDF and receipt.", "format": "unix-time", "nullable": true, "type": "integer" }, "ending_balance": { "description": "Ending customer balance after the invoice is finalized. Invoices are finalized approximately an hour after successful webhook delivery or when payment collection is attempted for the invoice. If the invoice has not been finalized yet, this will be null.", "nullable": true, "type": "integer" }, "footer": { "description": "Footer displayed on the invoice.", "maxLength": 5000, "nullable": true, "type": "string" }, "from_invoice": { "anyOf": [ { "$ref": "#/components/schemas/invoices_resource_from_invoice" } ], "description": "Details of the invoice that was cloned. See the [revision documentation](https://stripe.com/docs/invoicing/invoice-revisions) for more details.", "nullable": true }, "hosted_invoice_url": { "description": "The URL for the hosted invoice page, which allows customers to view and pay an invoice. If the invoice has not been finalized yet, this will be null.", "maxLength": 5000, "nullable": true, "type": "string" }, "id": { "description": "Unique identifier for the object. For preview invoices created using the [create preview](https://stripe.com/docs/api/invoices/create_preview) endpoint, this id will be prefixed with `upcoming_in`.", "maxLength": 5000, "type": "string" }, "invoice_pdf": { "description": "The link to download the PDF for the invoice. If the invoice has not been finalized yet, this will be null.", "maxLength": 5000, "nullable": true, "type": "string" }, "issuer": { "$ref": "#/components/schemas/connect_account_reference" }, "last_finalization_error": { "anyOf": [ { "$ref": "#/components/schemas/api_errors" } ], "description": "The error encountered during the previous attempt to finalize the invoice. This field is cleared when the invoice is successfully finalized.", "nullable": true }, "latest_revision": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/invoice" } ], "description": "The ID of the most recent non-draft revision of this invoice", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/invoice" } ] } }, "lines": { "description": "The individual line items that make up the invoice. `lines` is sorted as follows: (1) pending invoice items (including prorations) in reverse chronological order, (2) subscription items in reverse chronological order, and (3) invoice items added after invoice creation in chronological order.", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/line_item" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "InvoiceLinesList", "type": "object", "x-expandableFields": [ "data" ] }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "nullable": true, "type": "object" }, "next_payment_attempt": { "description": "The time at which payment will next be attempted. This value will be `null` for invoices where `collection_method=send_invoice`.", "format": "unix-time", "nullable": true, "type": "integer" }, "number": { "description": "A unique, identifying string that appears on emails sent to the customer for this invoice. This starts with the customer's unique invoice_prefix if it is specified.", "maxLength": 5000, "nullable": true, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "invoice" ], "type": "string" }, "on_behalf_of": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/account" } ], "description": "The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://stripe.com/docs/billing/invoices/connect) documentation for details.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/account" } ] } }, "parent": { "anyOf": [ { "$ref": "#/components/schemas/billing_bill_resource_invoicing_parents_invoice_parent" } ], "description": "The parent that generated this invoice", "nullable": true }, "payment_settings": { "$ref": "#/components/schemas/invoices_payment_settings" }, "payments": { "description": "Payments for this invoice", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/invoice_payment" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "InvoicesPaymentsListInvoicePayments", "type": "object", "x-expandableFields": [ "data" ] }, "period_end": { "description": "End of the usage period during which invoice items were added to this invoice. This looks back one period for a subscription invoice. Use the [line item period](/api/invoices/line_item#invoice_line_item_object-period) to get the service period for each price.", "format": "unix-time", "type": "integer" }, "period_start": { "description": "Start of the usage period during which invoice items were added to this invoice. This looks back one period for a subscription invoice. Use the [line item period](/api/invoices/line_item#invoice_line_item_object-period) to get the service period for each price.", "format": "unix-time", "type": "integer" }, "post_payment_credit_notes_amount": { "description": "Total amount of all post-payment credit notes issued for this invoice.", "type": "integer" }, "pre_payment_credit_notes_amount": { "description": "Total amount of all pre-payment credit notes issued for this invoice.", "type": "integer" }, "receipt_number": { "description": "This is the transaction number that appears on email receipts sent for this invoice.", "maxLength": 5000, "nullable": true, "type": "string" }, "rendering": { "anyOf": [ { "$ref": "#/components/schemas/invoices_resource_invoice_rendering" } ], "description": "The rendering-related settings that control how the invoice is displayed on customer-facing surfaces such as PDF and Hosted Invoice Page.", "nullable": true }, "shipping_cost": { "anyOf": [ { "$ref": "#/components/schemas/invoices_resource_shipping_cost" } ], "description": "The details of the cost of shipping, including the ShippingRate applied on the invoice.", "nullable": true }, "shipping_details": { "anyOf": [ { "$ref": "#/components/schemas/shipping" } ], "description": "Shipping details for the invoice. The Invoice PDF will use the `shipping_details` value if it is set, otherwise the PDF will render the shipping address from the customer.", "nullable": true }, "starting_balance": { "description": "Starting customer balance before the invoice is finalized. If the invoice has not been finalized yet, this will be the current customer balance. For revision invoices, this also includes any customer balance that was applied to the original invoice.", "type": "integer" }, "statement_descriptor": { "description": "Extra information about an invoice for the customer's credit card statement.", "maxLength": 5000, "nullable": true, "type": "string" }, "status": { "description": "The status of the invoice, one of `draft`, `open`, `paid`, `uncollectible`, or `void`. [Learn more](https://stripe.com/docs/billing/invoices/workflow#workflow-overview)", "enum": [ "draft", "open", "paid", "uncollectible", "void" ], "nullable": true, "type": "string", "x-stripeBypassValidation": true }, "status_transitions": { "$ref": "#/components/schemas/invoices_resource_status_transitions" }, "subtotal": { "description": "Total of all subscriptions, invoice items, and prorations on the invoice before any invoice level discount or exclusive tax is applied. Item discounts are already incorporated", "type": "integer" }, "subtotal_excluding_tax": { "description": "The integer amount in cents (or local equivalent) representing the subtotal of the invoice before any invoice level discount or tax is applied. Item discounts are already incorporated", "nullable": true, "type": "integer" }, "test_clock": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/test_helpers.test_clock" } ], "description": "ID of the test clock this invoice belongs to.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/test_helpers.test_clock" } ] } }, "threshold_reason": { "$ref": "#/components/schemas/invoice_threshold_reason" }, "total": { "description": "Total after discounts and taxes.", "type": "integer" }, "total_discount_amounts": { "description": "The aggregate amounts calculated per discount across all line items.", "items": { "$ref": "#/components/schemas/discounts_resource_discount_amount" }, "nullable": true, "type": "array" }, "total_excluding_tax": { "description": "The integer amount in cents (or local equivalent) representing the total amount of the invoice including all discounts but excluding all tax.", "nullable": true, "type": "integer" }, "total_pretax_credit_amounts": { "description": "Contains pretax credit amounts (ex: discount, credit grants, etc) that apply to this invoice. This is a combined list of total_pretax_credit_amounts across all invoice line items.", "items": { "$ref": "#/components/schemas/invoices_resource_pretax_credit_amount" }, "nullable": true, "type": "array" }, "total_taxes": { "description": "The aggregate tax information of all line items.", "items": { "$ref": "#/components/schemas/billing_bill_resource_invoicing_taxes_tax" }, "nullable": true, "type": "array" }, "webhooks_delivered_at": { "description": "Invoices are automatically paid or sent 1 hour after webhooks are delivered, or until all webhook delivery attempts have [been exhausted](https://stripe.com/docs/billing/webhooks#understand). This field tracks the time when webhooks for this invoice were successfully delivered. If the invoice had no webhooks to deliver, this will be set while the invoice is being created.", "format": "unix-time", "nullable": true, "type": "integer" } }, "required": [ "amount_due", "amount_overpaid", "amount_paid", "amount_remaining", "amount_shipping", "attempt_count", "attempted", "auto_advance", "automatic_tax", "collection_method", "created", "currency", "customer", "default_tax_rates", "discounts", "id", "issuer", "lines", "livemode", "object", "payment_settings", "period_end", "period_start", "post_payment_credit_notes_amount", "pre_payment_credit_notes_amount", "starting_balance", "status_transitions", "subtotal", "total" ], "title": "Invoice", "type": "object", "x-expandableFields": [ "account_tax_ids", "application", "automatic_tax", "confirmation_secret", "custom_fields", "customer", "customer_address", "customer_shipping", "customer_tax_ids", "default_payment_method", "default_source", "default_tax_rates", "discounts", "from_invoice", "issuer", "last_finalization_error", "latest_revision", "lines", "on_behalf_of", "parent", "payment_settings", "payments", "rendering", "shipping_cost", "shipping_details", "status_transitions", "test_clock", "threshold_reason", "total_discount_amounts", "total_pretax_credit_amounts", "total_taxes" ], "x-resourceId": "invoice" }, "invoice_installments_card": { "description": "", "properties": { "enabled": { "description": "Whether Installments are enabled for this Invoice.", "nullable": true, "type": "boolean" } }, "title": "invoice_installments_card", "type": "object", "x-expandableFields": [] }, "invoice_item_threshold_reason": { "description": "", "properties": { "line_item_ids": { "description": "The IDs of the line items that triggered the threshold invoice.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "usage_gte": { "description": "The quantity threshold boundary that applied to the given line item.", "type": "integer" } }, "required": [ "line_item_ids", "usage_gte" ], "title": "InvoiceItemThresholdReason", "type": "object", "x-expandableFields": [] }, "invoice_line_item_period": { "description": "", "properties": { "end": { "description": "The end of the period, which must be greater than or equal to the start. This value is inclusive.", "format": "unix-time", "type": "integer" }, "start": { "description": "The start of the period. This value is inclusive.", "format": "unix-time", "type": "integer" } }, "required": [ "end", "start" ], "title": "InvoiceLineItemPeriod", "type": "object", "x-expandableFields": [] }, "invoice_mandate_options_card": { "description": "", "properties": { "amount": { "description": "Amount to be charged for future payments.", "nullable": true, "type": "integer" }, "amount_type": { "description": "One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.", "enum": [ "fixed", "maximum" ], "nullable": true, "type": "string" }, "description": { "description": "A description of the mandate or subscription that is meant to be displayed to the customer.", "maxLength": 200, "nullable": true, "type": "string" } }, "title": "invoice_mandate_options_card", "type": "object", "x-expandableFields": [] }, "invoice_payment": { "description": "Invoice Payments represent payments made against invoices. Invoice Payments can\nbe accessed in two ways:\n1. By expanding the `payments` field on the [Invoice](https://stripe.com/docs/api#invoice) resource.\n2. By using the Invoice Payment retrieve and list endpoints.\n\nInvoice Payments include the mapping between payment objects, such as Payment Intent, and Invoices.\nThis resource and its endpoints allows you to easily track if a payment is associated with a specific invoice and\nmonitor the allocation details of the payments.", "properties": { "amount_paid": { "description": "Amount that was actually paid for this invoice, in cents (or local equivalent). This field is null until the payment is `paid`. This amount can be less than the `amount_requested` if the PaymentIntent’s `amount_received` is not sufficient to pay all of the invoices that it is attached to.", "nullable": true, "type": "integer" }, "amount_requested": { "description": "Amount intended to be paid toward this invoice, in cents (or local equivalent)", "type": "integer" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "maxLength": 5000, "type": "string" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "invoice": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/invoice" }, { "$ref": "#/components/schemas/deleted_invoice" } ], "description": "The invoice that was paid.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/invoice" }, { "$ref": "#/components/schemas/deleted_invoice" } ] } }, "is_default": { "description": "Stripe automatically creates a default InvoicePayment when the invoice is finalized, and keeps it synchronized with the invoice’s `amount_remaining`. The PaymentIntent associated with the default payment can’t be edited or canceled directly.", "type": "boolean" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "invoice_payment" ], "type": "string" }, "payment": { "$ref": "#/components/schemas/invoices_payments_invoice_payment_associated_payment" }, "status": { "description": "The status of the payment, one of `open`, `paid`, or `canceled`.", "maxLength": 5000, "type": "string" }, "status_transitions": { "$ref": "#/components/schemas/invoices_payments_invoice_payment_status_transitions" } }, "required": [ "amount_requested", "created", "currency", "id", "invoice", "is_default", "livemode", "object", "payment", "status", "status_transitions" ], "title": "InvoicesInvoicePayment", "type": "object", "x-expandableFields": [ "invoice", "payment", "status_transitions" ], "x-resourceId": "invoice_payment" }, "invoice_payment_method_options_acss_debit": { "description": "", "properties": { "mandate_options": { "$ref": "#/components/schemas/invoice_payment_method_options_acss_debit_mandate_options" }, "verification_method": { "description": "Bank account verification method.", "enum": [ "automatic", "instant", "microdeposits" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "invoice_payment_method_options_acss_debit", "type": "object", "x-expandableFields": [ "mandate_options" ] }, "invoice_payment_method_options_acss_debit_mandate_options": { "description": "", "properties": { "transaction_type": { "description": "Transaction type of the mandate.", "enum": [ "business", "personal" ], "nullable": true, "type": "string" } }, "title": "invoice_payment_method_options_acss_debit_mandate_options", "type": "object", "x-expandableFields": [] }, "invoice_payment_method_options_bancontact": { "description": "", "properties": { "preferred_language": { "description": "Preferred language of the Bancontact authorization page that the customer is redirected to.", "enum": [ "de", "en", "fr", "nl" ], "type": "string" } }, "required": [ "preferred_language" ], "title": "invoice_payment_method_options_bancontact", "type": "object", "x-expandableFields": [] }, "invoice_payment_method_options_card": { "description": "", "properties": { "installments": { "$ref": "#/components/schemas/invoice_installments_card" }, "request_three_d_secure": { "description": "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.", "enum": [ "any", "automatic", "challenge" ], "nullable": true, "type": "string" } }, "title": "invoice_payment_method_options_card", "type": "object", "x-expandableFields": [ "installments" ] }, "invoice_payment_method_options_customer_balance": { "description": "", "properties": { "bank_transfer": { "$ref": "#/components/schemas/invoice_payment_method_options_customer_balance_bank_transfer" }, "funding_type": { "description": "The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.", "enum": [ "bank_transfer" ], "nullable": true, "type": "string" } }, "title": "invoice_payment_method_options_customer_balance", "type": "object", "x-expandableFields": [ "bank_transfer" ] }, "invoice_payment_method_options_customer_balance_bank_transfer": { "description": "", "properties": { "eu_bank_transfer": { "$ref": "#/components/schemas/invoice_payment_method_options_customer_balance_bank_transfer_eu_bank_transfer" }, "type": { "description": "The bank transfer type that can be used for funding. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.", "nullable": true, "type": "string" } }, "title": "invoice_payment_method_options_customer_balance_bank_transfer", "type": "object", "x-expandableFields": [ "eu_bank_transfer" ] }, "invoice_payment_method_options_customer_balance_bank_transfer_eu_bank_transfer": { "description": "", "properties": { "country": { "description": "The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`.", "enum": [ "BE", "DE", "ES", "FR", "IE", "NL" ], "type": "string" } }, "required": [ "country" ], "title": "invoice_payment_method_options_customer_balance_bank_transfer_eu_bank_transfer", "type": "object", "x-expandableFields": [] }, "invoice_payment_method_options_konbini": { "description": "", "properties": {}, "title": "invoice_payment_method_options_konbini", "type": "object", "x-expandableFields": [] }, "invoice_payment_method_options_sepa_debit": { "description": "", "properties": {}, "title": "invoice_payment_method_options_sepa_debit", "type": "object", "x-expandableFields": [] }, "invoice_payment_method_options_us_bank_account": { "description": "", "properties": { "financial_connections": { "$ref": "#/components/schemas/invoice_payment_method_options_us_bank_account_linked_account_options" }, "verification_method": { "description": "Bank account verification method.", "enum": [ "automatic", "instant", "microdeposits" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "invoice_payment_method_options_us_bank_account", "type": "object", "x-expandableFields": [ "financial_connections" ] }, "invoice_payment_method_options_us_bank_account_linked_account_options": { "description": "", "properties": { "filters": { "$ref": "#/components/schemas/invoice_payment_method_options_us_bank_account_linked_account_options_filters" }, "permissions": { "description": "The list of permissions to request. The `payment_method` permission must be included.", "items": { "enum": [ "balances", "ownership", "payment_method", "transactions" ], "type": "string" }, "type": "array" }, "prefetch": { "description": "Data features requested to be retrieved upon account creation.", "items": { "enum": [ "balances", "ownership", "transactions" ], "type": "string", "x-stripeBypassValidation": true }, "nullable": true, "type": "array" } }, "title": "invoice_payment_method_options_us_bank_account_linked_account_options", "type": "object", "x-expandableFields": [ "filters" ] }, "invoice_payment_method_options_us_bank_account_linked_account_options_filters": { "description": "", "properties": { "account_subcategories": { "description": "The account subcategories to use to filter for possible accounts to link. Valid subcategories are `checking` and `savings`.", "items": { "enum": [ "checking", "savings" ], "type": "string" }, "type": "array" } }, "title": "invoice_payment_method_options_us_bank_account_linked_account_options_filters", "type": "object", "x-expandableFields": [] }, "invoice_rendering_pdf": { "description": "", "properties": { "page_size": { "description": "Page size of invoice pdf. Options include a4, letter, and auto. If set to auto, page size will be switched to a4 or letter based on customer locale.", "enum": [ "a4", "auto", "letter" ], "nullable": true, "type": "string" } }, "title": "InvoiceRenderingPdf", "type": "object", "x-expandableFields": [] }, "invoice_rendering_template": { "description": "Invoice Rendering Templates are used to configure how invoices are rendered on surfaces like the PDF. Invoice Rendering Templates\ncan be created from within the Dashboard, and they can be used over the API when creating invoices.", "properties": { "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "nullable": true, "type": "object" }, "nickname": { "description": "A brief description of the template, hidden from customers", "maxLength": 5000, "nullable": true, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "invoice_rendering_template" ], "type": "string" }, "status": { "description": "The status of the template, one of `active` or `archived`.", "enum": [ "active", "archived" ], "type": "string" }, "version": { "description": "Version of this template; version increases by one when an update on the template changes any field that controls invoice rendering", "type": "integer" } }, "required": [ "created", "id", "livemode", "object", "status", "version" ], "title": "InvoiceRenderingTemplate", "type": "object", "x-expandableFields": [], "x-resourceId": "invoice_rendering_template" }, "invoice_setting_checkout_rendering_options": { "description": "", "properties": { "amount_tax_display": { "description": "How line-item prices and amounts will be displayed with respect to tax on invoice PDFs.", "maxLength": 5000, "nullable": true, "type": "string" }, "template": { "description": "ID of the invoice rendering template to be used for the generated invoice.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "invoice_setting_checkout_rendering_options", "type": "object", "x-expandableFields": [] }, "invoice_setting_custom_field": { "description": "", "properties": { "name": { "description": "The name of the custom field.", "maxLength": 5000, "type": "string" }, "value": { "description": "The value of the custom field.", "maxLength": 5000, "type": "string" } }, "required": [ "name", "value" ], "title": "InvoiceSettingCustomField", "type": "object", "x-expandableFields": [] }, "invoice_setting_customer_rendering_options": { "description": "", "properties": { "amount_tax_display": { "description": "How line-item prices and amounts will be displayed with respect to tax on invoice PDFs.", "maxLength": 5000, "nullable": true, "type": "string" }, "template": { "description": "ID of the invoice rendering template to be used for this customer's invoices. If set, the template will be used on all invoices for this customer unless a template is set directly on the invoice.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "InvoiceSettingCustomerRenderingOptions", "type": "object", "x-expandableFields": [] }, "invoice_setting_customer_setting": { "description": "", "properties": { "custom_fields": { "description": "Default custom fields to be displayed on invoices for this customer.", "items": { "$ref": "#/components/schemas/invoice_setting_custom_field" }, "nullable": true, "type": "array" }, "default_payment_method": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/payment_method" } ], "description": "ID of a payment method that's attached to the customer, to be used as the customer's default payment method for subscriptions and invoices.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/payment_method" } ] } }, "footer": { "description": "Default footer to be displayed on invoices for this customer.", "maxLength": 5000, "nullable": true, "type": "string" }, "rendering_options": { "anyOf": [ { "$ref": "#/components/schemas/invoice_setting_customer_rendering_options" } ], "description": "Default options for invoice PDF rendering for this customer.", "nullable": true } }, "title": "InvoiceSettingCustomerSetting", "type": "object", "x-expandableFields": [ "custom_fields", "default_payment_method", "rendering_options" ] }, "invoice_setting_quote_setting": { "description": "", "properties": { "days_until_due": { "description": "Number of days within which a customer must pay invoices generated by this quote. This value will be `null` for quotes where `collection_method=charge_automatically`.", "nullable": true, "type": "integer" }, "issuer": { "$ref": "#/components/schemas/connect_account_reference" } }, "required": [ "issuer" ], "title": "InvoiceSettingQuoteSetting", "type": "object", "x-expandableFields": [ "issuer" ] }, "invoice_setting_subscription_schedule_phase_setting": { "description": "", "properties": { "account_tax_ids": { "description": "The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule.", "items": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/tax_id" }, { "$ref": "#/components/schemas/deleted_tax_id" } ], "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/tax_id" }, { "$ref": "#/components/schemas/deleted_tax_id" } ] } }, "nullable": true, "type": "array" }, "days_until_due": { "description": "Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`.", "nullable": true, "type": "integer" }, "issuer": { "anyOf": [ { "$ref": "#/components/schemas/connect_account_reference" } ], "description": "The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.", "nullable": true } }, "title": "InvoiceSettingSubscriptionSchedulePhaseSetting", "type": "object", "x-expandableFields": [ "account_tax_ids", "issuer" ] }, "invoice_setting_subscription_schedule_setting": { "description": "", "properties": { "account_tax_ids": { "description": "The account tax IDs associated with the subscription schedule. Will be set on invoices generated by the subscription schedule.", "items": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/tax_id" }, { "$ref": "#/components/schemas/deleted_tax_id" } ], "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/tax_id" }, { "$ref": "#/components/schemas/deleted_tax_id" } ] } }, "nullable": true, "type": "array" }, "days_until_due": { "description": "Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`.", "nullable": true, "type": "integer" }, "issuer": { "$ref": "#/components/schemas/connect_account_reference" } }, "required": [ "issuer" ], "title": "InvoiceSettingSubscriptionScheduleSetting", "type": "object", "x-expandableFields": [ "account_tax_ids", "issuer" ] }, "invoice_threshold_reason": { "description": "", "properties": { "amount_gte": { "description": "The total invoice amount threshold boundary if it triggered the threshold invoice.", "nullable": true, "type": "integer" }, "item_reasons": { "description": "Indicates which line items triggered a threshold invoice.", "items": { "$ref": "#/components/schemas/invoice_item_threshold_reason" }, "type": "array" } }, "required": [ "item_reasons" ], "title": "InvoiceThresholdReason", "type": "object", "x-expandableFields": [ "item_reasons" ] }, "invoiceitem": { "description": "Invoice Items represent the component lines of an [invoice](https://stripe.com/docs/api/invoices). When you create an invoice item with an `invoice` field, it is attached to the specified invoice and included as [an invoice line item](https://stripe.com/docs/api/invoices/line_item) within [invoice.lines](https://stripe.com/docs/api/invoices/object#invoice_object-lines).\n\nInvoice Items can be created before you are ready to actually send the invoice. This can be particularly useful when combined\nwith a [subscription](https://stripe.com/docs/api/subscriptions). Sometimes you want to add a charge or credit to a customer, but actually charge\nor credit the customer's card only at the end of a regular billing cycle. This is useful for combining several charges\n(to minimize per-transaction fees), or for having Stripe tabulate your usage-based billing totals.\n\nRelated guides: [Integrate with the Invoicing API](https://stripe.com/docs/invoicing/integration), [Subscription Invoices](https://stripe.com/docs/billing/invoices/subscription#adding-upcoming-invoice-items).", "properties": { "amount": { "description": "Amount (in the `currency` specified) of the invoice item. This should always be equal to `unit_amount * quantity`.", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "customer": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/customer" }, { "$ref": "#/components/schemas/deleted_customer" } ], "description": "The ID of the customer who will be billed when this invoice item is billed.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/customer" }, { "$ref": "#/components/schemas/deleted_customer" } ] } }, "date": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users.", "maxLength": 5000, "nullable": true, "type": "string" }, "discountable": { "description": "If true, discounts will apply to this invoice item. Always false for prorations.", "type": "boolean" }, "discounts": { "description": "The discounts which apply to the invoice item. Item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount.", "items": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/discount" } ], "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/discount" } ] } }, "nullable": true, "type": "array" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "invoice": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/invoice" } ], "description": "The ID of the invoice this invoice item belongs to.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/invoice" } ] } }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "nullable": true, "type": "object" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "invoiceitem" ], "type": "string" }, "parent": { "anyOf": [ { "$ref": "#/components/schemas/billing_bill_resource_invoice_item_parents_invoice_item_parent" } ], "description": "The parent that generated this invoice item.", "nullable": true }, "period": { "$ref": "#/components/schemas/invoice_line_item_period" }, "pricing": { "anyOf": [ { "$ref": "#/components/schemas/billing_bill_resource_invoicing_pricing_pricing" } ], "description": "The pricing information of the invoice item.", "nullable": true }, "proration": { "description": "Whether the invoice item was created automatically as a proration adjustment when the customer switched plans.", "type": "boolean" }, "quantity": { "description": "Quantity of units for the invoice item. If the invoice item is a proration, the quantity of the subscription that the proration was computed for.", "type": "integer" }, "tax_rates": { "description": "The tax rates which apply to the invoice item. When set, the `default_tax_rates` on the invoice do not apply to this invoice item.", "items": { "$ref": "#/components/schemas/tax_rate" }, "nullable": true, "type": "array" }, "test_clock": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/test_helpers.test_clock" } ], "description": "ID of the test clock this invoice item belongs to.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/test_helpers.test_clock" } ] } } }, "required": [ "amount", "currency", "customer", "date", "discountable", "id", "livemode", "object", "period", "proration", "quantity" ], "title": "InvoiceItem", "type": "object", "x-expandableFields": [ "customer", "discounts", "invoice", "parent", "period", "pricing", "tax_rates", "test_clock" ], "x-resourceId": "invoiceitem" }, "invoices_payment_method_options": { "description": "", "properties": { "acss_debit": { "anyOf": [ { "$ref": "#/components/schemas/invoice_payment_method_options_acss_debit" } ], "description": "If paying by `acss_debit`, this sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to the invoice’s PaymentIntent.", "nullable": true }, "bancontact": { "anyOf": [ { "$ref": "#/components/schemas/invoice_payment_method_options_bancontact" } ], "description": "If paying by `bancontact`, this sub-hash contains details about the Bancontact payment method options to pass to the invoice’s PaymentIntent.", "nullable": true }, "card": { "anyOf": [ { "$ref": "#/components/schemas/invoice_payment_method_options_card" } ], "description": "If paying by `card`, this sub-hash contains details about the Card payment method options to pass to the invoice’s PaymentIntent.", "nullable": true }, "customer_balance": { "anyOf": [ { "$ref": "#/components/schemas/invoice_payment_method_options_customer_balance" } ], "description": "If paying by `customer_balance`, this sub-hash contains details about the Bank transfer payment method options to pass to the invoice’s PaymentIntent.", "nullable": true }, "konbini": { "anyOf": [ { "$ref": "#/components/schemas/invoice_payment_method_options_konbini" } ], "description": "If paying by `konbini`, this sub-hash contains details about the Konbini payment method options to pass to the invoice’s PaymentIntent.", "nullable": true }, "sepa_debit": { "anyOf": [ { "$ref": "#/components/schemas/invoice_payment_method_options_sepa_debit" } ], "description": "If paying by `sepa_debit`, this sub-hash contains details about the SEPA Direct Debit payment method options to pass to the invoice’s PaymentIntent.", "nullable": true }, "us_bank_account": { "anyOf": [ { "$ref": "#/components/schemas/invoice_payment_method_options_us_bank_account" } ], "description": "If paying by `us_bank_account`, this sub-hash contains details about the ACH direct debit payment method options to pass to the invoice’s PaymentIntent.", "nullable": true } }, "title": "InvoicesPaymentMethodOptions", "type": "object", "x-expandableFields": [ "acss_debit", "bancontact", "card", "customer_balance", "konbini", "sepa_debit", "us_bank_account" ] }, "invoices_payment_settings": { "description": "", "properties": { "default_mandate": { "description": "ID of the mandate to be used for this invoice. It must correspond to the payment method used to pay the invoice, including the invoice's default_payment_method or default_source, if set.", "maxLength": 5000, "nullable": true, "type": "string" }, "payment_method_options": { "anyOf": [ { "$ref": "#/components/schemas/invoices_payment_method_options" } ], "description": "Payment-method-specific configuration to provide to the invoice’s PaymentIntent.", "nullable": true }, "payment_method_types": { "description": "The list of payment method types (e.g. card) to provide to the invoice’s PaymentIntent. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your [invoice template settings](https://dashboard.stripe.com/settings/billing/invoice).", "items": { "enum": [ "ach_credit_transfer", "ach_debit", "acss_debit", "affirm", "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", "boleto", "card", "cashapp", "crypto", "customer_balance", "eps", "fpx", "giropay", "grabpay", "ideal", "jp_credit_transfer", "kakao_pay", "klarna", "konbini", "kr_card", "link", "multibanco", "naver_pay", "nz_bank_account", "p24", "payco", "paynow", "paypal", "promptpay", "revolut_pay", "sepa_credit_transfer", "sepa_debit", "sofort", "swish", "us_bank_account", "wechat_pay" ], "type": "string", "x-stripeBypassValidation": true }, "nullable": true, "type": "array" } }, "title": "InvoicesPaymentSettings", "type": "object", "x-expandableFields": [ "payment_method_options" ] }, "invoices_payments_invoice_payment_associated_payment": { "description": "", "properties": { "charge": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/charge" } ], "description": "ID of the successful charge for this payment when `type` is `charge`.Note: charge is only surfaced if the charge object is not associated with a payment intent. If the charge object does have a payment intent, the Invoice Payment surfaces the payment intent instead.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/charge" } ] } }, "payment_intent": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/payment_intent" } ], "description": "ID of the PaymentIntent associated with this payment when `type` is `payment_intent`. Note: This property is only populated for invoices finalized on or after March 15th, 2019.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/payment_intent" } ] } }, "type": { "description": "Type of payment object associated with this invoice payment.", "enum": [ "charge", "payment_intent" ], "type": "string" } }, "required": [ "type" ], "title": "InvoicesPaymentsInvoicePaymentAssociatedPayment", "type": "object", "x-expandableFields": [ "charge", "payment_intent" ] }, "invoices_payments_invoice_payment_status_transitions": { "description": "", "properties": { "canceled_at": { "description": "The time that the payment was canceled.", "format": "unix-time", "nullable": true, "type": "integer" }, "paid_at": { "description": "The time that the payment succeeded.", "format": "unix-time", "nullable": true, "type": "integer" } }, "title": "InvoicesPaymentsInvoicePaymentStatusTransitions", "type": "object", "x-expandableFields": [] }, "invoices_resource_confirmation_secret": { "description": "", "properties": { "client_secret": { "description": "The client_secret of the payment that Stripe creates for the invoice after finalization.", "maxLength": 5000, "type": "string" }, "type": { "description": "The type of client_secret. Currently this is always payment_intent, referencing the default payment_intent that Stripe creates during invoice finalization", "maxLength": 5000, "type": "string" } }, "required": [ "client_secret", "type" ], "title": "InvoicesResourceConfirmationSecret", "type": "object", "x-expandableFields": [] }, "invoices_resource_from_invoice": { "description": "", "properties": { "action": { "description": "The relation between this invoice and the cloned invoice", "maxLength": 5000, "type": "string" }, "invoice": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/invoice" } ], "description": "The invoice that was cloned.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/invoice" } ] } } }, "required": [ "action", "invoice" ], "title": "InvoicesResourceFromInvoice", "type": "object", "x-expandableFields": [ "invoice" ] }, "invoices_resource_invoice_rendering": { "description": "", "properties": { "amount_tax_display": { "description": "How line-item prices and amounts will be displayed with respect to tax on invoice PDFs.", "maxLength": 5000, "nullable": true, "type": "string" }, "pdf": { "anyOf": [ { "$ref": "#/components/schemas/invoice_rendering_pdf" } ], "description": "Invoice pdf rendering options", "nullable": true }, "template": { "description": "ID of the rendering template that the invoice is formatted by.", "maxLength": 5000, "nullable": true, "type": "string" }, "template_version": { "description": "Version of the rendering template that the invoice is using.", "nullable": true, "type": "integer" } }, "title": "InvoicesResourceInvoiceRendering", "type": "object", "x-expandableFields": [ "pdf" ] }, "invoices_resource_invoice_tax_id": { "description": "", "properties": { "type": { "description": "The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `al_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, `aw_tin`, `az_tin`, `bd_bin`, `bj_ifu`, `et_tin`, `kg_tin`, `la_tin`, `cm_niu`, `cv_nif`, `bf_ifu`, or `unknown`", "enum": [ "ad_nrt", "ae_trn", "al_tin", "am_tin", "ao_tin", "ar_cuit", "au_abn", "au_arn", "aw_tin", "az_tin", "ba_tin", "bb_tin", "bd_bin", "bf_ifu", "bg_uic", "bh_vat", "bj_ifu", "bo_tin", "br_cnpj", "br_cpf", "bs_tin", "by_tin", "ca_bn", "ca_gst_hst", "ca_pst_bc", "ca_pst_mb", "ca_pst_sk", "ca_qst", "cd_nif", "ch_uid", "ch_vat", "cl_tin", "cm_niu", "cn_tin", "co_nit", "cr_tin", "cv_nif", "de_stn", "do_rcn", "ec_ruc", "eg_tin", "es_cif", "et_tin", "eu_oss_vat", "eu_vat", "gb_vat", "ge_vat", "gn_nif", "hk_br", "hr_oib", "hu_tin", "id_npwp", "il_vat", "in_gst", "is_vat", "jp_cn", "jp_rn", "jp_trn", "ke_pin", "kg_tin", "kh_tin", "kr_brn", "kz_bin", "la_tin", "li_uid", "li_vat", "ma_vat", "md_vat", "me_pib", "mk_vat", "mr_nif", "mx_rfc", "my_frp", "my_itn", "my_sst", "ng_tin", "no_vat", "no_voec", "np_pan", "nz_gst", "om_vat", "pe_ruc", "ph_tin", "ro_tin", "rs_pib", "ru_inn", "ru_kpp", "sa_vat", "sg_gst", "sg_uen", "si_tin", "sn_ninea", "sr_fin", "sv_nit", "th_vat", "tj_tin", "tr_tin", "tw_vat", "tz_vat", "ua_vat", "ug_tin", "unknown", "us_ein", "uy_ruc", "uz_tin", "uz_vat", "ve_rif", "vn_tin", "za_vat", "zm_tin", "zw_tin" ], "type": "string" }, "value": { "description": "The value of the tax ID.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "type" ], "title": "InvoicesResourceInvoiceTaxID", "type": "object", "x-expandableFields": [] }, "invoices_resource_pretax_credit_amount": { "description": "", "properties": { "amount": { "description": "The amount, in cents (or local equivalent), of the pretax credit amount.", "type": "integer" }, "credit_balance_transaction": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/billing.credit_balance_transaction" } ], "description": "The credit balance transaction that was applied to get this pretax credit amount.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/billing.credit_balance_transaction" } ] } }, "discount": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/discount" }, { "$ref": "#/components/schemas/deleted_discount" } ], "description": "The discount that was applied to get this pretax credit amount.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/discount" }, { "$ref": "#/components/schemas/deleted_discount" } ] } }, "type": { "description": "Type of the pretax credit amount referenced.", "enum": [ "credit_balance_transaction", "discount" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "amount", "type" ], "title": "InvoicesResourcePretaxCreditAmount", "type": "object", "x-expandableFields": [ "credit_balance_transaction", "discount" ] }, "invoices_resource_shipping_cost": { "description": "", "properties": { "amount_subtotal": { "description": "Total shipping cost before any taxes are applied.", "type": "integer" }, "amount_tax": { "description": "Total tax amount applied due to shipping costs. If no tax was applied, defaults to 0.", "type": "integer" }, "amount_total": { "description": "Total shipping cost after taxes are applied.", "type": "integer" }, "shipping_rate": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/shipping_rate" } ], "description": "The ID of the ShippingRate for this invoice.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/shipping_rate" } ] } }, "taxes": { "description": "The taxes applied to the shipping rate.", "items": { "$ref": "#/components/schemas/line_items_tax_amount" }, "type": "array" } }, "required": [ "amount_subtotal", "amount_tax", "amount_total" ], "title": "InvoicesResourceShippingCost", "type": "object", "x-expandableFields": [ "shipping_rate", "taxes" ] }, "invoices_resource_status_transitions": { "description": "", "properties": { "finalized_at": { "description": "The time that the invoice draft was finalized.", "format": "unix-time", "nullable": true, "type": "integer" }, "marked_uncollectible_at": { "description": "The time that the invoice was marked uncollectible.", "format": "unix-time", "nullable": true, "type": "integer" }, "paid_at": { "description": "The time that the invoice was paid.", "format": "unix-time", "nullable": true, "type": "integer" }, "voided_at": { "description": "The time that the invoice was voided.", "format": "unix-time", "nullable": true, "type": "integer" } }, "title": "InvoicesResourceStatusTransitions", "type": "object", "x-expandableFields": [] }, "issuing.authorization": { "description": "When an [issued card](https://stripe.com/docs/issuing) is used to make a purchase, an Issuing `Authorization`\nobject is created. [Authorizations](https://stripe.com/docs/issuing/purchases/authorizations) must be approved for the\npurchase to be completed successfully.\n\nRelated guide: [Issued card authorizations](https://stripe.com/docs/issuing/purchases/authorizations)", "properties": { "amount": { "description": "The total amount that was authorized or rejected. This amount is in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). `amount` should be the same as `merchant_amount`, unless `currency` and `merchant_currency` are different.", "type": "integer" }, "amount_details": { "anyOf": [ { "$ref": "#/components/schemas/issuing_authorization_amount_details" } ], "description": "Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", "nullable": true }, "approved": { "description": "Whether the authorization has been approved.", "type": "boolean" }, "authorization_method": { "description": "How the card details were provided.", "enum": [ "chip", "contactless", "keyed_in", "online", "swipe" ], "type": "string" }, "balance_transactions": { "description": "List of balance transactions associated with this authorization.", "items": { "$ref": "#/components/schemas/balance_transaction" }, "type": "array" }, "card": { "$ref": "#/components/schemas/issuing.card" }, "cardholder": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/issuing.cardholder" } ], "description": "The cardholder to whom this authorization belongs.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/issuing.cardholder" } ] } }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "currency": { "description": "The currency of the cardholder. This currency can be different from the currency presented at authorization and the `merchant_currency` field on this authorization. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "fleet": { "anyOf": [ { "$ref": "#/components/schemas/issuing_authorization_fleet_data" } ], "description": "Fleet-specific information for authorizations using Fleet cards.", "nullable": true }, "fraud_challenges": { "description": "Fraud challenges sent to the cardholder, if this authorization was declined for fraud risk reasons.", "items": { "$ref": "#/components/schemas/issuing_authorization_fraud_challenge" }, "nullable": true, "type": "array" }, "fuel": { "anyOf": [ { "$ref": "#/components/schemas/issuing_authorization_fuel_data" } ], "description": "Information about fuel that was purchased with this transaction. Typically this information is received from the merchant after the authorization has been approved and the fuel dispensed.", "nullable": true }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "merchant_amount": { "description": "The total amount that was authorized or rejected. This amount is in the `merchant_currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). `merchant_amount` should be the same as `amount`, unless `merchant_currency` and `currency` are different.", "type": "integer" }, "merchant_currency": { "description": "The local currency that was presented to the cardholder for the authorization. This currency can be different from the cardholder currency and the `currency` field on this authorization. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "merchant_data": { "$ref": "#/components/schemas/issuing_authorization_merchant_data" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "type": "object" }, "network_data": { "anyOf": [ { "$ref": "#/components/schemas/issuing_authorization_network_data" } ], "description": "Details about the authorization, such as identifiers, set by the card network.", "nullable": true }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "issuing.authorization" ], "type": "string" }, "pending_request": { "anyOf": [ { "$ref": "#/components/schemas/issuing_authorization_pending_request" } ], "description": "The pending authorization request. This field will only be non-null during an `issuing_authorization.request` webhook.", "nullable": true }, "request_history": { "description": "History of every time a `pending_request` authorization was approved/declined, either by you directly or by Stripe (e.g. based on your spending_controls). If the merchant changes the authorization by performing an incremental authorization, you can look at this field to see the previous requests for the authorization. This field can be helpful in determining why a given authorization was approved/declined.", "items": { "$ref": "#/components/schemas/issuing_authorization_request" }, "type": "array" }, "status": { "description": "The current status of the authorization in its lifecycle.", "enum": [ "closed", "expired", "pending", "reversed" ], "type": "string" }, "token": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/issuing.token" } ], "description": "[Token](https://stripe.com/docs/api/issuing/tokens/object) object used for this authorization. If a network token was not used for this authorization, this field will be null.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/issuing.token" } ] } }, "transactions": { "description": "List of [transactions](https://stripe.com/docs/api/issuing/transactions) associated with this authorization.", "items": { "$ref": "#/components/schemas/issuing.transaction" }, "type": "array" }, "treasury": { "anyOf": [ { "$ref": "#/components/schemas/issuing_authorization_treasury" } ], "description": "[Treasury](https://stripe.com/docs/api/treasury) details related to this authorization if it was created on a [FinancialAccount](https://stripe.com/docs/api/treasury/financial_accounts).", "nullable": true }, "verification_data": { "$ref": "#/components/schemas/issuing_authorization_verification_data" }, "verified_by_fraud_challenge": { "description": "Whether the authorization bypassed fraud risk checks because the cardholder has previously completed a fraud challenge on a similar high-risk authorization from the same merchant.", "nullable": true, "type": "boolean" }, "wallet": { "description": "The digital wallet used for this transaction. One of `apple_pay`, `google_pay`, or `samsung_pay`. Will populate as `null` when no digital wallet was utilized.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "amount", "approved", "authorization_method", "balance_transactions", "card", "created", "currency", "id", "livemode", "merchant_amount", "merchant_currency", "merchant_data", "metadata", "object", "request_history", "status", "transactions", "verification_data" ], "title": "IssuingAuthorization", "type": "object", "x-expandableFields": [ "amount_details", "balance_transactions", "card", "cardholder", "fleet", "fraud_challenges", "fuel", "merchant_data", "network_data", "pending_request", "request_history", "token", "transactions", "treasury", "verification_data" ], "x-resourceId": "issuing.authorization" }, "issuing.card": { "description": "You can [create physical or virtual cards](https://stripe.com/docs/issuing) that are issued to cardholders.", "properties": { "brand": { "description": "The brand of the card.", "maxLength": 5000, "type": "string" }, "cancellation_reason": { "description": "The reason why the card was canceled.", "enum": [ "design_rejected", "lost", "stolen" ], "nullable": true, "type": "string", "x-stripeBypassValidation": true }, "cardholder": { "$ref": "#/components/schemas/issuing.cardholder" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Supported currencies are `usd` in the US, `eur` in the EU, and `gbp` in the UK.", "format": "currency", "type": "string" }, "cvc": { "description": "The card's CVC. For security reasons, this is only available for virtual cards, and will be omitted unless you explicitly request it with [the `expand` parameter](https://stripe.com/docs/api/expanding_objects). Additionally, it's only available via the [\"Retrieve a card\" endpoint](https://stripe.com/docs/api/issuing/cards/retrieve), not via \"List all cards\" or any other endpoint.", "maxLength": 5000, "type": "string" }, "exp_month": { "description": "The expiration month of the card.", "type": "integer" }, "exp_year": { "description": "The expiration year of the card.", "type": "integer" }, "financial_account": { "description": "The financial account this card is attached to.", "maxLength": 5000, "nullable": true, "type": "string" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "last4": { "description": "The last 4 digits of the card number.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "type": "object" }, "number": { "description": "The full unredacted card number. For security reasons, this is only available for virtual cards, and will be omitted unless you explicitly request it with [the `expand` parameter](https://stripe.com/docs/api/expanding_objects). Additionally, it's only available via the [\"Retrieve a card\" endpoint](https://stripe.com/docs/api/issuing/cards/retrieve), not via \"List all cards\" or any other endpoint.", "maxLength": 5000, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "issuing.card" ], "type": "string" }, "personalization_design": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/issuing.personalization_design" } ], "description": "The personalization design object belonging to this card.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/issuing.personalization_design" } ] } }, "replaced_by": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/issuing.card" } ], "description": "The latest card that replaces this card, if any.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/issuing.card" } ] } }, "replacement_for": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/issuing.card" } ], "description": "The card this card replaces, if any.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/issuing.card" } ] } }, "replacement_reason": { "description": "The reason why the previous card needed to be replaced.", "enum": [ "damaged", "expired", "lost", "stolen" ], "nullable": true, "type": "string", "x-stripeBypassValidation": true }, "shipping": { "anyOf": [ { "$ref": "#/components/schemas/issuing_card_shipping" } ], "description": "Where and how the card will be shipped.", "nullable": true }, "spending_controls": { "$ref": "#/components/schemas/issuing_card_authorization_controls" }, "status": { "description": "Whether authorizations can be approved on this card. May be blocked from activating cards depending on past-due Cardholder requirements. Defaults to `inactive`.", "enum": [ "active", "canceled", "inactive" ], "type": "string", "x-stripeBypassValidation": true }, "type": { "description": "The type of the card.", "enum": [ "physical", "virtual" ], "type": "string" }, "wallets": { "anyOf": [ { "$ref": "#/components/schemas/issuing_card_wallets" } ], "description": "Information relating to digital wallets (like Apple Pay and Google Pay).", "nullable": true } }, "required": [ "brand", "cardholder", "created", "currency", "exp_month", "exp_year", "id", "last4", "livemode", "metadata", "object", "spending_controls", "status", "type" ], "title": "IssuingCard", "type": "object", "x-expandableFields": [ "cardholder", "personalization_design", "replaced_by", "replacement_for", "shipping", "spending_controls", "wallets" ], "x-resourceId": "issuing.card" }, "issuing.cardholder": { "description": "An Issuing `Cardholder` object represents an individual or business entity who is [issued](https://stripe.com/docs/issuing) cards.\n\nRelated guide: [How to create a cardholder](https://stripe.com/docs/issuing/cards/virtual/issue-cards#create-cardholder)", "properties": { "billing": { "$ref": "#/components/schemas/issuing_cardholder_address" }, "company": { "anyOf": [ { "$ref": "#/components/schemas/issuing_cardholder_company" } ], "description": "Additional information about a `company` cardholder.", "nullable": true }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "email": { "description": "The cardholder's email address.", "maxLength": 5000, "nullable": true, "type": "string" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "individual": { "anyOf": [ { "$ref": "#/components/schemas/issuing_cardholder_individual" } ], "description": "Additional information about an `individual` cardholder.", "nullable": true }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "type": "object" }, "name": { "description": "The cardholder's name. This will be printed on cards issued to them.", "maxLength": 5000, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "issuing.cardholder" ], "type": "string" }, "phone_number": { "description": "The cardholder's phone number. This is required for all cardholders who will be creating EU cards. See the [3D Secure documentation](https://stripe.com/docs/issuing/3d-secure#when-is-3d-secure-applied) for more details.", "maxLength": 5000, "nullable": true, "type": "string" }, "preferred_locales": { "description": "The cardholder’s preferred locales (languages), ordered by preference. Locales can be `de`, `en`, `es`, `fr`, or `it`.\n This changes the language of the [3D Secure flow](https://stripe.com/docs/issuing/3d-secure) and one-time password messages sent to the cardholder.", "items": { "enum": [ "de", "en", "es", "fr", "it" ], "type": "string" }, "nullable": true, "type": "array" }, "requirements": { "$ref": "#/components/schemas/issuing_cardholder_requirements" }, "spending_controls": { "anyOf": [ { "$ref": "#/components/schemas/issuing_cardholder_authorization_controls" } ], "description": "Rules that control spending across this cardholder's cards. Refer to our [documentation](https://stripe.com/docs/issuing/controls/spending-controls) for more details.", "nullable": true }, "status": { "description": "Specifies whether to permit authorizations on this cardholder's cards.", "enum": [ "active", "blocked", "inactive" ], "type": "string" }, "type": { "description": "One of `individual` or `company`. See [Choose a cardholder type](https://stripe.com/docs/issuing/other/choose-cardholder) for more details.", "enum": [ "company", "individual" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "billing", "created", "id", "livemode", "metadata", "name", "object", "requirements", "status", "type" ], "title": "IssuingCardholder", "type": "object", "x-expandableFields": [ "billing", "company", "individual", "requirements", "spending_controls" ], "x-resourceId": "issuing.cardholder" }, "issuing.dispute": { "description": "As a [card issuer](https://stripe.com/docs/issuing), you can dispute transactions that the cardholder does not recognize, suspects to be fraudulent, or has other issues with.\n\nRelated guide: [Issuing disputes](https://stripe.com/docs/issuing/purchases/disputes)", "properties": { "amount": { "description": "Disputed amount in the card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Usually the amount of the `transaction`, but can differ (usually because of currency fluctuation).", "type": "integer" }, "balance_transactions": { "description": "List of balance transactions associated with the dispute.", "items": { "$ref": "#/components/schemas/balance_transaction" }, "nullable": true, "type": "array" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "currency": { "description": "The currency the `transaction` was made in.", "format": "currency", "type": "string" }, "evidence": { "$ref": "#/components/schemas/issuing_dispute_evidence" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "loss_reason": { "description": "The enum that describes the dispute loss outcome. If the dispute is not lost, this field will be absent. New enum values may be added in the future, so be sure to handle unknown values.", "enum": [ "cardholder_authentication_issuer_liability", "eci5_token_transaction_with_tavv", "excess_disputes_in_timeframe", "has_not_met_the_minimum_dispute_amount_requirements", "invalid_duplicate_dispute", "invalid_incorrect_amount_dispute", "invalid_no_authorization", "invalid_use_of_disputes", "merchandise_delivered_or_shipped", "merchandise_or_service_as_described", "not_cancelled", "other", "refund_issued", "submitted_beyond_allowable_time_limit", "transaction_3ds_required", "transaction_approved_after_prior_fraud_dispute", "transaction_authorized", "transaction_electronically_read", "transaction_qualifies_for_visa_easy_payment_service", "transaction_unattended" ], "type": "string" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "type": "object" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "issuing.dispute" ], "type": "string" }, "status": { "description": "Current status of the dispute.", "enum": [ "expired", "lost", "submitted", "unsubmitted", "won" ], "type": "string" }, "transaction": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/issuing.transaction" } ], "description": "The transaction being disputed.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/issuing.transaction" } ] } }, "treasury": { "anyOf": [ { "$ref": "#/components/schemas/issuing_dispute_treasury" } ], "description": "[Treasury](https://stripe.com/docs/api/treasury) details related to this dispute if it was created on a [FinancialAccount](/docs/api/treasury/financial_accounts", "nullable": true } }, "required": [ "amount", "created", "currency", "evidence", "id", "livemode", "metadata", "object", "status", "transaction" ], "title": "IssuingDispute", "type": "object", "x-expandableFields": [ "balance_transactions", "evidence", "transaction", "treasury" ], "x-resourceId": "issuing.dispute" }, "issuing.personalization_design": { "description": "A Personalization Design is a logical grouping of a Physical Bundle, card logo, and carrier text that represents a product line.", "properties": { "card_logo": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/file" } ], "description": "The file for the card logo to use with physical bundles that support card logos. Must have a `purpose` value of `issuing_logo`.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/file" } ] } }, "carrier_text": { "anyOf": [ { "$ref": "#/components/schemas/issuing_personalization_design_carrier_text" } ], "description": "Hash containing carrier text, for use with physical bundles that support carrier text.", "nullable": true }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "lookup_key": { "description": "A lookup key used to retrieve personalization designs dynamically from a static string. This may be up to 200 characters.", "maxLength": 5000, "nullable": true, "type": "string" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "type": "object" }, "name": { "description": "Friendly display name.", "maxLength": 5000, "nullable": true, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "issuing.personalization_design" ], "type": "string" }, "physical_bundle": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/issuing.physical_bundle" } ], "description": "The physical bundle object belonging to this personalization design.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/issuing.physical_bundle" } ] } }, "preferences": { "$ref": "#/components/schemas/issuing_personalization_design_preferences" }, "rejection_reasons": { "$ref": "#/components/schemas/issuing_personalization_design_rejection_reasons" }, "status": { "description": "Whether this personalization design can be used to create cards.", "enum": [ "active", "inactive", "rejected", "review" ], "type": "string" } }, "required": [ "created", "id", "livemode", "metadata", "object", "physical_bundle", "preferences", "rejection_reasons", "status" ], "title": "IssuingPersonalizationDesign", "type": "object", "x-expandableFields": [ "card_logo", "carrier_text", "physical_bundle", "preferences", "rejection_reasons" ], "x-resourceId": "issuing.personalization_design" }, "issuing.physical_bundle": { "description": "A Physical Bundle represents the bundle of physical items - card stock, carrier letter, and envelope - that is shipped to a cardholder when you create a physical card.", "properties": { "features": { "$ref": "#/components/schemas/issuing_physical_bundle_features" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "name": { "description": "Friendly display name.", "maxLength": 5000, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "issuing.physical_bundle" ], "type": "string" }, "status": { "description": "Whether this physical bundle can be used to create cards.", "enum": [ "active", "inactive", "review" ], "type": "string" }, "type": { "description": "Whether this physical bundle is a standard Stripe offering or custom-made for you.", "enum": [ "custom", "standard" ], "type": "string" } }, "required": [ "features", "id", "livemode", "name", "object", "status", "type" ], "title": "IssuingPhysicalBundle", "type": "object", "x-expandableFields": [ "features" ], "x-resourceId": "issuing.physical_bundle" }, "issuing.settlement": { "description": "When a non-stripe BIN is used, any use of an [issued card](https://stripe.com/docs/issuing) must be settled directly with the card network. The net amount owed is represented by an Issuing `Settlement` object.", "properties": { "bin": { "description": "The Bank Identification Number reflecting this settlement record.", "maxLength": 5000, "type": "string" }, "clearing_date": { "description": "The date that the transactions are cleared and posted to user's accounts.", "format": "unix-time", "type": "integer" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "interchange_fees_amount": { "description": "The total interchange received as reimbursement for the transactions.", "type": "integer" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "type": "object" }, "net_total_amount": { "description": "The total net amount required to settle with the network.", "type": "integer" }, "network": { "description": "The card network for this settlement report. One of [\"visa\", \"maestro\"]", "enum": [ "maestro", "visa" ], "type": "string" }, "network_fees_amount": { "description": "The total amount of fees owed to the network.", "type": "integer" }, "network_settlement_identifier": { "description": "The Settlement Identification Number assigned by the network.", "maxLength": 5000, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "issuing.settlement" ], "type": "string" }, "settlement_service": { "description": "One of `international` or `uk_national_net`.", "maxLength": 5000, "type": "string" }, "status": { "description": "The current processing status of this settlement.", "enum": [ "complete", "pending" ], "type": "string" }, "transaction_amount": { "description": "The total transaction amount reflected in this settlement.", "type": "integer" }, "transaction_count": { "description": "The total number of transactions reflected in this settlement.", "type": "integer" } }, "required": [ "bin", "clearing_date", "created", "currency", "id", "interchange_fees_amount", "livemode", "metadata", "net_total_amount", "network", "network_fees_amount", "network_settlement_identifier", "object", "settlement_service", "status", "transaction_amount", "transaction_count" ], "title": "IssuingSettlement", "type": "object", "x-expandableFields": [], "x-resourceId": "issuing.settlement" }, "issuing.token": { "description": "An issuing token object is created when an issued card is added to a digital wallet. As a [card issuer](https://stripe.com/docs/issuing), you can [view and manage these tokens](https://stripe.com/docs/issuing/controls/token-management) through Stripe.", "properties": { "card": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/issuing.card" } ], "description": "Card associated with this token.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/issuing.card" } ] } }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "device_fingerprint": { "description": "The hashed ID derived from the device ID from the card network associated with the token.", "maxLength": 5000, "nullable": true, "type": "string" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "last4": { "description": "The last four digits of the token.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "network": { "description": "The token service provider / card network associated with the token.", "enum": [ "mastercard", "visa" ], "type": "string" }, "network_data": { "$ref": "#/components/schemas/issuing_network_token_network_data" }, "network_updated_at": { "description": "Time at which the token was last updated by the card network. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "issuing.token" ], "type": "string" }, "status": { "description": "The usage state of the token.", "enum": [ "active", "deleted", "requested", "suspended" ], "type": "string" }, "wallet_provider": { "description": "The digital wallet for this token, if one was used.", "enum": [ "apple_pay", "google_pay", "samsung_pay" ], "type": "string" } }, "required": [ "card", "created", "id", "livemode", "network", "network_updated_at", "object", "status" ], "title": "IssuingNetworkToken", "type": "object", "x-expandableFields": [ "card", "network_data" ], "x-resourceId": "issuing.token" }, "issuing.transaction": { "description": "Any use of an [issued card](https://stripe.com/docs/issuing) that results in funds entering or leaving\nyour Stripe account, such as a completed purchase or refund, is represented by an Issuing\n`Transaction` object.\n\nRelated guide: [Issued card transactions](https://stripe.com/docs/issuing/purchases/transactions)", "properties": { "amount": { "description": "The transaction amount, which will be reflected in your balance. This amount is in your currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", "type": "integer" }, "amount_details": { "anyOf": [ { "$ref": "#/components/schemas/issuing_transaction_amount_details" } ], "description": "Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", "nullable": true }, "authorization": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/issuing.authorization" } ], "description": "The `Authorization` object that led to this transaction.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/issuing.authorization" } ] } }, "balance_transaction": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/balance_transaction" } ], "description": "ID of the [balance transaction](https://stripe.com/docs/api/balance_transactions) associated with this transaction.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/balance_transaction" } ] } }, "card": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/issuing.card" } ], "description": "The card used to make this transaction.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/issuing.card" } ] } }, "cardholder": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/issuing.cardholder" } ], "description": "The cardholder to whom this transaction belongs.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/issuing.cardholder" } ] } }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "dispute": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/issuing.dispute" } ], "description": "If you've disputed the transaction, the ID of the dispute.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/issuing.dispute" } ] } }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "merchant_amount": { "description": "The amount that the merchant will receive, denominated in `merchant_currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). It will be different from `amount` if the merchant is taking payment in a different currency.", "type": "integer" }, "merchant_currency": { "description": "The currency with which the merchant is taking payment.", "format": "currency", "type": "string" }, "merchant_data": { "$ref": "#/components/schemas/issuing_authorization_merchant_data" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "type": "object" }, "network_data": { "anyOf": [ { "$ref": "#/components/schemas/issuing_transaction_network_data" } ], "description": "Details about the transaction, such as processing dates, set by the card network.", "nullable": true }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "issuing.transaction" ], "type": "string" }, "purchase_details": { "anyOf": [ { "$ref": "#/components/schemas/issuing_transaction_purchase_details" } ], "description": "Additional purchase information that is optionally provided by the merchant.", "nullable": true }, "token": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/issuing.token" } ], "description": "[Token](https://stripe.com/docs/api/issuing/tokens/object) object used for this transaction. If a network token was not used for this transaction, this field will be null.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/issuing.token" } ] } }, "treasury": { "anyOf": [ { "$ref": "#/components/schemas/issuing_transaction_treasury" } ], "description": "[Treasury](https://stripe.com/docs/api/treasury) details related to this transaction if it was created on a [FinancialAccount](/docs/api/treasury/financial_accounts", "nullable": true }, "type": { "description": "The nature of the transaction.", "enum": [ "capture", "refund" ], "type": "string", "x-stripeBypassValidation": true }, "wallet": { "description": "The digital wallet used for this transaction. One of `apple_pay`, `google_pay`, or `samsung_pay`.", "enum": [ "apple_pay", "google_pay", "samsung_pay" ], "nullable": true, "type": "string" } }, "required": [ "amount", "card", "created", "currency", "id", "livemode", "merchant_amount", "merchant_currency", "merchant_data", "metadata", "object", "type" ], "title": "IssuingTransaction", "type": "object", "x-expandableFields": [ "amount_details", "authorization", "balance_transaction", "card", "cardholder", "dispute", "merchant_data", "network_data", "purchase_details", "token", "treasury" ], "x-resourceId": "issuing.transaction" }, "issuing_authorization_amount_details": { "description": "", "properties": { "atm_fee": { "description": "The fee charged by the ATM for the cash withdrawal.", "nullable": true, "type": "integer" }, "cashback_amount": { "description": "The amount of cash requested by the cardholder.", "nullable": true, "type": "integer" } }, "title": "IssuingAuthorizationAmountDetails", "type": "object", "x-expandableFields": [] }, "issuing_authorization_authentication_exemption": { "description": "", "properties": { "claimed_by": { "description": "The entity that requested the exemption, either the acquiring merchant or the Issuing user.", "enum": [ "acquirer", "issuer" ], "type": "string" }, "type": { "description": "The specific exemption claimed for this authorization.", "enum": [ "low_value_transaction", "transaction_risk_analysis", "unknown" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "claimed_by", "type" ], "title": "IssuingAuthorizationAuthenticationExemption", "type": "object", "x-expandableFields": [] }, "issuing_authorization_fleet_cardholder_prompt_data": { "description": "", "properties": { "alphanumeric_id": { "description": "[Deprecated] An alphanumeric ID, though typical point of sales only support numeric entry. The card program can be configured to prompt for a vehicle ID, driver ID, or generic ID.", "maxLength": 5000, "nullable": true, "type": "string" }, "driver_id": { "description": "Driver ID.", "maxLength": 5000, "nullable": true, "type": "string" }, "odometer": { "description": "Odometer reading.", "nullable": true, "type": "integer" }, "unspecified_id": { "description": "An alphanumeric ID. This field is used when a vehicle ID, driver ID, or generic ID is entered by the cardholder, but the merchant or card network did not specify the prompt type.", "maxLength": 5000, "nullable": true, "type": "string" }, "user_id": { "description": "User ID.", "maxLength": 5000, "nullable": true, "type": "string" }, "vehicle_number": { "description": "Vehicle number.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "IssuingAuthorizationFleetCardholderPromptData", "type": "object", "x-expandableFields": [] }, "issuing_authorization_fleet_data": { "description": "", "properties": { "cardholder_prompt_data": { "anyOf": [ { "$ref": "#/components/schemas/issuing_authorization_fleet_cardholder_prompt_data" } ], "description": "Answers to prompts presented to the cardholder at the point of sale. Prompted fields vary depending on the configuration of your physical fleet cards. Typical points of sale support only numeric entry.", "nullable": true }, "purchase_type": { "description": "The type of purchase.", "enum": [ "fuel_and_non_fuel_purchase", "fuel_purchase", "non_fuel_purchase" ], "nullable": true, "type": "string" }, "reported_breakdown": { "anyOf": [ { "$ref": "#/components/schemas/issuing_authorization_fleet_reported_breakdown" } ], "description": "More information about the total amount. Typically this information is received from the merchant after the authorization has been approved and the fuel dispensed. This information is not guaranteed to be accurate as some merchants may provide unreliable data.", "nullable": true }, "service_type": { "description": "The type of fuel service.", "enum": [ "full_service", "non_fuel_transaction", "self_service" ], "nullable": true, "type": "string" } }, "title": "IssuingAuthorizationFleetData", "type": "object", "x-expandableFields": [ "cardholder_prompt_data", "reported_breakdown" ] }, "issuing_authorization_fleet_fuel_price_data": { "description": "", "properties": { "gross_amount_decimal": { "description": "Gross fuel amount that should equal Fuel Quantity multiplied by Fuel Unit Cost, inclusive of taxes.", "format": "decimal", "nullable": true, "type": "string" } }, "title": "IssuingAuthorizationFleetFuelPriceData", "type": "object", "x-expandableFields": [] }, "issuing_authorization_fleet_non_fuel_price_data": { "description": "", "properties": { "gross_amount_decimal": { "description": "Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes.", "format": "decimal", "nullable": true, "type": "string" } }, "title": "IssuingAuthorizationFleetNonFuelPriceData", "type": "object", "x-expandableFields": [] }, "issuing_authorization_fleet_reported_breakdown": { "description": "", "properties": { "fuel": { "anyOf": [ { "$ref": "#/components/schemas/issuing_authorization_fleet_fuel_price_data" } ], "description": "Breakdown of fuel portion of the purchase.", "nullable": true }, "non_fuel": { "anyOf": [ { "$ref": "#/components/schemas/issuing_authorization_fleet_non_fuel_price_data" } ], "description": "Breakdown of non-fuel portion of the purchase.", "nullable": true }, "tax": { "anyOf": [ { "$ref": "#/components/schemas/issuing_authorization_fleet_tax_data" } ], "description": "Information about tax included in this transaction.", "nullable": true } }, "title": "IssuingAuthorizationFleetReportedBreakdown", "type": "object", "x-expandableFields": [ "fuel", "non_fuel", "tax" ] }, "issuing_authorization_fleet_tax_data": { "description": "", "properties": { "local_amount_decimal": { "description": "Amount of state or provincial Sales Tax included in the transaction amount. `null` if not reported by merchant or not subject to tax.", "format": "decimal", "nullable": true, "type": "string" }, "national_amount_decimal": { "description": "Amount of national Sales Tax or VAT included in the transaction amount. `null` if not reported by merchant or not subject to tax.", "format": "decimal", "nullable": true, "type": "string" } }, "title": "IssuingAuthorizationFleetTaxData", "type": "object", "x-expandableFields": [] }, "issuing_authorization_fraud_challenge": { "description": "", "properties": { "channel": { "description": "The method by which the fraud challenge was delivered to the cardholder.", "enum": [ "sms" ], "type": "string" }, "status": { "description": "The status of the fraud challenge.", "enum": [ "expired", "pending", "rejected", "undeliverable", "verified" ], "type": "string" }, "undeliverable_reason": { "description": "If the challenge is not deliverable, the reason why.", "enum": [ "no_phone_number", "unsupported_phone_number" ], "nullable": true, "type": "string" } }, "required": [ "channel", "status" ], "title": "IssuingAuthorizationFraudChallenge", "type": "object", "x-expandableFields": [] }, "issuing_authorization_fuel_data": { "description": "", "properties": { "industry_product_code": { "description": "[Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased.", "maxLength": 5000, "nullable": true, "type": "string" }, "quantity_decimal": { "description": "The quantity of `unit`s of fuel that was dispensed, represented as a decimal string with at most 12 decimal places.", "format": "decimal", "nullable": true, "type": "string" }, "type": { "description": "The type of fuel that was purchased.", "enum": [ "diesel", "other", "unleaded_plus", "unleaded_regular", "unleaded_super" ], "nullable": true, "type": "string" }, "unit": { "description": "The units for `quantity_decimal`.", "enum": [ "charging_minute", "imperial_gallon", "kilogram", "kilowatt_hour", "liter", "other", "pound", "us_gallon" ], "nullable": true, "type": "string" }, "unit_cost_decimal": { "description": "The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places.", "format": "decimal", "nullable": true, "type": "string" } }, "title": "IssuingAuthorizationFuelData", "type": "object", "x-expandableFields": [] }, "issuing_authorization_merchant_data": { "description": "", "properties": { "category": { "description": "A categorization of the seller's type of business. See our [merchant categories guide](https://stripe.com/docs/issuing/merchant-categories) for a list of possible values.", "maxLength": 5000, "type": "string" }, "category_code": { "description": "The merchant category code for the seller’s business", "maxLength": 5000, "type": "string" }, "city": { "description": "City where the seller is located", "maxLength": 5000, "nullable": true, "type": "string" }, "country": { "description": "Country where the seller is located", "maxLength": 5000, "nullable": true, "type": "string" }, "name": { "description": "Name of the seller", "maxLength": 5000, "nullable": true, "type": "string" }, "network_id": { "description": "Identifier assigned to the seller by the card network. Different card networks may assign different network_id fields to the same merchant.", "maxLength": 5000, "type": "string" }, "postal_code": { "description": "Postal code where the seller is located", "maxLength": 5000, "nullable": true, "type": "string" }, "state": { "description": "State where the seller is located", "maxLength": 5000, "nullable": true, "type": "string" }, "tax_id": { "description": "The seller's tax identification number. Currently populated for French merchants only.", "maxLength": 5000, "nullable": true, "type": "string" }, "terminal_id": { "description": "An ID assigned by the seller to the location of the sale.", "maxLength": 5000, "nullable": true, "type": "string" }, "url": { "description": "URL provided by the merchant on a 3DS request", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "category", "category_code", "network_id" ], "title": "IssuingAuthorizationMerchantData", "type": "object", "x-expandableFields": [] }, "issuing_authorization_network_data": { "description": "", "properties": { "acquiring_institution_id": { "description": "Identifier assigned to the acquirer by the card network. Sometimes this value is not provided by the network; in this case, the value will be `null`.", "maxLength": 5000, "nullable": true, "type": "string" }, "system_trace_audit_number": { "description": "The System Trace Audit Number (STAN) is a 6-digit identifier assigned by the acquirer. Prefer `network_data.transaction_id` if present, unless you have special requirements.", "maxLength": 5000, "nullable": true, "type": "string" }, "transaction_id": { "description": "Unique identifier for the authorization assigned by the card network used to match subsequent messages, disputes, and transactions.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "IssuingAuthorizationNetworkData", "type": "object", "x-expandableFields": [] }, "issuing_authorization_pending_request": { "description": "", "properties": { "amount": { "description": "The additional amount Stripe will hold if the authorization is approved, in the card's [currency](https://stripe.com/docs/api#issuing_authorization_object-pending-request-currency) and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", "type": "integer" }, "amount_details": { "anyOf": [ { "$ref": "#/components/schemas/issuing_authorization_amount_details" } ], "description": "Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", "nullable": true }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "is_amount_controllable": { "description": "If set `true`, you may provide [amount](https://stripe.com/docs/api/issuing/authorizations/approve#approve_issuing_authorization-amount) to control how much to hold for the authorization.", "type": "boolean" }, "merchant_amount": { "description": "The amount the merchant is requesting to be authorized in the `merchant_currency`. The amount is in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", "type": "integer" }, "merchant_currency": { "description": "The local currency the merchant is requesting to authorize.", "format": "currency", "type": "string" }, "network_risk_score": { "description": "The card network's estimate of the likelihood that an authorization is fraudulent. Takes on values between 1 and 99.", "nullable": true, "type": "integer" } }, "required": [ "amount", "currency", "is_amount_controllable", "merchant_amount", "merchant_currency" ], "title": "IssuingAuthorizationPendingRequest", "type": "object", "x-expandableFields": [ "amount_details" ] }, "issuing_authorization_request": { "description": "", "properties": { "amount": { "description": "The `pending_request.amount` at the time of the request, presented in your card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Stripe held this amount from your account to fund the authorization if the request was approved.", "type": "integer" }, "amount_details": { "anyOf": [ { "$ref": "#/components/schemas/issuing_authorization_amount_details" } ], "description": "Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", "nullable": true }, "approved": { "description": "Whether this request was approved.", "type": "boolean" }, "authorization_code": { "description": "A code created by Stripe which is shared with the merchant to validate the authorization. This field will be populated if the authorization message was approved. The code typically starts with the letter \"S\", followed by a six-digit number. For example, \"S498162\". Please note that the code is not guaranteed to be unique across authorizations.", "maxLength": 5000, "nullable": true, "type": "string" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "maxLength": 5000, "type": "string" }, "merchant_amount": { "description": "The `pending_request.merchant_amount` at the time of the request, presented in the `merchant_currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", "type": "integer" }, "merchant_currency": { "description": "The currency that was collected by the merchant and presented to the cardholder for the authorization. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "maxLength": 5000, "type": "string" }, "network_risk_score": { "description": "The card network's estimate of the likelihood that an authorization is fraudulent. Takes on values between 1 and 99.", "nullable": true, "type": "integer" }, "reason": { "description": "When an authorization is approved or declined by you or by Stripe, this field provides additional detail on the reason for the outcome.", "enum": [ "account_disabled", "card_active", "card_canceled", "card_expired", "card_inactive", "cardholder_blocked", "cardholder_inactive", "cardholder_verification_required", "insecure_authorization_method", "insufficient_funds", "network_fallback", "not_allowed", "pin_blocked", "spending_controls", "suspected_fraud", "verification_failed", "webhook_approved", "webhook_declined", "webhook_error", "webhook_timeout" ], "type": "string", "x-stripeBypassValidation": true }, "reason_message": { "description": "If the `request_history.reason` is `webhook_error` because the direct webhook response is invalid (for example, parsing errors or missing parameters), we surface a more detailed error message via this field.", "maxLength": 5000, "nullable": true, "type": "string" }, "requested_at": { "description": "Time when the card network received an authorization request from the acquirer in UTC. Referred to by networks as transmission time.", "format": "unix-time", "nullable": true, "type": "integer" } }, "required": [ "amount", "approved", "created", "currency", "merchant_amount", "merchant_currency", "reason" ], "title": "IssuingAuthorizationRequest", "type": "object", "x-expandableFields": [ "amount_details" ] }, "issuing_authorization_three_d_secure": { "description": "", "properties": { "result": { "description": "The outcome of the 3D Secure authentication request.", "enum": [ "attempt_acknowledged", "authenticated", "failed", "required" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "result" ], "title": "IssuingAuthorizationThreeDSecure", "type": "object", "x-expandableFields": [] }, "issuing_authorization_treasury": { "description": "", "properties": { "received_credits": { "description": "The array of [ReceivedCredits](https://stripe.com/docs/api/treasury/received_credits) associated with this authorization", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "received_debits": { "description": "The array of [ReceivedDebits](https://stripe.com/docs/api/treasury/received_debits) associated with this authorization", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "transaction": { "description": "The Treasury [Transaction](https://stripe.com/docs/api/treasury/transactions) associated with this authorization", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "received_credits", "received_debits" ], "title": "IssuingAuthorizationTreasury", "type": "object", "x-expandableFields": [] }, "issuing_authorization_verification_data": { "description": "", "properties": { "address_line1_check": { "description": "Whether the cardholder provided an address first line and if it matched the cardholder’s `billing.address.line1`.", "enum": [ "match", "mismatch", "not_provided" ], "type": "string" }, "address_postal_code_check": { "description": "Whether the cardholder provided a postal code and if it matched the cardholder’s `billing.address.postal_code`.", "enum": [ "match", "mismatch", "not_provided" ], "type": "string" }, "authentication_exemption": { "anyOf": [ { "$ref": "#/components/schemas/issuing_authorization_authentication_exemption" } ], "description": "The exemption applied to this authorization.", "nullable": true }, "cvc_check": { "description": "Whether the cardholder provided a CVC and if it matched Stripe’s record.", "enum": [ "match", "mismatch", "not_provided" ], "type": "string" }, "expiry_check": { "description": "Whether the cardholder provided an expiry date and if it matched Stripe’s record.", "enum": [ "match", "mismatch", "not_provided" ], "type": "string" }, "postal_code": { "description": "The postal code submitted as part of the authorization used for postal code verification.", "maxLength": 5000, "nullable": true, "type": "string" }, "three_d_secure": { "anyOf": [ { "$ref": "#/components/schemas/issuing_authorization_three_d_secure" } ], "description": "3D Secure details.", "nullable": true } }, "required": [ "address_line1_check", "address_postal_code_check", "cvc_check", "expiry_check" ], "title": "IssuingAuthorizationVerificationData", "type": "object", "x-expandableFields": [ "authentication_exemption", "three_d_secure" ] }, "issuing_card_apple_pay": { "description": "", "properties": { "eligible": { "description": "Apple Pay Eligibility", "type": "boolean" }, "ineligible_reason": { "description": "Reason the card is ineligible for Apple Pay", "enum": [ "missing_agreement", "missing_cardholder_contact", "unsupported_region" ], "nullable": true, "type": "string" } }, "required": [ "eligible" ], "title": "IssuingCardApplePay", "type": "object", "x-expandableFields": [] }, "issuing_card_authorization_controls": { "description": "", "properties": { "allowed_categories": { "description": "Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to allow. All other categories will be blocked. Cannot be set with `blocked_categories`.", "items": { "enum": [ "ac_refrigeration_repair", "accounting_bookkeeping_services", "advertising_services", "agricultural_cooperative", "airlines_air_carriers", "airports_flying_fields", "ambulance_services", "amusement_parks_carnivals", "antique_reproductions", "antique_shops", "aquariums", "architectural_surveying_services", "art_dealers_and_galleries", "artists_supply_and_craft_shops", "auto_and_home_supply_stores", "auto_body_repair_shops", "auto_paint_shops", "auto_service_shops", "automated_cash_disburse", "automated_fuel_dispensers", "automobile_associations", "automotive_parts_and_accessories_stores", "automotive_tire_stores", "bail_and_bond_payments", "bakeries", "bands_orchestras", "barber_and_beauty_shops", "betting_casino_gambling", "bicycle_shops", "billiard_pool_establishments", "boat_dealers", "boat_rentals_and_leases", "book_stores", "books_periodicals_and_newspapers", "bowling_alleys", "bus_lines", "business_secretarial_schools", "buying_shopping_services", "cable_satellite_and_other_pay_television_and_radio", "camera_and_photographic_supply_stores", "candy_nut_and_confectionery_stores", "car_and_truck_dealers_new_used", "car_and_truck_dealers_used_only", "car_rental_agencies", "car_washes", "carpentry_services", "carpet_upholstery_cleaning", "caterers", "charitable_and_social_service_organizations_fundraising", "chemicals_and_allied_products", "child_care_services", "childrens_and_infants_wear_stores", "chiropodists_podiatrists", "chiropractors", "cigar_stores_and_stands", "civic_social_fraternal_associations", "cleaning_and_maintenance", "clothing_rental", "colleges_universities", "commercial_equipment", "commercial_footwear", "commercial_photography_art_and_graphics", "commuter_transport_and_ferries", "computer_network_services", "computer_programming", "computer_repair", "computer_software_stores", "computers_peripherals_and_software", "concrete_work_services", "construction_materials", "consulting_public_relations", "correspondence_schools", "cosmetic_stores", "counseling_services", "country_clubs", "courier_services", "court_costs", "credit_reporting_agencies", "cruise_lines", "dairy_products_stores", "dance_hall_studios_schools", "dating_escort_services", "dentists_orthodontists", "department_stores", "detective_agencies", "digital_goods_applications", "digital_goods_games", "digital_goods_large_volume", "digital_goods_media", "direct_marketing_catalog_merchant", "direct_marketing_combination_catalog_and_retail_merchant", "direct_marketing_inbound_telemarketing", "direct_marketing_insurance_services", "direct_marketing_other", "direct_marketing_outbound_telemarketing", "direct_marketing_subscription", "direct_marketing_travel", "discount_stores", "doctors", "door_to_door_sales", "drapery_window_covering_and_upholstery_stores", "drinking_places", "drug_stores_and_pharmacies", "drugs_drug_proprietaries_and_druggist_sundries", "dry_cleaners", "durable_goods", "duty_free_stores", "eating_places_restaurants", "educational_services", "electric_razor_stores", "electric_vehicle_charging", "electrical_parts_and_equipment", "electrical_services", "electronics_repair_shops", "electronics_stores", "elementary_secondary_schools", "emergency_services_gcas_visa_use_only", "employment_temp_agencies", "equipment_rental", "exterminating_services", "family_clothing_stores", "fast_food_restaurants", "financial_institutions", "fines_government_administrative_entities", "fireplace_fireplace_screens_and_accessories_stores", "floor_covering_stores", "florists", "florists_supplies_nursery_stock_and_flowers", "freezer_and_locker_meat_provisioners", "fuel_dealers_non_automotive", "funeral_services_crematories", "furniture_home_furnishings_and_equipment_stores_except_appliances", "furniture_repair_refinishing", "furriers_and_fur_shops", "general_services", "gift_card_novelty_and_souvenir_shops", "glass_paint_and_wallpaper_stores", "glassware_crystal_stores", "golf_courses_public", "government_licensed_horse_dog_racing_us_region_only", "government_licensed_online_casions_online_gambling_us_region_only", "government_owned_lotteries_non_us_region", "government_owned_lotteries_us_region_only", "government_services", "grocery_stores_supermarkets", "hardware_equipment_and_supplies", "hardware_stores", "health_and_beauty_spas", "hearing_aids_sales_and_supplies", "heating_plumbing_a_c", "hobby_toy_and_game_shops", "home_supply_warehouse_stores", "hospitals", "hotels_motels_and_resorts", "household_appliance_stores", "industrial_supplies", "information_retrieval_services", "insurance_default", "insurance_underwriting_premiums", "intra_company_purchases", "jewelry_stores_watches_clocks_and_silverware_stores", "landscaping_services", "laundries", "laundry_cleaning_services", "legal_services_attorneys", "luggage_and_leather_goods_stores", "lumber_building_materials_stores", "manual_cash_disburse", "marinas_service_and_supplies", "marketplaces", "masonry_stonework_and_plaster", "massage_parlors", "medical_and_dental_labs", "medical_dental_ophthalmic_and_hospital_equipment_and_supplies", "medical_services", "membership_organizations", "mens_and_boys_clothing_and_accessories_stores", "mens_womens_clothing_stores", "metal_service_centers", "miscellaneous", "miscellaneous_apparel_and_accessory_shops", "miscellaneous_auto_dealers", "miscellaneous_business_services", "miscellaneous_food_stores", "miscellaneous_general_merchandise", "miscellaneous_general_services", "miscellaneous_home_furnishing_specialty_stores", "miscellaneous_publishing_and_printing", "miscellaneous_recreation_services", "miscellaneous_repair_shops", "miscellaneous_specialty_retail", "mobile_home_dealers", "motion_picture_theaters", "motor_freight_carriers_and_trucking", "motor_homes_dealers", "motor_vehicle_supplies_and_new_parts", "motorcycle_shops_and_dealers", "motorcycle_shops_dealers", "music_stores_musical_instruments_pianos_and_sheet_music", "news_dealers_and_newsstands", "non_fi_money_orders", "non_fi_stored_value_card_purchase_load", "nondurable_goods", "nurseries_lawn_and_garden_supply_stores", "nursing_personal_care", "office_and_commercial_furniture", "opticians_eyeglasses", "optometrists_ophthalmologist", "orthopedic_goods_prosthetic_devices", "osteopaths", "package_stores_beer_wine_and_liquor", "paints_varnishes_and_supplies", "parking_lots_garages", "passenger_railways", "pawn_shops", "pet_shops_pet_food_and_supplies", "petroleum_and_petroleum_products", "photo_developing", "photographic_photocopy_microfilm_equipment_and_supplies", "photographic_studios", "picture_video_production", "piece_goods_notions_and_other_dry_goods", "plumbing_heating_equipment_and_supplies", "political_organizations", "postal_services_government_only", "precious_stones_and_metals_watches_and_jewelry", "professional_services", "public_warehousing_and_storage", "quick_copy_repro_and_blueprint", "railroads", "real_estate_agents_and_managers_rentals", "record_stores", "recreational_vehicle_rentals", "religious_goods_stores", "religious_organizations", "roofing_siding_sheet_metal", "secretarial_support_services", "security_brokers_dealers", "service_stations", "sewing_needlework_fabric_and_piece_goods_stores", "shoe_repair_hat_cleaning", "shoe_stores", "small_appliance_repair", "snowmobile_dealers", "special_trade_services", "specialty_cleaning", "sporting_goods_stores", "sporting_recreation_camps", "sports_and_riding_apparel_stores", "sports_clubs_fields", "stamp_and_coin_stores", "stationary_office_supplies_printing_and_writing_paper", "stationery_stores_office_and_school_supply_stores", "swimming_pools_sales", "t_ui_travel_germany", "tailors_alterations", "tax_payments_government_agencies", "tax_preparation_services", "taxicabs_limousines", "telecommunication_equipment_and_telephone_sales", "telecommunication_services", "telegraph_services", "tent_and_awning_shops", "testing_laboratories", "theatrical_ticket_agencies", "timeshares", "tire_retreading_and_repair", "tolls_bridge_fees", "tourist_attractions_and_exhibits", "towing_services", "trailer_parks_campgrounds", "transportation_services", "travel_agencies_tour_operators", "truck_stop_iteration", "truck_utility_trailer_rentals", "typesetting_plate_making_and_related_services", "typewriter_stores", "u_s_federal_government_agencies_or_departments", "uniforms_commercial_clothing", "used_merchandise_and_secondhand_stores", "utilities", "variety_stores", "veterinary_services", "video_amusement_game_supplies", "video_game_arcades", "video_tape_rental_stores", "vocational_trade_schools", "watch_jewelry_repair", "welding_repair", "wholesale_clubs", "wig_and_toupee_stores", "wires_money_orders", "womens_accessory_and_specialty_shops", "womens_ready_to_wear_stores", "wrecking_and_salvage_yards" ], "type": "string" }, "nullable": true, "type": "array" }, "allowed_merchant_countries": { "description": "Array of strings containing representing countries from which authorizations will be allowed. Authorizations from merchants in all other countries will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `blocked_merchant_countries`. Provide an empty value to unset this control.", "items": { "maxLength": 5000, "type": "string" }, "nullable": true, "type": "array" }, "blocked_categories": { "description": "Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to decline. All other categories will be allowed. Cannot be set with `allowed_categories`.", "items": { "enum": [ "ac_refrigeration_repair", "accounting_bookkeeping_services", "advertising_services", "agricultural_cooperative", "airlines_air_carriers", "airports_flying_fields", "ambulance_services", "amusement_parks_carnivals", "antique_reproductions", "antique_shops", "aquariums", "architectural_surveying_services", "art_dealers_and_galleries", "artists_supply_and_craft_shops", "auto_and_home_supply_stores", "auto_body_repair_shops", "auto_paint_shops", "auto_service_shops", "automated_cash_disburse", "automated_fuel_dispensers", "automobile_associations", "automotive_parts_and_accessories_stores", "automotive_tire_stores", "bail_and_bond_payments", "bakeries", "bands_orchestras", "barber_and_beauty_shops", "betting_casino_gambling", "bicycle_shops", "billiard_pool_establishments", "boat_dealers", "boat_rentals_and_leases", "book_stores", "books_periodicals_and_newspapers", "bowling_alleys", "bus_lines", "business_secretarial_schools", "buying_shopping_services", "cable_satellite_and_other_pay_television_and_radio", "camera_and_photographic_supply_stores", "candy_nut_and_confectionery_stores", "car_and_truck_dealers_new_used", "car_and_truck_dealers_used_only", "car_rental_agencies", "car_washes", "carpentry_services", "carpet_upholstery_cleaning", "caterers", "charitable_and_social_service_organizations_fundraising", "chemicals_and_allied_products", "child_care_services", "childrens_and_infants_wear_stores", "chiropodists_podiatrists", "chiropractors", "cigar_stores_and_stands", "civic_social_fraternal_associations", "cleaning_and_maintenance", "clothing_rental", "colleges_universities", "commercial_equipment", "commercial_footwear", "commercial_photography_art_and_graphics", "commuter_transport_and_ferries", "computer_network_services", "computer_programming", "computer_repair", "computer_software_stores", "computers_peripherals_and_software", "concrete_work_services", "construction_materials", "consulting_public_relations", "correspondence_schools", "cosmetic_stores", "counseling_services", "country_clubs", "courier_services", "court_costs", "credit_reporting_agencies", "cruise_lines", "dairy_products_stores", "dance_hall_studios_schools", "dating_escort_services", "dentists_orthodontists", "department_stores", "detective_agencies", "digital_goods_applications", "digital_goods_games", "digital_goods_large_volume", "digital_goods_media", "direct_marketing_catalog_merchant", "direct_marketing_combination_catalog_and_retail_merchant", "direct_marketing_inbound_telemarketing", "direct_marketing_insurance_services", "direct_marketing_other", "direct_marketing_outbound_telemarketing", "direct_marketing_subscription", "direct_marketing_travel", "discount_stores", "doctors", "door_to_door_sales", "drapery_window_covering_and_upholstery_stores", "drinking_places", "drug_stores_and_pharmacies", "drugs_drug_proprietaries_and_druggist_sundries", "dry_cleaners", "durable_goods", "duty_free_stores", "eating_places_restaurants", "educational_services", "electric_razor_stores", "electric_vehicle_charging", "electrical_parts_and_equipment", "electrical_services", "electronics_repair_shops", "electronics_stores", "elementary_secondary_schools", "emergency_services_gcas_visa_use_only", "employment_temp_agencies", "equipment_rental", "exterminating_services", "family_clothing_stores", "fast_food_restaurants", "financial_institutions", "fines_government_administrative_entities", "fireplace_fireplace_screens_and_accessories_stores", "floor_covering_stores", "florists", "florists_supplies_nursery_stock_and_flowers", "freezer_and_locker_meat_provisioners", "fuel_dealers_non_automotive", "funeral_services_crematories", "furniture_home_furnishings_and_equipment_stores_except_appliances", "furniture_repair_refinishing", "furriers_and_fur_shops", "general_services", "gift_card_novelty_and_souvenir_shops", "glass_paint_and_wallpaper_stores", "glassware_crystal_stores", "golf_courses_public", "government_licensed_horse_dog_racing_us_region_only", "government_licensed_online_casions_online_gambling_us_region_only", "government_owned_lotteries_non_us_region", "government_owned_lotteries_us_region_only", "government_services", "grocery_stores_supermarkets", "hardware_equipment_and_supplies", "hardware_stores", "health_and_beauty_spas", "hearing_aids_sales_and_supplies", "heating_plumbing_a_c", "hobby_toy_and_game_shops", "home_supply_warehouse_stores", "hospitals", "hotels_motels_and_resorts", "household_appliance_stores", "industrial_supplies", "information_retrieval_services", "insurance_default", "insurance_underwriting_premiums", "intra_company_purchases", "jewelry_stores_watches_clocks_and_silverware_stores", "landscaping_services", "laundries", "laundry_cleaning_services", "legal_services_attorneys", "luggage_and_leather_goods_stores", "lumber_building_materials_stores", "manual_cash_disburse", "marinas_service_and_supplies", "marketplaces", "masonry_stonework_and_plaster", "massage_parlors", "medical_and_dental_labs", "medical_dental_ophthalmic_and_hospital_equipment_and_supplies", "medical_services", "membership_organizations", "mens_and_boys_clothing_and_accessories_stores", "mens_womens_clothing_stores", "metal_service_centers", "miscellaneous", "miscellaneous_apparel_and_accessory_shops", "miscellaneous_auto_dealers", "miscellaneous_business_services", "miscellaneous_food_stores", "miscellaneous_general_merchandise", "miscellaneous_general_services", "miscellaneous_home_furnishing_specialty_stores", "miscellaneous_publishing_and_printing", "miscellaneous_recreation_services", "miscellaneous_repair_shops", "miscellaneous_specialty_retail", "mobile_home_dealers", "motion_picture_theaters", "motor_freight_carriers_and_trucking", "motor_homes_dealers", "motor_vehicle_supplies_and_new_parts", "motorcycle_shops_and_dealers", "motorcycle_shops_dealers", "music_stores_musical_instruments_pianos_and_sheet_music", "news_dealers_and_newsstands", "non_fi_money_orders", "non_fi_stored_value_card_purchase_load", "nondurable_goods", "nurseries_lawn_and_garden_supply_stores", "nursing_personal_care", "office_and_commercial_furniture", "opticians_eyeglasses", "optometrists_ophthalmologist", "orthopedic_goods_prosthetic_devices", "osteopaths", "package_stores_beer_wine_and_liquor", "paints_varnishes_and_supplies", "parking_lots_garages", "passenger_railways", "pawn_shops", "pet_shops_pet_food_and_supplies", "petroleum_and_petroleum_products", "photo_developing", "photographic_photocopy_microfilm_equipment_and_supplies", "photographic_studios", "picture_video_production", "piece_goods_notions_and_other_dry_goods", "plumbing_heating_equipment_and_supplies", "political_organizations", "postal_services_government_only", "precious_stones_and_metals_watches_and_jewelry", "professional_services", "public_warehousing_and_storage", "quick_copy_repro_and_blueprint", "railroads", "real_estate_agents_and_managers_rentals", "record_stores", "recreational_vehicle_rentals", "religious_goods_stores", "religious_organizations", "roofing_siding_sheet_metal", "secretarial_support_services", "security_brokers_dealers", "service_stations", "sewing_needlework_fabric_and_piece_goods_stores", "shoe_repair_hat_cleaning", "shoe_stores", "small_appliance_repair", "snowmobile_dealers", "special_trade_services", "specialty_cleaning", "sporting_goods_stores", "sporting_recreation_camps", "sports_and_riding_apparel_stores", "sports_clubs_fields", "stamp_and_coin_stores", "stationary_office_supplies_printing_and_writing_paper", "stationery_stores_office_and_school_supply_stores", "swimming_pools_sales", "t_ui_travel_germany", "tailors_alterations", "tax_payments_government_agencies", "tax_preparation_services", "taxicabs_limousines", "telecommunication_equipment_and_telephone_sales", "telecommunication_services", "telegraph_services", "tent_and_awning_shops", "testing_laboratories", "theatrical_ticket_agencies", "timeshares", "tire_retreading_and_repair", "tolls_bridge_fees", "tourist_attractions_and_exhibits", "towing_services", "trailer_parks_campgrounds", "transportation_services", "travel_agencies_tour_operators", "truck_stop_iteration", "truck_utility_trailer_rentals", "typesetting_plate_making_and_related_services", "typewriter_stores", "u_s_federal_government_agencies_or_departments", "uniforms_commercial_clothing", "used_merchandise_and_secondhand_stores", "utilities", "variety_stores", "veterinary_services", "video_amusement_game_supplies", "video_game_arcades", "video_tape_rental_stores", "vocational_trade_schools", "watch_jewelry_repair", "welding_repair", "wholesale_clubs", "wig_and_toupee_stores", "wires_money_orders", "womens_accessory_and_specialty_shops", "womens_ready_to_wear_stores", "wrecking_and_salvage_yards" ], "type": "string" }, "nullable": true, "type": "array" }, "blocked_merchant_countries": { "description": "Array of strings containing representing countries from which authorizations will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `allowed_merchant_countries`. Provide an empty value to unset this control.", "items": { "maxLength": 5000, "type": "string" }, "nullable": true, "type": "array" }, "spending_limits": { "description": "Limit spending with amount-based rules that apply across any cards this card replaced (i.e., its `replacement_for` card and _that_ card's `replacement_for` card, up the chain).", "items": { "$ref": "#/components/schemas/issuing_card_spending_limit" }, "nullable": true, "type": "array" }, "spending_limits_currency": { "description": "Currency of the amounts within `spending_limits`. Always the same as the currency of the card.", "format": "currency", "nullable": true, "type": "string" } }, "title": "IssuingCardAuthorizationControls", "type": "object", "x-expandableFields": [ "spending_limits" ] }, "issuing_card_google_pay": { "description": "", "properties": { "eligible": { "description": "Google Pay Eligibility", "type": "boolean" }, "ineligible_reason": { "description": "Reason the card is ineligible for Google Pay", "enum": [ "missing_agreement", "missing_cardholder_contact", "unsupported_region" ], "nullable": true, "type": "string" } }, "required": [ "eligible" ], "title": "IssuingCardGooglePay", "type": "object", "x-expandableFields": [] }, "issuing_card_shipping": { "description": "", "properties": { "address": { "$ref": "#/components/schemas/address" }, "address_validation": { "anyOf": [ { "$ref": "#/components/schemas/issuing_card_shipping_address_validation" } ], "description": "Address validation details for the shipment.", "nullable": true }, "carrier": { "description": "The delivery company that shipped a card.", "enum": [ "dhl", "fedex", "royal_mail", "usps" ], "nullable": true, "type": "string" }, "customs": { "anyOf": [ { "$ref": "#/components/schemas/issuing_card_shipping_customs" } ], "description": "Additional information that may be required for clearing customs.", "nullable": true }, "eta": { "description": "A unix timestamp representing a best estimate of when the card will be delivered.", "format": "unix-time", "nullable": true, "type": "integer" }, "name": { "description": "Recipient name.", "maxLength": 5000, "type": "string" }, "phone_number": { "description": "The phone number of the receiver of the shipment. Our courier partners will use this number to contact you in the event of card delivery issues. For individual shipments to the EU/UK, if this field is empty, we will provide them with the phone number provided when the cardholder was initially created.", "maxLength": 5000, "nullable": true, "type": "string" }, "require_signature": { "description": "Whether a signature is required for card delivery. This feature is only supported for US users. Standard shipping service does not support signature on delivery. The default value for standard shipping service is false and for express and priority services is true.", "nullable": true, "type": "boolean" }, "service": { "description": "Shipment service, such as `standard` or `express`.", "enum": [ "express", "priority", "standard" ], "type": "string", "x-stripeBypassValidation": true }, "status": { "description": "The delivery status of the card.", "enum": [ "canceled", "delivered", "failure", "pending", "returned", "shipped", "submitted" ], "nullable": true, "type": "string" }, "tracking_number": { "description": "A tracking number for a card shipment.", "maxLength": 5000, "nullable": true, "type": "string" }, "tracking_url": { "description": "A link to the shipping carrier's site where you can view detailed information about a card shipment.", "maxLength": 5000, "nullable": true, "type": "string" }, "type": { "description": "Packaging options.", "enum": [ "bulk", "individual" ], "type": "string" } }, "required": [ "address", "name", "service", "type" ], "title": "IssuingCardShipping", "type": "object", "x-expandableFields": [ "address", "address_validation", "customs" ] }, "issuing_card_shipping_address_validation": { "description": "", "properties": { "mode": { "description": "The address validation capabilities to use.", "enum": [ "disabled", "normalization_only", "validation_and_normalization" ], "type": "string" }, "normalized_address": { "anyOf": [ { "$ref": "#/components/schemas/address" } ], "description": "The normalized shipping address.", "nullable": true }, "result": { "description": "The validation result for the shipping address.", "enum": [ "indeterminate", "likely_deliverable", "likely_undeliverable" ], "nullable": true, "type": "string" } }, "required": [ "mode" ], "title": "IssuingCardShippingAddressValidation", "type": "object", "x-expandableFields": [ "normalized_address" ] }, "issuing_card_shipping_customs": { "description": "", "properties": { "eori_number": { "description": "A registration number used for customs in Europe. See [https://www.gov.uk/eori](https://www.gov.uk/eori) for the UK and [https://ec.europa.eu/taxation_customs/business/customs-procedures-import-and-export/customs-procedures/economic-operators-registration-and-identification-number-eori_en](https://ec.europa.eu/taxation_customs/business/customs-procedures-import-and-export/customs-procedures/economic-operators-registration-and-identification-number-eori_en) for the EU.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "IssuingCardShippingCustoms", "type": "object", "x-expandableFields": [] }, "issuing_card_spending_limit": { "description": "", "properties": { "amount": { "description": "Maximum amount allowed to spend per interval. This amount is in the card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", "type": "integer" }, "categories": { "description": "Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) this limit applies to. Omitting this field will apply the limit to all categories.", "items": { "enum": [ "ac_refrigeration_repair", "accounting_bookkeeping_services", "advertising_services", "agricultural_cooperative", "airlines_air_carriers", "airports_flying_fields", "ambulance_services", "amusement_parks_carnivals", "antique_reproductions", "antique_shops", "aquariums", "architectural_surveying_services", "art_dealers_and_galleries", "artists_supply_and_craft_shops", "auto_and_home_supply_stores", "auto_body_repair_shops", "auto_paint_shops", "auto_service_shops", "automated_cash_disburse", "automated_fuel_dispensers", "automobile_associations", "automotive_parts_and_accessories_stores", "automotive_tire_stores", "bail_and_bond_payments", "bakeries", "bands_orchestras", "barber_and_beauty_shops", "betting_casino_gambling", "bicycle_shops", "billiard_pool_establishments", "boat_dealers", "boat_rentals_and_leases", "book_stores", "books_periodicals_and_newspapers", "bowling_alleys", "bus_lines", "business_secretarial_schools", "buying_shopping_services", "cable_satellite_and_other_pay_television_and_radio", "camera_and_photographic_supply_stores", "candy_nut_and_confectionery_stores", "car_and_truck_dealers_new_used", "car_and_truck_dealers_used_only", "car_rental_agencies", "car_washes", "carpentry_services", "carpet_upholstery_cleaning", "caterers", "charitable_and_social_service_organizations_fundraising", "chemicals_and_allied_products", "child_care_services", "childrens_and_infants_wear_stores", "chiropodists_podiatrists", "chiropractors", "cigar_stores_and_stands", "civic_social_fraternal_associations", "cleaning_and_maintenance", "clothing_rental", "colleges_universities", "commercial_equipment", "commercial_footwear", "commercial_photography_art_and_graphics", "commuter_transport_and_ferries", "computer_network_services", "computer_programming", "computer_repair", "computer_software_stores", "computers_peripherals_and_software", "concrete_work_services", "construction_materials", "consulting_public_relations", "correspondence_schools", "cosmetic_stores", "counseling_services", "country_clubs", "courier_services", "court_costs", "credit_reporting_agencies", "cruise_lines", "dairy_products_stores", "dance_hall_studios_schools", "dating_escort_services", "dentists_orthodontists", "department_stores", "detective_agencies", "digital_goods_applications", "digital_goods_games", "digital_goods_large_volume", "digital_goods_media", "direct_marketing_catalog_merchant", "direct_marketing_combination_catalog_and_retail_merchant", "direct_marketing_inbound_telemarketing", "direct_marketing_insurance_services", "direct_marketing_other", "direct_marketing_outbound_telemarketing", "direct_marketing_subscription", "direct_marketing_travel", "discount_stores", "doctors", "door_to_door_sales", "drapery_window_covering_and_upholstery_stores", "drinking_places", "drug_stores_and_pharmacies", "drugs_drug_proprietaries_and_druggist_sundries", "dry_cleaners", "durable_goods", "duty_free_stores", "eating_places_restaurants", "educational_services", "electric_razor_stores", "electric_vehicle_charging", "electrical_parts_and_equipment", "electrical_services", "electronics_repair_shops", "electronics_stores", "elementary_secondary_schools", "emergency_services_gcas_visa_use_only", "employment_temp_agencies", "equipment_rental", "exterminating_services", "family_clothing_stores", "fast_food_restaurants", "financial_institutions", "fines_government_administrative_entities", "fireplace_fireplace_screens_and_accessories_stores", "floor_covering_stores", "florists", "florists_supplies_nursery_stock_and_flowers", "freezer_and_locker_meat_provisioners", "fuel_dealers_non_automotive", "funeral_services_crematories", "furniture_home_furnishings_and_equipment_stores_except_appliances", "furniture_repair_refinishing", "furriers_and_fur_shops", "general_services", "gift_card_novelty_and_souvenir_shops", "glass_paint_and_wallpaper_stores", "glassware_crystal_stores", "golf_courses_public", "government_licensed_horse_dog_racing_us_region_only", "government_licensed_online_casions_online_gambling_us_region_only", "government_owned_lotteries_non_us_region", "government_owned_lotteries_us_region_only", "government_services", "grocery_stores_supermarkets", "hardware_equipment_and_supplies", "hardware_stores", "health_and_beauty_spas", "hearing_aids_sales_and_supplies", "heating_plumbing_a_c", "hobby_toy_and_game_shops", "home_supply_warehouse_stores", "hospitals", "hotels_motels_and_resorts", "household_appliance_stores", "industrial_supplies", "information_retrieval_services", "insurance_default", "insurance_underwriting_premiums", "intra_company_purchases", "jewelry_stores_watches_clocks_and_silverware_stores", "landscaping_services", "laundries", "laundry_cleaning_services", "legal_services_attorneys", "luggage_and_leather_goods_stores", "lumber_building_materials_stores", "manual_cash_disburse", "marinas_service_and_supplies", "marketplaces", "masonry_stonework_and_plaster", "massage_parlors", "medical_and_dental_labs", "medical_dental_ophthalmic_and_hospital_equipment_and_supplies", "medical_services", "membership_organizations", "mens_and_boys_clothing_and_accessories_stores", "mens_womens_clothing_stores", "metal_service_centers", "miscellaneous", "miscellaneous_apparel_and_accessory_shops", "miscellaneous_auto_dealers", "miscellaneous_business_services", "miscellaneous_food_stores", "miscellaneous_general_merchandise", "miscellaneous_general_services", "miscellaneous_home_furnishing_specialty_stores", "miscellaneous_publishing_and_printing", "miscellaneous_recreation_services", "miscellaneous_repair_shops", "miscellaneous_specialty_retail", "mobile_home_dealers", "motion_picture_theaters", "motor_freight_carriers_and_trucking", "motor_homes_dealers", "motor_vehicle_supplies_and_new_parts", "motorcycle_shops_and_dealers", "motorcycle_shops_dealers", "music_stores_musical_instruments_pianos_and_sheet_music", "news_dealers_and_newsstands", "non_fi_money_orders", "non_fi_stored_value_card_purchase_load", "nondurable_goods", "nurseries_lawn_and_garden_supply_stores", "nursing_personal_care", "office_and_commercial_furniture", "opticians_eyeglasses", "optometrists_ophthalmologist", "orthopedic_goods_prosthetic_devices", "osteopaths", "package_stores_beer_wine_and_liquor", "paints_varnishes_and_supplies", "parking_lots_garages", "passenger_railways", "pawn_shops", "pet_shops_pet_food_and_supplies", "petroleum_and_petroleum_products", "photo_developing", "photographic_photocopy_microfilm_equipment_and_supplies", "photographic_studios", "picture_video_production", "piece_goods_notions_and_other_dry_goods", "plumbing_heating_equipment_and_supplies", "political_organizations", "postal_services_government_only", "precious_stones_and_metals_watches_and_jewelry", "professional_services", "public_warehousing_and_storage", "quick_copy_repro_and_blueprint", "railroads", "real_estate_agents_and_managers_rentals", "record_stores", "recreational_vehicle_rentals", "religious_goods_stores", "religious_organizations", "roofing_siding_sheet_metal", "secretarial_support_services", "security_brokers_dealers", "service_stations", "sewing_needlework_fabric_and_piece_goods_stores", "shoe_repair_hat_cleaning", "shoe_stores", "small_appliance_repair", "snowmobile_dealers", "special_trade_services", "specialty_cleaning", "sporting_goods_stores", "sporting_recreation_camps", "sports_and_riding_apparel_stores", "sports_clubs_fields", "stamp_and_coin_stores", "stationary_office_supplies_printing_and_writing_paper", "stationery_stores_office_and_school_supply_stores", "swimming_pools_sales", "t_ui_travel_germany", "tailors_alterations", "tax_payments_government_agencies", "tax_preparation_services", "taxicabs_limousines", "telecommunication_equipment_and_telephone_sales", "telecommunication_services", "telegraph_services", "tent_and_awning_shops", "testing_laboratories", "theatrical_ticket_agencies", "timeshares", "tire_retreading_and_repair", "tolls_bridge_fees", "tourist_attractions_and_exhibits", "towing_services", "trailer_parks_campgrounds", "transportation_services", "travel_agencies_tour_operators", "truck_stop_iteration", "truck_utility_trailer_rentals", "typesetting_plate_making_and_related_services", "typewriter_stores", "u_s_federal_government_agencies_or_departments", "uniforms_commercial_clothing", "used_merchandise_and_secondhand_stores", "utilities", "variety_stores", "veterinary_services", "video_amusement_game_supplies", "video_game_arcades", "video_tape_rental_stores", "vocational_trade_schools", "watch_jewelry_repair", "welding_repair", "wholesale_clubs", "wig_and_toupee_stores", "wires_money_orders", "womens_accessory_and_specialty_shops", "womens_ready_to_wear_stores", "wrecking_and_salvage_yards" ], "type": "string" }, "nullable": true, "type": "array" }, "interval": { "description": "Interval (or event) to which the amount applies.", "enum": [ "all_time", "daily", "monthly", "per_authorization", "weekly", "yearly" ], "type": "string" } }, "required": [ "amount", "interval" ], "title": "IssuingCardSpendingLimit", "type": "object", "x-expandableFields": [] }, "issuing_card_wallets": { "description": "", "properties": { "apple_pay": { "$ref": "#/components/schemas/issuing_card_apple_pay" }, "google_pay": { "$ref": "#/components/schemas/issuing_card_google_pay" }, "primary_account_identifier": { "description": "Unique identifier for a card used with digital wallets", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "apple_pay", "google_pay" ], "title": "IssuingCardWallets", "type": "object", "x-expandableFields": [ "apple_pay", "google_pay" ] }, "issuing_cardholder_address": { "description": "", "properties": { "address": { "$ref": "#/components/schemas/address" } }, "required": [ "address" ], "title": "IssuingCardholderAddress", "type": "object", "x-expandableFields": [ "address" ] }, "issuing_cardholder_authorization_controls": { "description": "", "properties": { "allowed_categories": { "description": "Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to allow. All other categories will be blocked. Cannot be set with `blocked_categories`.", "items": { "enum": [ "ac_refrigeration_repair", "accounting_bookkeeping_services", "advertising_services", "agricultural_cooperative", "airlines_air_carriers", "airports_flying_fields", "ambulance_services", "amusement_parks_carnivals", "antique_reproductions", "antique_shops", "aquariums", "architectural_surveying_services", "art_dealers_and_galleries", "artists_supply_and_craft_shops", "auto_and_home_supply_stores", "auto_body_repair_shops", "auto_paint_shops", "auto_service_shops", "automated_cash_disburse", "automated_fuel_dispensers", "automobile_associations", "automotive_parts_and_accessories_stores", "automotive_tire_stores", "bail_and_bond_payments", "bakeries", "bands_orchestras", "barber_and_beauty_shops", "betting_casino_gambling", "bicycle_shops", "billiard_pool_establishments", "boat_dealers", "boat_rentals_and_leases", "book_stores", "books_periodicals_and_newspapers", "bowling_alleys", "bus_lines", "business_secretarial_schools", "buying_shopping_services", "cable_satellite_and_other_pay_television_and_radio", "camera_and_photographic_supply_stores", "candy_nut_and_confectionery_stores", "car_and_truck_dealers_new_used", "car_and_truck_dealers_used_only", "car_rental_agencies", "car_washes", "carpentry_services", "carpet_upholstery_cleaning", "caterers", "charitable_and_social_service_organizations_fundraising", "chemicals_and_allied_products", "child_care_services", "childrens_and_infants_wear_stores", "chiropodists_podiatrists", "chiropractors", "cigar_stores_and_stands", "civic_social_fraternal_associations", "cleaning_and_maintenance", "clothing_rental", "colleges_universities", "commercial_equipment", "commercial_footwear", "commercial_photography_art_and_graphics", "commuter_transport_and_ferries", "computer_network_services", "computer_programming", "computer_repair", "computer_software_stores", "computers_peripherals_and_software", "concrete_work_services", "construction_materials", "consulting_public_relations", "correspondence_schools", "cosmetic_stores", "counseling_services", "country_clubs", "courier_services", "court_costs", "credit_reporting_agencies", "cruise_lines", "dairy_products_stores", "dance_hall_studios_schools", "dating_escort_services", "dentists_orthodontists", "department_stores", "detective_agencies", "digital_goods_applications", "digital_goods_games", "digital_goods_large_volume", "digital_goods_media", "direct_marketing_catalog_merchant", "direct_marketing_combination_catalog_and_retail_merchant", "direct_marketing_inbound_telemarketing", "direct_marketing_insurance_services", "direct_marketing_other", "direct_marketing_outbound_telemarketing", "direct_marketing_subscription", "direct_marketing_travel", "discount_stores", "doctors", "door_to_door_sales", "drapery_window_covering_and_upholstery_stores", "drinking_places", "drug_stores_and_pharmacies", "drugs_drug_proprietaries_and_druggist_sundries", "dry_cleaners", "durable_goods", "duty_free_stores", "eating_places_restaurants", "educational_services", "electric_razor_stores", "electric_vehicle_charging", "electrical_parts_and_equipment", "electrical_services", "electronics_repair_shops", "electronics_stores", "elementary_secondary_schools", "emergency_services_gcas_visa_use_only", "employment_temp_agencies", "equipment_rental", "exterminating_services", "family_clothing_stores", "fast_food_restaurants", "financial_institutions", "fines_government_administrative_entities", "fireplace_fireplace_screens_and_accessories_stores", "floor_covering_stores", "florists", "florists_supplies_nursery_stock_and_flowers", "freezer_and_locker_meat_provisioners", "fuel_dealers_non_automotive", "funeral_services_crematories", "furniture_home_furnishings_and_equipment_stores_except_appliances", "furniture_repair_refinishing", "furriers_and_fur_shops", "general_services", "gift_card_novelty_and_souvenir_shops", "glass_paint_and_wallpaper_stores", "glassware_crystal_stores", "golf_courses_public", "government_licensed_horse_dog_racing_us_region_only", "government_licensed_online_casions_online_gambling_us_region_only", "government_owned_lotteries_non_us_region", "government_owned_lotteries_us_region_only", "government_services", "grocery_stores_supermarkets", "hardware_equipment_and_supplies", "hardware_stores", "health_and_beauty_spas", "hearing_aids_sales_and_supplies", "heating_plumbing_a_c", "hobby_toy_and_game_shops", "home_supply_warehouse_stores", "hospitals", "hotels_motels_and_resorts", "household_appliance_stores", "industrial_supplies", "information_retrieval_services", "insurance_default", "insurance_underwriting_premiums", "intra_company_purchases", "jewelry_stores_watches_clocks_and_silverware_stores", "landscaping_services", "laundries", "laundry_cleaning_services", "legal_services_attorneys", "luggage_and_leather_goods_stores", "lumber_building_materials_stores", "manual_cash_disburse", "marinas_service_and_supplies", "marketplaces", "masonry_stonework_and_plaster", "massage_parlors", "medical_and_dental_labs", "medical_dental_ophthalmic_and_hospital_equipment_and_supplies", "medical_services", "membership_organizations", "mens_and_boys_clothing_and_accessories_stores", "mens_womens_clothing_stores", "metal_service_centers", "miscellaneous", "miscellaneous_apparel_and_accessory_shops", "miscellaneous_auto_dealers", "miscellaneous_business_services", "miscellaneous_food_stores", "miscellaneous_general_merchandise", "miscellaneous_general_services", "miscellaneous_home_furnishing_specialty_stores", "miscellaneous_publishing_and_printing", "miscellaneous_recreation_services", "miscellaneous_repair_shops", "miscellaneous_specialty_retail", "mobile_home_dealers", "motion_picture_theaters", "motor_freight_carriers_and_trucking", "motor_homes_dealers", "motor_vehicle_supplies_and_new_parts", "motorcycle_shops_and_dealers", "motorcycle_shops_dealers", "music_stores_musical_instruments_pianos_and_sheet_music", "news_dealers_and_newsstands", "non_fi_money_orders", "non_fi_stored_value_card_purchase_load", "nondurable_goods", "nurseries_lawn_and_garden_supply_stores", "nursing_personal_care", "office_and_commercial_furniture", "opticians_eyeglasses", "optometrists_ophthalmologist", "orthopedic_goods_prosthetic_devices", "osteopaths", "package_stores_beer_wine_and_liquor", "paints_varnishes_and_supplies", "parking_lots_garages", "passenger_railways", "pawn_shops", "pet_shops_pet_food_and_supplies", "petroleum_and_petroleum_products", "photo_developing", "photographic_photocopy_microfilm_equipment_and_supplies", "photographic_studios", "picture_video_production", "piece_goods_notions_and_other_dry_goods", "plumbing_heating_equipment_and_supplies", "political_organizations", "postal_services_government_only", "precious_stones_and_metals_watches_and_jewelry", "professional_services", "public_warehousing_and_storage", "quick_copy_repro_and_blueprint", "railroads", "real_estate_agents_and_managers_rentals", "record_stores", "recreational_vehicle_rentals", "religious_goods_stores", "religious_organizations", "roofing_siding_sheet_metal", "secretarial_support_services", "security_brokers_dealers", "service_stations", "sewing_needlework_fabric_and_piece_goods_stores", "shoe_repair_hat_cleaning", "shoe_stores", "small_appliance_repair", "snowmobile_dealers", "special_trade_services", "specialty_cleaning", "sporting_goods_stores", "sporting_recreation_camps", "sports_and_riding_apparel_stores", "sports_clubs_fields", "stamp_and_coin_stores", "stationary_office_supplies_printing_and_writing_paper", "stationery_stores_office_and_school_supply_stores", "swimming_pools_sales", "t_ui_travel_germany", "tailors_alterations", "tax_payments_government_agencies", "tax_preparation_services", "taxicabs_limousines", "telecommunication_equipment_and_telephone_sales", "telecommunication_services", "telegraph_services", "tent_and_awning_shops", "testing_laboratories", "theatrical_ticket_agencies", "timeshares", "tire_retreading_and_repair", "tolls_bridge_fees", "tourist_attractions_and_exhibits", "towing_services", "trailer_parks_campgrounds", "transportation_services", "travel_agencies_tour_operators", "truck_stop_iteration", "truck_utility_trailer_rentals", "typesetting_plate_making_and_related_services", "typewriter_stores", "u_s_federal_government_agencies_or_departments", "uniforms_commercial_clothing", "used_merchandise_and_secondhand_stores", "utilities", "variety_stores", "veterinary_services", "video_amusement_game_supplies", "video_game_arcades", "video_tape_rental_stores", "vocational_trade_schools", "watch_jewelry_repair", "welding_repair", "wholesale_clubs", "wig_and_toupee_stores", "wires_money_orders", "womens_accessory_and_specialty_shops", "womens_ready_to_wear_stores", "wrecking_and_salvage_yards" ], "type": "string" }, "nullable": true, "type": "array" }, "allowed_merchant_countries": { "description": "Array of strings containing representing countries from which authorizations will be allowed. Authorizations from merchants in all other countries will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `blocked_merchant_countries`. Provide an empty value to unset this control.", "items": { "maxLength": 5000, "type": "string" }, "nullable": true, "type": "array" }, "blocked_categories": { "description": "Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to decline. All other categories will be allowed. Cannot be set with `allowed_categories`.", "items": { "enum": [ "ac_refrigeration_repair", "accounting_bookkeeping_services", "advertising_services", "agricultural_cooperative", "airlines_air_carriers", "airports_flying_fields", "ambulance_services", "amusement_parks_carnivals", "antique_reproductions", "antique_shops", "aquariums", "architectural_surveying_services", "art_dealers_and_galleries", "artists_supply_and_craft_shops", "auto_and_home_supply_stores", "auto_body_repair_shops", "auto_paint_shops", "auto_service_shops", "automated_cash_disburse", "automated_fuel_dispensers", "automobile_associations", "automotive_parts_and_accessories_stores", "automotive_tire_stores", "bail_and_bond_payments", "bakeries", "bands_orchestras", "barber_and_beauty_shops", "betting_casino_gambling", "bicycle_shops", "billiard_pool_establishments", "boat_dealers", "boat_rentals_and_leases", "book_stores", "books_periodicals_and_newspapers", "bowling_alleys", "bus_lines", "business_secretarial_schools", "buying_shopping_services", "cable_satellite_and_other_pay_television_and_radio", "camera_and_photographic_supply_stores", "candy_nut_and_confectionery_stores", "car_and_truck_dealers_new_used", "car_and_truck_dealers_used_only", "car_rental_agencies", "car_washes", "carpentry_services", "carpet_upholstery_cleaning", "caterers", "charitable_and_social_service_organizations_fundraising", "chemicals_and_allied_products", "child_care_services", "childrens_and_infants_wear_stores", "chiropodists_podiatrists", "chiropractors", "cigar_stores_and_stands", "civic_social_fraternal_associations", "cleaning_and_maintenance", "clothing_rental", "colleges_universities", "commercial_equipment", "commercial_footwear", "commercial_photography_art_and_graphics", "commuter_transport_and_ferries", "computer_network_services", "computer_programming", "computer_repair", "computer_software_stores", "computers_peripherals_and_software", "concrete_work_services", "construction_materials", "consulting_public_relations", "correspondence_schools", "cosmetic_stores", "counseling_services", "country_clubs", "courier_services", "court_costs", "credit_reporting_agencies", "cruise_lines", "dairy_products_stores", "dance_hall_studios_schools", "dating_escort_services", "dentists_orthodontists", "department_stores", "detective_agencies", "digital_goods_applications", "digital_goods_games", "digital_goods_large_volume", "digital_goods_media", "direct_marketing_catalog_merchant", "direct_marketing_combination_catalog_and_retail_merchant", "direct_marketing_inbound_telemarketing", "direct_marketing_insurance_services", "direct_marketing_other", "direct_marketing_outbound_telemarketing", "direct_marketing_subscription", "direct_marketing_travel", "discount_stores", "doctors", "door_to_door_sales", "drapery_window_covering_and_upholstery_stores", "drinking_places", "drug_stores_and_pharmacies", "drugs_drug_proprietaries_and_druggist_sundries", "dry_cleaners", "durable_goods", "duty_free_stores", "eating_places_restaurants", "educational_services", "electric_razor_stores", "electric_vehicle_charging", "electrical_parts_and_equipment", "electrical_services", "electronics_repair_shops", "electronics_stores", "elementary_secondary_schools", "emergency_services_gcas_visa_use_only", "employment_temp_agencies", "equipment_rental", "exterminating_services", "family_clothing_stores", "fast_food_restaurants", "financial_institutions", "fines_government_administrative_entities", "fireplace_fireplace_screens_and_accessories_stores", "floor_covering_stores", "florists", "florists_supplies_nursery_stock_and_flowers", "freezer_and_locker_meat_provisioners", "fuel_dealers_non_automotive", "funeral_services_crematories", "furniture_home_furnishings_and_equipment_stores_except_appliances", "furniture_repair_refinishing", "furriers_and_fur_shops", "general_services", "gift_card_novelty_and_souvenir_shops", "glass_paint_and_wallpaper_stores", "glassware_crystal_stores", "golf_courses_public", "government_licensed_horse_dog_racing_us_region_only", "government_licensed_online_casions_online_gambling_us_region_only", "government_owned_lotteries_non_us_region", "government_owned_lotteries_us_region_only", "government_services", "grocery_stores_supermarkets", "hardware_equipment_and_supplies", "hardware_stores", "health_and_beauty_spas", "hearing_aids_sales_and_supplies", "heating_plumbing_a_c", "hobby_toy_and_game_shops", "home_supply_warehouse_stores", "hospitals", "hotels_motels_and_resorts", "household_appliance_stores", "industrial_supplies", "information_retrieval_services", "insurance_default", "insurance_underwriting_premiums", "intra_company_purchases", "jewelry_stores_watches_clocks_and_silverware_stores", "landscaping_services", "laundries", "laundry_cleaning_services", "legal_services_attorneys", "luggage_and_leather_goods_stores", "lumber_building_materials_stores", "manual_cash_disburse", "marinas_service_and_supplies", "marketplaces", "masonry_stonework_and_plaster", "massage_parlors", "medical_and_dental_labs", "medical_dental_ophthalmic_and_hospital_equipment_and_supplies", "medical_services", "membership_organizations", "mens_and_boys_clothing_and_accessories_stores", "mens_womens_clothing_stores", "metal_service_centers", "miscellaneous", "miscellaneous_apparel_and_accessory_shops", "miscellaneous_auto_dealers", "miscellaneous_business_services", "miscellaneous_food_stores", "miscellaneous_general_merchandise", "miscellaneous_general_services", "miscellaneous_home_furnishing_specialty_stores", "miscellaneous_publishing_and_printing", "miscellaneous_recreation_services", "miscellaneous_repair_shops", "miscellaneous_specialty_retail", "mobile_home_dealers", "motion_picture_theaters", "motor_freight_carriers_and_trucking", "motor_homes_dealers", "motor_vehicle_supplies_and_new_parts", "motorcycle_shops_and_dealers", "motorcycle_shops_dealers", "music_stores_musical_instruments_pianos_and_sheet_music", "news_dealers_and_newsstands", "non_fi_money_orders", "non_fi_stored_value_card_purchase_load", "nondurable_goods", "nurseries_lawn_and_garden_supply_stores", "nursing_personal_care", "office_and_commercial_furniture", "opticians_eyeglasses", "optometrists_ophthalmologist", "orthopedic_goods_prosthetic_devices", "osteopaths", "package_stores_beer_wine_and_liquor", "paints_varnishes_and_supplies", "parking_lots_garages", "passenger_railways", "pawn_shops", "pet_shops_pet_food_and_supplies", "petroleum_and_petroleum_products", "photo_developing", "photographic_photocopy_microfilm_equipment_and_supplies", "photographic_studios", "picture_video_production", "piece_goods_notions_and_other_dry_goods", "plumbing_heating_equipment_and_supplies", "political_organizations", "postal_services_government_only", "precious_stones_and_metals_watches_and_jewelry", "professional_services", "public_warehousing_and_storage", "quick_copy_repro_and_blueprint", "railroads", "real_estate_agents_and_managers_rentals", "record_stores", "recreational_vehicle_rentals", "religious_goods_stores", "religious_organizations", "roofing_siding_sheet_metal", "secretarial_support_services", "security_brokers_dealers", "service_stations", "sewing_needlework_fabric_and_piece_goods_stores", "shoe_repair_hat_cleaning", "shoe_stores", "small_appliance_repair", "snowmobile_dealers", "special_trade_services", "specialty_cleaning", "sporting_goods_stores", "sporting_recreation_camps", "sports_and_riding_apparel_stores", "sports_clubs_fields", "stamp_and_coin_stores", "stationary_office_supplies_printing_and_writing_paper", "stationery_stores_office_and_school_supply_stores", "swimming_pools_sales", "t_ui_travel_germany", "tailors_alterations", "tax_payments_government_agencies", "tax_preparation_services", "taxicabs_limousines", "telecommunication_equipment_and_telephone_sales", "telecommunication_services", "telegraph_services", "tent_and_awning_shops", "testing_laboratories", "theatrical_ticket_agencies", "timeshares", "tire_retreading_and_repair", "tolls_bridge_fees", "tourist_attractions_and_exhibits", "towing_services", "trailer_parks_campgrounds", "transportation_services", "travel_agencies_tour_operators", "truck_stop_iteration", "truck_utility_trailer_rentals", "typesetting_plate_making_and_related_services", "typewriter_stores", "u_s_federal_government_agencies_or_departments", "uniforms_commercial_clothing", "used_merchandise_and_secondhand_stores", "utilities", "variety_stores", "veterinary_services", "video_amusement_game_supplies", "video_game_arcades", "video_tape_rental_stores", "vocational_trade_schools", "watch_jewelry_repair", "welding_repair", "wholesale_clubs", "wig_and_toupee_stores", "wires_money_orders", "womens_accessory_and_specialty_shops", "womens_ready_to_wear_stores", "wrecking_and_salvage_yards" ], "type": "string" }, "nullable": true, "type": "array" }, "blocked_merchant_countries": { "description": "Array of strings containing representing countries from which authorizations will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `allowed_merchant_countries`. Provide an empty value to unset this control.", "items": { "maxLength": 5000, "type": "string" }, "nullable": true, "type": "array" }, "spending_limits": { "description": "Limit spending with amount-based rules that apply across this cardholder's cards.", "items": { "$ref": "#/components/schemas/issuing_cardholder_spending_limit" }, "nullable": true, "type": "array" }, "spending_limits_currency": { "description": "Currency of the amounts within `spending_limits`.", "format": "currency", "nullable": true, "type": "string" } }, "title": "IssuingCardholderAuthorizationControls", "type": "object", "x-expandableFields": [ "spending_limits" ] }, "issuing_cardholder_card_issuing": { "description": "", "properties": { "user_terms_acceptance": { "anyOf": [ { "$ref": "#/components/schemas/issuing_cardholder_user_terms_acceptance" } ], "description": "Information about cardholder acceptance of Celtic [Authorized User Terms](https://stripe.com/docs/issuing/cards#accept-authorized-user-terms). Required for cards backed by a Celtic program.", "nullable": true } }, "title": "IssuingCardholderCardIssuing", "type": "object", "x-expandableFields": [ "user_terms_acceptance" ] }, "issuing_cardholder_company": { "description": "", "properties": { "tax_id_provided": { "description": "Whether the company's business ID number was provided.", "type": "boolean" } }, "required": [ "tax_id_provided" ], "title": "IssuingCardholderCompany", "type": "object", "x-expandableFields": [] }, "issuing_cardholder_id_document": { "description": "", "properties": { "back": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/file" } ], "description": "The back of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/file" } ] } }, "front": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/file" } ], "description": "The front of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/file" } ] } } }, "title": "IssuingCardholderIdDocument", "type": "object", "x-expandableFields": [ "back", "front" ] }, "issuing_cardholder_individual": { "description": "", "properties": { "card_issuing": { "anyOf": [ { "$ref": "#/components/schemas/issuing_cardholder_card_issuing" } ], "description": "Information related to the card_issuing program for this cardholder.", "nullable": true }, "dob": { "anyOf": [ { "$ref": "#/components/schemas/issuing_cardholder_individual_dob" } ], "description": "The date of birth of this cardholder.", "nullable": true }, "first_name": { "description": "The first name of this cardholder. Required before activating Cards. This field cannot contain any numbers, special characters (except periods, commas, hyphens, spaces and apostrophes) or non-latin letters.", "maxLength": 5000, "nullable": true, "type": "string" }, "last_name": { "description": "The last name of this cardholder. Required before activating Cards. This field cannot contain any numbers, special characters (except periods, commas, hyphens, spaces and apostrophes) or non-latin letters.", "maxLength": 5000, "nullable": true, "type": "string" }, "verification": { "anyOf": [ { "$ref": "#/components/schemas/issuing_cardholder_verification" } ], "description": "Government-issued ID document for this cardholder.", "nullable": true } }, "title": "IssuingCardholderIndividual", "type": "object", "x-expandableFields": [ "card_issuing", "dob", "verification" ] }, "issuing_cardholder_individual_dob": { "description": "", "properties": { "day": { "description": "The day of birth, between 1 and 31.", "nullable": true, "type": "integer" }, "month": { "description": "The month of birth, between 1 and 12.", "nullable": true, "type": "integer" }, "year": { "description": "The four-digit year of birth.", "nullable": true, "type": "integer" } }, "title": "IssuingCardholderIndividualDOB", "type": "object", "x-expandableFields": [] }, "issuing_cardholder_requirements": { "description": "", "properties": { "disabled_reason": { "description": "If `disabled_reason` is present, all cards will decline authorizations with `cardholder_verification_required` reason.", "enum": [ "listed", "rejected.listed", "requirements.past_due", "under_review" ], "nullable": true, "type": "string" }, "past_due": { "description": "Array of fields that need to be collected in order to verify and re-enable the cardholder.", "items": { "enum": [ "company.tax_id", "individual.card_issuing.user_terms_acceptance.date", "individual.card_issuing.user_terms_acceptance.ip", "individual.dob.day", "individual.dob.month", "individual.dob.year", "individual.first_name", "individual.last_name", "individual.verification.document" ], "type": "string", "x-stripeBypassValidation": true }, "nullable": true, "type": "array" } }, "title": "IssuingCardholderRequirements", "type": "object", "x-expandableFields": [] }, "issuing_cardholder_spending_limit": { "description": "", "properties": { "amount": { "description": "Maximum amount allowed to spend per interval. This amount is in the card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", "type": "integer" }, "categories": { "description": "Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) this limit applies to. Omitting this field will apply the limit to all categories.", "items": { "enum": [ "ac_refrigeration_repair", "accounting_bookkeeping_services", "advertising_services", "agricultural_cooperative", "airlines_air_carriers", "airports_flying_fields", "ambulance_services", "amusement_parks_carnivals", "antique_reproductions", "antique_shops", "aquariums", "architectural_surveying_services", "art_dealers_and_galleries", "artists_supply_and_craft_shops", "auto_and_home_supply_stores", "auto_body_repair_shops", "auto_paint_shops", "auto_service_shops", "automated_cash_disburse", "automated_fuel_dispensers", "automobile_associations", "automotive_parts_and_accessories_stores", "automotive_tire_stores", "bail_and_bond_payments", "bakeries", "bands_orchestras", "barber_and_beauty_shops", "betting_casino_gambling", "bicycle_shops", "billiard_pool_establishments", "boat_dealers", "boat_rentals_and_leases", "book_stores", "books_periodicals_and_newspapers", "bowling_alleys", "bus_lines", "business_secretarial_schools", "buying_shopping_services", "cable_satellite_and_other_pay_television_and_radio", "camera_and_photographic_supply_stores", "candy_nut_and_confectionery_stores", "car_and_truck_dealers_new_used", "car_and_truck_dealers_used_only", "car_rental_agencies", "car_washes", "carpentry_services", "carpet_upholstery_cleaning", "caterers", "charitable_and_social_service_organizations_fundraising", "chemicals_and_allied_products", "child_care_services", "childrens_and_infants_wear_stores", "chiropodists_podiatrists", "chiropractors", "cigar_stores_and_stands", "civic_social_fraternal_associations", "cleaning_and_maintenance", "clothing_rental", "colleges_universities", "commercial_equipment", "commercial_footwear", "commercial_photography_art_and_graphics", "commuter_transport_and_ferries", "computer_network_services", "computer_programming", "computer_repair", "computer_software_stores", "computers_peripherals_and_software", "concrete_work_services", "construction_materials", "consulting_public_relations", "correspondence_schools", "cosmetic_stores", "counseling_services", "country_clubs", "courier_services", "court_costs", "credit_reporting_agencies", "cruise_lines", "dairy_products_stores", "dance_hall_studios_schools", "dating_escort_services", "dentists_orthodontists", "department_stores", "detective_agencies", "digital_goods_applications", "digital_goods_games", "digital_goods_large_volume", "digital_goods_media", "direct_marketing_catalog_merchant", "direct_marketing_combination_catalog_and_retail_merchant", "direct_marketing_inbound_telemarketing", "direct_marketing_insurance_services", "direct_marketing_other", "direct_marketing_outbound_telemarketing", "direct_marketing_subscription", "direct_marketing_travel", "discount_stores", "doctors", "door_to_door_sales", "drapery_window_covering_and_upholstery_stores", "drinking_places", "drug_stores_and_pharmacies", "drugs_drug_proprietaries_and_druggist_sundries", "dry_cleaners", "durable_goods", "duty_free_stores", "eating_places_restaurants", "educational_services", "electric_razor_stores", "electric_vehicle_charging", "electrical_parts_and_equipment", "electrical_services", "electronics_repair_shops", "electronics_stores", "elementary_secondary_schools", "emergency_services_gcas_visa_use_only", "employment_temp_agencies", "equipment_rental", "exterminating_services", "family_clothing_stores", "fast_food_restaurants", "financial_institutions", "fines_government_administrative_entities", "fireplace_fireplace_screens_and_accessories_stores", "floor_covering_stores", "florists", "florists_supplies_nursery_stock_and_flowers", "freezer_and_locker_meat_provisioners", "fuel_dealers_non_automotive", "funeral_services_crematories", "furniture_home_furnishings_and_equipment_stores_except_appliances", "furniture_repair_refinishing", "furriers_and_fur_shops", "general_services", "gift_card_novelty_and_souvenir_shops", "glass_paint_and_wallpaper_stores", "glassware_crystal_stores", "golf_courses_public", "government_licensed_horse_dog_racing_us_region_only", "government_licensed_online_casions_online_gambling_us_region_only", "government_owned_lotteries_non_us_region", "government_owned_lotteries_us_region_only", "government_services", "grocery_stores_supermarkets", "hardware_equipment_and_supplies", "hardware_stores", "health_and_beauty_spas", "hearing_aids_sales_and_supplies", "heating_plumbing_a_c", "hobby_toy_and_game_shops", "home_supply_warehouse_stores", "hospitals", "hotels_motels_and_resorts", "household_appliance_stores", "industrial_supplies", "information_retrieval_services", "insurance_default", "insurance_underwriting_premiums", "intra_company_purchases", "jewelry_stores_watches_clocks_and_silverware_stores", "landscaping_services", "laundries", "laundry_cleaning_services", "legal_services_attorneys", "luggage_and_leather_goods_stores", "lumber_building_materials_stores", "manual_cash_disburse", "marinas_service_and_supplies", "marketplaces", "masonry_stonework_and_plaster", "massage_parlors", "medical_and_dental_labs", "medical_dental_ophthalmic_and_hospital_equipment_and_supplies", "medical_services", "membership_organizations", "mens_and_boys_clothing_and_accessories_stores", "mens_womens_clothing_stores", "metal_service_centers", "miscellaneous", "miscellaneous_apparel_and_accessory_shops", "miscellaneous_auto_dealers", "miscellaneous_business_services", "miscellaneous_food_stores", "miscellaneous_general_merchandise", "miscellaneous_general_services", "miscellaneous_home_furnishing_specialty_stores", "miscellaneous_publishing_and_printing", "miscellaneous_recreation_services", "miscellaneous_repair_shops", "miscellaneous_specialty_retail", "mobile_home_dealers", "motion_picture_theaters", "motor_freight_carriers_and_trucking", "motor_homes_dealers", "motor_vehicle_supplies_and_new_parts", "motorcycle_shops_and_dealers", "motorcycle_shops_dealers", "music_stores_musical_instruments_pianos_and_sheet_music", "news_dealers_and_newsstands", "non_fi_money_orders", "non_fi_stored_value_card_purchase_load", "nondurable_goods", "nurseries_lawn_and_garden_supply_stores", "nursing_personal_care", "office_and_commercial_furniture", "opticians_eyeglasses", "optometrists_ophthalmologist", "orthopedic_goods_prosthetic_devices", "osteopaths", "package_stores_beer_wine_and_liquor", "paints_varnishes_and_supplies", "parking_lots_garages", "passenger_railways", "pawn_shops", "pet_shops_pet_food_and_supplies", "petroleum_and_petroleum_products", "photo_developing", "photographic_photocopy_microfilm_equipment_and_supplies", "photographic_studios", "picture_video_production", "piece_goods_notions_and_other_dry_goods", "plumbing_heating_equipment_and_supplies", "political_organizations", "postal_services_government_only", "precious_stones_and_metals_watches_and_jewelry", "professional_services", "public_warehousing_and_storage", "quick_copy_repro_and_blueprint", "railroads", "real_estate_agents_and_managers_rentals", "record_stores", "recreational_vehicle_rentals", "religious_goods_stores", "religious_organizations", "roofing_siding_sheet_metal", "secretarial_support_services", "security_brokers_dealers", "service_stations", "sewing_needlework_fabric_and_piece_goods_stores", "shoe_repair_hat_cleaning", "shoe_stores", "small_appliance_repair", "snowmobile_dealers", "special_trade_services", "specialty_cleaning", "sporting_goods_stores", "sporting_recreation_camps", "sports_and_riding_apparel_stores", "sports_clubs_fields", "stamp_and_coin_stores", "stationary_office_supplies_printing_and_writing_paper", "stationery_stores_office_and_school_supply_stores", "swimming_pools_sales", "t_ui_travel_germany", "tailors_alterations", "tax_payments_government_agencies", "tax_preparation_services", "taxicabs_limousines", "telecommunication_equipment_and_telephone_sales", "telecommunication_services", "telegraph_services", "tent_and_awning_shops", "testing_laboratories", "theatrical_ticket_agencies", "timeshares", "tire_retreading_and_repair", "tolls_bridge_fees", "tourist_attractions_and_exhibits", "towing_services", "trailer_parks_campgrounds", "transportation_services", "travel_agencies_tour_operators", "truck_stop_iteration", "truck_utility_trailer_rentals", "typesetting_plate_making_and_related_services", "typewriter_stores", "u_s_federal_government_agencies_or_departments", "uniforms_commercial_clothing", "used_merchandise_and_secondhand_stores", "utilities", "variety_stores", "veterinary_services", "video_amusement_game_supplies", "video_game_arcades", "video_tape_rental_stores", "vocational_trade_schools", "watch_jewelry_repair", "welding_repair", "wholesale_clubs", "wig_and_toupee_stores", "wires_money_orders", "womens_accessory_and_specialty_shops", "womens_ready_to_wear_stores", "wrecking_and_salvage_yards" ], "type": "string" }, "nullable": true, "type": "array" }, "interval": { "description": "Interval (or event) to which the amount applies.", "enum": [ "all_time", "daily", "monthly", "per_authorization", "weekly", "yearly" ], "type": "string" } }, "required": [ "amount", "interval" ], "title": "IssuingCardholderSpendingLimit", "type": "object", "x-expandableFields": [] }, "issuing_cardholder_user_terms_acceptance": { "description": "", "properties": { "date": { "description": "The Unix timestamp marking when the cardholder accepted the Authorized User Terms.", "format": "unix-time", "nullable": true, "type": "integer" }, "ip": { "description": "The IP address from which the cardholder accepted the Authorized User Terms.", "maxLength": 5000, "nullable": true, "type": "string" }, "user_agent": { "description": "The user agent of the browser from which the cardholder accepted the Authorized User Terms.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "IssuingCardholderUserTermsAcceptance", "type": "object", "x-expandableFields": [] }, "issuing_cardholder_verification": { "description": "", "properties": { "document": { "anyOf": [ { "$ref": "#/components/schemas/issuing_cardholder_id_document" } ], "description": "An identifying document, either a passport or local ID card.", "nullable": true } }, "title": "IssuingCardholderVerification", "type": "object", "x-expandableFields": [ "document" ] }, "issuing_dispute_canceled_evidence": { "description": "", "properties": { "additional_documentation": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/file" } ], "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/file" } ] } }, "canceled_at": { "description": "Date when order was canceled.", "format": "unix-time", "nullable": true, "type": "integer" }, "cancellation_policy_provided": { "description": "Whether the cardholder was provided with a cancellation policy.", "nullable": true, "type": "boolean" }, "cancellation_reason": { "description": "Reason for canceling the order.", "maxLength": 5000, "nullable": true, "type": "string" }, "expected_at": { "description": "Date when the cardholder expected to receive the product.", "format": "unix-time", "nullable": true, "type": "integer" }, "explanation": { "description": "Explanation of why the cardholder is disputing this transaction.", "maxLength": 5000, "nullable": true, "type": "string" }, "product_description": { "description": "Description of the merchandise or service that was purchased.", "maxLength": 5000, "nullable": true, "type": "string" }, "product_type": { "description": "Whether the product was a merchandise or service.", "enum": [ "merchandise", "service" ], "nullable": true, "type": "string" }, "return_status": { "description": "Result of cardholder's attempt to return the product.", "enum": [ "merchant_rejected", "successful" ], "nullable": true, "type": "string" }, "returned_at": { "description": "Date when the product was returned or attempted to be returned.", "format": "unix-time", "nullable": true, "type": "integer" } }, "title": "IssuingDisputeCanceledEvidence", "type": "object", "x-expandableFields": [ "additional_documentation" ] }, "issuing_dispute_duplicate_evidence": { "description": "", "properties": { "additional_documentation": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/file" } ], "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/file" } ] } }, "card_statement": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/file" } ], "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Copy of the card statement showing that the product had already been paid for.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/file" } ] } }, "cash_receipt": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/file" } ], "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Copy of the receipt showing that the product had been paid for in cash.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/file" } ] } }, "check_image": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/file" } ], "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Image of the front and back of the check that was used to pay for the product.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/file" } ] } }, "explanation": { "description": "Explanation of why the cardholder is disputing this transaction.", "maxLength": 5000, "nullable": true, "type": "string" }, "original_transaction": { "description": "Transaction (e.g., ipi_...) that the disputed transaction is a duplicate of. Of the two or more transactions that are copies of each other, this is original undisputed one.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "IssuingDisputeDuplicateEvidence", "type": "object", "x-expandableFields": [ "additional_documentation", "card_statement", "cash_receipt", "check_image" ] }, "issuing_dispute_evidence": { "description": "", "properties": { "canceled": { "$ref": "#/components/schemas/issuing_dispute_canceled_evidence" }, "duplicate": { "$ref": "#/components/schemas/issuing_dispute_duplicate_evidence" }, "fraudulent": { "$ref": "#/components/schemas/issuing_dispute_fraudulent_evidence" }, "merchandise_not_as_described": { "$ref": "#/components/schemas/issuing_dispute_merchandise_not_as_described_evidence" }, "no_valid_authorization": { "$ref": "#/components/schemas/issuing_dispute_no_valid_authorization_evidence" }, "not_received": { "$ref": "#/components/schemas/issuing_dispute_not_received_evidence" }, "other": { "$ref": "#/components/schemas/issuing_dispute_other_evidence" }, "reason": { "description": "The reason for filing the dispute. Its value will match the field containing the evidence.", "enum": [ "canceled", "duplicate", "fraudulent", "merchandise_not_as_described", "no_valid_authorization", "not_received", "other", "service_not_as_described" ], "type": "string", "x-stripeBypassValidation": true }, "service_not_as_described": { "$ref": "#/components/schemas/issuing_dispute_service_not_as_described_evidence" } }, "required": [ "reason" ], "title": "IssuingDisputeEvidence", "type": "object", "x-expandableFields": [ "canceled", "duplicate", "fraudulent", "merchandise_not_as_described", "no_valid_authorization", "not_received", "other", "service_not_as_described" ] }, "issuing_dispute_fraudulent_evidence": { "description": "", "properties": { "additional_documentation": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/file" } ], "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/file" } ] } }, "explanation": { "description": "Explanation of why the cardholder is disputing this transaction.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "IssuingDisputeFraudulentEvidence", "type": "object", "x-expandableFields": [ "additional_documentation" ] }, "issuing_dispute_merchandise_not_as_described_evidence": { "description": "", "properties": { "additional_documentation": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/file" } ], "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/file" } ] } }, "explanation": { "description": "Explanation of why the cardholder is disputing this transaction.", "maxLength": 5000, "nullable": true, "type": "string" }, "received_at": { "description": "Date when the product was received.", "format": "unix-time", "nullable": true, "type": "integer" }, "return_description": { "description": "Description of the cardholder's attempt to return the product.", "maxLength": 5000, "nullable": true, "type": "string" }, "return_status": { "description": "Result of cardholder's attempt to return the product.", "enum": [ "merchant_rejected", "successful" ], "nullable": true, "type": "string" }, "returned_at": { "description": "Date when the product was returned or attempted to be returned.", "format": "unix-time", "nullable": true, "type": "integer" } }, "title": "IssuingDisputeMerchandiseNotAsDescribedEvidence", "type": "object", "x-expandableFields": [ "additional_documentation" ] }, "issuing_dispute_no_valid_authorization_evidence": { "description": "", "properties": { "additional_documentation": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/file" } ], "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/file" } ] } }, "explanation": { "description": "Explanation of why the cardholder is disputing this transaction.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "IssuingDisputeNoValidAuthorizationEvidence", "type": "object", "x-expandableFields": [ "additional_documentation" ] }, "issuing_dispute_not_received_evidence": { "description": "", "properties": { "additional_documentation": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/file" } ], "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/file" } ] } }, "expected_at": { "description": "Date when the cardholder expected to receive the product.", "format": "unix-time", "nullable": true, "type": "integer" }, "explanation": { "description": "Explanation of why the cardholder is disputing this transaction.", "maxLength": 5000, "nullable": true, "type": "string" }, "product_description": { "description": "Description of the merchandise or service that was purchased.", "maxLength": 5000, "nullable": true, "type": "string" }, "product_type": { "description": "Whether the product was a merchandise or service.", "enum": [ "merchandise", "service" ], "nullable": true, "type": "string" } }, "title": "IssuingDisputeNotReceivedEvidence", "type": "object", "x-expandableFields": [ "additional_documentation" ] }, "issuing_dispute_other_evidence": { "description": "", "properties": { "additional_documentation": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/file" } ], "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/file" } ] } }, "explanation": { "description": "Explanation of why the cardholder is disputing this transaction.", "maxLength": 5000, "nullable": true, "type": "string" }, "product_description": { "description": "Description of the merchandise or service that was purchased.", "maxLength": 5000, "nullable": true, "type": "string" }, "product_type": { "description": "Whether the product was a merchandise or service.", "enum": [ "merchandise", "service" ], "nullable": true, "type": "string" } }, "title": "IssuingDisputeOtherEvidence", "type": "object", "x-expandableFields": [ "additional_documentation" ] }, "issuing_dispute_service_not_as_described_evidence": { "description": "", "properties": { "additional_documentation": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/file" } ], "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/file" } ] } }, "canceled_at": { "description": "Date when order was canceled.", "format": "unix-time", "nullable": true, "type": "integer" }, "cancellation_reason": { "description": "Reason for canceling the order.", "maxLength": 5000, "nullable": true, "type": "string" }, "explanation": { "description": "Explanation of why the cardholder is disputing this transaction.", "maxLength": 5000, "nullable": true, "type": "string" }, "received_at": { "description": "Date when the product was received.", "format": "unix-time", "nullable": true, "type": "integer" } }, "title": "IssuingDisputeServiceNotAsDescribedEvidence", "type": "object", "x-expandableFields": [ "additional_documentation" ] }, "issuing_dispute_treasury": { "description": "", "properties": { "debit_reversal": { "description": "The Treasury [DebitReversal](https://stripe.com/docs/api/treasury/debit_reversals) representing this Issuing dispute", "maxLength": 5000, "nullable": true, "type": "string" }, "received_debit": { "description": "The Treasury [ReceivedDebit](https://stripe.com/docs/api/treasury/received_debits) that is being disputed.", "maxLength": 5000, "type": "string" } }, "required": [ "received_debit" ], "title": "IssuingDisputeTreasury", "type": "object", "x-expandableFields": [] }, "issuing_network_token_address": { "description": "", "properties": { "line1": { "description": "The street address of the cardholder tokenizing the card.", "maxLength": 5000, "type": "string" }, "postal_code": { "description": "The postal code of the cardholder tokenizing the card.", "maxLength": 5000, "type": "string" } }, "required": [ "line1", "postal_code" ], "title": "IssuingNetworkTokenAddress", "type": "object", "x-expandableFields": [] }, "issuing_network_token_device": { "description": "", "properties": { "device_fingerprint": { "description": "An obfuscated ID derived from the device ID.", "maxLength": 5000, "type": "string" }, "ip_address": { "description": "The IP address of the device at provisioning time.", "maxLength": 5000, "type": "string" }, "location": { "description": "The geographic latitude/longitude coordinates of the device at provisioning time. The format is [+-]decimal/[+-]decimal.", "maxLength": 5000, "type": "string" }, "name": { "description": "The name of the device used for tokenization.", "maxLength": 5000, "type": "string" }, "phone_number": { "description": "The phone number of the device used for tokenization.", "maxLength": 5000, "type": "string" }, "type": { "description": "The type of device used for tokenization.", "enum": [ "other", "phone", "watch" ], "type": "string" } }, "title": "IssuingNetworkTokenDevice", "type": "object", "x-expandableFields": [] }, "issuing_network_token_mastercard": { "description": "", "properties": { "card_reference_id": { "description": "A unique reference ID from MasterCard to represent the card account number.", "maxLength": 5000, "type": "string" }, "token_reference_id": { "description": "The network-unique identifier for the token.", "maxLength": 5000, "type": "string" }, "token_requestor_id": { "description": "The ID of the entity requesting tokenization, specific to MasterCard.", "maxLength": 5000, "type": "string" }, "token_requestor_name": { "description": "The name of the entity requesting tokenization, if known. This is directly provided from MasterCard.", "maxLength": 5000, "type": "string" } }, "required": [ "token_reference_id", "token_requestor_id" ], "title": "IssuingNetworkTokenMastercard", "type": "object", "x-expandableFields": [] }, "issuing_network_token_network_data": { "description": "", "properties": { "device": { "$ref": "#/components/schemas/issuing_network_token_device" }, "mastercard": { "$ref": "#/components/schemas/issuing_network_token_mastercard" }, "type": { "description": "The network that the token is associated with. An additional hash is included with a name matching this value, containing tokenization data specific to the card network.", "enum": [ "mastercard", "visa" ], "type": "string" }, "visa": { "$ref": "#/components/schemas/issuing_network_token_visa" }, "wallet_provider": { "$ref": "#/components/schemas/issuing_network_token_wallet_provider" } }, "required": [ "type" ], "title": "IssuingNetworkTokenNetworkData", "type": "object", "x-expandableFields": [ "device", "mastercard", "visa", "wallet_provider" ] }, "issuing_network_token_visa": { "description": "", "properties": { "card_reference_id": { "description": "A unique reference ID from Visa to represent the card account number.", "maxLength": 5000, "type": "string" }, "token_reference_id": { "description": "The network-unique identifier for the token.", "maxLength": 5000, "type": "string" }, "token_requestor_id": { "description": "The ID of the entity requesting tokenization, specific to Visa.", "maxLength": 5000, "type": "string" }, "token_risk_score": { "description": "Degree of risk associated with the token between `01` and `99`, with higher number indicating higher risk. A `00` value indicates the token was not scored by Visa.", "maxLength": 5000, "type": "string" } }, "required": [ "card_reference_id", "token_reference_id", "token_requestor_id" ], "title": "IssuingNetworkTokenVisa", "type": "object", "x-expandableFields": [] }, "issuing_network_token_wallet_provider": { "description": "", "properties": { "account_id": { "description": "The wallet provider-given account ID of the digital wallet the token belongs to.", "maxLength": 5000, "type": "string" }, "account_trust_score": { "description": "An evaluation on the trustworthiness of the wallet account between 1 and 5. A higher score indicates more trustworthy.", "type": "integer" }, "card_number_source": { "description": "The method used for tokenizing a card.", "enum": [ "app", "manual", "on_file", "other" ], "type": "string" }, "cardholder_address": { "$ref": "#/components/schemas/issuing_network_token_address" }, "cardholder_name": { "description": "The name of the cardholder tokenizing the card.", "maxLength": 5000, "type": "string" }, "device_trust_score": { "description": "An evaluation on the trustworthiness of the device. A higher score indicates more trustworthy.", "type": "integer" }, "hashed_account_email_address": { "description": "The hashed email address of the cardholder's account with the wallet provider.", "maxLength": 5000, "type": "string" }, "reason_codes": { "description": "The reasons for suggested tokenization given by the card network.", "items": { "enum": [ "account_card_too_new", "account_recently_changed", "account_too_new", "account_too_new_since_launch", "additional_device", "data_expired", "defer_id_v_decision", "device_recently_lost", "good_activity_history", "has_suspended_tokens", "high_risk", "inactive_account", "long_account_tenure", "low_account_score", "low_device_score", "low_phone_number_score", "network_service_error", "outside_home_territory", "provisioning_cardholder_mismatch", "provisioning_device_and_cardholder_mismatch", "provisioning_device_mismatch", "same_device_no_prior_authentication", "same_device_successful_prior_authentication", "software_update", "suspicious_activity", "too_many_different_cardholders", "too_many_recent_attempts", "too_many_recent_tokens" ], "type": "string" }, "type": "array" }, "suggested_decision": { "description": "The recommendation on responding to the tokenization request.", "enum": [ "approve", "decline", "require_auth" ], "type": "string" }, "suggested_decision_version": { "description": "The version of the standard for mapping reason codes followed by the wallet provider.", "maxLength": 5000, "type": "string" } }, "title": "IssuingNetworkTokenWalletProvider", "type": "object", "x-expandableFields": [ "cardholder_address" ] }, "issuing_personalization_design_carrier_text": { "description": "", "properties": { "footer_body": { "description": "The footer body text of the carrier letter.", "maxLength": 5000, "nullable": true, "type": "string" }, "footer_title": { "description": "The footer title text of the carrier letter.", "maxLength": 5000, "nullable": true, "type": "string" }, "header_body": { "description": "The header body text of the carrier letter.", "maxLength": 5000, "nullable": true, "type": "string" }, "header_title": { "description": "The header title text of the carrier letter.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "IssuingPersonalizationDesignCarrierText", "type": "object", "x-expandableFields": [] }, "issuing_personalization_design_preferences": { "description": "", "properties": { "is_default": { "description": "Whether we use this personalization design to create cards when one isn't specified. A connected account uses the Connect platform's default design if no personalization design is set as the default design.", "type": "boolean" }, "is_platform_default": { "description": "Whether this personalization design is used to create cards when one is not specified and a default for this connected account does not exist.", "nullable": true, "type": "boolean" } }, "required": [ "is_default" ], "title": "IssuingPersonalizationDesignPreferences", "type": "object", "x-expandableFields": [] }, "issuing_personalization_design_rejection_reasons": { "description": "", "properties": { "card_logo": { "description": "The reason(s) the card logo was rejected.", "items": { "enum": [ "geographic_location", "inappropriate", "network_name", "non_binary_image", "non_fiat_currency", "other", "other_entity", "promotional_material" ], "type": "string" }, "nullable": true, "type": "array" }, "carrier_text": { "description": "The reason(s) the carrier text was rejected.", "items": { "enum": [ "geographic_location", "inappropriate", "network_name", "non_fiat_currency", "other", "other_entity", "promotional_material" ], "type": "string" }, "nullable": true, "type": "array" } }, "title": "IssuingPersonalizationDesignRejectionReasons", "type": "object", "x-expandableFields": [] }, "issuing_physical_bundle_features": { "description": "", "properties": { "card_logo": { "description": "The policy for how to use card logo images in a card design with this physical bundle.", "enum": [ "optional", "required", "unsupported" ], "type": "string" }, "carrier_text": { "description": "The policy for how to use carrier letter text in a card design with this physical bundle.", "enum": [ "optional", "required", "unsupported" ], "type": "string" }, "second_line": { "description": "The policy for how to use a second line on a card with this physical bundle.", "enum": [ "optional", "required", "unsupported" ], "type": "string" } }, "required": [ "card_logo", "carrier_text", "second_line" ], "title": "IssuingPhysicalBundleFeatures", "type": "object", "x-expandableFields": [] }, "issuing_transaction_amount_details": { "description": "", "properties": { "atm_fee": { "description": "The fee charged by the ATM for the cash withdrawal.", "nullable": true, "type": "integer" }, "cashback_amount": { "description": "The amount of cash requested by the cardholder.", "nullable": true, "type": "integer" } }, "title": "IssuingTransactionAmountDetails", "type": "object", "x-expandableFields": [] }, "issuing_transaction_fleet_cardholder_prompt_data": { "description": "", "properties": { "driver_id": { "description": "Driver ID.", "maxLength": 5000, "nullable": true, "type": "string" }, "odometer": { "description": "Odometer reading.", "nullable": true, "type": "integer" }, "unspecified_id": { "description": "An alphanumeric ID. This field is used when a vehicle ID, driver ID, or generic ID is entered by the cardholder, but the merchant or card network did not specify the prompt type.", "maxLength": 5000, "nullable": true, "type": "string" }, "user_id": { "description": "User ID.", "maxLength": 5000, "nullable": true, "type": "string" }, "vehicle_number": { "description": "Vehicle number.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "IssuingTransactionFleetCardholderPromptData", "type": "object", "x-expandableFields": [] }, "issuing_transaction_fleet_data": { "description": "", "properties": { "cardholder_prompt_data": { "anyOf": [ { "$ref": "#/components/schemas/issuing_transaction_fleet_cardholder_prompt_data" } ], "description": "Answers to prompts presented to cardholder at point of sale.", "nullable": true }, "purchase_type": { "description": "The type of purchase. One of `fuel_purchase`, `non_fuel_purchase`, or `fuel_and_non_fuel_purchase`.", "maxLength": 5000, "nullable": true, "type": "string" }, "reported_breakdown": { "anyOf": [ { "$ref": "#/components/schemas/issuing_transaction_fleet_reported_breakdown" } ], "description": "More information about the total amount. This information is not guaranteed to be accurate as some merchants may provide unreliable data.", "nullable": true }, "service_type": { "description": "The type of fuel service. One of `non_fuel_transaction`, `full_service`, or `self_service`.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "IssuingTransactionFleetData", "type": "object", "x-expandableFields": [ "cardholder_prompt_data", "reported_breakdown" ] }, "issuing_transaction_fleet_fuel_price_data": { "description": "", "properties": { "gross_amount_decimal": { "description": "Gross fuel amount that should equal Fuel Volume multipled by Fuel Unit Cost, inclusive of taxes.", "format": "decimal", "nullable": true, "type": "string" } }, "title": "IssuingTransactionFleetFuelPriceData", "type": "object", "x-expandableFields": [] }, "issuing_transaction_fleet_non_fuel_price_data": { "description": "", "properties": { "gross_amount_decimal": { "description": "Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes.", "format": "decimal", "nullable": true, "type": "string" } }, "title": "IssuingTransactionFleetNonFuelPriceData", "type": "object", "x-expandableFields": [] }, "issuing_transaction_fleet_reported_breakdown": { "description": "", "properties": { "fuel": { "anyOf": [ { "$ref": "#/components/schemas/issuing_transaction_fleet_fuel_price_data" } ], "description": "Breakdown of fuel portion of the purchase.", "nullable": true }, "non_fuel": { "anyOf": [ { "$ref": "#/components/schemas/issuing_transaction_fleet_non_fuel_price_data" } ], "description": "Breakdown of non-fuel portion of the purchase.", "nullable": true }, "tax": { "anyOf": [ { "$ref": "#/components/schemas/issuing_transaction_fleet_tax_data" } ], "description": "Information about tax included in this transaction.", "nullable": true } }, "title": "IssuingTransactionFleetReportedBreakdown", "type": "object", "x-expandableFields": [ "fuel", "non_fuel", "tax" ] }, "issuing_transaction_fleet_tax_data": { "description": "", "properties": { "local_amount_decimal": { "description": "Amount of state or provincial Sales Tax included in the transaction amount. Null if not reported by merchant or not subject to tax.", "format": "decimal", "nullable": true, "type": "string" }, "national_amount_decimal": { "description": "Amount of national Sales Tax or VAT included in the transaction amount. Null if not reported by merchant or not subject to tax.", "format": "decimal", "nullable": true, "type": "string" } }, "title": "IssuingTransactionFleetTaxData", "type": "object", "x-expandableFields": [] }, "issuing_transaction_flight_data": { "description": "", "properties": { "departure_at": { "description": "The time that the flight departed.", "nullable": true, "type": "integer" }, "passenger_name": { "description": "The name of the passenger.", "maxLength": 5000, "nullable": true, "type": "string" }, "refundable": { "description": "Whether the ticket is refundable.", "nullable": true, "type": "boolean" }, "segments": { "description": "The legs of the trip.", "items": { "$ref": "#/components/schemas/issuing_transaction_flight_data_leg" }, "nullable": true, "type": "array" }, "travel_agency": { "description": "The travel agency that issued the ticket.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "IssuingTransactionFlightData", "type": "object", "x-expandableFields": [ "segments" ] }, "issuing_transaction_flight_data_leg": { "description": "", "properties": { "arrival_airport_code": { "description": "The three-letter IATA airport code of the flight's destination.", "maxLength": 5000, "nullable": true, "type": "string" }, "carrier": { "description": "The airline carrier code.", "maxLength": 5000, "nullable": true, "type": "string" }, "departure_airport_code": { "description": "The three-letter IATA airport code that the flight departed from.", "maxLength": 5000, "nullable": true, "type": "string" }, "flight_number": { "description": "The flight number.", "maxLength": 5000, "nullable": true, "type": "string" }, "service_class": { "description": "The flight's service class.", "maxLength": 5000, "nullable": true, "type": "string" }, "stopover_allowed": { "description": "Whether a stopover is allowed on this flight.", "nullable": true, "type": "boolean" } }, "title": "IssuingTransactionFlightDataLeg", "type": "object", "x-expandableFields": [] }, "issuing_transaction_fuel_data": { "description": "", "properties": { "industry_product_code": { "description": "[Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased.", "maxLength": 5000, "nullable": true, "type": "string" }, "quantity_decimal": { "description": "The quantity of `unit`s of fuel that was dispensed, represented as a decimal string with at most 12 decimal places.", "format": "decimal", "nullable": true, "type": "string" }, "type": { "description": "The type of fuel that was purchased. One of `diesel`, `unleaded_plus`, `unleaded_regular`, `unleaded_super`, or `other`.", "maxLength": 5000, "type": "string" }, "unit": { "description": "The units for `quantity_decimal`. One of `charging_minute`, `imperial_gallon`, `kilogram`, `kilowatt_hour`, `liter`, `pound`, `us_gallon`, or `other`.", "maxLength": 5000, "type": "string" }, "unit_cost_decimal": { "description": "The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places.", "format": "decimal", "type": "string" } }, "required": [ "type", "unit", "unit_cost_decimal" ], "title": "IssuingTransactionFuelData", "type": "object", "x-expandableFields": [] }, "issuing_transaction_lodging_data": { "description": "", "properties": { "check_in_at": { "description": "The time of checking into the lodging.", "nullable": true, "type": "integer" }, "nights": { "description": "The number of nights stayed at the lodging.", "nullable": true, "type": "integer" } }, "title": "IssuingTransactionLodgingData", "type": "object", "x-expandableFields": [] }, "issuing_transaction_network_data": { "description": "", "properties": { "authorization_code": { "description": "A code created by Stripe which is shared with the merchant to validate the authorization. This field will be populated if the authorization message was approved. The code typically starts with the letter \"S\", followed by a six-digit number. For example, \"S498162\". Please note that the code is not guaranteed to be unique across authorizations.", "maxLength": 5000, "nullable": true, "type": "string" }, "processing_date": { "description": "The date the transaction was processed by the card network. This can be different from the date the seller recorded the transaction depending on when the acquirer submits the transaction to the network.", "maxLength": 5000, "nullable": true, "type": "string" }, "transaction_id": { "description": "Unique identifier for the authorization assigned by the card network used to match subsequent messages, disputes, and transactions.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "IssuingTransactionNetworkData", "type": "object", "x-expandableFields": [] }, "issuing_transaction_purchase_details": { "description": "", "properties": { "fleet": { "anyOf": [ { "$ref": "#/components/schemas/issuing_transaction_fleet_data" } ], "description": "Fleet-specific information for transactions using Fleet cards.", "nullable": true }, "flight": { "anyOf": [ { "$ref": "#/components/schemas/issuing_transaction_flight_data" } ], "description": "Information about the flight that was purchased with this transaction.", "nullable": true }, "fuel": { "anyOf": [ { "$ref": "#/components/schemas/issuing_transaction_fuel_data" } ], "description": "Information about fuel that was purchased with this transaction.", "nullable": true }, "lodging": { "anyOf": [ { "$ref": "#/components/schemas/issuing_transaction_lodging_data" } ], "description": "Information about lodging that was purchased with this transaction.", "nullable": true }, "receipt": { "description": "The line items in the purchase.", "items": { "$ref": "#/components/schemas/issuing_transaction_receipt_data" }, "nullable": true, "type": "array" }, "reference": { "description": "A merchant-specific order number.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "IssuingTransactionPurchaseDetails", "type": "object", "x-expandableFields": [ "fleet", "flight", "fuel", "lodging", "receipt" ] }, "issuing_transaction_receipt_data": { "description": "", "properties": { "description": { "description": "The description of the item. The maximum length of this field is 26 characters.", "maxLength": 5000, "nullable": true, "type": "string" }, "quantity": { "description": "The quantity of the item.", "nullable": true, "type": "number" }, "total": { "description": "The total for this line item in cents.", "nullable": true, "type": "integer" }, "unit_cost": { "description": "The unit cost of the item in cents.", "nullable": true, "type": "integer" } }, "title": "IssuingTransactionReceiptData", "type": "object", "x-expandableFields": [] }, "issuing_transaction_treasury": { "description": "", "properties": { "received_credit": { "description": "The Treasury [ReceivedCredit](https://stripe.com/docs/api/treasury/received_credits) representing this Issuing transaction if it is a refund", "maxLength": 5000, "nullable": true, "type": "string" }, "received_debit": { "description": "The Treasury [ReceivedDebit](https://stripe.com/docs/api/treasury/received_debits) representing this Issuing transaction if it is a capture", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "IssuingTransactionTreasury", "type": "object", "x-expandableFields": [] }, "item": { "description": "A line item.", "properties": { "amount_discount": { "description": "Total discount amount applied. If no discounts were applied, defaults to 0.", "type": "integer" }, "amount_subtotal": { "description": "Total before any discounts or taxes are applied.", "type": "integer" }, "amount_tax": { "description": "Total tax amount applied. If no tax was applied, defaults to 0.", "type": "integer" }, "amount_total": { "description": "Total after discounts and taxes.", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users. Defaults to product name.", "maxLength": 5000, "nullable": true, "type": "string" }, "discounts": { "description": "The discounts applied to the line item.", "items": { "$ref": "#/components/schemas/line_items_discount_amount" }, "type": "array" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "item" ], "type": "string" }, "price": { "anyOf": [ { "$ref": "#/components/schemas/price" } ], "description": "The price used to generate the line item.", "nullable": true }, "quantity": { "description": "The quantity of products being purchased.", "nullable": true, "type": "integer" }, "taxes": { "description": "The taxes applied to the line item.", "items": { "$ref": "#/components/schemas/line_items_tax_amount" }, "type": "array" } }, "required": [ "amount_discount", "amount_subtotal", "amount_tax", "amount_total", "currency", "id", "object" ], "title": "LineItem", "type": "object", "x-expandableFields": [ "discounts", "price", "taxes" ], "x-resourceId": "item" }, "klarna_address": { "description": "", "properties": { "country": { "description": "The payer address country", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "klarna_address", "type": "object", "x-expandableFields": [] }, "klarna_payer_details": { "description": "", "properties": { "address": { "anyOf": [ { "$ref": "#/components/schemas/klarna_address" } ], "description": "The payer's address", "nullable": true } }, "title": "klarna_payer_details", "type": "object", "x-expandableFields": [ "address" ] }, "legal_entity_company": { "description": "", "properties": { "address": { "$ref": "#/components/schemas/address" }, "address_kana": { "anyOf": [ { "$ref": "#/components/schemas/legal_entity_japan_address" } ], "description": "The Kana variation of the company's primary address (Japan only).", "nullable": true }, "address_kanji": { "anyOf": [ { "$ref": "#/components/schemas/legal_entity_japan_address" } ], "description": "The Kanji variation of the company's primary address (Japan only).", "nullable": true }, "directors_provided": { "description": "Whether the company's directors have been provided. This Boolean will be `true` if you've manually indicated that all directors are provided via [the `directors_provided` parameter](https://stripe.com/docs/api/accounts/update#update_account-company-directors_provided).", "type": "boolean" }, "directorship_declaration": { "anyOf": [ { "$ref": "#/components/schemas/legal_entity_directorship_declaration" } ], "description": "This hash is used to attest that the director information provided to Stripe is both current and correct.", "nullable": true }, "executives_provided": { "description": "Whether the company's executives have been provided. This Boolean will be `true` if you've manually indicated that all executives are provided via [the `executives_provided` parameter](https://stripe.com/docs/api/accounts/update#update_account-company-executives_provided), or if Stripe determined that sufficient executives were provided.", "type": "boolean" }, "export_license_id": { "description": "The export license ID number of the company, also referred as Import Export Code (India only).", "maxLength": 5000, "type": "string" }, "export_purpose_code": { "description": "The purpose code to use for export transactions (India only).", "maxLength": 5000, "type": "string" }, "name": { "description": "The company's legal name. Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.", "maxLength": 5000, "nullable": true, "type": "string" }, "name_kana": { "description": "The Kana variation of the company's legal name (Japan only). Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.", "maxLength": 5000, "nullable": true, "type": "string" }, "name_kanji": { "description": "The Kanji variation of the company's legal name (Japan only). Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.", "maxLength": 5000, "nullable": true, "type": "string" }, "owners_provided": { "description": "Whether the company's owners have been provided. This Boolean will be `true` if you've manually indicated that all owners are provided via [the `owners_provided` parameter](https://stripe.com/docs/api/accounts/update#update_account-company-owners_provided), or if Stripe determined that sufficient owners were provided. Stripe determines ownership requirements using both the number of owners provided and their total percent ownership (calculated by adding the `percent_ownership` of each owner together).", "type": "boolean" }, "ownership_declaration": { "anyOf": [ { "$ref": "#/components/schemas/legal_entity_ubo_declaration" } ], "description": "This hash is used to attest that the beneficial owner information provided to Stripe is both current and correct.", "nullable": true }, "ownership_exemption_reason": { "description": "This value is used to determine if a business is exempt from providing ultimate beneficial owners. See [this support article](https://support.stripe.com/questions/exemption-from-providing-ownership-details) and [changelog](https://docs.stripe.com/changelog/acacia/2025-01-27/ownership-exemption-reason-accounts-api) for more details.", "enum": [ "qualified_entity_exceeds_ownership_threshold", "qualifies_as_financial_institution" ], "type": "string" }, "phone": { "description": "The company's phone number (used for verification).", "maxLength": 5000, "nullable": true, "type": "string" }, "registration_date": { "$ref": "#/components/schemas/legal_entity_registration_date" }, "structure": { "description": "The category identifying the legal structure of the company or legal entity. Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`. See [Business structure](https://stripe.com/docs/connect/identity-verification#business-structure) for more details.", "enum": [ "free_zone_establishment", "free_zone_llc", "government_instrumentality", "governmental_unit", "incorporated_non_profit", "incorporated_partnership", "limited_liability_partnership", "llc", "multi_member_llc", "private_company", "private_corporation", "private_partnership", "public_company", "public_corporation", "public_partnership", "registered_charity", "single_member_llc", "sole_establishment", "sole_proprietorship", "tax_exempt_government_instrumentality", "unincorporated_association", "unincorporated_non_profit", "unincorporated_partnership" ], "type": "string", "x-stripeBypassValidation": true }, "tax_id_provided": { "description": "Whether the company's business ID number was provided.", "type": "boolean" }, "tax_id_registrar": { "description": "The jurisdiction in which the `tax_id` is registered (Germany-based companies only).", "maxLength": 5000, "type": "string" }, "vat_id_provided": { "description": "Whether the company's business VAT number was provided.", "type": "boolean" }, "verification": { "anyOf": [ { "$ref": "#/components/schemas/legal_entity_company_verification" } ], "description": "Information on the verification state of the company.", "nullable": true } }, "title": "LegalEntityCompany", "type": "object", "x-expandableFields": [ "address", "address_kana", "address_kanji", "directorship_declaration", "ownership_declaration", "registration_date", "verification" ] }, "legal_entity_company_verification": { "description": "", "properties": { "document": { "$ref": "#/components/schemas/legal_entity_company_verification_document" } }, "required": [ "document" ], "title": "LegalEntityCompanyVerification", "type": "object", "x-expandableFields": [ "document" ] }, "legal_entity_company_verification_document": { "description": "", "properties": { "back": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/file" } ], "description": "The back of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `additional_verification`. Note that `additional_verification` files are [not downloadable](/file-upload#uploading-a-file).", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/file" } ] } }, "details": { "description": "A user-displayable string describing the verification state of this document.", "maxLength": 5000, "nullable": true, "type": "string" }, "details_code": { "description": "One of `document_corrupt`, `document_expired`, `document_failed_copy`, `document_failed_greyscale`, `document_failed_other`, `document_failed_test_mode`, `document_fraudulent`, `document_incomplete`, `document_invalid`, `document_manipulated`, `document_not_readable`, `document_not_uploaded`, `document_type_not_supported`, or `document_too_large`. A machine-readable code specifying the verification state for this document.", "maxLength": 5000, "nullable": true, "type": "string" }, "front": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/file" } ], "description": "The front of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `additional_verification`. Note that `additional_verification` files are [not downloadable](/file-upload#uploading-a-file).", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/file" } ] } } }, "title": "LegalEntityCompanyVerificationDocument", "type": "object", "x-expandableFields": [ "back", "front" ] }, "legal_entity_directorship_declaration": { "description": "", "properties": { "date": { "description": "The Unix timestamp marking when the directorship declaration attestation was made.", "format": "unix-time", "nullable": true, "type": "integer" }, "ip": { "description": "The IP address from which the directorship declaration attestation was made.", "maxLength": 5000, "nullable": true, "type": "string" }, "user_agent": { "description": "The user-agent string from the browser where the directorship declaration attestation was made.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "LegalEntityDirectorshipDeclaration", "type": "object", "x-expandableFields": [] }, "legal_entity_dob": { "description": "", "properties": { "day": { "description": "The day of birth, between 1 and 31.", "nullable": true, "type": "integer" }, "month": { "description": "The month of birth, between 1 and 12.", "nullable": true, "type": "integer" }, "year": { "description": "The four-digit year of birth.", "nullable": true, "type": "integer" } }, "title": "LegalEntityDOB", "type": "object", "x-expandableFields": [] }, "legal_entity_japan_address": { "description": "", "properties": { "city": { "description": "City/Ward.", "maxLength": 5000, "nullable": true, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "nullable": true, "type": "string" }, "line1": { "description": "Block/Building number.", "maxLength": 5000, "nullable": true, "type": "string" }, "line2": { "description": "Building details.", "maxLength": 5000, "nullable": true, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "nullable": true, "type": "string" }, "state": { "description": "Prefecture.", "maxLength": 5000, "nullable": true, "type": "string" }, "town": { "description": "Town/cho-me.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "LegalEntityJapanAddress", "type": "object", "x-expandableFields": [] }, "legal_entity_person_verification": { "description": "", "properties": { "additional_document": { "anyOf": [ { "$ref": "#/components/schemas/legal_entity_person_verification_document" } ], "description": "A document showing address, either a passport, local ID card, or utility bill from a well-known utility company.", "nullable": true }, "details": { "description": "A user-displayable string describing the verification state for the person. For example, this may say \"Provided identity information could not be verified\".", "maxLength": 5000, "nullable": true, "type": "string" }, "details_code": { "description": "One of `document_address_mismatch`, `document_dob_mismatch`, `document_duplicate_type`, `document_id_number_mismatch`, `document_name_mismatch`, `document_nationality_mismatch`, `failed_keyed_identity`, or `failed_other`. A machine-readable code specifying the verification state for the person.", "maxLength": 5000, "nullable": true, "type": "string" }, "document": { "$ref": "#/components/schemas/legal_entity_person_verification_document" }, "status": { "description": "The state of verification for the person. Possible values are `unverified`, `pending`, or `verified`. Please refer [guide](https://stripe.com/docs/connect/handling-api-verification) to handle verification updates.", "maxLength": 5000, "type": "string" } }, "required": [ "status" ], "title": "LegalEntityPersonVerification", "type": "object", "x-expandableFields": [ "additional_document", "document" ] }, "legal_entity_person_verification_document": { "description": "", "properties": { "back": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/file" } ], "description": "The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/file" } ] } }, "details": { "description": "A user-displayable string describing the verification state of this document. For example, if a document is uploaded and the picture is too fuzzy, this may say \"Identity document is too unclear to read\".", "maxLength": 5000, "nullable": true, "type": "string" }, "details_code": { "description": "One of `document_corrupt`, `document_country_not_supported`, `document_expired`, `document_failed_copy`, `document_failed_other`, `document_failed_test_mode`, `document_fraudulent`, `document_failed_greyscale`, `document_incomplete`, `document_invalid`, `document_manipulated`, `document_missing_back`, `document_missing_front`, `document_not_readable`, `document_not_uploaded`, `document_photo_mismatch`, `document_too_large`, or `document_type_not_supported`. A machine-readable code specifying the verification state for this document.", "maxLength": 5000, "nullable": true, "type": "string" }, "front": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/file" } ], "description": "The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/file" } ] } } }, "title": "LegalEntityPersonVerificationDocument", "type": "object", "x-expandableFields": [ "back", "front" ] }, "legal_entity_registration_date": { "description": "", "properties": { "day": { "description": "The day of registration, between 1 and 31.", "nullable": true, "type": "integer" }, "month": { "description": "The month of registration, between 1 and 12.", "nullable": true, "type": "integer" }, "year": { "description": "The four-digit year of registration.", "nullable": true, "type": "integer" } }, "title": "LegalEntityRegistrationDate", "type": "object", "x-expandableFields": [] }, "legal_entity_ubo_declaration": { "description": "", "properties": { "date": { "description": "The Unix timestamp marking when the beneficial owner attestation was made.", "format": "unix-time", "nullable": true, "type": "integer" }, "ip": { "description": "The IP address from which the beneficial owner attestation was made.", "maxLength": 5000, "nullable": true, "type": "string" }, "user_agent": { "description": "The user-agent string from the browser where the beneficial owner attestation was made.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "LegalEntityUBODeclaration", "type": "object", "x-expandableFields": [] }, "line_item": { "description": "Invoice Line Items represent the individual lines within an [invoice](https://stripe.com/docs/api/invoices) and only exist within the context of an invoice.\n\nEach line item is backed by either an [invoice item](https://stripe.com/docs/api/invoiceitems) or a [subscription item](https://stripe.com/docs/api/subscription_items).", "properties": { "amount": { "description": "The amount, in cents (or local equivalent).", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users.", "maxLength": 5000, "nullable": true, "type": "string" }, "discount_amounts": { "description": "The amount of discount calculated per discount for this line item.", "items": { "$ref": "#/components/schemas/discounts_resource_discount_amount" }, "nullable": true, "type": "array" }, "discountable": { "description": "If true, discounts will apply to this line item. Always false for prorations.", "type": "boolean" }, "discounts": { "description": "The discounts applied to the invoice line item. Line item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount.", "items": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/discount" } ], "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/discount" } ] } }, "type": "array" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "invoice": { "description": "The ID of the invoice that contains this line item.", "maxLength": 5000, "nullable": true, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Note that for line items with `type=subscription`, `metadata` reflects the current metadata from the subscription associated with the line item, unless the invoice line was directly updated with different metadata after creation.", "type": "object" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "line_item" ], "type": "string" }, "parent": { "anyOf": [ { "$ref": "#/components/schemas/billing_bill_resource_invoicing_lines_parents_invoice_line_item_parent" } ], "description": "The parent that generated this line item.", "nullable": true }, "period": { "$ref": "#/components/schemas/invoice_line_item_period" }, "pretax_credit_amounts": { "description": "Contains pretax credit amounts (ex: discount, credit grants, etc) that apply to this line item.", "items": { "$ref": "#/components/schemas/invoices_resource_pretax_credit_amount" }, "nullable": true, "type": "array" }, "pricing": { "anyOf": [ { "$ref": "#/components/schemas/billing_bill_resource_invoicing_pricing_pricing" } ], "description": "The pricing information of the line item.", "nullable": true }, "quantity": { "description": "The quantity of the subscription, if the line item is a subscription or a proration.", "nullable": true, "type": "integer" }, "subscription": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/subscription" } ], "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/subscription" } ] } }, "taxes": { "description": "The tax information of the line item.", "items": { "$ref": "#/components/schemas/billing_bill_resource_invoicing_taxes_tax" }, "nullable": true, "type": "array" } }, "required": [ "amount", "currency", "discountable", "discounts", "id", "livemode", "metadata", "object", "period" ], "title": "InvoiceLineItem", "type": "object", "x-expandableFields": [ "discount_amounts", "discounts", "parent", "period", "pretax_credit_amounts", "pricing", "subscription", "taxes" ], "x-resourceId": "line_item" }, "line_items_discount_amount": { "description": "", "properties": { "amount": { "description": "The amount discounted.", "type": "integer" }, "discount": { "$ref": "#/components/schemas/discount" } }, "required": [ "amount", "discount" ], "title": "LineItemsDiscountAmount", "type": "object", "x-expandableFields": [ "discount" ] }, "line_items_tax_amount": { "description": "", "properties": { "amount": { "description": "Amount of tax applied for this rate.", "type": "integer" }, "rate": { "$ref": "#/components/schemas/tax_rate" }, "taxability_reason": { "description": "The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.", "enum": [ "customer_exempt", "not_collecting", "not_subject_to_tax", "not_supported", "portion_product_exempt", "portion_reduced_rated", "portion_standard_rated", "product_exempt", "product_exempt_holiday", "proportionally_rated", "reduced_rated", "reverse_charge", "standard_rated", "taxable_basis_reduced", "zero_rated" ], "nullable": true, "type": "string", "x-stripeBypassValidation": true }, "taxable_amount": { "description": "The amount on which tax is calculated, in cents (or local equivalent).", "nullable": true, "type": "integer" } }, "required": [ "amount", "rate" ], "title": "LineItemsTaxAmount", "type": "object", "x-expandableFields": [ "rate" ] }, "linked_account_options_common": { "description": "", "properties": { "filters": { "$ref": "#/components/schemas/payment_flows_private_payment_methods_financial_connections_common_linked_account_options_filters" }, "permissions": { "description": "The list of permissions to request. The `payment_method` permission must be included.", "items": { "enum": [ "balances", "ownership", "payment_method", "transactions" ], "type": "string" }, "type": "array" }, "prefetch": { "description": "Data features requested to be retrieved upon account creation.", "items": { "enum": [ "balances", "ownership", "transactions" ], "type": "string", "x-stripeBypassValidation": true }, "nullable": true, "type": "array" }, "return_url": { "description": "For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.", "maxLength": 5000, "type": "string" } }, "title": "linked_account_options_common", "type": "object", "x-expandableFields": [ "filters" ] }, "login_link": { "description": "Login Links are single-use URLs that takes an Express account to the login page for their Stripe dashboard.\nA Login Link differs from an [Account Link](https://stripe.com/docs/api/account_links) in that it takes the user directly to their [Express dashboard for the specified account](https://stripe.com/docs/connect/integrate-express-dashboard#create-login-link)", "properties": { "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "login_link" ], "type": "string" }, "url": { "description": "The URL for the login link.", "maxLength": 5000, "type": "string" } }, "required": [ "created", "object", "url" ], "title": "LoginLink", "type": "object", "x-expandableFields": [], "x-resourceId": "login_link" }, "mandate": { "description": "A Mandate is a record of the permission that your customer gives you to debit their payment method.", "properties": { "customer_acceptance": { "$ref": "#/components/schemas/customer_acceptance" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "multi_use": { "$ref": "#/components/schemas/mandate_multi_use" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "mandate" ], "type": "string" }, "on_behalf_of": { "description": "The account (if any) that the mandate is intended for.", "maxLength": 5000, "type": "string" }, "payment_method": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/payment_method" } ], "description": "ID of the payment method associated with this mandate.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/payment_method" } ] } }, "payment_method_details": { "$ref": "#/components/schemas/mandate_payment_method_details" }, "single_use": { "$ref": "#/components/schemas/mandate_single_use" }, "status": { "description": "The mandate status indicates whether or not you can use it to initiate a payment.", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "type": { "description": "The type of the mandate.", "enum": [ "multi_use", "single_use" ], "type": "string" } }, "required": [ "customer_acceptance", "id", "livemode", "object", "payment_method", "payment_method_details", "status", "type" ], "title": "Mandate", "type": "object", "x-expandableFields": [ "customer_acceptance", "multi_use", "payment_method", "payment_method_details", "single_use" ], "x-resourceId": "mandate" }, "mandate_acss_debit": { "description": "", "properties": { "default_for": { "description": "List of Stripe products where this mandate can be selected automatically.", "items": { "enum": [ "invoice", "subscription" ], "type": "string" }, "type": "array" }, "interval_description": { "description": "Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'.", "maxLength": 5000, "nullable": true, "type": "string" }, "payment_schedule": { "description": "Payment schedule for the mandate.", "enum": [ "combined", "interval", "sporadic" ], "type": "string" }, "transaction_type": { "description": "Transaction type of the mandate.", "enum": [ "business", "personal" ], "type": "string" } }, "required": [ "payment_schedule", "transaction_type" ], "title": "mandate_acss_debit", "type": "object", "x-expandableFields": [] }, "mandate_amazon_pay": { "description": "", "properties": {}, "title": "mandate_amazon_pay", "type": "object", "x-expandableFields": [] }, "mandate_au_becs_debit": { "description": "", "properties": { "url": { "description": "The URL of the mandate. This URL generally contains sensitive information about the customer and should be shared with them exclusively.", "maxLength": 5000, "type": "string" } }, "required": [ "url" ], "title": "mandate_au_becs_debit", "type": "object", "x-expandableFields": [] }, "mandate_bacs_debit": { "description": "", "properties": { "network_status": { "description": "The status of the mandate on the Bacs network. Can be one of `pending`, `revoked`, `refused`, or `accepted`.", "enum": [ "accepted", "pending", "refused", "revoked" ], "type": "string" }, "reference": { "description": "The unique reference identifying the mandate on the Bacs network.", "maxLength": 5000, "type": "string" }, "revocation_reason": { "description": "When the mandate is revoked on the Bacs network this field displays the reason for the revocation.", "enum": [ "account_closed", "bank_account_restricted", "bank_ownership_changed", "could_not_process", "debit_not_authorized" ], "nullable": true, "type": "string" }, "url": { "description": "The URL that will contain the mandate that the customer has signed.", "maxLength": 5000, "type": "string" } }, "required": [ "network_status", "reference", "url" ], "title": "mandate_bacs_debit", "type": "object", "x-expandableFields": [] }, "mandate_cashapp": { "description": "", "properties": {}, "title": "mandate_cashapp", "type": "object", "x-expandableFields": [] }, "mandate_kakao_pay": { "description": "", "properties": {}, "title": "mandate_kakao_pay", "type": "object", "x-expandableFields": [] }, "mandate_klarna": { "description": "", "properties": {}, "title": "mandate_klarna", "type": "object", "x-expandableFields": [] }, "mandate_kr_card": { "description": "", "properties": {}, "title": "mandate_kr_card", "type": "object", "x-expandableFields": [] }, "mandate_link": { "description": "", "properties": {}, "title": "mandate_link", "type": "object", "x-expandableFields": [] }, "mandate_multi_use": { "description": "", "properties": {}, "title": "mandate_multi_use", "type": "object", "x-expandableFields": [] }, "mandate_naver_pay": { "description": "", "properties": {}, "title": "mandate_naver_pay", "type": "object", "x-expandableFields": [] }, "mandate_nz_bank_account": { "description": "", "properties": {}, "title": "mandate_nz_bank_account", "type": "object", "x-expandableFields": [] }, "mandate_payment_method_details": { "description": "", "properties": { "acss_debit": { "$ref": "#/components/schemas/mandate_acss_debit" }, "amazon_pay": { "$ref": "#/components/schemas/mandate_amazon_pay" }, "au_becs_debit": { "$ref": "#/components/schemas/mandate_au_becs_debit" }, "bacs_debit": { "$ref": "#/components/schemas/mandate_bacs_debit" }, "card": { "$ref": "#/components/schemas/card_mandate_payment_method_details" }, "cashapp": { "$ref": "#/components/schemas/mandate_cashapp" }, "kakao_pay": { "$ref": "#/components/schemas/mandate_kakao_pay" }, "klarna": { "$ref": "#/components/schemas/mandate_klarna" }, "kr_card": { "$ref": "#/components/schemas/mandate_kr_card" }, "link": { "$ref": "#/components/schemas/mandate_link" }, "naver_pay": { "$ref": "#/components/schemas/mandate_naver_pay" }, "nz_bank_account": { "$ref": "#/components/schemas/mandate_nz_bank_account" }, "paypal": { "$ref": "#/components/schemas/mandate_paypal" }, "revolut_pay": { "$ref": "#/components/schemas/mandate_revolut_pay" }, "sepa_debit": { "$ref": "#/components/schemas/mandate_sepa_debit" }, "type": { "description": "This mandate corresponds with a specific payment method type. The `payment_method_details` includes an additional hash with the same name and contains mandate information that's specific to that payment method.", "maxLength": 5000, "type": "string" }, "us_bank_account": { "$ref": "#/components/schemas/mandate_us_bank_account" } }, "required": [ "type" ], "title": "mandate_payment_method_details", "type": "object", "x-expandableFields": [ "acss_debit", "amazon_pay", "au_becs_debit", "bacs_debit", "card", "cashapp", "kakao_pay", "klarna", "kr_card", "link", "naver_pay", "nz_bank_account", "paypal", "revolut_pay", "sepa_debit", "us_bank_account" ] }, "mandate_paypal": { "description": "", "properties": { "billing_agreement_id": { "description": "The PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer.", "maxLength": 5000, "nullable": true, "type": "string" }, "payer_id": { "description": "PayPal account PayerID. This identifier uniquely identifies the PayPal customer.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "mandate_paypal", "type": "object", "x-expandableFields": [] }, "mandate_revolut_pay": { "description": "", "properties": {}, "title": "mandate_revolut_pay", "type": "object", "x-expandableFields": [] }, "mandate_sepa_debit": { "description": "", "properties": { "reference": { "description": "The unique reference of the mandate.", "maxLength": 5000, "type": "string" }, "url": { "description": "The URL of the mandate. This URL generally contains sensitive information about the customer and should be shared with them exclusively.", "maxLength": 5000, "type": "string" } }, "required": [ "reference", "url" ], "title": "mandate_sepa_debit", "type": "object", "x-expandableFields": [] }, "mandate_single_use": { "description": "", "properties": { "amount": { "description": "The amount of the payment on a single use mandate.", "type": "integer" }, "currency": { "description": "The currency of the payment on a single use mandate.", "format": "currency", "type": "string" } }, "required": [ "amount", "currency" ], "title": "mandate_single_use", "type": "object", "x-expandableFields": [] }, "mandate_us_bank_account": { "description": "", "properties": { "collection_method": { "description": "Mandate collection method", "enum": [ "paper" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "mandate_us_bank_account", "type": "object", "x-expandableFields": [] }, "networks": { "description": "", "properties": { "available": { "description": "All networks available for selection via [payment_method_options.card.network](/api/payment_intents/confirm#confirm_payment_intent-payment_method_options-card-network).", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "preferred": { "description": "The preferred network for co-branded cards. Can be `cartes_bancaires`, `mastercard`, `visa` or `invalid_preference` if requested network is not valid for the card.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "available" ], "title": "networks", "type": "object", "x-expandableFields": [] }, "notification_event_data": { "description": "", "properties": { "object": { "description": "Object containing the API resource relevant to the event. For example, an `invoice.created` event will have a full [invoice object](https://stripe.com/docs/api#invoice_object) as the value of the object key.", "type": "object" }, "previous_attributes": { "description": "Object containing the names of the updated attributes and their values prior to the event (only included in events of type `*.updated`). If an array attribute has any updated elements, this object contains the entire array. In Stripe API versions 2017-04-06 or earlier, an updated array attribute in this object includes only the updated array elements.", "type": "object" } }, "required": [ "object" ], "title": "NotificationEventData", "type": "object", "x-expandableFields": [] }, "notification_event_request": { "description": "", "properties": { "id": { "description": "ID of the API request that caused the event. If null, the event was automatic (e.g., Stripe's automatic subscription handling). Request logs are available in the [dashboard](https://dashboard.stripe.com/logs), but currently not in the API.", "maxLength": 5000, "nullable": true, "type": "string" }, "idempotency_key": { "description": "The idempotency key transmitted during the request, if any. *Note: This property is populated only for events on or after May 23, 2017*.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "NotificationEventRequest", "type": "object", "x-expandableFields": [] }, "offline_acceptance": { "description": "", "properties": {}, "title": "offline_acceptance", "type": "object", "x-expandableFields": [] }, "online_acceptance": { "description": "", "properties": { "ip_address": { "description": "The customer accepts the mandate from this IP address.", "maxLength": 5000, "nullable": true, "type": "string" }, "user_agent": { "description": "The customer accepts the mandate using the user agent of the browser.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "online_acceptance", "type": "object", "x-expandableFields": [] }, "outbound_payments_payment_method_details": { "description": "", "properties": { "billing_details": { "$ref": "#/components/schemas/treasury_shared_resource_billing_details" }, "financial_account": { "$ref": "#/components/schemas/outbound_payments_payment_method_details_financial_account" }, "type": { "description": "The type of the payment method used in the OutboundPayment.", "enum": [ "financial_account", "us_bank_account" ], "type": "string", "x-stripeBypassValidation": true }, "us_bank_account": { "$ref": "#/components/schemas/outbound_payments_payment_method_details_us_bank_account" } }, "required": [ "billing_details", "type" ], "title": "OutboundPaymentsPaymentMethodDetails", "type": "object", "x-expandableFields": [ "billing_details", "financial_account", "us_bank_account" ] }, "outbound_payments_payment_method_details_financial_account": { "description": "", "properties": { "id": { "description": "Token of the FinancialAccount.", "maxLength": 5000, "type": "string" }, "network": { "description": "The rails used to send funds.", "enum": [ "stripe" ], "type": "string" } }, "required": [ "id", "network" ], "title": "outbound_payments_payment_method_details_financial_account", "type": "object", "x-expandableFields": [] }, "outbound_payments_payment_method_details_us_bank_account": { "description": "", "properties": { "account_holder_type": { "description": "Account holder type: individual or company.", "enum": [ "company", "individual" ], "nullable": true, "type": "string" }, "account_type": { "description": "Account type: checkings or savings. Defaults to checking if omitted.", "enum": [ "checking", "savings" ], "nullable": true, "type": "string" }, "bank_name": { "description": "Name of the bank associated with the bank account.", "maxLength": 5000, "nullable": true, "type": "string" }, "fingerprint": { "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.", "maxLength": 5000, "nullable": true, "type": "string" }, "last4": { "description": "Last four digits of the bank account number.", "maxLength": 5000, "nullable": true, "type": "string" }, "mandate": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/mandate" } ], "description": "ID of the mandate used to make this payment.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/mandate" } ] } }, "network": { "description": "The network rails used. See the [docs](https://stripe.com/docs/treasury/money-movement/timelines) to learn more about money movement timelines for each network type.", "enum": [ "ach", "us_domestic_wire" ], "type": "string" }, "routing_number": { "description": "Routing number of the bank account.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "network" ], "title": "outbound_payments_payment_method_details_us_bank_account", "type": "object", "x-expandableFields": [ "mandate" ] }, "outbound_transfers_payment_method_details": { "description": "", "properties": { "billing_details": { "$ref": "#/components/schemas/treasury_shared_resource_billing_details" }, "financial_account": { "$ref": "#/components/schemas/outbound_transfers_payment_method_details_financial_account" }, "type": { "description": "The type of the payment method used in the OutboundTransfer.", "enum": [ "financial_account", "us_bank_account" ], "type": "string" }, "us_bank_account": { "$ref": "#/components/schemas/outbound_transfers_payment_method_details_us_bank_account" } }, "required": [ "billing_details", "type" ], "title": "OutboundTransfersPaymentMethodDetails", "type": "object", "x-expandableFields": [ "billing_details", "financial_account", "us_bank_account" ] }, "outbound_transfers_payment_method_details_financial_account": { "description": "", "properties": { "id": { "description": "Token of the FinancialAccount.", "maxLength": 5000, "type": "string" }, "network": { "description": "The rails used to send funds.", "enum": [ "stripe" ], "type": "string" } }, "required": [ "id", "network" ], "title": "outbound_transfers_payment_method_details_financial_account", "type": "object", "x-expandableFields": [] }, "outbound_transfers_payment_method_details_us_bank_account": { "description": "", "properties": { "account_holder_type": { "description": "Account holder type: individual or company.", "enum": [ "company", "individual" ], "nullable": true, "type": "string" }, "account_type": { "description": "Account type: checkings or savings. Defaults to checking if omitted.", "enum": [ "checking", "savings" ], "nullable": true, "type": "string" }, "bank_name": { "description": "Name of the bank associated with the bank account.", "maxLength": 5000, "nullable": true, "type": "string" }, "fingerprint": { "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.", "maxLength": 5000, "nullable": true, "type": "string" }, "last4": { "description": "Last four digits of the bank account number.", "maxLength": 5000, "nullable": true, "type": "string" }, "mandate": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/mandate" } ], "description": "ID of the mandate used to make this payment.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/mandate" } ] } }, "network": { "description": "The network rails used. See the [docs](https://stripe.com/docs/treasury/money-movement/timelines) to learn more about money movement timelines for each network type.", "enum": [ "ach", "us_domestic_wire" ], "type": "string" }, "routing_number": { "description": "Routing number of the bank account.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "network" ], "title": "outbound_transfers_payment_method_details_us_bank_account", "type": "object", "x-expandableFields": [ "mandate" ] }, "package_dimensions": { "description": "", "properties": { "height": { "description": "Height, in inches.", "type": "number" }, "length": { "description": "Length, in inches.", "type": "number" }, "weight": { "description": "Weight, in ounces.", "type": "number" }, "width": { "description": "Width, in inches.", "type": "number" } }, "required": [ "height", "length", "weight", "width" ], "title": "PackageDimensions", "type": "object", "x-expandableFields": [] }, "payment_flows_amount_details": { "description": "", "properties": { "tip": { "$ref": "#/components/schemas/payment_flows_amount_details_client_resource_tip" } }, "title": "PaymentFlowsAmountDetails", "type": "object", "x-expandableFields": [ "tip" ] }, "payment_flows_amount_details_client": { "description": "", "properties": { "tip": { "$ref": "#/components/schemas/payment_flows_amount_details_client_resource_tip" } }, "title": "PaymentFlowsAmountDetailsClient", "type": "object", "x-expandableFields": [ "tip" ] }, "payment_flows_amount_details_client_resource_tip": { "description": "", "properties": { "amount": { "description": "Portion of the amount that corresponds to a tip.", "type": "integer" } }, "title": "PaymentFlowsAmountDetailsClientResourceTip", "type": "object", "x-expandableFields": [] }, "payment_flows_automatic_payment_methods_payment_intent": { "description": "", "properties": { "allow_redirects": { "description": "Controls whether this PaymentIntent will accept redirect-based payment methods.\n\nRedirect-based payment methods may require your customer to be redirected to a payment method's app or site for authentication or additional steps. To [confirm](https://stripe.com/docs/api/payment_intents/confirm) this PaymentIntent, you may be required to provide a `return_url` to redirect customers back to your site after they authenticate or complete the payment.", "enum": [ "always", "never" ], "type": "string" }, "enabled": { "description": "Automatically calculates compatible payment methods", "type": "boolean" } }, "required": [ "enabled" ], "title": "PaymentFlowsAutomaticPaymentMethodsPaymentIntent", "type": "object", "x-expandableFields": [] }, "payment_flows_automatic_payment_methods_setup_intent": { "description": "", "properties": { "allow_redirects": { "description": "Controls whether this SetupIntent will accept redirect-based payment methods.\n\nRedirect-based payment methods may require your customer to be redirected to a payment method's app or site for authentication or additional steps. To [confirm](https://stripe.com/docs/api/setup_intents/confirm) this SetupIntent, you may be required to provide a `return_url` to redirect customers back to your site after they authenticate or complete the setup.", "enum": [ "always", "never" ], "type": "string" }, "enabled": { "description": "Automatically calculates compatible payment methods", "nullable": true, "type": "boolean" } }, "title": "PaymentFlowsAutomaticPaymentMethodsSetupIntent", "type": "object", "x-expandableFields": [] }, "payment_flows_installment_options": { "description": "", "properties": { "enabled": { "type": "boolean" }, "plan": { "$ref": "#/components/schemas/payment_method_details_card_installments_plan" } }, "required": [ "enabled" ], "title": "PaymentFlowsInstallmentOptions", "type": "object", "x-expandableFields": [ "plan" ] }, "payment_flows_payment_intent_presentment_details": { "description": "", "properties": { "presentment_amount": { "description": "Amount intended to be collected by this payment, denominated in `presentment_currency`.", "type": "integer" }, "presentment_currency": { "description": "Currency presented to the customer during payment.", "maxLength": 5000, "type": "string" } }, "required": [ "presentment_amount", "presentment_currency" ], "title": "PaymentFlowsPaymentIntentPresentmentDetails", "type": "object", "x-expandableFields": [] }, "payment_flows_private_payment_methods_alipay": { "description": "", "properties": {}, "title": "PaymentFlowsPrivatePaymentMethodsAlipay", "type": "object", "x-expandableFields": [] }, "payment_flows_private_payment_methods_alipay_details": { "description": "", "properties": { "buyer_id": { "description": "Uniquely identifies this particular Alipay account. You can use this attribute to check whether two Alipay accounts are the same.", "maxLength": 5000, "type": "string" }, "fingerprint": { "description": "Uniquely identifies this particular Alipay account. You can use this attribute to check whether two Alipay accounts are the same.", "maxLength": 5000, "nullable": true, "type": "string" }, "transaction_id": { "description": "Transaction ID of this particular Alipay transaction.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "PaymentFlowsPrivatePaymentMethodsAlipayDetails", "type": "object", "x-expandableFields": [] }, "payment_flows_private_payment_methods_card_details_api_resource_enterprise_features_extended_authorization_extended_authorization": { "description": "", "properties": { "status": { "description": "Indicates whether or not the capture window is extended beyond the standard authorization.", "enum": [ "disabled", "enabled" ], "type": "string" } }, "required": [ "status" ], "title": "PaymentFlowsPrivatePaymentMethodsCardDetailsAPIResourceEnterpriseFeaturesExtendedAuthorizationExtendedAuthorization", "type": "object", "x-expandableFields": [] }, "payment_flows_private_payment_methods_card_details_api_resource_enterprise_features_incremental_authorization_incremental_authorization": { "description": "", "properties": { "status": { "description": "Indicates whether or not the incremental authorization feature is supported.", "enum": [ "available", "unavailable" ], "type": "string" } }, "required": [ "status" ], "title": "PaymentFlowsPrivatePaymentMethodsCardDetailsAPIResourceEnterpriseFeaturesIncrementalAuthorizationIncrementalAuthorization", "type": "object", "x-expandableFields": [] }, "payment_flows_private_payment_methods_card_details_api_resource_enterprise_features_overcapture_overcapture": { "description": "", "properties": { "maximum_amount_capturable": { "description": "The maximum amount that can be captured.", "type": "integer" }, "status": { "description": "Indicates whether or not the authorized amount can be over-captured.", "enum": [ "available", "unavailable" ], "type": "string" } }, "required": [ "maximum_amount_capturable", "status" ], "title": "PaymentFlowsPrivatePaymentMethodsCardDetailsAPIResourceEnterpriseFeaturesOvercaptureOvercapture", "type": "object", "x-expandableFields": [] }, "payment_flows_private_payment_methods_card_details_api_resource_multicapture": { "description": "", "properties": { "status": { "description": "Indicates whether or not multiple captures are supported.", "enum": [ "available", "unavailable" ], "type": "string" } }, "required": [ "status" ], "title": "PaymentFlowsPrivatePaymentMethodsCardDetailsAPIResourceMulticapture", "type": "object", "x-expandableFields": [] }, "payment_flows_private_payment_methods_card_present_common_wallet": { "description": "", "properties": { "type": { "description": "The type of mobile wallet, one of `apple_pay`, `google_pay`, `samsung_pay`, or `unknown`.", "enum": [ "apple_pay", "google_pay", "samsung_pay", "unknown" ], "type": "string" } }, "required": [ "type" ], "title": "PaymentFlowsPrivatePaymentMethodsCardPresentCommonWallet", "type": "object", "x-expandableFields": [] }, "payment_flows_private_payment_methods_financial_connections_common_linked_account_options_filters": { "description": "", "properties": { "account_subcategories": { "description": "The account subcategories to use to filter for possible accounts to link. Valid subcategories are `checking` and `savings`.", "items": { "enum": [ "checking", "savings" ], "type": "string" }, "type": "array" } }, "title": "PaymentFlowsPrivatePaymentMethodsFinancialConnectionsCommonLinkedAccountOptionsFilters", "type": "object", "x-expandableFields": [] }, "payment_flows_private_payment_methods_kakao_pay_payment_method_options": { "description": "", "properties": { "capture_method": { "description": "Controls when the funds will be captured from the customer's account.", "enum": [ "manual" ], "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none", "off_session" ], "type": "string" } }, "title": "PaymentFlowsPrivatePaymentMethodsKakaoPayPaymentMethodOptions", "type": "object", "x-expandableFields": [] }, "payment_flows_private_payment_methods_klarna_dob": { "description": "", "properties": { "day": { "description": "The day of birth, between 1 and 31.", "nullable": true, "type": "integer" }, "month": { "description": "The month of birth, between 1 and 12.", "nullable": true, "type": "integer" }, "year": { "description": "The four-digit year of birth.", "nullable": true, "type": "integer" } }, "title": "PaymentFlowsPrivatePaymentMethodsKlarnaDOB", "type": "object", "x-expandableFields": [] }, "payment_flows_private_payment_methods_naver_pay_payment_method_options": { "description": "", "properties": { "capture_method": { "description": "Controls when the funds will be captured from the customer's account.", "enum": [ "manual" ], "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none", "off_session" ], "type": "string" } }, "title": "PaymentFlowsPrivatePaymentMethodsNaverPayPaymentMethodOptions", "type": "object", "x-expandableFields": [] }, "payment_flows_private_payment_methods_payco_payment_method_options": { "description": "", "properties": { "capture_method": { "description": "Controls when the funds will be captured from the customer's account.", "enum": [ "manual" ], "type": "string" } }, "title": "PaymentFlowsPrivatePaymentMethodsPaycoPaymentMethodOptions", "type": "object", "x-expandableFields": [] }, "payment_flows_private_payment_methods_samsung_pay_payment_method_options": { "description": "", "properties": { "capture_method": { "description": "Controls when the funds will be captured from the customer's account.", "enum": [ "manual" ], "type": "string" } }, "title": "PaymentFlowsPrivatePaymentMethodsSamsungPayPaymentMethodOptions", "type": "object", "x-expandableFields": [] }, "payment_intent": { "description": "A PaymentIntent guides you through the process of collecting a payment from your customer.\nWe recommend that you create exactly one PaymentIntent for each order or\ncustomer session in your system. You can reference the PaymentIntent later to\nsee the history of payment attempts for a particular session.\n\nA PaymentIntent transitions through\n[multiple statuses](https://stripe.com/docs/payments/intents#intent-statuses)\nthroughout its lifetime as it interfaces with Stripe.js to perform\nauthentication flows and ultimately creates at most one successful charge.\n\nRelated guide: [Payment Intents API](https://stripe.com/docs/payments/payment-intents)", "properties": { "amount": { "description": "Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).", "type": "integer" }, "amount_capturable": { "description": "Amount that can be captured from this PaymentIntent.", "type": "integer" }, "amount_details": { "anyOf": [ { "$ref": "#/components/schemas/payment_flows_amount_details" }, { "$ref": "#/components/schemas/payment_flows_amount_details_client" } ] }, "amount_received": { "description": "Amount that this PaymentIntent collects.", "type": "integer" }, "application": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/application" } ], "description": "ID of the Connect application that created the PaymentIntent.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/application" } ] } }, "application_fee_amount": { "description": "The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total amount captured. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).", "nullable": true, "type": "integer" }, "automatic_payment_methods": { "anyOf": [ { "$ref": "#/components/schemas/payment_flows_automatic_payment_methods_payment_intent" } ], "description": "Settings to configure compatible payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods)", "nullable": true }, "canceled_at": { "description": "Populated when `status` is `canceled`, this is the time at which the PaymentIntent was canceled. Measured in seconds since the Unix epoch.", "format": "unix-time", "nullable": true, "type": "integer" }, "cancellation_reason": { "description": "Reason for cancellation of this PaymentIntent, either user-provided (`duplicate`, `fraudulent`, `requested_by_customer`, or `abandoned`) or generated by Stripe internally (`failed_invoice`, `void_invoice`, `automatic`, or `expired`).", "enum": [ "abandoned", "automatic", "duplicate", "expired", "failed_invoice", "fraudulent", "requested_by_customer", "void_invoice" ], "nullable": true, "type": "string" }, "capture_method": { "description": "Controls when the funds will be captured from the customer's account.", "enum": [ "automatic", "automatic_async", "manual" ], "type": "string" }, "client_secret": { "description": "The client secret of this PaymentIntent. Used for client-side retrieval using a publishable key. \n\nThe client secret can be used to complete a payment from your frontend. It should not be stored, logged, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret.\n\nRefer to our docs to [accept a payment](https://stripe.com/docs/payments/accept-a-payment?ui=elements) and learn about how `client_secret` should be handled.", "maxLength": 5000, "nullable": true, "type": "string" }, "confirmation_method": { "description": "Describes whether we can confirm this PaymentIntent automatically, or if it requires customer action to confirm the payment.", "enum": [ "automatic", "manual" ], "type": "string" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "customer": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/customer" }, { "$ref": "#/components/schemas/deleted_customer" } ], "description": "ID of the Customer this PaymentIntent belongs to, if one exists.\n\nPayment methods attached to other Customers cannot be used with this PaymentIntent.\n\nIf [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/customer" }, { "$ref": "#/components/schemas/deleted_customer" } ] } }, "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users.", "maxLength": 5000, "nullable": true, "type": "string" }, "excluded_payment_method_types": { "description": "The list of payment method types to exclude from use with this payment.", "items": { "enum": [ "acss_debit", "affirm", "afterpay_clearpay", "alipay", "alma", "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", "billie", "blik", "boleto", "card", "cashapp", "crypto", "customer_balance", "eps", "fpx", "giropay", "grabpay", "ideal", "kakao_pay", "klarna", "konbini", "kr_card", "mobilepay", "multibanco", "naver_pay", "nz_bank_account", "oxxo", "p24", "pay_by_bank", "payco", "paynow", "paypal", "pix", "promptpay", "revolut_pay", "samsung_pay", "satispay", "sepa_debit", "sofort", "swish", "twint", "us_bank_account", "wechat_pay", "zip" ], "type": "string", "x-stripeBypassValidation": true }, "nullable": true, "type": "array" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "last_payment_error": { "anyOf": [ { "$ref": "#/components/schemas/api_errors" } ], "description": "The payment error encountered in the previous PaymentIntent confirmation. It will be cleared if the PaymentIntent is later updated for any reason.", "nullable": true }, "latest_charge": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/charge" } ], "description": "ID of the latest [Charge object](https://stripe.com/docs/api/charges) created by this PaymentIntent. This property is `null` until PaymentIntent confirmation is attempted.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/charge" } ] } }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Learn more about [storing information in metadata](https://stripe.com/docs/payments/payment-intents/creating-payment-intents#storing-information-in-metadata).", "type": "object" }, "next_action": { "anyOf": [ { "$ref": "#/components/schemas/payment_intent_next_action" } ], "nullable": true }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "payment_intent" ], "type": "string" }, "on_behalf_of": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/account" } ], "description": "The account (if any) for which the funds of the PaymentIntent are intended. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts) for details.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/account" } ] } }, "payment_method": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/payment_method" } ], "description": "ID of the payment method used in this PaymentIntent.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/payment_method" } ] } }, "payment_method_configuration_details": { "anyOf": [ { "$ref": "#/components/schemas/payment_method_config_biz_payment_method_configuration_details" } ], "description": "Information about the [payment method configuration](https://stripe.com/docs/api/payment_method_configurations) used for this PaymentIntent.", "nullable": true }, "payment_method_options": { "anyOf": [ { "$ref": "#/components/schemas/payment_intent_payment_method_options" } ], "description": "Payment-method-specific configuration for this PaymentIntent.", "nullable": true }, "payment_method_types": { "description": "The list of payment method types (e.g. card) that this PaymentIntent is allowed to use. A comprehensive list of valid payment method types can be found [here](https://docs.stripe.com/api/payment_methods/object#payment_method_object-type).", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "presentment_details": { "$ref": "#/components/schemas/payment_flows_payment_intent_presentment_details" }, "processing": { "anyOf": [ { "$ref": "#/components/schemas/payment_intent_processing" } ], "description": "If present, this property tells you about the processing state of the payment.", "nullable": true }, "receipt_email": { "description": "Email address that the receipt for the resulting payment will be sent to. If `receipt_email` is specified for a payment in live mode, a receipt will be sent regardless of your [email settings](https://dashboard.stripe.com/account/emails).", "maxLength": 5000, "nullable": true, "type": "string" }, "review": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/review" } ], "description": "ID of the review associated with this PaymentIntent, if any.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/review" } ] } }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "off_session", "on_session" ], "nullable": true, "type": "string" }, "shipping": { "anyOf": [ { "$ref": "#/components/schemas/shipping" } ], "description": "Shipping information for this PaymentIntent.", "nullable": true }, "statement_descriptor": { "description": "Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).\n\nSetting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead.", "maxLength": 5000, "nullable": true, "type": "string" }, "statement_descriptor_suffix": { "description": "Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement.", "maxLength": 5000, "nullable": true, "type": "string" }, "status": { "description": "Status of this PaymentIntent, one of `requires_payment_method`, `requires_confirmation`, `requires_action`, `processing`, `requires_capture`, `canceled`, or `succeeded`. Read more about each PaymentIntent [status](https://stripe.com/docs/payments/intents#intent-statuses).", "enum": [ "canceled", "processing", "requires_action", "requires_capture", "requires_confirmation", "requires_payment_method", "succeeded" ], "type": "string" }, "transfer_data": { "anyOf": [ { "$ref": "#/components/schemas/transfer_data" } ], "description": "The data that automatically creates a Transfer after the payment finalizes. Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).", "nullable": true }, "transfer_group": { "description": "A string that identifies the resulting payment as part of a group. Learn more about the [use case for connected accounts](https://stripe.com/docs/connect/separate-charges-and-transfers).", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "created", "id", "livemode", "object", "status" ], "title": "PaymentIntent", "type": "object", "x-expandableFields": [ "amount_details", "application", "automatic_payment_methods", "customer", "last_payment_error", "latest_charge", "next_action", "on_behalf_of", "payment_method", "payment_method_configuration_details", "payment_method_options", "presentment_details", "processing", "review", "shipping", "transfer_data" ], "x-resourceId": "payment_intent" }, "payment_intent_card_processing": { "description": "", "properties": { "customer_notification": { "$ref": "#/components/schemas/payment_intent_processing_customer_notification" } }, "title": "PaymentIntentCardProcessing", "type": "object", "x-expandableFields": [ "customer_notification" ] }, "payment_intent_next_action": { "description": "", "properties": { "alipay_handle_redirect": { "$ref": "#/components/schemas/payment_intent_next_action_alipay_handle_redirect" }, "boleto_display_details": { "$ref": "#/components/schemas/payment_intent_next_action_boleto" }, "card_await_notification": { "$ref": "#/components/schemas/payment_intent_next_action_card_await_notification" }, "cashapp_handle_redirect_or_display_qr_code": { "$ref": "#/components/schemas/payment_intent_next_action_cashapp_handle_redirect_or_display_qr_code" }, "display_bank_transfer_instructions": { "$ref": "#/components/schemas/payment_intent_next_action_display_bank_transfer_instructions" }, "konbini_display_details": { "$ref": "#/components/schemas/payment_intent_next_action_konbini" }, "multibanco_display_details": { "$ref": "#/components/schemas/payment_intent_next_action_display_multibanco_details" }, "oxxo_display_details": { "$ref": "#/components/schemas/payment_intent_next_action_display_oxxo_details" }, "paynow_display_qr_code": { "$ref": "#/components/schemas/payment_intent_next_action_paynow_display_qr_code" }, "pix_display_qr_code": { "$ref": "#/components/schemas/payment_intent_next_action_pix_display_qr_code" }, "promptpay_display_qr_code": { "$ref": "#/components/schemas/payment_intent_next_action_promptpay_display_qr_code" }, "redirect_to_url": { "$ref": "#/components/schemas/payment_intent_next_action_redirect_to_url" }, "swish_handle_redirect_or_display_qr_code": { "$ref": "#/components/schemas/payment_intent_next_action_swish_handle_redirect_or_display_qr_code" }, "type": { "description": "Type of the next action to perform. Refer to the other child attributes under `next_action` for available values. Examples include: `redirect_to_url`, `use_stripe_sdk`, `alipay_handle_redirect`, `oxxo_display_details`, or `verify_with_microdeposits`.", "maxLength": 5000, "type": "string" }, "use_stripe_sdk": { "description": "When confirming a PaymentIntent with Stripe.js, Stripe.js depends on the contents of this dictionary to invoke authentication flows. The shape of the contents is subject to change and is only intended to be used by Stripe.js.", "type": "object" }, "verify_with_microdeposits": { "$ref": "#/components/schemas/payment_intent_next_action_verify_with_microdeposits" }, "wechat_pay_display_qr_code": { "$ref": "#/components/schemas/payment_intent_next_action_wechat_pay_display_qr_code" }, "wechat_pay_redirect_to_android_app": { "$ref": "#/components/schemas/payment_intent_next_action_wechat_pay_redirect_to_android_app" }, "wechat_pay_redirect_to_ios_app": { "$ref": "#/components/schemas/payment_intent_next_action_wechat_pay_redirect_to_ios_app" } }, "required": [ "type" ], "title": "PaymentIntentNextAction", "type": "object", "x-expandableFields": [ "alipay_handle_redirect", "boleto_display_details", "card_await_notification", "cashapp_handle_redirect_or_display_qr_code", "display_bank_transfer_instructions", "konbini_display_details", "multibanco_display_details", "oxxo_display_details", "paynow_display_qr_code", "pix_display_qr_code", "promptpay_display_qr_code", "redirect_to_url", "swish_handle_redirect_or_display_qr_code", "verify_with_microdeposits", "wechat_pay_display_qr_code", "wechat_pay_redirect_to_android_app", "wechat_pay_redirect_to_ios_app" ] }, "payment_intent_next_action_alipay_handle_redirect": { "description": "", "properties": { "native_data": { "description": "The native data to be used with Alipay SDK you must redirect your customer to in order to authenticate the payment in an Android App.", "maxLength": 5000, "nullable": true, "type": "string" }, "native_url": { "description": "The native URL you must redirect your customer to in order to authenticate the payment in an iOS App.", "maxLength": 5000, "nullable": true, "type": "string" }, "return_url": { "description": "If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion.", "maxLength": 5000, "nullable": true, "type": "string" }, "url": { "description": "The URL you must redirect your customer to in order to authenticate the payment.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "PaymentIntentNextActionAlipayHandleRedirect", "type": "object", "x-expandableFields": [] }, "payment_intent_next_action_boleto": { "description": "", "properties": { "expires_at": { "description": "The timestamp after which the boleto expires.", "format": "unix-time", "nullable": true, "type": "integer" }, "hosted_voucher_url": { "description": "The URL to the hosted boleto voucher page, which allows customers to view the boleto voucher.", "maxLength": 5000, "nullable": true, "type": "string" }, "number": { "description": "The boleto number.", "maxLength": 5000, "nullable": true, "type": "string" }, "pdf": { "description": "The URL to the downloadable boleto voucher PDF.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "payment_intent_next_action_boleto", "type": "object", "x-expandableFields": [] }, "payment_intent_next_action_card_await_notification": { "description": "", "properties": { "charge_attempt_at": { "description": "The time that payment will be attempted. If customer approval is required, they need to provide approval before this time.", "format": "unix-time", "nullable": true, "type": "integer" }, "customer_approval_required": { "description": "For payments greater than INR 15000, the customer must provide explicit approval of the payment with their bank. For payments of lower amount, no customer action is required.", "nullable": true, "type": "boolean" } }, "title": "PaymentIntentNextActionCardAwaitNotification", "type": "object", "x-expandableFields": [] }, "payment_intent_next_action_cashapp_handle_redirect_or_display_qr_code": { "description": "", "properties": { "hosted_instructions_url": { "description": "The URL to the hosted Cash App Pay instructions page, which allows customers to view the QR code, and supports QR code refreshing on expiration.", "maxLength": 5000, "type": "string" }, "mobile_auth_url": { "description": "The url for mobile redirect based auth", "maxLength": 5000, "type": "string" }, "qr_code": { "$ref": "#/components/schemas/payment_intent_next_action_cashapp_qr_code" } }, "required": [ "hosted_instructions_url", "mobile_auth_url", "qr_code" ], "title": "PaymentIntentNextActionCashappHandleRedirectOrDisplayQrCode", "type": "object", "x-expandableFields": [ "qr_code" ] }, "payment_intent_next_action_cashapp_qr_code": { "description": "", "properties": { "expires_at": { "description": "The date (unix timestamp) when the QR code expires.", "format": "unix-time", "type": "integer" }, "image_url_png": { "description": "The image_url_png string used to render QR code", "maxLength": 5000, "type": "string" }, "image_url_svg": { "description": "The image_url_svg string used to render QR code", "maxLength": 5000, "type": "string" } }, "required": [ "expires_at", "image_url_png", "image_url_svg" ], "title": "PaymentIntentNextActionCashappQRCode", "type": "object", "x-expandableFields": [] }, "payment_intent_next_action_display_bank_transfer_instructions": { "description": "", "properties": { "amount_remaining": { "description": "The remaining amount that needs to be transferred to complete the payment.", "nullable": true, "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "nullable": true, "type": "string" }, "financial_addresses": { "description": "A list of financial addresses that can be used to fund the customer balance", "items": { "$ref": "#/components/schemas/funding_instructions_bank_transfer_financial_address" }, "type": "array" }, "hosted_instructions_url": { "description": "A link to a hosted page that guides your customer through completing the transfer.", "maxLength": 5000, "nullable": true, "type": "string" }, "reference": { "description": "A string identifying this payment. Instruct your customer to include this code in the reference or memo field of their bank transfer.", "maxLength": 5000, "nullable": true, "type": "string" }, "type": { "description": "Type of bank transfer", "enum": [ "eu_bank_transfer", "gb_bank_transfer", "jp_bank_transfer", "mx_bank_transfer", "us_bank_transfer" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "PaymentIntentNextActionDisplayBankTransferInstructions", "type": "object", "x-expandableFields": [ "financial_addresses" ] }, "payment_intent_next_action_display_multibanco_details": { "description": "", "properties": { "entity": { "description": "Entity number associated with this Multibanco payment.", "maxLength": 5000, "nullable": true, "type": "string" }, "expires_at": { "description": "The timestamp at which the Multibanco voucher expires.", "format": "unix-time", "nullable": true, "type": "integer" }, "hosted_voucher_url": { "description": "The URL for the hosted Multibanco voucher page, which allows customers to view a Multibanco voucher.", "maxLength": 5000, "nullable": true, "type": "string" }, "reference": { "description": "Reference number associated with this Multibanco payment.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "PaymentIntentNextActionDisplayMultibancoDetails", "type": "object", "x-expandableFields": [] }, "payment_intent_next_action_display_oxxo_details": { "description": "", "properties": { "expires_after": { "description": "The timestamp after which the OXXO voucher expires.", "format": "unix-time", "nullable": true, "type": "integer" }, "hosted_voucher_url": { "description": "The URL for the hosted OXXO voucher page, which allows customers to view and print an OXXO voucher.", "maxLength": 5000, "nullable": true, "type": "string" }, "number": { "description": "OXXO reference number.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "PaymentIntentNextActionDisplayOxxoDetails", "type": "object", "x-expandableFields": [] }, "payment_intent_next_action_konbini": { "description": "", "properties": { "expires_at": { "description": "The timestamp at which the pending Konbini payment expires.", "format": "unix-time", "type": "integer" }, "hosted_voucher_url": { "description": "The URL for the Konbini payment instructions page, which allows customers to view and print a Konbini voucher.", "maxLength": 5000, "nullable": true, "type": "string" }, "stores": { "$ref": "#/components/schemas/payment_intent_next_action_konbini_stores" } }, "required": [ "expires_at", "stores" ], "title": "payment_intent_next_action_konbini", "type": "object", "x-expandableFields": [ "stores" ] }, "payment_intent_next_action_konbini_familymart": { "description": "", "properties": { "confirmation_number": { "description": "The confirmation number.", "maxLength": 5000, "type": "string" }, "payment_code": { "description": "The payment code.", "maxLength": 5000, "type": "string" } }, "required": [ "payment_code" ], "title": "payment_intent_next_action_konbini_familymart", "type": "object", "x-expandableFields": [] }, "payment_intent_next_action_konbini_lawson": { "description": "", "properties": { "confirmation_number": { "description": "The confirmation number.", "maxLength": 5000, "type": "string" }, "payment_code": { "description": "The payment code.", "maxLength": 5000, "type": "string" } }, "required": [ "payment_code" ], "title": "payment_intent_next_action_konbini_lawson", "type": "object", "x-expandableFields": [] }, "payment_intent_next_action_konbini_ministop": { "description": "", "properties": { "confirmation_number": { "description": "The confirmation number.", "maxLength": 5000, "type": "string" }, "payment_code": { "description": "The payment code.", "maxLength": 5000, "type": "string" } }, "required": [ "payment_code" ], "title": "payment_intent_next_action_konbini_ministop", "type": "object", "x-expandableFields": [] }, "payment_intent_next_action_konbini_seicomart": { "description": "", "properties": { "confirmation_number": { "description": "The confirmation number.", "maxLength": 5000, "type": "string" }, "payment_code": { "description": "The payment code.", "maxLength": 5000, "type": "string" } }, "required": [ "payment_code" ], "title": "payment_intent_next_action_konbini_seicomart", "type": "object", "x-expandableFields": [] }, "payment_intent_next_action_konbini_stores": { "description": "", "properties": { "familymart": { "anyOf": [ { "$ref": "#/components/schemas/payment_intent_next_action_konbini_familymart" } ], "description": "FamilyMart instruction details.", "nullable": true }, "lawson": { "anyOf": [ { "$ref": "#/components/schemas/payment_intent_next_action_konbini_lawson" } ], "description": "Lawson instruction details.", "nullable": true }, "ministop": { "anyOf": [ { "$ref": "#/components/schemas/payment_intent_next_action_konbini_ministop" } ], "description": "Ministop instruction details.", "nullable": true }, "seicomart": { "anyOf": [ { "$ref": "#/components/schemas/payment_intent_next_action_konbini_seicomart" } ], "description": "Seicomart instruction details.", "nullable": true } }, "title": "payment_intent_next_action_konbini_stores", "type": "object", "x-expandableFields": [ "familymart", "lawson", "ministop", "seicomart" ] }, "payment_intent_next_action_paynow_display_qr_code": { "description": "", "properties": { "data": { "description": "The raw data string used to generate QR code, it should be used together with QR code library.", "maxLength": 5000, "type": "string" }, "hosted_instructions_url": { "description": "The URL to the hosted PayNow instructions page, which allows customers to view the PayNow QR code.", "maxLength": 5000, "nullable": true, "type": "string" }, "image_url_png": { "description": "The image_url_png string used to render QR code", "maxLength": 5000, "type": "string" }, "image_url_svg": { "description": "The image_url_svg string used to render QR code", "maxLength": 5000, "type": "string" } }, "required": [ "data", "image_url_png", "image_url_svg" ], "title": "PaymentIntentNextActionPaynowDisplayQrCode", "type": "object", "x-expandableFields": [] }, "payment_intent_next_action_pix_display_qr_code": { "description": "", "properties": { "data": { "description": "The raw data string used to generate QR code, it should be used together with QR code library.", "maxLength": 5000, "type": "string" }, "expires_at": { "description": "The date (unix timestamp) when the PIX expires.", "type": "integer" }, "hosted_instructions_url": { "description": "The URL to the hosted pix instructions page, which allows customers to view the pix QR code.", "maxLength": 5000, "type": "string" }, "image_url_png": { "description": "The image_url_png string used to render png QR code", "maxLength": 5000, "type": "string" }, "image_url_svg": { "description": "The image_url_svg string used to render svg QR code", "maxLength": 5000, "type": "string" } }, "title": "PaymentIntentNextActionPixDisplayQrCode", "type": "object", "x-expandableFields": [] }, "payment_intent_next_action_promptpay_display_qr_code": { "description": "", "properties": { "data": { "description": "The raw data string used to generate QR code, it should be used together with QR code library.", "maxLength": 5000, "type": "string" }, "hosted_instructions_url": { "description": "The URL to the hosted PromptPay instructions page, which allows customers to view the PromptPay QR code.", "maxLength": 5000, "type": "string" }, "image_url_png": { "description": "The PNG path used to render the QR code, can be used as the source in an HTML img tag", "maxLength": 5000, "type": "string" }, "image_url_svg": { "description": "The SVG path used to render the QR code, can be used as the source in an HTML img tag", "maxLength": 5000, "type": "string" } }, "required": [ "data", "hosted_instructions_url", "image_url_png", "image_url_svg" ], "title": "PaymentIntentNextActionPromptpayDisplayQrCode", "type": "object", "x-expandableFields": [] }, "payment_intent_next_action_redirect_to_url": { "description": "", "properties": { "return_url": { "description": "If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion.", "maxLength": 5000, "nullable": true, "type": "string" }, "url": { "description": "The URL you must redirect your customer to in order to authenticate the payment.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "PaymentIntentNextActionRedirectToUrl", "type": "object", "x-expandableFields": [] }, "payment_intent_next_action_swish_handle_redirect_or_display_qr_code": { "description": "", "properties": { "hosted_instructions_url": { "description": "The URL to the hosted Swish instructions page, which allows customers to view the QR code.", "maxLength": 5000, "type": "string" }, "qr_code": { "$ref": "#/components/schemas/payment_intent_next_action_swish_qr_code" } }, "required": [ "hosted_instructions_url", "qr_code" ], "title": "PaymentIntentNextActionSwishHandleRedirectOrDisplayQrCode", "type": "object", "x-expandableFields": [ "qr_code" ] }, "payment_intent_next_action_swish_qr_code": { "description": "", "properties": { "data": { "description": "The raw data string used to generate QR code, it should be used together with QR code library.", "maxLength": 5000, "type": "string" }, "image_url_png": { "description": "The image_url_png string used to render QR code", "maxLength": 5000, "type": "string" }, "image_url_svg": { "description": "The image_url_svg string used to render QR code", "maxLength": 5000, "type": "string" } }, "required": [ "data", "image_url_png", "image_url_svg" ], "title": "PaymentIntentNextActionSwishQRCode", "type": "object", "x-expandableFields": [] }, "payment_intent_next_action_verify_with_microdeposits": { "description": "", "properties": { "arrival_date": { "description": "The timestamp when the microdeposits are expected to land.", "format": "unix-time", "type": "integer" }, "hosted_verification_url": { "description": "The URL for the hosted verification page, which allows customers to verify their bank account.", "maxLength": 5000, "type": "string" }, "microdeposit_type": { "description": "The type of the microdeposit sent to the customer. Used to distinguish between different verification methods.", "enum": [ "amounts", "descriptor_code" ], "nullable": true, "type": "string" } }, "required": [ "arrival_date", "hosted_verification_url" ], "title": "PaymentIntentNextActionVerifyWithMicrodeposits", "type": "object", "x-expandableFields": [] }, "payment_intent_next_action_wechat_pay_display_qr_code": { "description": "", "properties": { "data": { "description": "The data being used to generate QR code", "maxLength": 5000, "type": "string" }, "hosted_instructions_url": { "description": "The URL to the hosted WeChat Pay instructions page, which allows customers to view the WeChat Pay QR code.", "maxLength": 5000, "type": "string" }, "image_data_url": { "description": "The base64 image data for a pre-generated QR code", "maxLength": 5000, "type": "string" }, "image_url_png": { "description": "The image_url_png string used to render QR code", "maxLength": 5000, "type": "string" }, "image_url_svg": { "description": "The image_url_svg string used to render QR code", "maxLength": 5000, "type": "string" } }, "required": [ "data", "hosted_instructions_url", "image_data_url", "image_url_png", "image_url_svg" ], "title": "PaymentIntentNextActionWechatPayDisplayQrCode", "type": "object", "x-expandableFields": [] }, "payment_intent_next_action_wechat_pay_redirect_to_android_app": { "description": "", "properties": { "app_id": { "description": "app_id is the APP ID registered on WeChat open platform", "maxLength": 5000, "type": "string" }, "nonce_str": { "description": "nonce_str is a random string", "maxLength": 5000, "type": "string" }, "package": { "description": "package is static value", "maxLength": 5000, "type": "string" }, "partner_id": { "description": "an unique merchant ID assigned by WeChat Pay", "maxLength": 5000, "type": "string" }, "prepay_id": { "description": "an unique trading ID assigned by WeChat Pay", "maxLength": 5000, "type": "string" }, "sign": { "description": "A signature", "maxLength": 5000, "type": "string" }, "timestamp": { "description": "Specifies the current time in epoch format", "maxLength": 5000, "type": "string" } }, "required": [ "app_id", "nonce_str", "package", "partner_id", "prepay_id", "sign", "timestamp" ], "title": "PaymentIntentNextActionWechatPayRedirectToAndroidApp", "type": "object", "x-expandableFields": [] }, "payment_intent_next_action_wechat_pay_redirect_to_ios_app": { "description": "", "properties": { "native_url": { "description": "An universal link that redirect to WeChat Pay app", "maxLength": 5000, "type": "string" } }, "required": [ "native_url" ], "title": "PaymentIntentNextActionWechatPayRedirectToIOSApp", "type": "object", "x-expandableFields": [] }, "payment_intent_payment_method_options": { "description": "", "properties": { "acss_debit": { "anyOf": [ { "$ref": "#/components/schemas/payment_intent_payment_method_options_acss_debit" }, { "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client" } ] }, "affirm": { "anyOf": [ { "$ref": "#/components/schemas/payment_method_options_affirm" }, { "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client" } ] }, "afterpay_clearpay": { "anyOf": [ { "$ref": "#/components/schemas/payment_method_options_afterpay_clearpay" }, { "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client" } ] }, "alipay": { "anyOf": [ { "$ref": "#/components/schemas/payment_method_options_alipay" }, { "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client" } ] }, "alma": { "anyOf": [ { "$ref": "#/components/schemas/payment_method_options_alma" }, { "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client" } ] }, "amazon_pay": { "anyOf": [ { "$ref": "#/components/schemas/payment_method_options_amazon_pay" }, { "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client" } ] }, "au_becs_debit": { "anyOf": [ { "$ref": "#/components/schemas/payment_intent_payment_method_options_au_becs_debit" }, { "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client" } ] }, "bacs_debit": { "anyOf": [ { "$ref": "#/components/schemas/payment_intent_payment_method_options_bacs_debit" }, { "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client" } ] }, "bancontact": { "anyOf": [ { "$ref": "#/components/schemas/payment_method_options_bancontact" }, { "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client" } ] }, "billie": { "anyOf": [ { "$ref": "#/components/schemas/payment_method_options_billie" }, { "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client" } ] }, "blik": { "anyOf": [ { "$ref": "#/components/schemas/payment_intent_payment_method_options_blik" }, { "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client" } ] }, "boleto": { "anyOf": [ { "$ref": "#/components/schemas/payment_method_options_boleto" }, { "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client" } ] }, "card": { "anyOf": [ { "$ref": "#/components/schemas/payment_intent_payment_method_options_card" }, { "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client" } ] }, "card_present": { "anyOf": [ { "$ref": "#/components/schemas/payment_method_options_card_present" }, { "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client" } ] }, "cashapp": { "anyOf": [ { "$ref": "#/components/schemas/payment_method_options_cashapp" }, { "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client" } ] }, "crypto": { "anyOf": [ { "$ref": "#/components/schemas/payment_method_options_crypto" }, { "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client" } ] }, "customer_balance": { "anyOf": [ { "$ref": "#/components/schemas/payment_method_options_customer_balance" }, { "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client" } ] }, "eps": { "anyOf": [ { "$ref": "#/components/schemas/payment_intent_payment_method_options_eps" }, { "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client" } ] }, "fpx": { "anyOf": [ { "$ref": "#/components/schemas/payment_method_options_fpx" }, { "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client" } ] }, "giropay": { "anyOf": [ { "$ref": "#/components/schemas/payment_method_options_giropay" }, { "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client" } ] }, "grabpay": { "anyOf": [ { "$ref": "#/components/schemas/payment_method_options_grabpay" }, { "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client" } ] }, "ideal": { "anyOf": [ { "$ref": "#/components/schemas/payment_method_options_ideal" }, { "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client" } ] }, "interac_present": { "anyOf": [ { "$ref": "#/components/schemas/payment_method_options_interac_present" }, { "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client" } ] }, "kakao_pay": { "anyOf": [ { "$ref": "#/components/schemas/payment_flows_private_payment_methods_kakao_pay_payment_method_options" }, { "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client" } ] }, "klarna": { "anyOf": [ { "$ref": "#/components/schemas/payment_method_options_klarna" }, { "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client" } ] }, "konbini": { "anyOf": [ { "$ref": "#/components/schemas/payment_method_options_konbini" }, { "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client" } ] }, "kr_card": { "anyOf": [ { "$ref": "#/components/schemas/payment_method_options_kr_card" }, { "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client" } ] }, "link": { "anyOf": [ { "$ref": "#/components/schemas/payment_intent_payment_method_options_link" }, { "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client" } ] }, "mobilepay": { "anyOf": [ { "$ref": "#/components/schemas/payment_intent_payment_method_options_mobilepay" }, { "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client" } ] }, "multibanco": { "anyOf": [ { "$ref": "#/components/schemas/payment_method_options_multibanco" }, { "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client" } ] }, "naver_pay": { "anyOf": [ { "$ref": "#/components/schemas/payment_flows_private_payment_methods_naver_pay_payment_method_options" }, { "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client" } ] }, "nz_bank_account": { "anyOf": [ { "$ref": "#/components/schemas/payment_intent_payment_method_options_nz_bank_account" }, { "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client" } ] }, "oxxo": { "anyOf": [ { "$ref": "#/components/schemas/payment_method_options_oxxo" }, { "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client" } ] }, "p24": { "anyOf": [ { "$ref": "#/components/schemas/payment_method_options_p24" }, { "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client" } ] }, "pay_by_bank": { "anyOf": [ { "$ref": "#/components/schemas/payment_method_options_pay_by_bank" }, { "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client" } ] }, "payco": { "anyOf": [ { "$ref": "#/components/schemas/payment_flows_private_payment_methods_payco_payment_method_options" }, { "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client" } ] }, "paynow": { "anyOf": [ { "$ref": "#/components/schemas/payment_method_options_paynow" }, { "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client" } ] }, "paypal": { "anyOf": [ { "$ref": "#/components/schemas/payment_method_options_paypal" }, { "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client" } ] }, "pix": { "anyOf": [ { "$ref": "#/components/schemas/payment_method_options_pix" }, { "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client" } ] }, "promptpay": { "anyOf": [ { "$ref": "#/components/schemas/payment_method_options_promptpay" }, { "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client" } ] }, "revolut_pay": { "anyOf": [ { "$ref": "#/components/schemas/payment_method_options_revolut_pay" }, { "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client" } ] }, "samsung_pay": { "anyOf": [ { "$ref": "#/components/schemas/payment_flows_private_payment_methods_samsung_pay_payment_method_options" }, { "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client" } ] }, "satispay": { "anyOf": [ { "$ref": "#/components/schemas/payment_method_options_satispay" }, { "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client" } ] }, "sepa_debit": { "anyOf": [ { "$ref": "#/components/schemas/payment_intent_payment_method_options_sepa_debit" }, { "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client" } ] }, "sofort": { "anyOf": [ { "$ref": "#/components/schemas/payment_method_options_sofort" }, { "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client" } ] }, "swish": { "anyOf": [ { "$ref": "#/components/schemas/payment_intent_payment_method_options_swish" }, { "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client" } ] }, "twint": { "anyOf": [ { "$ref": "#/components/schemas/payment_method_options_twint" }, { "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client" } ] }, "us_bank_account": { "anyOf": [ { "$ref": "#/components/schemas/payment_intent_payment_method_options_us_bank_account" }, { "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client" } ] }, "wechat_pay": { "anyOf": [ { "$ref": "#/components/schemas/payment_method_options_wechat_pay" }, { "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client" } ] }, "zip": { "anyOf": [ { "$ref": "#/components/schemas/payment_method_options_zip" }, { "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client" } ] } }, "title": "PaymentIntentPaymentMethodOptions", "type": "object", "x-expandableFields": [ "acss_debit", "affirm", "afterpay_clearpay", "alipay", "alma", "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", "billie", "blik", "boleto", "card", "card_present", "cashapp", "crypto", "customer_balance", "eps", "fpx", "giropay", "grabpay", "ideal", "interac_present", "kakao_pay", "klarna", "konbini", "kr_card", "link", "mobilepay", "multibanco", "naver_pay", "nz_bank_account", "oxxo", "p24", "pay_by_bank", "payco", "paynow", "paypal", "pix", "promptpay", "revolut_pay", "samsung_pay", "satispay", "sepa_debit", "sofort", "swish", "twint", "us_bank_account", "wechat_pay", "zip" ] }, "payment_intent_payment_method_options_acss_debit": { "description": "", "properties": { "mandate_options": { "$ref": "#/components/schemas/payment_intent_payment_method_options_mandate_options_acss_debit" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none", "off_session", "on_session" ], "type": "string" }, "target_date": { "description": "Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.", "maxLength": 5000, "type": "string" }, "verification_method": { "description": "Bank account verification method.", "enum": [ "automatic", "instant", "microdeposits" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "payment_intent_payment_method_options_acss_debit", "type": "object", "x-expandableFields": [ "mandate_options" ] }, "payment_intent_payment_method_options_au_becs_debit": { "description": "", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none", "off_session", "on_session" ], "type": "string" }, "target_date": { "description": "Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.", "maxLength": 5000, "type": "string" } }, "title": "payment_intent_payment_method_options_au_becs_debit", "type": "object", "x-expandableFields": [] }, "payment_intent_payment_method_options_bacs_debit": { "description": "", "properties": { "mandate_options": { "$ref": "#/components/schemas/payment_intent_payment_method_options_mandate_options_bacs_debit" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none", "off_session", "on_session" ], "type": "string" }, "target_date": { "description": "Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.", "maxLength": 5000, "type": "string" } }, "title": "payment_intent_payment_method_options_bacs_debit", "type": "object", "x-expandableFields": [ "mandate_options" ] }, "payment_intent_payment_method_options_blik": { "description": "", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "payment_intent_payment_method_options_blik", "type": "object", "x-expandableFields": [] }, "payment_intent_payment_method_options_card": { "description": "", "properties": { "capture_method": { "description": "Controls when the funds will be captured from the customer's account.", "enum": [ "manual" ], "type": "string", "x-stripeBypassValidation": true }, "installments": { "anyOf": [ { "$ref": "#/components/schemas/payment_method_options_card_installments" } ], "description": "Installment details for this payment.\n\nFor more information, see the [installments integration guide](https://stripe.com/docs/payments/installments).", "nullable": true }, "mandate_options": { "anyOf": [ { "$ref": "#/components/schemas/payment_method_options_card_mandate_options" } ], "description": "Configuration options for setting up an eMandate for cards issued in India.", "nullable": true }, "network": { "description": "Selected network to process this payment intent on. Depends on the available networks of the card attached to the payment intent. Can be only set confirm-time.", "enum": [ "amex", "cartes_bancaires", "diners", "discover", "eftpos_au", "girocard", "interac", "jcb", "link", "mastercard", "unionpay", "unknown", "visa" ], "nullable": true, "type": "string" }, "request_extended_authorization": { "description": "Request ability to [capture beyond the standard authorization validity window](https://stripe.com/docs/payments/extended-authorization) for this PaymentIntent.", "enum": [ "if_available", "never" ], "type": "string" }, "request_incremental_authorization": { "description": "Request ability to [increment the authorization](https://stripe.com/docs/payments/incremental-authorization) for this PaymentIntent.", "enum": [ "if_available", "never" ], "type": "string" }, "request_multicapture": { "description": "Request ability to make [multiple captures](https://stripe.com/docs/payments/multicapture) for this PaymentIntent.", "enum": [ "if_available", "never" ], "type": "string" }, "request_overcapture": { "description": "Request ability to [overcapture](https://stripe.com/docs/payments/overcapture) for this PaymentIntent.", "enum": [ "if_available", "never" ], "type": "string" }, "request_three_d_secure": { "description": "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.", "enum": [ "any", "automatic", "challenge" ], "nullable": true, "type": "string", "x-stripeBypassValidation": true }, "require_cvc_recollection": { "description": "When enabled, using a card that is attached to a customer will require the CVC to be provided again (i.e. using the cvc_token parameter).", "type": "boolean" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none", "off_session", "on_session" ], "type": "string" }, "statement_descriptor_suffix_kana": { "description": "Provides information about a card payment that customers see on their statements. Concatenated with the Kana prefix (shortened Kana descriptor) or Kana statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 22 characters.", "maxLength": 5000, "type": "string" }, "statement_descriptor_suffix_kanji": { "description": "Provides information about a card payment that customers see on their statements. Concatenated with the Kanji prefix (shortened Kanji descriptor) or Kanji statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 17 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 17 characters.", "maxLength": 5000, "type": "string" } }, "title": "payment_intent_payment_method_options_card", "type": "object", "x-expandableFields": [ "installments", "mandate_options" ] }, "payment_intent_payment_method_options_eps": { "description": "", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string" } }, "title": "payment_intent_payment_method_options_eps", "type": "object", "x-expandableFields": [] }, "payment_intent_payment_method_options_link": { "description": "", "properties": { "capture_method": { "description": "Controls when the funds will be captured from the customer's account.", "enum": [ "manual" ], "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none", "off_session" ], "type": "string" } }, "title": "payment_intent_payment_method_options_link", "type": "object", "x-expandableFields": [] }, "payment_intent_payment_method_options_mandate_options_acss_debit": { "description": "", "properties": { "custom_mandate_url": { "description": "A URL for custom mandate text", "maxLength": 5000, "type": "string" }, "interval_description": { "description": "Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'.", "maxLength": 5000, "nullable": true, "type": "string" }, "payment_schedule": { "description": "Payment schedule for the mandate.", "enum": [ "combined", "interval", "sporadic" ], "nullable": true, "type": "string" }, "transaction_type": { "description": "Transaction type of the mandate.", "enum": [ "business", "personal" ], "nullable": true, "type": "string" } }, "title": "payment_intent_payment_method_options_mandate_options_acss_debit", "type": "object", "x-expandableFields": [] }, "payment_intent_payment_method_options_mandate_options_bacs_debit": { "description": "", "properties": { "reference_prefix": { "description": "Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'.", "maxLength": 5000, "type": "string" } }, "title": "payment_intent_payment_method_options_mandate_options_bacs_debit", "type": "object", "x-expandableFields": [] }, "payment_intent_payment_method_options_mandate_options_sepa_debit": { "description": "", "properties": { "reference_prefix": { "description": "Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'.", "maxLength": 5000, "type": "string" } }, "title": "payment_intent_payment_method_options_mandate_options_sepa_debit", "type": "object", "x-expandableFields": [] }, "payment_intent_payment_method_options_mobilepay": { "description": "", "properties": { "capture_method": { "description": "Controls when the funds will be captured from the customer's account.", "enum": [ "manual" ], "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string" } }, "title": "payment_intent_payment_method_options_mobilepay", "type": "object", "x-expandableFields": [] }, "payment_intent_payment_method_options_nz_bank_account": { "description": "", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none", "off_session", "on_session" ], "type": "string" }, "target_date": { "description": "Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.", "maxLength": 5000, "type": "string" } }, "title": "payment_intent_payment_method_options_nz_bank_account", "type": "object", "x-expandableFields": [] }, "payment_intent_payment_method_options_sepa_debit": { "description": "", "properties": { "mandate_options": { "$ref": "#/components/schemas/payment_intent_payment_method_options_mandate_options_sepa_debit" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none", "off_session", "on_session" ], "type": "string" }, "target_date": { "description": "Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.", "maxLength": 5000, "type": "string" } }, "title": "payment_intent_payment_method_options_sepa_debit", "type": "object", "x-expandableFields": [ "mandate_options" ] }, "payment_intent_payment_method_options_swish": { "description": "", "properties": { "reference": { "description": "A reference for this payment to be displayed in the Swish app.", "maxLength": 35, "nullable": true, "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string" } }, "title": "payment_intent_payment_method_options_swish", "type": "object", "x-expandableFields": [] }, "payment_intent_payment_method_options_us_bank_account": { "description": "", "properties": { "financial_connections": { "$ref": "#/components/schemas/linked_account_options_common" }, "mandate_options": { "$ref": "#/components/schemas/payment_method_options_us_bank_account_mandate_options" }, "preferred_settlement_speed": { "description": "Preferred transaction settlement speed", "enum": [ "fastest", "standard" ], "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none", "off_session", "on_session" ], "type": "string" }, "target_date": { "description": "Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.", "maxLength": 5000, "type": "string" }, "verification_method": { "description": "Bank account verification method.", "enum": [ "automatic", "instant", "microdeposits" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "payment_intent_payment_method_options_us_bank_account", "type": "object", "x-expandableFields": [ "financial_connections", "mandate_options" ] }, "payment_intent_processing": { "description": "", "properties": { "card": { "$ref": "#/components/schemas/payment_intent_card_processing" }, "type": { "description": "Type of the payment method for which payment is in `processing` state, one of `card`.", "enum": [ "card" ], "type": "string" } }, "required": [ "type" ], "title": "PaymentIntentProcessing", "type": "object", "x-expandableFields": [ "card" ] }, "payment_intent_processing_customer_notification": { "description": "", "properties": { "approval_requested": { "description": "Whether customer approval has been requested for this payment. For payments greater than INR 15000 or mandate amount, the customer must provide explicit approval of the payment with their bank.", "nullable": true, "type": "boolean" }, "completes_at": { "description": "If customer approval is required, they need to provide approval before this time.", "format": "unix-time", "nullable": true, "type": "integer" } }, "title": "PaymentIntentProcessingCustomerNotification", "type": "object", "x-expandableFields": [] }, "payment_intent_type_specific_payment_method_options_client": { "description": "", "properties": { "capture_method": { "description": "Controls when the funds will be captured from the customer's account.", "enum": [ "manual", "manual_preferred" ], "type": "string" }, "installments": { "$ref": "#/components/schemas/payment_flows_installment_options" }, "request_incremental_authorization_support": { "description": "Request ability to [increment](https://stripe.com/docs/terminal/features/incremental-authorizations) this PaymentIntent if the combination of MCC and card brand is eligible. Check [incremental_authorization_supported](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported) in the [Confirm](https://stripe.com/docs/api/payment_intents/confirm) response to verify support.", "type": "boolean" }, "require_cvc_recollection": { "description": "When enabled, using a card that is attached to a customer will require the CVC to be provided again (i.e. using the cvc_token parameter).", "type": "boolean" }, "routing": { "$ref": "#/components/schemas/payment_method_options_card_present_routing" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none", "off_session", "on_session" ], "type": "string" }, "verification_method": { "description": "Bank account verification method.", "enum": [ "automatic", "instant", "microdeposits" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "PaymentIntentTypeSpecificPaymentMethodOptionsClient", "type": "object", "x-expandableFields": [ "installments", "routing" ] }, "payment_link": { "description": "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.\n\nWhen a customer opens a payment link it will open a new [checkout session](https://stripe.com/docs/api/checkout/sessions) to render the payment page. You can use [checkout session events](https://stripe.com/docs/api/events/types#event_types-checkout.session.completed) to track payments through payment links.\n\nRelated guide: [Payment Links API](https://stripe.com/docs/payment-links)", "properties": { "active": { "description": "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.", "type": "boolean" }, "after_completion": { "$ref": "#/components/schemas/payment_links_resource_after_completion" }, "allow_promotion_codes": { "description": "Whether user redeemable promotion codes are enabled.", "type": "boolean" }, "application": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/application" }, { "$ref": "#/components/schemas/deleted_application" } ], "description": "The ID of the Connect application that created the Payment Link.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/application" }, { "$ref": "#/components/schemas/deleted_application" } ] } }, "application_fee_amount": { "description": "The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account.", "nullable": true, "type": "integer" }, "application_fee_percent": { "description": "This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account.", "nullable": true, "type": "number" }, "automatic_tax": { "$ref": "#/components/schemas/payment_links_resource_automatic_tax" }, "billing_address_collection": { "description": "Configuration for collecting the customer's billing address. Defaults to `auto`.", "enum": [ "auto", "required" ], "type": "string" }, "consent_collection": { "anyOf": [ { "$ref": "#/components/schemas/payment_links_resource_consent_collection" } ], "description": "When set, provides configuration to gather active consent from customers.", "nullable": true }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "custom_fields": { "description": "Collect additional information from your customer using custom fields. Up to 3 fields are supported.", "items": { "$ref": "#/components/schemas/payment_links_resource_custom_fields" }, "type": "array" }, "custom_text": { "$ref": "#/components/schemas/payment_links_resource_custom_text" }, "customer_creation": { "description": "Configuration for Customer creation during checkout.", "enum": [ "always", "if_required" ], "type": "string" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "inactive_message": { "description": "The custom message to be displayed to a customer when a payment link is no longer active.", "maxLength": 5000, "nullable": true, "type": "string" }, "invoice_creation": { "anyOf": [ { "$ref": "#/components/schemas/payment_links_resource_invoice_creation" } ], "description": "Configuration for creating invoice for payment mode payment links.", "nullable": true }, "line_items": { "description": "The line items representing what is being sold.", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/item" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "PaymentLinksResourceListLineItems", "type": "object", "x-expandableFields": [ "data" ] }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "type": "object" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "payment_link" ], "type": "string" }, "on_behalf_of": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/account" } ], "description": "The account on behalf of which to charge. See the [Connect documentation](https://support.stripe.com/questions/sending-invoices-on-behalf-of-connected-accounts) for details.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/account" } ] } }, "optional_items": { "description": "The optional items presented to the customer at checkout.", "items": { "$ref": "#/components/schemas/payment_links_resource_optional_item" }, "nullable": true, "type": "array" }, "payment_intent_data": { "anyOf": [ { "$ref": "#/components/schemas/payment_links_resource_payment_intent_data" } ], "description": "Indicates the parameters to be passed to PaymentIntent creation during checkout.", "nullable": true }, "payment_method_collection": { "description": "Configuration for collecting a payment method during checkout. Defaults to `always`.", "enum": [ "always", "if_required" ], "type": "string" }, "payment_method_types": { "description": "The list of payment method types that customers can use. When `null`, Stripe will dynamically show relevant payment methods you've enabled in your [payment method settings](https://dashboard.stripe.com/settings/payment_methods).", "items": { "enum": [ "affirm", "afterpay_clearpay", "alipay", "alma", "au_becs_debit", "bacs_debit", "bancontact", "billie", "blik", "boleto", "card", "cashapp", "eps", "fpx", "giropay", "grabpay", "ideal", "klarna", "konbini", "link", "mobilepay", "multibanco", "oxxo", "p24", "pay_by_bank", "paynow", "paypal", "pix", "promptpay", "satispay", "sepa_debit", "sofort", "swish", "twint", "us_bank_account", "wechat_pay", "zip" ], "type": "string", "x-stripeBypassValidation": true }, "nullable": true, "type": "array" }, "phone_number_collection": { "$ref": "#/components/schemas/payment_links_resource_phone_number_collection" }, "restrictions": { "anyOf": [ { "$ref": "#/components/schemas/payment_links_resource_restrictions" } ], "description": "Settings that restrict the usage of a payment link.", "nullable": true }, "shipping_address_collection": { "anyOf": [ { "$ref": "#/components/schemas/payment_links_resource_shipping_address_collection" } ], "description": "Configuration for collecting the customer's shipping address.", "nullable": true }, "shipping_options": { "description": "The shipping rate options applied to the session.", "items": { "$ref": "#/components/schemas/payment_links_resource_shipping_option" }, "type": "array" }, "submit_type": { "description": "Indicates the type of transaction being performed which customizes relevant text on the page, such as the submit button.", "enum": [ "auto", "book", "donate", "pay", "subscribe" ], "type": "string" }, "subscription_data": { "anyOf": [ { "$ref": "#/components/schemas/payment_links_resource_subscription_data" } ], "description": "When creating a subscription, the specified configuration data will be used. There must be at least one line item with a recurring price to use `subscription_data`.", "nullable": true }, "tax_id_collection": { "$ref": "#/components/schemas/payment_links_resource_tax_id_collection" }, "transfer_data": { "anyOf": [ { "$ref": "#/components/schemas/payment_links_resource_transfer_data" } ], "description": "The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to.", "nullable": true }, "url": { "description": "The public URL that can be shared with customers.", "maxLength": 5000, "type": "string" } }, "required": [ "active", "after_completion", "allow_promotion_codes", "automatic_tax", "billing_address_collection", "currency", "custom_fields", "custom_text", "customer_creation", "id", "livemode", "metadata", "object", "payment_method_collection", "phone_number_collection", "shipping_options", "submit_type", "tax_id_collection", "url" ], "title": "PaymentLink", "type": "object", "x-expandableFields": [ "after_completion", "application", "automatic_tax", "consent_collection", "custom_fields", "custom_text", "invoice_creation", "line_items", "on_behalf_of", "optional_items", "payment_intent_data", "phone_number_collection", "restrictions", "shipping_address_collection", "shipping_options", "subscription_data", "tax_id_collection", "transfer_data" ], "x-resourceId": "payment_link" }, "payment_links_resource_after_completion": { "description": "", "properties": { "hosted_confirmation": { "$ref": "#/components/schemas/payment_links_resource_completion_behavior_confirmation_page" }, "redirect": { "$ref": "#/components/schemas/payment_links_resource_completion_behavior_redirect" }, "type": { "description": "The specified behavior after the purchase is complete.", "enum": [ "hosted_confirmation", "redirect" ], "type": "string" } }, "required": [ "type" ], "title": "PaymentLinksResourceAfterCompletion", "type": "object", "x-expandableFields": [ "hosted_confirmation", "redirect" ] }, "payment_links_resource_automatic_tax": { "description": "", "properties": { "enabled": { "description": "If `true`, tax will be calculated automatically using the customer's location.", "type": "boolean" }, "liability": { "anyOf": [ { "$ref": "#/components/schemas/connect_account_reference" } ], "description": "The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.", "nullable": true } }, "required": [ "enabled" ], "title": "PaymentLinksResourceAutomaticTax", "type": "object", "x-expandableFields": [ "liability" ] }, "payment_links_resource_completed_sessions": { "description": "", "properties": { "count": { "description": "The current number of checkout sessions that have been completed on the payment link which count towards the `completed_sessions` restriction to be met.", "type": "integer" }, "limit": { "description": "The maximum number of checkout sessions that can be completed for the `completed_sessions` restriction to be met.", "type": "integer" } }, "required": [ "count", "limit" ], "title": "PaymentLinksResourceCompletedSessions", "type": "object", "x-expandableFields": [] }, "payment_links_resource_completion_behavior_confirmation_page": { "description": "", "properties": { "custom_message": { "description": "The custom message that is displayed to the customer after the purchase is complete.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "PaymentLinksResourceCompletionBehaviorConfirmationPage", "type": "object", "x-expandableFields": [] }, "payment_links_resource_completion_behavior_redirect": { "description": "", "properties": { "url": { "description": "The URL the customer will be redirected to after the purchase is complete.", "maxLength": 5000, "type": "string" } }, "required": [ "url" ], "title": "PaymentLinksResourceCompletionBehaviorRedirect", "type": "object", "x-expandableFields": [] }, "payment_links_resource_consent_collection": { "description": "", "properties": { "payment_method_reuse_agreement": { "anyOf": [ { "$ref": "#/components/schemas/payment_links_resource_payment_method_reuse_agreement" } ], "description": "Settings related to the payment method reuse text shown in the Checkout UI.", "nullable": true }, "promotions": { "description": "If set to `auto`, enables the collection of customer consent for promotional communications.", "enum": [ "auto", "none" ], "nullable": true, "type": "string" }, "terms_of_service": { "description": "If set to `required`, it requires cutomers to accept the terms of service before being able to pay. If set to `none`, customers won't be shown a checkbox to accept the terms of service.", "enum": [ "none", "required" ], "nullable": true, "type": "string" } }, "title": "PaymentLinksResourceConsentCollection", "type": "object", "x-expandableFields": [ "payment_method_reuse_agreement" ] }, "payment_links_resource_custom_fields": { "description": "", "properties": { "dropdown": { "$ref": "#/components/schemas/payment_links_resource_custom_fields_dropdown" }, "key": { "description": "String of your choice that your integration can use to reconcile this field. Must be unique to this field, alphanumeric, and up to 200 characters.", "maxLength": 5000, "type": "string" }, "label": { "$ref": "#/components/schemas/payment_links_resource_custom_fields_label" }, "numeric": { "$ref": "#/components/schemas/payment_links_resource_custom_fields_numeric" }, "optional": { "description": "Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`.", "type": "boolean" }, "text": { "$ref": "#/components/schemas/payment_links_resource_custom_fields_text" }, "type": { "description": "The type of the field.", "enum": [ "dropdown", "numeric", "text" ], "type": "string" } }, "required": [ "key", "label", "optional", "type" ], "title": "PaymentLinksResourceCustomFields", "type": "object", "x-expandableFields": [ "dropdown", "label", "numeric", "text" ] }, "payment_links_resource_custom_fields_dropdown": { "description": "", "properties": { "default_value": { "description": "The value that will pre-fill on the payment page.", "maxLength": 5000, "nullable": true, "type": "string" }, "options": { "description": "The options available for the customer to select. Up to 200 options allowed.", "items": { "$ref": "#/components/schemas/payment_links_resource_custom_fields_dropdown_option" }, "type": "array" } }, "required": [ "options" ], "title": "PaymentLinksResourceCustomFieldsDropdown", "type": "object", "x-expandableFields": [ "options" ] }, "payment_links_resource_custom_fields_dropdown_option": { "description": "", "properties": { "label": { "description": "The label for the option, displayed to the customer. Up to 100 characters.", "maxLength": 5000, "type": "string" }, "value": { "description": "The value for this option, not displayed to the customer, used by your integration to reconcile the option selected by the customer. Must be unique to this option, alphanumeric, and up to 100 characters.", "maxLength": 5000, "type": "string" } }, "required": [ "label", "value" ], "title": "PaymentLinksResourceCustomFieldsDropdownOption", "type": "object", "x-expandableFields": [] }, "payment_links_resource_custom_fields_label": { "description": "", "properties": { "custom": { "description": "Custom text for the label, displayed to the customer. Up to 50 characters.", "maxLength": 5000, "nullable": true, "type": "string" }, "type": { "description": "The type of the label.", "enum": [ "custom" ], "type": "string" } }, "required": [ "type" ], "title": "PaymentLinksResourceCustomFieldsLabel", "type": "object", "x-expandableFields": [] }, "payment_links_resource_custom_fields_numeric": { "description": "", "properties": { "default_value": { "description": "The value that will pre-fill the field on the payment page.", "maxLength": 5000, "nullable": true, "type": "string" }, "maximum_length": { "description": "The maximum character length constraint for the customer's input.", "nullable": true, "type": "integer" }, "minimum_length": { "description": "The minimum character length requirement for the customer's input.", "nullable": true, "type": "integer" } }, "title": "PaymentLinksResourceCustomFieldsNumeric", "type": "object", "x-expandableFields": [] }, "payment_links_resource_custom_fields_text": { "description": "", "properties": { "default_value": { "description": "The value that will pre-fill the field on the payment page.", "maxLength": 5000, "nullable": true, "type": "string" }, "maximum_length": { "description": "The maximum character length constraint for the customer's input.", "nullable": true, "type": "integer" }, "minimum_length": { "description": "The minimum character length requirement for the customer's input.", "nullable": true, "type": "integer" } }, "title": "PaymentLinksResourceCustomFieldsText", "type": "object", "x-expandableFields": [] }, "payment_links_resource_custom_text": { "description": "", "properties": { "after_submit": { "anyOf": [ { "$ref": "#/components/schemas/payment_links_resource_custom_text_position" } ], "description": "Custom text that should be displayed after the payment confirmation button.", "nullable": true }, "shipping_address": { "anyOf": [ { "$ref": "#/components/schemas/payment_links_resource_custom_text_position" } ], "description": "Custom text that should be displayed alongside shipping address collection.", "nullable": true }, "submit": { "anyOf": [ { "$ref": "#/components/schemas/payment_links_resource_custom_text_position" } ], "description": "Custom text that should be displayed alongside the payment confirmation button.", "nullable": true }, "terms_of_service_acceptance": { "anyOf": [ { "$ref": "#/components/schemas/payment_links_resource_custom_text_position" } ], "description": "Custom text that should be displayed in place of the default terms of service agreement text.", "nullable": true } }, "title": "PaymentLinksResourceCustomText", "type": "object", "x-expandableFields": [ "after_submit", "shipping_address", "submit", "terms_of_service_acceptance" ] }, "payment_links_resource_custom_text_position": { "description": "", "properties": { "message": { "description": "Text may be up to 1200 characters in length.", "maxLength": 500, "type": "string" } }, "required": [ "message" ], "title": "PaymentLinksResourceCustomTextPosition", "type": "object", "x-expandableFields": [] }, "payment_links_resource_invoice_creation": { "description": "", "properties": { "enabled": { "description": "Enable creating an invoice on successful payment.", "type": "boolean" }, "invoice_data": { "anyOf": [ { "$ref": "#/components/schemas/payment_links_resource_invoice_settings" } ], "description": "Configuration for the invoice. Default invoice values will be used if unspecified.", "nullable": true } }, "required": [ "enabled" ], "title": "PaymentLinksResourceInvoiceCreation", "type": "object", "x-expandableFields": [ "invoice_data" ] }, "payment_links_resource_invoice_settings": { "description": "", "properties": { "account_tax_ids": { "description": "The account tax IDs associated with the invoice.", "items": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/tax_id" }, { "$ref": "#/components/schemas/deleted_tax_id" } ], "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/tax_id" }, { "$ref": "#/components/schemas/deleted_tax_id" } ] } }, "nullable": true, "type": "array" }, "custom_fields": { "description": "A list of up to 4 custom fields to be displayed on the invoice.", "items": { "$ref": "#/components/schemas/invoice_setting_custom_field" }, "nullable": true, "type": "array" }, "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users.", "maxLength": 5000, "nullable": true, "type": "string" }, "footer": { "description": "Footer to be displayed on the invoice.", "maxLength": 5000, "nullable": true, "type": "string" }, "issuer": { "anyOf": [ { "$ref": "#/components/schemas/connect_account_reference" } ], "description": "The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.", "nullable": true }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "nullable": true, "type": "object" }, "rendering_options": { "anyOf": [ { "$ref": "#/components/schemas/invoice_setting_checkout_rendering_options" } ], "description": "Options for invoice PDF rendering.", "nullable": true } }, "title": "PaymentLinksResourceInvoiceSettings", "type": "object", "x-expandableFields": [ "account_tax_ids", "custom_fields", "issuer", "rendering_options" ] }, "payment_links_resource_optional_item": { "description": "", "properties": { "adjustable_quantity": { "anyOf": [ { "$ref": "#/components/schemas/payment_links_resource_optional_item_adjustable_quantity" } ], "nullable": true }, "price": { "maxLength": 5000, "type": "string" }, "quantity": { "type": "integer" } }, "required": [ "price", "quantity" ], "title": "PaymentLinksResourceOptionalItem", "type": "object", "x-expandableFields": [ "adjustable_quantity" ] }, "payment_links_resource_optional_item_adjustable_quantity": { "description": "", "properties": { "enabled": { "description": "Set to true if the quantity can be adjusted to any non-negative integer.", "type": "boolean" }, "maximum": { "description": "The maximum quantity of this item the customer can purchase. By default this value is 99.", "nullable": true, "type": "integer" }, "minimum": { "description": "The minimum quantity of this item the customer must purchase, if they choose to purchase it. Because this item is optional, the customer will always be able to remove it from their order, even if the `minimum` configured here is greater than 0. By default this value is 0.", "nullable": true, "type": "integer" } }, "required": [ "enabled" ], "title": "PaymentLinksResourceOptionalItemAdjustableQuantity", "type": "object", "x-expandableFields": [] }, "payment_links_resource_payment_intent_data": { "description": "", "properties": { "capture_method": { "description": "Indicates when the funds will be captured from the customer's account.", "enum": [ "automatic", "automatic_async", "manual" ], "nullable": true, "type": "string" }, "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users.", "maxLength": 5000, "nullable": true, "type": "string" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will set metadata on [Payment Intents](https://stripe.com/docs/api/payment_intents) generated from this payment link.", "type": "object" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with the payment method collected during checkout.", "enum": [ "off_session", "on_session" ], "nullable": true, "type": "string" }, "statement_descriptor": { "description": "For a non-card payment, information about the charge that appears on the customer's statement when this payment succeeds in creating a charge.", "maxLength": 5000, "nullable": true, "type": "string" }, "statement_descriptor_suffix": { "description": "For a card payment, information about the charge that appears on the customer's statement when this payment succeeds in creating a charge. Concatenated with the account's statement descriptor prefix to form the complete statement descriptor.", "maxLength": 5000, "nullable": true, "type": "string" }, "transfer_group": { "description": "A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/connect/separate-charges-and-transfers) for details.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "metadata" ], "title": "PaymentLinksResourcePaymentIntentData", "type": "object", "x-expandableFields": [] }, "payment_links_resource_payment_method_reuse_agreement": { "description": "", "properties": { "position": { "description": "Determines the position and visibility of the payment method reuse agreement in the UI. When set to `auto`, Stripe's defaults will be used.\n\nWhen set to `hidden`, the payment method reuse agreement text will always be hidden in the UI.", "enum": [ "auto", "hidden" ], "type": "string" } }, "required": [ "position" ], "title": "PaymentLinksResourcePaymentMethodReuseAgreement", "type": "object", "x-expandableFields": [] }, "payment_links_resource_phone_number_collection": { "description": "", "properties": { "enabled": { "description": "If `true`, a phone number will be collected during checkout.", "type": "boolean" } }, "required": [ "enabled" ], "title": "PaymentLinksResourcePhoneNumberCollection", "type": "object", "x-expandableFields": [] }, "payment_links_resource_restrictions": { "description": "", "properties": { "completed_sessions": { "$ref": "#/components/schemas/payment_links_resource_completed_sessions" } }, "required": [ "completed_sessions" ], "title": "PaymentLinksResourceRestrictions", "type": "object", "x-expandableFields": [ "completed_sessions" ] }, "payment_links_resource_shipping_address_collection": { "description": "", "properties": { "allowed_countries": { "description": "An array of two-letter ISO country codes representing which countries Checkout should provide as options for shipping locations. Unsupported country codes: `AS, CX, CC, CU, HM, IR, KP, MH, FM, NF, MP, PW, SD, SY, UM, VI`.", "items": { "enum": [ "AC", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CV", "CW", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MK", "ML", "MM", "MN", "MO", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SZ", "TA", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VN", "VU", "WF", "WS", "XK", "YE", "YT", "ZA", "ZM", "ZW", "ZZ" ], "type": "string" }, "type": "array" } }, "required": [ "allowed_countries" ], "title": "PaymentLinksResourceShippingAddressCollection", "type": "object", "x-expandableFields": [] }, "payment_links_resource_shipping_option": { "description": "", "properties": { "shipping_amount": { "description": "A non-negative integer in cents representing how much to charge.", "type": "integer" }, "shipping_rate": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/shipping_rate" } ], "description": "The ID of the Shipping Rate to use for this shipping option.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/shipping_rate" } ] } } }, "required": [ "shipping_amount", "shipping_rate" ], "title": "PaymentLinksResourceShippingOption", "type": "object", "x-expandableFields": [ "shipping_rate" ] }, "payment_links_resource_subscription_data": { "description": "", "properties": { "description": { "description": "The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.", "maxLength": 5000, "nullable": true, "type": "string" }, "invoice_settings": { "$ref": "#/components/schemas/payment_links_resource_subscription_data_invoice_settings" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will set metadata on [Subscriptions](https://stripe.com/docs/api/subscriptions) generated from this payment link.", "type": "object" }, "trial_period_days": { "description": "Integer representing the number of trial period days before the customer is charged for the first time.", "nullable": true, "type": "integer" }, "trial_settings": { "anyOf": [ { "$ref": "#/components/schemas/subscriptions_trials_resource_trial_settings" } ], "description": "Settings related to subscription trials.", "nullable": true } }, "required": [ "invoice_settings", "metadata" ], "title": "PaymentLinksResourceSubscriptionData", "type": "object", "x-expandableFields": [ "invoice_settings", "trial_settings" ] }, "payment_links_resource_subscription_data_invoice_settings": { "description": "", "properties": { "issuer": { "$ref": "#/components/schemas/connect_account_reference" } }, "required": [ "issuer" ], "title": "PaymentLinksResourceSubscriptionDataInvoiceSettings", "type": "object", "x-expandableFields": [ "issuer" ] }, "payment_links_resource_tax_id_collection": { "description": "", "properties": { "enabled": { "description": "Indicates whether tax ID collection is enabled for the session.", "type": "boolean" }, "required": { "enum": [ "if_supported", "never" ], "type": "string" } }, "required": [ "enabled", "required" ], "title": "PaymentLinksResourceTaxIdCollection", "type": "object", "x-expandableFields": [] }, "payment_links_resource_transfer_data": { "description": "", "properties": { "amount": { "description": "The amount in cents (or local equivalent) that will be transferred to the destination account. By default, the entire amount is transferred to the destination.", "nullable": true, "type": "integer" }, "destination": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/account" } ], "description": "The connected account receiving the transfer.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/account" } ] } } }, "required": [ "destination" ], "title": "PaymentLinksResourceTransferData", "type": "object", "x-expandableFields": [ "destination" ] }, "payment_method": { "description": "PaymentMethod objects represent your customer's payment instruments.\nYou can use them with [PaymentIntents](https://stripe.com/docs/payments/payment-intents) to collect payments or save them to\nCustomer objects to store instrument details for future payments.\n\nRelated guides: [Payment Methods](https://stripe.com/docs/payments/payment-methods) and [More Payment Scenarios](https://stripe.com/docs/payments/more-payment-scenarios).", "properties": { "acss_debit": { "$ref": "#/components/schemas/payment_method_acss_debit" }, "affirm": { "$ref": "#/components/schemas/payment_method_affirm" }, "afterpay_clearpay": { "$ref": "#/components/schemas/payment_method_afterpay_clearpay" }, "alipay": { "$ref": "#/components/schemas/payment_flows_private_payment_methods_alipay" }, "allow_redisplay": { "description": "This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to “unspecified”.", "enum": [ "always", "limited", "unspecified" ], "type": "string" }, "alma": { "$ref": "#/components/schemas/payment_method_alma" }, "amazon_pay": { "$ref": "#/components/schemas/payment_method_amazon_pay" }, "au_becs_debit": { "$ref": "#/components/schemas/payment_method_au_becs_debit" }, "bacs_debit": { "$ref": "#/components/schemas/payment_method_bacs_debit" }, "bancontact": { "$ref": "#/components/schemas/payment_method_bancontact" }, "billie": { "$ref": "#/components/schemas/payment_method_billie" }, "billing_details": { "$ref": "#/components/schemas/billing_details" }, "blik": { "$ref": "#/components/schemas/payment_method_blik" }, "boleto": { "$ref": "#/components/schemas/payment_method_boleto" }, "card": { "$ref": "#/components/schemas/payment_method_card" }, "card_present": { "$ref": "#/components/schemas/payment_method_card_present" }, "cashapp": { "$ref": "#/components/schemas/payment_method_cashapp" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "crypto": { "$ref": "#/components/schemas/payment_method_crypto" }, "customer": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/customer" } ], "description": "The ID of the Customer to which this PaymentMethod is saved. This will not be set when the PaymentMethod has not been saved to a Customer.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/customer" } ] } }, "customer_balance": { "$ref": "#/components/schemas/payment_method_customer_balance" }, "eps": { "$ref": "#/components/schemas/payment_method_eps" }, "fpx": { "$ref": "#/components/schemas/payment_method_fpx" }, "giropay": { "$ref": "#/components/schemas/payment_method_giropay" }, "grabpay": { "$ref": "#/components/schemas/payment_method_grabpay" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "ideal": { "$ref": "#/components/schemas/payment_method_ideal" }, "interac_present": { "$ref": "#/components/schemas/payment_method_interac_present" }, "kakao_pay": { "$ref": "#/components/schemas/payment_method_kakao_pay" }, "klarna": { "$ref": "#/components/schemas/payment_method_klarna" }, "konbini": { "$ref": "#/components/schemas/payment_method_konbini" }, "kr_card": { "$ref": "#/components/schemas/payment_method_kr_card" }, "link": { "$ref": "#/components/schemas/payment_method_link" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "nullable": true, "type": "object" }, "mobilepay": { "$ref": "#/components/schemas/payment_method_mobilepay" }, "multibanco": { "$ref": "#/components/schemas/payment_method_multibanco" }, "naver_pay": { "$ref": "#/components/schemas/payment_method_naver_pay" }, "nz_bank_account": { "$ref": "#/components/schemas/payment_method_nz_bank_account" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "payment_method" ], "type": "string" }, "oxxo": { "$ref": "#/components/schemas/payment_method_oxxo" }, "p24": { "$ref": "#/components/schemas/payment_method_p24" }, "pay_by_bank": { "$ref": "#/components/schemas/payment_method_pay_by_bank" }, "payco": { "$ref": "#/components/schemas/payment_method_payco" }, "paynow": { "$ref": "#/components/schemas/payment_method_paynow" }, "paypal": { "$ref": "#/components/schemas/payment_method_paypal" }, "pix": { "$ref": "#/components/schemas/payment_method_pix" }, "promptpay": { "$ref": "#/components/schemas/payment_method_promptpay" }, "radar_options": { "$ref": "#/components/schemas/radar_radar_options" }, "revolut_pay": { "$ref": "#/components/schemas/payment_method_revolut_pay" }, "samsung_pay": { "$ref": "#/components/schemas/payment_method_samsung_pay" }, "satispay": { "$ref": "#/components/schemas/payment_method_satispay" }, "sepa_debit": { "$ref": "#/components/schemas/payment_method_sepa_debit" }, "sofort": { "$ref": "#/components/schemas/payment_method_sofort" }, "swish": { "$ref": "#/components/schemas/payment_method_swish" }, "twint": { "$ref": "#/components/schemas/payment_method_twint" }, "type": { "description": "The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.", "enum": [ "acss_debit", "affirm", "afterpay_clearpay", "alipay", "alma", "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", "billie", "blik", "boleto", "card", "card_present", "cashapp", "crypto", "customer_balance", "eps", "fpx", "giropay", "grabpay", "ideal", "interac_present", "kakao_pay", "klarna", "konbini", "kr_card", "link", "mobilepay", "multibanco", "naver_pay", "nz_bank_account", "oxxo", "p24", "pay_by_bank", "payco", "paynow", "paypal", "pix", "promptpay", "revolut_pay", "samsung_pay", "satispay", "sepa_debit", "sofort", "swish", "twint", "us_bank_account", "wechat_pay", "zip" ], "type": "string", "x-stripeBypassValidation": true }, "us_bank_account": { "$ref": "#/components/schemas/payment_method_us_bank_account" }, "wechat_pay": { "$ref": "#/components/schemas/payment_method_wechat_pay" }, "zip": { "$ref": "#/components/schemas/payment_method_zip" } }, "required": [ "billing_details", "created", "id", "livemode", "object", "type" ], "title": "PaymentMethod", "type": "object", "x-expandableFields": [ "acss_debit", "affirm", "afterpay_clearpay", "alipay", "alma", "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", "billie", "billing_details", "blik", "boleto", "card", "card_present", "cashapp", "crypto", "customer", "customer_balance", "eps", "fpx", "giropay", "grabpay", "ideal", "interac_present", "kakao_pay", "klarna", "konbini", "kr_card", "link", "mobilepay", "multibanco", "naver_pay", "nz_bank_account", "oxxo", "p24", "pay_by_bank", "payco", "paynow", "paypal", "pix", "promptpay", "radar_options", "revolut_pay", "samsung_pay", "satispay", "sepa_debit", "sofort", "swish", "twint", "us_bank_account", "wechat_pay", "zip" ], "x-resourceId": "payment_method" }, "payment_method_acss_debit": { "description": "", "properties": { "bank_name": { "description": "Name of the bank associated with the bank account.", "maxLength": 5000, "nullable": true, "type": "string" }, "fingerprint": { "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.", "maxLength": 5000, "nullable": true, "type": "string" }, "institution_number": { "description": "Institution number of the bank account.", "maxLength": 5000, "nullable": true, "type": "string" }, "last4": { "description": "Last four digits of the bank account number.", "maxLength": 5000, "nullable": true, "type": "string" }, "transit_number": { "description": "Transit number of the bank account.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "payment_method_acss_debit", "type": "object", "x-expandableFields": [] }, "payment_method_affirm": { "description": "", "properties": {}, "title": "payment_method_affirm", "type": "object", "x-expandableFields": [] }, "payment_method_afterpay_clearpay": { "description": "", "properties": {}, "title": "payment_method_afterpay_clearpay", "type": "object", "x-expandableFields": [] }, "payment_method_alma": { "description": "", "properties": {}, "title": "payment_method_alma", "type": "object", "x-expandableFields": [] }, "payment_method_amazon_pay": { "description": "", "properties": {}, "title": "payment_method_amazon_pay", "type": "object", "x-expandableFields": [] }, "payment_method_au_becs_debit": { "description": "", "properties": { "bsb_number": { "description": "Six-digit number identifying bank and branch associated with this bank account.", "maxLength": 5000, "nullable": true, "type": "string" }, "fingerprint": { "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.", "maxLength": 5000, "nullable": true, "type": "string" }, "last4": { "description": "Last four digits of the bank account number.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "payment_method_au_becs_debit", "type": "object", "x-expandableFields": [] }, "payment_method_bacs_debit": { "description": "", "properties": { "fingerprint": { "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.", "maxLength": 5000, "nullable": true, "type": "string" }, "last4": { "description": "Last four digits of the bank account number.", "maxLength": 5000, "nullable": true, "type": "string" }, "sort_code": { "description": "Sort code of the bank account. (e.g., `10-20-30`)", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "payment_method_bacs_debit", "type": "object", "x-expandableFields": [] }, "payment_method_bancontact": { "description": "", "properties": {}, "title": "payment_method_bancontact", "type": "object", "x-expandableFields": [] }, "payment_method_billie": { "description": "", "properties": {}, "title": "payment_method_billie", "type": "object", "x-expandableFields": [] }, "payment_method_blik": { "description": "", "properties": {}, "title": "payment_method_blik", "type": "object", "x-expandableFields": [] }, "payment_method_boleto": { "description": "", "properties": { "tax_id": { "description": "Uniquely identifies the customer tax id (CNPJ or CPF)", "maxLength": 5000, "type": "string" } }, "required": [ "tax_id" ], "title": "payment_method_boleto", "type": "object", "x-expandableFields": [] }, "payment_method_card": { "description": "", "properties": { "brand": { "description": "Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`.", "maxLength": 5000, "type": "string" }, "checks": { "anyOf": [ { "$ref": "#/components/schemas/payment_method_card_checks" } ], "description": "Checks on Card address and CVC if provided.", "nullable": true }, "country": { "description": "Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.", "maxLength": 5000, "nullable": true, "type": "string" }, "display_brand": { "description": "The brand to use when displaying the card, this accounts for customer's brand choice on dual-branded cards. Can be `american_express`, `cartes_bancaires`, `diners_club`, `discover`, `eftpos_australia`, `interac`, `jcb`, `mastercard`, `union_pay`, `visa`, or `other` and may contain more values in the future.", "maxLength": 5000, "nullable": true, "type": "string" }, "exp_month": { "description": "Two-digit number representing the card's expiration month.", "type": "integer" }, "exp_year": { "description": "Four-digit number representing the card's expiration year.", "type": "integer" }, "fingerprint": { "description": "Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.\n\n*As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*", "maxLength": 5000, "nullable": true, "type": "string" }, "funding": { "description": "Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.", "maxLength": 5000, "type": "string" }, "generated_from": { "anyOf": [ { "$ref": "#/components/schemas/payment_method_card_generated_card" } ], "description": "Details of the original PaymentMethod that created this object.", "nullable": true }, "last4": { "description": "The last four digits of the card.", "maxLength": 5000, "type": "string" }, "networks": { "anyOf": [ { "$ref": "#/components/schemas/networks" } ], "description": "Contains information about card networks that can be used to process the payment.", "nullable": true }, "regulated_status": { "description": "Status of a card based on the card issuer.", "enum": [ "regulated", "unregulated" ], "nullable": true, "type": "string" }, "three_d_secure_usage": { "anyOf": [ { "$ref": "#/components/schemas/three_d_secure_usage" } ], "description": "Contains details on how this Card may be used for 3D Secure authentication.", "nullable": true }, "wallet": { "anyOf": [ { "$ref": "#/components/schemas/payment_method_card_wallet" } ], "description": "If this Card is part of a card wallet, this contains the details of the card wallet.", "nullable": true } }, "required": [ "brand", "exp_month", "exp_year", "funding", "last4" ], "title": "payment_method_card", "type": "object", "x-expandableFields": [ "checks", "generated_from", "networks", "three_d_secure_usage", "wallet" ] }, "payment_method_card_checks": { "description": "", "properties": { "address_line1_check": { "description": "If a address line1 was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.", "maxLength": 5000, "nullable": true, "type": "string" }, "address_postal_code_check": { "description": "If a address postal code was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.", "maxLength": 5000, "nullable": true, "type": "string" }, "cvc_check": { "description": "If a CVC was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "payment_method_card_checks", "type": "object", "x-expandableFields": [] }, "payment_method_card_generated_card": { "description": "", "properties": { "charge": { "description": "The charge that created this object.", "maxLength": 5000, "nullable": true, "type": "string" }, "payment_method_details": { "anyOf": [ { "$ref": "#/components/schemas/card_generated_from_payment_method_details" } ], "description": "Transaction-specific details of the payment method used in the payment.", "nullable": true }, "setup_attempt": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/setup_attempt" } ], "description": "The ID of the SetupAttempt that generated this PaymentMethod, if any.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/setup_attempt" } ] } } }, "title": "payment_method_card_generated_card", "type": "object", "x-expandableFields": [ "payment_method_details", "setup_attempt" ] }, "payment_method_card_present": { "description": "", "properties": { "brand": { "description": "Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`.", "maxLength": 5000, "nullable": true, "type": "string" }, "brand_product": { "description": "The [product code](https://stripe.com/docs/card-product-codes) that identifies the specific program or product associated with a card.", "maxLength": 5000, "nullable": true, "type": "string" }, "cardholder_name": { "description": "The cardholder name as read from the card, in [ISO 7813](https://en.wikipedia.org/wiki/ISO/IEC_7813) format. May include alphanumeric characters, special characters and first/last name separator (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay.", "maxLength": 5000, "nullable": true, "type": "string" }, "country": { "description": "Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.", "maxLength": 5000, "nullable": true, "type": "string" }, "description": { "description": "A high-level description of the type of cards issued in this range.", "maxLength": 5000, "nullable": true, "type": "string" }, "exp_month": { "description": "Two-digit number representing the card's expiration month.", "type": "integer" }, "exp_year": { "description": "Four-digit number representing the card's expiration year.", "type": "integer" }, "fingerprint": { "description": "Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.\n\n*As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*", "maxLength": 5000, "nullable": true, "type": "string" }, "funding": { "description": "Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.", "maxLength": 5000, "nullable": true, "type": "string" }, "issuer": { "description": "The name of the card's issuing bank.", "maxLength": 5000, "nullable": true, "type": "string" }, "last4": { "description": "The last four digits of the card.", "maxLength": 5000, "nullable": true, "type": "string" }, "networks": { "anyOf": [ { "$ref": "#/components/schemas/payment_method_card_present_networks" } ], "description": "Contains information about card networks that can be used to process the payment.", "nullable": true }, "offline": { "anyOf": [ { "$ref": "#/components/schemas/payment_method_details_card_present_offline" } ], "description": "Details about payment methods collected offline.", "nullable": true }, "preferred_locales": { "description": "The languages that the issuing bank recommends using for localizing any customer-facing text, as read from the card. Referenced from EMV tag 5F2D, data encoded on the card's chip.", "items": { "maxLength": 5000, "type": "string" }, "nullable": true, "type": "array" }, "read_method": { "description": "How card details were read in this transaction.", "enum": [ "contact_emv", "contactless_emv", "contactless_magstripe_mode", "magnetic_stripe_fallback", "magnetic_stripe_track2" ], "nullable": true, "type": "string" }, "wallet": { "$ref": "#/components/schemas/payment_flows_private_payment_methods_card_present_common_wallet" } }, "required": [ "exp_month", "exp_year" ], "title": "payment_method_card_present", "type": "object", "x-expandableFields": [ "networks", "offline", "wallet" ] }, "payment_method_card_present_networks": { "description": "", "properties": { "available": { "description": "All networks available for selection via [payment_method_options.card.network](/api/payment_intents/confirm#confirm_payment_intent-payment_method_options-card-network).", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "preferred": { "description": "The preferred network for the card.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "available" ], "title": "payment_method_card_present_networks", "type": "object", "x-expandableFields": [] }, "payment_method_card_wallet": { "description": "", "properties": { "amex_express_checkout": { "$ref": "#/components/schemas/payment_method_card_wallet_amex_express_checkout" }, "apple_pay": { "$ref": "#/components/schemas/payment_method_card_wallet_apple_pay" }, "dynamic_last4": { "description": "(For tokenized numbers only.) The last four digits of the device account number.", "maxLength": 5000, "nullable": true, "type": "string" }, "google_pay": { "$ref": "#/components/schemas/payment_method_card_wallet_google_pay" }, "link": { "$ref": "#/components/schemas/payment_method_card_wallet_link" }, "masterpass": { "$ref": "#/components/schemas/payment_method_card_wallet_masterpass" }, "samsung_pay": { "$ref": "#/components/schemas/payment_method_card_wallet_samsung_pay" }, "type": { "description": "The type of the card wallet, one of `amex_express_checkout`, `apple_pay`, `google_pay`, `masterpass`, `samsung_pay`, `visa_checkout`, or `link`. An additional hash is included on the Wallet subhash with a name matching this value. It contains additional information specific to the card wallet type.", "enum": [ "amex_express_checkout", "apple_pay", "google_pay", "link", "masterpass", "samsung_pay", "visa_checkout" ], "type": "string" }, "visa_checkout": { "$ref": "#/components/schemas/payment_method_card_wallet_visa_checkout" } }, "required": [ "type" ], "title": "payment_method_card_wallet", "type": "object", "x-expandableFields": [ "amex_express_checkout", "apple_pay", "google_pay", "link", "masterpass", "samsung_pay", "visa_checkout" ] }, "payment_method_card_wallet_amex_express_checkout": { "description": "", "properties": {}, "title": "payment_method_card_wallet_amex_express_checkout", "type": "object", "x-expandableFields": [] }, "payment_method_card_wallet_apple_pay": { "description": "", "properties": {}, "title": "payment_method_card_wallet_apple_pay", "type": "object", "x-expandableFields": [] }, "payment_method_card_wallet_google_pay": { "description": "", "properties": {}, "title": "payment_method_card_wallet_google_pay", "type": "object", "x-expandableFields": [] }, "payment_method_card_wallet_link": { "description": "", "properties": {}, "title": "payment_method_card_wallet_link", "type": "object", "x-expandableFields": [] }, "payment_method_card_wallet_masterpass": { "description": "", "properties": { "billing_address": { "anyOf": [ { "$ref": "#/components/schemas/address" } ], "description": "Owner's verified billing address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.", "nullable": true }, "email": { "description": "Owner's verified email. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.", "maxLength": 5000, "nullable": true, "type": "string" }, "name": { "description": "Owner's verified full name. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.", "maxLength": 5000, "nullable": true, "type": "string" }, "shipping_address": { "anyOf": [ { "$ref": "#/components/schemas/address" } ], "description": "Owner's verified shipping address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.", "nullable": true } }, "title": "payment_method_card_wallet_masterpass", "type": "object", "x-expandableFields": [ "billing_address", "shipping_address" ] }, "payment_method_card_wallet_samsung_pay": { "description": "", "properties": {}, "title": "payment_method_card_wallet_samsung_pay", "type": "object", "x-expandableFields": [] }, "payment_method_card_wallet_visa_checkout": { "description": "", "properties": { "billing_address": { "anyOf": [ { "$ref": "#/components/schemas/address" } ], "description": "Owner's verified billing address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.", "nullable": true }, "email": { "description": "Owner's verified email. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.", "maxLength": 5000, "nullable": true, "type": "string" }, "name": { "description": "Owner's verified full name. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.", "maxLength": 5000, "nullable": true, "type": "string" }, "shipping_address": { "anyOf": [ { "$ref": "#/components/schemas/address" } ], "description": "Owner's verified shipping address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.", "nullable": true } }, "title": "payment_method_card_wallet_visa_checkout", "type": "object", "x-expandableFields": [ "billing_address", "shipping_address" ] }, "payment_method_cashapp": { "description": "", "properties": { "buyer_id": { "description": "A unique and immutable identifier assigned by Cash App to every buyer.", "maxLength": 5000, "nullable": true, "type": "string" }, "cashtag": { "description": "A public identifier for buyers using Cash App.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "payment_method_cashapp", "type": "object", "x-expandableFields": [] }, "payment_method_config_biz_payment_method_configuration_details": { "description": "", "properties": { "id": { "description": "ID of the payment method configuration used.", "maxLength": 5000, "type": "string" }, "parent": { "description": "ID of the parent payment method configuration used.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "id" ], "title": "PaymentMethodConfigBizPaymentMethodConfigurationDetails", "type": "object", "x-expandableFields": [] }, "payment_method_config_resource_display_preference": { "description": "", "properties": { "overridable": { "description": "For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used.", "nullable": true, "type": "boolean" }, "preference": { "description": "The account's display preference.", "enum": [ "none", "off", "on" ], "type": "string" }, "value": { "description": "The effective display preference value.", "enum": [ "off", "on" ], "type": "string" } }, "required": [ "preference", "value" ], "title": "PaymentMethodConfigResourceDisplayPreference", "type": "object", "x-expandableFields": [] }, "payment_method_config_resource_payment_method_properties": { "description": "", "properties": { "available": { "description": "Whether this payment method may be offered at checkout. True if `display_preference` is `on` and the payment method's capability is active.", "type": "boolean" }, "display_preference": { "$ref": "#/components/schemas/payment_method_config_resource_display_preference" } }, "required": [ "available", "display_preference" ], "title": "PaymentMethodConfigResourcePaymentMethodProperties", "type": "object", "x-expandableFields": [ "display_preference" ] }, "payment_method_configuration": { "description": "PaymentMethodConfigurations control which payment methods are displayed to your customers when you don't explicitly specify payment method types. You can have multiple configurations with different sets of payment methods for different scenarios.\n\nThere are two types of PaymentMethodConfigurations. Which is used depends on the [charge type](https://stripe.com/docs/connect/charges):\n\n**Direct** configurations apply to payments created on your account, including Connect destination charges, Connect separate charges and transfers, and payments not involving Connect.\n\n**Child** configurations apply to payments created on your connected accounts using direct charges, and charges with the on_behalf_of parameter.\n\nChild configurations have a `parent` that sets default values and controls which settings connected accounts may override. You can specify a parent ID at payment time, and Stripe will automatically resolve the connected account’s associated child configuration. Parent configurations are [managed in the dashboard](https://dashboard.stripe.com/settings/payment_methods/connected_accounts) and are not available in this API.\n\nRelated guides:\n- [Payment Method Configurations API](https://stripe.com/docs/connect/payment-method-configurations)\n- [Multiple configurations on dynamic payment methods](https://stripe.com/docs/payments/multiple-payment-method-configs)\n- [Multiple configurations for your Connect accounts](https://stripe.com/docs/connect/multiple-payment-method-configurations)", "properties": { "acss_debit": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "active": { "description": "Whether the configuration can be used for new payments.", "type": "boolean" }, "affirm": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "afterpay_clearpay": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "alipay": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "alma": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "amazon_pay": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "apple_pay": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "application": { "description": "For child configs, the Connect application associated with the configuration.", "maxLength": 5000, "nullable": true, "type": "string" }, "au_becs_debit": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "bacs_debit": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "bancontact": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "billie": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "blik": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "boleto": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "card": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "cartes_bancaires": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "cashapp": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "customer_balance": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "eps": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "fpx": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "giropay": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "google_pay": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "grabpay": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "ideal": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "is_default": { "description": "The default configuration is used whenever a payment method configuration is not specified.", "type": "boolean" }, "jcb": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "kakao_pay": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "klarna": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "konbini": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "kr_card": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "link": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "mobilepay": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "multibanco": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "name": { "description": "The configuration's name.", "maxLength": 5000, "type": "string" }, "naver_pay": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "nz_bank_account": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "payment_method_configuration" ], "type": "string" }, "oxxo": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "p24": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "parent": { "description": "For child configs, the configuration's parent configuration.", "maxLength": 5000, "nullable": true, "type": "string" }, "pay_by_bank": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "payco": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "paynow": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "paypal": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "pix": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "promptpay": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "revolut_pay": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "samsung_pay": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "satispay": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "sepa_debit": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "sofort": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "swish": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "twint": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "us_bank_account": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "wechat_pay": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "zip": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" } }, "required": [ "active", "id", "is_default", "livemode", "name", "object" ], "title": "PaymentMethodConfigResourcePaymentMethodConfiguration", "type": "object", "x-expandableFields": [ "acss_debit", "affirm", "afterpay_clearpay", "alipay", "alma", "amazon_pay", "apple_pay", "au_becs_debit", "bacs_debit", "bancontact", "billie", "blik", "boleto", "card", "cartes_bancaires", "cashapp", "customer_balance", "eps", "fpx", "giropay", "google_pay", "grabpay", "ideal", "jcb", "kakao_pay", "klarna", "konbini", "kr_card", "link", "mobilepay", "multibanco", "naver_pay", "nz_bank_account", "oxxo", "p24", "pay_by_bank", "payco", "paynow", "paypal", "pix", "promptpay", "revolut_pay", "samsung_pay", "satispay", "sepa_debit", "sofort", "swish", "twint", "us_bank_account", "wechat_pay", "zip" ], "x-resourceId": "payment_method_configuration" }, "payment_method_crypto": { "description": "", "properties": {}, "title": "payment_method_crypto", "type": "object", "x-expandableFields": [] }, "payment_method_customer_balance": { "description": "", "properties": {}, "title": "payment_method_customer_balance", "type": "object", "x-expandableFields": [] }, "payment_method_details": { "description": "", "properties": { "ach_credit_transfer": { "$ref": "#/components/schemas/payment_method_details_ach_credit_transfer" }, "ach_debit": { "$ref": "#/components/schemas/payment_method_details_ach_debit" }, "acss_debit": { "$ref": "#/components/schemas/payment_method_details_acss_debit" }, "affirm": { "$ref": "#/components/schemas/payment_method_details_affirm" }, "afterpay_clearpay": { "$ref": "#/components/schemas/payment_method_details_afterpay_clearpay" }, "alipay": { "$ref": "#/components/schemas/payment_flows_private_payment_methods_alipay_details" }, "alma": { "$ref": "#/components/schemas/payment_method_details_alma" }, "amazon_pay": { "$ref": "#/components/schemas/payment_method_details_amazon_pay" }, "au_becs_debit": { "$ref": "#/components/schemas/payment_method_details_au_becs_debit" }, "bacs_debit": { "$ref": "#/components/schemas/payment_method_details_bacs_debit" }, "bancontact": { "$ref": "#/components/schemas/payment_method_details_bancontact" }, "billie": { "$ref": "#/components/schemas/payment_method_details_billie" }, "blik": { "$ref": "#/components/schemas/payment_method_details_blik" }, "boleto": { "$ref": "#/components/schemas/payment_method_details_boleto" }, "card": { "$ref": "#/components/schemas/payment_method_details_card" }, "card_present": { "$ref": "#/components/schemas/payment_method_details_card_present" }, "cashapp": { "$ref": "#/components/schemas/payment_method_details_cashapp" }, "crypto": { "$ref": "#/components/schemas/payment_method_details_crypto" }, "customer_balance": { "$ref": "#/components/schemas/payment_method_details_customer_balance" }, "eps": { "$ref": "#/components/schemas/payment_method_details_eps" }, "fpx": { "$ref": "#/components/schemas/payment_method_details_fpx" }, "giropay": { "$ref": "#/components/schemas/payment_method_details_giropay" }, "grabpay": { "$ref": "#/components/schemas/payment_method_details_grabpay" }, "ideal": { "$ref": "#/components/schemas/payment_method_details_ideal" }, "interac_present": { "$ref": "#/components/schemas/payment_method_details_interac_present" }, "kakao_pay": { "$ref": "#/components/schemas/payment_method_details_kakao_pay" }, "klarna": { "$ref": "#/components/schemas/payment_method_details_klarna" }, "konbini": { "$ref": "#/components/schemas/payment_method_details_konbini" }, "kr_card": { "$ref": "#/components/schemas/payment_method_details_kr_card" }, "link": { "$ref": "#/components/schemas/payment_method_details_link" }, "mobilepay": { "$ref": "#/components/schemas/payment_method_details_mobilepay" }, "multibanco": { "$ref": "#/components/schemas/payment_method_details_multibanco" }, "naver_pay": { "$ref": "#/components/schemas/payment_method_details_naver_pay" }, "nz_bank_account": { "$ref": "#/components/schemas/payment_method_details_nz_bank_account" }, "oxxo": { "$ref": "#/components/schemas/payment_method_details_oxxo" }, "p24": { "$ref": "#/components/schemas/payment_method_details_p24" }, "pay_by_bank": { "$ref": "#/components/schemas/payment_method_details_pay_by_bank" }, "payco": { "$ref": "#/components/schemas/payment_method_details_payco" }, "paynow": { "$ref": "#/components/schemas/payment_method_details_paynow" }, "paypal": { "$ref": "#/components/schemas/payment_method_details_paypal" }, "pix": { "$ref": "#/components/schemas/payment_method_details_pix" }, "promptpay": { "$ref": "#/components/schemas/payment_method_details_promptpay" }, "revolut_pay": { "$ref": "#/components/schemas/payment_method_details_revolut_pay" }, "samsung_pay": { "$ref": "#/components/schemas/payment_method_details_samsung_pay" }, "satispay": { "$ref": "#/components/schemas/payment_method_details_satispay" }, "sepa_debit": { "$ref": "#/components/schemas/payment_method_details_sepa_debit" }, "sofort": { "$ref": "#/components/schemas/payment_method_details_sofort" }, "stripe_account": { "$ref": "#/components/schemas/payment_method_details_stripe_account" }, "swish": { "$ref": "#/components/schemas/payment_method_details_swish" }, "twint": { "$ref": "#/components/schemas/payment_method_details_twint" }, "type": { "description": "The type of transaction-specific details of the payment method used in the payment. See [PaymentMethod.type](https://stripe.com/docs/api/payment_methods/object#payment_method_object-type) for the full list of possible types.\nAn additional hash is included on `payment_method_details` with a name matching this value.\nIt contains information specific to the payment method.", "maxLength": 5000, "type": "string" }, "us_bank_account": { "$ref": "#/components/schemas/payment_method_details_us_bank_account" }, "wechat": { "$ref": "#/components/schemas/payment_method_details_wechat" }, "wechat_pay": { "$ref": "#/components/schemas/payment_method_details_wechat_pay" }, "zip": { "$ref": "#/components/schemas/payment_method_details_zip" } }, "required": [ "type" ], "title": "payment_method_details", "type": "object", "x-expandableFields": [ "ach_credit_transfer", "ach_debit", "acss_debit", "affirm", "afterpay_clearpay", "alipay", "alma", "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", "billie", "blik", "boleto", "card", "card_present", "cashapp", "crypto", "customer_balance", "eps", "fpx", "giropay", "grabpay", "ideal", "interac_present", "kakao_pay", "klarna", "konbini", "kr_card", "link", "mobilepay", "multibanco", "naver_pay", "nz_bank_account", "oxxo", "p24", "pay_by_bank", "payco", "paynow", "paypal", "pix", "promptpay", "revolut_pay", "samsung_pay", "satispay", "sepa_debit", "sofort", "stripe_account", "swish", "twint", "us_bank_account", "wechat", "wechat_pay", "zip" ] }, "payment_method_details_ach_credit_transfer": { "description": "", "properties": { "account_number": { "description": "Account number to transfer funds to.", "maxLength": 5000, "nullable": true, "type": "string" }, "bank_name": { "description": "Name of the bank associated with the routing number.", "maxLength": 5000, "nullable": true, "type": "string" }, "routing_number": { "description": "Routing transit number for the bank account to transfer funds to.", "maxLength": 5000, "nullable": true, "type": "string" }, "swift_code": { "description": "SWIFT code of the bank associated with the routing number.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "payment_method_details_ach_credit_transfer", "type": "object", "x-expandableFields": [] }, "payment_method_details_ach_debit": { "description": "", "properties": { "account_holder_type": { "description": "Type of entity that holds the account. This can be either `individual` or `company`.", "enum": [ "company", "individual" ], "nullable": true, "type": "string" }, "bank_name": { "description": "Name of the bank associated with the bank account.", "maxLength": 5000, "nullable": true, "type": "string" }, "country": { "description": "Two-letter ISO code representing the country the bank account is located in.", "maxLength": 5000, "nullable": true, "type": "string" }, "fingerprint": { "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.", "maxLength": 5000, "nullable": true, "type": "string" }, "last4": { "description": "Last four digits of the bank account number.", "maxLength": 5000, "nullable": true, "type": "string" }, "routing_number": { "description": "Routing transit number of the bank account.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "payment_method_details_ach_debit", "type": "object", "x-expandableFields": [] }, "payment_method_details_acss_debit": { "description": "", "properties": { "bank_name": { "description": "Name of the bank associated with the bank account.", "maxLength": 5000, "nullable": true, "type": "string" }, "fingerprint": { "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.", "maxLength": 5000, "nullable": true, "type": "string" }, "institution_number": { "description": "Institution number of the bank account", "maxLength": 5000, "nullable": true, "type": "string" }, "last4": { "description": "Last four digits of the bank account number.", "maxLength": 5000, "nullable": true, "type": "string" }, "mandate": { "description": "ID of the mandate used to make this payment.", "maxLength": 5000, "type": "string" }, "transit_number": { "description": "Transit number of the bank account.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "payment_method_details_acss_debit", "type": "object", "x-expandableFields": [] }, "payment_method_details_affirm": { "description": "", "properties": { "location": { "description": "ID of the [location](https://stripe.com/docs/api/terminal/locations) that this transaction's reader is assigned to.", "maxLength": 5000, "type": "string" }, "reader": { "description": "ID of the [reader](https://stripe.com/docs/api/terminal/readers) this transaction was made on.", "maxLength": 5000, "type": "string" }, "transaction_id": { "description": "The Affirm transaction ID associated with this payment.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "payment_method_details_affirm", "type": "object", "x-expandableFields": [] }, "payment_method_details_afterpay_clearpay": { "description": "", "properties": { "order_id": { "description": "The Afterpay order ID associated with this payment intent.", "maxLength": 5000, "nullable": true, "type": "string" }, "reference": { "description": "Order identifier shown to the merchant in Afterpay’s online portal.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "payment_method_details_afterpay_clearpay", "type": "object", "x-expandableFields": [] }, "payment_method_details_alma": { "description": "", "properties": { "installments": { "$ref": "#/components/schemas/alma_installments" }, "transaction_id": { "description": "The Alma transaction ID associated with this payment.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "payment_method_details_alma", "type": "object", "x-expandableFields": [ "installments" ] }, "payment_method_details_amazon_pay": { "description": "", "properties": { "funding": { "$ref": "#/components/schemas/amazon_pay_underlying_payment_method_funding_details" }, "transaction_id": { "description": "The Amazon Pay transaction ID associated with this payment.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "payment_method_details_amazon_pay", "type": "object", "x-expandableFields": [ "funding" ] }, "payment_method_details_au_becs_debit": { "description": "", "properties": { "bsb_number": { "description": "Bank-State-Branch number of the bank account.", "maxLength": 5000, "nullable": true, "type": "string" }, "fingerprint": { "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.", "maxLength": 5000, "nullable": true, "type": "string" }, "last4": { "description": "Last four digits of the bank account number.", "maxLength": 5000, "nullable": true, "type": "string" }, "mandate": { "description": "ID of the mandate used to make this payment.", "maxLength": 5000, "type": "string" } }, "title": "payment_method_details_au_becs_debit", "type": "object", "x-expandableFields": [] }, "payment_method_details_bacs_debit": { "description": "", "properties": { "fingerprint": { "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.", "maxLength": 5000, "nullable": true, "type": "string" }, "last4": { "description": "Last four digits of the bank account number.", "maxLength": 5000, "nullable": true, "type": "string" }, "mandate": { "description": "ID of the mandate used to make this payment.", "maxLength": 5000, "nullable": true, "type": "string" }, "sort_code": { "description": "Sort code of the bank account. (e.g., `10-20-30`)", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "payment_method_details_bacs_debit", "type": "object", "x-expandableFields": [] }, "payment_method_details_bancontact": { "description": "", "properties": { "bank_code": { "description": "Bank code of bank associated with the bank account.", "maxLength": 5000, "nullable": true, "type": "string" }, "bank_name": { "description": "Name of the bank associated with the bank account.", "maxLength": 5000, "nullable": true, "type": "string" }, "bic": { "description": "Bank Identifier Code of the bank associated with the bank account.", "maxLength": 5000, "nullable": true, "type": "string" }, "generated_sepa_debit": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/payment_method" } ], "description": "The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/payment_method" } ] } }, "generated_sepa_debit_mandate": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/mandate" } ], "description": "The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/mandate" } ] } }, "iban_last4": { "description": "Last four characters of the IBAN.", "maxLength": 5000, "nullable": true, "type": "string" }, "preferred_language": { "description": "Preferred language of the Bancontact authorization page that the customer is redirected to.\nCan be one of `en`, `de`, `fr`, or `nl`", "enum": [ "de", "en", "fr", "nl" ], "nullable": true, "type": "string" }, "verified_name": { "description": "Owner's verified full name. Values are verified or provided by Bancontact directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "payment_method_details_bancontact", "type": "object", "x-expandableFields": [ "generated_sepa_debit", "generated_sepa_debit_mandate" ] }, "payment_method_details_billie": { "description": "", "properties": { "transaction_id": { "description": "The Billie transaction ID associated with this payment.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "payment_method_details_billie", "type": "object", "x-expandableFields": [] }, "payment_method_details_blik": { "description": "", "properties": { "buyer_id": { "description": "A unique and immutable identifier assigned by BLIK to every buyer.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "payment_method_details_blik", "type": "object", "x-expandableFields": [] }, "payment_method_details_boleto": { "description": "", "properties": { "tax_id": { "description": "The tax ID of the customer (CPF for individuals consumers or CNPJ for businesses consumers)", "maxLength": 5000, "type": "string" } }, "required": [ "tax_id" ], "title": "payment_method_details_boleto", "type": "object", "x-expandableFields": [] }, "payment_method_details_card": { "description": "", "properties": { "amount_authorized": { "description": "The authorized amount.", "nullable": true, "type": "integer" }, "authorization_code": { "description": "Authorization code on the charge.", "maxLength": 5000, "nullable": true, "type": "string" }, "brand": { "description": "Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`.", "maxLength": 5000, "nullable": true, "type": "string" }, "capture_before": { "description": "When using manual capture, a future timestamp at which the charge will be automatically refunded if uncaptured.", "format": "unix-time", "type": "integer" }, "checks": { "anyOf": [ { "$ref": "#/components/schemas/payment_method_details_card_checks" } ], "description": "Check results by Card networks on Card address and CVC at time of payment.", "nullable": true }, "country": { "description": "Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.", "maxLength": 5000, "nullable": true, "type": "string" }, "exp_month": { "description": "Two-digit number representing the card's expiration month.", "type": "integer" }, "exp_year": { "description": "Four-digit number representing the card's expiration year.", "type": "integer" }, "extended_authorization": { "$ref": "#/components/schemas/payment_flows_private_payment_methods_card_details_api_resource_enterprise_features_extended_authorization_extended_authorization" }, "fingerprint": { "description": "Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.\n\n*As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*", "maxLength": 5000, "nullable": true, "type": "string" }, "funding": { "description": "Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.", "maxLength": 5000, "nullable": true, "type": "string" }, "incremental_authorization": { "$ref": "#/components/schemas/payment_flows_private_payment_methods_card_details_api_resource_enterprise_features_incremental_authorization_incremental_authorization" }, "installments": { "anyOf": [ { "$ref": "#/components/schemas/payment_method_details_card_installments" } ], "description": "Installment details for this payment.\n\nFor more information, see the [installments integration guide](https://stripe.com/docs/payments/installments).", "nullable": true }, "last4": { "description": "The last four digits of the card.", "maxLength": 5000, "nullable": true, "type": "string" }, "mandate": { "description": "ID of the mandate used to make this payment or created by it.", "maxLength": 5000, "nullable": true, "type": "string" }, "multicapture": { "$ref": "#/components/schemas/payment_flows_private_payment_methods_card_details_api_resource_multicapture" }, "network": { "description": "Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.", "maxLength": 5000, "nullable": true, "type": "string" }, "network_token": { "anyOf": [ { "$ref": "#/components/schemas/payment_method_details_card_network_token" } ], "description": "If this card has network token credentials, this contains the details of the network token credentials.", "nullable": true }, "network_transaction_id": { "description": "This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. This value will be present if it is returned by the financial network in the authorization response, and null otherwise.", "maxLength": 5000, "nullable": true, "type": "string" }, "overcapture": { "$ref": "#/components/schemas/payment_flows_private_payment_methods_card_details_api_resource_enterprise_features_overcapture_overcapture" }, "regulated_status": { "description": "Status of a card based on the card issuer.", "enum": [ "regulated", "unregulated" ], "nullable": true, "type": "string" }, "three_d_secure": { "anyOf": [ { "$ref": "#/components/schemas/three_d_secure_details_charge" } ], "description": "Populated if this transaction used 3D Secure authentication.", "nullable": true }, "wallet": { "anyOf": [ { "$ref": "#/components/schemas/payment_method_details_card_wallet" } ], "description": "If this Card is part of a card wallet, this contains the details of the card wallet.", "nullable": true } }, "required": [ "exp_month", "exp_year" ], "title": "payment_method_details_card", "type": "object", "x-expandableFields": [ "checks", "extended_authorization", "incremental_authorization", "installments", "multicapture", "network_token", "overcapture", "three_d_secure", "wallet" ] }, "payment_method_details_card_checks": { "description": "", "properties": { "address_line1_check": { "description": "If a address line1 was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.", "maxLength": 5000, "nullable": true, "type": "string" }, "address_postal_code_check": { "description": "If a address postal code was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.", "maxLength": 5000, "nullable": true, "type": "string" }, "cvc_check": { "description": "If a CVC was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "payment_method_details_card_checks", "type": "object", "x-expandableFields": [] }, "payment_method_details_card_installments": { "description": "", "properties": { "plan": { "anyOf": [ { "$ref": "#/components/schemas/payment_method_details_card_installments_plan" } ], "description": "Installment plan selected for the payment.", "nullable": true } }, "title": "payment_method_details_card_installments", "type": "object", "x-expandableFields": [ "plan" ] }, "payment_method_details_card_installments_plan": { "description": "", "properties": { "count": { "description": "For `fixed_count` installment plans, this is the number of installment payments your customer will make to their credit card.", "nullable": true, "type": "integer" }, "interval": { "description": "For `fixed_count` installment plans, this is the interval between installment payments your customer will make to their credit card.\nOne of `month`.", "enum": [ "month" ], "nullable": true, "type": "string" }, "type": { "description": "Type of installment plan, one of `fixed_count`, `bonus`, or `revolving`.", "enum": [ "bonus", "fixed_count", "revolving" ], "type": "string" } }, "required": [ "type" ], "title": "payment_method_details_card_installments_plan", "type": "object", "x-expandableFields": [] }, "payment_method_details_card_network_token": { "description": "", "properties": { "used": { "description": "Indicates if Stripe used a network token, either user provided or Stripe managed when processing the transaction.", "type": "boolean" } }, "required": [ "used" ], "title": "payment_method_details_card_network_token", "type": "object", "x-expandableFields": [] }, "payment_method_details_card_present": { "description": "", "properties": { "amount_authorized": { "description": "The authorized amount", "nullable": true, "type": "integer" }, "brand": { "description": "Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`.", "maxLength": 5000, "nullable": true, "type": "string" }, "brand_product": { "description": "The [product code](https://stripe.com/docs/card-product-codes) that identifies the specific program or product associated with a card.", "maxLength": 5000, "nullable": true, "type": "string" }, "capture_before": { "description": "When using manual capture, a future timestamp after which the charge will be automatically refunded if uncaptured.", "format": "unix-time", "type": "integer" }, "cardholder_name": { "description": "The cardholder name as read from the card, in [ISO 7813](https://en.wikipedia.org/wiki/ISO/IEC_7813) format. May include alphanumeric characters, special characters and first/last name separator (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay.", "maxLength": 5000, "nullable": true, "type": "string" }, "country": { "description": "Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.", "maxLength": 5000, "nullable": true, "type": "string" }, "description": { "description": "A high-level description of the type of cards issued in this range.", "maxLength": 5000, "nullable": true, "type": "string" }, "emv_auth_data": { "description": "Authorization response cryptogram.", "maxLength": 5000, "nullable": true, "type": "string" }, "exp_month": { "description": "Two-digit number representing the card's expiration month.", "type": "integer" }, "exp_year": { "description": "Four-digit number representing the card's expiration year.", "type": "integer" }, "fingerprint": { "description": "Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.\n\n*As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*", "maxLength": 5000, "nullable": true, "type": "string" }, "funding": { "description": "Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.", "maxLength": 5000, "nullable": true, "type": "string" }, "generated_card": { "description": "ID of a card PaymentMethod generated from the card_present PaymentMethod that may be attached to a Customer for future transactions. Only present if it was possible to generate a card PaymentMethod.", "maxLength": 5000, "nullable": true, "type": "string" }, "incremental_authorization_supported": { "description": "Whether this [PaymentIntent](https://stripe.com/docs/api/payment_intents) is eligible for incremental authorizations. Request support using [request_incremental_authorization_support](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-payment_method_options-card_present-request_incremental_authorization_support).", "type": "boolean" }, "issuer": { "description": "The name of the card's issuing bank.", "maxLength": 5000, "nullable": true, "type": "string" }, "last4": { "description": "The last four digits of the card.", "maxLength": 5000, "nullable": true, "type": "string" }, "network": { "description": "Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.", "maxLength": 5000, "nullable": true, "type": "string" }, "network_transaction_id": { "description": "This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. This value will be present if it is returned by the financial network in the authorization response, and null otherwise.", "maxLength": 5000, "nullable": true, "type": "string" }, "offline": { "anyOf": [ { "$ref": "#/components/schemas/payment_method_details_card_present_offline" } ], "description": "Details about payments collected offline.", "nullable": true }, "overcapture_supported": { "description": "Defines whether the authorized amount can be over-captured or not", "type": "boolean" }, "preferred_locales": { "description": "The languages that the issuing bank recommends using for localizing any customer-facing text, as read from the card. Referenced from EMV tag 5F2D, data encoded on the card's chip.", "items": { "maxLength": 5000, "type": "string" }, "nullable": true, "type": "array" }, "read_method": { "description": "How card details were read in this transaction.", "enum": [ "contact_emv", "contactless_emv", "contactless_magstripe_mode", "magnetic_stripe_fallback", "magnetic_stripe_track2" ], "nullable": true, "type": "string" }, "receipt": { "anyOf": [ { "$ref": "#/components/schemas/payment_method_details_card_present_receipt" } ], "description": "A collection of fields required to be displayed on receipts. Only required for EMV transactions.", "nullable": true }, "wallet": { "$ref": "#/components/schemas/payment_flows_private_payment_methods_card_present_common_wallet" } }, "required": [ "exp_month", "exp_year", "incremental_authorization_supported", "overcapture_supported" ], "title": "payment_method_details_card_present", "type": "object", "x-expandableFields": [ "offline", "receipt", "wallet" ] }, "payment_method_details_card_present_offline": { "description": "", "properties": { "stored_at": { "description": "Time at which the payment was collected while offline", "format": "unix-time", "nullable": true, "type": "integer" }, "type": { "description": "The method used to process this payment method offline. Only deferred is allowed.", "enum": [ "deferred" ], "nullable": true, "type": "string" } }, "title": "payment_method_details_card_present_offline", "type": "object", "x-expandableFields": [] }, "payment_method_details_card_present_receipt": { "description": "", "properties": { "account_type": { "description": "The type of account being debited or credited", "enum": [ "checking", "credit", "prepaid", "unknown" ], "type": "string", "x-stripeBypassValidation": true }, "application_cryptogram": { "description": "The Application Cryptogram, a unique value generated by the card to authenticate the transaction with issuers.", "maxLength": 5000, "nullable": true, "type": "string" }, "application_preferred_name": { "description": "The Application Identifier (AID) on the card used to determine which networks are eligible to process the transaction. Referenced from EMV tag 9F12, data encoded on the card's chip.", "maxLength": 5000, "nullable": true, "type": "string" }, "authorization_code": { "description": "Identifier for this transaction.", "maxLength": 5000, "nullable": true, "type": "string" }, "authorization_response_code": { "description": "EMV tag 8A. A code returned by the card issuer.", "maxLength": 5000, "nullable": true, "type": "string" }, "cardholder_verification_method": { "description": "Describes the method used by the cardholder to verify ownership of the card. One of the following: `approval`, `failure`, `none`, `offline_pin`, `offline_pin_and_signature`, `online_pin`, or `signature`.", "maxLength": 5000, "nullable": true, "type": "string" }, "dedicated_file_name": { "description": "Similar to the application_preferred_name, identifying the applications (AIDs) available on the card. Referenced from EMV tag 84.", "maxLength": 5000, "nullable": true, "type": "string" }, "terminal_verification_results": { "description": "A 5-byte string that records the checks and validations that occur between the card and the terminal. These checks determine how the terminal processes the transaction and what risk tolerance is acceptable. Referenced from EMV Tag 95.", "maxLength": 5000, "nullable": true, "type": "string" }, "transaction_status_information": { "description": "An indication of which steps were completed during the card read process. Referenced from EMV Tag 9B.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "payment_method_details_card_present_receipt", "type": "object", "x-expandableFields": [] }, "payment_method_details_card_wallet": { "description": "", "properties": { "amex_express_checkout": { "$ref": "#/components/schemas/payment_method_details_card_wallet_amex_express_checkout" }, "apple_pay": { "$ref": "#/components/schemas/payment_method_details_card_wallet_apple_pay" }, "dynamic_last4": { "description": "(For tokenized numbers only.) The last four digits of the device account number.", "maxLength": 5000, "nullable": true, "type": "string" }, "google_pay": { "$ref": "#/components/schemas/payment_method_details_card_wallet_google_pay" }, "link": { "$ref": "#/components/schemas/payment_method_details_card_wallet_link" }, "masterpass": { "$ref": "#/components/schemas/payment_method_details_card_wallet_masterpass" }, "samsung_pay": { "$ref": "#/components/schemas/payment_method_details_card_wallet_samsung_pay" }, "type": { "description": "The type of the card wallet, one of `amex_express_checkout`, `apple_pay`, `google_pay`, `masterpass`, `samsung_pay`, `visa_checkout`, or `link`. An additional hash is included on the Wallet subhash with a name matching this value. It contains additional information specific to the card wallet type.", "enum": [ "amex_express_checkout", "apple_pay", "google_pay", "link", "masterpass", "samsung_pay", "visa_checkout" ], "type": "string" }, "visa_checkout": { "$ref": "#/components/schemas/payment_method_details_card_wallet_visa_checkout" } }, "required": [ "type" ], "title": "payment_method_details_card_wallet", "type": "object", "x-expandableFields": [ "amex_express_checkout", "apple_pay", "google_pay", "link", "masterpass", "samsung_pay", "visa_checkout" ] }, "payment_method_details_card_wallet_amex_express_checkout": { "description": "", "properties": {}, "title": "payment_method_details_card_wallet_amex_express_checkout", "type": "object", "x-expandableFields": [] }, "payment_method_details_card_wallet_apple_pay": { "description": "", "properties": {}, "title": "payment_method_details_card_wallet_apple_pay", "type": "object", "x-expandableFields": [] }, "payment_method_details_card_wallet_google_pay": { "description": "", "properties": {}, "title": "payment_method_details_card_wallet_google_pay", "type": "object", "x-expandableFields": [] }, "payment_method_details_card_wallet_link": { "description": "", "properties": {}, "title": "payment_method_details_card_wallet_link", "type": "object", "x-expandableFields": [] }, "payment_method_details_card_wallet_masterpass": { "description": "", "properties": { "billing_address": { "anyOf": [ { "$ref": "#/components/schemas/address" } ], "description": "Owner's verified billing address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.", "nullable": true }, "email": { "description": "Owner's verified email. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.", "maxLength": 5000, "nullable": true, "type": "string" }, "name": { "description": "Owner's verified full name. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.", "maxLength": 5000, "nullable": true, "type": "string" }, "shipping_address": { "anyOf": [ { "$ref": "#/components/schemas/address" } ], "description": "Owner's verified shipping address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.", "nullable": true } }, "title": "payment_method_details_card_wallet_masterpass", "type": "object", "x-expandableFields": [ "billing_address", "shipping_address" ] }, "payment_method_details_card_wallet_samsung_pay": { "description": "", "properties": {}, "title": "payment_method_details_card_wallet_samsung_pay", "type": "object", "x-expandableFields": [] }, "payment_method_details_card_wallet_visa_checkout": { "description": "", "properties": { "billing_address": { "anyOf": [ { "$ref": "#/components/schemas/address" } ], "description": "Owner's verified billing address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.", "nullable": true }, "email": { "description": "Owner's verified email. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.", "maxLength": 5000, "nullable": true, "type": "string" }, "name": { "description": "Owner's verified full name. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.", "maxLength": 5000, "nullable": true, "type": "string" }, "shipping_address": { "anyOf": [ { "$ref": "#/components/schemas/address" } ], "description": "Owner's verified shipping address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.", "nullable": true } }, "title": "payment_method_details_card_wallet_visa_checkout", "type": "object", "x-expandableFields": [ "billing_address", "shipping_address" ] }, "payment_method_details_cashapp": { "description": "", "properties": { "buyer_id": { "description": "A unique and immutable identifier assigned by Cash App to every buyer.", "maxLength": 5000, "nullable": true, "type": "string" }, "cashtag": { "description": "A public identifier for buyers using Cash App.", "maxLength": 5000, "nullable": true, "type": "string" }, "transaction_id": { "description": "A unique and immutable identifier of payments assigned by Cash App", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "payment_method_details_cashapp", "type": "object", "x-expandableFields": [] }, "payment_method_details_crypto": { "description": "", "properties": { "buyer_address": { "description": "The wallet address of the customer.", "maxLength": 5000, "type": "string" }, "network": { "description": "The blockchain network that the transaction was sent on.", "enum": [ "base", "ethereum", "polygon" ], "type": "string" }, "token_currency": { "description": "The token currency that the transaction was sent with.", "enum": [ "usdc", "usdg", "usdp" ], "type": "string" }, "transaction_hash": { "description": "The blockchain transaction hash of the crypto payment.", "maxLength": 5000, "type": "string" } }, "title": "payment_method_details_crypto", "type": "object", "x-expandableFields": [] }, "payment_method_details_customer_balance": { "description": "", "properties": {}, "title": "payment_method_details_customer_balance", "type": "object", "x-expandableFields": [] }, "payment_method_details_eps": { "description": "", "properties": { "bank": { "description": "The customer's bank. Should be one of `arzte_und_apotheker_bank`, `austrian_anadi_bank_ag`, `bank_austria`, `bankhaus_carl_spangler`, `bankhaus_schelhammer_und_schattera_ag`, `bawag_psk_ag`, `bks_bank_ag`, `brull_kallmus_bank_ag`, `btv_vier_lander_bank`, `capital_bank_grawe_gruppe_ag`, `deutsche_bank_ag`, `dolomitenbank`, `easybank_ag`, `erste_bank_und_sparkassen`, `hypo_alpeadriabank_international_ag`, `hypo_noe_lb_fur_niederosterreich_u_wien`, `hypo_oberosterreich_salzburg_steiermark`, `hypo_tirol_bank_ag`, `hypo_vorarlberg_bank_ag`, `hypo_bank_burgenland_aktiengesellschaft`, `marchfelder_bank`, `oberbank_ag`, `raiffeisen_bankengruppe_osterreich`, `schoellerbank_ag`, `sparda_bank_wien`, `volksbank_gruppe`, `volkskreditbank_ag`, or `vr_bank_braunau`.", "enum": [ "arzte_und_apotheker_bank", "austrian_anadi_bank_ag", "bank_austria", "bankhaus_carl_spangler", "bankhaus_schelhammer_und_schattera_ag", "bawag_psk_ag", "bks_bank_ag", "brull_kallmus_bank_ag", "btv_vier_lander_bank", "capital_bank_grawe_gruppe_ag", "deutsche_bank_ag", "dolomitenbank", "easybank_ag", "erste_bank_und_sparkassen", "hypo_alpeadriabank_international_ag", "hypo_bank_burgenland_aktiengesellschaft", "hypo_noe_lb_fur_niederosterreich_u_wien", "hypo_oberosterreich_salzburg_steiermark", "hypo_tirol_bank_ag", "hypo_vorarlberg_bank_ag", "marchfelder_bank", "oberbank_ag", "raiffeisen_bankengruppe_osterreich", "schoellerbank_ag", "sparda_bank_wien", "volksbank_gruppe", "volkskreditbank_ag", "vr_bank_braunau" ], "nullable": true, "type": "string" }, "verified_name": { "description": "Owner's verified full name. Values are verified or provided by EPS directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated.\nEPS rarely provides this information so the attribute is usually empty.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "payment_method_details_eps", "type": "object", "x-expandableFields": [] }, "payment_method_details_fpx": { "description": "", "properties": { "bank": { "description": "The customer's bank. Can be one of `affin_bank`, `agrobank`, `alliance_bank`, `ambank`, `bank_islam`, `bank_muamalat`, `bank_rakyat`, `bsn`, `cimb`, `hong_leong_bank`, `hsbc`, `kfh`, `maybank2u`, `ocbc`, `public_bank`, `rhb`, `standard_chartered`, `uob`, `deutsche_bank`, `maybank2e`, `pb_enterprise`, or `bank_of_china`.", "enum": [ "affin_bank", "agrobank", "alliance_bank", "ambank", "bank_islam", "bank_muamalat", "bank_of_china", "bank_rakyat", "bsn", "cimb", "deutsche_bank", "hong_leong_bank", "hsbc", "kfh", "maybank2e", "maybank2u", "ocbc", "pb_enterprise", "public_bank", "rhb", "standard_chartered", "uob" ], "type": "string" }, "transaction_id": { "description": "Unique transaction id generated by FPX for every request from the merchant", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "bank" ], "title": "payment_method_details_fpx", "type": "object", "x-expandableFields": [] }, "payment_method_details_giropay": { "description": "", "properties": { "bank_code": { "description": "Bank code of bank associated with the bank account.", "maxLength": 5000, "nullable": true, "type": "string" }, "bank_name": { "description": "Name of the bank associated with the bank account.", "maxLength": 5000, "nullable": true, "type": "string" }, "bic": { "description": "Bank Identifier Code of the bank associated with the bank account.", "maxLength": 5000, "nullable": true, "type": "string" }, "verified_name": { "description": "Owner's verified full name. Values are verified or provided by Giropay directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated.\nGiropay rarely provides this information so the attribute is usually empty.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "payment_method_details_giropay", "type": "object", "x-expandableFields": [] }, "payment_method_details_grabpay": { "description": "", "properties": { "transaction_id": { "description": "Unique transaction id generated by GrabPay", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "payment_method_details_grabpay", "type": "object", "x-expandableFields": [] }, "payment_method_details_ideal": { "description": "", "properties": { "bank": { "description": "The customer's bank. Can be one of `abn_amro`, `asn_bank`, `bunq`, `buut`, `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`.", "enum": [ "abn_amro", "asn_bank", "bunq", "buut", "handelsbanken", "ing", "knab", "moneyou", "n26", "nn", "rabobank", "regiobank", "revolut", "sns_bank", "triodos_bank", "van_lanschot", "yoursafe" ], "nullable": true, "type": "string" }, "bic": { "description": "The Bank Identifier Code of the customer's bank.", "enum": [ "ABNANL2A", "ASNBNL21", "BITSNL2A", "BUNQNL2A", "BUUTNL2A", "FVLBNL22", "HANDNL2A", "INGBNL2A", "KNABNL2H", "MOYONL21", "NNBANL2G", "NTSBDEB1", "RABONL2U", "RBRBNL21", "REVOIE23", "REVOLT21", "SNSBNL2A", "TRIONL2U" ], "nullable": true, "type": "string" }, "generated_sepa_debit": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/payment_method" } ], "description": "The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/payment_method" } ] } }, "generated_sepa_debit_mandate": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/mandate" } ], "description": "The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/mandate" } ] } }, "iban_last4": { "description": "Last four characters of the IBAN.", "maxLength": 5000, "nullable": true, "type": "string" }, "verified_name": { "description": "Owner's verified full name. Values are verified or provided by iDEAL directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "payment_method_details_ideal", "type": "object", "x-expandableFields": [ "generated_sepa_debit", "generated_sepa_debit_mandate" ] }, "payment_method_details_interac_present": { "description": "", "properties": { "brand": { "description": "Card brand. Can be `interac`, `mastercard` or `visa`.", "maxLength": 5000, "nullable": true, "type": "string" }, "cardholder_name": { "description": "The cardholder name as read from the card, in [ISO 7813](https://en.wikipedia.org/wiki/ISO/IEC_7813) format. May include alphanumeric characters, special characters and first/last name separator (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay.", "maxLength": 5000, "nullable": true, "type": "string" }, "country": { "description": "Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.", "maxLength": 5000, "nullable": true, "type": "string" }, "description": { "description": "A high-level description of the type of cards issued in this range.", "maxLength": 5000, "nullable": true, "type": "string" }, "emv_auth_data": { "description": "Authorization response cryptogram.", "maxLength": 5000, "nullable": true, "type": "string" }, "exp_month": { "description": "Two-digit number representing the card's expiration month.", "type": "integer" }, "exp_year": { "description": "Four-digit number representing the card's expiration year.", "type": "integer" }, "fingerprint": { "description": "Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.\n\n*As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*", "maxLength": 5000, "nullable": true, "type": "string" }, "funding": { "description": "Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.", "maxLength": 5000, "nullable": true, "type": "string" }, "generated_card": { "description": "ID of a card PaymentMethod generated from the card_present PaymentMethod that may be attached to a Customer for future transactions. Only present if it was possible to generate a card PaymentMethod.", "maxLength": 5000, "nullable": true, "type": "string" }, "issuer": { "description": "The name of the card's issuing bank.", "maxLength": 5000, "nullable": true, "type": "string" }, "last4": { "description": "The last four digits of the card.", "maxLength": 5000, "nullable": true, "type": "string" }, "network": { "description": "Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.", "maxLength": 5000, "nullable": true, "type": "string" }, "network_transaction_id": { "description": "This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. This value will be present if it is returned by the financial network in the authorization response, and null otherwise.", "maxLength": 5000, "nullable": true, "type": "string" }, "preferred_locales": { "description": "The languages that the issuing bank recommends using for localizing any customer-facing text, as read from the card. Referenced from EMV tag 5F2D, data encoded on the card's chip.", "items": { "maxLength": 5000, "type": "string" }, "nullable": true, "type": "array" }, "read_method": { "description": "How card details were read in this transaction.", "enum": [ "contact_emv", "contactless_emv", "contactless_magstripe_mode", "magnetic_stripe_fallback", "magnetic_stripe_track2" ], "nullable": true, "type": "string" }, "receipt": { "anyOf": [ { "$ref": "#/components/schemas/payment_method_details_interac_present_receipt" } ], "description": "A collection of fields required to be displayed on receipts. Only required for EMV transactions.", "nullable": true } }, "required": [ "exp_month", "exp_year" ], "title": "payment_method_details_interac_present", "type": "object", "x-expandableFields": [ "receipt" ] }, "payment_method_details_interac_present_receipt": { "description": "", "properties": { "account_type": { "description": "The type of account being debited or credited", "enum": [ "checking", "savings", "unknown" ], "type": "string", "x-stripeBypassValidation": true }, "application_cryptogram": { "description": "The Application Cryptogram, a unique value generated by the card to authenticate the transaction with issuers.", "maxLength": 5000, "nullable": true, "type": "string" }, "application_preferred_name": { "description": "The Application Identifier (AID) on the card used to determine which networks are eligible to process the transaction. Referenced from EMV tag 9F12, data encoded on the card's chip.", "maxLength": 5000, "nullable": true, "type": "string" }, "authorization_code": { "description": "Identifier for this transaction.", "maxLength": 5000, "nullable": true, "type": "string" }, "authorization_response_code": { "description": "EMV tag 8A. A code returned by the card issuer.", "maxLength": 5000, "nullable": true, "type": "string" }, "cardholder_verification_method": { "description": "Describes the method used by the cardholder to verify ownership of the card. One of the following: `approval`, `failure`, `none`, `offline_pin`, `offline_pin_and_signature`, `online_pin`, or `signature`.", "maxLength": 5000, "nullable": true, "type": "string" }, "dedicated_file_name": { "description": "Similar to the application_preferred_name, identifying the applications (AIDs) available on the card. Referenced from EMV tag 84.", "maxLength": 5000, "nullable": true, "type": "string" }, "terminal_verification_results": { "description": "A 5-byte string that records the checks and validations that occur between the card and the terminal. These checks determine how the terminal processes the transaction and what risk tolerance is acceptable. Referenced from EMV Tag 95.", "maxLength": 5000, "nullable": true, "type": "string" }, "transaction_status_information": { "description": "An indication of which steps were completed during the card read process. Referenced from EMV Tag 9B.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "payment_method_details_interac_present_receipt", "type": "object", "x-expandableFields": [] }, "payment_method_details_kakao_pay": { "description": "", "properties": { "buyer_id": { "description": "A unique identifier for the buyer as determined by the local payment processor.", "maxLength": 5000, "nullable": true, "type": "string" }, "transaction_id": { "description": "The Kakao Pay transaction ID associated with this payment.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "payment_method_details_kakao_pay", "type": "object", "x-expandableFields": [] }, "payment_method_details_klarna": { "description": "", "properties": { "payer_details": { "anyOf": [ { "$ref": "#/components/schemas/klarna_payer_details" } ], "description": "The payer details for this transaction.", "nullable": true }, "payment_method_category": { "description": "The Klarna payment method used for this transaction.\nCan be one of `pay_later`, `pay_now`, `pay_with_financing`, or `pay_in_installments`", "maxLength": 5000, "nullable": true, "type": "string" }, "preferred_locale": { "description": "Preferred language of the Klarna authorization page that the customer is redirected to.\nCan be one of `de-AT`, `en-AT`, `nl-BE`, `fr-BE`, `en-BE`, `de-DE`, `en-DE`, `da-DK`, `en-DK`, `es-ES`, `en-ES`, `fi-FI`, `sv-FI`, `en-FI`, `en-GB`, `en-IE`, `it-IT`, `en-IT`, `nl-NL`, `en-NL`, `nb-NO`, `en-NO`, `sv-SE`, `en-SE`, `en-US`, `es-US`, `fr-FR`, `en-FR`, `cs-CZ`, `en-CZ`, `ro-RO`, `en-RO`, `el-GR`, `en-GR`, `en-AU`, `en-NZ`, `en-CA`, `fr-CA`, `pl-PL`, `en-PL`, `pt-PT`, `en-PT`, `de-CH`, `fr-CH`, `it-CH`, or `en-CH`", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "payment_method_details_klarna", "type": "object", "x-expandableFields": [ "payer_details" ] }, "payment_method_details_konbini": { "description": "", "properties": { "store": { "anyOf": [ { "$ref": "#/components/schemas/payment_method_details_konbini_store" } ], "description": "If the payment succeeded, this contains the details of the convenience store where the payment was completed.", "nullable": true } }, "title": "payment_method_details_konbini", "type": "object", "x-expandableFields": [ "store" ] }, "payment_method_details_konbini_store": { "description": "", "properties": { "chain": { "description": "The name of the convenience store chain where the payment was completed.", "enum": [ "familymart", "lawson", "ministop", "seicomart" ], "nullable": true, "type": "string" } }, "title": "payment_method_details_konbini_store", "type": "object", "x-expandableFields": [] }, "payment_method_details_kr_card": { "description": "", "properties": { "brand": { "description": "The local credit or debit card brand.", "enum": [ "bc", "citi", "hana", "hyundai", "jeju", "jeonbuk", "kakaobank", "kbank", "kdbbank", "kookmin", "kwangju", "lotte", "mg", "nh", "post", "samsung", "savingsbank", "shinhan", "shinhyup", "suhyup", "tossbank", "woori" ], "nullable": true, "type": "string" }, "buyer_id": { "description": "A unique identifier for the buyer as determined by the local payment processor.", "maxLength": 5000, "nullable": true, "type": "string" }, "last4": { "description": "The last four digits of the card. This may not be present for American Express cards.", "maxLength": 4, "nullable": true, "type": "string" }, "transaction_id": { "description": "The Korean Card transaction ID associated with this payment.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "payment_method_details_kr_card", "type": "object", "x-expandableFields": [] }, "payment_method_details_link": { "description": "", "properties": { "country": { "description": "Two-letter ISO code representing the funding source country beneath the Link payment.\nYou could use this attribute to get a sense of international fees.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "payment_method_details_link", "type": "object", "x-expandableFields": [] }, "payment_method_details_mobilepay": { "description": "", "properties": { "card": { "anyOf": [ { "$ref": "#/components/schemas/internal_card" } ], "description": "Internal card details", "nullable": true } }, "title": "payment_method_details_mobilepay", "type": "object", "x-expandableFields": [ "card" ] }, "payment_method_details_multibanco": { "description": "", "properties": { "entity": { "description": "Entity number associated with this Multibanco payment.", "maxLength": 5000, "nullable": true, "type": "string" }, "reference": { "description": "Reference number associated with this Multibanco payment.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "payment_method_details_multibanco", "type": "object", "x-expandableFields": [] }, "payment_method_details_naver_pay": { "description": "", "properties": { "buyer_id": { "description": "A unique identifier for the buyer as determined by the local payment processor.", "maxLength": 5000, "nullable": true, "type": "string" }, "transaction_id": { "description": "The Naver Pay transaction ID associated with this payment.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "payment_method_details_naver_pay", "type": "object", "x-expandableFields": [] }, "payment_method_details_nz_bank_account": { "description": "", "properties": { "account_holder_name": { "description": "The name on the bank account. Only present if the account holder name is different from the name of the authorized signatory collected in the PaymentMethod’s billing details.", "maxLength": 5000, "nullable": true, "type": "string" }, "bank_code": { "description": "The numeric code for the bank account's bank.", "maxLength": 5000, "type": "string" }, "bank_name": { "description": "The name of the bank.", "maxLength": 5000, "type": "string" }, "branch_code": { "description": "The numeric code for the bank account's bank branch.", "maxLength": 5000, "type": "string" }, "last4": { "description": "Last four digits of the bank account number.", "maxLength": 5000, "type": "string" }, "suffix": { "description": "The suffix of the bank account number.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "bank_code", "bank_name", "branch_code", "last4" ], "title": "payment_method_details_nz_bank_account", "type": "object", "x-expandableFields": [] }, "payment_method_details_oxxo": { "description": "", "properties": { "number": { "description": "OXXO reference number", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "payment_method_details_oxxo", "type": "object", "x-expandableFields": [] }, "payment_method_details_p24": { "description": "", "properties": { "bank": { "description": "The customer's bank. Can be one of `ing`, `citi_handlowy`, `tmobile_usbugi_bankowe`, `plus_bank`, `etransfer_pocztowy24`, `banki_spbdzielcze`, `bank_nowy_bfg_sa`, `getin_bank`, `velobank`, `blik`, `noble_pay`, `ideabank`, `envelobank`, `santander_przelew24`, `nest_przelew`, `mbank_mtransfer`, `inteligo`, `pbac_z_ipko`, `bnp_paribas`, `credit_agricole`, `toyota_bank`, `bank_pekao_sa`, `volkswagen_bank`, `bank_millennium`, `alior_bank`, or `boz`.", "enum": [ "alior_bank", "bank_millennium", "bank_nowy_bfg_sa", "bank_pekao_sa", "banki_spbdzielcze", "blik", "bnp_paribas", "boz", "citi_handlowy", "credit_agricole", "envelobank", "etransfer_pocztowy24", "getin_bank", "ideabank", "ing", "inteligo", "mbank_mtransfer", "nest_przelew", "noble_pay", "pbac_z_ipko", "plus_bank", "santander_przelew24", "tmobile_usbugi_bankowe", "toyota_bank", "velobank", "volkswagen_bank" ], "nullable": true, "type": "string" }, "reference": { "description": "Unique reference for this Przelewy24 payment.", "maxLength": 5000, "nullable": true, "type": "string" }, "verified_name": { "description": "Owner's verified full name. Values are verified or provided by Przelewy24 directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated.\nPrzelewy24 rarely provides this information so the attribute is usually empty.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "payment_method_details_p24", "type": "object", "x-expandableFields": [] }, "payment_method_details_passthrough_card": { "description": "", "properties": { "brand": { "description": "Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`.", "maxLength": 5000, "nullable": true, "type": "string" }, "country": { "description": "Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.", "maxLength": 5000, "nullable": true, "type": "string" }, "exp_month": { "description": "Two-digit number representing the card's expiration month.", "nullable": true, "type": "integer" }, "exp_year": { "description": "Four-digit number representing the card's expiration year.", "nullable": true, "type": "integer" }, "funding": { "description": "Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.", "maxLength": 5000, "nullable": true, "type": "string" }, "last4": { "description": "The last four digits of the card.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "payment_method_details_passthrough_card", "type": "object", "x-expandableFields": [] }, "payment_method_details_pay_by_bank": { "description": "", "properties": {}, "title": "payment_method_details_pay_by_bank", "type": "object", "x-expandableFields": [] }, "payment_method_details_payco": { "description": "", "properties": { "buyer_id": { "description": "A unique identifier for the buyer as determined by the local payment processor.", "maxLength": 5000, "nullable": true, "type": "string" }, "transaction_id": { "description": "The Payco transaction ID associated with this payment.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "payment_method_details_payco", "type": "object", "x-expandableFields": [] }, "payment_method_details_paynow": { "description": "", "properties": { "location": { "description": "ID of the [location](https://stripe.com/docs/api/terminal/locations) that this transaction's reader is assigned to.", "maxLength": 5000, "type": "string" }, "reader": { "description": "ID of the [reader](https://stripe.com/docs/api/terminal/readers) this transaction was made on.", "maxLength": 5000, "type": "string" }, "reference": { "description": "Reference number associated with this PayNow payment", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "payment_method_details_paynow", "type": "object", "x-expandableFields": [] }, "payment_method_details_paypal": { "description": "", "properties": { "country": { "description": "Two-letter ISO code representing the buyer's country. Values are provided by PayPal directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.", "maxLength": 5000, "nullable": true, "type": "string" }, "payer_email": { "description": "Owner's email. Values are provided by PayPal directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated.", "maxLength": 5000, "nullable": true, "type": "string" }, "payer_id": { "description": "PayPal account PayerID. This identifier uniquely identifies the PayPal customer.", "maxLength": 5000, "nullable": true, "type": "string" }, "payer_name": { "description": "Owner's full name. Values provided by PayPal directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated.", "maxLength": 5000, "nullable": true, "type": "string" }, "seller_protection": { "anyOf": [ { "$ref": "#/components/schemas/paypal_seller_protection" } ], "description": "The level of protection offered as defined by PayPal Seller Protection for Merchants, for this transaction.", "nullable": true }, "transaction_id": { "description": "A unique ID generated by PayPal for this transaction.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "payment_method_details_paypal", "type": "object", "x-expandableFields": [ "seller_protection" ] }, "payment_method_details_pix": { "description": "", "properties": { "bank_transaction_id": { "description": "Unique transaction id generated by BCB", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "payment_method_details_pix", "type": "object", "x-expandableFields": [] }, "payment_method_details_promptpay": { "description": "", "properties": { "reference": { "description": "Bill reference generated by PromptPay", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "payment_method_details_promptpay", "type": "object", "x-expandableFields": [] }, "payment_method_details_revolut_pay": { "description": "", "properties": { "funding": { "$ref": "#/components/schemas/revolut_pay_underlying_payment_method_funding_details" }, "transaction_id": { "description": "The Revolut Pay transaction ID associated with this payment.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "payment_method_details_revolut_pay", "type": "object", "x-expandableFields": [ "funding" ] }, "payment_method_details_samsung_pay": { "description": "", "properties": { "buyer_id": { "description": "A unique identifier for the buyer as determined by the local payment processor.", "maxLength": 5000, "nullable": true, "type": "string" }, "transaction_id": { "description": "The Samsung Pay transaction ID associated with this payment.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "payment_method_details_samsung_pay", "type": "object", "x-expandableFields": [] }, "payment_method_details_satispay": { "description": "", "properties": { "transaction_id": { "description": "The Satispay transaction ID associated with this payment.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "payment_method_details_satispay", "type": "object", "x-expandableFields": [] }, "payment_method_details_sepa_debit": { "description": "", "properties": { "bank_code": { "description": "Bank code of bank associated with the bank account.", "maxLength": 5000, "nullable": true, "type": "string" }, "branch_code": { "description": "Branch code of bank associated with the bank account.", "maxLength": 5000, "nullable": true, "type": "string" }, "country": { "description": "Two-letter ISO code representing the country the bank account is located in.", "maxLength": 5000, "nullable": true, "type": "string" }, "fingerprint": { "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.", "maxLength": 5000, "nullable": true, "type": "string" }, "last4": { "description": "Last four characters of the IBAN.", "maxLength": 5000, "nullable": true, "type": "string" }, "mandate": { "description": "Find the ID of the mandate used for this payment under the [payment_method_details.sepa_debit.mandate](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-sepa_debit-mandate) property on the Charge. Use this mandate ID to [retrieve the Mandate](https://stripe.com/docs/api/mandates/retrieve).", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "payment_method_details_sepa_debit", "type": "object", "x-expandableFields": [] }, "payment_method_details_sofort": { "description": "", "properties": { "bank_code": { "description": "Bank code of bank associated with the bank account.", "maxLength": 5000, "nullable": true, "type": "string" }, "bank_name": { "description": "Name of the bank associated with the bank account.", "maxLength": 5000, "nullable": true, "type": "string" }, "bic": { "description": "Bank Identifier Code of the bank associated with the bank account.", "maxLength": 5000, "nullable": true, "type": "string" }, "country": { "description": "Two-letter ISO code representing the country the bank account is located in.", "maxLength": 5000, "nullable": true, "type": "string" }, "generated_sepa_debit": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/payment_method" } ], "description": "The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/payment_method" } ] } }, "generated_sepa_debit_mandate": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/mandate" } ], "description": "The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/mandate" } ] } }, "iban_last4": { "description": "Last four characters of the IBAN.", "maxLength": 5000, "nullable": true, "type": "string" }, "preferred_language": { "description": "Preferred language of the SOFORT authorization page that the customer is redirected to.\nCan be one of `de`, `en`, `es`, `fr`, `it`, `nl`, or `pl`", "enum": [ "de", "en", "es", "fr", "it", "nl", "pl" ], "nullable": true, "type": "string" }, "verified_name": { "description": "Owner's verified full name. Values are verified or provided by SOFORT directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "payment_method_details_sofort", "type": "object", "x-expandableFields": [ "generated_sepa_debit", "generated_sepa_debit_mandate" ] }, "payment_method_details_stripe_account": { "description": "", "properties": {}, "title": "payment_method_details_stripe_account", "type": "object", "x-expandableFields": [] }, "payment_method_details_swish": { "description": "", "properties": { "fingerprint": { "description": "Uniquely identifies the payer's Swish account. You can use this attribute to check whether two Swish transactions were paid for by the same payer", "maxLength": 5000, "nullable": true, "type": "string" }, "payment_reference": { "description": "Payer bank reference number for the payment", "maxLength": 5000, "nullable": true, "type": "string" }, "verified_phone_last4": { "description": "The last four digits of the Swish account phone number", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "payment_method_details_swish", "type": "object", "x-expandableFields": [] }, "payment_method_details_twint": { "description": "", "properties": {}, "title": "payment_method_details_twint", "type": "object", "x-expandableFields": [] }, "payment_method_details_us_bank_account": { "description": "", "properties": { "account_holder_type": { "description": "Account holder type: individual or company.", "enum": [ "company", "individual" ], "nullable": true, "type": "string" }, "account_type": { "description": "Account type: checkings or savings. Defaults to checking if omitted.", "enum": [ "checking", "savings" ], "nullable": true, "type": "string" }, "bank_name": { "description": "Name of the bank associated with the bank account.", "maxLength": 5000, "nullable": true, "type": "string" }, "fingerprint": { "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.", "maxLength": 5000, "nullable": true, "type": "string" }, "last4": { "description": "Last four digits of the bank account number.", "maxLength": 5000, "nullable": true, "type": "string" }, "mandate": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/mandate" } ], "description": "ID of the mandate used to make this payment.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/mandate" } ] } }, "payment_reference": { "description": "Reference number to locate ACH payments with customer's bank.", "maxLength": 5000, "nullable": true, "type": "string" }, "routing_number": { "description": "Routing number of the bank account.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "payment_method_details_us_bank_account", "type": "object", "x-expandableFields": [ "mandate" ] }, "payment_method_details_wechat": { "description": "", "properties": {}, "title": "payment_method_details_wechat", "type": "object", "x-expandableFields": [] }, "payment_method_details_wechat_pay": { "description": "", "properties": { "fingerprint": { "description": "Uniquely identifies this particular WeChat Pay account. You can use this attribute to check whether two WeChat accounts are the same.", "maxLength": 5000, "nullable": true, "type": "string" }, "location": { "description": "ID of the [location](https://stripe.com/docs/api/terminal/locations) that this transaction's reader is assigned to.", "maxLength": 5000, "type": "string" }, "reader": { "description": "ID of the [reader](https://stripe.com/docs/api/terminal/readers) this transaction was made on.", "maxLength": 5000, "type": "string" }, "transaction_id": { "description": "Transaction ID of this particular WeChat Pay transaction.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "payment_method_details_wechat_pay", "type": "object", "x-expandableFields": [] }, "payment_method_details_zip": { "description": "", "properties": {}, "title": "payment_method_details_zip", "type": "object", "x-expandableFields": [] }, "payment_method_domain": { "description": "A payment method domain represents a web domain that you have registered with Stripe.\nStripe Elements use registered payment method domains to control where certain payment methods are shown.\n\nRelated guide: [Payment method domains](https://stripe.com/docs/payments/payment-methods/pmd-registration).", "properties": { "amazon_pay": { "$ref": "#/components/schemas/payment_method_domain_resource_payment_method_status" }, "apple_pay": { "$ref": "#/components/schemas/payment_method_domain_resource_payment_method_status" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "domain_name": { "description": "The domain name that this payment method domain object represents.", "maxLength": 5000, "type": "string" }, "enabled": { "description": "Whether this payment method domain is enabled. If the domain is not enabled, payment methods that require a payment method domain will not appear in Elements.", "type": "boolean" }, "google_pay": { "$ref": "#/components/schemas/payment_method_domain_resource_payment_method_status" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "klarna": { "$ref": "#/components/schemas/payment_method_domain_resource_payment_method_status" }, "link": { "$ref": "#/components/schemas/payment_method_domain_resource_payment_method_status" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "payment_method_domain" ], "type": "string" }, "paypal": { "$ref": "#/components/schemas/payment_method_domain_resource_payment_method_status" } }, "required": [ "amazon_pay", "apple_pay", "created", "domain_name", "enabled", "google_pay", "id", "klarna", "link", "livemode", "object", "paypal" ], "title": "PaymentMethodDomainResourcePaymentMethodDomain", "type": "object", "x-expandableFields": [ "amazon_pay", "apple_pay", "google_pay", "klarna", "link", "paypal" ], "x-resourceId": "payment_method_domain" }, "payment_method_domain_resource_payment_method_status": { "description": "Indicates the status of a specific payment method on a payment method domain.", "properties": { "status": { "description": "The status of the payment method on the domain.", "enum": [ "active", "inactive" ], "type": "string" }, "status_details": { "$ref": "#/components/schemas/payment_method_domain_resource_payment_method_status_details" } }, "required": [ "status" ], "title": "PaymentMethodDomainResourcePaymentMethodStatus", "type": "object", "x-expandableFields": [ "status_details" ] }, "payment_method_domain_resource_payment_method_status_details": { "description": "Contains additional details about the status of a payment method for a specific payment method domain.", "properties": { "error_message": { "description": "The error message associated with the status of the payment method on the domain.", "maxLength": 5000, "type": "string" } }, "required": [ "error_message" ], "title": "PaymentMethodDomainResourcePaymentMethodStatusDetails", "type": "object", "x-expandableFields": [] }, "payment_method_eps": { "description": "", "properties": { "bank": { "description": "The customer's bank. Should be one of `arzte_und_apotheker_bank`, `austrian_anadi_bank_ag`, `bank_austria`, `bankhaus_carl_spangler`, `bankhaus_schelhammer_und_schattera_ag`, `bawag_psk_ag`, `bks_bank_ag`, `brull_kallmus_bank_ag`, `btv_vier_lander_bank`, `capital_bank_grawe_gruppe_ag`, `deutsche_bank_ag`, `dolomitenbank`, `easybank_ag`, `erste_bank_und_sparkassen`, `hypo_alpeadriabank_international_ag`, `hypo_noe_lb_fur_niederosterreich_u_wien`, `hypo_oberosterreich_salzburg_steiermark`, `hypo_tirol_bank_ag`, `hypo_vorarlberg_bank_ag`, `hypo_bank_burgenland_aktiengesellschaft`, `marchfelder_bank`, `oberbank_ag`, `raiffeisen_bankengruppe_osterreich`, `schoellerbank_ag`, `sparda_bank_wien`, `volksbank_gruppe`, `volkskreditbank_ag`, or `vr_bank_braunau`.", "enum": [ "arzte_und_apotheker_bank", "austrian_anadi_bank_ag", "bank_austria", "bankhaus_carl_spangler", "bankhaus_schelhammer_und_schattera_ag", "bawag_psk_ag", "bks_bank_ag", "brull_kallmus_bank_ag", "btv_vier_lander_bank", "capital_bank_grawe_gruppe_ag", "deutsche_bank_ag", "dolomitenbank", "easybank_ag", "erste_bank_und_sparkassen", "hypo_alpeadriabank_international_ag", "hypo_bank_burgenland_aktiengesellschaft", "hypo_noe_lb_fur_niederosterreich_u_wien", "hypo_oberosterreich_salzburg_steiermark", "hypo_tirol_bank_ag", "hypo_vorarlberg_bank_ag", "marchfelder_bank", "oberbank_ag", "raiffeisen_bankengruppe_osterreich", "schoellerbank_ag", "sparda_bank_wien", "volksbank_gruppe", "volkskreditbank_ag", "vr_bank_braunau" ], "nullable": true, "type": "string" } }, "title": "payment_method_eps", "type": "object", "x-expandableFields": [] }, "payment_method_fpx": { "description": "", "properties": { "bank": { "description": "The customer's bank, if provided. Can be one of `affin_bank`, `agrobank`, `alliance_bank`, `ambank`, `bank_islam`, `bank_muamalat`, `bank_rakyat`, `bsn`, `cimb`, `hong_leong_bank`, `hsbc`, `kfh`, `maybank2u`, `ocbc`, `public_bank`, `rhb`, `standard_chartered`, `uob`, `deutsche_bank`, `maybank2e`, `pb_enterprise`, or `bank_of_china`.", "enum": [ "affin_bank", "agrobank", "alliance_bank", "ambank", "bank_islam", "bank_muamalat", "bank_of_china", "bank_rakyat", "bsn", "cimb", "deutsche_bank", "hong_leong_bank", "hsbc", "kfh", "maybank2e", "maybank2u", "ocbc", "pb_enterprise", "public_bank", "rhb", "standard_chartered", "uob" ], "type": "string" } }, "required": [ "bank" ], "title": "payment_method_fpx", "type": "object", "x-expandableFields": [] }, "payment_method_giropay": { "description": "", "properties": {}, "title": "payment_method_giropay", "type": "object", "x-expandableFields": [] }, "payment_method_grabpay": { "description": "", "properties": {}, "title": "payment_method_grabpay", "type": "object", "x-expandableFields": [] }, "payment_method_ideal": { "description": "", "properties": { "bank": { "description": "The customer's bank, if provided. Can be one of `abn_amro`, `asn_bank`, `bunq`, `buut`, `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`.", "enum": [ "abn_amro", "asn_bank", "bunq", "buut", "handelsbanken", "ing", "knab", "moneyou", "n26", "nn", "rabobank", "regiobank", "revolut", "sns_bank", "triodos_bank", "van_lanschot", "yoursafe" ], "nullable": true, "type": "string" }, "bic": { "description": "The Bank Identifier Code of the customer's bank, if the bank was provided.", "enum": [ "ABNANL2A", "ASNBNL21", "BITSNL2A", "BUNQNL2A", "BUUTNL2A", "FVLBNL22", "HANDNL2A", "INGBNL2A", "KNABNL2H", "MOYONL21", "NNBANL2G", "NTSBDEB1", "RABONL2U", "RBRBNL21", "REVOIE23", "REVOLT21", "SNSBNL2A", "TRIONL2U" ], "nullable": true, "type": "string" } }, "title": "payment_method_ideal", "type": "object", "x-expandableFields": [] }, "payment_method_interac_present": { "description": "", "properties": { "brand": { "description": "Card brand. Can be `interac`, `mastercard` or `visa`.", "maxLength": 5000, "nullable": true, "type": "string" }, "cardholder_name": { "description": "The cardholder name as read from the card, in [ISO 7813](https://en.wikipedia.org/wiki/ISO/IEC_7813) format. May include alphanumeric characters, special characters and first/last name separator (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay.", "maxLength": 5000, "nullable": true, "type": "string" }, "country": { "description": "Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.", "maxLength": 5000, "nullable": true, "type": "string" }, "description": { "description": "A high-level description of the type of cards issued in this range.", "maxLength": 5000, "nullable": true, "type": "string" }, "exp_month": { "description": "Two-digit number representing the card's expiration month.", "type": "integer" }, "exp_year": { "description": "Four-digit number representing the card's expiration year.", "type": "integer" }, "fingerprint": { "description": "Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.\n\n*As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*", "maxLength": 5000, "nullable": true, "type": "string" }, "funding": { "description": "Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.", "maxLength": 5000, "nullable": true, "type": "string" }, "issuer": { "description": "The name of the card's issuing bank.", "maxLength": 5000, "nullable": true, "type": "string" }, "last4": { "description": "The last four digits of the card.", "maxLength": 5000, "nullable": true, "type": "string" }, "networks": { "anyOf": [ { "$ref": "#/components/schemas/payment_method_card_present_networks" } ], "description": "Contains information about card networks that can be used to process the payment.", "nullable": true }, "preferred_locales": { "description": "The languages that the issuing bank recommends using for localizing any customer-facing text, as read from the card. Referenced from EMV tag 5F2D, data encoded on the card's chip.", "items": { "maxLength": 5000, "type": "string" }, "nullable": true, "type": "array" }, "read_method": { "description": "How card details were read in this transaction.", "enum": [ "contact_emv", "contactless_emv", "contactless_magstripe_mode", "magnetic_stripe_fallback", "magnetic_stripe_track2" ], "nullable": true, "type": "string" } }, "required": [ "exp_month", "exp_year" ], "title": "payment_method_interac_present", "type": "object", "x-expandableFields": [ "networks" ] }, "payment_method_kakao_pay": { "description": "", "properties": {}, "title": "payment_method_kakao_pay", "type": "object", "x-expandableFields": [] }, "payment_method_klarna": { "description": "", "properties": { "dob": { "anyOf": [ { "$ref": "#/components/schemas/payment_flows_private_payment_methods_klarna_dob" } ], "description": "The customer's date of birth, if provided.", "nullable": true } }, "title": "payment_method_klarna", "type": "object", "x-expandableFields": [ "dob" ] }, "payment_method_konbini": { "description": "", "properties": {}, "title": "payment_method_konbini", "type": "object", "x-expandableFields": [] }, "payment_method_kr_card": { "description": "", "properties": { "brand": { "description": "The local credit or debit card brand.", "enum": [ "bc", "citi", "hana", "hyundai", "jeju", "jeonbuk", "kakaobank", "kbank", "kdbbank", "kookmin", "kwangju", "lotte", "mg", "nh", "post", "samsung", "savingsbank", "shinhan", "shinhyup", "suhyup", "tossbank", "woori" ], "nullable": true, "type": "string" }, "last4": { "description": "The last four digits of the card. This may not be present for American Express cards.", "maxLength": 4, "nullable": true, "type": "string" } }, "title": "payment_method_kr_card", "type": "object", "x-expandableFields": [] }, "payment_method_link": { "description": "", "properties": { "email": { "description": "Account owner's email address.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "payment_method_link", "type": "object", "x-expandableFields": [] }, "payment_method_mobilepay": { "description": "", "properties": {}, "title": "payment_method_mobilepay", "type": "object", "x-expandableFields": [] }, "payment_method_multibanco": { "description": "", "properties": {}, "title": "payment_method_multibanco", "type": "object", "x-expandableFields": [] }, "payment_method_naver_pay": { "description": "", "properties": { "buyer_id": { "description": "Uniquely identifies this particular Naver Pay account. You can use this attribute to check whether two Naver Pay accounts are the same.", "maxLength": 5000, "nullable": true, "type": "string" }, "funding": { "description": "Whether to fund this transaction with Naver Pay points or a card.", "enum": [ "card", "points" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "funding" ], "title": "payment_method_naver_pay", "type": "object", "x-expandableFields": [] }, "payment_method_nz_bank_account": { "description": "", "properties": { "account_holder_name": { "description": "The name on the bank account. Only present if the account holder name is different from the name of the authorized signatory collected in the PaymentMethod’s billing details.", "maxLength": 5000, "nullable": true, "type": "string" }, "bank_code": { "description": "The numeric code for the bank account's bank.", "maxLength": 5000, "type": "string" }, "bank_name": { "description": "The name of the bank.", "maxLength": 5000, "type": "string" }, "branch_code": { "description": "The numeric code for the bank account's bank branch.", "maxLength": 5000, "type": "string" }, "last4": { "description": "Last four digits of the bank account number.", "maxLength": 5000, "type": "string" }, "suffix": { "description": "The suffix of the bank account number.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "bank_code", "bank_name", "branch_code", "last4" ], "title": "payment_method_nz_bank_account", "type": "object", "x-expandableFields": [] }, "payment_method_options_affirm": { "description": "", "properties": { "capture_method": { "description": "Controls when the funds will be captured from the customer's account.", "enum": [ "manual" ], "type": "string" }, "preferred_locale": { "description": "Preferred language of the Affirm authorization page that the customer is redirected to.", "maxLength": 30, "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_affirm", "type": "object", "x-expandableFields": [] }, "payment_method_options_afterpay_clearpay": { "description": "", "properties": { "capture_method": { "description": "Controls when the funds will be captured from the customer's account.", "enum": [ "manual" ], "type": "string" }, "reference": { "description": "An internal identifier or reference that this payment corresponds to. You must limit the identifier to 128 characters, and it can only contain letters, numbers, underscores, backslashes, and dashes.\nThis field differs from the statement descriptor and item name.", "maxLength": 5000, "nullable": true, "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "payment_method_options_afterpay_clearpay", "type": "object", "x-expandableFields": [] }, "payment_method_options_alipay": { "description": "", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none", "off_session" ], "type": "string" } }, "title": "payment_method_options_alipay", "type": "object", "x-expandableFields": [] }, "payment_method_options_alma": { "description": "", "properties": { "capture_method": { "description": "Controls when the funds will be captured from the customer's account.", "enum": [ "manual" ], "type": "string" } }, "title": "payment_method_options_alma", "type": "object", "x-expandableFields": [] }, "payment_method_options_amazon_pay": { "description": "", "properties": { "capture_method": { "description": "Controls when the funds will be captured from the customer's account.", "enum": [ "manual" ], "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none", "off_session" ], "type": "string" } }, "title": "payment_method_options_amazon_pay", "type": "object", "x-expandableFields": [] }, "payment_method_options_bancontact": { "description": "", "properties": { "preferred_language": { "description": "Preferred language of the Bancontact authorization page that the customer is redirected to.", "enum": [ "de", "en", "fr", "nl" ], "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none", "off_session" ], "type": "string" } }, "required": [ "preferred_language" ], "title": "payment_method_options_bancontact", "type": "object", "x-expandableFields": [] }, "payment_method_options_billie": { "description": "", "properties": { "capture_method": { "description": "Controls when the funds will be captured from the customer's account.", "enum": [ "manual" ], "type": "string" } }, "title": "payment_method_options_billie", "type": "object", "x-expandableFields": [] }, "payment_method_options_boleto": { "description": "", "properties": { "expires_after_days": { "description": "The number of calendar days before a Boleto voucher expires. For example, if you create a Boleto voucher on Monday and you set expires_after_days to 2, the Boleto voucher will expire on Wednesday at 23:59 America/Sao_Paulo time.", "type": "integer" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none", "off_session", "on_session" ], "type": "string" } }, "required": [ "expires_after_days" ], "title": "payment_method_options_boleto", "type": "object", "x-expandableFields": [] }, "payment_method_options_card_installments": { "description": "", "properties": { "available_plans": { "description": "Installment plans that may be selected for this PaymentIntent.", "items": { "$ref": "#/components/schemas/payment_method_details_card_installments_plan" }, "nullable": true, "type": "array" }, "enabled": { "description": "Whether Installments are enabled for this PaymentIntent.", "type": "boolean" }, "plan": { "anyOf": [ { "$ref": "#/components/schemas/payment_method_details_card_installments_plan" } ], "description": "Installment plan selected for this PaymentIntent.", "nullable": true } }, "required": [ "enabled" ], "title": "payment_method_options_card_installments", "type": "object", "x-expandableFields": [ "available_plans", "plan" ] }, "payment_method_options_card_mandate_options": { "description": "", "properties": { "amount": { "description": "Amount to be charged for future payments.", "type": "integer" }, "amount_type": { "description": "One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.", "enum": [ "fixed", "maximum" ], "type": "string" }, "description": { "description": "A description of the mandate or subscription that is meant to be displayed to the customer.", "maxLength": 200, "nullable": true, "type": "string" }, "end_date": { "description": "End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.", "format": "unix-time", "nullable": true, "type": "integer" }, "interval": { "description": "Specifies payment frequency. One of `day`, `week`, `month`, `year`, or `sporadic`.", "enum": [ "day", "month", "sporadic", "week", "year" ], "type": "string" }, "interval_count": { "description": "The number of intervals between payments. For example, `interval=month` and `interval_count=3` indicates one payment every three months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). This parameter is optional when `interval=sporadic`.", "nullable": true, "type": "integer" }, "reference": { "description": "Unique identifier for the mandate or subscription.", "maxLength": 80, "type": "string" }, "start_date": { "description": "Start date of the mandate or subscription. Start date should not be lesser than yesterday.", "format": "unix-time", "type": "integer" }, "supported_types": { "description": "Specifies the type of mandates supported. Possible values are `india`.", "items": { "enum": [ "india" ], "type": "string" }, "nullable": true, "type": "array" } }, "required": [ "amount", "amount_type", "interval", "reference", "start_date" ], "title": "payment_method_options_card_mandate_options", "type": "object", "x-expandableFields": [] }, "payment_method_options_card_present": { "description": "", "properties": { "request_extended_authorization": { "description": "Request ability to capture this payment beyond the standard [authorization validity window](https://stripe.com/docs/terminal/features/extended-authorizations#authorization-validity)", "nullable": true, "type": "boolean" }, "request_incremental_authorization_support": { "description": "Request ability to [increment](https://stripe.com/docs/terminal/features/incremental-authorizations) this PaymentIntent if the combination of MCC and card brand is eligible. Check [incremental_authorization_supported](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported) in the [Confirm](https://stripe.com/docs/api/payment_intents/confirm) response to verify support.", "nullable": true, "type": "boolean" }, "routing": { "$ref": "#/components/schemas/payment_method_options_card_present_routing" } }, "title": "payment_method_options_card_present", "type": "object", "x-expandableFields": [ "routing" ] }, "payment_method_options_card_present_routing": { "description": "", "properties": { "requested_priority": { "description": "Requested routing priority", "enum": [ "domestic", "international" ], "nullable": true, "type": "string" } }, "title": "payment_method_options_card_present_routing", "type": "object", "x-expandableFields": [] }, "payment_method_options_cashapp": { "description": "", "properties": { "capture_method": { "description": "Controls when the funds will be captured from the customer's account.", "enum": [ "manual" ], "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none", "off_session", "on_session" ], "type": "string" } }, "title": "payment_method_options_cashapp", "type": "object", "x-expandableFields": [] }, "payment_method_options_crypto": { "description": "", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "payment_method_options_crypto", "type": "object", "x-expandableFields": [] }, "payment_method_options_customer_balance": { "description": "", "properties": { "bank_transfer": { "$ref": "#/components/schemas/payment_method_options_customer_balance_bank_transfer" }, "funding_type": { "description": "The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.", "enum": [ "bank_transfer" ], "nullable": true, "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_customer_balance", "type": "object", "x-expandableFields": [ "bank_transfer" ] }, "payment_method_options_customer_balance_bank_transfer": { "description": "", "properties": { "eu_bank_transfer": { "$ref": "#/components/schemas/payment_method_options_customer_balance_eu_bank_account" }, "requested_address_types": { "description": "List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.\n\nPermitted values include: `sort_code`, `zengin`, `iban`, or `spei`.", "items": { "enum": [ "aba", "iban", "sepa", "sort_code", "spei", "swift", "zengin" ], "type": "string", "x-stripeBypassValidation": true }, "type": "array" }, "type": { "description": "The bank transfer type that this PaymentIntent is allowed to use for funding Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.", "enum": [ "eu_bank_transfer", "gb_bank_transfer", "jp_bank_transfer", "mx_bank_transfer", "us_bank_transfer" ], "nullable": true, "type": "string", "x-stripeBypassValidation": true } }, "title": "payment_method_options_customer_balance_bank_transfer", "type": "object", "x-expandableFields": [ "eu_bank_transfer" ] }, "payment_method_options_customer_balance_eu_bank_account": { "description": "", "properties": { "country": { "description": "The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`.", "enum": [ "BE", "DE", "ES", "FR", "IE", "NL" ], "type": "string" } }, "required": [ "country" ], "title": "payment_method_options_customer_balance_eu_bank_account", "type": "object", "x-expandableFields": [] }, "payment_method_options_fpx": { "description": "", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_fpx", "type": "object", "x-expandableFields": [] }, "payment_method_options_giropay": { "description": "", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_giropay", "type": "object", "x-expandableFields": [] }, "payment_method_options_grabpay": { "description": "", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_grabpay", "type": "object", "x-expandableFields": [] }, "payment_method_options_ideal": { "description": "", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none", "off_session" ], "type": "string" } }, "title": "payment_method_options_ideal", "type": "object", "x-expandableFields": [] }, "payment_method_options_interac_present": { "description": "", "properties": {}, "title": "payment_method_options_interac_present", "type": "object", "x-expandableFields": [] }, "payment_method_options_klarna": { "description": "", "properties": { "capture_method": { "description": "Controls when the funds will be captured from the customer's account.", "enum": [ "manual" ], "type": "string" }, "preferred_locale": { "description": "Preferred locale of the Klarna checkout page that the customer is redirected to.", "maxLength": 5000, "nullable": true, "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none", "off_session", "on_session" ], "type": "string" } }, "title": "payment_method_options_klarna", "type": "object", "x-expandableFields": [] }, "payment_method_options_konbini": { "description": "", "properties": { "confirmation_number": { "description": "An optional 10 to 11 digit numeric-only string determining the confirmation code at applicable convenience stores.", "maxLength": 5000, "nullable": true, "type": "string" }, "expires_after_days": { "description": "The number of calendar days (between 1 and 60) after which Konbini payment instructions will expire. For example, if a PaymentIntent is confirmed with Konbini and `expires_after_days` set to 2 on Monday JST, the instructions will expire on Wednesday 23:59:59 JST.", "nullable": true, "type": "integer" }, "expires_at": { "description": "The timestamp at which the Konbini payment instructions will expire. Only one of `expires_after_days` or `expires_at` may be set.", "format": "unix-time", "nullable": true, "type": "integer" }, "product_description": { "description": "A product descriptor of up to 22 characters, which will appear to customers at the convenience store.", "maxLength": 5000, "nullable": true, "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_konbini", "type": "object", "x-expandableFields": [] }, "payment_method_options_kr_card": { "description": "", "properties": { "capture_method": { "description": "Controls when the funds will be captured from the customer's account.", "enum": [ "manual" ], "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none", "off_session" ], "type": "string" } }, "title": "payment_method_options_kr_card", "type": "object", "x-expandableFields": [] }, "payment_method_options_multibanco": { "description": "", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_multibanco", "type": "object", "x-expandableFields": [] }, "payment_method_options_oxxo": { "description": "", "properties": { "expires_after_days": { "description": "The number of calendar days before an OXXO invoice expires. For example, if you create an OXXO invoice on Monday and you set expires_after_days to 2, the OXXO invoice will expire on Wednesday at 23:59 America/Mexico_City time.", "type": "integer" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string" } }, "required": [ "expires_after_days" ], "title": "payment_method_options_oxxo", "type": "object", "x-expandableFields": [] }, "payment_method_options_p24": { "description": "", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_p24", "type": "object", "x-expandableFields": [] }, "payment_method_options_pay_by_bank": { "description": "", "properties": {}, "title": "payment_method_options_pay_by_bank", "type": "object", "x-expandableFields": [] }, "payment_method_options_paynow": { "description": "", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_paynow", "type": "object", "x-expandableFields": [] }, "payment_method_options_paypal": { "description": "", "properties": { "capture_method": { "description": "Controls when the funds will be captured from the customer's account.", "enum": [ "manual" ], "type": "string" }, "preferred_locale": { "description": "Preferred locale of the PayPal checkout page that the customer is redirected to.", "maxLength": 5000, "nullable": true, "type": "string" }, "reference": { "description": "A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID.", "maxLength": 5000, "nullable": true, "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none", "off_session" ], "type": "string" } }, "title": "payment_method_options_paypal", "type": "object", "x-expandableFields": [] }, "payment_method_options_pix": { "description": "", "properties": { "amount_includes_iof": { "description": "Determines if the amount includes the IOF tax.", "enum": [ "always", "never" ], "type": "string" }, "expires_after_seconds": { "description": "The number of seconds (between 10 and 1209600) after which Pix payment will expire.", "nullable": true, "type": "integer" }, "expires_at": { "description": "The timestamp at which the Pix expires.", "nullable": true, "type": "integer" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "payment_method_options_pix", "type": "object", "x-expandableFields": [] }, "payment_method_options_promptpay": { "description": "", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_promptpay", "type": "object", "x-expandableFields": [] }, "payment_method_options_revolut_pay": { "description": "", "properties": { "capture_method": { "description": "Controls when the funds will be captured from the customer's account.", "enum": [ "manual" ], "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none", "off_session" ], "type": "string" } }, "title": "payment_method_options_revolut_pay", "type": "object", "x-expandableFields": [] }, "payment_method_options_satispay": { "description": "", "properties": { "capture_method": { "description": "Controls when the funds will be captured from the customer's account.", "enum": [ "manual" ], "type": "string" } }, "title": "payment_method_options_satispay", "type": "object", "x-expandableFields": [] }, "payment_method_options_sofort": { "description": "", "properties": { "preferred_language": { "description": "Preferred language of the SOFORT authorization page that the customer is redirected to.", "enum": [ "de", "en", "es", "fr", "it", "nl", "pl" ], "nullable": true, "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none", "off_session" ], "type": "string" } }, "title": "payment_method_options_sofort", "type": "object", "x-expandableFields": [] }, "payment_method_options_twint": { "description": "", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_twint", "type": "object", "x-expandableFields": [] }, "payment_method_options_us_bank_account_mandate_options": { "description": "", "properties": { "collection_method": { "description": "Mandate collection method", "enum": [ "paper" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "payment_method_options_us_bank_account_mandate_options", "type": "object", "x-expandableFields": [] }, "payment_method_options_wechat_pay": { "description": "", "properties": { "app_id": { "description": "The app ID registered with WeChat Pay. Only required when client is ios or android.", "maxLength": 5000, "nullable": true, "type": "string" }, "client": { "description": "The client type that the end customer will pay from", "enum": [ "android", "ios", "web" ], "nullable": true, "type": "string", "x-stripeBypassValidation": true }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_wechat_pay", "type": "object", "x-expandableFields": [] }, "payment_method_options_zip": { "description": "", "properties": { "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_zip", "type": "object", "x-expandableFields": [] }, "payment_method_oxxo": { "description": "", "properties": {}, "title": "payment_method_oxxo", "type": "object", "x-expandableFields": [] }, "payment_method_p24": { "description": "", "properties": { "bank": { "description": "The customer's bank, if provided.", "enum": [ "alior_bank", "bank_millennium", "bank_nowy_bfg_sa", "bank_pekao_sa", "banki_spbdzielcze", "blik", "bnp_paribas", "boz", "citi_handlowy", "credit_agricole", "envelobank", "etransfer_pocztowy24", "getin_bank", "ideabank", "ing", "inteligo", "mbank_mtransfer", "nest_przelew", "noble_pay", "pbac_z_ipko", "plus_bank", "santander_przelew24", "tmobile_usbugi_bankowe", "toyota_bank", "velobank", "volkswagen_bank" ], "nullable": true, "type": "string", "x-stripeBypassValidation": true } }, "title": "payment_method_p24", "type": "object", "x-expandableFields": [] }, "payment_method_pay_by_bank": { "description": "", "properties": {}, "title": "payment_method_pay_by_bank", "type": "object", "x-expandableFields": [] }, "payment_method_payco": { "description": "", "properties": {}, "title": "payment_method_payco", "type": "object", "x-expandableFields": [] }, "payment_method_paynow": { "description": "", "properties": {}, "title": "payment_method_paynow", "type": "object", "x-expandableFields": [] }, "payment_method_paypal": { "description": "", "properties": { "country": { "description": "Two-letter ISO code representing the buyer's country. Values are provided by PayPal directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.", "maxLength": 5000, "nullable": true, "type": "string" }, "payer_email": { "description": "Owner's email. Values are provided by PayPal directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated.", "maxLength": 5000, "nullable": true, "type": "string" }, "payer_id": { "description": "PayPal account PayerID. This identifier uniquely identifies the PayPal customer.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "payment_method_paypal", "type": "object", "x-expandableFields": [] }, "payment_method_pix": { "description": "", "properties": {}, "title": "payment_method_pix", "type": "object", "x-expandableFields": [] }, "payment_method_promptpay": { "description": "", "properties": {}, "title": "payment_method_promptpay", "type": "object", "x-expandableFields": [] }, "payment_method_revolut_pay": { "description": "", "properties": {}, "title": "payment_method_revolut_pay", "type": "object", "x-expandableFields": [] }, "payment_method_samsung_pay": { "description": "", "properties": {}, "title": "payment_method_samsung_pay", "type": "object", "x-expandableFields": [] }, "payment_method_satispay": { "description": "", "properties": {}, "title": "payment_method_satispay", "type": "object", "x-expandableFields": [] }, "payment_method_sepa_debit": { "description": "", "properties": { "bank_code": { "description": "Bank code of bank associated with the bank account.", "maxLength": 5000, "nullable": true, "type": "string" }, "branch_code": { "description": "Branch code of bank associated with the bank account.", "maxLength": 5000, "nullable": true, "type": "string" }, "country": { "description": "Two-letter ISO code representing the country the bank account is located in.", "maxLength": 5000, "nullable": true, "type": "string" }, "fingerprint": { "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.", "maxLength": 5000, "nullable": true, "type": "string" }, "generated_from": { "anyOf": [ { "$ref": "#/components/schemas/sepa_debit_generated_from" } ], "description": "Information about the object that generated this PaymentMethod.", "nullable": true }, "last4": { "description": "Last four characters of the IBAN.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "payment_method_sepa_debit", "type": "object", "x-expandableFields": [ "generated_from" ] }, "payment_method_sofort": { "description": "", "properties": { "country": { "description": "Two-letter ISO code representing the country the bank account is located in.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "payment_method_sofort", "type": "object", "x-expandableFields": [] }, "payment_method_swish": { "description": "", "properties": {}, "title": "payment_method_swish", "type": "object", "x-expandableFields": [] }, "payment_method_twint": { "description": "", "properties": {}, "title": "payment_method_twint", "type": "object", "x-expandableFields": [] }, "payment_method_us_bank_account": { "description": "", "properties": { "account_holder_type": { "description": "Account holder type: individual or company.", "enum": [ "company", "individual" ], "nullable": true, "type": "string" }, "account_type": { "description": "Account type: checkings or savings. Defaults to checking if omitted.", "enum": [ "checking", "savings" ], "nullable": true, "type": "string" }, "bank_name": { "description": "The name of the bank.", "maxLength": 5000, "nullable": true, "type": "string" }, "financial_connections_account": { "description": "The ID of the Financial Connections Account used to create the payment method.", "maxLength": 5000, "nullable": true, "type": "string" }, "fingerprint": { "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.", "maxLength": 5000, "nullable": true, "type": "string" }, "last4": { "description": "Last four digits of the bank account number.", "maxLength": 5000, "nullable": true, "type": "string" }, "networks": { "anyOf": [ { "$ref": "#/components/schemas/us_bank_account_networks" } ], "description": "Contains information about US bank account networks that can be used.", "nullable": true }, "routing_number": { "description": "Routing number of the bank account.", "maxLength": 5000, "nullable": true, "type": "string" }, "status_details": { "anyOf": [ { "$ref": "#/components/schemas/payment_method_us_bank_account_status_details" } ], "description": "Contains information about the future reusability of this PaymentMethod.", "nullable": true } }, "title": "payment_method_us_bank_account", "type": "object", "x-expandableFields": [ "networks", "status_details" ] }, "payment_method_us_bank_account_blocked": { "description": "", "properties": { "network_code": { "description": "The ACH network code that resulted in this block.", "enum": [ "R02", "R03", "R04", "R05", "R07", "R08", "R10", "R11", "R16", "R20", "R29", "R31" ], "nullable": true, "type": "string" }, "reason": { "description": "The reason why this PaymentMethod's fingerprint has been blocked", "enum": [ "bank_account_closed", "bank_account_frozen", "bank_account_invalid_details", "bank_account_restricted", "bank_account_unusable", "debit_not_authorized" ], "nullable": true, "type": "string" } }, "title": "payment_method_us_bank_account_blocked", "type": "object", "x-expandableFields": [] }, "payment_method_us_bank_account_status_details": { "description": "", "properties": { "blocked": { "$ref": "#/components/schemas/payment_method_us_bank_account_blocked" } }, "title": "payment_method_us_bank_account_status_details", "type": "object", "x-expandableFields": [ "blocked" ] }, "payment_method_wechat_pay": { "description": "", "properties": {}, "title": "payment_method_wechat_pay", "type": "object", "x-expandableFields": [] }, "payment_method_zip": { "description": "", "properties": {}, "title": "payment_method_zip", "type": "object", "x-expandableFields": [] }, "payment_pages_checkout_session_adaptive_pricing": { "description": "", "properties": { "enabled": { "description": "If enabled, Adaptive Pricing is available on [eligible sessions](https://docs.stripe.com/payments/currencies/localize-prices/adaptive-pricing?payment-ui=stripe-hosted#restrictions).", "type": "boolean" } }, "required": [ "enabled" ], "title": "PaymentPagesCheckoutSessionAdaptivePricing", "type": "object", "x-expandableFields": [] }, "payment_pages_checkout_session_after_expiration": { "description": "", "properties": { "recovery": { "anyOf": [ { "$ref": "#/components/schemas/payment_pages_checkout_session_after_expiration_recovery" } ], "description": "When set, configuration used to recover the Checkout Session on expiry.", "nullable": true } }, "title": "PaymentPagesCheckoutSessionAfterExpiration", "type": "object", "x-expandableFields": [ "recovery" ] }, "payment_pages_checkout_session_after_expiration_recovery": { "description": "", "properties": { "allow_promotion_codes": { "description": "Enables user redeemable promotion codes on the recovered Checkout Sessions. Defaults to `false`", "type": "boolean" }, "enabled": { "description": "If `true`, a recovery url will be generated to recover this Checkout Session if it\nexpires before a transaction is completed. It will be attached to the\nCheckout Session object upon expiration.", "type": "boolean" }, "expires_at": { "description": "The timestamp at which the recovery URL will expire.", "format": "unix-time", "nullable": true, "type": "integer" }, "url": { "description": "URL that creates a new Checkout Session when clicked that is a copy of this expired Checkout Session", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "allow_promotion_codes", "enabled" ], "title": "PaymentPagesCheckoutSessionAfterExpirationRecovery", "type": "object", "x-expandableFields": [] }, "payment_pages_checkout_session_automatic_tax": { "description": "", "properties": { "enabled": { "description": "Indicates whether automatic tax is enabled for the session", "type": "boolean" }, "liability": { "anyOf": [ { "$ref": "#/components/schemas/connect_account_reference" } ], "description": "The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.", "nullable": true }, "provider": { "description": "The tax provider powering automatic tax.", "maxLength": 5000, "nullable": true, "type": "string" }, "status": { "description": "The status of the most recent automated tax calculation for this session.", "enum": [ "complete", "failed", "requires_location_inputs" ], "nullable": true, "type": "string" } }, "required": [ "enabled" ], "title": "PaymentPagesCheckoutSessionAutomaticTax", "type": "object", "x-expandableFields": [ "liability" ] }, "payment_pages_checkout_session_checkout_address_details": { "description": "", "properties": { "address": { "$ref": "#/components/schemas/address" }, "name": { "description": "Customer name.", "maxLength": 5000, "type": "string" } }, "required": [ "address", "name" ], "title": "PaymentPagesCheckoutSessionCheckoutAddressDetails", "type": "object", "x-expandableFields": [ "address" ] }, "payment_pages_checkout_session_collected_information": { "description": "", "properties": { "shipping_details": { "anyOf": [ { "$ref": "#/components/schemas/payment_pages_checkout_session_checkout_address_details" } ], "description": "Shipping information for this Checkout Session.", "nullable": true } }, "title": "PaymentPagesCheckoutSessionCollectedInformation", "type": "object", "x-expandableFields": [ "shipping_details" ] }, "payment_pages_checkout_session_consent": { "description": "", "properties": { "promotions": { "description": "If `opt_in`, the customer consents to receiving promotional communications\nfrom the merchant about this Checkout Session.", "enum": [ "opt_in", "opt_out" ], "nullable": true, "type": "string" }, "terms_of_service": { "description": "If `accepted`, the customer in this Checkout Session has agreed to the merchant's terms of service.", "enum": [ "accepted" ], "nullable": true, "type": "string", "x-stripeBypassValidation": true } }, "title": "PaymentPagesCheckoutSessionConsent", "type": "object", "x-expandableFields": [] }, "payment_pages_checkout_session_consent_collection": { "description": "", "properties": { "payment_method_reuse_agreement": { "anyOf": [ { "$ref": "#/components/schemas/payment_pages_checkout_session_payment_method_reuse_agreement" } ], "description": "If set to `hidden`, it will hide legal text related to the reuse of a payment method.", "nullable": true }, "promotions": { "description": "If set to `auto`, enables the collection of customer consent for promotional communications. The Checkout\nSession will determine whether to display an option to opt into promotional communication\nfrom the merchant depending on the customer's locale. Only available to US merchants.", "enum": [ "auto", "none" ], "nullable": true, "type": "string" }, "terms_of_service": { "description": "If set to `required`, it requires customers to accept the terms of service before being able to pay.", "enum": [ "none", "required" ], "nullable": true, "type": "string" } }, "title": "PaymentPagesCheckoutSessionConsentCollection", "type": "object", "x-expandableFields": [ "payment_method_reuse_agreement" ] }, "payment_pages_checkout_session_currency_conversion": { "description": "", "properties": { "amount_subtotal": { "description": "Total of all items in source currency before discounts or taxes are applied.", "type": "integer" }, "amount_total": { "description": "Total of all items in source currency after discounts and taxes are applied.", "type": "integer" }, "fx_rate": { "description": "Exchange rate used to convert source currency amounts to customer currency amounts", "format": "decimal", "type": "string" }, "source_currency": { "description": "Creation currency of the CheckoutSession before localization", "maxLength": 5000, "type": "string" } }, "required": [ "amount_subtotal", "amount_total", "fx_rate", "source_currency" ], "title": "PaymentPagesCheckoutSessionCurrencyConversion", "type": "object", "x-expandableFields": [] }, "payment_pages_checkout_session_custom_fields": { "description": "", "properties": { "dropdown": { "$ref": "#/components/schemas/payment_pages_checkout_session_custom_fields_dropdown" }, "key": { "description": "String of your choice that your integration can use to reconcile this field. Must be unique to this field, alphanumeric, and up to 200 characters.", "maxLength": 5000, "type": "string" }, "label": { "$ref": "#/components/schemas/payment_pages_checkout_session_custom_fields_label" }, "numeric": { "$ref": "#/components/schemas/payment_pages_checkout_session_custom_fields_numeric" }, "optional": { "description": "Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`.", "type": "boolean" }, "text": { "$ref": "#/components/schemas/payment_pages_checkout_session_custom_fields_text" }, "type": { "description": "The type of the field.", "enum": [ "dropdown", "numeric", "text" ], "type": "string" } }, "required": [ "key", "label", "optional", "type" ], "title": "PaymentPagesCheckoutSessionCustomFields", "type": "object", "x-expandableFields": [ "dropdown", "label", "numeric", "text" ] }, "payment_pages_checkout_session_custom_fields_dropdown": { "description": "", "properties": { "default_value": { "description": "The value that will pre-fill on the payment page.", "maxLength": 5000, "nullable": true, "type": "string" }, "options": { "description": "The options available for the customer to select. Up to 200 options allowed.", "items": { "$ref": "#/components/schemas/payment_pages_checkout_session_custom_fields_option" }, "type": "array" }, "value": { "description": "The option selected by the customer. This will be the `value` for the option.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "options" ], "title": "PaymentPagesCheckoutSessionCustomFieldsDropdown", "type": "object", "x-expandableFields": [ "options" ] }, "payment_pages_checkout_session_custom_fields_label": { "description": "", "properties": { "custom": { "description": "Custom text for the label, displayed to the customer. Up to 50 characters.", "maxLength": 5000, "nullable": true, "type": "string" }, "type": { "description": "The type of the label.", "enum": [ "custom" ], "type": "string" } }, "required": [ "type" ], "title": "PaymentPagesCheckoutSessionCustomFieldsLabel", "type": "object", "x-expandableFields": [] }, "payment_pages_checkout_session_custom_fields_numeric": { "description": "", "properties": { "default_value": { "description": "The value that will pre-fill the field on the payment page.", "maxLength": 5000, "nullable": true, "type": "string" }, "maximum_length": { "description": "The maximum character length constraint for the customer's input.", "nullable": true, "type": "integer" }, "minimum_length": { "description": "The minimum character length requirement for the customer's input.", "nullable": true, "type": "integer" }, "value": { "description": "The value entered by the customer, containing only digits.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "PaymentPagesCheckoutSessionCustomFieldsNumeric", "type": "object", "x-expandableFields": [] }, "payment_pages_checkout_session_custom_fields_option": { "description": "", "properties": { "label": { "description": "The label for the option, displayed to the customer. Up to 100 characters.", "maxLength": 5000, "type": "string" }, "value": { "description": "The value for this option, not displayed to the customer, used by your integration to reconcile the option selected by the customer. Must be unique to this option, alphanumeric, and up to 100 characters.", "maxLength": 5000, "type": "string" } }, "required": [ "label", "value" ], "title": "PaymentPagesCheckoutSessionCustomFieldsOption", "type": "object", "x-expandableFields": [] }, "payment_pages_checkout_session_custom_fields_text": { "description": "", "properties": { "default_value": { "description": "The value that will pre-fill the field on the payment page.", "maxLength": 5000, "nullable": true, "type": "string" }, "maximum_length": { "description": "The maximum character length constraint for the customer's input.", "nullable": true, "type": "integer" }, "minimum_length": { "description": "The minimum character length requirement for the customer's input.", "nullable": true, "type": "integer" }, "value": { "description": "The value entered by the customer.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "PaymentPagesCheckoutSessionCustomFieldsText", "type": "object", "x-expandableFields": [] }, "payment_pages_checkout_session_custom_text": { "description": "", "properties": { "after_submit": { "anyOf": [ { "$ref": "#/components/schemas/payment_pages_checkout_session_custom_text_position" } ], "description": "Custom text that should be displayed after the payment confirmation button.", "nullable": true }, "shipping_address": { "anyOf": [ { "$ref": "#/components/schemas/payment_pages_checkout_session_custom_text_position" } ], "description": "Custom text that should be displayed alongside shipping address collection.", "nullable": true }, "submit": { "anyOf": [ { "$ref": "#/components/schemas/payment_pages_checkout_session_custom_text_position" } ], "description": "Custom text that should be displayed alongside the payment confirmation button.", "nullable": true }, "terms_of_service_acceptance": { "anyOf": [ { "$ref": "#/components/schemas/payment_pages_checkout_session_custom_text_position" } ], "description": "Custom text that should be displayed in place of the default terms of service agreement text.", "nullable": true } }, "title": "PaymentPagesCheckoutSessionCustomText", "type": "object", "x-expandableFields": [ "after_submit", "shipping_address", "submit", "terms_of_service_acceptance" ] }, "payment_pages_checkout_session_custom_text_position": { "description": "", "properties": { "message": { "description": "Text may be up to 1200 characters in length.", "maxLength": 500, "type": "string" } }, "required": [ "message" ], "title": "PaymentPagesCheckoutSessionCustomTextPosition", "type": "object", "x-expandableFields": [] }, "payment_pages_checkout_session_customer_details": { "description": "", "properties": { "address": { "anyOf": [ { "$ref": "#/components/schemas/address" } ], "description": "The customer's address after a completed Checkout Session. Note: This property is populated only for sessions on or after March 30, 2022.", "nullable": true }, "email": { "description": "The email associated with the Customer, if one exists, on the Checkout Session after a completed Checkout Session or at time of session expiry.\nOtherwise, if the customer has consented to promotional content, this value is the most recent valid email provided by the customer on the Checkout form.", "maxLength": 5000, "nullable": true, "type": "string" }, "name": { "description": "The customer's name after a completed Checkout Session. Note: This property is populated only for sessions on or after March 30, 2022.", "maxLength": 5000, "nullable": true, "type": "string" }, "phone": { "description": "The customer's phone number after a completed Checkout Session.", "maxLength": 5000, "nullable": true, "type": "string" }, "tax_exempt": { "description": "The customer’s tax exempt status after a completed Checkout Session.", "enum": [ "exempt", "none", "reverse" ], "nullable": true, "type": "string" }, "tax_ids": { "description": "The customer’s tax IDs after a completed Checkout Session.", "items": { "$ref": "#/components/schemas/payment_pages_checkout_session_tax_id" }, "nullable": true, "type": "array" } }, "title": "PaymentPagesCheckoutSessionCustomerDetails", "type": "object", "x-expandableFields": [ "address", "tax_ids" ] }, "payment_pages_checkout_session_discount": { "description": "", "properties": { "coupon": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/coupon" } ], "description": "Coupon attached to the Checkout Session.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/coupon" } ] } }, "promotion_code": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/promotion_code" } ], "description": "Promotion code attached to the Checkout Session.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/promotion_code" } ] } } }, "title": "PaymentPagesCheckoutSessionDiscount", "type": "object", "x-expandableFields": [ "coupon", "promotion_code" ] }, "payment_pages_checkout_session_invoice_creation": { "description": "", "properties": { "enabled": { "description": "Indicates whether invoice creation is enabled for the Checkout Session.", "type": "boolean" }, "invoice_data": { "$ref": "#/components/schemas/payment_pages_checkout_session_invoice_settings" } }, "required": [ "enabled", "invoice_data" ], "title": "PaymentPagesCheckoutSessionInvoiceCreation", "type": "object", "x-expandableFields": [ "invoice_data" ] }, "payment_pages_checkout_session_invoice_settings": { "description": "", "properties": { "account_tax_ids": { "description": "The account tax IDs associated with the invoice.", "items": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/tax_id" }, { "$ref": "#/components/schemas/deleted_tax_id" } ], "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/tax_id" }, { "$ref": "#/components/schemas/deleted_tax_id" } ] } }, "nullable": true, "type": "array" }, "custom_fields": { "description": "Custom fields displayed on the invoice.", "items": { "$ref": "#/components/schemas/invoice_setting_custom_field" }, "nullable": true, "type": "array" }, "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users.", "maxLength": 5000, "nullable": true, "type": "string" }, "footer": { "description": "Footer displayed on the invoice.", "maxLength": 5000, "nullable": true, "type": "string" }, "issuer": { "anyOf": [ { "$ref": "#/components/schemas/connect_account_reference" } ], "description": "The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.", "nullable": true }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "nullable": true, "type": "object" }, "rendering_options": { "anyOf": [ { "$ref": "#/components/schemas/invoice_setting_checkout_rendering_options" } ], "description": "Options for invoice PDF rendering.", "nullable": true } }, "title": "PaymentPagesCheckoutSessionInvoiceSettings", "type": "object", "x-expandableFields": [ "account_tax_ids", "custom_fields", "issuer", "rendering_options" ] }, "payment_pages_checkout_session_optional_item": { "description": "", "properties": { "adjustable_quantity": { "anyOf": [ { "$ref": "#/components/schemas/payment_pages_checkout_session_optional_item_adjustable_quantity" } ], "nullable": true }, "price": { "maxLength": 5000, "type": "string" }, "quantity": { "type": "integer" } }, "required": [ "price", "quantity" ], "title": "PaymentPagesCheckoutSessionOptionalItem", "type": "object", "x-expandableFields": [ "adjustable_quantity" ] }, "payment_pages_checkout_session_optional_item_adjustable_quantity": { "description": "", "properties": { "enabled": { "description": "Set to true if the quantity can be adjusted to any non-negative integer.", "type": "boolean" }, "maximum": { "description": "The maximum quantity of this item the customer can purchase. By default this value is 99. You can specify a value up to 999999.", "nullable": true, "type": "integer" }, "minimum": { "description": "The minimum quantity of this item the customer must purchase, if they choose to purchase it. Because this item is optional, the customer will always be able to remove it from their order, even if the `minimum` configured here is greater than 0. By default this value is 0.", "nullable": true, "type": "integer" } }, "required": [ "enabled" ], "title": "PaymentPagesCheckoutSessionOptionalItemAdjustableQuantity", "type": "object", "x-expandableFields": [] }, "payment_pages_checkout_session_payment_method_reuse_agreement": { "description": "", "properties": { "position": { "description": "Determines the position and visibility of the payment method reuse agreement in the UI. When set to `auto`, Stripe's defaults will be used.\n\nWhen set to `hidden`, the payment method reuse agreement text will always be hidden in the UI.", "enum": [ "auto", "hidden" ], "type": "string" } }, "required": [ "position" ], "title": "PaymentPagesCheckoutSessionPaymentMethodReuseAgreement", "type": "object", "x-expandableFields": [] }, "payment_pages_checkout_session_permissions": { "description": "", "properties": { "update_shipping_details": { "description": "Determines which entity is allowed to update the shipping details.\n\nDefault is `client_only`. Stripe Checkout client will automatically update the shipping details. If set to `server_only`, only your server is allowed to update the shipping details.\n\nWhen set to `server_only`, you must add the onShippingDetailsChange event handler when initializing the Stripe Checkout client and manually update the shipping details from your server using the Stripe API.", "enum": [ "client_only", "server_only" ], "nullable": true, "type": "string" } }, "title": "PaymentPagesCheckoutSessionPermissions", "type": "object", "x-expandableFields": [] }, "payment_pages_checkout_session_phone_number_collection": { "description": "", "properties": { "enabled": { "description": "Indicates whether phone number collection is enabled for the session", "type": "boolean" } }, "required": [ "enabled" ], "title": "PaymentPagesCheckoutSessionPhoneNumberCollection", "type": "object", "x-expandableFields": [] }, "payment_pages_checkout_session_saved_payment_method_options": { "description": "", "properties": { "allow_redisplay_filters": { "description": "Uses the `allow_redisplay` value of each saved payment method to filter the set presented to a returning customer. By default, only saved payment methods with ’allow_redisplay: ‘always’ are shown in Checkout.", "items": { "enum": [ "always", "limited", "unspecified" ], "type": "string" }, "nullable": true, "type": "array" }, "payment_method_remove": { "description": "Enable customers to choose if they wish to remove their saved payment methods. Disabled by default.", "enum": [ "disabled", "enabled" ], "nullable": true, "type": "string" }, "payment_method_save": { "description": "Enable customers to choose if they wish to save their payment method for future use. Disabled by default.", "enum": [ "disabled", "enabled" ], "nullable": true, "type": "string" } }, "title": "PaymentPagesCheckoutSessionSavedPaymentMethodOptions", "type": "object", "x-expandableFields": [] }, "payment_pages_checkout_session_shipping_address_collection": { "description": "", "properties": { "allowed_countries": { "description": "An array of two-letter ISO country codes representing which countries Checkout should provide as options for\nshipping locations. Unsupported country codes: `AS, CX, CC, CU, HM, IR, KP, MH, FM, NF, MP, PW, SY, UM, VI`.", "items": { "enum": [ "AC", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CV", "CW", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MK", "ML", "MM", "MN", "MO", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SZ", "TA", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VN", "VU", "WF", "WS", "XK", "YE", "YT", "ZA", "ZM", "ZW", "ZZ" ], "type": "string" }, "type": "array" } }, "required": [ "allowed_countries" ], "title": "PaymentPagesCheckoutSessionShippingAddressCollection", "type": "object", "x-expandableFields": [] }, "payment_pages_checkout_session_shipping_cost": { "description": "", "properties": { "amount_subtotal": { "description": "Total shipping cost before any discounts or taxes are applied.", "type": "integer" }, "amount_tax": { "description": "Total tax amount applied due to shipping costs. If no tax was applied, defaults to 0.", "type": "integer" }, "amount_total": { "description": "Total shipping cost after discounts and taxes are applied.", "type": "integer" }, "shipping_rate": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/shipping_rate" } ], "description": "The ID of the ShippingRate for this order.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/shipping_rate" } ] } }, "taxes": { "description": "The taxes applied to the shipping rate.", "items": { "$ref": "#/components/schemas/line_items_tax_amount" }, "type": "array" } }, "required": [ "amount_subtotal", "amount_tax", "amount_total" ], "title": "PaymentPagesCheckoutSessionShippingCost", "type": "object", "x-expandableFields": [ "shipping_rate", "taxes" ] }, "payment_pages_checkout_session_shipping_option": { "description": "", "properties": { "shipping_amount": { "description": "A non-negative integer in cents representing how much to charge.", "type": "integer" }, "shipping_rate": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/shipping_rate" } ], "description": "The shipping rate.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/shipping_rate" } ] } } }, "required": [ "shipping_amount", "shipping_rate" ], "title": "PaymentPagesCheckoutSessionShippingOption", "type": "object", "x-expandableFields": [ "shipping_rate" ] }, "payment_pages_checkout_session_tax_id": { "description": "", "properties": { "type": { "description": "The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `al_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, `aw_tin`, `az_tin`, `bd_bin`, `bj_ifu`, `et_tin`, `kg_tin`, `la_tin`, `cm_niu`, `cv_nif`, `bf_ifu`, or `unknown`", "enum": [ "ad_nrt", "ae_trn", "al_tin", "am_tin", "ao_tin", "ar_cuit", "au_abn", "au_arn", "aw_tin", "az_tin", "ba_tin", "bb_tin", "bd_bin", "bf_ifu", "bg_uic", "bh_vat", "bj_ifu", "bo_tin", "br_cnpj", "br_cpf", "bs_tin", "by_tin", "ca_bn", "ca_gst_hst", "ca_pst_bc", "ca_pst_mb", "ca_pst_sk", "ca_qst", "cd_nif", "ch_uid", "ch_vat", "cl_tin", "cm_niu", "cn_tin", "co_nit", "cr_tin", "cv_nif", "de_stn", "do_rcn", "ec_ruc", "eg_tin", "es_cif", "et_tin", "eu_oss_vat", "eu_vat", "gb_vat", "ge_vat", "gn_nif", "hk_br", "hr_oib", "hu_tin", "id_npwp", "il_vat", "in_gst", "is_vat", "jp_cn", "jp_rn", "jp_trn", "ke_pin", "kg_tin", "kh_tin", "kr_brn", "kz_bin", "la_tin", "li_uid", "li_vat", "ma_vat", "md_vat", "me_pib", "mk_vat", "mr_nif", "mx_rfc", "my_frp", "my_itn", "my_sst", "ng_tin", "no_vat", "no_voec", "np_pan", "nz_gst", "om_vat", "pe_ruc", "ph_tin", "ro_tin", "rs_pib", "ru_inn", "ru_kpp", "sa_vat", "sg_gst", "sg_uen", "si_tin", "sn_ninea", "sr_fin", "sv_nit", "th_vat", "tj_tin", "tr_tin", "tw_vat", "tz_vat", "ua_vat", "ug_tin", "unknown", "us_ein", "uy_ruc", "uz_tin", "uz_vat", "ve_rif", "vn_tin", "za_vat", "zm_tin", "zw_tin" ], "type": "string" }, "value": { "description": "The value of the tax ID.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "type" ], "title": "PaymentPagesCheckoutSessionTaxID", "type": "object", "x-expandableFields": [] }, "payment_pages_checkout_session_tax_id_collection": { "description": "", "properties": { "enabled": { "description": "Indicates whether tax ID collection is enabled for the session", "type": "boolean" }, "required": { "description": "Indicates whether a tax ID is required on the payment page", "enum": [ "if_supported", "never" ], "type": "string" } }, "required": [ "enabled", "required" ], "title": "PaymentPagesCheckoutSessionTaxIDCollection", "type": "object", "x-expandableFields": [] }, "payment_pages_checkout_session_total_details": { "description": "", "properties": { "amount_discount": { "description": "This is the sum of all the discounts.", "type": "integer" }, "amount_shipping": { "description": "This is the sum of all the shipping amounts.", "nullable": true, "type": "integer" }, "amount_tax": { "description": "This is the sum of all the tax amounts.", "type": "integer" }, "breakdown": { "$ref": "#/components/schemas/payment_pages_checkout_session_total_details_resource_breakdown" } }, "required": [ "amount_discount", "amount_tax" ], "title": "PaymentPagesCheckoutSessionTotalDetails", "type": "object", "x-expandableFields": [ "breakdown" ] }, "payment_pages_checkout_session_total_details_resource_breakdown": { "description": "", "properties": { "discounts": { "description": "The aggregated discounts.", "items": { "$ref": "#/components/schemas/line_items_discount_amount" }, "type": "array" }, "taxes": { "description": "The aggregated tax amounts by rate.", "items": { "$ref": "#/components/schemas/line_items_tax_amount" }, "type": "array" } }, "required": [ "discounts", "taxes" ], "title": "PaymentPagesCheckoutSessionTotalDetailsResourceBreakdown", "type": "object", "x-expandableFields": [ "discounts", "taxes" ] }, "payment_pages_private_card_payment_method_options_resource_restrictions": { "description": "", "properties": { "brands_blocked": { "description": "Specify the card brands to block in the Checkout Session. If a customer enters or selects a card belonging to a blocked brand, they can't complete the Session.", "items": { "enum": [ "american_express", "discover_global_network", "mastercard", "visa" ], "type": "string" }, "type": "array" } }, "title": "PaymentPagesPrivateCardPaymentMethodOptionsResourceRestrictions", "type": "object", "x-expandableFields": [] }, "payment_source": { "anyOf": [ { "$ref": "#/components/schemas/account" }, { "$ref": "#/components/schemas/bank_account" }, { "$ref": "#/components/schemas/card" }, { "$ref": "#/components/schemas/source" } ], "title": "Polymorphic", "x-resourceId": "payment_source", "x-stripeBypassValidation": true }, "payout": { "description": "A `Payout` object is created when you receive funds from Stripe, or when you\ninitiate a payout to either a bank account or debit card of a [connected\nStripe account](/docs/connect/bank-debit-card-payouts). You can retrieve individual payouts,\nand list all payouts. Payouts are made on [varying\nschedules](/docs/connect/manage-payout-schedule), depending on your country and\nindustry.\n\nRelated guide: [Receiving payouts](https://stripe.com/docs/payouts)", "properties": { "amount": { "description": "The amount (in cents (or local equivalent)) that transfers to your bank account or debit card.", "type": "integer" }, "application_fee": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/application_fee" } ], "description": "The application fee (if any) for the payout. [See the Connect documentation](https://stripe.com/docs/connect/instant-payouts#monetization-and-fees) for details.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/application_fee" } ] } }, "application_fee_amount": { "description": "The amount of the application fee (if any) requested for the payout. [See the Connect documentation](https://stripe.com/docs/connect/instant-payouts#monetization-and-fees) for details.", "nullable": true, "type": "integer" }, "arrival_date": { "description": "Date that you can expect the payout to arrive in the bank. This factors in delays to account for weekends or bank holidays.", "format": "unix-time", "type": "integer" }, "automatic": { "description": "Returns `true` if the payout is created by an [automated payout schedule](https://stripe.com/docs/payouts#payout-schedule) and `false` if it's [requested manually](https://stripe.com/docs/payouts#manual-payouts).", "type": "boolean" }, "balance_transaction": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/balance_transaction" } ], "description": "ID of the balance transaction that describes the impact of this payout on your account balance.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/balance_transaction" } ] } }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users.", "maxLength": 5000, "nullable": true, "type": "string" }, "destination": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/bank_account" }, { "$ref": "#/components/schemas/card" }, { "$ref": "#/components/schemas/deleted_bank_account" }, { "$ref": "#/components/schemas/deleted_card" } ], "description": "ID of the bank account or card the payout is sent to.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/bank_account" }, { "$ref": "#/components/schemas/card" }, { "$ref": "#/components/schemas/deleted_bank_account" }, { "$ref": "#/components/schemas/deleted_card" } ] }, "x-stripeBypassValidation": true }, "failure_balance_transaction": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/balance_transaction" } ], "description": "If the payout fails or cancels, this is the ID of the balance transaction that reverses the initial balance transaction and returns the funds from the failed payout back in your balance.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/balance_transaction" } ] } }, "failure_code": { "description": "Error code that provides a reason for a payout failure, if available. View our [list of failure codes](https://stripe.com/docs/api#payout_failures).", "maxLength": 5000, "nullable": true, "type": "string" }, "failure_message": { "description": "Message that provides the reason for a payout failure, if available.", "maxLength": 5000, "nullable": true, "type": "string" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "nullable": true, "type": "object" }, "method": { "description": "The method used to send this payout, which can be `standard` or `instant`. `instant` is supported for payouts to debit cards and bank accounts in certain countries. Learn more about [bank support for Instant Payouts](https://stripe.com/docs/payouts/instant-payouts-banks).", "maxLength": 5000, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "payout" ], "type": "string" }, "original_payout": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/payout" } ], "description": "If the payout reverses another, this is the ID of the original payout.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/payout" } ] } }, "payout_method": { "description": "ID of the v2 FinancialAccount the funds are sent to.", "maxLength": 5000, "nullable": true, "type": "string" }, "reconciliation_status": { "description": "If `completed`, you can use the [Balance Transactions API](https://stripe.com/docs/api/balance_transactions/list#balance_transaction_list-payout) to list all balance transactions that are paid out in this payout.", "enum": [ "completed", "in_progress", "not_applicable" ], "type": "string" }, "reversed_by": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/payout" } ], "description": "If the payout reverses, this is the ID of the payout that reverses this payout.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/payout" } ] } }, "source_type": { "description": "The source balance this payout came from, which can be one of the following: `card`, `fpx`, or `bank_account`.", "maxLength": 5000, "type": "string" }, "statement_descriptor": { "description": "Extra information about a payout that displays on the user's bank statement.", "maxLength": 5000, "nullable": true, "type": "string" }, "status": { "description": "Current status of the payout: `paid`, `pending`, `in_transit`, `canceled` or `failed`. A payout is `pending` until it's submitted to the bank, when it becomes `in_transit`. The status changes to `paid` if the transaction succeeds, or to `failed` or `canceled` (within 5 business days). Some payouts that fail might initially show as `paid`, then change to `failed`.", "maxLength": 5000, "type": "string" }, "trace_id": { "anyOf": [ { "$ref": "#/components/schemas/payouts_trace_id" } ], "description": "A value that generates from the beneficiary's bank that allows users to track payouts with their bank. Banks might call this a \"reference number\" or something similar.", "nullable": true }, "type": { "description": "Can be `bank_account` or `card`.", "enum": [ "bank_account", "card" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "amount", "arrival_date", "automatic", "created", "currency", "id", "livemode", "method", "object", "reconciliation_status", "source_type", "status", "type" ], "title": "Payout", "type": "object", "x-expandableFields": [ "application_fee", "balance_transaction", "destination", "failure_balance_transaction", "original_payout", "reversed_by", "trace_id" ], "x-resourceId": "payout" }, "payouts_trace_id": { "description": "", "properties": { "status": { "description": "Possible values are `pending`, `supported`, and `unsupported`. When `payout.status` is `pending` or `in_transit`, this will be `pending`. When the payout transitions to `paid`, `failed`, or `canceled`, this status will become `supported` or `unsupported` shortly after in most cases. In some cases, this may appear as `pending` for up to 10 days after `arrival_date` until transitioning to `supported` or `unsupported`.", "maxLength": 5000, "type": "string" }, "value": { "description": "The trace ID value if `trace_id.status` is `supported`, otherwise `nil`.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "status" ], "title": "PayoutsTraceID", "type": "object", "x-expandableFields": [] }, "paypal_seller_protection": { "description": "", "properties": { "dispute_categories": { "description": "An array of conditions that are covered for the transaction, if applicable.", "items": { "enum": [ "fraudulent", "product_not_received" ], "type": "string", "x-stripeBypassValidation": true }, "nullable": true, "type": "array" }, "status": { "description": "Indicates whether the transaction is eligible for PayPal's seller protection.", "enum": [ "eligible", "not_eligible", "partially_eligible" ], "type": "string" } }, "required": [ "status" ], "title": "paypal_seller_protection", "type": "object", "x-expandableFields": [] }, "person": { "description": "This is an object representing a person associated with a Stripe account.\n\nA platform can only access a subset of data in a person for an account where [account.controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`, which includes Standard and Express accounts, after creating an Account Link or Account Session to start Connect onboarding.\n\nSee the [Standard onboarding](/connect/standard-accounts) or [Express onboarding](/connect/express-accounts) documentation for information about prefilling information and account onboarding steps. Learn more about [handling identity verification with the API](/connect/handling-api-verification#person-information).", "properties": { "account": { "description": "The account the person is associated with.", "maxLength": 5000, "type": "string" }, "additional_tos_acceptances": { "$ref": "#/components/schemas/person_additional_tos_acceptances" }, "address": { "$ref": "#/components/schemas/address" }, "address_kana": { "anyOf": [ { "$ref": "#/components/schemas/legal_entity_japan_address" } ], "nullable": true }, "address_kanji": { "anyOf": [ { "$ref": "#/components/schemas/legal_entity_japan_address" } ], "nullable": true }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "dob": { "$ref": "#/components/schemas/legal_entity_dob" }, "email": { "description": "The person's email address. Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.", "maxLength": 5000, "nullable": true, "type": "string" }, "first_name": { "description": "The person's first name. Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.", "maxLength": 5000, "nullable": true, "type": "string" }, "first_name_kana": { "description": "The Kana variation of the person's first name (Japan only). Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.", "maxLength": 5000, "nullable": true, "type": "string" }, "first_name_kanji": { "description": "The Kanji variation of the person's first name (Japan only). Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.", "maxLength": 5000, "nullable": true, "type": "string" }, "full_name_aliases": { "description": "A list of alternate names or aliases that the person is known by. Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "future_requirements": { "anyOf": [ { "$ref": "#/components/schemas/person_future_requirements" } ], "nullable": true }, "gender": { "description": "The person's gender.", "nullable": true, "type": "string" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "id_number_provided": { "description": "Whether the person's `id_number` was provided. True if either the full ID number was provided or if only the required part of the ID number was provided (ex. last four of an individual's SSN for the US indicated by `ssn_last_4_provided`).", "type": "boolean" }, "id_number_secondary_provided": { "description": "Whether the person's `id_number_secondary` was provided.", "type": "boolean" }, "last_name": { "description": "The person's last name. Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.", "maxLength": 5000, "nullable": true, "type": "string" }, "last_name_kana": { "description": "The Kana variation of the person's last name (Japan only). Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.", "maxLength": 5000, "nullable": true, "type": "string" }, "last_name_kanji": { "description": "The Kanji variation of the person's last name (Japan only). Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.", "maxLength": 5000, "nullable": true, "type": "string" }, "maiden_name": { "description": "The person's maiden name.", "maxLength": 5000, "nullable": true, "type": "string" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "type": "object" }, "nationality": { "description": "The country where the person is a national.", "maxLength": 5000, "nullable": true, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "person" ], "type": "string" }, "phone": { "description": "The person's phone number.", "maxLength": 5000, "nullable": true, "type": "string" }, "political_exposure": { "description": "Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction.", "enum": [ "existing", "none" ], "type": "string" }, "registered_address": { "$ref": "#/components/schemas/address" }, "relationship": { "$ref": "#/components/schemas/person_relationship" }, "requirements": { "anyOf": [ { "$ref": "#/components/schemas/person_requirements" } ], "nullable": true }, "ssn_last_4_provided": { "description": "Whether the last four digits of the person's Social Security number have been provided (U.S. only).", "type": "boolean" }, "us_cfpb_data": { "anyOf": [ { "$ref": "#/components/schemas/person_us_cfpb_data" } ], "description": "Demographic data related to the person.", "nullable": true }, "verification": { "$ref": "#/components/schemas/legal_entity_person_verification" } }, "required": [ "account", "created", "id", "object" ], "title": "Person", "type": "object", "x-expandableFields": [ "additional_tos_acceptances", "address", "address_kana", "address_kanji", "dob", "future_requirements", "registered_address", "relationship", "requirements", "us_cfpb_data", "verification" ], "x-resourceId": "person" }, "person_additional_tos_acceptance": { "description": "", "properties": { "date": { "description": "The Unix timestamp marking when the legal guardian accepted the service agreement.", "format": "unix-time", "nullable": true, "type": "integer" }, "ip": { "description": "The IP address from which the legal guardian accepted the service agreement.", "maxLength": 5000, "nullable": true, "type": "string" }, "user_agent": { "description": "The user agent of the browser from which the legal guardian accepted the service agreement.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "PersonAdditionalTOSAcceptance", "type": "object", "x-expandableFields": [] }, "person_additional_tos_acceptances": { "description": "", "properties": { "account": { "anyOf": [ { "$ref": "#/components/schemas/person_additional_tos_acceptance" } ], "description": "Details on the legal guardian's acceptance of the main Stripe service agreement.", "nullable": true } }, "title": "PersonAdditionalTOSAcceptances", "type": "object", "x-expandableFields": [ "account" ] }, "person_ethnicity_details": { "description": "", "properties": { "ethnicity": { "description": "The persons ethnicity", "items": { "enum": [ "cuban", "hispanic_or_latino", "mexican", "not_hispanic_or_latino", "other_hispanic_or_latino", "prefer_not_to_answer", "puerto_rican" ], "type": "string" }, "nullable": true, "type": "array" }, "ethnicity_other": { "description": "Please specify your origin, when other is selected.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "PersonEthnicityDetails", "type": "object", "x-expandableFields": [] }, "person_future_requirements": { "description": "", "properties": { "alternatives": { "description": "Fields that are due and can be satisfied by providing the corresponding alternative fields instead.", "items": { "$ref": "#/components/schemas/account_requirements_alternative" }, "nullable": true, "type": "array" }, "currently_due": { "description": "Fields that need to be collected to keep the person's account enabled. If not collected by the account's `future_requirements[current_deadline]`, these fields will transition to the main `requirements` hash, and may immediately become `past_due`, but the account may also be given a grace period depending on the account's enablement state prior to transition.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "errors": { "description": "Fields that are `currently_due` and need to be collected again because validation or verification failed.", "items": { "$ref": "#/components/schemas/account_requirements_error" }, "type": "array" }, "eventually_due": { "description": "Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well, and the account's `future_requirements[current_deadline]` becomes set.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "past_due": { "description": "Fields that weren't collected by the account's `requirements.current_deadline`. These fields need to be collected to enable the person's account. New fields will never appear here; `future_requirements.past_due` will always be a subset of `requirements.past_due`.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "pending_verification": { "description": "Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due` or `currently_due`. Fields might appear in `eventually_due` or `currently_due` and in `pending_verification` if verification fails but another verification is still pending.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "required": [ "currently_due", "errors", "eventually_due", "past_due", "pending_verification" ], "title": "PersonFutureRequirements", "type": "object", "x-expandableFields": [ "alternatives", "errors" ] }, "person_race_details": { "description": "", "properties": { "race": { "description": "The persons race.", "items": { "enum": [ "african_american", "american_indian_or_alaska_native", "asian", "asian_indian", "black_or_african_american", "chinese", "ethiopian", "filipino", "guamanian_or_chamorro", "haitian", "jamaican", "japanese", "korean", "native_hawaiian", "native_hawaiian_or_other_pacific_islander", "nigerian", "other_asian", "other_black_or_african_american", "other_pacific_islander", "prefer_not_to_answer", "samoan", "somali", "vietnamese", "white" ], "type": "string" }, "nullable": true, "type": "array" }, "race_other": { "description": "Please specify your race, when other is selected.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "PersonRaceDetails", "type": "object", "x-expandableFields": [] }, "person_relationship": { "description": "", "properties": { "authorizer": { "description": "Whether the person is the authorizer of the account's representative.", "nullable": true, "type": "boolean" }, "director": { "description": "Whether the person is a director of the account's legal entity. Directors are typically members of the governing board of the company, or responsible for ensuring the company meets its regulatory obligations.", "nullable": true, "type": "boolean" }, "executive": { "description": "Whether the person has significant responsibility to control, manage, or direct the organization.", "nullable": true, "type": "boolean" }, "legal_guardian": { "description": "Whether the person is the legal guardian of the account's representative.", "nullable": true, "type": "boolean" }, "owner": { "description": "Whether the person is an owner of the account’s legal entity.", "nullable": true, "type": "boolean" }, "percent_ownership": { "description": "The percent owned by the person of the account's legal entity.", "nullable": true, "type": "number" }, "representative": { "description": "Whether the person is authorized as the primary representative of the account. This is the person nominated by the business to provide information about themselves, and general information about the account. There can only be one representative at any given time. At the time the account is created, this person should be set to the person responsible for opening the account.", "nullable": true, "type": "boolean" }, "title": { "description": "The person's title (e.g., CEO, Support Engineer).", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "PersonRelationship", "type": "object", "x-expandableFields": [] }, "person_requirements": { "description": "", "properties": { "alternatives": { "description": "Fields that are due and can be satisfied by providing the corresponding alternative fields instead.", "items": { "$ref": "#/components/schemas/account_requirements_alternative" }, "nullable": true, "type": "array" }, "currently_due": { "description": "Fields that need to be collected to keep the person's account enabled. If not collected by the account's `current_deadline`, these fields appear in `past_due` as well, and the account is disabled.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "errors": { "description": "Fields that are `currently_due` and need to be collected again because validation or verification failed.", "items": { "$ref": "#/components/schemas/account_requirements_error" }, "type": "array" }, "eventually_due": { "description": "Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well, and the account's `current_deadline` becomes set.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "past_due": { "description": "Fields that weren't collected by the account's `current_deadline`. These fields need to be collected to enable the person's account.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "pending_verification": { "description": "Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. Fields might appear in `eventually_due`, `currently_due`, or `past_due` and in `pending_verification` if verification fails but another verification is still pending.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "required": [ "currently_due", "errors", "eventually_due", "past_due", "pending_verification" ], "title": "PersonRequirements", "type": "object", "x-expandableFields": [ "alternatives", "errors" ] }, "person_us_cfpb_data": { "description": "", "properties": { "ethnicity_details": { "anyOf": [ { "$ref": "#/components/schemas/person_ethnicity_details" } ], "description": "The persons ethnicity details", "nullable": true }, "race_details": { "anyOf": [ { "$ref": "#/components/schemas/person_race_details" } ], "description": "The persons race details", "nullable": true }, "self_identified_gender": { "description": "The persons self-identified gender", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "PersonUSCfpbData", "type": "object", "x-expandableFields": [ "ethnicity_details", "race_details" ] }, "plan": { "description": "You can now model subscriptions more flexibly using the [Prices API](https://stripe.com/docs/api#prices). It replaces the Plans API and is backwards compatible to simplify your migration.\n\nPlans define the base price, currency, and billing cycle for recurring purchases of products.\n[Products](https://stripe.com/docs/api#products) help you track inventory or provisioning, and plans help you track pricing. Different physical goods or levels of service should be represented by products, and pricing options should be represented by plans. This approach lets you change prices without having to change your provisioning scheme.\n\nFor example, you might have a single \"gold\" product that has plans for $10/month, $100/year, €9/month, and €90/year.\n\nRelated guides: [Set up a subscription](https://stripe.com/docs/billing/subscriptions/set-up-subscription) and more about [products and prices](https://stripe.com/docs/products-prices/overview).", "properties": { "active": { "description": "Whether the plan can be used for new purchases.", "type": "boolean" }, "amount": { "description": "The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`.", "nullable": true, "type": "integer" }, "amount_decimal": { "description": "The unit amount in cents (or local equivalent) to be charged, represented as a decimal string with at most 12 decimal places. Only set if `billing_scheme=per_unit`.", "format": "decimal", "nullable": true, "type": "string" }, "billing_scheme": { "description": "Describes how to compute the price per period. Either `per_unit` or `tiered`. `per_unit` indicates that the fixed amount (specified in `amount`) will be charged per unit in `quantity` (for plans with `usage_type=licensed`), or per unit of total usage (for plans with `usage_type=metered`). `tiered` indicates that the unit pricing will be computed using a tiering strategy as defined using the `tiers` and `tiers_mode` attributes.", "enum": [ "per_unit", "tiered" ], "type": "string" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "interval": { "description": "The frequency at which a subscription is billed. One of `day`, `week`, `month` or `year`.", "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "description": "The number of intervals (specified in the `interval` attribute) between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months.", "type": "integer" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "nullable": true, "type": "object" }, "meter": { "description": "The meter tracking the usage of a metered price", "maxLength": 5000, "nullable": true, "type": "string" }, "nickname": { "description": "A brief description of the plan, hidden from customers.", "maxLength": 5000, "nullable": true, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "plan" ], "type": "string" }, "product": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/product" }, { "$ref": "#/components/schemas/deleted_product" } ], "description": "The product whose pricing this plan determines.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/product" }, { "$ref": "#/components/schemas/deleted_product" } ] } }, "tiers": { "description": "Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.", "items": { "$ref": "#/components/schemas/plan_tier" }, "type": "array" }, "tiers_mode": { "description": "Defines if the tiering price should be `graduated` or `volume` based. In `volume`-based tiering, the maximum quantity within a period determines the per unit price. In `graduated` tiering, pricing can change as the quantity grows.", "enum": [ "graduated", "volume" ], "nullable": true, "type": "string" }, "transform_usage": { "anyOf": [ { "$ref": "#/components/schemas/transform_usage" } ], "description": "Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with `tiers`.", "nullable": true }, "trial_period_days": { "description": "Default number of trial days when subscribing a customer to this plan using [`trial_from_plan=true`](https://stripe.com/docs/api#create_subscription-trial_from_plan).", "nullable": true, "type": "integer" }, "usage_type": { "description": "Configures how the quantity per period should be determined. Can be either `metered` or `licensed`. `licensed` automatically bills the `quantity` set when adding it to a subscription. `metered` aggregates the total usage based on usage records. Defaults to `licensed`.", "enum": [ "licensed", "metered" ], "type": "string" } }, "required": [ "active", "billing_scheme", "created", "currency", "id", "interval", "interval_count", "livemode", "object", "usage_type" ], "title": "Plan", "type": "object", "x-expandableFields": [ "product", "tiers", "transform_usage" ], "x-resourceId": "plan" }, "plan_tier": { "description": "", "properties": { "flat_amount": { "description": "Price for the entire tier.", "nullable": true, "type": "integer" }, "flat_amount_decimal": { "description": "Same as `flat_amount`, but contains a decimal value with at most 12 decimal places.", "format": "decimal", "nullable": true, "type": "string" }, "unit_amount": { "description": "Per unit price for units relevant to the tier.", "nullable": true, "type": "integer" }, "unit_amount_decimal": { "description": "Same as `unit_amount`, but contains a decimal value with at most 12 decimal places.", "format": "decimal", "nullable": true, "type": "string" }, "up_to": { "description": "Up to and including to this quantity will be contained in the tier.", "nullable": true, "type": "integer" } }, "title": "PlanTier", "type": "object", "x-expandableFields": [] }, "platform_earning_fee_source": { "description": "", "properties": { "charge": { "description": "Charge ID that created this application fee.", "maxLength": 5000, "type": "string" }, "payout": { "description": "Payout ID that created this application fee.", "maxLength": 5000, "type": "string" }, "type": { "description": "Type of object that created the application fee.", "enum": [ "charge", "payout" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "PlatformEarningFeeSource", "type": "object", "x-expandableFields": [] }, "portal_business_profile": { "description": "", "properties": { "headline": { "description": "The messaging shown to customers in the portal.", "maxLength": 5000, "nullable": true, "type": "string" }, "privacy_policy_url": { "description": "A link to the business’s publicly available privacy policy.", "maxLength": 5000, "nullable": true, "type": "string" }, "terms_of_service_url": { "description": "A link to the business’s publicly available terms of service.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "PortalBusinessProfile", "type": "object", "x-expandableFields": [] }, "portal_customer_update": { "description": "", "properties": { "allowed_updates": { "description": "The types of customer updates that are supported. When empty, customers are not updateable.", "items": { "enum": [ "address", "email", "name", "phone", "shipping", "tax_id" ], "type": "string" }, "type": "array" }, "enabled": { "description": "Whether the feature is enabled.", "type": "boolean" } }, "required": [ "allowed_updates", "enabled" ], "title": "PortalCustomerUpdate", "type": "object", "x-expandableFields": [] }, "portal_features": { "description": "", "properties": { "customer_update": { "$ref": "#/components/schemas/portal_customer_update" }, "invoice_history": { "$ref": "#/components/schemas/portal_invoice_list" }, "payment_method_update": { "$ref": "#/components/schemas/portal_payment_method_update" }, "subscription_cancel": { "$ref": "#/components/schemas/portal_subscription_cancel" }, "subscription_update": { "$ref": "#/components/schemas/portal_subscription_update" } }, "required": [ "customer_update", "invoice_history", "payment_method_update", "subscription_cancel", "subscription_update" ], "title": "PortalFeatures", "type": "object", "x-expandableFields": [ "customer_update", "invoice_history", "payment_method_update", "subscription_cancel", "subscription_update" ] }, "portal_flows_after_completion_hosted_confirmation": { "description": "", "properties": { "custom_message": { "description": "A custom message to display to the customer after the flow is completed.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "PortalFlowsAfterCompletionHostedConfirmation", "type": "object", "x-expandableFields": [] }, "portal_flows_after_completion_redirect": { "description": "", "properties": { "return_url": { "description": "The URL the customer will be redirected to after the flow is completed.", "maxLength": 5000, "type": "string" } }, "required": [ "return_url" ], "title": "PortalFlowsAfterCompletionRedirect", "type": "object", "x-expandableFields": [] }, "portal_flows_coupon_offer": { "description": "", "properties": { "coupon": { "description": "The ID of the coupon to be offered.", "maxLength": 5000, "type": "string" } }, "required": [ "coupon" ], "title": "PortalFlowsCouponOffer", "type": "object", "x-expandableFields": [] }, "portal_flows_flow": { "description": "", "properties": { "after_completion": { "$ref": "#/components/schemas/portal_flows_flow_after_completion" }, "subscription_cancel": { "anyOf": [ { "$ref": "#/components/schemas/portal_flows_flow_subscription_cancel" } ], "description": "Configuration when `flow.type=subscription_cancel`.", "nullable": true }, "subscription_update": { "anyOf": [ { "$ref": "#/components/schemas/portal_flows_flow_subscription_update" } ], "description": "Configuration when `flow.type=subscription_update`.", "nullable": true }, "subscription_update_confirm": { "anyOf": [ { "$ref": "#/components/schemas/portal_flows_flow_subscription_update_confirm" } ], "description": "Configuration when `flow.type=subscription_update_confirm`.", "nullable": true }, "type": { "description": "Type of flow that the customer will go through.", "enum": [ "payment_method_update", "subscription_cancel", "subscription_update", "subscription_update_confirm" ], "type": "string" } }, "required": [ "after_completion", "type" ], "title": "PortalFlowsFlow", "type": "object", "x-expandableFields": [ "after_completion", "subscription_cancel", "subscription_update", "subscription_update_confirm" ] }, "portal_flows_flow_after_completion": { "description": "", "properties": { "hosted_confirmation": { "anyOf": [ { "$ref": "#/components/schemas/portal_flows_after_completion_hosted_confirmation" } ], "description": "Configuration when `after_completion.type=hosted_confirmation`.", "nullable": true }, "redirect": { "anyOf": [ { "$ref": "#/components/schemas/portal_flows_after_completion_redirect" } ], "description": "Configuration when `after_completion.type=redirect`.", "nullable": true }, "type": { "description": "The specified type of behavior after the flow is completed.", "enum": [ "hosted_confirmation", "portal_homepage", "redirect" ], "type": "string" } }, "required": [ "type" ], "title": "PortalFlowsFlowAfterCompletion", "type": "object", "x-expandableFields": [ "hosted_confirmation", "redirect" ] }, "portal_flows_flow_subscription_cancel": { "description": "", "properties": { "retention": { "anyOf": [ { "$ref": "#/components/schemas/portal_flows_retention" } ], "description": "Specify a retention strategy to be used in the cancellation flow.", "nullable": true }, "subscription": { "description": "The ID of the subscription to be canceled.", "maxLength": 5000, "type": "string" } }, "required": [ "subscription" ], "title": "PortalFlowsFlowSubscriptionCancel", "type": "object", "x-expandableFields": [ "retention" ] }, "portal_flows_flow_subscription_update": { "description": "", "properties": { "subscription": { "description": "The ID of the subscription to be updated.", "maxLength": 5000, "type": "string" } }, "required": [ "subscription" ], "title": "PortalFlowsFlowSubscriptionUpdate", "type": "object", "x-expandableFields": [] }, "portal_flows_flow_subscription_update_confirm": { "description": "", "properties": { "discounts": { "description": "The coupon or promotion code to apply to this subscription update.", "items": { "$ref": "#/components/schemas/portal_flows_subscription_update_confirm_discount" }, "nullable": true, "type": "array" }, "items": { "description": "The [subscription item](https://stripe.com/docs/api/subscription_items) to be updated through this flow. Currently, only up to one may be specified and subscriptions with multiple items are not updatable.", "items": { "$ref": "#/components/schemas/portal_flows_subscription_update_confirm_item" }, "type": "array" }, "subscription": { "description": "The ID of the subscription to be updated.", "maxLength": 5000, "type": "string" } }, "required": [ "items", "subscription" ], "title": "PortalFlowsFlowSubscriptionUpdateConfirm", "type": "object", "x-expandableFields": [ "discounts", "items" ] }, "portal_flows_retention": { "description": "", "properties": { "coupon_offer": { "anyOf": [ { "$ref": "#/components/schemas/portal_flows_coupon_offer" } ], "description": "Configuration when `retention.type=coupon_offer`.", "nullable": true }, "type": { "description": "Type of retention strategy that will be used.", "enum": [ "coupon_offer" ], "type": "string" } }, "required": [ "type" ], "title": "PortalFlowsRetention", "type": "object", "x-expandableFields": [ "coupon_offer" ] }, "portal_flows_subscription_update_confirm_discount": { "description": "", "properties": { "coupon": { "description": "The ID of the coupon to apply to this subscription update.", "maxLength": 5000, "nullable": true, "type": "string" }, "promotion_code": { "description": "The ID of a promotion code to apply to this subscription update.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "PortalFlowsSubscriptionUpdateConfirmDiscount", "type": "object", "x-expandableFields": [] }, "portal_flows_subscription_update_confirm_item": { "description": "", "properties": { "id": { "description": "The ID of the [subscription item](https://stripe.com/docs/api/subscriptions/object#subscription_object-items-data-id) to be updated.", "maxLength": 5000, "nullable": true, "type": "string" }, "price": { "description": "The price the customer should subscribe to through this flow. The price must also be included in the configuration's [`features.subscription_update.products`](https://stripe.com/docs/api/customer_portal/configuration#portal_configuration_object-features-subscription_update-products).", "maxLength": 5000, "nullable": true, "type": "string" }, "quantity": { "description": "[Quantity](https://stripe.com/docs/subscriptions/quantities) for this item that the customer should subscribe to through this flow.", "type": "integer" } }, "title": "PortalFlowsSubscriptionUpdateConfirmItem", "type": "object", "x-expandableFields": [] }, "portal_invoice_list": { "description": "", "properties": { "enabled": { "description": "Whether the feature is enabled.", "type": "boolean" } }, "required": [ "enabled" ], "title": "PortalInvoiceList", "type": "object", "x-expandableFields": [] }, "portal_login_page": { "description": "", "properties": { "enabled": { "description": "If `true`, a shareable `url` will be generated that will take your customers to a hosted login page for the customer portal.\n\nIf `false`, the previously generated `url`, if any, will be deactivated.", "type": "boolean" }, "url": { "description": "A shareable URL to the hosted portal login page. Your customers will be able to log in with their [email](https://stripe.com/docs/api/customers/object#customer_object-email) and receive a link to their customer portal.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "enabled" ], "title": "PortalLoginPage", "type": "object", "x-expandableFields": [] }, "portal_payment_method_update": { "description": "", "properties": { "enabled": { "description": "Whether the feature is enabled.", "type": "boolean" } }, "required": [ "enabled" ], "title": "PortalPaymentMethodUpdate", "type": "object", "x-expandableFields": [] }, "portal_resource_schedule_update_at_period_end": { "description": "", "properties": { "conditions": { "description": "List of conditions. When any condition is true, an update will be scheduled at the end of the current period.", "items": { "$ref": "#/components/schemas/portal_resource_schedule_update_at_period_end_condition" }, "type": "array" } }, "required": [ "conditions" ], "title": "PortalResourceScheduleUpdateAtPeriodEnd", "type": "object", "x-expandableFields": [ "conditions" ] }, "portal_resource_schedule_update_at_period_end_condition": { "description": "", "properties": { "type": { "description": "The type of condition.", "enum": [ "decreasing_item_amount", "shortening_interval" ], "type": "string" } }, "required": [ "type" ], "title": "PortalResourceScheduleUpdateAtPeriodEndCondition", "type": "object", "x-expandableFields": [] }, "portal_subscription_cancel": { "description": "", "properties": { "cancellation_reason": { "$ref": "#/components/schemas/portal_subscription_cancellation_reason" }, "enabled": { "description": "Whether the feature is enabled.", "type": "boolean" }, "mode": { "description": "Whether to cancel subscriptions immediately or at the end of the billing period.", "enum": [ "at_period_end", "immediately" ], "type": "string" }, "proration_behavior": { "description": "Whether to create prorations when canceling subscriptions. Possible values are `none` and `create_prorations`.", "enum": [ "always_invoice", "create_prorations", "none" ], "type": "string" } }, "required": [ "cancellation_reason", "enabled", "mode", "proration_behavior" ], "title": "PortalSubscriptionCancel", "type": "object", "x-expandableFields": [ "cancellation_reason" ] }, "portal_subscription_cancellation_reason": { "description": "", "properties": { "enabled": { "description": "Whether the feature is enabled.", "type": "boolean" }, "options": { "description": "Which cancellation reasons will be given as options to the customer.", "items": { "enum": [ "customer_service", "low_quality", "missing_features", "other", "switched_service", "too_complex", "too_expensive", "unused" ], "type": "string" }, "type": "array" } }, "required": [ "enabled", "options" ], "title": "PortalSubscriptionCancellationReason", "type": "object", "x-expandableFields": [] }, "portal_subscription_update": { "description": "", "properties": { "default_allowed_updates": { "description": "The types of subscription updates that are supported for items listed in the `products` attribute. When empty, subscriptions are not updateable.", "items": { "enum": [ "price", "promotion_code", "quantity" ], "type": "string" }, "type": "array" }, "enabled": { "description": "Whether the feature is enabled.", "type": "boolean" }, "products": { "description": "The list of up to 10 products that support subscription updates.", "items": { "$ref": "#/components/schemas/portal_subscription_update_product" }, "nullable": true, "type": "array" }, "proration_behavior": { "description": "Determines how to handle prorations resulting from subscription updates. Valid values are `none`, `create_prorations`, and `always_invoice`. Defaults to a value of `none` if you don't set it during creation.", "enum": [ "always_invoice", "create_prorations", "none" ], "type": "string" }, "schedule_at_period_end": { "$ref": "#/components/schemas/portal_resource_schedule_update_at_period_end" } }, "required": [ "default_allowed_updates", "enabled", "proration_behavior", "schedule_at_period_end" ], "title": "PortalSubscriptionUpdate", "type": "object", "x-expandableFields": [ "products", "schedule_at_period_end" ] }, "portal_subscription_update_product": { "description": "", "properties": { "adjustable_quantity": { "$ref": "#/components/schemas/portal_subscription_update_product_adjustable_quantity" }, "prices": { "description": "The list of price IDs which, when subscribed to, a subscription can be updated.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "product": { "description": "The product ID.", "maxLength": 5000, "type": "string" } }, "required": [ "adjustable_quantity", "prices", "product" ], "title": "PortalSubscriptionUpdateProduct", "type": "object", "x-expandableFields": [ "adjustable_quantity" ] }, "portal_subscription_update_product_adjustable_quantity": { "description": "", "properties": { "enabled": { "description": "If true, the quantity can be adjusted to any non-negative integer.", "type": "boolean" }, "maximum": { "description": "The maximum quantity that can be set for the product.", "nullable": true, "type": "integer" }, "minimum": { "description": "The minimum quantity that can be set for the product.", "type": "integer" } }, "required": [ "enabled", "minimum" ], "title": "PortalSubscriptionUpdateProductAdjustableQuantity", "type": "object", "x-expandableFields": [] }, "price": { "description": "Prices define the unit cost, currency, and (optional) billing cycle for both recurring and one-time purchases of products.\n[Products](https://stripe.com/docs/api#products) help you track inventory or provisioning, and prices help you track payment terms. Different physical goods or levels of service should be represented by products, and pricing options should be represented by prices. This approach lets you change prices without having to change your provisioning scheme.\n\nFor example, you might have a single \"gold\" product that has prices for $10/month, $100/year, and €9 once.\n\nRelated guides: [Set up a subscription](https://stripe.com/docs/billing/subscriptions/set-up-subscription), [create an invoice](https://stripe.com/docs/billing/invoices/create), and more about [products and prices](https://stripe.com/docs/products-prices/overview).", "properties": { "active": { "description": "Whether the price can be used for new purchases.", "type": "boolean" }, "billing_scheme": { "description": "Describes how to compute the price per period. Either `per_unit` or `tiered`. `per_unit` indicates that the fixed amount (specified in `unit_amount` or `unit_amount_decimal`) will be charged per unit in `quantity` (for prices with `usage_type=licensed`), or per unit of total usage (for prices with `usage_type=metered`). `tiered` indicates that the unit pricing will be computed using a tiering strategy as defined using the `tiers` and `tiers_mode` attributes.", "enum": [ "per_unit", "tiered" ], "type": "string" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "currency_options": { "additionalProperties": { "$ref": "#/components/schemas/currency_option" }, "description": "Prices defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).", "type": "object" }, "custom_unit_amount": { "anyOf": [ { "$ref": "#/components/schemas/custom_unit_amount" } ], "description": "When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.", "nullable": true }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "lookup_key": { "description": "A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.", "maxLength": 5000, "nullable": true, "type": "string" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "type": "object" }, "nickname": { "description": "A brief description of the price, hidden from customers.", "maxLength": 5000, "nullable": true, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "price" ], "type": "string" }, "product": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/product" }, { "$ref": "#/components/schemas/deleted_product" } ], "description": "The ID of the product this price is associated with.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/product" }, { "$ref": "#/components/schemas/deleted_product" } ] } }, "recurring": { "anyOf": [ { "$ref": "#/components/schemas/recurring" } ], "description": "The recurring components of a price such as `interval` and `usage_type`.", "nullable": true }, "tax_behavior": { "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.", "enum": [ "exclusive", "inclusive", "unspecified" ], "nullable": true, "type": "string" }, "tiers": { "description": "Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.", "items": { "$ref": "#/components/schemas/price_tier" }, "type": "array" }, "tiers_mode": { "description": "Defines if the tiering price should be `graduated` or `volume` based. In `volume`-based tiering, the maximum quantity within a period determines the per unit price. In `graduated` tiering, pricing can change as the quantity grows.", "enum": [ "graduated", "volume" ], "nullable": true, "type": "string" }, "transform_quantity": { "anyOf": [ { "$ref": "#/components/schemas/transform_quantity" } ], "description": "Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with `tiers`.", "nullable": true }, "type": { "description": "One of `one_time` or `recurring` depending on whether the price is for a one-time purchase or a recurring (subscription) purchase.", "enum": [ "one_time", "recurring" ], "type": "string" }, "unit_amount": { "description": "The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`.", "nullable": true, "type": "integer" }, "unit_amount_decimal": { "description": "The unit amount in cents (or local equivalent) to be charged, represented as a decimal string with at most 12 decimal places. Only set if `billing_scheme=per_unit`.", "format": "decimal", "nullable": true, "type": "string" } }, "required": [ "active", "billing_scheme", "created", "currency", "id", "livemode", "metadata", "object", "product", "type" ], "title": "Price", "type": "object", "x-expandableFields": [ "currency_options", "custom_unit_amount", "product", "recurring", "tiers", "transform_quantity" ], "x-resourceId": "price" }, "price_tier": { "description": "", "properties": { "flat_amount": { "description": "Price for the entire tier.", "nullable": true, "type": "integer" }, "flat_amount_decimal": { "description": "Same as `flat_amount`, but contains a decimal value with at most 12 decimal places.", "format": "decimal", "nullable": true, "type": "string" }, "unit_amount": { "description": "Per unit price for units relevant to the tier.", "nullable": true, "type": "integer" }, "unit_amount_decimal": { "description": "Same as `unit_amount`, but contains a decimal value with at most 12 decimal places.", "format": "decimal", "nullable": true, "type": "string" }, "up_to": { "description": "Up to and including to this quantity will be contained in the tier.", "nullable": true, "type": "integer" } }, "title": "PriceTier", "type": "object", "x-expandableFields": [] }, "product": { "description": "Products describe the specific goods or services you offer to your customers.\nFor example, you might offer a Standard and Premium version of your goods or service; each version would be a separate Product.\nThey can be used in conjunction with [Prices](https://stripe.com/docs/api#prices) to configure pricing in Payment Links, Checkout, and Subscriptions.\n\nRelated guides: [Set up a subscription](https://stripe.com/docs/billing/subscriptions/set-up-subscription),\n[share a Payment Link](https://stripe.com/docs/payment-links),\n[accept payments with Checkout](https://stripe.com/docs/payments/accept-a-payment#create-product-prices-upfront),\nand more about [Products and Prices](https://stripe.com/docs/products-prices/overview)", "properties": { "active": { "description": "Whether the product is currently available for purchase.", "type": "boolean" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "default_price": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/price" } ], "description": "The ID of the [Price](https://stripe.com/docs/api/prices) object that is the default price for this product.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/price" } ] } }, "description": { "description": "The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.", "maxLength": 5000, "nullable": true, "type": "string" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "images": { "description": "A list of up to 8 URLs of images for this product, meant to be displayable to the customer.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "marketing_features": { "description": "A list of up to 15 marketing features for this product. These are displayed in [pricing tables](https://stripe.com/docs/payments/checkout/pricing-table).", "items": { "$ref": "#/components/schemas/product_marketing_feature" }, "type": "array" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "type": "object" }, "name": { "description": "The product's name, meant to be displayable to the customer.", "maxLength": 5000, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "product" ], "type": "string" }, "package_dimensions": { "anyOf": [ { "$ref": "#/components/schemas/package_dimensions" } ], "description": "The dimensions of this product for shipping purposes.", "nullable": true }, "shippable": { "description": "Whether this product is shipped (i.e., physical goods).", "nullable": true, "type": "boolean" }, "statement_descriptor": { "description": "Extra information about a product which will appear on your customer's credit card statement. In the case that multiple products are billed at once, the first statement descriptor will be used. Only used for subscription payments.", "maxLength": 5000, "nullable": true, "type": "string" }, "tax_code": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/tax_code" } ], "description": "A [tax code](https://stripe.com/docs/tax/tax-categories) ID.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/tax_code" } ] } }, "unit_label": { "description": "A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.", "maxLength": 5000, "nullable": true, "type": "string" }, "updated": { "description": "Time at which the object was last updated. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "url": { "description": "A URL of a publicly-accessible webpage for this product.", "maxLength": 2048, "nullable": true, "type": "string" } }, "required": [ "active", "created", "id", "images", "livemode", "marketing_features", "metadata", "name", "object", "updated" ], "title": "Product", "type": "object", "x-expandableFields": [ "default_price", "marketing_features", "package_dimensions", "tax_code" ], "x-resourceId": "product" }, "product_feature": { "description": "A product_feature represents an attachment between a feature and a product.\nWhen a product is purchased that has a feature attached, Stripe will create an entitlement to the feature for the purchasing customer.", "properties": { "entitlement_feature": { "$ref": "#/components/schemas/entitlements.feature" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "product_feature" ], "type": "string" } }, "required": [ "entitlement_feature", "id", "livemode", "object" ], "title": "ProductFeature", "type": "object", "x-expandableFields": [ "entitlement_feature" ], "x-resourceId": "product_feature" }, "product_marketing_feature": { "description": "", "properties": { "name": { "description": "The marketing feature name. Up to 80 characters long.", "maxLength": 5000, "type": "string" } }, "title": "ProductMarketingFeature", "type": "object", "x-expandableFields": [] }, "promotion_code": { "description": "A Promotion Code represents a customer-redeemable code for a [coupon](https://stripe.com/docs/api#coupons).\nYou can create multiple codes for a single coupon.\n\nIf you enable promotion codes in your [customer portal configuration](https://stripe.com/docs/customer-management/configure-portal), then customers can redeem a code themselves when updating a subscription in the portal.\nCustomers can also view the currently active promotion codes and coupons on each of their subscriptions in the portal.", "properties": { "active": { "description": "Whether the promotion code is currently active. A promotion code is only active if the coupon is also valid.", "type": "boolean" }, "code": { "description": "The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for each customer. Valid characters are lower case letters (a-z), upper case letters (A-Z), and digits (0-9).", "maxLength": 5000, "type": "string" }, "coupon": { "$ref": "#/components/schemas/coupon" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "customer": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/customer" }, { "$ref": "#/components/schemas/deleted_customer" } ], "description": "The customer that this promotion code can be used by.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/customer" }, { "$ref": "#/components/schemas/deleted_customer" } ] } }, "expires_at": { "description": "Date at which the promotion code can no longer be redeemed.", "format": "unix-time", "nullable": true, "type": "integer" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "max_redemptions": { "description": "Maximum number of times this promotion code can be redeemed.", "nullable": true, "type": "integer" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "nullable": true, "type": "object" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "promotion_code" ], "type": "string" }, "restrictions": { "$ref": "#/components/schemas/promotion_codes_resource_restrictions" }, "times_redeemed": { "description": "Number of times this promotion code has been used.", "type": "integer" } }, "required": [ "active", "code", "coupon", "created", "id", "livemode", "object", "restrictions", "times_redeemed" ], "title": "PromotionCode", "type": "object", "x-expandableFields": [ "coupon", "customer", "restrictions" ], "x-resourceId": "promotion_code" }, "promotion_code_currency_option": { "description": "", "properties": { "minimum_amount": { "description": "Minimum amount required to redeem this Promotion Code into a Coupon (e.g., a purchase must be $100 or more to work).", "type": "integer" } }, "required": [ "minimum_amount" ], "title": "PromotionCodeCurrencyOption", "type": "object", "x-expandableFields": [] }, "promotion_codes_resource_restrictions": { "description": "", "properties": { "currency_options": { "additionalProperties": { "$ref": "#/components/schemas/promotion_code_currency_option" }, "description": "Promotion code restrictions defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).", "type": "object" }, "first_time_transaction": { "description": "A Boolean indicating if the Promotion Code should only be redeemed for Customers without any successful payments or invoices", "type": "boolean" }, "minimum_amount": { "description": "Minimum amount required to redeem this Promotion Code into a Coupon (e.g., a purchase must be $100 or more to work).", "nullable": true, "type": "integer" }, "minimum_amount_currency": { "description": "Three-letter [ISO code](https://stripe.com/docs/currencies) for minimum_amount", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "first_time_transaction" ], "title": "PromotionCodesResourceRestrictions", "type": "object", "x-expandableFields": [ "currency_options" ] }, "quote": { "description": "A Quote is a way to model prices that you'd like to provide to a customer.\nOnce accepted, it will automatically create an invoice, subscription or subscription schedule.", "properties": { "amount_subtotal": { "description": "Total before any discounts or taxes are applied.", "type": "integer" }, "amount_total": { "description": "Total after discounts and taxes are applied.", "type": "integer" }, "application": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/application" }, { "$ref": "#/components/schemas/deleted_application" } ], "description": "ID of the Connect Application that created the quote.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/application" }, { "$ref": "#/components/schemas/deleted_application" } ] } }, "application_fee_amount": { "description": "The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. Only applicable if there are no line items with recurring prices on the quote.", "nullable": true, "type": "integer" }, "application_fee_percent": { "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. Only applicable if there are line items with recurring prices on the quote.", "nullable": true, "type": "number" }, "automatic_tax": { "$ref": "#/components/schemas/quotes_resource_automatic_tax" }, "collection_method": { "description": "Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay invoices at the end of the subscription cycle or on finalization using the default payment method attached to the subscription or customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically`.", "enum": [ "charge_automatically", "send_invoice" ], "type": "string" }, "computed": { "$ref": "#/components/schemas/quotes_resource_computed" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "maxLength": 5000, "nullable": true, "type": "string" }, "customer": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/customer" }, { "$ref": "#/components/schemas/deleted_customer" } ], "description": "The customer which this quote belongs to. A customer is required before finalizing the quote. Once specified, it cannot be changed.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/customer" }, { "$ref": "#/components/schemas/deleted_customer" } ] } }, "default_tax_rates": { "description": "The tax rates applied to this quote.", "items": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/tax_rate" } ], "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/tax_rate" } ] } }, "type": "array" }, "description": { "description": "A description that will be displayed on the quote PDF.", "maxLength": 5000, "nullable": true, "type": "string" }, "discounts": { "description": "The discounts applied to this quote.", "items": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/discount" } ], "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/discount" } ] } }, "type": "array" }, "expires_at": { "description": "The date on which the quote will be canceled if in `open` or `draft` status. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "footer": { "description": "A footer that will be displayed on the quote PDF.", "maxLength": 5000, "nullable": true, "type": "string" }, "from_quote": { "anyOf": [ { "$ref": "#/components/schemas/quotes_resource_from_quote" } ], "description": "Details of the quote that was cloned. See the [cloning documentation](https://stripe.com/docs/quotes/clone) for more details.", "nullable": true }, "header": { "description": "A header that will be displayed on the quote PDF.", "maxLength": 5000, "nullable": true, "type": "string" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "invoice": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/invoice" }, { "$ref": "#/components/schemas/deleted_invoice" } ], "description": "The invoice that was created from this quote.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/invoice" }, { "$ref": "#/components/schemas/deleted_invoice" } ] } }, "invoice_settings": { "$ref": "#/components/schemas/invoice_setting_quote_setting" }, "line_items": { "description": "A list of items the customer is being quoted for.", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/item" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "QuotesResourceListLineItems", "type": "object", "x-expandableFields": [ "data" ] }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "type": "object" }, "number": { "description": "A unique number that identifies this particular quote. This number is assigned once the quote is [finalized](https://stripe.com/docs/quotes/overview#finalize).", "maxLength": 5000, "nullable": true, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "quote" ], "type": "string" }, "on_behalf_of": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/account" } ], "description": "The account on behalf of which to charge. See the [Connect documentation](https://support.stripe.com/questions/sending-invoices-on-behalf-of-connected-accounts) for details.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/account" } ] } }, "status": { "description": "The status of the quote.", "enum": [ "accepted", "canceled", "draft", "open" ], "type": "string", "x-stripeBypassValidation": true }, "status_transitions": { "$ref": "#/components/schemas/quotes_resource_status_transitions" }, "subscription": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/subscription" } ], "description": "The subscription that was created or updated from this quote.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/subscription" } ] } }, "subscription_data": { "$ref": "#/components/schemas/quotes_resource_subscription_data_subscription_data" }, "subscription_schedule": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/subscription_schedule" } ], "description": "The subscription schedule that was created or updated from this quote.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/subscription_schedule" } ] } }, "test_clock": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/test_helpers.test_clock" } ], "description": "ID of the test clock this quote belongs to.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/test_helpers.test_clock" } ] } }, "total_details": { "$ref": "#/components/schemas/quotes_resource_total_details" }, "transfer_data": { "anyOf": [ { "$ref": "#/components/schemas/quotes_resource_transfer_data" } ], "description": "The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the invoices.", "nullable": true } }, "required": [ "amount_subtotal", "amount_total", "automatic_tax", "collection_method", "computed", "created", "discounts", "expires_at", "id", "invoice_settings", "livemode", "metadata", "object", "status", "status_transitions", "subscription_data", "total_details" ], "title": "Quote", "type": "object", "x-expandableFields": [ "application", "automatic_tax", "computed", "customer", "default_tax_rates", "discounts", "from_quote", "invoice", "invoice_settings", "line_items", "on_behalf_of", "status_transitions", "subscription", "subscription_data", "subscription_schedule", "test_clock", "total_details", "transfer_data" ], "x-resourceId": "quote" }, "quotes_resource_automatic_tax": { "description": "", "properties": { "enabled": { "description": "Automatically calculate taxes", "type": "boolean" }, "liability": { "anyOf": [ { "$ref": "#/components/schemas/connect_account_reference" } ], "description": "The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.", "nullable": true }, "provider": { "description": "The tax provider powering automatic tax.", "maxLength": 5000, "nullable": true, "type": "string" }, "status": { "description": "The status of the most recent automated tax calculation for this quote.", "enum": [ "complete", "failed", "requires_location_inputs" ], "nullable": true, "type": "string" } }, "required": [ "enabled" ], "title": "QuotesResourceAutomaticTax", "type": "object", "x-expandableFields": [ "liability" ] }, "quotes_resource_computed": { "description": "", "properties": { "recurring": { "anyOf": [ { "$ref": "#/components/schemas/quotes_resource_recurring" } ], "description": "The definitive totals and line items the customer will be charged on a recurring basis. Takes into account the line items with recurring prices and discounts with `duration=forever` coupons only. Defaults to `null` if no inputted line items with recurring prices.", "nullable": true }, "upfront": { "$ref": "#/components/schemas/quotes_resource_upfront" } }, "required": [ "upfront" ], "title": "QuotesResourceComputed", "type": "object", "x-expandableFields": [ "recurring", "upfront" ] }, "quotes_resource_from_quote": { "description": "", "properties": { "is_revision": { "description": "Whether this quote is a revision of a different quote.", "type": "boolean" }, "quote": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/quote" } ], "description": "The quote that was cloned.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/quote" } ] } } }, "required": [ "is_revision", "quote" ], "title": "QuotesResourceFromQuote", "type": "object", "x-expandableFields": [ "quote" ] }, "quotes_resource_recurring": { "description": "", "properties": { "amount_subtotal": { "description": "Total before any discounts or taxes are applied.", "type": "integer" }, "amount_total": { "description": "Total after discounts and taxes are applied.", "type": "integer" }, "interval": { "description": "The frequency at which a subscription is billed. One of `day`, `week`, `month` or `year`.", "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "description": "The number of intervals (specified in the `interval` attribute) between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months.", "type": "integer" }, "total_details": { "$ref": "#/components/schemas/quotes_resource_total_details" } }, "required": [ "amount_subtotal", "amount_total", "interval", "interval_count", "total_details" ], "title": "QuotesResourceRecurring", "type": "object", "x-expandableFields": [ "total_details" ] }, "quotes_resource_status_transitions": { "description": "", "properties": { "accepted_at": { "description": "The time that the quote was accepted. Measured in seconds since Unix epoch.", "format": "unix-time", "nullable": true, "type": "integer" }, "canceled_at": { "description": "The time that the quote was canceled. Measured in seconds since Unix epoch.", "format": "unix-time", "nullable": true, "type": "integer" }, "finalized_at": { "description": "The time that the quote was finalized. Measured in seconds since Unix epoch.", "format": "unix-time", "nullable": true, "type": "integer" } }, "title": "QuotesResourceStatusTransitions", "type": "object", "x-expandableFields": [] }, "quotes_resource_subscription_data_billing_mode": { "description": "The billing mode of the quote.", "properties": { "type": { "description": "Controls how prorations and invoices for subscriptions are calculated and orchestrated.", "enum": [ "classic", "flexible" ], "type": "string" } }, "required": [ "type" ], "title": "QuotesResourceSubscriptionDataBillingMode", "type": "object", "x-expandableFields": [] }, "quotes_resource_subscription_data_subscription_data": { "description": "", "properties": { "billing_mode": { "$ref": "#/components/schemas/quotes_resource_subscription_data_billing_mode" }, "description": { "description": "The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.", "maxLength": 5000, "nullable": true, "type": "string" }, "effective_date": { "description": "When creating a new subscription, the date of which the subscription schedule will start after the quote is accepted. This date is ignored if it is in the past when the quote is accepted. Measured in seconds since the Unix epoch.", "format": "unix-time", "nullable": true, "type": "integer" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will set metadata on the subscription or subscription schedule when the quote is accepted. If a recurring price is included in `line_items`, this field will be passed to the resulting subscription's `metadata` field. If `subscription_data.effective_date` is used, this field will be passed to the resulting subscription schedule's `phases.metadata` field. Unlike object-level metadata, this field is declarative. Updates will clear prior values.", "nullable": true, "type": "object" }, "trial_period_days": { "description": "Integer representing the number of trial period days before the customer is charged for the first time.", "nullable": true, "type": "integer" } }, "required": [ "billing_mode" ], "title": "QuotesResourceSubscriptionDataSubscriptionData", "type": "object", "x-expandableFields": [ "billing_mode" ] }, "quotes_resource_total_details": { "description": "", "properties": { "amount_discount": { "description": "This is the sum of all the discounts.", "type": "integer" }, "amount_shipping": { "description": "This is the sum of all the shipping amounts.", "nullable": true, "type": "integer" }, "amount_tax": { "description": "This is the sum of all the tax amounts.", "type": "integer" }, "breakdown": { "$ref": "#/components/schemas/quotes_resource_total_details_resource_breakdown" } }, "required": [ "amount_discount", "amount_tax" ], "title": "QuotesResourceTotalDetails", "type": "object", "x-expandableFields": [ "breakdown" ] }, "quotes_resource_total_details_resource_breakdown": { "description": "", "properties": { "discounts": { "description": "The aggregated discounts.", "items": { "$ref": "#/components/schemas/line_items_discount_amount" }, "type": "array" }, "taxes": { "description": "The aggregated tax amounts by rate.", "items": { "$ref": "#/components/schemas/line_items_tax_amount" }, "type": "array" } }, "required": [ "discounts", "taxes" ], "title": "QuotesResourceTotalDetailsResourceBreakdown", "type": "object", "x-expandableFields": [ "discounts", "taxes" ] }, "quotes_resource_transfer_data": { "description": "", "properties": { "amount": { "description": "The amount in cents (or local equivalent) that will be transferred to the destination account when the invoice is paid. By default, the entire amount is transferred to the destination.", "nullable": true, "type": "integer" }, "amount_percent": { "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount will be transferred to the destination.", "nullable": true, "type": "number" }, "destination": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/account" } ], "description": "The account where funds from the payment will be transferred to upon payment success.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/account" } ] } } }, "required": [ "destination" ], "title": "QuotesResourceTransferData", "type": "object", "x-expandableFields": [ "destination" ] }, "quotes_resource_upfront": { "description": "", "properties": { "amount_subtotal": { "description": "Total before any discounts or taxes are applied.", "type": "integer" }, "amount_total": { "description": "Total after discounts and taxes are applied.", "type": "integer" }, "line_items": { "description": "The line items that will appear on the next invoice after this quote is accepted. This does not include pending invoice items that exist on the customer but may still be included in the next invoice.", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/item" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "QuotesResourceListLineItems", "type": "object", "x-expandableFields": [ "data" ] }, "total_details": { "$ref": "#/components/schemas/quotes_resource_total_details" } }, "required": [ "amount_subtotal", "amount_total", "total_details" ], "title": "QuotesResourceUpfront", "type": "object", "x-expandableFields": [ "line_items", "total_details" ] }, "radar.early_fraud_warning": { "description": "An early fraud warning indicates that the card issuer has notified us that a\ncharge may be fraudulent.\n\nRelated guide: [Early fraud warnings](https://stripe.com/docs/disputes/measuring#early-fraud-warnings)", "properties": { "actionable": { "description": "An EFW is actionable if it has not received a dispute and has not been fully refunded. You may wish to proactively refund a charge that receives an EFW, in order to avoid receiving a dispute later.", "type": "boolean" }, "charge": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/charge" } ], "description": "ID of the charge this early fraud warning is for, optionally expanded.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/charge" } ] } }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "fraud_type": { "description": "The type of fraud labelled by the issuer. One of `card_never_received`, `fraudulent_card_application`, `made_with_counterfeit_card`, `made_with_lost_card`, `made_with_stolen_card`, `misc`, `unauthorized_use_of_card`.", "maxLength": 5000, "type": "string" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "radar.early_fraud_warning" ], "type": "string" }, "payment_intent": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/payment_intent" } ], "description": "ID of the Payment Intent this early fraud warning is for, optionally expanded.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/payment_intent" } ] } } }, "required": [ "actionable", "charge", "created", "fraud_type", "id", "livemode", "object" ], "title": "RadarEarlyFraudWarning", "type": "object", "x-expandableFields": [ "charge", "payment_intent" ], "x-resourceId": "radar.early_fraud_warning" }, "radar.value_list": { "description": "Value lists allow you to group values together which can then be referenced in rules.\n\nRelated guide: [Default Stripe lists](https://stripe.com/docs/radar/lists#managing-list-items)", "properties": { "alias": { "description": "The name of the value list for use in rules.", "maxLength": 5000, "type": "string" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "created_by": { "description": "The name or email address of the user who created this value list.", "maxLength": 5000, "type": "string" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "item_type": { "description": "The type of items in the value list. One of `card_fingerprint`, `card_bin`, `email`, `ip_address`, `country`, `string`, `case_sensitive_string`, `customer_id`, `sepa_debit_fingerprint`, or `us_bank_account_fingerprint`.", "enum": [ "card_bin", "card_fingerprint", "case_sensitive_string", "country", "customer_id", "email", "ip_address", "sepa_debit_fingerprint", "string", "us_bank_account_fingerprint" ], "type": "string" }, "list_items": { "description": "List of items contained within this value list.", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/radar.value_list_item" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "RadarListListItemList", "type": "object", "x-expandableFields": [ "data" ] }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "type": "object" }, "name": { "description": "The name of the value list.", "maxLength": 5000, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "radar.value_list" ], "type": "string" } }, "required": [ "alias", "created", "created_by", "id", "item_type", "list_items", "livemode", "metadata", "name", "object" ], "title": "RadarListList", "type": "object", "x-expandableFields": [ "list_items" ], "x-resourceId": "radar.value_list" }, "radar.value_list_item": { "description": "Value list items allow you to add specific values to a given Radar value list, which can then be used in rules.\n\nRelated guide: [Managing list items](https://stripe.com/docs/radar/lists#managing-list-items)", "properties": { "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "created_by": { "description": "The name or email address of the user who added this item to the value list.", "maxLength": 5000, "type": "string" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "radar.value_list_item" ], "type": "string" }, "value": { "description": "The value of the item.", "maxLength": 5000, "type": "string" }, "value_list": { "description": "The identifier of the value list this item belongs to.", "maxLength": 5000, "type": "string" } }, "required": [ "created", "created_by", "id", "livemode", "object", "value", "value_list" ], "title": "RadarListListItem", "type": "object", "x-expandableFields": [], "x-resourceId": "radar.value_list_item" }, "radar_radar_options": { "description": "Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.", "properties": { "session": { "description": "A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.", "maxLength": 5000, "type": "string" } }, "title": "RadarRadarOptions", "type": "object", "x-expandableFields": [] }, "radar_review_resource_location": { "description": "", "properties": { "city": { "description": "The city where the payment originated.", "maxLength": 5000, "nullable": true, "type": "string" }, "country": { "description": "Two-letter ISO code representing the country where the payment originated.", "maxLength": 5000, "nullable": true, "type": "string" }, "latitude": { "description": "The geographic latitude where the payment originated.", "nullable": true, "type": "number" }, "longitude": { "description": "The geographic longitude where the payment originated.", "nullable": true, "type": "number" }, "region": { "description": "The state/county/province/region where the payment originated.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "RadarReviewResourceLocation", "type": "object", "x-expandableFields": [] }, "radar_review_resource_session": { "description": "", "properties": { "browser": { "description": "The browser used in this browser session (e.g., `Chrome`).", "maxLength": 5000, "nullable": true, "type": "string" }, "device": { "description": "Information about the device used for the browser session (e.g., `Samsung SM-G930T`).", "maxLength": 5000, "nullable": true, "type": "string" }, "platform": { "description": "The platform for the browser session (e.g., `Macintosh`).", "maxLength": 5000, "nullable": true, "type": "string" }, "version": { "description": "The version for the browser session (e.g., `61.0.3163.100`).", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "RadarReviewResourceSession", "type": "object", "x-expandableFields": [] }, "received_payment_method_details_financial_account": { "description": "", "properties": { "id": { "description": "The FinancialAccount ID.", "maxLength": 5000, "type": "string" }, "network": { "description": "The rails the ReceivedCredit was sent over. A FinancialAccount can only send funds over `stripe`.", "enum": [ "stripe" ], "type": "string" } }, "required": [ "id", "network" ], "title": "received_payment_method_details_financial_account", "type": "object", "x-expandableFields": [] }, "recurring": { "description": "", "properties": { "interval": { "description": "The frequency at which a subscription is billed. One of `day`, `week`, `month` or `year`.", "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "description": "The number of intervals (specified in the `interval` attribute) between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months.", "type": "integer" }, "meter": { "description": "The meter tracking the usage of a metered price", "maxLength": 5000, "nullable": true, "type": "string" }, "usage_type": { "description": "Configures how the quantity per period should be determined. Can be either `metered` or `licensed`. `licensed` automatically bills the `quantity` set when adding it to a subscription. `metered` aggregates the total usage based on usage records. Defaults to `licensed`.", "enum": [ "licensed", "metered" ], "type": "string" } }, "required": [ "interval", "interval_count", "usage_type" ], "title": "Recurring", "type": "object", "x-expandableFields": [] }, "refund": { "description": "Refund objects allow you to refund a previously created charge that isn't\nrefunded yet. Funds are refunded to the credit or debit card that's\ninitially charged.\n\nRelated guide: [Refunds](https://stripe.com/docs/refunds)", "properties": { "amount": { "description": "Amount, in cents (or local equivalent).", "type": "integer" }, "balance_transaction": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/balance_transaction" } ], "description": "Balance transaction that describes the impact on your account balance.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/balance_transaction" } ] } }, "charge": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/charge" } ], "description": "ID of the charge that's refunded.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/charge" } ] } }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "description": { "description": "An arbitrary string attached to the object. You can use this for displaying to users (available on non-card refunds only).", "maxLength": 5000, "type": "string" }, "destination_details": { "$ref": "#/components/schemas/refund_destination_details" }, "failure_balance_transaction": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/balance_transaction" } ], "description": "After the refund fails, this balance transaction describes the adjustment made on your account balance that reverses the initial balance transaction.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/balance_transaction" } ] } }, "failure_reason": { "description": "Provides the reason for the refund failure. Possible values are: `lost_or_stolen_card`, `expired_or_canceled_card`, `charge_for_pending_refund_disputed`, `insufficient_funds`, `declined`, `merchant_request`, or `unknown`.", "maxLength": 5000, "type": "string" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "instructions_email": { "description": "For payment methods without native refund support (for example, Konbini, PromptPay), provide an email address for the customer to receive refund instructions.", "maxLength": 5000, "type": "string" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "nullable": true, "type": "object" }, "next_action": { "$ref": "#/components/schemas/refund_next_action" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "refund" ], "type": "string" }, "payment_intent": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/payment_intent" } ], "description": "ID of the PaymentIntent that's refunded.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/payment_intent" } ] } }, "pending_reason": { "description": "Provides the reason for why the refund is pending. Possible values are: `processing`, `insufficient_funds`, or `charge_pending`.", "enum": [ "charge_pending", "insufficient_funds", "processing" ], "type": "string" }, "presentment_details": { "$ref": "#/components/schemas/payment_flows_payment_intent_presentment_details" }, "reason": { "description": "Reason for the refund, which is either user-provided (`duplicate`, `fraudulent`, or `requested_by_customer`) or generated by Stripe internally (`expired_uncaptured_charge`).", "enum": [ "duplicate", "expired_uncaptured_charge", "fraudulent", "requested_by_customer" ], "nullable": true, "type": "string", "x-stripeBypassValidation": true }, "receipt_number": { "description": "This is the transaction number that appears on email receipts sent for this refund.", "maxLength": 5000, "nullable": true, "type": "string" }, "source_transfer_reversal": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/transfer_reversal" } ], "description": "The transfer reversal that's associated with the refund. Only present if the charge came from another Stripe account.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/transfer_reversal" } ] } }, "status": { "description": "Status of the refund. This can be `pending`, `requires_action`, `succeeded`, `failed`, or `canceled`. Learn more about [failed refunds](https://stripe.com/docs/refunds#failed-refunds).", "maxLength": 5000, "nullable": true, "type": "string" }, "transfer_reversal": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/transfer_reversal" } ], "description": "This refers to the transfer reversal object if the accompanying transfer reverses. This is only applicable if the charge was created using the destination parameter.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/transfer_reversal" } ] } } }, "required": [ "amount", "created", "currency", "id", "object" ], "title": "Refund", "type": "object", "x-expandableFields": [ "balance_transaction", "charge", "destination_details", "failure_balance_transaction", "next_action", "payment_intent", "presentment_details", "source_transfer_reversal", "transfer_reversal" ], "x-resourceId": "refund" }, "refund_destination_details": { "description": "", "properties": { "affirm": { "$ref": "#/components/schemas/destination_details_unimplemented" }, "afterpay_clearpay": { "$ref": "#/components/schemas/destination_details_unimplemented" }, "alipay": { "$ref": "#/components/schemas/destination_details_unimplemented" }, "alma": { "$ref": "#/components/schemas/destination_details_unimplemented" }, "amazon_pay": { "$ref": "#/components/schemas/destination_details_unimplemented" }, "au_bank_transfer": { "$ref": "#/components/schemas/destination_details_unimplemented" }, "blik": { "$ref": "#/components/schemas/refund_destination_details_blik" }, "br_bank_transfer": { "$ref": "#/components/schemas/refund_destination_details_br_bank_transfer" }, "card": { "$ref": "#/components/schemas/refund_destination_details_card" }, "cashapp": { "$ref": "#/components/schemas/destination_details_unimplemented" }, "customer_cash_balance": { "$ref": "#/components/schemas/destination_details_unimplemented" }, "eps": { "$ref": "#/components/schemas/destination_details_unimplemented" }, "eu_bank_transfer": { "$ref": "#/components/schemas/refund_destination_details_eu_bank_transfer" }, "gb_bank_transfer": { "$ref": "#/components/schemas/refund_destination_details_gb_bank_transfer" }, "giropay": { "$ref": "#/components/schemas/destination_details_unimplemented" }, "grabpay": { "$ref": "#/components/schemas/destination_details_unimplemented" }, "jp_bank_transfer": { "$ref": "#/components/schemas/refund_destination_details_jp_bank_transfer" }, "klarna": { "$ref": "#/components/schemas/destination_details_unimplemented" }, "multibanco": { "$ref": "#/components/schemas/refund_destination_details_multibanco" }, "mx_bank_transfer": { "$ref": "#/components/schemas/refund_destination_details_mx_bank_transfer" }, "nz_bank_transfer": { "$ref": "#/components/schemas/destination_details_unimplemented" }, "p24": { "$ref": "#/components/schemas/refund_destination_details_p24" }, "paynow": { "$ref": "#/components/schemas/destination_details_unimplemented" }, "paypal": { "$ref": "#/components/schemas/refund_destination_details_paypal" }, "pix": { "$ref": "#/components/schemas/destination_details_unimplemented" }, "revolut": { "$ref": "#/components/schemas/destination_details_unimplemented" }, "sofort": { "$ref": "#/components/schemas/destination_details_unimplemented" }, "swish": { "$ref": "#/components/schemas/refund_destination_details_swish" }, "th_bank_transfer": { "$ref": "#/components/schemas/refund_destination_details_th_bank_transfer" }, "type": { "description": "The type of transaction-specific details of the payment method used in the refund (e.g., `card`). An additional hash is included on `destination_details` with a name matching this value. It contains information specific to the refund transaction.", "maxLength": 5000, "type": "string" }, "us_bank_transfer": { "$ref": "#/components/schemas/refund_destination_details_us_bank_transfer" }, "wechat_pay": { "$ref": "#/components/schemas/destination_details_unimplemented" }, "zip": { "$ref": "#/components/schemas/destination_details_unimplemented" } }, "required": [ "type" ], "title": "refund_destination_details", "type": "object", "x-expandableFields": [ "affirm", "afterpay_clearpay", "alipay", "alma", "amazon_pay", "au_bank_transfer", "blik", "br_bank_transfer", "card", "cashapp", "customer_cash_balance", "eps", "eu_bank_transfer", "gb_bank_transfer", "giropay", "grabpay", "jp_bank_transfer", "klarna", "multibanco", "mx_bank_transfer", "nz_bank_transfer", "p24", "paynow", "paypal", "pix", "revolut", "sofort", "swish", "th_bank_transfer", "us_bank_transfer", "wechat_pay", "zip" ] }, "refund_destination_details_blik": { "description": "", "properties": { "network_decline_code": { "description": "For refunds declined by the network, a decline code provided by the network which indicates the reason the refund failed.", "maxLength": 5000, "nullable": true, "type": "string" }, "reference": { "description": "The reference assigned to the refund.", "maxLength": 5000, "nullable": true, "type": "string" }, "reference_status": { "description": "Status of the reference on the refund. This can be `pending`, `available` or `unavailable`.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "refund_destination_details_blik", "type": "object", "x-expandableFields": [] }, "refund_destination_details_br_bank_transfer": { "description": "", "properties": { "reference": { "description": "The reference assigned to the refund.", "maxLength": 5000, "nullable": true, "type": "string" }, "reference_status": { "description": "Status of the reference on the refund. This can be `pending`, `available` or `unavailable`.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "refund_destination_details_br_bank_transfer", "type": "object", "x-expandableFields": [] }, "refund_destination_details_card": { "description": "", "properties": { "reference": { "description": "Value of the reference number assigned to the refund.", "maxLength": 5000, "type": "string" }, "reference_status": { "description": "Status of the reference number on the refund. This can be `pending`, `available` or `unavailable`.", "maxLength": 5000, "type": "string" }, "reference_type": { "description": "Type of the reference number assigned to the refund.", "maxLength": 5000, "type": "string" }, "type": { "description": "The type of refund. This can be `refund`, `reversal`, or `pending`.", "enum": [ "pending", "refund", "reversal" ], "type": "string" } }, "required": [ "type" ], "title": "refund_destination_details_card", "type": "object", "x-expandableFields": [] }, "refund_destination_details_eu_bank_transfer": { "description": "", "properties": { "reference": { "description": "The reference assigned to the refund.", "maxLength": 5000, "nullable": true, "type": "string" }, "reference_status": { "description": "Status of the reference on the refund. This can be `pending`, `available` or `unavailable`.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "refund_destination_details_eu_bank_transfer", "type": "object", "x-expandableFields": [] }, "refund_destination_details_gb_bank_transfer": { "description": "", "properties": { "reference": { "description": "The reference assigned to the refund.", "maxLength": 5000, "nullable": true, "type": "string" }, "reference_status": { "description": "Status of the reference on the refund. This can be `pending`, `available` or `unavailable`.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "refund_destination_details_gb_bank_transfer", "type": "object", "x-expandableFields": [] }, "refund_destination_details_jp_bank_transfer": { "description": "", "properties": { "reference": { "description": "The reference assigned to the refund.", "maxLength": 5000, "nullable": true, "type": "string" }, "reference_status": { "description": "Status of the reference on the refund. This can be `pending`, `available` or `unavailable`.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "refund_destination_details_jp_bank_transfer", "type": "object", "x-expandableFields": [] }, "refund_destination_details_multibanco": { "description": "", "properties": { "reference": { "description": "The reference assigned to the refund.", "maxLength": 5000, "nullable": true, "type": "string" }, "reference_status": { "description": "Status of the reference on the refund. This can be `pending`, `available` or `unavailable`.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "refund_destination_details_multibanco", "type": "object", "x-expandableFields": [] }, "refund_destination_details_mx_bank_transfer": { "description": "", "properties": { "reference": { "description": "The reference assigned to the refund.", "maxLength": 5000, "nullable": true, "type": "string" }, "reference_status": { "description": "Status of the reference on the refund. This can be `pending`, `available` or `unavailable`.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "refund_destination_details_mx_bank_transfer", "type": "object", "x-expandableFields": [] }, "refund_destination_details_p24": { "description": "", "properties": { "reference": { "description": "The reference assigned to the refund.", "maxLength": 5000, "nullable": true, "type": "string" }, "reference_status": { "description": "Status of the reference on the refund. This can be `pending`, `available` or `unavailable`.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "refund_destination_details_p24", "type": "object", "x-expandableFields": [] }, "refund_destination_details_paypal": { "description": "", "properties": { "network_decline_code": { "description": "For refunds declined by the network, a decline code provided by the network which indicates the reason the refund failed.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "refund_destination_details_paypal", "type": "object", "x-expandableFields": [] }, "refund_destination_details_swish": { "description": "", "properties": { "network_decline_code": { "description": "For refunds declined by the network, a decline code provided by the network which indicates the reason the refund failed.", "maxLength": 5000, "nullable": true, "type": "string" }, "reference": { "description": "The reference assigned to the refund.", "maxLength": 5000, "nullable": true, "type": "string" }, "reference_status": { "description": "Status of the reference on the refund. This can be `pending`, `available` or `unavailable`.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "refund_destination_details_swish", "type": "object", "x-expandableFields": [] }, "refund_destination_details_th_bank_transfer": { "description": "", "properties": { "reference": { "description": "The reference assigned to the refund.", "maxLength": 5000, "nullable": true, "type": "string" }, "reference_status": { "description": "Status of the reference on the refund. This can be `pending`, `available` or `unavailable`.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "refund_destination_details_th_bank_transfer", "type": "object", "x-expandableFields": [] }, "refund_destination_details_us_bank_transfer": { "description": "", "properties": { "reference": { "description": "The reference assigned to the refund.", "maxLength": 5000, "nullable": true, "type": "string" }, "reference_status": { "description": "Status of the reference on the refund. This can be `pending`, `available` or `unavailable`.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "refund_destination_details_us_bank_transfer", "type": "object", "x-expandableFields": [] }, "refund_next_action": { "description": "", "properties": { "display_details": { "$ref": "#/components/schemas/refund_next_action_display_details" }, "type": { "description": "Type of the next action to perform.", "maxLength": 5000, "type": "string" } }, "required": [ "type" ], "title": "RefundNextAction", "type": "object", "x-expandableFields": [ "display_details" ] }, "refund_next_action_display_details": { "description": "", "properties": { "email_sent": { "$ref": "#/components/schemas/email_sent" }, "expires_at": { "description": "The expiry timestamp.", "format": "unix-time", "type": "integer" } }, "required": [ "email_sent", "expires_at" ], "title": "RefundNextActionDisplayDetails", "type": "object", "x-expandableFields": [ "email_sent" ] }, "reporting.report_run": { "description": "The Report Run object represents an instance of a report type generated with\nspecific run parameters. Once the object is created, Stripe begins processing the report.\nWhen the report has finished running, it will give you a reference to a file\nwhere you can retrieve your results. For an overview, see\n[API Access to Reports](https://stripe.com/docs/reporting/statements/api).\n\nNote that certain report types can only be run based on your live-mode data (not test-mode\ndata), and will error when queried without a [live-mode API key](https://stripe.com/docs/keys#test-live-modes).", "properties": { "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "error": { "description": "If something should go wrong during the run, a message about the failure (populated when\n `status=failed`).", "maxLength": 5000, "nullable": true, "type": "string" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "`true` if the report is run on live mode data and `false` if it is run on test mode data.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "reporting.report_run" ], "type": "string" }, "parameters": { "$ref": "#/components/schemas/financial_reporting_finance_report_run_run_parameters" }, "report_type": { "description": "The ID of the [report type](https://stripe.com/docs/reports/report-types) to run, such as `\"balance.summary.1\"`.", "maxLength": 5000, "type": "string" }, "result": { "anyOf": [ { "$ref": "#/components/schemas/file" } ], "description": "The file object representing the result of the report run (populated when\n `status=succeeded`).", "nullable": true }, "status": { "description": "Status of this report run. This will be `pending` when the run is initially created.\n When the run finishes, this will be set to `succeeded` and the `result` field will be populated.\n Rarely, we may encounter an error, at which point this will be set to `failed` and the `error` field will be populated.", "maxLength": 5000, "type": "string" }, "succeeded_at": { "description": "Timestamp at which this run successfully finished (populated when\n `status=succeeded`). Measured in seconds since the Unix epoch.", "format": "unix-time", "nullable": true, "type": "integer" } }, "required": [ "created", "id", "livemode", "object", "parameters", "report_type", "status" ], "title": "reporting_report_run", "type": "object", "x-expandableFields": [ "parameters", "result" ], "x-resourceId": "reporting.report_run" }, "reporting.report_type": { "description": "The Report Type resource corresponds to a particular type of report, such as\nthe \"Activity summary\" or \"Itemized payouts\" reports. These objects are\nidentified by an ID belonging to a set of enumerated values. See\n[API Access to Reports documentation](https://stripe.com/docs/reporting/statements/api)\nfor those Report Type IDs, along with required and optional parameters.\n\nNote that certain report types can only be run based on your live-mode data (not test-mode\ndata), and will error when queried without a [live-mode API key](https://stripe.com/docs/keys#test-live-modes).", "properties": { "data_available_end": { "description": "Most recent time for which this Report Type is available. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "data_available_start": { "description": "Earliest time for which this Report Type is available. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "default_columns": { "description": "List of column names that are included by default when this Report Type gets run. (If the Report Type doesn't support the `columns` parameter, this will be null.)", "items": { "maxLength": 5000, "type": "string" }, "nullable": true, "type": "array" }, "id": { "description": "The [ID of the Report Type](https://stripe.com/docs/reporting/statements/api#available-report-types), such as `balance.summary.1`.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "name": { "description": "Human-readable name of the Report Type", "maxLength": 5000, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "reporting.report_type" ], "type": "string" }, "updated": { "description": "When this Report Type was latest updated. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "version": { "description": "Version of the Report Type. Different versions report with the same ID will have the same purpose, but may take different run parameters or have different result schemas.", "type": "integer" } }, "required": [ "data_available_end", "data_available_start", "id", "livemode", "name", "object", "updated", "version" ], "title": "reporting_report_type", "type": "object", "x-expandableFields": [], "x-resourceId": "reporting.report_type" }, "reserve_transaction": { "description": "", "properties": { "amount": { "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users.", "maxLength": 5000, "nullable": true, "type": "string" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "reserve_transaction" ], "type": "string" } }, "required": [ "amount", "currency", "id", "object" ], "title": "ReserveTransaction", "type": "object", "x-expandableFields": [] }, "review": { "description": "Reviews can be used to supplement automated fraud detection with human expertise.\n\nLearn more about [Radar](/radar) and reviewing payments\n[here](https://stripe.com/docs/radar/reviews).", "properties": { "billing_zip": { "description": "The ZIP or postal code of the card used, if applicable.", "maxLength": 5000, "nullable": true, "type": "string" }, "charge": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/charge" } ], "description": "The charge associated with this review.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/charge" } ] } }, "closed_reason": { "description": "The reason the review was closed, or null if it has not yet been closed. One of `approved`, `refunded`, `refunded_as_fraud`, `disputed`, `redacted`, `canceled`, `payment_never_settled`, or `acknowledged`.", "enum": [ "approved", "canceled", "disputed", "redacted", "refunded", "refunded_as_fraud" ], "nullable": true, "type": "string", "x-stripeBypassValidation": true }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "ip_address": { "description": "The IP address where the payment originated.", "maxLength": 5000, "nullable": true, "type": "string" }, "ip_address_location": { "anyOf": [ { "$ref": "#/components/schemas/radar_review_resource_location" } ], "description": "Information related to the location of the payment. Note that this information is an approximation and attempts to locate the nearest population center - it should not be used to determine a specific address.", "nullable": true }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "review" ], "type": "string" }, "open": { "description": "If `true`, the review needs action.", "type": "boolean" }, "opened_reason": { "description": "The reason the review was opened. One of `rule` or `manual`.", "enum": [ "manual", "rule" ], "type": "string" }, "payment_intent": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/payment_intent" } ], "description": "The PaymentIntent ID associated with this review, if one exists.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/payment_intent" } ] } }, "reason": { "description": "The reason the review is currently open or closed. One of `rule`, `manual`, `approved`, `refunded`, `refunded_as_fraud`, `disputed`, `redacted`, `canceled`, `payment_never_settled`, or `acknowledged`.", "maxLength": 5000, "type": "string" }, "session": { "anyOf": [ { "$ref": "#/components/schemas/radar_review_resource_session" } ], "description": "Information related to the browsing session of the user who initiated the payment.", "nullable": true } }, "required": [ "created", "id", "livemode", "object", "open", "opened_reason", "reason" ], "title": "RadarReview", "type": "object", "x-expandableFields": [ "charge", "ip_address_location", "payment_intent", "session" ], "x-resourceId": "review" }, "revolut_pay_underlying_payment_method_funding_details": { "description": "", "properties": { "card": { "$ref": "#/components/schemas/payment_method_details_passthrough_card" }, "type": { "description": "funding type of the underlying payment method.", "enum": [ "card" ], "nullable": true, "type": "string" } }, "title": "revolut_pay_underlying_payment_method_funding_details", "type": "object", "x-expandableFields": [ "card" ] }, "rule": { "description": "", "properties": { "action": { "description": "The action taken on the payment.", "maxLength": 5000, "type": "string" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "predicate": { "description": "The predicate to evaluate the payment against.", "maxLength": 5000, "type": "string" } }, "required": [ "action", "id", "predicate" ], "title": "RadarRule", "type": "object", "x-expandableFields": [] }, "scheduled_query_run": { "description": "If you have [scheduled a Sigma query](https://stripe.com/docs/sigma/scheduled-queries), you'll\nreceive a `sigma.scheduled_query_run.created` webhook each time the query\nruns. The webhook contains a `ScheduledQueryRun` object, which you can use to\nretrieve the query results.", "properties": { "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "data_load_time": { "description": "When the query was run, Sigma contained a snapshot of your Stripe data at this time.", "format": "unix-time", "type": "integer" }, "error": { "$ref": "#/components/schemas/sigma_scheduled_query_run_error" }, "file": { "anyOf": [ { "$ref": "#/components/schemas/file" } ], "description": "The file object representing the results of the query.", "nullable": true }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "scheduled_query_run" ], "type": "string" }, "result_available_until": { "description": "Time at which the result expires and is no longer available for download.", "format": "unix-time", "type": "integer" }, "sql": { "description": "SQL for the query.", "maxLength": 100000, "type": "string" }, "status": { "description": "The query's execution status, which will be `completed` for successful runs, and `canceled`, `failed`, or `timed_out` otherwise.", "maxLength": 5000, "type": "string" }, "title": { "description": "Title of the query.", "maxLength": 5000, "type": "string" } }, "required": [ "created", "data_load_time", "id", "livemode", "object", "result_available_until", "sql", "status", "title" ], "title": "ScheduledQueryRun", "type": "object", "x-expandableFields": [ "error", "file" ], "x-resourceId": "scheduled_query_run" }, "schedules_phase_automatic_tax": { "description": "", "properties": { "disabled_reason": { "description": "If Stripe disabled automatic tax, this enum describes why.", "enum": [ "requires_location_inputs" ], "nullable": true, "type": "string" }, "enabled": { "description": "Whether Stripe automatically computes tax on invoices created during this phase.", "type": "boolean" }, "liability": { "anyOf": [ { "$ref": "#/components/schemas/connect_account_reference" } ], "description": "The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.", "nullable": true } }, "required": [ "enabled" ], "title": "SchedulesPhaseAutomaticTax", "type": "object", "x-expandableFields": [ "liability" ] }, "secret_service_resource_scope": { "description": "", "properties": { "type": { "description": "The secret scope type.", "enum": [ "account", "user" ], "type": "string" }, "user": { "description": "The user ID, if type is set to \"user\"", "maxLength": 5000, "type": "string" } }, "required": [ "type" ], "title": "SecretServiceResourceScope", "type": "object", "x-expandableFields": [] }, "sepa_debit_generated_from": { "description": "", "properties": { "charge": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/charge" } ], "description": "The ID of the Charge that generated this PaymentMethod, if any.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/charge" } ] } }, "setup_attempt": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/setup_attempt" } ], "description": "The ID of the SetupAttempt that generated this PaymentMethod, if any.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/setup_attempt" } ] } } }, "title": "sepa_debit_generated_from", "type": "object", "x-expandableFields": [ "charge", "setup_attempt" ] }, "setup_attempt": { "description": "A SetupAttempt describes one attempted confirmation of a SetupIntent,\nwhether that confirmation is successful or unsuccessful. You can use\nSetupAttempts to inspect details of a specific attempt at setting up a\npayment method using a SetupIntent.", "properties": { "application": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/application" } ], "description": "The value of [application](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-application) on the SetupIntent at the time of this confirmation.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/application" } ] } }, "attach_to_self": { "description": "If present, the SetupIntent's payment method will be attached to the in-context Stripe Account.\n\nIt can only be used for this Stripe Account’s own money movement flows like InboundTransfer and OutboundTransfers. It cannot be set to true when setting up a PaymentMethod for a Customer, and defaults to false when attaching a PaymentMethod to a Customer.", "type": "boolean" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "customer": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/customer" }, { "$ref": "#/components/schemas/deleted_customer" } ], "description": "The value of [customer](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-customer) on the SetupIntent at the time of this confirmation.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/customer" }, { "$ref": "#/components/schemas/deleted_customer" } ] } }, "flow_directions": { "description": "Indicates the directions of money movement for which this payment method is intended to be used.\n\nInclude `inbound` if you intend to use the payment method as the origin to pull funds from. Include `outbound` if you intend to use the payment method as the destination to send funds to. You can include both if you intend to use the payment method for both purposes.", "items": { "enum": [ "inbound", "outbound" ], "type": "string" }, "nullable": true, "type": "array" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "setup_attempt" ], "type": "string" }, "on_behalf_of": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/account" } ], "description": "The value of [on_behalf_of](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-on_behalf_of) on the SetupIntent at the time of this confirmation.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/account" } ] } }, "payment_method": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/payment_method" } ], "description": "ID of the payment method used with this SetupAttempt.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/payment_method" } ] } }, "payment_method_details": { "$ref": "#/components/schemas/setup_attempt_payment_method_details" }, "setup_error": { "anyOf": [ { "$ref": "#/components/schemas/api_errors" } ], "description": "The error encountered during this attempt to confirm the SetupIntent, if any.", "nullable": true }, "setup_intent": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/setup_intent" } ], "description": "ID of the SetupIntent that this attempt belongs to.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/setup_intent" } ] } }, "status": { "description": "Status of this SetupAttempt, one of `requires_confirmation`, `requires_action`, `processing`, `succeeded`, `failed`, or `abandoned`.", "maxLength": 5000, "type": "string" }, "usage": { "description": "The value of [usage](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-usage) on the SetupIntent at the time of this confirmation, one of `off_session` or `on_session`.", "maxLength": 5000, "type": "string" } }, "required": [ "created", "id", "livemode", "object", "payment_method", "payment_method_details", "setup_intent", "status", "usage" ], "title": "PaymentFlowsSetupIntentSetupAttempt", "type": "object", "x-expandableFields": [ "application", "customer", "on_behalf_of", "payment_method", "payment_method_details", "setup_error", "setup_intent" ], "x-resourceId": "setup_attempt" }, "setup_attempt_payment_method_details": { "description": "", "properties": { "acss_debit": { "$ref": "#/components/schemas/setup_attempt_payment_method_details_acss_debit" }, "amazon_pay": { "$ref": "#/components/schemas/setup_attempt_payment_method_details_amazon_pay" }, "au_becs_debit": { "$ref": "#/components/schemas/setup_attempt_payment_method_details_au_becs_debit" }, "bacs_debit": { "$ref": "#/components/schemas/setup_attempt_payment_method_details_bacs_debit" }, "bancontact": { "$ref": "#/components/schemas/setup_attempt_payment_method_details_bancontact" }, "boleto": { "$ref": "#/components/schemas/setup_attempt_payment_method_details_boleto" }, "card": { "$ref": "#/components/schemas/setup_attempt_payment_method_details_card" }, "card_present": { "$ref": "#/components/schemas/setup_attempt_payment_method_details_card_present" }, "cashapp": { "$ref": "#/components/schemas/setup_attempt_payment_method_details_cashapp" }, "ideal": { "$ref": "#/components/schemas/setup_attempt_payment_method_details_ideal" }, "kakao_pay": { "$ref": "#/components/schemas/setup_attempt_payment_method_details_kakao_pay" }, "klarna": { "$ref": "#/components/schemas/setup_attempt_payment_method_details_klarna" }, "kr_card": { "$ref": "#/components/schemas/setup_attempt_payment_method_details_kr_card" }, "link": { "$ref": "#/components/schemas/setup_attempt_payment_method_details_link" }, "naver_pay": { "$ref": "#/components/schemas/setup_attempt_payment_method_details_naver_pay" }, "nz_bank_account": { "$ref": "#/components/schemas/setup_attempt_payment_method_details_nz_bank_account" }, "paypal": { "$ref": "#/components/schemas/setup_attempt_payment_method_details_paypal" }, "revolut_pay": { "$ref": "#/components/schemas/setup_attempt_payment_method_details_revolut_pay" }, "sepa_debit": { "$ref": "#/components/schemas/setup_attempt_payment_method_details_sepa_debit" }, "sofort": { "$ref": "#/components/schemas/setup_attempt_payment_method_details_sofort" }, "type": { "description": "The type of the payment method used in the SetupIntent (e.g., `card`). An additional hash is included on `payment_method_details` with a name matching this value. It contains confirmation-specific information for the payment method.", "maxLength": 5000, "type": "string" }, "us_bank_account": { "$ref": "#/components/schemas/setup_attempt_payment_method_details_us_bank_account" } }, "required": [ "type" ], "title": "SetupAttemptPaymentMethodDetails", "type": "object", "x-expandableFields": [ "acss_debit", "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", "boleto", "card", "card_present", "cashapp", "ideal", "kakao_pay", "klarna", "kr_card", "link", "naver_pay", "nz_bank_account", "paypal", "revolut_pay", "sepa_debit", "sofort", "us_bank_account" ] }, "setup_attempt_payment_method_details_acss_debit": { "description": "", "properties": {}, "title": "setup_attempt_payment_method_details_acss_debit", "type": "object", "x-expandableFields": [] }, "setup_attempt_payment_method_details_amazon_pay": { "description": "", "properties": {}, "title": "setup_attempt_payment_method_details_amazon_pay", "type": "object", "x-expandableFields": [] }, "setup_attempt_payment_method_details_au_becs_debit": { "description": "", "properties": {}, "title": "setup_attempt_payment_method_details_au_becs_debit", "type": "object", "x-expandableFields": [] }, "setup_attempt_payment_method_details_bacs_debit": { "description": "", "properties": {}, "title": "setup_attempt_payment_method_details_bacs_debit", "type": "object", "x-expandableFields": [] }, "setup_attempt_payment_method_details_bancontact": { "description": "", "properties": { "bank_code": { "description": "Bank code of bank associated with the bank account.", "maxLength": 5000, "nullable": true, "type": "string" }, "bank_name": { "description": "Name of the bank associated with the bank account.", "maxLength": 5000, "nullable": true, "type": "string" }, "bic": { "description": "Bank Identifier Code of the bank associated with the bank account.", "maxLength": 5000, "nullable": true, "type": "string" }, "generated_sepa_debit": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/payment_method" } ], "description": "The ID of the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/payment_method" } ] } }, "generated_sepa_debit_mandate": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/mandate" } ], "description": "The mandate for the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/mandate" } ] } }, "iban_last4": { "description": "Last four characters of the IBAN.", "maxLength": 5000, "nullable": true, "type": "string" }, "preferred_language": { "description": "Preferred language of the Bancontact authorization page that the customer is redirected to.\nCan be one of `en`, `de`, `fr`, or `nl`", "enum": [ "de", "en", "fr", "nl" ], "nullable": true, "type": "string" }, "verified_name": { "description": "Owner's verified full name. Values are verified or provided by Bancontact directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "setup_attempt_payment_method_details_bancontact", "type": "object", "x-expandableFields": [ "generated_sepa_debit", "generated_sepa_debit_mandate" ] }, "setup_attempt_payment_method_details_boleto": { "description": "", "properties": {}, "title": "setup_attempt_payment_method_details_boleto", "type": "object", "x-expandableFields": [] }, "setup_attempt_payment_method_details_card": { "description": "", "properties": { "brand": { "description": "Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`.", "maxLength": 5000, "nullable": true, "type": "string" }, "checks": { "anyOf": [ { "$ref": "#/components/schemas/setup_attempt_payment_method_details_card_checks" } ], "description": "Check results by Card networks on Card address and CVC at the time of authorization", "nullable": true }, "country": { "description": "Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.", "maxLength": 5000, "nullable": true, "type": "string" }, "exp_month": { "description": "Two-digit number representing the card's expiration month.", "nullable": true, "type": "integer" }, "exp_year": { "description": "Four-digit number representing the card's expiration year.", "nullable": true, "type": "integer" }, "fingerprint": { "description": "Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.\n\n*As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*", "maxLength": 5000, "nullable": true, "type": "string" }, "funding": { "description": "Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.", "maxLength": 5000, "nullable": true, "type": "string" }, "last4": { "description": "The last four digits of the card.", "maxLength": 5000, "nullable": true, "type": "string" }, "network": { "description": "Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.", "maxLength": 5000, "nullable": true, "type": "string" }, "three_d_secure": { "anyOf": [ { "$ref": "#/components/schemas/three_d_secure_details" } ], "description": "Populated if this authorization used 3D Secure authentication.", "nullable": true }, "wallet": { "anyOf": [ { "$ref": "#/components/schemas/setup_attempt_payment_method_details_card_wallet" } ], "description": "If this Card is part of a card wallet, this contains the details of the card wallet.", "nullable": true } }, "title": "setup_attempt_payment_method_details_card", "type": "object", "x-expandableFields": [ "checks", "three_d_secure", "wallet" ] }, "setup_attempt_payment_method_details_card_checks": { "description": "", "properties": { "address_line1_check": { "description": "If a address line1 was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.", "maxLength": 5000, "nullable": true, "type": "string" }, "address_postal_code_check": { "description": "If a address postal code was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.", "maxLength": 5000, "nullable": true, "type": "string" }, "cvc_check": { "description": "If a CVC was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "setup_attempt_payment_method_details_card_checks", "type": "object", "x-expandableFields": [] }, "setup_attempt_payment_method_details_card_present": { "description": "", "properties": { "generated_card": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/payment_method" } ], "description": "The ID of the Card PaymentMethod which was generated by this SetupAttempt.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/payment_method" } ] } }, "offline": { "anyOf": [ { "$ref": "#/components/schemas/payment_method_details_card_present_offline" } ], "description": "Details about payments collected offline.", "nullable": true } }, "title": "setup_attempt_payment_method_details_card_present", "type": "object", "x-expandableFields": [ "generated_card", "offline" ] }, "setup_attempt_payment_method_details_card_wallet": { "description": "", "properties": { "apple_pay": { "$ref": "#/components/schemas/payment_method_details_card_wallet_apple_pay" }, "google_pay": { "$ref": "#/components/schemas/payment_method_details_card_wallet_google_pay" }, "type": { "description": "The type of the card wallet, one of `apple_pay`, `google_pay`, or `link`. An additional hash is included on the Wallet subhash with a name matching this value. It contains additional information specific to the card wallet type.", "enum": [ "apple_pay", "google_pay", "link" ], "type": "string" } }, "required": [ "type" ], "title": "setup_attempt_payment_method_details_card_wallet", "type": "object", "x-expandableFields": [ "apple_pay", "google_pay" ] }, "setup_attempt_payment_method_details_cashapp": { "description": "", "properties": {}, "title": "setup_attempt_payment_method_details_cashapp", "type": "object", "x-expandableFields": [] }, "setup_attempt_payment_method_details_ideal": { "description": "", "properties": { "bank": { "description": "The customer's bank. Can be one of `abn_amro`, `asn_bank`, `bunq`, `buut`, `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`.", "enum": [ "abn_amro", "asn_bank", "bunq", "buut", "handelsbanken", "ing", "knab", "moneyou", "n26", "nn", "rabobank", "regiobank", "revolut", "sns_bank", "triodos_bank", "van_lanschot", "yoursafe" ], "nullable": true, "type": "string" }, "bic": { "description": "The Bank Identifier Code of the customer's bank.", "enum": [ "ABNANL2A", "ASNBNL21", "BITSNL2A", "BUNQNL2A", "BUUTNL2A", "FVLBNL22", "HANDNL2A", "INGBNL2A", "KNABNL2H", "MOYONL21", "NNBANL2G", "NTSBDEB1", "RABONL2U", "RBRBNL21", "REVOIE23", "REVOLT21", "SNSBNL2A", "TRIONL2U" ], "nullable": true, "type": "string" }, "generated_sepa_debit": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/payment_method" } ], "description": "The ID of the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/payment_method" } ] } }, "generated_sepa_debit_mandate": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/mandate" } ], "description": "The mandate for the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/mandate" } ] } }, "iban_last4": { "description": "Last four characters of the IBAN.", "maxLength": 5000, "nullable": true, "type": "string" }, "verified_name": { "description": "Owner's verified full name. Values are verified or provided by iDEAL directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "setup_attempt_payment_method_details_ideal", "type": "object", "x-expandableFields": [ "generated_sepa_debit", "generated_sepa_debit_mandate" ] }, "setup_attempt_payment_method_details_kakao_pay": { "description": "", "properties": {}, "title": "setup_attempt_payment_method_details_kakao_pay", "type": "object", "x-expandableFields": [] }, "setup_attempt_payment_method_details_klarna": { "description": "", "properties": {}, "title": "setup_attempt_payment_method_details_klarna", "type": "object", "x-expandableFields": [] }, "setup_attempt_payment_method_details_kr_card": { "description": "", "properties": {}, "title": "setup_attempt_payment_method_details_kr_card", "type": "object", "x-expandableFields": [] }, "setup_attempt_payment_method_details_link": { "description": "", "properties": {}, "title": "setup_attempt_payment_method_details_link", "type": "object", "x-expandableFields": [] }, "setup_attempt_payment_method_details_naver_pay": { "description": "", "properties": { "buyer_id": { "description": "Uniquely identifies this particular Naver Pay account. You can use this attribute to check whether two Naver Pay accounts are the same.", "maxLength": 5000, "type": "string" } }, "title": "setup_attempt_payment_method_details_naver_pay", "type": "object", "x-expandableFields": [] }, "setup_attempt_payment_method_details_nz_bank_account": { "description": "", "properties": {}, "title": "setup_attempt_payment_method_details_nz_bank_account", "type": "object", "x-expandableFields": [] }, "setup_attempt_payment_method_details_paypal": { "description": "", "properties": {}, "title": "setup_attempt_payment_method_details_paypal", "type": "object", "x-expandableFields": [] }, "setup_attempt_payment_method_details_revolut_pay": { "description": "", "properties": {}, "title": "setup_attempt_payment_method_details_revolut_pay", "type": "object", "x-expandableFields": [] }, "setup_attempt_payment_method_details_sepa_debit": { "description": "", "properties": {}, "title": "setup_attempt_payment_method_details_sepa_debit", "type": "object", "x-expandableFields": [] }, "setup_attempt_payment_method_details_sofort": { "description": "", "properties": { "bank_code": { "description": "Bank code of bank associated with the bank account.", "maxLength": 5000, "nullable": true, "type": "string" }, "bank_name": { "description": "Name of the bank associated with the bank account.", "maxLength": 5000, "nullable": true, "type": "string" }, "bic": { "description": "Bank Identifier Code of the bank associated with the bank account.", "maxLength": 5000, "nullable": true, "type": "string" }, "generated_sepa_debit": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/payment_method" } ], "description": "The ID of the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/payment_method" } ] } }, "generated_sepa_debit_mandate": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/mandate" } ], "description": "The mandate for the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/mandate" } ] } }, "iban_last4": { "description": "Last four characters of the IBAN.", "maxLength": 5000, "nullable": true, "type": "string" }, "preferred_language": { "description": "Preferred language of the Sofort authorization page that the customer is redirected to.\nCan be one of `en`, `de`, `fr`, or `nl`", "enum": [ "de", "en", "fr", "nl" ], "nullable": true, "type": "string" }, "verified_name": { "description": "Owner's verified full name. Values are verified or provided by Sofort directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "setup_attempt_payment_method_details_sofort", "type": "object", "x-expandableFields": [ "generated_sepa_debit", "generated_sepa_debit_mandate" ] }, "setup_attempt_payment_method_details_us_bank_account": { "description": "", "properties": {}, "title": "setup_attempt_payment_method_details_us_bank_account", "type": "object", "x-expandableFields": [] }, "setup_intent": { "description": "A SetupIntent guides you through the process of setting up and saving a customer's payment credentials for future payments.\nFor example, you can use a SetupIntent to set up and save your customer's card without immediately collecting a payment.\nLater, you can use [PaymentIntents](https://stripe.com/docs/api#payment_intents) to drive the payment flow.\n\nCreate a SetupIntent when you're ready to collect your customer's payment credentials.\nDon't maintain long-lived, unconfirmed SetupIntents because they might not be valid.\nThe SetupIntent transitions through multiple [statuses](https://docs.stripe.com/payments/intents#intent-statuses) as it guides\nyou through the setup process.\n\nSuccessful SetupIntents result in payment credentials that are optimized for future payments.\nFor example, cardholders in [certain regions](https://stripe.com/guides/strong-customer-authentication) might need to be run through\n[Strong Customer Authentication](https://docs.stripe.com/strong-customer-authentication) during payment method collection\nto streamline later [off-session payments](https://docs.stripe.com/payments/setup-intents).\nIf you use the SetupIntent with a [Customer](https://stripe.com/docs/api#setup_intent_object-customer),\nit automatically attaches the resulting payment method to that Customer after successful setup.\nWe recommend using SetupIntents or [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) on\nPaymentIntents to save payment methods to prevent saving invalid or unoptimized payment methods.\n\nBy using SetupIntents, you can reduce friction for your customers, even as regulations change over time.\n\nRelated guide: [Setup Intents API](https://docs.stripe.com/payments/setup-intents)", "properties": { "application": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/application" } ], "description": "ID of the Connect application that created the SetupIntent.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/application" } ] } }, "attach_to_self": { "description": "If present, the SetupIntent's payment method will be attached to the in-context Stripe Account.\n\nIt can only be used for this Stripe Account’s own money movement flows like InboundTransfer and OutboundTransfers. It cannot be set to true when setting up a PaymentMethod for a Customer, and defaults to false when attaching a PaymentMethod to a Customer.", "type": "boolean" }, "automatic_payment_methods": { "anyOf": [ { "$ref": "#/components/schemas/payment_flows_automatic_payment_methods_setup_intent" } ], "description": "Settings for dynamic payment methods compatible with this Setup Intent", "nullable": true }, "cancellation_reason": { "description": "Reason for cancellation of this SetupIntent, one of `abandoned`, `requested_by_customer`, or `duplicate`.", "enum": [ "abandoned", "duplicate", "requested_by_customer" ], "nullable": true, "type": "string" }, "client_secret": { "description": "The client secret of this SetupIntent. Used for client-side retrieval using a publishable key.\n\nThe client secret can be used to complete payment setup from your frontend. It should not be stored, logged, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret.", "maxLength": 5000, "nullable": true, "type": "string" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "customer": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/customer" }, { "$ref": "#/components/schemas/deleted_customer" } ], "description": "ID of the Customer this SetupIntent belongs to, if one exists.\n\nIf present, the SetupIntent's payment method will be attached to the Customer on successful setup. Payment methods attached to other Customers cannot be used with this SetupIntent.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/customer" }, { "$ref": "#/components/schemas/deleted_customer" } ] } }, "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users.", "maxLength": 5000, "nullable": true, "type": "string" }, "flow_directions": { "description": "Indicates the directions of money movement for which this payment method is intended to be used.\n\nInclude `inbound` if you intend to use the payment method as the origin to pull funds from. Include `outbound` if you intend to use the payment method as the destination to send funds to. You can include both if you intend to use the payment method for both purposes.", "items": { "enum": [ "inbound", "outbound" ], "type": "string" }, "nullable": true, "type": "array" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "last_setup_error": { "anyOf": [ { "$ref": "#/components/schemas/api_errors" } ], "description": "The error encountered in the previous SetupIntent confirmation.", "nullable": true }, "latest_attempt": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/setup_attempt" } ], "description": "The most recent SetupAttempt for this SetupIntent.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/setup_attempt" } ] } }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "mandate": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/mandate" } ], "description": "ID of the multi use Mandate generated by the SetupIntent.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/mandate" } ] } }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "nullable": true, "type": "object" }, "next_action": { "anyOf": [ { "$ref": "#/components/schemas/setup_intent_next_action" } ], "description": "If present, this property tells you what actions you need to take in order for your customer to continue payment setup.", "nullable": true }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "setup_intent" ], "type": "string" }, "on_behalf_of": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/account" } ], "description": "The account (if any) for which the setup is intended.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/account" } ] } }, "payment_method": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/payment_method" } ], "description": "ID of the payment method used with this SetupIntent. If the payment method is `card_present` and isn't a digital wallet, then the [generated_card](https://docs.stripe.com/api/setup_attempts/object#setup_attempt_object-payment_method_details-card_present-generated_card) associated with the `latest_attempt` is attached to the Customer instead.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/payment_method" } ] } }, "payment_method_configuration_details": { "anyOf": [ { "$ref": "#/components/schemas/payment_method_config_biz_payment_method_configuration_details" } ], "description": "Information about the [payment method configuration](https://stripe.com/docs/api/payment_method_configurations) used for this Setup Intent.", "nullable": true }, "payment_method_options": { "anyOf": [ { "$ref": "#/components/schemas/setup_intent_payment_method_options" } ], "description": "Payment method-specific configuration for this SetupIntent.", "nullable": true }, "payment_method_types": { "description": "The list of payment method types (e.g. card) that this SetupIntent is allowed to set up. A list of valid payment method types can be found [here](https://docs.stripe.com/api/payment_methods/object#payment_method_object-type).", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "single_use_mandate": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/mandate" } ], "description": "ID of the single_use Mandate generated by the SetupIntent.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/mandate" } ] } }, "status": { "description": "[Status](https://stripe.com/docs/payments/intents#intent-statuses) of this SetupIntent, one of `requires_payment_method`, `requires_confirmation`, `requires_action`, `processing`, `canceled`, or `succeeded`.", "enum": [ "canceled", "processing", "requires_action", "requires_confirmation", "requires_payment_method", "succeeded" ], "type": "string" }, "usage": { "description": "Indicates how the payment method is intended to be used in the future.\n\nUse `on_session` if you intend to only reuse the payment method when the customer is in your checkout flow. Use `off_session` if your customer may or may not be in your checkout flow. If not provided, this value defaults to `off_session`.", "maxLength": 5000, "type": "string" } }, "required": [ "created", "id", "livemode", "object", "payment_method_types", "status", "usage" ], "title": "SetupIntent", "type": "object", "x-expandableFields": [ "application", "automatic_payment_methods", "customer", "last_setup_error", "latest_attempt", "mandate", "next_action", "on_behalf_of", "payment_method", "payment_method_configuration_details", "payment_method_options", "single_use_mandate" ], "x-resourceId": "setup_intent" }, "setup_intent_next_action": { "description": "", "properties": { "cashapp_handle_redirect_or_display_qr_code": { "$ref": "#/components/schemas/payment_intent_next_action_cashapp_handle_redirect_or_display_qr_code" }, "redirect_to_url": { "$ref": "#/components/schemas/setup_intent_next_action_redirect_to_url" }, "type": { "description": "Type of the next action to perform. Refer to the other child attributes under `next_action` for available values. Examples include: `redirect_to_url`, `use_stripe_sdk`, `alipay_handle_redirect`, `oxxo_display_details`, or `verify_with_microdeposits`.", "maxLength": 5000, "type": "string" }, "use_stripe_sdk": { "description": "When confirming a SetupIntent with Stripe.js, Stripe.js depends on the contents of this dictionary to invoke authentication flows. The shape of the contents is subject to change and is only intended to be used by Stripe.js.", "type": "object" }, "verify_with_microdeposits": { "$ref": "#/components/schemas/setup_intent_next_action_verify_with_microdeposits" } }, "required": [ "type" ], "title": "SetupIntentNextAction", "type": "object", "x-expandableFields": [ "cashapp_handle_redirect_or_display_qr_code", "redirect_to_url", "verify_with_microdeposits" ] }, "setup_intent_next_action_redirect_to_url": { "description": "", "properties": { "return_url": { "description": "If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion.", "maxLength": 5000, "nullable": true, "type": "string" }, "url": { "description": "The URL you must redirect your customer to in order to authenticate.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "SetupIntentNextActionRedirectToUrl", "type": "object", "x-expandableFields": [] }, "setup_intent_next_action_verify_with_microdeposits": { "description": "", "properties": { "arrival_date": { "description": "The timestamp when the microdeposits are expected to land.", "format": "unix-time", "type": "integer" }, "hosted_verification_url": { "description": "The URL for the hosted verification page, which allows customers to verify their bank account.", "maxLength": 5000, "type": "string" }, "microdeposit_type": { "description": "The type of the microdeposit sent to the customer. Used to distinguish between different verification methods.", "enum": [ "amounts", "descriptor_code" ], "nullable": true, "type": "string" } }, "required": [ "arrival_date", "hosted_verification_url" ], "title": "SetupIntentNextActionVerifyWithMicrodeposits", "type": "object", "x-expandableFields": [] }, "setup_intent_payment_method_options": { "description": "", "properties": { "acss_debit": { "anyOf": [ { "$ref": "#/components/schemas/setup_intent_payment_method_options_acss_debit" }, { "$ref": "#/components/schemas/setup_intent_type_specific_payment_method_options_client" } ] }, "amazon_pay": { "anyOf": [ { "$ref": "#/components/schemas/setup_intent_payment_method_options_amazon_pay" }, { "$ref": "#/components/schemas/setup_intent_type_specific_payment_method_options_client" } ] }, "bacs_debit": { "anyOf": [ { "$ref": "#/components/schemas/setup_intent_payment_method_options_bacs_debit" }, { "$ref": "#/components/schemas/setup_intent_type_specific_payment_method_options_client" } ] }, "card": { "anyOf": [ { "$ref": "#/components/schemas/setup_intent_payment_method_options_card" }, { "$ref": "#/components/schemas/setup_intent_type_specific_payment_method_options_client" } ] }, "card_present": { "anyOf": [ { "$ref": "#/components/schemas/setup_intent_payment_method_options_card_present" }, { "$ref": "#/components/schemas/setup_intent_type_specific_payment_method_options_client" } ] }, "klarna": { "anyOf": [ { "$ref": "#/components/schemas/setup_intent_payment_method_options_klarna" }, { "$ref": "#/components/schemas/setup_intent_type_specific_payment_method_options_client" } ] }, "link": { "anyOf": [ { "$ref": "#/components/schemas/setup_intent_payment_method_options_link" }, { "$ref": "#/components/schemas/setup_intent_type_specific_payment_method_options_client" } ] }, "paypal": { "anyOf": [ { "$ref": "#/components/schemas/setup_intent_payment_method_options_paypal" }, { "$ref": "#/components/schemas/setup_intent_type_specific_payment_method_options_client" } ] }, "sepa_debit": { "anyOf": [ { "$ref": "#/components/schemas/setup_intent_payment_method_options_sepa_debit" }, { "$ref": "#/components/schemas/setup_intent_type_specific_payment_method_options_client" } ] }, "us_bank_account": { "anyOf": [ { "$ref": "#/components/schemas/setup_intent_payment_method_options_us_bank_account" }, { "$ref": "#/components/schemas/setup_intent_type_specific_payment_method_options_client" } ] } }, "title": "SetupIntentPaymentMethodOptions", "type": "object", "x-expandableFields": [ "acss_debit", "amazon_pay", "bacs_debit", "card", "card_present", "klarna", "link", "paypal", "sepa_debit", "us_bank_account" ] }, "setup_intent_payment_method_options_acss_debit": { "description": "", "properties": { "currency": { "description": "Currency supported by the bank account", "enum": [ "cad", "usd" ], "nullable": true, "type": "string" }, "mandate_options": { "$ref": "#/components/schemas/setup_intent_payment_method_options_mandate_options_acss_debit" }, "verification_method": { "description": "Bank account verification method.", "enum": [ "automatic", "instant", "microdeposits" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "setup_intent_payment_method_options_acss_debit", "type": "object", "x-expandableFields": [ "mandate_options" ] }, "setup_intent_payment_method_options_amazon_pay": { "description": "", "properties": {}, "title": "setup_intent_payment_method_options_amazon_pay", "type": "object", "x-expandableFields": [] }, "setup_intent_payment_method_options_bacs_debit": { "description": "", "properties": { "mandate_options": { "$ref": "#/components/schemas/setup_intent_payment_method_options_mandate_options_bacs_debit" } }, "title": "setup_intent_payment_method_options_bacs_debit", "type": "object", "x-expandableFields": [ "mandate_options" ] }, "setup_intent_payment_method_options_card": { "description": "", "properties": { "mandate_options": { "anyOf": [ { "$ref": "#/components/schemas/setup_intent_payment_method_options_card_mandate_options" } ], "description": "Configuration options for setting up an eMandate for cards issued in India.", "nullable": true }, "network": { "description": "Selected network to process this SetupIntent on. Depends on the available networks of the card attached to the setup intent. Can be only set confirm-time.", "enum": [ "amex", "cartes_bancaires", "diners", "discover", "eftpos_au", "girocard", "interac", "jcb", "link", "mastercard", "unionpay", "unknown", "visa" ], "nullable": true, "type": "string" }, "request_three_d_secure": { "description": "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.", "enum": [ "any", "automatic", "challenge" ], "nullable": true, "type": "string", "x-stripeBypassValidation": true } }, "title": "setup_intent_payment_method_options_card", "type": "object", "x-expandableFields": [ "mandate_options" ] }, "setup_intent_payment_method_options_card_mandate_options": { "description": "", "properties": { "amount": { "description": "Amount to be charged for future payments.", "type": "integer" }, "amount_type": { "description": "One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.", "enum": [ "fixed", "maximum" ], "type": "string" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "description": { "description": "A description of the mandate or subscription that is meant to be displayed to the customer.", "maxLength": 200, "nullable": true, "type": "string" }, "end_date": { "description": "End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.", "format": "unix-time", "nullable": true, "type": "integer" }, "interval": { "description": "Specifies payment frequency. One of `day`, `week`, `month`, `year`, or `sporadic`.", "enum": [ "day", "month", "sporadic", "week", "year" ], "type": "string" }, "interval_count": { "description": "The number of intervals between payments. For example, `interval=month` and `interval_count=3` indicates one payment every three months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). This parameter is optional when `interval=sporadic`.", "nullable": true, "type": "integer" }, "reference": { "description": "Unique identifier for the mandate or subscription.", "maxLength": 80, "type": "string" }, "start_date": { "description": "Start date of the mandate or subscription. Start date should not be lesser than yesterday.", "format": "unix-time", "type": "integer" }, "supported_types": { "description": "Specifies the type of mandates supported. Possible values are `india`.", "items": { "enum": [ "india" ], "type": "string" }, "nullable": true, "type": "array" } }, "required": [ "amount", "amount_type", "currency", "interval", "reference", "start_date" ], "title": "setup_intent_payment_method_options_card_mandate_options", "type": "object", "x-expandableFields": [] }, "setup_intent_payment_method_options_card_present": { "description": "", "properties": {}, "title": "setup_intent_payment_method_options_card_present", "type": "object", "x-expandableFields": [] }, "setup_intent_payment_method_options_klarna": { "description": "", "properties": { "currency": { "description": "The currency of the setup intent. Three letter ISO currency code.", "format": "currency", "nullable": true, "type": "string" }, "preferred_locale": { "description": "Preferred locale of the Klarna checkout page that the customer is redirected to.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "setup_intent_payment_method_options_klarna", "type": "object", "x-expandableFields": [] }, "setup_intent_payment_method_options_link": { "description": "", "properties": {}, "title": "setup_intent_payment_method_options_link", "type": "object", "x-expandableFields": [] }, "setup_intent_payment_method_options_mandate_options_acss_debit": { "description": "", "properties": { "custom_mandate_url": { "description": "A URL for custom mandate text", "maxLength": 5000, "type": "string" }, "default_for": { "description": "List of Stripe products where this mandate can be selected automatically.", "items": { "enum": [ "invoice", "subscription" ], "type": "string" }, "type": "array" }, "interval_description": { "description": "Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'.", "maxLength": 5000, "nullable": true, "type": "string" }, "payment_schedule": { "description": "Payment schedule for the mandate.", "enum": [ "combined", "interval", "sporadic" ], "nullable": true, "type": "string" }, "transaction_type": { "description": "Transaction type of the mandate.", "enum": [ "business", "personal" ], "nullable": true, "type": "string" } }, "title": "setup_intent_payment_method_options_mandate_options_acss_debit", "type": "object", "x-expandableFields": [] }, "setup_intent_payment_method_options_mandate_options_bacs_debit": { "description": "", "properties": { "reference_prefix": { "description": "Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'.", "maxLength": 5000, "type": "string" } }, "title": "setup_intent_payment_method_options_mandate_options_bacs_debit", "type": "object", "x-expandableFields": [] }, "setup_intent_payment_method_options_mandate_options_sepa_debit": { "description": "", "properties": { "reference_prefix": { "description": "Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'.", "maxLength": 5000, "type": "string" } }, "title": "setup_intent_payment_method_options_mandate_options_sepa_debit", "type": "object", "x-expandableFields": [] }, "setup_intent_payment_method_options_paypal": { "description": "", "properties": { "billing_agreement_id": { "description": "The PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "setup_intent_payment_method_options_paypal", "type": "object", "x-expandableFields": [] }, "setup_intent_payment_method_options_sepa_debit": { "description": "", "properties": { "mandate_options": { "$ref": "#/components/schemas/setup_intent_payment_method_options_mandate_options_sepa_debit" } }, "title": "setup_intent_payment_method_options_sepa_debit", "type": "object", "x-expandableFields": [ "mandate_options" ] }, "setup_intent_payment_method_options_us_bank_account": { "description": "", "properties": { "financial_connections": { "$ref": "#/components/schemas/linked_account_options_common" }, "mandate_options": { "$ref": "#/components/schemas/payment_method_options_us_bank_account_mandate_options" }, "verification_method": { "description": "Bank account verification method.", "enum": [ "automatic", "instant", "microdeposits" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "setup_intent_payment_method_options_us_bank_account", "type": "object", "x-expandableFields": [ "financial_connections", "mandate_options" ] }, "setup_intent_type_specific_payment_method_options_client": { "description": "", "properties": { "verification_method": { "description": "Bank account verification method.", "enum": [ "automatic", "instant", "microdeposits" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "SetupIntentTypeSpecificPaymentMethodOptionsClient", "type": "object", "x-expandableFields": [] }, "shipping": { "description": "", "properties": { "address": { "$ref": "#/components/schemas/address" }, "carrier": { "description": "The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.", "maxLength": 5000, "nullable": true, "type": "string" }, "name": { "description": "Recipient name.", "maxLength": 5000, "type": "string" }, "phone": { "description": "Recipient phone (including extension).", "maxLength": 5000, "nullable": true, "type": "string" }, "tracking_number": { "description": "The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "Shipping", "type": "object", "x-expandableFields": [ "address" ] }, "shipping_rate": { "description": "Shipping rates describe the price of shipping presented to your customers and\napplied to a purchase. For more information, see [Charge for shipping](https://stripe.com/docs/payments/during-payment/charge-shipping).", "properties": { "active": { "description": "Whether the shipping rate can be used for new purchases. Defaults to `true`.", "type": "boolean" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "delivery_estimate": { "anyOf": [ { "$ref": "#/components/schemas/shipping_rate_delivery_estimate" } ], "description": "The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.", "nullable": true }, "display_name": { "description": "The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.", "maxLength": 5000, "nullable": true, "type": "string" }, "fixed_amount": { "$ref": "#/components/schemas/shipping_rate_fixed_amount" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "type": "object" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "shipping_rate" ], "type": "string" }, "tax_behavior": { "description": "Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.", "enum": [ "exclusive", "inclusive", "unspecified" ], "nullable": true, "type": "string" }, "tax_code": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/tax_code" } ], "description": "A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/tax_code" } ] } }, "type": { "description": "The type of calculation to use on the shipping rate.", "enum": [ "fixed_amount" ], "type": "string" } }, "required": [ "active", "created", "id", "livemode", "metadata", "object", "type" ], "title": "ShippingRate", "type": "object", "x-expandableFields": [ "delivery_estimate", "fixed_amount", "tax_code" ], "x-resourceId": "shipping_rate" }, "shipping_rate_currency_option": { "description": "", "properties": { "amount": { "description": "A non-negative integer in cents representing how much to charge.", "type": "integer" }, "tax_behavior": { "description": "Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.", "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" } }, "required": [ "amount", "tax_behavior" ], "title": "ShippingRateCurrencyOption", "type": "object", "x-expandableFields": [] }, "shipping_rate_delivery_estimate": { "description": "", "properties": { "maximum": { "anyOf": [ { "$ref": "#/components/schemas/shipping_rate_delivery_estimate_bound" } ], "description": "The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.", "nullable": true }, "minimum": { "anyOf": [ { "$ref": "#/components/schemas/shipping_rate_delivery_estimate_bound" } ], "description": "The lower bound of the estimated range. If empty, represents no lower bound.", "nullable": true } }, "title": "ShippingRateDeliveryEstimate", "type": "object", "x-expandableFields": [ "maximum", "minimum" ] }, "shipping_rate_delivery_estimate_bound": { "description": "", "properties": { "unit": { "description": "A unit of time.", "enum": [ "business_day", "day", "hour", "month", "week" ], "type": "string" }, "value": { "description": "Must be greater than 0.", "type": "integer" } }, "required": [ "unit", "value" ], "title": "ShippingRateDeliveryEstimateBound", "type": "object", "x-expandableFields": [] }, "shipping_rate_fixed_amount": { "description": "", "properties": { "amount": { "description": "A non-negative integer in cents representing how much to charge.", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "currency_options": { "additionalProperties": { "$ref": "#/components/schemas/shipping_rate_currency_option" }, "description": "Shipping rates defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).", "type": "object" } }, "required": [ "amount", "currency" ], "title": "ShippingRateFixedAmount", "type": "object", "x-expandableFields": [ "currency_options" ] }, "sigma.sigma_api_query": { "description": "A saved query object represents a query that can be executed for a run.", "properties": { "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "type": "integer" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "name": { "description": "The name of the query.", "maxLength": 5000, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "sigma.sigma_api_query" ], "type": "string" }, "sql": { "description": "The sql statement for the query.", "maxLength": 5000, "type": "string" } }, "required": [ "created", "id", "livemode", "name", "object", "sql" ], "title": "SigmaSigmaResourcesSigmaAPIQuery", "type": "object", "x-expandableFields": [], "x-resourceId": "sigma.sigma_api_query" }, "sigma_scheduled_query_run_error": { "description": "", "properties": { "message": { "description": "Information about the run failure.", "maxLength": 5000, "type": "string" } }, "required": [ "message" ], "title": "SigmaScheduledQueryRunError", "type": "object", "x-expandableFields": [] }, "source": { "description": "`Source` objects allow you to accept a variety of payment methods. They\nrepresent a customer's payment instrument, and can be used with the Stripe API\njust like a `Card` object: once chargeable, they can be charged, or can be\nattached to customers.\n\nStripe doesn't recommend using the deprecated [Sources API](https://stripe.com/docs/api/sources).\nWe recommend that you adopt the [PaymentMethods API](https://stripe.com/docs/api/payment_methods).\nThis newer API provides access to our latest features and payment method types.\n\nRelated guides: [Sources API](https://stripe.com/docs/sources) and [Sources & Customers](https://stripe.com/docs/sources/customers).", "properties": { "ach_credit_transfer": { "$ref": "#/components/schemas/source_type_ach_credit_transfer" }, "ach_debit": { "$ref": "#/components/schemas/source_type_ach_debit" }, "acss_debit": { "$ref": "#/components/schemas/source_type_acss_debit" }, "alipay": { "$ref": "#/components/schemas/source_type_alipay" }, "allow_redisplay": { "description": "This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to “unspecified”.", "enum": [ "always", "limited", "unspecified" ], "nullable": true, "type": "string" }, "amount": { "description": "A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount associated with the source. This is the amount for which the source will be chargeable once ready. Required for `single_use` sources.", "nullable": true, "type": "integer" }, "au_becs_debit": { "$ref": "#/components/schemas/source_type_au_becs_debit" }, "bancontact": { "$ref": "#/components/schemas/source_type_bancontact" }, "card": { "$ref": "#/components/schemas/source_type_card" }, "card_present": { "$ref": "#/components/schemas/source_type_card_present" }, "client_secret": { "description": "The client secret of the source. Used for client-side retrieval using a publishable key.", "maxLength": 5000, "type": "string" }, "code_verification": { "$ref": "#/components/schemas/source_code_verification_flow" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "currency": { "description": "Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) associated with the source. This is the currency for which the source will be chargeable once ready. Required for `single_use` sources.", "format": "currency", "nullable": true, "type": "string" }, "customer": { "description": "The ID of the customer to which this source is attached. This will not be present when the source has not been attached to a customer.", "maxLength": 5000, "type": "string" }, "eps": { "$ref": "#/components/schemas/source_type_eps" }, "flow": { "description": "The authentication `flow` of the source. `flow` is one of `redirect`, `receiver`, `code_verification`, `none`.", "maxLength": 5000, "type": "string" }, "giropay": { "$ref": "#/components/schemas/source_type_giropay" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "ideal": { "$ref": "#/components/schemas/source_type_ideal" }, "klarna": { "$ref": "#/components/schemas/source_type_klarna" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "nullable": true, "type": "object" }, "multibanco": { "$ref": "#/components/schemas/source_type_multibanco" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "source" ], "type": "string" }, "owner": { "anyOf": [ { "$ref": "#/components/schemas/source_owner" } ], "description": "Information about the owner of the payment instrument that may be used or required by particular source types.", "nullable": true }, "p24": { "$ref": "#/components/schemas/source_type_p24" }, "receiver": { "$ref": "#/components/schemas/source_receiver_flow" }, "redirect": { "$ref": "#/components/schemas/source_redirect_flow" }, "sepa_debit": { "$ref": "#/components/schemas/source_type_sepa_debit" }, "sofort": { "$ref": "#/components/schemas/source_type_sofort" }, "source_order": { "$ref": "#/components/schemas/source_order" }, "statement_descriptor": { "description": "Extra information about a source. This will appear on your customer's statement every time you charge the source.", "maxLength": 5000, "nullable": true, "type": "string" }, "status": { "description": "The status of the source, one of `canceled`, `chargeable`, `consumed`, `failed`, or `pending`. Only `chargeable` sources can be used to create a charge.", "maxLength": 5000, "type": "string" }, "three_d_secure": { "$ref": "#/components/schemas/source_type_three_d_secure" }, "type": { "description": "The `type` of the source. The `type` is a payment method, one of `ach_credit_transfer`, `ach_debit`, `alipay`, `bancontact`, `card`, `card_present`, `eps`, `giropay`, `ideal`, `multibanco`, `klarna`, `p24`, `sepa_debit`, `sofort`, `three_d_secure`, or `wechat`. An additional hash is included on the source with a name matching this value. It contains additional information specific to the [payment method](https://stripe.com/docs/sources) used.", "enum": [ "ach_credit_transfer", "ach_debit", "acss_debit", "alipay", "au_becs_debit", "bancontact", "card", "card_present", "eps", "giropay", "ideal", "klarna", "multibanco", "p24", "sepa_debit", "sofort", "three_d_secure", "wechat" ], "type": "string", "x-stripeBypassValidation": true }, "usage": { "description": "Either `reusable` or `single_use`. Whether this source should be reusable or not. Some source types may or may not be reusable by construction, while others may leave the option at creation. If an incompatible value is passed, an error will be returned.", "maxLength": 5000, "nullable": true, "type": "string" }, "wechat": { "$ref": "#/components/schemas/source_type_wechat" } }, "required": [ "client_secret", "created", "flow", "id", "livemode", "object", "status", "type" ], "title": "Source", "type": "object", "x-expandableFields": [ "code_verification", "owner", "receiver", "redirect", "source_order" ], "x-resourceId": "source" }, "source_code_verification_flow": { "description": "", "properties": { "attempts_remaining": { "description": "The number of attempts remaining to authenticate the source object with a verification code.", "type": "integer" }, "status": { "description": "The status of the code verification, either `pending` (awaiting verification, `attempts_remaining` should be greater than 0), `succeeded` (successful verification) or `failed` (failed verification, cannot be verified anymore as `attempts_remaining` should be 0).", "maxLength": 5000, "type": "string" } }, "required": [ "attempts_remaining", "status" ], "title": "SourceCodeVerificationFlow", "type": "object", "x-expandableFields": [] }, "source_mandate_notification": { "description": "Source mandate notifications should be created when a notification related to\na source mandate must be sent to the payer. They will trigger a webhook or\ndeliver an email to the customer.", "properties": { "acss_debit": { "$ref": "#/components/schemas/source_mandate_notification_acss_debit_data" }, "amount": { "description": "A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the amount associated with the mandate notification. The amount is expressed in the currency of the underlying source. Required if the notification type is `debit_initiated`.", "nullable": true, "type": "integer" }, "bacs_debit": { "$ref": "#/components/schemas/source_mandate_notification_bacs_debit_data" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "source_mandate_notification" ], "type": "string" }, "reason": { "description": "The reason of the mandate notification. Valid reasons are `mandate_confirmed` or `debit_initiated`.", "maxLength": 5000, "type": "string" }, "sepa_debit": { "$ref": "#/components/schemas/source_mandate_notification_sepa_debit_data" }, "source": { "$ref": "#/components/schemas/source" }, "status": { "description": "The status of the mandate notification. Valid statuses are `pending` or `submitted`.", "maxLength": 5000, "type": "string" }, "type": { "description": "The type of source this mandate notification is attached to. Should be the source type identifier code for the payment method, such as `three_d_secure`.", "maxLength": 5000, "type": "string" } }, "required": [ "created", "id", "livemode", "object", "reason", "source", "status", "type" ], "title": "SourceMandateNotification", "type": "object", "x-expandableFields": [ "acss_debit", "bacs_debit", "sepa_debit", "source" ], "x-resourceId": "source_mandate_notification" }, "source_mandate_notification_acss_debit_data": { "description": "", "properties": { "statement_descriptor": { "description": "The statement descriptor associate with the debit.", "maxLength": 5000, "type": "string" } }, "title": "SourceMandateNotificationAcssDebitData", "type": "object", "x-expandableFields": [] }, "source_mandate_notification_bacs_debit_data": { "description": "", "properties": { "last4": { "description": "Last 4 digits of the account number associated with the debit.", "maxLength": 5000, "type": "string" } }, "title": "SourceMandateNotificationBacsDebitData", "type": "object", "x-expandableFields": [] }, "source_mandate_notification_sepa_debit_data": { "description": "", "properties": { "creditor_identifier": { "description": "SEPA creditor ID.", "maxLength": 5000, "type": "string" }, "last4": { "description": "Last 4 digits of the account number associated with the debit.", "maxLength": 5000, "type": "string" }, "mandate_reference": { "description": "Mandate reference associated with the debit.", "maxLength": 5000, "type": "string" } }, "title": "SourceMandateNotificationSepaDebitData", "type": "object", "x-expandableFields": [] }, "source_order": { "description": "", "properties": { "amount": { "description": "A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount for the order.", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "email": { "description": "The email address of the customer placing the order.", "maxLength": 5000, "type": "string" }, "items": { "description": "List of items constituting the order.", "items": { "$ref": "#/components/schemas/source_order_item" }, "nullable": true, "type": "array" }, "shipping": { "$ref": "#/components/schemas/shipping" } }, "required": [ "amount", "currency" ], "title": "SourceOrder", "type": "object", "x-expandableFields": [ "items", "shipping" ] }, "source_order_item": { "description": "", "properties": { "amount": { "description": "The amount (price) for this order item.", "nullable": true, "type": "integer" }, "currency": { "description": "This currency of this order item. Required when `amount` is present.", "maxLength": 5000, "nullable": true, "type": "string" }, "description": { "description": "Human-readable description for this order item.", "maxLength": 5000, "nullable": true, "type": "string" }, "parent": { "description": "The ID of the associated object for this line item. Expandable if not null (e.g., expandable to a SKU).", "maxLength": 5000, "nullable": true, "type": "string" }, "quantity": { "description": "The quantity of this order item. When type is `sku`, this is the number of instances of the SKU to be ordered.", "type": "integer" }, "type": { "description": "The type of this order item. Must be `sku`, `tax`, or `shipping`.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "SourceOrderItem", "type": "object", "x-expandableFields": [] }, "source_owner": { "description": "", "properties": { "address": { "anyOf": [ { "$ref": "#/components/schemas/address" } ], "description": "Owner's address.", "nullable": true }, "email": { "description": "Owner's email address.", "maxLength": 5000, "nullable": true, "type": "string" }, "name": { "description": "Owner's full name.", "maxLength": 5000, "nullable": true, "type": "string" }, "phone": { "description": "Owner's phone number (including extension).", "maxLength": 5000, "nullable": true, "type": "string" }, "verified_address": { "anyOf": [ { "$ref": "#/components/schemas/address" } ], "description": "Verified owner's address. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated.", "nullable": true }, "verified_email": { "description": "Verified owner's email address. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated.", "maxLength": 5000, "nullable": true, "type": "string" }, "verified_name": { "description": "Verified owner's full name. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated.", "maxLength": 5000, "nullable": true, "type": "string" }, "verified_phone": { "description": "Verified owner's phone number (including extension). Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "SourceOwner", "type": "object", "x-expandableFields": [ "address", "verified_address" ] }, "source_receiver_flow": { "description": "", "properties": { "address": { "description": "The address of the receiver source. This is the value that should be communicated to the customer to send their funds to.", "maxLength": 5000, "nullable": true, "type": "string" }, "amount_charged": { "description": "The total amount that was moved to your balance. This is almost always equal to the amount charged. In rare cases when customers deposit excess funds and we are unable to refund those, those funds get moved to your balance and show up in amount_charged as well. The amount charged is expressed in the source's currency.", "type": "integer" }, "amount_received": { "description": "The total amount received by the receiver source. `amount_received = amount_returned + amount_charged` should be true for consumed sources unless customers deposit excess funds. The amount received is expressed in the source's currency.", "type": "integer" }, "amount_returned": { "description": "The total amount that was returned to the customer. The amount returned is expressed in the source's currency.", "type": "integer" }, "refund_attributes_method": { "description": "Type of refund attribute method, one of `email`, `manual`, or `none`.", "maxLength": 5000, "type": "string" }, "refund_attributes_status": { "description": "Type of refund attribute status, one of `missing`, `requested`, or `available`.", "maxLength": 5000, "type": "string" } }, "required": [ "amount_charged", "amount_received", "amount_returned", "refund_attributes_method", "refund_attributes_status" ], "title": "SourceReceiverFlow", "type": "object", "x-expandableFields": [] }, "source_redirect_flow": { "description": "", "properties": { "failure_reason": { "description": "The failure reason for the redirect, either `user_abort` (the customer aborted or dropped out of the redirect flow), `declined` (the authentication failed or the transaction was declined), or `processing_error` (the redirect failed due to a technical error). Present only if the redirect status is `failed`.", "maxLength": 5000, "nullable": true, "type": "string" }, "return_url": { "description": "The URL you provide to redirect the customer to after they authenticated their payment.", "maxLength": 5000, "type": "string" }, "status": { "description": "The status of the redirect, either `pending` (ready to be used by your customer to authenticate the transaction), `succeeded` (succesful authentication, cannot be reused) or `not_required` (redirect should not be used) or `failed` (failed authentication, cannot be reused).", "maxLength": 5000, "type": "string" }, "url": { "description": "The URL provided to you to redirect a customer to as part of a `redirect` authentication flow.", "maxLength": 2048, "type": "string" } }, "required": [ "return_url", "status", "url" ], "title": "SourceRedirectFlow", "type": "object", "x-expandableFields": [] }, "source_transaction": { "description": "Some payment methods have no required amount that a customer must send.\nCustomers can be instructed to send any amount, and it can be made up of\nmultiple transactions. As such, sources can have multiple associated\ntransactions.", "properties": { "ach_credit_transfer": { "$ref": "#/components/schemas/source_transaction_ach_credit_transfer_data" }, "amount": { "description": "A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the amount your customer has pushed to the receiver.", "type": "integer" }, "chf_credit_transfer": { "$ref": "#/components/schemas/source_transaction_chf_credit_transfer_data" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "gbp_credit_transfer": { "$ref": "#/components/schemas/source_transaction_gbp_credit_transfer_data" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "source_transaction" ], "type": "string" }, "paper_check": { "$ref": "#/components/schemas/source_transaction_paper_check_data" }, "sepa_credit_transfer": { "$ref": "#/components/schemas/source_transaction_sepa_credit_transfer_data" }, "source": { "description": "The ID of the source this transaction is attached to.", "maxLength": 5000, "type": "string" }, "status": { "description": "The status of the transaction, one of `succeeded`, `pending`, or `failed`.", "maxLength": 5000, "type": "string" }, "type": { "description": "The type of source this transaction is attached to.", "enum": [ "ach_credit_transfer", "ach_debit", "alipay", "bancontact", "card", "card_present", "eps", "giropay", "ideal", "klarna", "multibanco", "p24", "sepa_debit", "sofort", "three_d_secure", "wechat" ], "type": "string" } }, "required": [ "amount", "created", "currency", "id", "livemode", "object", "source", "status", "type" ], "title": "SourceTransaction", "type": "object", "x-expandableFields": [ "ach_credit_transfer", "chf_credit_transfer", "gbp_credit_transfer", "paper_check", "sepa_credit_transfer" ], "x-resourceId": "source_transaction" }, "source_transaction_ach_credit_transfer_data": { "description": "", "properties": { "customer_data": { "description": "Customer data associated with the transfer.", "maxLength": 5000, "type": "string" }, "fingerprint": { "description": "Bank account fingerprint associated with the transfer.", "maxLength": 5000, "type": "string" }, "last4": { "description": "Last 4 digits of the account number associated with the transfer.", "maxLength": 5000, "type": "string" }, "routing_number": { "description": "Routing number associated with the transfer.", "maxLength": 5000, "type": "string" } }, "title": "SourceTransactionAchCreditTransferData", "type": "object", "x-expandableFields": [] }, "source_transaction_chf_credit_transfer_data": { "description": "", "properties": { "reference": { "description": "Reference associated with the transfer.", "maxLength": 5000, "type": "string" }, "sender_address_country": { "description": "Sender's country address.", "maxLength": 5000, "type": "string" }, "sender_address_line1": { "description": "Sender's line 1 address.", "maxLength": 5000, "type": "string" }, "sender_iban": { "description": "Sender's bank account IBAN.", "maxLength": 5000, "type": "string" }, "sender_name": { "description": "Sender's name.", "maxLength": 5000, "type": "string" } }, "title": "SourceTransactionChfCreditTransferData", "type": "object", "x-expandableFields": [] }, "source_transaction_gbp_credit_transfer_data": { "description": "", "properties": { "fingerprint": { "description": "Bank account fingerprint associated with the Stripe owned bank account receiving the transfer.", "maxLength": 5000, "type": "string" }, "funding_method": { "description": "The credit transfer rails the sender used to push this transfer. The possible rails are: Faster Payments, BACS, CHAPS, and wire transfers. Currently only Faster Payments is supported.", "maxLength": 5000, "type": "string" }, "last4": { "description": "Last 4 digits of sender account number associated with the transfer.", "maxLength": 5000, "type": "string" }, "reference": { "description": "Sender entered arbitrary information about the transfer.", "maxLength": 5000, "type": "string" }, "sender_account_number": { "description": "Sender account number associated with the transfer.", "maxLength": 5000, "type": "string" }, "sender_name": { "description": "Sender name associated with the transfer.", "maxLength": 5000, "type": "string" }, "sender_sort_code": { "description": "Sender sort code associated with the transfer.", "maxLength": 5000, "type": "string" } }, "title": "SourceTransactionGbpCreditTransferData", "type": "object", "x-expandableFields": [] }, "source_transaction_paper_check_data": { "description": "", "properties": { "available_at": { "description": "Time at which the deposited funds will be available for use. Measured in seconds since the Unix epoch.", "maxLength": 5000, "type": "string" }, "invoices": { "description": "Comma-separated list of invoice IDs associated with the paper check.", "maxLength": 5000, "type": "string" } }, "title": "SourceTransactionPaperCheckData", "type": "object", "x-expandableFields": [] }, "source_transaction_sepa_credit_transfer_data": { "description": "", "properties": { "reference": { "description": "Reference associated with the transfer.", "maxLength": 5000, "type": "string" }, "sender_iban": { "description": "Sender's bank account IBAN.", "maxLength": 5000, "type": "string" }, "sender_name": { "description": "Sender's name.", "maxLength": 5000, "type": "string" } }, "title": "SourceTransactionSepaCreditTransferData", "type": "object", "x-expandableFields": [] }, "source_type_ach_credit_transfer": { "properties": { "account_number": { "nullable": true, "type": "string" }, "bank_name": { "nullable": true, "type": "string" }, "fingerprint": { "nullable": true, "type": "string" }, "refund_account_holder_name": { "nullable": true, "type": "string" }, "refund_account_holder_type": { "nullable": true, "type": "string" }, "refund_routing_number": { "nullable": true, "type": "string" }, "routing_number": { "nullable": true, "type": "string" }, "swift_code": { "nullable": true, "type": "string" } }, "type": "object" }, "source_type_ach_debit": { "properties": { "bank_name": { "nullable": true, "type": "string" }, "country": { "nullable": true, "type": "string" }, "fingerprint": { "nullable": true, "type": "string" }, "last4": { "nullable": true, "type": "string" }, "routing_number": { "nullable": true, "type": "string" }, "type": { "nullable": true, "type": "string" } }, "type": "object" }, "source_type_acss_debit": { "properties": { "bank_address_city": { "nullable": true, "type": "string" }, "bank_address_line_1": { "nullable": true, "type": "string" }, "bank_address_line_2": { "nullable": true, "type": "string" }, "bank_address_postal_code": { "nullable": true, "type": "string" }, "bank_name": { "nullable": true, "type": "string" }, "category": { "nullable": true, "type": "string" }, "country": { "nullable": true, "type": "string" }, "fingerprint": { "nullable": true, "type": "string" }, "last4": { "nullable": true, "type": "string" }, "routing_number": { "nullable": true, "type": "string" } }, "type": "object" }, "source_type_alipay": { "properties": { "data_string": { "nullable": true, "type": "string" }, "native_url": { "nullable": true, "type": "string" }, "statement_descriptor": { "nullable": true, "type": "string" } }, "type": "object" }, "source_type_au_becs_debit": { "properties": { "bsb_number": { "nullable": true, "type": "string" }, "fingerprint": { "nullable": true, "type": "string" }, "last4": { "nullable": true, "type": "string" } }, "type": "object" }, "source_type_bancontact": { "properties": { "bank_code": { "nullable": true, "type": "string" }, "bank_name": { "nullable": true, "type": "string" }, "bic": { "nullable": true, "type": "string" }, "iban_last4": { "nullable": true, "type": "string" }, "preferred_language": { "nullable": true, "type": "string" }, "statement_descriptor": { "nullable": true, "type": "string" } }, "type": "object" }, "source_type_card": { "properties": { "address_line1_check": { "nullable": true, "type": "string" }, "address_zip_check": { "nullable": true, "type": "string" }, "brand": { "nullable": true, "type": "string" }, "country": { "nullable": true, "type": "string" }, "cvc_check": { "nullable": true, "type": "string" }, "dynamic_last4": { "nullable": true, "type": "string" }, "exp_month": { "nullable": true, "type": "integer" }, "exp_year": { "nullable": true, "type": "integer" }, "fingerprint": { "type": "string" }, "funding": { "nullable": true, "type": "string" }, "last4": { "nullable": true, "type": "string" }, "name": { "nullable": true, "type": "string" }, "three_d_secure": { "type": "string" }, "tokenization_method": { "nullable": true, "type": "string" } }, "type": "object" }, "source_type_card_present": { "properties": { "application_cryptogram": { "type": "string" }, "application_preferred_name": { "type": "string" }, "authorization_code": { "nullable": true, "type": "string" }, "authorization_response_code": { "type": "string" }, "brand": { "nullable": true, "type": "string" }, "country": { "nullable": true, "type": "string" }, "cvm_type": { "type": "string" }, "data_type": { "nullable": true, "type": "string" }, "dedicated_file_name": { "type": "string" }, "emv_auth_data": { "type": "string" }, "evidence_customer_signature": { "nullable": true, "type": "string" }, "evidence_transaction_certificate": { "nullable": true, "type": "string" }, "exp_month": { "nullable": true, "type": "integer" }, "exp_year": { "nullable": true, "type": "integer" }, "fingerprint": { "type": "string" }, "funding": { "nullable": true, "type": "string" }, "last4": { "nullable": true, "type": "string" }, "pos_device_id": { "nullable": true, "type": "string" }, "pos_entry_mode": { "type": "string" }, "read_method": { "nullable": true, "type": "string" }, "reader": { "nullable": true, "type": "string" }, "terminal_verification_results": { "type": "string" }, "transaction_status_information": { "type": "string" } }, "type": "object" }, "source_type_eps": { "properties": { "reference": { "nullable": true, "type": "string" }, "statement_descriptor": { "nullable": true, "type": "string" } }, "type": "object" }, "source_type_giropay": { "properties": { "bank_code": { "nullable": true, "type": "string" }, "bank_name": { "nullable": true, "type": "string" }, "bic": { "nullable": true, "type": "string" }, "statement_descriptor": { "nullable": true, "type": "string" } }, "type": "object" }, "source_type_ideal": { "properties": { "bank": { "nullable": true, "type": "string" }, "bic": { "nullable": true, "type": "string" }, "iban_last4": { "nullable": true, "type": "string" }, "statement_descriptor": { "nullable": true, "type": "string" } }, "type": "object" }, "source_type_klarna": { "properties": { "background_image_url": { "type": "string" }, "client_token": { "nullable": true, "type": "string" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "locale": { "type": "string" }, "logo_url": { "type": "string" }, "page_title": { "type": "string" }, "pay_later_asset_urls_descriptive": { "type": "string" }, "pay_later_asset_urls_standard": { "type": "string" }, "pay_later_name": { "type": "string" }, "pay_later_redirect_url": { "type": "string" }, "pay_now_asset_urls_descriptive": { "type": "string" }, "pay_now_asset_urls_standard": { "type": "string" }, "pay_now_name": { "type": "string" }, "pay_now_redirect_url": { "type": "string" }, "pay_over_time_asset_urls_descriptive": { "type": "string" }, "pay_over_time_asset_urls_standard": { "type": "string" }, "pay_over_time_name": { "type": "string" }, "pay_over_time_redirect_url": { "type": "string" }, "payment_method_categories": { "type": "string" }, "purchase_country": { "type": "string" }, "purchase_type": { "type": "string" }, "redirect_url": { "type": "string" }, "shipping_delay": { "type": "integer" }, "shipping_first_name": { "type": "string" }, "shipping_last_name": { "type": "string" } }, "type": "object" }, "source_type_multibanco": { "properties": { "entity": { "nullable": true, "type": "string" }, "reference": { "nullable": true, "type": "string" }, "refund_account_holder_address_city": { "nullable": true, "type": "string" }, "refund_account_holder_address_country": { "nullable": true, "type": "string" }, "refund_account_holder_address_line1": { "nullable": true, "type": "string" }, "refund_account_holder_address_line2": { "nullable": true, "type": "string" }, "refund_account_holder_address_postal_code": { "nullable": true, "type": "string" }, "refund_account_holder_address_state": { "nullable": true, "type": "string" }, "refund_account_holder_name": { "nullable": true, "type": "string" }, "refund_iban": { "nullable": true, "type": "string" } }, "type": "object" }, "source_type_p24": { "properties": { "reference": { "nullable": true, "type": "string" } }, "type": "object" }, "source_type_sepa_debit": { "properties": { "bank_code": { "nullable": true, "type": "string" }, "branch_code": { "nullable": true, "type": "string" }, "country": { "nullable": true, "type": "string" }, "fingerprint": { "nullable": true, "type": "string" }, "last4": { "nullable": true, "type": "string" }, "mandate_reference": { "nullable": true, "type": "string" }, "mandate_url": { "nullable": true, "type": "string" } }, "type": "object" }, "source_type_sofort": { "properties": { "bank_code": { "nullable": true, "type": "string" }, "bank_name": { "nullable": true, "type": "string" }, "bic": { "nullable": true, "type": "string" }, "country": { "nullable": true, "type": "string" }, "iban_last4": { "nullable": true, "type": "string" }, "preferred_language": { "nullable": true, "type": "string" }, "statement_descriptor": { "nullable": true, "type": "string" } }, "type": "object" }, "source_type_three_d_secure": { "properties": { "address_line1_check": { "nullable": true, "type": "string" }, "address_zip_check": { "nullable": true, "type": "string" }, "authenticated": { "nullable": true, "type": "boolean" }, "brand": { "nullable": true, "type": "string" }, "card": { "nullable": true, "type": "string" }, "country": { "nullable": true, "type": "string" }, "customer": { "nullable": true, "type": "string" }, "cvc_check": { "nullable": true, "type": "string" }, "dynamic_last4": { "nullable": true, "type": "string" }, "exp_month": { "nullable": true, "type": "integer" }, "exp_year": { "nullable": true, "type": "integer" }, "fingerprint": { "type": "string" }, "funding": { "nullable": true, "type": "string" }, "last4": { "nullable": true, "type": "string" }, "name": { "nullable": true, "type": "string" }, "three_d_secure": { "type": "string" }, "tokenization_method": { "nullable": true, "type": "string" } }, "type": "object" }, "source_type_wechat": { "properties": { "prepay_id": { "type": "string" }, "qr_code_url": { "nullable": true, "type": "string" }, "statement_descriptor": { "type": "string" } }, "type": "object" }, "subscription": { "description": "Subscriptions allow you to charge a customer on a recurring basis.\n\nRelated guide: [Creating subscriptions](https://stripe.com/docs/billing/subscriptions/creating)", "properties": { "application": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/application" }, { "$ref": "#/components/schemas/deleted_application" } ], "description": "ID of the Connect Application that created the subscription.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/application" }, { "$ref": "#/components/schemas/deleted_application" } ] } }, "application_fee_percent": { "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account.", "nullable": true, "type": "number" }, "automatic_tax": { "$ref": "#/components/schemas/subscription_automatic_tax" }, "billing_cycle_anchor": { "description": "The reference point that aligns future [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle) dates. It sets the day of week for `week` intervals, the day of month for `month` and `year` intervals, and the month of year for `year` intervals. The timestamp is in UTC format.", "format": "unix-time", "type": "integer" }, "billing_cycle_anchor_config": { "anyOf": [ { "$ref": "#/components/schemas/subscriptions_resource_billing_cycle_anchor_config" } ], "description": "The fixed values used to calculate the `billing_cycle_anchor`.", "nullable": true }, "billing_mode": { "$ref": "#/components/schemas/subscriptions_resource_billing_mode" }, "billing_thresholds": { "anyOf": [ { "$ref": "#/components/schemas/subscription_billing_thresholds" } ], "description": "Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period", "nullable": true }, "cancel_at": { "description": "A date in the future at which the subscription will automatically get canceled", "format": "unix-time", "nullable": true, "type": "integer" }, "cancel_at_period_end": { "description": "Whether this subscription will (if `status=active`) or did (if `status=canceled`) cancel at the end of the current billing period.", "type": "boolean" }, "canceled_at": { "description": "If the subscription has been canceled, the date of that cancellation. If the subscription was canceled with `cancel_at_period_end`, `canceled_at` will reflect the time of the most recent update request, not the end of the subscription period when the subscription is automatically moved to a canceled state.", "format": "unix-time", "nullable": true, "type": "integer" }, "cancellation_details": { "anyOf": [ { "$ref": "#/components/schemas/cancellation_details" } ], "description": "Details about why this subscription was cancelled", "nullable": true }, "collection_method": { "description": "Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`.", "enum": [ "charge_automatically", "send_invoice" ], "type": "string" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "customer": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/customer" }, { "$ref": "#/components/schemas/deleted_customer" } ], "description": "ID of the customer who owns the subscription.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/customer" }, { "$ref": "#/components/schemas/deleted_customer" } ] } }, "days_until_due": { "description": "Number of days a customer has to pay invoices generated by this subscription. This value will be `null` for subscriptions where `collection_method=charge_automatically`.", "nullable": true, "type": "integer" }, "default_payment_method": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/payment_method" } ], "description": "ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/payment_method" } ] } }, "default_source": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/bank_account" }, { "$ref": "#/components/schemas/card" }, { "$ref": "#/components/schemas/source" } ], "description": "ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/bank_account" }, { "$ref": "#/components/schemas/card" }, { "$ref": "#/components/schemas/source" } ] }, "x-stripeBypassValidation": true }, "default_tax_rates": { "description": "The tax rates that will apply to any subscription item that does not have `tax_rates` set. Invoices created will have their `default_tax_rates` populated from the subscription.", "items": { "$ref": "#/components/schemas/tax_rate" }, "nullable": true, "type": "array" }, "description": { "description": "The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.", "maxLength": 500, "nullable": true, "type": "string" }, "discounts": { "description": "The discounts applied to the subscription. Subscription item discounts are applied before subscription discounts. Use `expand[]=discounts` to expand each discount.", "items": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/discount" } ], "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/discount" } ] } }, "type": "array" }, "ended_at": { "description": "If the subscription has ended, the date the subscription ended.", "format": "unix-time", "nullable": true, "type": "integer" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "invoice_settings": { "$ref": "#/components/schemas/subscriptions_resource_subscription_invoice_settings" }, "items": { "description": "List of subscription items, each with an attached price.", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/subscription_item" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "SubscriptionItemList", "type": "object", "x-expandableFields": [ "data" ] }, "latest_invoice": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/invoice" } ], "description": "The most recent invoice this subscription has generated.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/invoice" } ] } }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "type": "object" }, "next_pending_invoice_item_invoice": { "description": "Specifies the approximate timestamp on which any pending invoice items will be billed according to the schedule provided at `pending_invoice_item_interval`.", "format": "unix-time", "nullable": true, "type": "integer" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "subscription" ], "type": "string" }, "on_behalf_of": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/account" } ], "description": "The account (if any) the charge was made on behalf of for charges associated with this subscription. See the [Connect documentation](https://stripe.com/docs/connect/subscriptions#on-behalf-of) for details.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/account" } ] } }, "pause_collection": { "anyOf": [ { "$ref": "#/components/schemas/subscriptions_resource_pause_collection" } ], "description": "If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://stripe.com/docs/billing/subscriptions/pause-payment).", "nullable": true }, "payment_settings": { "anyOf": [ { "$ref": "#/components/schemas/subscriptions_resource_payment_settings" } ], "description": "Payment settings passed on to invoices created by the subscription.", "nullable": true }, "pending_invoice_item_interval": { "anyOf": [ { "$ref": "#/components/schemas/subscription_pending_invoice_item_interval" } ], "description": "Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://stripe.com/docs/api#create_invoice) for the given subscription at the specified interval.", "nullable": true }, "pending_setup_intent": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/setup_intent" } ], "description": "You can use this [SetupIntent](https://stripe.com/docs/api/setup_intents) to collect user authentication when creating a subscription without immediate payment or updating a subscription's payment method, allowing you to optimize for off-session payments. Learn more in the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication#scenario-2).", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/setup_intent" } ] } }, "pending_update": { "anyOf": [ { "$ref": "#/components/schemas/subscriptions_resource_pending_update" } ], "description": "If specified, [pending updates](https://stripe.com/docs/billing/subscriptions/pending-updates) that will be applied to the subscription once the `latest_invoice` has been paid.", "nullable": true }, "schedule": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/subscription_schedule" } ], "description": "The schedule attached to the subscription", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/subscription_schedule" } ] } }, "start_date": { "description": "Date when the subscription was first created. The date might differ from the `created` date due to backdating.", "format": "unix-time", "type": "integer" }, "status": { "description": "Possible values are `incomplete`, `incomplete_expired`, `trialing`, `active`, `past_due`, `canceled`, `unpaid`, or `paused`. \n\nFor `collection_method=charge_automatically` a subscription moves into `incomplete` if the initial payment attempt fails. A subscription in this status can only have metadata and default_source updated. Once the first invoice is paid, the subscription moves into an `active` status. If the first invoice is not paid within 23 hours, the subscription transitions to `incomplete_expired`. This is a terminal status, the open invoice will be voided and no further invoices will be generated. \n\nA subscription that is currently in a trial period is `trialing` and moves to `active` when the trial period is over. \n\nA subscription can only enter a `paused` status [when a trial ends without a payment method](https://stripe.com/docs/billing/subscriptions/trials#create-free-trials-without-payment). A `paused` subscription doesn't generate invoices and can be resumed after your customer adds their payment method. The `paused` status is different from [pausing collection](https://stripe.com/docs/billing/subscriptions/pause-payment), which still generates invoices and leaves the subscription's status unchanged. \n\nIf subscription `collection_method=charge_automatically`, it becomes `past_due` when payment is required but cannot be paid (due to failed payment or awaiting additional user actions). Once Stripe has exhausted all payment retry attempts, the subscription will become `canceled` or `unpaid` (depending on your subscriptions settings). \n\nIf subscription `collection_method=send_invoice` it becomes `past_due` when its invoice is not paid by the due date, and `canceled` or `unpaid` if it is still not paid by an additional deadline after that. Note that when a subscription has a status of `unpaid`, no subsequent invoices will be attempted (invoices will be created, but then immediately automatically closed). After receiving updated payment information from a customer, you may choose to reopen and pay their closed invoices.", "enum": [ "active", "canceled", "incomplete", "incomplete_expired", "past_due", "paused", "trialing", "unpaid" ], "type": "string" }, "test_clock": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/test_helpers.test_clock" } ], "description": "ID of the test clock this subscription belongs to.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/test_helpers.test_clock" } ] } }, "transfer_data": { "anyOf": [ { "$ref": "#/components/schemas/subscription_transfer_data" } ], "description": "The account (if any) the subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices.", "nullable": true }, "trial_end": { "description": "If the subscription has a trial, the end of that trial.", "format": "unix-time", "nullable": true, "type": "integer" }, "trial_settings": { "anyOf": [ { "$ref": "#/components/schemas/subscriptions_trials_resource_trial_settings" } ], "description": "Settings related to subscription trials.", "nullable": true }, "trial_start": { "description": "If the subscription has a trial, the beginning of that trial.", "format": "unix-time", "nullable": true, "type": "integer" } }, "required": [ "automatic_tax", "billing_cycle_anchor", "billing_mode", "cancel_at_period_end", "collection_method", "created", "currency", "customer", "discounts", "id", "invoice_settings", "items", "livemode", "metadata", "object", "start_date", "status" ], "title": "Subscription", "type": "object", "x-expandableFields": [ "application", "automatic_tax", "billing_cycle_anchor_config", "billing_mode", "billing_thresholds", "cancellation_details", "customer", "default_payment_method", "default_source", "default_tax_rates", "discounts", "invoice_settings", "items", "latest_invoice", "on_behalf_of", "pause_collection", "payment_settings", "pending_invoice_item_interval", "pending_setup_intent", "pending_update", "schedule", "test_clock", "transfer_data", "trial_settings" ], "x-resourceId": "subscription" }, "subscription_automatic_tax": { "description": "", "properties": { "disabled_reason": { "description": "If Stripe disabled automatic tax, this enum describes why.", "enum": [ "requires_location_inputs" ], "nullable": true, "type": "string" }, "enabled": { "description": "Whether Stripe automatically computes tax on this subscription.", "type": "boolean" }, "liability": { "anyOf": [ { "$ref": "#/components/schemas/connect_account_reference" } ], "description": "The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.", "nullable": true } }, "required": [ "enabled" ], "title": "SubscriptionAutomaticTax", "type": "object", "x-expandableFields": [ "liability" ] }, "subscription_billing_thresholds": { "description": "", "properties": { "amount_gte": { "description": "Monetary threshold that triggers the subscription to create an invoice", "nullable": true, "type": "integer" }, "reset_billing_cycle_anchor": { "description": "Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. This value may not be `true` if the subscription contains items with plans that have `aggregate_usage=last_ever`.", "nullable": true, "type": "boolean" } }, "title": "SubscriptionBillingThresholds", "type": "object", "x-expandableFields": [] }, "subscription_item": { "description": "Subscription items allow you to create customer subscriptions with more than\none plan, making it easy to represent complex billing relationships.", "properties": { "billing_thresholds": { "anyOf": [ { "$ref": "#/components/schemas/subscription_item_billing_thresholds" } ], "description": "Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period", "nullable": true }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "type": "integer" }, "current_period_end": { "description": "The end time of this subscription item's current billing period.", "format": "unix-time", "type": "integer" }, "current_period_start": { "description": "The start time of this subscription item's current billing period.", "format": "unix-time", "type": "integer" }, "discounts": { "description": "The discounts applied to the subscription item. Subscription item discounts are applied before subscription discounts. Use `expand[]=discounts` to expand each discount.", "items": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/discount" } ], "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/discount" } ] } }, "type": "array" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "type": "object" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "subscription_item" ], "type": "string" }, "price": { "$ref": "#/components/schemas/price" }, "quantity": { "description": "The [quantity](https://stripe.com/docs/subscriptions/quantities) of the plan to which the customer should be subscribed.", "type": "integer" }, "subscription": { "description": "The `subscription` this `subscription_item` belongs to.", "maxLength": 5000, "type": "string" }, "tax_rates": { "description": "The tax rates which apply to this `subscription_item`. When set, the `default_tax_rates` on the subscription do not apply to this `subscription_item`.", "items": { "$ref": "#/components/schemas/tax_rate" }, "nullable": true, "type": "array" } }, "required": [ "created", "current_period_end", "current_period_start", "discounts", "id", "metadata", "object", "price", "subscription" ], "title": "SubscriptionItem", "type": "object", "x-expandableFields": [ "billing_thresholds", "discounts", "price", "tax_rates" ], "x-resourceId": "subscription_item" }, "subscription_item_billing_thresholds": { "description": "", "properties": { "usage_gte": { "description": "Usage threshold that triggers the subscription to create an invoice", "nullable": true, "type": "integer" } }, "title": "SubscriptionItemBillingThresholds", "type": "object", "x-expandableFields": [] }, "subscription_payment_method_options_card": { "description": "", "properties": { "mandate_options": { "$ref": "#/components/schemas/invoice_mandate_options_card" }, "network": { "description": "Selected network to process this Subscription on. Depends on the available networks of the card attached to the Subscription. Can be only set confirm-time.", "enum": [ "amex", "cartes_bancaires", "diners", "discover", "eftpos_au", "girocard", "interac", "jcb", "link", "mastercard", "unionpay", "unknown", "visa" ], "nullable": true, "type": "string" }, "request_three_d_secure": { "description": "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.", "enum": [ "any", "automatic", "challenge" ], "nullable": true, "type": "string" } }, "title": "subscription_payment_method_options_card", "type": "object", "x-expandableFields": [ "mandate_options" ] }, "subscription_pending_invoice_item_interval": { "description": "", "properties": { "interval": { "description": "Specifies invoicing frequency. Either `day`, `week`, `month` or `year`.", "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "description": "The number of intervals between invoices. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks).", "type": "integer" } }, "required": [ "interval", "interval_count" ], "title": "SubscriptionPendingInvoiceItemInterval", "type": "object", "x-expandableFields": [] }, "subscription_schedule": { "description": "A subscription schedule allows you to create and manage the lifecycle of a subscription by predefining expected changes.\n\nRelated guide: [Subscription schedules](https://stripe.com/docs/billing/subscriptions/subscription-schedules)", "properties": { "application": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/application" }, { "$ref": "#/components/schemas/deleted_application" } ], "description": "ID of the Connect Application that created the schedule.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/application" }, { "$ref": "#/components/schemas/deleted_application" } ] } }, "billing_mode": { "$ref": "#/components/schemas/subscriptions_resource_billing_mode" }, "canceled_at": { "description": "Time at which the subscription schedule was canceled. Measured in seconds since the Unix epoch.", "format": "unix-time", "nullable": true, "type": "integer" }, "completed_at": { "description": "Time at which the subscription schedule was completed. Measured in seconds since the Unix epoch.", "format": "unix-time", "nullable": true, "type": "integer" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "current_phase": { "anyOf": [ { "$ref": "#/components/schemas/subscription_schedule_current_phase" } ], "description": "Object representing the start and end dates for the current phase of the subscription schedule, if it is `active`.", "nullable": true }, "customer": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/customer" }, { "$ref": "#/components/schemas/deleted_customer" } ], "description": "ID of the customer who owns the subscription schedule.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/customer" }, { "$ref": "#/components/schemas/deleted_customer" } ] } }, "default_settings": { "$ref": "#/components/schemas/subscription_schedules_resource_default_settings" }, "end_behavior": { "description": "Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running. `cancel` will end the subscription schedule and cancel the underlying subscription.", "enum": [ "cancel", "none", "release", "renew" ], "type": "string" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "nullable": true, "type": "object" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "subscription_schedule" ], "type": "string" }, "phases": { "description": "Configuration for the subscription schedule's phases.", "items": { "$ref": "#/components/schemas/subscription_schedule_phase_configuration" }, "type": "array" }, "released_at": { "description": "Time at which the subscription schedule was released. Measured in seconds since the Unix epoch.", "format": "unix-time", "nullable": true, "type": "integer" }, "released_subscription": { "description": "ID of the subscription once managed by the subscription schedule (if it is released).", "maxLength": 5000, "nullable": true, "type": "string" }, "status": { "description": "The present status of the subscription schedule. Possible values are `not_started`, `active`, `completed`, `released`, and `canceled`. You can read more about the different states in our [behavior guide](https://stripe.com/docs/billing/subscriptions/subscription-schedules).", "enum": [ "active", "canceled", "completed", "not_started", "released" ], "type": "string" }, "subscription": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/subscription" } ], "description": "ID of the subscription managed by the subscription schedule.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/subscription" } ] } }, "test_clock": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/test_helpers.test_clock" } ], "description": "ID of the test clock this subscription schedule belongs to.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/test_helpers.test_clock" } ] } } }, "required": [ "billing_mode", "created", "customer", "default_settings", "end_behavior", "id", "livemode", "object", "phases", "status" ], "title": "SubscriptionSchedule", "type": "object", "x-expandableFields": [ "application", "billing_mode", "current_phase", "customer", "default_settings", "phases", "subscription", "test_clock" ], "x-resourceId": "subscription_schedule" }, "subscription_schedule_add_invoice_item": { "description": "An Add Invoice Item describes the prices and quantities that will be added as pending invoice items when entering a phase.", "properties": { "discounts": { "description": "The stackable discounts that will be applied to the item.", "items": { "$ref": "#/components/schemas/discounts_resource_stackable_discount" }, "type": "array" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "nullable": true, "type": "object" }, "period": { "$ref": "#/components/schemas/subscription_schedule_add_invoice_item_period" }, "price": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/price" }, { "$ref": "#/components/schemas/deleted_price" } ], "description": "ID of the price used to generate the invoice item.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/price" }, { "$ref": "#/components/schemas/deleted_price" } ] } }, "quantity": { "description": "The quantity of the invoice item.", "nullable": true, "type": "integer" }, "tax_rates": { "description": "The tax rates which apply to the item. When set, the `default_tax_rates` do not apply to this item.", "items": { "$ref": "#/components/schemas/tax_rate" }, "nullable": true, "type": "array" } }, "required": [ "discounts", "period", "price" ], "title": "SubscriptionScheduleAddInvoiceItem", "type": "object", "x-expandableFields": [ "discounts", "period", "price", "tax_rates" ] }, "subscription_schedule_add_invoice_item_period": { "description": "", "properties": { "end": { "$ref": "#/components/schemas/subscription_schedules_resource_invoice_item_period_resource_period_end" }, "start": { "$ref": "#/components/schemas/subscription_schedules_resource_invoice_item_period_resource_period_start" } }, "required": [ "end", "start" ], "title": "SubscriptionScheduleAddInvoiceItemPeriod", "type": "object", "x-expandableFields": [ "end", "start" ] }, "subscription_schedule_configuration_item": { "description": "A phase item describes the price and quantity of a phase.", "properties": { "billing_thresholds": { "anyOf": [ { "$ref": "#/components/schemas/subscription_item_billing_thresholds" } ], "description": "Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period", "nullable": true }, "discounts": { "description": "The discounts applied to the subscription item. Subscription item discounts are applied before subscription discounts. Use `expand[]=discounts` to expand each discount.", "items": { "$ref": "#/components/schemas/discounts_resource_stackable_discount" }, "type": "array" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an item. Metadata on this item will update the underlying subscription item's `metadata` when the phase is entered.", "nullable": true, "type": "object" }, "price": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/price" }, { "$ref": "#/components/schemas/deleted_price" } ], "description": "ID of the price to which the customer should be subscribed.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/price" }, { "$ref": "#/components/schemas/deleted_price" } ] } }, "quantity": { "description": "Quantity of the plan to which the customer should be subscribed.", "type": "integer" }, "tax_rates": { "description": "The tax rates which apply to this `phase_item`. When set, the `default_tax_rates` on the phase do not apply to this `phase_item`.", "items": { "$ref": "#/components/schemas/tax_rate" }, "nullable": true, "type": "array" } }, "required": [ "discounts", "price" ], "title": "SubscriptionScheduleConfigurationItem", "type": "object", "x-expandableFields": [ "billing_thresholds", "discounts", "price", "tax_rates" ] }, "subscription_schedule_current_phase": { "description": "", "properties": { "end_date": { "description": "The end of this phase of the subscription schedule.", "format": "unix-time", "type": "integer" }, "start_date": { "description": "The start of this phase of the subscription schedule.", "format": "unix-time", "type": "integer" } }, "required": [ "end_date", "start_date" ], "title": "SubscriptionScheduleCurrentPhase", "type": "object", "x-expandableFields": [] }, "subscription_schedule_phase_configuration": { "description": "A phase describes the plans, coupon, and trialing status of a subscription for a predefined time period.", "properties": { "add_invoice_items": { "description": "A list of prices and quantities that will generate invoice items appended to the next invoice for this phase.", "items": { "$ref": "#/components/schemas/subscription_schedule_add_invoice_item" }, "type": "array" }, "application_fee_percent": { "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account during this phase of the schedule.", "nullable": true, "type": "number" }, "automatic_tax": { "$ref": "#/components/schemas/schedules_phase_automatic_tax" }, "billing_cycle_anchor": { "description": "Possible values are `phase_start` or `automatic`. If `phase_start` then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. If `automatic` then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).", "enum": [ "automatic", "phase_start" ], "nullable": true, "type": "string" }, "billing_thresholds": { "anyOf": [ { "$ref": "#/components/schemas/subscription_billing_thresholds" } ], "description": "Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period", "nullable": true }, "collection_method": { "description": "Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`.", "enum": [ "charge_automatically", "send_invoice" ], "nullable": true, "type": "string" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "default_payment_method": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/payment_method" } ], "description": "ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/payment_method" } ] } }, "default_tax_rates": { "description": "The default tax rates to apply to the subscription during this phase of the subscription schedule.", "items": { "$ref": "#/components/schemas/tax_rate" }, "nullable": true, "type": "array" }, "description": { "description": "Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.", "maxLength": 5000, "nullable": true, "type": "string" }, "discounts": { "description": "The stackable discounts that will be applied to the subscription on this phase. Subscription item discounts are applied before subscription discounts.", "items": { "$ref": "#/components/schemas/discounts_resource_stackable_discount" }, "type": "array" }, "end_date": { "description": "The end of this phase of the subscription schedule.", "format": "unix-time", "type": "integer" }, "invoice_settings": { "anyOf": [ { "$ref": "#/components/schemas/invoice_setting_subscription_schedule_phase_setting" } ], "description": "The invoice settings applicable during this phase.", "nullable": true }, "items": { "description": "Subscription items to configure the subscription to during this phase of the subscription schedule.", "items": { "$ref": "#/components/schemas/subscription_schedule_configuration_item" }, "type": "array" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a phase. Metadata on a schedule's phase will update the underlying subscription's `metadata` when the phase is entered. Updating the underlying subscription's `metadata` directly will not affect the current phase's `metadata`.", "nullable": true, "type": "object" }, "on_behalf_of": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/account" } ], "description": "The account (if any) the charge was made on behalf of for charges associated with the schedule's subscription. See the Connect documentation for details.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/account" } ] } }, "proration_behavior": { "description": "When transitioning phases, controls how prorations are handled (if any). Possible values are `create_prorations`, `none`, and `always_invoice`.", "enum": [ "always_invoice", "create_prorations", "none" ], "type": "string" }, "start_date": { "description": "The start of this phase of the subscription schedule.", "format": "unix-time", "type": "integer" }, "transfer_data": { "anyOf": [ { "$ref": "#/components/schemas/subscription_transfer_data" } ], "description": "The account (if any) the associated subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices.", "nullable": true }, "trial_end": { "description": "When the trial ends within the phase.", "format": "unix-time", "nullable": true, "type": "integer" } }, "required": [ "add_invoice_items", "currency", "discounts", "end_date", "items", "proration_behavior", "start_date" ], "title": "SubscriptionSchedulePhaseConfiguration", "type": "object", "x-expandableFields": [ "add_invoice_items", "automatic_tax", "billing_thresholds", "default_payment_method", "default_tax_rates", "discounts", "invoice_settings", "items", "on_behalf_of", "transfer_data" ] }, "subscription_schedules_resource_default_settings": { "description": "", "properties": { "application_fee_percent": { "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account during this phase of the schedule.", "nullable": true, "type": "number" }, "automatic_tax": { "$ref": "#/components/schemas/subscription_schedules_resource_default_settings_automatic_tax" }, "billing_cycle_anchor": { "description": "Possible values are `phase_start` or `automatic`. If `phase_start` then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. If `automatic` then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).", "enum": [ "automatic", "phase_start" ], "type": "string" }, "billing_thresholds": { "anyOf": [ { "$ref": "#/components/schemas/subscription_billing_thresholds" } ], "description": "Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period", "nullable": true }, "collection_method": { "description": "Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`.", "enum": [ "charge_automatically", "send_invoice" ], "nullable": true, "type": "string" }, "default_payment_method": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/payment_method" } ], "description": "ID of the default payment method for the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/payment_method" } ] } }, "description": { "description": "Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.", "maxLength": 5000, "nullable": true, "type": "string" }, "invoice_settings": { "$ref": "#/components/schemas/invoice_setting_subscription_schedule_setting" }, "on_behalf_of": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/account" } ], "description": "The account (if any) the charge was made on behalf of for charges associated with the schedule's subscription. See the Connect documentation for details.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/account" } ] } }, "transfer_data": { "anyOf": [ { "$ref": "#/components/schemas/subscription_transfer_data" } ], "description": "The account (if any) the associated subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices.", "nullable": true } }, "required": [ "billing_cycle_anchor", "invoice_settings" ], "title": "SubscriptionSchedulesResourceDefaultSettings", "type": "object", "x-expandableFields": [ "automatic_tax", "billing_thresholds", "default_payment_method", "invoice_settings", "on_behalf_of", "transfer_data" ] }, "subscription_schedules_resource_default_settings_automatic_tax": { "description": "", "properties": { "disabled_reason": { "description": "If Stripe disabled automatic tax, this enum describes why.", "enum": [ "requires_location_inputs" ], "nullable": true, "type": "string" }, "enabled": { "description": "Whether Stripe automatically computes tax on invoices created during this phase.", "type": "boolean" }, "liability": { "anyOf": [ { "$ref": "#/components/schemas/connect_account_reference" } ], "description": "The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.", "nullable": true } }, "required": [ "enabled" ], "title": "SubscriptionSchedulesResourceDefaultSettingsAutomaticTax", "type": "object", "x-expandableFields": [ "liability" ] }, "subscription_schedules_resource_invoice_item_period_resource_period_end": { "description": "", "properties": { "timestamp": { "description": "A precise Unix timestamp for the end of the invoice item period. Must be greater than or equal to `period.start`.", "format": "unix-time", "type": "integer" }, "type": { "description": "Select how to calculate the end of the invoice item period.", "enum": [ "min_item_period_end", "phase_end", "timestamp" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "SubscriptionSchedulesResourceInvoiceItemPeriodResourcePeriodEnd", "type": "object", "x-expandableFields": [] }, "subscription_schedules_resource_invoice_item_period_resource_period_start": { "description": "", "properties": { "timestamp": { "description": "A precise Unix timestamp for the start of the invoice item period. Must be less than or equal to `period.end`.", "format": "unix-time", "type": "integer" }, "type": { "description": "Select how to calculate the start of the invoice item period.", "enum": [ "max_item_period_start", "phase_start", "timestamp" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "SubscriptionSchedulesResourceInvoiceItemPeriodResourcePeriodStart", "type": "object", "x-expandableFields": [] }, "subscription_transfer_data": { "description": "", "properties": { "amount_percent": { "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination.", "nullable": true, "type": "number" }, "destination": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/account" } ], "description": "The account where funds from the payment will be transferred to upon payment success.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/account" } ] } } }, "required": [ "destination" ], "title": "SubscriptionTransferData", "type": "object", "x-expandableFields": [ "destination" ] }, "subscriptions_resource_billing_cycle_anchor_config": { "description": "", "properties": { "day_of_month": { "description": "The day of the month of the billing_cycle_anchor.", "type": "integer" }, "hour": { "description": "The hour of the day of the billing_cycle_anchor.", "nullable": true, "type": "integer" }, "minute": { "description": "The minute of the hour of the billing_cycle_anchor.", "nullable": true, "type": "integer" }, "month": { "description": "The month to start full cycle billing periods.", "nullable": true, "type": "integer" }, "second": { "description": "The second of the minute of the billing_cycle_anchor.", "nullable": true, "type": "integer" } }, "required": [ "day_of_month" ], "title": "SubscriptionsResourceBillingCycleAnchorConfig", "type": "object", "x-expandableFields": [] }, "subscriptions_resource_billing_mode": { "description": "The billing mode of the subscription.", "properties": { "type": { "description": "Controls how prorations and invoices for subscriptions are calculated and orchestrated.", "enum": [ "classic", "flexible" ], "type": "string" }, "updated_at": { "description": "Details on when the current billing_mode was adopted.", "format": "unix-time", "type": "integer" } }, "required": [ "type" ], "title": "SubscriptionsResourceBillingMode", "type": "object", "x-expandableFields": [] }, "subscriptions_resource_pause_collection": { "description": "The Pause Collection settings determine how we will pause collection for this subscription and for how long the subscription\nshould be paused.", "properties": { "behavior": { "description": "The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.", "enum": [ "keep_as_draft", "mark_uncollectible", "void" ], "type": "string" }, "resumes_at": { "description": "The time after which the subscription will resume collecting payments.", "format": "unix-time", "nullable": true, "type": "integer" } }, "required": [ "behavior" ], "title": "SubscriptionsResourcePauseCollection", "type": "object", "x-expandableFields": [] }, "subscriptions_resource_payment_method_options": { "description": "", "properties": { "acss_debit": { "anyOf": [ { "$ref": "#/components/schemas/invoice_payment_method_options_acss_debit" } ], "description": "This sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to invoices created by the subscription.", "nullable": true }, "bancontact": { "anyOf": [ { "$ref": "#/components/schemas/invoice_payment_method_options_bancontact" } ], "description": "This sub-hash contains details about the Bancontact payment method options to pass to invoices created by the subscription.", "nullable": true }, "card": { "anyOf": [ { "$ref": "#/components/schemas/subscription_payment_method_options_card" } ], "description": "This sub-hash contains details about the Card payment method options to pass to invoices created by the subscription.", "nullable": true }, "customer_balance": { "anyOf": [ { "$ref": "#/components/schemas/invoice_payment_method_options_customer_balance" } ], "description": "This sub-hash contains details about the Bank transfer payment method options to pass to invoices created by the subscription.", "nullable": true }, "konbini": { "anyOf": [ { "$ref": "#/components/schemas/invoice_payment_method_options_konbini" } ], "description": "This sub-hash contains details about the Konbini payment method options to pass to invoices created by the subscription.", "nullable": true }, "sepa_debit": { "anyOf": [ { "$ref": "#/components/schemas/invoice_payment_method_options_sepa_debit" } ], "description": "This sub-hash contains details about the SEPA Direct Debit payment method options to pass to invoices created by the subscription.", "nullable": true }, "us_bank_account": { "anyOf": [ { "$ref": "#/components/schemas/invoice_payment_method_options_us_bank_account" } ], "description": "This sub-hash contains details about the ACH direct debit payment method options to pass to invoices created by the subscription.", "nullable": true } }, "title": "SubscriptionsResourcePaymentMethodOptions", "type": "object", "x-expandableFields": [ "acss_debit", "bancontact", "card", "customer_balance", "konbini", "sepa_debit", "us_bank_account" ] }, "subscriptions_resource_payment_settings": { "description": "", "properties": { "payment_method_options": { "anyOf": [ { "$ref": "#/components/schemas/subscriptions_resource_payment_method_options" } ], "description": "Payment-method-specific configuration to provide to invoices created by the subscription.", "nullable": true }, "payment_method_types": { "description": "The list of payment method types to provide to every invoice created by the subscription. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your [invoice template settings](https://dashboard.stripe.com/settings/billing/invoice).", "items": { "enum": [ "ach_credit_transfer", "ach_debit", "acss_debit", "affirm", "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", "boleto", "card", "cashapp", "crypto", "customer_balance", "eps", "fpx", "giropay", "grabpay", "ideal", "jp_credit_transfer", "kakao_pay", "klarna", "konbini", "kr_card", "link", "multibanco", "naver_pay", "nz_bank_account", "p24", "payco", "paynow", "paypal", "promptpay", "revolut_pay", "sepa_credit_transfer", "sepa_debit", "sofort", "swish", "us_bank_account", "wechat_pay" ], "type": "string", "x-stripeBypassValidation": true }, "nullable": true, "type": "array" }, "save_default_payment_method": { "description": "Configure whether Stripe updates `subscription.default_payment_method` when payment succeeds. Defaults to `off`.", "enum": [ "off", "on_subscription" ], "nullable": true, "type": "string" } }, "title": "SubscriptionsResourcePaymentSettings", "type": "object", "x-expandableFields": [ "payment_method_options" ] }, "subscriptions_resource_pending_update": { "description": "Pending Updates store the changes pending from a previous update that will be applied\nto the Subscription upon successful payment.", "properties": { "billing_cycle_anchor": { "description": "If the update is applied, determines the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. The timestamp is in UTC format.", "format": "unix-time", "nullable": true, "type": "integer" }, "expires_at": { "description": "The point after which the changes reflected by this update will be discarded and no longer applied.", "format": "unix-time", "type": "integer" }, "subscription_items": { "description": "List of subscription items, each with an attached plan, that will be set if the update is applied.", "items": { "$ref": "#/components/schemas/subscription_item" }, "nullable": true, "type": "array" }, "trial_end": { "description": "Unix timestamp representing the end of the trial period the customer will get before being charged for the first time, if the update is applied.", "format": "unix-time", "nullable": true, "type": "integer" }, "trial_from_plan": { "description": "Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more.", "nullable": true, "type": "boolean" } }, "required": [ "expires_at" ], "title": "SubscriptionsResourcePendingUpdate", "type": "object", "x-expandableFields": [ "subscription_items" ] }, "subscriptions_resource_subscription_invoice_settings": { "description": "", "properties": { "account_tax_ids": { "description": "The account tax IDs associated with the subscription. Will be set on invoices generated by the subscription.", "items": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/tax_id" }, { "$ref": "#/components/schemas/deleted_tax_id" } ], "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/tax_id" }, { "$ref": "#/components/schemas/deleted_tax_id" } ] } }, "nullable": true, "type": "array" }, "issuer": { "$ref": "#/components/schemas/connect_account_reference" } }, "required": [ "issuer" ], "title": "SubscriptionsResourceSubscriptionInvoiceSettings", "type": "object", "x-expandableFields": [ "account_tax_ids", "issuer" ] }, "subscriptions_trials_resource_end_behavior": { "description": "Defines how a subscription behaves when a free trial ends.", "properties": { "missing_payment_method": { "description": "Indicates how the subscription should change when the trial ends if the user did not provide a payment method.", "enum": [ "cancel", "create_invoice", "pause" ], "type": "string" } }, "required": [ "missing_payment_method" ], "title": "SubscriptionsTrialsResourceEndBehavior", "type": "object", "x-expandableFields": [] }, "subscriptions_trials_resource_trial_settings": { "description": "Configures how this subscription behaves during the trial period.", "properties": { "end_behavior": { "$ref": "#/components/schemas/subscriptions_trials_resource_end_behavior" } }, "required": [ "end_behavior" ], "title": "SubscriptionsTrialsResourceTrialSettings", "type": "object", "x-expandableFields": [ "end_behavior" ] }, "tax.calculation": { "description": "A Tax Calculation allows you to calculate the tax to collect from your customer.\n\nRelated guide: [Calculate tax in your custom payment flow](https://stripe.com/docs/tax/custom)", "properties": { "amount_total": { "description": "Total amount after taxes in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "maxLength": 5000, "type": "string" }, "customer": { "description": "The ID of an existing [Customer](https://stripe.com/docs/api/customers/object) used for the resource.", "maxLength": 5000, "nullable": true, "type": "string" }, "customer_details": { "$ref": "#/components/schemas/tax_product_resource_customer_details" }, "expires_at": { "description": "Timestamp of date at which the tax calculation will expire.", "format": "unix-time", "nullable": true, "type": "integer" }, "id": { "description": "Unique identifier for the calculation.", "maxLength": 5000, "nullable": true, "type": "string" }, "line_items": { "description": "The list of items the customer is purchasing.", "nullable": true, "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/tax.calculation_line_item" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/tax/calculations/[^/]+/line_items", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "TaxProductResourceTaxCalculationLineItemList", "type": "object", "x-expandableFields": [ "data" ] }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "tax.calculation" ], "type": "string" }, "ship_from_details": { "anyOf": [ { "$ref": "#/components/schemas/tax_product_resource_ship_from_details" } ], "description": "The details of the ship from location, such as the address.", "nullable": true }, "shipping_cost": { "anyOf": [ { "$ref": "#/components/schemas/tax_product_resource_tax_calculation_shipping_cost" } ], "description": "The shipping cost details for the calculation.", "nullable": true }, "tax_amount_exclusive": { "description": "The amount of tax to be collected on top of the line item prices.", "type": "integer" }, "tax_amount_inclusive": { "description": "The amount of tax already included in the line item prices.", "type": "integer" }, "tax_breakdown": { "description": "Breakdown of individual tax amounts that add up to the total.", "items": { "$ref": "#/components/schemas/tax_product_resource_tax_breakdown" }, "type": "array" }, "tax_date": { "description": "Timestamp of date at which the tax rules and rates in effect applies for the calculation.", "format": "unix-time", "type": "integer" } }, "required": [ "amount_total", "currency", "customer_details", "livemode", "object", "tax_amount_exclusive", "tax_amount_inclusive", "tax_breakdown", "tax_date" ], "title": "TaxProductResourceTaxCalculation", "type": "object", "x-expandableFields": [ "customer_details", "line_items", "ship_from_details", "shipping_cost", "tax_breakdown" ], "x-resourceId": "tax.calculation" }, "tax.calculation_line_item": { "description": "", "properties": { "amount": { "description": "The line item amount in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount.", "type": "integer" }, "amount_tax": { "description": "The amount of tax calculated for this line item, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", "type": "integer" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "nullable": true, "type": "object" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "tax.calculation_line_item" ], "type": "string" }, "product": { "description": "The ID of an existing [Product](https://stripe.com/docs/api/products/object).", "maxLength": 5000, "nullable": true, "type": "string" }, "quantity": { "description": "The number of units of the item being purchased. For reversals, this is the quantity reversed.", "type": "integer" }, "reference": { "description": "A custom identifier for this line item.", "maxLength": 5000, "type": "string" }, "tax_behavior": { "description": "Specifies whether the `amount` includes taxes. If `tax_behavior=inclusive`, then the amount includes taxes.", "enum": [ "exclusive", "inclusive" ], "type": "string" }, "tax_breakdown": { "description": "Detailed account of taxes relevant to this line item.", "items": { "$ref": "#/components/schemas/tax_product_resource_line_item_tax_breakdown" }, "nullable": true, "type": "array" }, "tax_code": { "description": "The [tax code](https://stripe.com/docs/tax/tax-categories) ID used for this resource.", "maxLength": 5000, "type": "string" } }, "required": [ "amount", "amount_tax", "id", "livemode", "object", "quantity", "reference", "tax_behavior", "tax_code" ], "title": "TaxProductResourceTaxCalculationLineItem", "type": "object", "x-expandableFields": [ "tax_breakdown" ], "x-resourceId": "tax.calculation_line_item" }, "tax.registration": { "description": "A Tax `Registration` lets us know that your business is registered to collect tax on payments within a region, enabling you to [automatically collect tax](https://stripe.com/docs/tax).\n\nStripe doesn't register on your behalf with the relevant authorities when you create a Tax `Registration` object. For more information on how to register to collect tax, see [our guide](https://stripe.com/docs/tax/registering).\n\nRelated guide: [Using the Registrations API](https://stripe.com/docs/tax/registrations-api)", "properties": { "active_from": { "description": "Time at which the registration becomes active. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "country_options": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "expires_at": { "description": "If set, the registration stops being active at this time. If not set, the registration will be active indefinitely. Measured in seconds since the Unix epoch.", "format": "unix-time", "nullable": true, "type": "integer" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "tax.registration" ], "type": "string" }, "status": { "description": "The status of the registration. This field is present for convenience and can be deduced from `active_from` and `expires_at`.", "enum": [ "active", "expired", "scheduled" ], "type": "string" } }, "required": [ "active_from", "country", "country_options", "created", "id", "livemode", "object", "status" ], "title": "TaxProductRegistrationsResourceTaxRegistration", "type": "object", "x-expandableFields": [ "country_options" ], "x-resourceId": "tax.registration" }, "tax.settings": { "description": "You can use Tax `Settings` to manage configurations used by Stripe Tax calculations.\n\nRelated guide: [Using the Settings API](https://stripe.com/docs/tax/settings-api)", "properties": { "defaults": { "$ref": "#/components/schemas/tax_product_resource_tax_settings_defaults" }, "head_office": { "anyOf": [ { "$ref": "#/components/schemas/tax_product_resource_tax_settings_head_office" } ], "description": "The place where your business is located.", "nullable": true }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "tax.settings" ], "type": "string" }, "status": { "description": "The status of the Tax `Settings`.", "enum": [ "active", "pending" ], "type": "string" }, "status_details": { "$ref": "#/components/schemas/tax_product_resource_tax_settings_status_details" } }, "required": [ "defaults", "livemode", "object", "status", "status_details" ], "title": "TaxProductResourceTaxSettings", "type": "object", "x-expandableFields": [ "defaults", "head_office", "status_details" ], "x-resourceId": "tax.settings" }, "tax.transaction": { "description": "A Tax Transaction records the tax collected from or refunded to your customer.\n\nRelated guide: [Calculate tax in your custom payment flow](https://stripe.com/docs/tax/custom#tax-transaction)", "properties": { "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "maxLength": 5000, "type": "string" }, "customer": { "description": "The ID of an existing [Customer](https://stripe.com/docs/api/customers/object) used for the resource.", "maxLength": 5000, "nullable": true, "type": "string" }, "customer_details": { "$ref": "#/components/schemas/tax_product_resource_customer_details" }, "id": { "description": "Unique identifier for the transaction.", "maxLength": 5000, "type": "string" }, "line_items": { "description": "The tax collected or refunded, by line item.", "nullable": true, "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/tax.transaction_line_item" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/tax/transactions/[^/]+/line_items", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "TaxProductResourceTaxTransactionLineItemList", "type": "object", "x-expandableFields": [ "data" ] }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "nullable": true, "type": "object" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "tax.transaction" ], "type": "string" }, "posted_at": { "description": "The Unix timestamp representing when the tax liability is assumed or reduced.", "format": "unix-time", "type": "integer" }, "reference": { "description": "A custom unique identifier, such as 'myOrder_123'.", "maxLength": 5000, "type": "string" }, "reversal": { "anyOf": [ { "$ref": "#/components/schemas/tax_product_resource_tax_transaction_resource_reversal" } ], "description": "If `type=reversal`, contains information about what was reversed.", "nullable": true }, "ship_from_details": { "anyOf": [ { "$ref": "#/components/schemas/tax_product_resource_ship_from_details" } ], "description": "The details of the ship from location, such as the address.", "nullable": true }, "shipping_cost": { "anyOf": [ { "$ref": "#/components/schemas/tax_product_resource_tax_transaction_shipping_cost" } ], "description": "The shipping cost details for the transaction.", "nullable": true }, "tax_date": { "description": "Timestamp of date at which the tax rules and rates in effect applies for the calculation.", "format": "unix-time", "type": "integer" }, "type": { "description": "If `reversal`, this transaction reverses an earlier transaction.", "enum": [ "reversal", "transaction" ], "type": "string" } }, "required": [ "created", "currency", "customer_details", "id", "livemode", "object", "posted_at", "reference", "tax_date", "type" ], "title": "TaxProductResourceTaxTransaction", "type": "object", "x-expandableFields": [ "customer_details", "line_items", "reversal", "ship_from_details", "shipping_cost" ], "x-resourceId": "tax.transaction" }, "tax.transaction_line_item": { "description": "", "properties": { "amount": { "description": "The line item amount in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount.", "type": "integer" }, "amount_tax": { "description": "The amount of tax calculated for this line item, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", "type": "integer" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "nullable": true, "type": "object" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "tax.transaction_line_item" ], "type": "string" }, "product": { "description": "The ID of an existing [Product](https://stripe.com/docs/api/products/object).", "maxLength": 5000, "nullable": true, "type": "string" }, "quantity": { "description": "The number of units of the item being purchased. For reversals, this is the quantity reversed.", "type": "integer" }, "reference": { "description": "A custom identifier for this line item in the transaction.", "maxLength": 5000, "type": "string" }, "reversal": { "anyOf": [ { "$ref": "#/components/schemas/tax_product_resource_tax_transaction_line_item_resource_reversal" } ], "description": "If `type=reversal`, contains information about what was reversed.", "nullable": true }, "tax_behavior": { "description": "Specifies whether the `amount` includes taxes. If `tax_behavior=inclusive`, then the amount includes taxes.", "enum": [ "exclusive", "inclusive" ], "type": "string" }, "tax_code": { "description": "The [tax code](https://stripe.com/docs/tax/tax-categories) ID used for this resource.", "maxLength": 5000, "type": "string" }, "type": { "description": "If `reversal`, this line item reverses an earlier transaction.", "enum": [ "reversal", "transaction" ], "type": "string" } }, "required": [ "amount", "amount_tax", "id", "livemode", "object", "quantity", "reference", "tax_behavior", "tax_code", "type" ], "title": "TaxProductResourceTaxTransactionLineItem", "type": "object", "x-expandableFields": [ "reversal" ], "x-resourceId": "tax.transaction_line_item" }, "tax_code": { "description": "[Tax codes](https://stripe.com/docs/tax/tax-categories) classify goods and services for tax purposes.", "properties": { "description": { "description": "A detailed description of which types of products the tax code represents.", "maxLength": 5000, "type": "string" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "name": { "description": "A short name for the tax code.", "maxLength": 5000, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "tax_code" ], "type": "string" } }, "required": [ "description", "id", "name", "object" ], "title": "TaxProductResourceTaxCode", "type": "object", "x-expandableFields": [], "x-resourceId": "tax_code" }, "tax_deducted_at_source": { "description": "", "properties": { "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "tax_deducted_at_source" ], "type": "string" }, "period_end": { "description": "The end of the invoicing period. This TDS applies to Stripe fees collected during this invoicing period.", "format": "unix-time", "type": "integer" }, "period_start": { "description": "The start of the invoicing period. This TDS applies to Stripe fees collected during this invoicing period.", "format": "unix-time", "type": "integer" }, "tax_deduction_account_number": { "description": "The TAN that was supplied to Stripe when TDS was assessed", "maxLength": 5000, "type": "string" } }, "required": [ "id", "object", "period_end", "period_start", "tax_deduction_account_number" ], "title": "TaxDeductedAtSource", "type": "object", "x-expandableFields": [] }, "tax_i_ds_owner": { "description": "", "properties": { "account": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/account" } ], "description": "The account being referenced when `type` is `account`.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/account" } ] } }, "application": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/application" } ], "description": "The Connect Application being referenced when `type` is `application`.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/application" } ] } }, "customer": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/customer" } ], "description": "The customer being referenced when `type` is `customer`.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/customer" } ] } }, "type": { "description": "Type of owner referenced.", "enum": [ "account", "application", "customer", "self" ], "type": "string" } }, "required": [ "type" ], "title": "TaxIDsOwner", "type": "object", "x-expandableFields": [ "account", "application", "customer" ] }, "tax_id": { "description": "You can add one or multiple tax IDs to a [customer](https://stripe.com/docs/api/customers) or account.\nCustomer and account tax IDs get displayed on related invoices and credit notes.\n\nRelated guides: [Customer tax identification numbers](https://stripe.com/docs/billing/taxes/tax-ids), [Account tax IDs](https://stripe.com/docs/invoicing/connect#account-tax-ids)", "properties": { "country": { "description": "Two-letter ISO code representing the country of the tax ID.", "maxLength": 5000, "nullable": true, "type": "string" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "customer": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/customer" } ], "description": "ID of the customer.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/customer" } ] } }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "tax_id" ], "type": "string" }, "owner": { "anyOf": [ { "$ref": "#/components/schemas/tax_i_ds_owner" } ], "description": "The account or customer the tax ID belongs to.", "nullable": true }, "type": { "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `aw_tin`, `az_tin`, `ba_tin`, `bb_tin`, `bd_bin`, `bf_ifu`, `bg_uic`, `bh_vat`, `bj_ifu`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cm_niu`, `cn_tin`, `co_nit`, `cr_tin`, `cv_nif`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `et_tin`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kg_tin`, `kh_tin`, `kr_brn`, `kz_bin`, `la_tin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin`. Note that some legacy tax IDs have type `unknown`", "enum": [ "ad_nrt", "ae_trn", "al_tin", "am_tin", "ao_tin", "ar_cuit", "au_abn", "au_arn", "aw_tin", "az_tin", "ba_tin", "bb_tin", "bd_bin", "bf_ifu", "bg_uic", "bh_vat", "bj_ifu", "bo_tin", "br_cnpj", "br_cpf", "bs_tin", "by_tin", "ca_bn", "ca_gst_hst", "ca_pst_bc", "ca_pst_mb", "ca_pst_sk", "ca_qst", "cd_nif", "ch_uid", "ch_vat", "cl_tin", "cm_niu", "cn_tin", "co_nit", "cr_tin", "cv_nif", "de_stn", "do_rcn", "ec_ruc", "eg_tin", "es_cif", "et_tin", "eu_oss_vat", "eu_vat", "gb_vat", "ge_vat", "gn_nif", "hk_br", "hr_oib", "hu_tin", "id_npwp", "il_vat", "in_gst", "is_vat", "jp_cn", "jp_rn", "jp_trn", "ke_pin", "kg_tin", "kh_tin", "kr_brn", "kz_bin", "la_tin", "li_uid", "li_vat", "ma_vat", "md_vat", "me_pib", "mk_vat", "mr_nif", "mx_rfc", "my_frp", "my_itn", "my_sst", "ng_tin", "no_vat", "no_voec", "np_pan", "nz_gst", "om_vat", "pe_ruc", "ph_tin", "ro_tin", "rs_pib", "ru_inn", "ru_kpp", "sa_vat", "sg_gst", "sg_uen", "si_tin", "sn_ninea", "sr_fin", "sv_nit", "th_vat", "tj_tin", "tr_tin", "tw_vat", "tz_vat", "ua_vat", "ug_tin", "unknown", "us_ein", "uy_ruc", "uz_tin", "uz_vat", "ve_rif", "vn_tin", "za_vat", "zm_tin", "zw_tin" ], "type": "string" }, "value": { "description": "Value of the tax ID.", "maxLength": 5000, "type": "string" }, "verification": { "anyOf": [ { "$ref": "#/components/schemas/tax_id_verification" } ], "description": "Tax ID verification information.", "nullable": true } }, "required": [ "created", "id", "livemode", "object", "type", "value" ], "title": "tax_id", "type": "object", "x-expandableFields": [ "customer", "owner", "verification" ], "x-resourceId": "tax_id" }, "tax_id_verification": { "description": "", "properties": { "status": { "description": "Verification status, one of `pending`, `verified`, `unverified`, or `unavailable`.", "enum": [ "pending", "unavailable", "unverified", "verified" ], "type": "string" }, "verified_address": { "description": "Verified address.", "maxLength": 5000, "nullable": true, "type": "string" }, "verified_name": { "description": "Verified name.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "status" ], "title": "tax_id_verification", "type": "object", "x-expandableFields": [] }, "tax_product_registrations_resource_country_options": { "description": "", "properties": { "ae": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default_inbound_goods" }, "al": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default" }, "am": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" }, "ao": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default" }, "at": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe" }, "au": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default_inbound_goods" }, "aw": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default" }, "az": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" }, "ba": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default" }, "bb": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default" }, "bd": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default" }, "be": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe" }, "bf": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default" }, "bg": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe" }, "bh": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default" }, "bj": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" }, "bs": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default" }, "by": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" }, "ca": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_canada" }, "cd": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default" }, "ch": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default_inbound_goods" }, "cl": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" }, "cm": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" }, "co": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" }, "cr": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" }, "cv": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" }, "cy": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe" }, "cz": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe" }, "de": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe" }, "dk": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe" }, "ec": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" }, "ee": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe" }, "eg": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" }, "es": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe" }, "et": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default" }, "fi": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe" }, "fr": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe" }, "gb": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default_inbound_goods" }, "ge": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" }, "gn": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default" }, "gr": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe" }, "hr": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe" }, "hu": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe" }, "id": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" }, "ie": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe" }, "in": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" }, "is": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default" }, "it": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe" }, "jp": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default_inbound_goods" }, "ke": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" }, "kg": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" }, "kh": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" }, "kr": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" }, "kz": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" }, "la": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" }, "lt": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe" }, "lu": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe" }, "lv": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe" }, "ma": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" }, "md": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" }, "me": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default" }, "mk": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default" }, "mr": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default" }, "mt": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe" }, "mx": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" }, "my": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" }, "ng": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" }, "nl": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe" }, "no": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default_inbound_goods" }, "np": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" }, "nz": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default_inbound_goods" }, "om": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default" }, "pe": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" }, "ph": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" }, "pl": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe" }, "pt": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe" }, "ro": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe" }, "rs": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default" }, "ru": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" }, "sa": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" }, "se": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe" }, "sg": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default_inbound_goods" }, "si": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe" }, "sk": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe" }, "sn": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" }, "sr": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default" }, "th": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" }, "tj": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" }, "tr": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" }, "tz": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" }, "ua": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" }, "ug": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" }, "us": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_united_states" }, "uy": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default" }, "uz": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" }, "vn": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" }, "za": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default" }, "zm": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" }, "zw": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default" } }, "title": "TaxProductRegistrationsResourceCountryOptions", "type": "object", "x-expandableFields": [ "ae", "al", "am", "ao", "at", "au", "aw", "az", "ba", "bb", "bd", "be", "bf", "bg", "bh", "bj", "bs", "by", "ca", "cd", "ch", "cl", "cm", "co", "cr", "cv", "cy", "cz", "de", "dk", "ec", "ee", "eg", "es", "et", "fi", "fr", "gb", "ge", "gn", "gr", "hr", "hu", "id", "ie", "in", "is", "it", "jp", "ke", "kg", "kh", "kr", "kz", "la", "lt", "lu", "lv", "ma", "md", "me", "mk", "mr", "mt", "mx", "my", "ng", "nl", "no", "np", "nz", "om", "pe", "ph", "pl", "pt", "ro", "rs", "ru", "sa", "se", "sg", "si", "sk", "sn", "sr", "th", "tj", "tr", "tz", "ua", "ug", "us", "uy", "uz", "vn", "za", "zm", "zw" ] }, "tax_product_registrations_resource_country_options_ca_province_standard": { "description": "", "properties": { "province": { "description": "Two-letter CA province code ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).", "maxLength": 5000, "type": "string" } }, "required": [ "province" ], "title": "TaxProductRegistrationsResourceCountryOptionsCaProvinceStandard", "type": "object", "x-expandableFields": [] }, "tax_product_registrations_resource_country_options_canada": { "description": "", "properties": { "province_standard": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_ca_province_standard" }, "type": { "description": "Type of registration in Canada.", "enum": [ "province_standard", "simplified", "standard" ], "type": "string" } }, "required": [ "type" ], "title": "TaxProductRegistrationsResourceCountryOptionsCanada", "type": "object", "x-expandableFields": [ "province_standard" ] }, "tax_product_registrations_resource_country_options_default": { "description": "", "properties": { "type": { "description": "Type of registration in `country`.", "enum": [ "standard" ], "type": "string" } }, "required": [ "type" ], "title": "TaxProductRegistrationsResourceCountryOptionsDefault", "type": "object", "x-expandableFields": [] }, "tax_product_registrations_resource_country_options_default_inbound_goods": { "description": "", "properties": { "standard": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default_standard" }, "type": { "description": "Type of registration in `country`.", "enum": [ "standard" ], "type": "string" } }, "required": [ "type" ], "title": "TaxProductRegistrationsResourceCountryOptionsDefaultInboundGoods", "type": "object", "x-expandableFields": [ "standard" ] }, "tax_product_registrations_resource_country_options_default_standard": { "description": "", "properties": { "place_of_supply_scheme": { "description": "Place of supply scheme used in an Default standard registration.", "enum": [ "inbound_goods", "standard" ], "type": "string" } }, "required": [ "place_of_supply_scheme" ], "title": "TaxProductRegistrationsResourceCountryOptionsDefaultStandard", "type": "object", "x-expandableFields": [] }, "tax_product_registrations_resource_country_options_eu_standard": { "description": "", "properties": { "place_of_supply_scheme": { "description": "Place of supply scheme used in an EU standard registration.", "enum": [ "inbound_goods", "small_seller", "standard" ], "type": "string" } }, "required": [ "place_of_supply_scheme" ], "title": "TaxProductRegistrationsResourceCountryOptionsEuStandard", "type": "object", "x-expandableFields": [] }, "tax_product_registrations_resource_country_options_europe": { "description": "", "properties": { "standard": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_eu_standard" }, "type": { "description": "Type of registration in an EU country.", "enum": [ "ioss", "oss_non_union", "oss_union", "standard" ], "type": "string" } }, "required": [ "type" ], "title": "TaxProductRegistrationsResourceCountryOptionsEurope", "type": "object", "x-expandableFields": [ "standard" ] }, "tax_product_registrations_resource_country_options_simplified": { "description": "", "properties": { "type": { "description": "Type of registration in `country`.", "enum": [ "simplified" ], "type": "string" } }, "required": [ "type" ], "title": "TaxProductRegistrationsResourceCountryOptionsSimplified", "type": "object", "x-expandableFields": [] }, "tax_product_registrations_resource_country_options_united_states": { "description": "", "properties": { "local_amusement_tax": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_us_local_amusement_tax" }, "local_lease_tax": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_us_local_lease_tax" }, "state": { "description": "Two-letter US state code ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).", "maxLength": 5000, "type": "string" }, "state_sales_tax": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_us_state_sales_tax" }, "type": { "description": "Type of registration in the US.", "enum": [ "local_amusement_tax", "local_lease_tax", "state_communications_tax", "state_retail_delivery_fee", "state_sales_tax" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "state", "type" ], "title": "TaxProductRegistrationsResourceCountryOptionsUnitedStates", "type": "object", "x-expandableFields": [ "local_amusement_tax", "local_lease_tax", "state_sales_tax" ] }, "tax_product_registrations_resource_country_options_us_local_amusement_tax": { "description": "", "properties": { "jurisdiction": { "description": "A [FIPS code](https://www.census.gov/library/reference/code-lists/ansi.html) representing the local jurisdiction.", "maxLength": 5000, "type": "string" } }, "required": [ "jurisdiction" ], "title": "TaxProductRegistrationsResourceCountryOptionsUsLocalAmusementTax", "type": "object", "x-expandableFields": [] }, "tax_product_registrations_resource_country_options_us_local_lease_tax": { "description": "", "properties": { "jurisdiction": { "description": "A [FIPS code](https://www.census.gov/library/reference/code-lists/ansi.html) representing the local jurisdiction.", "maxLength": 5000, "type": "string" } }, "required": [ "jurisdiction" ], "title": "TaxProductRegistrationsResourceCountryOptionsUsLocalLeaseTax", "type": "object", "x-expandableFields": [] }, "tax_product_registrations_resource_country_options_us_state_sales_tax": { "description": "", "properties": { "elections": { "description": "Elections for the state sales tax registration.", "items": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_us_state_sales_tax_election" }, "type": "array" } }, "title": "TaxProductRegistrationsResourceCountryOptionsUsStateSalesTax", "type": "object", "x-expandableFields": [ "elections" ] }, "tax_product_registrations_resource_country_options_us_state_sales_tax_election": { "description": "", "properties": { "jurisdiction": { "description": "A [FIPS code](https://www.census.gov/library/reference/code-lists/ansi.html) representing the local jurisdiction.", "maxLength": 5000, "type": "string" }, "type": { "description": "The type of the election for the state sales tax registration.", "enum": [ "local_use_tax", "simplified_sellers_use_tax", "single_local_use_tax" ], "type": "string" } }, "required": [ "type" ], "title": "TaxProductRegistrationsResourceCountryOptionsUsStateSalesTaxElection", "type": "object", "x-expandableFields": [] }, "tax_product_resource_customer_details": { "description": "", "properties": { "address": { "anyOf": [ { "$ref": "#/components/schemas/tax_product_resource_postal_address" } ], "description": "The customer's postal address (for example, home or business location).", "nullable": true }, "address_source": { "description": "The type of customer address provided.", "enum": [ "billing", "shipping" ], "nullable": true, "type": "string" }, "ip_address": { "description": "The customer's IP address (IPv4 or IPv6).", "maxLength": 5000, "nullable": true, "type": "string" }, "tax_ids": { "description": "The customer's tax IDs (for example, EU VAT numbers).", "items": { "$ref": "#/components/schemas/tax_product_resource_customer_details_resource_tax_id" }, "type": "array" }, "taxability_override": { "description": "The taxability override used for taxation.", "enum": [ "customer_exempt", "none", "reverse_charge" ], "type": "string" } }, "required": [ "tax_ids", "taxability_override" ], "title": "TaxProductResourceCustomerDetails", "type": "object", "x-expandableFields": [ "address", "tax_ids" ] }, "tax_product_resource_customer_details_resource_tax_id": { "description": "", "properties": { "type": { "description": "The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `al_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, `aw_tin`, `az_tin`, `bd_bin`, `bj_ifu`, `et_tin`, `kg_tin`, `la_tin`, `cm_niu`, `cv_nif`, `bf_ifu`, or `unknown`", "enum": [ "ad_nrt", "ae_trn", "al_tin", "am_tin", "ao_tin", "ar_cuit", "au_abn", "au_arn", "aw_tin", "az_tin", "ba_tin", "bb_tin", "bd_bin", "bf_ifu", "bg_uic", "bh_vat", "bj_ifu", "bo_tin", "br_cnpj", "br_cpf", "bs_tin", "by_tin", "ca_bn", "ca_gst_hst", "ca_pst_bc", "ca_pst_mb", "ca_pst_sk", "ca_qst", "cd_nif", "ch_uid", "ch_vat", "cl_tin", "cm_niu", "cn_tin", "co_nit", "cr_tin", "cv_nif", "de_stn", "do_rcn", "ec_ruc", "eg_tin", "es_cif", "et_tin", "eu_oss_vat", "eu_vat", "gb_vat", "ge_vat", "gn_nif", "hk_br", "hr_oib", "hu_tin", "id_npwp", "il_vat", "in_gst", "is_vat", "jp_cn", "jp_rn", "jp_trn", "ke_pin", "kg_tin", "kh_tin", "kr_brn", "kz_bin", "la_tin", "li_uid", "li_vat", "ma_vat", "md_vat", "me_pib", "mk_vat", "mr_nif", "mx_rfc", "my_frp", "my_itn", "my_sst", "ng_tin", "no_vat", "no_voec", "np_pan", "nz_gst", "om_vat", "pe_ruc", "ph_tin", "ro_tin", "rs_pib", "ru_inn", "ru_kpp", "sa_vat", "sg_gst", "sg_uen", "si_tin", "sn_ninea", "sr_fin", "sv_nit", "th_vat", "tj_tin", "tr_tin", "tw_vat", "tz_vat", "ua_vat", "ug_tin", "unknown", "us_ein", "uy_ruc", "uz_tin", "uz_vat", "ve_rif", "vn_tin", "za_vat", "zm_tin", "zw_tin" ], "type": "string" }, "value": { "description": "The value of the tax ID.", "maxLength": 5000, "type": "string" } }, "required": [ "type", "value" ], "title": "TaxProductResourceCustomerDetailsResourceTaxId", "type": "object", "x-expandableFields": [] }, "tax_product_resource_jurisdiction": { "description": "", "properties": { "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "display_name": { "description": "A human-readable name for the jurisdiction imposing the tax.", "maxLength": 5000, "type": "string" }, "level": { "description": "Indicates the level of the jurisdiction imposing the tax.", "enum": [ "city", "country", "county", "district", "state" ], "type": "string" }, "state": { "description": "[ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2), without country prefix. For example, \"NY\" for New York, United States.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "country", "display_name", "level" ], "title": "TaxProductResourceJurisdiction", "type": "object", "x-expandableFields": [] }, "tax_product_resource_line_item_tax_breakdown": { "description": "", "properties": { "amount": { "description": "The amount of tax, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", "type": "integer" }, "jurisdiction": { "$ref": "#/components/schemas/tax_product_resource_jurisdiction" }, "sourcing": { "description": "Indicates whether the jurisdiction was determined by the origin (merchant's address) or destination (customer's address).", "enum": [ "destination", "origin" ], "type": "string", "x-stripeBypassValidation": true }, "tax_rate_details": { "anyOf": [ { "$ref": "#/components/schemas/tax_product_resource_line_item_tax_rate_details" } ], "description": "Details regarding the rate for this tax. This field will be `null` when the tax is not imposed, for example if the product is exempt from tax.", "nullable": true }, "taxability_reason": { "description": "The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.", "enum": [ "customer_exempt", "not_collecting", "not_subject_to_tax", "not_supported", "portion_product_exempt", "portion_reduced_rated", "portion_standard_rated", "product_exempt", "product_exempt_holiday", "proportionally_rated", "reduced_rated", "reverse_charge", "standard_rated", "taxable_basis_reduced", "zero_rated" ], "type": "string" }, "taxable_amount": { "description": "The amount on which tax is calculated, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", "type": "integer" } }, "required": [ "amount", "jurisdiction", "sourcing", "taxability_reason", "taxable_amount" ], "title": "TaxProductResourceLineItemTaxBreakdown", "type": "object", "x-expandableFields": [ "jurisdiction", "tax_rate_details" ] }, "tax_product_resource_line_item_tax_rate_details": { "description": "", "properties": { "display_name": { "description": "A localized display name for tax type, intended to be human-readable. For example, \"Local Sales and Use Tax\", \"Value-added tax (VAT)\", or \"Umsatzsteuer (USt.)\".", "maxLength": 5000, "type": "string" }, "percentage_decimal": { "description": "The tax rate percentage as a string. For example, 8.5% is represented as \"8.5\".", "maxLength": 5000, "type": "string" }, "tax_type": { "description": "The tax type, such as `vat` or `sales_tax`.", "enum": [ "amusement_tax", "communications_tax", "gst", "hst", "igst", "jct", "lease_tax", "pst", "qst", "retail_delivery_fee", "rst", "sales_tax", "service_tax", "vat" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "display_name", "percentage_decimal", "tax_type" ], "title": "TaxProductResourceLineItemTaxRateDetails", "type": "object", "x-expandableFields": [] }, "tax_product_resource_postal_address": { "description": "", "properties": { "city": { "description": "City, district, suburb, town, or village.", "maxLength": 5000, "nullable": true, "type": "string" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "line1": { "description": "Address line 1 (e.g., street, PO Box, or company name).", "maxLength": 5000, "nullable": true, "type": "string" }, "line2": { "description": "Address line 2 (e.g., apartment, suite, unit, or building).", "maxLength": 5000, "nullable": true, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "nullable": true, "type": "string" }, "state": { "description": "State/province as an [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) subdivision code, without country prefix. Example: \"NY\" or \"TX\".", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "country" ], "title": "TaxProductResourcePostalAddress", "type": "object", "x-expandableFields": [] }, "tax_product_resource_ship_from_details": { "description": "", "properties": { "address": { "$ref": "#/components/schemas/tax_product_resource_postal_address" } }, "required": [ "address" ], "title": "TaxProductResourceShipFromDetails", "type": "object", "x-expandableFields": [ "address" ] }, "tax_product_resource_tax_breakdown": { "description": "", "properties": { "amount": { "description": "The amount of tax, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", "type": "integer" }, "inclusive": { "description": "Specifies whether the tax amount is included in the line item amount.", "type": "boolean" }, "tax_rate_details": { "$ref": "#/components/schemas/tax_product_resource_tax_rate_details" }, "taxability_reason": { "description": "The reasoning behind this tax, for example, if the product is tax exempt. We might extend the possible values for this field to support new tax rules.", "enum": [ "customer_exempt", "not_collecting", "not_subject_to_tax", "not_supported", "portion_product_exempt", "portion_reduced_rated", "portion_standard_rated", "product_exempt", "product_exempt_holiday", "proportionally_rated", "reduced_rated", "reverse_charge", "standard_rated", "taxable_basis_reduced", "zero_rated" ], "type": "string" }, "taxable_amount": { "description": "The amount on which tax is calculated, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", "type": "integer" } }, "required": [ "amount", "inclusive", "tax_rate_details", "taxability_reason", "taxable_amount" ], "title": "TaxProductResourceTaxBreakdown", "type": "object", "x-expandableFields": [ "tax_rate_details" ] }, "tax_product_resource_tax_calculation_shipping_cost": { "description": "", "properties": { "amount": { "description": "The shipping amount in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount.", "type": "integer" }, "amount_tax": { "description": "The amount of tax calculated for shipping, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", "type": "integer" }, "shipping_rate": { "description": "The ID of an existing [ShippingRate](https://stripe.com/docs/api/shipping_rates/object).", "maxLength": 5000, "type": "string" }, "tax_behavior": { "description": "Specifies whether the `amount` includes taxes. If `tax_behavior=inclusive`, then the amount includes taxes.", "enum": [ "exclusive", "inclusive" ], "type": "string" }, "tax_breakdown": { "description": "Detailed account of taxes relevant to shipping cost.", "items": { "$ref": "#/components/schemas/tax_product_resource_line_item_tax_breakdown" }, "type": "array" }, "tax_code": { "description": "The [tax code](https://stripe.com/docs/tax/tax-categories) ID used for shipping.", "maxLength": 5000, "type": "string" } }, "required": [ "amount", "amount_tax", "tax_behavior", "tax_code" ], "title": "TaxProductResourceTaxCalculationShippingCost", "type": "object", "x-expandableFields": [ "tax_breakdown" ] }, "tax_product_resource_tax_rate_details": { "description": "", "properties": { "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "nullable": true, "type": "string" }, "flat_amount": { "anyOf": [ { "$ref": "#/components/schemas/tax_rate_flat_amount" } ], "description": "The amount of the tax rate when the `rate_type` is `flat_amount`. Tax rates with `rate_type` `percentage` can vary based on the transaction, resulting in this field being `null`. This field exposes the amount and currency of the flat tax rate.", "nullable": true }, "percentage_decimal": { "description": "The tax rate percentage as a string. For example, 8.5% is represented as `\"8.5\"`.", "maxLength": 5000, "type": "string" }, "rate_type": { "description": "Indicates the type of tax rate applied to the taxable amount. This value can be `null` when no tax applies to the location. This field is only present for TaxRates created by Stripe Tax.", "enum": [ "flat_amount", "percentage" ], "nullable": true, "type": "string" }, "state": { "description": "State, county, province, or region.", "maxLength": 5000, "nullable": true, "type": "string" }, "tax_type": { "description": "The tax type, such as `vat` or `sales_tax`.", "enum": [ "amusement_tax", "communications_tax", "gst", "hst", "igst", "jct", "lease_tax", "pst", "qst", "retail_delivery_fee", "rst", "sales_tax", "service_tax", "vat" ], "nullable": true, "type": "string", "x-stripeBypassValidation": true } }, "required": [ "percentage_decimal" ], "title": "TaxProductResourceTaxRateDetails", "type": "object", "x-expandableFields": [ "flat_amount" ] }, "tax_product_resource_tax_settings_defaults": { "description": "", "properties": { "tax_behavior": { "description": "Default [tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#tax-behavior) used to specify whether the price is considered inclusive of taxes or exclusive of taxes. If the item's price has a tax behavior set, it will take precedence over the default tax behavior.", "enum": [ "exclusive", "inclusive", "inferred_by_currency" ], "nullable": true, "type": "string" }, "tax_code": { "description": "Default [tax code](https://stripe.com/docs/tax/tax-categories) used to classify your products and prices.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "TaxProductResourceTaxSettingsDefaults", "type": "object", "x-expandableFields": [] }, "tax_product_resource_tax_settings_head_office": { "description": "", "properties": { "address": { "$ref": "#/components/schemas/address" } }, "required": [ "address" ], "title": "TaxProductResourceTaxSettingsHeadOffice", "type": "object", "x-expandableFields": [ "address" ] }, "tax_product_resource_tax_settings_status_details": { "description": "", "properties": { "active": { "$ref": "#/components/schemas/tax_product_resource_tax_settings_status_details_resource_active" }, "pending": { "$ref": "#/components/schemas/tax_product_resource_tax_settings_status_details_resource_pending" } }, "title": "TaxProductResourceTaxSettingsStatusDetails", "type": "object", "x-expandableFields": [ "active", "pending" ] }, "tax_product_resource_tax_settings_status_details_resource_active": { "description": "", "properties": {}, "title": "TaxProductResourceTaxSettingsStatusDetailsResourceActive", "type": "object", "x-expandableFields": [] }, "tax_product_resource_tax_settings_status_details_resource_pending": { "description": "", "properties": { "missing_fields": { "description": "The list of missing fields that are required to perform calculations. It includes the entry `head_office` when the status is `pending`. It is recommended to set the optional values even if they aren't listed as required for calculating taxes. Calculations can fail if missing fields aren't explicitly provided on every call.", "items": { "maxLength": 5000, "type": "string" }, "nullable": true, "type": "array" } }, "title": "TaxProductResourceTaxSettingsStatusDetailsResourcePending", "type": "object", "x-expandableFields": [] }, "tax_product_resource_tax_transaction_line_item_resource_reversal": { "description": "", "properties": { "original_line_item": { "description": "The `id` of the line item to reverse in the original transaction.", "maxLength": 5000, "type": "string" } }, "required": [ "original_line_item" ], "title": "TaxProductResourceTaxTransactionLineItemResourceReversal", "type": "object", "x-expandableFields": [] }, "tax_product_resource_tax_transaction_resource_reversal": { "description": "", "properties": { "original_transaction": { "description": "The `id` of the reversed `Transaction` object.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "TaxProductResourceTaxTransactionResourceReversal", "type": "object", "x-expandableFields": [] }, "tax_product_resource_tax_transaction_shipping_cost": { "description": "", "properties": { "amount": { "description": "The shipping amount in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount.", "type": "integer" }, "amount_tax": { "description": "The amount of tax calculated for shipping, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", "type": "integer" }, "shipping_rate": { "description": "The ID of an existing [ShippingRate](https://stripe.com/docs/api/shipping_rates/object).", "maxLength": 5000, "type": "string" }, "tax_behavior": { "description": "Specifies whether the `amount` includes taxes. If `tax_behavior=inclusive`, then the amount includes taxes.", "enum": [ "exclusive", "inclusive" ], "type": "string" }, "tax_code": { "description": "The [tax code](https://stripe.com/docs/tax/tax-categories) ID used for shipping.", "maxLength": 5000, "type": "string" } }, "required": [ "amount", "amount_tax", "tax_behavior", "tax_code" ], "title": "TaxProductResourceTaxTransactionShippingCost", "type": "object", "x-expandableFields": [] }, "tax_rate": { "description": "Tax rates can be applied to [invoices](/invoicing/taxes/tax-rates), [subscriptions](/billing/taxes/tax-rates) and [Checkout Sessions](/payments/checkout/use-manual-tax-rates) to collect tax.\n\nRelated guide: [Tax rates](/billing/taxes/tax-rates)", "properties": { "active": { "description": "Defaults to `true`. When set to `false`, this tax rate cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set.", "type": "boolean" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "nullable": true, "type": "string" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "description": { "description": "An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.", "maxLength": 5000, "nullable": true, "type": "string" }, "display_name": { "description": "The display name of the tax rates as it will appear to your customer on their receipt email, PDF, and the hosted invoice page.", "maxLength": 5000, "type": "string" }, "effective_percentage": { "description": "Actual/effective tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true,\nthis percentage reflects the rate actually used to calculate tax based on the product's taxability\nand whether the user is registered to collect taxes in the corresponding jurisdiction.", "nullable": true, "type": "number" }, "flat_amount": { "anyOf": [ { "$ref": "#/components/schemas/tax_rate_flat_amount" } ], "description": "The amount of the tax rate when the `rate_type` is `flat_amount`. Tax rates with `rate_type` `percentage` can vary based on the transaction, resulting in this field being `null`. This field exposes the amount and currency of the flat tax rate.", "nullable": true }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "inclusive": { "description": "This specifies if the tax rate is inclusive or exclusive.", "type": "boolean" }, "jurisdiction": { "description": "The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.", "maxLength": 5000, "nullable": true, "type": "string" }, "jurisdiction_level": { "description": "The level of the jurisdiction that imposes this tax rate. Will be `null` for manually defined tax rates.", "enum": [ "city", "country", "county", "district", "multiple", "state" ], "nullable": true, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "nullable": true, "type": "object" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "tax_rate" ], "type": "string" }, "percentage": { "description": "Tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true, this percentage includes the statutory tax rate of non-taxable jurisdictions.", "type": "number" }, "rate_type": { "description": "Indicates the type of tax rate applied to the taxable amount. This value can be `null` when no tax applies to the location. This field is only present for TaxRates created by Stripe Tax.", "enum": [ "flat_amount", "percentage" ], "nullable": true, "type": "string" }, "state": { "description": "[ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2), without country prefix. For example, \"NY\" for New York, United States.", "maxLength": 5000, "nullable": true, "type": "string" }, "tax_type": { "description": "The high-level tax type, such as `vat` or `sales_tax`.", "enum": [ "amusement_tax", "communications_tax", "gst", "hst", "igst", "jct", "lease_tax", "pst", "qst", "retail_delivery_fee", "rst", "sales_tax", "service_tax", "vat" ], "nullable": true, "type": "string", "x-stripeBypassValidation": true } }, "required": [ "active", "created", "display_name", "id", "inclusive", "livemode", "object", "percentage" ], "title": "TaxRate", "type": "object", "x-expandableFields": [ "flat_amount" ], "x-resourceId": "tax_rate" }, "tax_rate_flat_amount": { "description": "The amount of the tax rate when the `rate_type`` is `flat_amount`. Tax rates with `rate_type` `percentage` can vary based on the transaction, resulting in this field being `null`. This field exposes the amount and currency of the flat tax rate.", "properties": { "amount": { "description": "Amount of the tax when the `rate_type` is `flat_amount`. This positive integer represents how much to charge in the smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).", "type": "integer" }, "currency": { "description": "Three-letter ISO currency code, in lowercase.", "maxLength": 5000, "type": "string" } }, "required": [ "amount", "currency" ], "title": "TaxRateFlatAmount", "type": "object", "x-expandableFields": [] }, "terminal.configuration": { "description": "A Configurations object represents how features should be configured for terminal readers.\nFor information about how to use it, see the [Terminal configurations documentation](https://docs.stripe.com/terminal/fleet/configurations-overview).", "properties": { "bbpos_wisepos_e": { "$ref": "#/components/schemas/terminal_configuration_configuration_resource_device_type_specific_config" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "is_account_default": { "description": "Whether this Configuration is the default for your account", "nullable": true, "type": "boolean" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "name": { "description": "String indicating the name of the Configuration object, set by the user", "maxLength": 5000, "nullable": true, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "terminal.configuration" ], "type": "string" }, "offline": { "$ref": "#/components/schemas/terminal_configuration_configuration_resource_offline_config" }, "reboot_window": { "$ref": "#/components/schemas/terminal_configuration_configuration_resource_reboot_window" }, "stripe_s700": { "$ref": "#/components/schemas/terminal_configuration_configuration_resource_device_type_specific_config" }, "tipping": { "$ref": "#/components/schemas/terminal_configuration_configuration_resource_tipping" }, "verifone_p400": { "$ref": "#/components/schemas/terminal_configuration_configuration_resource_device_type_specific_config" }, "wifi": { "$ref": "#/components/schemas/terminal_configuration_configuration_resource_wifi_config" } }, "required": [ "id", "livemode", "object" ], "title": "TerminalConfigurationConfiguration", "type": "object", "x-expandableFields": [ "bbpos_wisepos_e", "offline", "reboot_window", "stripe_s700", "tipping", "verifone_p400", "wifi" ], "x-resourceId": "terminal.configuration" }, "terminal.connection_token": { "description": "A Connection Token is used by the Stripe Terminal SDK to connect to a reader.\n\nRelated guide: [Fleet management](https://stripe.com/docs/terminal/fleet/locations)", "properties": { "location": { "description": "The id of the location that this connection token is scoped to. Note that location scoping only applies to internet-connected readers. For more details, see [the docs on scoping connection tokens](https://docs.stripe.com/terminal/fleet/locations-and-zones?dashboard-or-api=api#connection-tokens).", "maxLength": 5000, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "terminal.connection_token" ], "type": "string" }, "secret": { "description": "Your application should pass this token to the Stripe Terminal SDK.", "maxLength": 5000, "type": "string" } }, "required": [ "object", "secret" ], "title": "TerminalConnectionToken", "type": "object", "x-expandableFields": [], "x-resourceId": "terminal.connection_token" }, "terminal.location": { "description": "A Location represents a grouping of readers.\n\nRelated guide: [Fleet management](https://stripe.com/docs/terminal/fleet/locations)", "properties": { "address": { "$ref": "#/components/schemas/address" }, "configuration_overrides": { "description": "The ID of a configuration that will be used to customize all readers in this location.", "maxLength": 5000, "type": "string" }, "display_name": { "description": "The display name of the location.", "maxLength": 5000, "type": "string" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "type": "object" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "terminal.location" ], "type": "string" } }, "required": [ "address", "display_name", "id", "livemode", "metadata", "object" ], "title": "TerminalLocationLocation", "type": "object", "x-expandableFields": [ "address" ], "x-resourceId": "terminal.location" }, "terminal.reader": { "description": "A Reader represents a physical device for accepting payment details.\n\nRelated guide: [Connecting to a reader](https://stripe.com/docs/terminal/payments/connect-reader)", "properties": { "action": { "anyOf": [ { "$ref": "#/components/schemas/terminal_reader_reader_resource_reader_action" } ], "description": "The most recent action performed by the reader.", "nullable": true }, "device_sw_version": { "description": "The current software version of the reader.", "maxLength": 5000, "nullable": true, "type": "string" }, "device_type": { "description": "Device type of the reader.", "enum": [ "bbpos_chipper2x", "bbpos_wisepad3", "bbpos_wisepos_e", "mobile_phone_reader", "simulated_stripe_s700", "simulated_wisepos_e", "stripe_m2", "stripe_s700", "verifone_P400" ], "type": "string", "x-stripeBypassValidation": true }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "ip_address": { "description": "The local IP address of the reader.", "maxLength": 5000, "nullable": true, "type": "string" }, "label": { "description": "Custom label given to the reader for easier identification.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "location": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/terminal.location" } ], "description": "The location identifier of the reader.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/terminal.location" } ] } }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "type": "object" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "terminal.reader" ], "type": "string" }, "serial_number": { "description": "Serial number of the reader.", "maxLength": 5000, "type": "string" }, "status": { "description": "The networking status of the reader. We do not recommend using this field in flows that may block taking payments.", "enum": [ "offline", "online" ], "nullable": true, "type": "string" } }, "required": [ "device_type", "id", "label", "livemode", "metadata", "object", "serial_number" ], "title": "TerminalReaderReader", "type": "object", "x-expandableFields": [ "action", "location" ], "x-resourceId": "terminal.reader" }, "terminal_configuration_configuration_resource_currency_specific_config": { "description": "", "properties": { "fixed_amounts": { "description": "Fixed amounts displayed when collecting a tip", "items": { "type": "integer" }, "nullable": true, "type": "array" }, "percentages": { "description": "Percentages displayed when collecting a tip", "items": { "type": "integer" }, "nullable": true, "type": "array" }, "smart_tip_threshold": { "description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed", "type": "integer" } }, "title": "TerminalConfigurationConfigurationResourceCurrencySpecificConfig", "type": "object", "x-expandableFields": [] }, "terminal_configuration_configuration_resource_device_type_specific_config": { "description": "", "properties": { "splashscreen": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/file" } ], "description": "A File ID representing an image to display on the reader", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/file" } ] } } }, "title": "TerminalConfigurationConfigurationResourceDeviceTypeSpecificConfig", "type": "object", "x-expandableFields": [ "splashscreen" ] }, "terminal_configuration_configuration_resource_enterprise_peap_wifi": { "description": "", "properties": { "ca_certificate_file": { "description": "A File ID representing a PEM file containing the server certificate", "maxLength": 5000, "type": "string" }, "password": { "description": "Password for connecting to the WiFi network", "maxLength": 5000, "type": "string" }, "ssid": { "description": "Name of the WiFi network", "maxLength": 5000, "type": "string" }, "username": { "description": "Username for connecting to the WiFi network", "maxLength": 5000, "type": "string" } }, "required": [ "password", "ssid", "username" ], "title": "TerminalConfigurationConfigurationResourceEnterprisePEAPWifi", "type": "object", "x-expandableFields": [] }, "terminal_configuration_configuration_resource_enterprise_tls_wifi": { "description": "", "properties": { "ca_certificate_file": { "description": "A File ID representing a PEM file containing the server certificate", "maxLength": 5000, "type": "string" }, "client_certificate_file": { "description": "A File ID representing a PEM file containing the client certificate", "maxLength": 5000, "type": "string" }, "private_key_file": { "description": "A File ID representing a PEM file containing the client RSA private key", "maxLength": 5000, "type": "string" }, "private_key_file_password": { "description": "Password for the private key file", "maxLength": 5000, "type": "string" }, "ssid": { "description": "Name of the WiFi network", "maxLength": 5000, "type": "string" } }, "required": [ "client_certificate_file", "private_key_file", "ssid" ], "title": "TerminalConfigurationConfigurationResourceEnterpriseTLSWifi", "type": "object", "x-expandableFields": [] }, "terminal_configuration_configuration_resource_offline_config": { "description": "", "properties": { "enabled": { "description": "Determines whether to allow transactions to be collected while reader is offline. Defaults to false.", "nullable": true, "type": "boolean" } }, "title": "TerminalConfigurationConfigurationResourceOfflineConfig", "type": "object", "x-expandableFields": [] }, "terminal_configuration_configuration_resource_personal_psk_wifi": { "description": "", "properties": { "password": { "description": "Password for connecting to the WiFi network", "maxLength": 5000, "type": "string" }, "ssid": { "description": "Name of the WiFi network", "maxLength": 5000, "type": "string" } }, "required": [ "password", "ssid" ], "title": "TerminalConfigurationConfigurationResourcePersonalPSKWifi", "type": "object", "x-expandableFields": [] }, "terminal_configuration_configuration_resource_reboot_window": { "description": "", "properties": { "end_hour": { "description": "Integer between 0 to 23 that represents the end hour of the reboot time window. The value must be different than the start_hour.", "type": "integer" }, "start_hour": { "description": "Integer between 0 to 23 that represents the start hour of the reboot time window.", "type": "integer" } }, "required": [ "end_hour", "start_hour" ], "title": "TerminalConfigurationConfigurationResourceRebootWindow", "type": "object", "x-expandableFields": [] }, "terminal_configuration_configuration_resource_tipping": { "description": "", "properties": { "aed": { "$ref": "#/components/schemas/terminal_configuration_configuration_resource_currency_specific_config" }, "aud": { "$ref": "#/components/schemas/terminal_configuration_configuration_resource_currency_specific_config" }, "bgn": { "$ref": "#/components/schemas/terminal_configuration_configuration_resource_currency_specific_config" }, "cad": { "$ref": "#/components/schemas/terminal_configuration_configuration_resource_currency_specific_config" }, "chf": { "$ref": "#/components/schemas/terminal_configuration_configuration_resource_currency_specific_config" }, "czk": { "$ref": "#/components/schemas/terminal_configuration_configuration_resource_currency_specific_config" }, "dkk": { "$ref": "#/components/schemas/terminal_configuration_configuration_resource_currency_specific_config" }, "eur": { "$ref": "#/components/schemas/terminal_configuration_configuration_resource_currency_specific_config" }, "gbp": { "$ref": "#/components/schemas/terminal_configuration_configuration_resource_currency_specific_config" }, "hkd": { "$ref": "#/components/schemas/terminal_configuration_configuration_resource_currency_specific_config" }, "huf": { "$ref": "#/components/schemas/terminal_configuration_configuration_resource_currency_specific_config" }, "jpy": { "$ref": "#/components/schemas/terminal_configuration_configuration_resource_currency_specific_config" }, "mxn": { "$ref": "#/components/schemas/terminal_configuration_configuration_resource_currency_specific_config" }, "myr": { "$ref": "#/components/schemas/terminal_configuration_configuration_resource_currency_specific_config" }, "nok": { "$ref": "#/components/schemas/terminal_configuration_configuration_resource_currency_specific_config" }, "nzd": { "$ref": "#/components/schemas/terminal_configuration_configuration_resource_currency_specific_config" }, "pln": { "$ref": "#/components/schemas/terminal_configuration_configuration_resource_currency_specific_config" }, "ron": { "$ref": "#/components/schemas/terminal_configuration_configuration_resource_currency_specific_config" }, "sek": { "$ref": "#/components/schemas/terminal_configuration_configuration_resource_currency_specific_config" }, "sgd": { "$ref": "#/components/schemas/terminal_configuration_configuration_resource_currency_specific_config" }, "usd": { "$ref": "#/components/schemas/terminal_configuration_configuration_resource_currency_specific_config" } }, "title": "TerminalConfigurationConfigurationResourceTipping", "type": "object", "x-expandableFields": [ "aed", "aud", "bgn", "cad", "chf", "czk", "dkk", "eur", "gbp", "hkd", "huf", "jpy", "mxn", "myr", "nok", "nzd", "pln", "ron", "sek", "sgd", "usd" ] }, "terminal_configuration_configuration_resource_wifi_config": { "description": "", "properties": { "enterprise_eap_peap": { "$ref": "#/components/schemas/terminal_configuration_configuration_resource_enterprise_peap_wifi" }, "enterprise_eap_tls": { "$ref": "#/components/schemas/terminal_configuration_configuration_resource_enterprise_tls_wifi" }, "personal_psk": { "$ref": "#/components/schemas/terminal_configuration_configuration_resource_personal_psk_wifi" }, "type": { "description": "Security type of the WiFi network. The hash with the corresponding name contains the credentials for this security type.", "enum": [ "enterprise_eap_peap", "enterprise_eap_tls", "personal_psk" ], "type": "string" } }, "required": [ "type" ], "title": "TerminalConfigurationConfigurationResourceWifiConfig", "type": "object", "x-expandableFields": [ "enterprise_eap_peap", "enterprise_eap_tls", "personal_psk" ] }, "terminal_reader_reader_resource_cart": { "description": "Represents a cart to be displayed on the reader", "properties": { "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "line_items": { "description": "List of line items in the cart.", "items": { "$ref": "#/components/schemas/terminal_reader_reader_resource_line_item" }, "type": "array" }, "tax": { "description": "Tax amount for the entire cart. A positive integer in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", "nullable": true, "type": "integer" }, "total": { "description": "Total amount for the entire cart, including tax. A positive integer in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", "type": "integer" } }, "required": [ "currency", "line_items", "total" ], "title": "TerminalReaderReaderResourceCart", "type": "object", "x-expandableFields": [ "line_items" ] }, "terminal_reader_reader_resource_choice": { "description": "Choice to be selected on a Reader", "properties": { "id": { "description": "The id to be selected", "maxLength": 5000, "nullable": true, "type": "string" }, "style": { "description": "The button style for the choice", "enum": [ "primary", "secondary" ], "nullable": true, "type": "string" }, "text": { "description": "The text to be selected", "maxLength": 5000, "type": "string" } }, "required": [ "text" ], "title": "TerminalReaderReaderResourceChoice", "type": "object", "x-expandableFields": [] }, "terminal_reader_reader_resource_collect_config": { "description": "Represents a per-transaction override of a reader configuration", "properties": { "enable_customer_cancellation": { "description": "Enable customer-initiated cancellation when processing this payment.", "type": "boolean" }, "skip_tipping": { "description": "Override showing a tipping selection screen on this transaction.", "type": "boolean" }, "tipping": { "$ref": "#/components/schemas/terminal_reader_reader_resource_tipping_config" } }, "title": "TerminalReaderReaderResourceCollectConfig", "type": "object", "x-expandableFields": [ "tipping" ] }, "terminal_reader_reader_resource_collect_inputs_action": { "description": "Represents a reader action to collect customer inputs", "properties": { "inputs": { "description": "List of inputs to be collected.", "items": { "$ref": "#/components/schemas/terminal_reader_reader_resource_input" }, "type": "array" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "nullable": true, "type": "object" } }, "required": [ "inputs" ], "title": "TerminalReaderReaderResourceCollectInputsAction", "type": "object", "x-expandableFields": [ "inputs" ] }, "terminal_reader_reader_resource_collect_payment_method_action": { "description": "Represents a reader action to collect a payment method", "properties": { "collect_config": { "$ref": "#/components/schemas/terminal_reader_reader_resource_collect_config" }, "payment_intent": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/payment_intent" } ], "description": "Most recent PaymentIntent processed by the reader.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/payment_intent" } ] } }, "payment_method": { "$ref": "#/components/schemas/payment_method" } }, "required": [ "payment_intent" ], "title": "TerminalReaderReaderResourceCollectPaymentMethodAction", "type": "object", "x-expandableFields": [ "collect_config", "payment_intent", "payment_method" ] }, "terminal_reader_reader_resource_confirm_config": { "description": "Represents a per-transaction override of a reader configuration", "properties": { "return_url": { "description": "If the customer doesn't abandon authenticating the payment, they're redirected to this URL after completion.", "maxLength": 5000, "type": "string" } }, "title": "TerminalReaderReaderResourceConfirmConfig", "type": "object", "x-expandableFields": [] }, "terminal_reader_reader_resource_confirm_payment_intent_action": { "description": "Represents a reader action to confirm a payment", "properties": { "confirm_config": { "$ref": "#/components/schemas/terminal_reader_reader_resource_confirm_config" }, "payment_intent": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/payment_intent" } ], "description": "Most recent PaymentIntent processed by the reader.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/payment_intent" } ] } } }, "required": [ "payment_intent" ], "title": "TerminalReaderReaderResourceConfirmPaymentIntentAction", "type": "object", "x-expandableFields": [ "confirm_config", "payment_intent" ] }, "terminal_reader_reader_resource_custom_text": { "description": "Represents custom text to be displayed when collecting the input using a reader", "properties": { "description": { "description": "Customize the default description for this input", "maxLength": 5000, "nullable": true, "type": "string" }, "skip_button": { "description": "Customize the default label for this input's skip button", "maxLength": 5000, "nullable": true, "type": "string" }, "submit_button": { "description": "Customize the default label for this input's submit button", "maxLength": 5000, "nullable": true, "type": "string" }, "title": { "description": "Customize the default title for this input", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "TerminalReaderReaderResourceCustomText", "type": "object", "x-expandableFields": [] }, "terminal_reader_reader_resource_email": { "description": "Information about a email being collected using a reader", "properties": { "value": { "description": "The collected email address", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "TerminalReaderReaderResourceEmail", "type": "object", "x-expandableFields": [] }, "terminal_reader_reader_resource_input": { "description": "Represents an input to be collected using the reader", "properties": { "custom_text": { "anyOf": [ { "$ref": "#/components/schemas/terminal_reader_reader_resource_custom_text" } ], "description": "Default text of input being collected.", "nullable": true }, "email": { "$ref": "#/components/schemas/terminal_reader_reader_resource_email" }, "numeric": { "$ref": "#/components/schemas/terminal_reader_reader_resource_numeric" }, "phone": { "$ref": "#/components/schemas/terminal_reader_reader_resource_phone" }, "required": { "description": "Indicate that this input is required, disabling the skip button.", "nullable": true, "type": "boolean" }, "selection": { "$ref": "#/components/schemas/terminal_reader_reader_resource_selection" }, "signature": { "$ref": "#/components/schemas/terminal_reader_reader_resource_signature" }, "skipped": { "description": "Indicate that this input was skipped by the user.", "type": "boolean" }, "text": { "$ref": "#/components/schemas/terminal_reader_reader_resource_text" }, "toggles": { "description": "List of toggles being collected. Values are present if collection is complete.", "items": { "$ref": "#/components/schemas/terminal_reader_reader_resource_toggle" }, "nullable": true, "type": "array" }, "type": { "description": "Type of input being collected.", "enum": [ "email", "numeric", "phone", "selection", "signature", "text" ], "type": "string" } }, "required": [ "type" ], "title": "TerminalReaderReaderResourceInput", "type": "object", "x-expandableFields": [ "custom_text", "email", "numeric", "phone", "selection", "signature", "text", "toggles" ] }, "terminal_reader_reader_resource_line_item": { "description": "Represents a line item to be displayed on the reader", "properties": { "amount": { "description": "The amount of the line item. A positive integer in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", "type": "integer" }, "description": { "description": "Description of the line item.", "maxLength": 5000, "type": "string" }, "quantity": { "description": "The quantity of the line item.", "type": "integer" } }, "required": [ "amount", "description", "quantity" ], "title": "TerminalReaderReaderResourceLineItem", "type": "object", "x-expandableFields": [] }, "terminal_reader_reader_resource_numeric": { "description": "Information about a number being collected using a reader", "properties": { "value": { "description": "The collected number", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "TerminalReaderReaderResourceNumeric", "type": "object", "x-expandableFields": [] }, "terminal_reader_reader_resource_phone": { "description": "Information about a phone number being collected using a reader", "properties": { "value": { "description": "The collected phone number", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "TerminalReaderReaderResourcePhone", "type": "object", "x-expandableFields": [] }, "terminal_reader_reader_resource_process_config": { "description": "Represents a per-transaction override of a reader configuration", "properties": { "enable_customer_cancellation": { "description": "Enable customer-initiated cancellation when processing this payment.", "type": "boolean" }, "return_url": { "description": "If the customer doesn't abandon authenticating the payment, they're redirected to this URL after completion.", "maxLength": 5000, "type": "string" }, "skip_tipping": { "description": "Override showing a tipping selection screen on this transaction.", "type": "boolean" }, "tipping": { "$ref": "#/components/schemas/terminal_reader_reader_resource_tipping_config" } }, "title": "TerminalReaderReaderResourceProcessConfig", "type": "object", "x-expandableFields": [ "tipping" ] }, "terminal_reader_reader_resource_process_payment_intent_action": { "description": "Represents a reader action to process a payment intent", "properties": { "payment_intent": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/payment_intent" } ], "description": "Most recent PaymentIntent processed by the reader.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/payment_intent" } ] } }, "process_config": { "$ref": "#/components/schemas/terminal_reader_reader_resource_process_config" } }, "required": [ "payment_intent" ], "title": "TerminalReaderReaderResourceProcessPaymentIntentAction", "type": "object", "x-expandableFields": [ "payment_intent", "process_config" ] }, "terminal_reader_reader_resource_process_setup_config": { "description": "Represents a per-setup override of a reader configuration", "properties": { "enable_customer_cancellation": { "description": "Enable customer-initiated cancellation when processing this SetupIntent.", "type": "boolean" } }, "title": "TerminalReaderReaderResourceProcessSetupConfig", "type": "object", "x-expandableFields": [] }, "terminal_reader_reader_resource_process_setup_intent_action": { "description": "Represents a reader action to process a setup intent", "properties": { "generated_card": { "description": "ID of a card PaymentMethod generated from the card_present PaymentMethod that may be attached to a Customer for future transactions. Only present if it was possible to generate a card PaymentMethod.", "maxLength": 5000, "type": "string" }, "process_config": { "$ref": "#/components/schemas/terminal_reader_reader_resource_process_setup_config" }, "setup_intent": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/setup_intent" } ], "description": "Most recent SetupIntent processed by the reader.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/setup_intent" } ] } } }, "required": [ "setup_intent" ], "title": "TerminalReaderReaderResourceProcessSetupIntentAction", "type": "object", "x-expandableFields": [ "process_config", "setup_intent" ] }, "terminal_reader_reader_resource_reader_action": { "description": "Represents an action performed by the reader", "properties": { "collect_inputs": { "$ref": "#/components/schemas/terminal_reader_reader_resource_collect_inputs_action" }, "collect_payment_method": { "$ref": "#/components/schemas/terminal_reader_reader_resource_collect_payment_method_action" }, "confirm_payment_intent": { "$ref": "#/components/schemas/terminal_reader_reader_resource_confirm_payment_intent_action" }, "failure_code": { "description": "Failure code, only set if status is `failed`.", "maxLength": 5000, "nullable": true, "type": "string" }, "failure_message": { "description": "Detailed failure message, only set if status is `failed`.", "maxLength": 5000, "nullable": true, "type": "string" }, "process_payment_intent": { "$ref": "#/components/schemas/terminal_reader_reader_resource_process_payment_intent_action" }, "process_setup_intent": { "$ref": "#/components/schemas/terminal_reader_reader_resource_process_setup_intent_action" }, "refund_payment": { "$ref": "#/components/schemas/terminal_reader_reader_resource_refund_payment_action" }, "set_reader_display": { "$ref": "#/components/schemas/terminal_reader_reader_resource_set_reader_display_action" }, "status": { "description": "Status of the action performed by the reader.", "enum": [ "failed", "in_progress", "succeeded" ], "type": "string" }, "type": { "description": "Type of action performed by the reader.", "enum": [ "collect_inputs", "collect_payment_method", "confirm_payment_intent", "process_payment_intent", "process_setup_intent", "refund_payment", "set_reader_display" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "status", "type" ], "title": "TerminalReaderReaderResourceReaderAction", "type": "object", "x-expandableFields": [ "collect_inputs", "collect_payment_method", "confirm_payment_intent", "process_payment_intent", "process_setup_intent", "refund_payment", "set_reader_display" ] }, "terminal_reader_reader_resource_refund_payment_action": { "description": "Represents a reader action to refund a payment", "properties": { "amount": { "description": "The amount being refunded.", "type": "integer" }, "charge": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/charge" } ], "description": "Charge that is being refunded.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/charge" } ] } }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "type": "object" }, "payment_intent": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/payment_intent" } ], "description": "Payment intent that is being refunded.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/payment_intent" } ] } }, "reason": { "description": "The reason for the refund.", "enum": [ "duplicate", "fraudulent", "requested_by_customer" ], "type": "string" }, "refund": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/refund" } ], "description": "Unique identifier for the refund object.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/refund" } ] } }, "refund_application_fee": { "description": "Boolean indicating whether the application fee should be refunded when refunding this charge. If a full charge refund is given, the full application fee will be refunded. Otherwise, the application fee will be refunded in an amount proportional to the amount of the charge refunded. An application fee can be refunded only by the application that created the charge.", "type": "boolean" }, "refund_payment_config": { "$ref": "#/components/schemas/terminal_reader_reader_resource_refund_payment_config" }, "reverse_transfer": { "description": "Boolean indicating whether the transfer should be reversed when refunding this charge. The transfer will be reversed proportionally to the amount being refunded (either the entire or partial amount). A transfer can be reversed only by the application that created the charge.", "type": "boolean" } }, "title": "TerminalReaderReaderResourceRefundPaymentAction", "type": "object", "x-expandableFields": [ "charge", "payment_intent", "refund", "refund_payment_config" ] }, "terminal_reader_reader_resource_refund_payment_config": { "description": "Represents a per-transaction override of a reader configuration", "properties": { "enable_customer_cancellation": { "description": "Enable customer-initiated cancellation when refunding this payment.", "type": "boolean" } }, "title": "TerminalReaderReaderResourceRefundPaymentConfig", "type": "object", "x-expandableFields": [] }, "terminal_reader_reader_resource_selection": { "description": "Information about a selection being collected using a reader", "properties": { "choices": { "description": "List of possible choices to be selected", "items": { "$ref": "#/components/schemas/terminal_reader_reader_resource_choice" }, "type": "array" }, "id": { "description": "The id of the selected choice", "maxLength": 5000, "nullable": true, "type": "string" }, "text": { "description": "The text of the selected choice", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "choices" ], "title": "TerminalReaderReaderResourceSelection", "type": "object", "x-expandableFields": [ "choices" ] }, "terminal_reader_reader_resource_set_reader_display_action": { "description": "Represents a reader action to set the reader display", "properties": { "cart": { "anyOf": [ { "$ref": "#/components/schemas/terminal_reader_reader_resource_cart" } ], "description": "Cart object to be displayed by the reader.", "nullable": true }, "type": { "description": "Type of information to be displayed by the reader.", "enum": [ "cart" ], "type": "string" } }, "required": [ "type" ], "title": "TerminalReaderReaderResourceSetReaderDisplayAction", "type": "object", "x-expandableFields": [ "cart" ] }, "terminal_reader_reader_resource_signature": { "description": "Information about a signature being collected using a reader", "properties": { "value": { "description": "The File ID of a collected signature image", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "TerminalReaderReaderResourceSignature", "type": "object", "x-expandableFields": [] }, "terminal_reader_reader_resource_text": { "description": "Information about text being collected using a reader", "properties": { "value": { "description": "The collected text value", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "TerminalReaderReaderResourceText", "type": "object", "x-expandableFields": [] }, "terminal_reader_reader_resource_tipping_config": { "description": "Represents a per-transaction tipping configuration", "properties": { "amount_eligible": { "description": "Amount used to calculate tip suggestions on tipping selection screen for this transaction. Must be a positive integer in the smallest currency unit (e.g., 100 cents to represent $1.00 or 100 to represent ¥100, a zero-decimal currency).", "type": "integer" } }, "title": "TerminalReaderReaderResourceTippingConfig", "type": "object", "x-expandableFields": [] }, "terminal_reader_reader_resource_toggle": { "description": "Information about an input's toggle", "properties": { "default_value": { "description": "The toggle's default value", "enum": [ "disabled", "enabled" ], "nullable": true, "type": "string" }, "description": { "description": "The toggle's description text", "maxLength": 5000, "nullable": true, "type": "string" }, "title": { "description": "The toggle's title text", "maxLength": 5000, "nullable": true, "type": "string" }, "value": { "description": "The toggle's collected value", "enum": [ "disabled", "enabled" ], "nullable": true, "type": "string" } }, "title": "TerminalReaderReaderResourceToggle", "type": "object", "x-expandableFields": [] }, "test_helpers.test_clock": { "description": "A test clock enables deterministic control over objects in testmode. With a test clock, you can create\nobjects at a frozen time in the past or future, and advance to a specific future time to observe webhooks and state changes. After the clock advances,\nyou can either validate the current state of your scenario (and test your assumptions), change the current state of your scenario (and test more complex scenarios), or keep advancing forward in time.", "properties": { "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "deletes_after": { "description": "Time at which this clock is scheduled to auto delete.", "format": "unix-time", "type": "integer" }, "frozen_time": { "description": "Time at which all objects belonging to this clock are frozen.", "format": "unix-time", "type": "integer" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "name": { "description": "The custom name supplied at creation.", "maxLength": 5000, "nullable": true, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "test_helpers.test_clock" ], "type": "string" }, "status": { "description": "The status of the Test Clock.", "enum": [ "advancing", "internal_failure", "ready" ], "type": "string" }, "status_details": { "$ref": "#/components/schemas/billing_clocks_resource_status_details_status_details" } }, "required": [ "created", "deletes_after", "frozen_time", "id", "livemode", "object", "status", "status_details" ], "title": "TestClock", "type": "object", "x-expandableFields": [ "status_details" ], "x-resourceId": "test_helpers.test_clock" }, "three_d_secure_details": { "description": "", "properties": { "authentication_flow": { "description": "For authenticated transactions: how the customer was authenticated by\nthe issuing bank.", "enum": [ "challenge", "frictionless" ], "nullable": true, "type": "string" }, "electronic_commerce_indicator": { "description": "The Electronic Commerce Indicator (ECI). A protocol-level field\nindicating what degree of authentication was performed.", "enum": [ "01", "02", "05", "06", "07" ], "nullable": true, "type": "string", "x-stripeBypassValidation": true }, "result": { "description": "Indicates the outcome of 3D Secure authentication.", "enum": [ "attempt_acknowledged", "authenticated", "exempted", "failed", "not_supported", "processing_error" ], "nullable": true, "type": "string" }, "result_reason": { "description": "Additional information about why 3D Secure succeeded or failed based\non the `result`.", "enum": [ "abandoned", "bypassed", "canceled", "card_not_enrolled", "network_not_supported", "protocol_error", "rejected" ], "nullable": true, "type": "string" }, "transaction_id": { "description": "The 3D Secure 1 XID or 3D Secure 2 Directory Server Transaction ID\n(dsTransId) for this payment.", "maxLength": 5000, "nullable": true, "type": "string" }, "version": { "description": "The version of 3D Secure that was used.", "enum": [ "1.0.2", "2.1.0", "2.2.0" ], "nullable": true, "type": "string", "x-stripeBypassValidation": true } }, "title": "three_d_secure_details", "type": "object", "x-expandableFields": [] }, "three_d_secure_details_charge": { "description": "", "properties": { "authentication_flow": { "description": "For authenticated transactions: how the customer was authenticated by\nthe issuing bank.", "enum": [ "challenge", "frictionless" ], "nullable": true, "type": "string" }, "electronic_commerce_indicator": { "description": "The Electronic Commerce Indicator (ECI). A protocol-level field\nindicating what degree of authentication was performed.", "enum": [ "01", "02", "05", "06", "07" ], "nullable": true, "type": "string", "x-stripeBypassValidation": true }, "exemption_indicator": { "description": "The exemption requested via 3DS and accepted by the issuer at authentication time.", "enum": [ "low_risk", "none" ], "nullable": true, "type": "string" }, "exemption_indicator_applied": { "description": "Whether Stripe requested the value of `exemption_indicator` in the transaction. This will depend on\nthe outcome of Stripe's internal risk assessment.", "type": "boolean" }, "result": { "description": "Indicates the outcome of 3D Secure authentication.", "enum": [ "attempt_acknowledged", "authenticated", "exempted", "failed", "not_supported", "processing_error" ], "nullable": true, "type": "string" }, "result_reason": { "description": "Additional information about why 3D Secure succeeded or failed based\non the `result`.", "enum": [ "abandoned", "bypassed", "canceled", "card_not_enrolled", "network_not_supported", "protocol_error", "rejected" ], "nullable": true, "type": "string" }, "transaction_id": { "description": "The 3D Secure 1 XID or 3D Secure 2 Directory Server Transaction ID\n(dsTransId) for this payment.", "maxLength": 5000, "nullable": true, "type": "string" }, "version": { "description": "The version of 3D Secure that was used.", "enum": [ "1.0.2", "2.1.0", "2.2.0" ], "nullable": true, "type": "string", "x-stripeBypassValidation": true } }, "title": "three_d_secure_details_charge", "type": "object", "x-expandableFields": [] }, "three_d_secure_usage": { "description": "", "properties": { "supported": { "description": "Whether 3D Secure is supported on this card.", "type": "boolean" } }, "required": [ "supported" ], "title": "three_d_secure_usage", "type": "object", "x-expandableFields": [] }, "thresholds_resource_usage_alert_filter": { "description": "", "properties": { "customer": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/customer" } ], "description": "Limit the scope of the alert to this customer ID", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/customer" } ] } }, "type": { "enum": [ "customer" ], "type": "string" } }, "required": [ "type" ], "title": "ThresholdsResourceUsageAlertFilter", "type": "object", "x-expandableFields": [ "customer" ] }, "thresholds_resource_usage_threshold_config": { "description": "The usage threshold alert configuration enables setting up alerts for when a certain usage threshold on a specific meter is crossed.", "properties": { "filters": { "description": "The filters allow limiting the scope of this usage alert. You can only specify up to one filter at this time.", "items": { "$ref": "#/components/schemas/thresholds_resource_usage_alert_filter" }, "nullable": true, "type": "array" }, "gte": { "description": "The value at which this alert will trigger.", "type": "integer" }, "meter": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/billing.meter" } ], "description": "The [Billing Meter](/api/billing/meter) ID whose usage is monitored.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/billing.meter" } ] } }, "recurrence": { "description": "Defines how the alert will behave.", "enum": [ "one_time" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "gte", "meter", "recurrence" ], "title": "ThresholdsResourceUsageThresholdConfig", "type": "object", "x-expandableFields": [ "filters", "meter" ] }, "token": { "description": "Tokenization is the process Stripe uses to collect sensitive card or bank\naccount details, or personally identifiable information (PII), directly from\nyour customers in a secure manner. A token representing this information is\nreturned to your server to use. Use our\n[recommended payments integrations](https://stripe.com/docs/payments) to perform this process\non the client-side. This guarantees that no sensitive card data touches your server,\nand allows your integration to operate in a PCI-compliant way.\n\nIf you can't use client-side tokenization, you can also create tokens using\nthe API with either your publishable or secret API key. If\nyour integration uses this method, you're responsible for any PCI compliance\nthat it might require, and you must keep your secret API key safe. Unlike with\nclient-side tokenization, your customer's information isn't sent directly to\nStripe, so we can't determine how it's handled or stored.\n\nYou can't store or use tokens more than once. To store card or bank account\ninformation for later use, create [Customer](https://stripe.com/docs/api#customers)\nobjects or [External accounts](/api#external_accounts).\n[Radar](https://stripe.com/docs/radar), our integrated solution for automatic fraud protection,\nperforms best with integrations that use client-side tokenization.", "properties": { "bank_account": { "$ref": "#/components/schemas/bank_account" }, "card": { "$ref": "#/components/schemas/card" }, "client_ip": { "description": "IP address of the client that generates the token.", "maxLength": 5000, "nullable": true, "type": "string" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "token" ], "type": "string" }, "type": { "description": "Type of the token: `account`, `bank_account`, `card`, or `pii`.", "maxLength": 5000, "type": "string" }, "used": { "description": "Determines if you have already used this token (you can only use tokens once).", "type": "boolean" } }, "required": [ "created", "id", "livemode", "object", "type", "used" ], "title": "Token", "type": "object", "x-expandableFields": [ "bank_account", "card" ], "x-resourceId": "token" }, "token_card_networks": { "description": "", "properties": { "preferred": { "description": "The preferred network for co-branded cards. Can be `cartes_bancaires`, `mastercard`, `visa` or `invalid_preference` if requested network is not valid for the card.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "token_card_networks", "type": "object", "x-expandableFields": [] }, "topup": { "description": "To top up your Stripe balance, you create a top-up object. You can retrieve\nindividual top-ups, as well as list all top-ups. Top-ups are identified by a\nunique, random ID.\n\nRelated guide: [Topping up your platform account](https://stripe.com/docs/connect/top-ups)", "properties": { "amount": { "description": "Amount transferred.", "type": "integer" }, "balance_transaction": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/balance_transaction" } ], "description": "ID of the balance transaction that describes the impact of this top-up on your account balance. May not be specified depending on status of top-up.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/balance_transaction" } ] } }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "maxLength": 5000, "type": "string" }, "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users.", "maxLength": 5000, "nullable": true, "type": "string" }, "expected_availability_date": { "description": "Date the funds are expected to arrive in your Stripe account for payouts. This factors in delays like weekends or bank holidays. May not be specified depending on status of top-up.", "nullable": true, "type": "integer" }, "failure_code": { "description": "Error code explaining reason for top-up failure if available (see [the errors section](https://stripe.com/docs/api#errors) for a list of codes).", "maxLength": 5000, "nullable": true, "type": "string" }, "failure_message": { "description": "Message to user further explaining reason for top-up failure if available.", "maxLength": 5000, "nullable": true, "type": "string" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "type": "object" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "topup" ], "type": "string" }, "source": { "anyOf": [ { "$ref": "#/components/schemas/source" } ], "description": "The source field is deprecated. It might not always be present in the API response.", "nullable": true }, "statement_descriptor": { "description": "Extra information about a top-up. This will appear on your source's bank statement. It must contain at least one letter.", "maxLength": 5000, "nullable": true, "type": "string" }, "status": { "description": "The status of the top-up is either `canceled`, `failed`, `pending`, `reversed`, or `succeeded`.", "enum": [ "canceled", "failed", "pending", "reversed", "succeeded" ], "type": "string" }, "transfer_group": { "description": "A string that identifies this top-up as part of a group.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "amount", "created", "currency", "id", "livemode", "metadata", "object", "status" ], "title": "Topup", "type": "object", "x-expandableFields": [ "balance_transaction", "source" ], "x-resourceId": "topup" }, "transfer": { "description": "A `Transfer` object is created when you move funds between Stripe accounts as\npart of Connect.\n\nBefore April 6, 2017, transfers also represented movement of funds from a\nStripe account to a card or bank account. This behavior has since been split\nout into a [Payout](https://stripe.com/docs/api#payout_object) object, with corresponding payout endpoints. For more\ninformation, read about the\n[transfer/payout split](https://stripe.com/docs/transfer-payout-split).\n\nRelated guide: [Creating separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers)", "properties": { "amount": { "description": "Amount in cents (or local equivalent) to be transferred.", "type": "integer" }, "amount_reversed": { "description": "Amount in cents (or local equivalent) reversed (can be less than the amount attribute on the transfer if a partial reversal was issued).", "type": "integer" }, "balance_transaction": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/balance_transaction" } ], "description": "Balance transaction that describes the impact of this transfer on your account balance.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/balance_transaction" } ] } }, "created": { "description": "Time that this record of the transfer was first created.", "format": "unix-time", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users.", "maxLength": 5000, "nullable": true, "type": "string" }, "destination": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/account" } ], "description": "ID of the Stripe account the transfer was sent to.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/account" } ] } }, "destination_payment": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/charge" } ], "description": "If the destination is a Stripe account, this will be the ID of the payment that the destination account received for the transfer.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/charge" } ] } }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "type": "object" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "transfer" ], "type": "string" }, "reversals": { "description": "A list of reversals that have been applied to the transfer.", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/transfer_reversal" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "TransferReversalList", "type": "object", "x-expandableFields": [ "data" ] }, "reversed": { "description": "Whether the transfer has been fully reversed. If the transfer is only partially reversed, this attribute will still be false.", "type": "boolean" }, "source_transaction": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/charge" } ], "description": "ID of the charge that was used to fund the transfer. If null, the transfer was funded from the available balance.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/charge" } ] } }, "source_type": { "description": "The source balance this transfer came from. One of `card`, `fpx`, or `bank_account`.", "maxLength": 5000, "type": "string" }, "transfer_group": { "description": "A string that identifies this transaction as part of a group. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) for details.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "amount", "amount_reversed", "created", "currency", "id", "livemode", "metadata", "object", "reversals", "reversed" ], "title": "Transfer", "type": "object", "x-expandableFields": [ "balance_transaction", "destination", "destination_payment", "reversals", "source_transaction" ], "x-resourceId": "transfer" }, "transfer_data": { "description": "", "properties": { "amount": { "description": "The amount transferred to the destination account. This transfer will occur automatically after the payment succeeds. If no amount is specified, by default the entire payment amount is transferred to the destination account.\n The amount must be less than or equal to the [amount](https://stripe.com/docs/api/payment_intents/object#payment_intent_object-amount), and must be a positive integer\n representing how much to transfer in the smallest currency unit (e.g., 100 cents to charge $1.00).", "type": "integer" }, "destination": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/account" } ], "description": "The account (if any) that the payment is attributed to for tax reporting, and where funds from the payment are transferred to after payment success.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/account" } ] } } }, "required": [ "destination" ], "title": "transfer_data", "type": "object", "x-expandableFields": [ "destination" ] }, "transfer_reversal": { "description": "[Stripe Connect](https://stripe.com/docs/connect) platforms can reverse transfers made to a\nconnected account, either entirely or partially, and can also specify whether\nto refund any related application fees. Transfer reversals add to the\nplatform's balance and subtract from the destination account's balance.\n\nReversing a transfer that was made for a [destination\ncharge](/docs/connect/destination-charges) is allowed only up to the amount of\nthe charge. It is possible to reverse a\n[transfer_group](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options)\ntransfer only if the destination account has enough balance to cover the\nreversal.\n\nRelated guide: [Reverse transfers](https://stripe.com/docs/connect/separate-charges-and-transfers#reverse-transfers)", "properties": { "amount": { "description": "Amount, in cents (or local equivalent).", "type": "integer" }, "balance_transaction": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/balance_transaction" } ], "description": "Balance transaction that describes the impact on your account balance.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/balance_transaction" } ] } }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "destination_payment_refund": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/refund" } ], "description": "Linked payment refund for the transfer reversal.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/refund" } ] } }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "nullable": true, "type": "object" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "transfer_reversal" ], "type": "string" }, "source_refund": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/refund" } ], "description": "ID of the refund responsible for the transfer reversal.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/refund" } ] } }, "transfer": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/transfer" } ], "description": "ID of the transfer that was reversed.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/transfer" } ] } } }, "required": [ "amount", "created", "currency", "id", "object", "transfer" ], "title": "TransferReversal", "type": "object", "x-expandableFields": [ "balance_transaction", "destination_payment_refund", "source_refund", "transfer" ], "x-resourceId": "transfer_reversal" }, "transfer_schedule": { "description": "", "properties": { "delay_days": { "description": "The number of days charges for the account will be held before being paid out.", "type": "integer" }, "interval": { "description": "How frequently funds will be paid out. One of `manual` (payouts only created via API call), `daily`, `weekly`, or `monthly`.", "maxLength": 5000, "type": "string" }, "monthly_anchor": { "description": "The day of the month funds will be paid out. Only shown if `interval` is monthly. Payouts scheduled between the 29th and 31st of the month are sent on the last day of shorter months.", "type": "integer" }, "monthly_payout_days": { "description": "The days of the month funds will be paid out. Only shown if `interval` is monthly. Payouts scheduled between the 29th and 31st of the month are sent on the last day of shorter months.", "items": { "type": "integer" }, "type": "array" }, "weekly_anchor": { "description": "The day of the week funds will be paid out, of the style 'monday', 'tuesday', etc. Only shown if `interval` is weekly.", "maxLength": 5000, "type": "string" }, "weekly_payout_days": { "description": "The days of the week when available funds are paid out, specified as an array, for example, [`monday`, `tuesday`]. Only shown if `interval` is weekly.", "items": { "enum": [ "friday", "monday", "saturday", "sunday", "thursday", "tuesday", "wednesday" ], "type": "string" }, "type": "array" } }, "required": [ "delay_days", "interval" ], "title": "TransferSchedule", "type": "object", "x-expandableFields": [] }, "transform_quantity": { "description": "", "properties": { "divide_by": { "description": "Divide usage by this number.", "type": "integer" }, "round": { "description": "After division, either round the result `up` or `down`.", "enum": [ "down", "up" ], "type": "string" } }, "required": [ "divide_by", "round" ], "title": "TransformQuantity", "type": "object", "x-expandableFields": [] }, "transform_usage": { "description": "", "properties": { "divide_by": { "description": "Divide usage by this number.", "type": "integer" }, "round": { "description": "After division, either round the result `up` or `down`.", "enum": [ "down", "up" ], "type": "string" } }, "required": [ "divide_by", "round" ], "title": "TransformUsage", "type": "object", "x-expandableFields": [] }, "treasury.credit_reversal": { "description": "You can reverse some [ReceivedCredits](https://stripe.com/docs/api#received_credits) depending on their network and source flow. Reversing a ReceivedCredit leads to the creation of a new object known as a CreditReversal.", "properties": { "amount": { "description": "Amount (in cents) transferred.", "type": "integer" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "financial_account": { "description": "The FinancialAccount to reverse funds from.", "maxLength": 5000, "type": "string" }, "hosted_regulatory_receipt_url": { "description": "A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.", "maxLength": 5000, "nullable": true, "type": "string" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "type": "object" }, "network": { "description": "The rails used to reverse the funds.", "enum": [ "ach", "stripe" ], "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "treasury.credit_reversal" ], "type": "string" }, "received_credit": { "description": "The ReceivedCredit being reversed.", "maxLength": 5000, "type": "string" }, "status": { "description": "Status of the CreditReversal", "enum": [ "canceled", "posted", "processing" ], "type": "string" }, "status_transitions": { "$ref": "#/components/schemas/treasury_received_credits_resource_status_transitions" }, "transaction": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/treasury.transaction" } ], "description": "The Transaction associated with this object.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/treasury.transaction" } ] } } }, "required": [ "amount", "created", "currency", "financial_account", "id", "livemode", "metadata", "network", "object", "received_credit", "status", "status_transitions" ], "title": "TreasuryReceivedCreditsResourceCreditReversal", "type": "object", "x-expandableFields": [ "status_transitions", "transaction" ], "x-resourceId": "treasury.credit_reversal" }, "treasury.debit_reversal": { "description": "You can reverse some [ReceivedDebits](https://stripe.com/docs/api#received_debits) depending on their network and source flow. Reversing a ReceivedDebit leads to the creation of a new object known as a DebitReversal.", "properties": { "amount": { "description": "Amount (in cents) transferred.", "type": "integer" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "financial_account": { "description": "The FinancialAccount to reverse funds from.", "maxLength": 5000, "nullable": true, "type": "string" }, "hosted_regulatory_receipt_url": { "description": "A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.", "maxLength": 5000, "nullable": true, "type": "string" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "linked_flows": { "anyOf": [ { "$ref": "#/components/schemas/treasury_received_debits_resource_debit_reversal_linked_flows" } ], "description": "Other flows linked to a DebitReversal.", "nullable": true }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "type": "object" }, "network": { "description": "The rails used to reverse the funds.", "enum": [ "ach", "card" ], "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "treasury.debit_reversal" ], "type": "string" }, "received_debit": { "description": "The ReceivedDebit being reversed.", "maxLength": 5000, "type": "string" }, "status": { "description": "Status of the DebitReversal", "enum": [ "failed", "processing", "succeeded" ], "type": "string" }, "status_transitions": { "$ref": "#/components/schemas/treasury_received_debits_resource_status_transitions" }, "transaction": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/treasury.transaction" } ], "description": "The Transaction associated with this object.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/treasury.transaction" } ] } } }, "required": [ "amount", "created", "currency", "id", "livemode", "metadata", "network", "object", "received_debit", "status", "status_transitions" ], "title": "TreasuryReceivedDebitsResourceDebitReversal", "type": "object", "x-expandableFields": [ "linked_flows", "status_transitions", "transaction" ], "x-resourceId": "treasury.debit_reversal" }, "treasury.financial_account": { "description": "Stripe Treasury provides users with a container for money called a FinancialAccount that is separate from their Payments balance.\nFinancialAccounts serve as the source and destination of Treasury’s money movement APIs.", "properties": { "active_features": { "description": "The array of paths to active Features in the Features hash.", "items": { "enum": [ "card_issuing", "deposit_insurance", "financial_addresses.aba", "financial_addresses.aba.forwarding", "inbound_transfers.ach", "intra_stripe_flows", "outbound_payments.ach", "outbound_payments.us_domestic_wire", "outbound_transfers.ach", "outbound_transfers.us_domestic_wire", "remote_deposit_capture" ], "type": "string", "x-stripeBypassValidation": true }, "type": "array" }, "balance": { "$ref": "#/components/schemas/treasury_financial_accounts_resource_balance" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "features": { "$ref": "#/components/schemas/treasury.financial_account_features" }, "financial_addresses": { "description": "The set of credentials that resolve to a FinancialAccount.", "items": { "$ref": "#/components/schemas/treasury_financial_accounts_resource_financial_address" }, "type": "array" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "is_default": { "type": "boolean" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "nullable": true, "type": "object" }, "nickname": { "description": "The nickname for the FinancialAccount.", "maxLength": 5000, "nullable": true, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "treasury.financial_account" ], "type": "string" }, "pending_features": { "description": "The array of paths to pending Features in the Features hash.", "items": { "enum": [ "card_issuing", "deposit_insurance", "financial_addresses.aba", "financial_addresses.aba.forwarding", "inbound_transfers.ach", "intra_stripe_flows", "outbound_payments.ach", "outbound_payments.us_domestic_wire", "outbound_transfers.ach", "outbound_transfers.us_domestic_wire", "remote_deposit_capture" ], "type": "string", "x-stripeBypassValidation": true }, "type": "array" }, "platform_restrictions": { "anyOf": [ { "$ref": "#/components/schemas/treasury_financial_accounts_resource_platform_restrictions" } ], "description": "The set of functionalities that the platform can restrict on the FinancialAccount.", "nullable": true }, "restricted_features": { "description": "The array of paths to restricted Features in the Features hash.", "items": { "enum": [ "card_issuing", "deposit_insurance", "financial_addresses.aba", "financial_addresses.aba.forwarding", "inbound_transfers.ach", "intra_stripe_flows", "outbound_payments.ach", "outbound_payments.us_domestic_wire", "outbound_transfers.ach", "outbound_transfers.us_domestic_wire", "remote_deposit_capture" ], "type": "string", "x-stripeBypassValidation": true }, "type": "array" }, "status": { "description": "Status of this FinancialAccount.", "enum": [ "closed", "open" ], "type": "string", "x-stripeBypassValidation": true }, "status_details": { "$ref": "#/components/schemas/treasury_financial_accounts_resource_status_details" }, "supported_currencies": { "description": "The currencies the FinancialAccount can hold a balance in. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.", "items": { "type": "string" }, "type": "array" } }, "required": [ "balance", "country", "created", "financial_addresses", "id", "livemode", "object", "status", "status_details", "supported_currencies" ], "title": "TreasuryFinancialAccountsResourceFinancialAccount", "type": "object", "x-expandableFields": [ "balance", "features", "financial_addresses", "platform_restrictions", "status_details" ], "x-resourceId": "treasury.financial_account" }, "treasury.financial_account_features": { "description": "Encodes whether a FinancialAccount has access to a particular Feature, with a `status` enum and associated `status_details`.\nStripe or the platform can control Features via the requested field.", "properties": { "card_issuing": { "$ref": "#/components/schemas/treasury_financial_accounts_resource_toggle_settings" }, "deposit_insurance": { "$ref": "#/components/schemas/treasury_financial_accounts_resource_toggle_settings" }, "financial_addresses": { "$ref": "#/components/schemas/treasury_financial_accounts_resource_financial_addresses_features" }, "inbound_transfers": { "$ref": "#/components/schemas/treasury_financial_accounts_resource_inbound_transfers" }, "intra_stripe_flows": { "$ref": "#/components/schemas/treasury_financial_accounts_resource_toggle_settings" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "treasury.financial_account_features" ], "type": "string" }, "outbound_payments": { "$ref": "#/components/schemas/treasury_financial_accounts_resource_outbound_payments" }, "outbound_transfers": { "$ref": "#/components/schemas/treasury_financial_accounts_resource_outbound_transfers" } }, "required": [ "object" ], "title": "TreasuryFinancialAccountsResourceFinancialAccountFeatures", "type": "object", "x-expandableFields": [ "card_issuing", "deposit_insurance", "financial_addresses", "inbound_transfers", "intra_stripe_flows", "outbound_payments", "outbound_transfers" ], "x-resourceId": "treasury.financial_account_features" }, "treasury.inbound_transfer": { "description": "Use [InboundTransfers](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/into/inbound-transfers) to add funds to your [FinancialAccount](https://stripe.com/docs/api#financial_accounts) via a PaymentMethod that is owned by you. The funds will be transferred via an ACH debit.\n\nRelated guide: [Moving money with Treasury using InboundTransfer objects](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/into/inbound-transfers)", "properties": { "amount": { "description": "Amount (in cents) transferred.", "type": "integer" }, "cancelable": { "description": "Returns `true` if the InboundTransfer is able to be canceled.", "type": "boolean" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users.", "maxLength": 5000, "nullable": true, "type": "string" }, "failure_details": { "anyOf": [ { "$ref": "#/components/schemas/treasury_inbound_transfers_resource_failure_details" } ], "description": "Details about this InboundTransfer's failure. Only set when status is `failed`.", "nullable": true }, "financial_account": { "description": "The FinancialAccount that received the funds.", "maxLength": 5000, "type": "string" }, "hosted_regulatory_receipt_url": { "description": "A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.", "maxLength": 5000, "nullable": true, "type": "string" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "linked_flows": { "$ref": "#/components/schemas/treasury_inbound_transfers_resource_inbound_transfer_resource_linked_flows" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "type": "object" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "treasury.inbound_transfer" ], "type": "string" }, "origin_payment_method": { "description": "The origin payment method to be debited for an InboundTransfer.", "maxLength": 5000, "nullable": true, "type": "string" }, "origin_payment_method_details": { "anyOf": [ { "$ref": "#/components/schemas/inbound_transfers" } ], "description": "Details about the PaymentMethod for an InboundTransfer.", "nullable": true }, "returned": { "description": "Returns `true` if the funds for an InboundTransfer were returned after the InboundTransfer went to the `succeeded` state.", "nullable": true, "type": "boolean" }, "statement_descriptor": { "description": "Statement descriptor shown when funds are debited from the source. Not all payment networks support `statement_descriptor`.", "maxLength": 5000, "type": "string" }, "status": { "description": "Status of the InboundTransfer: `processing`, `succeeded`, `failed`, and `canceled`. An InboundTransfer is `processing` if it is created and pending. The status changes to `succeeded` once the funds have been \"confirmed\" and a `transaction` is created and posted. The status changes to `failed` if the transfer fails.", "enum": [ "canceled", "failed", "processing", "succeeded" ], "type": "string", "x-stripeBypassValidation": true }, "status_transitions": { "$ref": "#/components/schemas/treasury_inbound_transfers_resource_inbound_transfer_resource_status_transitions" }, "transaction": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/treasury.transaction" } ], "description": "The Transaction associated with this object.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/treasury.transaction" } ] } } }, "required": [ "amount", "cancelable", "created", "currency", "financial_account", "id", "linked_flows", "livemode", "metadata", "object", "statement_descriptor", "status", "status_transitions" ], "title": "TreasuryInboundTransfersResourceInboundTransfer", "type": "object", "x-expandableFields": [ "failure_details", "linked_flows", "origin_payment_method_details", "status_transitions", "transaction" ], "x-resourceId": "treasury.inbound_transfer" }, "treasury.outbound_payment": { "description": "Use [OutboundPayments](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-payments) to send funds to another party's external bank account or [FinancialAccount](https://stripe.com/docs/api#financial_accounts). To send money to an account belonging to the same user, use an [OutboundTransfer](https://stripe.com/docs/api#outbound_transfers).\n\nSimulate OutboundPayment state changes with the `/v1/test_helpers/treasury/outbound_payments` endpoints. These methods can only be called on test mode objects.\n\nRelated guide: [Moving money with Treasury using OutboundPayment objects](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-payments)", "properties": { "amount": { "description": "Amount (in cents) transferred.", "type": "integer" }, "cancelable": { "description": "Returns `true` if the object can be canceled, and `false` otherwise.", "type": "boolean" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "customer": { "description": "ID of the [customer](https://stripe.com/docs/api/customers) to whom an OutboundPayment is sent.", "maxLength": 5000, "nullable": true, "type": "string" }, "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users.", "maxLength": 5000, "nullable": true, "type": "string" }, "destination_payment_method": { "description": "The PaymentMethod via which an OutboundPayment is sent. This field can be empty if the OutboundPayment was created using `destination_payment_method_data`.", "maxLength": 5000, "nullable": true, "type": "string" }, "destination_payment_method_details": { "anyOf": [ { "$ref": "#/components/schemas/outbound_payments_payment_method_details" } ], "description": "Details about the PaymentMethod for an OutboundPayment.", "nullable": true }, "end_user_details": { "anyOf": [ { "$ref": "#/components/schemas/treasury_outbound_payments_resource_outbound_payment_resource_end_user_details" } ], "description": "Details about the end user.", "nullable": true }, "expected_arrival_date": { "description": "The date when funds are expected to arrive in the destination account.", "format": "unix-time", "type": "integer" }, "financial_account": { "description": "The FinancialAccount that funds were pulled from.", "maxLength": 5000, "type": "string" }, "hosted_regulatory_receipt_url": { "description": "A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.", "maxLength": 5000, "nullable": true, "type": "string" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "type": "object" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "treasury.outbound_payment" ], "type": "string" }, "returned_details": { "anyOf": [ { "$ref": "#/components/schemas/treasury_outbound_payments_resource_returned_status" } ], "description": "Details about a returned OutboundPayment. Only set when the status is `returned`.", "nullable": true }, "statement_descriptor": { "description": "The description that appears on the receiving end for an OutboundPayment (for example, bank statement for external bank transfer).", "maxLength": 5000, "type": "string" }, "status": { "description": "Current status of the OutboundPayment: `processing`, `failed`, `posted`, `returned`, `canceled`. An OutboundPayment is `processing` if it has been created and is pending. The status changes to `posted` once the OutboundPayment has been \"confirmed\" and funds have left the account, or to `failed` or `canceled`. If an OutboundPayment fails to arrive at its destination, its status will change to `returned`.", "enum": [ "canceled", "failed", "posted", "processing", "returned" ], "type": "string" }, "status_transitions": { "$ref": "#/components/schemas/treasury_outbound_payments_resource_outbound_payment_resource_status_transitions" }, "tracking_details": { "anyOf": [ { "$ref": "#/components/schemas/treasury_outbound_payments_resource_outbound_payment_resource_tracking_details" } ], "description": "Details about network-specific tracking information if available.", "nullable": true }, "transaction": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/treasury.transaction" } ], "description": "The Transaction associated with this object.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/treasury.transaction" } ] } } }, "required": [ "amount", "cancelable", "created", "currency", "expected_arrival_date", "financial_account", "id", "livemode", "metadata", "object", "statement_descriptor", "status", "status_transitions", "transaction" ], "title": "TreasuryOutboundPaymentsResourceOutboundPayment", "type": "object", "x-expandableFields": [ "destination_payment_method_details", "end_user_details", "returned_details", "status_transitions", "tracking_details", "transaction" ], "x-resourceId": "treasury.outbound_payment" }, "treasury.outbound_transfer": { "description": "Use [OutboundTransfers](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-transfers) to transfer funds from a [FinancialAccount](https://stripe.com/docs/api#financial_accounts) to a PaymentMethod belonging to the same entity. To send funds to a different party, use [OutboundPayments](https://stripe.com/docs/api#outbound_payments) instead. You can send funds over ACH rails or through a domestic wire transfer to a user's own external bank account.\n\nSimulate OutboundTransfer state changes with the `/v1/test_helpers/treasury/outbound_transfers` endpoints. These methods can only be called on test mode objects.\n\nRelated guide: [Moving money with Treasury using OutboundTransfer objects](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-transfers)", "properties": { "amount": { "description": "Amount (in cents) transferred.", "type": "integer" }, "cancelable": { "description": "Returns `true` if the object can be canceled, and `false` otherwise.", "type": "boolean" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users.", "maxLength": 5000, "nullable": true, "type": "string" }, "destination_payment_method": { "description": "The PaymentMethod used as the payment instrument for an OutboundTransfer.", "maxLength": 5000, "nullable": true, "type": "string" }, "destination_payment_method_details": { "$ref": "#/components/schemas/outbound_transfers_payment_method_details" }, "expected_arrival_date": { "description": "The date when funds are expected to arrive in the destination account.", "format": "unix-time", "type": "integer" }, "financial_account": { "description": "The FinancialAccount that funds were pulled from.", "maxLength": 5000, "type": "string" }, "hosted_regulatory_receipt_url": { "description": "A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.", "maxLength": 5000, "nullable": true, "type": "string" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "type": "object" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "treasury.outbound_transfer" ], "type": "string" }, "returned_details": { "anyOf": [ { "$ref": "#/components/schemas/treasury_outbound_transfers_resource_returned_details" } ], "description": "Details about a returned OutboundTransfer. Only set when the status is `returned`.", "nullable": true }, "statement_descriptor": { "description": "Information about the OutboundTransfer to be sent to the recipient account.", "maxLength": 5000, "type": "string" }, "status": { "description": "Current status of the OutboundTransfer: `processing`, `failed`, `canceled`, `posted`, `returned`. An OutboundTransfer is `processing` if it has been created and is pending. The status changes to `posted` once the OutboundTransfer has been \"confirmed\" and funds have left the account, or to `failed` or `canceled`. If an OutboundTransfer fails to arrive at its destination, its status will change to `returned`.", "enum": [ "canceled", "failed", "posted", "processing", "returned" ], "type": "string" }, "status_transitions": { "$ref": "#/components/schemas/treasury_outbound_transfers_resource_status_transitions" }, "tracking_details": { "anyOf": [ { "$ref": "#/components/schemas/treasury_outbound_transfers_resource_outbound_transfer_resource_tracking_details" } ], "description": "Details about network-specific tracking information if available.", "nullable": true }, "transaction": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/treasury.transaction" } ], "description": "The Transaction associated with this object.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/treasury.transaction" } ] } } }, "required": [ "amount", "cancelable", "created", "currency", "destination_payment_method_details", "expected_arrival_date", "financial_account", "id", "livemode", "metadata", "object", "statement_descriptor", "status", "status_transitions", "transaction" ], "title": "TreasuryOutboundTransfersResourceOutboundTransfer", "type": "object", "x-expandableFields": [ "destination_payment_method_details", "returned_details", "status_transitions", "tracking_details", "transaction" ], "x-resourceId": "treasury.outbound_transfer" }, "treasury.received_credit": { "description": "ReceivedCredits represent funds sent to a [FinancialAccount](https://stripe.com/docs/api#financial_accounts) (for example, via ACH or wire). These money movements are not initiated from the FinancialAccount.", "properties": { "amount": { "description": "Amount (in cents) transferred.", "type": "integer" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users.", "maxLength": 5000, "type": "string" }, "failure_code": { "description": "Reason for the failure. A ReceivedCredit might fail because the receiving FinancialAccount is closed or frozen.", "enum": [ "account_closed", "account_frozen", "international_transaction", "other" ], "nullable": true, "type": "string", "x-stripeBypassValidation": true }, "financial_account": { "description": "The FinancialAccount that received the funds.", "maxLength": 5000, "nullable": true, "type": "string" }, "hosted_regulatory_receipt_url": { "description": "A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.", "maxLength": 5000, "nullable": true, "type": "string" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "initiating_payment_method_details": { "$ref": "#/components/schemas/treasury_shared_resource_initiating_payment_method_details_initiating_payment_method_details" }, "linked_flows": { "$ref": "#/components/schemas/treasury_received_credits_resource_linked_flows" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "network": { "description": "The rails used to send the funds.", "enum": [ "ach", "card", "stripe", "us_domestic_wire" ], "type": "string", "x-stripeBypassValidation": true }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "treasury.received_credit" ], "type": "string" }, "reversal_details": { "anyOf": [ { "$ref": "#/components/schemas/treasury_received_credits_resource_reversal_details" } ], "description": "Details describing when a ReceivedCredit may be reversed.", "nullable": true }, "status": { "description": "Status of the ReceivedCredit. ReceivedCredits are created either `succeeded` (approved) or `failed` (declined). If a ReceivedCredit is declined, the failure reason can be found in the `failure_code` field.", "enum": [ "failed", "succeeded" ], "type": "string", "x-stripeBypassValidation": true }, "transaction": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/treasury.transaction" } ], "description": "The Transaction associated with this object.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/treasury.transaction" } ] } } }, "required": [ "amount", "created", "currency", "description", "id", "initiating_payment_method_details", "linked_flows", "livemode", "network", "object", "status" ], "title": "TreasuryReceivedCreditsResourceReceivedCredit", "type": "object", "x-expandableFields": [ "initiating_payment_method_details", "linked_flows", "reversal_details", "transaction" ], "x-resourceId": "treasury.received_credit" }, "treasury.received_debit": { "description": "ReceivedDebits represent funds pulled from a [FinancialAccount](https://stripe.com/docs/api#financial_accounts). These are not initiated from the FinancialAccount.", "properties": { "amount": { "description": "Amount (in cents) transferred.", "type": "integer" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users.", "maxLength": 5000, "type": "string" }, "failure_code": { "description": "Reason for the failure. A ReceivedDebit might fail because the FinancialAccount doesn't have sufficient funds, is closed, or is frozen.", "enum": [ "account_closed", "account_frozen", "insufficient_funds", "international_transaction", "other" ], "nullable": true, "type": "string" }, "financial_account": { "description": "The FinancialAccount that funds were pulled from.", "maxLength": 5000, "nullable": true, "type": "string" }, "hosted_regulatory_receipt_url": { "description": "A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.", "maxLength": 5000, "nullable": true, "type": "string" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "initiating_payment_method_details": { "$ref": "#/components/schemas/treasury_shared_resource_initiating_payment_method_details_initiating_payment_method_details" }, "linked_flows": { "$ref": "#/components/schemas/treasury_received_debits_resource_linked_flows" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "network": { "description": "The network used for the ReceivedDebit.", "enum": [ "ach", "card", "stripe" ], "type": "string", "x-stripeBypassValidation": true }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "treasury.received_debit" ], "type": "string" }, "reversal_details": { "anyOf": [ { "$ref": "#/components/schemas/treasury_received_debits_resource_reversal_details" } ], "description": "Details describing when a ReceivedDebit might be reversed.", "nullable": true }, "status": { "description": "Status of the ReceivedDebit. ReceivedDebits are created with a status of either `succeeded` (approved) or `failed` (declined). The failure reason can be found under the `failure_code`.", "enum": [ "failed", "succeeded" ], "type": "string", "x-stripeBypassValidation": true }, "transaction": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/treasury.transaction" } ], "description": "The Transaction associated with this object.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/treasury.transaction" } ] } } }, "required": [ "amount", "created", "currency", "description", "id", "linked_flows", "livemode", "network", "object", "status" ], "title": "TreasuryReceivedDebitsResourceReceivedDebit", "type": "object", "x-expandableFields": [ "initiating_payment_method_details", "linked_flows", "reversal_details", "transaction" ], "x-resourceId": "treasury.received_debit" }, "treasury.transaction": { "description": "Transactions represent changes to a [FinancialAccount's](https://stripe.com/docs/api#financial_accounts) balance.", "properties": { "amount": { "description": "Amount (in cents) transferred.", "type": "integer" }, "balance_impact": { "$ref": "#/components/schemas/treasury_transactions_resource_balance_impact" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users.", "maxLength": 5000, "type": "string" }, "entries": { "description": "A list of TransactionEntries that are part of this Transaction. This cannot be expanded in any list endpoints.", "nullable": true, "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/treasury.transaction_entry" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/treasury/transaction_entries", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "TreasuryTransactionsResourceTransactionEntryList", "type": "object", "x-expandableFields": [ "data" ] }, "financial_account": { "description": "The FinancialAccount associated with this object.", "maxLength": 5000, "type": "string" }, "flow": { "description": "ID of the flow that created the Transaction.", "maxLength": 5000, "nullable": true, "type": "string" }, "flow_details": { "anyOf": [ { "$ref": "#/components/schemas/treasury_transactions_resource_flow_details" } ], "description": "Details of the flow that created the Transaction.", "nullable": true }, "flow_type": { "description": "Type of the flow that created the Transaction.", "enum": [ "credit_reversal", "debit_reversal", "inbound_transfer", "issuing_authorization", "other", "outbound_payment", "outbound_transfer", "received_credit", "received_debit" ], "type": "string" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "treasury.transaction" ], "type": "string" }, "status": { "description": "Status of the Transaction.", "enum": [ "open", "posted", "void" ], "type": "string" }, "status_transitions": { "$ref": "#/components/schemas/treasury_transactions_resource_abstract_transaction_resource_status_transitions" } }, "required": [ "amount", "balance_impact", "created", "currency", "description", "financial_account", "flow_type", "id", "livemode", "object", "status", "status_transitions" ], "title": "TreasuryTransactionsResourceTransaction", "type": "object", "x-expandableFields": [ "balance_impact", "entries", "flow_details", "status_transitions" ], "x-resourceId": "treasury.transaction" }, "treasury.transaction_entry": { "description": "TransactionEntries represent individual units of money movements within a single [Transaction](https://stripe.com/docs/api#transactions).", "properties": { "balance_impact": { "$ref": "#/components/schemas/treasury_transactions_resource_balance_impact" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "effective_at": { "description": "When the TransactionEntry will impact the FinancialAccount's balance.", "format": "unix-time", "type": "integer" }, "financial_account": { "description": "The FinancialAccount associated with this object.", "maxLength": 5000, "type": "string" }, "flow": { "description": "Token of the flow associated with the TransactionEntry.", "maxLength": 5000, "nullable": true, "type": "string" }, "flow_details": { "anyOf": [ { "$ref": "#/components/schemas/treasury_transactions_resource_flow_details" } ], "description": "Details of the flow associated with the TransactionEntry.", "nullable": true }, "flow_type": { "description": "Type of the flow associated with the TransactionEntry.", "enum": [ "credit_reversal", "debit_reversal", "inbound_transfer", "issuing_authorization", "other", "outbound_payment", "outbound_transfer", "received_credit", "received_debit" ], "type": "string" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "treasury.transaction_entry" ], "type": "string" }, "transaction": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/treasury.transaction" } ], "description": "The Transaction associated with this object.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/treasury.transaction" } ] } }, "type": { "description": "The specific money movement that generated the TransactionEntry.", "enum": [ "credit_reversal", "credit_reversal_posting", "debit_reversal", "inbound_transfer", "inbound_transfer_return", "issuing_authorization_hold", "issuing_authorization_release", "other", "outbound_payment", "outbound_payment_cancellation", "outbound_payment_failure", "outbound_payment_posting", "outbound_payment_return", "outbound_transfer", "outbound_transfer_cancellation", "outbound_transfer_failure", "outbound_transfer_posting", "outbound_transfer_return", "received_credit", "received_debit" ], "type": "string" } }, "required": [ "balance_impact", "created", "currency", "effective_at", "financial_account", "flow_type", "id", "livemode", "object", "transaction", "type" ], "title": "TreasuryTransactionsResourceTransactionEntry", "type": "object", "x-expandableFields": [ "balance_impact", "flow_details", "transaction" ], "x-resourceId": "treasury.transaction_entry" }, "treasury_financial_accounts_resource_aba_record": { "description": "ABA Records contain U.S. bank account details per the ABA format.", "properties": { "account_holder_name": { "description": "The name of the person or business that owns the bank account.", "maxLength": 5000, "type": "string" }, "account_number": { "description": "The account number.", "maxLength": 5000, "nullable": true, "type": "string" }, "account_number_last4": { "description": "The last four characters of the account number.", "maxLength": 5000, "type": "string" }, "bank_name": { "description": "Name of the bank.", "maxLength": 5000, "type": "string" }, "routing_number": { "description": "Routing number for the account.", "maxLength": 5000, "type": "string" } }, "required": [ "account_holder_name", "account_number_last4", "bank_name", "routing_number" ], "title": "TreasuryFinancialAccountsResourceABARecord", "type": "object", "x-expandableFields": [] }, "treasury_financial_accounts_resource_aba_toggle_settings": { "description": "Toggle settings for enabling/disabling the ABA address feature", "properties": { "requested": { "description": "Whether the FinancialAccount should have the Feature.", "type": "boolean" }, "status": { "description": "Whether the Feature is operational.", "enum": [ "active", "pending", "restricted" ], "type": "string" }, "status_details": { "description": "Additional details; includes at least one entry when the status is not `active`.", "items": { "$ref": "#/components/schemas/treasury_financial_accounts_resource_toggles_setting_status_details" }, "type": "array" } }, "required": [ "requested", "status", "status_details" ], "title": "TreasuryFinancialAccountsResourceAbaToggleSettings", "type": "object", "x-expandableFields": [ "status_details" ] }, "treasury_financial_accounts_resource_balance": { "description": "Balance information for the FinancialAccount", "properties": { "cash": { "additionalProperties": { "type": "integer" }, "description": "Funds the user can spend right now.", "type": "object" }, "inbound_pending": { "additionalProperties": { "type": "integer" }, "description": "Funds not spendable yet, but will become available at a later time.", "type": "object" }, "outbound_pending": { "additionalProperties": { "type": "integer" }, "description": "Funds in the account, but not spendable because they are being held for pending outbound flows.", "type": "object" } }, "required": [ "cash", "inbound_pending", "outbound_pending" ], "title": "TreasuryFinancialAccountsResourceBalance", "type": "object", "x-expandableFields": [] }, "treasury_financial_accounts_resource_closed_status_details": { "description": "", "properties": { "reasons": { "description": "The array that contains reasons for a FinancialAccount closure.", "items": { "enum": [ "account_rejected", "closed_by_platform", "other" ], "type": "string" }, "type": "array" } }, "required": [ "reasons" ], "title": "TreasuryFinancialAccountsResourceClosedStatusDetails", "type": "object", "x-expandableFields": [] }, "treasury_financial_accounts_resource_financial_address": { "description": "FinancialAddresses contain identifying information that resolves to a FinancialAccount.", "properties": { "aba": { "$ref": "#/components/schemas/treasury_financial_accounts_resource_aba_record" }, "supported_networks": { "description": "The list of networks that the address supports", "items": { "enum": [ "ach", "us_domestic_wire" ], "type": "string", "x-stripeBypassValidation": true }, "type": "array" }, "type": { "description": "The type of financial address", "enum": [ "aba" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "TreasuryFinancialAccountsResourceFinancialAddress", "type": "object", "x-expandableFields": [ "aba" ] }, "treasury_financial_accounts_resource_financial_addresses_features": { "description": "Settings related to Financial Addresses features on a Financial Account", "properties": { "aba": { "$ref": "#/components/schemas/treasury_financial_accounts_resource_aba_toggle_settings" } }, "title": "TreasuryFinancialAccountsResourceFinancialAddressesFeatures", "type": "object", "x-expandableFields": [ "aba" ] }, "treasury_financial_accounts_resource_inbound_ach_toggle_settings": { "description": "Toggle settings for enabling/disabling an inbound ACH specific feature", "properties": { "requested": { "description": "Whether the FinancialAccount should have the Feature.", "type": "boolean" }, "status": { "description": "Whether the Feature is operational.", "enum": [ "active", "pending", "restricted" ], "type": "string" }, "status_details": { "description": "Additional details; includes at least one entry when the status is not `active`.", "items": { "$ref": "#/components/schemas/treasury_financial_accounts_resource_toggles_setting_status_details" }, "type": "array" } }, "required": [ "requested", "status", "status_details" ], "title": "TreasuryFinancialAccountsResourceInboundAchToggleSettings", "type": "object", "x-expandableFields": [ "status_details" ] }, "treasury_financial_accounts_resource_inbound_transfers": { "description": "InboundTransfers contains inbound transfers features for a FinancialAccount.", "properties": { "ach": { "$ref": "#/components/schemas/treasury_financial_accounts_resource_inbound_ach_toggle_settings" } }, "title": "TreasuryFinancialAccountsResourceInboundTransfers", "type": "object", "x-expandableFields": [ "ach" ] }, "treasury_financial_accounts_resource_outbound_ach_toggle_settings": { "description": "Toggle settings for enabling/disabling an outbound ACH specific feature", "properties": { "requested": { "description": "Whether the FinancialAccount should have the Feature.", "type": "boolean" }, "status": { "description": "Whether the Feature is operational.", "enum": [ "active", "pending", "restricted" ], "type": "string" }, "status_details": { "description": "Additional details; includes at least one entry when the status is not `active`.", "items": { "$ref": "#/components/schemas/treasury_financial_accounts_resource_toggles_setting_status_details" }, "type": "array" } }, "required": [ "requested", "status", "status_details" ], "title": "TreasuryFinancialAccountsResourceOutboundAchToggleSettings", "type": "object", "x-expandableFields": [ "status_details" ] }, "treasury_financial_accounts_resource_outbound_payments": { "description": "Settings related to Outbound Payments features on a Financial Account", "properties": { "ach": { "$ref": "#/components/schemas/treasury_financial_accounts_resource_outbound_ach_toggle_settings" }, "us_domestic_wire": { "$ref": "#/components/schemas/treasury_financial_accounts_resource_toggle_settings" } }, "title": "TreasuryFinancialAccountsResourceOutboundPayments", "type": "object", "x-expandableFields": [ "ach", "us_domestic_wire" ] }, "treasury_financial_accounts_resource_outbound_transfers": { "description": "OutboundTransfers contains outbound transfers features for a FinancialAccount.", "properties": { "ach": { "$ref": "#/components/schemas/treasury_financial_accounts_resource_outbound_ach_toggle_settings" }, "us_domestic_wire": { "$ref": "#/components/schemas/treasury_financial_accounts_resource_toggle_settings" } }, "title": "TreasuryFinancialAccountsResourceOutboundTransfers", "type": "object", "x-expandableFields": [ "ach", "us_domestic_wire" ] }, "treasury_financial_accounts_resource_platform_restrictions": { "description": "Restrictions that a Connect Platform has placed on this FinancialAccount.", "properties": { "inbound_flows": { "description": "Restricts all inbound money movement.", "enum": [ "restricted", "unrestricted" ], "nullable": true, "type": "string" }, "outbound_flows": { "description": "Restricts all outbound money movement.", "enum": [ "restricted", "unrestricted" ], "nullable": true, "type": "string" } }, "title": "TreasuryFinancialAccountsResourcePlatformRestrictions", "type": "object", "x-expandableFields": [] }, "treasury_financial_accounts_resource_status_details": { "description": "", "properties": { "closed": { "anyOf": [ { "$ref": "#/components/schemas/treasury_financial_accounts_resource_closed_status_details" } ], "description": "Details related to the closure of this FinancialAccount", "nullable": true } }, "title": "TreasuryFinancialAccountsResourceStatusDetails", "type": "object", "x-expandableFields": [ "closed" ] }, "treasury_financial_accounts_resource_toggle_settings": { "description": "Toggle settings for enabling/disabling a feature", "properties": { "requested": { "description": "Whether the FinancialAccount should have the Feature.", "type": "boolean" }, "status": { "description": "Whether the Feature is operational.", "enum": [ "active", "pending", "restricted" ], "type": "string" }, "status_details": { "description": "Additional details; includes at least one entry when the status is not `active`.", "items": { "$ref": "#/components/schemas/treasury_financial_accounts_resource_toggles_setting_status_details" }, "type": "array" } }, "required": [ "requested", "status", "status_details" ], "title": "TreasuryFinancialAccountsResourceToggleSettings", "type": "object", "x-expandableFields": [ "status_details" ] }, "treasury_financial_accounts_resource_toggles_setting_status_details": { "description": "Additional details on the FinancialAccount Features information.", "properties": { "code": { "description": "Represents the reason why the status is `pending` or `restricted`.", "enum": [ "activating", "capability_not_requested", "financial_account_closed", "rejected_other", "rejected_unsupported_business", "requirements_past_due", "requirements_pending_verification", "restricted_by_platform", "restricted_other" ], "type": "string", "x-stripeBypassValidation": true }, "resolution": { "description": "Represents what the user should do, if anything, to activate the Feature.", "enum": [ "contact_stripe", "provide_information", "remove_restriction" ], "nullable": true, "type": "string", "x-stripeBypassValidation": true }, "restriction": { "description": "The `platform_restrictions` that are restricting this Feature.", "enum": [ "inbound_flows", "outbound_flows" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "code" ], "title": "TreasuryFinancialAccountsResourceTogglesSettingStatusDetails", "type": "object", "x-expandableFields": [] }, "treasury_inbound_transfers_resource_failure_details": { "description": "", "properties": { "code": { "description": "Reason for the failure.", "enum": [ "account_closed", "account_frozen", "bank_account_restricted", "bank_ownership_changed", "debit_not_authorized", "incorrect_account_holder_address", "incorrect_account_holder_name", "incorrect_account_holder_tax_id", "insufficient_funds", "invalid_account_number", "invalid_currency", "no_account", "other" ], "type": "string" } }, "required": [ "code" ], "title": "TreasuryInboundTransfersResourceFailureDetails", "type": "object", "x-expandableFields": [] }, "treasury_inbound_transfers_resource_inbound_transfer_resource_linked_flows": { "description": "", "properties": { "received_debit": { "description": "If funds for this flow were returned after the flow went to the `succeeded` state, this field contains a reference to the ReceivedDebit return.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "TreasuryInboundTransfersResourceInboundTransferResourceLinkedFlows", "type": "object", "x-expandableFields": [] }, "treasury_inbound_transfers_resource_inbound_transfer_resource_status_transitions": { "description": "", "properties": { "canceled_at": { "description": "Timestamp describing when an InboundTransfer changed status to `canceled`.", "format": "unix-time", "nullable": true, "type": "integer" }, "failed_at": { "description": "Timestamp describing when an InboundTransfer changed status to `failed`.", "format": "unix-time", "nullable": true, "type": "integer" }, "succeeded_at": { "description": "Timestamp describing when an InboundTransfer changed status to `succeeded`.", "format": "unix-time", "nullable": true, "type": "integer" } }, "title": "TreasuryInboundTransfersResourceInboundTransferResourceStatusTransitions", "type": "object", "x-expandableFields": [] }, "treasury_outbound_payments_resource_ach_tracking_details": { "description": "", "properties": { "trace_id": { "description": "ACH trace ID of the OutboundPayment for payments sent over the `ach` network.", "maxLength": 5000, "type": "string" } }, "required": [ "trace_id" ], "title": "TreasuryOutboundPaymentsResourceACHTrackingDetails", "type": "object", "x-expandableFields": [] }, "treasury_outbound_payments_resource_outbound_payment_resource_end_user_details": { "description": "", "properties": { "ip_address": { "description": "IP address of the user initiating the OutboundPayment. Set if `present` is set to `true`. IP address collection is required for risk and compliance reasons. This will be used to help determine if the OutboundPayment is authorized or should be blocked.", "maxLength": 5000, "nullable": true, "type": "string" }, "present": { "description": "`true` if the OutboundPayment creation request is being made on behalf of an end user by a platform. Otherwise, `false`.", "type": "boolean" } }, "required": [ "present" ], "title": "TreasuryOutboundPaymentsResourceOutboundPaymentResourceEndUserDetails", "type": "object", "x-expandableFields": [] }, "treasury_outbound_payments_resource_outbound_payment_resource_status_transitions": { "description": "", "properties": { "canceled_at": { "description": "Timestamp describing when an OutboundPayment changed status to `canceled`.", "format": "unix-time", "nullable": true, "type": "integer" }, "failed_at": { "description": "Timestamp describing when an OutboundPayment changed status to `failed`.", "format": "unix-time", "nullable": true, "type": "integer" }, "posted_at": { "description": "Timestamp describing when an OutboundPayment changed status to `posted`.", "format": "unix-time", "nullable": true, "type": "integer" }, "returned_at": { "description": "Timestamp describing when an OutboundPayment changed status to `returned`.", "format": "unix-time", "nullable": true, "type": "integer" } }, "title": "TreasuryOutboundPaymentsResourceOutboundPaymentResourceStatusTransitions", "type": "object", "x-expandableFields": [] }, "treasury_outbound_payments_resource_outbound_payment_resource_tracking_details": { "description": "", "properties": { "ach": { "$ref": "#/components/schemas/treasury_outbound_payments_resource_ach_tracking_details" }, "type": { "description": "The US bank account network used to send funds.", "enum": [ "ach", "us_domestic_wire" ], "type": "string" }, "us_domestic_wire": { "$ref": "#/components/schemas/treasury_outbound_payments_resource_us_domestic_wire_tracking_details" } }, "required": [ "type" ], "title": "TreasuryOutboundPaymentsResourceOutboundPaymentResourceTrackingDetails", "type": "object", "x-expandableFields": [ "ach", "us_domestic_wire" ] }, "treasury_outbound_payments_resource_returned_status": { "description": "", "properties": { "code": { "description": "Reason for the return.", "enum": [ "account_closed", "account_frozen", "bank_account_restricted", "bank_ownership_changed", "declined", "incorrect_account_holder_name", "invalid_account_number", "invalid_currency", "no_account", "other" ], "type": "string" }, "transaction": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/treasury.transaction" } ], "description": "The Transaction associated with this object.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/treasury.transaction" } ] } } }, "required": [ "code", "transaction" ], "title": "TreasuryOutboundPaymentsResourceReturnedStatus", "type": "object", "x-expandableFields": [ "transaction" ] }, "treasury_outbound_payments_resource_us_domestic_wire_tracking_details": { "description": "", "properties": { "chips": { "description": "CHIPS System Sequence Number (SSN) of the OutboundPayment for payments sent over the `us_domestic_wire` network.", "maxLength": 5000, "nullable": true, "type": "string" }, "imad": { "description": "IMAD of the OutboundPayment for payments sent over the `us_domestic_wire` network.", "maxLength": 5000, "nullable": true, "type": "string" }, "omad": { "description": "OMAD of the OutboundPayment for payments sent over the `us_domestic_wire` network.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "TreasuryOutboundPaymentsResourceUSDomesticWireTrackingDetails", "type": "object", "x-expandableFields": [] }, "treasury_outbound_transfers_resource_ach_tracking_details": { "description": "", "properties": { "trace_id": { "description": "ACH trace ID of the OutboundTransfer for transfers sent over the `ach` network.", "maxLength": 5000, "type": "string" } }, "required": [ "trace_id" ], "title": "TreasuryOutboundTransfersResourceACHTrackingDetails", "type": "object", "x-expandableFields": [] }, "treasury_outbound_transfers_resource_outbound_transfer_resource_tracking_details": { "description": "", "properties": { "ach": { "$ref": "#/components/schemas/treasury_outbound_transfers_resource_ach_tracking_details" }, "type": { "description": "The US bank account network used to send funds.", "enum": [ "ach", "us_domestic_wire" ], "type": "string" }, "us_domestic_wire": { "$ref": "#/components/schemas/treasury_outbound_transfers_resource_us_domestic_wire_tracking_details" } }, "required": [ "type" ], "title": "TreasuryOutboundTransfersResourceOutboundTransferResourceTrackingDetails", "type": "object", "x-expandableFields": [ "ach", "us_domestic_wire" ] }, "treasury_outbound_transfers_resource_returned_details": { "description": "", "properties": { "code": { "description": "Reason for the return.", "enum": [ "account_closed", "account_frozen", "bank_account_restricted", "bank_ownership_changed", "declined", "incorrect_account_holder_name", "invalid_account_number", "invalid_currency", "no_account", "other" ], "type": "string" }, "transaction": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/treasury.transaction" } ], "description": "The Transaction associated with this object.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/treasury.transaction" } ] } } }, "required": [ "code", "transaction" ], "title": "TreasuryOutboundTransfersResourceReturnedDetails", "type": "object", "x-expandableFields": [ "transaction" ] }, "treasury_outbound_transfers_resource_status_transitions": { "description": "", "properties": { "canceled_at": { "description": "Timestamp describing when an OutboundTransfer changed status to `canceled`", "format": "unix-time", "nullable": true, "type": "integer" }, "failed_at": { "description": "Timestamp describing when an OutboundTransfer changed status to `failed`", "format": "unix-time", "nullable": true, "type": "integer" }, "posted_at": { "description": "Timestamp describing when an OutboundTransfer changed status to `posted`", "format": "unix-time", "nullable": true, "type": "integer" }, "returned_at": { "description": "Timestamp describing when an OutboundTransfer changed status to `returned`", "format": "unix-time", "nullable": true, "type": "integer" } }, "title": "TreasuryOutboundTransfersResourceStatusTransitions", "type": "object", "x-expandableFields": [] }, "treasury_outbound_transfers_resource_us_domestic_wire_tracking_details": { "description": "", "properties": { "chips": { "description": "CHIPS System Sequence Number (SSN) of the OutboundTransfer for transfers sent over the `us_domestic_wire` network.", "maxLength": 5000, "nullable": true, "type": "string" }, "imad": { "description": "IMAD of the OutboundTransfer for transfers sent over the `us_domestic_wire` network.", "maxLength": 5000, "nullable": true, "type": "string" }, "omad": { "description": "OMAD of the OutboundTransfer for transfers sent over the `us_domestic_wire` network.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "TreasuryOutboundTransfersResourceUSDomesticWireTrackingDetails", "type": "object", "x-expandableFields": [] }, "treasury_received_credits_resource_linked_flows": { "description": "", "properties": { "credit_reversal": { "description": "The CreditReversal created as a result of this ReceivedCredit being reversed.", "maxLength": 5000, "nullable": true, "type": "string" }, "issuing_authorization": { "description": "Set if the ReceivedCredit was created due to an [Issuing Authorization](https://stripe.com/docs/api#issuing_authorizations) object.", "maxLength": 5000, "nullable": true, "type": "string" }, "issuing_transaction": { "description": "Set if the ReceivedCredit is also viewable as an [Issuing transaction](https://stripe.com/docs/api#issuing_transactions) object.", "maxLength": 5000, "nullable": true, "type": "string" }, "source_flow": { "description": "ID of the source flow. Set if `network` is `stripe` and the source flow is visible to the user. Examples of source flows include OutboundPayments, payouts, or CreditReversals.", "maxLength": 5000, "nullable": true, "type": "string" }, "source_flow_details": { "anyOf": [ { "$ref": "#/components/schemas/treasury_received_credits_resource_source_flows_details" } ], "description": "The expandable object of the source flow.", "nullable": true }, "source_flow_type": { "description": "The type of flow that originated the ReceivedCredit (for example, `outbound_payment`).", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "TreasuryReceivedCreditsResourceLinkedFlows", "type": "object", "x-expandableFields": [ "source_flow_details" ] }, "treasury_received_credits_resource_reversal_details": { "description": "", "properties": { "deadline": { "description": "Time before which a ReceivedCredit can be reversed.", "format": "unix-time", "nullable": true, "type": "integer" }, "restricted_reason": { "description": "Set if a ReceivedCredit cannot be reversed.", "enum": [ "already_reversed", "deadline_passed", "network_restricted", "other", "source_flow_restricted" ], "nullable": true, "type": "string" } }, "title": "TreasuryReceivedCreditsResourceReversalDetails", "type": "object", "x-expandableFields": [] }, "treasury_received_credits_resource_source_flows_details": { "description": "", "properties": { "credit_reversal": { "$ref": "#/components/schemas/treasury.credit_reversal" }, "outbound_payment": { "$ref": "#/components/schemas/treasury.outbound_payment" }, "outbound_transfer": { "$ref": "#/components/schemas/treasury.outbound_transfer" }, "payout": { "$ref": "#/components/schemas/payout" }, "type": { "description": "The type of the source flow that originated the ReceivedCredit.", "enum": [ "credit_reversal", "other", "outbound_payment", "outbound_transfer", "payout" ], "type": "string" } }, "required": [ "type" ], "title": "TreasuryReceivedCreditsResourceSourceFlowsDetails", "type": "object", "x-expandableFields": [ "credit_reversal", "outbound_payment", "outbound_transfer", "payout" ] }, "treasury_received_credits_resource_status_transitions": { "description": "", "properties": { "posted_at": { "description": "Timestamp describing when the CreditReversal changed status to `posted`", "format": "unix-time", "nullable": true, "type": "integer" } }, "title": "TreasuryReceivedCreditsResourceStatusTransitions", "type": "object", "x-expandableFields": [] }, "treasury_received_debits_resource_debit_reversal_linked_flows": { "description": "", "properties": { "issuing_dispute": { "description": "Set if there is an Issuing dispute associated with the DebitReversal.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "TreasuryReceivedDebitsResourceDebitReversalLinkedFlows", "type": "object", "x-expandableFields": [] }, "treasury_received_debits_resource_linked_flows": { "description": "", "properties": { "debit_reversal": { "description": "The DebitReversal created as a result of this ReceivedDebit being reversed.", "maxLength": 5000, "nullable": true, "type": "string" }, "inbound_transfer": { "description": "Set if the ReceivedDebit is associated with an InboundTransfer's return of funds.", "maxLength": 5000, "nullable": true, "type": "string" }, "issuing_authorization": { "description": "Set if the ReceivedDebit was created due to an [Issuing Authorization](https://stripe.com/docs/api#issuing_authorizations) object.", "maxLength": 5000, "nullable": true, "type": "string" }, "issuing_transaction": { "description": "Set if the ReceivedDebit is also viewable as an [Issuing Dispute](https://stripe.com/docs/api#issuing_disputes) object.", "maxLength": 5000, "nullable": true, "type": "string" }, "payout": { "description": "Set if the ReceivedDebit was created due to a [Payout](https://stripe.com/docs/api#payouts) object.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "TreasuryReceivedDebitsResourceLinkedFlows", "type": "object", "x-expandableFields": [] }, "treasury_received_debits_resource_reversal_details": { "description": "", "properties": { "deadline": { "description": "Time before which a ReceivedDebit can be reversed.", "format": "unix-time", "nullable": true, "type": "integer" }, "restricted_reason": { "description": "Set if a ReceivedDebit can't be reversed.", "enum": [ "already_reversed", "deadline_passed", "network_restricted", "other", "source_flow_restricted" ], "nullable": true, "type": "string" } }, "title": "TreasuryReceivedDebitsResourceReversalDetails", "type": "object", "x-expandableFields": [] }, "treasury_received_debits_resource_status_transitions": { "description": "", "properties": { "completed_at": { "description": "Timestamp describing when the DebitReversal changed status to `completed`.", "format": "unix-time", "nullable": true, "type": "integer" } }, "title": "TreasuryReceivedDebitsResourceStatusTransitions", "type": "object", "x-expandableFields": [] }, "treasury_shared_resource_billing_details": { "description": "", "properties": { "address": { "$ref": "#/components/schemas/address" }, "email": { "description": "Email address.", "maxLength": 5000, "nullable": true, "type": "string" }, "name": { "description": "Full name.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": [ "address" ], "title": "TreasurySharedResourceBillingDetails", "type": "object", "x-expandableFields": [ "address" ] }, "treasury_shared_resource_initiating_payment_method_details_initiating_payment_method_details": { "description": "", "properties": { "balance": { "description": "Set when `type` is `balance`.", "enum": [ "payments" ], "type": "string" }, "billing_details": { "$ref": "#/components/schemas/treasury_shared_resource_billing_details" }, "financial_account": { "$ref": "#/components/schemas/received_payment_method_details_financial_account" }, "issuing_card": { "description": "Set when `type` is `issuing_card`. This is an [Issuing Card](https://stripe.com/docs/api#issuing_cards) ID.", "maxLength": 5000, "type": "string" }, "type": { "description": "Polymorphic type matching the originating money movement's source. This can be an external account, a Stripe balance, or a FinancialAccount.", "enum": [ "balance", "financial_account", "issuing_card", "stripe", "us_bank_account" ], "type": "string", "x-stripeBypassValidation": true }, "us_bank_account": { "$ref": "#/components/schemas/treasury_shared_resource_initiating_payment_method_details_us_bank_account" } }, "required": [ "billing_details", "type" ], "title": "TreasurySharedResourceInitiatingPaymentMethodDetailsInitiatingPaymentMethodDetails", "type": "object", "x-expandableFields": [ "billing_details", "financial_account", "us_bank_account" ] }, "treasury_shared_resource_initiating_payment_method_details_us_bank_account": { "description": "", "properties": { "bank_name": { "description": "Bank name.", "maxLength": 5000, "nullable": true, "type": "string" }, "last4": { "description": "The last four digits of the bank account number.", "maxLength": 5000, "nullable": true, "type": "string" }, "routing_number": { "description": "The routing number for the bank account.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "TreasurySharedResourceInitiatingPaymentMethodDetailsUSBankAccount", "type": "object", "x-expandableFields": [] }, "treasury_transactions_resource_abstract_transaction_resource_status_transitions": { "description": "", "properties": { "posted_at": { "description": "Timestamp describing when the Transaction changed status to `posted`.", "format": "unix-time", "nullable": true, "type": "integer" }, "void_at": { "description": "Timestamp describing when the Transaction changed status to `void`.", "format": "unix-time", "nullable": true, "type": "integer" } }, "title": "TreasuryTransactionsResourceAbstractTransactionResourceStatusTransitions", "type": "object", "x-expandableFields": [] }, "treasury_transactions_resource_balance_impact": { "description": "Change to a FinancialAccount's balance", "properties": { "cash": { "description": "The change made to funds the user can spend right now.", "type": "integer" }, "inbound_pending": { "description": "The change made to funds that are not spendable yet, but will become available at a later time.", "type": "integer" }, "outbound_pending": { "description": "The change made to funds in the account, but not spendable because they are being held for pending outbound flows.", "type": "integer" } }, "required": [ "cash", "inbound_pending", "outbound_pending" ], "title": "TreasuryTransactionsResourceBalanceImpact", "type": "object", "x-expandableFields": [] }, "treasury_transactions_resource_flow_details": { "description": "", "properties": { "credit_reversal": { "$ref": "#/components/schemas/treasury.credit_reversal" }, "debit_reversal": { "$ref": "#/components/schemas/treasury.debit_reversal" }, "inbound_transfer": { "$ref": "#/components/schemas/treasury.inbound_transfer" }, "issuing_authorization": { "$ref": "#/components/schemas/issuing.authorization" }, "outbound_payment": { "$ref": "#/components/schemas/treasury.outbound_payment" }, "outbound_transfer": { "$ref": "#/components/schemas/treasury.outbound_transfer" }, "received_credit": { "$ref": "#/components/schemas/treasury.received_credit" }, "received_debit": { "$ref": "#/components/schemas/treasury.received_debit" }, "type": { "description": "Type of the flow that created the Transaction. Set to the same value as `flow_type`.", "enum": [ "credit_reversal", "debit_reversal", "inbound_transfer", "issuing_authorization", "other", "outbound_payment", "outbound_transfer", "received_credit", "received_debit" ], "type": "string" } }, "required": [ "type" ], "title": "TreasuryTransactionsResourceFlowDetails", "type": "object", "x-expandableFields": [ "credit_reversal", "debit_reversal", "inbound_transfer", "issuing_authorization", "outbound_payment", "outbound_transfer", "received_credit", "received_debit" ] }, "us_bank_account_networks": { "description": "", "properties": { "preferred": { "description": "The preferred network.", "maxLength": 5000, "nullable": true, "type": "string" }, "supported": { "description": "All supported networks.", "items": { "enum": [ "ach", "us_domestic_wire" ], "type": "string" }, "type": "array" } }, "required": [ "supported" ], "title": "us_bank_account_networks", "type": "object", "x-expandableFields": [] }, "verification_session_redaction": { "description": "", "properties": { "status": { "description": "Indicates whether this object and its related objects have been redacted or not.", "enum": [ "processing", "redacted" ], "type": "string" } }, "required": [ "status" ], "title": "verification_session_redaction", "type": "object", "x-expandableFields": [] }, "webhook_endpoint": { "description": "You can configure [webhook endpoints](https://docs.stripe.com/webhooks/) via the API to be\nnotified about events that happen in your Stripe account or connected\naccounts.\n\nMost users configure webhooks from [the dashboard](https://dashboard.stripe.com/webhooks), which provides a user interface for registering and testing your webhook endpoints.\n\nRelated guide: [Setting up webhooks](https://docs.stripe.com/webhooks/configure)", "properties": { "api_version": { "description": "The API version events are rendered as for this webhook endpoint.", "maxLength": 5000, "nullable": true, "type": "string" }, "application": { "description": "The ID of the associated Connect application.", "maxLength": 5000, "nullable": true, "type": "string" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "description": { "description": "An optional description of what the webhook is used for.", "maxLength": 5000, "nullable": true, "type": "string" }, "enabled_events": { "description": "The list of events to enable for this endpoint. `['*']` indicates that all events are enabled, except those that require explicit selection.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "type": "object" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "webhook_endpoint" ], "type": "string" }, "secret": { "description": "The endpoint's secret, used to generate [webhook signatures](https://docs.stripe.com/webhooks/signatures). Only returned at creation.", "maxLength": 5000, "type": "string" }, "status": { "description": "The status of the webhook. It can be `enabled` or `disabled`.", "maxLength": 5000, "type": "string" }, "url": { "description": "The URL of the webhook endpoint.", "maxLength": 5000, "type": "string" } }, "required": [ "created", "enabled_events", "id", "livemode", "metadata", "object", "status", "url" ], "title": "NotificationWebhookEndpoint", "type": "object", "x-expandableFields": [], "x-resourceId": "webhook_endpoint" } }, "securitySchemes": { "basicAuth": { "description": "Basic HTTP authentication. Allowed headers-- Authorization: Basic | Authorization: Basic ", "scheme": "basic", "type": "http" }, "bearerAuth": { "bearerFormat": "auth-scheme", "description": "Bearer HTTP authentication. Allowed headers-- Authorization: Bearer ", "scheme": "bearer", "type": "http" } } }, "info": { "contact": { "email": "dev-platform@stripe.com", "name": "Stripe Dev Platform Team", "url": "https://stripe.com" }, "description": "The Stripe REST API. Please see https://stripe.com/docs/api for more details.", "termsOfService": "https://stripe.com/us/terms/", "title": "Stripe API", "version": "2025-08-27.basil", "x-stripeSpecFilename": "spec3" }, "openapi": "3.0.0", "paths": { "/v1/account": { "get": { "description": "

Retrieves the details of an account.

", "operationId": "GetAccount", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/account" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve account" } }, "/v1/account_links": { "post": { "description": "

Creates an AccountLink object that includes a single-use Stripe URL that the platform can redirect their user to in order to take them through the Connect Onboarding flow.

", "operationId": "PostAccountLinks", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "collection_options": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "account": { "description": "The identifier of the account to create an account link for.", "maxLength": 5000, "type": "string" }, "collect": { "description": "The collect parameter is deprecated. Use `collection_options` instead.", "enum": [ "currently_due", "eventually_due" ], "type": "string" }, "collection_options": { "description": "Specifies the requirements that Stripe collects from connected accounts in the Connect Onboarding flow.", "properties": { "fields": { "enum": [ "currently_due", "eventually_due" ], "type": "string" }, "future_requirements": { "enum": [ "include", "omit" ], "type": "string" } }, "title": "collection_options_params", "type": "object" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "refresh_url": { "description": "The URL the user will be redirected to if the account link is expired, has been previously-visited, or is otherwise invalid. The URL you specify should attempt to generate a new account link with the same parameters used to create the original account link, then redirect the user to the new account link's URL so they can continue with Connect Onboarding. If a new account link cannot be generated or the redirect fails you should display a useful error to the user.", "type": "string" }, "return_url": { "description": "The URL that the user will be redirected to upon leaving or completing the linked flow.", "type": "string" }, "type": { "description": "The type of account link the user is requesting.\n\nYou can create Account Links of type `account_update` only for connected accounts where your platform is responsible for collecting requirements, including Custom accounts. You can't create them for accounts that have access to a Stripe-hosted Dashboard. If you use [Connect embedded components](/connect/get-started-connect-embedded-components), you can include components that allow your connected accounts to update their own information. For an account without Stripe-hosted Dashboard access where Stripe is liable for negative balances, you must use embedded components.", "enum": [ "account_onboarding", "account_update" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "account", "type" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/account_link" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create an account link" } }, "/v1/account_sessions": { "post": { "description": "

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.

", "operationId": "PostAccountSessions", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "components": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "account": { "description": "The identifier of the account to create an Account Session for.", "type": "string" }, "components": { "description": "Each key of the dictionary represents an embedded component, and each embedded component maps to its configuration (e.g. whether it has been enabled or not).", "properties": { "account_management": { "properties": { "enabled": { "type": "boolean" }, "features": { "properties": { "disable_stripe_user_authentication": { "type": "boolean" }, "external_account_collection": { "type": "boolean" } }, "title": "account_features_param", "type": "object" } }, "required": [ "enabled" ], "title": "account_config_param", "type": "object" }, "account_onboarding": { "properties": { "enabled": { "type": "boolean" }, "features": { "properties": { "disable_stripe_user_authentication": { "type": "boolean" }, "external_account_collection": { "type": "boolean" } }, "title": "account_features_param", "type": "object" } }, "required": [ "enabled" ], "title": "account_config_param", "type": "object" }, "balance_report": { "properties": { "enabled": { "type": "boolean" }, "features": { "properties": {}, "title": "base_features_param", "type": "object" } }, "required": [ "enabled" ], "title": "base_config_param", "type": "object" }, "balances": { "properties": { "enabled": { "type": "boolean" }, "features": { "properties": { "disable_stripe_user_authentication": { "type": "boolean" }, "edit_payout_schedule": { "type": "boolean" }, "external_account_collection": { "type": "boolean" }, "instant_payouts": { "type": "boolean" }, "standard_payouts": { "type": "boolean" } }, "title": "payouts_features_param", "type": "object" } }, "required": [ "enabled" ], "title": "payouts_config_param", "type": "object" }, "disputes_list": { "properties": { "enabled": { "type": "boolean" }, "features": { "properties": { "capture_payments": { "type": "boolean" }, "destination_on_behalf_of_charge_management": { "type": "boolean" }, "dispute_management": { "type": "boolean" }, "refund_management": { "type": "boolean" } }, "title": "disputes_list_features_param", "type": "object" } }, "required": [ "enabled" ], "title": "disputes_list_config_param", "type": "object" }, "documents": { "properties": { "enabled": { "type": "boolean" }, "features": { "properties": {}, "title": "base_features_param", "type": "object" } }, "required": [ "enabled" ], "title": "base_config_param", "type": "object" }, "financial_account": { "properties": { "enabled": { "type": "boolean" }, "features": { "properties": { "disable_stripe_user_authentication": { "type": "boolean" }, "external_account_collection": { "type": "boolean" }, "send_money": { "type": "boolean" }, "transfer_balance": { "type": "boolean" } }, "title": "financial_account_features_param", "type": "object" } }, "required": [ "enabled" ], "title": "financial_account_config_param", "type": "object" }, "financial_account_transactions": { "properties": { "enabled": { "type": "boolean" }, "features": { "properties": { "card_spend_dispute_management": { "type": "boolean" } }, "title": "financial_account_transactions_features_param", "type": "object" } }, "required": [ "enabled" ], "title": "financial_account_transactions_config_param", "type": "object" }, "instant_payouts_promotion": { "properties": { "enabled": { "type": "boolean" }, "features": { "properties": { "disable_stripe_user_authentication": { "type": "boolean" }, "external_account_collection": { "type": "boolean" }, "instant_payouts": { "type": "boolean" } }, "title": "instant_payouts_promotion_features_param", "type": "object" } }, "required": [ "enabled" ], "title": "instant_payouts_promotion_config_param", "type": "object" }, "issuing_card": { "properties": { "enabled": { "type": "boolean" }, "features": { "properties": { "card_management": { "type": "boolean" }, "card_spend_dispute_management": { "type": "boolean" }, "cardholder_management": { "type": "boolean" }, "spend_control_management": { "type": "boolean" } }, "title": "issuing_card_features_param", "type": "object" } }, "required": [ "enabled" ], "title": "issuing_card_config_param", "type": "object" }, "issuing_cards_list": { "properties": { "enabled": { "type": "boolean" }, "features": { "properties": { "card_management": { "type": "boolean" }, "card_spend_dispute_management": { "type": "boolean" }, "cardholder_management": { "type": "boolean" }, "disable_stripe_user_authentication": { "type": "boolean" }, "spend_control_management": { "type": "boolean" } }, "title": "issuing_cards_list_features_param", "type": "object" } }, "required": [ "enabled" ], "title": "issuing_cards_list_config_param", "type": "object" }, "notification_banner": { "properties": { "enabled": { "type": "boolean" }, "features": { "properties": { "disable_stripe_user_authentication": { "type": "boolean" }, "external_account_collection": { "type": "boolean" } }, "title": "account_features_param", "type": "object" } }, "required": [ "enabled" ], "title": "account_config_param", "type": "object" }, "payment_details": { "properties": { "enabled": { "type": "boolean" }, "features": { "properties": { "capture_payments": { "type": "boolean" }, "destination_on_behalf_of_charge_management": { "type": "boolean" }, "dispute_management": { "type": "boolean" }, "refund_management": { "type": "boolean" } }, "title": "payments_features_param", "type": "object" } }, "required": [ "enabled" ], "title": "payments_config_param", "type": "object" }, "payment_disputes": { "properties": { "enabled": { "type": "boolean" }, "features": { "properties": { "destination_on_behalf_of_charge_management": { "type": "boolean" }, "dispute_management": { "type": "boolean" }, "refund_management": { "type": "boolean" } }, "title": "payment_disputes_features_param", "type": "object" } }, "required": [ "enabled" ], "title": "payment_disputes_config_param", "type": "object" }, "payments": { "properties": { "enabled": { "type": "boolean" }, "features": { "properties": { "capture_payments": { "type": "boolean" }, "destination_on_behalf_of_charge_management": { "type": "boolean" }, "dispute_management": { "type": "boolean" }, "refund_management": { "type": "boolean" } }, "title": "payments_features_param", "type": "object" } }, "required": [ "enabled" ], "title": "payments_config_param", "type": "object" }, "payout_details": { "properties": { "enabled": { "type": "boolean" }, "features": { "properties": {}, "title": "base_features_param", "type": "object" } }, "required": [ "enabled" ], "title": "base_config_param", "type": "object" }, "payout_reconciliation_report": { "properties": { "enabled": { "type": "boolean" }, "features": { "properties": {}, "title": "base_features_param", "type": "object" } }, "required": [ "enabled" ], "title": "base_config_param", "type": "object" }, "payouts": { "properties": { "enabled": { "type": "boolean" }, "features": { "properties": { "disable_stripe_user_authentication": { "type": "boolean" }, "edit_payout_schedule": { "type": "boolean" }, "external_account_collection": { "type": "boolean" }, "instant_payouts": { "type": "boolean" }, "standard_payouts": { "type": "boolean" } }, "title": "payouts_features_param", "type": "object" } }, "required": [ "enabled" ], "title": "payouts_config_param", "type": "object" }, "payouts_list": { "properties": { "enabled": { "type": "boolean" }, "features": { "properties": {}, "title": "base_features_param", "type": "object" } }, "required": [ "enabled" ], "title": "base_config_param", "type": "object" }, "tax_registrations": { "properties": { "enabled": { "type": "boolean" }, "features": { "properties": {}, "title": "base_features_param", "type": "object" } }, "required": [ "enabled" ], "title": "base_config_param", "type": "object" }, "tax_settings": { "properties": { "enabled": { "type": "boolean" }, "features": { "properties": {}, "title": "base_features_param", "type": "object" } }, "required": [ "enabled" ], "title": "base_config_param", "type": "object" } }, "title": "account_session_create_components_param", "type": "object" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "required": [ "account", "components" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/account_session" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create an Account Session" } }, "/v1/accounts": { "get": { "description": "

Returns a list of accounts connected to your platform via Connect. If you’re not a platform, the list is empty.

", "operationId": "GetAccounts", "parameters": [ { "description": "Only return connected accounts that were created during the given date interval.", "explode": true, "in": "query", "name": "created", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "type": "integer" }, "gte": { "type": "integer" }, "lt": { "type": "integer" }, "lte": { "type": "integer" } }, "title": "range_query_specs", "type": "object" }, { "type": "integer" } ] }, "style": "deepObject" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/account" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/accounts", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "AccountList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all connected accounts" }, "post": { "description": "

With Connect, you can create Stripe accounts for your users.\nTo do this, you’ll first need to register your platform.

\n\n

If you’ve already collected information for your connected accounts, you can prefill that information when\ncreating the account. Connect Onboarding won’t ask for the prefilled information during account onboarding.\nYou can prefill any information on the account.

", "operationId": "PostAccounts", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "bank_account": { "explode": true, "style": "deepObject" }, "business_profile": { "explode": true, "style": "deepObject" }, "capabilities": { "explode": true, "style": "deepObject" }, "company": { "explode": true, "style": "deepObject" }, "controller": { "explode": true, "style": "deepObject" }, "documents": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "groups": { "explode": true, "style": "deepObject" }, "individual": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "settings": { "explode": true, "style": "deepObject" }, "tos_acceptance": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "account_token": { "description": "An [account token](https://stripe.com/docs/api#create_account_token), used to securely provide details to the account.", "maxLength": 5000, "type": "string" }, "bank_account": { "anyOf": [ { "properties": { "account_holder_name": { "maxLength": 5000, "type": "string" }, "account_holder_type": { "enum": [ "company", "individual" ], "maxLength": 5000, "type": "string" }, "account_number": { "maxLength": 5000, "type": "string" }, "account_type": { "enum": [ "checking", "futsu", "savings", "toza" ], "maxLength": 5000, "type": "string" }, "country": { "maxLength": 5000, "type": "string" }, "currency": { "format": "currency", "type": "string" }, "documents": { "properties": { "bank_account_ownership_verification": { "properties": { "files": { "items": { "maxLength": 500, "type": "string" }, "type": "array" } }, "title": "documents_param", "type": "object" } }, "title": "external_account_documents_param", "type": "object" }, "object": { "enum": [ "bank_account" ], "maxLength": 5000, "type": "string" }, "routing_number": { "maxLength": 5000, "type": "string" } }, "required": [ "account_number", "country" ], "title": "external_account_payout_bank_account", "type": "object" }, { "maxLength": 5000, "type": "string" } ], "description": "Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details." }, "business_profile": { "description": "Business information about the account.", "properties": { "annual_revenue": { "properties": { "amount": { "type": "integer" }, "currency": { "format": "currency", "type": "string" }, "fiscal_year_end": { "maxLength": 5000, "type": "string" } }, "required": [ "amount", "currency", "fiscal_year_end" ], "title": "annual_revenue_specs", "type": "object" }, "estimated_worker_count": { "type": "integer" }, "mcc": { "maxLength": 4, "type": "string" }, "minority_owned_business_designation": { "items": { "enum": [ "lgbtqi_owned_business", "minority_owned_business", "none_of_these_apply", "prefer_not_to_answer", "women_owned_business" ], "type": "string" }, "type": "array" }, "monthly_estimated_revenue": { "properties": { "amount": { "type": "integer" }, "currency": { "format": "currency", "type": "string" } }, "required": [ "amount", "currency" ], "title": "monthly_estimated_revenue_specs", "type": "object" }, "name": { "maxLength": 5000, "type": "string" }, "product_description": { "maxLength": 40000, "type": "string" }, "support_address": { "properties": { "city": { "maxLength": 100, "type": "string" }, "country": { "maxLength": 5000, "type": "string" }, "line1": { "maxLength": 200, "type": "string" }, "line2": { "maxLength": 200, "type": "string" }, "postal_code": { "maxLength": 5000, "type": "string" }, "state": { "maxLength": 5000, "type": "string" } }, "title": "address_specs", "type": "object" }, "support_email": { "type": "string" }, "support_phone": { "maxLength": 5000, "type": "string" }, "support_url": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "url": { "type": "string" } }, "title": "business_profile_specs", "type": "object" }, "business_type": { "description": "The business type. Once you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.", "enum": [ "company", "government_entity", "individual", "non_profit" ], "type": "string", "x-stripeBypassValidation": true }, "capabilities": { "description": "Each key of the dictionary represents a capability, and each capability\nmaps to its settings (for example, whether it has been requested or not). Each\ncapability is inactive until you have provided its specific\nrequirements and Stripe has verified them. An account might have some\nof its requested capabilities be active and some be inactive.\n\nRequired when [account.controller.stripe_dashboard.type](/api/accounts/create#create_account-controller-dashboard-type)\nis `none`, which includes Custom accounts.", "properties": { "acss_debit_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "affirm_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "afterpay_clearpay_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "alma_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "amazon_pay_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "au_becs_debit_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "bacs_debit_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "bancontact_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "bank_transfer_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "billie_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "blik_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "boleto_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "card_issuing": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "card_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "cartes_bancaires_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "cashapp_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "crypto_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "eps_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "fpx_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "gb_bank_transfer_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "giropay_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "grabpay_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "ideal_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "india_international_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "jcb_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "jp_bank_transfer_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "kakao_pay_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "klarna_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "konbini_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "kr_card_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "legacy_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "link_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "mobilepay_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "multibanco_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "mx_bank_transfer_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "naver_pay_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "nz_bank_account_becs_debit_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "oxxo_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "p24_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "pay_by_bank_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "payco_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "paynow_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "pix_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "promptpay_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "revolut_pay_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "samsung_pay_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "satispay_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "sepa_bank_transfer_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "sepa_debit_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "sofort_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "swish_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "tax_reporting_us_1099_k": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "tax_reporting_us_1099_misc": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "transfers": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "treasury": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "twint_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "us_bank_account_ach_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "us_bank_transfer_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "zip_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" } }, "title": "capabilities_param", "type": "object" }, "company": { "description": "Information about the company or business. This field is available for any `business_type`. Once you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.", "properties": { "address": { "properties": { "city": { "maxLength": 100, "type": "string" }, "country": { "maxLength": 5000, "type": "string" }, "line1": { "maxLength": 200, "type": "string" }, "line2": { "maxLength": 200, "type": "string" }, "postal_code": { "maxLength": 5000, "type": "string" }, "state": { "maxLength": 5000, "type": "string" } }, "title": "legal_entity_and_kyc_address_specs", "type": "object" }, "address_kana": { "properties": { "city": { "maxLength": 5000, "type": "string" }, "country": { "maxLength": 5000, "type": "string" }, "line1": { "maxLength": 5000, "type": "string" }, "line2": { "maxLength": 5000, "type": "string" }, "postal_code": { "maxLength": 5000, "type": "string" }, "state": { "maxLength": 5000, "type": "string" }, "town": { "maxLength": 5000, "type": "string" } }, "title": "japan_address_kana_specs", "type": "object" }, "address_kanji": { "properties": { "city": { "maxLength": 5000, "type": "string" }, "country": { "maxLength": 5000, "type": "string" }, "line1": { "maxLength": 5000, "type": "string" }, "line2": { "maxLength": 5000, "type": "string" }, "postal_code": { "maxLength": 5000, "type": "string" }, "state": { "maxLength": 5000, "type": "string" }, "town": { "maxLength": 5000, "type": "string" } }, "title": "japan_address_kanji_specs", "type": "object" }, "directors_provided": { "type": "boolean" }, "directorship_declaration": { "properties": { "date": { "format": "unix-time", "type": "integer" }, "ip": { "type": "string" }, "user_agent": { "maxLength": 5000, "type": "string" } }, "title": "company_directorship_declaration", "type": "object" }, "executives_provided": { "type": "boolean" }, "export_license_id": { "maxLength": 5000, "type": "string" }, "export_purpose_code": { "maxLength": 5000, "type": "string" }, "name": { "maxLength": 100, "type": "string" }, "name_kana": { "maxLength": 100, "type": "string" }, "name_kanji": { "maxLength": 100, "type": "string" }, "owners_provided": { "type": "boolean" }, "ownership_declaration": { "properties": { "date": { "format": "unix-time", "type": "integer" }, "ip": { "type": "string" }, "user_agent": { "maxLength": 5000, "type": "string" } }, "title": "company_ownership_declaration", "type": "object" }, "ownership_exemption_reason": { "enum": [ "", "qualified_entity_exceeds_ownership_threshold", "qualifies_as_financial_institution" ], "type": "string" }, "phone": { "maxLength": 5000, "type": "string" }, "registration_date": { "anyOf": [ { "properties": { "day": { "type": "integer" }, "month": { "type": "integer" }, "year": { "type": "integer" } }, "required": [ "day", "month", "year" ], "title": "registration_date_specs", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "registration_number": { "maxLength": 5000, "type": "string" }, "structure": { "enum": [ "", "free_zone_establishment", "free_zone_llc", "government_instrumentality", "governmental_unit", "incorporated_non_profit", "incorporated_partnership", "limited_liability_partnership", "llc", "multi_member_llc", "private_company", "private_corporation", "private_partnership", "public_company", "public_corporation", "public_partnership", "registered_charity", "single_member_llc", "sole_establishment", "sole_proprietorship", "tax_exempt_government_instrumentality", "unincorporated_association", "unincorporated_non_profit", "unincorporated_partnership" ], "type": "string", "x-stripeBypassValidation": true }, "tax_id": { "maxLength": 5000, "type": "string" }, "tax_id_registrar": { "maxLength": 5000, "type": "string" }, "vat_id": { "maxLength": 5000, "type": "string" }, "verification": { "properties": { "document": { "properties": { "back": { "maxLength": 500, "type": "string" }, "front": { "maxLength": 500, "type": "string" } }, "title": "verification_document_specs", "type": "object" } }, "title": "verification_specs", "type": "object" } }, "title": "company_specs", "type": "object" }, "controller": { "description": "A hash of configuration describing the account controller's attributes.", "properties": { "fees": { "properties": { "payer": { "enum": [ "account", "application" ], "type": "string" } }, "title": "controller_fees_specs", "type": "object" }, "losses": { "properties": { "payments": { "enum": [ "application", "stripe" ], "type": "string" } }, "title": "controller_losses_specs", "type": "object" }, "requirement_collection": { "enum": [ "application", "stripe" ], "type": "string" }, "stripe_dashboard": { "properties": { "type": { "enum": [ "express", "full", "none" ], "type": "string" } }, "title": "controller_dashboard_specs", "type": "object" } }, "title": "controller_specs", "type": "object" }, "country": { "description": "The country in which the account holder resides, or in which the business is legally established. This should be an ISO 3166-1 alpha-2 country code. For example, if you are in the United States and the business for which you're creating an account is legally represented in Canada, you would use `CA` as the country for the account being created. Available countries include [Stripe's global markets](https://stripe.com/global) as well as countries where [cross-border payouts](https://stripe.com/docs/connect/cross-border-payouts) are supported.", "maxLength": 5000, "type": "string" }, "default_currency": { "description": "Three-letter ISO currency code representing the default currency for the account. This must be a currency that [Stripe supports in the account's country](https://docs.stripe.com/payouts).", "format": "currency", "type": "string" }, "documents": { "description": "Documents that may be submitted to satisfy various informational requests.", "properties": { "bank_account_ownership_verification": { "properties": { "files": { "items": { "maxLength": 500, "type": "string" }, "type": "array" } }, "title": "documents_param", "type": "object" }, "company_license": { "properties": { "files": { "items": { "maxLength": 500, "type": "string" }, "type": "array" } }, "title": "documents_param", "type": "object" }, "company_memorandum_of_association": { "properties": { "files": { "items": { "maxLength": 500, "type": "string" }, "type": "array" } }, "title": "documents_param", "type": "object" }, "company_ministerial_decree": { "properties": { "files": { "items": { "maxLength": 500, "type": "string" }, "type": "array" } }, "title": "documents_param", "type": "object" }, "company_registration_verification": { "properties": { "files": { "items": { "maxLength": 500, "type": "string" }, "type": "array" } }, "title": "documents_param", "type": "object" }, "company_tax_id_verification": { "properties": { "files": { "items": { "maxLength": 500, "type": "string" }, "type": "array" } }, "title": "documents_param", "type": "object" }, "proof_of_address": { "properties": { "files": { "items": { "maxLength": 500, "type": "string" }, "type": "array" } }, "title": "documents_param", "type": "object" }, "proof_of_registration": { "properties": { "files": { "items": { "maxLength": 500, "type": "string" }, "type": "array" } }, "title": "documents_param", "type": "object" }, "proof_of_ultimate_beneficial_ownership": { "properties": { "files": { "items": { "maxLength": 500, "type": "string" }, "type": "array" } }, "title": "documents_param", "type": "object" } }, "title": "documents_specs", "type": "object" }, "email": { "description": "The email address of the account holder. This is only to make the account easier to identify to you. If [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts, Stripe doesn't email the account without your consent.", "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "external_account": { "description": "A card or bank account to attach to the account for receiving [payouts](/connect/bank-debit-card-payouts) (you won’t be able to use it for top-ups). You can provide either a token, like the ones returned by [Stripe.js](/js), or a dictionary, as documented in the `external_account` parameter for [bank account](/api#account_create_bank_account) creation.

By default, providing an external account sets it as the new default external account for its currency, and deletes the old default if one exists. To add additional external accounts without replacing the existing default for the currency, use the [bank account](/api#account_create_bank_account) or [card creation](/api#account_create_card) APIs. After you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.", "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true }, "groups": { "description": "A hash of account group type to tokens. These are account groups this account should be added to.", "properties": { "payments_pricing": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "account_groups_specs", "type": "object" }, "individual": { "description": "Information about the person represented by the account. This field is null unless `business_type` is set to `individual`. Once you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.", "properties": { "address": { "properties": { "city": { "maxLength": 100, "type": "string" }, "country": { "maxLength": 5000, "type": "string" }, "line1": { "maxLength": 200, "type": "string" }, "line2": { "maxLength": 200, "type": "string" }, "postal_code": { "maxLength": 5000, "type": "string" }, "state": { "maxLength": 5000, "type": "string" } }, "title": "address_specs", "type": "object" }, "address_kana": { "properties": { "city": { "maxLength": 5000, "type": "string" }, "country": { "maxLength": 5000, "type": "string" }, "line1": { "maxLength": 5000, "type": "string" }, "line2": { "maxLength": 5000, "type": "string" }, "postal_code": { "maxLength": 5000, "type": "string" }, "state": { "maxLength": 5000, "type": "string" }, "town": { "maxLength": 5000, "type": "string" } }, "title": "japan_address_kana_specs", "type": "object" }, "address_kanji": { "properties": { "city": { "maxLength": 5000, "type": "string" }, "country": { "maxLength": 5000, "type": "string" }, "line1": { "maxLength": 5000, "type": "string" }, "line2": { "maxLength": 5000, "type": "string" }, "postal_code": { "maxLength": 5000, "type": "string" }, "state": { "maxLength": 5000, "type": "string" }, "town": { "maxLength": 5000, "type": "string" } }, "title": "japan_address_kanji_specs", "type": "object" }, "dob": { "anyOf": [ { "properties": { "day": { "type": "integer" }, "month": { "type": "integer" }, "year": { "type": "integer" } }, "required": [ "day", "month", "year" ], "title": "date_of_birth_specs", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "email": { "type": "string" }, "first_name": { "maxLength": 100, "type": "string" }, "first_name_kana": { "maxLength": 5000, "type": "string" }, "first_name_kanji": { "maxLength": 5000, "type": "string" }, "full_name_aliases": { "anyOf": [ { "items": { "maxLength": 300, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ] }, "gender": { "type": "string" }, "id_number": { "maxLength": 5000, "type": "string" }, "id_number_secondary": { "maxLength": 5000, "type": "string" }, "last_name": { "maxLength": 100, "type": "string" }, "last_name_kana": { "maxLength": 5000, "type": "string" }, "last_name_kanji": { "maxLength": 5000, "type": "string" }, "maiden_name": { "maxLength": 5000, "type": "string" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "phone": { "type": "string" }, "political_exposure": { "enum": [ "existing", "none" ], "type": "string" }, "registered_address": { "properties": { "city": { "maxLength": 100, "type": "string" }, "country": { "maxLength": 5000, "type": "string" }, "line1": { "maxLength": 200, "type": "string" }, "line2": { "maxLength": 200, "type": "string" }, "postal_code": { "maxLength": 5000, "type": "string" }, "state": { "maxLength": 5000, "type": "string" } }, "title": "address_specs", "type": "object" }, "relationship": { "properties": { "director": { "type": "boolean" }, "executive": { "type": "boolean" }, "owner": { "type": "boolean" }, "percent_ownership": { "anyOf": [ { "type": "number" }, { "enum": [ "" ], "type": "string" } ] }, "title": { "maxLength": 5000, "type": "string" } }, "title": "individual_relationship_specs", "type": "object" }, "ssn_last_4": { "maxLength": 5000, "type": "string" }, "verification": { "properties": { "additional_document": { "properties": { "back": { "maxLength": 500, "type": "string" }, "front": { "maxLength": 500, "type": "string" } }, "title": "person_verification_document_specs", "type": "object" }, "document": { "properties": { "back": { "maxLength": 500, "type": "string" }, "front": { "maxLength": 500, "type": "string" } }, "title": "person_verification_document_specs", "type": "object" } }, "title": "person_verification_specs", "type": "object" } }, "title": "individual_specs", "type": "object" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "settings": { "description": "Options for customizing how the account functions within Stripe.", "properties": { "bacs_debit_payments": { "properties": { "display_name": { "type": "string" } }, "title": "bacs_debit_payments_specs", "type": "object" }, "branding": { "properties": { "icon": { "maxLength": 5000, "type": "string" }, "logo": { "maxLength": 5000, "type": "string" }, "primary_color": { "maxLength": 5000, "type": "string" }, "secondary_color": { "maxLength": 5000, "type": "string" } }, "title": "branding_settings_specs", "type": "object" }, "card_issuing": { "properties": { "tos_acceptance": { "properties": { "date": { "format": "unix-time", "type": "integer" }, "ip": { "type": "string" }, "user_agent": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "settings_terms_of_service_specs", "type": "object" } }, "title": "card_issuing_settings_specs", "type": "object" }, "card_payments": { "properties": { "decline_on": { "properties": { "avs_failure": { "type": "boolean" }, "cvc_failure": { "type": "boolean" } }, "title": "decline_charge_on_specs", "type": "object" }, "statement_descriptor_prefix": { "maxLength": 10, "type": "string" }, "statement_descriptor_prefix_kana": { "anyOf": [ { "maxLength": 10, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "statement_descriptor_prefix_kanji": { "anyOf": [ { "maxLength": 10, "type": "string" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "card_payments_settings_specs", "type": "object" }, "invoices": { "properties": { "hosted_payment_method_save": { "enum": [ "always", "never", "offer" ], "type": "string" } }, "title": "invoices_settings_specs_create", "type": "object" }, "payments": { "properties": { "statement_descriptor": { "maxLength": 22, "type": "string" }, "statement_descriptor_kana": { "maxLength": 22, "type": "string" }, "statement_descriptor_kanji": { "maxLength": 22, "type": "string" } }, "title": "payments_settings_specs", "type": "object" }, "payouts": { "properties": { "debit_negative_balances": { "type": "boolean" }, "schedule": { "properties": { "delay_days": { "anyOf": [ { "enum": [ "minimum" ], "maxLength": 5000, "type": "string" }, { "type": "integer" } ] }, "interval": { "enum": [ "daily", "manual", "monthly", "weekly" ], "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true }, "monthly_anchor": { "type": "integer" }, "monthly_payout_days": { "items": { "type": "integer" }, "type": "array" }, "weekly_anchor": { "enum": [ "friday", "monday", "saturday", "sunday", "thursday", "tuesday", "wednesday" ], "maxLength": 5000, "type": "string" }, "weekly_payout_days": { "items": { "enum": [ "friday", "monday", "saturday", "sunday", "thursday", "tuesday", "wednesday" ], "type": "string" }, "type": "array" } }, "title": "transfer_schedule_specs", "type": "object" }, "statement_descriptor": { "maxLength": 22, "type": "string" } }, "title": "payout_settings_specs", "type": "object" }, "treasury": { "properties": { "tos_acceptance": { "properties": { "date": { "format": "unix-time", "type": "integer" }, "ip": { "type": "string" }, "user_agent": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "settings_terms_of_service_specs", "type": "object" } }, "title": "treasury_settings_specs", "type": "object" } }, "title": "settings_specs", "type": "object" }, "tos_acceptance": { "description": "Details on the account's acceptance of the [Stripe Services Agreement](/connect/updating-accounts#tos-acceptance). This property can only be updated for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. This property defaults to a `full` service agreement when empty.", "properties": { "date": { "format": "unix-time", "type": "integer" }, "ip": { "type": "string" }, "service_agreement": { "maxLength": 5000, "type": "string" }, "user_agent": { "maxLength": 5000, "type": "string" } }, "title": "tos_acceptance_specs", "type": "object" }, "type": { "description": "The type of Stripe account to create. May be one of `custom`, `express` or `standard`.", "enum": [ "custom", "express", "standard" ], "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/account" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } } } }, "/v1/accounts/{account}": { "delete": { "description": "

With Connect, you can delete accounts you manage.

\n\n

Test-mode accounts can be deleted at any time.

\n\n

Live-mode accounts that have access to the standard dashboard and Stripe is responsible for negative account balances cannot be deleted, which includes Standard accounts. All other Live-mode accounts, can be deleted when all balances are zero.

\n\n

If you want to delete your own account, use the account information tab in your account settings instead.

", "operationId": "DeleteAccountsAccount", "parameters": [ { "in": "path", "name": "account", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted_account" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Delete an account" }, "get": { "description": "

Retrieves the details of an account.

", "operationId": "GetAccountsAccount", "parameters": [ { "in": "path", "name": "account", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/account" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve account" }, "post": { "description": "

Updates a connected account by setting the values of the parameters passed. Any parameters not provided are\nleft unchanged.

\n\n

For accounts where controller.requirement_collection\nis application, which includes Custom accounts, you can update any information on the account.

\n\n

For accounts where controller.requirement_collection\nis stripe, which includes Standard and Express accounts, you can update all information until you create\nan Account Link or Account Session to start Connect onboarding,\nafter which some properties can no longer be updated.

\n\n

To update your own account, use the Dashboard. Refer to our\nConnect documentation to learn more about updating accounts.

", "operationId": "PostAccountsAccount", "parameters": [ { "in": "path", "name": "account", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "business_profile": { "explode": true, "style": "deepObject" }, "capabilities": { "explode": true, "style": "deepObject" }, "company": { "explode": true, "style": "deepObject" }, "documents": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "groups": { "explode": true, "style": "deepObject" }, "individual": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "settings": { "explode": true, "style": "deepObject" }, "tos_acceptance": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "account_token": { "description": "An [account token](https://stripe.com/docs/api#create_account_token), used to securely provide details to the account.", "maxLength": 5000, "type": "string" }, "business_profile": { "description": "Business information about the account.", "properties": { "annual_revenue": { "properties": { "amount": { "type": "integer" }, "currency": { "format": "currency", "type": "string" }, "fiscal_year_end": { "maxLength": 5000, "type": "string" } }, "required": [ "amount", "currency", "fiscal_year_end" ], "title": "annual_revenue_specs", "type": "object" }, "estimated_worker_count": { "type": "integer" }, "mcc": { "maxLength": 4, "type": "string" }, "minority_owned_business_designation": { "items": { "enum": [ "lgbtqi_owned_business", "minority_owned_business", "none_of_these_apply", "prefer_not_to_answer", "women_owned_business" ], "type": "string" }, "type": "array" }, "monthly_estimated_revenue": { "properties": { "amount": { "type": "integer" }, "currency": { "format": "currency", "type": "string" } }, "required": [ "amount", "currency" ], "title": "monthly_estimated_revenue_specs", "type": "object" }, "name": { "maxLength": 5000, "type": "string" }, "product_description": { "maxLength": 40000, "type": "string" }, "support_address": { "properties": { "city": { "maxLength": 100, "type": "string" }, "country": { "maxLength": 5000, "type": "string" }, "line1": { "maxLength": 200, "type": "string" }, "line2": { "maxLength": 200, "type": "string" }, "postal_code": { "maxLength": 5000, "type": "string" }, "state": { "maxLength": 5000, "type": "string" } }, "title": "address_specs", "type": "object" }, "support_email": { "type": "string" }, "support_phone": { "maxLength": 5000, "type": "string" }, "support_url": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "url": { "type": "string" } }, "title": "business_profile_update_specs", "type": "object" }, "business_type": { "description": "The business type. Once you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.", "enum": [ "company", "government_entity", "individual", "non_profit" ], "type": "string", "x-stripeBypassValidation": true }, "capabilities": { "description": "Each key of the dictionary represents a capability, and each capability\nmaps to its settings (for example, whether it has been requested or not). Each\ncapability is inactive until you have provided its specific\nrequirements and Stripe has verified them. An account might have some\nof its requested capabilities be active and some be inactive.\n\nRequired when [account.controller.stripe_dashboard.type](/api/accounts/create#create_account-controller-dashboard-type)\nis `none`, which includes Custom accounts.", "properties": { "acss_debit_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "affirm_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "afterpay_clearpay_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "alma_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "amazon_pay_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "au_becs_debit_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "bacs_debit_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "bancontact_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "bank_transfer_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "billie_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "blik_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "boleto_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "card_issuing": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "card_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "cartes_bancaires_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "cashapp_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "crypto_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "eps_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "fpx_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "gb_bank_transfer_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "giropay_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "grabpay_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "ideal_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "india_international_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "jcb_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "jp_bank_transfer_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "kakao_pay_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "klarna_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "konbini_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "kr_card_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "legacy_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "link_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "mobilepay_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "multibanco_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "mx_bank_transfer_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "naver_pay_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "nz_bank_account_becs_debit_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "oxxo_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "p24_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "pay_by_bank_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "payco_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "paynow_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "pix_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "promptpay_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "revolut_pay_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "samsung_pay_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "satispay_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "sepa_bank_transfer_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "sepa_debit_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "sofort_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "swish_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "tax_reporting_us_1099_k": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "tax_reporting_us_1099_misc": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "transfers": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "treasury": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "twint_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "us_bank_account_ach_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "us_bank_transfer_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" }, "zip_payments": { "properties": { "requested": { "type": "boolean" } }, "title": "capability_param", "type": "object" } }, "title": "capabilities_param", "type": "object" }, "company": { "description": "Information about the company or business. This field is available for any `business_type`. Once you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.", "properties": { "address": { "properties": { "city": { "maxLength": 100, "type": "string" }, "country": { "maxLength": 5000, "type": "string" }, "line1": { "maxLength": 200, "type": "string" }, "line2": { "maxLength": 200, "type": "string" }, "postal_code": { "maxLength": 5000, "type": "string" }, "state": { "maxLength": 5000, "type": "string" } }, "title": "legal_entity_and_kyc_address_specs", "type": "object" }, "address_kana": { "properties": { "city": { "maxLength": 5000, "type": "string" }, "country": { "maxLength": 5000, "type": "string" }, "line1": { "maxLength": 5000, "type": "string" }, "line2": { "maxLength": 5000, "type": "string" }, "postal_code": { "maxLength": 5000, "type": "string" }, "state": { "maxLength": 5000, "type": "string" }, "town": { "maxLength": 5000, "type": "string" } }, "title": "japan_address_kana_specs", "type": "object" }, "address_kanji": { "properties": { "city": { "maxLength": 5000, "type": "string" }, "country": { "maxLength": 5000, "type": "string" }, "line1": { "maxLength": 5000, "type": "string" }, "line2": { "maxLength": 5000, "type": "string" }, "postal_code": { "maxLength": 5000, "type": "string" }, "state": { "maxLength": 5000, "type": "string" }, "town": { "maxLength": 5000, "type": "string" } }, "title": "japan_address_kanji_specs", "type": "object" }, "directors_provided": { "type": "boolean" }, "directorship_declaration": { "properties": { "date": { "format": "unix-time", "type": "integer" }, "ip": { "type": "string" }, "user_agent": { "maxLength": 5000, "type": "string" } }, "title": "company_directorship_declaration", "type": "object" }, "executives_provided": { "type": "boolean" }, "export_license_id": { "maxLength": 5000, "type": "string" }, "export_purpose_code": { "maxLength": 5000, "type": "string" }, "name": { "maxLength": 100, "type": "string" }, "name_kana": { "maxLength": 100, "type": "string" }, "name_kanji": { "maxLength": 100, "type": "string" }, "owners_provided": { "type": "boolean" }, "ownership_declaration": { "properties": { "date": { "format": "unix-time", "type": "integer" }, "ip": { "type": "string" }, "user_agent": { "maxLength": 5000, "type": "string" } }, "title": "company_ownership_declaration", "type": "object" }, "ownership_exemption_reason": { "enum": [ "", "qualified_entity_exceeds_ownership_threshold", "qualifies_as_financial_institution" ], "type": "string" }, "phone": { "maxLength": 5000, "type": "string" }, "registration_date": { "anyOf": [ { "properties": { "day": { "type": "integer" }, "month": { "type": "integer" }, "year": { "type": "integer" } }, "required": [ "day", "month", "year" ], "title": "registration_date_specs", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "registration_number": { "maxLength": 5000, "type": "string" }, "structure": { "enum": [ "", "free_zone_establishment", "free_zone_llc", "government_instrumentality", "governmental_unit", "incorporated_non_profit", "incorporated_partnership", "limited_liability_partnership", "llc", "multi_member_llc", "private_company", "private_corporation", "private_partnership", "public_company", "public_corporation", "public_partnership", "registered_charity", "single_member_llc", "sole_establishment", "sole_proprietorship", "tax_exempt_government_instrumentality", "unincorporated_association", "unincorporated_non_profit", "unincorporated_partnership" ], "type": "string", "x-stripeBypassValidation": true }, "tax_id": { "maxLength": 5000, "type": "string" }, "tax_id_registrar": { "maxLength": 5000, "type": "string" }, "vat_id": { "maxLength": 5000, "type": "string" }, "verification": { "properties": { "document": { "properties": { "back": { "maxLength": 500, "type": "string" }, "front": { "maxLength": 500, "type": "string" } }, "title": "verification_document_specs", "type": "object" } }, "title": "verification_specs", "type": "object" } }, "title": "company_update_specs", "type": "object" }, "default_currency": { "description": "Three-letter ISO currency code representing the default currency for the account. This must be a currency that [Stripe supports in the account's country](https://docs.stripe.com/payouts).", "format": "currency", "type": "string" }, "documents": { "description": "Documents that may be submitted to satisfy various informational requests.", "properties": { "bank_account_ownership_verification": { "properties": { "files": { "items": { "maxLength": 500, "type": "string" }, "type": "array" } }, "title": "documents_param", "type": "object" }, "company_license": { "properties": { "files": { "items": { "maxLength": 500, "type": "string" }, "type": "array" } }, "title": "documents_param", "type": "object" }, "company_memorandum_of_association": { "properties": { "files": { "items": { "maxLength": 500, "type": "string" }, "type": "array" } }, "title": "documents_param", "type": "object" }, "company_ministerial_decree": { "properties": { "files": { "items": { "maxLength": 500, "type": "string" }, "type": "array" } }, "title": "documents_param", "type": "object" }, "company_registration_verification": { "properties": { "files": { "items": { "maxLength": 500, "type": "string" }, "type": "array" } }, "title": "documents_param", "type": "object" }, "company_tax_id_verification": { "properties": { "files": { "items": { "maxLength": 500, "type": "string" }, "type": "array" } }, "title": "documents_param", "type": "object" }, "proof_of_address": { "properties": { "files": { "items": { "maxLength": 500, "type": "string" }, "type": "array" } }, "title": "documents_param", "type": "object" }, "proof_of_registration": { "properties": { "files": { "items": { "maxLength": 500, "type": "string" }, "type": "array" } }, "title": "documents_param", "type": "object" }, "proof_of_ultimate_beneficial_ownership": { "properties": { "files": { "items": { "maxLength": 500, "type": "string" }, "type": "array" } }, "title": "documents_param", "type": "object" } }, "title": "documents_specs", "type": "object" }, "email": { "description": "The email address of the account holder. This is only to make the account easier to identify to you. If [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts, Stripe doesn't email the account without your consent.", "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "external_account": { "description": "A card or bank account to attach to the account for receiving [payouts](/connect/bank-debit-card-payouts) (you won’t be able to use it for top-ups). You can provide either a token, like the ones returned by [Stripe.js](/js), or a dictionary, as documented in the `external_account` parameter for [bank account](/api#account_create_bank_account) creation.

By default, providing an external account sets it as the new default external account for its currency, and deletes the old default if one exists. To add additional external accounts without replacing the existing default for the currency, use the [bank account](/api#account_create_bank_account) or [card creation](/api#account_create_card) APIs. After you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.", "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true }, "groups": { "description": "A hash of account group type to tokens. These are account groups this account should be added to.", "properties": { "payments_pricing": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "account_groups_specs", "type": "object" }, "individual": { "description": "Information about the person represented by the account. This field is null unless `business_type` is set to `individual`. Once you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.", "properties": { "address": { "properties": { "city": { "maxLength": 100, "type": "string" }, "country": { "maxLength": 5000, "type": "string" }, "line1": { "maxLength": 200, "type": "string" }, "line2": { "maxLength": 200, "type": "string" }, "postal_code": { "maxLength": 5000, "type": "string" }, "state": { "maxLength": 5000, "type": "string" } }, "title": "address_specs", "type": "object" }, "address_kana": { "properties": { "city": { "maxLength": 5000, "type": "string" }, "country": { "maxLength": 5000, "type": "string" }, "line1": { "maxLength": 5000, "type": "string" }, "line2": { "maxLength": 5000, "type": "string" }, "postal_code": { "maxLength": 5000, "type": "string" }, "state": { "maxLength": 5000, "type": "string" }, "town": { "maxLength": 5000, "type": "string" } }, "title": "japan_address_kana_specs", "type": "object" }, "address_kanji": { "properties": { "city": { "maxLength": 5000, "type": "string" }, "country": { "maxLength": 5000, "type": "string" }, "line1": { "maxLength": 5000, "type": "string" }, "line2": { "maxLength": 5000, "type": "string" }, "postal_code": { "maxLength": 5000, "type": "string" }, "state": { "maxLength": 5000, "type": "string" }, "town": { "maxLength": 5000, "type": "string" } }, "title": "japan_address_kanji_specs", "type": "object" }, "dob": { "anyOf": [ { "properties": { "day": { "type": "integer" }, "month": { "type": "integer" }, "year": { "type": "integer" } }, "required": [ "day", "month", "year" ], "title": "date_of_birth_specs", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "email": { "type": "string" }, "first_name": { "maxLength": 100, "type": "string" }, "first_name_kana": { "maxLength": 5000, "type": "string" }, "first_name_kanji": { "maxLength": 5000, "type": "string" }, "full_name_aliases": { "anyOf": [ { "items": { "maxLength": 300, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ] }, "gender": { "type": "string" }, "id_number": { "maxLength": 5000, "type": "string" }, "id_number_secondary": { "maxLength": 5000, "type": "string" }, "last_name": { "maxLength": 100, "type": "string" }, "last_name_kana": { "maxLength": 5000, "type": "string" }, "last_name_kanji": { "maxLength": 5000, "type": "string" }, "maiden_name": { "maxLength": 5000, "type": "string" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "phone": { "type": "string" }, "political_exposure": { "enum": [ "existing", "none" ], "type": "string" }, "registered_address": { "properties": { "city": { "maxLength": 100, "type": "string" }, "country": { "maxLength": 5000, "type": "string" }, "line1": { "maxLength": 200, "type": "string" }, "line2": { "maxLength": 200, "type": "string" }, "postal_code": { "maxLength": 5000, "type": "string" }, "state": { "maxLength": 5000, "type": "string" } }, "title": "address_specs", "type": "object" }, "relationship": { "properties": { "director": { "type": "boolean" }, "executive": { "type": "boolean" }, "owner": { "type": "boolean" }, "percent_ownership": { "anyOf": [ { "type": "number" }, { "enum": [ "" ], "type": "string" } ] }, "title": { "maxLength": 5000, "type": "string" } }, "title": "individual_relationship_specs", "type": "object" }, "ssn_last_4": { "maxLength": 5000, "type": "string" }, "verification": { "properties": { "additional_document": { "properties": { "back": { "maxLength": 500, "type": "string" }, "front": { "maxLength": 500, "type": "string" } }, "title": "person_verification_document_specs", "type": "object" }, "document": { "properties": { "back": { "maxLength": 500, "type": "string" }, "front": { "maxLength": 500, "type": "string" } }, "title": "person_verification_document_specs", "type": "object" } }, "title": "person_verification_specs", "type": "object" } }, "title": "individual_update_specs", "type": "object" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "settings": { "description": "Options for customizing how the account functions within Stripe.", "properties": { "bacs_debit_payments": { "properties": { "display_name": { "type": "string" } }, "title": "bacs_debit_payments_specs", "type": "object" }, "branding": { "properties": { "icon": { "maxLength": 5000, "type": "string" }, "logo": { "maxLength": 5000, "type": "string" }, "primary_color": { "maxLength": 5000, "type": "string" }, "secondary_color": { "maxLength": 5000, "type": "string" } }, "title": "branding_settings_specs", "type": "object" }, "card_issuing": { "properties": { "tos_acceptance": { "properties": { "date": { "format": "unix-time", "type": "integer" }, "ip": { "type": "string" }, "user_agent": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "settings_terms_of_service_specs", "type": "object" } }, "title": "card_issuing_settings_specs", "type": "object" }, "card_payments": { "properties": { "decline_on": { "properties": { "avs_failure": { "type": "boolean" }, "cvc_failure": { "type": "boolean" } }, "title": "decline_charge_on_specs", "type": "object" }, "statement_descriptor_prefix": { "maxLength": 10, "type": "string" }, "statement_descriptor_prefix_kana": { "anyOf": [ { "maxLength": 10, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "statement_descriptor_prefix_kanji": { "anyOf": [ { "maxLength": 10, "type": "string" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "card_payments_settings_specs", "type": "object" }, "invoices": { "properties": { "default_account_tax_ids": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ] }, "hosted_payment_method_save": { "enum": [ "always", "never", "offer" ], "type": "string" } }, "title": "invoices_settings_specs", "type": "object" }, "payments": { "properties": { "statement_descriptor": { "maxLength": 22, "type": "string" }, "statement_descriptor_kana": { "maxLength": 22, "type": "string" }, "statement_descriptor_kanji": { "maxLength": 22, "type": "string" } }, "title": "payments_settings_specs", "type": "object" }, "payouts": { "properties": { "debit_negative_balances": { "type": "boolean" }, "schedule": { "properties": { "delay_days": { "anyOf": [ { "enum": [ "minimum" ], "maxLength": 5000, "type": "string" }, { "type": "integer" } ] }, "interval": { "enum": [ "daily", "manual", "monthly", "weekly" ], "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true }, "monthly_anchor": { "type": "integer" }, "monthly_payout_days": { "items": { "type": "integer" }, "type": "array" }, "weekly_anchor": { "enum": [ "friday", "monday", "saturday", "sunday", "thursday", "tuesday", "wednesday" ], "maxLength": 5000, "type": "string" }, "weekly_payout_days": { "items": { "enum": [ "friday", "monday", "saturday", "sunday", "thursday", "tuesday", "wednesday" ], "type": "string" }, "type": "array" } }, "title": "transfer_schedule_specs", "type": "object" }, "statement_descriptor": { "maxLength": 22, "type": "string" } }, "title": "payout_settings_specs", "type": "object" }, "treasury": { "properties": { "tos_acceptance": { "properties": { "date": { "format": "unix-time", "type": "integer" }, "ip": { "type": "string" }, "user_agent": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "settings_terms_of_service_specs", "type": "object" } }, "title": "treasury_settings_specs", "type": "object" } }, "title": "settings_specs_update", "type": "object" }, "tos_acceptance": { "description": "Details on the account's acceptance of the [Stripe Services Agreement](/connect/updating-accounts#tos-acceptance). This property can only be updated for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. This property defaults to a `full` service agreement when empty.", "properties": { "date": { "format": "unix-time", "type": "integer" }, "ip": { "type": "string" }, "service_agreement": { "maxLength": 5000, "type": "string" }, "user_agent": { "maxLength": 5000, "type": "string" } }, "title": "tos_acceptance_specs", "type": "object" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/account" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update an account" } }, "/v1/accounts/{account}/bank_accounts": { "post": { "description": "

Create an external account for a given account.

", "operationId": "PostAccountsAccountBankAccounts", "parameters": [ { "in": "path", "name": "account", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "bank_account": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "bank_account": { "anyOf": [ { "properties": { "account_holder_name": { "maxLength": 5000, "type": "string" }, "account_holder_type": { "enum": [ "company", "individual" ], "maxLength": 5000, "type": "string" }, "account_number": { "maxLength": 5000, "type": "string" }, "account_type": { "enum": [ "checking", "futsu", "savings", "toza" ], "maxLength": 5000, "type": "string" }, "country": { "maxLength": 5000, "type": "string" }, "currency": { "format": "currency", "type": "string" }, "documents": { "properties": { "bank_account_ownership_verification": { "properties": { "files": { "items": { "maxLength": 500, "type": "string" }, "type": "array" } }, "title": "documents_param", "type": "object" } }, "title": "external_account_documents_param", "type": "object" }, "object": { "enum": [ "bank_account" ], "maxLength": 5000, "type": "string" }, "routing_number": { "maxLength": 5000, "type": "string" } }, "required": [ "account_number", "country" ], "title": "external_account_payout_bank_account", "type": "object" }, { "maxLength": 5000, "type": "string" } ], "description": "Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details." }, "default_for_currency": { "description": "When set to true, or if this is the first external account added in this currency, this account becomes the default external account for its currency.", "type": "boolean" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "external_account": { "description": "A token, like the ones returned by [Stripe.js](https://stripe.com/docs/js) or a dictionary containing a user's external account details (with the options shown below). Please refer to full [documentation](https://stripe.com/docs/api/external_accounts) instead.", "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/external_account" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create an external account" } }, "/v1/accounts/{account}/bank_accounts/{id}": { "delete": { "description": "

Delete a specified external account for a given account.

", "operationId": "DeleteAccountsAccountBankAccountsId", "parameters": [ { "in": "path", "name": "account", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "description": "Unique identifier for the external account to be deleted.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted_external_account" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Delete an external account" }, "get": { "description": "

Retrieve a specified external account for a given account.

", "operationId": "GetAccountsAccountBankAccountsId", "parameters": [ { "in": "path", "name": "account", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "Unique identifier for the external account to be retrieved.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/external_account" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve an external account" }, "post": { "description": "

Updates the metadata, account holder name, account holder type of a bank account belonging to\na connected account and optionally sets it as the default for its currency. Other bank account\ndetails are not editable by design.

\n\n

You can only update bank accounts when account.controller.requirement_collection is application, which includes Custom accounts.

\n\n

You can re-enable a disabled bank account by performing an update call without providing any\narguments or changes.

", "operationId": "PostAccountsAccountBankAccountsId", "parameters": [ { "in": "path", "name": "account", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "documents": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "account_holder_name": { "description": "The name of the person or business that owns the bank account.", "maxLength": 5000, "type": "string" }, "account_holder_type": { "description": "The type of entity that holds the account. This can be either `individual` or `company`.", "enum": [ "", "company", "individual" ], "maxLength": 5000, "type": "string" }, "account_type": { "description": "The bank account type. This can only be `checking` or `savings` in most countries. In Japan, this can only be `futsu` or `toza`.", "enum": [ "checking", "futsu", "savings", "toza" ], "maxLength": 5000, "type": "string" }, "address_city": { "description": "City/District/Suburb/Town/Village.", "maxLength": 5000, "type": "string" }, "address_country": { "description": "Billing address country, if provided when creating card.", "maxLength": 5000, "type": "string" }, "address_line1": { "description": "Address line 1 (Street address/PO Box/Company name).", "maxLength": 5000, "type": "string" }, "address_line2": { "description": "Address line 2 (Apartment/Suite/Unit/Building).", "maxLength": 5000, "type": "string" }, "address_state": { "description": "State/County/Province/Region.", "maxLength": 5000, "type": "string" }, "address_zip": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "default_for_currency": { "description": "When set to true, this becomes the default external account for its currency.", "type": "boolean" }, "documents": { "description": "Documents that may be submitted to satisfy various informational requests.", "properties": { "bank_account_ownership_verification": { "properties": { "files": { "items": { "maxLength": 500, "type": "string" }, "type": "array" } }, "title": "documents_param", "type": "object" } }, "title": "external_account_documents_param", "type": "object" }, "exp_month": { "description": "Two digit number representing the card’s expiration month.", "maxLength": 5000, "type": "string" }, "exp_year": { "description": "Four digit number representing the card’s expiration year.", "maxLength": 5000, "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "name": { "description": "Cardholder name.", "maxLength": 5000, "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/external_account" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } } } }, "/v1/accounts/{account}/capabilities": { "get": { "description": "

Returns a list of capabilities associated with the account. The capabilities are returned sorted by creation date, with the most recent capability appearing first.

", "operationId": "GetAccountsAccountCapabilities", "parameters": [ { "in": "path", "name": "account", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/capability" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "ListAccountCapability", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all account capabilities" } }, "/v1/accounts/{account}/capabilities/{capability}": { "get": { "description": "

Retrieves information about the specified Account Capability.

", "operationId": "GetAccountsAccountCapabilitiesCapability", "parameters": [ { "in": "path", "name": "account", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "in": "path", "name": "capability", "required": true, "schema": { "type": "string" }, "style": "simple" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve an Account Capability" }, "post": { "description": "

Updates an existing Account Capability. Request or remove a capability by updating its requested parameter.

", "operationId": "PostAccountsAccountCapabilitiesCapability", "parameters": [ { "in": "path", "name": "account", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "in": "path", "name": "capability", "required": true, "schema": { "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "requested": { "description": "To request a new capability for an account, pass true. There can be a delay before the requested capability becomes active. If the capability has any activation requirements, the response includes them in the `requirements` arrays.\n\nIf a capability isn't permanent, you can remove it from the account by passing false. Some capabilities are permanent after they've been requested. Attempting to remove a permanent capability returns an error.", "type": "boolean" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update an Account Capability" } }, "/v1/accounts/{account}/external_accounts": { "get": { "description": "

List external accounts for an account.

", "operationId": "GetAccountsAccountExternalAccounts", "parameters": [ { "in": "path", "name": "account", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "Filter external accounts according to a particular object type.", "in": "query", "name": "object", "required": false, "schema": { "enum": [ "bank_account", "card" ], "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "description": "The list contains all external accounts that have been attached to the Stripe account. These may be bank accounts or cards.", "items": { "anyOf": [ { "$ref": "#/components/schemas/bank_account" }, { "$ref": "#/components/schemas/card" } ], "title": "Polymorphic", "x-stripeBypassValidation": true }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "ExternalAccountList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all external accounts" }, "post": { "description": "

Create an external account for a given account.

", "operationId": "PostAccountsAccountExternalAccounts", "parameters": [ { "in": "path", "name": "account", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "bank_account": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "bank_account": { "anyOf": [ { "properties": { "account_holder_name": { "maxLength": 5000, "type": "string" }, "account_holder_type": { "enum": [ "company", "individual" ], "maxLength": 5000, "type": "string" }, "account_number": { "maxLength": 5000, "type": "string" }, "account_type": { "enum": [ "checking", "futsu", "savings", "toza" ], "maxLength": 5000, "type": "string" }, "country": { "maxLength": 5000, "type": "string" }, "currency": { "format": "currency", "type": "string" }, "documents": { "properties": { "bank_account_ownership_verification": { "properties": { "files": { "items": { "maxLength": 500, "type": "string" }, "type": "array" } }, "title": "documents_param", "type": "object" } }, "title": "external_account_documents_param", "type": "object" }, "object": { "enum": [ "bank_account" ], "maxLength": 5000, "type": "string" }, "routing_number": { "maxLength": 5000, "type": "string" } }, "required": [ "account_number", "country" ], "title": "external_account_payout_bank_account", "type": "object" }, { "maxLength": 5000, "type": "string" } ], "description": "Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details." }, "default_for_currency": { "description": "When set to true, or if this is the first external account added in this currency, this account becomes the default external account for its currency.", "type": "boolean" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "external_account": { "description": "A token, like the ones returned by [Stripe.js](https://stripe.com/docs/js) or a dictionary containing a user's external account details (with the options shown below). Please refer to full [documentation](https://stripe.com/docs/api/external_accounts) instead.", "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/external_account" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create an external account" } }, "/v1/accounts/{account}/external_accounts/{id}": { "delete": { "description": "

Delete a specified external account for a given account.

", "operationId": "DeleteAccountsAccountExternalAccountsId", "parameters": [ { "in": "path", "name": "account", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "description": "Unique identifier for the external account to be deleted.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted_external_account" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Delete an external account" }, "get": { "description": "

Retrieve a specified external account for a given account.

", "operationId": "GetAccountsAccountExternalAccountsId", "parameters": [ { "in": "path", "name": "account", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "Unique identifier for the external account to be retrieved.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/external_account" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve an external account" }, "post": { "description": "

Updates the metadata, account holder name, account holder type of a bank account belonging to\na connected account and optionally sets it as the default for its currency. Other bank account\ndetails are not editable by design.

\n\n

You can only update bank accounts when account.controller.requirement_collection is application, which includes Custom accounts.

\n\n

You can re-enable a disabled bank account by performing an update call without providing any\narguments or changes.

", "operationId": "PostAccountsAccountExternalAccountsId", "parameters": [ { "in": "path", "name": "account", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "documents": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "account_holder_name": { "description": "The name of the person or business that owns the bank account.", "maxLength": 5000, "type": "string" }, "account_holder_type": { "description": "The type of entity that holds the account. This can be either `individual` or `company`.", "enum": [ "", "company", "individual" ], "maxLength": 5000, "type": "string" }, "account_type": { "description": "The bank account type. This can only be `checking` or `savings` in most countries. In Japan, this can only be `futsu` or `toza`.", "enum": [ "checking", "futsu", "savings", "toza" ], "maxLength": 5000, "type": "string" }, "address_city": { "description": "City/District/Suburb/Town/Village.", "maxLength": 5000, "type": "string" }, "address_country": { "description": "Billing address country, if provided when creating card.", "maxLength": 5000, "type": "string" }, "address_line1": { "description": "Address line 1 (Street address/PO Box/Company name).", "maxLength": 5000, "type": "string" }, "address_line2": { "description": "Address line 2 (Apartment/Suite/Unit/Building).", "maxLength": 5000, "type": "string" }, "address_state": { "description": "State/County/Province/Region.", "maxLength": 5000, "type": "string" }, "address_zip": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "default_for_currency": { "description": "When set to true, this becomes the default external account for its currency.", "type": "boolean" }, "documents": { "description": "Documents that may be submitted to satisfy various informational requests.", "properties": { "bank_account_ownership_verification": { "properties": { "files": { "items": { "maxLength": 500, "type": "string" }, "type": "array" } }, "title": "documents_param", "type": "object" } }, "title": "external_account_documents_param", "type": "object" }, "exp_month": { "description": "Two digit number representing the card’s expiration month.", "maxLength": 5000, "type": "string" }, "exp_year": { "description": "Four digit number representing the card’s expiration year.", "maxLength": 5000, "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "name": { "description": "Cardholder name.", "maxLength": 5000, "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/external_account" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } } } }, "/v1/accounts/{account}/login_links": { "post": { "description": "

Creates a login link for a connected account to access the Express Dashboard.

\n\n

You can only create login links for accounts that use the Express Dashboard and are connected to your platform.

", "operationId": "PostAccountsAccountLoginLinks", "parameters": [ { "in": "path", "name": "account", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/login_link" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a login link" } }, "/v1/accounts/{account}/people": { "get": { "description": "

Returns a list of people associated with the account’s legal entity. The people are returned sorted by creation date, with the most recent people appearing first.

", "operationId": "GetAccountsAccountPeople", "parameters": [ { "in": "path", "name": "account", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "Filters on the list of people returned based on the person's relationship to the account's company.", "explode": true, "in": "query", "name": "relationship", "required": false, "schema": { "properties": { "authorizer": { "type": "boolean" }, "director": { "type": "boolean" }, "executive": { "type": "boolean" }, "legal_guardian": { "type": "boolean" }, "owner": { "type": "boolean" }, "representative": { "type": "boolean" } }, "title": "all_people_relationship_specs", "type": "object" }, "style": "deepObject" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/person" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "PersonList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all persons" }, "post": { "description": "

Creates a new person.

", "operationId": "PostAccountsAccountPeople", "parameters": [ { "in": "path", "name": "account", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "additional_tos_acceptances": { "explode": true, "style": "deepObject" }, "address": { "explode": true, "style": "deepObject" }, "address_kana": { "explode": true, "style": "deepObject" }, "address_kanji": { "explode": true, "style": "deepObject" }, "dob": { "explode": true, "style": "deepObject" }, "documents": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "full_name_aliases": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "registered_address": { "explode": true, "style": "deepObject" }, "relationship": { "explode": true, "style": "deepObject" }, "us_cfpb_data": { "explode": true, "style": "deepObject" }, "verification": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "additional_tos_acceptances": { "description": "Details on the legal guardian's or authorizer's acceptance of the required Stripe agreements.", "properties": { "account": { "properties": { "date": { "format": "unix-time", "type": "integer" }, "ip": { "type": "string" }, "user_agent": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "settings_terms_of_service_specs", "type": "object" } }, "title": "person_additional_tos_acceptances_specs", "type": "object" }, "address": { "description": "The person's address.", "properties": { "city": { "maxLength": 100, "type": "string" }, "country": { "maxLength": 5000, "type": "string" }, "line1": { "maxLength": 200, "type": "string" }, "line2": { "maxLength": 200, "type": "string" }, "postal_code": { "maxLength": 5000, "type": "string" }, "state": { "maxLength": 5000, "type": "string" } }, "title": "legal_entity_and_kyc_address_specs", "type": "object" }, "address_kana": { "description": "The Kana variation of the person's address (Japan only).", "properties": { "city": { "maxLength": 5000, "type": "string" }, "country": { "maxLength": 5000, "type": "string" }, "line1": { "maxLength": 5000, "type": "string" }, "line2": { "maxLength": 5000, "type": "string" }, "postal_code": { "maxLength": 5000, "type": "string" }, "state": { "maxLength": 5000, "type": "string" }, "town": { "maxLength": 5000, "type": "string" } }, "title": "japan_address_kana_specs", "type": "object" }, "address_kanji": { "description": "The Kanji variation of the person's address (Japan only).", "properties": { "city": { "maxLength": 5000, "type": "string" }, "country": { "maxLength": 5000, "type": "string" }, "line1": { "maxLength": 5000, "type": "string" }, "line2": { "maxLength": 5000, "type": "string" }, "postal_code": { "maxLength": 5000, "type": "string" }, "state": { "maxLength": 5000, "type": "string" }, "town": { "maxLength": 5000, "type": "string" } }, "title": "japan_address_kanji_specs", "type": "object" }, "dob": { "anyOf": [ { "properties": { "day": { "type": "integer" }, "month": { "type": "integer" }, "year": { "type": "integer" } }, "required": [ "day", "month", "year" ], "title": "date_of_birth_specs", "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "The person's date of birth." }, "documents": { "description": "Documents that may be submitted to satisfy various informational requests.", "properties": { "company_authorization": { "properties": { "files": { "items": { "anyOf": [ { "maxLength": 500, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "type": "array" } }, "title": "documents_param", "type": "object" }, "passport": { "properties": { "files": { "items": { "anyOf": [ { "maxLength": 500, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "type": "array" } }, "title": "documents_param", "type": "object" }, "visa": { "properties": { "files": { "items": { "anyOf": [ { "maxLength": 500, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "type": "array" } }, "title": "documents_param", "type": "object" } }, "title": "person_documents_specs", "type": "object" }, "email": { "description": "The person's email address.", "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "first_name": { "description": "The person's first name.", "maxLength": 5000, "type": "string" }, "first_name_kana": { "description": "The Kana variation of the person's first name (Japan only).", "maxLength": 5000, "type": "string" }, "first_name_kanji": { "description": "The Kanji variation of the person's first name (Japan only).", "maxLength": 5000, "type": "string" }, "full_name_aliases": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "A list of alternate names or aliases that the person is known by." }, "gender": { "description": "The person's gender (International regulations require either \"male\" or \"female\").", "type": "string" }, "id_number": { "description": "The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii).", "maxLength": 5000, "type": "string" }, "id_number_secondary": { "description": "The person's secondary ID number, as appropriate for their country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii).", "maxLength": 5000, "type": "string" }, "last_name": { "description": "The person's last name.", "maxLength": 5000, "type": "string" }, "last_name_kana": { "description": "The Kana variation of the person's last name (Japan only).", "maxLength": 5000, "type": "string" }, "last_name_kanji": { "description": "The Kanji variation of the person's last name (Japan only).", "maxLength": 5000, "type": "string" }, "maiden_name": { "description": "The person's maiden name.", "maxLength": 5000, "type": "string" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "nationality": { "description": "The country where the person is a national. Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)), or \"XX\" if unavailable.", "maxLength": 5000, "type": "string" }, "person_token": { "description": "A [person token](https://docs.stripe.com/connect/account-tokens), used to securely provide details to the person.", "maxLength": 5000, "type": "string" }, "phone": { "description": "The person's phone number.", "type": "string" }, "political_exposure": { "description": "Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction.", "enum": [ "existing", "none" ], "type": "string" }, "registered_address": { "description": "The person's registered address.", "properties": { "city": { "maxLength": 100, "type": "string" }, "country": { "maxLength": 5000, "type": "string" }, "line1": { "maxLength": 200, "type": "string" }, "line2": { "maxLength": 200, "type": "string" }, "postal_code": { "maxLength": 5000, "type": "string" }, "state": { "maxLength": 5000, "type": "string" } }, "title": "address_specs", "type": "object" }, "relationship": { "description": "The relationship that this person has with the account's legal entity.", "properties": { "authorizer": { "type": "boolean" }, "director": { "type": "boolean" }, "executive": { "type": "boolean" }, "legal_guardian": { "type": "boolean" }, "owner": { "type": "boolean" }, "percent_ownership": { "anyOf": [ { "type": "number" }, { "enum": [ "" ], "type": "string" } ] }, "representative": { "type": "boolean" }, "title": { "maxLength": 5000, "type": "string" } }, "title": "relationship_specs", "type": "object" }, "ssn_last_4": { "description": "The last four digits of the person's Social Security number (U.S. only).", "type": "string" }, "us_cfpb_data": { "description": "Demographic data related to the person.", "properties": { "ethnicity_details": { "properties": { "ethnicity": { "items": { "enum": [ "cuban", "hispanic_or_latino", "mexican", "not_hispanic_or_latino", "other_hispanic_or_latino", "prefer_not_to_answer", "puerto_rican" ], "type": "string" }, "type": "array" }, "ethnicity_other": { "maxLength": 5000, "type": "string" } }, "title": "us_cfpb_ethnicity_details_specs", "type": "object" }, "race_details": { "properties": { "race": { "items": { "enum": [ "african_american", "american_indian_or_alaska_native", "asian", "asian_indian", "black_or_african_american", "chinese", "ethiopian", "filipino", "guamanian_or_chamorro", "haitian", "jamaican", "japanese", "korean", "native_hawaiian", "native_hawaiian_or_other_pacific_islander", "nigerian", "other_asian", "other_black_or_african_american", "other_pacific_islander", "prefer_not_to_answer", "samoan", "somali", "vietnamese", "white" ], "type": "string" }, "type": "array" }, "race_other": { "maxLength": 5000, "type": "string" } }, "title": "us_cfpb_race_details_specs", "type": "object" }, "self_identified_gender": { "maxLength": 5000, "type": "string" } }, "title": "us_cfpb_data_specs", "type": "object" }, "verification": { "description": "The person's verification status.", "properties": { "additional_document": { "properties": { "back": { "maxLength": 500, "type": "string" }, "front": { "maxLength": 500, "type": "string" } }, "title": "person_verification_document_specs", "type": "object" }, "document": { "properties": { "back": { "maxLength": 500, "type": "string" }, "front": { "maxLength": 500, "type": "string" } }, "title": "person_verification_document_specs", "type": "object" } }, "title": "person_verification_specs", "type": "object" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/person" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a person" } }, "/v1/accounts/{account}/people/{person}": { "delete": { "description": "

Deletes an existing person’s relationship to the account’s legal entity. Any person with a relationship for an account can be deleted through the API, except if the person is the account_opener. If your integration is using the executive parameter, you cannot delete the only verified executive on file.

", "operationId": "DeleteAccountsAccountPeoplePerson", "parameters": [ { "in": "path", "name": "account", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "in": "path", "name": "person", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted_person" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Delete a person" }, "get": { "description": "

Retrieves an existing person.

", "operationId": "GetAccountsAccountPeoplePerson", "parameters": [ { "in": "path", "name": "account", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "person", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/person" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a person" }, "post": { "description": "

Updates an existing person.

", "operationId": "PostAccountsAccountPeoplePerson", "parameters": [ { "in": "path", "name": "account", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "in": "path", "name": "person", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "additional_tos_acceptances": { "explode": true, "style": "deepObject" }, "address": { "explode": true, "style": "deepObject" }, "address_kana": { "explode": true, "style": "deepObject" }, "address_kanji": { "explode": true, "style": "deepObject" }, "dob": { "explode": true, "style": "deepObject" }, "documents": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "full_name_aliases": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "registered_address": { "explode": true, "style": "deepObject" }, "relationship": { "explode": true, "style": "deepObject" }, "us_cfpb_data": { "explode": true, "style": "deepObject" }, "verification": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "additional_tos_acceptances": { "description": "Details on the legal guardian's or authorizer's acceptance of the required Stripe agreements.", "properties": { "account": { "properties": { "date": { "format": "unix-time", "type": "integer" }, "ip": { "type": "string" }, "user_agent": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "settings_terms_of_service_specs", "type": "object" } }, "title": "person_additional_tos_acceptances_specs", "type": "object" }, "address": { "description": "The person's address.", "properties": { "city": { "maxLength": 100, "type": "string" }, "country": { "maxLength": 5000, "type": "string" }, "line1": { "maxLength": 200, "type": "string" }, "line2": { "maxLength": 200, "type": "string" }, "postal_code": { "maxLength": 5000, "type": "string" }, "state": { "maxLength": 5000, "type": "string" } }, "title": "legal_entity_and_kyc_address_specs", "type": "object" }, "address_kana": { "description": "The Kana variation of the person's address (Japan only).", "properties": { "city": { "maxLength": 5000, "type": "string" }, "country": { "maxLength": 5000, "type": "string" }, "line1": { "maxLength": 5000, "type": "string" }, "line2": { "maxLength": 5000, "type": "string" }, "postal_code": { "maxLength": 5000, "type": "string" }, "state": { "maxLength": 5000, "type": "string" }, "town": { "maxLength": 5000, "type": "string" } }, "title": "japan_address_kana_specs", "type": "object" }, "address_kanji": { "description": "The Kanji variation of the person's address (Japan only).", "properties": { "city": { "maxLength": 5000, "type": "string" }, "country": { "maxLength": 5000, "type": "string" }, "line1": { "maxLength": 5000, "type": "string" }, "line2": { "maxLength": 5000, "type": "string" }, "postal_code": { "maxLength": 5000, "type": "string" }, "state": { "maxLength": 5000, "type": "string" }, "town": { "maxLength": 5000, "type": "string" } }, "title": "japan_address_kanji_specs", "type": "object" }, "dob": { "anyOf": [ { "properties": { "day": { "type": "integer" }, "month": { "type": "integer" }, "year": { "type": "integer" } }, "required": [ "day", "month", "year" ], "title": "date_of_birth_specs", "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "The person's date of birth." }, "documents": { "description": "Documents that may be submitted to satisfy various informational requests.", "properties": { "company_authorization": { "properties": { "files": { "items": { "anyOf": [ { "maxLength": 500, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "type": "array" } }, "title": "documents_param", "type": "object" }, "passport": { "properties": { "files": { "items": { "anyOf": [ { "maxLength": 500, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "type": "array" } }, "title": "documents_param", "type": "object" }, "visa": { "properties": { "files": { "items": { "anyOf": [ { "maxLength": 500, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "type": "array" } }, "title": "documents_param", "type": "object" } }, "title": "person_documents_specs", "type": "object" }, "email": { "description": "The person's email address.", "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "first_name": { "description": "The person's first name.", "maxLength": 5000, "type": "string" }, "first_name_kana": { "description": "The Kana variation of the person's first name (Japan only).", "maxLength": 5000, "type": "string" }, "first_name_kanji": { "description": "The Kanji variation of the person's first name (Japan only).", "maxLength": 5000, "type": "string" }, "full_name_aliases": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "A list of alternate names or aliases that the person is known by." }, "gender": { "description": "The person's gender (International regulations require either \"male\" or \"female\").", "type": "string" }, "id_number": { "description": "The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii).", "maxLength": 5000, "type": "string" }, "id_number_secondary": { "description": "The person's secondary ID number, as appropriate for their country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii).", "maxLength": 5000, "type": "string" }, "last_name": { "description": "The person's last name.", "maxLength": 5000, "type": "string" }, "last_name_kana": { "description": "The Kana variation of the person's last name (Japan only).", "maxLength": 5000, "type": "string" }, "last_name_kanji": { "description": "The Kanji variation of the person's last name (Japan only).", "maxLength": 5000, "type": "string" }, "maiden_name": { "description": "The person's maiden name.", "maxLength": 5000, "type": "string" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "nationality": { "description": "The country where the person is a national. Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)), or \"XX\" if unavailable.", "maxLength": 5000, "type": "string" }, "person_token": { "description": "A [person token](https://docs.stripe.com/connect/account-tokens), used to securely provide details to the person.", "maxLength": 5000, "type": "string" }, "phone": { "description": "The person's phone number.", "type": "string" }, "political_exposure": { "description": "Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction.", "enum": [ "existing", "none" ], "type": "string" }, "registered_address": { "description": "The person's registered address.", "properties": { "city": { "maxLength": 100, "type": "string" }, "country": { "maxLength": 5000, "type": "string" }, "line1": { "maxLength": 200, "type": "string" }, "line2": { "maxLength": 200, "type": "string" }, "postal_code": { "maxLength": 5000, "type": "string" }, "state": { "maxLength": 5000, "type": "string" } }, "title": "address_specs", "type": "object" }, "relationship": { "description": "The relationship that this person has with the account's legal entity.", "properties": { "authorizer": { "type": "boolean" }, "director": { "type": "boolean" }, "executive": { "type": "boolean" }, "legal_guardian": { "type": "boolean" }, "owner": { "type": "boolean" }, "percent_ownership": { "anyOf": [ { "type": "number" }, { "enum": [ "" ], "type": "string" } ] }, "representative": { "type": "boolean" }, "title": { "maxLength": 5000, "type": "string" } }, "title": "relationship_specs", "type": "object" }, "ssn_last_4": { "description": "The last four digits of the person's Social Security number (U.S. only).", "type": "string" }, "us_cfpb_data": { "description": "Demographic data related to the person.", "properties": { "ethnicity_details": { "properties": { "ethnicity": { "items": { "enum": [ "cuban", "hispanic_or_latino", "mexican", "not_hispanic_or_latino", "other_hispanic_or_latino", "prefer_not_to_answer", "puerto_rican" ], "type": "string" }, "type": "array" }, "ethnicity_other": { "maxLength": 5000, "type": "string" } }, "title": "us_cfpb_ethnicity_details_specs", "type": "object" }, "race_details": { "properties": { "race": { "items": { "enum": [ "african_american", "american_indian_or_alaska_native", "asian", "asian_indian", "black_or_african_american", "chinese", "ethiopian", "filipino", "guamanian_or_chamorro", "haitian", "jamaican", "japanese", "korean", "native_hawaiian", "native_hawaiian_or_other_pacific_islander", "nigerian", "other_asian", "other_black_or_african_american", "other_pacific_islander", "prefer_not_to_answer", "samoan", "somali", "vietnamese", "white" ], "type": "string" }, "type": "array" }, "race_other": { "maxLength": 5000, "type": "string" } }, "title": "us_cfpb_race_details_specs", "type": "object" }, "self_identified_gender": { "maxLength": 5000, "type": "string" } }, "title": "us_cfpb_data_specs", "type": "object" }, "verification": { "description": "The person's verification status.", "properties": { "additional_document": { "properties": { "back": { "maxLength": 500, "type": "string" }, "front": { "maxLength": 500, "type": "string" } }, "title": "person_verification_document_specs", "type": "object" }, "document": { "properties": { "back": { "maxLength": 500, "type": "string" }, "front": { "maxLength": 500, "type": "string" } }, "title": "person_verification_document_specs", "type": "object" } }, "title": "person_verification_specs", "type": "object" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/person" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a person" } }, "/v1/accounts/{account}/persons": { "get": { "description": "

Returns a list of people associated with the account’s legal entity. The people are returned sorted by creation date, with the most recent people appearing first.

", "operationId": "GetAccountsAccountPersons", "parameters": [ { "in": "path", "name": "account", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "Filters on the list of people returned based on the person's relationship to the account's company.", "explode": true, "in": "query", "name": "relationship", "required": false, "schema": { "properties": { "authorizer": { "type": "boolean" }, "director": { "type": "boolean" }, "executive": { "type": "boolean" }, "legal_guardian": { "type": "boolean" }, "owner": { "type": "boolean" }, "representative": { "type": "boolean" } }, "title": "all_people_relationship_specs", "type": "object" }, "style": "deepObject" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/person" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "PersonList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all persons" }, "post": { "description": "

Creates a new person.

", "operationId": "PostAccountsAccountPersons", "parameters": [ { "in": "path", "name": "account", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "additional_tos_acceptances": { "explode": true, "style": "deepObject" }, "address": { "explode": true, "style": "deepObject" }, "address_kana": { "explode": true, "style": "deepObject" }, "address_kanji": { "explode": true, "style": "deepObject" }, "dob": { "explode": true, "style": "deepObject" }, "documents": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "full_name_aliases": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "registered_address": { "explode": true, "style": "deepObject" }, "relationship": { "explode": true, "style": "deepObject" }, "us_cfpb_data": { "explode": true, "style": "deepObject" }, "verification": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "additional_tos_acceptances": { "description": "Details on the legal guardian's or authorizer's acceptance of the required Stripe agreements.", "properties": { "account": { "properties": { "date": { "format": "unix-time", "type": "integer" }, "ip": { "type": "string" }, "user_agent": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "settings_terms_of_service_specs", "type": "object" } }, "title": "person_additional_tos_acceptances_specs", "type": "object" }, "address": { "description": "The person's address.", "properties": { "city": { "maxLength": 100, "type": "string" }, "country": { "maxLength": 5000, "type": "string" }, "line1": { "maxLength": 200, "type": "string" }, "line2": { "maxLength": 200, "type": "string" }, "postal_code": { "maxLength": 5000, "type": "string" }, "state": { "maxLength": 5000, "type": "string" } }, "title": "legal_entity_and_kyc_address_specs", "type": "object" }, "address_kana": { "description": "The Kana variation of the person's address (Japan only).", "properties": { "city": { "maxLength": 5000, "type": "string" }, "country": { "maxLength": 5000, "type": "string" }, "line1": { "maxLength": 5000, "type": "string" }, "line2": { "maxLength": 5000, "type": "string" }, "postal_code": { "maxLength": 5000, "type": "string" }, "state": { "maxLength": 5000, "type": "string" }, "town": { "maxLength": 5000, "type": "string" } }, "title": "japan_address_kana_specs", "type": "object" }, "address_kanji": { "description": "The Kanji variation of the person's address (Japan only).", "properties": { "city": { "maxLength": 5000, "type": "string" }, "country": { "maxLength": 5000, "type": "string" }, "line1": { "maxLength": 5000, "type": "string" }, "line2": { "maxLength": 5000, "type": "string" }, "postal_code": { "maxLength": 5000, "type": "string" }, "state": { "maxLength": 5000, "type": "string" }, "town": { "maxLength": 5000, "type": "string" } }, "title": "japan_address_kanji_specs", "type": "object" }, "dob": { "anyOf": [ { "properties": { "day": { "type": "integer" }, "month": { "type": "integer" }, "year": { "type": "integer" } }, "required": [ "day", "month", "year" ], "title": "date_of_birth_specs", "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "The person's date of birth." }, "documents": { "description": "Documents that may be submitted to satisfy various informational requests.", "properties": { "company_authorization": { "properties": { "files": { "items": { "anyOf": [ { "maxLength": 500, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "type": "array" } }, "title": "documents_param", "type": "object" }, "passport": { "properties": { "files": { "items": { "anyOf": [ { "maxLength": 500, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "type": "array" } }, "title": "documents_param", "type": "object" }, "visa": { "properties": { "files": { "items": { "anyOf": [ { "maxLength": 500, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "type": "array" } }, "title": "documents_param", "type": "object" } }, "title": "person_documents_specs", "type": "object" }, "email": { "description": "The person's email address.", "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "first_name": { "description": "The person's first name.", "maxLength": 5000, "type": "string" }, "first_name_kana": { "description": "The Kana variation of the person's first name (Japan only).", "maxLength": 5000, "type": "string" }, "first_name_kanji": { "description": "The Kanji variation of the person's first name (Japan only).", "maxLength": 5000, "type": "string" }, "full_name_aliases": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "A list of alternate names or aliases that the person is known by." }, "gender": { "description": "The person's gender (International regulations require either \"male\" or \"female\").", "type": "string" }, "id_number": { "description": "The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii).", "maxLength": 5000, "type": "string" }, "id_number_secondary": { "description": "The person's secondary ID number, as appropriate for their country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii).", "maxLength": 5000, "type": "string" }, "last_name": { "description": "The person's last name.", "maxLength": 5000, "type": "string" }, "last_name_kana": { "description": "The Kana variation of the person's last name (Japan only).", "maxLength": 5000, "type": "string" }, "last_name_kanji": { "description": "The Kanji variation of the person's last name (Japan only).", "maxLength": 5000, "type": "string" }, "maiden_name": { "description": "The person's maiden name.", "maxLength": 5000, "type": "string" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "nationality": { "description": "The country where the person is a national. Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)), or \"XX\" if unavailable.", "maxLength": 5000, "type": "string" }, "person_token": { "description": "A [person token](https://docs.stripe.com/connect/account-tokens), used to securely provide details to the person.", "maxLength": 5000, "type": "string" }, "phone": { "description": "The person's phone number.", "type": "string" }, "political_exposure": { "description": "Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction.", "enum": [ "existing", "none" ], "type": "string" }, "registered_address": { "description": "The person's registered address.", "properties": { "city": { "maxLength": 100, "type": "string" }, "country": { "maxLength": 5000, "type": "string" }, "line1": { "maxLength": 200, "type": "string" }, "line2": { "maxLength": 200, "type": "string" }, "postal_code": { "maxLength": 5000, "type": "string" }, "state": { "maxLength": 5000, "type": "string" } }, "title": "address_specs", "type": "object" }, "relationship": { "description": "The relationship that this person has with the account's legal entity.", "properties": { "authorizer": { "type": "boolean" }, "director": { "type": "boolean" }, "executive": { "type": "boolean" }, "legal_guardian": { "type": "boolean" }, "owner": { "type": "boolean" }, "percent_ownership": { "anyOf": [ { "type": "number" }, { "enum": [ "" ], "type": "string" } ] }, "representative": { "type": "boolean" }, "title": { "maxLength": 5000, "type": "string" } }, "title": "relationship_specs", "type": "object" }, "ssn_last_4": { "description": "The last four digits of the person's Social Security number (U.S. only).", "type": "string" }, "us_cfpb_data": { "description": "Demographic data related to the person.", "properties": { "ethnicity_details": { "properties": { "ethnicity": { "items": { "enum": [ "cuban", "hispanic_or_latino", "mexican", "not_hispanic_or_latino", "other_hispanic_or_latino", "prefer_not_to_answer", "puerto_rican" ], "type": "string" }, "type": "array" }, "ethnicity_other": { "maxLength": 5000, "type": "string" } }, "title": "us_cfpb_ethnicity_details_specs", "type": "object" }, "race_details": { "properties": { "race": { "items": { "enum": [ "african_american", "american_indian_or_alaska_native", "asian", "asian_indian", "black_or_african_american", "chinese", "ethiopian", "filipino", "guamanian_or_chamorro", "haitian", "jamaican", "japanese", "korean", "native_hawaiian", "native_hawaiian_or_other_pacific_islander", "nigerian", "other_asian", "other_black_or_african_american", "other_pacific_islander", "prefer_not_to_answer", "samoan", "somali", "vietnamese", "white" ], "type": "string" }, "type": "array" }, "race_other": { "maxLength": 5000, "type": "string" } }, "title": "us_cfpb_race_details_specs", "type": "object" }, "self_identified_gender": { "maxLength": 5000, "type": "string" } }, "title": "us_cfpb_data_specs", "type": "object" }, "verification": { "description": "The person's verification status.", "properties": { "additional_document": { "properties": { "back": { "maxLength": 500, "type": "string" }, "front": { "maxLength": 500, "type": "string" } }, "title": "person_verification_document_specs", "type": "object" }, "document": { "properties": { "back": { "maxLength": 500, "type": "string" }, "front": { "maxLength": 500, "type": "string" } }, "title": "person_verification_document_specs", "type": "object" } }, "title": "person_verification_specs", "type": "object" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/person" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a person" } }, "/v1/accounts/{account}/persons/{person}": { "delete": { "description": "

Deletes an existing person’s relationship to the account’s legal entity. Any person with a relationship for an account can be deleted through the API, except if the person is the account_opener. If your integration is using the executive parameter, you cannot delete the only verified executive on file.

", "operationId": "DeleteAccountsAccountPersonsPerson", "parameters": [ { "in": "path", "name": "account", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "in": "path", "name": "person", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted_person" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Delete a person" }, "get": { "description": "

Retrieves an existing person.

", "operationId": "GetAccountsAccountPersonsPerson", "parameters": [ { "in": "path", "name": "account", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "person", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/person" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a person" }, "post": { "description": "

Updates an existing person.

", "operationId": "PostAccountsAccountPersonsPerson", "parameters": [ { "in": "path", "name": "account", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "in": "path", "name": "person", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "additional_tos_acceptances": { "explode": true, "style": "deepObject" }, "address": { "explode": true, "style": "deepObject" }, "address_kana": { "explode": true, "style": "deepObject" }, "address_kanji": { "explode": true, "style": "deepObject" }, "dob": { "explode": true, "style": "deepObject" }, "documents": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "full_name_aliases": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "registered_address": { "explode": true, "style": "deepObject" }, "relationship": { "explode": true, "style": "deepObject" }, "us_cfpb_data": { "explode": true, "style": "deepObject" }, "verification": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "additional_tos_acceptances": { "description": "Details on the legal guardian's or authorizer's acceptance of the required Stripe agreements.", "properties": { "account": { "properties": { "date": { "format": "unix-time", "type": "integer" }, "ip": { "type": "string" }, "user_agent": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "settings_terms_of_service_specs", "type": "object" } }, "title": "person_additional_tos_acceptances_specs", "type": "object" }, "address": { "description": "The person's address.", "properties": { "city": { "maxLength": 100, "type": "string" }, "country": { "maxLength": 5000, "type": "string" }, "line1": { "maxLength": 200, "type": "string" }, "line2": { "maxLength": 200, "type": "string" }, "postal_code": { "maxLength": 5000, "type": "string" }, "state": { "maxLength": 5000, "type": "string" } }, "title": "legal_entity_and_kyc_address_specs", "type": "object" }, "address_kana": { "description": "The Kana variation of the person's address (Japan only).", "properties": { "city": { "maxLength": 5000, "type": "string" }, "country": { "maxLength": 5000, "type": "string" }, "line1": { "maxLength": 5000, "type": "string" }, "line2": { "maxLength": 5000, "type": "string" }, "postal_code": { "maxLength": 5000, "type": "string" }, "state": { "maxLength": 5000, "type": "string" }, "town": { "maxLength": 5000, "type": "string" } }, "title": "japan_address_kana_specs", "type": "object" }, "address_kanji": { "description": "The Kanji variation of the person's address (Japan only).", "properties": { "city": { "maxLength": 5000, "type": "string" }, "country": { "maxLength": 5000, "type": "string" }, "line1": { "maxLength": 5000, "type": "string" }, "line2": { "maxLength": 5000, "type": "string" }, "postal_code": { "maxLength": 5000, "type": "string" }, "state": { "maxLength": 5000, "type": "string" }, "town": { "maxLength": 5000, "type": "string" } }, "title": "japan_address_kanji_specs", "type": "object" }, "dob": { "anyOf": [ { "properties": { "day": { "type": "integer" }, "month": { "type": "integer" }, "year": { "type": "integer" } }, "required": [ "day", "month", "year" ], "title": "date_of_birth_specs", "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "The person's date of birth." }, "documents": { "description": "Documents that may be submitted to satisfy various informational requests.", "properties": { "company_authorization": { "properties": { "files": { "items": { "anyOf": [ { "maxLength": 500, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "type": "array" } }, "title": "documents_param", "type": "object" }, "passport": { "properties": { "files": { "items": { "anyOf": [ { "maxLength": 500, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "type": "array" } }, "title": "documents_param", "type": "object" }, "visa": { "properties": { "files": { "items": { "anyOf": [ { "maxLength": 500, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "type": "array" } }, "title": "documents_param", "type": "object" } }, "title": "person_documents_specs", "type": "object" }, "email": { "description": "The person's email address.", "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "first_name": { "description": "The person's first name.", "maxLength": 5000, "type": "string" }, "first_name_kana": { "description": "The Kana variation of the person's first name (Japan only).", "maxLength": 5000, "type": "string" }, "first_name_kanji": { "description": "The Kanji variation of the person's first name (Japan only).", "maxLength": 5000, "type": "string" }, "full_name_aliases": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "A list of alternate names or aliases that the person is known by." }, "gender": { "description": "The person's gender (International regulations require either \"male\" or \"female\").", "type": "string" }, "id_number": { "description": "The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii).", "maxLength": 5000, "type": "string" }, "id_number_secondary": { "description": "The person's secondary ID number, as appropriate for their country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii).", "maxLength": 5000, "type": "string" }, "last_name": { "description": "The person's last name.", "maxLength": 5000, "type": "string" }, "last_name_kana": { "description": "The Kana variation of the person's last name (Japan only).", "maxLength": 5000, "type": "string" }, "last_name_kanji": { "description": "The Kanji variation of the person's last name (Japan only).", "maxLength": 5000, "type": "string" }, "maiden_name": { "description": "The person's maiden name.", "maxLength": 5000, "type": "string" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "nationality": { "description": "The country where the person is a national. Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)), or \"XX\" if unavailable.", "maxLength": 5000, "type": "string" }, "person_token": { "description": "A [person token](https://docs.stripe.com/connect/account-tokens), used to securely provide details to the person.", "maxLength": 5000, "type": "string" }, "phone": { "description": "The person's phone number.", "type": "string" }, "political_exposure": { "description": "Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction.", "enum": [ "existing", "none" ], "type": "string" }, "registered_address": { "description": "The person's registered address.", "properties": { "city": { "maxLength": 100, "type": "string" }, "country": { "maxLength": 5000, "type": "string" }, "line1": { "maxLength": 200, "type": "string" }, "line2": { "maxLength": 200, "type": "string" }, "postal_code": { "maxLength": 5000, "type": "string" }, "state": { "maxLength": 5000, "type": "string" } }, "title": "address_specs", "type": "object" }, "relationship": { "description": "The relationship that this person has with the account's legal entity.", "properties": { "authorizer": { "type": "boolean" }, "director": { "type": "boolean" }, "executive": { "type": "boolean" }, "legal_guardian": { "type": "boolean" }, "owner": { "type": "boolean" }, "percent_ownership": { "anyOf": [ { "type": "number" }, { "enum": [ "" ], "type": "string" } ] }, "representative": { "type": "boolean" }, "title": { "maxLength": 5000, "type": "string" } }, "title": "relationship_specs", "type": "object" }, "ssn_last_4": { "description": "The last four digits of the person's Social Security number (U.S. only).", "type": "string" }, "us_cfpb_data": { "description": "Demographic data related to the person.", "properties": { "ethnicity_details": { "properties": { "ethnicity": { "items": { "enum": [ "cuban", "hispanic_or_latino", "mexican", "not_hispanic_or_latino", "other_hispanic_or_latino", "prefer_not_to_answer", "puerto_rican" ], "type": "string" }, "type": "array" }, "ethnicity_other": { "maxLength": 5000, "type": "string" } }, "title": "us_cfpb_ethnicity_details_specs", "type": "object" }, "race_details": { "properties": { "race": { "items": { "enum": [ "african_american", "american_indian_or_alaska_native", "asian", "asian_indian", "black_or_african_american", "chinese", "ethiopian", "filipino", "guamanian_or_chamorro", "haitian", "jamaican", "japanese", "korean", "native_hawaiian", "native_hawaiian_or_other_pacific_islander", "nigerian", "other_asian", "other_black_or_african_american", "other_pacific_islander", "prefer_not_to_answer", "samoan", "somali", "vietnamese", "white" ], "type": "string" }, "type": "array" }, "race_other": { "maxLength": 5000, "type": "string" } }, "title": "us_cfpb_race_details_specs", "type": "object" }, "self_identified_gender": { "maxLength": 5000, "type": "string" } }, "title": "us_cfpb_data_specs", "type": "object" }, "verification": { "description": "The person's verification status.", "properties": { "additional_document": { "properties": { "back": { "maxLength": 500, "type": "string" }, "front": { "maxLength": 500, "type": "string" } }, "title": "person_verification_document_specs", "type": "object" }, "document": { "properties": { "back": { "maxLength": 500, "type": "string" }, "front": { "maxLength": 500, "type": "string" } }, "title": "person_verification_document_specs", "type": "object" } }, "title": "person_verification_specs", "type": "object" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/person" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a person" } }, "/v1/accounts/{account}/reject": { "post": { "description": "

With Connect, you can reject accounts that you have flagged as suspicious.

\n\n

Only accounts where your platform is liable for negative account balances, which includes Custom and Express accounts, can be rejected. Test-mode accounts can be rejected at any time. Live-mode accounts can only be rejected after all balances are zero.

", "operationId": "PostAccountsAccountReject", "parameters": [ { "in": "path", "name": "account", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "reason": { "description": "The reason for rejecting the account. Can be `fraud`, `terms_of_service`, or `other`.", "maxLength": 5000, "type": "string" } }, "required": [ "reason" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/account" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Reject an account" } }, "/v1/apple_pay/domains": { "get": { "description": "

List apple pay domains.

", "operationId": "GetApplePayDomains", "parameters": [ { "in": "query", "name": "domain_name", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/apple_pay_domain" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/apple_pay/domains", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "ApplePayDomainList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } } }, "post": { "description": "

Create an apple pay domain.

", "operationId": "PostApplePayDomains", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "domain_name": { "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "required": [ "domain_name" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/apple_pay_domain" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } } } }, "/v1/apple_pay/domains/{domain}": { "delete": { "description": "

Delete an apple pay domain.

", "operationId": "DeleteApplePayDomainsDomain", "parameters": [ { "in": "path", "name": "domain", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted_apple_pay_domain" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } } }, "get": { "description": "

Retrieve an apple pay domain.

", "operationId": "GetApplePayDomainsDomain", "parameters": [ { "in": "path", "name": "domain", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/apple_pay_domain" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } } } }, "/v1/application_fees": { "get": { "description": "

Returns a list of application fees you’ve previously collected. The application fees are returned in sorted order, with the most recent fees appearing first.

", "operationId": "GetApplicationFees", "parameters": [ { "description": "Only return application fees for the charge specified by this charge ID.", "in": "query", "name": "charge", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Only return applications fees that were created during the given date interval.", "explode": true, "in": "query", "name": "created", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "type": "integer" }, "gte": { "type": "integer" }, "lt": { "type": "integer" }, "lte": { "type": "integer" } }, "title": "range_query_specs", "type": "object" }, { "type": "integer" } ] }, "style": "deepObject" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/application_fee" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/application_fees", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "PlatformEarningList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all application fees" } }, "/v1/application_fees/{fee}/refunds/{id}": { "get": { "description": "

By default, you can see the 10 most recent refunds stored directly on the application fee object, but you can also retrieve details about a specific refund stored on the application fee.

", "operationId": "GetApplicationFeesFeeRefundsId", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "fee", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fee_refund" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve an application fee refund" }, "post": { "description": "

Updates the specified application fee refund by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

\n\n

This request only accepts metadata as an argument.

", "operationId": "PostApplicationFeesFeeRefundsId", "parameters": [ { "in": "path", "name": "fee", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fee_refund" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update an application fee refund" } }, "/v1/application_fees/{id}": { "get": { "description": "

Retrieves the details of an application fee that your account has collected. The same information is returned when refunding the application fee.

", "operationId": "GetApplicationFeesId", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/application_fee" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve an application fee" } }, "/v1/application_fees/{id}/refund": { "post": { "description": "", "operationId": "PostApplicationFeesIdRefund", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "amount": { "type": "integer" }, "directive": { "maxLength": 5000, "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/application_fee" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } } } }, "/v1/application_fees/{id}/refunds": { "get": { "description": "

You can see a list of the refunds belonging to a specific application fee. Note that the 10 most recent refunds are always available by default on the application fee object. If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional refunds.

", "operationId": "GetApplicationFeesIdRefunds", "parameters": [ { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/fee_refund" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "FeeRefundList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all application fee refunds" }, "post": { "description": "

Refunds an application fee that has previously been collected but not yet refunded.\nFunds will be refunded to the Stripe account from which the fee was originally collected.

\n\n

You can optionally refund only part of an application fee.\nYou can do so multiple times, until the entire fee has been refunded.

\n\n

Once entirely refunded, an application fee can’t be refunded again.\nThis method will raise an error when called on an already-refunded application fee,\nor when trying to refund more money than is left on an application fee.

", "operationId": "PostApplicationFeesIdRefunds", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "amount": { "description": "A positive integer, in _cents (or local equivalent)_, representing how much of this fee to refund. Can refund only up to the remaining unrefunded amount of the fee.", "type": "integer" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fee_refund" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create an application fee refund" } }, "/v1/apps/secrets": { "get": { "description": "

List all secrets stored on the given scope.

", "operationId": "GetAppsSecrets", "parameters": [ { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "Specifies the scoping of the secret. Requests originating from UI extensions can only access account-scoped secrets or secrets scoped to their own user.", "explode": true, "in": "query", "name": "scope", "required": true, "schema": { "properties": { "type": { "enum": [ "account", "user" ], "type": "string" }, "user": { "maxLength": 5000, "type": "string" } }, "required": [ "type" ], "title": "scope_param", "type": "object" }, "style": "deepObject" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/apps.secret" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/apps/secrets", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "SecretServiceResourceSecretList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List secrets" }, "post": { "description": "

Create or replace a secret in the secret store.

", "operationId": "PostAppsSecrets", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "scope": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "expires_at": { "description": "The Unix timestamp for the expiry time of the secret, after which the secret deletes.", "format": "unix-time", "type": "integer" }, "name": { "description": "A name for the secret that's unique within the scope.", "maxLength": 5000, "type": "string" }, "payload": { "description": "The plaintext secret value to be stored.", "maxLength": 5000, "type": "string" }, "scope": { "description": "Specifies the scoping of the secret. Requests originating from UI extensions can only access account-scoped secrets or secrets scoped to their own user.", "properties": { "type": { "enum": [ "account", "user" ], "type": "string" }, "user": { "maxLength": 5000, "type": "string" } }, "required": [ "type" ], "title": "scope_param", "type": "object" } }, "required": [ "name", "payload", "scope" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/apps.secret" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Set a Secret" } }, "/v1/apps/secrets/delete": { "post": { "description": "

Deletes a secret from the secret store by name and scope.

", "operationId": "PostAppsSecretsDelete", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "scope": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "name": { "description": "A name for the secret that's unique within the scope.", "maxLength": 5000, "type": "string" }, "scope": { "description": "Specifies the scoping of the secret. Requests originating from UI extensions can only access account-scoped secrets or secrets scoped to their own user.", "properties": { "type": { "enum": [ "account", "user" ], "type": "string" }, "user": { "maxLength": 5000, "type": "string" } }, "required": [ "type" ], "title": "scope_param", "type": "object" } }, "required": [ "name", "scope" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/apps.secret" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Delete a Secret" } }, "/v1/apps/secrets/find": { "get": { "description": "

Finds a secret in the secret store by name and scope.

", "operationId": "GetAppsSecretsFind", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A name for the secret that's unique within the scope.", "in": "query", "name": "name", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies the scoping of the secret. Requests originating from UI extensions can only access account-scoped secrets or secrets scoped to their own user.", "explode": true, "in": "query", "name": "scope", "required": true, "schema": { "properties": { "type": { "enum": [ "account", "user" ], "type": "string" }, "user": { "maxLength": 5000, "type": "string" } }, "required": [ "type" ], "title": "scope_param", "type": "object" }, "style": "deepObject" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/apps.secret" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Find a Secret" } }, "/v1/balance": { "get": { "description": "

Retrieves the current account balance, based on the authentication that was used to make the request.\n For a sample request, see Accounting for negative balances.

", "operationId": "GetBalance", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/balance" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve balance" } }, "/v1/balance/history": { "get": { "description": "

Returns a list of transactions that have contributed to the Stripe account balance (e.g., charges, transfers, and so forth). The transactions are returned in sorted order, with the most recent transactions appearing first.

\n\n

Note that this endpoint was previously called “Balance history” and used the path /v1/balance/history.

", "operationId": "GetBalanceHistory", "parameters": [ { "description": "Only return transactions that were created during the given date interval.", "explode": true, "in": "query", "name": "created", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "type": "integer" }, "gte": { "type": "integer" }, "lt": { "type": "integer" }, "lte": { "type": "integer" } }, "title": "range_query_specs", "type": "object" }, { "type": "integer" } ] }, "style": "deepObject" }, { "description": "Only return transactions in a certain currency. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "in": "query", "name": "currency", "required": false, "schema": { "format": "currency", "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "For automatic Stripe payouts only, only returns transactions that were paid out on the specified payout ID.", "in": "query", "name": "payout", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Only returns the original transaction.", "in": "query", "name": "source", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Only returns transactions of the given type. One of: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `climate_order_purchase`, `climate_order_refund`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_outbound`, `obligation_reversal_inbound`, `payment`, `payment_failure_refund`, `payment_network_reserve_hold`, `payment_network_reserve_release`, `payment_refund`, `payment_reversal`, `payment_unreconciled`, `payout`, `payout_cancel`, `payout_failure`, `payout_minimum_balance_hold`, `payout_minimum_balance_release`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `stripe_balance_payment_debit`, `stripe_balance_payment_debit_reversal`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`.", "in": "query", "name": "type", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/balance_transaction" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/balance_transactions", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "BalanceTransactionsList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all balance transactions" } }, "/v1/balance/history/{id}": { "get": { "description": "

Retrieves the balance transaction with the given ID.

\n\n

Note that this endpoint previously used the path /v1/balance/history/:id.

", "operationId": "GetBalanceHistoryId", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/balance_transaction" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a balance transaction" } }, "/v1/balance_transactions": { "get": { "description": "

Returns a list of transactions that have contributed to the Stripe account balance (e.g., charges, transfers, and so forth). The transactions are returned in sorted order, with the most recent transactions appearing first.

\n\n

Note that this endpoint was previously called “Balance history” and used the path /v1/balance/history.

", "operationId": "GetBalanceTransactions", "parameters": [ { "description": "Only return transactions that were created during the given date interval.", "explode": true, "in": "query", "name": "created", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "type": "integer" }, "gte": { "type": "integer" }, "lt": { "type": "integer" }, "lte": { "type": "integer" } }, "title": "range_query_specs", "type": "object" }, { "type": "integer" } ] }, "style": "deepObject" }, { "description": "Only return transactions in a certain currency. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "in": "query", "name": "currency", "required": false, "schema": { "format": "currency", "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "For automatic Stripe payouts only, only returns transactions that were paid out on the specified payout ID.", "in": "query", "name": "payout", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Only returns the original transaction.", "in": "query", "name": "source", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Only returns transactions of the given type. One of: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `climate_order_purchase`, `climate_order_refund`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_outbound`, `obligation_reversal_inbound`, `payment`, `payment_failure_refund`, `payment_network_reserve_hold`, `payment_network_reserve_release`, `payment_refund`, `payment_reversal`, `payment_unreconciled`, `payout`, `payout_cancel`, `payout_failure`, `payout_minimum_balance_hold`, `payout_minimum_balance_release`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `stripe_balance_payment_debit`, `stripe_balance_payment_debit_reversal`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`.", "in": "query", "name": "type", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/balance_transaction" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/balance_transactions", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "BalanceTransactionsList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all balance transactions" } }, "/v1/balance_transactions/{id}": { "get": { "description": "

Retrieves the balance transaction with the given ID.

\n\n

Note that this endpoint previously used the path /v1/balance/history/:id.

", "operationId": "GetBalanceTransactionsId", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/balance_transaction" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a balance transaction" } }, "/v1/billing/alerts": { "get": { "description": "

Lists billing active and inactive alerts

", "operationId": "GetBillingAlerts", "parameters": [ { "description": "Filter results to only include this type of alert.", "in": "query", "name": "alert_type", "required": false, "schema": { "enum": [ "usage_threshold" ], "type": "string", "x-stripeBypassValidation": true }, "style": "form" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "Filter results to only include alerts with the given meter.", "in": "query", "name": "meter", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/billing.alert" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/billing/alerts", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "ThresholdsResourceAlertList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List billing alerts" }, "post": { "description": "

Creates a billing alert

", "operationId": "PostBillingAlerts", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "usage_threshold": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "alert_type": { "description": "The type of alert to create.", "enum": [ "usage_threshold" ], "type": "string", "x-stripeBypassValidation": true }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "title": { "description": "The title of the alert.", "maxLength": 256, "type": "string" }, "usage_threshold": { "description": "The configuration of the usage threshold.", "properties": { "filters": { "items": { "properties": { "customer": { "maxLength": 5000, "type": "string" }, "type": { "enum": [ "customer" ], "type": "string" } }, "required": [ "type" ], "title": "usage_alert_filter", "type": "object" }, "type": "array" }, "gte": { "type": "integer" }, "meter": { "maxLength": 5000, "type": "string" }, "recurrence": { "enum": [ "one_time" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "gte", "meter", "recurrence" ], "title": "usage_threshold_config", "type": "object" } }, "required": [ "alert_type", "title" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/billing.alert" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a billing alert" } }, "/v1/billing/alerts/{id}": { "get": { "description": "

Retrieves a billing alert given an ID

", "operationId": "GetBillingAlertsId", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/billing.alert" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a billing alert" } }, "/v1/billing/alerts/{id}/activate": { "post": { "description": "

Reactivates this alert, allowing it to trigger again.

", "operationId": "PostBillingAlertsIdActivate", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/billing.alert" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Activate a billing alert" } }, "/v1/billing/alerts/{id}/archive": { "post": { "description": "

Archives this alert, removing it from the list view and APIs. This is non-reversible.

", "operationId": "PostBillingAlertsIdArchive", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/billing.alert" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Archive a billing alert" } }, "/v1/billing/alerts/{id}/deactivate": { "post": { "description": "

Deactivates this alert, preventing it from triggering.

", "operationId": "PostBillingAlertsIdDeactivate", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/billing.alert" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Deactivate a billing alert" } }, "/v1/billing/credit_balance_summary": { "get": { "description": "

Retrieves the credit balance summary for a customer.

", "operationId": "GetBillingCreditBalanceSummary", "parameters": [ { "description": "The customer for which to fetch credit balance summary.", "in": "query", "name": "customer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "The filter criteria for the credit balance summary.", "explode": true, "in": "query", "name": "filter", "required": true, "schema": { "properties": { "applicability_scope": { "properties": { "price_type": { "enum": [ "metered" ], "type": "string" }, "prices": { "items": { "properties": { "id": { "maxLength": 5000, "type": "string" } }, "required": [ "id" ], "title": "applicable_price_param", "type": "object" }, "type": "array" } }, "title": "scope_param", "type": "object" }, "credit_grant": { "maxLength": 5000, "type": "string" }, "type": { "enum": [ "applicability_scope", "credit_grant" ], "type": "string" } }, "required": [ "type" ], "title": "balance_summary_filter_param", "type": "object" }, "style": "deepObject" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/billing.credit_balance_summary" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve the credit balance summary for a customer" } }, "/v1/billing/credit_balance_transactions": { "get": { "description": "

Retrieve a list of credit balance transactions.

", "operationId": "GetBillingCreditBalanceTransactions", "parameters": [ { "description": "The credit grant for which to fetch credit balance transactions.", "in": "query", "name": "credit_grant", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "The customer for which to fetch credit balance transactions.", "in": "query", "name": "customer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/billing.credit_balance_transaction" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/billing/credit_grants", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "BillingCreditGrantsResourceBalanceTransactionList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List credit balance transactions" } }, "/v1/billing/credit_balance_transactions/{id}": { "get": { "description": "

Retrieves a credit balance transaction.

", "operationId": "GetBillingCreditBalanceTransactionsId", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "Unique identifier for the object.", "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/billing.credit_balance_transaction" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a credit balance transaction" } }, "/v1/billing/credit_grants": { "get": { "description": "

Retrieve a list of credit grants.

", "operationId": "GetBillingCreditGrants", "parameters": [ { "description": "Only return credit grants for this customer.", "in": "query", "name": "customer", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/billing.credit_grant" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/billing/credit_grants", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "BillingCreditGrantsResourceCreditGrantList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List credit grants" }, "post": { "description": "

Creates a credit grant.

", "operationId": "PostBillingCreditGrants", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "amount": { "explode": true, "style": "deepObject" }, "applicability_config": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "amount": { "description": "Amount of this credit grant.", "properties": { "monetary": { "properties": { "currency": { "format": "currency", "type": "string" }, "value": { "type": "integer" } }, "required": [ "currency", "value" ], "title": "monetary_amount_param", "type": "object" }, "type": { "enum": [ "monetary" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "amount_param", "type": "object" }, "applicability_config": { "description": "Configuration specifying what this credit grant applies to. We currently only support `metered` prices that have a [Billing Meter](https://docs.stripe.com/api/billing/meter) attached to them.", "properties": { "scope": { "properties": { "price_type": { "enum": [ "metered" ], "type": "string" }, "prices": { "items": { "properties": { "id": { "maxLength": 5000, "type": "string" } }, "required": [ "id" ], "title": "applicable_price_param", "type": "object" }, "type": "array" } }, "title": "scope_param", "type": "object" } }, "required": [ "scope" ], "title": "applicability_config_param", "type": "object" }, "category": { "description": "The category of this credit grant.", "enum": [ "paid", "promotional" ], "type": "string" }, "customer": { "description": "ID of the customer to receive the billing credits.", "maxLength": 5000, "type": "string" }, "effective_at": { "description": "The time when the billing credits become effective-when they're eligible for use. It defaults to the current timestamp if not specified.", "format": "unix-time", "type": "integer" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "expires_at": { "description": "The time when the billing credits expire. If not specified, the billing credits don't expire.", "format": "unix-time", "type": "integer" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of key-value pairs that you can attach to an object. You can use this to store additional information about the object (for example, cost basis) in a structured format.", "type": "object" }, "name": { "description": "A descriptive name shown in the Dashboard.", "maxLength": 100, "type": "string" }, "priority": { "description": "The desired priority for applying this credit grant. If not specified, it will be set to the default value of 50. The highest priority is 0 and the lowest is 100.", "type": "integer" } }, "required": [ "amount", "applicability_config", "category", "customer" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/billing.credit_grant" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a credit grant" } }, "/v1/billing/credit_grants/{id}": { "get": { "description": "

Retrieves a credit grant.

", "operationId": "GetBillingCreditGrantsId", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "Unique identifier for the object.", "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/billing.credit_grant" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a credit grant" }, "post": { "description": "

Updates a credit grant.

", "operationId": "PostBillingCreditGrantsId", "parameters": [ { "description": "Unique identifier for the object.", "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "expires_at": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "expires_at": { "anyOf": [ { "format": "unix-time", "type": "integer" }, { "enum": [ "" ], "type": "string" } ], "description": "The time when the billing credits created by this credit grant expire. If set to empty, the billing credits never expire." }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of key-value pairs you can attach to an object. You can use this to store additional information about the object (for example, cost basis) in a structured format.", "type": "object" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/billing.credit_grant" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a credit grant" } }, "/v1/billing/credit_grants/{id}/expire": { "post": { "description": "

Expires a credit grant.

", "operationId": "PostBillingCreditGrantsIdExpire", "parameters": [ { "description": "Unique identifier for the object.", "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/billing.credit_grant" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Expire a credit grant" } }, "/v1/billing/credit_grants/{id}/void": { "post": { "description": "

Voids a credit grant.

", "operationId": "PostBillingCreditGrantsIdVoid", "parameters": [ { "description": "Unique identifier for the object.", "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/billing.credit_grant" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Void a credit grant" } }, "/v1/billing/meter_event_adjustments": { "post": { "description": "

Creates a billing meter event adjustment.

", "operationId": "PostBillingMeterEventAdjustments", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "cancel": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "cancel": { "description": "Specifies which event to cancel.", "properties": { "identifier": { "maxLength": 100, "type": "string" } }, "title": "event_adjustment_cancel_settings_param", "type": "object" }, "event_name": { "description": "The name of the meter event. Corresponds with the `event_name` field on a meter.", "maxLength": 100, "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "type": { "description": "Specifies whether to cancel a single event or a range of events for a time period. Time period cancellation is not supported yet.", "enum": [ "cancel" ], "type": "string" } }, "required": [ "event_name", "type" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/billing.meter_event_adjustment" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a billing meter event adjustment" } }, "/v1/billing/meter_events": { "post": { "description": "

Creates a billing meter event.

", "operationId": "PostBillingMeterEvents", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "payload": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "event_name": { "description": "The name of the meter event. Corresponds with the `event_name` field on a meter.", "maxLength": 100, "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "identifier": { "description": "A unique identifier for the event. If not provided, one is generated. We recommend using UUID-like identifiers. We will enforce uniqueness within a rolling period of at least 24 hours. The enforcement of uniqueness primarily addresses issues arising from accidental retries or other problems occurring within extremely brief time intervals. This approach helps prevent duplicate entries and ensures data integrity in high-frequency operations.", "maxLength": 100, "type": "string" }, "payload": { "additionalProperties": { "type": "string" }, "description": "The payload of the event. This must contain the fields corresponding to a meter's `customer_mapping.event_payload_key` (default is `stripe_customer_id`) and `value_settings.event_payload_key` (default is `value`). Read more about the [payload](https://docs.stripe.com/billing/subscriptions/usage-based/recording-usage#payload-key-overrides).", "type": "object" }, "timestamp": { "description": "The time of the event. Measured in seconds since the Unix epoch. Must be within the past 35 calendar days or up to 5 minutes in the future. Defaults to current timestamp if not specified.", "format": "unix-time", "type": "integer" } }, "required": [ "event_name", "payload" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/billing.meter_event" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a billing meter event" } }, "/v1/billing/meters": { "get": { "description": "

Retrieve a list of billing meters.

", "operationId": "GetBillingMeters", "parameters": [ { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Filter results to only include meters with the given status.", "in": "query", "name": "status", "required": false, "schema": { "enum": [ "active", "inactive" ], "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/billing.meter" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/billing/meters", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "BillingMeterResourceBillingMeterList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List billing meters" }, "post": { "description": "

Creates a billing meter.

", "operationId": "PostBillingMeters", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "customer_mapping": { "explode": true, "style": "deepObject" }, "default_aggregation": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "value_settings": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "customer_mapping": { "description": "Fields that specify how to map a meter event to a customer.", "properties": { "event_payload_key": { "maxLength": 100, "type": "string" }, "type": { "enum": [ "by_id" ], "type": "string" } }, "required": [ "event_payload_key", "type" ], "title": "customer_mapping_param", "type": "object" }, "default_aggregation": { "description": "The default settings to aggregate a meter's events with.", "properties": { "formula": { "enum": [ "count", "last", "sum" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "formula" ], "title": "aggregation_settings_param", "type": "object" }, "display_name": { "description": "The meter’s name. Not visible to the customer.", "maxLength": 250, "type": "string" }, "event_name": { "description": "The name of the meter event to record usage for. Corresponds with the `event_name` field on meter events.", "maxLength": 100, "type": "string" }, "event_time_window": { "description": "The time window which meter events have been pre-aggregated for, if any.", "enum": [ "day", "hour" ], "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "value_settings": { "description": "Fields that specify how to calculate a meter event's value.", "properties": { "event_payload_key": { "maxLength": 100, "type": "string" } }, "required": [ "event_payload_key" ], "title": "meter_value_settings_param", "type": "object" } }, "required": [ "default_aggregation", "display_name", "event_name" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/billing.meter" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a billing meter" } }, "/v1/billing/meters/{id}": { "get": { "description": "

Retrieves a billing meter given an ID.

", "operationId": "GetBillingMetersId", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/billing.meter" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a billing meter" }, "post": { "description": "

Updates a billing meter.

", "operationId": "PostBillingMetersId", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "display_name": { "description": "The meter’s name. Not visible to the customer.", "maxLength": 250, "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/billing.meter" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a billing meter" } }, "/v1/billing/meters/{id}/deactivate": { "post": { "description": "

When a meter is deactivated, no more meter events will be accepted for this meter. You can’t attach a deactivated meter to a price.

", "operationId": "PostBillingMetersIdDeactivate", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/billing.meter" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Deactivate a billing meter" } }, "/v1/billing/meters/{id}/event_summaries": { "get": { "description": "

Retrieve a list of billing meter event summaries.

", "operationId": "GetBillingMetersIdEventSummaries", "parameters": [ { "description": "The customer for which to fetch event summaries.", "in": "query", "name": "customer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "The timestamp from when to stop aggregating meter events (exclusive). Must be aligned with minute boundaries.", "in": "query", "name": "end_time", "required": true, "schema": { "format": "unix-time", "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "Unique identifier for the object.", "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "The timestamp from when to start aggregating meter events (inclusive). Must be aligned with minute boundaries.", "in": "query", "name": "start_time", "required": true, "schema": { "format": "unix-time", "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies what granularity to use when generating event summaries. If not specified, a single event summary would be returned for the specified time range. For hourly granularity, start and end times must align with hour boundaries (e.g., 00:00, 01:00, ..., 23:00). For daily granularity, start and end times must align with UTC day boundaries (00:00 UTC).", "in": "query", "name": "value_grouping_window", "required": false, "schema": { "enum": [ "day", "hour" ], "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/billing.meter_event_summary" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/billing/meters/[^/]+/event_summaries", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "BillingMeterResourceBillingMeterEventSummaryList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List billing meter event summaries" } }, "/v1/billing/meters/{id}/reactivate": { "post": { "description": "

When a meter is reactivated, events for this meter can be accepted and you can attach the meter to a price.

", "operationId": "PostBillingMetersIdReactivate", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/billing.meter" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Reactivate a billing meter" } }, "/v1/billing_portal/configurations": { "get": { "description": "

Returns a list of configurations that describe the functionality of the customer portal.

", "operationId": "GetBillingPortalConfigurations", "parameters": [ { "description": "Only return configurations that are active or inactive (e.g., pass `true` to only list active configurations).", "in": "query", "name": "active", "required": false, "schema": { "type": "boolean" }, "style": "form" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "Only return the default or non-default configurations (e.g., pass `true` to only list the default configuration).", "in": "query", "name": "is_default", "required": false, "schema": { "type": "boolean" }, "style": "form" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/billing_portal.configuration" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/billing_portal/configurations", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "PortalPublicResourceConfigurationList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List portal configurations" }, "post": { "description": "

Creates a configuration that describes the functionality and behavior of a PortalSession

", "operationId": "PostBillingPortalConfigurations", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "business_profile": { "explode": true, "style": "deepObject" }, "default_return_url": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "features": { "explode": true, "style": "deepObject" }, "login_page": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "name": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "business_profile": { "description": "The business information shown to customers in the portal.", "properties": { "headline": { "anyOf": [ { "maxLength": 60, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "privacy_policy_url": { "type": "string" }, "terms_of_service_url": { "type": "string" } }, "title": "business_profile_create_param", "type": "object" }, "default_return_url": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "The default URL to redirect customers to when they click on the portal's link to return to your website. This can be [overriden](https://stripe.com/docs/api/customer_portal/sessions/create#create_portal_session-return_url) when creating the session." }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "features": { "description": "Information about the features available in the portal.", "properties": { "customer_update": { "properties": { "allowed_updates": { "anyOf": [ { "items": { "enum": [ "address", "email", "name", "phone", "shipping", "tax_id" ], "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ] }, "enabled": { "type": "boolean" } }, "required": [ "enabled" ], "title": "customer_update_creation_param", "type": "object" }, "invoice_history": { "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ], "title": "invoice_list_param", "type": "object" }, "payment_method_update": { "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ], "title": "payment_method_update_param", "type": "object" }, "subscription_cancel": { "properties": { "cancellation_reason": { "properties": { "enabled": { "type": "boolean" }, "options": { "anyOf": [ { "items": { "enum": [ "customer_service", "low_quality", "missing_features", "other", "switched_service", "too_complex", "too_expensive", "unused" ], "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ] } }, "required": [ "enabled", "options" ], "title": "subscription_cancellation_reason_creation_param", "type": "object" }, "enabled": { "type": "boolean" }, "mode": { "enum": [ "at_period_end", "immediately" ], "type": "string" }, "proration_behavior": { "enum": [ "always_invoice", "create_prorations", "none" ], "type": "string" } }, "required": [ "enabled" ], "title": "subscription_cancel_creation_param", "type": "object" }, "subscription_update": { "properties": { "default_allowed_updates": { "anyOf": [ { "items": { "enum": [ "price", "promotion_code", "quantity" ], "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ] }, "enabled": { "type": "boolean" }, "products": { "anyOf": [ { "items": { "properties": { "adjustable_quantity": { "properties": { "enabled": { "type": "boolean" }, "maximum": { "type": "integer" }, "minimum": { "type": "integer" } }, "required": [ "enabled" ], "title": "subscription_update_product_adjustable_quantity_param", "type": "object" }, "prices": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "product": { "maxLength": 5000, "type": "string" } }, "required": [ "prices", "product" ], "title": "subscription_update_product_param", "type": "object" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ] }, "proration_behavior": { "enum": [ "always_invoice", "create_prorations", "none" ], "type": "string" }, "schedule_at_period_end": { "properties": { "conditions": { "items": { "properties": { "type": { "enum": [ "decreasing_item_amount", "shortening_interval" ], "type": "string" } }, "required": [ "type" ], "title": "schedule_update_at_period_end_condition_param", "type": "object" }, "type": "array" } }, "title": "schedule_update_at_period_end_creating_param", "type": "object" } }, "required": [ "enabled" ], "title": "subscription_update_creation_param", "type": "object" } }, "title": "features_creation_param", "type": "object" }, "login_page": { "description": "The hosted login page for this configuration. Learn more about the portal login page in our [integration docs](https://stripe.com/docs/billing/subscriptions/integrating-customer-portal#share).", "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ], "title": "login_page_create_param", "type": "object" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "name": { "anyOf": [ { "maxLength": 256, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "The name of the configuration." } }, "required": [ "features" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/billing_portal.configuration" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a portal configuration" } }, "/v1/billing_portal/configurations/{configuration}": { "get": { "description": "

Retrieves a configuration that describes the functionality of the customer portal.

", "operationId": "GetBillingPortalConfigurationsConfiguration", "parameters": [ { "in": "path", "name": "configuration", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/billing_portal.configuration" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a portal configuration" }, "post": { "description": "

Updates a configuration that describes the functionality of the customer portal.

", "operationId": "PostBillingPortalConfigurationsConfiguration", "parameters": [ { "in": "path", "name": "configuration", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "business_profile": { "explode": true, "style": "deepObject" }, "default_return_url": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "features": { "explode": true, "style": "deepObject" }, "login_page": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "name": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "active": { "description": "Whether the configuration is active and can be used to create portal sessions.", "type": "boolean" }, "business_profile": { "description": "The business information shown to customers in the portal.", "properties": { "headline": { "anyOf": [ { "maxLength": 60, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "privacy_policy_url": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "terms_of_service_url": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "business_profile_update_param", "type": "object" }, "default_return_url": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "The default URL to redirect customers to when they click on the portal's link to return to your website. This can be [overriden](https://stripe.com/docs/api/customer_portal/sessions/create#create_portal_session-return_url) when creating the session." }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "features": { "description": "Information about the features available in the portal.", "properties": { "customer_update": { "properties": { "allowed_updates": { "anyOf": [ { "items": { "enum": [ "address", "email", "name", "phone", "shipping", "tax_id" ], "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ] }, "enabled": { "type": "boolean" } }, "title": "customer_update_updating_param", "type": "object" }, "invoice_history": { "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ], "title": "invoice_list_param", "type": "object" }, "payment_method_update": { "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ], "title": "payment_method_update_param", "type": "object" }, "subscription_cancel": { "properties": { "cancellation_reason": { "properties": { "enabled": { "type": "boolean" }, "options": { "anyOf": [ { "items": { "enum": [ "customer_service", "low_quality", "missing_features", "other", "switched_service", "too_complex", "too_expensive", "unused" ], "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ] } }, "required": [ "enabled" ], "title": "subscription_cancellation_reason_updating_param", "type": "object" }, "enabled": { "type": "boolean" }, "mode": { "enum": [ "at_period_end", "immediately" ], "type": "string" }, "proration_behavior": { "enum": [ "always_invoice", "create_prorations", "none" ], "type": "string" } }, "title": "subscription_cancel_updating_param", "type": "object" }, "subscription_update": { "properties": { "default_allowed_updates": { "anyOf": [ { "items": { "enum": [ "price", "promotion_code", "quantity" ], "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ] }, "enabled": { "type": "boolean" }, "products": { "anyOf": [ { "items": { "properties": { "adjustable_quantity": { "properties": { "enabled": { "type": "boolean" }, "maximum": { "type": "integer" }, "minimum": { "type": "integer" } }, "required": [ "enabled" ], "title": "subscription_update_product_adjustable_quantity_param", "type": "object" }, "prices": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "product": { "maxLength": 5000, "type": "string" } }, "required": [ "prices", "product" ], "title": "subscription_update_product_param", "type": "object" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ] }, "proration_behavior": { "enum": [ "always_invoice", "create_prorations", "none" ], "type": "string" }, "schedule_at_period_end": { "properties": { "conditions": { "anyOf": [ { "items": { "properties": { "type": { "enum": [ "decreasing_item_amount", "shortening_interval" ], "type": "string" } }, "required": [ "type" ], "title": "schedule_update_at_period_end_condition_param", "type": "object" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "schedule_update_at_period_end_updating_param", "type": "object" } }, "title": "subscription_update_updating_param", "type": "object" } }, "title": "features_updating_param", "type": "object" }, "login_page": { "description": "The hosted login page for this configuration. Learn more about the portal login page in our [integration docs](https://stripe.com/docs/billing/subscriptions/integrating-customer-portal#share).", "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ], "title": "login_page_update_param", "type": "object" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "name": { "anyOf": [ { "maxLength": 256, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "The name of the configuration." } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/billing_portal.configuration" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a portal configuration" } }, "/v1/billing_portal/sessions": { "post": { "description": "

Creates a session of the customer portal.

", "operationId": "PostBillingPortalSessions", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "flow_data": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "configuration": { "description": "The ID of an existing [configuration](https://stripe.com/docs/api/customer_portal/configuration) to use for this session, describing its functionality and features. If not specified, the session uses the default configuration.", "maxLength": 5000, "type": "string" }, "customer": { "description": "The ID of an existing customer.", "maxLength": 5000, "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "flow_data": { "description": "Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows.", "properties": { "after_completion": { "properties": { "hosted_confirmation": { "properties": { "custom_message": { "maxLength": 500, "type": "string" } }, "title": "after_completion_hosted_confirmation_param", "type": "object" }, "redirect": { "properties": { "return_url": { "type": "string" } }, "required": [ "return_url" ], "title": "after_completion_redirect_param", "type": "object" }, "type": { "enum": [ "hosted_confirmation", "portal_homepage", "redirect" ], "type": "string" } }, "required": [ "type" ], "title": "flow_data_after_completion_param", "type": "object" }, "subscription_cancel": { "properties": { "retention": { "properties": { "coupon_offer": { "properties": { "coupon": { "maxLength": 5000, "type": "string" } }, "required": [ "coupon" ], "title": "coupon_offer_param", "type": "object" }, "type": { "enum": [ "coupon_offer" ], "type": "string" } }, "required": [ "coupon_offer", "type" ], "title": "retention_param", "type": "object" }, "subscription": { "maxLength": 5000, "type": "string" } }, "required": [ "subscription" ], "title": "flow_data_subscription_cancel_param", "type": "object" }, "subscription_update": { "properties": { "subscription": { "maxLength": 5000, "type": "string" } }, "required": [ "subscription" ], "title": "flow_data_subscription_update_param", "type": "object" }, "subscription_update_confirm": { "properties": { "discounts": { "items": { "properties": { "coupon": { "maxLength": 5000, "type": "string" }, "promotion_code": { "maxLength": 5000, "type": "string" } }, "title": "subscription_update_confirm_discount_params", "type": "object" }, "type": "array" }, "items": { "items": { "properties": { "id": { "maxLength": 5000, "type": "string" }, "price": { "maxLength": 5000, "type": "string" }, "quantity": { "type": "integer" } }, "required": [ "id" ], "title": "subscription_update_confirm_item_params", "type": "object" }, "type": "array" }, "subscription": { "maxLength": 5000, "type": "string" } }, "required": [ "items", "subscription" ], "title": "flow_data_subscription_update_confirm_param", "type": "object" }, "type": { "enum": [ "payment_method_update", "subscription_cancel", "subscription_update", "subscription_update_confirm" ], "type": "string" } }, "required": [ "type" ], "title": "flow_data_param", "type": "object" }, "locale": { "description": "The IETF language tag of the locale customer portal is displayed in. If blank or auto, the customer’s `preferred_locales` or browser’s locale is used.", "enum": [ "auto", "bg", "cs", "da", "de", "el", "en", "en-AU", "en-CA", "en-GB", "en-IE", "en-IN", "en-NZ", "en-SG", "es", "es-419", "et", "fi", "fil", "fr", "fr-CA", "hr", "hu", "id", "it", "ja", "ko", "lt", "lv", "ms", "mt", "nb", "nl", "pl", "pt", "pt-BR", "ro", "ru", "sk", "sl", "sv", "th", "tr", "vi", "zh", "zh-HK", "zh-TW" ], "type": "string" }, "on_behalf_of": { "description": "The `on_behalf_of` account to use for this session. When specified, only subscriptions and invoices with this `on_behalf_of` account appear in the portal. For more information, see the [docs](https://stripe.com/docs/connect/separate-charges-and-transfers#settlement-merchant). Use the [Accounts API](https://stripe.com/docs/api/accounts/object#account_object-settings-branding) to modify the `on_behalf_of` account's branding settings, which the portal displays.", "type": "string" }, "return_url": { "description": "The default URL to redirect customers to when they click on the portal's link to return to your website.", "type": "string" } }, "required": [ "customer" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/billing_portal.session" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a portal session" } }, "/v1/charges": { "get": { "description": "

Returns a list of charges you’ve previously created. The charges are returned in sorted order, with the most recent charges appearing first.

", "operationId": "GetCharges", "parameters": [ { "description": "Only return charges that were created during the given date interval.", "explode": true, "in": "query", "name": "created", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "type": "integer" }, "gte": { "type": "integer" }, "lt": { "type": "integer" }, "lte": { "type": "integer" } }, "title": "range_query_specs", "type": "object" }, { "type": "integer" } ] }, "style": "deepObject" }, { "description": "Only return charges for the customer specified by this customer ID.", "in": "query", "name": "customer", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "Only return charges that were created by the PaymentIntent specified by this PaymentIntent ID.", "in": "query", "name": "payment_intent", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "type": "string" }, "style": "form" }, { "description": "Only return charges for this transfer group, limited to 100.", "in": "query", "name": "transfer_group", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/charge" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/charges", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "ChargeList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all charges" }, "post": { "description": "

This method is no longer recommended—use the Payment Intents API\nto initiate a new payment instead. Confirmation of the PaymentIntent creates the Charge\nobject used to request payment.

", "operationId": "PostCharges", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "card": { "explode": true, "style": "deepObject" }, "destination": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "radar_options": { "explode": true, "style": "deepObject" }, "shipping": { "explode": true, "style": "deepObject" }, "transfer_data": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "amount": { "description": "Amount intended to be collected by this payment. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).", "type": "integer" }, "application_fee": { "type": "integer" }, "application_fee_amount": { "description": "A fee in cents (or local equivalent) that will be applied to the charge and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the `Stripe-Account` header in order to take an application fee. For more information, see the application fees [documentation](https://stripe.com/docs/connect/direct-charges#collect-fees).", "type": "integer" }, "capture": { "description": "Whether to immediately capture the charge. Defaults to `true`. When `false`, the charge issues an authorization (or pre-authorization), and will need to be [captured](https://stripe.com/docs/api#capture_charge) later. Uncaptured charges expire after a set number of days (7 by default). For more information, see the [authorizing charges and settling later](https://stripe.com/docs/charges/placing-a-hold) documentation.", "type": "boolean" }, "card": { "anyOf": [ { "properties": { "address_city": { "maxLength": 5000, "type": "string" }, "address_country": { "maxLength": 5000, "type": "string" }, "address_line1": { "maxLength": 5000, "type": "string" }, "address_line2": { "maxLength": 5000, "type": "string" }, "address_state": { "maxLength": 5000, "type": "string" }, "address_zip": { "maxLength": 5000, "type": "string" }, "cvc": { "maxLength": 5000, "type": "string" }, "exp_month": { "type": "integer" }, "exp_year": { "type": "integer" }, "metadata": { "additionalProperties": { "type": "string" }, "type": "object" }, "name": { "maxLength": 5000, "type": "string" }, "number": { "maxLength": 5000, "type": "string" }, "object": { "enum": [ "card" ], "maxLength": 5000, "type": "string" } }, "required": [ "exp_month", "exp_year", "number" ], "title": "customer_payment_source_card", "type": "object" }, { "maxLength": 5000, "type": "string" } ], "description": "A token, like the ones returned by [Stripe.js](https://stripe.com/docs/js).", "x-stripeBypassValidation": true }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "customer": { "description": "The ID of an existing customer that will be charged in this request.", "maxLength": 500, "type": "string" }, "description": { "description": "An arbitrary string which you can attach to a `Charge` object. It is displayed when in the web interface alongside the charge. Note that if you use Stripe to send automatic email receipts to your customers, your receipt emails will include the `description` of the charge(s) that they are describing.", "maxLength": 40000, "type": "string" }, "destination": { "anyOf": [ { "properties": { "account": { "maxLength": 5000, "type": "string" }, "amount": { "type": "integer" } }, "required": [ "account" ], "title": "destination_specs", "type": "object" }, { "type": "string" } ] }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "on_behalf_of": { "description": "The Stripe account ID for which these funds are intended. Automatically set if you use the `destination` parameter. For details, see [Creating Separate Charges and Transfers](https://stripe.com/docs/connect/separate-charges-and-transfers#settlement-merchant).", "maxLength": 5000, "type": "string" }, "radar_options": { "description": "Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.", "properties": { "session": { "maxLength": 5000, "type": "string" } }, "title": "radar_options_with_hidden_options", "type": "object" }, "receipt_email": { "description": "The email address to which this charge's [receipt](https://stripe.com/docs/dashboard/receipts) will be sent. The receipt will not be sent until the charge is paid, and no receipts will be sent for test mode charges. If this charge is for a [Customer](https://stripe.com/docs/api/customers/object), the email address specified here will override the customer's email address. If `receipt_email` is specified for a charge in live mode, a receipt will be sent regardless of your [email settings](https://dashboard.stripe.com/account/emails).", "type": "string" }, "shipping": { "description": "Shipping information for the charge. Helps prevent fraud on charges for physical goods.", "properties": { "address": { "properties": { "city": { "maxLength": 5000, "type": "string" }, "country": { "maxLength": 5000, "type": "string" }, "line1": { "maxLength": 5000, "type": "string" }, "line2": { "maxLength": 5000, "type": "string" }, "postal_code": { "maxLength": 5000, "type": "string" }, "state": { "maxLength": 5000, "type": "string" } }, "title": "optional_fields_address", "type": "object" }, "carrier": { "maxLength": 5000, "type": "string" }, "name": { "maxLength": 5000, "type": "string" }, "phone": { "maxLength": 5000, "type": "string" }, "tracking_number": { "maxLength": 5000, "type": "string" } }, "required": [ "address", "name" ], "title": "optional_fields_shipping", "type": "object" }, "source": { "description": "A payment source to be charged. This can be the ID of a [card](https://stripe.com/docs/api#cards) (i.e., credit or debit card), a [bank account](https://stripe.com/docs/api#bank_accounts), a [source](https://stripe.com/docs/api#sources), a [token](https://stripe.com/docs/api#tokens), or a [connected account](https://stripe.com/docs/connect/account-debits#charging-a-connected-account). For certain sources---namely, [cards](https://stripe.com/docs/api#cards), [bank accounts](https://stripe.com/docs/api#bank_accounts), and attached [sources](https://stripe.com/docs/api#sources)---you must also pass the ID of the associated customer.", "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true }, "statement_descriptor": { "description": "For a non-card charge, text that appears on the customer's statement as the statement descriptor. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).\n\nFor a card charge, this value is ignored unless you don't specify a `statement_descriptor_suffix`, in which case this value is used as the suffix.", "maxLength": 22, "type": "string" }, "statement_descriptor_suffix": { "description": "Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement. If the account has no prefix value, the suffix is concatenated to the account's statement descriptor.", "maxLength": 22, "type": "string" }, "transfer_data": { "description": "An optional dictionary including the account to automatically transfer to as part of a destination charge. [See the Connect documentation](https://stripe.com/docs/connect/destination-charges) for details.", "properties": { "amount": { "type": "integer" }, "destination": { "maxLength": 5000, "type": "string" } }, "required": [ "destination" ], "title": "transfer_data_specs", "type": "object" }, "transfer_group": { "description": "A string that identifies this transaction as part of a group. For details, see [Grouping transactions](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options).", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/charge" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } } } }, "/v1/charges/search": { "get": { "description": "

Search for charges you’ve previously created using Stripe’s Search Query Language.\nDon’t use search in read-after-write flows where strict consistency is necessary. Under normal operating\nconditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up\nto an hour behind during outages. Search functionality is not available to merchants in India.

", "operationId": "GetChargesSearch", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.", "in": "query", "name": "page", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for charges](https://stripe.com/docs/search#query-fields-for-charges).", "in": "query", "name": "query", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/charge" }, "type": "array" }, "has_more": { "type": "boolean" }, "next_page": { "maxLength": 5000, "nullable": true, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "search_result" ], "type": "string" }, "total_count": { "description": "The total number of objects that match the query, only accurate up to 10,000.", "type": "integer" }, "url": { "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "SearchResult", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Search charges" } }, "/v1/charges/{charge}": { "get": { "description": "

Retrieves the details of a charge that has previously been created. Supply the unique charge ID that was returned from your previous request, and Stripe will return the corresponding charge information. The same information is returned when creating or refunding the charge.

", "operationId": "GetChargesCharge", "parameters": [ { "in": "path", "name": "charge", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/charge" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a charge" }, "post": { "description": "

Updates the specified charge by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

", "operationId": "PostChargesCharge", "parameters": [ { "in": "path", "name": "charge", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "fraud_details": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "shipping": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "customer": { "description": "The ID of an existing customer that will be associated with this request. This field may only be updated if there is no existing associated customer with this charge.", "maxLength": 5000, "type": "string" }, "description": { "description": "An arbitrary string which you can attach to a charge object. It is displayed when in the web interface alongside the charge. Note that if you use Stripe to send automatic email receipts to your customers, your receipt emails will include the `description` of the charge(s) that they are describing.", "maxLength": 40000, "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "fraud_details": { "description": "A set of key-value pairs you can attach to a charge giving information about its riskiness. If you believe a charge is fraudulent, include a `user_report` key with a value of `fraudulent`. If you believe a charge is safe, include a `user_report` key with a value of `safe`. Stripe will use the information you send to improve our fraud detection algorithms.", "properties": { "user_report": { "enum": [ "", "fraudulent", "safe" ], "maxLength": 5000, "type": "string" } }, "required": [ "user_report" ], "title": "fraud_details", "type": "object" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "receipt_email": { "description": "This is the email address that the receipt for this charge will be sent to. If this field is updated, then a new email receipt will be sent to the updated address.", "maxLength": 5000, "type": "string" }, "shipping": { "description": "Shipping information for the charge. Helps prevent fraud on charges for physical goods.", "properties": { "address": { "properties": { "city": { "maxLength": 5000, "type": "string" }, "country": { "maxLength": 5000, "type": "string" }, "line1": { "maxLength": 5000, "type": "string" }, "line2": { "maxLength": 5000, "type": "string" }, "postal_code": { "maxLength": 5000, "type": "string" }, "state": { "maxLength": 5000, "type": "string" } }, "title": "optional_fields_address", "type": "object" }, "carrier": { "maxLength": 5000, "type": "string" }, "name": { "maxLength": 5000, "type": "string" }, "phone": { "maxLength": 5000, "type": "string" }, "tracking_number": { "maxLength": 5000, "type": "string" } }, "required": [ "address", "name" ], "title": "optional_fields_shipping", "type": "object" }, "transfer_group": { "description": "A string that identifies this transaction as part of a group. `transfer_group` may only be provided if it has not been set. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) for details.", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/charge" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a charge" } }, "/v1/charges/{charge}/capture": { "post": { "description": "

Capture the payment of an existing, uncaptured charge that was created with the capture option set to false.

\n\n

Uncaptured payments expire a set number of days after they are created (7 by default), after which they are marked as refunded and capture attempts will fail.

\n\n

Don’t use this method to capture a PaymentIntent-initiated charge. Use Capture a PaymentIntent.

", "operationId": "PostChargesChargeCapture", "parameters": [ { "in": "path", "name": "charge", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "transfer_data": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "amount": { "description": "The amount to capture, which must be less than or equal to the original amount.", "type": "integer" }, "application_fee": { "description": "An application fee to add on to this charge.", "type": "integer" }, "application_fee_amount": { "description": "An application fee amount to add on to this charge, which must be less than or equal to the original amount.", "type": "integer" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "receipt_email": { "description": "The email address to send this charge's receipt to. This will override the previously-specified email address for this charge, if one was set. Receipts will not be sent in test mode.", "type": "string" }, "statement_descriptor": { "description": "For a non-card charge, text that appears on the customer's statement as the statement descriptor. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).\n\nFor a card charge, this value is ignored unless you don't specify a `statement_descriptor_suffix`, in which case this value is used as the suffix.", "maxLength": 22, "type": "string" }, "statement_descriptor_suffix": { "description": "Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement. If the account has no prefix value, the suffix is concatenated to the account's statement descriptor.", "maxLength": 22, "type": "string" }, "transfer_data": { "description": "An optional dictionary including the account to automatically transfer to as part of a destination charge. [See the Connect documentation](https://stripe.com/docs/connect/destination-charges) for details.", "properties": { "amount": { "type": "integer" } }, "title": "transfer_data_specs", "type": "object" }, "transfer_group": { "description": "A string that identifies this transaction as part of a group. `transfer_group` may only be provided if it has not been set. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) for details.", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/charge" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Capture a payment" } }, "/v1/charges/{charge}/dispute": { "get": { "description": "

Retrieve a dispute for a specified charge.

", "operationId": "GetChargesChargeDispute", "parameters": [ { "in": "path", "name": "charge", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dispute" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } } }, "post": { "description": "", "operationId": "PostChargesChargeDispute", "parameters": [ { "in": "path", "name": "charge", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "evidence": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "evidence": { "description": "Evidence to upload, to respond to a dispute. Updating any field in the hash will submit all fields in the hash for review. The combined character count of all fields is limited to 150,000.", "properties": { "access_activity_log": { "maxLength": 20000, "type": "string" }, "billing_address": { "maxLength": 5000, "type": "string" }, "cancellation_policy": { "type": "string" }, "cancellation_policy_disclosure": { "maxLength": 20000, "type": "string" }, "cancellation_rebuttal": { "maxLength": 20000, "type": "string" }, "customer_communication": { "type": "string" }, "customer_email_address": { "maxLength": 5000, "type": "string" }, "customer_name": { "maxLength": 5000, "type": "string" }, "customer_purchase_ip": { "maxLength": 5000, "type": "string" }, "customer_signature": { "type": "string" }, "duplicate_charge_documentation": { "type": "string" }, "duplicate_charge_explanation": { "maxLength": 20000, "type": "string" }, "duplicate_charge_id": { "maxLength": 5000, "type": "string" }, "enhanced_evidence": { "anyOf": [ { "properties": { "visa_compelling_evidence_3": { "properties": { "disputed_transaction": { "properties": { "customer_account_id": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "customer_device_fingerprint": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "customer_device_id": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "customer_email_address": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "customer_purchase_ip": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "merchandise_or_services": { "enum": [ "merchandise", "services" ], "type": "string" }, "product_description": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "shipping_address": { "properties": { "city": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "country": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "line1": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "line2": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "postal_code": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "state": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "shipping_address", "type": "object" } }, "title": "visa_compelling_evidence3_disputed_transaction", "type": "object" }, "prior_undisputed_transactions": { "items": { "properties": { "charge": { "maxLength": 5000, "type": "string" }, "customer_account_id": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "customer_device_fingerprint": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "customer_device_id": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "customer_email_address": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "customer_purchase_ip": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "product_description": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "shipping_address": { "properties": { "city": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "country": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "line1": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "line2": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "postal_code": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "state": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "shipping_address", "type": "object" } }, "required": [ "charge" ], "title": "visa_compelling_evidence3_prior_undisputed_transaction", "type": "object" }, "type": "array" } }, "title": "visa_compelling_evidence3", "type": "object" }, "visa_compliance": { "properties": { "fee_acknowledged": { "type": "boolean" } }, "title": "visa_compliance", "type": "object" } }, "title": "enhanced_evidence", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "product_description": { "maxLength": 20000, "type": "string" }, "receipt": { "type": "string" }, "refund_policy": { "type": "string" }, "refund_policy_disclosure": { "maxLength": 20000, "type": "string" }, "refund_refusal_explanation": { "maxLength": 20000, "type": "string" }, "service_date": { "maxLength": 5000, "type": "string" }, "service_documentation": { "type": "string" }, "shipping_address": { "maxLength": 5000, "type": "string" }, "shipping_carrier": { "maxLength": 5000, "type": "string" }, "shipping_date": { "maxLength": 5000, "type": "string" }, "shipping_documentation": { "type": "string" }, "shipping_tracking_number": { "maxLength": 5000, "type": "string" }, "uncategorized_file": { "type": "string" }, "uncategorized_text": { "maxLength": 20000, "type": "string" } }, "title": "dispute_evidence_params", "type": "object" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "submit": { "description": "Whether to immediately submit evidence to the bank. If `false`, evidence is staged on the dispute. Staged evidence is visible in the API and Dashboard, and can be submitted to the bank by making another request with this attribute set to `true` (the default).", "type": "boolean" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dispute" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } } } }, "/v1/charges/{charge}/dispute/close": { "post": { "description": "", "operationId": "PostChargesChargeDisputeClose", "parameters": [ { "in": "path", "name": "charge", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dispute" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } } } }, "/v1/charges/{charge}/refund": { "post": { "description": "

When you create a new refund, you must specify either a Charge or a PaymentIntent object.

\n\n

This action refunds a previously created charge that’s not refunded yet.\nFunds are refunded to the credit or debit card that’s originally charged.

\n\n

You can optionally refund only part of a charge.\nYou can repeat this until the entire charge is refunded.

\n\n

After you entirely refund a charge, you can’t refund it again.\nThis method raises an error when it’s called on an already-refunded charge,\nor when you attempt to refund more money than is left on a charge.

", "operationId": "PostChargesChargeRefund", "parameters": [ { "description": "The identifier of the charge to refund.", "in": "path", "name": "charge", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "amount": { "description": "A positive integer in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) representing how much of this charge to refund. Can refund only up to the remaining, unrefunded amount of the charge.", "type": "integer" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "instructions_email": { "description": "For payment methods without native refund support (e.g., Konbini, PromptPay), use this email from the customer to receive refund instructions.", "type": "string" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "payment_intent": { "description": "The identifier of the PaymentIntent to refund.", "maxLength": 5000, "type": "string" }, "reason": { "description": "String indicating the reason for the refund. If set, possible values are `duplicate`, `fraudulent`, and `requested_by_customer`. If you believe the charge to be fraudulent, specifying `fraudulent` as the reason will add the associated card and email to your [block lists](https://stripe.com/docs/radar/lists), and will also help us improve our fraud detection algorithms.", "enum": [ "duplicate", "fraudulent", "requested_by_customer" ], "maxLength": 5000, "type": "string" }, "refund_application_fee": { "description": "Boolean indicating whether the application fee should be refunded when refunding this charge. If a full charge refund is given, the full application fee will be refunded. Otherwise, the application fee will be refunded in an amount proportional to the amount of the charge refunded. An application fee can be refunded only by the application that created the charge.", "type": "boolean" }, "reverse_transfer": { "description": "Boolean indicating whether the transfer should be reversed when refunding this charge. The transfer will be reversed proportionally to the amount being refunded (either the entire or partial amount).

A transfer can be reversed only by the application that created the charge.", "type": "boolean" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/charge" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a refund" } }, "/v1/charges/{charge}/refunds": { "get": { "description": "

You can see a list of the refunds belonging to a specific charge. Note that the 10 most recent refunds are always available by default on the charge object. If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional refunds.

", "operationId": "GetChargesChargeRefunds", "parameters": [ { "in": "path", "name": "charge", "required": true, "schema": { "type": "string" }, "style": "simple" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/refund" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "RefundList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all refunds" }, "post": { "description": "

When you create a new refund, you must specify a Charge or a PaymentIntent object on which to create it.

\n\n

Creating a new refund will refund a charge that has previously been created but not yet refunded.\nFunds will be refunded to the credit or debit card that was originally charged.

\n\n

You can optionally refund only part of a charge.\nYou can do so multiple times, until the entire charge has been refunded.

\n\n

Once entirely refunded, a charge can’t be refunded again.\nThis method will raise an error when called on an already-refunded charge,\nor when trying to refund more money than is left on a charge.

", "operationId": "PostChargesChargeRefunds", "parameters": [ { "description": "The identifier of the charge to refund.", "in": "path", "name": "charge", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "amount": { "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "customer": { "description": "Customer whose customer balance to refund from.", "maxLength": 5000, "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "instructions_email": { "description": "For payment methods without native refund support (e.g., Konbini, PromptPay), use this email from the customer to receive refund instructions.", "type": "string" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "origin": { "description": "Origin of the refund", "enum": [ "customer_balance" ], "type": "string" }, "payment_intent": { "description": "The identifier of the PaymentIntent to refund.", "maxLength": 5000, "type": "string" }, "reason": { "description": "String indicating the reason for the refund. If set, possible values are `duplicate`, `fraudulent`, and `requested_by_customer`. If you believe the charge to be fraudulent, specifying `fraudulent` as the reason will add the associated card and email to your [block lists](https://stripe.com/docs/radar/lists), and will also help us improve our fraud detection algorithms.", "enum": [ "duplicate", "fraudulent", "requested_by_customer" ], "maxLength": 5000, "type": "string" }, "refund_application_fee": { "description": "Boolean indicating whether the application fee should be refunded when refunding this charge. If a full charge refund is given, the full application fee will be refunded. Otherwise, the application fee will be refunded in an amount proportional to the amount of the charge refunded. An application fee can be refunded only by the application that created the charge.", "type": "boolean" }, "reverse_transfer": { "description": "Boolean indicating whether the transfer should be reversed when refunding this charge. The transfer will be reversed proportionally to the amount being refunded (either the entire or partial amount).

A transfer can be reversed only by the application that created the charge.", "type": "boolean" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/refund" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create customer balance refund" } }, "/v1/charges/{charge}/refunds/{refund}": { "get": { "description": "

Retrieves the details of an existing refund.

", "operationId": "GetChargesChargeRefundsRefund", "parameters": [ { "in": "path", "name": "charge", "required": true, "schema": { "type": "string" }, "style": "simple" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "refund", "required": true, "schema": { "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/refund" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } } }, "post": { "description": "

Update a specified refund.

", "operationId": "PostChargesChargeRefundsRefund", "parameters": [ { "in": "path", "name": "charge", "required": true, "schema": { "type": "string" }, "style": "simple" }, { "in": "path", "name": "refund", "required": true, "schema": { "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ] } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/refund" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } } } }, "/v1/checkout/sessions": { "get": { "description": "

Returns a list of Checkout Sessions.

", "operationId": "GetCheckoutSessions", "parameters": [ { "description": "Only return Checkout Sessions that were created during the given date interval.", "explode": true, "in": "query", "name": "created", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "type": "integer" }, "gte": { "type": "integer" }, "lt": { "type": "integer" }, "lte": { "type": "integer" } }, "title": "range_query_specs", "type": "object" }, { "type": "integer" } ] }, "style": "deepObject" }, { "description": "Only return the Checkout Sessions for the Customer specified.", "in": "query", "name": "customer", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Only return the Checkout Sessions for the Customer details specified.", "explode": true, "in": "query", "name": "customer_details", "required": false, "schema": { "properties": { "email": { "type": "string" } }, "required": [ "email" ], "title": "customer_details_params", "type": "object" }, "style": "deepObject" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "Only return the Checkout Session for the PaymentIntent specified.", "in": "query", "name": "payment_intent", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Only return the Checkout Sessions for the Payment Link specified.", "in": "query", "name": "payment_link", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Only return the Checkout Sessions matching the given status.", "in": "query", "name": "status", "required": false, "schema": { "enum": [ "complete", "expired", "open" ], "type": "string" }, "style": "form" }, { "description": "Only return the Checkout Session for the subscription specified.", "in": "query", "name": "subscription", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/checkout.session" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "PaymentPagesCheckoutSessionList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all Checkout Sessions" }, "post": { "description": "

Creates a Checkout Session object.

", "operationId": "PostCheckoutSessions", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "adaptive_pricing": { "explode": true, "style": "deepObject" }, "after_expiration": { "explode": true, "style": "deepObject" }, "automatic_tax": { "explode": true, "style": "deepObject" }, "consent_collection": { "explode": true, "style": "deepObject" }, "custom_fields": { "explode": true, "style": "deepObject" }, "custom_text": { "explode": true, "style": "deepObject" }, "customer_update": { "explode": true, "style": "deepObject" }, "discounts": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "invoice_creation": { "explode": true, "style": "deepObject" }, "line_items": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "optional_items": { "explode": true, "style": "deepObject" }, "payment_intent_data": { "explode": true, "style": "deepObject" }, "payment_method_data": { "explode": true, "style": "deepObject" }, "payment_method_options": { "explode": true, "style": "deepObject" }, "payment_method_types": { "explode": true, "style": "deepObject" }, "permissions": { "explode": true, "style": "deepObject" }, "phone_number_collection": { "explode": true, "style": "deepObject" }, "saved_payment_method_options": { "explode": true, "style": "deepObject" }, "setup_intent_data": { "explode": true, "style": "deepObject" }, "shipping_address_collection": { "explode": true, "style": "deepObject" }, "shipping_options": { "explode": true, "style": "deepObject" }, "subscription_data": { "explode": true, "style": "deepObject" }, "tax_id_collection": { "explode": true, "style": "deepObject" }, "wallet_options": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "adaptive_pricing": { "description": "Settings for price localization with [Adaptive Pricing](https://docs.stripe.com/payments/checkout/adaptive-pricing).", "properties": { "enabled": { "type": "boolean" } }, "title": "adaptive_pricing_params", "type": "object" }, "after_expiration": { "description": "Configure actions after a Checkout Session has expired.", "properties": { "recovery": { "properties": { "allow_promotion_codes": { "type": "boolean" }, "enabled": { "type": "boolean" } }, "required": [ "enabled" ], "title": "recovery_params", "type": "object" } }, "title": "after_expiration_params", "type": "object" }, "allow_promotion_codes": { "description": "Enables user redeemable promotion codes.", "type": "boolean" }, "automatic_tax": { "description": "Settings for automatic tax lookup for this session and resulting payments, invoices, and subscriptions.", "properties": { "enabled": { "type": "boolean" }, "liability": { "properties": { "account": { "type": "string" }, "type": { "enum": [ "account", "self" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "param", "type": "object" } }, "required": [ "enabled" ], "title": "automatic_tax_params", "type": "object" }, "billing_address_collection": { "description": "Specify whether Checkout should collect the customer's billing address. Defaults to `auto`.", "enum": [ "auto", "required" ], "type": "string" }, "cancel_url": { "description": "If set, Checkout displays a back button and customers will be directed to this URL if they decide to cancel payment and return to your website. This parameter is not allowed if ui_mode is `embedded` or `custom`.", "type": "string" }, "client_reference_id": { "description": "A unique string to reference the Checkout Session. This can be a\ncustomer ID, a cart ID, or similar, and can be used to reconcile the\nsession with your internal systems.", "maxLength": 200, "type": "string" }, "consent_collection": { "description": "Configure fields for the Checkout Session to gather active consent from customers.", "properties": { "payment_method_reuse_agreement": { "properties": { "position": { "enum": [ "auto", "hidden" ], "type": "string" } }, "required": [ "position" ], "title": "payment_method_reuse_agreement_params", "type": "object" }, "promotions": { "enum": [ "auto", "none" ], "type": "string" }, "terms_of_service": { "enum": [ "none", "required" ], "type": "string" } }, "title": "consent_collection_params", "type": "object" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). Required in `setup` mode when `payment_method_types` is not set.", "format": "currency", "type": "string" }, "custom_fields": { "description": "Collect additional information from your customer using custom fields. Up to 3 fields are supported.", "items": { "properties": { "dropdown": { "properties": { "default_value": { "maxLength": 100, "type": "string" }, "options": { "items": { "properties": { "label": { "maxLength": 100, "type": "string" }, "value": { "maxLength": 100, "type": "string" } }, "required": [ "label", "value" ], "title": "custom_field_option_param", "type": "object" }, "type": "array" } }, "required": [ "options" ], "title": "custom_field_dropdown_param", "type": "object" }, "key": { "maxLength": 200, "type": "string" }, "label": { "properties": { "custom": { "maxLength": 50, "type": "string" }, "type": { "enum": [ "custom" ], "type": "string" } }, "required": [ "custom", "type" ], "title": "custom_field_label_param", "type": "object" }, "numeric": { "properties": { "default_value": { "maxLength": 255, "type": "string" }, "maximum_length": { "type": "integer" }, "minimum_length": { "type": "integer" } }, "title": "custom_field_numeric_param", "type": "object" }, "optional": { "type": "boolean" }, "text": { "properties": { "default_value": { "maxLength": 255, "type": "string" }, "maximum_length": { "type": "integer" }, "minimum_length": { "type": "integer" } }, "title": "custom_field_text_param", "type": "object" }, "type": { "enum": [ "dropdown", "numeric", "text" ], "type": "string" } }, "required": [ "key", "label", "type" ], "title": "custom_field_param", "type": "object" }, "type": "array" }, "custom_text": { "description": "Display additional text for your customers using custom text.", "properties": { "after_submit": { "anyOf": [ { "properties": { "message": { "maxLength": 1200, "type": "string" } }, "required": [ "message" ], "title": "custom_text_position_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "shipping_address": { "anyOf": [ { "properties": { "message": { "maxLength": 1200, "type": "string" } }, "required": [ "message" ], "title": "custom_text_position_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "submit": { "anyOf": [ { "properties": { "message": { "maxLength": 1200, "type": "string" } }, "required": [ "message" ], "title": "custom_text_position_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "terms_of_service_acceptance": { "anyOf": [ { "properties": { "message": { "maxLength": 1200, "type": "string" } }, "required": [ "message" ], "title": "custom_text_position_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "custom_text_param", "type": "object" }, "customer": { "description": "ID of an existing Customer, if one exists. In `payment` mode, the customer’s most recently saved card\npayment method will be used to prefill the email, name, card details, and billing address\non the Checkout page. In `subscription` mode, the customer’s [default payment method](https://stripe.com/docs/api/customers/update#update_customer-invoice_settings-default_payment_method)\nwill be used if it’s a card, otherwise the most recently saved card will be used. A valid billing address, billing name and billing email are required on the payment method for Checkout to prefill the customer's card details.\n\nIf the Customer already has a valid [email](https://stripe.com/docs/api/customers/object#customer_object-email) set, the email will be prefilled and not editable in Checkout.\nIf the Customer does not have a valid `email`, Checkout will set the email entered during the session on the Customer.\n\nIf blank for Checkout Sessions in `subscription` mode or with `customer_creation` set as `always` in `payment` mode, Checkout will create a new Customer object based on information provided during the payment flow.\n\nYou can set [`payment_intent_data.setup_future_usage`](https://stripe.com/docs/api/checkout/sessions/create#create_checkout_session-payment_intent_data-setup_future_usage) to have Checkout automatically attach the payment method to the Customer you pass in for future reuse.", "maxLength": 5000, "type": "string" }, "customer_creation": { "description": "Configure whether a Checkout Session creates a [Customer](https://stripe.com/docs/api/customers) during Session confirmation.\n\nWhen a Customer is not created, you can still retrieve email, address, and other customer data entered in Checkout\nwith [customer_details](https://stripe.com/docs/api/checkout/sessions/object#checkout_session_object-customer_details).\n\nSessions that don't create Customers instead are grouped by [guest customers](https://stripe.com/docs/payments/checkout/guest-customers)\nin the Dashboard. Promotion codes limited to first time customers will return invalid for these Sessions.\n\nCan only be set in `payment` and `setup` mode.", "enum": [ "always", "if_required" ], "type": "string" }, "customer_email": { "description": "If provided, this value will be used when the Customer object is created.\nIf not provided, customers will be asked to enter their email address.\nUse this parameter to prefill customer data if you already have an email\non file. To access information about the customer once a session is\ncomplete, use the `customer` field.", "type": "string" }, "customer_update": { "description": "Controls what fields on Customer can be updated by the Checkout Session. Can only be provided when `customer` is provided.", "properties": { "address": { "enum": [ "auto", "never" ], "type": "string", "x-stripeBypassValidation": true }, "name": { "enum": [ "auto", "never" ], "type": "string", "x-stripeBypassValidation": true }, "shipping": { "enum": [ "auto", "never" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "customer_update_params", "type": "object" }, "discounts": { "description": "The coupon or promotion code to apply to this Session. Currently, only up to one may be specified.", "items": { "properties": { "coupon": { "maxLength": 5000, "type": "string" }, "promotion_code": { "maxLength": 5000, "type": "string" } }, "title": "discount_params", "type": "object" }, "type": "array" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "expires_at": { "description": "The Epoch time in seconds at which the Checkout Session will expire. It can be anywhere from 30 minutes to 24 hours after Checkout Session creation. By default, this value is 24 hours from creation.", "format": "unix-time", "type": "integer" }, "invoice_creation": { "description": "Generate a post-purchase Invoice for one-time payments.", "properties": { "enabled": { "type": "boolean" }, "invoice_data": { "properties": { "account_tax_ids": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ] }, "custom_fields": { "anyOf": [ { "items": { "properties": { "name": { "maxLength": 40, "type": "string" }, "value": { "maxLength": 140, "type": "string" } }, "required": [ "name", "value" ], "title": "custom_field_params", "type": "object" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ] }, "description": { "maxLength": 1500, "type": "string" }, "footer": { "maxLength": 5000, "type": "string" }, "issuer": { "properties": { "account": { "type": "string" }, "type": { "enum": [ "account", "self" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "param", "type": "object" }, "metadata": { "additionalProperties": { "type": "string" }, "type": "object" }, "rendering_options": { "anyOf": [ { "properties": { "amount_tax_display": { "enum": [ "", "exclude_tax", "include_inclusive_tax" ], "type": "string" }, "template": { "maxLength": 5000, "type": "string" } }, "title": "checkout_rendering_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "invoice_data_params", "type": "object" } }, "required": [ "enabled" ], "title": "invoice_creation_params", "type": "object" }, "line_items": { "description": "A list of items the customer is purchasing. Use this parameter to pass one-time or recurring [Prices](https://stripe.com/docs/api/prices). The parameter is required for `payment` and `subscription` mode.\n\nFor `payment` mode, there is a maximum of 100 line items, however it is recommended to consolidate line items if there are more than a few dozen.\n\nFor `subscription` mode, there is a maximum of 20 line items with recurring Prices and 20 line items with one-time Prices. Line items with one-time Prices will be on the initial invoice only.", "items": { "properties": { "adjustable_quantity": { "properties": { "enabled": { "type": "boolean" }, "maximum": { "type": "integer" }, "minimum": { "type": "integer" } }, "required": [ "enabled" ], "title": "adjustable_quantity_params", "type": "object" }, "dynamic_tax_rates": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "price": { "maxLength": 5000, "type": "string" }, "price_data": { "properties": { "currency": { "format": "currency", "type": "string" }, "product": { "maxLength": 5000, "type": "string" }, "product_data": { "properties": { "description": { "maxLength": 40000, "type": "string" }, "images": { "items": { "type": "string" }, "type": "array" }, "metadata": { "additionalProperties": { "type": "string" }, "type": "object" }, "name": { "maxLength": 5000, "type": "string" }, "tax_code": { "maxLength": 5000, "type": "string" } }, "required": [ "name" ], "title": "product_data", "type": "object" }, "recurring": { "properties": { "interval": { "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "type": "integer" } }, "required": [ "interval" ], "title": "recurring_adhoc", "type": "object" }, "tax_behavior": { "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" }, "unit_amount": { "type": "integer" }, "unit_amount_decimal": { "format": "decimal", "type": "string" } }, "required": [ "currency" ], "title": "price_data_with_product_data", "type": "object" }, "quantity": { "type": "integer" }, "tax_rates": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "title": "line_item_params", "type": "object" }, "type": "array" }, "locale": { "description": "The IETF language tag of the locale Checkout is displayed in. If blank or `auto`, the browser's locale is used.", "enum": [ "auto", "bg", "cs", "da", "de", "el", "en", "en-GB", "es", "es-419", "et", "fi", "fil", "fr", "fr-CA", "hr", "hu", "id", "it", "ja", "ko", "lt", "lv", "ms", "mt", "nb", "nl", "pl", "pt", "pt-BR", "ro", "ru", "sk", "sl", "sv", "th", "tr", "vi", "zh", "zh-HK", "zh-TW" ], "type": "string", "x-stripeBypassValidation": true }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "mode": { "description": "The mode of the Checkout Session. Pass `subscription` if the Checkout Session includes at least one recurring item.", "enum": [ "payment", "setup", "subscription" ], "type": "string" }, "optional_items": { "description": "A list of optional items the customer can add to their order at checkout. Use this parameter to pass one-time or recurring [Prices](https://stripe.com/docs/api/prices).\n\nThere is a maximum of 10 optional items allowed on a Checkout Session, and the existing limits on the number of line items allowed on a Checkout Session apply to the combined number of line items and optional items.\n\nFor `payment` mode, there is a maximum of 100 combined line items and optional items, however it is recommended to consolidate items if there are more than a few dozen.\n\nFor `subscription` mode, there is a maximum of 20 line items and optional items with recurring Prices and 20 line items and optional items with one-time Prices.", "items": { "properties": { "adjustable_quantity": { "properties": { "enabled": { "type": "boolean" }, "maximum": { "type": "integer" }, "minimum": { "type": "integer" } }, "required": [ "enabled" ], "title": "optional_item_adjustable_quantity_params", "type": "object" }, "price": { "maxLength": 5000, "type": "string" }, "quantity": { "type": "integer" } }, "required": [ "price", "quantity" ], "title": "optional_item_params", "type": "object" }, "type": "array" }, "origin_context": { "description": "Where the user is coming from. This informs the optimizations that are applied to the session.", "enum": [ "mobile_app", "web" ], "type": "string" }, "payment_intent_data": { "description": "A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in `payment` mode.", "properties": { "application_fee_amount": { "type": "integer" }, "capture_method": { "enum": [ "automatic", "automatic_async", "manual" ], "type": "string" }, "description": { "maxLength": 1000, "type": "string" }, "metadata": { "additionalProperties": { "type": "string" }, "type": "object" }, "on_behalf_of": { "type": "string" }, "receipt_email": { "type": "string" }, "setup_future_usage": { "enum": [ "off_session", "on_session" ], "type": "string" }, "shipping": { "properties": { "address": { "properties": { "city": { "maxLength": 5000, "type": "string" }, "country": { "maxLength": 5000, "type": "string" }, "line1": { "maxLength": 5000, "type": "string" }, "line2": { "maxLength": 5000, "type": "string" }, "postal_code": { "maxLength": 5000, "type": "string" }, "state": { "maxLength": 5000, "type": "string" } }, "required": [ "line1" ], "title": "address", "type": "object" }, "carrier": { "maxLength": 5000, "type": "string" }, "name": { "maxLength": 5000, "type": "string" }, "phone": { "maxLength": 5000, "type": "string" }, "tracking_number": { "maxLength": 5000, "type": "string" } }, "required": [ "address", "name" ], "title": "shipping", "type": "object" }, "statement_descriptor": { "maxLength": 22, "type": "string" }, "statement_descriptor_suffix": { "maxLength": 22, "type": "string" }, "transfer_data": { "properties": { "amount": { "type": "integer" }, "destination": { "type": "string" } }, "required": [ "destination" ], "title": "transfer_data_params", "type": "object" }, "transfer_group": { "type": "string" } }, "title": "payment_intent_data_params", "type": "object" }, "payment_method_collection": { "description": "Specify whether Checkout should collect a payment method. When set to `if_required`, Checkout will not collect a payment method when the total due for the session is 0.\nThis may occur if the Checkout Session includes a free trial or a discount.\n\nCan only be set in `subscription` mode. Defaults to `always`.\n\nIf you'd like information on how to collect a payment method outside of Checkout, read the guide on configuring [subscriptions with a free trial](https://stripe.com/docs/payments/checkout/free-trials).", "enum": [ "always", "if_required" ], "type": "string" }, "payment_method_configuration": { "description": "The ID of the payment method configuration to use with this Checkout session.", "maxLength": 100, "type": "string" }, "payment_method_data": { "description": "This parameter allows you to set some attributes on the payment method created during a Checkout session.", "properties": { "allow_redisplay": { "enum": [ "always", "limited", "unspecified" ], "type": "string" } }, "title": "payment_method_data_param", "type": "object" }, "payment_method_options": { "description": "Payment-method-specific configuration.", "properties": { "acss_debit": { "properties": { "currency": { "enum": [ "cad", "usd" ], "type": "string" }, "mandate_options": { "properties": { "custom_mandate_url": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "default_for": { "items": { "enum": [ "invoice", "subscription" ], "type": "string" }, "type": "array" }, "interval_description": { "maxLength": 500, "type": "string" }, "payment_schedule": { "enum": [ "combined", "interval", "sporadic" ], "type": "string" }, "transaction_type": { "enum": [ "business", "personal" ], "type": "string" } }, "title": "mandate_options_param", "type": "object" }, "setup_future_usage": { "enum": [ "none", "off_session", "on_session" ], "type": "string" }, "target_date": { "maxLength": 5000, "type": "string" }, "verification_method": { "enum": [ "automatic", "instant", "microdeposits" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "payment_method_options_param", "type": "object" }, "affirm": { "properties": { "setup_future_usage": { "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, "afterpay_clearpay": { "properties": { "setup_future_usage": { "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, "alipay": { "properties": { "setup_future_usage": { "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, "amazon_pay": { "properties": { "setup_future_usage": { "enum": [ "none", "off_session" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, "au_becs_debit": { "properties": { "setup_future_usage": { "enum": [ "none" ], "type": "string" }, "target_date": { "maxLength": 5000, "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, "bacs_debit": { "properties": { "mandate_options": { "properties": { "reference_prefix": { "anyOf": [ { "maxLength": 12, "type": "string" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "payment_method_options_mandate_options_param", "type": "object" }, "setup_future_usage": { "enum": [ "none", "off_session", "on_session" ], "type": "string" }, "target_date": { "maxLength": 5000, "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, "bancontact": { "properties": { "setup_future_usage": { "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, "boleto": { "properties": { "expires_after_days": { "type": "integer" }, "setup_future_usage": { "enum": [ "none", "off_session", "on_session" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, "card": { "properties": { "installments": { "properties": { "enabled": { "type": "boolean" } }, "title": "installments_param", "type": "object" }, "request_extended_authorization": { "enum": [ "if_available", "never" ], "type": "string" }, "request_incremental_authorization": { "enum": [ "if_available", "never" ], "type": "string" }, "request_multicapture": { "enum": [ "if_available", "never" ], "type": "string" }, "request_overcapture": { "enum": [ "if_available", "never" ], "type": "string" }, "request_three_d_secure": { "enum": [ "any", "automatic", "challenge" ], "type": "string", "x-stripeBypassValidation": true }, "restrictions": { "properties": { "brands_blocked": { "items": { "enum": [ "american_express", "discover_global_network", "mastercard", "visa" ], "type": "string" }, "type": "array" } }, "title": "restrictions_param", "type": "object" }, "setup_future_usage": { "enum": [ "off_session", "on_session" ], "type": "string" }, "statement_descriptor_suffix_kana": { "maxLength": 22, "type": "string" }, "statement_descriptor_suffix_kanji": { "maxLength": 17, "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, "cashapp": { "properties": { "setup_future_usage": { "enum": [ "none", "off_session", "on_session" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, "customer_balance": { "properties": { "bank_transfer": { "properties": { "eu_bank_transfer": { "properties": { "country": { "maxLength": 5000, "type": "string" } }, "required": [ "country" ], "title": "eu_bank_transfer_params", "type": "object" }, "requested_address_types": { "items": { "enum": [ "aba", "iban", "sepa", "sort_code", "spei", "swift", "zengin" ], "type": "string", "x-stripeBypassValidation": true }, "type": "array" }, "type": { "enum": [ "eu_bank_transfer", "gb_bank_transfer", "jp_bank_transfer", "mx_bank_transfer", "us_bank_transfer" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "bank_transfer_param", "type": "object" }, "funding_type": { "enum": [ "bank_transfer" ], "type": "string" }, "setup_future_usage": { "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, "eps": { "properties": { "setup_future_usage": { "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, "fpx": { "properties": { "setup_future_usage": { "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, "giropay": { "properties": { "setup_future_usage": { "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, "grabpay": { "properties": { "setup_future_usage": { "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, "ideal": { "properties": { "setup_future_usage": { "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, "kakao_pay": { "properties": { "capture_method": { "enum": [ "manual" ], "type": "string" }, "setup_future_usage": { "enum": [ "none", "off_session" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, "klarna": { "properties": { "setup_future_usage": { "enum": [ "none" ], "type": "string" }, "subscriptions": { "anyOf": [ { "items": { "properties": { "interval": { "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "type": "integer" }, "name": { "maxLength": 255, "type": "string" }, "next_billing": { "properties": { "amount": { "type": "integer" }, "date": { "maxLength": 5000, "type": "string" } }, "required": [ "amount", "date" ], "title": "subscription_next_billing_param", "type": "object" }, "reference": { "maxLength": 255, "type": "string" } }, "required": [ "interval", "next_billing", "reference" ], "title": "setup_intent_subscription_param", "type": "object" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "payment_method_options_param", "type": "object" }, "konbini": { "properties": { "expires_after_days": { "type": "integer" }, "setup_future_usage": { "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, "kr_card": { "properties": { "capture_method": { "enum": [ "manual" ], "type": "string" }, "setup_future_usage": { "enum": [ "none", "off_session" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, "link": { "properties": { "setup_future_usage": { "enum": [ "none", "off_session" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, "mobilepay": { "properties": { "setup_future_usage": { "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, "multibanco": { "properties": { "setup_future_usage": { "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, "naver_pay": { "properties": { "capture_method": { "enum": [ "manual" ], "type": "string" }, "setup_future_usage": { "enum": [ "none", "off_session" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, "oxxo": { "properties": { "expires_after_days": { "type": "integer" }, "setup_future_usage": { "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, "p24": { "properties": { "setup_future_usage": { "enum": [ "none" ], "type": "string" }, "tos_shown_and_accepted": { "type": "boolean" } }, "title": "payment_method_options_param", "type": "object" }, "pay_by_bank": { "properties": {}, "title": "payment_method_options_param", "type": "object" }, "payco": { "properties": { "capture_method": { "enum": [ "manual" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, "paynow": { "properties": { "setup_future_usage": { "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, "paypal": { "properties": { "capture_method": { "enum": [ "", "manual" ], "type": "string" }, "preferred_locale": { "enum": [ "cs-CZ", "da-DK", "de-AT", "de-DE", "de-LU", "el-GR", "en-GB", "en-US", "es-ES", "fi-FI", "fr-BE", "fr-FR", "fr-LU", "hu-HU", "it-IT", "nl-BE", "nl-NL", "pl-PL", "pt-PT", "sk-SK", "sv-SE" ], "type": "string", "x-stripeBypassValidation": true }, "reference": { "maxLength": 127, "type": "string" }, "risk_correlation_id": { "maxLength": 32, "type": "string" }, "setup_future_usage": { "enum": [ "", "none", "off_session" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, "pix": { "properties": { "amount_includes_iof": { "enum": [ "always", "never" ], "type": "string" }, "expires_after_seconds": { "type": "integer" }, "setup_future_usage": { "enum": [ "none" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "payment_method_options_param", "type": "object" }, "revolut_pay": { "properties": { "setup_future_usage": { "enum": [ "none", "off_session" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, "samsung_pay": { "properties": { "capture_method": { "enum": [ "manual" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, "sepa_debit": { "properties": { "mandate_options": { "properties": { "reference_prefix": { "anyOf": [ { "maxLength": 12, "type": "string" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "payment_method_options_mandate_options_param", "type": "object" }, "setup_future_usage": { "enum": [ "none", "off_session", "on_session" ], "type": "string" }, "target_date": { "maxLength": 5000, "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, "sofort": { "properties": { "setup_future_usage": { "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, "swish": { "properties": { "reference": { "maxLength": 5000, "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, "us_bank_account": { "properties": { "financial_connections": { "properties": { "permissions": { "items": { "enum": [ "balances", "ownership", "payment_method", "transactions" ], "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true }, "type": "array" }, "prefetch": { "items": { "enum": [ "balances", "ownership", "transactions" ], "type": "string", "x-stripeBypassValidation": true }, "type": "array" } }, "title": "linked_account_options_param", "type": "object" }, "setup_future_usage": { "enum": [ "none", "off_session", "on_session" ], "type": "string" }, "target_date": { "maxLength": 5000, "type": "string" }, "verification_method": { "enum": [ "automatic", "instant" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "payment_method_options_param", "type": "object" }, "wechat_pay": { "properties": { "app_id": { "maxLength": 5000, "type": "string" }, "client": { "enum": [ "android", "ios", "web" ], "type": "string", "x-stripeBypassValidation": true }, "setup_future_usage": { "enum": [ "none" ], "type": "string" } }, "required": [ "client" ], "title": "payment_method_options_param", "type": "object" } }, "title": "payment_method_options_param", "type": "object" }, "payment_method_types": { "description": "A list of the types of payment methods (e.g., `card`) this Checkout Session can accept.\n\nYou can omit this attribute to manage your payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods).\nSee [Dynamic Payment Methods](https://stripe.com/docs/payments/payment-methods/integration-options#using-dynamic-payment-methods) for more details.\n\nRead more about the supported payment methods and their requirements in our [payment\nmethod details guide](/docs/payments/checkout/payment-methods).\n\nIf multiple payment methods are passed, Checkout will dynamically reorder them to\nprioritize the most relevant payment methods based on the customer's location and\nother characteristics.", "items": { "enum": [ "acss_debit", "affirm", "afterpay_clearpay", "alipay", "alma", "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", "billie", "blik", "boleto", "card", "cashapp", "crypto", "customer_balance", "eps", "fpx", "giropay", "grabpay", "ideal", "kakao_pay", "klarna", "konbini", "kr_card", "link", "mobilepay", "multibanco", "naver_pay", "nz_bank_account", "oxxo", "p24", "pay_by_bank", "payco", "paynow", "paypal", "pix", "promptpay", "revolut_pay", "samsung_pay", "satispay", "sepa_debit", "sofort", "swish", "twint", "us_bank_account", "wechat_pay", "zip" ], "type": "string", "x-stripeBypassValidation": true }, "type": "array" }, "permissions": { "description": "This property is used to set up permissions for various actions (e.g., update) on the CheckoutSession object. Can only be set when creating `embedded` or `custom` sessions.\n\nFor specific permissions, please refer to their dedicated subsections, such as `permissions.update_shipping_details`.", "properties": { "update_shipping_details": { "enum": [ "client_only", "server_only" ], "type": "string" } }, "title": "permissions_param", "type": "object" }, "phone_number_collection": { "description": "Controls phone number collection settings for the session.\n\nWe recommend that you review your privacy policy and check with your legal contacts\nbefore using this feature. Learn more about [collecting phone numbers with Checkout](https://stripe.com/docs/payments/checkout/phone-numbers).", "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ], "title": "phone_number_collection_params", "type": "object" }, "redirect_on_completion": { "description": "This parameter applies to `ui_mode: embedded`. Learn more about the [redirect behavior](https://stripe.com/docs/payments/checkout/custom-success-page?payment-ui=embedded-form) of embedded sessions. Defaults to `always`.", "enum": [ "always", "if_required", "never" ], "type": "string" }, "return_url": { "description": "The URL to redirect your customer back to after they authenticate or cancel their payment on the\npayment method's app or site. This parameter is required if `ui_mode` is `embedded` or `custom`\nand redirect-based payment methods are enabled on the session.", "type": "string" }, "saved_payment_method_options": { "description": "Controls saved payment method settings for the session. Only available in `payment` and `subscription` mode.", "properties": { "allow_redisplay_filters": { "items": { "enum": [ "always", "limited", "unspecified" ], "type": "string" }, "type": "array" }, "payment_method_remove": { "enum": [ "disabled", "enabled" ], "type": "string" }, "payment_method_save": { "enum": [ "disabled", "enabled" ], "type": "string" } }, "title": "saved_payment_method_options_param", "type": "object" }, "setup_intent_data": { "description": "A subset of parameters to be passed to SetupIntent creation for Checkout Sessions in `setup` mode.", "properties": { "description": { "maxLength": 1000, "type": "string" }, "metadata": { "additionalProperties": { "type": "string" }, "type": "object" }, "on_behalf_of": { "type": "string" } }, "title": "setup_intent_data_param", "type": "object" }, "shipping_address_collection": { "description": "When set, provides configuration for Checkout to collect a shipping address from a customer.", "properties": { "allowed_countries": { "items": { "enum": [ "AC", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CV", "CW", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MK", "ML", "MM", "MN", "MO", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SZ", "TA", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VN", "VU", "WF", "WS", "XK", "YE", "YT", "ZA", "ZM", "ZW", "ZZ" ], "type": "string" }, "type": "array" } }, "required": [ "allowed_countries" ], "title": "shipping_address_collection_params", "type": "object" }, "shipping_options": { "description": "The shipping rate options to apply to this Session. Up to a maximum of 5.", "items": { "properties": { "shipping_rate": { "maxLength": 5000, "type": "string" }, "shipping_rate_data": { "properties": { "delivery_estimate": { "properties": { "maximum": { "properties": { "unit": { "enum": [ "business_day", "day", "hour", "month", "week" ], "type": "string" }, "value": { "type": "integer" } }, "required": [ "unit", "value" ], "title": "delivery_estimate_bound", "type": "object" }, "minimum": { "properties": { "unit": { "enum": [ "business_day", "day", "hour", "month", "week" ], "type": "string" }, "value": { "type": "integer" } }, "required": [ "unit", "value" ], "title": "delivery_estimate_bound", "type": "object" } }, "title": "delivery_estimate", "type": "object" }, "display_name": { "maxLength": 100, "type": "string" }, "fixed_amount": { "properties": { "amount": { "type": "integer" }, "currency": { "format": "currency", "type": "string" }, "currency_options": { "additionalProperties": { "properties": { "amount": { "type": "integer" }, "tax_behavior": { "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" } }, "required": [ "amount" ], "title": "currency_option", "type": "object" }, "type": "object" } }, "required": [ "amount", "currency" ], "title": "fixed_amount", "type": "object" }, "metadata": { "additionalProperties": { "type": "string" }, "type": "object" }, "tax_behavior": { "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" }, "tax_code": { "type": "string" }, "type": { "enum": [ "fixed_amount" ], "type": "string" } }, "required": [ "display_name" ], "title": "method_params", "type": "object" } }, "title": "shipping_option_params", "type": "object" }, "type": "array" }, "submit_type": { "description": "Describes the type of transaction being performed by Checkout in order\nto customize relevant text on the page, such as the submit button.\n `submit_type` can only be specified on Checkout Sessions in\n`payment` or `subscription` mode. If blank or `auto`, `pay` is used.", "enum": [ "auto", "book", "donate", "pay", "subscribe" ], "type": "string" }, "subscription_data": { "description": "A subset of parameters to be passed to subscription creation for Checkout Sessions in `subscription` mode.", "properties": { "application_fee_percent": { "type": "number" }, "billing_cycle_anchor": { "format": "unix-time", "type": "integer" }, "billing_mode": { "properties": { "type": { "enum": [ "classic", "flexible" ], "type": "string" } }, "required": [ "type" ], "title": "billing_mode", "type": "object" }, "default_tax_rates": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "description": { "maxLength": 500, "type": "string" }, "invoice_settings": { "properties": { "issuer": { "properties": { "account": { "type": "string" }, "type": { "enum": [ "account", "self" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "param", "type": "object" } }, "title": "invoice_settings_params", "type": "object" }, "metadata": { "additionalProperties": { "type": "string" }, "type": "object" }, "on_behalf_of": { "type": "string" }, "proration_behavior": { "enum": [ "create_prorations", "none" ], "type": "string" }, "transfer_data": { "properties": { "amount_percent": { "type": "number" }, "destination": { "type": "string" } }, "required": [ "destination" ], "title": "transfer_data_specs", "type": "object" }, "trial_end": { "format": "unix-time", "type": "integer" }, "trial_period_days": { "type": "integer" }, "trial_settings": { "properties": { "end_behavior": { "properties": { "missing_payment_method": { "enum": [ "cancel", "create_invoice", "pause" ], "type": "string" } }, "required": [ "missing_payment_method" ], "title": "end_behavior", "type": "object" } }, "required": [ "end_behavior" ], "title": "trial_settings_config", "type": "object" } }, "title": "subscription_data_params", "type": "object" }, "success_url": { "description": "The URL to which Stripe should send customers when payment or setup\nis complete.\nThis parameter is not allowed if ui_mode is `embedded` or `custom`. If you'd like to use\ninformation from the successful Checkout Session on your page, read the\nguide on [customizing your success page](https://stripe.com/docs/payments/checkout/custom-success-page).", "type": "string" }, "tax_id_collection": { "description": "Controls tax ID collection during checkout.", "properties": { "enabled": { "type": "boolean" }, "required": { "enum": [ "if_supported", "never" ], "type": "string" } }, "required": [ "enabled" ], "title": "tax_id_collection_params", "type": "object" }, "ui_mode": { "description": "The UI mode of the Session. Defaults to `hosted`.", "enum": [ "custom", "embedded", "hosted" ], "type": "string" }, "wallet_options": { "description": "Wallet-specific configuration.", "properties": { "link": { "properties": { "display": { "enum": [ "auto", "never" ], "type": "string" } }, "title": "wallet_options_param", "type": "object" } }, "title": "wallet_options_param", "type": "object" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/checkout.session" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a Checkout Session" } }, "/v1/checkout/sessions/{session}": { "get": { "description": "

Retrieves a Checkout Session object.

", "operationId": "GetCheckoutSessionsSession", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "session", "required": true, "schema": { "maxLength": 66, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/checkout.session" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a Checkout Session" }, "post": { "description": "

Updates a Checkout Session object.

\n\n

Related guide: Dynamically update Checkout

", "operationId": "PostCheckoutSessionsSession", "parameters": [ { "in": "path", "name": "session", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "collected_information": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "shipping_options": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "collected_information": { "description": "Information about the customer collected within the Checkout Session. Can only be set when updating `embedded` or `custom` sessions.", "properties": { "shipping_details": { "properties": { "address": { "properties": { "city": { "maxLength": 5000, "type": "string" }, "country": { "maxLength": 5000, "type": "string" }, "line1": { "maxLength": 5000, "type": "string" }, "line2": { "maxLength": 5000, "type": "string" }, "postal_code": { "maxLength": 5000, "type": "string" }, "state": { "maxLength": 5000, "type": "string" } }, "required": [ "country", "line1" ], "title": "address", "type": "object" }, "name": { "maxLength": 255, "type": "string" } }, "required": [ "address", "name" ], "title": "shipping_details_params", "type": "object" } }, "title": "collected_information_params", "type": "object" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "shipping_options": { "anyOf": [ { "items": { "properties": { "shipping_rate": { "maxLength": 5000, "type": "string" }, "shipping_rate_data": { "properties": { "delivery_estimate": { "properties": { "maximum": { "properties": { "unit": { "enum": [ "business_day", "day", "hour", "month", "week" ], "type": "string" }, "value": { "type": "integer" } }, "required": [ "unit", "value" ], "title": "delivery_estimate_bound", "type": "object" }, "minimum": { "properties": { "unit": { "enum": [ "business_day", "day", "hour", "month", "week" ], "type": "string" }, "value": { "type": "integer" } }, "required": [ "unit", "value" ], "title": "delivery_estimate_bound", "type": "object" } }, "title": "delivery_estimate", "type": "object" }, "display_name": { "maxLength": 100, "type": "string" }, "fixed_amount": { "properties": { "amount": { "type": "integer" }, "currency": { "format": "currency", "type": "string" }, "currency_options": { "additionalProperties": { "properties": { "amount": { "type": "integer" }, "tax_behavior": { "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" } }, "required": [ "amount" ], "title": "currency_option", "type": "object" }, "type": "object" } }, "required": [ "amount", "currency" ], "title": "fixed_amount", "type": "object" }, "metadata": { "additionalProperties": { "type": "string" }, "type": "object" }, "tax_behavior": { "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" }, "tax_code": { "type": "string" }, "type": { "enum": [ "fixed_amount" ], "type": "string" } }, "required": [ "display_name" ], "title": "method_params", "type": "object" } }, "title": "shipping_option_params", "type": "object" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The shipping rate options to apply to this Session. Up to a maximum of 5." } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/checkout.session" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a Checkout Session" } }, "/v1/checkout/sessions/{session}/expire": { "post": { "description": "

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

\n\n

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

", "operationId": "PostCheckoutSessionsSessionExpire", "parameters": [ { "in": "path", "name": "session", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/checkout.session" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Expire a Checkout Session" } }, "/v1/checkout/sessions/{session}/line_items": { "get": { "description": "

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.

", "operationId": "GetCheckoutSessionsSessionLineItems", "parameters": [ { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "in": "path", "name": "session", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/item" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "PaymentPagesCheckoutSessionListLineItems", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a Checkout Session's line items" } }, "/v1/climate/orders": { "get": { "description": "

Lists all Climate order objects. The orders are returned sorted by creation date, with the\nmost recently created orders appearing first.

", "operationId": "GetClimateOrders", "parameters": [ { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/climate.order" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/climate/orders", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "ClimateRemovalsOrdersList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List orders" }, "post": { "description": "

Creates a Climate order object for a given Climate product. The order will be processed immediately\nafter creation and payment will be deducted your Stripe balance.

", "operationId": "PostClimateOrders", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "beneficiary": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "amount": { "description": "Requested amount of carbon removal units. Either this or `metric_tons` must be specified.", "type": "integer" }, "beneficiary": { "description": "Publicly sharable reference for the end beneficiary of carbon removal. Assumed to be the Stripe account if not set.", "properties": { "public_name": { "maxLength": 5000, "type": "string" } }, "required": [ "public_name" ], "title": "beneficiary_params", "type": "object" }, "currency": { "description": "Request currency for the order as a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a supported [settlement currency for your account](https://stripe.com/docs/currencies). If omitted, the account's default currency will be used.", "maxLength": 5000, "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "metric_tons": { "description": "Requested number of tons for the order. Either this or `amount` must be specified.", "format": "decimal", "type": "string" }, "product": { "description": "Unique identifier of the Climate product.", "maxLength": 5000, "type": "string" } }, "required": [ "product" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/climate.order" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create an order" } }, "/v1/climate/orders/{order}": { "get": { "description": "

Retrieves the details of a Climate order object with the given ID.

", "operationId": "GetClimateOrdersOrder", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "Unique identifier of the order.", "in": "path", "name": "order", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/climate.order" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve an order" }, "post": { "description": "

Updates the specified order by setting the values of the parameters passed.

", "operationId": "PostClimateOrdersOrder", "parameters": [ { "description": "Unique identifier of the order.", "in": "path", "name": "order", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "beneficiary": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "beneficiary": { "anyOf": [ { "properties": { "public_name": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] } }, "required": [ "public_name" ], "title": "beneficiary_params", "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Publicly sharable reference for the end beneficiary of carbon removal. Assumed to be the Stripe account if not set." }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/climate.order" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update an order" } }, "/v1/climate/orders/{order}/cancel": { "post": { "description": "

Cancels a Climate order. You can cancel an order within 24 hours of creation. Stripe refunds the\nreservation amount_subtotal, but not the amount_fees for user-triggered cancellations. Frontier\nmight cancel reservations if suppliers fail to deliver. If Frontier cancels the reservation, Stripe\nprovides 90 days advance notice and refunds the amount_total.

", "operationId": "PostClimateOrdersOrderCancel", "parameters": [ { "description": "Unique identifier of the order.", "in": "path", "name": "order", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/climate.order" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Cancel an order" } }, "/v1/climate/products": { "get": { "description": "

Lists all available Climate product objects.

", "operationId": "GetClimateProducts", "parameters": [ { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/climate.product" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/climate/products", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "ClimateRemovalsProductsList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List products" } }, "/v1/climate/products/{product}": { "get": { "description": "

Retrieves the details of a Climate product with the given ID.

", "operationId": "GetClimateProductsProduct", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "product", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/climate.product" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a product" } }, "/v1/climate/suppliers": { "get": { "description": "

Lists all available Climate supplier objects.

", "operationId": "GetClimateSuppliers", "parameters": [ { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/climate.supplier" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/climate/suppliers", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "ClimateRemovalsSuppliersList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List suppliers" } }, "/v1/climate/suppliers/{supplier}": { "get": { "description": "

Retrieves a Climate supplier object.

", "operationId": "GetClimateSuppliersSupplier", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "supplier", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/climate.supplier" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a supplier" } }, "/v1/confirmation_tokens/{confirmation_token}": { "get": { "description": "

Retrieves an existing ConfirmationToken object

", "operationId": "GetConfirmationTokensConfirmationToken", "parameters": [ { "in": "path", "name": "confirmation_token", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/confirmation_token" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a ConfirmationToken" } }, "/v1/country_specs": { "get": { "description": "

Lists all Country Spec objects available in the API.

", "operationId": "GetCountrySpecs", "parameters": [ { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/country_spec" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/country_specs", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "CountrySpecList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List Country Specs" } }, "/v1/country_specs/{country}": { "get": { "description": "

Returns a Country Spec for a given Country code.

", "operationId": "GetCountrySpecsCountry", "parameters": [ { "in": "path", "name": "country", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/country_spec" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a Country Spec" } }, "/v1/coupons": { "get": { "description": "

Returns a list of your coupons.

", "operationId": "GetCoupons", "parameters": [ { "description": "A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.", "explode": true, "in": "query", "name": "created", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "type": "integer" }, "gte": { "type": "integer" }, "lt": { "type": "integer" }, "lte": { "type": "integer" } }, "title": "range_query_specs", "type": "object" }, { "type": "integer" } ] }, "style": "deepObject" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/coupon" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/coupons", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "CouponsResourceCouponList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all coupons" }, "post": { "description": "

You can create coupons easily via the coupon management page of the Stripe dashboard. Coupon creation is also accessible via the API if you need to create coupons on the fly.

\n\n

A coupon has either a percent_off or an amount_off and currency. If you set an amount_off, that amount will be subtracted from any invoice’s subtotal. For example, an invoice with a subtotal of 100 will have a final total of 0 if a coupon with an amount_off of 200 is applied to it and an invoice with a subtotal of 300 will have a final total of 100 if a coupon with an amount_off of 200 is applied to it.

", "operationId": "PostCoupons", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "applies_to": { "explode": true, "style": "deepObject" }, "currency_options": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "amount_off": { "description": "A positive integer representing the amount to subtract from an invoice total (required if `percent_off` is not passed).", "type": "integer" }, "applies_to": { "description": "A hash containing directions for what this Coupon will apply discounts to.", "properties": { "products": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "title": "applies_to_params", "type": "object" }, "currency": { "description": "Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the `amount_off` parameter (required if `amount_off` is passed).", "format": "currency", "type": "string" }, "currency_options": { "additionalProperties": { "properties": { "amount_off": { "type": "integer" } }, "required": [ "amount_off" ], "title": "currency_option", "type": "object" }, "description": "Coupons defined in each available currency option (only supported if `amount_off` is passed). Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).", "type": "object" }, "duration": { "description": "Specifies how long the discount will be in effect if used on a subscription. Defaults to `once`.", "enum": [ "forever", "once", "repeating" ], "type": "string", "x-stripeBypassValidation": true }, "duration_in_months": { "description": "Required only if `duration` is `repeating`, in which case it must be a positive integer that specifies the number of months the discount will be in effect.", "type": "integer" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "id": { "description": "Unique string of your choice that will be used to identify this coupon when applying it to a customer. If you don't want to specify a particular code, you can leave the ID blank and we'll generate a random code for you.", "maxLength": 5000, "type": "string" }, "max_redemptions": { "description": "A positive integer specifying the number of times the coupon can be redeemed before it's no longer valid. For example, you might have a 50% off coupon that the first 20 readers of your blog can use.", "type": "integer" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "name": { "description": "Name of the coupon displayed to customers on, for instance invoices, or receipts. By default the `id` is shown if `name` is not set.", "maxLength": 40, "type": "string" }, "percent_off": { "description": "A positive float larger than 0, and smaller or equal to 100, that represents the discount the coupon will apply (required if `amount_off` is not passed).", "type": "number" }, "redeem_by": { "description": "Unix timestamp specifying the last time at which the coupon can be redeemed. After the redeem_by date, the coupon can no longer be applied to new customers.", "format": "unix-time", "type": "integer" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/coupon" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a coupon" } }, "/v1/coupons/{coupon}": { "delete": { "description": "

You can delete coupons via the coupon management page of the Stripe dashboard. However, deleting a coupon does not affect any customers who have already applied the coupon; it means that new customers can’t redeem the coupon. You can also delete coupons via the API.

", "operationId": "DeleteCouponsCoupon", "parameters": [ { "in": "path", "name": "coupon", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted_coupon" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Delete a coupon" }, "get": { "description": "

Retrieves the coupon with the given ID.

", "operationId": "GetCouponsCoupon", "parameters": [ { "in": "path", "name": "coupon", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/coupon" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a coupon" }, "post": { "description": "

Updates the metadata of a coupon. Other coupon details (currency, duration, amount_off) are, by design, not editable.

", "operationId": "PostCouponsCoupon", "parameters": [ { "in": "path", "name": "coupon", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "currency_options": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "currency_options": { "additionalProperties": { "properties": { "amount_off": { "type": "integer" } }, "required": [ "amount_off" ], "title": "currency_option", "type": "object" }, "description": "Coupons defined in each available currency option (only supported if the coupon is amount-based). Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).", "type": "object" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "name": { "description": "Name of the coupon displayed to customers on, for instance invoices, or receipts. By default the `id` is shown if `name` is not set.", "maxLength": 40, "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/coupon" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a coupon" } }, "/v1/credit_notes": { "get": { "description": "

Returns a list of credit notes.

", "operationId": "GetCreditNotes", "parameters": [ { "description": "Only return credit notes that were created during the given date interval.", "explode": true, "in": "query", "name": "created", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "type": "integer" }, "gte": { "type": "integer" }, "lt": { "type": "integer" }, "lte": { "type": "integer" } }, "title": "range_query_specs", "type": "object" }, { "type": "integer" } ] }, "style": "deepObject" }, { "description": "Only return credit notes for the customer specified by this customer ID.", "in": "query", "name": "customer", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "Only return credit notes for the invoice specified by this invoice ID.", "in": "query", "name": "invoice", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/credit_note" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "CreditNotesList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all credit notes" }, "post": { "description": "

Issue a credit note to adjust the amount of a finalized invoice. A credit note will first reduce the invoice’s amount_remaining (and amount_due), but not below zero.\nThis amount is indicated by the credit note’s pre_payment_amount. The excess amount is indicated by post_payment_amount, and it can result in any combination of the following:

\n\n
    \n
  • Refunds: create a new refund (using refund_amount) or link existing refunds (using refunds).
    • \n
  • Customer balance credit: credit the customer’s balance (using credit_amount) which will be automatically applied to their next invoice when it’s finalized.
    • \n
  • Outside of Stripe credit: record the amount that is or will be credited outside of Stripe (using out_of_band_amount).
    • \n
\n\n

The sum of refunds, customer balance credits, and outside of Stripe credits must equal the post_payment_amount.

\n\n

You may issue multiple credit notes for an invoice. Each credit note may increment the invoice’s pre_payment_credit_notes_amount,\npost_payment_credit_notes_amount, or both, depending on the invoice’s amount_remaining at the time of credit note creation.

", "operationId": "PostCreditNotes", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "lines": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "refunds": { "explode": true, "style": "deepObject" }, "shipping_cost": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "amount": { "description": "The integer amount in cents (or local equivalent) representing the total amount of the credit note. One of `amount`, `lines`, or `shipping_cost` must be provided.", "type": "integer" }, "credit_amount": { "description": "The integer amount in cents (or local equivalent) representing the amount to credit the customer's balance, which will be automatically applied to their next invoice.", "type": "integer" }, "effective_at": { "description": "The date when this credit note is in effect. Same as `created` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the credit note PDF.", "format": "unix-time", "type": "integer" }, "email_type": { "description": "Type of email to send to the customer, one of `credit_note` or `none` and the default is `credit_note`.", "enum": [ "credit_note", "none" ], "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "invoice": { "description": "ID of the invoice.", "maxLength": 5000, "type": "string" }, "lines": { "description": "Line items that make up the credit note. One of `amount`, `lines`, or `shipping_cost` must be provided.", "items": { "properties": { "amount": { "type": "integer" }, "description": { "maxLength": 5000, "type": "string" }, "invoice_line_item": { "maxLength": 5000, "type": "string" }, "quantity": { "type": "integer" }, "tax_amounts": { "anyOf": [ { "items": { "properties": { "amount": { "type": "integer" }, "tax_rate": { "maxLength": 5000, "type": "string" }, "taxable_amount": { "type": "integer" } }, "required": [ "amount", "tax_rate", "taxable_amount" ], "title": "tax_amount_with_tax_rate_param", "type": "object" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ] }, "tax_rates": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ] }, "type": { "enum": [ "custom_line_item", "invoice_line_item" ], "type": "string" }, "unit_amount": { "type": "integer" }, "unit_amount_decimal": { "format": "decimal", "type": "string" } }, "required": [ "type" ], "title": "credit_note_line_item_params", "type": "object" }, "type": "array" }, "memo": { "description": "The credit note's memo appears on the credit note PDF.", "maxLength": 5000, "type": "string" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "out_of_band_amount": { "description": "The integer amount in cents (or local equivalent) representing the amount that is credited outside of Stripe.", "type": "integer" }, "reason": { "description": "Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory`", "enum": [ "duplicate", "fraudulent", "order_change", "product_unsatisfactory" ], "type": "string" }, "refund_amount": { "description": "The integer amount in cents (or local equivalent) representing the amount to refund. If set, a refund will be created for the charge associated with the invoice.", "type": "integer" }, "refunds": { "description": "Refunds to link to this credit note.", "items": { "properties": { "amount_refunded": { "type": "integer" }, "refund": { "type": "string" } }, "title": "credit_note_refund_params", "type": "object" }, "type": "array" }, "shipping_cost": { "description": "When shipping_cost contains the shipping_rate from the invoice, the shipping_cost is included in the credit note. One of `amount`, `lines`, or `shipping_cost` must be provided.", "properties": { "shipping_rate": { "maxLength": 5000, "type": "string" } }, "title": "credit_note_shipping_cost", "type": "object" } }, "required": [ "invoice" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/credit_note" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a credit note" } }, "/v1/credit_notes/preview": { "get": { "description": "

Get a preview of a credit note without creating it.

", "operationId": "GetCreditNotesPreview", "parameters": [ { "description": "The integer amount in cents (or local equivalent) representing the total amount of the credit note. One of `amount`, `lines`, or `shipping_cost` must be provided.", "in": "query", "name": "amount", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "The integer amount in cents (or local equivalent) representing the amount to credit the customer's balance, which will be automatically applied to their next invoice.", "in": "query", "name": "credit_amount", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "The date when this credit note is in effect. Same as `created` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the credit note PDF.", "in": "query", "name": "effective_at", "required": false, "schema": { "format": "unix-time", "type": "integer" }, "style": "form" }, { "description": "Type of email to send to the customer, one of `credit_note` or `none` and the default is `credit_note`.", "in": "query", "name": "email_type", "required": false, "schema": { "enum": [ "credit_note", "none" ], "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "ID of the invoice.", "in": "query", "name": "invoice", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Line items that make up the credit note. One of `amount`, `lines`, or `shipping_cost` must be provided.", "explode": true, "in": "query", "name": "lines", "required": false, "schema": { "items": { "properties": { "amount": { "type": "integer" }, "description": { "maxLength": 5000, "type": "string" }, "invoice_line_item": { "maxLength": 5000, "type": "string" }, "quantity": { "type": "integer" }, "tax_amounts": { "anyOf": [ { "items": { "properties": { "amount": { "type": "integer" }, "tax_rate": { "maxLength": 5000, "type": "string" }, "taxable_amount": { "type": "integer" } }, "required": [ "amount", "tax_rate", "taxable_amount" ], "title": "tax_amount_with_tax_rate_param", "type": "object" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ] }, "tax_rates": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ] }, "type": { "enum": [ "custom_line_item", "invoice_line_item" ], "type": "string" }, "unit_amount": { "type": "integer" }, "unit_amount_decimal": { "format": "decimal", "type": "string" } }, "required": [ "type" ], "title": "credit_note_line_item_params", "type": "object" }, "type": "array" }, "style": "deepObject" }, { "description": "The credit note's memo appears on the credit note PDF.", "in": "query", "name": "memo", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "explode": true, "in": "query", "name": "metadata", "required": false, "schema": { "additionalProperties": { "type": "string" }, "type": "object" }, "style": "deepObject" }, { "description": "The integer amount in cents (or local equivalent) representing the amount that is credited outside of Stripe.", "in": "query", "name": "out_of_band_amount", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory`", "in": "query", "name": "reason", "required": false, "schema": { "enum": [ "duplicate", "fraudulent", "order_change", "product_unsatisfactory" ], "type": "string" }, "style": "form" }, { "description": "The integer amount in cents (or local equivalent) representing the amount to refund. If set, a refund will be created for the charge associated with the invoice.", "in": "query", "name": "refund_amount", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "Refunds to link to this credit note.", "explode": true, "in": "query", "name": "refunds", "required": false, "schema": { "items": { "properties": { "amount_refunded": { "type": "integer" }, "refund": { "type": "string" } }, "title": "credit_note_refund_params", "type": "object" }, "type": "array" }, "style": "deepObject" }, { "description": "When shipping_cost contains the shipping_rate from the invoice, the shipping_cost is included in the credit note. One of `amount`, `lines`, or `shipping_cost` must be provided.", "explode": true, "in": "query", "name": "shipping_cost", "required": false, "schema": { "properties": { "shipping_rate": { "maxLength": 5000, "type": "string" } }, "title": "credit_note_shipping_cost", "type": "object" }, "style": "deepObject" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/credit_note" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Preview a credit note" } }, "/v1/credit_notes/preview/lines": { "get": { "description": "

When retrieving a credit note preview, you’ll get a lines property containing the first handful of those items. This URL you can retrieve the full (paginated) list of line items.

", "operationId": "GetCreditNotesPreviewLines", "parameters": [ { "description": "The integer amount in cents (or local equivalent) representing the total amount of the credit note. One of `amount`, `lines`, or `shipping_cost` must be provided.", "in": "query", "name": "amount", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "The integer amount in cents (or local equivalent) representing the amount to credit the customer's balance, which will be automatically applied to their next invoice.", "in": "query", "name": "credit_amount", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "The date when this credit note is in effect. Same as `created` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the credit note PDF.", "in": "query", "name": "effective_at", "required": false, "schema": { "format": "unix-time", "type": "integer" }, "style": "form" }, { "description": "Type of email to send to the customer, one of `credit_note` or `none` and the default is `credit_note`.", "in": "query", "name": "email_type", "required": false, "schema": { "enum": [ "credit_note", "none" ], "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "ID of the invoice.", "in": "query", "name": "invoice", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "Line items that make up the credit note. One of `amount`, `lines`, or `shipping_cost` must be provided.", "explode": true, "in": "query", "name": "lines", "required": false, "schema": { "items": { "properties": { "amount": { "type": "integer" }, "description": { "maxLength": 5000, "type": "string" }, "invoice_line_item": { "maxLength": 5000, "type": "string" }, "quantity": { "type": "integer" }, "tax_amounts": { "anyOf": [ { "items": { "properties": { "amount": { "type": "integer" }, "tax_rate": { "maxLength": 5000, "type": "string" }, "taxable_amount": { "type": "integer" } }, "required": [ "amount", "tax_rate", "taxable_amount" ], "title": "tax_amount_with_tax_rate_param", "type": "object" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ] }, "tax_rates": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ] }, "type": { "enum": [ "custom_line_item", "invoice_line_item" ], "type": "string" }, "unit_amount": { "type": "integer" }, "unit_amount_decimal": { "format": "decimal", "type": "string" } }, "required": [ "type" ], "title": "credit_note_line_item_params", "type": "object" }, "type": "array" }, "style": "deepObject" }, { "description": "The credit note's memo appears on the credit note PDF.", "in": "query", "name": "memo", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "explode": true, "in": "query", "name": "metadata", "required": false, "schema": { "additionalProperties": { "type": "string" }, "type": "object" }, "style": "deepObject" }, { "description": "The integer amount in cents (or local equivalent) representing the amount that is credited outside of Stripe.", "in": "query", "name": "out_of_band_amount", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory`", "in": "query", "name": "reason", "required": false, "schema": { "enum": [ "duplicate", "fraudulent", "order_change", "product_unsatisfactory" ], "type": "string" }, "style": "form" }, { "description": "The integer amount in cents (or local equivalent) representing the amount to refund. If set, a refund will be created for the charge associated with the invoice.", "in": "query", "name": "refund_amount", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "Refunds to link to this credit note.", "explode": true, "in": "query", "name": "refunds", "required": false, "schema": { "items": { "properties": { "amount_refunded": { "type": "integer" }, "refund": { "type": "string" } }, "title": "credit_note_refund_params", "type": "object" }, "type": "array" }, "style": "deepObject" }, { "description": "When shipping_cost contains the shipping_rate from the invoice, the shipping_cost is included in the credit note. One of `amount`, `lines`, or `shipping_cost` must be provided.", "explode": true, "in": "query", "name": "shipping_cost", "required": false, "schema": { "properties": { "shipping_rate": { "maxLength": 5000, "type": "string" } }, "title": "credit_note_shipping_cost", "type": "object" }, "style": "deepObject" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/credit_note_line_item" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "CreditNoteLinesList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a credit note preview's line items" } }, "/v1/credit_notes/{credit_note}/lines": { "get": { "description": "

When retrieving a credit note, you’ll get a lines property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.

", "operationId": "GetCreditNotesCreditNoteLines", "parameters": [ { "in": "path", "name": "credit_note", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/credit_note_line_item" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "CreditNoteLinesList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a credit note's line items" } }, "/v1/credit_notes/{id}": { "get": { "description": "

Retrieves the credit note object with the given identifier.

", "operationId": "GetCreditNotesId", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/credit_note" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a credit note" }, "post": { "description": "

Updates an existing credit note.

", "operationId": "PostCreditNotesId", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "memo": { "description": "Credit note memo.", "maxLength": 5000, "type": "string" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/credit_note" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a credit note" } }, "/v1/credit_notes/{id}/void": { "post": { "description": "

Marks a credit note as void. Learn more about voiding credit notes.

", "operationId": "PostCreditNotesIdVoid", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/credit_note" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Void a credit note" } }, "/v1/customer_sessions": { "post": { "description": "

Creates a Customer Session object that includes a single-use client secret that you can use on your front-end to grant client-side API access for certain customer resources.

", "operationId": "PostCustomerSessions", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "components": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "components": { "description": "Configuration for each component. Exactly 1 component must be enabled.", "properties": { "buy_button": { "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ], "title": "buy_button_param", "type": "object" }, "payment_element": { "properties": { "enabled": { "type": "boolean" }, "features": { "properties": { "payment_method_allow_redisplay_filters": { "items": { "enum": [ "always", "limited", "unspecified" ], "type": "string" }, "type": "array" }, "payment_method_redisplay": { "enum": [ "disabled", "enabled" ], "type": "string", "x-stripeBypassValidation": true }, "payment_method_redisplay_limit": { "type": "integer" }, "payment_method_remove": { "enum": [ "disabled", "enabled" ], "type": "string", "x-stripeBypassValidation": true }, "payment_method_save": { "enum": [ "disabled", "enabled" ], "type": "string", "x-stripeBypassValidation": true }, "payment_method_save_usage": { "enum": [ "off_session", "on_session" ], "type": "string" } }, "title": "features_param", "type": "object" } }, "required": [ "enabled" ], "title": "payment_element_param", "type": "object" }, "pricing_table": { "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ], "title": "pricing_table_param", "type": "object" } }, "title": "components", "type": "object" }, "customer": { "description": "The ID of an existing customer for which to create the Customer Session.", "maxLength": 5000, "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "required": [ "components", "customer" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer_session" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a Customer Session" } }, "/v1/customers": { "get": { "description": "

Returns a list of your customers. The customers are returned sorted by creation date, with the most recent customers appearing first.

", "operationId": "GetCustomers", "parameters": [ { "description": "Only return customers that were created during the given date interval.", "explode": true, "in": "query", "name": "created", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "type": "integer" }, "gte": { "type": "integer" }, "lt": { "type": "integer" }, "lte": { "type": "integer" } }, "title": "range_query_specs", "type": "object" }, { "type": "integer" } ] }, "style": "deepObject" }, { "description": "A case-sensitive filter on the list based on the customer's `email` field. The value must be a string.", "in": "query", "name": "email", "required": false, "schema": { "maxLength": 512, "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Provides a list of customers that are associated with the specified test clock. The response will not include customers with test clocks if this parameter is not set.", "in": "query", "name": "test_clock", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/customer" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/customers", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "CustomerResourceCustomerList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all customers" }, "post": { "description": "

Creates a new customer object.

", "operationId": "PostCustomers", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "address": { "explode": true, "style": "deepObject" }, "cash_balance": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "invoice_settings": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "preferred_locales": { "explode": true, "style": "deepObject" }, "shipping": { "explode": true, "style": "deepObject" }, "tax": { "explode": true, "style": "deepObject" }, "tax_id_data": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "address": { "anyOf": [ { "properties": { "city": { "maxLength": 5000, "type": "string" }, "country": { "maxLength": 5000, "type": "string" }, "line1": { "maxLength": 5000, "type": "string" }, "line2": { "maxLength": 5000, "type": "string" }, "postal_code": { "maxLength": 5000, "type": "string" }, "state": { "maxLength": 5000, "type": "string" } }, "title": "optional_fields_customer_address", "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "The customer's address." }, "balance": { "description": "An integer amount in cents (or local equivalent) that represents the customer's current balance, which affect the customer's future invoices. A negative amount represents a credit that decreases the amount due on an invoice; a positive amount increases the amount due on an invoice.", "type": "integer" }, "cash_balance": { "description": "Balance information and default balance settings for this customer.", "properties": { "settings": { "properties": { "reconciliation_mode": { "enum": [ "automatic", "manual", "merchant_default" ], "type": "string" } }, "title": "balance_settings_param", "type": "object" } }, "title": "cash_balance_param", "type": "object" }, "description": { "description": "An arbitrary string that you can attach to a customer object. It is displayed alongside the customer in the dashboard.", "maxLength": 5000, "type": "string" }, "email": { "description": "Customer's email address. It's displayed alongside the customer in your dashboard and can be useful for searching and tracking. This may be up to *512 characters*.", "maxLength": 512, "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "invoice_prefix": { "description": "The prefix for the customer used to generate unique invoice numbers. Must be 3–12 uppercase letters or numbers.", "maxLength": 5000, "type": "string" }, "invoice_settings": { "description": "Default invoice settings for this customer.", "properties": { "custom_fields": { "anyOf": [ { "items": { "properties": { "name": { "maxLength": 40, "type": "string" }, "value": { "maxLength": 140, "type": "string" } }, "required": [ "name", "value" ], "title": "custom_field_params", "type": "object" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ] }, "default_payment_method": { "maxLength": 5000, "type": "string" }, "footer": { "maxLength": 5000, "type": "string" }, "rendering_options": { "anyOf": [ { "properties": { "amount_tax_display": { "enum": [ "", "exclude_tax", "include_inclusive_tax" ], "type": "string" }, "template": { "maxLength": 5000, "type": "string" } }, "title": "customer_rendering_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "customer_param", "type": "object" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "name": { "description": "The customer's full name or business name.", "maxLength": 256, "type": "string" }, "next_invoice_sequence": { "description": "The sequence to be used on the customer's next invoice. Defaults to 1.", "type": "integer" }, "payment_method": { "maxLength": 5000, "type": "string" }, "phone": { "description": "The customer's phone number.", "maxLength": 20, "type": "string" }, "preferred_locales": { "description": "Customer's preferred languages, ordered by preference.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "shipping": { "anyOf": [ { "properties": { "address": { "properties": { "city": { "maxLength": 5000, "type": "string" }, "country": { "maxLength": 5000, "type": "string" }, "line1": { "maxLength": 5000, "type": "string" }, "line2": { "maxLength": 5000, "type": "string" }, "postal_code": { "maxLength": 5000, "type": "string" }, "state": { "maxLength": 5000, "type": "string" } }, "title": "optional_fields_customer_address", "type": "object" }, "name": { "maxLength": 5000, "type": "string" }, "phone": { "maxLength": 5000, "type": "string" } }, "required": [ "address", "name" ], "title": "customer_shipping", "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "The customer's shipping information. Appears on invoices emailed to this customer." }, "source": { "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true }, "tax": { "description": "Tax details about the customer.", "properties": { "ip_address": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "validate_location": { "enum": [ "deferred", "immediately" ], "type": "string" } }, "title": "shared_tax_create_param", "type": "object" }, "tax_exempt": { "description": "The customer's tax exemption. One of `none`, `exempt`, or `reverse`.", "enum": [ "", "exempt", "none", "reverse" ], "type": "string" }, "tax_id_data": { "description": "The customer's tax IDs.", "items": { "properties": { "type": { "enum": [ "ad_nrt", "ae_trn", "al_tin", "am_tin", "ao_tin", "ar_cuit", "au_abn", "au_arn", "aw_tin", "az_tin", "ba_tin", "bb_tin", "bd_bin", "bf_ifu", "bg_uic", "bh_vat", "bj_ifu", "bo_tin", "br_cnpj", "br_cpf", "bs_tin", "by_tin", "ca_bn", "ca_gst_hst", "ca_pst_bc", "ca_pst_mb", "ca_pst_sk", "ca_qst", "cd_nif", "ch_uid", "ch_vat", "cl_tin", "cm_niu", "cn_tin", "co_nit", "cr_tin", "cv_nif", "de_stn", "do_rcn", "ec_ruc", "eg_tin", "es_cif", "et_tin", "eu_oss_vat", "eu_vat", "gb_vat", "ge_vat", "gn_nif", "hk_br", "hr_oib", "hu_tin", "id_npwp", "il_vat", "in_gst", "is_vat", "jp_cn", "jp_rn", "jp_trn", "ke_pin", "kg_tin", "kh_tin", "kr_brn", "kz_bin", "la_tin", "li_uid", "li_vat", "ma_vat", "md_vat", "me_pib", "mk_vat", "mr_nif", "mx_rfc", "my_frp", "my_itn", "my_sst", "ng_tin", "no_vat", "no_voec", "np_pan", "nz_gst", "om_vat", "pe_ruc", "ph_tin", "ro_tin", "rs_pib", "ru_inn", "ru_kpp", "sa_vat", "sg_gst", "sg_uen", "si_tin", "sn_ninea", "sr_fin", "sv_nit", "th_vat", "tj_tin", "tr_tin", "tw_vat", "tz_vat", "ua_vat", "ug_tin", "us_ein", "uy_ruc", "uz_tin", "uz_vat", "ve_rif", "vn_tin", "za_vat", "zm_tin", "zw_tin" ], "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true }, "value": { "type": "string" } }, "required": [ "type", "value" ], "title": "data_params", "type": "object" }, "type": "array" }, "test_clock": { "description": "ID of the test clock to attach to the customer.", "maxLength": 5000, "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a customer" } }, "/v1/customers/search": { "get": { "description": "

Search for customers you’ve previously created using Stripe’s Search Query Language.\nDon’t use search in read-after-write flows where strict consistency is necessary. Under normal operating\nconditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up\nto an hour behind during outages. Search functionality is not available to merchants in India.

", "operationId": "GetCustomersSearch", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.", "in": "query", "name": "page", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for customers](https://stripe.com/docs/search#query-fields-for-customers).", "in": "query", "name": "query", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/customer" }, "type": "array" }, "has_more": { "type": "boolean" }, "next_page": { "maxLength": 5000, "nullable": true, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "search_result" ], "type": "string" }, "total_count": { "description": "The total number of objects that match the query, only accurate up to 10,000.", "type": "integer" }, "url": { "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "SearchResult", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Search customers" } }, "/v1/customers/{customer}": { "delete": { "description": "

Permanently deletes a customer. It cannot be undone. Also immediately cancels any active subscriptions on the customer.

", "operationId": "DeleteCustomersCustomer", "parameters": [ { "in": "path", "name": "customer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted_customer" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Delete a customer" }, "get": { "description": "

Retrieves a Customer object.

", "operationId": "GetCustomersCustomer", "parameters": [ { "in": "path", "name": "customer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/customer" }, { "$ref": "#/components/schemas/deleted_customer" } ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a customer" }, "post": { "description": "

Updates the specified customer by setting the values of the parameters passed. Any parameters not provided will be left unchanged. For example, if you pass the source parameter, that becomes the customer’s active source (e.g., a card) to be used for all charges in the future. When you update a customer to a new valid card source by passing the source parameter: for each of the customer’s current subscriptions, if the subscription bills automatically and is in the past_due state, then the latest open invoice for the subscription with automatic collection enabled will be retried. This retry will not count as an automatic retry, and will not affect the next regularly scheduled payment for the invoice. Changing the default_source for a customer will not trigger this behavior.

\n\n

This request accepts mostly the same arguments as the customer creation call.

", "operationId": "PostCustomersCustomer", "parameters": [ { "in": "path", "name": "customer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "address": { "explode": true, "style": "deepObject" }, "bank_account": { "explode": true, "style": "deepObject" }, "card": { "explode": true, "style": "deepObject" }, "cash_balance": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "invoice_settings": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "preferred_locales": { "explode": true, "style": "deepObject" }, "shipping": { "explode": true, "style": "deepObject" }, "tax": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "address": { "anyOf": [ { "properties": { "city": { "maxLength": 5000, "type": "string" }, "country": { "maxLength": 5000, "type": "string" }, "line1": { "maxLength": 5000, "type": "string" }, "line2": { "maxLength": 5000, "type": "string" }, "postal_code": { "maxLength": 5000, "type": "string" }, "state": { "maxLength": 5000, "type": "string" } }, "title": "optional_fields_customer_address", "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "The customer's address." }, "balance": { "description": "An integer amount in cents (or local equivalent) that represents the customer's current balance, which affect the customer's future invoices. A negative amount represents a credit that decreases the amount due on an invoice; a positive amount increases the amount due on an invoice.", "type": "integer" }, "bank_account": { "anyOf": [ { "properties": { "account_holder_name": { "maxLength": 5000, "type": "string" }, "account_holder_type": { "enum": [ "company", "individual" ], "maxLength": 5000, "type": "string" }, "account_number": { "maxLength": 5000, "type": "string" }, "country": { "maxLength": 5000, "type": "string" }, "currency": { "format": "currency", "type": "string" }, "object": { "enum": [ "bank_account" ], "maxLength": 5000, "type": "string" }, "routing_number": { "maxLength": 5000, "type": "string" } }, "required": [ "account_number", "country" ], "title": "customer_payment_source_bank_account", "type": "object" }, { "maxLength": 5000, "type": "string" } ], "description": "Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details." }, "card": { "anyOf": [ { "properties": { "address_city": { "maxLength": 5000, "type": "string" }, "address_country": { "maxLength": 5000, "type": "string" }, "address_line1": { "maxLength": 5000, "type": "string" }, "address_line2": { "maxLength": 5000, "type": "string" }, "address_state": { "maxLength": 5000, "type": "string" }, "address_zip": { "maxLength": 5000, "type": "string" }, "cvc": { "maxLength": 5000, "type": "string" }, "exp_month": { "type": "integer" }, "exp_year": { "type": "integer" }, "metadata": { "additionalProperties": { "type": "string" }, "type": "object" }, "name": { "maxLength": 5000, "type": "string" }, "number": { "maxLength": 5000, "type": "string" }, "object": { "enum": [ "card" ], "maxLength": 5000, "type": "string" } }, "required": [ "exp_month", "exp_year", "number" ], "title": "customer_payment_source_card", "type": "object" }, { "maxLength": 5000, "type": "string" } ], "description": "A token, like the ones returned by [Stripe.js](https://stripe.com/docs/js).", "x-stripeBypassValidation": true }, "cash_balance": { "description": "Balance information and default balance settings for this customer.", "properties": { "settings": { "properties": { "reconciliation_mode": { "enum": [ "automatic", "manual", "merchant_default" ], "type": "string" } }, "title": "balance_settings_param", "type": "object" } }, "title": "cash_balance_param", "type": "object" }, "default_alipay_account": { "description": "ID of Alipay account to make the customer's new default for invoice payments.", "maxLength": 500, "type": "string" }, "default_bank_account": { "description": "ID of bank account to make the customer's new default for invoice payments.", "maxLength": 500, "type": "string" }, "default_card": { "description": "ID of card to make the customer's new default for invoice payments.", "maxLength": 500, "type": "string" }, "default_source": { "description": "If you are using payment methods created via the PaymentMethods API, see the [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/update#update_customer-invoice_settings-default_payment_method) parameter.\n\nProvide the ID of a payment source already attached to this customer to make it this customer's default payment source.\n\nIf you want to add a new payment source and make it the default, see the [source](https://stripe.com/docs/api/customers/update#update_customer-source) property.", "maxLength": 500, "type": "string" }, "description": { "description": "An arbitrary string that you can attach to a customer object. It is displayed alongside the customer in the dashboard.", "maxLength": 5000, "type": "string" }, "email": { "description": "Customer's email address. It's displayed alongside the customer in your dashboard and can be useful for searching and tracking. This may be up to *512 characters*.", "maxLength": 512, "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "invoice_prefix": { "description": "The prefix for the customer used to generate unique invoice numbers. Must be 3–12 uppercase letters or numbers.", "maxLength": 5000, "type": "string" }, "invoice_settings": { "description": "Default invoice settings for this customer.", "properties": { "custom_fields": { "anyOf": [ { "items": { "properties": { "name": { "maxLength": 40, "type": "string" }, "value": { "maxLength": 140, "type": "string" } }, "required": [ "name", "value" ], "title": "custom_field_params", "type": "object" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ] }, "default_payment_method": { "maxLength": 5000, "type": "string" }, "footer": { "maxLength": 5000, "type": "string" }, "rendering_options": { "anyOf": [ { "properties": { "amount_tax_display": { "enum": [ "", "exclude_tax", "include_inclusive_tax" ], "type": "string" }, "template": { "maxLength": 5000, "type": "string" } }, "title": "customer_rendering_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "customer_param", "type": "object" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "name": { "description": "The customer's full name or business name.", "maxLength": 256, "type": "string" }, "next_invoice_sequence": { "description": "The sequence to be used on the customer's next invoice. Defaults to 1.", "type": "integer" }, "phone": { "description": "The customer's phone number.", "maxLength": 20, "type": "string" }, "preferred_locales": { "description": "Customer's preferred languages, ordered by preference.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "shipping": { "anyOf": [ { "properties": { "address": { "properties": { "city": { "maxLength": 5000, "type": "string" }, "country": { "maxLength": 5000, "type": "string" }, "line1": { "maxLength": 5000, "type": "string" }, "line2": { "maxLength": 5000, "type": "string" }, "postal_code": { "maxLength": 5000, "type": "string" }, "state": { "maxLength": 5000, "type": "string" } }, "title": "optional_fields_customer_address", "type": "object" }, "name": { "maxLength": 5000, "type": "string" }, "phone": { "maxLength": 5000, "type": "string" } }, "required": [ "address", "name" ], "title": "customer_shipping", "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "The customer's shipping information. Appears on invoices emailed to this customer." }, "source": { "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true }, "tax": { "description": "Tax details about the customer.", "properties": { "ip_address": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "validate_location": { "enum": [ "auto", "deferred", "immediately" ], "type": "string" } }, "title": "shared_tax_update_param", "type": "object" }, "tax_exempt": { "description": "The customer's tax exemption. One of `none`, `exempt`, or `reverse`.", "enum": [ "", "exempt", "none", "reverse" ], "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a customer" } }, "/v1/customers/{customer}/balance_transactions": { "get": { "description": "

Returns a list of transactions that updated the customer’s balances.

", "operationId": "GetCustomersCustomerBalanceTransactions", "parameters": [ { "in": "path", "name": "customer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/customer_balance_transaction" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "CustomerBalanceTransactionList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List customer balance transactions" }, "post": { "description": "

Creates an immutable transaction that updates the customer’s credit balance.

", "operationId": "PostCustomersCustomerBalanceTransactions", "parameters": [ { "in": "path", "name": "customer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "amount": { "description": "The integer amount in **cents (or local equivalent)** to apply to the customer's credit balance.", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). Specifies the [`invoice_credit_balance`](https://stripe.com/docs/api/customers/object#customer_object-invoice_credit_balance) that this transaction will apply to. If the customer's `currency` is not set, it will be updated to this value.", "format": "currency", "type": "string" }, "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users.", "maxLength": 350, "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." } }, "required": [ "amount", "currency" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer_balance_transaction" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a customer balance transaction" } }, "/v1/customers/{customer}/balance_transactions/{transaction}": { "get": { "description": "

Retrieves a specific customer balance transaction that updated the customer’s balances.

", "operationId": "GetCustomersCustomerBalanceTransactionsTransaction", "parameters": [ { "in": "path", "name": "customer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "transaction", "required": true, "schema": { "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer_balance_transaction" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a customer balance transaction" }, "post": { "description": "

Most credit balance transaction fields are immutable, but you may update its description and metadata.

", "operationId": "PostCustomersCustomerBalanceTransactionsTransaction", "parameters": [ { "in": "path", "name": "customer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "in": "path", "name": "transaction", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users.", "maxLength": 350, "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer_balance_transaction" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a customer credit balance transaction" } }, "/v1/customers/{customer}/bank_accounts": { "get": { "deprecated": true, "description": "

You can see a list of the bank accounts belonging to a Customer. Note that the 10 most recent sources are always available by default on the Customer. If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional bank accounts.

", "operationId": "GetCustomersCustomerBankAccounts", "parameters": [ { "in": "path", "name": "customer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/bank_account" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "BankAccountList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all bank accounts" }, "post": { "description": "

When you create a new credit card, you must specify a customer or recipient on which to create it.

\n\n

If the card’s owner has no default card, then the new card will become the default.\nHowever, if the owner already has a default, then it will not change.\nTo change the default, you should update the customer to have a new default_source.

", "operationId": "PostCustomersCustomerBankAccounts", "parameters": [ { "in": "path", "name": "customer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "bank_account": { "explode": true, "style": "deepObject" }, "card": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "alipay_account": { "description": "A token returned by [Stripe.js](https://stripe.com/docs/js) representing the user’s Alipay account details.", "maxLength": 5000, "type": "string" }, "bank_account": { "anyOf": [ { "properties": { "account_holder_name": { "maxLength": 5000, "type": "string" }, "account_holder_type": { "enum": [ "company", "individual" ], "maxLength": 5000, "type": "string" }, "account_number": { "maxLength": 5000, "type": "string" }, "country": { "maxLength": 5000, "type": "string" }, "currency": { "format": "currency", "type": "string" }, "object": { "enum": [ "bank_account" ], "maxLength": 5000, "type": "string" }, "routing_number": { "maxLength": 5000, "type": "string" } }, "required": [ "account_number", "country" ], "title": "customer_payment_source_bank_account", "type": "object" }, { "maxLength": 5000, "type": "string" } ], "description": "Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details." }, "card": { "anyOf": [ { "properties": { "address_city": { "maxLength": 5000, "type": "string" }, "address_country": { "maxLength": 5000, "type": "string" }, "address_line1": { "maxLength": 5000, "type": "string" }, "address_line2": { "maxLength": 5000, "type": "string" }, "address_state": { "maxLength": 5000, "type": "string" }, "address_zip": { "maxLength": 5000, "type": "string" }, "cvc": { "maxLength": 5000, "type": "string" }, "exp_month": { "type": "integer" }, "exp_year": { "type": "integer" }, "metadata": { "additionalProperties": { "type": "string" }, "type": "object" }, "name": { "maxLength": 5000, "type": "string" }, "number": { "maxLength": 5000, "type": "string" }, "object": { "enum": [ "card" ], "maxLength": 5000, "type": "string" } }, "required": [ "exp_month", "exp_year", "number" ], "title": "customer_payment_source_card", "type": "object" }, { "maxLength": 5000, "type": "string" } ], "description": "A token, like the ones returned by [Stripe.js](https://stripe.com/docs/js).", "x-stripeBypassValidation": true }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "source": { "description": "Please refer to full [documentation](https://stripe.com/docs/api) instead.", "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_source" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a card" } }, "/v1/customers/{customer}/bank_accounts/{id}": { "delete": { "description": "

Delete a specified source for a given customer.

", "operationId": "DeleteCustomersCustomerBankAccountsId", "parameters": [ { "in": "path", "name": "customer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/payment_source" }, { "$ref": "#/components/schemas/deleted_payment_source" } ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Delete a customer source" }, "get": { "deprecated": true, "description": "

By default, you can see the 10 most recent sources stored on a Customer directly on the object, but you can also retrieve details about a specific bank account stored on the Stripe account.

", "operationId": "GetCustomersCustomerBankAccountsId", "parameters": [ { "in": "path", "name": "customer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bank_account" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a bank account" }, "post": { "description": "

Update a specified source for a given customer.

", "operationId": "PostCustomersCustomerBankAccountsId", "parameters": [ { "in": "path", "name": "customer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "owner": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "account_holder_name": { "description": "The name of the person or business that owns the bank account.", "maxLength": 5000, "type": "string" }, "account_holder_type": { "description": "The type of entity that holds the account. This can be either `individual` or `company`.", "enum": [ "company", "individual" ], "maxLength": 5000, "type": "string" }, "address_city": { "description": "City/District/Suburb/Town/Village.", "maxLength": 5000, "type": "string" }, "address_country": { "description": "Billing address country, if provided when creating card.", "maxLength": 5000, "type": "string" }, "address_line1": { "description": "Address line 1 (Street address/PO Box/Company name).", "maxLength": 5000, "type": "string" }, "address_line2": { "description": "Address line 2 (Apartment/Suite/Unit/Building).", "maxLength": 5000, "type": "string" }, "address_state": { "description": "State/County/Province/Region.", "maxLength": 5000, "type": "string" }, "address_zip": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "exp_month": { "description": "Two digit number representing the card’s expiration month.", "maxLength": 5000, "type": "string" }, "exp_year": { "description": "Four digit number representing the card’s expiration year.", "maxLength": 5000, "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "name": { "description": "Cardholder name.", "maxLength": 5000, "type": "string" }, "owner": { "properties": { "address": { "properties": { "city": { "maxLength": 5000, "type": "string" }, "country": { "maxLength": 5000, "type": "string" }, "line1": { "maxLength": 5000, "type": "string" }, "line2": { "maxLength": 5000, "type": "string" }, "postal_code": { "maxLength": 5000, "type": "string" }, "state": { "maxLength": 5000, "type": "string" } }, "title": "source_address", "type": "object" }, "email": { "type": "string" }, "name": { "maxLength": 5000, "type": "string" }, "phone": { "maxLength": 5000, "type": "string" } }, "title": "owner", "type": "object" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/card" }, { "$ref": "#/components/schemas/bank_account" }, { "$ref": "#/components/schemas/source" } ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } } } }, "/v1/customers/{customer}/bank_accounts/{id}/verify": { "post": { "description": "

Verify a specified bank account for a given customer.

", "operationId": "PostCustomersCustomerBankAccountsIdVerify", "parameters": [ { "in": "path", "name": "customer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "amounts": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "amounts": { "description": "Two positive integers, in *cents*, equal to the values of the microdeposits sent to the bank account.", "items": { "type": "integer" }, "type": "array" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bank_account" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Verify a bank account" } }, "/v1/customers/{customer}/cards": { "get": { "deprecated": true, "description": "

You can see a list of the cards belonging to a customer.\nNote that the 10 most recent sources are always available on the Customer object.\nIf you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional cards.

", "operationId": "GetCustomersCustomerCards", "parameters": [ { "in": "path", "name": "customer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/card" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "CardList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all cards" }, "post": { "description": "

When you create a new credit card, you must specify a customer or recipient on which to create it.

\n\n

If the card’s owner has no default card, then the new card will become the default.\nHowever, if the owner already has a default, then it will not change.\nTo change the default, you should update the customer to have a new default_source.

", "operationId": "PostCustomersCustomerCards", "parameters": [ { "in": "path", "name": "customer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "bank_account": { "explode": true, "style": "deepObject" }, "card": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "alipay_account": { "description": "A token returned by [Stripe.js](https://stripe.com/docs/js) representing the user’s Alipay account details.", "maxLength": 5000, "type": "string" }, "bank_account": { "anyOf": [ { "properties": { "account_holder_name": { "maxLength": 5000, "type": "string" }, "account_holder_type": { "enum": [ "company", "individual" ], "maxLength": 5000, "type": "string" }, "account_number": { "maxLength": 5000, "type": "string" }, "country": { "maxLength": 5000, "type": "string" }, "currency": { "format": "currency", "type": "string" }, "object": { "enum": [ "bank_account" ], "maxLength": 5000, "type": "string" }, "routing_number": { "maxLength": 5000, "type": "string" } }, "required": [ "account_number", "country" ], "title": "customer_payment_source_bank_account", "type": "object" }, { "maxLength": 5000, "type": "string" } ], "description": "Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details." }, "card": { "anyOf": [ { "properties": { "address_city": { "maxLength": 5000, "type": "string" }, "address_country": { "maxLength": 5000, "type": "string" }, "address_line1": { "maxLength": 5000, "type": "string" }, "address_line2": { "maxLength": 5000, "type": "string" }, "address_state": { "maxLength": 5000, "type": "string" }, "address_zip": { "maxLength": 5000, "type": "string" }, "cvc": { "maxLength": 5000, "type": "string" }, "exp_month": { "type": "integer" }, "exp_year": { "type": "integer" }, "metadata": { "additionalProperties": { "type": "string" }, "type": "object" }, "name": { "maxLength": 5000, "type": "string" }, "number": { "maxLength": 5000, "type": "string" }, "object": { "enum": [ "card" ], "maxLength": 5000, "type": "string" } }, "required": [ "exp_month", "exp_year", "number" ], "title": "customer_payment_source_card", "type": "object" }, { "maxLength": 5000, "type": "string" } ], "description": "A token, like the ones returned by [Stripe.js](https://stripe.com/docs/js).", "x-stripeBypassValidation": true }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "source": { "description": "Please refer to full [documentation](https://stripe.com/docs/api) instead.", "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_source" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a card" } }, "/v1/customers/{customer}/cards/{id}": { "delete": { "description": "

Delete a specified source for a given customer.

", "operationId": "DeleteCustomersCustomerCardsId", "parameters": [ { "in": "path", "name": "customer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/payment_source" }, { "$ref": "#/components/schemas/deleted_payment_source" } ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Delete a customer source" }, "get": { "deprecated": true, "description": "

You can always see the 10 most recent cards directly on a customer; this method lets you retrieve details about a specific card stored on the customer.

", "operationId": "GetCustomersCustomerCardsId", "parameters": [ { "in": "path", "name": "customer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/card" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a card" }, "post": { "description": "

Update a specified source for a given customer.

", "operationId": "PostCustomersCustomerCardsId", "parameters": [ { "in": "path", "name": "customer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "owner": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "account_holder_name": { "description": "The name of the person or business that owns the bank account.", "maxLength": 5000, "type": "string" }, "account_holder_type": { "description": "The type of entity that holds the account. This can be either `individual` or `company`.", "enum": [ "company", "individual" ], "maxLength": 5000, "type": "string" }, "address_city": { "description": "City/District/Suburb/Town/Village.", "maxLength": 5000, "type": "string" }, "address_country": { "description": "Billing address country, if provided when creating card.", "maxLength": 5000, "type": "string" }, "address_line1": { "description": "Address line 1 (Street address/PO Box/Company name).", "maxLength": 5000, "type": "string" }, "address_line2": { "description": "Address line 2 (Apartment/Suite/Unit/Building).", "maxLength": 5000, "type": "string" }, "address_state": { "description": "State/County/Province/Region.", "maxLength": 5000, "type": "string" }, "address_zip": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "exp_month": { "description": "Two digit number representing the card’s expiration month.", "maxLength": 5000, "type": "string" }, "exp_year": { "description": "Four digit number representing the card’s expiration year.", "maxLength": 5000, "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "name": { "description": "Cardholder name.", "maxLength": 5000, "type": "string" }, "owner": { "properties": { "address": { "properties": { "city": { "maxLength": 5000, "type": "string" }, "country": { "maxLength": 5000, "type": "string" }, "line1": { "maxLength": 5000, "type": "string" }, "line2": { "maxLength": 5000, "type": "string" }, "postal_code": { "maxLength": 5000, "type": "string" }, "state": { "maxLength": 5000, "type": "string" } }, "title": "source_address", "type": "object" }, "email": { "type": "string" }, "name": { "maxLength": 5000, "type": "string" }, "phone": { "maxLength": 5000, "type": "string" } }, "title": "owner", "type": "object" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/card" }, { "$ref": "#/components/schemas/bank_account" }, { "$ref": "#/components/schemas/source" } ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } } } }, "/v1/customers/{customer}/cash_balance": { "get": { "description": "

Retrieves a customer’s cash balance.

", "operationId": "GetCustomersCustomerCashBalance", "parameters": [ { "in": "path", "name": "customer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cash_balance" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a cash balance" }, "post": { "description": "

Changes the settings on a customer’s cash balance.

", "operationId": "PostCustomersCustomerCashBalance", "parameters": [ { "in": "path", "name": "customer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "settings": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "settings": { "description": "A hash of settings for this cash balance.", "properties": { "reconciliation_mode": { "enum": [ "automatic", "manual", "merchant_default" ], "type": "string" } }, "title": "balance_settings_param", "type": "object" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cash_balance" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a cash balance's settings" } }, "/v1/customers/{customer}/cash_balance_transactions": { "get": { "description": "

Returns a list of transactions that modified the customer’s cash balance.

", "operationId": "GetCustomersCustomerCashBalanceTransactions", "parameters": [ { "in": "path", "name": "customer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Customers with certain payments enabled have a cash balance, representing funds that were paid\nby the customer to a merchant, but have not yet been allocated to a payment. Cash Balance Transactions\nrepresent when funds are moved into or out of this balance. This includes funding by the customer, allocation\nto payments, and refunds to the customer.", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/customer_cash_balance_transaction" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "CustomerCashBalanceTransactionList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List cash balance transactions" } }, "/v1/customers/{customer}/cash_balance_transactions/{transaction}": { "get": { "description": "

Retrieves a specific cash balance transaction, which updated the customer’s cash balance.

", "operationId": "GetCustomersCustomerCashBalanceTransactionsTransaction", "parameters": [ { "in": "path", "name": "customer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "transaction", "required": true, "schema": { "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer_cash_balance_transaction" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a cash balance transaction" } }, "/v1/customers/{customer}/discount": { "delete": { "description": "

Removes the currently applied discount on a customer.

", "operationId": "DeleteCustomersCustomerDiscount", "parameters": [ { "in": "path", "name": "customer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted_discount" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Delete a customer discount" }, "get": { "description": "", "operationId": "GetCustomersCustomerDiscount", "parameters": [ { "in": "path", "name": "customer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/discount" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } } } }, "/v1/customers/{customer}/funding_instructions": { "post": { "description": "

Retrieve funding instructions for a customer cash balance. If funding instructions do not yet exist for the customer, new\nfunding instructions will be created. If funding instructions have already been created for a given customer, the same\nfunding instructions will be retrieved. In other words, we will return the same funding instructions each time.

", "operationId": "PostCustomersCustomerFundingInstructions", "parameters": [ { "in": "path", "name": "customer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "bank_transfer": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "bank_transfer": { "description": "Additional parameters for `bank_transfer` funding types", "properties": { "eu_bank_transfer": { "properties": { "country": { "maxLength": 5000, "type": "string" } }, "required": [ "country" ], "title": "eu_bank_account_params", "type": "object" }, "requested_address_types": { "items": { "enum": [ "iban", "sort_code", "spei", "zengin" ], "type": "string", "x-stripeBypassValidation": true }, "type": "array" }, "type": { "enum": [ "eu_bank_transfer", "gb_bank_transfer", "jp_bank_transfer", "mx_bank_transfer", "us_bank_transfer" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "bank_transfer_params", "type": "object" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "funding_type": { "description": "The `funding_type` to get the instructions for.", "enum": [ "bank_transfer" ], "type": "string" } }, "required": [ "bank_transfer", "currency", "funding_type" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/funding_instructions" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create or retrieve funding instructions for a customer cash balance" } }, "/v1/customers/{customer}/payment_methods": { "get": { "description": "

Returns a list of PaymentMethods for a given Customer

", "operationId": "GetCustomersCustomerPaymentMethods", "parameters": [ { "description": "This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow.", "in": "query", "name": "allow_redisplay", "required": false, "schema": { "enum": [ "always", "limited", "unspecified" ], "type": "string" }, "style": "form" }, { "in": "path", "name": "customer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "An optional filter on the list, based on the object `type` field. Without the filter, the list includes all current and future payment method types. If your integration expects only one type of payment method in the response, make sure to provide a type value in the request.", "in": "query", "name": "type", "required": false, "schema": { "enum": [ "acss_debit", "affirm", "afterpay_clearpay", "alipay", "alma", "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", "billie", "blik", "boleto", "card", "cashapp", "crypto", "customer_balance", "eps", "fpx", "giropay", "grabpay", "ideal", "kakao_pay", "klarna", "konbini", "kr_card", "link", "mobilepay", "multibanco", "naver_pay", "nz_bank_account", "oxxo", "p24", "pay_by_bank", "payco", "paynow", "paypal", "pix", "promptpay", "revolut_pay", "samsung_pay", "satispay", "sepa_debit", "sofort", "swish", "twint", "us_bank_account", "wechat_pay", "zip" ], "type": "string", "x-stripeBypassValidation": true }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/payment_method" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "CustomerPaymentMethodResourceList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List a Customer's PaymentMethods" } }, "/v1/customers/{customer}/payment_methods/{payment_method}": { "get": { "description": "

Retrieves a PaymentMethod object for a given Customer.

", "operationId": "GetCustomersCustomerPaymentMethodsPaymentMethod", "parameters": [ { "in": "path", "name": "customer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "payment_method", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_method" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a Customer's PaymentMethod" } }, "/v1/customers/{customer}/sources": { "get": { "description": "

List sources for a specified customer.

", "operationId": "GetCustomersCustomerSources", "parameters": [ { "in": "path", "name": "customer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "Filter sources according to a particular object type.", "in": "query", "name": "object", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "description": "Details about each object.", "items": { "anyOf": [ { "$ref": "#/components/schemas/bank_account" }, { "$ref": "#/components/schemas/card" }, { "$ref": "#/components/schemas/source" } ], "title": "Polymorphic", "x-stripeBypassValidation": true }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "ApmsSourcesSourceList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } } }, "post": { "description": "

When you create a new credit card, you must specify a customer or recipient on which to create it.

\n\n

If the card’s owner has no default card, then the new card will become the default.\nHowever, if the owner already has a default, then it will not change.\nTo change the default, you should update the customer to have a new default_source.

", "operationId": "PostCustomersCustomerSources", "parameters": [ { "in": "path", "name": "customer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "bank_account": { "explode": true, "style": "deepObject" }, "card": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "alipay_account": { "description": "A token returned by [Stripe.js](https://stripe.com/docs/js) representing the user’s Alipay account details.", "maxLength": 5000, "type": "string" }, "bank_account": { "anyOf": [ { "properties": { "account_holder_name": { "maxLength": 5000, "type": "string" }, "account_holder_type": { "enum": [ "company", "individual" ], "maxLength": 5000, "type": "string" }, "account_number": { "maxLength": 5000, "type": "string" }, "country": { "maxLength": 5000, "type": "string" }, "currency": { "format": "currency", "type": "string" }, "object": { "enum": [ "bank_account" ], "maxLength": 5000, "type": "string" }, "routing_number": { "maxLength": 5000, "type": "string" } }, "required": [ "account_number", "country" ], "title": "customer_payment_source_bank_account", "type": "object" }, { "maxLength": 5000, "type": "string" } ], "description": "Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details." }, "card": { "anyOf": [ { "properties": { "address_city": { "maxLength": 5000, "type": "string" }, "address_country": { "maxLength": 5000, "type": "string" }, "address_line1": { "maxLength": 5000, "type": "string" }, "address_line2": { "maxLength": 5000, "type": "string" }, "address_state": { "maxLength": 5000, "type": "string" }, "address_zip": { "maxLength": 5000, "type": "string" }, "cvc": { "maxLength": 5000, "type": "string" }, "exp_month": { "type": "integer" }, "exp_year": { "type": "integer" }, "metadata": { "additionalProperties": { "type": "string" }, "type": "object" }, "name": { "maxLength": 5000, "type": "string" }, "number": { "maxLength": 5000, "type": "string" }, "object": { "enum": [ "card" ], "maxLength": 5000, "type": "string" } }, "required": [ "exp_month", "exp_year", "number" ], "title": "customer_payment_source_card", "type": "object" }, { "maxLength": 5000, "type": "string" } ], "description": "A token, like the ones returned by [Stripe.js](https://stripe.com/docs/js).", "x-stripeBypassValidation": true }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "source": { "description": "Please refer to full [documentation](https://stripe.com/docs/api) instead.", "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_source" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a card" } }, "/v1/customers/{customer}/sources/{id}": { "delete": { "description": "

Delete a specified source for a given customer.

", "operationId": "DeleteCustomersCustomerSourcesId", "parameters": [ { "in": "path", "name": "customer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/payment_source" }, { "$ref": "#/components/schemas/deleted_payment_source" } ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Delete a customer source" }, "get": { "description": "

Retrieve a specified source for a given customer.

", "operationId": "GetCustomersCustomerSourcesId", "parameters": [ { "in": "path", "name": "customer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 500, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_source" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } } }, "post": { "description": "

Update a specified source for a given customer.

", "operationId": "PostCustomersCustomerSourcesId", "parameters": [ { "in": "path", "name": "customer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "owner": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "account_holder_name": { "description": "The name of the person or business that owns the bank account.", "maxLength": 5000, "type": "string" }, "account_holder_type": { "description": "The type of entity that holds the account. This can be either `individual` or `company`.", "enum": [ "company", "individual" ], "maxLength": 5000, "type": "string" }, "address_city": { "description": "City/District/Suburb/Town/Village.", "maxLength": 5000, "type": "string" }, "address_country": { "description": "Billing address country, if provided when creating card.", "maxLength": 5000, "type": "string" }, "address_line1": { "description": "Address line 1 (Street address/PO Box/Company name).", "maxLength": 5000, "type": "string" }, "address_line2": { "description": "Address line 2 (Apartment/Suite/Unit/Building).", "maxLength": 5000, "type": "string" }, "address_state": { "description": "State/County/Province/Region.", "maxLength": 5000, "type": "string" }, "address_zip": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "exp_month": { "description": "Two digit number representing the card’s expiration month.", "maxLength": 5000, "type": "string" }, "exp_year": { "description": "Four digit number representing the card’s expiration year.", "maxLength": 5000, "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "name": { "description": "Cardholder name.", "maxLength": 5000, "type": "string" }, "owner": { "properties": { "address": { "properties": { "city": { "maxLength": 5000, "type": "string" }, "country": { "maxLength": 5000, "type": "string" }, "line1": { "maxLength": 5000, "type": "string" }, "line2": { "maxLength": 5000, "type": "string" }, "postal_code": { "maxLength": 5000, "type": "string" }, "state": { "maxLength": 5000, "type": "string" } }, "title": "source_address", "type": "object" }, "email": { "type": "string" }, "name": { "maxLength": 5000, "type": "string" }, "phone": { "maxLength": 5000, "type": "string" } }, "title": "owner", "type": "object" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/card" }, { "$ref": "#/components/schemas/bank_account" }, { "$ref": "#/components/schemas/source" } ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } } } }, "/v1/customers/{customer}/sources/{id}/verify": { "post": { "description": "

Verify a specified bank account for a given customer.

", "operationId": "PostCustomersCustomerSourcesIdVerify", "parameters": [ { "in": "path", "name": "customer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "amounts": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "amounts": { "description": "Two positive integers, in *cents*, equal to the values of the microdeposits sent to the bank account.", "items": { "type": "integer" }, "type": "array" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bank_account" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Verify a bank account" } }, "/v1/customers/{customer}/subscriptions": { "get": { "description": "

You can see a list of the customer’s active subscriptions. Note that the 10 most recent active subscriptions are always available by default on the customer object. If you need more than those 10, you can use the limit and starting_after parameters to page through additional subscriptions.

", "operationId": "GetCustomersCustomerSubscriptions", "parameters": [ { "in": "path", "name": "customer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/subscription" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "SubscriptionList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List active subscriptions" }, "post": { "description": "

Creates a new subscription on an existing customer.

", "operationId": "PostCustomersCustomerSubscriptions", "parameters": [ { "in": "path", "name": "customer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "add_invoice_items": { "explode": true, "style": "deepObject" }, "application_fee_percent": { "explode": true, "style": "deepObject" }, "automatic_tax": { "explode": true, "style": "deepObject" }, "billing_thresholds": { "explode": true, "style": "deepObject" }, "cancel_at": { "explode": true, "style": "deepObject" }, "default_tax_rates": { "explode": true, "style": "deepObject" }, "discounts": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "invoice_settings": { "explode": true, "style": "deepObject" }, "items": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "payment_settings": { "explode": true, "style": "deepObject" }, "pending_invoice_item_interval": { "explode": true, "style": "deepObject" }, "transfer_data": { "explode": true, "style": "deepObject" }, "trial_end": { "explode": true, "style": "deepObject" }, "trial_settings": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "add_invoice_items": { "description": "A list of prices and quantities that will generate invoice items appended to the next invoice for this subscription. You may pass up to 20 items.", "items": { "properties": { "discounts": { "items": { "properties": { "coupon": { "maxLength": 5000, "type": "string" }, "discount": { "maxLength": 5000, "type": "string" }, "promotion_code": { "maxLength": 5000, "type": "string" } }, "title": "discounts_data_param", "type": "object" }, "type": "array" }, "metadata": { "additionalProperties": { "type": "string" }, "type": "object" }, "period": { "properties": { "end": { "properties": { "timestamp": { "format": "unix-time", "type": "integer" }, "type": { "enum": [ "min_item_period_end", "timestamp" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "invoice_item_period_end", "type": "object" }, "start": { "properties": { "timestamp": { "format": "unix-time", "type": "integer" }, "type": { "enum": [ "max_item_period_start", "now", "timestamp" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "invoice_item_period_start", "type": "object" } }, "required": [ "end", "start" ], "title": "invoice_item_period", "type": "object" }, "price": { "maxLength": 5000, "type": "string" }, "price_data": { "properties": { "currency": { "format": "currency", "type": "string" }, "product": { "maxLength": 5000, "type": "string" }, "tax_behavior": { "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" }, "unit_amount": { "type": "integer" }, "unit_amount_decimal": { "format": "decimal", "type": "string" } }, "required": [ "currency", "product" ], "title": "one_time_price_data_with_negative_amounts", "type": "object" }, "quantity": { "type": "integer" }, "tax_rates": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "add_invoice_item_entry", "type": "object" }, "type": "array" }, "application_fee_percent": { "anyOf": [ { "type": "number" }, { "enum": [ "" ], "type": "string" } ], "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions)." }, "automatic_tax": { "description": "Automatic tax settings for this subscription.", "properties": { "enabled": { "type": "boolean" }, "liability": { "properties": { "account": { "type": "string" }, "type": { "enum": [ "account", "self" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "param", "type": "object" } }, "required": [ "enabled" ], "title": "automatic_tax_config", "type": "object" }, "backdate_start_date": { "description": "A past timestamp to backdate the subscription's start date to. If set, the first invoice will contain line items for the timespan between the start date and the current time. Can be combined with trials and the billing cycle anchor.", "format": "unix-time", "type": "integer" }, "billing_cycle_anchor": { "description": "A future timestamp in UTC format to anchor the subscription's [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle). The anchor is the reference point that aligns future billing cycle dates. It sets the day of week for `week` intervals, the day of month for `month` and `year` intervals, and the month of year for `year` intervals.", "format": "unix-time", "type": "integer", "x-stripeBypassValidation": true }, "billing_thresholds": { "anyOf": [ { "properties": { "amount_gte": { "type": "integer" }, "reset_billing_cycle_anchor": { "type": "boolean" } }, "title": "billing_thresholds_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds." }, "cancel_at": { "anyOf": [ { "format": "unix-time", "type": "integer" }, { "enum": [ "max_period_end", "min_period_end" ], "type": "string" } ], "description": "A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period." }, "cancel_at_period_end": { "description": "Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`.", "type": "boolean" }, "collection_method": { "description": "Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically`.", "enum": [ "charge_automatically", "send_invoice" ], "type": "string" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "days_until_due": { "description": "Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where `collection_method` is set to `send_invoice`.", "type": "integer" }, "default_payment_method": { "description": "ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).", "maxLength": 5000, "type": "string" }, "default_source": { "description": "ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).", "maxLength": 5000, "type": "string" }, "default_tax_rates": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The tax rates that will apply to any subscription item that does not have `tax_rates` set. Invoices created will have their `default_tax_rates` populated from the subscription." }, "discounts": { "anyOf": [ { "items": { "properties": { "coupon": { "maxLength": 5000, "type": "string" }, "discount": { "maxLength": 5000, "type": "string" }, "promotion_code": { "maxLength": 5000, "type": "string" } }, "title": "discounts_data_param", "type": "object" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The coupons to redeem into discounts for the subscription. If not specified or empty, inherits the discount from the subscription's customer." }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "invoice_settings": { "description": "All invoices will be billed using the specified settings.", "properties": { "account_tax_ids": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ] }, "issuer": { "properties": { "account": { "type": "string" }, "type": { "enum": [ "account", "self" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "param", "type": "object" } }, "title": "invoice_settings_param", "type": "object" }, "items": { "description": "A list of up to 20 subscription items, each with an attached price.", "items": { "properties": { "billing_thresholds": { "anyOf": [ { "properties": { "usage_gte": { "type": "integer" } }, "required": [ "usage_gte" ], "title": "item_billing_thresholds_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "discounts": { "anyOf": [ { "items": { "properties": { "coupon": { "maxLength": 5000, "type": "string" }, "discount": { "maxLength": 5000, "type": "string" }, "promotion_code": { "maxLength": 5000, "type": "string" } }, "title": "discounts_data_param", "type": "object" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ] }, "metadata": { "additionalProperties": { "type": "string" }, "type": "object" }, "price": { "maxLength": 5000, "type": "string" }, "price_data": { "properties": { "currency": { "format": "currency", "type": "string" }, "product": { "maxLength": 5000, "type": "string" }, "recurring": { "properties": { "interval": { "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "type": "integer" } }, "required": [ "interval" ], "title": "recurring_adhoc", "type": "object" }, "tax_behavior": { "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" }, "unit_amount": { "type": "integer" }, "unit_amount_decimal": { "format": "decimal", "type": "string" } }, "required": [ "currency", "product", "recurring" ], "title": "recurring_price_data", "type": "object" }, "quantity": { "type": "integer" }, "tax_rates": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "subscription_item_create_params", "type": "object" }, "type": "array" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "off_session": { "description": "Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to `false` (on-session).", "type": "boolean" }, "payment_behavior": { "description": "Only applies to subscriptions with `collection_method=charge_automatically`.\n\nUse `allow_incomplete` to create Subscriptions with `status=incomplete` if the first invoice can't be paid. Creating Subscriptions with this status allows you to manage scenarios where additional customer actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior.\n\nUse `default_incomplete` to create Subscriptions with `status=incomplete` when the first invoice requires payment, otherwise start as active. Subscriptions transition to `status=active` when successfully confirming the PaymentIntent on the first invoice. This allows simpler management of scenarios where additional customer actions are needed to pay a subscription’s invoice, such as failed payments, [SCA regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method. If the PaymentIntent is not confirmed within 23 hours Subscriptions transition to `status=incomplete_expired`, which is a terminal state.\n\nUse `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's first invoice can't be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further customer action is needed, this parameter doesn't create a Subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more.\n\n`pending_if_incomplete` is only used with updates and cannot be passed when creating a Subscription.\n\nSubscriptions with `collection_method=send_invoice` are automatically activated regardless of the first Invoice status.", "enum": [ "allow_incomplete", "default_incomplete", "error_if_incomplete", "pending_if_incomplete" ], "type": "string" }, "payment_settings": { "description": "Payment settings to pass to invoices created by the subscription.", "properties": { "payment_method_options": { "properties": { "acss_debit": { "anyOf": [ { "properties": { "mandate_options": { "properties": { "transaction_type": { "enum": [ "business", "personal" ], "type": "string" } }, "title": "mandate_options_param", "type": "object" }, "verification_method": { "enum": [ "automatic", "instant", "microdeposits" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "invoice_payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "bancontact": { "anyOf": [ { "properties": { "preferred_language": { "enum": [ "de", "en", "fr", "nl" ], "type": "string" } }, "title": "invoice_payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "card": { "anyOf": [ { "properties": { "mandate_options": { "properties": { "amount": { "type": "integer" }, "amount_type": { "enum": [ "fixed", "maximum" ], "type": "string" }, "description": { "maxLength": 200, "type": "string" } }, "title": "mandate_options_param", "type": "object" }, "network": { "enum": [ "amex", "cartes_bancaires", "diners", "discover", "eftpos_au", "girocard", "interac", "jcb", "link", "mastercard", "unionpay", "unknown", "visa" ], "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true }, "request_three_d_secure": { "enum": [ "any", "automatic", "challenge" ], "type": "string" } }, "title": "subscription_payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "customer_balance": { "anyOf": [ { "properties": { "bank_transfer": { "properties": { "eu_bank_transfer": { "properties": { "country": { "maxLength": 5000, "type": "string" } }, "required": [ "country" ], "title": "eu_bank_transfer_param", "type": "object" }, "type": { "type": "string" } }, "title": "bank_transfer_param", "type": "object" }, "funding_type": { "type": "string" } }, "title": "invoice_payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "konbini": { "anyOf": [ { "properties": {}, "title": "invoice_payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "sepa_debit": { "anyOf": [ { "properties": {}, "title": "invoice_payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "us_bank_account": { "anyOf": [ { "properties": { "financial_connections": { "properties": { "filters": { "properties": { "account_subcategories": { "items": { "enum": [ "checking", "savings" ], "type": "string" }, "type": "array" } }, "title": "invoice_linked_account_options_filters_param", "type": "object" }, "permissions": { "items": { "enum": [ "balances", "ownership", "payment_method", "transactions" ], "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true }, "type": "array" }, "prefetch": { "items": { "enum": [ "balances", "ownership", "transactions" ], "type": "string", "x-stripeBypassValidation": true }, "type": "array" } }, "title": "invoice_linked_account_options_param", "type": "object" }, "verification_method": { "enum": [ "automatic", "instant", "microdeposits" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "invoice_payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "payment_method_options", "type": "object" }, "payment_method_types": { "anyOf": [ { "items": { "enum": [ "ach_credit_transfer", "ach_debit", "acss_debit", "affirm", "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", "boleto", "card", "cashapp", "crypto", "customer_balance", "eps", "fpx", "giropay", "grabpay", "ideal", "jp_credit_transfer", "kakao_pay", "klarna", "konbini", "kr_card", "link", "multibanco", "naver_pay", "nz_bank_account", "p24", "payco", "paynow", "paypal", "promptpay", "revolut_pay", "sepa_credit_transfer", "sepa_debit", "sofort", "swish", "us_bank_account", "wechat_pay" ], "type": "string", "x-stripeBypassValidation": true }, "type": "array" }, { "enum": [ "" ], "type": "string" } ] }, "save_default_payment_method": { "enum": [ "off", "on_subscription" ], "type": "string" } }, "title": "payment_settings", "type": "object" }, "pending_invoice_item_interval": { "anyOf": [ { "properties": { "interval": { "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "type": "integer" } }, "required": [ "interval" ], "title": "pending_invoice_item_interval_params", "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://stripe.com/docs/api#create_invoice) for the given subscription at the specified interval." }, "proration_behavior": { "description": "Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) resulting from the `billing_cycle_anchor`. If no value is passed, the default is `create_prorations`.", "enum": [ "always_invoice", "create_prorations", "none" ], "type": "string" }, "transfer_data": { "description": "If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges.", "properties": { "amount_percent": { "type": "number" }, "destination": { "type": "string" } }, "required": [ "destination" ], "title": "transfer_data_specs", "type": "object" }, "trial_end": { "anyOf": [ { "enum": [ "now" ], "maxLength": 5000, "type": "string" }, { "format": "unix-time", "type": "integer" } ], "description": "Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more." }, "trial_from_plan": { "description": "Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more.", "type": "boolean" }, "trial_period_days": { "description": "Integer representing the number of trial period days before the customer is charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more.", "type": "integer" }, "trial_settings": { "description": "Settings related to subscription trials.", "properties": { "end_behavior": { "properties": { "missing_payment_method": { "enum": [ "cancel", "create_invoice", "pause" ], "type": "string" } }, "required": [ "missing_payment_method" ], "title": "end_behavior", "type": "object" } }, "required": [ "end_behavior" ], "title": "trial_settings_config", "type": "object" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/subscription" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a subscription" } }, "/v1/customers/{customer}/subscriptions/{subscription_exposed_id}": { "delete": { "description": "

Cancels a customer’s subscription. If you set the at_period_end parameter to true, the subscription will remain active until the end of the period, at which point it will be canceled and not renewed. Otherwise, with the default false value, the subscription is terminated immediately. In either case, the customer will not be charged again for the subscription.

\n\n

Note, however, that any pending invoice items that you’ve created will still be charged for at the end of the period, unless manually deleted. If you’ve set the subscription to cancel at the end of the period, any pending prorations will also be left in place and collected at the end of the period. But if the subscription is set to cancel immediately, pending prorations will be removed.

\n\n

By default, upon subscription cancellation, Stripe will stop automatic collection of all finalized invoices for the customer. This is intended to prevent unexpected payment attempts after the customer has canceled a subscription. However, you can resume automatic collection of the invoices manually after subscription cancellation to have us proceed. Or, you could check for unpaid invoices before allowing the customer to cancel the subscription at all.

", "operationId": "DeleteCustomersCustomerSubscriptionsSubscriptionExposedId", "parameters": [ { "in": "path", "name": "customer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "in": "path", "name": "subscription_exposed_id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "invoice_now": { "description": "Can be set to `true` if `at_period_end` is not set to `true`. Will generate a final invoice that invoices for any un-invoiced metered usage and new/pending proration invoice items.", "type": "boolean" }, "prorate": { "description": "Can be set to `true` if `at_period_end` is not set to `true`. Will generate a proration invoice item that credits remaining unused time until the subscription period end.", "type": "boolean" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/subscription" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Cancel a subscription" }, "get": { "description": "

Retrieves the subscription with the given ID.

", "operationId": "GetCustomersCustomerSubscriptionsSubscriptionExposedId", "parameters": [ { "in": "path", "name": "customer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "subscription_exposed_id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/subscription" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a subscription" }, "post": { "description": "

Updates an existing subscription on a customer to match the specified parameters. When changing plans or quantities, we will optionally prorate the price we charge next month to make up for any price changes. To preview how the proration will be calculated, use the upcoming invoice endpoint.

", "operationId": "PostCustomersCustomerSubscriptionsSubscriptionExposedId", "parameters": [ { "in": "path", "name": "customer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "in": "path", "name": "subscription_exposed_id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "add_invoice_items": { "explode": true, "style": "deepObject" }, "application_fee_percent": { "explode": true, "style": "deepObject" }, "automatic_tax": { "explode": true, "style": "deepObject" }, "billing_thresholds": { "explode": true, "style": "deepObject" }, "cancel_at": { "explode": true, "style": "deepObject" }, "cancellation_details": { "explode": true, "style": "deepObject" }, "default_source": { "explode": true, "style": "deepObject" }, "default_tax_rates": { "explode": true, "style": "deepObject" }, "discounts": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "invoice_settings": { "explode": true, "style": "deepObject" }, "items": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "pause_collection": { "explode": true, "style": "deepObject" }, "payment_settings": { "explode": true, "style": "deepObject" }, "pending_invoice_item_interval": { "explode": true, "style": "deepObject" }, "transfer_data": { "explode": true, "style": "deepObject" }, "trial_end": { "explode": true, "style": "deepObject" }, "trial_settings": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "add_invoice_items": { "description": "A list of prices and quantities that will generate invoice items appended to the next invoice for this subscription. You may pass up to 20 items.", "items": { "properties": { "discounts": { "items": { "properties": { "coupon": { "maxLength": 5000, "type": "string" }, "discount": { "maxLength": 5000, "type": "string" }, "promotion_code": { "maxLength": 5000, "type": "string" } }, "title": "discounts_data_param", "type": "object" }, "type": "array" }, "metadata": { "additionalProperties": { "type": "string" }, "type": "object" }, "period": { "properties": { "end": { "properties": { "timestamp": { "format": "unix-time", "type": "integer" }, "type": { "enum": [ "min_item_period_end", "timestamp" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "invoice_item_period_end", "type": "object" }, "start": { "properties": { "timestamp": { "format": "unix-time", "type": "integer" }, "type": { "enum": [ "max_item_period_start", "now", "timestamp" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "invoice_item_period_start", "type": "object" } }, "required": [ "end", "start" ], "title": "invoice_item_period", "type": "object" }, "price": { "maxLength": 5000, "type": "string" }, "price_data": { "properties": { "currency": { "format": "currency", "type": "string" }, "product": { "maxLength": 5000, "type": "string" }, "tax_behavior": { "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" }, "unit_amount": { "type": "integer" }, "unit_amount_decimal": { "format": "decimal", "type": "string" } }, "required": [ "currency", "product" ], "title": "one_time_price_data_with_negative_amounts", "type": "object" }, "quantity": { "type": "integer" }, "tax_rates": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "add_invoice_item_entry", "type": "object" }, "type": "array" }, "application_fee_percent": { "anyOf": [ { "type": "number" }, { "enum": [ "" ], "type": "string" } ], "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions)." }, "automatic_tax": { "description": "Automatic tax settings for this subscription. We recommend you only include this parameter when the existing value is being changed.", "properties": { "enabled": { "type": "boolean" }, "liability": { "properties": { "account": { "type": "string" }, "type": { "enum": [ "account", "self" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "param", "type": "object" } }, "required": [ "enabled" ], "title": "automatic_tax_config", "type": "object" }, "billing_cycle_anchor": { "description": "Either `now` or `unchanged`. Setting the value to `now` resets the subscription's billing cycle anchor to the current time. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).", "enum": [ "now", "unchanged" ], "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true }, "billing_thresholds": { "anyOf": [ { "properties": { "amount_gte": { "type": "integer" }, "reset_billing_cycle_anchor": { "type": "boolean" } }, "title": "billing_thresholds_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds." }, "cancel_at": { "anyOf": [ { "format": "unix-time", "type": "integer" }, { "enum": [ "" ], "type": "string" }, { "enum": [ "max_period_end", "min_period_end" ], "type": "string" } ], "description": "A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period." }, "cancel_at_period_end": { "description": "Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`.", "type": "boolean" }, "cancellation_details": { "description": "Details about why this subscription was cancelled", "properties": { "comment": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "feedback": { "enum": [ "", "customer_service", "low_quality", "missing_features", "other", "switched_service", "too_complex", "too_expensive", "unused" ], "type": "string" } }, "title": "cancellation_details_param", "type": "object" }, "collection_method": { "description": "Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically`.", "enum": [ "charge_automatically", "send_invoice" ], "type": "string" }, "days_until_due": { "description": "Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where `collection_method` is set to `send_invoice`.", "type": "integer" }, "default_payment_method": { "description": "ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).", "maxLength": 5000, "type": "string" }, "default_source": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source)." }, "default_tax_rates": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The tax rates that will apply to any subscription item that does not have `tax_rates` set. Invoices created will have their `default_tax_rates` populated from the subscription. Pass an empty string to remove previously-defined tax rates." }, "discounts": { "anyOf": [ { "items": { "properties": { "coupon": { "maxLength": 5000, "type": "string" }, "discount": { "maxLength": 5000, "type": "string" }, "promotion_code": { "maxLength": 5000, "type": "string" } }, "title": "discounts_data_param", "type": "object" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The coupons to redeem into discounts for the subscription. If not specified or empty, inherits the discount from the subscription's customer." }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "invoice_settings": { "description": "All invoices will be billed using the specified settings.", "properties": { "account_tax_ids": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ] }, "issuer": { "properties": { "account": { "type": "string" }, "type": { "enum": [ "account", "self" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "param", "type": "object" } }, "title": "invoice_settings_param", "type": "object" }, "items": { "description": "A list of up to 20 subscription items, each with an attached price.", "items": { "properties": { "billing_thresholds": { "anyOf": [ { "properties": { "usage_gte": { "type": "integer" } }, "required": [ "usage_gte" ], "title": "item_billing_thresholds_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "clear_usage": { "type": "boolean" }, "deleted": { "type": "boolean" }, "discounts": { "anyOf": [ { "items": { "properties": { "coupon": { "maxLength": 5000, "type": "string" }, "discount": { "maxLength": 5000, "type": "string" }, "promotion_code": { "maxLength": 5000, "type": "string" } }, "title": "discounts_data_param", "type": "object" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ] }, "id": { "maxLength": 5000, "type": "string" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "price": { "maxLength": 5000, "type": "string" }, "price_data": { "properties": { "currency": { "format": "currency", "type": "string" }, "product": { "maxLength": 5000, "type": "string" }, "recurring": { "properties": { "interval": { "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "type": "integer" } }, "required": [ "interval" ], "title": "recurring_adhoc", "type": "object" }, "tax_behavior": { "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" }, "unit_amount": { "type": "integer" }, "unit_amount_decimal": { "format": "decimal", "type": "string" } }, "required": [ "currency", "product", "recurring" ], "title": "recurring_price_data", "type": "object" }, "quantity": { "type": "integer" }, "tax_rates": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "subscription_item_update_params", "type": "object" }, "type": "array" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "off_session": { "description": "Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to `false` (on-session).", "type": "boolean" }, "pause_collection": { "anyOf": [ { "properties": { "behavior": { "enum": [ "keep_as_draft", "mark_uncollectible", "void" ], "type": "string" }, "resumes_at": { "format": "unix-time", "type": "integer" } }, "required": [ "behavior" ], "title": "pause_collection_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://stripe.com/docs/billing/subscriptions/pause-payment)." }, "payment_behavior": { "description": "Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior.\n\nUse `default_incomplete` to transition the subscription to `status=past_due` when payment is required and await explicit confirmation of the invoice's payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription’s invoice. Such as failed payments, [SCA regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method.\n\nUse `pending_if_incomplete` to update the subscription using [pending updates](https://stripe.com/docs/billing/subscriptions/pending-updates). When you use `pending_if_incomplete` you can only pass the parameters [supported by pending updates](https://stripe.com/docs/billing/pending-updates-reference#supported-attributes).\n\nUse `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://docs.stripe.com/changelog/2019-03-14) to learn more.", "enum": [ "allow_incomplete", "default_incomplete", "error_if_incomplete", "pending_if_incomplete" ], "type": "string" }, "payment_settings": { "description": "Payment settings to pass to invoices created by the subscription.", "properties": { "payment_method_options": { "properties": { "acss_debit": { "anyOf": [ { "properties": { "mandate_options": { "properties": { "transaction_type": { "enum": [ "business", "personal" ], "type": "string" } }, "title": "mandate_options_param", "type": "object" }, "verification_method": { "enum": [ "automatic", "instant", "microdeposits" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "invoice_payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "bancontact": { "anyOf": [ { "properties": { "preferred_language": { "enum": [ "de", "en", "fr", "nl" ], "type": "string" } }, "title": "invoice_payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "card": { "anyOf": [ { "properties": { "mandate_options": { "properties": { "amount": { "type": "integer" }, "amount_type": { "enum": [ "fixed", "maximum" ], "type": "string" }, "description": { "maxLength": 200, "type": "string" } }, "title": "mandate_options_param", "type": "object" }, "network": { "enum": [ "amex", "cartes_bancaires", "diners", "discover", "eftpos_au", "girocard", "interac", "jcb", "link", "mastercard", "unionpay", "unknown", "visa" ], "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true }, "request_three_d_secure": { "enum": [ "any", "automatic", "challenge" ], "type": "string" } }, "title": "subscription_payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "customer_balance": { "anyOf": [ { "properties": { "bank_transfer": { "properties": { "eu_bank_transfer": { "properties": { "country": { "maxLength": 5000, "type": "string" } }, "required": [ "country" ], "title": "eu_bank_transfer_param", "type": "object" }, "type": { "type": "string" } }, "title": "bank_transfer_param", "type": "object" }, "funding_type": { "type": "string" } }, "title": "invoice_payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "konbini": { "anyOf": [ { "properties": {}, "title": "invoice_payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "sepa_debit": { "anyOf": [ { "properties": {}, "title": "invoice_payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "us_bank_account": { "anyOf": [ { "properties": { "financial_connections": { "properties": { "filters": { "properties": { "account_subcategories": { "items": { "enum": [ "checking", "savings" ], "type": "string" }, "type": "array" } }, "title": "invoice_linked_account_options_filters_param", "type": "object" }, "permissions": { "items": { "enum": [ "balances", "ownership", "payment_method", "transactions" ], "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true }, "type": "array" }, "prefetch": { "items": { "enum": [ "balances", "ownership", "transactions" ], "type": "string", "x-stripeBypassValidation": true }, "type": "array" } }, "title": "invoice_linked_account_options_param", "type": "object" }, "verification_method": { "enum": [ "automatic", "instant", "microdeposits" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "invoice_payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "payment_method_options", "type": "object" }, "payment_method_types": { "anyOf": [ { "items": { "enum": [ "ach_credit_transfer", "ach_debit", "acss_debit", "affirm", "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", "boleto", "card", "cashapp", "crypto", "customer_balance", "eps", "fpx", "giropay", "grabpay", "ideal", "jp_credit_transfer", "kakao_pay", "klarna", "konbini", "kr_card", "link", "multibanco", "naver_pay", "nz_bank_account", "p24", "payco", "paynow", "paypal", "promptpay", "revolut_pay", "sepa_credit_transfer", "sepa_debit", "sofort", "swish", "us_bank_account", "wechat_pay" ], "type": "string", "x-stripeBypassValidation": true }, "type": "array" }, { "enum": [ "" ], "type": "string" } ] }, "save_default_payment_method": { "enum": [ "off", "on_subscription" ], "type": "string" } }, "title": "payment_settings", "type": "object" }, "pending_invoice_item_interval": { "anyOf": [ { "properties": { "interval": { "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "type": "integer" } }, "required": [ "interval" ], "title": "pending_invoice_item_interval_params", "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://stripe.com/docs/api#create_invoice) for the given subscription at the specified interval." }, "proration_behavior": { "description": "Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.", "enum": [ "always_invoice", "create_prorations", "none" ], "type": "string" }, "proration_date": { "description": "If set, prorations will be calculated as though the subscription was updated at the given time. This can be used to apply exactly the same prorations that were previewed with the [create preview](https://stripe.com/docs/api/invoices/create_preview) endpoint. `proration_date` can also be used to implement custom proration logic, such as prorating by day instead of by second, by providing the time that you wish to use for proration calculations.", "format": "unix-time", "type": "integer" }, "transfer_data": { "anyOf": [ { "properties": { "amount_percent": { "type": "number" }, "destination": { "type": "string" } }, "required": [ "destination" ], "title": "transfer_data_specs", "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges. This will be unset if you POST an empty value." }, "trial_end": { "anyOf": [ { "enum": [ "now" ], "maxLength": 5000, "type": "string" }, { "format": "unix-time", "type": "integer" } ], "description": "Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`." }, "trial_from_plan": { "description": "Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more.", "type": "boolean" }, "trial_settings": { "description": "Settings related to subscription trials.", "properties": { "end_behavior": { "properties": { "missing_payment_method": { "enum": [ "cancel", "create_invoice", "pause" ], "type": "string" } }, "required": [ "missing_payment_method" ], "title": "end_behavior", "type": "object" } }, "required": [ "end_behavior" ], "title": "trial_settings_config", "type": "object" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/subscription" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a subscription on a customer" } }, "/v1/customers/{customer}/subscriptions/{subscription_exposed_id}/discount": { "delete": { "description": "

Removes the currently applied discount on a customer.

", "operationId": "DeleteCustomersCustomerSubscriptionsSubscriptionExposedIdDiscount", "parameters": [ { "in": "path", "name": "customer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "in": "path", "name": "subscription_exposed_id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted_discount" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Delete a customer discount" }, "get": { "description": "", "operationId": "GetCustomersCustomerSubscriptionsSubscriptionExposedIdDiscount", "parameters": [ { "in": "path", "name": "customer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "subscription_exposed_id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/discount" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } } } }, "/v1/customers/{customer}/tax_ids": { "get": { "description": "

Returns a list of tax IDs for a customer.

", "operationId": "GetCustomersCustomerTaxIds", "parameters": [ { "in": "path", "name": "customer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/tax_id" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "TaxIDsList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all Customer tax IDs" }, "post": { "description": "

Creates a new tax_id object for a customer.

", "operationId": "PostCustomersCustomerTaxIds", "parameters": [ { "in": "path", "name": "customer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "type": { "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `aw_tin`, `az_tin`, `ba_tin`, `bb_tin`, `bd_bin`, `bf_ifu`, `bg_uic`, `bh_vat`, `bj_ifu`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cm_niu`, `cn_tin`, `co_nit`, `cr_tin`, `cv_nif`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `et_tin`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kg_tin`, `kh_tin`, `kr_brn`, `kz_bin`, `la_tin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin`", "enum": [ "ad_nrt", "ae_trn", "al_tin", "am_tin", "ao_tin", "ar_cuit", "au_abn", "au_arn", "aw_tin", "az_tin", "ba_tin", "bb_tin", "bd_bin", "bf_ifu", "bg_uic", "bh_vat", "bj_ifu", "bo_tin", "br_cnpj", "br_cpf", "bs_tin", "by_tin", "ca_bn", "ca_gst_hst", "ca_pst_bc", "ca_pst_mb", "ca_pst_sk", "ca_qst", "cd_nif", "ch_uid", "ch_vat", "cl_tin", "cm_niu", "cn_tin", "co_nit", "cr_tin", "cv_nif", "de_stn", "do_rcn", "ec_ruc", "eg_tin", "es_cif", "et_tin", "eu_oss_vat", "eu_vat", "gb_vat", "ge_vat", "gn_nif", "hk_br", "hr_oib", "hu_tin", "id_npwp", "il_vat", "in_gst", "is_vat", "jp_cn", "jp_rn", "jp_trn", "ke_pin", "kg_tin", "kh_tin", "kr_brn", "kz_bin", "la_tin", "li_uid", "li_vat", "ma_vat", "md_vat", "me_pib", "mk_vat", "mr_nif", "mx_rfc", "my_frp", "my_itn", "my_sst", "ng_tin", "no_vat", "no_voec", "np_pan", "nz_gst", "om_vat", "pe_ruc", "ph_tin", "ro_tin", "rs_pib", "ru_inn", "ru_kpp", "sa_vat", "sg_gst", "sg_uen", "si_tin", "sn_ninea", "sr_fin", "sv_nit", "th_vat", "tj_tin", "tr_tin", "tw_vat", "tz_vat", "ua_vat", "ug_tin", "us_ein", "uy_ruc", "uz_tin", "uz_vat", "ve_rif", "vn_tin", "za_vat", "zm_tin", "zw_tin" ], "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true }, "value": { "description": "Value of the tax ID.", "type": "string" } }, "required": [ "type", "value" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax_id" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a Customer tax ID" } }, "/v1/customers/{customer}/tax_ids/{id}": { "delete": { "description": "

Deletes an existing tax_id object.

", "operationId": "DeleteCustomersCustomerTaxIdsId", "parameters": [ { "in": "path", "name": "customer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted_tax_id" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Delete a Customer tax ID" }, "get": { "description": "

Retrieves the tax_id object with the given identifier.

", "operationId": "GetCustomersCustomerTaxIdsId", "parameters": [ { "in": "path", "name": "customer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax_id" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a Customer tax ID" } }, "/v1/disputes": { "get": { "description": "

Returns a list of your disputes.

", "operationId": "GetDisputes", "parameters": [ { "description": "Only return disputes associated to the charge specified by this charge ID.", "in": "query", "name": "charge", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Only return disputes that were created during the given date interval.", "explode": true, "in": "query", "name": "created", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "type": "integer" }, "gte": { "type": "integer" }, "lt": { "type": "integer" }, "lte": { "type": "integer" } }, "title": "range_query_specs", "type": "object" }, { "type": "integer" } ] }, "style": "deepObject" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "Only return disputes associated to the PaymentIntent specified by this PaymentIntent ID.", "in": "query", "name": "payment_intent", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/dispute" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/disputes", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "DisputeList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all disputes" } }, "/v1/disputes/{dispute}": { "get": { "description": "

Retrieves the dispute with the given ID.

", "operationId": "GetDisputesDispute", "parameters": [ { "in": "path", "name": "dispute", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dispute" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a dispute" }, "post": { "description": "

When you get a dispute, contacting your customer is always the best first step. If that doesn’t work, you can submit evidence to help us resolve the dispute in your favor. You can do this in your dashboard, but if you prefer, you can use the API to submit evidence programmatically.

\n\n

Depending on your dispute type, different evidence fields will give you a better chance of winning your dispute. To figure out which evidence fields to provide, see our guide to dispute types.

", "operationId": "PostDisputesDispute", "parameters": [ { "in": "path", "name": "dispute", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "evidence": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "evidence": { "description": "Evidence to upload, to respond to a dispute. Updating any field in the hash will submit all fields in the hash for review. The combined character count of all fields is limited to 150,000.", "properties": { "access_activity_log": { "maxLength": 20000, "type": "string" }, "billing_address": { "maxLength": 5000, "type": "string" }, "cancellation_policy": { "type": "string" }, "cancellation_policy_disclosure": { "maxLength": 20000, "type": "string" }, "cancellation_rebuttal": { "maxLength": 20000, "type": "string" }, "customer_communication": { "type": "string" }, "customer_email_address": { "maxLength": 5000, "type": "string" }, "customer_name": { "maxLength": 5000, "type": "string" }, "customer_purchase_ip": { "maxLength": 5000, "type": "string" }, "customer_signature": { "type": "string" }, "duplicate_charge_documentation": { "type": "string" }, "duplicate_charge_explanation": { "maxLength": 20000, "type": "string" }, "duplicate_charge_id": { "maxLength": 5000, "type": "string" }, "enhanced_evidence": { "anyOf": [ { "properties": { "visa_compelling_evidence_3": { "properties": { "disputed_transaction": { "properties": { "customer_account_id": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "customer_device_fingerprint": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "customer_device_id": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "customer_email_address": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "customer_purchase_ip": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "merchandise_or_services": { "enum": [ "merchandise", "services" ], "type": "string" }, "product_description": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "shipping_address": { "properties": { "city": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "country": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "line1": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "line2": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "postal_code": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "state": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "shipping_address", "type": "object" } }, "title": "visa_compelling_evidence3_disputed_transaction", "type": "object" }, "prior_undisputed_transactions": { "items": { "properties": { "charge": { "maxLength": 5000, "type": "string" }, "customer_account_id": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "customer_device_fingerprint": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "customer_device_id": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "customer_email_address": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "customer_purchase_ip": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "product_description": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "shipping_address": { "properties": { "city": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "country": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "line1": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "line2": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "postal_code": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "state": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "shipping_address", "type": "object" } }, "required": [ "charge" ], "title": "visa_compelling_evidence3_prior_undisputed_transaction", "type": "object" }, "type": "array" } }, "title": "visa_compelling_evidence3", "type": "object" }, "visa_compliance": { "properties": { "fee_acknowledged": { "type": "boolean" } }, "title": "visa_compliance", "type": "object" } }, "title": "enhanced_evidence", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "product_description": { "maxLength": 20000, "type": "string" }, "receipt": { "type": "string" }, "refund_policy": { "type": "string" }, "refund_policy_disclosure": { "maxLength": 20000, "type": "string" }, "refund_refusal_explanation": { "maxLength": 20000, "type": "string" }, "service_date": { "maxLength": 5000, "type": "string" }, "service_documentation": { "type": "string" }, "shipping_address": { "maxLength": 5000, "type": "string" }, "shipping_carrier": { "maxLength": 5000, "type": "string" }, "shipping_date": { "maxLength": 5000, "type": "string" }, "shipping_documentation": { "type": "string" }, "shipping_tracking_number": { "maxLength": 5000, "type": "string" }, "uncategorized_file": { "type": "string" }, "uncategorized_text": { "maxLength": 20000, "type": "string" } }, "title": "dispute_evidence_params", "type": "object" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "submit": { "description": "Whether to immediately submit evidence to the bank. If `false`, evidence is staged on the dispute. Staged evidence is visible in the API and Dashboard, and can be submitted to the bank by making another request with this attribute set to `true` (the default).", "type": "boolean" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dispute" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a dispute" } }, "/v1/disputes/{dispute}/close": { "post": { "description": "

Closing the dispute for a charge indicates that you do not have any evidence to submit and are essentially dismissing the dispute, acknowledging it as lost.

\n\n

The status of the dispute will change from needs_response to lost. Closing a dispute is irreversible.

", "operationId": "PostDisputesDisputeClose", "parameters": [ { "in": "path", "name": "dispute", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dispute" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Close a dispute" } }, "/v1/entitlements/active_entitlements": { "get": { "description": "

Retrieve a list of active entitlements for a customer

", "operationId": "GetEntitlementsActiveEntitlements", "parameters": [ { "description": "The ID of the customer.", "in": "query", "name": "customer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/entitlements.active_entitlement" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "EntitlementsResourceCustomerEntitlementList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all active entitlements" } }, "/v1/entitlements/active_entitlements/{id}": { "get": { "description": "

Retrieve an active entitlement

", "operationId": "GetEntitlementsActiveEntitlementsId", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "The ID of the entitlement.", "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/entitlements.active_entitlement" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve an active entitlement" } }, "/v1/entitlements/features": { "get": { "description": "

Retrieve a list of features

", "operationId": "GetEntitlementsFeatures", "parameters": [ { "description": "If set, filter results to only include features with the given archive status.", "in": "query", "name": "archived", "required": false, "schema": { "type": "boolean" }, "style": "form" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "If set, filter results to only include features with the given lookup_key.", "in": "query", "name": "lookup_key", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/entitlements.feature" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/entitlements/features", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "EntitlementsResourceFeatureList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all features" }, "post": { "description": "

Creates a feature

", "operationId": "PostEntitlementsFeatures", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "lookup_key": { "description": "A unique key you provide as your own system identifier. This may be up to 80 characters.", "maxLength": 80, "type": "string" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "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.", "type": "object" }, "name": { "description": "The feature's name, for your own purpose, not meant to be displayable to the customer.", "maxLength": 80, "type": "string" } }, "required": [ "lookup_key", "name" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/entitlements.feature" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a feature" } }, "/v1/entitlements/features/{id}": { "get": { "description": "

Retrieves a feature

", "operationId": "GetEntitlementsFeaturesId", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "The ID of the feature.", "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/entitlements.feature" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a feature" }, "post": { "description": "

Update a feature’s metadata or permanently deactivate it.

", "operationId": "PostEntitlementsFeaturesId", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "active": { "description": "Inactive features cannot be attached to new products and will not be returned from the features list endpoint.", "type": "boolean" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "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." }, "name": { "description": "The feature's name, for your own purpose, not meant to be displayable to the customer.", "maxLength": 80, "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/entitlements.feature" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Updates a feature" } }, "/v1/ephemeral_keys": { "post": { "description": "

Creates a short-lived API key for a given resource.

", "operationId": "PostEphemeralKeys", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "customer": { "description": "The ID of the Customer you'd like to modify using the resulting ephemeral key.", "maxLength": 5000, "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "issuing_card": { "description": "The ID of the Issuing Card you'd like to access using the resulting ephemeral key.", "maxLength": 5000, "type": "string" }, "nonce": { "description": "A single-use token, created by Stripe.js, used for creating ephemeral keys for Issuing Cards without exchanging sensitive information.", "maxLength": 5000, "type": "string" }, "verification_session": { "description": "The ID of the Identity VerificationSession you'd like to access using the resulting ephemeral key", "maxLength": 5000, "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ephemeral_key" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create an ephemeral key" } }, "/v1/ephemeral_keys/{key}": { "delete": { "description": "

Invalidates a short-lived API key for a given resource.

", "operationId": "DeleteEphemeralKeysKey", "parameters": [ { "in": "path", "name": "key", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ephemeral_key" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Immediately invalidate an ephemeral key" } }, "/v1/events": { "get": { "description": "

List events, going back up to 30 days. Each event data is rendered according to Stripe API version at its creation time, specified in event object api_version attribute (not according to your current Stripe API version or Stripe-Version header).

", "operationId": "GetEvents", "parameters": [ { "description": "Only return events that were created during the given date interval.", "explode": true, "in": "query", "name": "created", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "type": "integer" }, "gte": { "type": "integer" }, "lt": { "type": "integer" }, "lte": { "type": "integer" } }, "title": "range_query_specs", "type": "object" }, { "type": "integer" } ] }, "style": "deepObject" }, { "description": "Filter events by whether all webhooks were successfully delivered. If false, events which are still pending or have failed all delivery attempts to a webhook endpoint will be returned.", "in": "query", "name": "delivery_success", "required": false, "schema": { "type": "boolean" }, "style": "form" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "A string containing a specific event name, or group of events using * as a wildcard. The list will be filtered to include only events with a matching event property.", "in": "query", "name": "type", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "An array of up to 20 strings containing specific event names. The list will be filtered to include only events with a matching event property. You may pass either `type` or `types`, but not both.", "explode": true, "in": "query", "name": "types", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/event" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/events", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "NotificationEventList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all events" } }, "/v1/events/{id}": { "get": { "description": "

Retrieves the details of an event if it was created in the last 30 days. Supply the unique identifier of the event, which you might have received in a webhook.

", "operationId": "GetEventsId", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/event" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve an event" } }, "/v1/exchange_rates": { "get": { "description": "

Returns a list of objects that contain the rates at which foreign currencies are converted to one another. Only shows the currencies for which Stripe supports.

", "operationId": "GetExchangeRates", "parameters": [ { "description": "A cursor for use in pagination. `ending_before` is the currency that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with the exchange rate for currency X your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and total number of supported payout currencies, and the default is the max.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "A cursor for use in pagination. `starting_after` is the currency that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with the exchange rate for currency X, your subsequent call can include `starting_after=X` in order to fetch the next page of the list.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/exchange_rate" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/exchange_rates", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "ExchangeRateList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all exchange rates" } }, "/v1/exchange_rates/{rate_id}": { "get": { "description": "

Retrieves the exchange rates from the given currency to every supported currency.

", "operationId": "GetExchangeRatesRateId", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "rate_id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/exchange_rate" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve an exchange rate" } }, "/v1/external_accounts/{id}": { "post": { "description": "

Updates the metadata, account holder name, account holder type of a bank account belonging to\na connected account and optionally sets it as the default for its currency. Other bank account\ndetails are not editable by design.

\n\n

You can only update bank accounts when account.controller.requirement_collection is application, which includes Custom accounts.

\n\n

You can re-enable a disabled bank account by performing an update call without providing any\narguments or changes.

", "operationId": "PostExternalAccountsId", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "documents": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "account_holder_name": { "description": "The name of the person or business that owns the bank account.", "maxLength": 5000, "type": "string" }, "account_holder_type": { "description": "The type of entity that holds the account. This can be either `individual` or `company`.", "enum": [ "", "company", "individual" ], "maxLength": 5000, "type": "string" }, "account_type": { "description": "The bank account type. This can only be `checking` or `savings` in most countries. In Japan, this can only be `futsu` or `toza`.", "enum": [ "checking", "futsu", "savings", "toza" ], "maxLength": 5000, "type": "string" }, "address_city": { "description": "City/District/Suburb/Town/Village.", "maxLength": 5000, "type": "string" }, "address_country": { "description": "Billing address country, if provided when creating card.", "maxLength": 5000, "type": "string" }, "address_line1": { "description": "Address line 1 (Street address/PO Box/Company name).", "maxLength": 5000, "type": "string" }, "address_line2": { "description": "Address line 2 (Apartment/Suite/Unit/Building).", "maxLength": 5000, "type": "string" }, "address_state": { "description": "State/County/Province/Region.", "maxLength": 5000, "type": "string" }, "address_zip": { "description": "ZIP or postal code.", "maxLength": 5000, "type": "string" }, "default_for_currency": { "description": "When set to true, this becomes the default external account for its currency.", "type": "boolean" }, "documents": { "description": "Documents that may be submitted to satisfy various informational requests.", "properties": { "bank_account_ownership_verification": { "properties": { "files": { "items": { "maxLength": 500, "type": "string" }, "type": "array" } }, "title": "documents_param", "type": "object" } }, "title": "external_account_documents_param", "type": "object" }, "exp_month": { "description": "Two digit number representing the card’s expiration month.", "maxLength": 5000, "type": "string" }, "exp_year": { "description": "Four digit number representing the card’s expiration year.", "maxLength": 5000, "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "name": { "description": "Cardholder name.", "maxLength": 5000, "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/external_account" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } } } }, "/v1/file_links": { "get": { "description": "

Returns a list of file links.

", "operationId": "GetFileLinks", "parameters": [ { "description": "Only return links that were created during the given date interval.", "explode": true, "in": "query", "name": "created", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "type": "integer" }, "gte": { "type": "integer" }, "lt": { "type": "integer" }, "lte": { "type": "integer" } }, "title": "range_query_specs", "type": "object" }, { "type": "integer" } ] }, "style": "deepObject" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "Filter links by their expiration status. By default, Stripe returns all links.", "in": "query", "name": "expired", "required": false, "schema": { "type": "boolean" }, "style": "form" }, { "description": "Only return links for the given file.", "in": "query", "name": "file", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/file_link" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/file_links", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "FileResourceFileLinkList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all file links" }, "post": { "description": "

Creates a new file link object.

", "operationId": "PostFileLinks", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "expires_at": { "description": "The link isn't usable after this future timestamp.", "format": "unix-time", "type": "integer" }, "file": { "description": "The ID of the file. The file's `purpose` must be one of the following: `business_icon`, `business_logo`, `customer_signature`, `dispute_evidence`, `finance_report_run`, `financial_account_statement`, `identity_document_downloadable`, `issuing_regulatory_reporting`, `pci_document`, `selfie`, `sigma_scheduled_query`, `tax_document_user_upload`, `terminal_android_apk`, or `terminal_reader_splashscreen`.", "maxLength": 5000, "type": "string" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." } }, "required": [ "file" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/file_link" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a file link" } }, "/v1/file_links/{link}": { "get": { "description": "

Retrieves the file link with the given ID.

", "operationId": "GetFileLinksLink", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "link", "required": true, "schema": { "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/file_link" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a file link" }, "post": { "description": "

Updates an existing file link object. Expired links can no longer be updated.

", "operationId": "PostFileLinksLink", "parameters": [ { "in": "path", "name": "link", "required": true, "schema": { "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "expires_at": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "expires_at": { "anyOf": [ { "enum": [ "now" ], "maxLength": 5000, "type": "string" }, { "format": "unix-time", "type": "integer" }, { "enum": [ "" ], "type": "string" } ], "description": "A future timestamp after which the link will no longer be usable, or `now` to expire the link immediately." }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/file_link" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a file link" } }, "/v1/files": { "get": { "description": "

Returns a list of the files that your account has access to. Stripe sorts and returns the files by their creation dates, placing the most recently created files at the top.

", "operationId": "GetFiles", "parameters": [ { "description": "Only return files that were created during the given date interval.", "explode": true, "in": "query", "name": "created", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "type": "integer" }, "gte": { "type": "integer" }, "lt": { "type": "integer" }, "lte": { "type": "integer" } }, "title": "range_query_specs", "type": "object" }, { "type": "integer" } ] }, "style": "deepObject" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "Filter queries by the file purpose. If you don't provide a purpose, the queries return unfiltered files.", "in": "query", "name": "purpose", "required": false, "schema": { "enum": [ "account_requirement", "additional_verification", "business_icon", "business_logo", "customer_signature", "dispute_evidence", "document_provider_identity_document", "finance_report_run", "financial_account_statement", "identity_document", "identity_document_downloadable", "issuing_regulatory_reporting", "pci_document", "selfie", "sigma_scheduled_query", "tax_document_user_upload", "terminal_android_apk", "terminal_reader_splashscreen" ], "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/file" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/files", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "FileResourceFileList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all files" }, "post": { "description": "

To upload a file to Stripe, you need to send a request of type multipart/form-data. Include the file you want to upload in the request, and the parameters for creating a file.

\n\n

All of Stripe’s officially supported Client libraries support sending multipart/form-data.

", "operationId": "PostFiles", "requestBody": { "content": { "multipart/form-data": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "file_link_data": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "file": { "description": "A file to upload. Make sure that the specifications follow RFC 2388, which defines file transfers for the `multipart/form-data` protocol.", "format": "binary", "type": "string" }, "file_link_data": { "description": "Optional parameters that automatically create a [file link](https://stripe.com/docs/api#file_links) for the newly created file.", "properties": { "create": { "type": "boolean" }, "expires_at": { "format": "unix-time", "type": "integer" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ] } }, "required": [ "create" ], "title": "file_link_creation_params", "type": "object" }, "purpose": { "description": "The [purpose](https://stripe.com/docs/file-upload#uploading-a-file) of the uploaded file.", "enum": [ "account_requirement", "additional_verification", "business_icon", "business_logo", "customer_signature", "dispute_evidence", "identity_document", "issuing_regulatory_reporting", "pci_document", "tax_document_user_upload", "terminal_android_apk", "terminal_reader_splashscreen" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "file", "purpose" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/file" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "servers": [ { "url": "https://files.stripe.com/" } ], "summary": "Create a file" } }, "/v1/files/{file}": { "get": { "description": "

Retrieves the details of an existing file object. After you supply a unique file ID, Stripe returns the corresponding file object. Learn how to access file contents.

", "operationId": "GetFilesFile", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "file", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/file" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a file" } }, "/v1/financial_connections/accounts": { "get": { "description": "

Returns a list of Financial Connections Account objects.

", "operationId": "GetFinancialConnectionsAccounts", "parameters": [ { "description": "If present, only return accounts that belong to the specified account holder. `account_holder[customer]` and `account_holder[account]` are mutually exclusive.", "explode": true, "in": "query", "name": "account_holder", "required": false, "schema": { "properties": { "account": { "maxLength": 5000, "type": "string" }, "customer": { "maxLength": 5000, "type": "string" } }, "title": "accountholder_params", "type": "object" }, "style": "deepObject" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "If present, only return accounts that were collected as part of the given session.", "in": "query", "name": "session", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/financial_connections.account" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/financial_connections/accounts", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "BankConnectionsResourceLinkedAccountList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List Accounts" } }, "/v1/financial_connections/accounts/{account}": { "get": { "description": "

Retrieves the details of an Financial Connections Account.

", "operationId": "GetFinancialConnectionsAccountsAccount", "parameters": [ { "in": "path", "name": "account", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/financial_connections.account" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve an Account" } }, "/v1/financial_connections/accounts/{account}/disconnect": { "post": { "description": "

Disables your access to a Financial Connections Account. You will no longer be able to access data associated with the account (e.g. balances, transactions).

", "operationId": "PostFinancialConnectionsAccountsAccountDisconnect", "parameters": [ { "in": "path", "name": "account", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/financial_connections.account" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Disconnect an Account" } }, "/v1/financial_connections/accounts/{account}/owners": { "get": { "description": "

Lists all owners for a given Account

", "operationId": "GetFinancialConnectionsAccountsAccountOwners", "parameters": [ { "in": "path", "name": "account", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "The ID of the ownership object to fetch owners from.", "in": "query", "name": "ownership", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/financial_connections.account_owner" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "BankConnectionsResourceOwnerList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List Account Owners" } }, "/v1/financial_connections/accounts/{account}/refresh": { "post": { "description": "

Refreshes the data associated with a Financial Connections Account.

", "operationId": "PostFinancialConnectionsAccountsAccountRefresh", "parameters": [ { "in": "path", "name": "account", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "features": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "features": { "description": "The list of account features that you would like to refresh.", "items": { "enum": [ "balance", "ownership", "transactions" ], "type": "string", "x-stripeBypassValidation": true }, "type": "array" } }, "required": [ "features" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/financial_connections.account" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Refresh Account data" } }, "/v1/financial_connections/accounts/{account}/subscribe": { "post": { "description": "

Subscribes to periodic refreshes of data associated with a Financial Connections Account.

", "operationId": "PostFinancialConnectionsAccountsAccountSubscribe", "parameters": [ { "in": "path", "name": "account", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "features": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "features": { "description": "The list of account features to which you would like to subscribe.", "items": { "enum": [ "transactions" ], "type": "string", "x-stripeBypassValidation": true }, "type": "array" } }, "required": [ "features" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/financial_connections.account" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Subscribe to data refreshes for an Account" } }, "/v1/financial_connections/accounts/{account}/unsubscribe": { "post": { "description": "

Unsubscribes from periodic refreshes of data associated with a Financial Connections Account.

", "operationId": "PostFinancialConnectionsAccountsAccountUnsubscribe", "parameters": [ { "in": "path", "name": "account", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "features": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "features": { "description": "The list of account features from which you would like to unsubscribe.", "items": { "enum": [ "transactions" ], "type": "string", "x-stripeBypassValidation": true }, "type": "array" } }, "required": [ "features" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/financial_connections.account" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Unsubscribe from data refreshes for an Account" } }, "/v1/financial_connections/sessions": { "post": { "description": "

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.

", "operationId": "PostFinancialConnectionsSessions", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "account_holder": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "filters": { "explode": true, "style": "deepObject" }, "permissions": { "explode": true, "style": "deepObject" }, "prefetch": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "account_holder": { "description": "The account holder to link accounts for.", "properties": { "account": { "maxLength": 5000, "type": "string" }, "customer": { "maxLength": 5000, "type": "string" }, "type": { "enum": [ "account", "customer" ], "type": "string" } }, "required": [ "type" ], "title": "accountholder_params", "type": "object" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "filters": { "description": "Filters to restrict the kinds of accounts to collect.", "properties": { "account_subcategories": { "items": { "enum": [ "checking", "credit_card", "line_of_credit", "mortgage", "savings" ], "type": "string" }, "type": "array" }, "countries": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "title": "filters_params", "type": "object" }, "permissions": { "description": "List of data features that you would like to request access to.\n\nPossible values are `balances`, `transactions`, `ownership`, and `payment_method`.", "items": { "enum": [ "balances", "ownership", "payment_method", "transactions" ], "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true }, "type": "array" }, "prefetch": { "description": "List of data features that you would like to retrieve upon account creation.", "items": { "enum": [ "balances", "ownership", "transactions" ], "type": "string", "x-stripeBypassValidation": true }, "type": "array" }, "return_url": { "description": "For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.", "maxLength": 5000, "type": "string" } }, "required": [ "account_holder", "permissions" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/financial_connections.session" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a Session" } }, "/v1/financial_connections/sessions/{session}": { "get": { "description": "

Retrieves the details of a Financial Connections Session

", "operationId": "GetFinancialConnectionsSessionsSession", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "session", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/financial_connections.session" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a Session" } }, "/v1/financial_connections/transactions": { "get": { "description": "

Returns a list of Financial Connections Transaction objects.

", "operationId": "GetFinancialConnectionsTransactions", "parameters": [ { "description": "The ID of the Financial Connections Account whose transactions will be retrieved.", "in": "query", "name": "account", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "A filter on the list based on the object `transacted_at` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with the following options:", "explode": true, "in": "query", "name": "transacted_at", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "type": "integer" }, "gte": { "type": "integer" }, "lt": { "type": "integer" }, "lte": { "type": "integer" } }, "title": "range_query_specs", "type": "object" }, { "type": "integer" } ] }, "style": "deepObject" }, { "description": "A filter on the list based on the object `transaction_refresh` field. The value can be a dictionary with the following options:", "explode": true, "in": "query", "name": "transaction_refresh", "required": false, "schema": { "properties": { "after": { "maxLength": 5000, "type": "string" } }, "required": [ "after" ], "title": "transaction_refresh_params", "type": "object" }, "style": "deepObject" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/financial_connections.transaction" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/financial_connections/transactions", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "BankConnectionsResourceTransactionList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List Transactions" } }, "/v1/financial_connections/transactions/{transaction}": { "get": { "description": "

Retrieves the details of a Financial Connections Transaction

", "operationId": "GetFinancialConnectionsTransactionsTransaction", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "transaction", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/financial_connections.transaction" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a Transaction" } }, "/v1/forwarding/requests": { "get": { "description": "

Lists all ForwardingRequest objects.

", "operationId": "GetForwardingRequests", "parameters": [ { "description": "Similar to other List endpoints, filters results based on created timestamp. You can pass gt, gte, lt, and lte timestamp values.", "explode": true, "in": "query", "name": "created", "required": false, "schema": { "properties": { "gt": { "type": "integer" }, "gte": { "type": "integer" }, "lt": { "type": "integer" }, "lte": { "type": "integer" } }, "title": "created_param", "type": "object" }, "style": "deepObject" }, { "description": "A pagination cursor to fetch the previous page of the list. The value must be a ForwardingRequest ID.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "A pagination cursor to fetch the next page of the list. The value must be a ForwardingRequest ID.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "List of ForwardingRequest data.", "properties": { "data": { "items": { "$ref": "#/components/schemas/forwarding.request" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "ForwardingRequestList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all ForwardingRequests" }, "post": { "description": "

Creates a ForwardingRequest object.

", "operationId": "PostForwardingRequests", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "replacements": { "explode": true, "style": "deepObject" }, "request": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "payment_method": { "description": "The PaymentMethod to insert into the forwarded request. Forwarding previously consumed PaymentMethods is allowed.", "maxLength": 5000, "type": "string" }, "replacements": { "description": "The field kinds to be replaced in the forwarded request.", "items": { "enum": [ "card_cvc", "card_expiry", "card_number", "cardholder_name", "request_signature" ], "type": "string", "x-stripeBypassValidation": true }, "type": "array" }, "request": { "description": "The request body and headers to be sent to the destination endpoint.", "properties": { "body": { "maxLength": 5000, "type": "string" }, "headers": { "items": { "properties": { "name": { "maxLength": 5000, "type": "string" }, "value": { "maxLength": 5000, "type": "string" } }, "required": [ "name", "value" ], "title": "header_param", "type": "object" }, "type": "array" } }, "title": "request_param", "type": "object" }, "url": { "description": "The destination URL for the forwarded request. Must be supported by the config.", "maxLength": 5000, "type": "string" } }, "required": [ "payment_method", "replacements", "url" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forwarding.request" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a ForwardingRequest" } }, "/v1/forwarding/requests/{id}": { "get": { "description": "

Retrieves a ForwardingRequest object.

", "operationId": "GetForwardingRequestsId", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forwarding.request" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a ForwardingRequest" } }, "/v1/identity/verification_reports": { "get": { "description": "

List all verification reports.

", "operationId": "GetIdentityVerificationReports", "parameters": [ { "description": "A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems.", "in": "query", "name": "client_reference_id", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Only return VerificationReports that were created during the given date interval.", "explode": true, "in": "query", "name": "created", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "type": "integer" }, "gte": { "type": "integer" }, "lt": { "type": "integer" }, "lte": { "type": "integer" } }, "title": "range_query_specs", "type": "object" }, { "type": "integer" } ] }, "style": "deepObject" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Only return VerificationReports of this type", "in": "query", "name": "type", "required": false, "schema": { "enum": [ "document", "id_number" ], "type": "string", "x-stripeBypassValidation": true }, "style": "form" }, { "description": "Only return VerificationReports created by this VerificationSession ID. It is allowed to provide a VerificationIntent ID.", "in": "query", "name": "verification_session", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/identity.verification_report" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/identity/verification_reports", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "GelatoVerificationReportList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List VerificationReports" } }, "/v1/identity/verification_reports/{report}": { "get": { "description": "

Retrieves an existing VerificationReport

", "operationId": "GetIdentityVerificationReportsReport", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "report", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/identity.verification_report" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a VerificationReport" } }, "/v1/identity/verification_sessions": { "get": { "description": "

Returns a list of VerificationSessions

", "operationId": "GetIdentityVerificationSessions", "parameters": [ { "description": "A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems.", "in": "query", "name": "client_reference_id", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Only return VerificationSessions that were created during the given date interval.", "explode": true, "in": "query", "name": "created", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "type": "integer" }, "gte": { "type": "integer" }, "lt": { "type": "integer" }, "lte": { "type": "integer" } }, "title": "range_query_specs", "type": "object" }, { "type": "integer" } ] }, "style": "deepObject" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "in": "query", "name": "related_customer", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Only return VerificationSessions with this status. [Learn more about the lifecycle of sessions](https://stripe.com/docs/identity/how-sessions-work).", "in": "query", "name": "status", "required": false, "schema": { "enum": [ "canceled", "processing", "requires_input", "verified" ], "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/identity.verification_session" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/identity/verification_sessions", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "GelatoVerificationSessionList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List VerificationSessions" }, "post": { "description": "

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

", "operationId": "PostIdentityVerificationSessions", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "options": { "explode": true, "style": "deepObject" }, "provided_details": { "explode": true, "style": "deepObject" }, "related_person": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "client_reference_id": { "description": "A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems.", "maxLength": 5000, "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "options": { "description": "A set of options for the session’s verification checks.", "properties": { "document": { "anyOf": [ { "properties": { "allowed_types": { "items": { "enum": [ "driving_license", "id_card", "passport" ], "type": "string" }, "type": "array" }, "require_id_number": { "type": "boolean" }, "require_live_capture": { "type": "boolean" }, "require_matching_selfie": { "type": "boolean" } }, "title": "document_options", "type": "object" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "session_options_param", "type": "object" }, "provided_details": { "description": "Details provided about the user being verified. These details may be shown to the user.", "properties": { "email": { "type": "string" }, "phone": { "type": "string" } }, "title": "provided_details_param", "type": "object" }, "related_customer": { "description": "Customer ID", "maxLength": 5000, "type": "string" }, "related_person": { "description": "Tokens referencing a Person resource and it's associated account.", "properties": { "account": { "maxLength": 5000, "type": "string" }, "person": { "maxLength": 5000, "type": "string" } }, "required": [ "account", "person" ], "title": "related_person_param", "type": "object" }, "return_url": { "description": "The URL that the user will be redirected to upon completing the verification flow.", "type": "string" }, "type": { "description": "The type of [verification check](https://stripe.com/docs/identity/verification-checks) to be performed. You must provide a `type` if not passing `verification_flow`.", "enum": [ "document", "id_number" ], "type": "string", "x-stripeBypassValidation": true }, "verification_flow": { "description": "The ID of a verification flow from the Dashboard. See https://docs.stripe.com/identity/verification-flows.", "maxLength": 5000, "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/identity.verification_session" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a VerificationSession" } }, "/v1/identity/verification_sessions/{session}": { "get": { "description": "

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.

", "operationId": "GetIdentityVerificationSessionsSession", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "session", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/identity.verification_session" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a VerificationSession" }, "post": { "description": "

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.

", "operationId": "PostIdentityVerificationSessionsSession", "parameters": [ { "in": "path", "name": "session", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "options": { "explode": true, "style": "deepObject" }, "provided_details": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "options": { "description": "A set of options for the session’s verification checks.", "properties": { "document": { "anyOf": [ { "properties": { "allowed_types": { "items": { "enum": [ "driving_license", "id_card", "passport" ], "type": "string" }, "type": "array" }, "require_id_number": { "type": "boolean" }, "require_live_capture": { "type": "boolean" }, "require_matching_selfie": { "type": "boolean" } }, "title": "document_options", "type": "object" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "session_options_param", "type": "object" }, "provided_details": { "description": "Details provided about the user being verified. These details may be shown to the user.", "properties": { "email": { "type": "string" }, "phone": { "type": "string" } }, "title": "provided_details_param", "type": "object" }, "type": { "description": "The type of [verification check](https://stripe.com/docs/identity/verification-checks) to be performed.", "enum": [ "document", "id_number" ], "type": "string", "x-stripeBypassValidation": true } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/identity.verification_session" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a VerificationSession" } }, "/v1/identity/verification_sessions/{session}/cancel": { "post": { "description": "

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.

", "operationId": "PostIdentityVerificationSessionsSessionCancel", "parameters": [ { "in": "path", "name": "session", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/identity.verification_session" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Cancel a VerificationSession" } }, "/v1/identity/verification_sessions/{session}/redact": { "post": { "description": "

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 redaction process may take up to four days. When the redaction process is in progress, the\nVerificationSession’s redaction.status field will be set to processing; when the process is\nfinished, it will change to redacted and an identity.verification_session.redacted event\nwill be emitted.

\n\n

Redaction is irreversible. Redacted objects are still accessible in the Stripe API, but all the\nfields that contain personal data will be replaced by the string [redacted] or a similar\nplaceholder. The metadata field will also be erased. Redacted objects cannot be updated or\nused for any purpose.

\n\n

Learn more.

", "operationId": "PostIdentityVerificationSessionsSessionRedact", "parameters": [ { "in": "path", "name": "session", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/identity.verification_session" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Redact a VerificationSession" } }, "/v1/invoice_payments": { "get": { "description": "

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

", "operationId": "GetInvoicePayments", "parameters": [ { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "The identifier of the invoice whose payments to return.", "in": "query", "name": "invoice", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "The payment details of the invoice payments to return.", "explode": true, "in": "query", "name": "payment", "required": false, "schema": { "properties": { "payment_intent": { "maxLength": 5000, "type": "string" }, "type": { "enum": [ "payment_intent" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "payment_param", "type": "object" }, "style": "deepObject" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "The status of the invoice payments to return.", "in": "query", "name": "status", "required": false, "schema": { "enum": [ "canceled", "open", "paid" ], "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/invoice_payment" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "InvoicesPaymentsListInvoicePayments", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all payments for an invoice" } }, "/v1/invoice_payments/{invoice_payment}": { "get": { "description": "

Retrieves the invoice payment with the given ID.

", "operationId": "GetInvoicePaymentsInvoicePayment", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "invoice_payment", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/invoice_payment" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve an InvoicePayment" } }, "/v1/invoice_rendering_templates": { "get": { "description": "

List all templates, ordered by creation date, with the most recently created template appearing first.

", "operationId": "GetInvoiceRenderingTemplates", "parameters": [ { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "in": "query", "name": "status", "required": false, "schema": { "enum": [ "active", "archived" ], "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/invoice_rendering_template" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "InvoiceRenderingTemplatesList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all invoice rendering templates" } }, "/v1/invoice_rendering_templates/{template}": { "get": { "description": "

Retrieves an invoice rendering template with the given ID. It by default returns the latest version of the template. Optionally, specify a version to see previous versions.

", "operationId": "GetInvoiceRenderingTemplatesTemplate", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "template", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "in": "query", "name": "version", "required": false, "schema": { "type": "integer" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/invoice_rendering_template" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve an invoice rendering template" } }, "/v1/invoice_rendering_templates/{template}/archive": { "post": { "description": "

Updates the status of an invoice rendering template to ‘archived’ so no new Stripe objects (customers, invoices, etc.) can reference it. The template can also no longer be updated. However, if the template is already set on a Stripe object, it will continue to be applied on invoices generated by it.

", "operationId": "PostInvoiceRenderingTemplatesTemplateArchive", "parameters": [ { "in": "path", "name": "template", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/invoice_rendering_template" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Archive an invoice rendering template" } }, "/v1/invoice_rendering_templates/{template}/unarchive": { "post": { "description": "

Unarchive an invoice rendering template so it can be used on new Stripe objects again.

", "operationId": "PostInvoiceRenderingTemplatesTemplateUnarchive", "parameters": [ { "in": "path", "name": "template", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/invoice_rendering_template" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Unarchive an invoice rendering template" } }, "/v1/invoiceitems": { "get": { "description": "

Returns a list of your invoice items. Invoice items are returned sorted by creation date, with the most recently created invoice items appearing first.

", "operationId": "GetInvoiceitems", "parameters": [ { "description": "Only return invoice items that were created during the given date interval.", "explode": true, "in": "query", "name": "created", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "type": "integer" }, "gte": { "type": "integer" }, "lt": { "type": "integer" }, "lte": { "type": "integer" } }, "title": "range_query_specs", "type": "object" }, { "type": "integer" } ] }, "style": "deepObject" }, { "description": "The identifier of the customer whose invoice items to return. If none is provided, all invoice items will be returned.", "in": "query", "name": "customer", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "Only return invoice items belonging to this invoice. If none is provided, all invoice items will be returned. If specifying an invoice, no customer identifier is needed.", "in": "query", "name": "invoice", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "Set to `true` to only show pending invoice items, which are not yet attached to any invoices. Set to `false` to only show invoice items already attached to invoices. If unspecified, no filter is applied.", "in": "query", "name": "pending", "required": false, "schema": { "type": "boolean" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/invoiceitem" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/invoiceitems", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "InvoicesItemsList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all invoice items" }, "post": { "description": "

Creates an item to be added to a draft invoice (up to 250 items per invoice). If no invoice is specified, the item will be on the next invoice created for the customer specified.

", "operationId": "PostInvoiceitems", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "discounts": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "period": { "explode": true, "style": "deepObject" }, "price_data": { "explode": true, "style": "deepObject" }, "pricing": { "explode": true, "style": "deepObject" }, "tax_code": { "explode": true, "style": "deepObject" }, "tax_rates": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "amount": { "description": "The integer amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. Passing in a negative `amount` will reduce the `amount_due` on the invoice.", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "customer": { "description": "The ID of the customer who will be billed when this invoice item is billed.", "maxLength": 5000, "type": "string" }, "description": { "description": "An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking.", "maxLength": 5000, "type": "string" }, "discountable": { "description": "Controls whether discounts apply to this invoice item. Defaults to false for prorations or negative invoice items, and true for all other invoice items.", "type": "boolean" }, "discounts": { "anyOf": [ { "items": { "properties": { "coupon": { "maxLength": 5000, "type": "string" }, "discount": { "maxLength": 5000, "type": "string" }, "promotion_code": { "maxLength": 5000, "type": "string" } }, "title": "discounts_data_param", "type": "object" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The coupons and promotion codes to redeem into discounts for the invoice item or invoice line item." }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "invoice": { "description": "The ID of an existing invoice to add this invoice item to. For subscription invoices, when left blank, the invoice item will be added to the next upcoming scheduled invoice. For standalone invoices, the invoice item won't be automatically added unless you pass `pending_invoice_item_behavior: 'include'` when creating the invoice. This is useful when adding invoice items in response to an invoice.created webhook. You can only add invoice items to draft invoices and there is a maximum of 250 items per invoice.", "maxLength": 5000, "type": "string" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "period": { "description": "The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details.", "properties": { "end": { "format": "unix-time", "type": "integer" }, "start": { "format": "unix-time", "type": "integer" } }, "required": [ "end", "start" ], "title": "period", "type": "object" }, "price_data": { "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.", "properties": { "currency": { "format": "currency", "type": "string" }, "product": { "maxLength": 5000, "type": "string" }, "tax_behavior": { "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" }, "unit_amount": { "type": "integer" }, "unit_amount_decimal": { "format": "decimal", "type": "string" } }, "required": [ "currency", "product" ], "title": "one_time_price_data", "type": "object" }, "pricing": { "description": "The pricing information for the invoice item.", "properties": { "price": { "maxLength": 5000, "type": "string" } }, "title": "pricing_param", "type": "object" }, "quantity": { "description": "Non-negative integer. The quantity of units for the invoice item.", "type": "integer" }, "subscription": { "description": "The ID of a subscription to add this invoice item to. When left blank, the invoice item is added to the next upcoming scheduled invoice. When set, scheduled invoices for subscriptions other than the specified subscription will ignore the invoice item. Use this when you want to express that an invoice item has been accrued within the context of a particular subscription.", "maxLength": 5000, "type": "string" }, "tax_behavior": { "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.", "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" }, "tax_code": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "A [tax code](https://stripe.com/docs/tax/tax-categories) ID." }, "tax_rates": { "description": "The tax rates which apply to the invoice item. When set, the `default_tax_rates` on the invoice do not apply to this invoice item.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "unit_amount_decimal": { "description": "The decimal unit amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. This `unit_amount_decimal` will be multiplied by the quantity to get the full amount. Passing in a negative `unit_amount_decimal` will reduce the `amount_due` on the invoice. Accepts at most 12 decimal places.", "format": "decimal", "type": "string" } }, "required": [ "customer" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/invoiceitem" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create an invoice item" } }, "/v1/invoiceitems/{invoiceitem}": { "delete": { "description": "

Deletes an invoice item, removing it from an invoice. Deleting invoice items is only possible when they’re not attached to invoices, or if it’s attached to a draft invoice.

", "operationId": "DeleteInvoiceitemsInvoiceitem", "parameters": [ { "in": "path", "name": "invoiceitem", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted_invoiceitem" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Delete an invoice item" }, "get": { "description": "

Retrieves the invoice item with the given ID.

", "operationId": "GetInvoiceitemsInvoiceitem", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "invoiceitem", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/invoiceitem" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve an invoice item" }, "post": { "description": "

Updates the amount or description of an invoice item on an upcoming invoice. Updating an invoice item is only possible before the invoice it’s attached to is closed.

", "operationId": "PostInvoiceitemsInvoiceitem", "parameters": [ { "in": "path", "name": "invoiceitem", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "discounts": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "period": { "explode": true, "style": "deepObject" }, "price_data": { "explode": true, "style": "deepObject" }, "pricing": { "explode": true, "style": "deepObject" }, "tax_code": { "explode": true, "style": "deepObject" }, "tax_rates": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "amount": { "description": "The integer amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. If you want to apply a credit to the customer's account, pass a negative amount.", "type": "integer" }, "description": { "description": "An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking.", "maxLength": 5000, "type": "string" }, "discountable": { "description": "Controls whether discounts apply to this invoice item. Defaults to false for prorations or negative invoice items, and true for all other invoice items. Cannot be set to true for prorations.", "type": "boolean" }, "discounts": { "anyOf": [ { "items": { "properties": { "coupon": { "maxLength": 5000, "type": "string" }, "discount": { "maxLength": 5000, "type": "string" }, "promotion_code": { "maxLength": 5000, "type": "string" } }, "title": "discounts_data_param", "type": "object" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The coupons, promotion codes & existing discounts which apply to the invoice item or invoice line item. Item discounts are applied before invoice discounts. Pass an empty string to remove previously-defined discounts." }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "period": { "description": "The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details.", "properties": { "end": { "format": "unix-time", "type": "integer" }, "start": { "format": "unix-time", "type": "integer" } }, "required": [ "end", "start" ], "title": "period", "type": "object" }, "price_data": { "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.", "properties": { "currency": { "format": "currency", "type": "string" }, "product": { "maxLength": 5000, "type": "string" }, "tax_behavior": { "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" }, "unit_amount": { "type": "integer" }, "unit_amount_decimal": { "format": "decimal", "type": "string" } }, "required": [ "currency", "product" ], "title": "one_time_price_data", "type": "object" }, "pricing": { "description": "The pricing information for the invoice item.", "properties": { "price": { "maxLength": 5000, "type": "string" } }, "title": "pricing_param", "type": "object" }, "quantity": { "description": "Non-negative integer. The quantity of units for the invoice item.", "type": "integer" }, "tax_behavior": { "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.", "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" }, "tax_code": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "A [tax code](https://stripe.com/docs/tax/tax-categories) ID." }, "tax_rates": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The tax rates which apply to the invoice item. When set, the `default_tax_rates` on the invoice do not apply to this invoice item. Pass an empty string to remove previously-defined tax rates." }, "unit_amount_decimal": { "description": "The decimal unit amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. This `unit_amount_decimal` will be multiplied by the quantity to get the full amount. Passing in a negative `unit_amount_decimal` will reduce the `amount_due` on the invoice. Accepts at most 12 decimal places.", "format": "decimal", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/invoiceitem" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update an invoice item" } }, "/v1/invoices": { "get": { "description": "

You can list all invoices, or list the invoices for a specific customer. The invoices are returned sorted by creation date, with the most recently created invoices appearing first.

", "operationId": "GetInvoices", "parameters": [ { "description": "The collection method of the invoice to retrieve. Either `charge_automatically` or `send_invoice`.", "in": "query", "name": "collection_method", "required": false, "schema": { "enum": [ "charge_automatically", "send_invoice" ], "type": "string" }, "style": "form" }, { "description": "Only return invoices that were created during the given date interval.", "explode": true, "in": "query", "name": "created", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "type": "integer" }, "gte": { "type": "integer" }, "lt": { "type": "integer" }, "lte": { "type": "integer" } }, "title": "range_query_specs", "type": "object" }, { "type": "integer" } ] }, "style": "deepObject" }, { "description": "Only return invoices for the customer specified by this customer ID.", "in": "query", "name": "customer", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "explode": true, "in": "query", "name": "due_date", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "type": "integer" }, "gte": { "type": "integer" }, "lt": { "type": "integer" }, "lte": { "type": "integer" } }, "title": "range_query_specs", "type": "object" }, { "type": "integer" } ] }, "style": "deepObject" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "The status of the invoice, one of `draft`, `open`, `paid`, `uncollectible`, or `void`. [Learn more](https://stripe.com/docs/billing/invoices/workflow#workflow-overview)", "in": "query", "name": "status", "required": false, "schema": { "enum": [ "draft", "open", "paid", "uncollectible", "void" ], "type": "string" }, "style": "form" }, { "description": "Only return invoices for the subscription specified by this subscription ID.", "in": "query", "name": "subscription", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/invoice" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/invoices", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "InvoicesResourceList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all invoices" }, "post": { "description": "

This endpoint creates a draft invoice for a given customer. The invoice remains a draft until you finalize the invoice, which allows you to pay or send the invoice to your customers.

", "operationId": "PostInvoices", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "account_tax_ids": { "explode": true, "style": "deepObject" }, "automatic_tax": { "explode": true, "style": "deepObject" }, "custom_fields": { "explode": true, "style": "deepObject" }, "default_tax_rates": { "explode": true, "style": "deepObject" }, "discounts": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "from_invoice": { "explode": true, "style": "deepObject" }, "issuer": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "payment_settings": { "explode": true, "style": "deepObject" }, "rendering": { "explode": true, "style": "deepObject" }, "shipping_cost": { "explode": true, "style": "deepObject" }, "shipping_details": { "explode": true, "style": "deepObject" }, "transfer_data": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "account_tax_ids": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The account tax IDs associated with the invoice. Only editable when the invoice is a draft." }, "application_fee_amount": { "description": "A fee in cents (or local equivalent) that will be applied to the invoice and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees [documentation](https://stripe.com/docs/billing/invoices/connect#collecting-fees).", "type": "integer" }, "auto_advance": { "description": "Controls whether Stripe performs [automatic collection](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection) of the invoice. If `false`, the invoice's state doesn't automatically advance without an explicit action. Defaults to false.", "type": "boolean" }, "automatic_tax": { "description": "Settings for automatic tax lookup for this invoice.", "properties": { "enabled": { "type": "boolean" }, "liability": { "properties": { "account": { "type": "string" }, "type": { "enum": [ "account", "self" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "param", "type": "object" } }, "required": [ "enabled" ], "title": "automatic_tax_param", "type": "object" }, "automatically_finalizes_at": { "description": "The time when this invoice should be scheduled to finalize (up to 5 years in the future). The invoice is finalized at this time if it's still in draft state.", "format": "unix-time", "type": "integer" }, "collection_method": { "description": "Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this invoice using the default source attached to the customer. When sending an invoice, Stripe will email this invoice to the customer with payment instructions. Defaults to `charge_automatically`.", "enum": [ "charge_automatically", "send_invoice" ], "type": "string" }, "currency": { "description": "The currency to create this invoice in. Defaults to that of `customer` if not specified.", "format": "currency", "type": "string" }, "custom_fields": { "anyOf": [ { "items": { "properties": { "name": { "maxLength": 40, "type": "string" }, "value": { "maxLength": 140, "type": "string" } }, "required": [ "name", "value" ], "title": "custom_field_params", "type": "object" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "A list of up to 4 custom fields to be displayed on the invoice." }, "customer": { "description": "The ID of the customer who will be billed.", "maxLength": 5000, "type": "string" }, "days_until_due": { "description": "The number of days from when the invoice is created until it is due. Valid only for invoices where `collection_method=send_invoice`.", "type": "integer" }, "default_payment_method": { "description": "ID of the default payment method for the invoice. It must belong to the customer associated with the invoice. If not set, defaults to the subscription's default payment method, if any, or to the default payment method in the customer's invoice settings.", "maxLength": 5000, "type": "string" }, "default_source": { "description": "ID of the default payment source for the invoice. It must belong to the customer associated with the invoice and be in a chargeable state. If not set, defaults to the subscription's default source, if any, or to the customer's default source.", "maxLength": 5000, "type": "string" }, "default_tax_rates": { "description": "The tax rates that will apply to any line item that does not have `tax_rates` set.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard.", "maxLength": 1500, "type": "string" }, "discounts": { "anyOf": [ { "items": { "properties": { "coupon": { "maxLength": 5000, "type": "string" }, "discount": { "maxLength": 5000, "type": "string" }, "promotion_code": { "maxLength": 5000, "type": "string" } }, "title": "discounts_data_param", "type": "object" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The coupons and promotion codes to redeem into discounts for the invoice. If not specified, inherits the discount from the invoice's customer. Pass an empty string to avoid inheriting any discounts." }, "due_date": { "description": "The date on which payment for this invoice is due. Valid only for invoices where `collection_method=send_invoice`.", "format": "unix-time", "type": "integer" }, "effective_at": { "description": "The date when this invoice is in effect. Same as `finalized_at` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the invoice PDF and receipt.", "format": "unix-time", "type": "integer" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "footer": { "description": "Footer to be displayed on the invoice.", "maxLength": 5000, "type": "string" }, "from_invoice": { "description": "Revise an existing invoice. The new invoice will be created in `status=draft`. See the [revision documentation](https://stripe.com/docs/invoicing/invoice-revisions) for more details.", "properties": { "action": { "enum": [ "revision" ], "maxLength": 5000, "type": "string" }, "invoice": { "maxLength": 5000, "type": "string" } }, "required": [ "action", "invoice" ], "title": "from_invoice", "type": "object" }, "issuer": { "description": "The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.", "properties": { "account": { "type": "string" }, "type": { "enum": [ "account", "self" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "param", "type": "object" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "number": { "description": "Set the number for this invoice. If no number is present then a number will be assigned automatically when the invoice is finalized. In many markets, regulations require invoices to be unique, sequential and / or gapless. You are responsible for ensuring this is true across all your different invoicing systems in the event that you edit the invoice number using our API. If you use only Stripe for your invoices and do not change invoice numbers, Stripe handles this aspect of compliance for you automatically.", "maxLength": 26, "type": "string" }, "on_behalf_of": { "description": "The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://stripe.com/docs/billing/invoices/connect) documentation for details.", "type": "string" }, "payment_settings": { "description": "Configuration settings for the PaymentIntent that is generated when the invoice is finalized.", "properties": { "default_mandate": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "payment_method_options": { "properties": { "acss_debit": { "anyOf": [ { "properties": { "mandate_options": { "properties": { "transaction_type": { "enum": [ "business", "personal" ], "type": "string" } }, "title": "mandate_options_param", "type": "object" }, "verification_method": { "enum": [ "automatic", "instant", "microdeposits" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "invoice_payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "bancontact": { "anyOf": [ { "properties": { "preferred_language": { "enum": [ "de", "en", "fr", "nl" ], "type": "string" } }, "title": "invoice_payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "card": { "anyOf": [ { "properties": { "installments": { "properties": { "enabled": { "type": "boolean" }, "plan": { "anyOf": [ { "properties": { "count": { "type": "integer" }, "interval": { "enum": [ "month" ], "type": "string" }, "type": { "enum": [ "bonus", "fixed_count", "revolving" ], "type": "string" } }, "required": [ "type" ], "title": "installment_plan", "type": "object" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "installments_param", "type": "object" }, "request_three_d_secure": { "enum": [ "any", "automatic", "challenge" ], "type": "string" } }, "title": "invoice_payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "customer_balance": { "anyOf": [ { "properties": { "bank_transfer": { "properties": { "eu_bank_transfer": { "properties": { "country": { "maxLength": 5000, "type": "string" } }, "required": [ "country" ], "title": "eu_bank_transfer_param", "type": "object" }, "type": { "type": "string" } }, "title": "bank_transfer_param", "type": "object" }, "funding_type": { "type": "string" } }, "title": "invoice_payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "konbini": { "anyOf": [ { "properties": {}, "title": "invoice_payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "sepa_debit": { "anyOf": [ { "properties": {}, "title": "invoice_payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "us_bank_account": { "anyOf": [ { "properties": { "financial_connections": { "properties": { "filters": { "properties": { "account_subcategories": { "items": { "enum": [ "checking", "savings" ], "type": "string" }, "type": "array" } }, "title": "invoice_linked_account_options_filters_param", "type": "object" }, "permissions": { "items": { "enum": [ "balances", "ownership", "payment_method", "transactions" ], "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true }, "type": "array" }, "prefetch": { "items": { "enum": [ "balances", "ownership", "transactions" ], "type": "string", "x-stripeBypassValidation": true }, "type": "array" } }, "title": "invoice_linked_account_options_param", "type": "object" }, "verification_method": { "enum": [ "automatic", "instant", "microdeposits" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "invoice_payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "payment_method_options", "type": "object" }, "payment_method_types": { "anyOf": [ { "items": { "enum": [ "ach_credit_transfer", "ach_debit", "acss_debit", "affirm", "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", "boleto", "card", "cashapp", "crypto", "customer_balance", "eps", "fpx", "giropay", "grabpay", "ideal", "jp_credit_transfer", "kakao_pay", "klarna", "konbini", "kr_card", "link", "multibanco", "naver_pay", "nz_bank_account", "p24", "payco", "paynow", "paypal", "promptpay", "revolut_pay", "sepa_credit_transfer", "sepa_debit", "sofort", "swish", "us_bank_account", "wechat_pay" ], "type": "string", "x-stripeBypassValidation": true }, "type": "array" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "payment_settings", "type": "object" }, "pending_invoice_items_behavior": { "description": "How to handle pending invoice items on invoice creation. Defaults to `exclude` if the parameter is omitted.", "enum": [ "exclude", "include" ], "type": "string", "x-stripeBypassValidation": true }, "rendering": { "description": "The rendering-related settings that control how the invoice is displayed on customer-facing surfaces such as PDF and Hosted Invoice Page.", "properties": { "amount_tax_display": { "enum": [ "", "exclude_tax", "include_inclusive_tax" ], "type": "string" }, "pdf": { "properties": { "page_size": { "enum": [ "a4", "auto", "letter" ], "type": "string" } }, "title": "rendering_pdf_param", "type": "object" }, "template": { "maxLength": 5000, "type": "string" }, "template_version": { "anyOf": [ { "type": "integer" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "rendering_param", "type": "object" }, "shipping_cost": { "description": "Settings for the cost of shipping for this invoice.", "properties": { "shipping_rate": { "maxLength": 5000, "type": "string" }, "shipping_rate_data": { "properties": { "delivery_estimate": { "properties": { "maximum": { "properties": { "unit": { "enum": [ "business_day", "day", "hour", "month", "week" ], "type": "string" }, "value": { "type": "integer" } }, "required": [ "unit", "value" ], "title": "delivery_estimate_bound", "type": "object" }, "minimum": { "properties": { "unit": { "enum": [ "business_day", "day", "hour", "month", "week" ], "type": "string" }, "value": { "type": "integer" } }, "required": [ "unit", "value" ], "title": "delivery_estimate_bound", "type": "object" } }, "title": "delivery_estimate", "type": "object" }, "display_name": { "maxLength": 100, "type": "string" }, "fixed_amount": { "properties": { "amount": { "type": "integer" }, "currency": { "format": "currency", "type": "string" }, "currency_options": { "additionalProperties": { "properties": { "amount": { "type": "integer" }, "tax_behavior": { "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" } }, "required": [ "amount" ], "title": "currency_option", "type": "object" }, "type": "object" } }, "required": [ "amount", "currency" ], "title": "fixed_amount", "type": "object" }, "metadata": { "additionalProperties": { "type": "string" }, "type": "object" }, "tax_behavior": { "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" }, "tax_code": { "type": "string" }, "type": { "enum": [ "fixed_amount" ], "type": "string" } }, "required": [ "display_name" ], "title": "method_params", "type": "object" } }, "title": "shipping_cost", "type": "object" }, "shipping_details": { "description": "Shipping details for the invoice. The Invoice PDF will use the `shipping_details` value if it is set, otherwise the PDF will render the shipping address from the customer.", "properties": { "address": { "properties": { "city": { "maxLength": 5000, "type": "string" }, "country": { "maxLength": 5000, "type": "string" }, "line1": { "maxLength": 5000, "type": "string" }, "line2": { "maxLength": 5000, "type": "string" }, "postal_code": { "maxLength": 5000, "type": "string" }, "state": { "maxLength": 5000, "type": "string" } }, "title": "optional_fields_address", "type": "object" }, "name": { "maxLength": 5000, "type": "string" }, "phone": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] } }, "required": [ "address", "name" ], "title": "recipient_shipping_with_optional_fields_address", "type": "object" }, "statement_descriptor": { "description": "Extra information about a charge for the customer's credit card statement. It must contain at least one letter. If not specified and this invoice is part of a subscription, the default `statement_descriptor` will be set to the first subscription item's product's `statement_descriptor`.", "maxLength": 22, "type": "string" }, "subscription": { "description": "The ID of the subscription to invoice, if any. If set, the created invoice will only include pending invoice items for that subscription. The subscription's billing cycle and regular subscription events won't be affected.", "maxLength": 5000, "type": "string" }, "transfer_data": { "description": "If specified, the funds from the invoice will be transferred to the destination and the ID of the resulting transfer will be found on the invoice's charge.", "properties": { "amount": { "type": "integer" }, "destination": { "type": "string" } }, "required": [ "destination" ], "title": "transfer_data_specs", "type": "object" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/invoice" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create an invoice" } }, "/v1/invoices/create_preview": { "post": { "description": "

At any time, you can preview the upcoming invoice for a subscription or subscription schedule. This will show you all the charges that are pending, including subscription renewal charges, invoice item charges, etc. It will also show you any discounts that are applicable to the invoice.

\n\n

You can also preview the effects of creating or updating a subscription or subscription schedule, including a preview of any prorations that will take place. To ensure that the actual proration is calculated exactly the same as the previewed proration, you should pass the subscription_details.proration_date parameter when doing the actual subscription update.

\n\n

The recommended way to get only the prorations being previewed on the invoice is to consider line items where parent.subscription_item_details.proration is true.

\n\n

Note that when you are viewing an upcoming invoice, you are simply viewing a preview – the invoice has not yet been created. As such, the upcoming invoice will not show up in invoice listing calls, and you cannot use the API to pay or edit the invoice. If you want to change the amount that your customer will be billed, you can add, remove, or update pending invoice items, or update the customer’s discount.

\n\n

Note: Currency conversion calculations use the latest exchange rates. Exchange rates may vary between the time of the preview and the time of the actual invoice creation. Learn more

", "operationId": "PostInvoicesCreatePreview", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "automatic_tax": { "explode": true, "style": "deepObject" }, "customer_details": { "explode": true, "style": "deepObject" }, "discounts": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "invoice_items": { "explode": true, "style": "deepObject" }, "issuer": { "explode": true, "style": "deepObject" }, "on_behalf_of": { "explode": true, "style": "deepObject" }, "schedule_details": { "explode": true, "style": "deepObject" }, "subscription_details": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "automatic_tax": { "description": "Settings for automatic tax lookup for this invoice preview.", "properties": { "enabled": { "type": "boolean" }, "liability": { "properties": { "account": { "type": "string" }, "type": { "enum": [ "account", "self" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "param", "type": "object" } }, "required": [ "enabled" ], "title": "automatic_tax_param", "type": "object" }, "currency": { "description": "The currency to preview this invoice in. Defaults to that of `customer` if not specified.", "format": "currency", "type": "string" }, "customer": { "description": "The identifier of the customer whose upcoming invoice you'd like to retrieve. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set.", "maxLength": 5000, "type": "string" }, "customer_details": { "description": "Details about the customer you want to invoice or overrides for an existing customer. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set.", "properties": { "address": { "anyOf": [ { "properties": { "city": { "maxLength": 5000, "type": "string" }, "country": { "maxLength": 5000, "type": "string" }, "line1": { "maxLength": 5000, "type": "string" }, "line2": { "maxLength": 5000, "type": "string" }, "postal_code": { "maxLength": 5000, "type": "string" }, "state": { "maxLength": 5000, "type": "string" } }, "title": "optional_fields_address", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "shipping": { "anyOf": [ { "properties": { "address": { "properties": { "city": { "maxLength": 5000, "type": "string" }, "country": { "maxLength": 5000, "type": "string" }, "line1": { "maxLength": 5000, "type": "string" }, "line2": { "maxLength": 5000, "type": "string" }, "postal_code": { "maxLength": 5000, "type": "string" }, "state": { "maxLength": 5000, "type": "string" } }, "title": "optional_fields_customer_address", "type": "object" }, "name": { "maxLength": 5000, "type": "string" }, "phone": { "maxLength": 5000, "type": "string" } }, "required": [ "address", "name" ], "title": "customer_shipping", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "tax": { "properties": { "ip_address": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "tax_param", "type": "object" }, "tax_exempt": { "enum": [ "", "exempt", "none", "reverse" ], "type": "string" }, "tax_ids": { "items": { "properties": { "type": { "enum": [ "ad_nrt", "ae_trn", "al_tin", "am_tin", "ao_tin", "ar_cuit", "au_abn", "au_arn", "aw_tin", "az_tin", "ba_tin", "bb_tin", "bd_bin", "bf_ifu", "bg_uic", "bh_vat", "bj_ifu", "bo_tin", "br_cnpj", "br_cpf", "bs_tin", "by_tin", "ca_bn", "ca_gst_hst", "ca_pst_bc", "ca_pst_mb", "ca_pst_sk", "ca_qst", "cd_nif", "ch_uid", "ch_vat", "cl_tin", "cm_niu", "cn_tin", "co_nit", "cr_tin", "cv_nif", "de_stn", "do_rcn", "ec_ruc", "eg_tin", "es_cif", "et_tin", "eu_oss_vat", "eu_vat", "gb_vat", "ge_vat", "gn_nif", "hk_br", "hr_oib", "hu_tin", "id_npwp", "il_vat", "in_gst", "is_vat", "jp_cn", "jp_rn", "jp_trn", "ke_pin", "kg_tin", "kh_tin", "kr_brn", "kz_bin", "la_tin", "li_uid", "li_vat", "ma_vat", "md_vat", "me_pib", "mk_vat", "mr_nif", "mx_rfc", "my_frp", "my_itn", "my_sst", "ng_tin", "no_vat", "no_voec", "np_pan", "nz_gst", "om_vat", "pe_ruc", "ph_tin", "ro_tin", "rs_pib", "ru_inn", "ru_kpp", "sa_vat", "sg_gst", "sg_uen", "si_tin", "sn_ninea", "sr_fin", "sv_nit", "th_vat", "tj_tin", "tr_tin", "tw_vat", "tz_vat", "ua_vat", "ug_tin", "us_ein", "uy_ruc", "uz_tin", "uz_vat", "ve_rif", "vn_tin", "za_vat", "zm_tin", "zw_tin" ], "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true }, "value": { "type": "string" } }, "required": [ "type", "value" ], "title": "data_params", "type": "object" }, "type": "array" } }, "title": "customer_details_param", "type": "object" }, "discounts": { "anyOf": [ { "items": { "properties": { "coupon": { "maxLength": 5000, "type": "string" }, "discount": { "maxLength": 5000, "type": "string" }, "promotion_code": { "maxLength": 5000, "type": "string" } }, "title": "discounts_data_param", "type": "object" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The coupons to redeem into discounts for the invoice preview. If not specified, inherits the discount from the subscription or customer. This works for both coupons directly applied to an invoice and coupons applied to a subscription. Pass an empty string to avoid inheriting any discounts." }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "invoice_items": { "description": "List of invoice items to add or update in the upcoming invoice preview (up to 250).", "items": { "properties": { "amount": { "type": "integer" }, "currency": { "format": "currency", "type": "string" }, "description": { "maxLength": 5000, "type": "string" }, "discountable": { "type": "boolean" }, "discounts": { "anyOf": [ { "items": { "properties": { "coupon": { "maxLength": 5000, "type": "string" }, "discount": { "maxLength": 5000, "type": "string" }, "promotion_code": { "maxLength": 5000, "type": "string" } }, "title": "discounts_data_param", "type": "object" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ] }, "invoiceitem": { "maxLength": 5000, "type": "string" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "period": { "properties": { "end": { "format": "unix-time", "type": "integer" }, "start": { "format": "unix-time", "type": "integer" } }, "required": [ "end", "start" ], "title": "period", "type": "object" }, "price": { "maxLength": 5000, "type": "string" }, "price_data": { "properties": { "currency": { "format": "currency", "type": "string" }, "product": { "maxLength": 5000, "type": "string" }, "tax_behavior": { "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" }, "unit_amount": { "type": "integer" }, "unit_amount_decimal": { "format": "decimal", "type": "string" } }, "required": [ "currency", "product" ], "title": "one_time_price_data", "type": "object" }, "quantity": { "type": "integer" }, "tax_behavior": { "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" }, "tax_code": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "tax_rates": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ] }, "unit_amount": { "type": "integer" }, "unit_amount_decimal": { "format": "decimal", "type": "string" } }, "title": "invoice_item_preview_params", "type": "object" }, "type": "array" }, "issuer": { "description": "The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.", "properties": { "account": { "type": "string" }, "type": { "enum": [ "account", "self" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "param", "type": "object" }, "on_behalf_of": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://stripe.com/docs/billing/invoices/connect) documentation for details." }, "preview_mode": { "description": "Customizes the types of values to include when calculating the invoice. Defaults to `next` if unspecified.", "enum": [ "next", "recurring" ], "type": "string" }, "schedule": { "description": "The identifier of the schedule whose upcoming invoice you'd like to retrieve. Cannot be used with subscription or subscription fields.", "maxLength": 5000, "type": "string" }, "schedule_details": { "description": "The schedule creation or modification params to apply as a preview. Cannot be used with `subscription` or `subscription_` prefixed fields.", "properties": { "billing_mode": { "properties": { "type": { "enum": [ "classic", "flexible" ], "type": "string" } }, "required": [ "type" ], "title": "billing_mode", "type": "object" }, "end_behavior": { "enum": [ "cancel", "release" ], "type": "string" }, "phases": { "items": { "properties": { "add_invoice_items": { "items": { "properties": { "discounts": { "items": { "properties": { "coupon": { "maxLength": 5000, "type": "string" }, "discount": { "maxLength": 5000, "type": "string" }, "promotion_code": { "maxLength": 5000, "type": "string" } }, "title": "discounts_data_param", "type": "object" }, "type": "array" }, "metadata": { "additionalProperties": { "type": "string" }, "type": "object" }, "period": { "properties": { "end": { "properties": { "timestamp": { "format": "unix-time", "type": "integer" }, "type": { "enum": [ "min_item_period_end", "phase_end", "timestamp" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "invoice_item_period_end", "type": "object" }, "start": { "properties": { "timestamp": { "format": "unix-time", "type": "integer" }, "type": { "enum": [ "max_item_period_start", "phase_start", "timestamp" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "invoice_item_period_start", "type": "object" } }, "required": [ "end", "start" ], "title": "invoice_item_period", "type": "object" }, "price": { "maxLength": 5000, "type": "string" }, "price_data": { "properties": { "currency": { "format": "currency", "type": "string" }, "product": { "maxLength": 5000, "type": "string" }, "tax_behavior": { "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" }, "unit_amount": { "type": "integer" }, "unit_amount_decimal": { "format": "decimal", "type": "string" } }, "required": [ "currency", "product" ], "title": "one_time_price_data_with_negative_amounts", "type": "object" }, "quantity": { "type": "integer" }, "tax_rates": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "add_invoice_item_entry", "type": "object" }, "type": "array" }, "application_fee_percent": { "type": "number" }, "automatic_tax": { "properties": { "enabled": { "type": "boolean" }, "liability": { "properties": { "account": { "type": "string" }, "type": { "enum": [ "account", "self" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "param", "type": "object" } }, "required": [ "enabled" ], "title": "automatic_tax_config", "type": "object" }, "billing_cycle_anchor": { "enum": [ "automatic", "phase_start" ], "type": "string" }, "billing_thresholds": { "anyOf": [ { "properties": { "amount_gte": { "type": "integer" }, "reset_billing_cycle_anchor": { "type": "boolean" } }, "title": "billing_thresholds_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "collection_method": { "enum": [ "charge_automatically", "send_invoice" ], "type": "string" }, "default_payment_method": { "maxLength": 5000, "type": "string" }, "default_tax_rates": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ] }, "description": { "anyOf": [ { "maxLength": 500, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "discounts": { "anyOf": [ { "items": { "properties": { "coupon": { "maxLength": 5000, "type": "string" }, "discount": { "maxLength": 5000, "type": "string" }, "promotion_code": { "maxLength": 5000, "type": "string" } }, "title": "discounts_data_param", "type": "object" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ] }, "duration": { "properties": { "interval": { "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "type": "integer" } }, "required": [ "interval" ], "title": "duration_params", "type": "object" }, "end_date": { "anyOf": [ { "format": "unix-time", "type": "integer" }, { "enum": [ "now" ], "maxLength": 5000, "type": "string" } ] }, "invoice_settings": { "properties": { "account_tax_ids": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ] }, "days_until_due": { "type": "integer" }, "issuer": { "properties": { "account": { "type": "string" }, "type": { "enum": [ "account", "self" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "param", "type": "object" } }, "title": "invoice_settings", "type": "object" }, "items": { "items": { "properties": { "billing_thresholds": { "anyOf": [ { "properties": { "usage_gte": { "type": "integer" } }, "required": [ "usage_gte" ], "title": "item_billing_thresholds_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "discounts": { "anyOf": [ { "items": { "properties": { "coupon": { "maxLength": 5000, "type": "string" }, "discount": { "maxLength": 5000, "type": "string" }, "promotion_code": { "maxLength": 5000, "type": "string" } }, "title": "discounts_data_param", "type": "object" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ] }, "metadata": { "additionalProperties": { "type": "string" }, "type": "object" }, "price": { "maxLength": 5000, "type": "string" }, "price_data": { "properties": { "currency": { "format": "currency", "type": "string" }, "product": { "maxLength": 5000, "type": "string" }, "recurring": { "properties": { "interval": { "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "type": "integer" } }, "required": [ "interval" ], "title": "recurring_adhoc", "type": "object" }, "tax_behavior": { "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" }, "unit_amount": { "type": "integer" }, "unit_amount_decimal": { "format": "decimal", "type": "string" } }, "required": [ "currency", "product", "recurring" ], "title": "recurring_price_data", "type": "object" }, "quantity": { "type": "integer" }, "tax_rates": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "configuration_item_params", "type": "object" }, "type": "array" }, "iterations": { "type": "integer" }, "metadata": { "additionalProperties": { "type": "string" }, "type": "object" }, "on_behalf_of": { "type": "string" }, "proration_behavior": { "enum": [ "always_invoice", "create_prorations", "none" ], "type": "string" }, "start_date": { "anyOf": [ { "format": "unix-time", "type": "integer" }, { "enum": [ "now" ], "maxLength": 5000, "type": "string" } ] }, "transfer_data": { "properties": { "amount_percent": { "type": "number" }, "destination": { "type": "string" } }, "required": [ "destination" ], "title": "transfer_data_specs", "type": "object" }, "trial": { "type": "boolean" }, "trial_end": { "anyOf": [ { "format": "unix-time", "type": "integer" }, { "enum": [ "now" ], "maxLength": 5000, "type": "string" } ] } }, "required": [ "items" ], "title": "phase_configuration_params", "type": "object" }, "type": "array" }, "proration_behavior": { "enum": [ "always_invoice", "create_prorations", "none" ], "type": "string" } }, "title": "schedule_details_params", "type": "object" }, "subscription": { "description": "The identifier of the subscription for which you'd like to retrieve the upcoming invoice. If not provided, but a `subscription_details.items` is provided, you will preview creating a subscription with those items. If neither `subscription` nor `subscription_details.items` is provided, you will retrieve the next upcoming invoice from among the customer's subscriptions.", "maxLength": 5000, "type": "string" }, "subscription_details": { "description": "The subscription creation or modification params to apply as a preview. Cannot be used with `schedule` or `schedule_details` fields.", "properties": { "billing_cycle_anchor": { "anyOf": [ { "enum": [ "now", "unchanged" ], "maxLength": 5000, "type": "string" }, { "format": "unix-time", "type": "integer" } ] }, "billing_mode": { "properties": { "type": { "enum": [ "classic", "flexible" ], "type": "string" } }, "required": [ "type" ], "title": "billing_mode", "type": "object" }, "cancel_at": { "anyOf": [ { "format": "unix-time", "type": "integer" }, { "enum": [ "" ], "type": "string" }, { "enum": [ "max_period_end", "min_period_end" ], "type": "string" } ] }, "cancel_at_period_end": { "type": "boolean" }, "cancel_now": { "type": "boolean" }, "default_tax_rates": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ] }, "items": { "items": { "properties": { "billing_thresholds": { "anyOf": [ { "properties": { "usage_gte": { "type": "integer" } }, "required": [ "usage_gte" ], "title": "item_billing_thresholds_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "clear_usage": { "type": "boolean" }, "deleted": { "type": "boolean" }, "discounts": { "anyOf": [ { "items": { "properties": { "coupon": { "maxLength": 5000, "type": "string" }, "discount": { "maxLength": 5000, "type": "string" }, "promotion_code": { "maxLength": 5000, "type": "string" } }, "title": "discounts_data_param", "type": "object" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ] }, "id": { "maxLength": 5000, "type": "string" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "price": { "maxLength": 5000, "type": "string" }, "price_data": { "properties": { "currency": { "format": "currency", "type": "string" }, "product": { "maxLength": 5000, "type": "string" }, "recurring": { "properties": { "interval": { "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "type": "integer" } }, "required": [ "interval" ], "title": "recurring_adhoc", "type": "object" }, "tax_behavior": { "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" }, "unit_amount": { "type": "integer" }, "unit_amount_decimal": { "format": "decimal", "type": "string" } }, "required": [ "currency", "product", "recurring" ], "title": "recurring_price_data", "type": "object" }, "quantity": { "type": "integer" }, "tax_rates": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "subscription_item_update_params", "type": "object" }, "type": "array" }, "proration_behavior": { "enum": [ "always_invoice", "create_prorations", "none" ], "type": "string" }, "proration_date": { "format": "unix-time", "type": "integer" }, "resume_at": { "enum": [ "now" ], "maxLength": 5000, "type": "string" }, "start_date": { "format": "unix-time", "type": "integer" }, "trial_end": { "anyOf": [ { "enum": [ "now" ], "maxLength": 5000, "type": "string" }, { "format": "unix-time", "type": "integer" } ] } }, "title": "subscription_details_params", "type": "object" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/invoice" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a preview invoice" } }, "/v1/invoices/search": { "get": { "description": "

Search for invoices you’ve previously created using Stripe’s Search Query Language.\nDon’t use search in read-after-write flows where strict consistency is necessary. Under normal operating\nconditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up\nto an hour behind during outages. Search functionality is not available to merchants in India.

", "operationId": "GetInvoicesSearch", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.", "in": "query", "name": "page", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for invoices](https://stripe.com/docs/search#query-fields-for-invoices).", "in": "query", "name": "query", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/invoice" }, "type": "array" }, "has_more": { "type": "boolean" }, "next_page": { "maxLength": 5000, "nullable": true, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "search_result" ], "type": "string" }, "total_count": { "description": "The total number of objects that match the query, only accurate up to 10,000.", "type": "integer" }, "url": { "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "SearchResult", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Search invoices" } }, "/v1/invoices/{invoice}": { "delete": { "description": "

Permanently deletes a one-off invoice draft. This cannot be undone. Attempts to delete invoices that are no longer in a draft state will fail; once an invoice has been finalized or if an invoice is for a subscription, it must be voided.

", "operationId": "DeleteInvoicesInvoice", "parameters": [ { "in": "path", "name": "invoice", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted_invoice" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Delete a draft invoice" }, "get": { "description": "

Retrieves the invoice with the given ID.

", "operationId": "GetInvoicesInvoice", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "invoice", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/invoice" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve an invoice" }, "post": { "description": "

Draft invoices are fully editable. Once an invoice is finalized,\nmonetary values, as well as collection_method, become uneditable.

\n\n

If you would like to stop the Stripe Billing engine from automatically finalizing, reattempting payments on,\nsending reminders for, or automatically reconciling invoices, pass\nauto_advance=false.

", "operationId": "PostInvoicesInvoice", "parameters": [ { "in": "path", "name": "invoice", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "account_tax_ids": { "explode": true, "style": "deepObject" }, "automatic_tax": { "explode": true, "style": "deepObject" }, "custom_fields": { "explode": true, "style": "deepObject" }, "default_source": { "explode": true, "style": "deepObject" }, "default_tax_rates": { "explode": true, "style": "deepObject" }, "discounts": { "explode": true, "style": "deepObject" }, "effective_at": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "issuer": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "number": { "explode": true, "style": "deepObject" }, "on_behalf_of": { "explode": true, "style": "deepObject" }, "payment_settings": { "explode": true, "style": "deepObject" }, "rendering": { "explode": true, "style": "deepObject" }, "shipping_cost": { "explode": true, "style": "deepObject" }, "shipping_details": { "explode": true, "style": "deepObject" }, "transfer_data": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "account_tax_ids": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The account tax IDs associated with the invoice. Only editable when the invoice is a draft." }, "application_fee_amount": { "description": "A fee in cents (or local equivalent) that will be applied to the invoice and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees [documentation](https://stripe.com/docs/billing/invoices/connect#collecting-fees).", "type": "integer" }, "auto_advance": { "description": "Controls whether Stripe performs [automatic collection](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection) of the invoice.", "type": "boolean" }, "automatic_tax": { "description": "Settings for automatic tax lookup for this invoice.", "properties": { "enabled": { "type": "boolean" }, "liability": { "properties": { "account": { "type": "string" }, "type": { "enum": [ "account", "self" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "param", "type": "object" } }, "required": [ "enabled" ], "title": "automatic_tax_param", "type": "object" }, "automatically_finalizes_at": { "description": "The time when this invoice should be scheduled to finalize (up to 5 years in the future). The invoice is finalized at this time if it's still in draft state. To turn off automatic finalization, set `auto_advance` to false.", "format": "unix-time", "type": "integer" }, "collection_method": { "description": "Either `charge_automatically` or `send_invoice`. This field can be updated only on `draft` invoices.", "enum": [ "charge_automatically", "send_invoice" ], "type": "string" }, "custom_fields": { "anyOf": [ { "items": { "properties": { "name": { "maxLength": 40, "type": "string" }, "value": { "maxLength": 140, "type": "string" } }, "required": [ "name", "value" ], "title": "custom_field_params", "type": "object" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "A list of up to 4 custom fields to be displayed on the invoice. If a value for `custom_fields` is specified, the list specified will replace the existing custom field list on this invoice. Pass an empty string to remove previously-defined fields." }, "days_until_due": { "description": "The number of days from which the invoice is created until it is due. Only valid for invoices where `collection_method=send_invoice`. This field can only be updated on `draft` invoices.", "type": "integer" }, "default_payment_method": { "description": "ID of the default payment method for the invoice. It must belong to the customer associated with the invoice. If not set, defaults to the subscription's default payment method, if any, or to the default payment method in the customer's invoice settings.", "maxLength": 5000, "type": "string" }, "default_source": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "ID of the default payment source for the invoice. It must belong to the customer associated with the invoice and be in a chargeable state. If not set, defaults to the subscription's default source, if any, or to the customer's default source." }, "default_tax_rates": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The tax rates that will apply to any line item that does not have `tax_rates` set. Pass an empty string to remove previously-defined tax rates." }, "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard.", "maxLength": 1500, "type": "string" }, "discounts": { "anyOf": [ { "items": { "properties": { "coupon": { "maxLength": 5000, "type": "string" }, "discount": { "maxLength": 5000, "type": "string" }, "promotion_code": { "maxLength": 5000, "type": "string" } }, "title": "discounts_data_param", "type": "object" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The discounts that will apply to the invoice. Pass an empty string to remove previously-defined discounts." }, "due_date": { "description": "The date on which payment for this invoice is due. Only valid for invoices where `collection_method=send_invoice`. This field can only be updated on `draft` invoices.", "format": "unix-time", "type": "integer" }, "effective_at": { "anyOf": [ { "format": "unix-time", "type": "integer" }, { "enum": [ "" ], "type": "string" } ], "description": "The date when this invoice is in effect. Same as `finalized_at` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the invoice PDF and receipt." }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "footer": { "description": "Footer to be displayed on the invoice.", "maxLength": 5000, "type": "string" }, "issuer": { "description": "The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.", "properties": { "account": { "type": "string" }, "type": { "enum": [ "account", "self" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "param", "type": "object" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "number": { "anyOf": [ { "maxLength": 26, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Set the number for this invoice. If no number is present then a number will be assigned automatically when the invoice is finalized. In many markets, regulations require invoices to be unique, sequential and / or gapless. You are responsible for ensuring this is true across all your different invoicing systems in the event that you edit the invoice number using our API. If you use only Stripe for your invoices and do not change invoice numbers, Stripe handles this aspect of compliance for you automatically." }, "on_behalf_of": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://stripe.com/docs/billing/invoices/connect) documentation for details." }, "payment_settings": { "description": "Configuration settings for the PaymentIntent that is generated when the invoice is finalized.", "properties": { "default_mandate": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "payment_method_options": { "properties": { "acss_debit": { "anyOf": [ { "properties": { "mandate_options": { "properties": { "transaction_type": { "enum": [ "business", "personal" ], "type": "string" } }, "title": "mandate_options_param", "type": "object" }, "verification_method": { "enum": [ "automatic", "instant", "microdeposits" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "invoice_payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "bancontact": { "anyOf": [ { "properties": { "preferred_language": { "enum": [ "de", "en", "fr", "nl" ], "type": "string" } }, "title": "invoice_payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "card": { "anyOf": [ { "properties": { "installments": { "properties": { "enabled": { "type": "boolean" }, "plan": { "anyOf": [ { "properties": { "count": { "type": "integer" }, "interval": { "enum": [ "month" ], "type": "string" }, "type": { "enum": [ "bonus", "fixed_count", "revolving" ], "type": "string" } }, "required": [ "type" ], "title": "installment_plan", "type": "object" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "installments_param", "type": "object" }, "request_three_d_secure": { "enum": [ "any", "automatic", "challenge" ], "type": "string" } }, "title": "invoice_payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "customer_balance": { "anyOf": [ { "properties": { "bank_transfer": { "properties": { "eu_bank_transfer": { "properties": { "country": { "maxLength": 5000, "type": "string" } }, "required": [ "country" ], "title": "eu_bank_transfer_param", "type": "object" }, "type": { "type": "string" } }, "title": "bank_transfer_param", "type": "object" }, "funding_type": { "type": "string" } }, "title": "invoice_payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "konbini": { "anyOf": [ { "properties": {}, "title": "invoice_payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "sepa_debit": { "anyOf": [ { "properties": {}, "title": "invoice_payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "us_bank_account": { "anyOf": [ { "properties": { "financial_connections": { "properties": { "filters": { "properties": { "account_subcategories": { "items": { "enum": [ "checking", "savings" ], "type": "string" }, "type": "array" } }, "title": "invoice_linked_account_options_filters_param", "type": "object" }, "permissions": { "items": { "enum": [ "balances", "ownership", "payment_method", "transactions" ], "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true }, "type": "array" }, "prefetch": { "items": { "enum": [ "balances", "ownership", "transactions" ], "type": "string", "x-stripeBypassValidation": true }, "type": "array" } }, "title": "invoice_linked_account_options_param", "type": "object" }, "verification_method": { "enum": [ "automatic", "instant", "microdeposits" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "invoice_payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "payment_method_options", "type": "object" }, "payment_method_types": { "anyOf": [ { "items": { "enum": [ "ach_credit_transfer", "ach_debit", "acss_debit", "affirm", "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", "boleto", "card", "cashapp", "crypto", "customer_balance", "eps", "fpx", "giropay", "grabpay", "ideal", "jp_credit_transfer", "kakao_pay", "klarna", "konbini", "kr_card", "link", "multibanco", "naver_pay", "nz_bank_account", "p24", "payco", "paynow", "paypal", "promptpay", "revolut_pay", "sepa_credit_transfer", "sepa_debit", "sofort", "swish", "us_bank_account", "wechat_pay" ], "type": "string", "x-stripeBypassValidation": true }, "type": "array" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "payment_settings", "type": "object" }, "rendering": { "description": "The rendering-related settings that control how the invoice is displayed on customer-facing surfaces such as PDF and Hosted Invoice Page.", "properties": { "amount_tax_display": { "enum": [ "", "exclude_tax", "include_inclusive_tax" ], "type": "string" }, "pdf": { "properties": { "page_size": { "enum": [ "a4", "auto", "letter" ], "type": "string" } }, "title": "rendering_pdf_param", "type": "object" }, "template": { "maxLength": 5000, "type": "string" }, "template_version": { "anyOf": [ { "type": "integer" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "rendering_param", "type": "object" }, "shipping_cost": { "anyOf": [ { "properties": { "shipping_rate": { "maxLength": 5000, "type": "string" }, "shipping_rate_data": { "properties": { "delivery_estimate": { "properties": { "maximum": { "properties": { "unit": { "enum": [ "business_day", "day", "hour", "month", "week" ], "type": "string" }, "value": { "type": "integer" } }, "required": [ "unit", "value" ], "title": "delivery_estimate_bound", "type": "object" }, "minimum": { "properties": { "unit": { "enum": [ "business_day", "day", "hour", "month", "week" ], "type": "string" }, "value": { "type": "integer" } }, "required": [ "unit", "value" ], "title": "delivery_estimate_bound", "type": "object" } }, "title": "delivery_estimate", "type": "object" }, "display_name": { "maxLength": 100, "type": "string" }, "fixed_amount": { "properties": { "amount": { "type": "integer" }, "currency": { "format": "currency", "type": "string" }, "currency_options": { "additionalProperties": { "properties": { "amount": { "type": "integer" }, "tax_behavior": { "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" } }, "required": [ "amount" ], "title": "currency_option", "type": "object" }, "type": "object" } }, "required": [ "amount", "currency" ], "title": "fixed_amount", "type": "object" }, "metadata": { "additionalProperties": { "type": "string" }, "type": "object" }, "tax_behavior": { "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" }, "tax_code": { "type": "string" }, "type": { "enum": [ "fixed_amount" ], "type": "string" } }, "required": [ "display_name" ], "title": "method_params", "type": "object" } }, "title": "shipping_cost", "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Settings for the cost of shipping for this invoice." }, "shipping_details": { "anyOf": [ { "properties": { "address": { "properties": { "city": { "maxLength": 5000, "type": "string" }, "country": { "maxLength": 5000, "type": "string" }, "line1": { "maxLength": 5000, "type": "string" }, "line2": { "maxLength": 5000, "type": "string" }, "postal_code": { "maxLength": 5000, "type": "string" }, "state": { "maxLength": 5000, "type": "string" } }, "title": "optional_fields_address", "type": "object" }, "name": { "maxLength": 5000, "type": "string" }, "phone": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] } }, "required": [ "address", "name" ], "title": "recipient_shipping_with_optional_fields_address", "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Shipping details for the invoice. The Invoice PDF will use the `shipping_details` value if it is set, otherwise the PDF will render the shipping address from the customer." }, "statement_descriptor": { "description": "Extra information about a charge for the customer's credit card statement. It must contain at least one letter. If not specified and this invoice is part of a subscription, the default `statement_descriptor` will be set to the first subscription item's product's `statement_descriptor`.", "maxLength": 22, "type": "string" }, "transfer_data": { "anyOf": [ { "properties": { "amount": { "type": "integer" }, "destination": { "type": "string" } }, "required": [ "destination" ], "title": "transfer_data_specs", "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "If specified, the funds from the invoice will be transferred to the destination and the ID of the resulting transfer will be found on the invoice's charge. This will be unset if you POST an empty value." } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/invoice" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update an invoice" } }, "/v1/invoices/{invoice}/add_lines": { "post": { "description": "

Adds multiple line items to an invoice. This is only possible when an invoice is still a draft.

", "operationId": "PostInvoicesInvoiceAddLines", "parameters": [ { "in": "path", "name": "invoice", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "invoice_metadata": { "explode": true, "style": "deepObject" }, "lines": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "invoice_metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "lines": { "description": "The line items to add.", "items": { "properties": { "amount": { "type": "integer" }, "description": { "maxLength": 5000, "type": "string" }, "discountable": { "type": "boolean" }, "discounts": { "anyOf": [ { "items": { "properties": { "coupon": { "maxLength": 5000, "type": "string" }, "discount": { "maxLength": 5000, "type": "string" }, "promotion_code": { "maxLength": 5000, "type": "string" } }, "title": "discounts_data_param", "type": "object" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ] }, "invoice_item": { "maxLength": 5000, "type": "string" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "period": { "properties": { "end": { "format": "unix-time", "type": "integer" }, "start": { "format": "unix-time", "type": "integer" } }, "required": [ "end", "start" ], "title": "period", "type": "object" }, "price_data": { "properties": { "currency": { "format": "currency", "type": "string" }, "product": { "maxLength": 5000, "type": "string" }, "product_data": { "properties": { "description": { "maxLength": 40000, "type": "string" }, "images": { "items": { "type": "string" }, "type": "array" }, "metadata": { "additionalProperties": { "type": "string" }, "type": "object" }, "name": { "maxLength": 5000, "type": "string" }, "tax_code": { "maxLength": 5000, "type": "string" } }, "required": [ "name" ], "title": "product_data", "type": "object" }, "tax_behavior": { "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" }, "unit_amount": { "type": "integer" }, "unit_amount_decimal": { "format": "decimal", "type": "string" } }, "required": [ "currency" ], "title": "one_time_price_data_with_product_data", "type": "object" }, "pricing": { "properties": { "price": { "maxLength": 5000, "type": "string" } }, "title": "pricing_param", "type": "object" }, "quantity": { "type": "integer" }, "tax_amounts": { "anyOf": [ { "items": { "properties": { "amount": { "type": "integer" }, "tax_rate_data": { "properties": { "country": { "maxLength": 5000, "type": "string" }, "description": { "maxLength": 5000, "type": "string" }, "display_name": { "maxLength": 100, "type": "string" }, "inclusive": { "type": "boolean" }, "jurisdiction": { "maxLength": 200, "type": "string" }, "jurisdiction_level": { "enum": [ "city", "country", "county", "district", "multiple", "state" ], "type": "string" }, "percentage": { "type": "number" }, "state": { "maxLength": 5000, "type": "string" }, "tax_type": { "enum": [ "amusement_tax", "communications_tax", "gst", "hst", "igst", "jct", "lease_tax", "pst", "qst", "retail_delivery_fee", "rst", "sales_tax", "service_tax", "vat" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "display_name", "inclusive", "percentage" ], "title": "tax_rate_data_param", "type": "object" }, "taxability_reason": { "enum": [ "customer_exempt", "not_collecting", "not_subject_to_tax", "not_supported", "portion_product_exempt", "portion_reduced_rated", "portion_standard_rated", "product_exempt", "product_exempt_holiday", "proportionally_rated", "reduced_rated", "reverse_charge", "standard_rated", "taxable_basis_reduced", "zero_rated" ], "type": "string", "x-stripeBypassValidation": true }, "taxable_amount": { "type": "integer" } }, "required": [ "amount", "tax_rate_data", "taxable_amount" ], "title": "tax_amount_param", "type": "object" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ] }, "tax_rates": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "lines_data_param", "type": "object" }, "type": "array" } }, "required": [ "lines" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/invoice" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Bulk add invoice line items" } }, "/v1/invoices/{invoice}/attach_payment": { "post": { "description": "

Attaches a PaymentIntent or an Out of Band Payment to the invoice, adding it to the list of payments.

\n\n

For the PaymentIntent, when the PaymentIntent’s status changes to succeeded, the payment is credited\nto the invoice, increasing its amount_paid. When the invoice is fully paid, the\ninvoice’s status becomes paid.

\n\n

If the PaymentIntent’s status is already succeeded when it’s attached, it’s\ncredited to the invoice immediately.

\n\n

See: Partial payments to learn more.

", "operationId": "PostInvoicesInvoiceAttachPayment", "parameters": [ { "in": "path", "name": "invoice", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "payment_intent": { "description": "The ID of the PaymentIntent to attach to the invoice.", "maxLength": 5000, "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/invoice" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Attach a payment to an Invoice" } }, "/v1/invoices/{invoice}/finalize": { "post": { "description": "

Stripe automatically finalizes drafts before sending and attempting payment on invoices. However, if you’d like to finalize a draft invoice manually, you can do so using this method.

", "operationId": "PostInvoicesInvoiceFinalize", "parameters": [ { "in": "path", "name": "invoice", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "auto_advance": { "description": "Controls whether Stripe performs [automatic collection](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection) of the invoice. If `false`, the invoice's state doesn't automatically advance without an explicit action.", "type": "boolean" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/invoice" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Finalize an invoice" } }, "/v1/invoices/{invoice}/lines": { "get": { "description": "

When retrieving an invoice, you’ll get a lines property containing the total count of line items and the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.

", "operationId": "GetInvoicesInvoiceLines", "parameters": [ { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "invoice", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/line_item" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "InvoiceLinesList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve an invoice's line items" } }, "/v1/invoices/{invoice}/lines/{line_item_id}": { "post": { "description": "

Updates an invoice’s line item. Some fields, such as tax_amounts, only live on the invoice line item,\nso they can only be updated through this endpoint. Other fields, such as amount, live on both the invoice\nitem and the invoice line item, so updates on this endpoint will propagate to the invoice item as well.\nUpdating an invoice’s line item is only possible before the invoice is finalized.

", "operationId": "PostInvoicesInvoiceLinesLineItemId", "parameters": [ { "description": "Invoice ID of line item", "in": "path", "name": "invoice", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "description": "Invoice line item ID", "in": "path", "name": "line_item_id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "discounts": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "period": { "explode": true, "style": "deepObject" }, "price_data": { "explode": true, "style": "deepObject" }, "pricing": { "explode": true, "style": "deepObject" }, "tax_amounts": { "explode": true, "style": "deepObject" }, "tax_rates": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "amount": { "description": "The integer amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. If you want to apply a credit to the customer's account, pass a negative amount.", "type": "integer" }, "description": { "description": "An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking.", "maxLength": 5000, "type": "string" }, "discountable": { "description": "Controls whether discounts apply to this line item. Defaults to false for prorations or negative line items, and true for all other line items. Cannot be set to true for prorations.", "type": "boolean" }, "discounts": { "anyOf": [ { "items": { "properties": { "coupon": { "maxLength": 5000, "type": "string" }, "discount": { "maxLength": 5000, "type": "string" }, "promotion_code": { "maxLength": 5000, "type": "string" } }, "title": "discounts_data_param", "type": "object" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The coupons, promotion codes & existing discounts which apply to the line item. Item discounts are applied before invoice discounts. Pass an empty string to remove previously-defined discounts." }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`. For [type=subscription](https://stripe.com/docs/api/invoices/line_item#invoice_line_item_object-type) line items, the incoming metadata specified on the request is directly used to set this value, in contrast to [type=invoiceitem](api/invoices/line_item#invoice_line_item_object-type) line items, where any existing metadata on the invoice line is merged with the incoming data." }, "period": { "description": "The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details.", "properties": { "end": { "format": "unix-time", "type": "integer" }, "start": { "format": "unix-time", "type": "integer" } }, "required": [ "end", "start" ], "title": "period", "type": "object" }, "price_data": { "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.", "properties": { "currency": { "format": "currency", "type": "string" }, "product": { "maxLength": 5000, "type": "string" }, "product_data": { "properties": { "description": { "maxLength": 40000, "type": "string" }, "images": { "items": { "type": "string" }, "type": "array" }, "metadata": { "additionalProperties": { "type": "string" }, "type": "object" }, "name": { "maxLength": 5000, "type": "string" }, "tax_code": { "maxLength": 5000, "type": "string" } }, "required": [ "name" ], "title": "product_data", "type": "object" }, "tax_behavior": { "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" }, "unit_amount": { "type": "integer" }, "unit_amount_decimal": { "format": "decimal", "type": "string" } }, "required": [ "currency" ], "title": "one_time_price_data_with_product_data", "type": "object" }, "pricing": { "description": "The pricing information for the invoice item.", "properties": { "price": { "maxLength": 5000, "type": "string" } }, "title": "pricing_param", "type": "object" }, "quantity": { "description": "Non-negative integer. The quantity of units for the line item.", "type": "integer" }, "tax_amounts": { "anyOf": [ { "items": { "properties": { "amount": { "type": "integer" }, "tax_rate_data": { "properties": { "country": { "maxLength": 5000, "type": "string" }, "description": { "maxLength": 5000, "type": "string" }, "display_name": { "maxLength": 100, "type": "string" }, "inclusive": { "type": "boolean" }, "jurisdiction": { "maxLength": 200, "type": "string" }, "jurisdiction_level": { "enum": [ "city", "country", "county", "district", "multiple", "state" ], "type": "string" }, "percentage": { "type": "number" }, "state": { "maxLength": 5000, "type": "string" }, "tax_type": { "enum": [ "amusement_tax", "communications_tax", "gst", "hst", "igst", "jct", "lease_tax", "pst", "qst", "retail_delivery_fee", "rst", "sales_tax", "service_tax", "vat" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "display_name", "inclusive", "percentage" ], "title": "tax_rate_data_param", "type": "object" }, "taxability_reason": { "enum": [ "customer_exempt", "not_collecting", "not_subject_to_tax", "not_supported", "portion_product_exempt", "portion_reduced_rated", "portion_standard_rated", "product_exempt", "product_exempt_holiday", "proportionally_rated", "reduced_rated", "reverse_charge", "standard_rated", "taxable_basis_reduced", "zero_rated" ], "type": "string", "x-stripeBypassValidation": true }, "taxable_amount": { "type": "integer" } }, "required": [ "amount", "tax_rate_data", "taxable_amount" ], "title": "tax_amount_param", "type": "object" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "A list of up to 10 tax amounts for this line item. This can be useful if you calculate taxes on your own or use a third-party to calculate them. You cannot set tax amounts if any line item has [tax_rates](https://stripe.com/docs/api/invoices/line_item#invoice_line_item_object-tax_rates) or if the invoice has [default_tax_rates](https://stripe.com/docs/api/invoices/object#invoice_object-default_tax_rates) or uses [automatic tax](https://stripe.com/docs/tax/invoicing). Pass an empty string to remove previously defined tax amounts." }, "tax_rates": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The tax rates which apply to the line item. When set, the `default_tax_rates` on the invoice do not apply to this line item. Pass an empty string to remove previously-defined tax rates." } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/line_item" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update an invoice's line item" } }, "/v1/invoices/{invoice}/mark_uncollectible": { "post": { "description": "

Marking an invoice as uncollectible is useful for keeping track of bad debts that can be written off for accounting purposes.

", "operationId": "PostInvoicesInvoiceMarkUncollectible", "parameters": [ { "in": "path", "name": "invoice", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/invoice" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Mark an invoice as uncollectible" } }, "/v1/invoices/{invoice}/pay": { "post": { "description": "

Stripe automatically creates and then attempts to collect payment on invoices for customers on subscriptions according to your subscriptions settings. However, if you’d like to attempt payment on an invoice out of the normal collection schedule or for some other reason, you can do so.

", "operationId": "PostInvoicesInvoicePay", "parameters": [ { "in": "path", "name": "invoice", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "mandate": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "forgive": { "description": "In cases where the source used to pay the invoice has insufficient funds, passing `forgive=true` controls whether a charge should be attempted for the full amount available on the source, up to the amount to fully pay the invoice. This effectively forgives the difference between the amount available on the source and the amount due. \n\nPassing `forgive=false` will fail the charge if the source hasn't been pre-funded with the right amount. An example for this case is with ACH Credit Transfers and wires: if the amount wired is less than the amount due by a small amount, you might want to forgive the difference. Defaults to `false`.", "type": "boolean" }, "mandate": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "ID of the mandate to be used for this invoice. It must correspond to the payment method used to pay the invoice, including the payment_method param or the invoice's default_payment_method or default_source, if set." }, "off_session": { "description": "Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to `true` (off-session).", "type": "boolean" }, "paid_out_of_band": { "description": "Boolean representing whether an invoice is paid outside of Stripe. This will result in no charge being made. Defaults to `false`.", "type": "boolean" }, "payment_method": { "description": "A PaymentMethod to be charged. The PaymentMethod must be the ID of a PaymentMethod belonging to the customer associated with the invoice being paid.", "maxLength": 5000, "type": "string" }, "source": { "description": "A payment source to be charged. The source must be the ID of a source belonging to the customer associated with the invoice being paid.", "maxLength": 5000, "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/invoice" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Pay an invoice" } }, "/v1/invoices/{invoice}/remove_lines": { "post": { "description": "

Removes multiple line items from an invoice. This is only possible when an invoice is still a draft.

", "operationId": "PostInvoicesInvoiceRemoveLines", "parameters": [ { "in": "path", "name": "invoice", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "invoice_metadata": { "explode": true, "style": "deepObject" }, "lines": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "invoice_metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "lines": { "description": "The line items to remove.", "items": { "properties": { "behavior": { "enum": [ "delete", "unassign" ], "type": "string" }, "id": { "maxLength": 5000, "type": "string" } }, "required": [ "behavior", "id" ], "title": "lines_data_param", "type": "object" }, "type": "array" } }, "required": [ "lines" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/invoice" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Bulk remove invoice line items" } }, "/v1/invoices/{invoice}/send": { "post": { "description": "

Stripe will automatically send invoices to customers according to your subscriptions settings. However, if you’d like to manually send an invoice to your customer out of the normal schedule, you can do so. When sending invoices that have already been paid, there will be no reference to the payment in the email.

\n\n

Requests made in test-mode result in no emails being sent, despite sending an invoice.sent event.

", "operationId": "PostInvoicesInvoiceSend", "parameters": [ { "in": "path", "name": "invoice", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/invoice" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Send an invoice for manual payment" } }, "/v1/invoices/{invoice}/update_lines": { "post": { "description": "

Updates multiple line items on an invoice. This is only possible when an invoice is still a draft.

", "operationId": "PostInvoicesInvoiceUpdateLines", "parameters": [ { "in": "path", "name": "invoice", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "invoice_metadata": { "explode": true, "style": "deepObject" }, "lines": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "invoice_metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`. For [type=subscription](https://stripe.com/docs/api/invoices/line_item#invoice_line_item_object-type) line items, the incoming metadata specified on the request is directly used to set this value, in contrast to [type=invoiceitem](api/invoices/line_item#invoice_line_item_object-type) line items, where any existing metadata on the invoice line is merged with the incoming data." }, "lines": { "description": "The line items to update.", "items": { "properties": { "amount": { "type": "integer" }, "description": { "maxLength": 5000, "type": "string" }, "discountable": { "type": "boolean" }, "discounts": { "anyOf": [ { "items": { "properties": { "coupon": { "maxLength": 5000, "type": "string" }, "discount": { "maxLength": 5000, "type": "string" }, "promotion_code": { "maxLength": 5000, "type": "string" } }, "title": "discounts_data_param", "type": "object" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ] }, "id": { "maxLength": 5000, "type": "string" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "period": { "properties": { "end": { "format": "unix-time", "type": "integer" }, "start": { "format": "unix-time", "type": "integer" } }, "required": [ "end", "start" ], "title": "period", "type": "object" }, "price_data": { "properties": { "currency": { "format": "currency", "type": "string" }, "product": { "maxLength": 5000, "type": "string" }, "product_data": { "properties": { "description": { "maxLength": 40000, "type": "string" }, "images": { "items": { "type": "string" }, "type": "array" }, "metadata": { "additionalProperties": { "type": "string" }, "type": "object" }, "name": { "maxLength": 5000, "type": "string" }, "tax_code": { "maxLength": 5000, "type": "string" } }, "required": [ "name" ], "title": "product_data", "type": "object" }, "tax_behavior": { "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" }, "unit_amount": { "type": "integer" }, "unit_amount_decimal": { "format": "decimal", "type": "string" } }, "required": [ "currency" ], "title": "one_time_price_data_with_product_data", "type": "object" }, "pricing": { "properties": { "price": { "maxLength": 5000, "type": "string" } }, "title": "pricing_param", "type": "object" }, "quantity": { "type": "integer" }, "tax_amounts": { "anyOf": [ { "items": { "properties": { "amount": { "type": "integer" }, "tax_rate_data": { "properties": { "country": { "maxLength": 5000, "type": "string" }, "description": { "maxLength": 5000, "type": "string" }, "display_name": { "maxLength": 100, "type": "string" }, "inclusive": { "type": "boolean" }, "jurisdiction": { "maxLength": 200, "type": "string" }, "jurisdiction_level": { "enum": [ "city", "country", "county", "district", "multiple", "state" ], "type": "string" }, "percentage": { "type": "number" }, "state": { "maxLength": 5000, "type": "string" }, "tax_type": { "enum": [ "amusement_tax", "communications_tax", "gst", "hst", "igst", "jct", "lease_tax", "pst", "qst", "retail_delivery_fee", "rst", "sales_tax", "service_tax", "vat" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "display_name", "inclusive", "percentage" ], "title": "tax_rate_data_param", "type": "object" }, "taxability_reason": { "enum": [ "customer_exempt", "not_collecting", "not_subject_to_tax", "not_supported", "portion_product_exempt", "portion_reduced_rated", "portion_standard_rated", "product_exempt", "product_exempt_holiday", "proportionally_rated", "reduced_rated", "reverse_charge", "standard_rated", "taxable_basis_reduced", "zero_rated" ], "type": "string", "x-stripeBypassValidation": true }, "taxable_amount": { "type": "integer" } }, "required": [ "amount", "tax_rate_data", "taxable_amount" ], "title": "tax_amount_param", "type": "object" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ] }, "tax_rates": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ] } }, "required": [ "id" ], "title": "lines_data_param", "type": "object" }, "type": "array" } }, "required": [ "lines" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/invoice" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Bulk update invoice line items" } }, "/v1/invoices/{invoice}/void": { "post": { "description": "

Mark a finalized invoice as void. This cannot be undone. Voiding an invoice is similar to deletion, however it only applies to finalized invoices and maintains a papertrail where the invoice can still be found.

\n\n

Consult with local regulations to determine whether and how an invoice might be amended, canceled, or voided in the jurisdiction you’re doing business in. You might need to issue another invoice or credit note instead. Stripe recommends that you consult with your legal counsel for advice specific to your business.

", "operationId": "PostInvoicesInvoiceVoid", "parameters": [ { "in": "path", "name": "invoice", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/invoice" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Void an invoice" } }, "/v1/issuing/authorizations": { "get": { "description": "

Returns a list of Issuing Authorization objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

", "operationId": "GetIssuingAuthorizations", "parameters": [ { "description": "Only return authorizations that belong to the given card.", "in": "query", "name": "card", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Only return authorizations that belong to the given cardholder.", "in": "query", "name": "cardholder", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Only return authorizations that were created during the given date interval.", "explode": true, "in": "query", "name": "created", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "type": "integer" }, "gte": { "type": "integer" }, "lt": { "type": "integer" }, "lte": { "type": "integer" } }, "title": "range_query_specs", "type": "object" }, { "type": "integer" } ] }, "style": "deepObject" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Only return authorizations with the given status. One of `pending`, `closed`, or `reversed`.", "in": "query", "name": "status", "required": false, "schema": { "enum": [ "closed", "expired", "pending", "reversed" ], "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/issuing.authorization" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/issuing/authorizations", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "IssuingAuthorizationList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all authorizations" } }, "/v1/issuing/authorizations/{authorization}": { "get": { "description": "

Retrieves an Issuing Authorization object.

", "operationId": "GetIssuingAuthorizationsAuthorization", "parameters": [ { "in": "path", "name": "authorization", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issuing.authorization" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve an authorization" }, "post": { "description": "

Updates the specified Issuing Authorization object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

", "operationId": "PostIssuingAuthorizationsAuthorization", "parameters": [ { "in": "path", "name": "authorization", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issuing.authorization" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update an authorization" } }, "/v1/issuing/authorizations/{authorization}/approve": { "post": { "deprecated": true, "description": "

[Deprecated] Approves a pending Issuing Authorization object. This request should be made within the timeout window of the real-time authorization flow. \nThis method is deprecated. Instead, respond directly to the webhook request to approve an authorization.

", "operationId": "PostIssuingAuthorizationsAuthorizationApprove", "parameters": [ { "in": "path", "name": "authorization", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "amount": { "description": "If the authorization's `pending_request.is_amount_controllable` property is `true`, you may provide this value to control how much to hold for the authorization. Must be positive (use [`decline`](https://stripe.com/docs/api/issuing/authorizations/decline) to decline an authorization request).", "type": "integer" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issuing.authorization" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Approve an authorization" } }, "/v1/issuing/authorizations/{authorization}/decline": { "post": { "deprecated": true, "description": "

[Deprecated] Declines a pending Issuing Authorization object. This request should be made within the timeout window of the real time authorization flow.\nThis method is deprecated. Instead, respond directly to the webhook request to decline an authorization.

", "operationId": "PostIssuingAuthorizationsAuthorizationDecline", "parameters": [ { "in": "path", "name": "authorization", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issuing.authorization" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Decline an authorization" } }, "/v1/issuing/cardholders": { "get": { "description": "

Returns a list of Issuing Cardholder objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

", "operationId": "GetIssuingCardholders", "parameters": [ { "description": "Only return cardholders that were created during the given date interval.", "explode": true, "in": "query", "name": "created", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "type": "integer" }, "gte": { "type": "integer" }, "lt": { "type": "integer" }, "lte": { "type": "integer" } }, "title": "range_query_specs", "type": "object" }, { "type": "integer" } ] }, "style": "deepObject" }, { "description": "Only return cardholders that have the given email address.", "in": "query", "name": "email", "required": false, "schema": { "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "Only return cardholders that have the given phone number.", "in": "query", "name": "phone_number", "required": false, "schema": { "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Only return cardholders that have the given status. One of `active`, `inactive`, or `blocked`.", "in": "query", "name": "status", "required": false, "schema": { "enum": [ "active", "blocked", "inactive" ], "type": "string" }, "style": "form" }, { "description": "Only return cardholders that have the given type. One of `individual` or `company`.", "in": "query", "name": "type", "required": false, "schema": { "enum": [ "company", "individual" ], "type": "string", "x-stripeBypassValidation": true }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/issuing.cardholder" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/issuing/cardholders", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "IssuingCardholderList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all cardholders" }, "post": { "description": "

Creates a new Issuing Cardholder object that can be issued cards.

", "operationId": "PostIssuingCardholders", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "billing": { "explode": true, "style": "deepObject" }, "company": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "individual": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "preferred_locales": { "explode": true, "style": "deepObject" }, "spending_controls": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "billing": { "description": "The cardholder's billing address.", "properties": { "address": { "properties": { "city": { "maxLength": 5000, "type": "string" }, "country": { "maxLength": 5000, "type": "string" }, "line1": { "maxLength": 5000, "type": "string" }, "line2": { "maxLength": 5000, "type": "string" }, "postal_code": { "maxLength": 5000, "type": "string" }, "state": { "maxLength": 5000, "type": "string" } }, "required": [ "city", "country", "line1", "postal_code" ], "title": "required_address", "type": "object" } }, "required": [ "address" ], "title": "billing_specs", "type": "object" }, "company": { "description": "Additional information about a `company` cardholder.", "properties": { "tax_id": { "maxLength": 5000, "type": "string" } }, "title": "company_param", "type": "object" }, "email": { "description": "The cardholder's email address.", "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "individual": { "description": "Additional information about an `individual` cardholder.", "properties": { "card_issuing": { "properties": { "user_terms_acceptance": { "properties": { "date": { "format": "unix-time", "type": "integer" }, "ip": { "type": "string" }, "user_agent": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "terms_acceptance_param", "type": "object" } }, "title": "card_issuing_param", "type": "object" }, "dob": { "properties": { "day": { "type": "integer" }, "month": { "type": "integer" }, "year": { "type": "integer" } }, "required": [ "day", "month", "year" ], "title": "date_of_birth_specs", "type": "object" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "verification": { "properties": { "document": { "properties": { "back": { "maxLength": 5000, "type": "string" }, "front": { "maxLength": 5000, "type": "string" } }, "title": "person_verification_document_param", "type": "object" } }, "title": "person_verification_param", "type": "object" } }, "title": "individual_param", "type": "object" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "name": { "description": "The cardholder's name. This will be printed on cards issued to them. The maximum length of this field is 24 characters. This field cannot contain any special characters or numbers.", "type": "string" }, "phone_number": { "description": "The cardholder's phone number. This will be transformed to [E.164](https://en.wikipedia.org/wiki/E.164) if it is not provided in that format already. This is required for all cardholders who will be creating EU cards. See the [3D Secure documentation](https://stripe.com/docs/issuing/3d-secure#when-is-3d-secure-applied) for more details.", "type": "string" }, "preferred_locales": { "description": "The cardholder’s preferred locales (languages), ordered by preference. Locales can be `de`, `en`, `es`, `fr`, or `it`.\n This changes the language of the [3D Secure flow](https://stripe.com/docs/issuing/3d-secure) and one-time password messages sent to the cardholder.", "items": { "enum": [ "de", "en", "es", "fr", "it" ], "type": "string" }, "type": "array" }, "spending_controls": { "description": "Rules that control spending across this cardholder's cards. Refer to our [documentation](https://stripe.com/docs/issuing/controls/spending-controls) for more details.", "properties": { "allowed_categories": { "items": { "enum": [ "ac_refrigeration_repair", "accounting_bookkeeping_services", "advertising_services", "agricultural_cooperative", "airlines_air_carriers", "airports_flying_fields", "ambulance_services", "amusement_parks_carnivals", "antique_reproductions", "antique_shops", "aquariums", "architectural_surveying_services", "art_dealers_and_galleries", "artists_supply_and_craft_shops", "auto_and_home_supply_stores", "auto_body_repair_shops", "auto_paint_shops", "auto_service_shops", "automated_cash_disburse", "automated_fuel_dispensers", "automobile_associations", "automotive_parts_and_accessories_stores", "automotive_tire_stores", "bail_and_bond_payments", "bakeries", "bands_orchestras", "barber_and_beauty_shops", "betting_casino_gambling", "bicycle_shops", "billiard_pool_establishments", "boat_dealers", "boat_rentals_and_leases", "book_stores", "books_periodicals_and_newspapers", "bowling_alleys", "bus_lines", "business_secretarial_schools", "buying_shopping_services", "cable_satellite_and_other_pay_television_and_radio", "camera_and_photographic_supply_stores", "candy_nut_and_confectionery_stores", "car_and_truck_dealers_new_used", "car_and_truck_dealers_used_only", "car_rental_agencies", "car_washes", "carpentry_services", "carpet_upholstery_cleaning", "caterers", "charitable_and_social_service_organizations_fundraising", "chemicals_and_allied_products", "child_care_services", "childrens_and_infants_wear_stores", "chiropodists_podiatrists", "chiropractors", "cigar_stores_and_stands", "civic_social_fraternal_associations", "cleaning_and_maintenance", "clothing_rental", "colleges_universities", "commercial_equipment", "commercial_footwear", "commercial_photography_art_and_graphics", "commuter_transport_and_ferries", "computer_network_services", "computer_programming", "computer_repair", "computer_software_stores", "computers_peripherals_and_software", "concrete_work_services", "construction_materials", "consulting_public_relations", "correspondence_schools", "cosmetic_stores", "counseling_services", "country_clubs", "courier_services", "court_costs", "credit_reporting_agencies", "cruise_lines", "dairy_products_stores", "dance_hall_studios_schools", "dating_escort_services", "dentists_orthodontists", "department_stores", "detective_agencies", "digital_goods_applications", "digital_goods_games", "digital_goods_large_volume", "digital_goods_media", "direct_marketing_catalog_merchant", "direct_marketing_combination_catalog_and_retail_merchant", "direct_marketing_inbound_telemarketing", "direct_marketing_insurance_services", "direct_marketing_other", "direct_marketing_outbound_telemarketing", "direct_marketing_subscription", "direct_marketing_travel", "discount_stores", "doctors", "door_to_door_sales", "drapery_window_covering_and_upholstery_stores", "drinking_places", "drug_stores_and_pharmacies", "drugs_drug_proprietaries_and_druggist_sundries", "dry_cleaners", "durable_goods", "duty_free_stores", "eating_places_restaurants", "educational_services", "electric_razor_stores", "electric_vehicle_charging", "electrical_parts_and_equipment", "electrical_services", "electronics_repair_shops", "electronics_stores", "elementary_secondary_schools", "emergency_services_gcas_visa_use_only", "employment_temp_agencies", "equipment_rental", "exterminating_services", "family_clothing_stores", "fast_food_restaurants", "financial_institutions", "fines_government_administrative_entities", "fireplace_fireplace_screens_and_accessories_stores", "floor_covering_stores", "florists", "florists_supplies_nursery_stock_and_flowers", "freezer_and_locker_meat_provisioners", "fuel_dealers_non_automotive", "funeral_services_crematories", "furniture_home_furnishings_and_equipment_stores_except_appliances", "furniture_repair_refinishing", "furriers_and_fur_shops", "general_services", "gift_card_novelty_and_souvenir_shops", "glass_paint_and_wallpaper_stores", "glassware_crystal_stores", "golf_courses_public", "government_licensed_horse_dog_racing_us_region_only", "government_licensed_online_casions_online_gambling_us_region_only", "government_owned_lotteries_non_us_region", "government_owned_lotteries_us_region_only", "government_services", "grocery_stores_supermarkets", "hardware_equipment_and_supplies", "hardware_stores", "health_and_beauty_spas", "hearing_aids_sales_and_supplies", "heating_plumbing_a_c", "hobby_toy_and_game_shops", "home_supply_warehouse_stores", "hospitals", "hotels_motels_and_resorts", "household_appliance_stores", "industrial_supplies", "information_retrieval_services", "insurance_default", "insurance_underwriting_premiums", "intra_company_purchases", "jewelry_stores_watches_clocks_and_silverware_stores", "landscaping_services", "laundries", "laundry_cleaning_services", "legal_services_attorneys", "luggage_and_leather_goods_stores", "lumber_building_materials_stores", "manual_cash_disburse", "marinas_service_and_supplies", "marketplaces", "masonry_stonework_and_plaster", "massage_parlors", "medical_and_dental_labs", "medical_dental_ophthalmic_and_hospital_equipment_and_supplies", "medical_services", "membership_organizations", "mens_and_boys_clothing_and_accessories_stores", "mens_womens_clothing_stores", "metal_service_centers", "miscellaneous", "miscellaneous_apparel_and_accessory_shops", "miscellaneous_auto_dealers", "miscellaneous_business_services", "miscellaneous_food_stores", "miscellaneous_general_merchandise", "miscellaneous_general_services", "miscellaneous_home_furnishing_specialty_stores", "miscellaneous_publishing_and_printing", "miscellaneous_recreation_services", "miscellaneous_repair_shops", "miscellaneous_specialty_retail", "mobile_home_dealers", "motion_picture_theaters", "motor_freight_carriers_and_trucking", "motor_homes_dealers", "motor_vehicle_supplies_and_new_parts", "motorcycle_shops_and_dealers", "motorcycle_shops_dealers", "music_stores_musical_instruments_pianos_and_sheet_music", "news_dealers_and_newsstands", "non_fi_money_orders", "non_fi_stored_value_card_purchase_load", "nondurable_goods", "nurseries_lawn_and_garden_supply_stores", "nursing_personal_care", "office_and_commercial_furniture", "opticians_eyeglasses", "optometrists_ophthalmologist", "orthopedic_goods_prosthetic_devices", "osteopaths", "package_stores_beer_wine_and_liquor", "paints_varnishes_and_supplies", "parking_lots_garages", "passenger_railways", "pawn_shops", "pet_shops_pet_food_and_supplies", "petroleum_and_petroleum_products", "photo_developing", "photographic_photocopy_microfilm_equipment_and_supplies", "photographic_studios", "picture_video_production", "piece_goods_notions_and_other_dry_goods", "plumbing_heating_equipment_and_supplies", "political_organizations", "postal_services_government_only", "precious_stones_and_metals_watches_and_jewelry", "professional_services", "public_warehousing_and_storage", "quick_copy_repro_and_blueprint", "railroads", "real_estate_agents_and_managers_rentals", "record_stores", "recreational_vehicle_rentals", "religious_goods_stores", "religious_organizations", "roofing_siding_sheet_metal", "secretarial_support_services", "security_brokers_dealers", "service_stations", "sewing_needlework_fabric_and_piece_goods_stores", "shoe_repair_hat_cleaning", "shoe_stores", "small_appliance_repair", "snowmobile_dealers", "special_trade_services", "specialty_cleaning", "sporting_goods_stores", "sporting_recreation_camps", "sports_and_riding_apparel_stores", "sports_clubs_fields", "stamp_and_coin_stores", "stationary_office_supplies_printing_and_writing_paper", "stationery_stores_office_and_school_supply_stores", "swimming_pools_sales", "t_ui_travel_germany", "tailors_alterations", "tax_payments_government_agencies", "tax_preparation_services", "taxicabs_limousines", "telecommunication_equipment_and_telephone_sales", "telecommunication_services", "telegraph_services", "tent_and_awning_shops", "testing_laboratories", "theatrical_ticket_agencies", "timeshares", "tire_retreading_and_repair", "tolls_bridge_fees", "tourist_attractions_and_exhibits", "towing_services", "trailer_parks_campgrounds", "transportation_services", "travel_agencies_tour_operators", "truck_stop_iteration", "truck_utility_trailer_rentals", "typesetting_plate_making_and_related_services", "typewriter_stores", "u_s_federal_government_agencies_or_departments", "uniforms_commercial_clothing", "used_merchandise_and_secondhand_stores", "utilities", "variety_stores", "veterinary_services", "video_amusement_game_supplies", "video_game_arcades", "video_tape_rental_stores", "vocational_trade_schools", "watch_jewelry_repair", "welding_repair", "wholesale_clubs", "wig_and_toupee_stores", "wires_money_orders", "womens_accessory_and_specialty_shops", "womens_ready_to_wear_stores", "wrecking_and_salvage_yards" ], "maxLength": 5000, "type": "string" }, "type": "array" }, "allowed_merchant_countries": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "blocked_categories": { "items": { "enum": [ "ac_refrigeration_repair", "accounting_bookkeeping_services", "advertising_services", "agricultural_cooperative", "airlines_air_carriers", "airports_flying_fields", "ambulance_services", "amusement_parks_carnivals", "antique_reproductions", "antique_shops", "aquariums", "architectural_surveying_services", "art_dealers_and_galleries", "artists_supply_and_craft_shops", "auto_and_home_supply_stores", "auto_body_repair_shops", "auto_paint_shops", "auto_service_shops", "automated_cash_disburse", "automated_fuel_dispensers", "automobile_associations", "automotive_parts_and_accessories_stores", "automotive_tire_stores", "bail_and_bond_payments", "bakeries", "bands_orchestras", "barber_and_beauty_shops", "betting_casino_gambling", "bicycle_shops", "billiard_pool_establishments", "boat_dealers", "boat_rentals_and_leases", "book_stores", "books_periodicals_and_newspapers", "bowling_alleys", "bus_lines", "business_secretarial_schools", "buying_shopping_services", "cable_satellite_and_other_pay_television_and_radio", "camera_and_photographic_supply_stores", "candy_nut_and_confectionery_stores", "car_and_truck_dealers_new_used", "car_and_truck_dealers_used_only", "car_rental_agencies", "car_washes", "carpentry_services", "carpet_upholstery_cleaning", "caterers", "charitable_and_social_service_organizations_fundraising", "chemicals_and_allied_products", "child_care_services", "childrens_and_infants_wear_stores", "chiropodists_podiatrists", "chiropractors", "cigar_stores_and_stands", "civic_social_fraternal_associations", "cleaning_and_maintenance", "clothing_rental", "colleges_universities", "commercial_equipment", "commercial_footwear", "commercial_photography_art_and_graphics", "commuter_transport_and_ferries", "computer_network_services", "computer_programming", "computer_repair", "computer_software_stores", "computers_peripherals_and_software", "concrete_work_services", "construction_materials", "consulting_public_relations", "correspondence_schools", "cosmetic_stores", "counseling_services", "country_clubs", "courier_services", "court_costs", "credit_reporting_agencies", "cruise_lines", "dairy_products_stores", "dance_hall_studios_schools", "dating_escort_services", "dentists_orthodontists", "department_stores", "detective_agencies", "digital_goods_applications", "digital_goods_games", "digital_goods_large_volume", "digital_goods_media", "direct_marketing_catalog_merchant", "direct_marketing_combination_catalog_and_retail_merchant", "direct_marketing_inbound_telemarketing", "direct_marketing_insurance_services", "direct_marketing_other", "direct_marketing_outbound_telemarketing", "direct_marketing_subscription", "direct_marketing_travel", "discount_stores", "doctors", "door_to_door_sales", "drapery_window_covering_and_upholstery_stores", "drinking_places", "drug_stores_and_pharmacies", "drugs_drug_proprietaries_and_druggist_sundries", "dry_cleaners", "durable_goods", "duty_free_stores", "eating_places_restaurants", "educational_services", "electric_razor_stores", "electric_vehicle_charging", "electrical_parts_and_equipment", "electrical_services", "electronics_repair_shops", "electronics_stores", "elementary_secondary_schools", "emergency_services_gcas_visa_use_only", "employment_temp_agencies", "equipment_rental", "exterminating_services", "family_clothing_stores", "fast_food_restaurants", "financial_institutions", "fines_government_administrative_entities", "fireplace_fireplace_screens_and_accessories_stores", "floor_covering_stores", "florists", "florists_supplies_nursery_stock_and_flowers", "freezer_and_locker_meat_provisioners", "fuel_dealers_non_automotive", "funeral_services_crematories", "furniture_home_furnishings_and_equipment_stores_except_appliances", "furniture_repair_refinishing", "furriers_and_fur_shops", "general_services", "gift_card_novelty_and_souvenir_shops", "glass_paint_and_wallpaper_stores", "glassware_crystal_stores", "golf_courses_public", "government_licensed_horse_dog_racing_us_region_only", "government_licensed_online_casions_online_gambling_us_region_only", "government_owned_lotteries_non_us_region", "government_owned_lotteries_us_region_only", "government_services", "grocery_stores_supermarkets", "hardware_equipment_and_supplies", "hardware_stores", "health_and_beauty_spas", "hearing_aids_sales_and_supplies", "heating_plumbing_a_c", "hobby_toy_and_game_shops", "home_supply_warehouse_stores", "hospitals", "hotels_motels_and_resorts", "household_appliance_stores", "industrial_supplies", "information_retrieval_services", "insurance_default", "insurance_underwriting_premiums", "intra_company_purchases", "jewelry_stores_watches_clocks_and_silverware_stores", "landscaping_services", "laundries", "laundry_cleaning_services", "legal_services_attorneys", "luggage_and_leather_goods_stores", "lumber_building_materials_stores", "manual_cash_disburse", "marinas_service_and_supplies", "marketplaces", "masonry_stonework_and_plaster", "massage_parlors", "medical_and_dental_labs", "medical_dental_ophthalmic_and_hospital_equipment_and_supplies", "medical_services", "membership_organizations", "mens_and_boys_clothing_and_accessories_stores", "mens_womens_clothing_stores", "metal_service_centers", "miscellaneous", "miscellaneous_apparel_and_accessory_shops", "miscellaneous_auto_dealers", "miscellaneous_business_services", "miscellaneous_food_stores", "miscellaneous_general_merchandise", "miscellaneous_general_services", "miscellaneous_home_furnishing_specialty_stores", "miscellaneous_publishing_and_printing", "miscellaneous_recreation_services", "miscellaneous_repair_shops", "miscellaneous_specialty_retail", "mobile_home_dealers", "motion_picture_theaters", "motor_freight_carriers_and_trucking", "motor_homes_dealers", "motor_vehicle_supplies_and_new_parts", "motorcycle_shops_and_dealers", "motorcycle_shops_dealers", "music_stores_musical_instruments_pianos_and_sheet_music", "news_dealers_and_newsstands", "non_fi_money_orders", "non_fi_stored_value_card_purchase_load", "nondurable_goods", "nurseries_lawn_and_garden_supply_stores", "nursing_personal_care", "office_and_commercial_furniture", "opticians_eyeglasses", "optometrists_ophthalmologist", "orthopedic_goods_prosthetic_devices", "osteopaths", "package_stores_beer_wine_and_liquor", "paints_varnishes_and_supplies", "parking_lots_garages", "passenger_railways", "pawn_shops", "pet_shops_pet_food_and_supplies", "petroleum_and_petroleum_products", "photo_developing", "photographic_photocopy_microfilm_equipment_and_supplies", "photographic_studios", "picture_video_production", "piece_goods_notions_and_other_dry_goods", "plumbing_heating_equipment_and_supplies", "political_organizations", "postal_services_government_only", "precious_stones_and_metals_watches_and_jewelry", "professional_services", "public_warehousing_and_storage", "quick_copy_repro_and_blueprint", "railroads", "real_estate_agents_and_managers_rentals", "record_stores", "recreational_vehicle_rentals", "religious_goods_stores", "religious_organizations", "roofing_siding_sheet_metal", "secretarial_support_services", "security_brokers_dealers", "service_stations", "sewing_needlework_fabric_and_piece_goods_stores", "shoe_repair_hat_cleaning", "shoe_stores", "small_appliance_repair", "snowmobile_dealers", "special_trade_services", "specialty_cleaning", "sporting_goods_stores", "sporting_recreation_camps", "sports_and_riding_apparel_stores", "sports_clubs_fields", "stamp_and_coin_stores", "stationary_office_supplies_printing_and_writing_paper", "stationery_stores_office_and_school_supply_stores", "swimming_pools_sales", "t_ui_travel_germany", "tailors_alterations", "tax_payments_government_agencies", "tax_preparation_services", "taxicabs_limousines", "telecommunication_equipment_and_telephone_sales", "telecommunication_services", "telegraph_services", "tent_and_awning_shops", "testing_laboratories", "theatrical_ticket_agencies", "timeshares", "tire_retreading_and_repair", "tolls_bridge_fees", "tourist_attractions_and_exhibits", "towing_services", "trailer_parks_campgrounds", "transportation_services", "travel_agencies_tour_operators", "truck_stop_iteration", "truck_utility_trailer_rentals", "typesetting_plate_making_and_related_services", "typewriter_stores", "u_s_federal_government_agencies_or_departments", "uniforms_commercial_clothing", "used_merchandise_and_secondhand_stores", "utilities", "variety_stores", "veterinary_services", "video_amusement_game_supplies", "video_game_arcades", "video_tape_rental_stores", "vocational_trade_schools", "watch_jewelry_repair", "welding_repair", "wholesale_clubs", "wig_and_toupee_stores", "wires_money_orders", "womens_accessory_and_specialty_shops", "womens_ready_to_wear_stores", "wrecking_and_salvage_yards" ], "maxLength": 5000, "type": "string" }, "type": "array" }, "blocked_merchant_countries": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "spending_limits": { "items": { "properties": { "amount": { "type": "integer" }, "categories": { "items": { "enum": [ "ac_refrigeration_repair", "accounting_bookkeeping_services", "advertising_services", "agricultural_cooperative", "airlines_air_carriers", "airports_flying_fields", "ambulance_services", "amusement_parks_carnivals", "antique_reproductions", "antique_shops", "aquariums", "architectural_surveying_services", "art_dealers_and_galleries", "artists_supply_and_craft_shops", "auto_and_home_supply_stores", "auto_body_repair_shops", "auto_paint_shops", "auto_service_shops", "automated_cash_disburse", "automated_fuel_dispensers", "automobile_associations", "automotive_parts_and_accessories_stores", "automotive_tire_stores", "bail_and_bond_payments", "bakeries", "bands_orchestras", "barber_and_beauty_shops", "betting_casino_gambling", "bicycle_shops", "billiard_pool_establishments", "boat_dealers", "boat_rentals_and_leases", "book_stores", "books_periodicals_and_newspapers", "bowling_alleys", "bus_lines", "business_secretarial_schools", "buying_shopping_services", "cable_satellite_and_other_pay_television_and_radio", "camera_and_photographic_supply_stores", "candy_nut_and_confectionery_stores", "car_and_truck_dealers_new_used", "car_and_truck_dealers_used_only", "car_rental_agencies", "car_washes", "carpentry_services", "carpet_upholstery_cleaning", "caterers", "charitable_and_social_service_organizations_fundraising", "chemicals_and_allied_products", "child_care_services", "childrens_and_infants_wear_stores", "chiropodists_podiatrists", "chiropractors", "cigar_stores_and_stands", "civic_social_fraternal_associations", "cleaning_and_maintenance", "clothing_rental", "colleges_universities", "commercial_equipment", "commercial_footwear", "commercial_photography_art_and_graphics", "commuter_transport_and_ferries", "computer_network_services", "computer_programming", "computer_repair", "computer_software_stores", "computers_peripherals_and_software", "concrete_work_services", "construction_materials", "consulting_public_relations", "correspondence_schools", "cosmetic_stores", "counseling_services", "country_clubs", "courier_services", "court_costs", "credit_reporting_agencies", "cruise_lines", "dairy_products_stores", "dance_hall_studios_schools", "dating_escort_services", "dentists_orthodontists", "department_stores", "detective_agencies", "digital_goods_applications", "digital_goods_games", "digital_goods_large_volume", "digital_goods_media", "direct_marketing_catalog_merchant", "direct_marketing_combination_catalog_and_retail_merchant", "direct_marketing_inbound_telemarketing", "direct_marketing_insurance_services", "direct_marketing_other", "direct_marketing_outbound_telemarketing", "direct_marketing_subscription", "direct_marketing_travel", "discount_stores", "doctors", "door_to_door_sales", "drapery_window_covering_and_upholstery_stores", "drinking_places", "drug_stores_and_pharmacies", "drugs_drug_proprietaries_and_druggist_sundries", "dry_cleaners", "durable_goods", "duty_free_stores", "eating_places_restaurants", "educational_services", "electric_razor_stores", "electric_vehicle_charging", "electrical_parts_and_equipment", "electrical_services", "electronics_repair_shops", "electronics_stores", "elementary_secondary_schools", "emergency_services_gcas_visa_use_only", "employment_temp_agencies", "equipment_rental", "exterminating_services", "family_clothing_stores", "fast_food_restaurants", "financial_institutions", "fines_government_administrative_entities", "fireplace_fireplace_screens_and_accessories_stores", "floor_covering_stores", "florists", "florists_supplies_nursery_stock_and_flowers", "freezer_and_locker_meat_provisioners", "fuel_dealers_non_automotive", "funeral_services_crematories", "furniture_home_furnishings_and_equipment_stores_except_appliances", "furniture_repair_refinishing", "furriers_and_fur_shops", "general_services", "gift_card_novelty_and_souvenir_shops", "glass_paint_and_wallpaper_stores", "glassware_crystal_stores", "golf_courses_public", "government_licensed_horse_dog_racing_us_region_only", "government_licensed_online_casions_online_gambling_us_region_only", "government_owned_lotteries_non_us_region", "government_owned_lotteries_us_region_only", "government_services", "grocery_stores_supermarkets", "hardware_equipment_and_supplies", "hardware_stores", "health_and_beauty_spas", "hearing_aids_sales_and_supplies", "heating_plumbing_a_c", "hobby_toy_and_game_shops", "home_supply_warehouse_stores", "hospitals", "hotels_motels_and_resorts", "household_appliance_stores", "industrial_supplies", "information_retrieval_services", "insurance_default", "insurance_underwriting_premiums", "intra_company_purchases", "jewelry_stores_watches_clocks_and_silverware_stores", "landscaping_services", "laundries", "laundry_cleaning_services", "legal_services_attorneys", "luggage_and_leather_goods_stores", "lumber_building_materials_stores", "manual_cash_disburse", "marinas_service_and_supplies", "marketplaces", "masonry_stonework_and_plaster", "massage_parlors", "medical_and_dental_labs", "medical_dental_ophthalmic_and_hospital_equipment_and_supplies", "medical_services", "membership_organizations", "mens_and_boys_clothing_and_accessories_stores", "mens_womens_clothing_stores", "metal_service_centers", "miscellaneous", "miscellaneous_apparel_and_accessory_shops", "miscellaneous_auto_dealers", "miscellaneous_business_services", "miscellaneous_food_stores", "miscellaneous_general_merchandise", "miscellaneous_general_services", "miscellaneous_home_furnishing_specialty_stores", "miscellaneous_publishing_and_printing", "miscellaneous_recreation_services", "miscellaneous_repair_shops", "miscellaneous_specialty_retail", "mobile_home_dealers", "motion_picture_theaters", "motor_freight_carriers_and_trucking", "motor_homes_dealers", "motor_vehicle_supplies_and_new_parts", "motorcycle_shops_and_dealers", "motorcycle_shops_dealers", "music_stores_musical_instruments_pianos_and_sheet_music", "news_dealers_and_newsstands", "non_fi_money_orders", "non_fi_stored_value_card_purchase_load", "nondurable_goods", "nurseries_lawn_and_garden_supply_stores", "nursing_personal_care", "office_and_commercial_furniture", "opticians_eyeglasses", "optometrists_ophthalmologist", "orthopedic_goods_prosthetic_devices", "osteopaths", "package_stores_beer_wine_and_liquor", "paints_varnishes_and_supplies", "parking_lots_garages", "passenger_railways", "pawn_shops", "pet_shops_pet_food_and_supplies", "petroleum_and_petroleum_products", "photo_developing", "photographic_photocopy_microfilm_equipment_and_supplies", "photographic_studios", "picture_video_production", "piece_goods_notions_and_other_dry_goods", "plumbing_heating_equipment_and_supplies", "political_organizations", "postal_services_government_only", "precious_stones_and_metals_watches_and_jewelry", "professional_services", "public_warehousing_and_storage", "quick_copy_repro_and_blueprint", "railroads", "real_estate_agents_and_managers_rentals", "record_stores", "recreational_vehicle_rentals", "religious_goods_stores", "religious_organizations", "roofing_siding_sheet_metal", "secretarial_support_services", "security_brokers_dealers", "service_stations", "sewing_needlework_fabric_and_piece_goods_stores", "shoe_repair_hat_cleaning", "shoe_stores", "small_appliance_repair", "snowmobile_dealers", "special_trade_services", "specialty_cleaning", "sporting_goods_stores", "sporting_recreation_camps", "sports_and_riding_apparel_stores", "sports_clubs_fields", "stamp_and_coin_stores", "stationary_office_supplies_printing_and_writing_paper", "stationery_stores_office_and_school_supply_stores", "swimming_pools_sales", "t_ui_travel_germany", "tailors_alterations", "tax_payments_government_agencies", "tax_preparation_services", "taxicabs_limousines", "telecommunication_equipment_and_telephone_sales", "telecommunication_services", "telegraph_services", "tent_and_awning_shops", "testing_laboratories", "theatrical_ticket_agencies", "timeshares", "tire_retreading_and_repair", "tolls_bridge_fees", "tourist_attractions_and_exhibits", "towing_services", "trailer_parks_campgrounds", "transportation_services", "travel_agencies_tour_operators", "truck_stop_iteration", "truck_utility_trailer_rentals", "typesetting_plate_making_and_related_services", "typewriter_stores", "u_s_federal_government_agencies_or_departments", "uniforms_commercial_clothing", "used_merchandise_and_secondhand_stores", "utilities", "variety_stores", "veterinary_services", "video_amusement_game_supplies", "video_game_arcades", "video_tape_rental_stores", "vocational_trade_schools", "watch_jewelry_repair", "welding_repair", "wholesale_clubs", "wig_and_toupee_stores", "wires_money_orders", "womens_accessory_and_specialty_shops", "womens_ready_to_wear_stores", "wrecking_and_salvage_yards" ], "maxLength": 5000, "type": "string" }, "type": "array" }, "interval": { "enum": [ "all_time", "daily", "monthly", "per_authorization", "weekly", "yearly" ], "type": "string" } }, "required": [ "amount", "interval" ], "title": "spending_limits_param", "type": "object" }, "type": "array" }, "spending_limits_currency": { "type": "string" } }, "title": "authorization_controls_param_v2", "type": "object" }, "status": { "description": "Specifies whether to permit authorizations on this cardholder's cards. Defaults to `active`.", "enum": [ "active", "inactive" ], "type": "string" }, "type": { "description": "One of `individual` or `company`. See [Choose a cardholder type](https://stripe.com/docs/issuing/other/choose-cardholder) for more details.", "enum": [ "company", "individual" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "billing", "name" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issuing.cardholder" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a cardholder" } }, "/v1/issuing/cardholders/{cardholder}": { "get": { "description": "

Retrieves an Issuing Cardholder object.

", "operationId": "GetIssuingCardholdersCardholder", "parameters": [ { "in": "path", "name": "cardholder", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issuing.cardholder" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a cardholder" }, "post": { "description": "

Updates the specified Issuing Cardholder object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

", "operationId": "PostIssuingCardholdersCardholder", "parameters": [ { "in": "path", "name": "cardholder", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "billing": { "explode": true, "style": "deepObject" }, "company": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "individual": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "preferred_locales": { "explode": true, "style": "deepObject" }, "spending_controls": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "billing": { "description": "The cardholder's billing address.", "properties": { "address": { "properties": { "city": { "maxLength": 5000, "type": "string" }, "country": { "maxLength": 5000, "type": "string" }, "line1": { "maxLength": 5000, "type": "string" }, "line2": { "maxLength": 5000, "type": "string" }, "postal_code": { "maxLength": 5000, "type": "string" }, "state": { "maxLength": 5000, "type": "string" } }, "required": [ "city", "country", "line1", "postal_code" ], "title": "required_address", "type": "object" } }, "required": [ "address" ], "title": "billing_specs", "type": "object" }, "company": { "description": "Additional information about a `company` cardholder.", "properties": { "tax_id": { "maxLength": 5000, "type": "string" } }, "title": "company_param", "type": "object" }, "email": { "description": "The cardholder's email address.", "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "individual": { "description": "Additional information about an `individual` cardholder.", "properties": { "card_issuing": { "properties": { "user_terms_acceptance": { "properties": { "date": { "format": "unix-time", "type": "integer" }, "ip": { "type": "string" }, "user_agent": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "terms_acceptance_param", "type": "object" } }, "title": "card_issuing_param", "type": "object" }, "dob": { "properties": { "day": { "type": "integer" }, "month": { "type": "integer" }, "year": { "type": "integer" } }, "required": [ "day", "month", "year" ], "title": "date_of_birth_specs", "type": "object" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "verification": { "properties": { "document": { "properties": { "back": { "maxLength": 5000, "type": "string" }, "front": { "maxLength": 5000, "type": "string" } }, "title": "person_verification_document_param", "type": "object" } }, "title": "person_verification_param", "type": "object" } }, "title": "individual_param", "type": "object" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "phone_number": { "description": "The cardholder's phone number. This is required for all cardholders who will be creating EU cards. See the [3D Secure documentation](https://stripe.com/docs/issuing/3d-secure) for more details.", "type": "string" }, "preferred_locales": { "description": "The cardholder’s preferred locales (languages), ordered by preference. Locales can be `de`, `en`, `es`, `fr`, or `it`.\n This changes the language of the [3D Secure flow](https://stripe.com/docs/issuing/3d-secure) and one-time password messages sent to the cardholder.", "items": { "enum": [ "de", "en", "es", "fr", "it" ], "type": "string" }, "type": "array" }, "spending_controls": { "description": "Rules that control spending across this cardholder's cards. Refer to our [documentation](https://stripe.com/docs/issuing/controls/spending-controls) for more details.", "properties": { "allowed_categories": { "items": { "enum": [ "ac_refrigeration_repair", "accounting_bookkeeping_services", "advertising_services", "agricultural_cooperative", "airlines_air_carriers", "airports_flying_fields", "ambulance_services", "amusement_parks_carnivals", "antique_reproductions", "antique_shops", "aquariums", "architectural_surveying_services", "art_dealers_and_galleries", "artists_supply_and_craft_shops", "auto_and_home_supply_stores", "auto_body_repair_shops", "auto_paint_shops", "auto_service_shops", "automated_cash_disburse", "automated_fuel_dispensers", "automobile_associations", "automotive_parts_and_accessories_stores", "automotive_tire_stores", "bail_and_bond_payments", "bakeries", "bands_orchestras", "barber_and_beauty_shops", "betting_casino_gambling", "bicycle_shops", "billiard_pool_establishments", "boat_dealers", "boat_rentals_and_leases", "book_stores", "books_periodicals_and_newspapers", "bowling_alleys", "bus_lines", "business_secretarial_schools", "buying_shopping_services", "cable_satellite_and_other_pay_television_and_radio", "camera_and_photographic_supply_stores", "candy_nut_and_confectionery_stores", "car_and_truck_dealers_new_used", "car_and_truck_dealers_used_only", "car_rental_agencies", "car_washes", "carpentry_services", "carpet_upholstery_cleaning", "caterers", "charitable_and_social_service_organizations_fundraising", "chemicals_and_allied_products", "child_care_services", "childrens_and_infants_wear_stores", "chiropodists_podiatrists", "chiropractors", "cigar_stores_and_stands", "civic_social_fraternal_associations", "cleaning_and_maintenance", "clothing_rental", "colleges_universities", "commercial_equipment", "commercial_footwear", "commercial_photography_art_and_graphics", "commuter_transport_and_ferries", "computer_network_services", "computer_programming", "computer_repair", "computer_software_stores", "computers_peripherals_and_software", "concrete_work_services", "construction_materials", "consulting_public_relations", "correspondence_schools", "cosmetic_stores", "counseling_services", "country_clubs", "courier_services", "court_costs", "credit_reporting_agencies", "cruise_lines", "dairy_products_stores", "dance_hall_studios_schools", "dating_escort_services", "dentists_orthodontists", "department_stores", "detective_agencies", "digital_goods_applications", "digital_goods_games", "digital_goods_large_volume", "digital_goods_media", "direct_marketing_catalog_merchant", "direct_marketing_combination_catalog_and_retail_merchant", "direct_marketing_inbound_telemarketing", "direct_marketing_insurance_services", "direct_marketing_other", "direct_marketing_outbound_telemarketing", "direct_marketing_subscription", "direct_marketing_travel", "discount_stores", "doctors", "door_to_door_sales", "drapery_window_covering_and_upholstery_stores", "drinking_places", "drug_stores_and_pharmacies", "drugs_drug_proprietaries_and_druggist_sundries", "dry_cleaners", "durable_goods", "duty_free_stores", "eating_places_restaurants", "educational_services", "electric_razor_stores", "electric_vehicle_charging", "electrical_parts_and_equipment", "electrical_services", "electronics_repair_shops", "electronics_stores", "elementary_secondary_schools", "emergency_services_gcas_visa_use_only", "employment_temp_agencies", "equipment_rental", "exterminating_services", "family_clothing_stores", "fast_food_restaurants", "financial_institutions", "fines_government_administrative_entities", "fireplace_fireplace_screens_and_accessories_stores", "floor_covering_stores", "florists", "florists_supplies_nursery_stock_and_flowers", "freezer_and_locker_meat_provisioners", "fuel_dealers_non_automotive", "funeral_services_crematories", "furniture_home_furnishings_and_equipment_stores_except_appliances", "furniture_repair_refinishing", "furriers_and_fur_shops", "general_services", "gift_card_novelty_and_souvenir_shops", "glass_paint_and_wallpaper_stores", "glassware_crystal_stores", "golf_courses_public", "government_licensed_horse_dog_racing_us_region_only", "government_licensed_online_casions_online_gambling_us_region_only", "government_owned_lotteries_non_us_region", "government_owned_lotteries_us_region_only", "government_services", "grocery_stores_supermarkets", "hardware_equipment_and_supplies", "hardware_stores", "health_and_beauty_spas", "hearing_aids_sales_and_supplies", "heating_plumbing_a_c", "hobby_toy_and_game_shops", "home_supply_warehouse_stores", "hospitals", "hotels_motels_and_resorts", "household_appliance_stores", "industrial_supplies", "information_retrieval_services", "insurance_default", "insurance_underwriting_premiums", "intra_company_purchases", "jewelry_stores_watches_clocks_and_silverware_stores", "landscaping_services", "laundries", "laundry_cleaning_services", "legal_services_attorneys", "luggage_and_leather_goods_stores", "lumber_building_materials_stores", "manual_cash_disburse", "marinas_service_and_supplies", "marketplaces", "masonry_stonework_and_plaster", "massage_parlors", "medical_and_dental_labs", "medical_dental_ophthalmic_and_hospital_equipment_and_supplies", "medical_services", "membership_organizations", "mens_and_boys_clothing_and_accessories_stores", "mens_womens_clothing_stores", "metal_service_centers", "miscellaneous", "miscellaneous_apparel_and_accessory_shops", "miscellaneous_auto_dealers", "miscellaneous_business_services", "miscellaneous_food_stores", "miscellaneous_general_merchandise", "miscellaneous_general_services", "miscellaneous_home_furnishing_specialty_stores", "miscellaneous_publishing_and_printing", "miscellaneous_recreation_services", "miscellaneous_repair_shops", "miscellaneous_specialty_retail", "mobile_home_dealers", "motion_picture_theaters", "motor_freight_carriers_and_trucking", "motor_homes_dealers", "motor_vehicle_supplies_and_new_parts", "motorcycle_shops_and_dealers", "motorcycle_shops_dealers", "music_stores_musical_instruments_pianos_and_sheet_music", "news_dealers_and_newsstands", "non_fi_money_orders", "non_fi_stored_value_card_purchase_load", "nondurable_goods", "nurseries_lawn_and_garden_supply_stores", "nursing_personal_care", "office_and_commercial_furniture", "opticians_eyeglasses", "optometrists_ophthalmologist", "orthopedic_goods_prosthetic_devices", "osteopaths", "package_stores_beer_wine_and_liquor", "paints_varnishes_and_supplies", "parking_lots_garages", "passenger_railways", "pawn_shops", "pet_shops_pet_food_and_supplies", "petroleum_and_petroleum_products", "photo_developing", "photographic_photocopy_microfilm_equipment_and_supplies", "photographic_studios", "picture_video_production", "piece_goods_notions_and_other_dry_goods", "plumbing_heating_equipment_and_supplies", "political_organizations", "postal_services_government_only", "precious_stones_and_metals_watches_and_jewelry", "professional_services", "public_warehousing_and_storage", "quick_copy_repro_and_blueprint", "railroads", "real_estate_agents_and_managers_rentals", "record_stores", "recreational_vehicle_rentals", "religious_goods_stores", "religious_organizations", "roofing_siding_sheet_metal", "secretarial_support_services", "security_brokers_dealers", "service_stations", "sewing_needlework_fabric_and_piece_goods_stores", "shoe_repair_hat_cleaning", "shoe_stores", "small_appliance_repair", "snowmobile_dealers", "special_trade_services", "specialty_cleaning", "sporting_goods_stores", "sporting_recreation_camps", "sports_and_riding_apparel_stores", "sports_clubs_fields", "stamp_and_coin_stores", "stationary_office_supplies_printing_and_writing_paper", "stationery_stores_office_and_school_supply_stores", "swimming_pools_sales", "t_ui_travel_germany", "tailors_alterations", "tax_payments_government_agencies", "tax_preparation_services", "taxicabs_limousines", "telecommunication_equipment_and_telephone_sales", "telecommunication_services", "telegraph_services", "tent_and_awning_shops", "testing_laboratories", "theatrical_ticket_agencies", "timeshares", "tire_retreading_and_repair", "tolls_bridge_fees", "tourist_attractions_and_exhibits", "towing_services", "trailer_parks_campgrounds", "transportation_services", "travel_agencies_tour_operators", "truck_stop_iteration", "truck_utility_trailer_rentals", "typesetting_plate_making_and_related_services", "typewriter_stores", "u_s_federal_government_agencies_or_departments", "uniforms_commercial_clothing", "used_merchandise_and_secondhand_stores", "utilities", "variety_stores", "veterinary_services", "video_amusement_game_supplies", "video_game_arcades", "video_tape_rental_stores", "vocational_trade_schools", "watch_jewelry_repair", "welding_repair", "wholesale_clubs", "wig_and_toupee_stores", "wires_money_orders", "womens_accessory_and_specialty_shops", "womens_ready_to_wear_stores", "wrecking_and_salvage_yards" ], "maxLength": 5000, "type": "string" }, "type": "array" }, "allowed_merchant_countries": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "blocked_categories": { "items": { "enum": [ "ac_refrigeration_repair", "accounting_bookkeeping_services", "advertising_services", "agricultural_cooperative", "airlines_air_carriers", "airports_flying_fields", "ambulance_services", "amusement_parks_carnivals", "antique_reproductions", "antique_shops", "aquariums", "architectural_surveying_services", "art_dealers_and_galleries", "artists_supply_and_craft_shops", "auto_and_home_supply_stores", "auto_body_repair_shops", "auto_paint_shops", "auto_service_shops", "automated_cash_disburse", "automated_fuel_dispensers", "automobile_associations", "automotive_parts_and_accessories_stores", "automotive_tire_stores", "bail_and_bond_payments", "bakeries", "bands_orchestras", "barber_and_beauty_shops", "betting_casino_gambling", "bicycle_shops", "billiard_pool_establishments", "boat_dealers", "boat_rentals_and_leases", "book_stores", "books_periodicals_and_newspapers", "bowling_alleys", "bus_lines", "business_secretarial_schools", "buying_shopping_services", "cable_satellite_and_other_pay_television_and_radio", "camera_and_photographic_supply_stores", "candy_nut_and_confectionery_stores", "car_and_truck_dealers_new_used", "car_and_truck_dealers_used_only", "car_rental_agencies", "car_washes", "carpentry_services", "carpet_upholstery_cleaning", "caterers", "charitable_and_social_service_organizations_fundraising", "chemicals_and_allied_products", "child_care_services", "childrens_and_infants_wear_stores", "chiropodists_podiatrists", "chiropractors", "cigar_stores_and_stands", "civic_social_fraternal_associations", "cleaning_and_maintenance", "clothing_rental", "colleges_universities", "commercial_equipment", "commercial_footwear", "commercial_photography_art_and_graphics", "commuter_transport_and_ferries", "computer_network_services", "computer_programming", "computer_repair", "computer_software_stores", "computers_peripherals_and_software", "concrete_work_services", "construction_materials", "consulting_public_relations", "correspondence_schools", "cosmetic_stores", "counseling_services", "country_clubs", "courier_services", "court_costs", "credit_reporting_agencies", "cruise_lines", "dairy_products_stores", "dance_hall_studios_schools", "dating_escort_services", "dentists_orthodontists", "department_stores", "detective_agencies", "digital_goods_applications", "digital_goods_games", "digital_goods_large_volume", "digital_goods_media", "direct_marketing_catalog_merchant", "direct_marketing_combination_catalog_and_retail_merchant", "direct_marketing_inbound_telemarketing", "direct_marketing_insurance_services", "direct_marketing_other", "direct_marketing_outbound_telemarketing", "direct_marketing_subscription", "direct_marketing_travel", "discount_stores", "doctors", "door_to_door_sales", "drapery_window_covering_and_upholstery_stores", "drinking_places", "drug_stores_and_pharmacies", "drugs_drug_proprietaries_and_druggist_sundries", "dry_cleaners", "durable_goods", "duty_free_stores", "eating_places_restaurants", "educational_services", "electric_razor_stores", "electric_vehicle_charging", "electrical_parts_and_equipment", "electrical_services", "electronics_repair_shops", "electronics_stores", "elementary_secondary_schools", "emergency_services_gcas_visa_use_only", "employment_temp_agencies", "equipment_rental", "exterminating_services", "family_clothing_stores", "fast_food_restaurants", "financial_institutions", "fines_government_administrative_entities", "fireplace_fireplace_screens_and_accessories_stores", "floor_covering_stores", "florists", "florists_supplies_nursery_stock_and_flowers", "freezer_and_locker_meat_provisioners", "fuel_dealers_non_automotive", "funeral_services_crematories", "furniture_home_furnishings_and_equipment_stores_except_appliances", "furniture_repair_refinishing", "furriers_and_fur_shops", "general_services", "gift_card_novelty_and_souvenir_shops", "glass_paint_and_wallpaper_stores", "glassware_crystal_stores", "golf_courses_public", "government_licensed_horse_dog_racing_us_region_only", "government_licensed_online_casions_online_gambling_us_region_only", "government_owned_lotteries_non_us_region", "government_owned_lotteries_us_region_only", "government_services", "grocery_stores_supermarkets", "hardware_equipment_and_supplies", "hardware_stores", "health_and_beauty_spas", "hearing_aids_sales_and_supplies", "heating_plumbing_a_c", "hobby_toy_and_game_shops", "home_supply_warehouse_stores", "hospitals", "hotels_motels_and_resorts", "household_appliance_stores", "industrial_supplies", "information_retrieval_services", "insurance_default", "insurance_underwriting_premiums", "intra_company_purchases", "jewelry_stores_watches_clocks_and_silverware_stores", "landscaping_services", "laundries", "laundry_cleaning_services", "legal_services_attorneys", "luggage_and_leather_goods_stores", "lumber_building_materials_stores", "manual_cash_disburse", "marinas_service_and_supplies", "marketplaces", "masonry_stonework_and_plaster", "massage_parlors", "medical_and_dental_labs", "medical_dental_ophthalmic_and_hospital_equipment_and_supplies", "medical_services", "membership_organizations", "mens_and_boys_clothing_and_accessories_stores", "mens_womens_clothing_stores", "metal_service_centers", "miscellaneous", "miscellaneous_apparel_and_accessory_shops", "miscellaneous_auto_dealers", "miscellaneous_business_services", "miscellaneous_food_stores", "miscellaneous_general_merchandise", "miscellaneous_general_services", "miscellaneous_home_furnishing_specialty_stores", "miscellaneous_publishing_and_printing", "miscellaneous_recreation_services", "miscellaneous_repair_shops", "miscellaneous_specialty_retail", "mobile_home_dealers", "motion_picture_theaters", "motor_freight_carriers_and_trucking", "motor_homes_dealers", "motor_vehicle_supplies_and_new_parts", "motorcycle_shops_and_dealers", "motorcycle_shops_dealers", "music_stores_musical_instruments_pianos_and_sheet_music", "news_dealers_and_newsstands", "non_fi_money_orders", "non_fi_stored_value_card_purchase_load", "nondurable_goods", "nurseries_lawn_and_garden_supply_stores", "nursing_personal_care", "office_and_commercial_furniture", "opticians_eyeglasses", "optometrists_ophthalmologist", "orthopedic_goods_prosthetic_devices", "osteopaths", "package_stores_beer_wine_and_liquor", "paints_varnishes_and_supplies", "parking_lots_garages", "passenger_railways", "pawn_shops", "pet_shops_pet_food_and_supplies", "petroleum_and_petroleum_products", "photo_developing", "photographic_photocopy_microfilm_equipment_and_supplies", "photographic_studios", "picture_video_production", "piece_goods_notions_and_other_dry_goods", "plumbing_heating_equipment_and_supplies", "political_organizations", "postal_services_government_only", "precious_stones_and_metals_watches_and_jewelry", "professional_services", "public_warehousing_and_storage", "quick_copy_repro_and_blueprint", "railroads", "real_estate_agents_and_managers_rentals", "record_stores", "recreational_vehicle_rentals", "religious_goods_stores", "religious_organizations", "roofing_siding_sheet_metal", "secretarial_support_services", "security_brokers_dealers", "service_stations", "sewing_needlework_fabric_and_piece_goods_stores", "shoe_repair_hat_cleaning", "shoe_stores", "small_appliance_repair", "snowmobile_dealers", "special_trade_services", "specialty_cleaning", "sporting_goods_stores", "sporting_recreation_camps", "sports_and_riding_apparel_stores", "sports_clubs_fields", "stamp_and_coin_stores", "stationary_office_supplies_printing_and_writing_paper", "stationery_stores_office_and_school_supply_stores", "swimming_pools_sales", "t_ui_travel_germany", "tailors_alterations", "tax_payments_government_agencies", "tax_preparation_services", "taxicabs_limousines", "telecommunication_equipment_and_telephone_sales", "telecommunication_services", "telegraph_services", "tent_and_awning_shops", "testing_laboratories", "theatrical_ticket_agencies", "timeshares", "tire_retreading_and_repair", "tolls_bridge_fees", "tourist_attractions_and_exhibits", "towing_services", "trailer_parks_campgrounds", "transportation_services", "travel_agencies_tour_operators", "truck_stop_iteration", "truck_utility_trailer_rentals", "typesetting_plate_making_and_related_services", "typewriter_stores", "u_s_federal_government_agencies_or_departments", "uniforms_commercial_clothing", "used_merchandise_and_secondhand_stores", "utilities", "variety_stores", "veterinary_services", "video_amusement_game_supplies", "video_game_arcades", "video_tape_rental_stores", "vocational_trade_schools", "watch_jewelry_repair", "welding_repair", "wholesale_clubs", "wig_and_toupee_stores", "wires_money_orders", "womens_accessory_and_specialty_shops", "womens_ready_to_wear_stores", "wrecking_and_salvage_yards" ], "maxLength": 5000, "type": "string" }, "type": "array" }, "blocked_merchant_countries": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "spending_limits": { "items": { "properties": { "amount": { "type": "integer" }, "categories": { "items": { "enum": [ "ac_refrigeration_repair", "accounting_bookkeeping_services", "advertising_services", "agricultural_cooperative", "airlines_air_carriers", "airports_flying_fields", "ambulance_services", "amusement_parks_carnivals", "antique_reproductions", "antique_shops", "aquariums", "architectural_surveying_services", "art_dealers_and_galleries", "artists_supply_and_craft_shops", "auto_and_home_supply_stores", "auto_body_repair_shops", "auto_paint_shops", "auto_service_shops", "automated_cash_disburse", "automated_fuel_dispensers", "automobile_associations", "automotive_parts_and_accessories_stores", "automotive_tire_stores", "bail_and_bond_payments", "bakeries", "bands_orchestras", "barber_and_beauty_shops", "betting_casino_gambling", "bicycle_shops", "billiard_pool_establishments", "boat_dealers", "boat_rentals_and_leases", "book_stores", "books_periodicals_and_newspapers", "bowling_alleys", "bus_lines", "business_secretarial_schools", "buying_shopping_services", "cable_satellite_and_other_pay_television_and_radio", "camera_and_photographic_supply_stores", "candy_nut_and_confectionery_stores", "car_and_truck_dealers_new_used", "car_and_truck_dealers_used_only", "car_rental_agencies", "car_washes", "carpentry_services", "carpet_upholstery_cleaning", "caterers", "charitable_and_social_service_organizations_fundraising", "chemicals_and_allied_products", "child_care_services", "childrens_and_infants_wear_stores", "chiropodists_podiatrists", "chiropractors", "cigar_stores_and_stands", "civic_social_fraternal_associations", "cleaning_and_maintenance", "clothing_rental", "colleges_universities", "commercial_equipment", "commercial_footwear", "commercial_photography_art_and_graphics", "commuter_transport_and_ferries", "computer_network_services", "computer_programming", "computer_repair", "computer_software_stores", "computers_peripherals_and_software", "concrete_work_services", "construction_materials", "consulting_public_relations", "correspondence_schools", "cosmetic_stores", "counseling_services", "country_clubs", "courier_services", "court_costs", "credit_reporting_agencies", "cruise_lines", "dairy_products_stores", "dance_hall_studios_schools", "dating_escort_services", "dentists_orthodontists", "department_stores", "detective_agencies", "digital_goods_applications", "digital_goods_games", "digital_goods_large_volume", "digital_goods_media", "direct_marketing_catalog_merchant", "direct_marketing_combination_catalog_and_retail_merchant", "direct_marketing_inbound_telemarketing", "direct_marketing_insurance_services", "direct_marketing_other", "direct_marketing_outbound_telemarketing", "direct_marketing_subscription", "direct_marketing_travel", "discount_stores", "doctors", "door_to_door_sales", "drapery_window_covering_and_upholstery_stores", "drinking_places", "drug_stores_and_pharmacies", "drugs_drug_proprietaries_and_druggist_sundries", "dry_cleaners", "durable_goods", "duty_free_stores", "eating_places_restaurants", "educational_services", "electric_razor_stores", "electric_vehicle_charging", "electrical_parts_and_equipment", "electrical_services", "electronics_repair_shops", "electronics_stores", "elementary_secondary_schools", "emergency_services_gcas_visa_use_only", "employment_temp_agencies", "equipment_rental", "exterminating_services", "family_clothing_stores", "fast_food_restaurants", "financial_institutions", "fines_government_administrative_entities", "fireplace_fireplace_screens_and_accessories_stores", "floor_covering_stores", "florists", "florists_supplies_nursery_stock_and_flowers", "freezer_and_locker_meat_provisioners", "fuel_dealers_non_automotive", "funeral_services_crematories", "furniture_home_furnishings_and_equipment_stores_except_appliances", "furniture_repair_refinishing", "furriers_and_fur_shops", "general_services", "gift_card_novelty_and_souvenir_shops", "glass_paint_and_wallpaper_stores", "glassware_crystal_stores", "golf_courses_public", "government_licensed_horse_dog_racing_us_region_only", "government_licensed_online_casions_online_gambling_us_region_only", "government_owned_lotteries_non_us_region", "government_owned_lotteries_us_region_only", "government_services", "grocery_stores_supermarkets", "hardware_equipment_and_supplies", "hardware_stores", "health_and_beauty_spas", "hearing_aids_sales_and_supplies", "heating_plumbing_a_c", "hobby_toy_and_game_shops", "home_supply_warehouse_stores", "hospitals", "hotels_motels_and_resorts", "household_appliance_stores", "industrial_supplies", "information_retrieval_services", "insurance_default", "insurance_underwriting_premiums", "intra_company_purchases", "jewelry_stores_watches_clocks_and_silverware_stores", "landscaping_services", "laundries", "laundry_cleaning_services", "legal_services_attorneys", "luggage_and_leather_goods_stores", "lumber_building_materials_stores", "manual_cash_disburse", "marinas_service_and_supplies", "marketplaces", "masonry_stonework_and_plaster", "massage_parlors", "medical_and_dental_labs", "medical_dental_ophthalmic_and_hospital_equipment_and_supplies", "medical_services", "membership_organizations", "mens_and_boys_clothing_and_accessories_stores", "mens_womens_clothing_stores", "metal_service_centers", "miscellaneous", "miscellaneous_apparel_and_accessory_shops", "miscellaneous_auto_dealers", "miscellaneous_business_services", "miscellaneous_food_stores", "miscellaneous_general_merchandise", "miscellaneous_general_services", "miscellaneous_home_furnishing_specialty_stores", "miscellaneous_publishing_and_printing", "miscellaneous_recreation_services", "miscellaneous_repair_shops", "miscellaneous_specialty_retail", "mobile_home_dealers", "motion_picture_theaters", "motor_freight_carriers_and_trucking", "motor_homes_dealers", "motor_vehicle_supplies_and_new_parts", "motorcycle_shops_and_dealers", "motorcycle_shops_dealers", "music_stores_musical_instruments_pianos_and_sheet_music", "news_dealers_and_newsstands", "non_fi_money_orders", "non_fi_stored_value_card_purchase_load", "nondurable_goods", "nurseries_lawn_and_garden_supply_stores", "nursing_personal_care", "office_and_commercial_furniture", "opticians_eyeglasses", "optometrists_ophthalmologist", "orthopedic_goods_prosthetic_devices", "osteopaths", "package_stores_beer_wine_and_liquor", "paints_varnishes_and_supplies", "parking_lots_garages", "passenger_railways", "pawn_shops", "pet_shops_pet_food_and_supplies", "petroleum_and_petroleum_products", "photo_developing", "photographic_photocopy_microfilm_equipment_and_supplies", "photographic_studios", "picture_video_production", "piece_goods_notions_and_other_dry_goods", "plumbing_heating_equipment_and_supplies", "political_organizations", "postal_services_government_only", "precious_stones_and_metals_watches_and_jewelry", "professional_services", "public_warehousing_and_storage", "quick_copy_repro_and_blueprint", "railroads", "real_estate_agents_and_managers_rentals", "record_stores", "recreational_vehicle_rentals", "religious_goods_stores", "religious_organizations", "roofing_siding_sheet_metal", "secretarial_support_services", "security_brokers_dealers", "service_stations", "sewing_needlework_fabric_and_piece_goods_stores", "shoe_repair_hat_cleaning", "shoe_stores", "small_appliance_repair", "snowmobile_dealers", "special_trade_services", "specialty_cleaning", "sporting_goods_stores", "sporting_recreation_camps", "sports_and_riding_apparel_stores", "sports_clubs_fields", "stamp_and_coin_stores", "stationary_office_supplies_printing_and_writing_paper", "stationery_stores_office_and_school_supply_stores", "swimming_pools_sales", "t_ui_travel_germany", "tailors_alterations", "tax_payments_government_agencies", "tax_preparation_services", "taxicabs_limousines", "telecommunication_equipment_and_telephone_sales", "telecommunication_services", "telegraph_services", "tent_and_awning_shops", "testing_laboratories", "theatrical_ticket_agencies", "timeshares", "tire_retreading_and_repair", "tolls_bridge_fees", "tourist_attractions_and_exhibits", "towing_services", "trailer_parks_campgrounds", "transportation_services", "travel_agencies_tour_operators", "truck_stop_iteration", "truck_utility_trailer_rentals", "typesetting_plate_making_and_related_services", "typewriter_stores", "u_s_federal_government_agencies_or_departments", "uniforms_commercial_clothing", "used_merchandise_and_secondhand_stores", "utilities", "variety_stores", "veterinary_services", "video_amusement_game_supplies", "video_game_arcades", "video_tape_rental_stores", "vocational_trade_schools", "watch_jewelry_repair", "welding_repair", "wholesale_clubs", "wig_and_toupee_stores", "wires_money_orders", "womens_accessory_and_specialty_shops", "womens_ready_to_wear_stores", "wrecking_and_salvage_yards" ], "maxLength": 5000, "type": "string" }, "type": "array" }, "interval": { "enum": [ "all_time", "daily", "monthly", "per_authorization", "weekly", "yearly" ], "type": "string" } }, "required": [ "amount", "interval" ], "title": "spending_limits_param", "type": "object" }, "type": "array" }, "spending_limits_currency": { "type": "string" } }, "title": "authorization_controls_param_v2", "type": "object" }, "status": { "description": "Specifies whether to permit authorizations on this cardholder's cards.", "enum": [ "active", "inactive" ], "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issuing.cardholder" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a cardholder" } }, "/v1/issuing/cards": { "get": { "description": "

Returns a list of Issuing Card objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

", "operationId": "GetIssuingCards", "parameters": [ { "description": "Only return cards belonging to the Cardholder with the provided ID.", "in": "query", "name": "cardholder", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Only return cards that were issued during the given date interval.", "explode": true, "in": "query", "name": "created", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "type": "integer" }, "gte": { "type": "integer" }, "lt": { "type": "integer" }, "lte": { "type": "integer" } }, "title": "range_query_specs", "type": "object" }, { "type": "integer" } ] }, "style": "deepObject" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Only return cards that have the given expiration month.", "in": "query", "name": "exp_month", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "Only return cards that have the given expiration year.", "in": "query", "name": "exp_year", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "Only return cards that have the given last four digits.", "in": "query", "name": "last4", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "in": "query", "name": "personalization_design", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Only return cards that have the given status. One of `active`, `inactive`, or `canceled`.", "in": "query", "name": "status", "required": false, "schema": { "enum": [ "active", "canceled", "inactive" ], "type": "string", "x-stripeBypassValidation": true }, "style": "form" }, { "description": "Only return cards that have the given type. One of `virtual` or `physical`.", "in": "query", "name": "type", "required": false, "schema": { "enum": [ "physical", "virtual" ], "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/issuing.card" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/issuing/cards", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "IssuingCardList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all cards" }, "post": { "description": "

Creates an Issuing Card object.

", "operationId": "PostIssuingCards", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "pin": { "explode": true, "style": "deepObject" }, "second_line": { "explode": true, "style": "deepObject" }, "shipping": { "explode": true, "style": "deepObject" }, "spending_controls": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "cardholder": { "description": "The [Cardholder](https://stripe.com/docs/api#issuing_cardholder_object) object with which the card will be associated.", "maxLength": 5000, "type": "string" }, "currency": { "description": "The currency for the card.", "type": "string" }, "exp_month": { "description": "The desired expiration month (1-12) for this card if [specifying a custom expiration date](/issuing/cards/virtual/issue-cards?testing-method=with-code#exp-dates).", "type": "integer" }, "exp_year": { "description": "The desired 4-digit expiration year for this card if [specifying a custom expiration date](/issuing/cards/virtual/issue-cards?testing-method=with-code#exp-dates).", "type": "integer" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "financial_account": { "description": "The new financial account ID the card will be associated with. This field allows a card to be reassigned to a different financial account.", "type": "string" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "personalization_design": { "description": "The personalization design object belonging to this card.", "maxLength": 5000, "type": "string" }, "pin": { "description": "The desired PIN for this card.", "properties": { "encrypted_number": { "maxLength": 5000, "type": "string" } }, "title": "encrypted_pin_param", "type": "object" }, "replacement_for": { "description": "The card this is meant to be a replacement for (if any).", "maxLength": 5000, "type": "string" }, "replacement_reason": { "description": "If `replacement_for` is specified, this should indicate why that card is being replaced.", "enum": [ "damaged", "expired", "lost", "stolen" ], "type": "string", "x-stripeBypassValidation": true }, "second_line": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "The second line to print on the card. Max length: 24 characters." }, "shipping": { "description": "The address where the card will be shipped.", "properties": { "address": { "properties": { "city": { "maxLength": 5000, "type": "string" }, "country": { "maxLength": 5000, "type": "string" }, "line1": { "maxLength": 5000, "type": "string" }, "line2": { "maxLength": 5000, "type": "string" }, "postal_code": { "maxLength": 5000, "type": "string" }, "state": { "maxLength": 5000, "type": "string" } }, "required": [ "city", "country", "line1", "postal_code" ], "title": "required_address", "type": "object" }, "address_validation": { "properties": { "mode": { "enum": [ "disabled", "normalization_only", "validation_and_normalization" ], "type": "string" } }, "required": [ "mode" ], "title": "address_validation_param", "type": "object" }, "customs": { "properties": { "eori_number": { "maxLength": 5000, "type": "string" } }, "title": "customs_param", "type": "object" }, "name": { "maxLength": 5000, "type": "string" }, "phone_number": { "type": "string" }, "require_signature": { "type": "boolean" }, "service": { "enum": [ "express", "priority", "standard" ], "type": "string", "x-stripeBypassValidation": true }, "type": { "enum": [ "bulk", "individual" ], "type": "string" } }, "required": [ "address", "name" ], "title": "shipping_specs", "type": "object" }, "spending_controls": { "description": "Rules that control spending for this card. Refer to our [documentation](https://stripe.com/docs/issuing/controls/spending-controls) for more details.", "properties": { "allowed_categories": { "items": { "enum": [ "ac_refrigeration_repair", "accounting_bookkeeping_services", "advertising_services", "agricultural_cooperative", "airlines_air_carriers", "airports_flying_fields", "ambulance_services", "amusement_parks_carnivals", "antique_reproductions", "antique_shops", "aquariums", "architectural_surveying_services", "art_dealers_and_galleries", "artists_supply_and_craft_shops", "auto_and_home_supply_stores", "auto_body_repair_shops", "auto_paint_shops", "auto_service_shops", "automated_cash_disburse", "automated_fuel_dispensers", "automobile_associations", "automotive_parts_and_accessories_stores", "automotive_tire_stores", "bail_and_bond_payments", "bakeries", "bands_orchestras", "barber_and_beauty_shops", "betting_casino_gambling", "bicycle_shops", "billiard_pool_establishments", "boat_dealers", "boat_rentals_and_leases", "book_stores", "books_periodicals_and_newspapers", "bowling_alleys", "bus_lines", "business_secretarial_schools", "buying_shopping_services", "cable_satellite_and_other_pay_television_and_radio", "camera_and_photographic_supply_stores", "candy_nut_and_confectionery_stores", "car_and_truck_dealers_new_used", "car_and_truck_dealers_used_only", "car_rental_agencies", "car_washes", "carpentry_services", "carpet_upholstery_cleaning", "caterers", "charitable_and_social_service_organizations_fundraising", "chemicals_and_allied_products", "child_care_services", "childrens_and_infants_wear_stores", "chiropodists_podiatrists", "chiropractors", "cigar_stores_and_stands", "civic_social_fraternal_associations", "cleaning_and_maintenance", "clothing_rental", "colleges_universities", "commercial_equipment", "commercial_footwear", "commercial_photography_art_and_graphics", "commuter_transport_and_ferries", "computer_network_services", "computer_programming", "computer_repair", "computer_software_stores", "computers_peripherals_and_software", "concrete_work_services", "construction_materials", "consulting_public_relations", "correspondence_schools", "cosmetic_stores", "counseling_services", "country_clubs", "courier_services", "court_costs", "credit_reporting_agencies", "cruise_lines", "dairy_products_stores", "dance_hall_studios_schools", "dating_escort_services", "dentists_orthodontists", "department_stores", "detective_agencies", "digital_goods_applications", "digital_goods_games", "digital_goods_large_volume", "digital_goods_media", "direct_marketing_catalog_merchant", "direct_marketing_combination_catalog_and_retail_merchant", "direct_marketing_inbound_telemarketing", "direct_marketing_insurance_services", "direct_marketing_other", "direct_marketing_outbound_telemarketing", "direct_marketing_subscription", "direct_marketing_travel", "discount_stores", "doctors", "door_to_door_sales", "drapery_window_covering_and_upholstery_stores", "drinking_places", "drug_stores_and_pharmacies", "drugs_drug_proprietaries_and_druggist_sundries", "dry_cleaners", "durable_goods", "duty_free_stores", "eating_places_restaurants", "educational_services", "electric_razor_stores", "electric_vehicle_charging", "electrical_parts_and_equipment", "electrical_services", "electronics_repair_shops", "electronics_stores", "elementary_secondary_schools", "emergency_services_gcas_visa_use_only", "employment_temp_agencies", "equipment_rental", "exterminating_services", "family_clothing_stores", "fast_food_restaurants", "financial_institutions", "fines_government_administrative_entities", "fireplace_fireplace_screens_and_accessories_stores", "floor_covering_stores", "florists", "florists_supplies_nursery_stock_and_flowers", "freezer_and_locker_meat_provisioners", "fuel_dealers_non_automotive", "funeral_services_crematories", "furniture_home_furnishings_and_equipment_stores_except_appliances", "furniture_repair_refinishing", "furriers_and_fur_shops", "general_services", "gift_card_novelty_and_souvenir_shops", "glass_paint_and_wallpaper_stores", "glassware_crystal_stores", "golf_courses_public", "government_licensed_horse_dog_racing_us_region_only", "government_licensed_online_casions_online_gambling_us_region_only", "government_owned_lotteries_non_us_region", "government_owned_lotteries_us_region_only", "government_services", "grocery_stores_supermarkets", "hardware_equipment_and_supplies", "hardware_stores", "health_and_beauty_spas", "hearing_aids_sales_and_supplies", "heating_plumbing_a_c", "hobby_toy_and_game_shops", "home_supply_warehouse_stores", "hospitals", "hotels_motels_and_resorts", "household_appliance_stores", "industrial_supplies", "information_retrieval_services", "insurance_default", "insurance_underwriting_premiums", "intra_company_purchases", "jewelry_stores_watches_clocks_and_silverware_stores", "landscaping_services", "laundries", "laundry_cleaning_services", "legal_services_attorneys", "luggage_and_leather_goods_stores", "lumber_building_materials_stores", "manual_cash_disburse", "marinas_service_and_supplies", "marketplaces", "masonry_stonework_and_plaster", "massage_parlors", "medical_and_dental_labs", "medical_dental_ophthalmic_and_hospital_equipment_and_supplies", "medical_services", "membership_organizations", "mens_and_boys_clothing_and_accessories_stores", "mens_womens_clothing_stores", "metal_service_centers", "miscellaneous", "miscellaneous_apparel_and_accessory_shops", "miscellaneous_auto_dealers", "miscellaneous_business_services", "miscellaneous_food_stores", "miscellaneous_general_merchandise", "miscellaneous_general_services", "miscellaneous_home_furnishing_specialty_stores", "miscellaneous_publishing_and_printing", "miscellaneous_recreation_services", "miscellaneous_repair_shops", "miscellaneous_specialty_retail", "mobile_home_dealers", "motion_picture_theaters", "motor_freight_carriers_and_trucking", "motor_homes_dealers", "motor_vehicle_supplies_and_new_parts", "motorcycle_shops_and_dealers", "motorcycle_shops_dealers", "music_stores_musical_instruments_pianos_and_sheet_music", "news_dealers_and_newsstands", "non_fi_money_orders", "non_fi_stored_value_card_purchase_load", "nondurable_goods", "nurseries_lawn_and_garden_supply_stores", "nursing_personal_care", "office_and_commercial_furniture", "opticians_eyeglasses", "optometrists_ophthalmologist", "orthopedic_goods_prosthetic_devices", "osteopaths", "package_stores_beer_wine_and_liquor", "paints_varnishes_and_supplies", "parking_lots_garages", "passenger_railways", "pawn_shops", "pet_shops_pet_food_and_supplies", "petroleum_and_petroleum_products", "photo_developing", "photographic_photocopy_microfilm_equipment_and_supplies", "photographic_studios", "picture_video_production", "piece_goods_notions_and_other_dry_goods", "plumbing_heating_equipment_and_supplies", "political_organizations", "postal_services_government_only", "precious_stones_and_metals_watches_and_jewelry", "professional_services", "public_warehousing_and_storage", "quick_copy_repro_and_blueprint", "railroads", "real_estate_agents_and_managers_rentals", "record_stores", "recreational_vehicle_rentals", "religious_goods_stores", "religious_organizations", "roofing_siding_sheet_metal", "secretarial_support_services", "security_brokers_dealers", "service_stations", "sewing_needlework_fabric_and_piece_goods_stores", "shoe_repair_hat_cleaning", "shoe_stores", "small_appliance_repair", "snowmobile_dealers", "special_trade_services", "specialty_cleaning", "sporting_goods_stores", "sporting_recreation_camps", "sports_and_riding_apparel_stores", "sports_clubs_fields", "stamp_and_coin_stores", "stationary_office_supplies_printing_and_writing_paper", "stationery_stores_office_and_school_supply_stores", "swimming_pools_sales", "t_ui_travel_germany", "tailors_alterations", "tax_payments_government_agencies", "tax_preparation_services", "taxicabs_limousines", "telecommunication_equipment_and_telephone_sales", "telecommunication_services", "telegraph_services", "tent_and_awning_shops", "testing_laboratories", "theatrical_ticket_agencies", "timeshares", "tire_retreading_and_repair", "tolls_bridge_fees", "tourist_attractions_and_exhibits", "towing_services", "trailer_parks_campgrounds", "transportation_services", "travel_agencies_tour_operators", "truck_stop_iteration", "truck_utility_trailer_rentals", "typesetting_plate_making_and_related_services", "typewriter_stores", "u_s_federal_government_agencies_or_departments", "uniforms_commercial_clothing", "used_merchandise_and_secondhand_stores", "utilities", "variety_stores", "veterinary_services", "video_amusement_game_supplies", "video_game_arcades", "video_tape_rental_stores", "vocational_trade_schools", "watch_jewelry_repair", "welding_repair", "wholesale_clubs", "wig_and_toupee_stores", "wires_money_orders", "womens_accessory_and_specialty_shops", "womens_ready_to_wear_stores", "wrecking_and_salvage_yards" ], "maxLength": 5000, "type": "string" }, "type": "array" }, "allowed_merchant_countries": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "blocked_categories": { "items": { "enum": [ "ac_refrigeration_repair", "accounting_bookkeeping_services", "advertising_services", "agricultural_cooperative", "airlines_air_carriers", "airports_flying_fields", "ambulance_services", "amusement_parks_carnivals", "antique_reproductions", "antique_shops", "aquariums", "architectural_surveying_services", "art_dealers_and_galleries", "artists_supply_and_craft_shops", "auto_and_home_supply_stores", "auto_body_repair_shops", "auto_paint_shops", "auto_service_shops", "automated_cash_disburse", "automated_fuel_dispensers", "automobile_associations", "automotive_parts_and_accessories_stores", "automotive_tire_stores", "bail_and_bond_payments", "bakeries", "bands_orchestras", "barber_and_beauty_shops", "betting_casino_gambling", "bicycle_shops", "billiard_pool_establishments", "boat_dealers", "boat_rentals_and_leases", "book_stores", "books_periodicals_and_newspapers", "bowling_alleys", "bus_lines", "business_secretarial_schools", "buying_shopping_services", "cable_satellite_and_other_pay_television_and_radio", "camera_and_photographic_supply_stores", "candy_nut_and_confectionery_stores", "car_and_truck_dealers_new_used", "car_and_truck_dealers_used_only", "car_rental_agencies", "car_washes", "carpentry_services", "carpet_upholstery_cleaning", "caterers", "charitable_and_social_service_organizations_fundraising", "chemicals_and_allied_products", "child_care_services", "childrens_and_infants_wear_stores", "chiropodists_podiatrists", "chiropractors", "cigar_stores_and_stands", "civic_social_fraternal_associations", "cleaning_and_maintenance", "clothing_rental", "colleges_universities", "commercial_equipment", "commercial_footwear", "commercial_photography_art_and_graphics", "commuter_transport_and_ferries", "computer_network_services", "computer_programming", "computer_repair", "computer_software_stores", "computers_peripherals_and_software", "concrete_work_services", "construction_materials", "consulting_public_relations", "correspondence_schools", "cosmetic_stores", "counseling_services", "country_clubs", "courier_services", "court_costs", "credit_reporting_agencies", "cruise_lines", "dairy_products_stores", "dance_hall_studios_schools", "dating_escort_services", "dentists_orthodontists", "department_stores", "detective_agencies", "digital_goods_applications", "digital_goods_games", "digital_goods_large_volume", "digital_goods_media", "direct_marketing_catalog_merchant", "direct_marketing_combination_catalog_and_retail_merchant", "direct_marketing_inbound_telemarketing", "direct_marketing_insurance_services", "direct_marketing_other", "direct_marketing_outbound_telemarketing", "direct_marketing_subscription", "direct_marketing_travel", "discount_stores", "doctors", "door_to_door_sales", "drapery_window_covering_and_upholstery_stores", "drinking_places", "drug_stores_and_pharmacies", "drugs_drug_proprietaries_and_druggist_sundries", "dry_cleaners", "durable_goods", "duty_free_stores", "eating_places_restaurants", "educational_services", "electric_razor_stores", "electric_vehicle_charging", "electrical_parts_and_equipment", "electrical_services", "electronics_repair_shops", "electronics_stores", "elementary_secondary_schools", "emergency_services_gcas_visa_use_only", "employment_temp_agencies", "equipment_rental", "exterminating_services", "family_clothing_stores", "fast_food_restaurants", "financial_institutions", "fines_government_administrative_entities", "fireplace_fireplace_screens_and_accessories_stores", "floor_covering_stores", "florists", "florists_supplies_nursery_stock_and_flowers", "freezer_and_locker_meat_provisioners", "fuel_dealers_non_automotive", "funeral_services_crematories", "furniture_home_furnishings_and_equipment_stores_except_appliances", "furniture_repair_refinishing", "furriers_and_fur_shops", "general_services", "gift_card_novelty_and_souvenir_shops", "glass_paint_and_wallpaper_stores", "glassware_crystal_stores", "golf_courses_public", "government_licensed_horse_dog_racing_us_region_only", "government_licensed_online_casions_online_gambling_us_region_only", "government_owned_lotteries_non_us_region", "government_owned_lotteries_us_region_only", "government_services", "grocery_stores_supermarkets", "hardware_equipment_and_supplies", "hardware_stores", "health_and_beauty_spas", "hearing_aids_sales_and_supplies", "heating_plumbing_a_c", "hobby_toy_and_game_shops", "home_supply_warehouse_stores", "hospitals", "hotels_motels_and_resorts", "household_appliance_stores", "industrial_supplies", "information_retrieval_services", "insurance_default", "insurance_underwriting_premiums", "intra_company_purchases", "jewelry_stores_watches_clocks_and_silverware_stores", "landscaping_services", "laundries", "laundry_cleaning_services", "legal_services_attorneys", "luggage_and_leather_goods_stores", "lumber_building_materials_stores", "manual_cash_disburse", "marinas_service_and_supplies", "marketplaces", "masonry_stonework_and_plaster", "massage_parlors", "medical_and_dental_labs", "medical_dental_ophthalmic_and_hospital_equipment_and_supplies", "medical_services", "membership_organizations", "mens_and_boys_clothing_and_accessories_stores", "mens_womens_clothing_stores", "metal_service_centers", "miscellaneous", "miscellaneous_apparel_and_accessory_shops", "miscellaneous_auto_dealers", "miscellaneous_business_services", "miscellaneous_food_stores", "miscellaneous_general_merchandise", "miscellaneous_general_services", "miscellaneous_home_furnishing_specialty_stores", "miscellaneous_publishing_and_printing", "miscellaneous_recreation_services", "miscellaneous_repair_shops", "miscellaneous_specialty_retail", "mobile_home_dealers", "motion_picture_theaters", "motor_freight_carriers_and_trucking", "motor_homes_dealers", "motor_vehicle_supplies_and_new_parts", "motorcycle_shops_and_dealers", "motorcycle_shops_dealers", "music_stores_musical_instruments_pianos_and_sheet_music", "news_dealers_and_newsstands", "non_fi_money_orders", "non_fi_stored_value_card_purchase_load", "nondurable_goods", "nurseries_lawn_and_garden_supply_stores", "nursing_personal_care", "office_and_commercial_furniture", "opticians_eyeglasses", "optometrists_ophthalmologist", "orthopedic_goods_prosthetic_devices", "osteopaths", "package_stores_beer_wine_and_liquor", "paints_varnishes_and_supplies", "parking_lots_garages", "passenger_railways", "pawn_shops", "pet_shops_pet_food_and_supplies", "petroleum_and_petroleum_products", "photo_developing", "photographic_photocopy_microfilm_equipment_and_supplies", "photographic_studios", "picture_video_production", "piece_goods_notions_and_other_dry_goods", "plumbing_heating_equipment_and_supplies", "political_organizations", "postal_services_government_only", "precious_stones_and_metals_watches_and_jewelry", "professional_services", "public_warehousing_and_storage", "quick_copy_repro_and_blueprint", "railroads", "real_estate_agents_and_managers_rentals", "record_stores", "recreational_vehicle_rentals", "religious_goods_stores", "religious_organizations", "roofing_siding_sheet_metal", "secretarial_support_services", "security_brokers_dealers", "service_stations", "sewing_needlework_fabric_and_piece_goods_stores", "shoe_repair_hat_cleaning", "shoe_stores", "small_appliance_repair", "snowmobile_dealers", "special_trade_services", "specialty_cleaning", "sporting_goods_stores", "sporting_recreation_camps", "sports_and_riding_apparel_stores", "sports_clubs_fields", "stamp_and_coin_stores", "stationary_office_supplies_printing_and_writing_paper", "stationery_stores_office_and_school_supply_stores", "swimming_pools_sales", "t_ui_travel_germany", "tailors_alterations", "tax_payments_government_agencies", "tax_preparation_services", "taxicabs_limousines", "telecommunication_equipment_and_telephone_sales", "telecommunication_services", "telegraph_services", "tent_and_awning_shops", "testing_laboratories", "theatrical_ticket_agencies", "timeshares", "tire_retreading_and_repair", "tolls_bridge_fees", "tourist_attractions_and_exhibits", "towing_services", "trailer_parks_campgrounds", "transportation_services", "travel_agencies_tour_operators", "truck_stop_iteration", "truck_utility_trailer_rentals", "typesetting_plate_making_and_related_services", "typewriter_stores", "u_s_federal_government_agencies_or_departments", "uniforms_commercial_clothing", "used_merchandise_and_secondhand_stores", "utilities", "variety_stores", "veterinary_services", "video_amusement_game_supplies", "video_game_arcades", "video_tape_rental_stores", "vocational_trade_schools", "watch_jewelry_repair", "welding_repair", "wholesale_clubs", "wig_and_toupee_stores", "wires_money_orders", "womens_accessory_and_specialty_shops", "womens_ready_to_wear_stores", "wrecking_and_salvage_yards" ], "maxLength": 5000, "type": "string" }, "type": "array" }, "blocked_merchant_countries": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "spending_limits": { "items": { "properties": { "amount": { "type": "integer" }, "categories": { "items": { "enum": [ "ac_refrigeration_repair", "accounting_bookkeeping_services", "advertising_services", "agricultural_cooperative", "airlines_air_carriers", "airports_flying_fields", "ambulance_services", "amusement_parks_carnivals", "antique_reproductions", "antique_shops", "aquariums", "architectural_surveying_services", "art_dealers_and_galleries", "artists_supply_and_craft_shops", "auto_and_home_supply_stores", "auto_body_repair_shops", "auto_paint_shops", "auto_service_shops", "automated_cash_disburse", "automated_fuel_dispensers", "automobile_associations", "automotive_parts_and_accessories_stores", "automotive_tire_stores", "bail_and_bond_payments", "bakeries", "bands_orchestras", "barber_and_beauty_shops", "betting_casino_gambling", "bicycle_shops", "billiard_pool_establishments", "boat_dealers", "boat_rentals_and_leases", "book_stores", "books_periodicals_and_newspapers", "bowling_alleys", "bus_lines", "business_secretarial_schools", "buying_shopping_services", "cable_satellite_and_other_pay_television_and_radio", "camera_and_photographic_supply_stores", "candy_nut_and_confectionery_stores", "car_and_truck_dealers_new_used", "car_and_truck_dealers_used_only", "car_rental_agencies", "car_washes", "carpentry_services", "carpet_upholstery_cleaning", "caterers", "charitable_and_social_service_organizations_fundraising", "chemicals_and_allied_products", "child_care_services", "childrens_and_infants_wear_stores", "chiropodists_podiatrists", "chiropractors", "cigar_stores_and_stands", "civic_social_fraternal_associations", "cleaning_and_maintenance", "clothing_rental", "colleges_universities", "commercial_equipment", "commercial_footwear", "commercial_photography_art_and_graphics", "commuter_transport_and_ferries", "computer_network_services", "computer_programming", "computer_repair", "computer_software_stores", "computers_peripherals_and_software", "concrete_work_services", "construction_materials", "consulting_public_relations", "correspondence_schools", "cosmetic_stores", "counseling_services", "country_clubs", "courier_services", "court_costs", "credit_reporting_agencies", "cruise_lines", "dairy_products_stores", "dance_hall_studios_schools", "dating_escort_services", "dentists_orthodontists", "department_stores", "detective_agencies", "digital_goods_applications", "digital_goods_games", "digital_goods_large_volume", "digital_goods_media", "direct_marketing_catalog_merchant", "direct_marketing_combination_catalog_and_retail_merchant", "direct_marketing_inbound_telemarketing", "direct_marketing_insurance_services", "direct_marketing_other", "direct_marketing_outbound_telemarketing", "direct_marketing_subscription", "direct_marketing_travel", "discount_stores", "doctors", "door_to_door_sales", "drapery_window_covering_and_upholstery_stores", "drinking_places", "drug_stores_and_pharmacies", "drugs_drug_proprietaries_and_druggist_sundries", "dry_cleaners", "durable_goods", "duty_free_stores", "eating_places_restaurants", "educational_services", "electric_razor_stores", "electric_vehicle_charging", "electrical_parts_and_equipment", "electrical_services", "electronics_repair_shops", "electronics_stores", "elementary_secondary_schools", "emergency_services_gcas_visa_use_only", "employment_temp_agencies", "equipment_rental", "exterminating_services", "family_clothing_stores", "fast_food_restaurants", "financial_institutions", "fines_government_administrative_entities", "fireplace_fireplace_screens_and_accessories_stores", "floor_covering_stores", "florists", "florists_supplies_nursery_stock_and_flowers", "freezer_and_locker_meat_provisioners", "fuel_dealers_non_automotive", "funeral_services_crematories", "furniture_home_furnishings_and_equipment_stores_except_appliances", "furniture_repair_refinishing", "furriers_and_fur_shops", "general_services", "gift_card_novelty_and_souvenir_shops", "glass_paint_and_wallpaper_stores", "glassware_crystal_stores", "golf_courses_public", "government_licensed_horse_dog_racing_us_region_only", "government_licensed_online_casions_online_gambling_us_region_only", "government_owned_lotteries_non_us_region", "government_owned_lotteries_us_region_only", "government_services", "grocery_stores_supermarkets", "hardware_equipment_and_supplies", "hardware_stores", "health_and_beauty_spas", "hearing_aids_sales_and_supplies", "heating_plumbing_a_c", "hobby_toy_and_game_shops", "home_supply_warehouse_stores", "hospitals", "hotels_motels_and_resorts", "household_appliance_stores", "industrial_supplies", "information_retrieval_services", "insurance_default", "insurance_underwriting_premiums", "intra_company_purchases", "jewelry_stores_watches_clocks_and_silverware_stores", "landscaping_services", "laundries", "laundry_cleaning_services", "legal_services_attorneys", "luggage_and_leather_goods_stores", "lumber_building_materials_stores", "manual_cash_disburse", "marinas_service_and_supplies", "marketplaces", "masonry_stonework_and_plaster", "massage_parlors", "medical_and_dental_labs", "medical_dental_ophthalmic_and_hospital_equipment_and_supplies", "medical_services", "membership_organizations", "mens_and_boys_clothing_and_accessories_stores", "mens_womens_clothing_stores", "metal_service_centers", "miscellaneous", "miscellaneous_apparel_and_accessory_shops", "miscellaneous_auto_dealers", "miscellaneous_business_services", "miscellaneous_food_stores", "miscellaneous_general_merchandise", "miscellaneous_general_services", "miscellaneous_home_furnishing_specialty_stores", "miscellaneous_publishing_and_printing", "miscellaneous_recreation_services", "miscellaneous_repair_shops", "miscellaneous_specialty_retail", "mobile_home_dealers", "motion_picture_theaters", "motor_freight_carriers_and_trucking", "motor_homes_dealers", "motor_vehicle_supplies_and_new_parts", "motorcycle_shops_and_dealers", "motorcycle_shops_dealers", "music_stores_musical_instruments_pianos_and_sheet_music", "news_dealers_and_newsstands", "non_fi_money_orders", "non_fi_stored_value_card_purchase_load", "nondurable_goods", "nurseries_lawn_and_garden_supply_stores", "nursing_personal_care", "office_and_commercial_furniture", "opticians_eyeglasses", "optometrists_ophthalmologist", "orthopedic_goods_prosthetic_devices", "osteopaths", "package_stores_beer_wine_and_liquor", "paints_varnishes_and_supplies", "parking_lots_garages", "passenger_railways", "pawn_shops", "pet_shops_pet_food_and_supplies", "petroleum_and_petroleum_products", "photo_developing", "photographic_photocopy_microfilm_equipment_and_supplies", "photographic_studios", "picture_video_production", "piece_goods_notions_and_other_dry_goods", "plumbing_heating_equipment_and_supplies", "political_organizations", "postal_services_government_only", "precious_stones_and_metals_watches_and_jewelry", "professional_services", "public_warehousing_and_storage", "quick_copy_repro_and_blueprint", "railroads", "real_estate_agents_and_managers_rentals", "record_stores", "recreational_vehicle_rentals", "religious_goods_stores", "religious_organizations", "roofing_siding_sheet_metal", "secretarial_support_services", "security_brokers_dealers", "service_stations", "sewing_needlework_fabric_and_piece_goods_stores", "shoe_repair_hat_cleaning", "shoe_stores", "small_appliance_repair", "snowmobile_dealers", "special_trade_services", "specialty_cleaning", "sporting_goods_stores", "sporting_recreation_camps", "sports_and_riding_apparel_stores", "sports_clubs_fields", "stamp_and_coin_stores", "stationary_office_supplies_printing_and_writing_paper", "stationery_stores_office_and_school_supply_stores", "swimming_pools_sales", "t_ui_travel_germany", "tailors_alterations", "tax_payments_government_agencies", "tax_preparation_services", "taxicabs_limousines", "telecommunication_equipment_and_telephone_sales", "telecommunication_services", "telegraph_services", "tent_and_awning_shops", "testing_laboratories", "theatrical_ticket_agencies", "timeshares", "tire_retreading_and_repair", "tolls_bridge_fees", "tourist_attractions_and_exhibits", "towing_services", "trailer_parks_campgrounds", "transportation_services", "travel_agencies_tour_operators", "truck_stop_iteration", "truck_utility_trailer_rentals", "typesetting_plate_making_and_related_services", "typewriter_stores", "u_s_federal_government_agencies_or_departments", "uniforms_commercial_clothing", "used_merchandise_and_secondhand_stores", "utilities", "variety_stores", "veterinary_services", "video_amusement_game_supplies", "video_game_arcades", "video_tape_rental_stores", "vocational_trade_schools", "watch_jewelry_repair", "welding_repair", "wholesale_clubs", "wig_and_toupee_stores", "wires_money_orders", "womens_accessory_and_specialty_shops", "womens_ready_to_wear_stores", "wrecking_and_salvage_yards" ], "maxLength": 5000, "type": "string" }, "type": "array" }, "interval": { "enum": [ "all_time", "daily", "monthly", "per_authorization", "weekly", "yearly" ], "type": "string" } }, "required": [ "amount", "interval" ], "title": "spending_limits_param", "type": "object" }, "type": "array" } }, "title": "authorization_controls_param", "type": "object" }, "status": { "description": "Whether authorizations can be approved on this card. May be blocked from activating cards depending on past-due Cardholder requirements. Defaults to `inactive`.", "enum": [ "active", "inactive" ], "type": "string" }, "type": { "description": "The type of card to issue. Possible values are `physical` or `virtual`.", "enum": [ "physical", "virtual" ], "type": "string" } }, "required": [ "currency", "type" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issuing.card" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a card" } }, "/v1/issuing/cards/{card}": { "get": { "description": "

Retrieves an Issuing Card object.

", "operationId": "GetIssuingCardsCard", "parameters": [ { "in": "path", "name": "card", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issuing.card" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a card" }, "post": { "description": "

Updates the specified Issuing Card object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

", "operationId": "PostIssuingCardsCard", "parameters": [ { "in": "path", "name": "card", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "pin": { "explode": true, "style": "deepObject" }, "shipping": { "explode": true, "style": "deepObject" }, "spending_controls": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "cancellation_reason": { "description": "Reason why the `status` of this card is `canceled`.", "enum": [ "lost", "stolen" ], "type": "string", "x-stripeBypassValidation": true }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "personalization_design": { "maxLength": 5000, "type": "string" }, "pin": { "description": "The desired new PIN for this card.", "properties": { "encrypted_number": { "maxLength": 5000, "type": "string" } }, "title": "encrypted_pin_param", "type": "object" }, "shipping": { "description": "Updated shipping information for the card.", "properties": { "address": { "properties": { "city": { "maxLength": 5000, "type": "string" }, "country": { "maxLength": 5000, "type": "string" }, "line1": { "maxLength": 5000, "type": "string" }, "line2": { "maxLength": 5000, "type": "string" }, "postal_code": { "maxLength": 5000, "type": "string" }, "state": { "maxLength": 5000, "type": "string" } }, "required": [ "city", "country", "line1", "postal_code" ], "title": "required_address", "type": "object" }, "address_validation": { "properties": { "mode": { "enum": [ "disabled", "normalization_only", "validation_and_normalization" ], "type": "string" } }, "required": [ "mode" ], "title": "address_validation_param", "type": "object" }, "customs": { "properties": { "eori_number": { "maxLength": 5000, "type": "string" } }, "title": "customs_param", "type": "object" }, "name": { "maxLength": 5000, "type": "string" }, "phone_number": { "type": "string" }, "require_signature": { "type": "boolean" }, "service": { "enum": [ "express", "priority", "standard" ], "type": "string", "x-stripeBypassValidation": true }, "type": { "enum": [ "bulk", "individual" ], "type": "string" } }, "required": [ "address", "name" ], "title": "shipping_specs", "type": "object" }, "spending_controls": { "description": "Rules that control spending for this card. Refer to our [documentation](https://stripe.com/docs/issuing/controls/spending-controls) for more details.", "properties": { "allowed_categories": { "items": { "enum": [ "ac_refrigeration_repair", "accounting_bookkeeping_services", "advertising_services", "agricultural_cooperative", "airlines_air_carriers", "airports_flying_fields", "ambulance_services", "amusement_parks_carnivals", "antique_reproductions", "antique_shops", "aquariums", "architectural_surveying_services", "art_dealers_and_galleries", "artists_supply_and_craft_shops", "auto_and_home_supply_stores", "auto_body_repair_shops", "auto_paint_shops", "auto_service_shops", "automated_cash_disburse", "automated_fuel_dispensers", "automobile_associations", "automotive_parts_and_accessories_stores", "automotive_tire_stores", "bail_and_bond_payments", "bakeries", "bands_orchestras", "barber_and_beauty_shops", "betting_casino_gambling", "bicycle_shops", "billiard_pool_establishments", "boat_dealers", "boat_rentals_and_leases", "book_stores", "books_periodicals_and_newspapers", "bowling_alleys", "bus_lines", "business_secretarial_schools", "buying_shopping_services", "cable_satellite_and_other_pay_television_and_radio", "camera_and_photographic_supply_stores", "candy_nut_and_confectionery_stores", "car_and_truck_dealers_new_used", "car_and_truck_dealers_used_only", "car_rental_agencies", "car_washes", "carpentry_services", "carpet_upholstery_cleaning", "caterers", "charitable_and_social_service_organizations_fundraising", "chemicals_and_allied_products", "child_care_services", "childrens_and_infants_wear_stores", "chiropodists_podiatrists", "chiropractors", "cigar_stores_and_stands", "civic_social_fraternal_associations", "cleaning_and_maintenance", "clothing_rental", "colleges_universities", "commercial_equipment", "commercial_footwear", "commercial_photography_art_and_graphics", "commuter_transport_and_ferries", "computer_network_services", "computer_programming", "computer_repair", "computer_software_stores", "computers_peripherals_and_software", "concrete_work_services", "construction_materials", "consulting_public_relations", "correspondence_schools", "cosmetic_stores", "counseling_services", "country_clubs", "courier_services", "court_costs", "credit_reporting_agencies", "cruise_lines", "dairy_products_stores", "dance_hall_studios_schools", "dating_escort_services", "dentists_orthodontists", "department_stores", "detective_agencies", "digital_goods_applications", "digital_goods_games", "digital_goods_large_volume", "digital_goods_media", "direct_marketing_catalog_merchant", "direct_marketing_combination_catalog_and_retail_merchant", "direct_marketing_inbound_telemarketing", "direct_marketing_insurance_services", "direct_marketing_other", "direct_marketing_outbound_telemarketing", "direct_marketing_subscription", "direct_marketing_travel", "discount_stores", "doctors", "door_to_door_sales", "drapery_window_covering_and_upholstery_stores", "drinking_places", "drug_stores_and_pharmacies", "drugs_drug_proprietaries_and_druggist_sundries", "dry_cleaners", "durable_goods", "duty_free_stores", "eating_places_restaurants", "educational_services", "electric_razor_stores", "electric_vehicle_charging", "electrical_parts_and_equipment", "electrical_services", "electronics_repair_shops", "electronics_stores", "elementary_secondary_schools", "emergency_services_gcas_visa_use_only", "employment_temp_agencies", "equipment_rental", "exterminating_services", "family_clothing_stores", "fast_food_restaurants", "financial_institutions", "fines_government_administrative_entities", "fireplace_fireplace_screens_and_accessories_stores", "floor_covering_stores", "florists", "florists_supplies_nursery_stock_and_flowers", "freezer_and_locker_meat_provisioners", "fuel_dealers_non_automotive", "funeral_services_crematories", "furniture_home_furnishings_and_equipment_stores_except_appliances", "furniture_repair_refinishing", "furriers_and_fur_shops", "general_services", "gift_card_novelty_and_souvenir_shops", "glass_paint_and_wallpaper_stores", "glassware_crystal_stores", "golf_courses_public", "government_licensed_horse_dog_racing_us_region_only", "government_licensed_online_casions_online_gambling_us_region_only", "government_owned_lotteries_non_us_region", "government_owned_lotteries_us_region_only", "government_services", "grocery_stores_supermarkets", "hardware_equipment_and_supplies", "hardware_stores", "health_and_beauty_spas", "hearing_aids_sales_and_supplies", "heating_plumbing_a_c", "hobby_toy_and_game_shops", "home_supply_warehouse_stores", "hospitals", "hotels_motels_and_resorts", "household_appliance_stores", "industrial_supplies", "information_retrieval_services", "insurance_default", "insurance_underwriting_premiums", "intra_company_purchases", "jewelry_stores_watches_clocks_and_silverware_stores", "landscaping_services", "laundries", "laundry_cleaning_services", "legal_services_attorneys", "luggage_and_leather_goods_stores", "lumber_building_materials_stores", "manual_cash_disburse", "marinas_service_and_supplies", "marketplaces", "masonry_stonework_and_plaster", "massage_parlors", "medical_and_dental_labs", "medical_dental_ophthalmic_and_hospital_equipment_and_supplies", "medical_services", "membership_organizations", "mens_and_boys_clothing_and_accessories_stores", "mens_womens_clothing_stores", "metal_service_centers", "miscellaneous", "miscellaneous_apparel_and_accessory_shops", "miscellaneous_auto_dealers", "miscellaneous_business_services", "miscellaneous_food_stores", "miscellaneous_general_merchandise", "miscellaneous_general_services", "miscellaneous_home_furnishing_specialty_stores", "miscellaneous_publishing_and_printing", "miscellaneous_recreation_services", "miscellaneous_repair_shops", "miscellaneous_specialty_retail", "mobile_home_dealers", "motion_picture_theaters", "motor_freight_carriers_and_trucking", "motor_homes_dealers", "motor_vehicle_supplies_and_new_parts", "motorcycle_shops_and_dealers", "motorcycle_shops_dealers", "music_stores_musical_instruments_pianos_and_sheet_music", "news_dealers_and_newsstands", "non_fi_money_orders", "non_fi_stored_value_card_purchase_load", "nondurable_goods", "nurseries_lawn_and_garden_supply_stores", "nursing_personal_care", "office_and_commercial_furniture", "opticians_eyeglasses", "optometrists_ophthalmologist", "orthopedic_goods_prosthetic_devices", "osteopaths", "package_stores_beer_wine_and_liquor", "paints_varnishes_and_supplies", "parking_lots_garages", "passenger_railways", "pawn_shops", "pet_shops_pet_food_and_supplies", "petroleum_and_petroleum_products", "photo_developing", "photographic_photocopy_microfilm_equipment_and_supplies", "photographic_studios", "picture_video_production", "piece_goods_notions_and_other_dry_goods", "plumbing_heating_equipment_and_supplies", "political_organizations", "postal_services_government_only", "precious_stones_and_metals_watches_and_jewelry", "professional_services", "public_warehousing_and_storage", "quick_copy_repro_and_blueprint", "railroads", "real_estate_agents_and_managers_rentals", "record_stores", "recreational_vehicle_rentals", "religious_goods_stores", "religious_organizations", "roofing_siding_sheet_metal", "secretarial_support_services", "security_brokers_dealers", "service_stations", "sewing_needlework_fabric_and_piece_goods_stores", "shoe_repair_hat_cleaning", "shoe_stores", "small_appliance_repair", "snowmobile_dealers", "special_trade_services", "specialty_cleaning", "sporting_goods_stores", "sporting_recreation_camps", "sports_and_riding_apparel_stores", "sports_clubs_fields", "stamp_and_coin_stores", "stationary_office_supplies_printing_and_writing_paper", "stationery_stores_office_and_school_supply_stores", "swimming_pools_sales", "t_ui_travel_germany", "tailors_alterations", "tax_payments_government_agencies", "tax_preparation_services", "taxicabs_limousines", "telecommunication_equipment_and_telephone_sales", "telecommunication_services", "telegraph_services", "tent_and_awning_shops", "testing_laboratories", "theatrical_ticket_agencies", "timeshares", "tire_retreading_and_repair", "tolls_bridge_fees", "tourist_attractions_and_exhibits", "towing_services", "trailer_parks_campgrounds", "transportation_services", "travel_agencies_tour_operators", "truck_stop_iteration", "truck_utility_trailer_rentals", "typesetting_plate_making_and_related_services", "typewriter_stores", "u_s_federal_government_agencies_or_departments", "uniforms_commercial_clothing", "used_merchandise_and_secondhand_stores", "utilities", "variety_stores", "veterinary_services", "video_amusement_game_supplies", "video_game_arcades", "video_tape_rental_stores", "vocational_trade_schools", "watch_jewelry_repair", "welding_repair", "wholesale_clubs", "wig_and_toupee_stores", "wires_money_orders", "womens_accessory_and_specialty_shops", "womens_ready_to_wear_stores", "wrecking_and_salvage_yards" ], "maxLength": 5000, "type": "string" }, "type": "array" }, "allowed_merchant_countries": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "blocked_categories": { "items": { "enum": [ "ac_refrigeration_repair", "accounting_bookkeeping_services", "advertising_services", "agricultural_cooperative", "airlines_air_carriers", "airports_flying_fields", "ambulance_services", "amusement_parks_carnivals", "antique_reproductions", "antique_shops", "aquariums", "architectural_surveying_services", "art_dealers_and_galleries", "artists_supply_and_craft_shops", "auto_and_home_supply_stores", "auto_body_repair_shops", "auto_paint_shops", "auto_service_shops", "automated_cash_disburse", "automated_fuel_dispensers", "automobile_associations", "automotive_parts_and_accessories_stores", "automotive_tire_stores", "bail_and_bond_payments", "bakeries", "bands_orchestras", "barber_and_beauty_shops", "betting_casino_gambling", "bicycle_shops", "billiard_pool_establishments", "boat_dealers", "boat_rentals_and_leases", "book_stores", "books_periodicals_and_newspapers", "bowling_alleys", "bus_lines", "business_secretarial_schools", "buying_shopping_services", "cable_satellite_and_other_pay_television_and_radio", "camera_and_photographic_supply_stores", "candy_nut_and_confectionery_stores", "car_and_truck_dealers_new_used", "car_and_truck_dealers_used_only", "car_rental_agencies", "car_washes", "carpentry_services", "carpet_upholstery_cleaning", "caterers", "charitable_and_social_service_organizations_fundraising", "chemicals_and_allied_products", "child_care_services", "childrens_and_infants_wear_stores", "chiropodists_podiatrists", "chiropractors", "cigar_stores_and_stands", "civic_social_fraternal_associations", "cleaning_and_maintenance", "clothing_rental", "colleges_universities", "commercial_equipment", "commercial_footwear", "commercial_photography_art_and_graphics", "commuter_transport_and_ferries", "computer_network_services", "computer_programming", "computer_repair", "computer_software_stores", "computers_peripherals_and_software", "concrete_work_services", "construction_materials", "consulting_public_relations", "correspondence_schools", "cosmetic_stores", "counseling_services", "country_clubs", "courier_services", "court_costs", "credit_reporting_agencies", "cruise_lines", "dairy_products_stores", "dance_hall_studios_schools", "dating_escort_services", "dentists_orthodontists", "department_stores", "detective_agencies", "digital_goods_applications", "digital_goods_games", "digital_goods_large_volume", "digital_goods_media", "direct_marketing_catalog_merchant", "direct_marketing_combination_catalog_and_retail_merchant", "direct_marketing_inbound_telemarketing", "direct_marketing_insurance_services", "direct_marketing_other", "direct_marketing_outbound_telemarketing", "direct_marketing_subscription", "direct_marketing_travel", "discount_stores", "doctors", "door_to_door_sales", "drapery_window_covering_and_upholstery_stores", "drinking_places", "drug_stores_and_pharmacies", "drugs_drug_proprietaries_and_druggist_sundries", "dry_cleaners", "durable_goods", "duty_free_stores", "eating_places_restaurants", "educational_services", "electric_razor_stores", "electric_vehicle_charging", "electrical_parts_and_equipment", "electrical_services", "electronics_repair_shops", "electronics_stores", "elementary_secondary_schools", "emergency_services_gcas_visa_use_only", "employment_temp_agencies", "equipment_rental", "exterminating_services", "family_clothing_stores", "fast_food_restaurants", "financial_institutions", "fines_government_administrative_entities", "fireplace_fireplace_screens_and_accessories_stores", "floor_covering_stores", "florists", "florists_supplies_nursery_stock_and_flowers", "freezer_and_locker_meat_provisioners", "fuel_dealers_non_automotive", "funeral_services_crematories", "furniture_home_furnishings_and_equipment_stores_except_appliances", "furniture_repair_refinishing", "furriers_and_fur_shops", "general_services", "gift_card_novelty_and_souvenir_shops", "glass_paint_and_wallpaper_stores", "glassware_crystal_stores", "golf_courses_public", "government_licensed_horse_dog_racing_us_region_only", "government_licensed_online_casions_online_gambling_us_region_only", "government_owned_lotteries_non_us_region", "government_owned_lotteries_us_region_only", "government_services", "grocery_stores_supermarkets", "hardware_equipment_and_supplies", "hardware_stores", "health_and_beauty_spas", "hearing_aids_sales_and_supplies", "heating_plumbing_a_c", "hobby_toy_and_game_shops", "home_supply_warehouse_stores", "hospitals", "hotels_motels_and_resorts", "household_appliance_stores", "industrial_supplies", "information_retrieval_services", "insurance_default", "insurance_underwriting_premiums", "intra_company_purchases", "jewelry_stores_watches_clocks_and_silverware_stores", "landscaping_services", "laundries", "laundry_cleaning_services", "legal_services_attorneys", "luggage_and_leather_goods_stores", "lumber_building_materials_stores", "manual_cash_disburse", "marinas_service_and_supplies", "marketplaces", "masonry_stonework_and_plaster", "massage_parlors", "medical_and_dental_labs", "medical_dental_ophthalmic_and_hospital_equipment_and_supplies", "medical_services", "membership_organizations", "mens_and_boys_clothing_and_accessories_stores", "mens_womens_clothing_stores", "metal_service_centers", "miscellaneous", "miscellaneous_apparel_and_accessory_shops", "miscellaneous_auto_dealers", "miscellaneous_business_services", "miscellaneous_food_stores", "miscellaneous_general_merchandise", "miscellaneous_general_services", "miscellaneous_home_furnishing_specialty_stores", "miscellaneous_publishing_and_printing", "miscellaneous_recreation_services", "miscellaneous_repair_shops", "miscellaneous_specialty_retail", "mobile_home_dealers", "motion_picture_theaters", "motor_freight_carriers_and_trucking", "motor_homes_dealers", "motor_vehicle_supplies_and_new_parts", "motorcycle_shops_and_dealers", "motorcycle_shops_dealers", "music_stores_musical_instruments_pianos_and_sheet_music", "news_dealers_and_newsstands", "non_fi_money_orders", "non_fi_stored_value_card_purchase_load", "nondurable_goods", "nurseries_lawn_and_garden_supply_stores", "nursing_personal_care", "office_and_commercial_furniture", "opticians_eyeglasses", "optometrists_ophthalmologist", "orthopedic_goods_prosthetic_devices", "osteopaths", "package_stores_beer_wine_and_liquor", "paints_varnishes_and_supplies", "parking_lots_garages", "passenger_railways", "pawn_shops", "pet_shops_pet_food_and_supplies", "petroleum_and_petroleum_products", "photo_developing", "photographic_photocopy_microfilm_equipment_and_supplies", "photographic_studios", "picture_video_production", "piece_goods_notions_and_other_dry_goods", "plumbing_heating_equipment_and_supplies", "political_organizations", "postal_services_government_only", "precious_stones_and_metals_watches_and_jewelry", "professional_services", "public_warehousing_and_storage", "quick_copy_repro_and_blueprint", "railroads", "real_estate_agents_and_managers_rentals", "record_stores", "recreational_vehicle_rentals", "religious_goods_stores", "religious_organizations", "roofing_siding_sheet_metal", "secretarial_support_services", "security_brokers_dealers", "service_stations", "sewing_needlework_fabric_and_piece_goods_stores", "shoe_repair_hat_cleaning", "shoe_stores", "small_appliance_repair", "snowmobile_dealers", "special_trade_services", "specialty_cleaning", "sporting_goods_stores", "sporting_recreation_camps", "sports_and_riding_apparel_stores", "sports_clubs_fields", "stamp_and_coin_stores", "stationary_office_supplies_printing_and_writing_paper", "stationery_stores_office_and_school_supply_stores", "swimming_pools_sales", "t_ui_travel_germany", "tailors_alterations", "tax_payments_government_agencies", "tax_preparation_services", "taxicabs_limousines", "telecommunication_equipment_and_telephone_sales", "telecommunication_services", "telegraph_services", "tent_and_awning_shops", "testing_laboratories", "theatrical_ticket_agencies", "timeshares", "tire_retreading_and_repair", "tolls_bridge_fees", "tourist_attractions_and_exhibits", "towing_services", "trailer_parks_campgrounds", "transportation_services", "travel_agencies_tour_operators", "truck_stop_iteration", "truck_utility_trailer_rentals", "typesetting_plate_making_and_related_services", "typewriter_stores", "u_s_federal_government_agencies_or_departments", "uniforms_commercial_clothing", "used_merchandise_and_secondhand_stores", "utilities", "variety_stores", "veterinary_services", "video_amusement_game_supplies", "video_game_arcades", "video_tape_rental_stores", "vocational_trade_schools", "watch_jewelry_repair", "welding_repair", "wholesale_clubs", "wig_and_toupee_stores", "wires_money_orders", "womens_accessory_and_specialty_shops", "womens_ready_to_wear_stores", "wrecking_and_salvage_yards" ], "maxLength": 5000, "type": "string" }, "type": "array" }, "blocked_merchant_countries": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "spending_limits": { "items": { "properties": { "amount": { "type": "integer" }, "categories": { "items": { "enum": [ "ac_refrigeration_repair", "accounting_bookkeeping_services", "advertising_services", "agricultural_cooperative", "airlines_air_carriers", "airports_flying_fields", "ambulance_services", "amusement_parks_carnivals", "antique_reproductions", "antique_shops", "aquariums", "architectural_surveying_services", "art_dealers_and_galleries", "artists_supply_and_craft_shops", "auto_and_home_supply_stores", "auto_body_repair_shops", "auto_paint_shops", "auto_service_shops", "automated_cash_disburse", "automated_fuel_dispensers", "automobile_associations", "automotive_parts_and_accessories_stores", "automotive_tire_stores", "bail_and_bond_payments", "bakeries", "bands_orchestras", "barber_and_beauty_shops", "betting_casino_gambling", "bicycle_shops", "billiard_pool_establishments", "boat_dealers", "boat_rentals_and_leases", "book_stores", "books_periodicals_and_newspapers", "bowling_alleys", "bus_lines", "business_secretarial_schools", "buying_shopping_services", "cable_satellite_and_other_pay_television_and_radio", "camera_and_photographic_supply_stores", "candy_nut_and_confectionery_stores", "car_and_truck_dealers_new_used", "car_and_truck_dealers_used_only", "car_rental_agencies", "car_washes", "carpentry_services", "carpet_upholstery_cleaning", "caterers", "charitable_and_social_service_organizations_fundraising", "chemicals_and_allied_products", "child_care_services", "childrens_and_infants_wear_stores", "chiropodists_podiatrists", "chiropractors", "cigar_stores_and_stands", "civic_social_fraternal_associations", "cleaning_and_maintenance", "clothing_rental", "colleges_universities", "commercial_equipment", "commercial_footwear", "commercial_photography_art_and_graphics", "commuter_transport_and_ferries", "computer_network_services", "computer_programming", "computer_repair", "computer_software_stores", "computers_peripherals_and_software", "concrete_work_services", "construction_materials", "consulting_public_relations", "correspondence_schools", "cosmetic_stores", "counseling_services", "country_clubs", "courier_services", "court_costs", "credit_reporting_agencies", "cruise_lines", "dairy_products_stores", "dance_hall_studios_schools", "dating_escort_services", "dentists_orthodontists", "department_stores", "detective_agencies", "digital_goods_applications", "digital_goods_games", "digital_goods_large_volume", "digital_goods_media", "direct_marketing_catalog_merchant", "direct_marketing_combination_catalog_and_retail_merchant", "direct_marketing_inbound_telemarketing", "direct_marketing_insurance_services", "direct_marketing_other", "direct_marketing_outbound_telemarketing", "direct_marketing_subscription", "direct_marketing_travel", "discount_stores", "doctors", "door_to_door_sales", "drapery_window_covering_and_upholstery_stores", "drinking_places", "drug_stores_and_pharmacies", "drugs_drug_proprietaries_and_druggist_sundries", "dry_cleaners", "durable_goods", "duty_free_stores", "eating_places_restaurants", "educational_services", "electric_razor_stores", "electric_vehicle_charging", "electrical_parts_and_equipment", "electrical_services", "electronics_repair_shops", "electronics_stores", "elementary_secondary_schools", "emergency_services_gcas_visa_use_only", "employment_temp_agencies", "equipment_rental", "exterminating_services", "family_clothing_stores", "fast_food_restaurants", "financial_institutions", "fines_government_administrative_entities", "fireplace_fireplace_screens_and_accessories_stores", "floor_covering_stores", "florists", "florists_supplies_nursery_stock_and_flowers", "freezer_and_locker_meat_provisioners", "fuel_dealers_non_automotive", "funeral_services_crematories", "furniture_home_furnishings_and_equipment_stores_except_appliances", "furniture_repair_refinishing", "furriers_and_fur_shops", "general_services", "gift_card_novelty_and_souvenir_shops", "glass_paint_and_wallpaper_stores", "glassware_crystal_stores", "golf_courses_public", "government_licensed_horse_dog_racing_us_region_only", "government_licensed_online_casions_online_gambling_us_region_only", "government_owned_lotteries_non_us_region", "government_owned_lotteries_us_region_only", "government_services", "grocery_stores_supermarkets", "hardware_equipment_and_supplies", "hardware_stores", "health_and_beauty_spas", "hearing_aids_sales_and_supplies", "heating_plumbing_a_c", "hobby_toy_and_game_shops", "home_supply_warehouse_stores", "hospitals", "hotels_motels_and_resorts", "household_appliance_stores", "industrial_supplies", "information_retrieval_services", "insurance_default", "insurance_underwriting_premiums", "intra_company_purchases", "jewelry_stores_watches_clocks_and_silverware_stores", "landscaping_services", "laundries", "laundry_cleaning_services", "legal_services_attorneys", "luggage_and_leather_goods_stores", "lumber_building_materials_stores", "manual_cash_disburse", "marinas_service_and_supplies", "marketplaces", "masonry_stonework_and_plaster", "massage_parlors", "medical_and_dental_labs", "medical_dental_ophthalmic_and_hospital_equipment_and_supplies", "medical_services", "membership_organizations", "mens_and_boys_clothing_and_accessories_stores", "mens_womens_clothing_stores", "metal_service_centers", "miscellaneous", "miscellaneous_apparel_and_accessory_shops", "miscellaneous_auto_dealers", "miscellaneous_business_services", "miscellaneous_food_stores", "miscellaneous_general_merchandise", "miscellaneous_general_services", "miscellaneous_home_furnishing_specialty_stores", "miscellaneous_publishing_and_printing", "miscellaneous_recreation_services", "miscellaneous_repair_shops", "miscellaneous_specialty_retail", "mobile_home_dealers", "motion_picture_theaters", "motor_freight_carriers_and_trucking", "motor_homes_dealers", "motor_vehicle_supplies_and_new_parts", "motorcycle_shops_and_dealers", "motorcycle_shops_dealers", "music_stores_musical_instruments_pianos_and_sheet_music", "news_dealers_and_newsstands", "non_fi_money_orders", "non_fi_stored_value_card_purchase_load", "nondurable_goods", "nurseries_lawn_and_garden_supply_stores", "nursing_personal_care", "office_and_commercial_furniture", "opticians_eyeglasses", "optometrists_ophthalmologist", "orthopedic_goods_prosthetic_devices", "osteopaths", "package_stores_beer_wine_and_liquor", "paints_varnishes_and_supplies", "parking_lots_garages", "passenger_railways", "pawn_shops", "pet_shops_pet_food_and_supplies", "petroleum_and_petroleum_products", "photo_developing", "photographic_photocopy_microfilm_equipment_and_supplies", "photographic_studios", "picture_video_production", "piece_goods_notions_and_other_dry_goods", "plumbing_heating_equipment_and_supplies", "political_organizations", "postal_services_government_only", "precious_stones_and_metals_watches_and_jewelry", "professional_services", "public_warehousing_and_storage", "quick_copy_repro_and_blueprint", "railroads", "real_estate_agents_and_managers_rentals", "record_stores", "recreational_vehicle_rentals", "religious_goods_stores", "religious_organizations", "roofing_siding_sheet_metal", "secretarial_support_services", "security_brokers_dealers", "service_stations", "sewing_needlework_fabric_and_piece_goods_stores", "shoe_repair_hat_cleaning", "shoe_stores", "small_appliance_repair", "snowmobile_dealers", "special_trade_services", "specialty_cleaning", "sporting_goods_stores", "sporting_recreation_camps", "sports_and_riding_apparel_stores", "sports_clubs_fields", "stamp_and_coin_stores", "stationary_office_supplies_printing_and_writing_paper", "stationery_stores_office_and_school_supply_stores", "swimming_pools_sales", "t_ui_travel_germany", "tailors_alterations", "tax_payments_government_agencies", "tax_preparation_services", "taxicabs_limousines", "telecommunication_equipment_and_telephone_sales", "telecommunication_services", "telegraph_services", "tent_and_awning_shops", "testing_laboratories", "theatrical_ticket_agencies", "timeshares", "tire_retreading_and_repair", "tolls_bridge_fees", "tourist_attractions_and_exhibits", "towing_services", "trailer_parks_campgrounds", "transportation_services", "travel_agencies_tour_operators", "truck_stop_iteration", "truck_utility_trailer_rentals", "typesetting_plate_making_and_related_services", "typewriter_stores", "u_s_federal_government_agencies_or_departments", "uniforms_commercial_clothing", "used_merchandise_and_secondhand_stores", "utilities", "variety_stores", "veterinary_services", "video_amusement_game_supplies", "video_game_arcades", "video_tape_rental_stores", "vocational_trade_schools", "watch_jewelry_repair", "welding_repair", "wholesale_clubs", "wig_and_toupee_stores", "wires_money_orders", "womens_accessory_and_specialty_shops", "womens_ready_to_wear_stores", "wrecking_and_salvage_yards" ], "maxLength": 5000, "type": "string" }, "type": "array" }, "interval": { "enum": [ "all_time", "daily", "monthly", "per_authorization", "weekly", "yearly" ], "type": "string" } }, "required": [ "amount", "interval" ], "title": "spending_limits_param", "type": "object" }, "type": "array" } }, "title": "authorization_controls_param", "type": "object" }, "status": { "description": "Dictates whether authorizations can be approved on this card. May be blocked from activating cards depending on past-due Cardholder requirements. Defaults to `inactive`. If this card is being canceled because it was lost or stolen, this information should be provided as `cancellation_reason`.", "enum": [ "active", "canceled", "inactive" ], "type": "string", "x-stripeBypassValidation": true } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issuing.card" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a card" } }, "/v1/issuing/disputes": { "get": { "description": "

Returns a list of Issuing Dispute objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

", "operationId": "GetIssuingDisputes", "parameters": [ { "description": "Only return Issuing disputes that were created during the given date interval.", "explode": true, "in": "query", "name": "created", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "type": "integer" }, "gte": { "type": "integer" }, "lt": { "type": "integer" }, "lte": { "type": "integer" } }, "title": "range_query_specs", "type": "object" }, { "type": "integer" } ] }, "style": "deepObject" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Select Issuing disputes with the given status.", "in": "query", "name": "status", "required": false, "schema": { "enum": [ "expired", "lost", "submitted", "unsubmitted", "won" ], "type": "string" }, "style": "form" }, { "description": "Select the Issuing dispute for the given transaction.", "in": "query", "name": "transaction", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/issuing.dispute" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/issuing/disputes", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "IssuingDisputeList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all disputes" }, "post": { "description": "

Creates an Issuing Dispute object. Individual pieces of evidence within the evidence object are optional at this point. Stripe only validates that required evidence is present during submission. Refer to Dispute reasons and evidence for more details about evidence requirements.

", "operationId": "PostIssuingDisputes", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "evidence": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "treasury": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "amount": { "description": "The dispute amount in the card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). If not set, defaults to the full transaction amount.", "type": "integer" }, "evidence": { "description": "Evidence provided for the dispute.", "properties": { "canceled": { "anyOf": [ { "properties": { "additional_documentation": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "canceled_at": { "anyOf": [ { "format": "unix-time", "type": "integer" }, { "enum": [ "" ], "type": "string" } ] }, "cancellation_policy_provided": { "anyOf": [ { "type": "boolean" }, { "enum": [ "" ], "type": "string" } ] }, "cancellation_reason": { "anyOf": [ { "maxLength": 2500, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "expected_at": { "anyOf": [ { "format": "unix-time", "type": "integer" }, { "enum": [ "" ], "type": "string" } ] }, "explanation": { "anyOf": [ { "maxLength": 2500, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "product_description": { "anyOf": [ { "maxLength": 2500, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "product_type": { "enum": [ "", "merchandise", "service" ], "type": "string" }, "return_status": { "enum": [ "", "merchant_rejected", "successful" ], "type": "string" }, "returned_at": { "anyOf": [ { "format": "unix-time", "type": "integer" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "canceled", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "duplicate": { "anyOf": [ { "properties": { "additional_documentation": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "card_statement": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "cash_receipt": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "check_image": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "explanation": { "anyOf": [ { "maxLength": 2500, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "original_transaction": { "maxLength": 5000, "type": "string" } }, "title": "duplicate", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "fraudulent": { "anyOf": [ { "properties": { "additional_documentation": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "explanation": { "anyOf": [ { "maxLength": 2500, "type": "string" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "fraudulent", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "merchandise_not_as_described": { "anyOf": [ { "properties": { "additional_documentation": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "explanation": { "anyOf": [ { "maxLength": 2500, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "received_at": { "anyOf": [ { "format": "unix-time", "type": "integer" }, { "enum": [ "" ], "type": "string" } ] }, "return_description": { "anyOf": [ { "maxLength": 2500, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "return_status": { "enum": [ "", "merchant_rejected", "successful" ], "type": "string" }, "returned_at": { "anyOf": [ { "format": "unix-time", "type": "integer" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "merchandise_not_as_described", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "no_valid_authorization": { "anyOf": [ { "properties": { "additional_documentation": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "explanation": { "anyOf": [ { "maxLength": 2500, "type": "string" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "no_valid_authorization", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "not_received": { "anyOf": [ { "properties": { "additional_documentation": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "expected_at": { "anyOf": [ { "format": "unix-time", "type": "integer" }, { "enum": [ "" ], "type": "string" } ] }, "explanation": { "anyOf": [ { "maxLength": 2500, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "product_description": { "anyOf": [ { "maxLength": 2500, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "product_type": { "enum": [ "", "merchandise", "service" ], "type": "string" } }, "title": "not_received", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "other": { "anyOf": [ { "properties": { "additional_documentation": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "explanation": { "anyOf": [ { "maxLength": 2500, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "product_description": { "anyOf": [ { "maxLength": 2500, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "product_type": { "enum": [ "", "merchandise", "service" ], "type": "string" } }, "title": "other", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "reason": { "enum": [ "canceled", "duplicate", "fraudulent", "merchandise_not_as_described", "no_valid_authorization", "not_received", "other", "service_not_as_described" ], "type": "string", "x-stripeBypassValidation": true }, "service_not_as_described": { "anyOf": [ { "properties": { "additional_documentation": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "canceled_at": { "anyOf": [ { "format": "unix-time", "type": "integer" }, { "enum": [ "" ], "type": "string" } ] }, "cancellation_reason": { "anyOf": [ { "maxLength": 2500, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "explanation": { "anyOf": [ { "maxLength": 2500, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "received_at": { "anyOf": [ { "format": "unix-time", "type": "integer" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "service_not_as_described", "type": "object" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "evidence_param", "type": "object" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "transaction": { "description": "The ID of the issuing transaction to create a dispute for. For transaction on Treasury FinancialAccounts, use `treasury.received_debit`.", "maxLength": 5000, "type": "string" }, "treasury": { "description": "Params for disputes related to Treasury FinancialAccounts", "properties": { "received_debit": { "maxLength": 5000, "type": "string" } }, "required": [ "received_debit" ], "title": "treasury_param", "type": "object" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issuing.dispute" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a dispute" } }, "/v1/issuing/disputes/{dispute}": { "get": { "description": "

Retrieves an Issuing Dispute object.

", "operationId": "GetIssuingDisputesDispute", "parameters": [ { "in": "path", "name": "dispute", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issuing.dispute" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a dispute" }, "post": { "description": "

Updates the specified Issuing Dispute object by setting the values of the parameters passed. Any parameters not provided will be left unchanged. Properties on the evidence object can be unset by passing in an empty string.

", "operationId": "PostIssuingDisputesDispute", "parameters": [ { "in": "path", "name": "dispute", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "evidence": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "amount": { "description": "The dispute amount in the card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", "type": "integer" }, "evidence": { "description": "Evidence provided for the dispute.", "properties": { "canceled": { "anyOf": [ { "properties": { "additional_documentation": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "canceled_at": { "anyOf": [ { "format": "unix-time", "type": "integer" }, { "enum": [ "" ], "type": "string" } ] }, "cancellation_policy_provided": { "anyOf": [ { "type": "boolean" }, { "enum": [ "" ], "type": "string" } ] }, "cancellation_reason": { "anyOf": [ { "maxLength": 2500, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "expected_at": { "anyOf": [ { "format": "unix-time", "type": "integer" }, { "enum": [ "" ], "type": "string" } ] }, "explanation": { "anyOf": [ { "maxLength": 2500, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "product_description": { "anyOf": [ { "maxLength": 2500, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "product_type": { "enum": [ "", "merchandise", "service" ], "type": "string" }, "return_status": { "enum": [ "", "merchant_rejected", "successful" ], "type": "string" }, "returned_at": { "anyOf": [ { "format": "unix-time", "type": "integer" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "canceled", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "duplicate": { "anyOf": [ { "properties": { "additional_documentation": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "card_statement": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "cash_receipt": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "check_image": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "explanation": { "anyOf": [ { "maxLength": 2500, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "original_transaction": { "maxLength": 5000, "type": "string" } }, "title": "duplicate", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "fraudulent": { "anyOf": [ { "properties": { "additional_documentation": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "explanation": { "anyOf": [ { "maxLength": 2500, "type": "string" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "fraudulent", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "merchandise_not_as_described": { "anyOf": [ { "properties": { "additional_documentation": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "explanation": { "anyOf": [ { "maxLength": 2500, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "received_at": { "anyOf": [ { "format": "unix-time", "type": "integer" }, { "enum": [ "" ], "type": "string" } ] }, "return_description": { "anyOf": [ { "maxLength": 2500, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "return_status": { "enum": [ "", "merchant_rejected", "successful" ], "type": "string" }, "returned_at": { "anyOf": [ { "format": "unix-time", "type": "integer" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "merchandise_not_as_described", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "no_valid_authorization": { "anyOf": [ { "properties": { "additional_documentation": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "explanation": { "anyOf": [ { "maxLength": 2500, "type": "string" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "no_valid_authorization", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "not_received": { "anyOf": [ { "properties": { "additional_documentation": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "expected_at": { "anyOf": [ { "format": "unix-time", "type": "integer" }, { "enum": [ "" ], "type": "string" } ] }, "explanation": { "anyOf": [ { "maxLength": 2500, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "product_description": { "anyOf": [ { "maxLength": 2500, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "product_type": { "enum": [ "", "merchandise", "service" ], "type": "string" } }, "title": "not_received", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "other": { "anyOf": [ { "properties": { "additional_documentation": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "explanation": { "anyOf": [ { "maxLength": 2500, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "product_description": { "anyOf": [ { "maxLength": 2500, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "product_type": { "enum": [ "", "merchandise", "service" ], "type": "string" } }, "title": "other", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "reason": { "enum": [ "canceled", "duplicate", "fraudulent", "merchandise_not_as_described", "no_valid_authorization", "not_received", "other", "service_not_as_described" ], "type": "string", "x-stripeBypassValidation": true }, "service_not_as_described": { "anyOf": [ { "properties": { "additional_documentation": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "canceled_at": { "anyOf": [ { "format": "unix-time", "type": "integer" }, { "enum": [ "" ], "type": "string" } ] }, "cancellation_reason": { "anyOf": [ { "maxLength": 2500, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "explanation": { "anyOf": [ { "maxLength": 2500, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "received_at": { "anyOf": [ { "format": "unix-time", "type": "integer" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "service_not_as_described", "type": "object" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "evidence_param", "type": "object" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issuing.dispute" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a dispute" } }, "/v1/issuing/disputes/{dispute}/submit": { "post": { "description": "

Submits an Issuing Dispute to the card network. Stripe validates that all evidence fields required for the dispute’s reason are present. For more details, see Dispute reasons and evidence.

", "operationId": "PostIssuingDisputesDisputeSubmit", "parameters": [ { "in": "path", "name": "dispute", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issuing.dispute" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Submit a dispute" } }, "/v1/issuing/personalization_designs": { "get": { "description": "

Returns a list of personalization design objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

", "operationId": "GetIssuingPersonalizationDesigns", "parameters": [ { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "Only return personalization designs with the given lookup keys.", "explode": true, "in": "query", "name": "lookup_keys", "required": false, "schema": { "items": { "maxLength": 200, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "Only return personalization designs with the given preferences.", "explode": true, "in": "query", "name": "preferences", "required": false, "schema": { "properties": { "is_default": { "type": "boolean" }, "is_platform_default": { "type": "boolean" } }, "title": "preferences_list_param", "type": "object" }, "style": "deepObject" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Only return personalization designs with the given status.", "in": "query", "name": "status", "required": false, "schema": { "enum": [ "active", "inactive", "rejected", "review" ], "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/issuing.personalization_design" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/issuing/personalization_designs", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "IssuingPersonalizationDesignList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all personalization designs" }, "post": { "description": "

Creates a personalization design object.

", "operationId": "PostIssuingPersonalizationDesigns", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "carrier_text": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "preferences": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "card_logo": { "description": "The file for the card logo, for use with physical bundles that support card logos. Must have a `purpose` value of `issuing_logo`.", "type": "string" }, "carrier_text": { "description": "Hash containing carrier text, for use with physical bundles that support carrier text.", "properties": { "footer_body": { "anyOf": [ { "maxLength": 200, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "footer_title": { "anyOf": [ { "maxLength": 30, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "header_body": { "anyOf": [ { "maxLength": 200, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "header_title": { "anyOf": [ { "maxLength": 30, "type": "string" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "carrier_text_param", "type": "object" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "lookup_key": { "description": "A lookup key used to retrieve personalization designs dynamically from a static string. This may be up to 200 characters.", "maxLength": 200, "type": "string" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "name": { "description": "Friendly display name.", "maxLength": 200, "type": "string" }, "physical_bundle": { "description": "The physical bundle object belonging to this personalization design.", "maxLength": 5000, "type": "string" }, "preferences": { "description": "Information on whether this personalization design is used to create cards when one is not specified.", "properties": { "is_default": { "type": "boolean" } }, "required": [ "is_default" ], "title": "preferences_param", "type": "object" }, "transfer_lookup_key": { "description": "If set to true, will atomically remove the lookup key from the existing personalization design, and assign it to this personalization design.", "type": "boolean" } }, "required": [ "physical_bundle" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issuing.personalization_design" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a personalization design" } }, "/v1/issuing/personalization_designs/{personalization_design}": { "get": { "description": "

Retrieves a personalization design object.

", "operationId": "GetIssuingPersonalizationDesignsPersonalizationDesign", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "personalization_design", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issuing.personalization_design" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a personalization design" }, "post": { "description": "

Updates a card personalization object.

", "operationId": "PostIssuingPersonalizationDesignsPersonalizationDesign", "parameters": [ { "in": "path", "name": "personalization_design", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "card_logo": { "explode": true, "style": "deepObject" }, "carrier_text": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "lookup_key": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "name": { "explode": true, "style": "deepObject" }, "preferences": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "card_logo": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "The file for the card logo, for use with physical bundles that support card logos. Must have a `purpose` value of `issuing_logo`." }, "carrier_text": { "anyOf": [ { "properties": { "footer_body": { "anyOf": [ { "maxLength": 200, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "footer_title": { "anyOf": [ { "maxLength": 30, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "header_body": { "anyOf": [ { "maxLength": 200, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "header_title": { "anyOf": [ { "maxLength": 30, "type": "string" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "carrier_text_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Hash containing carrier text, for use with physical bundles that support carrier text." }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "lookup_key": { "anyOf": [ { "maxLength": 200, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "A lookup key used to retrieve personalization designs dynamically from a static string. This may be up to 200 characters." }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "name": { "anyOf": [ { "maxLength": 200, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Friendly display name. Providing an empty string will set the field to null." }, "physical_bundle": { "description": "The physical bundle object belonging to this personalization design.", "maxLength": 5000, "type": "string" }, "preferences": { "description": "Information on whether this personalization design is used to create cards when one is not specified.", "properties": { "is_default": { "type": "boolean" } }, "required": [ "is_default" ], "title": "preferences_param", "type": "object" }, "transfer_lookup_key": { "description": "If set to true, will atomically remove the lookup key from the existing personalization design, and assign it to this personalization design.", "type": "boolean" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issuing.personalization_design" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a personalization design" } }, "/v1/issuing/physical_bundles": { "get": { "description": "

Returns a list of physical bundle objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

", "operationId": "GetIssuingPhysicalBundles", "parameters": [ { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Only return physical bundles with the given status.", "in": "query", "name": "status", "required": false, "schema": { "enum": [ "active", "inactive", "review" ], "type": "string" }, "style": "form" }, { "description": "Only return physical bundles with the given type.", "in": "query", "name": "type", "required": false, "schema": { "enum": [ "custom", "standard" ], "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/issuing.physical_bundle" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/issuing/physical_bundles", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "IssuingPhysicalBundleList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all physical bundles" } }, "/v1/issuing/physical_bundles/{physical_bundle}": { "get": { "description": "

Retrieves a physical bundle object.

", "operationId": "GetIssuingPhysicalBundlesPhysicalBundle", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "physical_bundle", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issuing.physical_bundle" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a physical bundle" } }, "/v1/issuing/settlements/{settlement}": { "get": { "description": "

Retrieves an Issuing Settlement object.

", "operationId": "GetIssuingSettlementsSettlement", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "settlement", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issuing.settlement" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a settlement" }, "post": { "description": "

Updates the specified Issuing Settlement object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

", "operationId": "PostIssuingSettlementsSettlement", "parameters": [ { "in": "path", "name": "settlement", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issuing.settlement" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a settlement" } }, "/v1/issuing/tokens": { "get": { "description": "

Lists all Issuing Token objects for a given card.

", "operationId": "GetIssuingTokens", "parameters": [ { "description": "The Issuing card identifier to list tokens for.", "in": "query", "name": "card", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Only return Issuing tokens that were created during the given date interval.", "explode": true, "in": "query", "name": "created", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "type": "integer" }, "gte": { "type": "integer" }, "lt": { "type": "integer" }, "lte": { "type": "integer" } }, "title": "range_query_specs", "type": "object" }, { "type": "integer" } ] }, "style": "deepObject" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Select Issuing tokens with the given status.", "in": "query", "name": "status", "required": false, "schema": { "enum": [ "active", "deleted", "requested", "suspended" ], "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/issuing.token" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "IssuingNetworkTokenList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all issuing tokens for card" } }, "/v1/issuing/tokens/{token}": { "get": { "description": "

Retrieves an Issuing Token object.

", "operationId": "GetIssuingTokensToken", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "token", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issuing.token" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve an issuing token" }, "post": { "description": "

Attempts to update the specified Issuing Token object to the status specified.

", "operationId": "PostIssuingTokensToken", "parameters": [ { "in": "path", "name": "token", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "status": { "description": "Specifies which status the token should be updated to.", "enum": [ "active", "deleted", "suspended" ], "type": "string" } }, "required": [ "status" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issuing.token" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a token status" } }, "/v1/issuing/transactions": { "get": { "description": "

Returns a list of Issuing Transaction objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

", "operationId": "GetIssuingTransactions", "parameters": [ { "description": "Only return transactions that belong to the given card.", "in": "query", "name": "card", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Only return transactions that belong to the given cardholder.", "in": "query", "name": "cardholder", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Only return transactions that were created during the given date interval.", "explode": true, "in": "query", "name": "created", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "type": "integer" }, "gte": { "type": "integer" }, "lt": { "type": "integer" }, "lte": { "type": "integer" } }, "title": "range_query_specs", "type": "object" }, { "type": "integer" } ] }, "style": "deepObject" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Only return transactions that have the given type. One of `capture` or `refund`.", "in": "query", "name": "type", "required": false, "schema": { "enum": [ "capture", "refund" ], "type": "string", "x-stripeBypassValidation": true }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/issuing.transaction" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/issuing/transactions", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "IssuingTransactionList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all transactions" } }, "/v1/issuing/transactions/{transaction}": { "get": { "description": "

Retrieves an Issuing Transaction object.

", "operationId": "GetIssuingTransactionsTransaction", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "transaction", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issuing.transaction" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a transaction" }, "post": { "description": "

Updates the specified Issuing Transaction object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

", "operationId": "PostIssuingTransactionsTransaction", "parameters": [ { "in": "path", "name": "transaction", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issuing.transaction" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a transaction" } }, "/v1/link_account_sessions": { "post": { "description": "

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.

", "operationId": "PostLinkAccountSessions", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "account_holder": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "filters": { "explode": true, "style": "deepObject" }, "permissions": { "explode": true, "style": "deepObject" }, "prefetch": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "account_holder": { "description": "The account holder to link accounts for.", "properties": { "account": { "maxLength": 5000, "type": "string" }, "customer": { "maxLength": 5000, "type": "string" }, "type": { "enum": [ "account", "customer" ], "type": "string" } }, "required": [ "type" ], "title": "accountholder_params", "type": "object" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "filters": { "description": "Filters to restrict the kinds of accounts to collect.", "properties": { "account_subcategories": { "items": { "enum": [ "checking", "credit_card", "line_of_credit", "mortgage", "savings" ], "type": "string" }, "type": "array" }, "countries": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "title": "filters_params", "type": "object" }, "permissions": { "description": "List of data features that you would like to request access to.\n\nPossible values are `balances`, `transactions`, `ownership`, and `payment_method`.", "items": { "enum": [ "balances", "ownership", "payment_method", "transactions" ], "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true }, "type": "array" }, "prefetch": { "description": "List of data features that you would like to retrieve upon account creation.", "items": { "enum": [ "balances", "ownership", "transactions" ], "type": "string", "x-stripeBypassValidation": true }, "type": "array" }, "return_url": { "description": "For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.", "maxLength": 5000, "type": "string" } }, "required": [ "account_holder", "permissions" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/financial_connections.session" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a Session" } }, "/v1/link_account_sessions/{session}": { "get": { "description": "

Retrieves the details of a Financial Connections Session

", "operationId": "GetLinkAccountSessionsSession", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "session", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/financial_connections.session" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a Session" } }, "/v1/linked_accounts": { "get": { "description": "

Returns a list of Financial Connections Account objects.

", "operationId": "GetLinkedAccounts", "parameters": [ { "description": "If present, only return accounts that belong to the specified account holder. `account_holder[customer]` and `account_holder[account]` are mutually exclusive.", "explode": true, "in": "query", "name": "account_holder", "required": false, "schema": { "properties": { "account": { "maxLength": 5000, "type": "string" }, "customer": { "maxLength": 5000, "type": "string" } }, "title": "accountholder_params", "type": "object" }, "style": "deepObject" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "If present, only return accounts that were collected as part of the given session.", "in": "query", "name": "session", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/financial_connections.account" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/financial_connections/accounts", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "BankConnectionsResourceLinkedAccountList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List Accounts" } }, "/v1/linked_accounts/{account}": { "get": { "description": "

Retrieves the details of an Financial Connections Account.

", "operationId": "GetLinkedAccountsAccount", "parameters": [ { "in": "path", "name": "account", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/financial_connections.account" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve an Account" } }, "/v1/linked_accounts/{account}/disconnect": { "post": { "description": "

Disables your access to a Financial Connections Account. You will no longer be able to access data associated with the account (e.g. balances, transactions).

", "operationId": "PostLinkedAccountsAccountDisconnect", "parameters": [ { "in": "path", "name": "account", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/financial_connections.account" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Disconnect an Account" } }, "/v1/linked_accounts/{account}/owners": { "get": { "description": "

Lists all owners for a given Account

", "operationId": "GetLinkedAccountsAccountOwners", "parameters": [ { "in": "path", "name": "account", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "The ID of the ownership object to fetch owners from.", "in": "query", "name": "ownership", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/financial_connections.account_owner" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "BankConnectionsResourceOwnerList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List Account Owners" } }, "/v1/linked_accounts/{account}/refresh": { "post": { "description": "

Refreshes the data associated with a Financial Connections Account.

", "operationId": "PostLinkedAccountsAccountRefresh", "parameters": [ { "in": "path", "name": "account", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "features": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "features": { "description": "The list of account features that you would like to refresh.", "items": { "enum": [ "balance", "ownership", "transactions" ], "type": "string", "x-stripeBypassValidation": true }, "type": "array" } }, "required": [ "features" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/financial_connections.account" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Refresh Account data" } }, "/v1/mandates/{mandate}": { "get": { "description": "

Retrieves a Mandate object.

", "operationId": "GetMandatesMandate", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "mandate", "required": true, "schema": { "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/mandate" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a Mandate" } }, "/v1/payment_intents": { "get": { "description": "

Returns a list of PaymentIntents.

", "operationId": "GetPaymentIntents", "parameters": [ { "description": "A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp or a dictionary with a number of different query options.", "explode": true, "in": "query", "name": "created", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "type": "integer" }, "gte": { "type": "integer" }, "lt": { "type": "integer" }, "lte": { "type": "integer" } }, "title": "range_query_specs", "type": "object" }, { "type": "integer" } ] }, "style": "deepObject" }, { "description": "Only return PaymentIntents for the customer that this customer ID specifies.", "in": "query", "name": "customer", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/payment_intent" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/payment_intents", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "PaymentFlowsPaymentIntentList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all PaymentIntents" }, "post": { "description": "

Creates a PaymentIntent object.

\n\n

After the PaymentIntent is created, attach a payment method and confirm\nto continue the payment. Learn more about the available payment flows\nwith the Payment Intents API.

\n\n

When you use confirm=true during creation, it’s equivalent to creating\nand confirming the PaymentIntent in the same call. You can use any parameters\navailable in the confirm API when you supply\nconfirm=true.

", "operationId": "PostPaymentIntents", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "automatic_payment_methods": { "explode": true, "style": "deepObject" }, "excluded_payment_method_types": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "mandate_data": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "off_session": { "explode": true, "style": "deepObject" }, "payment_method_data": { "explode": true, "style": "deepObject" }, "payment_method_options": { "explode": true, "style": "deepObject" }, "payment_method_types": { "explode": true, "style": "deepObject" }, "radar_options": { "explode": true, "style": "deepObject" }, "shipping": { "explode": true, "style": "deepObject" }, "transfer_data": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "amount": { "description": "Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).", "type": "integer" }, "application_fee_amount": { "description": "The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total amount captured. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).", "type": "integer" }, "automatic_payment_methods": { "description": "When you enable this parameter, this PaymentIntent accepts payment methods that you enable in the Dashboard and that are compatible with this PaymentIntent's other parameters.", "properties": { "allow_redirects": { "enum": [ "always", "never" ], "type": "string" }, "enabled": { "type": "boolean" } }, "required": [ "enabled" ], "title": "automatic_payment_methods_param", "type": "object" }, "capture_method": { "description": "Controls when the funds will be captured from the customer's account.", "enum": [ "automatic", "automatic_async", "manual" ], "type": "string" }, "confirm": { "description": "Set to `true` to attempt to [confirm this PaymentIntent](https://stripe.com/docs/api/payment_intents/confirm) immediately. This parameter defaults to `false`. When creating and confirming a PaymentIntent at the same time, you can also provide the parameters available in the [Confirm API](https://stripe.com/docs/api/payment_intents/confirm).", "type": "boolean" }, "confirmation_method": { "description": "Describes whether we can confirm this PaymentIntent automatically, or if it requires customer action to confirm the payment.", "enum": [ "automatic", "manual" ], "type": "string" }, "confirmation_token": { "description": "ID of the ConfirmationToken used to confirm this PaymentIntent.\n\nIf the provided ConfirmationToken contains properties that are also being provided in this request, such as `payment_method`, then the values in this request will take precedence.", "maxLength": 5000, "type": "string" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "customer": { "description": "ID of the Customer this PaymentIntent belongs to, if one exists.\n\nPayment methods attached to other Customers cannot be used with this PaymentIntent.\n\nIf [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead.", "maxLength": 5000, "type": "string" }, "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users.", "maxLength": 1000, "type": "string" }, "error_on_requires_action": { "description": "Set to `true` to fail the payment attempt if the PaymentIntent transitions into `requires_action`. Use this parameter for simpler integrations that don't handle customer actions, such as [saving cards without authentication](https://stripe.com/docs/payments/save-card-without-authentication). This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm).", "type": "boolean" }, "excluded_payment_method_types": { "description": "The list of payment method types to exclude from use with this payment.", "items": { "enum": [ "acss_debit", "affirm", "afterpay_clearpay", "alipay", "alma", "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", "billie", "blik", "boleto", "card", "cashapp", "crypto", "customer_balance", "eps", "fpx", "giropay", "grabpay", "ideal", "kakao_pay", "klarna", "konbini", "kr_card", "mobilepay", "multibanco", "naver_pay", "nz_bank_account", "oxxo", "p24", "pay_by_bank", "payco", "paynow", "paypal", "pix", "promptpay", "revolut_pay", "samsung_pay", "satispay", "sepa_debit", "sofort", "swish", "twint", "us_bank_account", "wechat_pay", "zip" ], "type": "string", "x-stripeBypassValidation": true }, "type": "array" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "mandate": { "description": "ID of the mandate that's used for this payment. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm).", "maxLength": 5000, "type": "string" }, "mandate_data": { "anyOf": [ { "properties": { "customer_acceptance": { "properties": { "accepted_at": { "format": "unix-time", "type": "integer" }, "offline": { "properties": {}, "title": "offline_param", "type": "object" }, "online": { "properties": { "ip_address": { "type": "string" }, "user_agent": { "maxLength": 5000, "type": "string" } }, "required": [ "ip_address", "user_agent" ], "title": "online_param", "type": "object" }, "type": { "enum": [ "offline", "online" ], "maxLength": 5000, "type": "string" } }, "required": [ "type" ], "title": "customer_acceptance_param", "type": "object" } }, "required": [ "customer_acceptance" ], "title": "secret_key_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "This hash contains details about the Mandate to create. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm)." }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "off_session": { "anyOf": [ { "type": "boolean" }, { "enum": [ "one_off", "recurring" ], "maxLength": 5000, "type": "string" } ], "description": "Set to `true` to indicate that the customer isn't in your checkout flow during this payment attempt and can't authenticate. Use this parameter in scenarios where you collect card details and [charge them later](https://stripe.com/docs/payments/cards/charging-saved-cards). This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm)." }, "on_behalf_of": { "description": "The Stripe account ID that these funds are intended for. Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).", "type": "string" }, "payment_method": { "description": "ID of the payment method (a PaymentMethod, Card, or [compatible Source](https://stripe.com/docs/payments/payment-methods/transitioning#compatibility) object) to attach to this PaymentIntent.\n\nIf you omit this parameter with `confirm=true`, `customer.default_source` attaches as this PaymentIntent's payment instrument to improve migration for users of the Charges API. We recommend that you explicitly provide the `payment_method` moving forward.\nIf the payment method is attached to a Customer, you must also provide the ID of that Customer as the [customer](https://stripe.com/docs/api#create_payment_intent-customer) parameter of this PaymentIntent.", "maxLength": 5000, "type": "string" }, "payment_method_configuration": { "description": "The ID of the [payment method configuration](https://stripe.com/docs/api/payment_method_configurations) to use with this PaymentIntent.", "maxLength": 100, "type": "string" }, "payment_method_data": { "description": "If provided, this hash will be used to create a PaymentMethod. The new PaymentMethod will appear\nin the [payment_method](https://stripe.com/docs/api/payment_intents/object#payment_intent_object-payment_method)\nproperty on the PaymentIntent.", "properties": { "acss_debit": { "properties": { "account_number": { "maxLength": 5000, "type": "string" }, "institution_number": { "maxLength": 5000, "type": "string" }, "transit_number": { "maxLength": 5000, "type": "string" } }, "required": [ "account_number", "institution_number", "transit_number" ], "title": "payment_method_param", "type": "object" }, "affirm": { "properties": {}, "title": "param", "type": "object" }, "afterpay_clearpay": { "properties": {}, "title": "param", "type": "object" }, "alipay": { "properties": {}, "title": "param", "type": "object" }, "allow_redisplay": { "enum": [ "always", "limited", "unspecified" ], "type": "string" }, "alma": { "properties": {}, "title": "param", "type": "object" }, "amazon_pay": { "properties": {}, "title": "param", "type": "object" }, "au_becs_debit": { "properties": { "account_number": { "maxLength": 5000, "type": "string" }, "bsb_number": { "maxLength": 5000, "type": "string" } }, "required": [ "account_number", "bsb_number" ], "title": "param", "type": "object" }, "bacs_debit": { "properties": { "account_number": { "maxLength": 5000, "type": "string" }, "sort_code": { "maxLength": 5000, "type": "string" } }, "title": "param", "type": "object" }, "bancontact": { "properties": {}, "title": "param", "type": "object" }, "billie": { "properties": {}, "title": "param", "type": "object" }, "billing_details": { "properties": { "address": { "anyOf": [ { "properties": { "city": { "maxLength": 5000, "type": "string" }, "country": { "maxLength": 5000, "type": "string" }, "line1": { "maxLength": 5000, "type": "string" }, "line2": { "maxLength": 5000, "type": "string" }, "postal_code": { "maxLength": 5000, "type": "string" }, "state": { "maxLength": 5000, "type": "string" } }, "title": "billing_details_address", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "email": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "name": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "phone": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "tax_id": { "maxLength": 5000, "type": "string" } }, "title": "billing_details_inner_params", "type": "object" }, "blik": { "properties": {}, "title": "param", "type": "object" }, "boleto": { "properties": { "tax_id": { "maxLength": 5000, "type": "string" } }, "required": [ "tax_id" ], "title": "param", "type": "object" }, "cashapp": { "properties": {}, "title": "param", "type": "object" }, "crypto": { "properties": {}, "title": "param", "type": "object" }, "customer_balance": { "properties": {}, "title": "param", "type": "object" }, "eps": { "properties": { "bank": { "enum": [ "arzte_und_apotheker_bank", "austrian_anadi_bank_ag", "bank_austria", "bankhaus_carl_spangler", "bankhaus_schelhammer_und_schattera_ag", "bawag_psk_ag", "bks_bank_ag", "brull_kallmus_bank_ag", "btv_vier_lander_bank", "capital_bank_grawe_gruppe_ag", "deutsche_bank_ag", "dolomitenbank", "easybank_ag", "erste_bank_und_sparkassen", "hypo_alpeadriabank_international_ag", "hypo_bank_burgenland_aktiengesellschaft", "hypo_noe_lb_fur_niederosterreich_u_wien", "hypo_oberosterreich_salzburg_steiermark", "hypo_tirol_bank_ag", "hypo_vorarlberg_bank_ag", "marchfelder_bank", "oberbank_ag", "raiffeisen_bankengruppe_osterreich", "schoellerbank_ag", "sparda_bank_wien", "volksbank_gruppe", "volkskreditbank_ag", "vr_bank_braunau" ], "maxLength": 5000, "type": "string" } }, "title": "param", "type": "object" }, "fpx": { "properties": { "bank": { "enum": [ "affin_bank", "agrobank", "alliance_bank", "ambank", "bank_islam", "bank_muamalat", "bank_of_china", "bank_rakyat", "bsn", "cimb", "deutsche_bank", "hong_leong_bank", "hsbc", "kfh", "maybank2e", "maybank2u", "ocbc", "pb_enterprise", "public_bank", "rhb", "standard_chartered", "uob" ], "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true } }, "required": [ "bank" ], "title": "param", "type": "object" }, "giropay": { "properties": {}, "title": "param", "type": "object" }, "grabpay": { "properties": {}, "title": "param", "type": "object" }, "ideal": { "properties": { "bank": { "enum": [ "abn_amro", "asn_bank", "bunq", "buut", "handelsbanken", "ing", "knab", "moneyou", "n26", "nn", "rabobank", "regiobank", "revolut", "sns_bank", "triodos_bank", "van_lanschot", "yoursafe" ], "maxLength": 5000, "type": "string" } }, "title": "param", "type": "object" }, "interac_present": { "properties": {}, "title": "param", "type": "object" }, "kakao_pay": { "properties": {}, "title": "param", "type": "object" }, "klarna": { "properties": { "dob": { "properties": { "day": { "type": "integer" }, "month": { "type": "integer" }, "year": { "type": "integer" } }, "required": [ "day", "month", "year" ], "title": "date_of_birth", "type": "object" } }, "title": "param", "type": "object" }, "konbini": { "properties": {}, "title": "param", "type": "object" }, "kr_card": { "properties": {}, "title": "param", "type": "object" }, "link": { "properties": {}, "title": "param", "type": "object" }, "metadata": { "additionalProperties": { "type": "string" }, "type": "object" }, "mobilepay": { "properties": {}, "title": "param", "type": "object" }, "multibanco": { "properties": {}, "title": "param", "type": "object" }, "naver_pay": { "properties": { "funding": { "enum": [ "card", "points" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "param", "type": "object" }, "nz_bank_account": { "properties": { "account_holder_name": { "maxLength": 5000, "type": "string" }, "account_number": { "maxLength": 5000, "type": "string" }, "bank_code": { "maxLength": 5000, "type": "string" }, "branch_code": { "maxLength": 5000, "type": "string" }, "reference": { "maxLength": 128, "type": "string" }, "suffix": { "maxLength": 5000, "type": "string" } }, "required": [ "account_number", "bank_code", "branch_code", "suffix" ], "title": "param", "type": "object" }, "oxxo": { "properties": {}, "title": "param", "type": "object" }, "p24": { "properties": { "bank": { "enum": [ "alior_bank", "bank_millennium", "bank_nowy_bfg_sa", "bank_pekao_sa", "banki_spbdzielcze", "blik", "bnp_paribas", "boz", "citi_handlowy", "credit_agricole", "envelobank", "etransfer_pocztowy24", "getin_bank", "ideabank", "ing", "inteligo", "mbank_mtransfer", "nest_przelew", "noble_pay", "pbac_z_ipko", "plus_bank", "santander_przelew24", "tmobile_usbugi_bankowe", "toyota_bank", "velobank", "volkswagen_bank" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "param", "type": "object" }, "pay_by_bank": { "properties": {}, "title": "param", "type": "object" }, "payco": { "properties": {}, "title": "param", "type": "object" }, "paynow": { "properties": {}, "title": "param", "type": "object" }, "paypal": { "properties": {}, "title": "param", "type": "object" }, "pix": { "properties": {}, "title": "param", "type": "object" }, "promptpay": { "properties": {}, "title": "param", "type": "object" }, "radar_options": { "properties": { "session": { "maxLength": 5000, "type": "string" } }, "title": "radar_options_with_hidden_options", "type": "object" }, "revolut_pay": { "properties": {}, "title": "param", "type": "object" }, "samsung_pay": { "properties": {}, "title": "param", "type": "object" }, "satispay": { "properties": {}, "title": "param", "type": "object" }, "sepa_debit": { "properties": { "iban": { "maxLength": 5000, "type": "string" } }, "required": [ "iban" ], "title": "param", "type": "object" }, "sofort": { "properties": { "country": { "enum": [ "AT", "BE", "DE", "ES", "IT", "NL" ], "type": "string" } }, "required": [ "country" ], "title": "param", "type": "object" }, "swish": { "properties": {}, "title": "param", "type": "object" }, "twint": { "properties": {}, "title": "param", "type": "object" }, "type": { "enum": [ "acss_debit", "affirm", "afterpay_clearpay", "alipay", "alma", "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", "billie", "blik", "boleto", "cashapp", "crypto", "customer_balance", "eps", "fpx", "giropay", "grabpay", "ideal", "kakao_pay", "klarna", "konbini", "kr_card", "link", "mobilepay", "multibanco", "naver_pay", "nz_bank_account", "oxxo", "p24", "pay_by_bank", "payco", "paynow", "paypal", "pix", "promptpay", "revolut_pay", "samsung_pay", "satispay", "sepa_debit", "sofort", "swish", "twint", "us_bank_account", "wechat_pay", "zip" ], "type": "string", "x-stripeBypassValidation": true }, "us_bank_account": { "properties": { "account_holder_type": { "enum": [ "company", "individual" ], "type": "string" }, "account_number": { "maxLength": 5000, "type": "string" }, "account_type": { "enum": [ "checking", "savings" ], "type": "string" }, "financial_connections_account": { "maxLength": 5000, "type": "string" }, "routing_number": { "maxLength": 5000, "type": "string" } }, "title": "payment_method_param", "type": "object" }, "wechat_pay": { "properties": {}, "title": "param", "type": "object" }, "zip": { "properties": {}, "title": "param", "type": "object" } }, "required": [ "type" ], "title": "payment_method_data_params", "type": "object" }, "payment_method_options": { "description": "Payment method-specific configuration for this PaymentIntent.", "properties": { "acss_debit": { "anyOf": [ { "properties": { "mandate_options": { "properties": { "custom_mandate_url": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "interval_description": { "maxLength": 500, "type": "string" }, "payment_schedule": { "enum": [ "combined", "interval", "sporadic" ], "type": "string" }, "transaction_type": { "enum": [ "business", "personal" ], "type": "string" } }, "title": "payment_intent_payment_method_options_mandate_options_param", "type": "object" }, "setup_future_usage": { "enum": [ "", "none", "off_session", "on_session" ], "type": "string" }, "target_date": { "maxLength": 5000, "type": "string" }, "verification_method": { "enum": [ "automatic", "instant", "microdeposits" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "payment_intent_payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "affirm": { "anyOf": [ { "properties": { "capture_method": { "enum": [ "", "manual" ], "type": "string" }, "preferred_locale": { "maxLength": 30, "type": "string" }, "setup_future_usage": { "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "afterpay_clearpay": { "anyOf": [ { "properties": { "capture_method": { "enum": [ "", "manual" ], "type": "string" }, "reference": { "maxLength": 128, "type": "string" }, "setup_future_usage": { "enum": [ "none" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "alipay": { "anyOf": [ { "properties": { "setup_future_usage": { "enum": [ "", "none", "off_session" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "alma": { "anyOf": [ { "properties": { "capture_method": { "enum": [ "", "manual" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "amazon_pay": { "anyOf": [ { "properties": { "capture_method": { "enum": [ "", "manual" ], "type": "string" }, "setup_future_usage": { "enum": [ "", "none", "off_session" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "au_becs_debit": { "anyOf": [ { "properties": { "setup_future_usage": { "enum": [ "", "none", "off_session", "on_session" ], "type": "string" }, "target_date": { "maxLength": 5000, "type": "string" } }, "title": "payment_intent_payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "bacs_debit": { "anyOf": [ { "properties": { "mandate_options": { "properties": { "reference_prefix": { "anyOf": [ { "maxLength": 12, "type": "string" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "payment_method_options_mandate_options_param", "type": "object" }, "setup_future_usage": { "enum": [ "", "none", "off_session", "on_session" ], "type": "string" }, "target_date": { "maxLength": 5000, "type": "string" } }, "title": "payment_intent_payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "bancontact": { "anyOf": [ { "properties": { "preferred_language": { "enum": [ "de", "en", "fr", "nl" ], "type": "string" }, "setup_future_usage": { "enum": [ "", "none", "off_session" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "billie": { "anyOf": [ { "properties": { "capture_method": { "enum": [ "", "manual" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "blik": { "anyOf": [ { "properties": { "code": { "maxLength": 5000, "type": "string" }, "setup_future_usage": { "enum": [ "", "none" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "payment_intent_payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "boleto": { "anyOf": [ { "properties": { "expires_after_days": { "type": "integer" }, "setup_future_usage": { "enum": [ "", "none", "off_session", "on_session" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "card": { "anyOf": [ { "properties": { "capture_method": { "enum": [ "", "manual" ], "type": "string", "x-stripeBypassValidation": true }, "cvc_token": { "maxLength": 5000, "type": "string" }, "installments": { "properties": { "enabled": { "type": "boolean" }, "plan": { "anyOf": [ { "properties": { "count": { "type": "integer" }, "interval": { "enum": [ "month" ], "type": "string" }, "type": { "enum": [ "bonus", "fixed_count", "revolving" ], "type": "string" } }, "required": [ "type" ], "title": "installment_plan", "type": "object" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "installments_param", "type": "object" }, "mandate_options": { "properties": { "amount": { "type": "integer" }, "amount_type": { "enum": [ "fixed", "maximum" ], "type": "string" }, "description": { "maxLength": 200, "type": "string" }, "end_date": { "format": "unix-time", "type": "integer" }, "interval": { "enum": [ "day", "month", "sporadic", "week", "year" ], "type": "string" }, "interval_count": { "type": "integer" }, "reference": { "maxLength": 80, "type": "string" }, "start_date": { "format": "unix-time", "type": "integer" }, "supported_types": { "items": { "enum": [ "india" ], "type": "string" }, "type": "array" } }, "required": [ "amount", "amount_type", "interval", "reference", "start_date" ], "title": "mandate_options_param", "type": "object" }, "network": { "enum": [ "amex", "cartes_bancaires", "diners", "discover", "eftpos_au", "girocard", "interac", "jcb", "link", "mastercard", "unionpay", "unknown", "visa" ], "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true }, "request_extended_authorization": { "enum": [ "if_available", "never" ], "type": "string" }, "request_incremental_authorization": { "enum": [ "if_available", "never" ], "type": "string" }, "request_multicapture": { "enum": [ "if_available", "never" ], "type": "string" }, "request_overcapture": { "enum": [ "if_available", "never" ], "type": "string" }, "request_three_d_secure": { "enum": [ "any", "automatic", "challenge" ], "type": "string", "x-stripeBypassValidation": true }, "require_cvc_recollection": { "type": "boolean" }, "setup_future_usage": { "enum": [ "", "none", "off_session", "on_session" ], "type": "string" }, "statement_descriptor_suffix_kana": { "anyOf": [ { "maxLength": 22, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "statement_descriptor_suffix_kanji": { "anyOf": [ { "maxLength": 17, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "three_d_secure": { "properties": { "ares_trans_status": { "enum": [ "A", "C", "I", "N", "R", "U", "Y" ], "type": "string" }, "cryptogram": { "maxLength": 5000, "type": "string" }, "electronic_commerce_indicator": { "enum": [ "01", "02", "05", "06", "07" ], "type": "string", "x-stripeBypassValidation": true }, "exemption_indicator": { "enum": [ "low_risk", "none" ], "type": "string" }, "network_options": { "properties": { "cartes_bancaires": { "properties": { "cb_avalgo": { "enum": [ "0", "1", "2", "3", "4", "A" ], "type": "string" }, "cb_exemption": { "maxLength": 4, "type": "string" }, "cb_score": { "type": "integer" } }, "required": [ "cb_avalgo" ], "title": "cartes_bancaires_network_options_param", "type": "object" } }, "title": "network_options_param", "type": "object" }, "requestor_challenge_indicator": { "maxLength": 2, "type": "string" }, "transaction_id": { "maxLength": 5000, "type": "string" }, "version": { "enum": [ "1.0.2", "2.1.0", "2.2.0" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "cryptogram", "transaction_id", "version" ], "title": "payment_method_options_param", "type": "object" } }, "title": "payment_intent_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "card_present": { "anyOf": [ { "properties": { "request_extended_authorization": { "type": "boolean" }, "request_incremental_authorization_support": { "type": "boolean" }, "routing": { "properties": { "requested_priority": { "enum": [ "domestic", "international" ], "type": "string" } }, "title": "routing_payment_method_options_param", "type": "object" } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "cashapp": { "anyOf": [ { "properties": { "capture_method": { "enum": [ "", "manual" ], "type": "string" }, "setup_future_usage": { "enum": [ "", "none", "off_session", "on_session" ], "type": "string" } }, "title": "payment_intent_payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "crypto": { "anyOf": [ { "properties": { "setup_future_usage": { "enum": [ "none" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "customer_balance": { "anyOf": [ { "properties": { "bank_transfer": { "properties": { "eu_bank_transfer": { "properties": { "country": { "maxLength": 5000, "type": "string" } }, "required": [ "country" ], "title": "eu_bank_transfer_params", "type": "object" }, "requested_address_types": { "items": { "enum": [ "aba", "iban", "sepa", "sort_code", "spei", "swift", "zengin" ], "type": "string", "x-stripeBypassValidation": true }, "type": "array" }, "type": { "enum": [ "eu_bank_transfer", "gb_bank_transfer", "jp_bank_transfer", "mx_bank_transfer", "us_bank_transfer" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "bank_transfer_param", "type": "object" }, "funding_type": { "enum": [ "bank_transfer" ], "type": "string" }, "setup_future_usage": { "enum": [ "none" ], "type": "string" } }, "title": "payment_intent_payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "eps": { "anyOf": [ { "properties": { "setup_future_usage": { "enum": [ "none" ], "type": "string" } }, "title": "payment_intent_payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "fpx": { "anyOf": [ { "properties": { "setup_future_usage": { "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "giropay": { "anyOf": [ { "properties": { "setup_future_usage": { "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "grabpay": { "anyOf": [ { "properties": { "setup_future_usage": { "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "ideal": { "anyOf": [ { "properties": { "setup_future_usage": { "enum": [ "", "none", "off_session" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "interac_present": { "anyOf": [ { "properties": {}, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "kakao_pay": { "anyOf": [ { "properties": { "capture_method": { "enum": [ "", "manual" ], "type": "string" }, "setup_future_usage": { "enum": [ "", "none", "off_session" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "klarna": { "anyOf": [ { "properties": { "capture_method": { "enum": [ "", "manual" ], "type": "string" }, "on_demand": { "properties": { "average_amount": { "type": "integer" }, "maximum_amount": { "type": "integer" }, "minimum_amount": { "type": "integer" }, "purchase_interval": { "enum": [ "day", "month", "week", "year" ], "type": "string" }, "purchase_interval_count": { "type": "integer" } }, "title": "on_demand_param", "type": "object" }, "preferred_locale": { "enum": [ "cs-CZ", "da-DK", "de-AT", "de-CH", "de-DE", "el-GR", "en-AT", "en-AU", "en-BE", "en-CA", "en-CH", "en-CZ", "en-DE", "en-DK", "en-ES", "en-FI", "en-FR", "en-GB", "en-GR", "en-IE", "en-IT", "en-NL", "en-NO", "en-NZ", "en-PL", "en-PT", "en-RO", "en-SE", "en-US", "es-ES", "es-US", "fi-FI", "fr-BE", "fr-CA", "fr-CH", "fr-FR", "it-CH", "it-IT", "nb-NO", "nl-BE", "nl-NL", "pl-PL", "pt-PT", "ro-RO", "sv-FI", "sv-SE" ], "type": "string", "x-stripeBypassValidation": true }, "setup_future_usage": { "enum": [ "none", "off_session", "on_session" ], "type": "string" }, "subscriptions": { "anyOf": [ { "items": { "properties": { "interval": { "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "type": "integer" }, "name": { "maxLength": 255, "type": "string" }, "next_billing": { "properties": { "amount": { "type": "integer" }, "date": { "maxLength": 5000, "type": "string" } }, "required": [ "amount", "date" ], "title": "subscription_next_billing_param", "type": "object" }, "reference": { "maxLength": 255, "type": "string" } }, "required": [ "interval", "reference" ], "title": "subscription_param", "type": "object" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "konbini": { "anyOf": [ { "properties": { "confirmation_number": { "anyOf": [ { "maxLength": 11, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "expires_after_days": { "anyOf": [ { "type": "integer" }, { "enum": [ "" ], "type": "string" } ] }, "expires_at": { "anyOf": [ { "format": "unix-time", "type": "integer" }, { "enum": [ "" ], "type": "string" } ] }, "product_description": { "anyOf": [ { "maxLength": 22, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "setup_future_usage": { "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "kr_card": { "anyOf": [ { "properties": { "capture_method": { "enum": [ "", "manual" ], "type": "string" }, "setup_future_usage": { "enum": [ "", "none", "off_session" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "link": { "anyOf": [ { "properties": { "capture_method": { "enum": [ "", "manual" ], "type": "string" }, "setup_future_usage": { "enum": [ "", "none", "off_session" ], "type": "string" } }, "title": "payment_intent_payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "mobilepay": { "anyOf": [ { "properties": { "capture_method": { "enum": [ "", "manual" ], "type": "string" }, "setup_future_usage": { "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "multibanco": { "anyOf": [ { "properties": { "setup_future_usage": { "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "naver_pay": { "anyOf": [ { "properties": { "capture_method": { "enum": [ "", "manual" ], "type": "string" }, "setup_future_usage": { "enum": [ "", "none", "off_session" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "nz_bank_account": { "anyOf": [ { "properties": { "setup_future_usage": { "enum": [ "", "none", "off_session", "on_session" ], "type": "string" }, "target_date": { "maxLength": 5000, "type": "string" } }, "title": "payment_intent_payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "oxxo": { "anyOf": [ { "properties": { "expires_after_days": { "type": "integer" }, "setup_future_usage": { "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "p24": { "anyOf": [ { "properties": { "setup_future_usage": { "enum": [ "none" ], "type": "string" }, "tos_shown_and_accepted": { "type": "boolean" } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "pay_by_bank": { "anyOf": [ { "properties": {}, "title": "payment_intent_payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "payco": { "anyOf": [ { "properties": { "capture_method": { "enum": [ "", "manual" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "paynow": { "anyOf": [ { "properties": { "setup_future_usage": { "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "paypal": { "anyOf": [ { "properties": { "capture_method": { "enum": [ "", "manual" ], "type": "string" }, "preferred_locale": { "enum": [ "cs-CZ", "da-DK", "de-AT", "de-DE", "de-LU", "el-GR", "en-GB", "en-US", "es-ES", "fi-FI", "fr-BE", "fr-FR", "fr-LU", "hu-HU", "it-IT", "nl-BE", "nl-NL", "pl-PL", "pt-PT", "sk-SK", "sv-SE" ], "type": "string", "x-stripeBypassValidation": true }, "reference": { "maxLength": 127, "type": "string" }, "risk_correlation_id": { "maxLength": 32, "type": "string" }, "setup_future_usage": { "enum": [ "", "none", "off_session" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "pix": { "anyOf": [ { "properties": { "amount_includes_iof": { "enum": [ "always", "never" ], "type": "string" }, "expires_after_seconds": { "type": "integer" }, "expires_at": { "format": "unix-time", "type": "integer" }, "setup_future_usage": { "enum": [ "none" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "promptpay": { "anyOf": [ { "properties": { "setup_future_usage": { "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "revolut_pay": { "anyOf": [ { "properties": { "capture_method": { "enum": [ "", "manual" ], "type": "string" }, "setup_future_usage": { "enum": [ "", "none", "off_session" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "samsung_pay": { "anyOf": [ { "properties": { "capture_method": { "enum": [ "", "manual" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "satispay": { "anyOf": [ { "properties": { "capture_method": { "enum": [ "", "manual" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "sepa_debit": { "anyOf": [ { "properties": { "mandate_options": { "properties": { "reference_prefix": { "anyOf": [ { "maxLength": 12, "type": "string" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "payment_method_options_mandate_options_param", "type": "object" }, "setup_future_usage": { "enum": [ "", "none", "off_session", "on_session" ], "type": "string" }, "target_date": { "maxLength": 5000, "type": "string" } }, "title": "payment_intent_payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "sofort": { "anyOf": [ { "properties": { "preferred_language": { "enum": [ "", "de", "en", "es", "fr", "it", "nl", "pl" ], "type": "string" }, "setup_future_usage": { "enum": [ "", "none", "off_session" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "swish": { "anyOf": [ { "properties": { "reference": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "setup_future_usage": { "enum": [ "none" ], "type": "string" } }, "title": "payment_intent_payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "twint": { "anyOf": [ { "properties": { "setup_future_usage": { "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "us_bank_account": { "anyOf": [ { "properties": { "financial_connections": { "properties": { "filters": { "properties": { "account_subcategories": { "items": { "enum": [ "checking", "savings" ], "maxLength": 5000, "type": "string" }, "type": "array" } }, "title": "linked_account_options_filters_param", "type": "object" }, "permissions": { "items": { "enum": [ "balances", "ownership", "payment_method", "transactions" ], "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true }, "type": "array" }, "prefetch": { "items": { "enum": [ "balances", "ownership", "transactions" ], "type": "string", "x-stripeBypassValidation": true }, "type": "array" }, "return_url": { "maxLength": 5000, "type": "string" } }, "title": "linked_account_options_param", "type": "object" }, "mandate_options": { "properties": { "collection_method": { "enum": [ "", "paper" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "mandate_options_param", "type": "object" }, "networks": { "properties": { "requested": { "items": { "enum": [ "ach", "us_domestic_wire" ], "type": "string" }, "type": "array" } }, "title": "networks_options_param", "type": "object" }, "preferred_settlement_speed": { "enum": [ "", "fastest", "standard" ], "type": "string" }, "setup_future_usage": { "enum": [ "", "none", "off_session", "on_session" ], "type": "string" }, "target_date": { "maxLength": 5000, "type": "string" }, "verification_method": { "enum": [ "automatic", "instant", "microdeposits" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "payment_intent_payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "wechat_pay": { "anyOf": [ { "properties": { "app_id": { "maxLength": 5000, "type": "string" }, "client": { "enum": [ "android", "ios", "web" ], "type": "string", "x-stripeBypassValidation": true }, "setup_future_usage": { "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "zip": { "anyOf": [ { "properties": { "setup_future_usage": { "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "payment_method_options_param", "type": "object" }, "payment_method_types": { "description": "The list of payment method types (for example, a card) that this PaymentIntent can use. If you don't provide this, Stripe will dynamically show relevant payment methods from your [payment method settings](https://dashboard.stripe.com/settings/payment_methods). A list of valid payment method types can be found [here](https://docs.stripe.com/api/payment_methods/object#payment_method_object-type).", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "radar_options": { "description": "Options to configure Radar. Learn more about [Radar Sessions](https://stripe.com/docs/radar/radar-session).", "properties": { "session": { "maxLength": 5000, "type": "string" } }, "title": "radar_options_with_hidden_options", "type": "object" }, "receipt_email": { "description": "Email address to send the receipt to. If you specify `receipt_email` for a payment in live mode, you send a receipt regardless of your [email settings](https://dashboard.stripe.com/account/emails).", "type": "string" }, "return_url": { "description": "The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. If you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm).", "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", "enum": [ "off_session", "on_session" ], "type": "string" }, "shipping": { "description": "Shipping information for this PaymentIntent.", "properties": { "address": { "properties": { "city": { "maxLength": 5000, "type": "string" }, "country": { "maxLength": 5000, "type": "string" }, "line1": { "maxLength": 5000, "type": "string" }, "line2": { "maxLength": 5000, "type": "string" }, "postal_code": { "maxLength": 5000, "type": "string" }, "state": { "maxLength": 5000, "type": "string" } }, "title": "optional_fields_address", "type": "object" }, "carrier": { "maxLength": 5000, "type": "string" }, "name": { "maxLength": 5000, "type": "string" }, "phone": { "maxLength": 5000, "type": "string" }, "tracking_number": { "maxLength": 5000, "type": "string" } }, "required": [ "address", "name" ], "title": "optional_fields_shipping", "type": "object" }, "statement_descriptor": { "description": "Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).\n\nSetting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead.", "maxLength": 22, "type": "string" }, "statement_descriptor_suffix": { "description": "Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement.", "maxLength": 22, "type": "string" }, "transfer_data": { "description": "The parameters that you can use to automatically create a Transfer.\nLearn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).", "properties": { "amount": { "type": "integer" }, "destination": { "type": "string" } }, "required": [ "destination" ], "title": "transfer_data_creation_params", "type": "object" }, "transfer_group": { "description": "A string that identifies the resulting payment as part of a group. Learn more about the [use case for connected accounts](https://stripe.com/docs/connect/separate-charges-and-transfers).", "type": "string" }, "use_stripe_sdk": { "description": "Set to `true` when confirming server-side and using Stripe.js, iOS, or Android client-side SDKs to handle the next actions.", "type": "boolean" } }, "required": [ "amount", "currency" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_intent" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a PaymentIntent" } }, "/v1/payment_intents/search": { "get": { "description": "

Search for PaymentIntents you’ve previously created using Stripe’s Search Query Language.\nDon’t use search in read-after-write flows where strict consistency is necessary. Under normal operating\nconditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up\nto an hour behind during outages. Search functionality is not available to merchants in India.

", "operationId": "GetPaymentIntentsSearch", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.", "in": "query", "name": "page", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for payment intents](https://stripe.com/docs/search#query-fields-for-payment-intents).", "in": "query", "name": "query", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/payment_intent" }, "type": "array" }, "has_more": { "type": "boolean" }, "next_page": { "maxLength": 5000, "nullable": true, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "search_result" ], "type": "string" }, "total_count": { "description": "The total number of objects that match the query, only accurate up to 10,000.", "type": "integer" }, "url": { "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "SearchResult", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Search PaymentIntents" } }, "/v1/payment_intents/{intent}": { "get": { "description": "

Retrieves the details of a PaymentIntent that has previously been created.

\n\n

You can retrieve a PaymentIntent client-side using a publishable key when the client_secret is in the query string.

\n\n

If you retrieve a PaymentIntent with a publishable key, it only returns a subset of properties. Refer to the payment intent object reference for more details.

", "operationId": "GetPaymentIntentsIntent", "parameters": [ { "description": "The client secret of the PaymentIntent. We require it if you use a publishable key to retrieve the source.", "in": "query", "name": "client_secret", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "intent", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_intent" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a PaymentIntent" }, "post": { "description": "

Updates properties on a PaymentIntent object without confirming.

\n\n

Depending on which properties you update, you might need to confirm the\nPaymentIntent again. For example, updating the payment_method\nalways requires you to confirm the PaymentIntent again. If you prefer to\nupdate and confirm at the same time, we recommend updating properties through\nthe confirm API instead.

", "operationId": "PostPaymentIntentsIntent", "parameters": [ { "in": "path", "name": "intent", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "application_fee_amount": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "payment_method_data": { "explode": true, "style": "deepObject" }, "payment_method_options": { "explode": true, "style": "deepObject" }, "payment_method_types": { "explode": true, "style": "deepObject" }, "receipt_email": { "explode": true, "style": "deepObject" }, "shipping": { "explode": true, "style": "deepObject" }, "transfer_data": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "amount": { "description": "Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).", "type": "integer" }, "application_fee_amount": { "anyOf": [ { "type": "integer" }, { "enum": [ "" ], "type": "string" } ], "description": "The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total amount captured. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts)." }, "capture_method": { "description": "Controls when the funds will be captured from the customer's account.", "enum": [ "automatic", "automatic_async", "manual" ], "type": "string" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "customer": { "description": "ID of the Customer this PaymentIntent belongs to, if one exists.\n\nPayment methods attached to other Customers cannot be used with this PaymentIntent.\n\nIf [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead.", "maxLength": 5000, "type": "string" }, "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users.", "maxLength": 1000, "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "payment_method": { "description": "ID of the payment method (a PaymentMethod, Card, or [compatible Source](https://stripe.com/docs/payments/payment-methods/transitioning#compatibility) object) to attach to this PaymentIntent. To unset this field to null, pass in an empty string.", "maxLength": 5000, "type": "string" }, "payment_method_configuration": { "description": "The ID of the [payment method configuration](https://stripe.com/docs/api/payment_method_configurations) to use with this PaymentIntent.", "maxLength": 100, "type": "string" }, "payment_method_data": { "description": "If provided, this hash will be used to create a PaymentMethod. The new PaymentMethod will appear\nin the [payment_method](https://stripe.com/docs/api/payment_intents/object#payment_intent_object-payment_method)\nproperty on the PaymentIntent.", "properties": { "acss_debit": { "properties": { "account_number": { "maxLength": 5000, "type": "string" }, "institution_number": { "maxLength": 5000, "type": "string" }, "transit_number": { "maxLength": 5000, "type": "string" } }, "required": [ "account_number", "institution_number", "transit_number" ], "title": "payment_method_param", "type": "object" }, "affirm": { "properties": {}, "title": "param", "type": "object" }, "afterpay_clearpay": { "properties": {}, "title": "param", "type": "object" }, "alipay": { "properties": {}, "title": "param", "type": "object" }, "allow_redisplay": { "enum": [ "always", "limited", "unspecified" ], "type": "string" }, "alma": { "properties": {}, "title": "param", "type": "object" }, "amazon_pay": { "properties": {}, "title": "param", "type": "object" }, "au_becs_debit": { "properties": { "account_number": { "maxLength": 5000, "type": "string" }, "bsb_number": { "maxLength": 5000, "type": "string" } }, "required": [ "account_number", "bsb_number" ], "title": "param", "type": "object" }, "bacs_debit": { "properties": { "account_number": { "maxLength": 5000, "type": "string" }, "sort_code": { "maxLength": 5000, "type": "string" } }, "title": "param", "type": "object" }, "bancontact": { "properties": {}, "title": "param", "type": "object" }, "billie": { "properties": {}, "title": "param", "type": "object" }, "billing_details": { "properties": { "address": { "anyOf": [ { "properties": { "city": { "maxLength": 5000, "type": "string" }, "country": { "maxLength": 5000, "type": "string" }, "line1": { "maxLength": 5000, "type": "string" }, "line2": { "maxLength": 5000, "type": "string" }, "postal_code": { "maxLength": 5000, "type": "string" }, "state": { "maxLength": 5000, "type": "string" } }, "title": "billing_details_address", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "email": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "name": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "phone": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "tax_id": { "maxLength": 5000, "type": "string" } }, "title": "billing_details_inner_params", "type": "object" }, "blik": { "properties": {}, "title": "param", "type": "object" }, "boleto": { "properties": { "tax_id": { "maxLength": 5000, "type": "string" } }, "required": [ "tax_id" ], "title": "param", "type": "object" }, "cashapp": { "properties": {}, "title": "param", "type": "object" }, "crypto": { "properties": {}, "title": "param", "type": "object" }, "customer_balance": { "properties": {}, "title": "param", "type": "object" }, "eps": { "properties": { "bank": { "enum": [ "arzte_und_apotheker_bank", "austrian_anadi_bank_ag", "bank_austria", "bankhaus_carl_spangler", "bankhaus_schelhammer_und_schattera_ag", "bawag_psk_ag", "bks_bank_ag", "brull_kallmus_bank_ag", "btv_vier_lander_bank", "capital_bank_grawe_gruppe_ag", "deutsche_bank_ag", "dolomitenbank", "easybank_ag", "erste_bank_und_sparkassen", "hypo_alpeadriabank_international_ag", "hypo_bank_burgenland_aktiengesellschaft", "hypo_noe_lb_fur_niederosterreich_u_wien", "hypo_oberosterreich_salzburg_steiermark", "hypo_tirol_bank_ag", "hypo_vorarlberg_bank_ag", "marchfelder_bank", "oberbank_ag", "raiffeisen_bankengruppe_osterreich", "schoellerbank_ag", "sparda_bank_wien", "volksbank_gruppe", "volkskreditbank_ag", "vr_bank_braunau" ], "maxLength": 5000, "type": "string" } }, "title": "param", "type": "object" }, "fpx": { "properties": { "bank": { "enum": [ "affin_bank", "agrobank", "alliance_bank", "ambank", "bank_islam", "bank_muamalat", "bank_of_china", "bank_rakyat", "bsn", "cimb", "deutsche_bank", "hong_leong_bank", "hsbc", "kfh", "maybank2e", "maybank2u", "ocbc", "pb_enterprise", "public_bank", "rhb", "standard_chartered", "uob" ], "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true } }, "required": [ "bank" ], "title": "param", "type": "object" }, "giropay": { "properties": {}, "title": "param", "type": "object" }, "grabpay": { "properties": {}, "title": "param", "type": "object" }, "ideal": { "properties": { "bank": { "enum": [ "abn_amro", "asn_bank", "bunq", "buut", "handelsbanken", "ing", "knab", "moneyou", "n26", "nn", "rabobank", "regiobank", "revolut", "sns_bank", "triodos_bank", "van_lanschot", "yoursafe" ], "maxLength": 5000, "type": "string" } }, "title": "param", "type": "object" }, "interac_present": { "properties": {}, "title": "param", "type": "object" }, "kakao_pay": { "properties": {}, "title": "param", "type": "object" }, "klarna": { "properties": { "dob": { "properties": { "day": { "type": "integer" }, "month": { "type": "integer" }, "year": { "type": "integer" } }, "required": [ "day", "month", "year" ], "title": "date_of_birth", "type": "object" } }, "title": "param", "type": "object" }, "konbini": { "properties": {}, "title": "param", "type": "object" }, "kr_card": { "properties": {}, "title": "param", "type": "object" }, "link": { "properties": {}, "title": "param", "type": "object" }, "metadata": { "additionalProperties": { "type": "string" }, "type": "object" }, "mobilepay": { "properties": {}, "title": "param", "type": "object" }, "multibanco": { "properties": {}, "title": "param", "type": "object" }, "naver_pay": { "properties": { "funding": { "enum": [ "card", "points" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "param", "type": "object" }, "nz_bank_account": { "properties": { "account_holder_name": { "maxLength": 5000, "type": "string" }, "account_number": { "maxLength": 5000, "type": "string" }, "bank_code": { "maxLength": 5000, "type": "string" }, "branch_code": { "maxLength": 5000, "type": "string" }, "reference": { "maxLength": 128, "type": "string" }, "suffix": { "maxLength": 5000, "type": "string" } }, "required": [ "account_number", "bank_code", "branch_code", "suffix" ], "title": "param", "type": "object" }, "oxxo": { "properties": {}, "title": "param", "type": "object" }, "p24": { "properties": { "bank": { "enum": [ "alior_bank", "bank_millennium", "bank_nowy_bfg_sa", "bank_pekao_sa", "banki_spbdzielcze", "blik", "bnp_paribas", "boz", "citi_handlowy", "credit_agricole", "envelobank", "etransfer_pocztowy24", "getin_bank", "ideabank", "ing", "inteligo", "mbank_mtransfer", "nest_przelew", "noble_pay", "pbac_z_ipko", "plus_bank", "santander_przelew24", "tmobile_usbugi_bankowe", "toyota_bank", "velobank", "volkswagen_bank" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "param", "type": "object" }, "pay_by_bank": { "properties": {}, "title": "param", "type": "object" }, "payco": { "properties": {}, "title": "param", "type": "object" }, "paynow": { "properties": {}, "title": "param", "type": "object" }, "paypal": { "properties": {}, "title": "param", "type": "object" }, "pix": { "properties": {}, "title": "param", "type": "object" }, "promptpay": { "properties": {}, "title": "param", "type": "object" }, "radar_options": { "properties": { "session": { "maxLength": 5000, "type": "string" } }, "title": "radar_options_with_hidden_options", "type": "object" }, "revolut_pay": { "properties": {}, "title": "param", "type": "object" }, "samsung_pay": { "properties": {}, "title": "param", "type": "object" }, "satispay": { "properties": {}, "title": "param", "type": "object" }, "sepa_debit": { "properties": { "iban": { "maxLength": 5000, "type": "string" } }, "required": [ "iban" ], "title": "param", "type": "object" }, "sofort": { "properties": { "country": { "enum": [ "AT", "BE", "DE", "ES", "IT", "NL" ], "type": "string" } }, "required": [ "country" ], "title": "param", "type": "object" }, "swish": { "properties": {}, "title": "param", "type": "object" }, "twint": { "properties": {}, "title": "param", "type": "object" }, "type": { "enum": [ "acss_debit", "affirm", "afterpay_clearpay", "alipay", "alma", "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", "billie", "blik", "boleto", "cashapp", "crypto", "customer_balance", "eps", "fpx", "giropay", "grabpay", "ideal", "kakao_pay", "klarna", "konbini", "kr_card", "link", "mobilepay", "multibanco", "naver_pay", "nz_bank_account", "oxxo", "p24", "pay_by_bank", "payco", "paynow", "paypal", "pix", "promptpay", "revolut_pay", "samsung_pay", "satispay", "sepa_debit", "sofort", "swish", "twint", "us_bank_account", "wechat_pay", "zip" ], "type": "string", "x-stripeBypassValidation": true }, "us_bank_account": { "properties": { "account_holder_type": { "enum": [ "company", "individual" ], "type": "string" }, "account_number": { "maxLength": 5000, "type": "string" }, "account_type": { "enum": [ "checking", "savings" ], "type": "string" }, "financial_connections_account": { "maxLength": 5000, "type": "string" }, "routing_number": { "maxLength": 5000, "type": "string" } }, "title": "payment_method_param", "type": "object" }, "wechat_pay": { "properties": {}, "title": "param", "type": "object" }, "zip": { "properties": {}, "title": "param", "type": "object" } }, "required": [ "type" ], "title": "payment_method_data_params", "type": "object" }, "payment_method_options": { "description": "Payment-method-specific configuration for this PaymentIntent.", "properties": { "acss_debit": { "anyOf": [ { "properties": { "mandate_options": { "properties": { "custom_mandate_url": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "interval_description": { "maxLength": 500, "type": "string" }, "payment_schedule": { "enum": [ "combined", "interval", "sporadic" ], "type": "string" }, "transaction_type": { "enum": [ "business", "personal" ], "type": "string" } }, "title": "payment_intent_payment_method_options_mandate_options_param", "type": "object" }, "setup_future_usage": { "enum": [ "", "none", "off_session", "on_session" ], "type": "string" }, "target_date": { "maxLength": 5000, "type": "string" }, "verification_method": { "enum": [ "automatic", "instant", "microdeposits" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "payment_intent_payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "affirm": { "anyOf": [ { "properties": { "capture_method": { "enum": [ "", "manual" ], "type": "string" }, "preferred_locale": { "maxLength": 30, "type": "string" }, "setup_future_usage": { "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "afterpay_clearpay": { "anyOf": [ { "properties": { "capture_method": { "enum": [ "", "manual" ], "type": "string" }, "reference": { "maxLength": 128, "type": "string" }, "setup_future_usage": { "enum": [ "none" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "alipay": { "anyOf": [ { "properties": { "setup_future_usage": { "enum": [ "", "none", "off_session" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "alma": { "anyOf": [ { "properties": { "capture_method": { "enum": [ "", "manual" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "amazon_pay": { "anyOf": [ { "properties": { "capture_method": { "enum": [ "", "manual" ], "type": "string" }, "setup_future_usage": { "enum": [ "", "none", "off_session" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "au_becs_debit": { "anyOf": [ { "properties": { "setup_future_usage": { "enum": [ "", "none", "off_session", "on_session" ], "type": "string" }, "target_date": { "maxLength": 5000, "type": "string" } }, "title": "payment_intent_payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "bacs_debit": { "anyOf": [ { "properties": { "mandate_options": { "properties": { "reference_prefix": { "anyOf": [ { "maxLength": 12, "type": "string" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "payment_method_options_mandate_options_param", "type": "object" }, "setup_future_usage": { "enum": [ "", "none", "off_session", "on_session" ], "type": "string" }, "target_date": { "maxLength": 5000, "type": "string" } }, "title": "payment_intent_payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "bancontact": { "anyOf": [ { "properties": { "preferred_language": { "enum": [ "de", "en", "fr", "nl" ], "type": "string" }, "setup_future_usage": { "enum": [ "", "none", "off_session" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "billie": { "anyOf": [ { "properties": { "capture_method": { "enum": [ "", "manual" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "blik": { "anyOf": [ { "properties": { "code": { "maxLength": 5000, "type": "string" }, "setup_future_usage": { "enum": [ "", "none" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "payment_intent_payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "boleto": { "anyOf": [ { "properties": { "expires_after_days": { "type": "integer" }, "setup_future_usage": { "enum": [ "", "none", "off_session", "on_session" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "card": { "anyOf": [ { "properties": { "capture_method": { "enum": [ "", "manual" ], "type": "string", "x-stripeBypassValidation": true }, "cvc_token": { "maxLength": 5000, "type": "string" }, "installments": { "properties": { "enabled": { "type": "boolean" }, "plan": { "anyOf": [ { "properties": { "count": { "type": "integer" }, "interval": { "enum": [ "month" ], "type": "string" }, "type": { "enum": [ "bonus", "fixed_count", "revolving" ], "type": "string" } }, "required": [ "type" ], "title": "installment_plan", "type": "object" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "installments_param", "type": "object" }, "mandate_options": { "properties": { "amount": { "type": "integer" }, "amount_type": { "enum": [ "fixed", "maximum" ], "type": "string" }, "description": { "maxLength": 200, "type": "string" }, "end_date": { "format": "unix-time", "type": "integer" }, "interval": { "enum": [ "day", "month", "sporadic", "week", "year" ], "type": "string" }, "interval_count": { "type": "integer" }, "reference": { "maxLength": 80, "type": "string" }, "start_date": { "format": "unix-time", "type": "integer" }, "supported_types": { "items": { "enum": [ "india" ], "type": "string" }, "type": "array" } }, "required": [ "amount", "amount_type", "interval", "reference", "start_date" ], "title": "mandate_options_param", "type": "object" }, "network": { "enum": [ "amex", "cartes_bancaires", "diners", "discover", "eftpos_au", "girocard", "interac", "jcb", "link", "mastercard", "unionpay", "unknown", "visa" ], "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true }, "request_extended_authorization": { "enum": [ "if_available", "never" ], "type": "string" }, "request_incremental_authorization": { "enum": [ "if_available", "never" ], "type": "string" }, "request_multicapture": { "enum": [ "if_available", "never" ], "type": "string" }, "request_overcapture": { "enum": [ "if_available", "never" ], "type": "string" }, "request_three_d_secure": { "enum": [ "any", "automatic", "challenge" ], "type": "string", "x-stripeBypassValidation": true }, "require_cvc_recollection": { "type": "boolean" }, "setup_future_usage": { "enum": [ "", "none", "off_session", "on_session" ], "type": "string" }, "statement_descriptor_suffix_kana": { "anyOf": [ { "maxLength": 22, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "statement_descriptor_suffix_kanji": { "anyOf": [ { "maxLength": 17, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "three_d_secure": { "properties": { "ares_trans_status": { "enum": [ "A", "C", "I", "N", "R", "U", "Y" ], "type": "string" }, "cryptogram": { "maxLength": 5000, "type": "string" }, "electronic_commerce_indicator": { "enum": [ "01", "02", "05", "06", "07" ], "type": "string", "x-stripeBypassValidation": true }, "exemption_indicator": { "enum": [ "low_risk", "none" ], "type": "string" }, "network_options": { "properties": { "cartes_bancaires": { "properties": { "cb_avalgo": { "enum": [ "0", "1", "2", "3", "4", "A" ], "type": "string" }, "cb_exemption": { "maxLength": 4, "type": "string" }, "cb_score": { "type": "integer" } }, "required": [ "cb_avalgo" ], "title": "cartes_bancaires_network_options_param", "type": "object" } }, "title": "network_options_param", "type": "object" }, "requestor_challenge_indicator": { "maxLength": 2, "type": "string" }, "transaction_id": { "maxLength": 5000, "type": "string" }, "version": { "enum": [ "1.0.2", "2.1.0", "2.2.0" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "cryptogram", "transaction_id", "version" ], "title": "payment_method_options_param", "type": "object" } }, "title": "payment_intent_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "card_present": { "anyOf": [ { "properties": { "request_extended_authorization": { "type": "boolean" }, "request_incremental_authorization_support": { "type": "boolean" }, "routing": { "properties": { "requested_priority": { "enum": [ "domestic", "international" ], "type": "string" } }, "title": "routing_payment_method_options_param", "type": "object" } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "cashapp": { "anyOf": [ { "properties": { "capture_method": { "enum": [ "", "manual" ], "type": "string" }, "setup_future_usage": { "enum": [ "", "none", "off_session", "on_session" ], "type": "string" } }, "title": "payment_intent_payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "crypto": { "anyOf": [ { "properties": { "setup_future_usage": { "enum": [ "none" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "customer_balance": { "anyOf": [ { "properties": { "bank_transfer": { "properties": { "eu_bank_transfer": { "properties": { "country": { "maxLength": 5000, "type": "string" } }, "required": [ "country" ], "title": "eu_bank_transfer_params", "type": "object" }, "requested_address_types": { "items": { "enum": [ "aba", "iban", "sepa", "sort_code", "spei", "swift", "zengin" ], "type": "string", "x-stripeBypassValidation": true }, "type": "array" }, "type": { "enum": [ "eu_bank_transfer", "gb_bank_transfer", "jp_bank_transfer", "mx_bank_transfer", "us_bank_transfer" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "bank_transfer_param", "type": "object" }, "funding_type": { "enum": [ "bank_transfer" ], "type": "string" }, "setup_future_usage": { "enum": [ "none" ], "type": "string" } }, "title": "payment_intent_payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "eps": { "anyOf": [ { "properties": { "setup_future_usage": { "enum": [ "none" ], "type": "string" } }, "title": "payment_intent_payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "fpx": { "anyOf": [ { "properties": { "setup_future_usage": { "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "giropay": { "anyOf": [ { "properties": { "setup_future_usage": { "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "grabpay": { "anyOf": [ { "properties": { "setup_future_usage": { "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "ideal": { "anyOf": [ { "properties": { "setup_future_usage": { "enum": [ "", "none", "off_session" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "interac_present": { "anyOf": [ { "properties": {}, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "kakao_pay": { "anyOf": [ { "properties": { "capture_method": { "enum": [ "", "manual" ], "type": "string" }, "setup_future_usage": { "enum": [ "", "none", "off_session" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "klarna": { "anyOf": [ { "properties": { "capture_method": { "enum": [ "", "manual" ], "type": "string" }, "on_demand": { "properties": { "average_amount": { "type": "integer" }, "maximum_amount": { "type": "integer" }, "minimum_amount": { "type": "integer" }, "purchase_interval": { "enum": [ "day", "month", "week", "year" ], "type": "string" }, "purchase_interval_count": { "type": "integer" } }, "title": "on_demand_param", "type": "object" }, "preferred_locale": { "enum": [ "cs-CZ", "da-DK", "de-AT", "de-CH", "de-DE", "el-GR", "en-AT", "en-AU", "en-BE", "en-CA", "en-CH", "en-CZ", "en-DE", "en-DK", "en-ES", "en-FI", "en-FR", "en-GB", "en-GR", "en-IE", "en-IT", "en-NL", "en-NO", "en-NZ", "en-PL", "en-PT", "en-RO", "en-SE", "en-US", "es-ES", "es-US", "fi-FI", "fr-BE", "fr-CA", "fr-CH", "fr-FR", "it-CH", "it-IT", "nb-NO", "nl-BE", "nl-NL", "pl-PL", "pt-PT", "ro-RO", "sv-FI", "sv-SE" ], "type": "string", "x-stripeBypassValidation": true }, "setup_future_usage": { "enum": [ "none", "off_session", "on_session" ], "type": "string" }, "subscriptions": { "anyOf": [ { "items": { "properties": { "interval": { "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "type": "integer" }, "name": { "maxLength": 255, "type": "string" }, "next_billing": { "properties": { "amount": { "type": "integer" }, "date": { "maxLength": 5000, "type": "string" } }, "required": [ "amount", "date" ], "title": "subscription_next_billing_param", "type": "object" }, "reference": { "maxLength": 255, "type": "string" } }, "required": [ "interval", "reference" ], "title": "subscription_param", "type": "object" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "konbini": { "anyOf": [ { "properties": { "confirmation_number": { "anyOf": [ { "maxLength": 11, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "expires_after_days": { "anyOf": [ { "type": "integer" }, { "enum": [ "" ], "type": "string" } ] }, "expires_at": { "anyOf": [ { "format": "unix-time", "type": "integer" }, { "enum": [ "" ], "type": "string" } ] }, "product_description": { "anyOf": [ { "maxLength": 22, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "setup_future_usage": { "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "kr_card": { "anyOf": [ { "properties": { "capture_method": { "enum": [ "", "manual" ], "type": "string" }, "setup_future_usage": { "enum": [ "", "none", "off_session" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "link": { "anyOf": [ { "properties": { "capture_method": { "enum": [ "", "manual" ], "type": "string" }, "setup_future_usage": { "enum": [ "", "none", "off_session" ], "type": "string" } }, "title": "payment_intent_payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "mobilepay": { "anyOf": [ { "properties": { "capture_method": { "enum": [ "", "manual" ], "type": "string" }, "setup_future_usage": { "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "multibanco": { "anyOf": [ { "properties": { "setup_future_usage": { "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "naver_pay": { "anyOf": [ { "properties": { "capture_method": { "enum": [ "", "manual" ], "type": "string" }, "setup_future_usage": { "enum": [ "", "none", "off_session" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "nz_bank_account": { "anyOf": [ { "properties": { "setup_future_usage": { "enum": [ "", "none", "off_session", "on_session" ], "type": "string" }, "target_date": { "maxLength": 5000, "type": "string" } }, "title": "payment_intent_payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "oxxo": { "anyOf": [ { "properties": { "expires_after_days": { "type": "integer" }, "setup_future_usage": { "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "p24": { "anyOf": [ { "properties": { "setup_future_usage": { "enum": [ "none" ], "type": "string" }, "tos_shown_and_accepted": { "type": "boolean" } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "pay_by_bank": { "anyOf": [ { "properties": {}, "title": "payment_intent_payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "payco": { "anyOf": [ { "properties": { "capture_method": { "enum": [ "", "manual" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "paynow": { "anyOf": [ { "properties": { "setup_future_usage": { "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "paypal": { "anyOf": [ { "properties": { "capture_method": { "enum": [ "", "manual" ], "type": "string" }, "preferred_locale": { "enum": [ "cs-CZ", "da-DK", "de-AT", "de-DE", "de-LU", "el-GR", "en-GB", "en-US", "es-ES", "fi-FI", "fr-BE", "fr-FR", "fr-LU", "hu-HU", "it-IT", "nl-BE", "nl-NL", "pl-PL", "pt-PT", "sk-SK", "sv-SE" ], "type": "string", "x-stripeBypassValidation": true }, "reference": { "maxLength": 127, "type": "string" }, "risk_correlation_id": { "maxLength": 32, "type": "string" }, "setup_future_usage": { "enum": [ "", "none", "off_session" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "pix": { "anyOf": [ { "properties": { "amount_includes_iof": { "enum": [ "always", "never" ], "type": "string" }, "expires_after_seconds": { "type": "integer" }, "expires_at": { "format": "unix-time", "type": "integer" }, "setup_future_usage": { "enum": [ "none" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "promptpay": { "anyOf": [ { "properties": { "setup_future_usage": { "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "revolut_pay": { "anyOf": [ { "properties": { "capture_method": { "enum": [ "", "manual" ], "type": "string" }, "setup_future_usage": { "enum": [ "", "none", "off_session" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "samsung_pay": { "anyOf": [ { "properties": { "capture_method": { "enum": [ "", "manual" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "satispay": { "anyOf": [ { "properties": { "capture_method": { "enum": [ "", "manual" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "sepa_debit": { "anyOf": [ { "properties": { "mandate_options": { "properties": { "reference_prefix": { "anyOf": [ { "maxLength": 12, "type": "string" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "payment_method_options_mandate_options_param", "type": "object" }, "setup_future_usage": { "enum": [ "", "none", "off_session", "on_session" ], "type": "string" }, "target_date": { "maxLength": 5000, "type": "string" } }, "title": "payment_intent_payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "sofort": { "anyOf": [ { "properties": { "preferred_language": { "enum": [ "", "de", "en", "es", "fr", "it", "nl", "pl" ], "type": "string" }, "setup_future_usage": { "enum": [ "", "none", "off_session" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "swish": { "anyOf": [ { "properties": { "reference": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "setup_future_usage": { "enum": [ "none" ], "type": "string" } }, "title": "payment_intent_payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "twint": { "anyOf": [ { "properties": { "setup_future_usage": { "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "us_bank_account": { "anyOf": [ { "properties": { "financial_connections": { "properties": { "filters": { "properties": { "account_subcategories": { "items": { "enum": [ "checking", "savings" ], "maxLength": 5000, "type": "string" }, "type": "array" } }, "title": "linked_account_options_filters_param", "type": "object" }, "permissions": { "items": { "enum": [ "balances", "ownership", "payment_method", "transactions" ], "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true }, "type": "array" }, "prefetch": { "items": { "enum": [ "balances", "ownership", "transactions" ], "type": "string", "x-stripeBypassValidation": true }, "type": "array" }, "return_url": { "maxLength": 5000, "type": "string" } }, "title": "linked_account_options_param", "type": "object" }, "mandate_options": { "properties": { "collection_method": { "enum": [ "", "paper" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "mandate_options_param", "type": "object" }, "networks": { "properties": { "requested": { "items": { "enum": [ "ach", "us_domestic_wire" ], "type": "string" }, "type": "array" } }, "title": "networks_options_param", "type": "object" }, "preferred_settlement_speed": { "enum": [ "", "fastest", "standard" ], "type": "string" }, "setup_future_usage": { "enum": [ "", "none", "off_session", "on_session" ], "type": "string" }, "target_date": { "maxLength": 5000, "type": "string" }, "verification_method": { "enum": [ "automatic", "instant", "microdeposits" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "payment_intent_payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "wechat_pay": { "anyOf": [ { "properties": { "app_id": { "maxLength": 5000, "type": "string" }, "client": { "enum": [ "android", "ios", "web" ], "type": "string", "x-stripeBypassValidation": true }, "setup_future_usage": { "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "zip": { "anyOf": [ { "properties": { "setup_future_usage": { "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "payment_method_options_param", "type": "object" }, "payment_method_types": { "description": "The list of payment method types (for example, card) that this PaymentIntent can use. Use `automatic_payment_methods` to manage payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods). A list of valid payment method types can be found [here](https://docs.stripe.com/api/payment_methods/object#payment_method_object-type).", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "receipt_email": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Email address that the receipt for the resulting payment will be sent to. If `receipt_email` is specified for a payment in live mode, a receipt will be sent regardless of your [email settings](https://dashboard.stripe.com/account/emails)." }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "", "off_session", "on_session" ], "type": "string" }, "shipping": { "anyOf": [ { "properties": { "address": { "properties": { "city": { "maxLength": 5000, "type": "string" }, "country": { "maxLength": 5000, "type": "string" }, "line1": { "maxLength": 5000, "type": "string" }, "line2": { "maxLength": 5000, "type": "string" }, "postal_code": { "maxLength": 5000, "type": "string" }, "state": { "maxLength": 5000, "type": "string" } }, "title": "optional_fields_address", "type": "object" }, "carrier": { "maxLength": 5000, "type": "string" }, "name": { "maxLength": 5000, "type": "string" }, "phone": { "maxLength": 5000, "type": "string" }, "tracking_number": { "maxLength": 5000, "type": "string" } }, "required": [ "address", "name" ], "title": "optional_fields_shipping", "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Shipping information for this PaymentIntent." }, "statement_descriptor": { "description": "Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).\n\nSetting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead.", "maxLength": 22, "type": "string" }, "statement_descriptor_suffix": { "description": "Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement.", "maxLength": 22, "type": "string" }, "transfer_data": { "description": "Use this parameter to automatically create a Transfer when the payment succeeds. Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).", "properties": { "amount": { "type": "integer" } }, "title": "transfer_data_update_params", "type": "object" }, "transfer_group": { "description": "A string that identifies the resulting payment as part of a group. You can only provide `transfer_group` if it hasn't been set. Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_intent" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a PaymentIntent" } }, "/v1/payment_intents/{intent}/apply_customer_balance": { "post": { "description": "

Manually reconcile the remaining amount for a customer_balance PaymentIntent.

", "operationId": "PostPaymentIntentsIntentApplyCustomerBalance", "parameters": [ { "in": "path", "name": "intent", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "amount": { "description": "Amount that you intend to apply to this PaymentIntent from the customer’s cash balance. If the PaymentIntent was created by an Invoice, the full amount of the PaymentIntent is applied regardless of this parameter.\n\nA positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (for example, 100 cents to charge 1 USD or 100 to charge 100 JPY, a zero-decimal currency). The maximum amount is the amount of the PaymentIntent.\n\nWhen you omit the amount, it defaults to the remaining amount requested on the PaymentIntent.", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_intent" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Reconcile a customer_balance PaymentIntent" } }, "/v1/payment_intents/{intent}/cancel": { "post": { "description": "

You can cancel a PaymentIntent object when it’s in one of these statuses: requires_payment_method, requires_capture, requires_confirmation, requires_action or, in rare cases, processing.

\n\n

After it’s canceled, no additional charges are made by the PaymentIntent and any operations on the PaymentIntent fail with an error. For PaymentIntents with a status of requires_capture, the remaining amount_capturable is automatically refunded.

\n\n

You can’t cancel the PaymentIntent for a Checkout Session. Expire the Checkout Session instead.

", "operationId": "PostPaymentIntentsIntentCancel", "parameters": [ { "in": "path", "name": "intent", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "cancellation_reason": { "description": "Reason for canceling this PaymentIntent. Possible values are: `duplicate`, `fraudulent`, `requested_by_customer`, or `abandoned`", "enum": [ "abandoned", "duplicate", "fraudulent", "requested_by_customer" ], "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_intent" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Cancel a PaymentIntent" } }, "/v1/payment_intents/{intent}/capture": { "post": { "description": "

Capture the funds of an existing uncaptured PaymentIntent when its status is requires_capture.

\n\n

Uncaptured PaymentIntents are cancelled a set number of days (7 by default) after their creation.

\n\n

Learn more about separate authorization and capture.

", "operationId": "PostPaymentIntentsIntentCapture", "parameters": [ { "in": "path", "name": "intent", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "transfer_data": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "amount_to_capture": { "description": "The amount to capture from the PaymentIntent, which must be less than or equal to the original amount. Defaults to the full `amount_capturable` if it's not provided.", "type": "integer" }, "application_fee_amount": { "description": "The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total amount captured. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).", "type": "integer" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "final_capture": { "description": "Defaults to `true`. When capturing a PaymentIntent, setting `final_capture` to `false` notifies Stripe to not release the remaining uncaptured funds to make sure that they're captured in future requests. You can only use this setting when [multicapture](https://stripe.com/docs/payments/multicapture) is available for PaymentIntents.", "type": "boolean" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "statement_descriptor": { "description": "Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).\n\nSetting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead.", "maxLength": 22, "type": "string" }, "statement_descriptor_suffix": { "description": "Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement.", "maxLength": 22, "type": "string" }, "transfer_data": { "description": "The parameters that you can use to automatically create a transfer after the payment\nis captured. Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).", "properties": { "amount": { "type": "integer" } }, "title": "transfer_data_capture_params", "type": "object" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_intent" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Capture a PaymentIntent" } }, "/v1/payment_intents/{intent}/confirm": { "post": { "description": "

Confirm that your customer intends to pay with current or provided\npayment method. Upon confirmation, the PaymentIntent will attempt to initiate\na payment.

\n\n

If the selected payment method requires additional authentication steps, the\nPaymentIntent will transition to the requires_action status and\nsuggest additional actions via next_action. If payment fails,\nthe PaymentIntent transitions to the requires_payment_method status or the\ncanceled status if the confirmation limit is reached. If\npayment succeeds, the PaymentIntent will transition to the succeeded\nstatus (or requires_capture, if capture_method is set to manual).

\n\n

If the confirmation_method is automatic, payment may be attempted\nusing our client SDKs\nand the PaymentIntent’s client_secret.\nAfter next_actions are handled by the client, no additional\nconfirmation is required to complete the payment.

\n\n

If the confirmation_method is manual, all payment attempts must be\ninitiated using a secret key.

\n\n

If any actions are required for the payment, the PaymentIntent will\nreturn to the requires_confirmation state\nafter those actions are completed. Your server needs to then\nexplicitly re-confirm the PaymentIntent to initiate the next payment\nattempt.

\n\n

There is a variable upper limit on how many times a PaymentIntent can be confirmed.\nAfter this limit is reached, any further calls to this endpoint will\ntransition the PaymentIntent to the canceled state.

", "operationId": "PostPaymentIntentsIntentConfirm", "parameters": [ { "in": "path", "name": "intent", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "mandate_data": { "explode": true, "style": "deepObject" }, "off_session": { "explode": true, "style": "deepObject" }, "payment_method_data": { "explode": true, "style": "deepObject" }, "payment_method_options": { "explode": true, "style": "deepObject" }, "payment_method_types": { "explode": true, "style": "deepObject" }, "radar_options": { "explode": true, "style": "deepObject" }, "receipt_email": { "explode": true, "style": "deepObject" }, "shipping": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "capture_method": { "description": "Controls when the funds will be captured from the customer's account.", "enum": [ "automatic", "automatic_async", "manual" ], "type": "string" }, "client_secret": { "description": "The client secret of the PaymentIntent.", "maxLength": 5000, "type": "string" }, "confirmation_token": { "description": "ID of the ConfirmationToken used to confirm this PaymentIntent.\n\nIf the provided ConfirmationToken contains properties that are also being provided in this request, such as `payment_method`, then the values in this request will take precedence.", "maxLength": 5000, "type": "string" }, "error_on_requires_action": { "description": "Set to `true` to fail the payment attempt if the PaymentIntent transitions into `requires_action`. This parameter is intended for simpler integrations that do not handle customer actions, like [saving cards without authentication](https://stripe.com/docs/payments/save-card-without-authentication).", "type": "boolean" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "mandate": { "description": "ID of the mandate that's used for this payment.", "maxLength": 5000, "type": "string" }, "mandate_data": { "anyOf": [ { "properties": { "customer_acceptance": { "properties": { "accepted_at": { "format": "unix-time", "type": "integer" }, "offline": { "properties": {}, "title": "offline_param", "type": "object" }, "online": { "properties": { "ip_address": { "type": "string" }, "user_agent": { "maxLength": 5000, "type": "string" } }, "required": [ "ip_address", "user_agent" ], "title": "online_param", "type": "object" }, "type": { "enum": [ "offline", "online" ], "maxLength": 5000, "type": "string" } }, "required": [ "type" ], "title": "customer_acceptance_param", "type": "object" } }, "required": [ "customer_acceptance" ], "title": "secret_key_param", "type": "object" }, { "enum": [ "" ], "type": "string" }, { "description": "This hash contains details about the Mandate to create", "properties": { "customer_acceptance": { "properties": { "online": { "properties": { "ip_address": { "type": "string" }, "user_agent": { "maxLength": 5000, "type": "string" } }, "title": "online_param", "type": "object" }, "type": { "enum": [ "online" ], "maxLength": 5000, "type": "string" } }, "required": [ "online", "type" ], "title": "customer_acceptance_param", "type": "object" } }, "required": [ "customer_acceptance" ], "title": "client_key_param", "type": "object" } ] }, "off_session": { "anyOf": [ { "type": "boolean" }, { "enum": [ "one_off", "recurring" ], "maxLength": 5000, "type": "string" } ], "description": "Set to `true` to indicate that the customer isn't in your checkout flow during this payment attempt and can't authenticate. Use this parameter in scenarios where you collect card details and [charge them later](https://stripe.com/docs/payments/cards/charging-saved-cards)." }, "payment_method": { "description": "ID of the payment method (a PaymentMethod, Card, or [compatible Source](https://stripe.com/docs/payments/payment-methods/transitioning#compatibility) object) to attach to this PaymentIntent.\nIf the payment method is attached to a Customer, it must match the [customer](https://stripe.com/docs/api#create_payment_intent-customer) that is set on this PaymentIntent.", "maxLength": 5000, "type": "string" }, "payment_method_data": { "description": "If provided, this hash will be used to create a PaymentMethod. The new PaymentMethod will appear\nin the [payment_method](https://stripe.com/docs/api/payment_intents/object#payment_intent_object-payment_method)\nproperty on the PaymentIntent.", "properties": { "acss_debit": { "properties": { "account_number": { "maxLength": 5000, "type": "string" }, "institution_number": { "maxLength": 5000, "type": "string" }, "transit_number": { "maxLength": 5000, "type": "string" } }, "required": [ "account_number", "institution_number", "transit_number" ], "title": "payment_method_param", "type": "object" }, "affirm": { "properties": {}, "title": "param", "type": "object" }, "afterpay_clearpay": { "properties": {}, "title": "param", "type": "object" }, "alipay": { "properties": {}, "title": "param", "type": "object" }, "allow_redisplay": { "enum": [ "always", "limited", "unspecified" ], "type": "string" }, "alma": { "properties": {}, "title": "param", "type": "object" }, "amazon_pay": { "properties": {}, "title": "param", "type": "object" }, "au_becs_debit": { "properties": { "account_number": { "maxLength": 5000, "type": "string" }, "bsb_number": { "maxLength": 5000, "type": "string" } }, "required": [ "account_number", "bsb_number" ], "title": "param", "type": "object" }, "bacs_debit": { "properties": { "account_number": { "maxLength": 5000, "type": "string" }, "sort_code": { "maxLength": 5000, "type": "string" } }, "title": "param", "type": "object" }, "bancontact": { "properties": {}, "title": "param", "type": "object" }, "billie": { "properties": {}, "title": "param", "type": "object" }, "billing_details": { "properties": { "address": { "anyOf": [ { "properties": { "city": { "maxLength": 5000, "type": "string" }, "country": { "maxLength": 5000, "type": "string" }, "line1": { "maxLength": 5000, "type": "string" }, "line2": { "maxLength": 5000, "type": "string" }, "postal_code": { "maxLength": 5000, "type": "string" }, "state": { "maxLength": 5000, "type": "string" } }, "title": "billing_details_address", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "email": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "name": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "phone": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "tax_id": { "maxLength": 5000, "type": "string" } }, "title": "billing_details_inner_params", "type": "object" }, "blik": { "properties": {}, "title": "param", "type": "object" }, "boleto": { "properties": { "tax_id": { "maxLength": 5000, "type": "string" } }, "required": [ "tax_id" ], "title": "param", "type": "object" }, "cashapp": { "properties": {}, "title": "param", "type": "object" }, "crypto": { "properties": {}, "title": "param", "type": "object" }, "customer_balance": { "properties": {}, "title": "param", "type": "object" }, "eps": { "properties": { "bank": { "enum": [ "arzte_und_apotheker_bank", "austrian_anadi_bank_ag", "bank_austria", "bankhaus_carl_spangler", "bankhaus_schelhammer_und_schattera_ag", "bawag_psk_ag", "bks_bank_ag", "brull_kallmus_bank_ag", "btv_vier_lander_bank", "capital_bank_grawe_gruppe_ag", "deutsche_bank_ag", "dolomitenbank", "easybank_ag", "erste_bank_und_sparkassen", "hypo_alpeadriabank_international_ag", "hypo_bank_burgenland_aktiengesellschaft", "hypo_noe_lb_fur_niederosterreich_u_wien", "hypo_oberosterreich_salzburg_steiermark", "hypo_tirol_bank_ag", "hypo_vorarlberg_bank_ag", "marchfelder_bank", "oberbank_ag", "raiffeisen_bankengruppe_osterreich", "schoellerbank_ag", "sparda_bank_wien", "volksbank_gruppe", "volkskreditbank_ag", "vr_bank_braunau" ], "maxLength": 5000, "type": "string" } }, "title": "param", "type": "object" }, "fpx": { "properties": { "bank": { "enum": [ "affin_bank", "agrobank", "alliance_bank", "ambank", "bank_islam", "bank_muamalat", "bank_of_china", "bank_rakyat", "bsn", "cimb", "deutsche_bank", "hong_leong_bank", "hsbc", "kfh", "maybank2e", "maybank2u", "ocbc", "pb_enterprise", "public_bank", "rhb", "standard_chartered", "uob" ], "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true } }, "required": [ "bank" ], "title": "param", "type": "object" }, "giropay": { "properties": {}, "title": "param", "type": "object" }, "grabpay": { "properties": {}, "title": "param", "type": "object" }, "ideal": { "properties": { "bank": { "enum": [ "abn_amro", "asn_bank", "bunq", "buut", "handelsbanken", "ing", "knab", "moneyou", "n26", "nn", "rabobank", "regiobank", "revolut", "sns_bank", "triodos_bank", "van_lanschot", "yoursafe" ], "maxLength": 5000, "type": "string" } }, "title": "param", "type": "object" }, "interac_present": { "properties": {}, "title": "param", "type": "object" }, "kakao_pay": { "properties": {}, "title": "param", "type": "object" }, "klarna": { "properties": { "dob": { "properties": { "day": { "type": "integer" }, "month": { "type": "integer" }, "year": { "type": "integer" } }, "required": [ "day", "month", "year" ], "title": "date_of_birth", "type": "object" } }, "title": "param", "type": "object" }, "konbini": { "properties": {}, "title": "param", "type": "object" }, "kr_card": { "properties": {}, "title": "param", "type": "object" }, "link": { "properties": {}, "title": "param", "type": "object" }, "metadata": { "additionalProperties": { "type": "string" }, "type": "object" }, "mobilepay": { "properties": {}, "title": "param", "type": "object" }, "multibanco": { "properties": {}, "title": "param", "type": "object" }, "naver_pay": { "properties": { "funding": { "enum": [ "card", "points" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "param", "type": "object" }, "nz_bank_account": { "properties": { "account_holder_name": { "maxLength": 5000, "type": "string" }, "account_number": { "maxLength": 5000, "type": "string" }, "bank_code": { "maxLength": 5000, "type": "string" }, "branch_code": { "maxLength": 5000, "type": "string" }, "reference": { "maxLength": 128, "type": "string" }, "suffix": { "maxLength": 5000, "type": "string" } }, "required": [ "account_number", "bank_code", "branch_code", "suffix" ], "title": "param", "type": "object" }, "oxxo": { "properties": {}, "title": "param", "type": "object" }, "p24": { "properties": { "bank": { "enum": [ "alior_bank", "bank_millennium", "bank_nowy_bfg_sa", "bank_pekao_sa", "banki_spbdzielcze", "blik", "bnp_paribas", "boz", "citi_handlowy", "credit_agricole", "envelobank", "etransfer_pocztowy24", "getin_bank", "ideabank", "ing", "inteligo", "mbank_mtransfer", "nest_przelew", "noble_pay", "pbac_z_ipko", "plus_bank", "santander_przelew24", "tmobile_usbugi_bankowe", "toyota_bank", "velobank", "volkswagen_bank" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "param", "type": "object" }, "pay_by_bank": { "properties": {}, "title": "param", "type": "object" }, "payco": { "properties": {}, "title": "param", "type": "object" }, "paynow": { "properties": {}, "title": "param", "type": "object" }, "paypal": { "properties": {}, "title": "param", "type": "object" }, "pix": { "properties": {}, "title": "param", "type": "object" }, "promptpay": { "properties": {}, "title": "param", "type": "object" }, "radar_options": { "properties": { "session": { "maxLength": 5000, "type": "string" } }, "title": "radar_options_with_hidden_options", "type": "object" }, "revolut_pay": { "properties": {}, "title": "param", "type": "object" }, "samsung_pay": { "properties": {}, "title": "param", "type": "object" }, "satispay": { "properties": {}, "title": "param", "type": "object" }, "sepa_debit": { "properties": { "iban": { "maxLength": 5000, "type": "string" } }, "required": [ "iban" ], "title": "param", "type": "object" }, "sofort": { "properties": { "country": { "enum": [ "AT", "BE", "DE", "ES", "IT", "NL" ], "type": "string" } }, "required": [ "country" ], "title": "param", "type": "object" }, "swish": { "properties": {}, "title": "param", "type": "object" }, "twint": { "properties": {}, "title": "param", "type": "object" }, "type": { "enum": [ "acss_debit", "affirm", "afterpay_clearpay", "alipay", "alma", "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", "billie", "blik", "boleto", "cashapp", "crypto", "customer_balance", "eps", "fpx", "giropay", "grabpay", "ideal", "kakao_pay", "klarna", "konbini", "kr_card", "link", "mobilepay", "multibanco", "naver_pay", "nz_bank_account", "oxxo", "p24", "pay_by_bank", "payco", "paynow", "paypal", "pix", "promptpay", "revolut_pay", "samsung_pay", "satispay", "sepa_debit", "sofort", "swish", "twint", "us_bank_account", "wechat_pay", "zip" ], "type": "string", "x-stripeBypassValidation": true }, "us_bank_account": { "properties": { "account_holder_type": { "enum": [ "company", "individual" ], "type": "string" }, "account_number": { "maxLength": 5000, "type": "string" }, "account_type": { "enum": [ "checking", "savings" ], "type": "string" }, "financial_connections_account": { "maxLength": 5000, "type": "string" }, "routing_number": { "maxLength": 5000, "type": "string" } }, "title": "payment_method_param", "type": "object" }, "wechat_pay": { "properties": {}, "title": "param", "type": "object" }, "zip": { "properties": {}, "title": "param", "type": "object" } }, "required": [ "type" ], "title": "payment_method_data_params", "type": "object" }, "payment_method_options": { "description": "Payment method-specific configuration for this PaymentIntent.", "properties": { "acss_debit": { "anyOf": [ { "properties": { "mandate_options": { "properties": { "custom_mandate_url": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "interval_description": { "maxLength": 500, "type": "string" }, "payment_schedule": { "enum": [ "combined", "interval", "sporadic" ], "type": "string" }, "transaction_type": { "enum": [ "business", "personal" ], "type": "string" } }, "title": "payment_intent_payment_method_options_mandate_options_param", "type": "object" }, "setup_future_usage": { "enum": [ "", "none", "off_session", "on_session" ], "type": "string" }, "target_date": { "maxLength": 5000, "type": "string" }, "verification_method": { "enum": [ "automatic", "instant", "microdeposits" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "payment_intent_payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "affirm": { "anyOf": [ { "properties": { "capture_method": { "enum": [ "", "manual" ], "type": "string" }, "preferred_locale": { "maxLength": 30, "type": "string" }, "setup_future_usage": { "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "afterpay_clearpay": { "anyOf": [ { "properties": { "capture_method": { "enum": [ "", "manual" ], "type": "string" }, "reference": { "maxLength": 128, "type": "string" }, "setup_future_usage": { "enum": [ "none" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "alipay": { "anyOf": [ { "properties": { "setup_future_usage": { "enum": [ "", "none", "off_session" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "alma": { "anyOf": [ { "properties": { "capture_method": { "enum": [ "", "manual" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "amazon_pay": { "anyOf": [ { "properties": { "capture_method": { "enum": [ "", "manual" ], "type": "string" }, "setup_future_usage": { "enum": [ "", "none", "off_session" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "au_becs_debit": { "anyOf": [ { "properties": { "setup_future_usage": { "enum": [ "", "none", "off_session", "on_session" ], "type": "string" }, "target_date": { "maxLength": 5000, "type": "string" } }, "title": "payment_intent_payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "bacs_debit": { "anyOf": [ { "properties": { "mandate_options": { "properties": { "reference_prefix": { "anyOf": [ { "maxLength": 12, "type": "string" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "payment_method_options_mandate_options_param", "type": "object" }, "setup_future_usage": { "enum": [ "", "none", "off_session", "on_session" ], "type": "string" }, "target_date": { "maxLength": 5000, "type": "string" } }, "title": "payment_intent_payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "bancontact": { "anyOf": [ { "properties": { "preferred_language": { "enum": [ "de", "en", "fr", "nl" ], "type": "string" }, "setup_future_usage": { "enum": [ "", "none", "off_session" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "billie": { "anyOf": [ { "properties": { "capture_method": { "enum": [ "", "manual" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "blik": { "anyOf": [ { "properties": { "code": { "maxLength": 5000, "type": "string" }, "setup_future_usage": { "enum": [ "", "none" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "payment_intent_payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "boleto": { "anyOf": [ { "properties": { "expires_after_days": { "type": "integer" }, "setup_future_usage": { "enum": [ "", "none", "off_session", "on_session" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "card": { "anyOf": [ { "properties": { "capture_method": { "enum": [ "", "manual" ], "type": "string", "x-stripeBypassValidation": true }, "cvc_token": { "maxLength": 5000, "type": "string" }, "installments": { "properties": { "enabled": { "type": "boolean" }, "plan": { "anyOf": [ { "properties": { "count": { "type": "integer" }, "interval": { "enum": [ "month" ], "type": "string" }, "type": { "enum": [ "bonus", "fixed_count", "revolving" ], "type": "string" } }, "required": [ "type" ], "title": "installment_plan", "type": "object" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "installments_param", "type": "object" }, "mandate_options": { "properties": { "amount": { "type": "integer" }, "amount_type": { "enum": [ "fixed", "maximum" ], "type": "string" }, "description": { "maxLength": 200, "type": "string" }, "end_date": { "format": "unix-time", "type": "integer" }, "interval": { "enum": [ "day", "month", "sporadic", "week", "year" ], "type": "string" }, "interval_count": { "type": "integer" }, "reference": { "maxLength": 80, "type": "string" }, "start_date": { "format": "unix-time", "type": "integer" }, "supported_types": { "items": { "enum": [ "india" ], "type": "string" }, "type": "array" } }, "required": [ "amount", "amount_type", "interval", "reference", "start_date" ], "title": "mandate_options_param", "type": "object" }, "network": { "enum": [ "amex", "cartes_bancaires", "diners", "discover", "eftpos_au", "girocard", "interac", "jcb", "link", "mastercard", "unionpay", "unknown", "visa" ], "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true }, "request_extended_authorization": { "enum": [ "if_available", "never" ], "type": "string" }, "request_incremental_authorization": { "enum": [ "if_available", "never" ], "type": "string" }, "request_multicapture": { "enum": [ "if_available", "never" ], "type": "string" }, "request_overcapture": { "enum": [ "if_available", "never" ], "type": "string" }, "request_three_d_secure": { "enum": [ "any", "automatic", "challenge" ], "type": "string", "x-stripeBypassValidation": true }, "require_cvc_recollection": { "type": "boolean" }, "setup_future_usage": { "enum": [ "", "none", "off_session", "on_session" ], "type": "string" }, "statement_descriptor_suffix_kana": { "anyOf": [ { "maxLength": 22, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "statement_descriptor_suffix_kanji": { "anyOf": [ { "maxLength": 17, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "three_d_secure": { "properties": { "ares_trans_status": { "enum": [ "A", "C", "I", "N", "R", "U", "Y" ], "type": "string" }, "cryptogram": { "maxLength": 5000, "type": "string" }, "electronic_commerce_indicator": { "enum": [ "01", "02", "05", "06", "07" ], "type": "string", "x-stripeBypassValidation": true }, "exemption_indicator": { "enum": [ "low_risk", "none" ], "type": "string" }, "network_options": { "properties": { "cartes_bancaires": { "properties": { "cb_avalgo": { "enum": [ "0", "1", "2", "3", "4", "A" ], "type": "string" }, "cb_exemption": { "maxLength": 4, "type": "string" }, "cb_score": { "type": "integer" } }, "required": [ "cb_avalgo" ], "title": "cartes_bancaires_network_options_param", "type": "object" } }, "title": "network_options_param", "type": "object" }, "requestor_challenge_indicator": { "maxLength": 2, "type": "string" }, "transaction_id": { "maxLength": 5000, "type": "string" }, "version": { "enum": [ "1.0.2", "2.1.0", "2.2.0" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "cryptogram", "transaction_id", "version" ], "title": "payment_method_options_param", "type": "object" } }, "title": "payment_intent_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "card_present": { "anyOf": [ { "properties": { "request_extended_authorization": { "type": "boolean" }, "request_incremental_authorization_support": { "type": "boolean" }, "routing": { "properties": { "requested_priority": { "enum": [ "domestic", "international" ], "type": "string" } }, "title": "routing_payment_method_options_param", "type": "object" } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "cashapp": { "anyOf": [ { "properties": { "capture_method": { "enum": [ "", "manual" ], "type": "string" }, "setup_future_usage": { "enum": [ "", "none", "off_session", "on_session" ], "type": "string" } }, "title": "payment_intent_payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "crypto": { "anyOf": [ { "properties": { "setup_future_usage": { "enum": [ "none" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "customer_balance": { "anyOf": [ { "properties": { "bank_transfer": { "properties": { "eu_bank_transfer": { "properties": { "country": { "maxLength": 5000, "type": "string" } }, "required": [ "country" ], "title": "eu_bank_transfer_params", "type": "object" }, "requested_address_types": { "items": { "enum": [ "aba", "iban", "sepa", "sort_code", "spei", "swift", "zengin" ], "type": "string", "x-stripeBypassValidation": true }, "type": "array" }, "type": { "enum": [ "eu_bank_transfer", "gb_bank_transfer", "jp_bank_transfer", "mx_bank_transfer", "us_bank_transfer" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "bank_transfer_param", "type": "object" }, "funding_type": { "enum": [ "bank_transfer" ], "type": "string" }, "setup_future_usage": { "enum": [ "none" ], "type": "string" } }, "title": "payment_intent_payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "eps": { "anyOf": [ { "properties": { "setup_future_usage": { "enum": [ "none" ], "type": "string" } }, "title": "payment_intent_payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "fpx": { "anyOf": [ { "properties": { "setup_future_usage": { "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "giropay": { "anyOf": [ { "properties": { "setup_future_usage": { "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "grabpay": { "anyOf": [ { "properties": { "setup_future_usage": { "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "ideal": { "anyOf": [ { "properties": { "setup_future_usage": { "enum": [ "", "none", "off_session" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "interac_present": { "anyOf": [ { "properties": {}, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "kakao_pay": { "anyOf": [ { "properties": { "capture_method": { "enum": [ "", "manual" ], "type": "string" }, "setup_future_usage": { "enum": [ "", "none", "off_session" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "klarna": { "anyOf": [ { "properties": { "capture_method": { "enum": [ "", "manual" ], "type": "string" }, "on_demand": { "properties": { "average_amount": { "type": "integer" }, "maximum_amount": { "type": "integer" }, "minimum_amount": { "type": "integer" }, "purchase_interval": { "enum": [ "day", "month", "week", "year" ], "type": "string" }, "purchase_interval_count": { "type": "integer" } }, "title": "on_demand_param", "type": "object" }, "preferred_locale": { "enum": [ "cs-CZ", "da-DK", "de-AT", "de-CH", "de-DE", "el-GR", "en-AT", "en-AU", "en-BE", "en-CA", "en-CH", "en-CZ", "en-DE", "en-DK", "en-ES", "en-FI", "en-FR", "en-GB", "en-GR", "en-IE", "en-IT", "en-NL", "en-NO", "en-NZ", "en-PL", "en-PT", "en-RO", "en-SE", "en-US", "es-ES", "es-US", "fi-FI", "fr-BE", "fr-CA", "fr-CH", "fr-FR", "it-CH", "it-IT", "nb-NO", "nl-BE", "nl-NL", "pl-PL", "pt-PT", "ro-RO", "sv-FI", "sv-SE" ], "type": "string", "x-stripeBypassValidation": true }, "setup_future_usage": { "enum": [ "none", "off_session", "on_session" ], "type": "string" }, "subscriptions": { "anyOf": [ { "items": { "properties": { "interval": { "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "type": "integer" }, "name": { "maxLength": 255, "type": "string" }, "next_billing": { "properties": { "amount": { "type": "integer" }, "date": { "maxLength": 5000, "type": "string" } }, "required": [ "amount", "date" ], "title": "subscription_next_billing_param", "type": "object" }, "reference": { "maxLength": 255, "type": "string" } }, "required": [ "interval", "reference" ], "title": "subscription_param", "type": "object" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "konbini": { "anyOf": [ { "properties": { "confirmation_number": { "anyOf": [ { "maxLength": 11, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "expires_after_days": { "anyOf": [ { "type": "integer" }, { "enum": [ "" ], "type": "string" } ] }, "expires_at": { "anyOf": [ { "format": "unix-time", "type": "integer" }, { "enum": [ "" ], "type": "string" } ] }, "product_description": { "anyOf": [ { "maxLength": 22, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "setup_future_usage": { "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "kr_card": { "anyOf": [ { "properties": { "capture_method": { "enum": [ "", "manual" ], "type": "string" }, "setup_future_usage": { "enum": [ "", "none", "off_session" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "link": { "anyOf": [ { "properties": { "capture_method": { "enum": [ "", "manual" ], "type": "string" }, "setup_future_usage": { "enum": [ "", "none", "off_session" ], "type": "string" } }, "title": "payment_intent_payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "mobilepay": { "anyOf": [ { "properties": { "capture_method": { "enum": [ "", "manual" ], "type": "string" }, "setup_future_usage": { "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "multibanco": { "anyOf": [ { "properties": { "setup_future_usage": { "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "naver_pay": { "anyOf": [ { "properties": { "capture_method": { "enum": [ "", "manual" ], "type": "string" }, "setup_future_usage": { "enum": [ "", "none", "off_session" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "nz_bank_account": { "anyOf": [ { "properties": { "setup_future_usage": { "enum": [ "", "none", "off_session", "on_session" ], "type": "string" }, "target_date": { "maxLength": 5000, "type": "string" } }, "title": "payment_intent_payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "oxxo": { "anyOf": [ { "properties": { "expires_after_days": { "type": "integer" }, "setup_future_usage": { "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "p24": { "anyOf": [ { "properties": { "setup_future_usage": { "enum": [ "none" ], "type": "string" }, "tos_shown_and_accepted": { "type": "boolean" } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "pay_by_bank": { "anyOf": [ { "properties": {}, "title": "payment_intent_payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "payco": { "anyOf": [ { "properties": { "capture_method": { "enum": [ "", "manual" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "paynow": { "anyOf": [ { "properties": { "setup_future_usage": { "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "paypal": { "anyOf": [ { "properties": { "capture_method": { "enum": [ "", "manual" ], "type": "string" }, "preferred_locale": { "enum": [ "cs-CZ", "da-DK", "de-AT", "de-DE", "de-LU", "el-GR", "en-GB", "en-US", "es-ES", "fi-FI", "fr-BE", "fr-FR", "fr-LU", "hu-HU", "it-IT", "nl-BE", "nl-NL", "pl-PL", "pt-PT", "sk-SK", "sv-SE" ], "type": "string", "x-stripeBypassValidation": true }, "reference": { "maxLength": 127, "type": "string" }, "risk_correlation_id": { "maxLength": 32, "type": "string" }, "setup_future_usage": { "enum": [ "", "none", "off_session" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "pix": { "anyOf": [ { "properties": { "amount_includes_iof": { "enum": [ "always", "never" ], "type": "string" }, "expires_after_seconds": { "type": "integer" }, "expires_at": { "format": "unix-time", "type": "integer" }, "setup_future_usage": { "enum": [ "none" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "promptpay": { "anyOf": [ { "properties": { "setup_future_usage": { "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "revolut_pay": { "anyOf": [ { "properties": { "capture_method": { "enum": [ "", "manual" ], "type": "string" }, "setup_future_usage": { "enum": [ "", "none", "off_session" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "samsung_pay": { "anyOf": [ { "properties": { "capture_method": { "enum": [ "", "manual" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "satispay": { "anyOf": [ { "properties": { "capture_method": { "enum": [ "", "manual" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "sepa_debit": { "anyOf": [ { "properties": { "mandate_options": { "properties": { "reference_prefix": { "anyOf": [ { "maxLength": 12, "type": "string" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "payment_method_options_mandate_options_param", "type": "object" }, "setup_future_usage": { "enum": [ "", "none", "off_session", "on_session" ], "type": "string" }, "target_date": { "maxLength": 5000, "type": "string" } }, "title": "payment_intent_payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "sofort": { "anyOf": [ { "properties": { "preferred_language": { "enum": [ "", "de", "en", "es", "fr", "it", "nl", "pl" ], "type": "string" }, "setup_future_usage": { "enum": [ "", "none", "off_session" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "swish": { "anyOf": [ { "properties": { "reference": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "setup_future_usage": { "enum": [ "none" ], "type": "string" } }, "title": "payment_intent_payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "twint": { "anyOf": [ { "properties": { "setup_future_usage": { "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "us_bank_account": { "anyOf": [ { "properties": { "financial_connections": { "properties": { "filters": { "properties": { "account_subcategories": { "items": { "enum": [ "checking", "savings" ], "maxLength": 5000, "type": "string" }, "type": "array" } }, "title": "linked_account_options_filters_param", "type": "object" }, "permissions": { "items": { "enum": [ "balances", "ownership", "payment_method", "transactions" ], "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true }, "type": "array" }, "prefetch": { "items": { "enum": [ "balances", "ownership", "transactions" ], "type": "string", "x-stripeBypassValidation": true }, "type": "array" }, "return_url": { "maxLength": 5000, "type": "string" } }, "title": "linked_account_options_param", "type": "object" }, "mandate_options": { "properties": { "collection_method": { "enum": [ "", "paper" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "mandate_options_param", "type": "object" }, "networks": { "properties": { "requested": { "items": { "enum": [ "ach", "us_domestic_wire" ], "type": "string" }, "type": "array" } }, "title": "networks_options_param", "type": "object" }, "preferred_settlement_speed": { "enum": [ "", "fastest", "standard" ], "type": "string" }, "setup_future_usage": { "enum": [ "", "none", "off_session", "on_session" ], "type": "string" }, "target_date": { "maxLength": 5000, "type": "string" }, "verification_method": { "enum": [ "automatic", "instant", "microdeposits" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "payment_intent_payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "wechat_pay": { "anyOf": [ { "properties": { "app_id": { "maxLength": 5000, "type": "string" }, "client": { "enum": [ "android", "ios", "web" ], "type": "string", "x-stripeBypassValidation": true }, "setup_future_usage": { "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "zip": { "anyOf": [ { "properties": { "setup_future_usage": { "enum": [ "none" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "payment_method_options_param", "type": "object" }, "payment_method_types": { "description": "The list of payment method types (for example, a card) that this PaymentIntent can use. Use `automatic_payment_methods` to manage payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods). A list of valid payment method types can be found [here](https://docs.stripe.com/api/payment_methods/object#payment_method_object-type).", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "radar_options": { "description": "Options to configure Radar. Learn more about [Radar Sessions](https://stripe.com/docs/radar/radar-session).", "properties": { "session": { "maxLength": 5000, "type": "string" } }, "title": "radar_options_with_hidden_options", "type": "object" }, "receipt_email": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "Email address that the receipt for the resulting payment will be sent to. If `receipt_email` is specified for a payment in live mode, a receipt will be sent regardless of your [email settings](https://dashboard.stripe.com/account/emails)." }, "return_url": { "description": "The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site.\nIf you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme.\nThis parameter is only used for cards and other redirect-based payment methods.", "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", "enum": [ "", "off_session", "on_session" ], "type": "string" }, "shipping": { "anyOf": [ { "properties": { "address": { "properties": { "city": { "maxLength": 5000, "type": "string" }, "country": { "maxLength": 5000, "type": "string" }, "line1": { "maxLength": 5000, "type": "string" }, "line2": { "maxLength": 5000, "type": "string" }, "postal_code": { "maxLength": 5000, "type": "string" }, "state": { "maxLength": 5000, "type": "string" } }, "title": "optional_fields_address", "type": "object" }, "carrier": { "maxLength": 5000, "type": "string" }, "name": { "maxLength": 5000, "type": "string" }, "phone": { "maxLength": 5000, "type": "string" }, "tracking_number": { "maxLength": 5000, "type": "string" } }, "required": [ "address", "name" ], "title": "optional_fields_shipping", "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Shipping information for this PaymentIntent." }, "use_stripe_sdk": { "description": "Set to `true` when confirming server-side and using Stripe.js, iOS, or Android client-side SDKs to handle the next actions.", "type": "boolean" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_intent" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Confirm a PaymentIntent" } }, "/v1/payment_intents/{intent}/increment_authorization": { "post": { "description": "

Perform an incremental authorization on an eligible\nPaymentIntent. To be eligible, the\nPaymentIntent’s status must be requires_capture and\nincremental_authorization_supported\nmust be true.

\n\n

Incremental authorizations attempt to increase the authorized amount on\nyour customer’s card to the new, higher amount provided. Similar to the\ninitial authorization, incremental authorizations can be declined. A\nsingle PaymentIntent can call this endpoint multiple times to further\nincrease the authorized amount.

\n\n

If the incremental authorization succeeds, the PaymentIntent object\nreturns with the updated\namount.\nIf the incremental authorization fails, a\ncard_declined error returns, and no other\nfields on the PaymentIntent or Charge update. The PaymentIntent\nobject remains capturable for the previously authorized amount.

\n\n

Each PaymentIntent can have a maximum of 10 incremental authorization attempts, including declines.\nAfter it’s captured, a PaymentIntent can no longer be incremented.

\n\n

Learn more about incremental authorizations.

", "operationId": "PostPaymentIntentsIntentIncrementAuthorization", "parameters": [ { "in": "path", "name": "intent", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "transfer_data": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "amount": { "description": "The updated total amount that you intend to collect from the cardholder. This amount must be greater than the currently authorized amount.", "type": "integer" }, "application_fee_amount": { "description": "The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total amount captured. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).", "type": "integer" }, "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users.", "maxLength": 1000, "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "statement_descriptor": { "description": "Text that appears on the customer's statement as the statement descriptor for a non-card or card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).", "maxLength": 22, "type": "string" }, "transfer_data": { "description": "The parameters used to automatically create a transfer after the payment is captured.\nLearn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).", "properties": { "amount": { "type": "integer" } }, "title": "transfer_data_update_params", "type": "object" } }, "required": [ "amount" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_intent" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Increment an authorization" } }, "/v1/payment_intents/{intent}/verify_microdeposits": { "post": { "description": "

Verifies microdeposits on a PaymentIntent object.

", "operationId": "PostPaymentIntentsIntentVerifyMicrodeposits", "parameters": [ { "in": "path", "name": "intent", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "amounts": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "amounts": { "description": "Two positive integers, in *cents*, equal to the values of the microdeposits sent to the bank account.", "items": { "type": "integer" }, "type": "array" }, "client_secret": { "description": "The client secret of the PaymentIntent.", "maxLength": 5000, "type": "string" }, "descriptor_code": { "description": "A six-character code starting with SM present in the microdeposit sent to the bank account.", "maxLength": 5000, "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_intent" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Verify microdeposits on a PaymentIntent" } }, "/v1/payment_links": { "get": { "description": "

Returns a list of your payment links.

", "operationId": "GetPaymentLinks", "parameters": [ { "description": "Only return payment links that are active or inactive (e.g., pass `false` to list all inactive payment links).", "in": "query", "name": "active", "required": false, "schema": { "type": "boolean" }, "style": "form" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/payment_link" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/payment_links", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "PaymentLinksResourcePaymentLinkList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all payment links" }, "post": { "description": "

Creates a payment link.

", "operationId": "PostPaymentLinks", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "after_completion": { "explode": true, "style": "deepObject" }, "automatic_tax": { "explode": true, "style": "deepObject" }, "consent_collection": { "explode": true, "style": "deepObject" }, "custom_fields": { "explode": true, "style": "deepObject" }, "custom_text": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "invoice_creation": { "explode": true, "style": "deepObject" }, "line_items": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "optional_items": { "explode": true, "style": "deepObject" }, "payment_intent_data": { "explode": true, "style": "deepObject" }, "payment_method_types": { "explode": true, "style": "deepObject" }, "phone_number_collection": { "explode": true, "style": "deepObject" }, "restrictions": { "explode": true, "style": "deepObject" }, "shipping_address_collection": { "explode": true, "style": "deepObject" }, "shipping_options": { "explode": true, "style": "deepObject" }, "subscription_data": { "explode": true, "style": "deepObject" }, "tax_id_collection": { "explode": true, "style": "deepObject" }, "transfer_data": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "after_completion": { "description": "Behavior after the purchase is complete.", "properties": { "hosted_confirmation": { "properties": { "custom_message": { "maxLength": 500, "type": "string" } }, "title": "after_completion_confirmation_page_params", "type": "object" }, "redirect": { "properties": { "url": { "type": "string" } }, "required": [ "url" ], "title": "after_completion_redirect_params", "type": "object" }, "type": { "enum": [ "hosted_confirmation", "redirect" ], "type": "string" } }, "required": [ "type" ], "title": "after_completion_params", "type": "object" }, "allow_promotion_codes": { "description": "Enables user redeemable promotion codes.", "type": "boolean" }, "application_fee_amount": { "description": "The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. Can only be applied when there are no line items with recurring prices.", "type": "integer" }, "application_fee_percent": { "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. There must be at least 1 line item with a recurring price to use this field.", "type": "number" }, "automatic_tax": { "description": "Configuration for automatic tax collection.", "properties": { "enabled": { "type": "boolean" }, "liability": { "properties": { "account": { "type": "string" }, "type": { "enum": [ "account", "self" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "param", "type": "object" } }, "required": [ "enabled" ], "title": "automatic_tax_params", "type": "object" }, "billing_address_collection": { "description": "Configuration for collecting the customer's billing address. Defaults to `auto`.", "enum": [ "auto", "required" ], "type": "string" }, "consent_collection": { "description": "Configure fields to gather active consent from customers.", "properties": { "payment_method_reuse_agreement": { "properties": { "position": { "enum": [ "auto", "hidden" ], "type": "string" } }, "required": [ "position" ], "title": "payment_method_reuse_agreement_params", "type": "object" }, "promotions": { "enum": [ "auto", "none" ], "type": "string" }, "terms_of_service": { "enum": [ "none", "required" ], "type": "string" } }, "title": "consent_collection_params", "type": "object" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies) and supported by each line item's price.", "format": "currency", "type": "string" }, "custom_fields": { "description": "Collect additional information from your customer using custom fields. Up to 3 fields are supported.", "items": { "properties": { "dropdown": { "properties": { "default_value": { "maxLength": 100, "type": "string" }, "options": { "items": { "properties": { "label": { "maxLength": 100, "type": "string" }, "value": { "maxLength": 100, "type": "string" } }, "required": [ "label", "value" ], "title": "custom_field_option_param", "type": "object" }, "type": "array" } }, "required": [ "options" ], "title": "custom_field_dropdown_param", "type": "object" }, "key": { "maxLength": 200, "type": "string" }, "label": { "properties": { "custom": { "maxLength": 50, "type": "string" }, "type": { "enum": [ "custom" ], "type": "string" } }, "required": [ "custom", "type" ], "title": "custom_field_label_param", "type": "object" }, "numeric": { "properties": { "default_value": { "maxLength": 255, "type": "string" }, "maximum_length": { "type": "integer" }, "minimum_length": { "type": "integer" } }, "title": "custom_field_numeric_param", "type": "object" }, "optional": { "type": "boolean" }, "text": { "properties": { "default_value": { "maxLength": 255, "type": "string" }, "maximum_length": { "type": "integer" }, "minimum_length": { "type": "integer" } }, "title": "custom_field_text_param", "type": "object" }, "type": { "enum": [ "dropdown", "numeric", "text" ], "type": "string" } }, "required": [ "key", "label", "type" ], "title": "custom_field_param", "type": "object" }, "type": "array" }, "custom_text": { "description": "Display additional text for your customers using custom text.", "properties": { "after_submit": { "anyOf": [ { "properties": { "message": { "maxLength": 1200, "type": "string" } }, "required": [ "message" ], "title": "custom_text_position_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "shipping_address": { "anyOf": [ { "properties": { "message": { "maxLength": 1200, "type": "string" } }, "required": [ "message" ], "title": "custom_text_position_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "submit": { "anyOf": [ { "properties": { "message": { "maxLength": 1200, "type": "string" } }, "required": [ "message" ], "title": "custom_text_position_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "terms_of_service_acceptance": { "anyOf": [ { "properties": { "message": { "maxLength": 1200, "type": "string" } }, "required": [ "message" ], "title": "custom_text_position_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "custom_text_param", "type": "object" }, "customer_creation": { "description": "Configures whether [checkout sessions](https://stripe.com/docs/api/checkout/sessions) created by this payment link create a [Customer](https://stripe.com/docs/api/customers).", "enum": [ "always", "if_required" ], "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "inactive_message": { "description": "The custom message to be displayed to a customer when a payment link is no longer active.", "maxLength": 500, "type": "string" }, "invoice_creation": { "description": "Generate a post-purchase Invoice for one-time payments.", "properties": { "enabled": { "type": "boolean" }, "invoice_data": { "properties": { "account_tax_ids": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ] }, "custom_fields": { "anyOf": [ { "items": { "properties": { "name": { "maxLength": 40, "type": "string" }, "value": { "maxLength": 140, "type": "string" } }, "required": [ "name", "value" ], "title": "custom_field_params", "type": "object" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ] }, "description": { "maxLength": 1500, "type": "string" }, "footer": { "maxLength": 5000, "type": "string" }, "issuer": { "properties": { "account": { "type": "string" }, "type": { "enum": [ "account", "self" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "param", "type": "object" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "rendering_options": { "anyOf": [ { "properties": { "amount_tax_display": { "enum": [ "", "exclude_tax", "include_inclusive_tax" ], "type": "string" }, "template": { "maxLength": 5000, "type": "string" } }, "title": "checkout_rendering_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "invoice_settings_params", "type": "object" } }, "required": [ "enabled" ], "title": "invoice_creation_create_params", "type": "object" }, "line_items": { "description": "The line items representing what is being sold. Each line item represents an item being sold. Up to 20 line items are supported.", "items": { "properties": { "adjustable_quantity": { "properties": { "enabled": { "type": "boolean" }, "maximum": { "type": "integer" }, "minimum": { "type": "integer" } }, "required": [ "enabled" ], "title": "adjustable_quantity_params", "type": "object" }, "price": { "maxLength": 5000, "type": "string" }, "price_data": { "properties": { "currency": { "format": "currency", "type": "string" }, "product": { "maxLength": 5000, "type": "string" }, "product_data": { "properties": { "description": { "maxLength": 40000, "type": "string" }, "images": { "items": { "type": "string" }, "type": "array" }, "metadata": { "additionalProperties": { "type": "string" }, "type": "object" }, "name": { "maxLength": 5000, "type": "string" }, "tax_code": { "maxLength": 5000, "type": "string" } }, "required": [ "name" ], "title": "product_data", "type": "object" }, "recurring": { "properties": { "interval": { "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "type": "integer" } }, "required": [ "interval" ], "title": "recurring_adhoc", "type": "object" }, "tax_behavior": { "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" }, "unit_amount": { "type": "integer" }, "unit_amount_decimal": { "format": "decimal", "type": "string" } }, "required": [ "currency" ], "title": "custom_amount_price_data_with_product_data", "type": "object" }, "quantity": { "type": "integer" } }, "required": [ "quantity" ], "title": "line_items_create_params", "type": "object" }, "type": "array" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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](https://stripe.com/docs/api/checkout/sessions) created by this payment link.", "type": "object" }, "on_behalf_of": { "description": "The account on behalf of which to charge.", "type": "string" }, "optional_items": { "description": "A list of optional items the customer can add to their order at checkout. Use this parameter to pass one-time or recurring [Prices](https://stripe.com/docs/api/prices).\nThere is a maximum of 10 optional items allowed on a payment link, and the existing limits on the number of line items allowed on a payment link apply to the combined number of line items and optional items.\nThere is a maximum of 20 combined line items and optional items.", "items": { "properties": { "adjustable_quantity": { "properties": { "enabled": { "type": "boolean" }, "maximum": { "type": "integer" }, "minimum": { "type": "integer" } }, "required": [ "enabled" ], "title": "optional_item_adjustable_quantity_params", "type": "object" }, "price": { "maxLength": 5000, "type": "string" }, "quantity": { "type": "integer" } }, "required": [ "price", "quantity" ], "title": "optional_item_params", "type": "object" }, "type": "array" }, "payment_intent_data": { "description": "A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in `payment` mode.", "properties": { "capture_method": { "enum": [ "automatic", "automatic_async", "manual" ], "type": "string" }, "description": { "maxLength": 1000, "type": "string" }, "metadata": { "additionalProperties": { "type": "string" }, "type": "object" }, "setup_future_usage": { "enum": [ "off_session", "on_session" ], "type": "string" }, "statement_descriptor": { "maxLength": 22, "type": "string" }, "statement_descriptor_suffix": { "maxLength": 22, "type": "string" }, "transfer_group": { "maxLength": 5000, "type": "string" } }, "title": "payment_intent_data_params", "type": "object" }, "payment_method_collection": { "description": "Specify whether Checkout should collect a payment method. When set to `if_required`, Checkout will not collect a payment method when the total due for the session is 0.This may occur if the Checkout Session includes a free trial or a discount.\n\nCan only be set in `subscription` mode. Defaults to `always`.\n\nIf you'd like information on how to collect a payment method outside of Checkout, read the guide on [configuring subscriptions with a free trial](https://stripe.com/docs/payments/checkout/free-trials).", "enum": [ "always", "if_required" ], "type": "string" }, "payment_method_types": { "description": "The list of payment method types that customers can use. If no value is passed, Stripe will dynamically show relevant payment methods from your [payment method settings](https://dashboard.stripe.com/settings/payment_methods) (20+ payment methods [supported](https://stripe.com/docs/payments/payment-methods/integration-options#payment-method-product-support)).", "items": { "enum": [ "affirm", "afterpay_clearpay", "alipay", "alma", "au_becs_debit", "bacs_debit", "bancontact", "billie", "blik", "boleto", "card", "cashapp", "eps", "fpx", "giropay", "grabpay", "ideal", "klarna", "konbini", "link", "mobilepay", "multibanco", "oxxo", "p24", "pay_by_bank", "paynow", "paypal", "pix", "promptpay", "satispay", "sepa_debit", "sofort", "swish", "twint", "us_bank_account", "wechat_pay", "zip" ], "type": "string", "x-stripeBypassValidation": true }, "type": "array" }, "phone_number_collection": { "description": "Controls phone number collection settings during checkout.\n\nWe recommend that you review your privacy policy and check with your legal contacts.", "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ], "title": "phone_number_collection_params", "type": "object" }, "restrictions": { "description": "Settings that restrict the usage of a payment link.", "properties": { "completed_sessions": { "properties": { "limit": { "type": "integer" } }, "required": [ "limit" ], "title": "completed_sessions_params", "type": "object" } }, "required": [ "completed_sessions" ], "title": "restrictions_params", "type": "object" }, "shipping_address_collection": { "description": "Configuration for collecting the customer's shipping address.", "properties": { "allowed_countries": { "items": { "enum": [ "AC", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CV", "CW", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MK", "ML", "MM", "MN", "MO", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SZ", "TA", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VN", "VU", "WF", "WS", "XK", "YE", "YT", "ZA", "ZM", "ZW", "ZZ" ], "type": "string" }, "type": "array" } }, "required": [ "allowed_countries" ], "title": "shipping_address_collection_params", "type": "object" }, "shipping_options": { "description": "The shipping rate options to apply to [checkout sessions](https://stripe.com/docs/api/checkout/sessions) created by this payment link.", "items": { "properties": { "shipping_rate": { "maxLength": 5000, "type": "string" } }, "title": "shipping_option_params", "type": "object" }, "type": "array" }, "submit_type": { "description": "Describes the type of transaction being performed in order to customize relevant text on the page, such as the submit button. Changing this value will also affect the hostname in the [url](https://stripe.com/docs/api/payment_links/payment_links/object#url) property (example: `donate.stripe.com`).", "enum": [ "auto", "book", "donate", "pay", "subscribe" ], "type": "string" }, "subscription_data": { "description": "When creating a subscription, the specified configuration data will be used. There must be at least one line item with a recurring price to use `subscription_data`.", "properties": { "description": { "maxLength": 500, "type": "string" }, "invoice_settings": { "properties": { "issuer": { "properties": { "account": { "type": "string" }, "type": { "enum": [ "account", "self" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "param", "type": "object" } }, "title": "subscription_data_invoice_settings_params", "type": "object" }, "metadata": { "additionalProperties": { "type": "string" }, "type": "object" }, "trial_period_days": { "type": "integer" }, "trial_settings": { "properties": { "end_behavior": { "properties": { "missing_payment_method": { "enum": [ "cancel", "create_invoice", "pause" ], "type": "string" } }, "required": [ "missing_payment_method" ], "title": "end_behavior", "type": "object" } }, "required": [ "end_behavior" ], "title": "trial_settings_config", "type": "object" } }, "title": "subscription_data_params", "type": "object" }, "tax_id_collection": { "description": "Controls tax ID collection during checkout.", "properties": { "enabled": { "type": "boolean" }, "required": { "enum": [ "if_supported", "never" ], "type": "string" } }, "required": [ "enabled" ], "title": "tax_id_collection_params", "type": "object" }, "transfer_data": { "description": "The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to.", "properties": { "amount": { "type": "integer" }, "destination": { "type": "string" } }, "required": [ "destination" ], "title": "transfer_data_params", "type": "object" } }, "required": [ "line_items" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_link" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a payment link" } }, "/v1/payment_links/{payment_link}": { "get": { "description": "

Retrieve a payment link.

", "operationId": "GetPaymentLinksPaymentLink", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "payment_link", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_link" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve payment link" }, "post": { "description": "

Updates a payment link.

", "operationId": "PostPaymentLinksPaymentLink", "parameters": [ { "in": "path", "name": "payment_link", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "after_completion": { "explode": true, "style": "deepObject" }, "automatic_tax": { "explode": true, "style": "deepObject" }, "custom_fields": { "explode": true, "style": "deepObject" }, "custom_text": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "inactive_message": { "explode": true, "style": "deepObject" }, "invoice_creation": { "explode": true, "style": "deepObject" }, "line_items": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "payment_intent_data": { "explode": true, "style": "deepObject" }, "payment_method_types": { "explode": true, "style": "deepObject" }, "phone_number_collection": { "explode": true, "style": "deepObject" }, "restrictions": { "explode": true, "style": "deepObject" }, "shipping_address_collection": { "explode": true, "style": "deepObject" }, "subscription_data": { "explode": true, "style": "deepObject" }, "tax_id_collection": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "active": { "description": "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.", "type": "boolean" }, "after_completion": { "description": "Behavior after the purchase is complete.", "properties": { "hosted_confirmation": { "properties": { "custom_message": { "maxLength": 500, "type": "string" } }, "title": "after_completion_confirmation_page_params", "type": "object" }, "redirect": { "properties": { "url": { "type": "string" } }, "required": [ "url" ], "title": "after_completion_redirect_params", "type": "object" }, "type": { "enum": [ "hosted_confirmation", "redirect" ], "type": "string" } }, "required": [ "type" ], "title": "after_completion_params", "type": "object" }, "allow_promotion_codes": { "description": "Enables user redeemable promotion codes.", "type": "boolean" }, "automatic_tax": { "description": "Configuration for automatic tax collection.", "properties": { "enabled": { "type": "boolean" }, "liability": { "properties": { "account": { "type": "string" }, "type": { "enum": [ "account", "self" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "param", "type": "object" } }, "required": [ "enabled" ], "title": "automatic_tax_params", "type": "object" }, "billing_address_collection": { "description": "Configuration for collecting the customer's billing address. Defaults to `auto`.", "enum": [ "auto", "required" ], "type": "string" }, "custom_fields": { "anyOf": [ { "items": { "properties": { "dropdown": { "properties": { "default_value": { "maxLength": 100, "type": "string" }, "options": { "items": { "properties": { "label": { "maxLength": 100, "type": "string" }, "value": { "maxLength": 100, "type": "string" } }, "required": [ "label", "value" ], "title": "custom_field_option_param", "type": "object" }, "type": "array" } }, "required": [ "options" ], "title": "custom_field_dropdown_param", "type": "object" }, "key": { "maxLength": 200, "type": "string" }, "label": { "properties": { "custom": { "maxLength": 50, "type": "string" }, "type": { "enum": [ "custom" ], "type": "string" } }, "required": [ "custom", "type" ], "title": "custom_field_label_param", "type": "object" }, "numeric": { "properties": { "default_value": { "maxLength": 255, "type": "string" }, "maximum_length": { "type": "integer" }, "minimum_length": { "type": "integer" } }, "title": "custom_field_numeric_param", "type": "object" }, "optional": { "type": "boolean" }, "text": { "properties": { "default_value": { "maxLength": 255, "type": "string" }, "maximum_length": { "type": "integer" }, "minimum_length": { "type": "integer" } }, "title": "custom_field_text_param", "type": "object" }, "type": { "enum": [ "dropdown", "numeric", "text" ], "type": "string" } }, "required": [ "key", "label", "type" ], "title": "custom_field_param", "type": "object" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "Collect additional information from your customer using custom fields. Up to 3 fields are supported." }, "custom_text": { "description": "Display additional text for your customers using custom text.", "properties": { "after_submit": { "anyOf": [ { "properties": { "message": { "maxLength": 1200, "type": "string" } }, "required": [ "message" ], "title": "custom_text_position_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "shipping_address": { "anyOf": [ { "properties": { "message": { "maxLength": 1200, "type": "string" } }, "required": [ "message" ], "title": "custom_text_position_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "submit": { "anyOf": [ { "properties": { "message": { "maxLength": 1200, "type": "string" } }, "required": [ "message" ], "title": "custom_text_position_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "terms_of_service_acceptance": { "anyOf": [ { "properties": { "message": { "maxLength": 1200, "type": "string" } }, "required": [ "message" ], "title": "custom_text_position_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "custom_text_param", "type": "object" }, "customer_creation": { "description": "Configures whether [checkout sessions](https://stripe.com/docs/api/checkout/sessions) created by this payment link create a [Customer](https://stripe.com/docs/api/customers).", "enum": [ "always", "if_required" ], "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "inactive_message": { "anyOf": [ { "maxLength": 500, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "The custom message to be displayed to a customer when a payment link is no longer active." }, "invoice_creation": { "description": "Generate a post-purchase Invoice for one-time payments.", "properties": { "enabled": { "type": "boolean" }, "invoice_data": { "properties": { "account_tax_ids": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ] }, "custom_fields": { "anyOf": [ { "items": { "properties": { "name": { "maxLength": 40, "type": "string" }, "value": { "maxLength": 140, "type": "string" } }, "required": [ "name", "value" ], "title": "custom_field_params", "type": "object" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ] }, "description": { "maxLength": 1500, "type": "string" }, "footer": { "maxLength": 5000, "type": "string" }, "issuer": { "properties": { "account": { "type": "string" }, "type": { "enum": [ "account", "self" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "param", "type": "object" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "rendering_options": { "anyOf": [ { "properties": { "amount_tax_display": { "enum": [ "", "exclude_tax", "include_inclusive_tax" ], "type": "string" }, "template": { "maxLength": 5000, "type": "string" } }, "title": "checkout_rendering_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "invoice_settings_params", "type": "object" } }, "required": [ "enabled" ], "title": "invoice_creation_update_params", "type": "object" }, "line_items": { "description": "The line items representing what is being sold. Each line item represents an item being sold. Up to 20 line items are supported.", "items": { "properties": { "adjustable_quantity": { "properties": { "enabled": { "type": "boolean" }, "maximum": { "type": "integer" }, "minimum": { "type": "integer" } }, "required": [ "enabled" ], "title": "adjustable_quantity_params", "type": "object" }, "id": { "maxLength": 5000, "type": "string" }, "quantity": { "type": "integer" } }, "required": [ "id" ], "title": "line_items_update_params", "type": "object" }, "type": "array" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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](https://stripe.com/docs/api/checkout/sessions) created by this payment link.", "type": "object" }, "payment_intent_data": { "description": "A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in `payment` mode.", "properties": { "description": { "anyOf": [ { "maxLength": 1000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "statement_descriptor": { "anyOf": [ { "maxLength": 22, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "statement_descriptor_suffix": { "anyOf": [ { "maxLength": 22, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "transfer_group": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "payment_intent_data_update_params", "type": "object" }, "payment_method_collection": { "description": "Specify whether Checkout should collect a payment method. When set to `if_required`, Checkout will not collect a payment method when the total due for the session is 0.This may occur if the Checkout Session includes a free trial or a discount.\n\nCan only be set in `subscription` mode. Defaults to `always`.\n\nIf you'd like information on how to collect a payment method outside of Checkout, read the guide on [configuring subscriptions with a free trial](https://stripe.com/docs/payments/checkout/free-trials).", "enum": [ "always", "if_required" ], "type": "string" }, "payment_method_types": { "anyOf": [ { "items": { "enum": [ "affirm", "afterpay_clearpay", "alipay", "alma", "au_becs_debit", "bacs_debit", "bancontact", "billie", "blik", "boleto", "card", "cashapp", "eps", "fpx", "giropay", "grabpay", "ideal", "klarna", "konbini", "link", "mobilepay", "multibanco", "oxxo", "p24", "pay_by_bank", "paynow", "paypal", "pix", "promptpay", "satispay", "sepa_debit", "sofort", "swish", "twint", "us_bank_account", "wechat_pay", "zip" ], "type": "string", "x-stripeBypassValidation": true }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The list of payment method types that customers can use. Pass an empty string to enable dynamic payment methods that use your [payment method settings](https://dashboard.stripe.com/settings/payment_methods)." }, "phone_number_collection": { "description": "Controls phone number collection settings during checkout.\n\nWe recommend that you review your privacy policy and check with your legal contacts.", "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ], "title": "phone_number_collection_params", "type": "object" }, "restrictions": { "anyOf": [ { "properties": { "completed_sessions": { "properties": { "limit": { "type": "integer" } }, "required": [ "limit" ], "title": "completed_sessions_params", "type": "object" } }, "required": [ "completed_sessions" ], "title": "restrictions_params", "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Settings that restrict the usage of a payment link." }, "shipping_address_collection": { "anyOf": [ { "properties": { "allowed_countries": { "items": { "enum": [ "AC", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CV", "CW", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MK", "ML", "MM", "MN", "MO", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SZ", "TA", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VN", "VU", "WF", "WS", "XK", "YE", "YT", "ZA", "ZM", "ZW", "ZZ" ], "type": "string" }, "type": "array" } }, "required": [ "allowed_countries" ], "title": "shipping_address_collection_params", "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Configuration for collecting the customer's shipping address." }, "submit_type": { "description": "Describes the type of transaction being performed in order to customize relevant text on the page, such as the submit button. Changing this value will also affect the hostname in the [url](https://stripe.com/docs/api/payment_links/payment_links/object#url) property (example: `donate.stripe.com`).", "enum": [ "auto", "book", "donate", "pay", "subscribe" ], "type": "string" }, "subscription_data": { "description": "When creating a subscription, the specified configuration data will be used. There must be at least one line item with a recurring price to use `subscription_data`.", "properties": { "invoice_settings": { "properties": { "issuer": { "properties": { "account": { "type": "string" }, "type": { "enum": [ "account", "self" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "param", "type": "object" } }, "title": "subscription_data_invoice_settings_params", "type": "object" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "trial_period_days": { "anyOf": [ { "type": "integer" }, { "enum": [ "" ], "type": "string" } ] }, "trial_settings": { "anyOf": [ { "properties": { "end_behavior": { "properties": { "missing_payment_method": { "enum": [ "cancel", "create_invoice", "pause" ], "type": "string" } }, "required": [ "missing_payment_method" ], "title": "end_behavior", "type": "object" } }, "required": [ "end_behavior" ], "title": "trial_settings_config", "type": "object" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "subscription_data_update_params", "type": "object" }, "tax_id_collection": { "description": "Controls tax ID collection during checkout.", "properties": { "enabled": { "type": "boolean" }, "required": { "enum": [ "if_supported", "never" ], "type": "string" } }, "required": [ "enabled" ], "title": "tax_id_collection_params", "type": "object" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_link" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a payment link" } }, "/v1/payment_links/{payment_link}/line_items": { "get": { "description": "

When retrieving a payment link, 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.

", "operationId": "GetPaymentLinksPaymentLinkLineItems", "parameters": [ { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "in": "path", "name": "payment_link", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/item" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "PaymentLinksResourceListLineItems", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a payment link's line items" } }, "/v1/payment_method_configurations": { "get": { "description": "

List payment method configurations

", "operationId": "GetPaymentMethodConfigurations", "parameters": [ { "description": "The Connect application to filter by.", "explode": true, "in": "query", "name": "application", "required": false, "schema": { "anyOf": [ { "maxLength": 100, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "style": "deepObject" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/payment_method_configuration" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/payment_method_configurations", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "PaymentMethodConfigResourcePaymentMethodConfigurationsList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List payment method configurations" }, "post": { "description": "

Creates a payment method configuration

", "operationId": "PostPaymentMethodConfigurations", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "acss_debit": { "explode": true, "style": "deepObject" }, "affirm": { "explode": true, "style": "deepObject" }, "afterpay_clearpay": { "explode": true, "style": "deepObject" }, "alipay": { "explode": true, "style": "deepObject" }, "alma": { "explode": true, "style": "deepObject" }, "amazon_pay": { "explode": true, "style": "deepObject" }, "apple_pay": { "explode": true, "style": "deepObject" }, "apple_pay_later": { "explode": true, "style": "deepObject" }, "au_becs_debit": { "explode": true, "style": "deepObject" }, "bacs_debit": { "explode": true, "style": "deepObject" }, "bancontact": { "explode": true, "style": "deepObject" }, "billie": { "explode": true, "style": "deepObject" }, "blik": { "explode": true, "style": "deepObject" }, "boleto": { "explode": true, "style": "deepObject" }, "card": { "explode": true, "style": "deepObject" }, "cartes_bancaires": { "explode": true, "style": "deepObject" }, "cashapp": { "explode": true, "style": "deepObject" }, "customer_balance": { "explode": true, "style": "deepObject" }, "eps": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "fpx": { "explode": true, "style": "deepObject" }, "giropay": { "explode": true, "style": "deepObject" }, "google_pay": { "explode": true, "style": "deepObject" }, "grabpay": { "explode": true, "style": "deepObject" }, "ideal": { "explode": true, "style": "deepObject" }, "jcb": { "explode": true, "style": "deepObject" }, "kakao_pay": { "explode": true, "style": "deepObject" }, "klarna": { "explode": true, "style": "deepObject" }, "konbini": { "explode": true, "style": "deepObject" }, "kr_card": { "explode": true, "style": "deepObject" }, "link": { "explode": true, "style": "deepObject" }, "mobilepay": { "explode": true, "style": "deepObject" }, "multibanco": { "explode": true, "style": "deepObject" }, "naver_pay": { "explode": true, "style": "deepObject" }, "nz_bank_account": { "explode": true, "style": "deepObject" }, "oxxo": { "explode": true, "style": "deepObject" }, "p24": { "explode": true, "style": "deepObject" }, "pay_by_bank": { "explode": true, "style": "deepObject" }, "payco": { "explode": true, "style": "deepObject" }, "paynow": { "explode": true, "style": "deepObject" }, "paypal": { "explode": true, "style": "deepObject" }, "pix": { "explode": true, "style": "deepObject" }, "promptpay": { "explode": true, "style": "deepObject" }, "revolut_pay": { "explode": true, "style": "deepObject" }, "samsung_pay": { "explode": true, "style": "deepObject" }, "satispay": { "explode": true, "style": "deepObject" }, "sepa_debit": { "explode": true, "style": "deepObject" }, "sofort": { "explode": true, "style": "deepObject" }, "swish": { "explode": true, "style": "deepObject" }, "twint": { "explode": true, "style": "deepObject" }, "us_bank_account": { "explode": true, "style": "deepObject" }, "wechat_pay": { "explode": true, "style": "deepObject" }, "zip": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "acss_debit": { "description": "Canadian pre-authorized debit payments, check this [page](https://stripe.com/docs/payments/acss-debit) for more details like country availability.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "affirm": { "description": "[Affirm](https://www.affirm.com/) gives your customers a way to split purchases over a series of payments. Depending on the purchase, they can pay with four interest-free payments (Split Pay) or pay over a longer term (Installments), which might include interest. Check this [page](https://stripe.com/docs/payments/affirm) for more details like country availability.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "afterpay_clearpay": { "description": "Afterpay gives your customers a way to pay for purchases in installments, check this [page](https://stripe.com/docs/payments/afterpay-clearpay) for more details like country availability. Afterpay is particularly popular among businesses selling fashion, beauty, and sports products.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "alipay": { "description": "Alipay is a digital wallet in China that has more than a billion active users worldwide. Alipay users can pay on the web or on a mobile device using login credentials or their Alipay app. Alipay has a low dispute rate and reduces fraud by authenticating payments using the customer's login credentials. Check this [page](https://stripe.com/docs/payments/alipay) for more details.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "alma": { "description": "Alma is a Buy Now, Pay Later payment method that offers customers the ability to pay in 2, 3, or 4 installments.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "amazon_pay": { "description": "Amazon Pay is a wallet payment method that lets your customers check out the same way as on Amazon.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "apple_pay": { "description": "Stripe users can accept [Apple Pay](https://stripe.com/payments/apple-pay) in iOS applications in iOS 9 and later, and on the web in Safari starting with iOS 10 or macOS Sierra. There are no additional fees to process Apple Pay payments, and the [pricing](https://stripe.com/pricing) is the same as other card transactions. Check this [page](https://stripe.com/docs/apple-pay) for more details.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "apple_pay_later": { "description": "Apple Pay Later, a payment method for customers to buy now and pay later, gives your customers a way to split purchases into four installments across six weeks.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "au_becs_debit": { "description": "Stripe users in Australia can accept Bulk Electronic Clearing System (BECS) direct debit payments from customers with an Australian bank account. Check this [page](https://stripe.com/docs/payments/au-becs-debit) for more details.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "bacs_debit": { "description": "Stripe users in the UK can accept Bacs Direct Debit payments from customers with a UK bank account, check this [page](https://stripe.com/docs/payments/payment-methods/bacs-debit) for more details.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "bancontact": { "description": "Bancontact is the most popular online payment method in Belgium, with over 15 million cards in circulation. [Customers](https://stripe.com/docs/api/customers) use a Bancontact card or mobile app linked to a Belgian bank account to make online payments that are secure, guaranteed, and confirmed immediately. Check this [page](https://stripe.com/docs/payments/bancontact) for more details.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "billie": { "description": "Billie is a [single-use](https://docs.stripe.com/payments/payment-methods#usage) payment method that offers businesses Pay by Invoice where they offer payment terms ranging from 7-120 days. Customers are redirected from your website or app, authorize the payment with Billie, then return to your website or app. You get [immediate notification](/payments/payment-methods#payment-notification) of whether the payment succeeded or failed.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "blik": { "description": "BLIK is a [single use](https://stripe.com/docs/payments/payment-methods#usage) payment method that requires customers to authenticate their payments. When customers want to pay online using BLIK, they request a six-digit code from their banking application and enter it into the payment collection form. Check this [page](https://stripe.com/docs/payments/blik) for more details.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "boleto": { "description": "Boleto is an official (regulated by the Central Bank of Brazil) payment method in Brazil. Check this [page](https://stripe.com/docs/payments/boleto) for more details.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "card": { "description": "Cards are a popular way for consumers and businesses to pay online or in person. Stripe supports global and local card networks.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "cartes_bancaires": { "description": "Cartes Bancaires is France's local card network. More than 95% of these cards are co-branded with either Visa or Mastercard, meaning you can process these cards over either Cartes Bancaires or the Visa or Mastercard networks. Check this [page](https://stripe.com/docs/payments/cartes-bancaires) for more details.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "cashapp": { "description": "Cash App is a popular consumer app in the US that allows customers to bank, invest, send, and receive money using their digital wallet. Check this [page](https://stripe.com/docs/payments/cash-app-pay) for more details.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "customer_balance": { "description": "Uses a customer’s [cash balance](https://stripe.com/docs/payments/customer-balance) for the payment. The cash balance can be funded via a bank transfer. Check this [page](https://stripe.com/docs/payments/bank-transfers) for more details.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "eps": { "description": "EPS is an Austria-based payment method that allows customers to complete transactions online using their bank credentials. EPS is supported by all Austrian banks and is accepted by over 80% of Austrian online retailers. Check this [page](https://stripe.com/docs/payments/eps) for more details.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "fpx": { "description": "Financial Process Exchange (FPX) is a Malaysia-based payment method that allows customers to complete transactions online using their bank credentials. Bank Negara Malaysia (BNM), the Central Bank of Malaysia, and eleven other major Malaysian financial institutions are members of the PayNet Group, which owns and operates FPX. It is one of the most popular online payment methods in Malaysia, with nearly 90 million transactions in 2018 according to BNM. Check this [page](https://stripe.com/docs/payments/fpx) for more details.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "giropay": { "description": "giropay is a German payment method based on online banking, introduced in 2006. It allows customers to complete transactions online using their online banking environment, with funds debited from their bank account. Depending on their bank, customers confirm payments on giropay using a second factor of authentication or a PIN. giropay accounts for 10% of online checkouts in Germany. Check this [page](https://stripe.com/docs/payments/giropay) for more details.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "google_pay": { "description": "Google Pay allows customers to make payments in your app or website using any credit or debit card saved to their Google Account, including those from Google Play, YouTube, Chrome, or an Android device. Use the Google Pay API to request any credit or debit card stored in your customer's Google account. Check this [page](https://stripe.com/docs/google-pay) for more details.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "grabpay": { "description": "GrabPay is a payment method developed by [Grab](https://www.grab.com/sg/consumer/finance/pay/). GrabPay is a digital wallet - customers maintain a balance in their wallets that they pay out with. Check this [page](https://stripe.com/docs/payments/grabpay) for more details.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "ideal": { "description": "iDEAL is a Netherlands-based payment method that allows customers to complete transactions online using their bank credentials. All major Dutch banks are members of Currence, the scheme that operates iDEAL, making it the most popular online payment method in the Netherlands with a share of online transactions close to 55%. Check this [page](https://stripe.com/docs/payments/ideal) for more details.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "jcb": { "description": "JCB is a credit card company based in Japan. JCB is currently available in Japan to businesses approved by JCB, and available to all businesses in Australia, Canada, Hong Kong, Japan, New Zealand, Singapore, Switzerland, United Kingdom, United States, and all countries in the European Economic Area except Iceland. Check this [page](https://support.stripe.com/questions/accepting-japan-credit-bureau-%28jcb%29-payments) for more details.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "kakao_pay": { "description": "Kakao Pay is a popular local wallet available in South Korea.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "klarna": { "description": "Klarna gives customers a range of [payment options](https://stripe.com/docs/payments/klarna#payment-options) during checkout. Available payment options vary depending on the customer's billing address and the transaction amount. These payment options make it convenient for customers to purchase items in all price ranges. Check this [page](https://stripe.com/docs/payments/klarna) for more details.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "konbini": { "description": "Konbini allows customers in Japan to pay for bills and online purchases at convenience stores with cash. Check this [page](https://stripe.com/docs/payments/konbini) for more details.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "kr_card": { "description": "Korean cards let users pay using locally issued cards from South Korea.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "link": { "description": "[Link](https://stripe.com/docs/payments/link) is a payment method network. With Link, users save their payment details once, then reuse that information to pay with one click for any business on the network.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "mobilepay": { "description": "MobilePay is a [single-use](https://stripe.com/docs/payments/payment-methods#usage) card wallet payment method used in Denmark and Finland. It allows customers to [authenticate and approve](https://stripe.com/docs/payments/payment-methods#customer-actions) payments using the MobilePay app. Check this [page](https://stripe.com/docs/payments/mobilepay) for more details.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "multibanco": { "description": "Stripe users in Europe and the United States can accept Multibanco payments from customers in Portugal using [Sources](https://stripe.com/docs/sources)—a single integration path for creating payments using any supported method.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "name": { "description": "Configuration name.", "maxLength": 100, "type": "string" }, "naver_pay": { "description": "Naver Pay is a popular local wallet available in South Korea.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "nz_bank_account": { "description": "Stripe users in New Zealand can accept Bulk Electronic Clearing System (BECS) direct debit payments from customers with a New Zeland bank account. Check this [page](https://stripe.com/docs/payments/nz-bank-account) for more details.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "oxxo": { "description": "OXXO is a Mexican chain of convenience stores with thousands of locations across Latin America and represents nearly 20% of online transactions in Mexico. OXXO allows customers to pay bills and online purchases in-store with cash. Check this [page](https://stripe.com/docs/payments/oxxo) for more details.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "p24": { "description": "Przelewy24 is a Poland-based payment method aggregator that allows customers to complete transactions online using bank transfers and other methods. Bank transfers account for 30% of online payments in Poland and Przelewy24 provides a way for customers to pay with over 165 banks. Check this [page](https://stripe.com/docs/payments/p24) for more details.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "parent": { "description": "Configuration's parent configuration. Specify to create a child configuration.", "maxLength": 100, "type": "string" }, "pay_by_bank": { "description": "Pay by bank is a redirect payment method backed by bank transfers. A customer is redirected to their bank to authorize a bank transfer for a given amount. This removes a lot of the error risks inherent in waiting for the customer to initiate a transfer themselves, and is less expensive than card payments.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "payco": { "description": "PAYCO is a [single-use](https://docs.stripe.com/payments/payment-methods#usage local wallet available in South Korea.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "paynow": { "description": "PayNow is a Singapore-based payment method that allows customers to make a payment using their preferred app from participating banks and participating non-bank financial institutions. Check this [page](https://stripe.com/docs/payments/paynow) for more details.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "paypal": { "description": "PayPal, a digital wallet popular with customers in Europe, allows your customers worldwide to pay using their PayPal account. Check this [page](https://stripe.com/docs/payments/paypal) for more details.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "pix": { "description": "Pix is a payment method popular in Brazil. When paying with Pix, customers authenticate and approve payments by scanning a QR code in their preferred banking app. Check this [page](https://docs.stripe.com/payments/pix) for more details.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "promptpay": { "description": "PromptPay is a Thailand-based payment method that allows customers to make a payment using their preferred app from participating banks. Check this [page](https://stripe.com/docs/payments/promptpay) for more details.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "revolut_pay": { "description": "Revolut Pay, developed by Revolut, a global finance app, is a digital wallet payment method. Revolut Pay uses the customer’s stored balance or cards to fund the payment, and offers the option for non-Revolut customers to save their details after their first purchase.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "samsung_pay": { "description": "Samsung Pay is a [single-use](https://docs.stripe.com/payments/payment-methods#usage local wallet available in South Korea.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "satispay": { "description": "Satispay is a [single-use](https://docs.stripe.com/payments/payment-methods#usage) payment method where customers are required to [authenticate](/payments/payment-methods#customer-actions) their payment. Customers pay by being redirected from your website or app, authorizing the payment with Satispay, then returning to your website or app. You get [immediate notification](/payments/payment-methods#payment-notification) of whether the payment succeeded or failed.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "sepa_debit": { "description": "The [Single Euro Payments Area (SEPA)](https://en.wikipedia.org/wiki/Single_Euro_Payments_Area) is an initiative of the European Union to simplify payments within and across member countries. SEPA established and enforced banking standards to allow for the direct debiting of every EUR-denominated bank account within the SEPA region, check this [page](https://stripe.com/docs/payments/sepa-debit) for more details.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "sofort": { "description": "Stripe users in Europe and the United States can use the [Payment Intents API](https://stripe.com/docs/payments/payment-intents)—a single integration path for creating payments using any supported method—to accept [Sofort](https://www.sofort.com/) payments from customers. Check this [page](https://stripe.com/docs/payments/sofort) for more details.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "swish": { "description": "Swish is a [real-time](https://stripe.com/docs/payments/real-time) payment method popular in Sweden. It allows customers to [authenticate and approve](https://stripe.com/docs/payments/payment-methods#customer-actions) payments using the Swish mobile app and the Swedish BankID mobile app. Check this [page](https://stripe.com/docs/payments/swish) for more details.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "twint": { "description": "Twint is a payment method popular in Switzerland. It allows customers to pay using their mobile phone. Check this [page](https://docs.stripe.com/payments/twint) for more details.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "us_bank_account": { "description": "Stripe users in the United States can accept ACH direct debit payments from customers with a US bank account using the Automated Clearing House (ACH) payments system operated by Nacha. Check this [page](https://stripe.com/docs/payments/ach-direct-debit) for more details.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "wechat_pay": { "description": "WeChat, owned by Tencent, is China's leading mobile app with over 1 billion monthly active users. Chinese consumers can use WeChat Pay to pay for goods and services inside of businesses' apps and websites. WeChat Pay users buy most frequently in gaming, e-commerce, travel, online education, and food/nutrition. Check this [page](https://stripe.com/docs/payments/wechat-pay) for more details.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "zip": { "description": "Zip gives your customers a way to split purchases over a series of payments. Check this [page](https://stripe.com/docs/payments/zip) for more details like country availability.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_method_configuration" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a payment method configuration" } }, "/v1/payment_method_configurations/{configuration}": { "get": { "description": "

Retrieve payment method configuration

", "operationId": "GetPaymentMethodConfigurationsConfiguration", "parameters": [ { "in": "path", "name": "configuration", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_method_configuration" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve payment method configuration" }, "post": { "description": "

Update payment method configuration

", "operationId": "PostPaymentMethodConfigurationsConfiguration", "parameters": [ { "in": "path", "name": "configuration", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "acss_debit": { "explode": true, "style": "deepObject" }, "affirm": { "explode": true, "style": "deepObject" }, "afterpay_clearpay": { "explode": true, "style": "deepObject" }, "alipay": { "explode": true, "style": "deepObject" }, "alma": { "explode": true, "style": "deepObject" }, "amazon_pay": { "explode": true, "style": "deepObject" }, "apple_pay": { "explode": true, "style": "deepObject" }, "apple_pay_later": { "explode": true, "style": "deepObject" }, "au_becs_debit": { "explode": true, "style": "deepObject" }, "bacs_debit": { "explode": true, "style": "deepObject" }, "bancontact": { "explode": true, "style": "deepObject" }, "billie": { "explode": true, "style": "deepObject" }, "blik": { "explode": true, "style": "deepObject" }, "boleto": { "explode": true, "style": "deepObject" }, "card": { "explode": true, "style": "deepObject" }, "cartes_bancaires": { "explode": true, "style": "deepObject" }, "cashapp": { "explode": true, "style": "deepObject" }, "customer_balance": { "explode": true, "style": "deepObject" }, "eps": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "fpx": { "explode": true, "style": "deepObject" }, "giropay": { "explode": true, "style": "deepObject" }, "google_pay": { "explode": true, "style": "deepObject" }, "grabpay": { "explode": true, "style": "deepObject" }, "ideal": { "explode": true, "style": "deepObject" }, "jcb": { "explode": true, "style": "deepObject" }, "kakao_pay": { "explode": true, "style": "deepObject" }, "klarna": { "explode": true, "style": "deepObject" }, "konbini": { "explode": true, "style": "deepObject" }, "kr_card": { "explode": true, "style": "deepObject" }, "link": { "explode": true, "style": "deepObject" }, "mobilepay": { "explode": true, "style": "deepObject" }, "multibanco": { "explode": true, "style": "deepObject" }, "naver_pay": { "explode": true, "style": "deepObject" }, "nz_bank_account": { "explode": true, "style": "deepObject" }, "oxxo": { "explode": true, "style": "deepObject" }, "p24": { "explode": true, "style": "deepObject" }, "pay_by_bank": { "explode": true, "style": "deepObject" }, "payco": { "explode": true, "style": "deepObject" }, "paynow": { "explode": true, "style": "deepObject" }, "paypal": { "explode": true, "style": "deepObject" }, "pix": { "explode": true, "style": "deepObject" }, "promptpay": { "explode": true, "style": "deepObject" }, "revolut_pay": { "explode": true, "style": "deepObject" }, "samsung_pay": { "explode": true, "style": "deepObject" }, "satispay": { "explode": true, "style": "deepObject" }, "sepa_debit": { "explode": true, "style": "deepObject" }, "sofort": { "explode": true, "style": "deepObject" }, "swish": { "explode": true, "style": "deepObject" }, "twint": { "explode": true, "style": "deepObject" }, "us_bank_account": { "explode": true, "style": "deepObject" }, "wechat_pay": { "explode": true, "style": "deepObject" }, "zip": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "acss_debit": { "description": "Canadian pre-authorized debit payments, check this [page](https://stripe.com/docs/payments/acss-debit) for more details like country availability.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "active": { "description": "Whether the configuration can be used for new payments.", "type": "boolean" }, "affirm": { "description": "[Affirm](https://www.affirm.com/) gives your customers a way to split purchases over a series of payments. Depending on the purchase, they can pay with four interest-free payments (Split Pay) or pay over a longer term (Installments), which might include interest. Check this [page](https://stripe.com/docs/payments/affirm) for more details like country availability.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "afterpay_clearpay": { "description": "Afterpay gives your customers a way to pay for purchases in installments, check this [page](https://stripe.com/docs/payments/afterpay-clearpay) for more details like country availability. Afterpay is particularly popular among businesses selling fashion, beauty, and sports products.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "alipay": { "description": "Alipay is a digital wallet in China that has more than a billion active users worldwide. Alipay users can pay on the web or on a mobile device using login credentials or their Alipay app. Alipay has a low dispute rate and reduces fraud by authenticating payments using the customer's login credentials. Check this [page](https://stripe.com/docs/payments/alipay) for more details.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "alma": { "description": "Alma is a Buy Now, Pay Later payment method that offers customers the ability to pay in 2, 3, or 4 installments.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "amazon_pay": { "description": "Amazon Pay is a wallet payment method that lets your customers check out the same way as on Amazon.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "apple_pay": { "description": "Stripe users can accept [Apple Pay](https://stripe.com/payments/apple-pay) in iOS applications in iOS 9 and later, and on the web in Safari starting with iOS 10 or macOS Sierra. There are no additional fees to process Apple Pay payments, and the [pricing](https://stripe.com/pricing) is the same as other card transactions. Check this [page](https://stripe.com/docs/apple-pay) for more details.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "apple_pay_later": { "description": "Apple Pay Later, a payment method for customers to buy now and pay later, gives your customers a way to split purchases into four installments across six weeks.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "au_becs_debit": { "description": "Stripe users in Australia can accept Bulk Electronic Clearing System (BECS) direct debit payments from customers with an Australian bank account. Check this [page](https://stripe.com/docs/payments/au-becs-debit) for more details.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "bacs_debit": { "description": "Stripe users in the UK can accept Bacs Direct Debit payments from customers with a UK bank account, check this [page](https://stripe.com/docs/payments/payment-methods/bacs-debit) for more details.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "bancontact": { "description": "Bancontact is the most popular online payment method in Belgium, with over 15 million cards in circulation. [Customers](https://stripe.com/docs/api/customers) use a Bancontact card or mobile app linked to a Belgian bank account to make online payments that are secure, guaranteed, and confirmed immediately. Check this [page](https://stripe.com/docs/payments/bancontact) for more details.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "billie": { "description": "Billie is a [single-use](https://docs.stripe.com/payments/payment-methods#usage) payment method that offers businesses Pay by Invoice where they offer payment terms ranging from 7-120 days. Customers are redirected from your website or app, authorize the payment with Billie, then return to your website or app. You get [immediate notification](/payments/payment-methods#payment-notification) of whether the payment succeeded or failed.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "blik": { "description": "BLIK is a [single use](https://stripe.com/docs/payments/payment-methods#usage) payment method that requires customers to authenticate their payments. When customers want to pay online using BLIK, they request a six-digit code from their banking application and enter it into the payment collection form. Check this [page](https://stripe.com/docs/payments/blik) for more details.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "boleto": { "description": "Boleto is an official (regulated by the Central Bank of Brazil) payment method in Brazil. Check this [page](https://stripe.com/docs/payments/boleto) for more details.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "card": { "description": "Cards are a popular way for consumers and businesses to pay online or in person. Stripe supports global and local card networks.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "cartes_bancaires": { "description": "Cartes Bancaires is France's local card network. More than 95% of these cards are co-branded with either Visa or Mastercard, meaning you can process these cards over either Cartes Bancaires or the Visa or Mastercard networks. Check this [page](https://stripe.com/docs/payments/cartes-bancaires) for more details.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "cashapp": { "description": "Cash App is a popular consumer app in the US that allows customers to bank, invest, send, and receive money using their digital wallet. Check this [page](https://stripe.com/docs/payments/cash-app-pay) for more details.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "customer_balance": { "description": "Uses a customer’s [cash balance](https://stripe.com/docs/payments/customer-balance) for the payment. The cash balance can be funded via a bank transfer. Check this [page](https://stripe.com/docs/payments/bank-transfers) for more details.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "eps": { "description": "EPS is an Austria-based payment method that allows customers to complete transactions online using their bank credentials. EPS is supported by all Austrian banks and is accepted by over 80% of Austrian online retailers. Check this [page](https://stripe.com/docs/payments/eps) for more details.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "fpx": { "description": "Financial Process Exchange (FPX) is a Malaysia-based payment method that allows customers to complete transactions online using their bank credentials. Bank Negara Malaysia (BNM), the Central Bank of Malaysia, and eleven other major Malaysian financial institutions are members of the PayNet Group, which owns and operates FPX. It is one of the most popular online payment methods in Malaysia, with nearly 90 million transactions in 2018 according to BNM. Check this [page](https://stripe.com/docs/payments/fpx) for more details.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "giropay": { "description": "giropay is a German payment method based on online banking, introduced in 2006. It allows customers to complete transactions online using their online banking environment, with funds debited from their bank account. Depending on their bank, customers confirm payments on giropay using a second factor of authentication or a PIN. giropay accounts for 10% of online checkouts in Germany. Check this [page](https://stripe.com/docs/payments/giropay) for more details.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "google_pay": { "description": "Google Pay allows customers to make payments in your app or website using any credit or debit card saved to their Google Account, including those from Google Play, YouTube, Chrome, or an Android device. Use the Google Pay API to request any credit or debit card stored in your customer's Google account. Check this [page](https://stripe.com/docs/google-pay) for more details.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "grabpay": { "description": "GrabPay is a payment method developed by [Grab](https://www.grab.com/sg/consumer/finance/pay/). GrabPay is a digital wallet - customers maintain a balance in their wallets that they pay out with. Check this [page](https://stripe.com/docs/payments/grabpay) for more details.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "ideal": { "description": "iDEAL is a Netherlands-based payment method that allows customers to complete transactions online using their bank credentials. All major Dutch banks are members of Currence, the scheme that operates iDEAL, making it the most popular online payment method in the Netherlands with a share of online transactions close to 55%. Check this [page](https://stripe.com/docs/payments/ideal) for more details.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "jcb": { "description": "JCB is a credit card company based in Japan. JCB is currently available in Japan to businesses approved by JCB, and available to all businesses in Australia, Canada, Hong Kong, Japan, New Zealand, Singapore, Switzerland, United Kingdom, United States, and all countries in the European Economic Area except Iceland. Check this [page](https://support.stripe.com/questions/accepting-japan-credit-bureau-%28jcb%29-payments) for more details.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "kakao_pay": { "description": "Kakao Pay is a popular local wallet available in South Korea.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "klarna": { "description": "Klarna gives customers a range of [payment options](https://stripe.com/docs/payments/klarna#payment-options) during checkout. Available payment options vary depending on the customer's billing address and the transaction amount. These payment options make it convenient for customers to purchase items in all price ranges. Check this [page](https://stripe.com/docs/payments/klarna) for more details.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "konbini": { "description": "Konbini allows customers in Japan to pay for bills and online purchases at convenience stores with cash. Check this [page](https://stripe.com/docs/payments/konbini) for more details.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "kr_card": { "description": "Korean cards let users pay using locally issued cards from South Korea.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "link": { "description": "[Link](https://stripe.com/docs/payments/link) is a payment method network. With Link, users save their payment details once, then reuse that information to pay with one click for any business on the network.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "mobilepay": { "description": "MobilePay is a [single-use](https://stripe.com/docs/payments/payment-methods#usage) card wallet payment method used in Denmark and Finland. It allows customers to [authenticate and approve](https://stripe.com/docs/payments/payment-methods#customer-actions) payments using the MobilePay app. Check this [page](https://stripe.com/docs/payments/mobilepay) for more details.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "multibanco": { "description": "Stripe users in Europe and the United States can accept Multibanco payments from customers in Portugal using [Sources](https://stripe.com/docs/sources)—a single integration path for creating payments using any supported method.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "name": { "description": "Configuration name.", "maxLength": 100, "type": "string" }, "naver_pay": { "description": "Naver Pay is a popular local wallet available in South Korea.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "nz_bank_account": { "description": "Stripe users in New Zealand can accept Bulk Electronic Clearing System (BECS) direct debit payments from customers with a New Zeland bank account. Check this [page](https://stripe.com/docs/payments/nz-bank-account) for more details.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "oxxo": { "description": "OXXO is a Mexican chain of convenience stores with thousands of locations across Latin America and represents nearly 20% of online transactions in Mexico. OXXO allows customers to pay bills and online purchases in-store with cash. Check this [page](https://stripe.com/docs/payments/oxxo) for more details.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "p24": { "description": "Przelewy24 is a Poland-based payment method aggregator that allows customers to complete transactions online using bank transfers and other methods. Bank transfers account for 30% of online payments in Poland and Przelewy24 provides a way for customers to pay with over 165 banks. Check this [page](https://stripe.com/docs/payments/p24) for more details.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "pay_by_bank": { "description": "Pay by bank is a redirect payment method backed by bank transfers. A customer is redirected to their bank to authorize a bank transfer for a given amount. This removes a lot of the error risks inherent in waiting for the customer to initiate a transfer themselves, and is less expensive than card payments.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "payco": { "description": "PAYCO is a [single-use](https://docs.stripe.com/payments/payment-methods#usage local wallet available in South Korea.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "paynow": { "description": "PayNow is a Singapore-based payment method that allows customers to make a payment using their preferred app from participating banks and participating non-bank financial institutions. Check this [page](https://stripe.com/docs/payments/paynow) for more details.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "paypal": { "description": "PayPal, a digital wallet popular with customers in Europe, allows your customers worldwide to pay using their PayPal account. Check this [page](https://stripe.com/docs/payments/paypal) for more details.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "pix": { "description": "Pix is a payment method popular in Brazil. When paying with Pix, customers authenticate and approve payments by scanning a QR code in their preferred banking app. Check this [page](https://docs.stripe.com/payments/pix) for more details.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "promptpay": { "description": "PromptPay is a Thailand-based payment method that allows customers to make a payment using their preferred app from participating banks. Check this [page](https://stripe.com/docs/payments/promptpay) for more details.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "revolut_pay": { "description": "Revolut Pay, developed by Revolut, a global finance app, is a digital wallet payment method. Revolut Pay uses the customer’s stored balance or cards to fund the payment, and offers the option for non-Revolut customers to save their details after their first purchase.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "samsung_pay": { "description": "Samsung Pay is a [single-use](https://docs.stripe.com/payments/payment-methods#usage local wallet available in South Korea.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "satispay": { "description": "Satispay is a [single-use](https://docs.stripe.com/payments/payment-methods#usage) payment method where customers are required to [authenticate](/payments/payment-methods#customer-actions) their payment. Customers pay by being redirected from your website or app, authorizing the payment with Satispay, then returning to your website or app. You get [immediate notification](/payments/payment-methods#payment-notification) of whether the payment succeeded or failed.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "sepa_debit": { "description": "The [Single Euro Payments Area (SEPA)](https://en.wikipedia.org/wiki/Single_Euro_Payments_Area) is an initiative of the European Union to simplify payments within and across member countries. SEPA established and enforced banking standards to allow for the direct debiting of every EUR-denominated bank account within the SEPA region, check this [page](https://stripe.com/docs/payments/sepa-debit) for more details.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "sofort": { "description": "Stripe users in Europe and the United States can use the [Payment Intents API](https://stripe.com/docs/payments/payment-intents)—a single integration path for creating payments using any supported method—to accept [Sofort](https://www.sofort.com/) payments from customers. Check this [page](https://stripe.com/docs/payments/sofort) for more details.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "swish": { "description": "Swish is a [real-time](https://stripe.com/docs/payments/real-time) payment method popular in Sweden. It allows customers to [authenticate and approve](https://stripe.com/docs/payments/payment-methods#customer-actions) payments using the Swish mobile app and the Swedish BankID mobile app. Check this [page](https://stripe.com/docs/payments/swish) for more details.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "twint": { "description": "Twint is a payment method popular in Switzerland. It allows customers to pay using their mobile phone. Check this [page](https://docs.stripe.com/payments/twint) for more details.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "us_bank_account": { "description": "Stripe users in the United States can accept ACH direct debit payments from customers with a US bank account using the Automated Clearing House (ACH) payments system operated by Nacha. Check this [page](https://stripe.com/docs/payments/ach-direct-debit) for more details.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "wechat_pay": { "description": "WeChat, owned by Tencent, is China's leading mobile app with over 1 billion monthly active users. Chinese consumers can use WeChat Pay to pay for goods and services inside of businesses' apps and websites. WeChat Pay users buy most frequently in gaming, e-commerce, travel, online education, and food/nutrition. Check this [page](https://stripe.com/docs/payments/wechat-pay) for more details.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" }, "zip": { "description": "Zip gives your customers a way to split purchases over a series of payments. Check this [page](https://stripe.com/docs/payments/zip) for more details like country availability.", "properties": { "display_preference": { "properties": { "preference": { "enum": [ "none", "off", "on" ], "type": "string" } }, "title": "display_preference_param", "type": "object" } }, "title": "payment_method_param", "type": "object" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_method_configuration" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update payment method configuration" } }, "/v1/payment_method_domains": { "get": { "description": "

Lists the details of existing payment method domains.

", "operationId": "GetPaymentMethodDomains", "parameters": [ { "description": "The domain name that this payment method domain object represents.", "in": "query", "name": "domain_name", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Whether this payment method domain is enabled. If the domain is not enabled, payment methods will not appear in Elements or Embedded Checkout", "in": "query", "name": "enabled", "required": false, "schema": { "type": "boolean" }, "style": "form" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/payment_method_domain" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/payment_method_domains", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "PaymentMethodDomainResourcePaymentMethodDomainList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List payment method domains" }, "post": { "description": "

Creates a payment method domain.

", "operationId": "PostPaymentMethodDomains", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "domain_name": { "description": "The domain name that this payment method domain object represents.", "maxLength": 5000, "type": "string" }, "enabled": { "description": "Whether this payment method domain is enabled. If the domain is not enabled, payment methods that require a payment method domain will not appear in Elements or Embedded Checkout.", "type": "boolean" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "required": [ "domain_name" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_method_domain" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a payment method domain" } }, "/v1/payment_method_domains/{payment_method_domain}": { "get": { "description": "

Retrieves the details of an existing payment method domain.

", "operationId": "GetPaymentMethodDomainsPaymentMethodDomain", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "payment_method_domain", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_method_domain" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a payment method domain" }, "post": { "description": "

Updates an existing payment method domain.

", "operationId": "PostPaymentMethodDomainsPaymentMethodDomain", "parameters": [ { "in": "path", "name": "payment_method_domain", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "enabled": { "description": "Whether this payment method domain is enabled. If the domain is not enabled, payment methods that require a payment method domain will not appear in Elements or Embedded Checkout.", "type": "boolean" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_method_domain" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a payment method domain" } }, "/v1/payment_method_domains/{payment_method_domain}/validate": { "post": { "description": "

Some payment methods might require additional steps to register a domain. If the requirements weren’t satisfied when the domain was created, the payment method will be inactive on the domain.\nThe payment method doesn’t appear in Elements or Embedded Checkout for this domain until it is active.

\n\n

To activate a payment method on an existing payment method domain, complete the required registration steps specific to the payment method, and then validate the payment method domain with this endpoint.

\n\n

Related guides: Payment method domains.

", "operationId": "PostPaymentMethodDomainsPaymentMethodDomainValidate", "parameters": [ { "in": "path", "name": "payment_method_domain", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_method_domain" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Validate an existing payment method domain" } }, "/v1/payment_methods": { "get": { "description": "

Returns a list of PaymentMethods for Treasury flows. If you want to list the PaymentMethods attached to a Customer for payments, you should use the List a Customer’s PaymentMethods API instead.

", "operationId": "GetPaymentMethods", "parameters": [ { "description": "The ID of the customer whose PaymentMethods will be retrieved.", "in": "query", "name": "customer", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "An optional filter on the list, based on the object `type` field. Without the filter, the list includes all current and future payment method types. If your integration expects only one type of payment method in the response, make sure to provide a type value in the request.", "in": "query", "name": "type", "required": false, "schema": { "enum": [ "acss_debit", "affirm", "afterpay_clearpay", "alipay", "alma", "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", "billie", "blik", "boleto", "card", "cashapp", "crypto", "customer_balance", "eps", "fpx", "giropay", "grabpay", "ideal", "kakao_pay", "klarna", "konbini", "kr_card", "link", "mobilepay", "multibanco", "naver_pay", "nz_bank_account", "oxxo", "p24", "pay_by_bank", "payco", "paynow", "paypal", "pix", "promptpay", "revolut_pay", "samsung_pay", "satispay", "sepa_debit", "sofort", "swish", "twint", "us_bank_account", "wechat_pay", "zip" ], "type": "string", "x-stripeBypassValidation": true }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/payment_method" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/payment_methods", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "PaymentFlowsPaymentMethodList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List PaymentMethods" }, "post": { "description": "

Creates a PaymentMethod object. Read the Stripe.js reference to learn how to create PaymentMethods via Stripe.js.

\n\n

Instead of creating a PaymentMethod directly, we recommend using the PaymentIntents API to accept a payment immediately or the SetupIntent API to collect payment method details ahead of a future payment.

", "operationId": "PostPaymentMethods", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "acss_debit": { "explode": true, "style": "deepObject" }, "affirm": { "explode": true, "style": "deepObject" }, "afterpay_clearpay": { "explode": true, "style": "deepObject" }, "alipay": { "explode": true, "style": "deepObject" }, "alma": { "explode": true, "style": "deepObject" }, "amazon_pay": { "explode": true, "style": "deepObject" }, "au_becs_debit": { "explode": true, "style": "deepObject" }, "bacs_debit": { "explode": true, "style": "deepObject" }, "bancontact": { "explode": true, "style": "deepObject" }, "billie": { "explode": true, "style": "deepObject" }, "billing_details": { "explode": true, "style": "deepObject" }, "blik": { "explode": true, "style": "deepObject" }, "boleto": { "explode": true, "style": "deepObject" }, "card": { "explode": true, "style": "deepObject" }, "cashapp": { "explode": true, "style": "deepObject" }, "crypto": { "explode": true, "style": "deepObject" }, "customer_balance": { "explode": true, "style": "deepObject" }, "eps": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "fpx": { "explode": true, "style": "deepObject" }, "giropay": { "explode": true, "style": "deepObject" }, "grabpay": { "explode": true, "style": "deepObject" }, "ideal": { "explode": true, "style": "deepObject" }, "interac_present": { "explode": true, "style": "deepObject" }, "kakao_pay": { "explode": true, "style": "deepObject" }, "klarna": { "explode": true, "style": "deepObject" }, "konbini": { "explode": true, "style": "deepObject" }, "kr_card": { "explode": true, "style": "deepObject" }, "link": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "mobilepay": { "explode": true, "style": "deepObject" }, "multibanco": { "explode": true, "style": "deepObject" }, "naver_pay": { "explode": true, "style": "deepObject" }, "nz_bank_account": { "explode": true, "style": "deepObject" }, "oxxo": { "explode": true, "style": "deepObject" }, "p24": { "explode": true, "style": "deepObject" }, "pay_by_bank": { "explode": true, "style": "deepObject" }, "payco": { "explode": true, "style": "deepObject" }, "paynow": { "explode": true, "style": "deepObject" }, "paypal": { "explode": true, "style": "deepObject" }, "pix": { "explode": true, "style": "deepObject" }, "promptpay": { "explode": true, "style": "deepObject" }, "radar_options": { "explode": true, "style": "deepObject" }, "revolut_pay": { "explode": true, "style": "deepObject" }, "samsung_pay": { "explode": true, "style": "deepObject" }, "satispay": { "explode": true, "style": "deepObject" }, "sepa_debit": { "explode": true, "style": "deepObject" }, "sofort": { "explode": true, "style": "deepObject" }, "swish": { "explode": true, "style": "deepObject" }, "twint": { "explode": true, "style": "deepObject" }, "us_bank_account": { "explode": true, "style": "deepObject" }, "wechat_pay": { "explode": true, "style": "deepObject" }, "zip": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "acss_debit": { "description": "If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method.", "properties": { "account_number": { "maxLength": 5000, "type": "string" }, "institution_number": { "maxLength": 5000, "type": "string" }, "transit_number": { "maxLength": 5000, "type": "string" } }, "required": [ "account_number", "institution_number", "transit_number" ], "title": "payment_method_param", "type": "object" }, "affirm": { "description": "If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method.", "properties": {}, "title": "param", "type": "object" }, "afterpay_clearpay": { "description": "If this is an `AfterpayClearpay` PaymentMethod, this hash contains details about the AfterpayClearpay payment method.", "properties": {}, "title": "param", "type": "object" }, "alipay": { "description": "If this is an `Alipay` PaymentMethod, this hash contains details about the Alipay payment method.", "properties": {}, "title": "param", "type": "object" }, "allow_redisplay": { "description": "This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to `unspecified`.", "enum": [ "always", "limited", "unspecified" ], "type": "string" }, "alma": { "description": "If this is a Alma PaymentMethod, this hash contains details about the Alma payment method.", "properties": {}, "title": "param", "type": "object" }, "amazon_pay": { "description": "If this is a AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method.", "properties": {}, "title": "param", "type": "object" }, "au_becs_debit": { "description": "If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account.", "properties": { "account_number": { "maxLength": 5000, "type": "string" }, "bsb_number": { "maxLength": 5000, "type": "string" } }, "required": [ "account_number", "bsb_number" ], "title": "param", "type": "object" }, "bacs_debit": { "description": "If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.", "properties": { "account_number": { "maxLength": 5000, "type": "string" }, "sort_code": { "maxLength": 5000, "type": "string" } }, "title": "param", "type": "object" }, "bancontact": { "description": "If this is a `bancontact` PaymentMethod, this hash contains details about the Bancontact payment method.", "properties": {}, "title": "param", "type": "object" }, "billie": { "description": "If this is a `billie` PaymentMethod, this hash contains details about the Billie payment method.", "properties": {}, "title": "param", "type": "object" }, "billing_details": { "description": "Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.", "properties": { "address": { "anyOf": [ { "properties": { "city": { "maxLength": 5000, "type": "string" }, "country": { "maxLength": 5000, "type": "string" }, "line1": { "maxLength": 5000, "type": "string" }, "line2": { "maxLength": 5000, "type": "string" }, "postal_code": { "maxLength": 5000, "type": "string" }, "state": { "maxLength": 5000, "type": "string" } }, "title": "billing_details_address", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "email": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "name": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "phone": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "tax_id": { "maxLength": 5000, "type": "string" } }, "title": "billing_details_inner_params", "type": "object" }, "blik": { "description": "If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.", "properties": {}, "title": "param", "type": "object" }, "boleto": { "description": "If this is a `boleto` PaymentMethod, this hash contains details about the Boleto payment method.", "properties": { "tax_id": { "maxLength": 5000, "type": "string" } }, "required": [ "tax_id" ], "title": "param", "type": "object" }, "card": { "anyOf": [ { "properties": { "cvc": { "maxLength": 5000, "type": "string" }, "exp_month": { "type": "integer" }, "exp_year": { "type": "integer" }, "networks": { "properties": { "preferred": { "enum": [ "cartes_bancaires", "mastercard", "visa" ], "type": "string" } }, "title": "networks_params", "type": "object" }, "number": { "maxLength": 5000, "type": "string" } }, "required": [ "exp_month", "exp_year", "number" ], "title": "card_details_params", "type": "object" }, { "properties": { "token": { "maxLength": 5000, "type": "string" } }, "required": [ "token" ], "title": "token_params", "type": "object" } ], "description": "If this is a `card` PaymentMethod, this hash contains the user's card details. For backwards compatibility, you can alternatively provide a Stripe token (e.g., for Apple Pay, Amex Express Checkout, or legacy Checkout) into the card hash with format `card: {token: \"tok_visa\"}`. When providing a card number, you must meet the requirements for [PCI compliance](https://stripe.com/docs/security#validating-pci-compliance). We strongly recommend using Stripe.js instead of interacting with this API directly.", "x-stripeBypassValidation": true }, "cashapp": { "description": "If this is a `cashapp` PaymentMethod, this hash contains details about the Cash App Pay payment method.", "properties": {}, "title": "param", "type": "object" }, "crypto": { "description": "If this is a Crypto PaymentMethod, this hash contains details about the Crypto payment method.", "properties": {}, "title": "param", "type": "object" }, "customer": { "description": "The `Customer` to whom the original PaymentMethod is attached.", "maxLength": 5000, "type": "string" }, "customer_balance": { "description": "If this is a `customer_balance` PaymentMethod, this hash contains details about the CustomerBalance payment method.", "properties": {}, "title": "param", "type": "object" }, "eps": { "description": "If this is an `eps` PaymentMethod, this hash contains details about the EPS payment method.", "properties": { "bank": { "enum": [ "arzte_und_apotheker_bank", "austrian_anadi_bank_ag", "bank_austria", "bankhaus_carl_spangler", "bankhaus_schelhammer_und_schattera_ag", "bawag_psk_ag", "bks_bank_ag", "brull_kallmus_bank_ag", "btv_vier_lander_bank", "capital_bank_grawe_gruppe_ag", "deutsche_bank_ag", "dolomitenbank", "easybank_ag", "erste_bank_und_sparkassen", "hypo_alpeadriabank_international_ag", "hypo_bank_burgenland_aktiengesellschaft", "hypo_noe_lb_fur_niederosterreich_u_wien", "hypo_oberosterreich_salzburg_steiermark", "hypo_tirol_bank_ag", "hypo_vorarlberg_bank_ag", "marchfelder_bank", "oberbank_ag", "raiffeisen_bankengruppe_osterreich", "schoellerbank_ag", "sparda_bank_wien", "volksbank_gruppe", "volkskreditbank_ag", "vr_bank_braunau" ], "maxLength": 5000, "type": "string" } }, "title": "param", "type": "object" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "fpx": { "description": "If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method.", "properties": { "bank": { "enum": [ "affin_bank", "agrobank", "alliance_bank", "ambank", "bank_islam", "bank_muamalat", "bank_of_china", "bank_rakyat", "bsn", "cimb", "deutsche_bank", "hong_leong_bank", "hsbc", "kfh", "maybank2e", "maybank2u", "ocbc", "pb_enterprise", "public_bank", "rhb", "standard_chartered", "uob" ], "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true } }, "required": [ "bank" ], "title": "param", "type": "object" }, "giropay": { "description": "If this is a `giropay` PaymentMethod, this hash contains details about the Giropay payment method.", "properties": {}, "title": "param", "type": "object" }, "grabpay": { "description": "If this is a `grabpay` PaymentMethod, this hash contains details about the GrabPay payment method.", "properties": {}, "title": "param", "type": "object" }, "ideal": { "description": "If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method.", "properties": { "bank": { "enum": [ "abn_amro", "asn_bank", "bunq", "buut", "handelsbanken", "ing", "knab", "moneyou", "n26", "nn", "rabobank", "regiobank", "revolut", "sns_bank", "triodos_bank", "van_lanschot", "yoursafe" ], "maxLength": 5000, "type": "string" } }, "title": "param", "type": "object" }, "interac_present": { "description": "If this is an `interac_present` PaymentMethod, this hash contains details about the Interac Present payment method.", "properties": {}, "title": "param", "type": "object" }, "kakao_pay": { "description": "If this is a `kakao_pay` PaymentMethod, this hash contains details about the Kakao Pay payment method.", "properties": {}, "title": "param", "type": "object" }, "klarna": { "description": "If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method.", "properties": { "dob": { "properties": { "day": { "type": "integer" }, "month": { "type": "integer" }, "year": { "type": "integer" } }, "required": [ "day", "month", "year" ], "title": "date_of_birth", "type": "object" } }, "title": "param", "type": "object" }, "konbini": { "description": "If this is a `konbini` PaymentMethod, this hash contains details about the Konbini payment method.", "properties": {}, "title": "param", "type": "object" }, "kr_card": { "description": "If this is a `kr_card` PaymentMethod, this hash contains details about the Korean Card payment method.", "properties": {}, "title": "param", "type": "object" }, "link": { "description": "If this is an `Link` PaymentMethod, this hash contains details about the Link payment method.", "properties": {}, "title": "param", "type": "object" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "mobilepay": { "description": "If this is a `mobilepay` PaymentMethod, this hash contains details about the MobilePay payment method.", "properties": {}, "title": "param", "type": "object" }, "multibanco": { "description": "If this is a `multibanco` PaymentMethod, this hash contains details about the Multibanco payment method.", "properties": {}, "title": "param", "type": "object" }, "naver_pay": { "description": "If this is a `naver_pay` PaymentMethod, this hash contains details about the Naver Pay payment method.", "properties": { "funding": { "enum": [ "card", "points" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "param", "type": "object" }, "nz_bank_account": { "description": "If this is an nz_bank_account PaymentMethod, this hash contains details about the nz_bank_account payment method.", "properties": { "account_holder_name": { "maxLength": 5000, "type": "string" }, "account_number": { "maxLength": 5000, "type": "string" }, "bank_code": { "maxLength": 5000, "type": "string" }, "branch_code": { "maxLength": 5000, "type": "string" }, "reference": { "maxLength": 128, "type": "string" }, "suffix": { "maxLength": 5000, "type": "string" } }, "required": [ "account_number", "bank_code", "branch_code", "suffix" ], "title": "param", "type": "object" }, "oxxo": { "description": "If this is an `oxxo` PaymentMethod, this hash contains details about the OXXO payment method.", "properties": {}, "title": "param", "type": "object" }, "p24": { "description": "If this is a `p24` PaymentMethod, this hash contains details about the P24 payment method.", "properties": { "bank": { "enum": [ "alior_bank", "bank_millennium", "bank_nowy_bfg_sa", "bank_pekao_sa", "banki_spbdzielcze", "blik", "bnp_paribas", "boz", "citi_handlowy", "credit_agricole", "envelobank", "etransfer_pocztowy24", "getin_bank", "ideabank", "ing", "inteligo", "mbank_mtransfer", "nest_przelew", "noble_pay", "pbac_z_ipko", "plus_bank", "santander_przelew24", "tmobile_usbugi_bankowe", "toyota_bank", "velobank", "volkswagen_bank" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "param", "type": "object" }, "pay_by_bank": { "description": "If this is a `pay_by_bank` PaymentMethod, this hash contains details about the PayByBank payment method.", "properties": {}, "title": "param", "type": "object" }, "payco": { "description": "If this is a `payco` PaymentMethod, this hash contains details about the PAYCO payment method.", "properties": {}, "title": "param", "type": "object" }, "payment_method": { "description": "The PaymentMethod to share.", "maxLength": 5000, "type": "string" }, "paynow": { "description": "If this is a `paynow` PaymentMethod, this hash contains details about the PayNow payment method.", "properties": {}, "title": "param", "type": "object" }, "paypal": { "description": "If this is a `paypal` PaymentMethod, this hash contains details about the PayPal payment method.", "properties": {}, "title": "param", "type": "object" }, "pix": { "description": "If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.", "properties": {}, "title": "param", "type": "object" }, "promptpay": { "description": "If this is a `promptpay` PaymentMethod, this hash contains details about the PromptPay payment method.", "properties": {}, "title": "param", "type": "object" }, "radar_options": { "description": "Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.", "properties": { "session": { "maxLength": 5000, "type": "string" } }, "title": "radar_options_with_hidden_options", "type": "object" }, "revolut_pay": { "description": "If this is a `revolut_pay` PaymentMethod, this hash contains details about the Revolut Pay payment method.", "properties": {}, "title": "param", "type": "object" }, "samsung_pay": { "description": "If this is a `samsung_pay` PaymentMethod, this hash contains details about the SamsungPay payment method.", "properties": {}, "title": "param", "type": "object" }, "satispay": { "description": "If this is a `satispay` PaymentMethod, this hash contains details about the Satispay payment method.", "properties": {}, "title": "param", "type": "object" }, "sepa_debit": { "description": "If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account.", "properties": { "iban": { "maxLength": 5000, "type": "string" } }, "required": [ "iban" ], "title": "param", "type": "object" }, "sofort": { "description": "If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.", "properties": { "country": { "enum": [ "AT", "BE", "DE", "ES", "IT", "NL" ], "type": "string" } }, "required": [ "country" ], "title": "param", "type": "object" }, "swish": { "description": "If this is a `swish` PaymentMethod, this hash contains details about the Swish payment method.", "properties": {}, "title": "param", "type": "object" }, "twint": { "description": "If this is a TWINT PaymentMethod, this hash contains details about the TWINT payment method.", "properties": {}, "title": "param", "type": "object" }, "type": { "description": "The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.", "enum": [ "acss_debit", "affirm", "afterpay_clearpay", "alipay", "alma", "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", "billie", "blik", "boleto", "card", "cashapp", "crypto", "customer_balance", "eps", "fpx", "giropay", "grabpay", "ideal", "kakao_pay", "klarna", "konbini", "kr_card", "link", "mobilepay", "multibanco", "naver_pay", "nz_bank_account", "oxxo", "p24", "pay_by_bank", "payco", "paynow", "paypal", "pix", "promptpay", "revolut_pay", "samsung_pay", "satispay", "sepa_debit", "sofort", "swish", "twint", "us_bank_account", "wechat_pay", "zip" ], "type": "string", "x-stripeBypassValidation": true }, "us_bank_account": { "description": "If this is an `us_bank_account` PaymentMethod, this hash contains details about the US bank account payment method.", "properties": { "account_holder_type": { "enum": [ "company", "individual" ], "type": "string" }, "account_number": { "maxLength": 5000, "type": "string" }, "account_type": { "enum": [ "checking", "savings" ], "type": "string" }, "financial_connections_account": { "maxLength": 5000, "type": "string" }, "routing_number": { "maxLength": 5000, "type": "string" } }, "title": "payment_method_param", "type": "object" }, "wechat_pay": { "description": "If this is an `wechat_pay` PaymentMethod, this hash contains details about the wechat_pay payment method.", "properties": {}, "title": "param", "type": "object" }, "zip": { "description": "If this is a `zip` PaymentMethod, this hash contains details about the Zip payment method.", "properties": {}, "title": "param", "type": "object" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_method" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Shares a PaymentMethod" } }, "/v1/payment_methods/{payment_method}": { "get": { "description": "

Retrieves a PaymentMethod object attached to the StripeAccount. To retrieve a payment method attached to a Customer, you should use Retrieve a Customer’s PaymentMethods

", "operationId": "GetPaymentMethodsPaymentMethod", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "payment_method", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_method" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a PaymentMethod" }, "post": { "description": "

Updates a PaymentMethod object. A PaymentMethod must be attached to a customer to be updated.

", "operationId": "PostPaymentMethodsPaymentMethod", "parameters": [ { "in": "path", "name": "payment_method", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "billing_details": { "explode": true, "style": "deepObject" }, "card": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "link": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "pay_by_bank": { "explode": true, "style": "deepObject" }, "us_bank_account": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "allow_redisplay": { "description": "This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to `unspecified`.", "enum": [ "always", "limited", "unspecified" ], "type": "string" }, "billing_details": { "description": "Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.", "properties": { "address": { "anyOf": [ { "properties": { "city": { "maxLength": 5000, "type": "string" }, "country": { "maxLength": 5000, "type": "string" }, "line1": { "maxLength": 5000, "type": "string" }, "line2": { "maxLength": 5000, "type": "string" }, "postal_code": { "maxLength": 5000, "type": "string" }, "state": { "maxLength": 5000, "type": "string" } }, "title": "billing_details_address", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "email": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "name": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "phone": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "tax_id": { "maxLength": 5000, "type": "string" } }, "title": "billing_details_inner_params", "type": "object" }, "card": { "description": "If this is a `card` PaymentMethod, this hash contains the user's card details.", "properties": { "exp_month": { "type": "integer" }, "exp_year": { "type": "integer" }, "networks": { "properties": { "preferred": { "enum": [ "", "cartes_bancaires", "mastercard", "visa" ], "type": "string" } }, "title": "networks_update_api_param", "type": "object" } }, "title": "update_api_param", "type": "object" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "link": { "description": "If this is an `Link` PaymentMethod, this hash contains details about the Link payment method.", "properties": {}, "title": "param", "type": "object" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "pay_by_bank": { "description": "If this is a `pay_by_bank` PaymentMethod, this hash contains details about the PayByBank payment method.", "properties": {}, "title": "param", "type": "object" }, "us_bank_account": { "description": "If this is an `us_bank_account` PaymentMethod, this hash contains details about the US bank account payment method.", "properties": { "account_holder_type": { "enum": [ "company", "individual" ], "type": "string" }, "account_type": { "enum": [ "checking", "savings" ], "type": "string" } }, "title": "update_param", "type": "object" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_method" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a PaymentMethod" } }, "/v1/payment_methods/{payment_method}/attach": { "post": { "description": "

Attaches a PaymentMethod object to a Customer.

\n\n

To attach a new PaymentMethod to a customer for future payments, we recommend you use a SetupIntent\nor a PaymentIntent with setup_future_usage.\nThese approaches will perform any necessary steps to set up the PaymentMethod for future payments. Using the /v1/payment_methods/:id/attach\nendpoint without first using a SetupIntent or PaymentIntent with setup_future_usage does not optimize the PaymentMethod for\nfuture use, which makes later declines and payment friction more likely.\nSee Optimizing cards for future payments for more information about setting up\nfuture payments.

\n\n

To use this PaymentMethod as the default for invoice or subscription payments,\nset invoice_settings.default_payment_method,\non the Customer to the PaymentMethod’s ID.

", "operationId": "PostPaymentMethodsPaymentMethodAttach", "parameters": [ { "in": "path", "name": "payment_method", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "customer": { "description": "The ID of the customer to which to attach the PaymentMethod.", "maxLength": 5000, "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "required": [ "customer" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_method" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Attach a PaymentMethod to a Customer" } }, "/v1/payment_methods/{payment_method}/detach": { "post": { "description": "

Detaches a PaymentMethod object from a Customer. After a PaymentMethod is detached, it can no longer be used for a payment or re-attached to a Customer.

", "operationId": "PostPaymentMethodsPaymentMethodDetach", "parameters": [ { "in": "path", "name": "payment_method", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_method" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Detach a PaymentMethod from a Customer" } }, "/v1/payouts": { "get": { "description": "

Returns a list of existing payouts sent to third-party bank accounts or payouts that Stripe sent to you. The payouts return in sorted order, with the most recently created payouts appearing first.

", "operationId": "GetPayouts", "parameters": [ { "description": "Only return payouts that are expected to arrive during the given date interval.", "explode": true, "in": "query", "name": "arrival_date", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "type": "integer" }, "gte": { "type": "integer" }, "lt": { "type": "integer" }, "lte": { "type": "integer" } }, "title": "range_query_specs", "type": "object" }, { "type": "integer" } ] }, "style": "deepObject" }, { "description": "Only return payouts that were created during the given date interval.", "explode": true, "in": "query", "name": "created", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "type": "integer" }, "gte": { "type": "integer" }, "lt": { "type": "integer" }, "lte": { "type": "integer" } }, "title": "range_query_specs", "type": "object" }, { "type": "integer" } ] }, "style": "deepObject" }, { "description": "The ID of an external account - only return payouts sent to this external account.", "in": "query", "name": "destination", "required": false, "schema": { "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Only return payouts that have the given status: `pending`, `paid`, `failed`, or `canceled`.", "in": "query", "name": "status", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/payout" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/payouts", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "PayoutList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all payouts" }, "post": { "description": "

To send funds to your own bank account, create a new payout object. Your Stripe balance must cover the payout amount. If it doesn’t, you receive an “Insufficient Funds” error.

\n\n

If your API key is in test mode, money won’t actually be sent, though every other action occurs as if you’re in live mode.

\n\n

If you create a manual payout on a Stripe account that uses multiple payment source types, you need to specify the source type balance that the payout draws from. The balance object details available and pending amounts by source type.

", "operationId": "PostPayouts", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "amount": { "description": "A positive integer in cents representing how much to payout.", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users.", "maxLength": 5000, "type": "string" }, "destination": { "description": "The ID of a bank account or a card to send the payout to. If you don't provide a destination, we use the default external account for the specified currency.", "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "method": { "description": "The method used to send this payout, which is `standard` or `instant`. We support `instant` for payouts to debit cards and bank accounts in certain countries. Learn more about [bank support for Instant Payouts](https://stripe.com/docs/payouts/instant-payouts-banks).", "enum": [ "instant", "standard" ], "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true }, "payout_method": { "description": "The ID of a v2 FinancialAccount to send funds to.", "type": "string" }, "source_type": { "description": "The balance type of your Stripe balance to draw this payout from. Balances for different payment sources are kept separately. You can find the amounts with the Balances API. One of `bank_account`, `card`, or `fpx`.", "enum": [ "bank_account", "card", "fpx" ], "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true }, "statement_descriptor": { "description": "A string that displays on the recipient's bank or card statement (up to 22 characters). A `statement_descriptor` that's longer than 22 characters return an error. Most banks truncate this information and display it inconsistently. Some banks might not display it at all.", "maxLength": 22, "type": "string", "x-stripeBypassValidation": true } }, "required": [ "amount", "currency" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payout" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a payout" } }, "/v1/payouts/{payout}": { "get": { "description": "

Retrieves the details of an existing payout. Supply the unique payout ID from either a payout creation request or the payout list. Stripe returns the corresponding payout information.

", "operationId": "GetPayoutsPayout", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "payout", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payout" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a payout" }, "post": { "description": "

Updates the specified payout by setting the values of the parameters you pass. We don’t change parameters that you don’t provide. This request only accepts the metadata as arguments.

", "operationId": "PostPayoutsPayout", "parameters": [ { "in": "path", "name": "payout", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payout" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a payout" } }, "/v1/payouts/{payout}/cancel": { "post": { "description": "

You can cancel a previously created payout if its status is pending. Stripe refunds the funds to your available balance. You can’t cancel automatic Stripe payouts.

", "operationId": "PostPayoutsPayoutCancel", "parameters": [ { "in": "path", "name": "payout", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payout" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Cancel a payout" } }, "/v1/payouts/{payout}/reverse": { "post": { "description": "

Reverses a payout by debiting the destination bank account. At this time, you can only reverse payouts for connected accounts to US bank accounts. If the payout is manual and in the pending status, use /v1/payouts/:id/cancel instead.

\n\n

By requesting a reversal through /v1/payouts/:id/reverse, you confirm that the authorized signatory of the selected bank account authorizes the debit on the bank account and that no other authorization is required.

", "operationId": "PostPayoutsPayoutReverse", "parameters": [ { "in": "path", "name": "payout", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payout" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Reverse a payout" } }, "/v1/plans": { "get": { "description": "

Returns a list of your plans.

", "operationId": "GetPlans", "parameters": [ { "description": "Only return plans that are active or inactive (e.g., pass `false` to list all inactive plans).", "in": "query", "name": "active", "required": false, "schema": { "type": "boolean" }, "style": "form" }, { "description": "A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.", "explode": true, "in": "query", "name": "created", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "type": "integer" }, "gte": { "type": "integer" }, "lt": { "type": "integer" }, "lte": { "type": "integer" } }, "title": "range_query_specs", "type": "object" }, { "type": "integer" } ] }, "style": "deepObject" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "Only return plans for the given product.", "in": "query", "name": "product", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/plan" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/plans", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "PlanList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all plans" }, "post": { "description": "

You can now model subscriptions more flexibly using the Prices API. It replaces the Plans API and is backwards compatible to simplify your migration.

", "operationId": "PostPlans", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "product": { "explode": true, "style": "deepObject" }, "tiers": { "explode": true, "style": "deepObject" }, "transform_usage": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "active": { "description": "Whether the plan is currently available for new subscriptions. Defaults to `true`.", "type": "boolean" }, "amount": { "description": "A positive integer in cents (or local equivalent) (or 0 for a free plan) representing how much to charge on a recurring basis.", "type": "integer" }, "amount_decimal": { "description": "Same as `amount`, but accepts a decimal value with at most 12 decimal places. Only one of `amount` and `amount_decimal` can be set.", "format": "decimal", "type": "string" }, "billing_scheme": { "description": "Describes how to compute the price per period. Either `per_unit` or `tiered`. `per_unit` indicates that the fixed amount (specified in `amount`) will be charged per unit in `quantity` (for plans with `usage_type=licensed`), or per unit of total usage (for plans with `usage_type=metered`). `tiered` indicates that the unit pricing will be computed using a tiering strategy as defined using the `tiers` and `tiers_mode` attributes.", "enum": [ "per_unit", "tiered" ], "type": "string" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "id": { "description": "An identifier randomly generated by Stripe. Used to identify this plan when subscribing a customer. You can optionally override this ID, but the ID must be unique across all plans in your Stripe account. You can, however, use the same plan ID in both live and test modes.", "maxLength": 5000, "type": "string" }, "interval": { "description": "Specifies billing frequency. Either `day`, `week`, `month` or `year`.", "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "description": "The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).", "type": "integer" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "meter": { "description": "The meter tracking the usage of a metered price", "maxLength": 5000, "type": "string" }, "nickname": { "description": "A brief description of the plan, hidden from customers.", "maxLength": 5000, "type": "string" }, "product": { "anyOf": [ { "description": "The product whose pricing the created plan will represent. This can either be the ID of an existing product, or a dictionary containing fields used to create a [service product](https://stripe.com/docs/api#product_object-type).", "properties": { "active": { "type": "boolean" }, "id": { "deprecated": true, "maxLength": 5000, "type": "string" }, "metadata": { "additionalProperties": { "type": "string" }, "type": "object" }, "name": { "maxLength": 5000, "type": "string" }, "statement_descriptor": { "maxLength": 22, "type": "string" }, "tax_code": { "maxLength": 5000, "type": "string" }, "unit_label": { "maxLength": 12, "type": "string" } }, "required": [ "name" ], "title": "inline_product_params", "type": "object" }, { "description": "The ID of the product whose pricing the created plan will represent.", "maxLength": 5000, "type": "string" } ] }, "tiers": { "description": "Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.", "items": { "properties": { "flat_amount": { "type": "integer" }, "flat_amount_decimal": { "format": "decimal", "type": "string" }, "unit_amount": { "type": "integer" }, "unit_amount_decimal": { "format": "decimal", "type": "string" }, "up_to": { "anyOf": [ { "enum": [ "inf" ], "maxLength": 5000, "type": "string" }, { "type": "integer" } ] } }, "required": [ "up_to" ], "title": "tier", "type": "object" }, "type": "array" }, "tiers_mode": { "description": "Defines if the tiering price should be `graduated` or `volume` based. In `volume`-based tiering, the maximum quantity within a period determines the per unit price, in `graduated` tiering pricing can successively change as the quantity grows.", "enum": [ "graduated", "volume" ], "type": "string" }, "transform_usage": { "description": "Apply a transformation to the reported usage or set quantity before computing the billed price. Cannot be combined with `tiers`.", "properties": { "divide_by": { "type": "integer" }, "round": { "enum": [ "down", "up" ], "type": "string" } }, "required": [ "divide_by", "round" ], "title": "transform_usage_param", "type": "object" }, "trial_period_days": { "description": "Default number of trial days when subscribing a customer to this plan using [`trial_from_plan=true`](https://stripe.com/docs/api#create_subscription-trial_from_plan).", "type": "integer" }, "usage_type": { "description": "Configures how the quantity per period should be determined. Can be either `metered` or `licensed`. `licensed` automatically bills the `quantity` set when adding it to a subscription. `metered` aggregates the total usage based on usage records. Defaults to `licensed`.", "enum": [ "licensed", "metered" ], "type": "string" } }, "required": [ "currency", "interval" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plan" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a plan" } }, "/v1/plans/{plan}": { "delete": { "description": "

Deleting plans means new subscribers can’t be added. Existing subscribers aren’t affected.

", "operationId": "DeletePlansPlan", "parameters": [ { "in": "path", "name": "plan", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted_plan" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Delete a plan" }, "get": { "description": "

Retrieves the plan with the given ID.

", "operationId": "GetPlansPlan", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "plan", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plan" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a plan" }, "post": { "description": "

Updates the specified plan by setting the values of the parameters passed. Any parameters not provided are left unchanged. By design, you cannot change a plan’s ID, amount, currency, or billing cycle.

", "operationId": "PostPlansPlan", "parameters": [ { "in": "path", "name": "plan", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "active": { "description": "Whether the plan is currently available for new subscriptions.", "type": "boolean" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "nickname": { "description": "A brief description of the plan, hidden from customers.", "maxLength": 5000, "type": "string" }, "product": { "description": "The product the plan belongs to. This cannot be changed once it has been used in a subscription or subscription schedule.", "maxLength": 5000, "type": "string" }, "trial_period_days": { "description": "Default number of trial days when subscribing a customer to this plan using [`trial_from_plan=true`](https://stripe.com/docs/api#create_subscription-trial_from_plan).", "type": "integer" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plan" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a plan" } }, "/v1/prices": { "get": { "description": "

Returns a list of your active prices, excluding inline prices. For the list of inactive prices, set active to false.

", "operationId": "GetPrices", "parameters": [ { "description": "Only return prices that are active or inactive (e.g., pass `false` to list all inactive prices).", "in": "query", "name": "active", "required": false, "schema": { "type": "boolean" }, "style": "form" }, { "description": "A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.", "explode": true, "in": "query", "name": "created", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "type": "integer" }, "gte": { "type": "integer" }, "lt": { "type": "integer" }, "lte": { "type": "integer" } }, "title": "range_query_specs", "type": "object" }, { "type": "integer" } ] }, "style": "deepObject" }, { "description": "Only return prices for the given currency.", "in": "query", "name": "currency", "required": false, "schema": { "format": "currency", "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "Only return the price with these lookup_keys, if any exist. You can specify up to 10 lookup_keys.", "explode": true, "in": "query", "name": "lookup_keys", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "Only return prices for the given product.", "in": "query", "name": "product", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Only return prices with these recurring fields.", "explode": true, "in": "query", "name": "recurring", "required": false, "schema": { "properties": { "interval": { "enum": [ "day", "month", "week", "year" ], "type": "string" }, "meter": { "maxLength": 5000, "type": "string" }, "usage_type": { "enum": [ "licensed", "metered" ], "type": "string" } }, "title": "all_prices_recurring_params", "type": "object" }, "style": "deepObject" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Only return prices of type `recurring` or `one_time`.", "in": "query", "name": "type", "required": false, "schema": { "enum": [ "one_time", "recurring" ], "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/price" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/prices", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "PriceList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all prices" }, "post": { "description": "

Creates a new Price for an existing Product. The Price can be recurring or one-time.

", "operationId": "PostPrices", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "currency_options": { "explode": true, "style": "deepObject" }, "custom_unit_amount": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "product_data": { "explode": true, "style": "deepObject" }, "recurring": { "explode": true, "style": "deepObject" }, "tiers": { "explode": true, "style": "deepObject" }, "transform_quantity": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "active": { "description": "Whether the price can be used for new purchases. Defaults to `true`.", "type": "boolean" }, "billing_scheme": { "description": "Describes how to compute the price per period. Either `per_unit` or `tiered`. `per_unit` indicates that the fixed amount (specified in `unit_amount` or `unit_amount_decimal`) will be charged per unit in `quantity` (for prices with `usage_type=licensed`), or per unit of total usage (for prices with `usage_type=metered`). `tiered` indicates that the unit pricing will be computed using a tiering strategy as defined using the `tiers` and `tiers_mode` attributes.", "enum": [ "per_unit", "tiered" ], "type": "string" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "currency_options": { "additionalProperties": { "properties": { "custom_unit_amount": { "properties": { "enabled": { "type": "boolean" }, "maximum": { "type": "integer" }, "minimum": { "type": "integer" }, "preset": { "type": "integer" } }, "required": [ "enabled" ], "title": "custom_unit_amount", "type": "object" }, "tax_behavior": { "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" }, "tiers": { "items": { "properties": { "flat_amount": { "type": "integer" }, "flat_amount_decimal": { "format": "decimal", "type": "string" }, "unit_amount": { "type": "integer" }, "unit_amount_decimal": { "format": "decimal", "type": "string" }, "up_to": { "anyOf": [ { "enum": [ "inf" ], "maxLength": 5000, "type": "string" }, { "type": "integer" } ] } }, "required": [ "up_to" ], "title": "tier", "type": "object" }, "type": "array" }, "unit_amount": { "type": "integer" }, "unit_amount_decimal": { "format": "decimal", "type": "string" } }, "title": "currency_option", "type": "object" }, "description": "Prices defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).", "type": "object" }, "custom_unit_amount": { "description": "When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.", "properties": { "enabled": { "type": "boolean" }, "maximum": { "type": "integer" }, "minimum": { "type": "integer" }, "preset": { "type": "integer" } }, "required": [ "enabled" ], "title": "custom_unit_amount", "type": "object" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "lookup_key": { "description": "A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.", "maxLength": 200, "type": "string" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "nickname": { "description": "A brief description of the price, hidden from customers.", "maxLength": 5000, "type": "string" }, "product": { "description": "The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.", "maxLength": 5000, "type": "string" }, "product_data": { "description": "These fields can be used to create a new product that this price will belong to.", "properties": { "active": { "type": "boolean" }, "id": { "deprecated": true, "maxLength": 5000, "type": "string" }, "metadata": { "additionalProperties": { "type": "string" }, "type": "object" }, "name": { "maxLength": 5000, "type": "string" }, "statement_descriptor": { "maxLength": 22, "type": "string" }, "tax_code": { "maxLength": 5000, "type": "string" }, "unit_label": { "maxLength": 12, "type": "string" } }, "required": [ "name" ], "title": "inline_product_params", "type": "object" }, "recurring": { "description": "The recurring components of a price such as `interval` and `usage_type`.", "properties": { "interval": { "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "type": "integer" }, "meter": { "maxLength": 5000, "type": "string" }, "usage_type": { "enum": [ "licensed", "metered" ], "type": "string" } }, "required": [ "interval" ], "title": "recurring", "type": "object" }, "tax_behavior": { "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.", "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" }, "tiers": { "description": "Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.", "items": { "properties": { "flat_amount": { "type": "integer" }, "flat_amount_decimal": { "format": "decimal", "type": "string" }, "unit_amount": { "type": "integer" }, "unit_amount_decimal": { "format": "decimal", "type": "string" }, "up_to": { "anyOf": [ { "enum": [ "inf" ], "maxLength": 5000, "type": "string" }, { "type": "integer" } ] } }, "required": [ "up_to" ], "title": "tier", "type": "object" }, "type": "array" }, "tiers_mode": { "description": "Defines if the tiering price should be `graduated` or `volume` based. In `volume`-based tiering, the maximum quantity within a period determines the per unit price, in `graduated` tiering pricing can successively change as the quantity grows.", "enum": [ "graduated", "volume" ], "type": "string" }, "transfer_lookup_key": { "description": "If set to true, will atomically remove the lookup key from the existing price, and assign it to this price.", "type": "boolean" }, "transform_quantity": { "description": "Apply a transformation to the reported usage or set quantity before computing the billed price. Cannot be combined with `tiers`.", "properties": { "divide_by": { "type": "integer" }, "round": { "enum": [ "down", "up" ], "type": "string" } }, "required": [ "divide_by", "round" ], "title": "transform_usage_param", "type": "object" }, "unit_amount": { "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. One of `unit_amount`, `unit_amount_decimal`, or `custom_unit_amount` is required, unless `billing_scheme=tiered`.", "type": "integer" }, "unit_amount_decimal": { "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", "format": "decimal", "type": "string" } }, "required": [ "currency" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/price" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a price" } }, "/v1/prices/search": { "get": { "description": "

Search for prices you’ve previously created using Stripe’s Search Query Language.\nDon’t use search in read-after-write flows where strict consistency is necessary. Under normal operating\nconditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up\nto an hour behind during outages. Search functionality is not available to merchants in India.

", "operationId": "GetPricesSearch", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.", "in": "query", "name": "page", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for prices](https://stripe.com/docs/search#query-fields-for-prices).", "in": "query", "name": "query", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/price" }, "type": "array" }, "has_more": { "type": "boolean" }, "next_page": { "maxLength": 5000, "nullable": true, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "search_result" ], "type": "string" }, "total_count": { "description": "The total number of objects that match the query, only accurate up to 10,000.", "type": "integer" }, "url": { "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "SearchResult", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Search prices" } }, "/v1/prices/{price}": { "get": { "description": "

Retrieves the price with the given ID.

", "operationId": "GetPricesPrice", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "price", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/price" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a price" }, "post": { "description": "

Updates the specified price by setting the values of the parameters passed. Any parameters not provided are left unchanged.

", "operationId": "PostPricesPrice", "parameters": [ { "in": "path", "name": "price", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "currency_options": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "active": { "description": "Whether the price can be used for new purchases. Defaults to `true`.", "type": "boolean" }, "currency_options": { "anyOf": [ { "additionalProperties": { "properties": { "custom_unit_amount": { "properties": { "enabled": { "type": "boolean" }, "maximum": { "type": "integer" }, "minimum": { "type": "integer" }, "preset": { "type": "integer" } }, "required": [ "enabled" ], "title": "custom_unit_amount", "type": "object" }, "tax_behavior": { "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" }, "tiers": { "items": { "properties": { "flat_amount": { "type": "integer" }, "flat_amount_decimal": { "format": "decimal", "type": "string" }, "unit_amount": { "type": "integer" }, "unit_amount_decimal": { "format": "decimal", "type": "string" }, "up_to": { "anyOf": [ { "enum": [ "inf" ], "maxLength": 5000, "type": "string" }, { "type": "integer" } ] } }, "required": [ "up_to" ], "title": "tier", "type": "object" }, "type": "array" }, "unit_amount": { "type": "integer" }, "unit_amount_decimal": { "format": "decimal", "type": "string" } }, "title": "currency_option", "type": "object" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Prices defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies)." }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "lookup_key": { "description": "A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.", "maxLength": 200, "type": "string" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "nickname": { "description": "A brief description of the price, hidden from customers.", "maxLength": 5000, "type": "string" }, "tax_behavior": { "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.", "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" }, "transfer_lookup_key": { "description": "If set to true, will atomically remove the lookup key from the existing price, and assign it to this price.", "type": "boolean" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/price" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a price" } }, "/v1/products": { "get": { "description": "

Returns a list of your products. The products are returned sorted by creation date, with the most recently created products appearing first.

", "operationId": "GetProducts", "parameters": [ { "description": "Only return products that are active or inactive (e.g., pass `false` to list all inactive products).", "in": "query", "name": "active", "required": false, "schema": { "type": "boolean" }, "style": "form" }, { "description": "Only return products that were created during the given date interval.", "explode": true, "in": "query", "name": "created", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "type": "integer" }, "gte": { "type": "integer" }, "lt": { "type": "integer" }, "lte": { "type": "integer" } }, "title": "range_query_specs", "type": "object" }, { "type": "integer" } ] }, "style": "deepObject" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "Only return products with the given IDs. Cannot be used with [starting_after](https://stripe.com/docs/api#list_products-starting_after) or [ending_before](https://stripe.com/docs/api#list_products-ending_before).", "explode": true, "in": "query", "name": "ids", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "Only return products that can be shipped (i.e., physical, not digital products).", "in": "query", "name": "shippable", "required": false, "schema": { "type": "boolean" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Only return products with the given url.", "in": "query", "name": "url", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/product" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/products", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "ProductList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all products" }, "post": { "description": "

Creates a new product object.

", "operationId": "PostProducts", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "default_price_data": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "images": { "explode": true, "style": "deepObject" }, "marketing_features": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "package_dimensions": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "active": { "description": "Whether the product is currently available for purchase. Defaults to `true`.", "type": "boolean" }, "default_price_data": { "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object. This Price will be set as the default price for this product.", "properties": { "currency": { "format": "currency", "type": "string" }, "currency_options": { "additionalProperties": { "properties": { "custom_unit_amount": { "properties": { "enabled": { "type": "boolean" }, "maximum": { "type": "integer" }, "minimum": { "type": "integer" }, "preset": { "type": "integer" } }, "required": [ "enabled" ], "title": "custom_unit_amount", "type": "object" }, "tax_behavior": { "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" }, "tiers": { "items": { "properties": { "flat_amount": { "type": "integer" }, "flat_amount_decimal": { "format": "decimal", "type": "string" }, "unit_amount": { "type": "integer" }, "unit_amount_decimal": { "format": "decimal", "type": "string" }, "up_to": { "anyOf": [ { "enum": [ "inf" ], "maxLength": 5000, "type": "string" }, { "type": "integer" } ] } }, "required": [ "up_to" ], "title": "tier", "type": "object" }, "type": "array" }, "unit_amount": { "type": "integer" }, "unit_amount_decimal": { "format": "decimal", "type": "string" } }, "title": "currency_option", "type": "object" }, "type": "object" }, "custom_unit_amount": { "properties": { "enabled": { "type": "boolean" }, "maximum": { "type": "integer" }, "minimum": { "type": "integer" }, "preset": { "type": "integer" } }, "required": [ "enabled" ], "title": "custom_unit_amount", "type": "object" }, "metadata": { "additionalProperties": { "type": "string" }, "type": "object" }, "recurring": { "properties": { "interval": { "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "type": "integer" } }, "required": [ "interval" ], "title": "recurring_adhoc", "type": "object" }, "tax_behavior": { "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" }, "unit_amount": { "type": "integer" }, "unit_amount_decimal": { "format": "decimal", "type": "string" } }, "required": [ "currency" ], "title": "price_data_without_product_with_metadata", "type": "object" }, "description": { "description": "The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.", "maxLength": 40000, "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "id": { "description": "An identifier will be randomly generated by Stripe. You can optionally override this ID, but the ID must be unique across all products in your Stripe account.", "maxLength": 5000, "type": "string" }, "images": { "description": "A list of up to 8 URLs of images for this product, meant to be displayable to the customer.", "items": { "type": "string" }, "type": "array" }, "marketing_features": { "description": "A list of up to 15 marketing features for this product. These are displayed in [pricing tables](https://stripe.com/docs/payments/checkout/pricing-table).", "items": { "properties": { "name": { "maxLength": 5000, "type": "string" } }, "required": [ "name" ], "title": "features", "type": "object" }, "type": "array" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "name": { "description": "The product's name, meant to be displayable to the customer.", "maxLength": 5000, "type": "string" }, "package_dimensions": { "description": "The dimensions of this product for shipping purposes.", "properties": { "height": { "type": "number" }, "length": { "type": "number" }, "weight": { "type": "number" }, "width": { "type": "number" } }, "required": [ "height", "length", "weight", "width" ], "title": "package_dimensions_specs", "type": "object" }, "shippable": { "description": "Whether this product is shipped (i.e., physical goods).", "type": "boolean" }, "statement_descriptor": { "description": "An arbitrary string to be displayed on your customer's credit card or bank statement. While most banks display this information consistently, some may display it incorrectly or not at all.\n\nThis may be up to 22 characters. The statement description may not include `<`, `>`, `\\`, `\"`, `'` characters, and will appear on your customer's statement in capital letters. Non-ASCII characters are automatically stripped.\n It must contain at least one letter. Only used for subscription payments.", "maxLength": 22, "type": "string" }, "tax_code": { "description": "A [tax code](https://stripe.com/docs/tax/tax-categories) ID.", "type": "string" }, "unit_label": { "description": "A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.", "maxLength": 12, "type": "string" }, "url": { "description": "A URL of a publicly-accessible webpage for this product.", "maxLength": 5000, "type": "string" } }, "required": [ "name" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a product" } }, "/v1/products/search": { "get": { "description": "

Search for products you’ve previously created using Stripe’s Search Query Language.\nDon’t use search in read-after-write flows where strict consistency is necessary. Under normal operating\nconditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up\nto an hour behind during outages. Search functionality is not available to merchants in India.

", "operationId": "GetProductsSearch", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.", "in": "query", "name": "page", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for products](https://stripe.com/docs/search#query-fields-for-products).", "in": "query", "name": "query", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/product" }, "type": "array" }, "has_more": { "type": "boolean" }, "next_page": { "maxLength": 5000, "nullable": true, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "search_result" ], "type": "string" }, "total_count": { "description": "The total number of objects that match the query, only accurate up to 10,000.", "type": "integer" }, "url": { "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "SearchResult", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Search products" } }, "/v1/products/{id}": { "delete": { "description": "

Delete a product. Deleting a product is only possible if it has no prices associated with it. Additionally, deleting a product with type=good is only possible if it has no SKUs associated with it.

", "operationId": "DeleteProductsId", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted_product" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Delete a product" }, "get": { "description": "

Retrieves the details of an existing product. Supply the unique product ID from either a product creation request or the product list, and Stripe will return the corresponding product information.

", "operationId": "GetProductsId", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a product" }, "post": { "description": "

Updates the specific product by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

", "operationId": "PostProductsId", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "description": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "images": { "explode": true, "style": "deepObject" }, "marketing_features": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "package_dimensions": { "explode": true, "style": "deepObject" }, "tax_code": { "explode": true, "style": "deepObject" }, "unit_label": { "explode": true, "style": "deepObject" }, "url": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "active": { "description": "Whether the product is available for purchase.", "type": "boolean" }, "default_price": { "description": "The ID of the [Price](https://stripe.com/docs/api/prices) object that is the default price for this product.", "maxLength": 5000, "type": "string" }, "description": { "anyOf": [ { "maxLength": 40000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes." }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "images": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "A list of up to 8 URLs of images for this product, meant to be displayable to the customer." }, "marketing_features": { "anyOf": [ { "items": { "properties": { "name": { "maxLength": 5000, "type": "string" } }, "required": [ "name" ], "title": "features", "type": "object" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "A list of up to 15 marketing features for this product. These are displayed in [pricing tables](https://stripe.com/docs/payments/checkout/pricing-table)." }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "name": { "description": "The product's name, meant to be displayable to the customer.", "maxLength": 5000, "type": "string" }, "package_dimensions": { "anyOf": [ { "properties": { "height": { "type": "number" }, "length": { "type": "number" }, "weight": { "type": "number" }, "width": { "type": "number" } }, "required": [ "height", "length", "weight", "width" ], "title": "package_dimensions_specs", "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "The dimensions of this product for shipping purposes." }, "shippable": { "description": "Whether this product is shipped (i.e., physical goods).", "type": "boolean" }, "statement_descriptor": { "description": "An arbitrary string to be displayed on your customer's credit card or bank statement. While most banks display this information consistently, some may display it incorrectly or not at all.\n\nThis may be up to 22 characters. The statement description may not include `<`, `>`, `\\`, `\"`, `'` characters, and will appear on your customer's statement in capital letters. Non-ASCII characters are automatically stripped.\n It must contain at least one letter. May only be set if `type=service`. Only used for subscription payments.", "maxLength": 22, "type": "string" }, "tax_code": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "A [tax code](https://stripe.com/docs/tax/tax-categories) ID." }, "unit_label": { "anyOf": [ { "maxLength": 12, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal. May only be set if `type=service`." }, "url": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "A URL of a publicly-accessible webpage for this product." } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a product" } }, "/v1/products/{product}/features": { "get": { "description": "

Retrieve a list of features for a product

", "operationId": "GetProductsProductFeatures", "parameters": [ { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "in": "path", "name": "product", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/product_feature" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "EntitlementsResourceProductFeatureList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all features attached to a product" }, "post": { "description": "

Creates a product_feature, which represents a feature attachment to a product

", "operationId": "PostProductsProductFeatures", "parameters": [ { "in": "path", "name": "product", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "entitlement_feature": { "description": "The ID of the [Feature](https://stripe.com/docs/api/entitlements/feature) object attached to this product.", "maxLength": 5000, "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "required": [ "entitlement_feature" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_feature" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Attach a feature to a product" } }, "/v1/products/{product}/features/{id}": { "delete": { "description": "

Deletes the feature attachment to a product

", "operationId": "DeleteProductsProductFeaturesId", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "in": "path", "name": "product", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted_product_feature" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Remove a feature from a product" }, "get": { "description": "

Retrieves a product_feature, which represents a feature attachment to a product

", "operationId": "GetProductsProductFeaturesId", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "The ID of the product_feature.", "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "description": "The ID of the product.", "in": "path", "name": "product", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_feature" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a product_feature" } }, "/v1/promotion_codes": { "get": { "description": "

Returns a list of your promotion codes.

", "operationId": "GetPromotionCodes", "parameters": [ { "description": "Filter promotion codes by whether they are active.", "in": "query", "name": "active", "required": false, "schema": { "type": "boolean" }, "style": "form" }, { "description": "Only return promotion codes that have this case-insensitive code.", "in": "query", "name": "code", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Only return promotion codes for this coupon.", "in": "query", "name": "coupon", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.", "explode": true, "in": "query", "name": "created", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "type": "integer" }, "gte": { "type": "integer" }, "lt": { "type": "integer" }, "lte": { "type": "integer" } }, "title": "range_query_specs", "type": "object" }, { "type": "integer" } ] }, "style": "deepObject" }, { "description": "Only return promotion codes that are restricted to this customer.", "in": "query", "name": "customer", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/promotion_code" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/promotion_codes", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "PromotionCodesResourcePromotionCodeList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all promotion codes" }, "post": { "description": "

A promotion code points to a coupon. You can optionally restrict the code to a specific customer, redemption limit, and expiration date.

", "operationId": "PostPromotionCodes", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "restrictions": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "active": { "description": "Whether the promotion code is currently active.", "type": "boolean" }, "code": { "description": "The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for a specific customer. Valid characters are lower case letters (a-z), upper case letters (A-Z), and digits (0-9).\n\nIf left blank, we will generate one automatically.", "maxLength": 500, "type": "string" }, "coupon": { "description": "The coupon for this promotion code.", "maxLength": 5000, "type": "string" }, "customer": { "description": "The customer that this promotion code can be used by. If not set, the promotion code can be used by all customers.", "maxLength": 5000, "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "expires_at": { "description": "The timestamp at which this promotion code will expire. If the coupon has specified a `redeems_by`, then this value cannot be after the coupon's `redeems_by`.", "format": "unix-time", "type": "integer" }, "max_redemptions": { "description": "A positive integer specifying the number of times the promotion code can be redeemed. If the coupon has specified a `max_redemptions`, then this value cannot be greater than the coupon's `max_redemptions`.", "type": "integer" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "restrictions": { "description": "Settings that restrict the redemption of the promotion code.", "properties": { "currency_options": { "additionalProperties": { "properties": { "minimum_amount": { "type": "integer" } }, "title": "currency_option", "type": "object" }, "type": "object" }, "first_time_transaction": { "type": "boolean" }, "minimum_amount": { "type": "integer" }, "minimum_amount_currency": { "format": "currency", "type": "string" } }, "title": "restrictions_params", "type": "object" } }, "required": [ "coupon" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/promotion_code" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a promotion code" } }, "/v1/promotion_codes/{promotion_code}": { "get": { "description": "

Retrieves the promotion code with the given ID. In order to retrieve a promotion code by the customer-facing code use list with the desired code.

", "operationId": "GetPromotionCodesPromotionCode", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "promotion_code", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/promotion_code" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a promotion code" }, "post": { "description": "

Updates the specified promotion code by setting the values of the parameters passed. Most fields are, by design, not editable.

", "operationId": "PostPromotionCodesPromotionCode", "parameters": [ { "in": "path", "name": "promotion_code", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "restrictions": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "active": { "description": "Whether the promotion code is currently active. A promotion code can only be reactivated when the coupon is still valid and the promotion code is otherwise redeemable.", "type": "boolean" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "restrictions": { "description": "Settings that restrict the redemption of the promotion code.", "properties": { "currency_options": { "additionalProperties": { "properties": { "minimum_amount": { "type": "integer" } }, "title": "currency_option", "type": "object" }, "type": "object" } }, "title": "restrictions_params", "type": "object" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/promotion_code" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a promotion code" } }, "/v1/quotes": { "get": { "description": "

Returns a list of your quotes.

", "operationId": "GetQuotes", "parameters": [ { "description": "The ID of the customer whose quotes will be retrieved.", "in": "query", "name": "customer", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "The status of the quote.", "in": "query", "name": "status", "required": false, "schema": { "enum": [ "accepted", "canceled", "draft", "open" ], "type": "string", "x-stripeBypassValidation": true }, "style": "form" }, { "description": "Provides a list of quotes that are associated with the specified test clock. The response will not include quotes with test clocks if this and the customer parameter is not set.", "in": "query", "name": "test_clock", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/quote" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/quotes", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "QuotesResourceQuoteList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all quotes" }, "post": { "description": "

A quote models prices and services for a customer. Default options for header, description, footer, and expires_at can be set in the dashboard via the quote template.

", "operationId": "PostQuotes", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "application_fee_amount": { "explode": true, "style": "deepObject" }, "application_fee_percent": { "explode": true, "style": "deepObject" }, "automatic_tax": { "explode": true, "style": "deepObject" }, "default_tax_rates": { "explode": true, "style": "deepObject" }, "description": { "explode": true, "style": "deepObject" }, "discounts": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "footer": { "explode": true, "style": "deepObject" }, "from_quote": { "explode": true, "style": "deepObject" }, "header": { "explode": true, "style": "deepObject" }, "invoice_settings": { "explode": true, "style": "deepObject" }, "line_items": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "on_behalf_of": { "explode": true, "style": "deepObject" }, "subscription_data": { "explode": true, "style": "deepObject" }, "transfer_data": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "application_fee_amount": { "anyOf": [ { "type": "integer" }, { "enum": [ "" ], "type": "string" } ], "description": "The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. There cannot be any line items with recurring prices when using this field." }, "application_fee_percent": { "anyOf": [ { "type": "number" }, { "enum": [ "" ], "type": "string" } ], "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. There must be at least 1 line item with a recurring price to use this field." }, "automatic_tax": { "description": "Settings for automatic tax lookup for this quote and resulting invoices and subscriptions.", "properties": { "enabled": { "type": "boolean" }, "liability": { "properties": { "account": { "type": "string" }, "type": { "enum": [ "account", "self" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "param", "type": "object" } }, "required": [ "enabled" ], "title": "automatic_tax_param", "type": "object" }, "collection_method": { "description": "Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay invoices at the end of the subscription cycle or at invoice finalization using the default payment method attached to the subscription or customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically`.", "enum": [ "charge_automatically", "send_invoice" ], "type": "string" }, "customer": { "description": "The customer for which this quote belongs to. A customer is required before finalizing the quote. Once specified, it cannot be changed.", "maxLength": 5000, "type": "string" }, "default_tax_rates": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The tax rates that will apply to any line item that does not have `tax_rates` set." }, "description": { "anyOf": [ { "maxLength": 500, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "A description that will be displayed on the quote PDF. If no value is passed, the default description configured in your [quote template settings](https://dashboard.stripe.com/settings/billing/quote) will be used." }, "discounts": { "anyOf": [ { "items": { "properties": { "coupon": { "maxLength": 5000, "type": "string" }, "discount": { "maxLength": 5000, "type": "string" }, "promotion_code": { "maxLength": 5000, "type": "string" } }, "title": "discounts_data_param", "type": "object" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The discounts applied to the quote." }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "expires_at": { "description": "A future timestamp on which the quote will be canceled if in `open` or `draft` status. Measured in seconds since the Unix epoch. If no value is passed, the default expiration date configured in your [quote template settings](https://dashboard.stripe.com/settings/billing/quote) will be used.", "format": "unix-time", "type": "integer" }, "footer": { "anyOf": [ { "maxLength": 500, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "A footer that will be displayed on the quote PDF. If no value is passed, the default footer configured in your [quote template settings](https://dashboard.stripe.com/settings/billing/quote) will be used." }, "from_quote": { "description": "Clone an existing quote. The new quote will be created in `status=draft`. When using this parameter, you cannot specify any other parameters except for `expires_at`.", "properties": { "is_revision": { "type": "boolean" }, "quote": { "maxLength": 5000, "type": "string" } }, "required": [ "quote" ], "title": "from_quote_params", "type": "object" }, "header": { "anyOf": [ { "maxLength": 50, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "A header that will be displayed on the quote PDF. If no value is passed, the default header configured in your [quote template settings](https://dashboard.stripe.com/settings/billing/quote) will be used." }, "invoice_settings": { "description": "All invoices will be billed using the specified settings.", "properties": { "days_until_due": { "type": "integer" }, "issuer": { "properties": { "account": { "type": "string" }, "type": { "enum": [ "account", "self" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "param", "type": "object" } }, "title": "quote_param", "type": "object" }, "line_items": { "description": "A list of line items the customer is being quoted for. Each line item includes information about the product, the quantity, and the resulting cost.", "items": { "properties": { "discounts": { "anyOf": [ { "items": { "properties": { "coupon": { "maxLength": 5000, "type": "string" }, "discount": { "maxLength": 5000, "type": "string" }, "promotion_code": { "maxLength": 5000, "type": "string" } }, "title": "discounts_data_param", "type": "object" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ] }, "price": { "maxLength": 5000, "type": "string" }, "price_data": { "properties": { "currency": { "format": "currency", "type": "string" }, "product": { "maxLength": 5000, "type": "string" }, "recurring": { "properties": { "interval": { "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "type": "integer" } }, "required": [ "interval" ], "title": "recurring_adhoc", "type": "object" }, "tax_behavior": { "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" }, "unit_amount": { "type": "integer" }, "unit_amount_decimal": { "format": "decimal", "type": "string" } }, "required": [ "currency", "product" ], "title": "price_data", "type": "object" }, "quantity": { "type": "integer" }, "tax_rates": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "line_item_create_params", "type": "object" }, "type": "array" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "on_behalf_of": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "The account on behalf of which to charge." }, "subscription_data": { "description": "When creating a subscription or subscription schedule, the specified configuration data will be used. There must be at least one line item with a recurring price for a subscription or subscription schedule to be created. A subscription schedule is created if `subscription_data[effective_date]` is present and in the future, otherwise a subscription is created.", "properties": { "billing_mode": { "properties": { "type": { "enum": [ "classic", "flexible" ], "type": "string" } }, "required": [ "type" ], "title": "billing_mode", "type": "object" }, "description": { "maxLength": 500, "type": "string" }, "effective_date": { "anyOf": [ { "enum": [ "current_period_end" ], "maxLength": 5000, "type": "string" }, { "format": "unix-time", "type": "integer" }, { "enum": [ "" ], "type": "string" } ] }, "metadata": { "additionalProperties": { "type": "string" }, "type": "object" }, "trial_period_days": { "anyOf": [ { "type": "integer" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "subscription_data_create_params", "type": "object" }, "test_clock": { "description": "ID of the test clock to attach to the quote.", "maxLength": 5000, "type": "string" }, "transfer_data": { "anyOf": [ { "properties": { "amount": { "type": "integer" }, "amount_percent": { "type": "number" }, "destination": { "type": "string" } }, "required": [ "destination" ], "title": "transfer_data_specs", "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "The data with which to automatically create a Transfer for each of the invoices." } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/quote" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a quote" } }, "/v1/quotes/{quote}": { "get": { "description": "

Retrieves the quote with the given ID.

", "operationId": "GetQuotesQuote", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "quote", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/quote" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a quote" }, "post": { "description": "

A quote models prices and services for a customer.

", "operationId": "PostQuotesQuote", "parameters": [ { "in": "path", "name": "quote", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "application_fee_amount": { "explode": true, "style": "deepObject" }, "application_fee_percent": { "explode": true, "style": "deepObject" }, "automatic_tax": { "explode": true, "style": "deepObject" }, "default_tax_rates": { "explode": true, "style": "deepObject" }, "description": { "explode": true, "style": "deepObject" }, "discounts": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "footer": { "explode": true, "style": "deepObject" }, "header": { "explode": true, "style": "deepObject" }, "invoice_settings": { "explode": true, "style": "deepObject" }, "line_items": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "on_behalf_of": { "explode": true, "style": "deepObject" }, "subscription_data": { "explode": true, "style": "deepObject" }, "transfer_data": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "application_fee_amount": { "anyOf": [ { "type": "integer" }, { "enum": [ "" ], "type": "string" } ], "description": "The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. There cannot be any line items with recurring prices when using this field." }, "application_fee_percent": { "anyOf": [ { "type": "number" }, { "enum": [ "" ], "type": "string" } ], "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. There must be at least 1 line item with a recurring price to use this field." }, "automatic_tax": { "description": "Settings for automatic tax lookup for this quote and resulting invoices and subscriptions.", "properties": { "enabled": { "type": "boolean" }, "liability": { "properties": { "account": { "type": "string" }, "type": { "enum": [ "account", "self" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "param", "type": "object" } }, "required": [ "enabled" ], "title": "automatic_tax_param", "type": "object" }, "collection_method": { "description": "Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay invoices at the end of the subscription cycle or at invoice finalization using the default payment method attached to the subscription or customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically`.", "enum": [ "charge_automatically", "send_invoice" ], "type": "string" }, "customer": { "description": "The customer for which this quote belongs to. A customer is required before finalizing the quote. Once specified, it cannot be changed.", "maxLength": 5000, "type": "string" }, "default_tax_rates": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The tax rates that will apply to any line item that does not have `tax_rates` set." }, "description": { "anyOf": [ { "maxLength": 500, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "A description that will be displayed on the quote PDF." }, "discounts": { "anyOf": [ { "items": { "properties": { "coupon": { "maxLength": 5000, "type": "string" }, "discount": { "maxLength": 5000, "type": "string" }, "promotion_code": { "maxLength": 5000, "type": "string" } }, "title": "discounts_data_param", "type": "object" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The discounts applied to the quote." }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "expires_at": { "description": "A future timestamp on which the quote will be canceled if in `open` or `draft` status. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "footer": { "anyOf": [ { "maxLength": 500, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "A footer that will be displayed on the quote PDF." }, "header": { "anyOf": [ { "maxLength": 50, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "A header that will be displayed on the quote PDF." }, "invoice_settings": { "description": "All invoices will be billed using the specified settings.", "properties": { "days_until_due": { "type": "integer" }, "issuer": { "properties": { "account": { "type": "string" }, "type": { "enum": [ "account", "self" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "param", "type": "object" } }, "title": "quote_param", "type": "object" }, "line_items": { "description": "A list of line items the customer is being quoted for. Each line item includes information about the product, the quantity, and the resulting cost.", "items": { "properties": { "discounts": { "anyOf": [ { "items": { "properties": { "coupon": { "maxLength": 5000, "type": "string" }, "discount": { "maxLength": 5000, "type": "string" }, "promotion_code": { "maxLength": 5000, "type": "string" } }, "title": "discounts_data_param", "type": "object" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ] }, "id": { "maxLength": 5000, "type": "string" }, "price": { "maxLength": 5000, "type": "string" }, "price_data": { "properties": { "currency": { "format": "currency", "type": "string" }, "product": { "maxLength": 5000, "type": "string" }, "recurring": { "properties": { "interval": { "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "type": "integer" } }, "required": [ "interval" ], "title": "recurring_adhoc", "type": "object" }, "tax_behavior": { "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" }, "unit_amount": { "type": "integer" }, "unit_amount_decimal": { "format": "decimal", "type": "string" } }, "required": [ "currency", "product" ], "title": "price_data", "type": "object" }, "quantity": { "type": "integer" }, "tax_rates": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "line_item_update_params", "type": "object" }, "type": "array" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "on_behalf_of": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "The account on behalf of which to charge." }, "subscription_data": { "description": "When creating a subscription or subscription schedule, the specified configuration data will be used. There must be at least one line item with a recurring price for a subscription or subscription schedule to be created. A subscription schedule is created if `subscription_data[effective_date]` is present and in the future, otherwise a subscription is created.", "properties": { "description": { "anyOf": [ { "maxLength": 500, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "effective_date": { "anyOf": [ { "enum": [ "current_period_end" ], "maxLength": 5000, "type": "string" }, { "format": "unix-time", "type": "integer" }, { "enum": [ "" ], "type": "string" } ] }, "metadata": { "additionalProperties": { "type": "string" }, "type": "object" }, "trial_period_days": { "anyOf": [ { "type": "integer" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "subscription_data_update_params", "type": "object" }, "transfer_data": { "anyOf": [ { "properties": { "amount": { "type": "integer" }, "amount_percent": { "type": "number" }, "destination": { "type": "string" } }, "required": [ "destination" ], "title": "transfer_data_specs", "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "The data with which to automatically create a Transfer for each of the invoices." } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/quote" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a quote" } }, "/v1/quotes/{quote}/accept": { "post": { "description": "

Accepts the specified quote.

", "operationId": "PostQuotesQuoteAccept", "parameters": [ { "in": "path", "name": "quote", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/quote" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Accept a quote" } }, "/v1/quotes/{quote}/cancel": { "post": { "description": "

Cancels the quote.

", "operationId": "PostQuotesQuoteCancel", "parameters": [ { "in": "path", "name": "quote", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/quote" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Cancel a quote" } }, "/v1/quotes/{quote}/computed_upfront_line_items": { "get": { "description": "

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

", "operationId": "GetQuotesQuoteComputedUpfrontLineItems", "parameters": [ { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "in": "path", "name": "quote", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/item" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "QuotesResourceListLineItems", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a quote's upfront line items" } }, "/v1/quotes/{quote}/finalize": { "post": { "description": "

Finalizes the quote.

", "operationId": "PostQuotesQuoteFinalize", "parameters": [ { "in": "path", "name": "quote", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "expires_at": { "description": "A future timestamp on which the quote will be canceled if in `open` or `draft` status. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/quote" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Finalize a quote" } }, "/v1/quotes/{quote}/line_items": { "get": { "description": "

When retrieving a quote, 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.

", "operationId": "GetQuotesQuoteLineItems", "parameters": [ { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "in": "path", "name": "quote", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/item" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "QuotesResourceListLineItems", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a quote's line items" } }, "/v1/quotes/{quote}/pdf": { "get": { "description": "

Download the PDF for a finalized quote. Explanation for special handling can be found here

", "operationId": "GetQuotesQuotePdf", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "quote", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/pdf": { "schema": { "format": "binary", "type": "string" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "servers": [ { "url": "https://files.stripe.com/" } ], "summary": "Download quote PDF" } }, "/v1/radar/early_fraud_warnings": { "get": { "description": "

Returns a list of early fraud warnings.

", "operationId": "GetRadarEarlyFraudWarnings", "parameters": [ { "description": "Only return early fraud warnings for the charge specified by this charge ID.", "in": "query", "name": "charge", "required": false, "schema": { "type": "string" }, "style": "form" }, { "description": "Only return early fraud warnings that were created during the given date interval.", "explode": true, "in": "query", "name": "created", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "type": "integer" }, "gte": { "type": "integer" }, "lt": { "type": "integer" }, "lte": { "type": "integer" } }, "title": "range_query_specs", "type": "object" }, { "type": "integer" } ] }, "style": "deepObject" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "Only return early fraud warnings for charges that were created by the PaymentIntent specified by this PaymentIntent ID.", "in": "query", "name": "payment_intent", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/radar.early_fraud_warning" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/radar/early_fraud_warnings", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "RadarEarlyFraudWarningList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all early fraud warnings" } }, "/v1/radar/early_fraud_warnings/{early_fraud_warning}": { "get": { "description": "

Retrieves the details of an early fraud warning that has previously been created.

\n\n

Please refer to the early fraud warning object reference for more details.

", "operationId": "GetRadarEarlyFraudWarningsEarlyFraudWarning", "parameters": [ { "in": "path", "name": "early_fraud_warning", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/radar.early_fraud_warning" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve an early fraud warning" } }, "/v1/radar/value_list_items": { "get": { "description": "

Returns a list of ValueListItem objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

", "operationId": "GetRadarValueListItems", "parameters": [ { "description": "Only return items that were created during the given date interval.", "explode": true, "in": "query", "name": "created", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "type": "integer" }, "gte": { "type": "integer" }, "lt": { "type": "integer" }, "lte": { "type": "integer" } }, "title": "range_query_specs", "type": "object" }, { "type": "integer" } ] }, "style": "deepObject" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Return items belonging to the parent list whose value matches the specified value (using an \"is like\" match).", "in": "query", "name": "value", "required": false, "schema": { "maxLength": 800, "type": "string" }, "style": "form" }, { "description": "Identifier for the parent value list this item belongs to.", "in": "query", "name": "value_list", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/radar.value_list_item" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/radar/value_list_items", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "RadarListListItemList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all value list items" }, "post": { "description": "

Creates a new ValueListItem object, which is added to the specified parent value list.

", "operationId": "PostRadarValueListItems", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "value": { "description": "The value of the item (whose type must match the type of the parent value list).", "maxLength": 800, "type": "string" }, "value_list": { "description": "The identifier of the value list which the created item will be added to.", "maxLength": 5000, "type": "string" } }, "required": [ "value", "value_list" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/radar.value_list_item" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a value list item" } }, "/v1/radar/value_list_items/{item}": { "delete": { "description": "

Deletes a ValueListItem object, removing it from its parent value list.

", "operationId": "DeleteRadarValueListItemsItem", "parameters": [ { "in": "path", "name": "item", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted_radar.value_list_item" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Delete a value list item" }, "get": { "description": "

Retrieves a ValueListItem object.

", "operationId": "GetRadarValueListItemsItem", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "item", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/radar.value_list_item" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a value list item" } }, "/v1/radar/value_lists": { "get": { "description": "

Returns a list of ValueList objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

", "operationId": "GetRadarValueLists", "parameters": [ { "description": "The alias used to reference the value list when writing rules.", "in": "query", "name": "alias", "required": false, "schema": { "maxLength": 100, "type": "string" }, "style": "form" }, { "description": "A value contained within a value list - returns all value lists containing this value.", "in": "query", "name": "contains", "required": false, "schema": { "maxLength": 800, "type": "string" }, "style": "form" }, { "description": "Only return value lists that were created during the given date interval.", "explode": true, "in": "query", "name": "created", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "type": "integer" }, "gte": { "type": "integer" }, "lt": { "type": "integer" }, "lte": { "type": "integer" } }, "title": "range_query_specs", "type": "object" }, { "type": "integer" } ] }, "style": "deepObject" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/radar.value_list" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/radar/value_lists", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "RadarListListList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all value lists" }, "post": { "description": "

Creates a new ValueList object, which can then be referenced in rules.

", "operationId": "PostRadarValueLists", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "alias": { "description": "The name of the value list for use in rules.", "maxLength": 100, "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "item_type": { "description": "Type of the items in the value list. One of `card_fingerprint`, `card_bin`, `email`, `ip_address`, `country`, `string`, `case_sensitive_string`, `customer_id`, `sepa_debit_fingerprint`, or `us_bank_account_fingerprint`. Use `string` if the item type is unknown or mixed.", "enum": [ "card_bin", "card_fingerprint", "case_sensitive_string", "country", "customer_id", "email", "ip_address", "sepa_debit_fingerprint", "string", "us_bank_account_fingerprint" ], "maxLength": 5000, "type": "string" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "name": { "description": "The human-readable name of the value list.", "maxLength": 100, "type": "string" } }, "required": [ "alias", "name" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/radar.value_list" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a value list" } }, "/v1/radar/value_lists/{value_list}": { "delete": { "description": "

Deletes a ValueList object, also deleting any items contained within the value list. To be deleted, a value list must not be referenced in any rules.

", "operationId": "DeleteRadarValueListsValueList", "parameters": [ { "in": "path", "name": "value_list", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted_radar.value_list" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Delete a value list" }, "get": { "description": "

Retrieves a ValueList object.

", "operationId": "GetRadarValueListsValueList", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "value_list", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/radar.value_list" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a value list" }, "post": { "description": "

Updates a ValueList object by setting the values of the parameters passed. Any parameters not provided will be left unchanged. Note that item_type is immutable.

", "operationId": "PostRadarValueListsValueList", "parameters": [ { "in": "path", "name": "value_list", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "alias": { "description": "The name of the value list for use in rules.", "maxLength": 100, "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "name": { "description": "The human-readable name of the value list.", "maxLength": 100, "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/radar.value_list" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a value list" } }, "/v1/refunds": { "get": { "description": "

Returns a list of all refunds you created. We return the refunds in sorted order, with the most recent refunds appearing first. The 10 most recent refunds are always available by default on the Charge object.

", "operationId": "GetRefunds", "parameters": [ { "description": "Only return refunds for the charge specified by this charge ID.", "in": "query", "name": "charge", "required": false, "schema": { "type": "string" }, "style": "form" }, { "description": "Only return refunds that were created during the given date interval.", "explode": true, "in": "query", "name": "created", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "type": "integer" }, "gte": { "type": "integer" }, "lt": { "type": "integer" }, "lte": { "type": "integer" } }, "title": "range_query_specs", "type": "object" }, { "type": "integer" } ] }, "style": "deepObject" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "Only return refunds for the PaymentIntent specified by this ID.", "in": "query", "name": "payment_intent", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/refund" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/refunds", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "APIMethodRefundList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all refunds" }, "post": { "description": "

When you create a new refund, you must specify a Charge or a PaymentIntent object on which to create it.

\n\n

Creating a new refund will refund a charge that has previously been created but not yet refunded.\nFunds will be refunded to the credit or debit card that was originally charged.

\n\n

You can optionally refund only part of a charge.\nYou can do so multiple times, until the entire charge has been refunded.

\n\n

Once entirely refunded, a charge can’t be refunded again.\nThis method will raise an error when called on an already-refunded charge,\nor when trying to refund more money than is left on a charge.

", "operationId": "PostRefunds", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "amount": { "type": "integer" }, "charge": { "description": "The identifier of the charge to refund.", "maxLength": 5000, "type": "string" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "customer": { "description": "Customer whose customer balance to refund from.", "maxLength": 5000, "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "instructions_email": { "description": "For payment methods without native refund support (e.g., Konbini, PromptPay), use this email from the customer to receive refund instructions.", "type": "string" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "origin": { "description": "Origin of the refund", "enum": [ "customer_balance" ], "type": "string" }, "payment_intent": { "description": "The identifier of the PaymentIntent to refund.", "maxLength": 5000, "type": "string" }, "reason": { "description": "String indicating the reason for the refund. If set, possible values are `duplicate`, `fraudulent`, and `requested_by_customer`. If you believe the charge to be fraudulent, specifying `fraudulent` as the reason will add the associated card and email to your [block lists](https://stripe.com/docs/radar/lists), and will also help us improve our fraud detection algorithms.", "enum": [ "duplicate", "fraudulent", "requested_by_customer" ], "maxLength": 5000, "type": "string" }, "refund_application_fee": { "description": "Boolean indicating whether the application fee should be refunded when refunding this charge. If a full charge refund is given, the full application fee will be refunded. Otherwise, the application fee will be refunded in an amount proportional to the amount of the charge refunded. An application fee can be refunded only by the application that created the charge.", "type": "boolean" }, "reverse_transfer": { "description": "Boolean indicating whether the transfer should be reversed when refunding this charge. The transfer will be reversed proportionally to the amount being refunded (either the entire or partial amount).

A transfer can be reversed only by the application that created the charge.", "type": "boolean" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/refund" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create customer balance refund" } }, "/v1/refunds/{refund}": { "get": { "description": "

Retrieves the details of an existing refund.

", "operationId": "GetRefundsRefund", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "refund", "required": true, "schema": { "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/refund" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a refund" }, "post": { "description": "

Updates the refund that you specify by setting the values of the passed parameters. Any parameters that you don’t provide remain unchanged.

\n\n

This request only accepts metadata as an argument.

", "operationId": "PostRefundsRefund", "parameters": [ { "in": "path", "name": "refund", "required": true, "schema": { "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/refund" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a refund" } }, "/v1/refunds/{refund}/cancel": { "post": { "description": "

Cancels a refund with a status of requires_action.

\n\n

You can’t cancel refunds in other states. Only refunds for payment methods that require customer action can enter the requires_action state.

", "operationId": "PostRefundsRefundCancel", "parameters": [ { "in": "path", "name": "refund", "required": true, "schema": { "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/refund" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Cancel a refund" } }, "/v1/reporting/report_runs": { "get": { "description": "

Returns a list of Report Runs, with the most recent appearing first.

", "operationId": "GetReportingReportRuns", "parameters": [ { "description": "Only return Report Runs that were created during the given date interval.", "explode": true, "in": "query", "name": "created", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "type": "integer" }, "gte": { "type": "integer" }, "lt": { "type": "integer" }, "lte": { "type": "integer" } }, "title": "range_query_specs", "type": "object" }, { "type": "integer" } ] }, "style": "deepObject" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/reporting.report_run" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/reporting/report_runs", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "FinancialReportingFinanceReportRunList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all Report Runs" }, "post": { "description": "

Creates a new object and begin running the report. (Certain report types require a live-mode API key.)

", "operationId": "PostReportingReportRuns", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "parameters": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "parameters": { "description": "Parameters specifying how the report should be run. Different Report Types have different required and optional parameters, listed in the [API Access to Reports](https://stripe.com/docs/reporting/statements/api) documentation.", "properties": { "columns": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "connected_account": { "type": "string" }, "currency": { "format": "currency", "type": "string" }, "interval_end": { "format": "unix-time", "type": "integer" }, "interval_start": { "format": "unix-time", "type": "integer" }, "payout": { "type": "string" }, "reporting_category": { "enum": [ "advance", "advance_funding", "anticipation_repayment", "charge", "charge_failure", "climate_order_purchase", "climate_order_refund", "connect_collection_transfer", "connect_reserved_funds", "contribution", "dispute", "dispute_reversal", "fee", "financing_paydown", "financing_paydown_reversal", "financing_payout", "financing_payout_reversal", "issuing_authorization_hold", "issuing_authorization_release", "issuing_dispute", "issuing_transaction", "network_cost", "other_adjustment", "partial_capture_reversal", "payout", "payout_reversal", "platform_earning", "platform_earning_refund", "refund", "refund_failure", "risk_reserved_funds", "tax", "topup", "topup_reversal", "transfer", "transfer_reversal", "unreconciled_customer_funds" ], "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true }, "timezone": { "enum": [ "Africa/Abidjan", "Africa/Accra", "Africa/Addis_Ababa", "Africa/Algiers", "Africa/Asmara", "Africa/Asmera", "Africa/Bamako", "Africa/Bangui", "Africa/Banjul", "Africa/Bissau", "Africa/Blantyre", "Africa/Brazzaville", "Africa/Bujumbura", "Africa/Cairo", "Africa/Casablanca", "Africa/Ceuta", "Africa/Conakry", "Africa/Dakar", "Africa/Dar_es_Salaam", "Africa/Djibouti", "Africa/Douala", "Africa/El_Aaiun", "Africa/Freetown", "Africa/Gaborone", "Africa/Harare", "Africa/Johannesburg", "Africa/Juba", "Africa/Kampala", "Africa/Khartoum", "Africa/Kigali", "Africa/Kinshasa", "Africa/Lagos", "Africa/Libreville", "Africa/Lome", "Africa/Luanda", "Africa/Lubumbashi", "Africa/Lusaka", "Africa/Malabo", "Africa/Maputo", "Africa/Maseru", "Africa/Mbabane", "Africa/Mogadishu", "Africa/Monrovia", "Africa/Nairobi", "Africa/Ndjamena", "Africa/Niamey", "Africa/Nouakchott", "Africa/Ouagadougou", "Africa/Porto-Novo", "Africa/Sao_Tome", "Africa/Timbuktu", "Africa/Tripoli", "Africa/Tunis", "Africa/Windhoek", "America/Adak", "America/Anchorage", "America/Anguilla", "America/Antigua", "America/Araguaina", "America/Argentina/Buenos_Aires", "America/Argentina/Catamarca", "America/Argentina/ComodRivadavia", "America/Argentina/Cordoba", "America/Argentina/Jujuy", "America/Argentina/La_Rioja", "America/Argentina/Mendoza", "America/Argentina/Rio_Gallegos", "America/Argentina/Salta", "America/Argentina/San_Juan", "America/Argentina/San_Luis", "America/Argentina/Tucuman", "America/Argentina/Ushuaia", "America/Aruba", "America/Asuncion", "America/Atikokan", "America/Atka", "America/Bahia", "America/Bahia_Banderas", "America/Barbados", "America/Belem", "America/Belize", "America/Blanc-Sablon", "America/Boa_Vista", "America/Bogota", "America/Boise", "America/Buenos_Aires", "America/Cambridge_Bay", "America/Campo_Grande", "America/Cancun", "America/Caracas", "America/Catamarca", "America/Cayenne", "America/Cayman", "America/Chicago", "America/Chihuahua", "America/Ciudad_Juarez", "America/Coral_Harbour", "America/Cordoba", "America/Costa_Rica", "America/Coyhaique", "America/Creston", "America/Cuiaba", "America/Curacao", "America/Danmarkshavn", "America/Dawson", "America/Dawson_Creek", "America/Denver", "America/Detroit", "America/Dominica", "America/Edmonton", "America/Eirunepe", "America/El_Salvador", "America/Ensenada", "America/Fort_Nelson", "America/Fort_Wayne", "America/Fortaleza", "America/Glace_Bay", "America/Godthab", "America/Goose_Bay", "America/Grand_Turk", "America/Grenada", "America/Guadeloupe", "America/Guatemala", "America/Guayaquil", "America/Guyana", "America/Halifax", "America/Havana", "America/Hermosillo", "America/Indiana/Indianapolis", "America/Indiana/Knox", "America/Indiana/Marengo", "America/Indiana/Petersburg", "America/Indiana/Tell_City", "America/Indiana/Vevay", "America/Indiana/Vincennes", "America/Indiana/Winamac", "America/Indianapolis", "America/Inuvik", "America/Iqaluit", "America/Jamaica", "America/Jujuy", "America/Juneau", "America/Kentucky/Louisville", "America/Kentucky/Monticello", "America/Knox_IN", "America/Kralendijk", "America/La_Paz", "America/Lima", "America/Los_Angeles", "America/Louisville", "America/Lower_Princes", "America/Maceio", "America/Managua", "America/Manaus", "America/Marigot", "America/Martinique", "America/Matamoros", "America/Mazatlan", "America/Mendoza", "America/Menominee", "America/Merida", "America/Metlakatla", "America/Mexico_City", "America/Miquelon", "America/Moncton", "America/Monterrey", "America/Montevideo", "America/Montreal", "America/Montserrat", "America/Nassau", "America/New_York", "America/Nipigon", "America/Nome", "America/Noronha", "America/North_Dakota/Beulah", "America/North_Dakota/Center", "America/North_Dakota/New_Salem", "America/Nuuk", "America/Ojinaga", "America/Panama", "America/Pangnirtung", "America/Paramaribo", "America/Phoenix", "America/Port-au-Prince", "America/Port_of_Spain", "America/Porto_Acre", "America/Porto_Velho", "America/Puerto_Rico", "America/Punta_Arenas", "America/Rainy_River", "America/Rankin_Inlet", "America/Recife", "America/Regina", "America/Resolute", "America/Rio_Branco", "America/Rosario", "America/Santa_Isabel", "America/Santarem", "America/Santiago", "America/Santo_Domingo", "America/Sao_Paulo", "America/Scoresbysund", "America/Shiprock", "America/Sitka", "America/St_Barthelemy", "America/St_Johns", "America/St_Kitts", "America/St_Lucia", "America/St_Thomas", "America/St_Vincent", "America/Swift_Current", "America/Tegucigalpa", "America/Thule", "America/Thunder_Bay", "America/Tijuana", "America/Toronto", "America/Tortola", "America/Vancouver", "America/Virgin", "America/Whitehorse", "America/Winnipeg", "America/Yakutat", "America/Yellowknife", "Antarctica/Casey", "Antarctica/Davis", "Antarctica/DumontDUrville", "Antarctica/Macquarie", "Antarctica/Mawson", "Antarctica/McMurdo", "Antarctica/Palmer", "Antarctica/Rothera", "Antarctica/South_Pole", "Antarctica/Syowa", "Antarctica/Troll", "Antarctica/Vostok", "Arctic/Longyearbyen", "Asia/Aden", "Asia/Almaty", "Asia/Amman", "Asia/Anadyr", "Asia/Aqtau", "Asia/Aqtobe", "Asia/Ashgabat", "Asia/Ashkhabad", "Asia/Atyrau", "Asia/Baghdad", "Asia/Bahrain", "Asia/Baku", "Asia/Bangkok", "Asia/Barnaul", "Asia/Beirut", "Asia/Bishkek", "Asia/Brunei", "Asia/Calcutta", "Asia/Chita", "Asia/Choibalsan", "Asia/Chongqing", "Asia/Chungking", "Asia/Colombo", "Asia/Dacca", "Asia/Damascus", "Asia/Dhaka", "Asia/Dili", "Asia/Dubai", "Asia/Dushanbe", "Asia/Famagusta", "Asia/Gaza", "Asia/Harbin", "Asia/Hebron", "Asia/Ho_Chi_Minh", "Asia/Hong_Kong", "Asia/Hovd", "Asia/Irkutsk", "Asia/Istanbul", "Asia/Jakarta", "Asia/Jayapura", "Asia/Jerusalem", "Asia/Kabul", "Asia/Kamchatka", "Asia/Karachi", "Asia/Kashgar", "Asia/Kathmandu", "Asia/Katmandu", "Asia/Khandyga", "Asia/Kolkata", "Asia/Krasnoyarsk", "Asia/Kuala_Lumpur", "Asia/Kuching", "Asia/Kuwait", "Asia/Macao", "Asia/Macau", "Asia/Magadan", "Asia/Makassar", "Asia/Manila", "Asia/Muscat", "Asia/Nicosia", "Asia/Novokuznetsk", "Asia/Novosibirsk", "Asia/Omsk", "Asia/Oral", "Asia/Phnom_Penh", "Asia/Pontianak", "Asia/Pyongyang", "Asia/Qatar", "Asia/Qostanay", "Asia/Qyzylorda", "Asia/Rangoon", "Asia/Riyadh", "Asia/Saigon", "Asia/Sakhalin", "Asia/Samarkand", "Asia/Seoul", "Asia/Shanghai", "Asia/Singapore", "Asia/Srednekolymsk", "Asia/Taipei", "Asia/Tashkent", "Asia/Tbilisi", "Asia/Tehran", "Asia/Tel_Aviv", "Asia/Thimbu", "Asia/Thimphu", "Asia/Tokyo", "Asia/Tomsk", "Asia/Ujung_Pandang", "Asia/Ulaanbaatar", "Asia/Ulan_Bator", "Asia/Urumqi", "Asia/Ust-Nera", "Asia/Vientiane", "Asia/Vladivostok", "Asia/Yakutsk", "Asia/Yangon", "Asia/Yekaterinburg", "Asia/Yerevan", "Atlantic/Azores", "Atlantic/Bermuda", "Atlantic/Canary", "Atlantic/Cape_Verde", "Atlantic/Faeroe", "Atlantic/Faroe", "Atlantic/Jan_Mayen", "Atlantic/Madeira", "Atlantic/Reykjavik", "Atlantic/South_Georgia", "Atlantic/St_Helena", "Atlantic/Stanley", "Australia/ACT", "Australia/Adelaide", "Australia/Brisbane", "Australia/Broken_Hill", "Australia/Canberra", "Australia/Currie", "Australia/Darwin", "Australia/Eucla", "Australia/Hobart", "Australia/LHI", "Australia/Lindeman", "Australia/Lord_Howe", "Australia/Melbourne", "Australia/NSW", "Australia/North", "Australia/Perth", "Australia/Queensland", "Australia/South", "Australia/Sydney", "Australia/Tasmania", "Australia/Victoria", "Australia/West", "Australia/Yancowinna", "Brazil/Acre", "Brazil/DeNoronha", "Brazil/East", "Brazil/West", "CET", "CST6CDT", "Canada/Atlantic", "Canada/Central", "Canada/Eastern", "Canada/Mountain", "Canada/Newfoundland", "Canada/Pacific", "Canada/Saskatchewan", "Canada/Yukon", "Chile/Continental", "Chile/EasterIsland", "Cuba", "EET", "EST", "EST5EDT", "Egypt", "Eire", "Etc/GMT", "Etc/GMT+0", "Etc/GMT+1", "Etc/GMT+10", "Etc/GMT+11", "Etc/GMT+12", "Etc/GMT+2", "Etc/GMT+3", "Etc/GMT+4", "Etc/GMT+5", "Etc/GMT+6", "Etc/GMT+7", "Etc/GMT+8", "Etc/GMT+9", "Etc/GMT-0", "Etc/GMT-1", "Etc/GMT-10", "Etc/GMT-11", "Etc/GMT-12", "Etc/GMT-13", "Etc/GMT-14", "Etc/GMT-2", "Etc/GMT-3", "Etc/GMT-4", "Etc/GMT-5", "Etc/GMT-6", "Etc/GMT-7", "Etc/GMT-8", "Etc/GMT-9", "Etc/GMT0", "Etc/Greenwich", "Etc/UCT", "Etc/UTC", "Etc/Universal", "Etc/Zulu", "Europe/Amsterdam", "Europe/Andorra", "Europe/Astrakhan", "Europe/Athens", "Europe/Belfast", "Europe/Belgrade", "Europe/Berlin", "Europe/Bratislava", "Europe/Brussels", "Europe/Bucharest", "Europe/Budapest", "Europe/Busingen", "Europe/Chisinau", "Europe/Copenhagen", "Europe/Dublin", "Europe/Gibraltar", "Europe/Guernsey", "Europe/Helsinki", "Europe/Isle_of_Man", "Europe/Istanbul", "Europe/Jersey", "Europe/Kaliningrad", "Europe/Kiev", "Europe/Kirov", "Europe/Kyiv", "Europe/Lisbon", "Europe/Ljubljana", "Europe/London", "Europe/Luxembourg", "Europe/Madrid", "Europe/Malta", "Europe/Mariehamn", "Europe/Minsk", "Europe/Monaco", "Europe/Moscow", "Europe/Nicosia", "Europe/Oslo", "Europe/Paris", "Europe/Podgorica", "Europe/Prague", "Europe/Riga", "Europe/Rome", "Europe/Samara", "Europe/San_Marino", "Europe/Sarajevo", "Europe/Saratov", "Europe/Simferopol", "Europe/Skopje", "Europe/Sofia", "Europe/Stockholm", "Europe/Tallinn", "Europe/Tirane", "Europe/Tiraspol", "Europe/Ulyanovsk", "Europe/Uzhgorod", "Europe/Vaduz", "Europe/Vatican", "Europe/Vienna", "Europe/Vilnius", "Europe/Volgograd", "Europe/Warsaw", "Europe/Zagreb", "Europe/Zaporozhye", "Europe/Zurich", "Factory", "GB", "GB-Eire", "GMT", "GMT+0", "GMT-0", "GMT0", "Greenwich", "HST", "Hongkong", "Iceland", "Indian/Antananarivo", "Indian/Chagos", "Indian/Christmas", "Indian/Cocos", "Indian/Comoro", "Indian/Kerguelen", "Indian/Mahe", "Indian/Maldives", "Indian/Mauritius", "Indian/Mayotte", "Indian/Reunion", "Iran", "Israel", "Jamaica", "Japan", "Kwajalein", "Libya", "MET", "MST", "MST7MDT", "Mexico/BajaNorte", "Mexico/BajaSur", "Mexico/General", "NZ", "NZ-CHAT", "Navajo", "PRC", "PST8PDT", "Pacific/Apia", "Pacific/Auckland", "Pacific/Bougainville", "Pacific/Chatham", "Pacific/Chuuk", "Pacific/Easter", "Pacific/Efate", "Pacific/Enderbury", "Pacific/Fakaofo", "Pacific/Fiji", "Pacific/Funafuti", "Pacific/Galapagos", "Pacific/Gambier", "Pacific/Guadalcanal", "Pacific/Guam", "Pacific/Honolulu", "Pacific/Johnston", "Pacific/Kanton", "Pacific/Kiritimati", "Pacific/Kosrae", "Pacific/Kwajalein", "Pacific/Majuro", "Pacific/Marquesas", "Pacific/Midway", "Pacific/Nauru", "Pacific/Niue", "Pacific/Norfolk", "Pacific/Noumea", "Pacific/Pago_Pago", "Pacific/Palau", "Pacific/Pitcairn", "Pacific/Pohnpei", "Pacific/Ponape", "Pacific/Port_Moresby", "Pacific/Rarotonga", "Pacific/Saipan", "Pacific/Samoa", "Pacific/Tahiti", "Pacific/Tarawa", "Pacific/Tongatapu", "Pacific/Truk", "Pacific/Wake", "Pacific/Wallis", "Pacific/Yap", "Poland", "Portugal", "ROC", "ROK", "Singapore", "Turkey", "UCT", "US/Alaska", "US/Aleutian", "US/Arizona", "US/Central", "US/East-Indiana", "US/Eastern", "US/Hawaii", "US/Indiana-Starke", "US/Michigan", "US/Mountain", "US/Pacific", "US/Pacific-New", "US/Samoa", "UTC", "Universal", "W-SU", "WET", "Zulu" ], "maxLength": 5000, "type": "string" } }, "title": "run_parameter_specs", "type": "object" }, "report_type": { "description": "The ID of the [report type](https://stripe.com/docs/reporting/statements/api#report-types) to run, such as `\"balance.summary.1\"`.", "type": "string" } }, "required": [ "report_type" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reporting.report_run" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a Report Run" } }, "/v1/reporting/report_runs/{report_run}": { "get": { "description": "

Retrieves the details of an existing Report Run.

", "operationId": "GetReportingReportRunsReportRun", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "report_run", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reporting.report_run" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a Report Run" } }, "/v1/reporting/report_types": { "get": { "description": "

Returns a full list of Report Types.

", "operationId": "GetReportingReportTypes", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/reporting.report_type" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "FinancialReportingFinanceReportTypeList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all Report Types" } }, "/v1/reporting/report_types/{report_type}": { "get": { "description": "

Retrieves the details of a Report Type. (Certain report types require a live-mode API key.)

", "operationId": "GetReportingReportTypesReportType", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "report_type", "required": true, "schema": { "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reporting.report_type" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a Report Type" } }, "/v1/reviews": { "get": { "description": "

Returns a list of Review objects that have open set to true. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

", "operationId": "GetReviews", "parameters": [ { "description": "Only return reviews that were created during the given date interval.", "explode": true, "in": "query", "name": "created", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "type": "integer" }, "gte": { "type": "integer" }, "lt": { "type": "integer" }, "lte": { "type": "integer" } }, "title": "range_query_specs", "type": "object" }, { "type": "integer" } ] }, "style": "deepObject" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/review" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "RadarReviewList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all open reviews" } }, "/v1/reviews/{review}": { "get": { "description": "

Retrieves a Review object.

", "operationId": "GetReviewsReview", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "review", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/review" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a review" } }, "/v1/reviews/{review}/approve": { "post": { "description": "

Approves a Review object, closing it and removing it from the list of reviews.

", "operationId": "PostReviewsReviewApprove", "parameters": [ { "in": "path", "name": "review", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/review" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Approve a review" } }, "/v1/setup_attempts": { "get": { "description": "

Returns a list of SetupAttempts that associate with a provided SetupIntent.

", "operationId": "GetSetupAttempts", "parameters": [ { "description": "A filter on the list, based on the object `created` field. The value\ncan be a string with an integer Unix timestamp or a\ndictionary with a number of different query options.", "explode": true, "in": "query", "name": "created", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "type": "integer" }, "gte": { "type": "integer" }, "lt": { "type": "integer" }, "lte": { "type": "integer" } }, "title": "range_query_specs", "type": "object" }, { "type": "integer" } ] }, "style": "deepObject" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "Only return SetupAttempts created by the SetupIntent specified by\nthis ID.", "in": "query", "name": "setup_intent", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/setup_attempt" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/setup_attempts", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "PaymentFlowsSetupIntentSetupAttemptList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all SetupAttempts" } }, "/v1/setup_intents": { "get": { "description": "

Returns a list of SetupIntents.

", "operationId": "GetSetupIntents", "parameters": [ { "description": "If present, the SetupIntent's payment method will be attached to the in-context Stripe Account.\n\nIt can only be used for this Stripe Account’s own money movement flows like InboundTransfer and OutboundTransfers. It cannot be set to true when setting up a PaymentMethod for a Customer, and defaults to false when attaching a PaymentMethod to a Customer.", "in": "query", "name": "attach_to_self", "required": false, "schema": { "type": "boolean" }, "style": "form" }, { "description": "A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.", "explode": true, "in": "query", "name": "created", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "type": "integer" }, "gte": { "type": "integer" }, "lt": { "type": "integer" }, "lte": { "type": "integer" } }, "title": "range_query_specs", "type": "object" }, { "type": "integer" } ] }, "style": "deepObject" }, { "description": "Only return SetupIntents for the customer specified by this customer ID.", "in": "query", "name": "customer", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "Only return SetupIntents that associate with the specified payment method.", "in": "query", "name": "payment_method", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/setup_intent" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/setup_intents", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "PaymentFlowsSetupIntentList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all SetupIntents" }, "post": { "description": "

Creates a SetupIntent object.

\n\n

After you create the SetupIntent, attach a payment method and confirm\nit to collect any required permissions to charge the payment method later.

", "operationId": "PostSetupIntents", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "automatic_payment_methods": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "flow_directions": { "explode": true, "style": "deepObject" }, "mandate_data": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "payment_method_data": { "explode": true, "style": "deepObject" }, "payment_method_options": { "explode": true, "style": "deepObject" }, "payment_method_types": { "explode": true, "style": "deepObject" }, "single_use": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "attach_to_self": { "description": "If present, the SetupIntent's payment method will be attached to the in-context Stripe Account.\n\nIt can only be used for this Stripe Account’s own money movement flows like InboundTransfer and OutboundTransfers. It cannot be set to true when setting up a PaymentMethod for a Customer, and defaults to false when attaching a PaymentMethod to a Customer.", "type": "boolean" }, "automatic_payment_methods": { "description": "When you enable this parameter, this SetupIntent accepts payment methods that you enable in the Dashboard and that are compatible with its other parameters.", "properties": { "allow_redirects": { "enum": [ "always", "never" ], "type": "string" }, "enabled": { "type": "boolean" } }, "required": [ "enabled" ], "title": "automatic_payment_methods_param", "type": "object" }, "confirm": { "description": "Set to `true` to attempt to confirm this SetupIntent immediately. This parameter defaults to `false`. If a card is the attached payment method, you can provide a `return_url` in case further authentication is necessary.", "type": "boolean" }, "confirmation_token": { "description": "ID of the ConfirmationToken used to confirm this SetupIntent.\n\nIf the provided ConfirmationToken contains properties that are also being provided in this request, such as `payment_method`, then the values in this request will take precedence.", "maxLength": 5000, "type": "string" }, "customer": { "description": "ID of the Customer this SetupIntent belongs to, if one exists.\n\nIf present, the SetupIntent's payment method will be attached to the Customer on successful setup. Payment methods attached to other Customers cannot be used with this SetupIntent.", "maxLength": 5000, "type": "string" }, "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users.", "maxLength": 1000, "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "flow_directions": { "description": "Indicates the directions of money movement for which this payment method is intended to be used.\n\nInclude `inbound` if you intend to use the payment method as the origin to pull funds from. Include `outbound` if you intend to use the payment method as the destination to send funds to. You can include both if you intend to use the payment method for both purposes.", "items": { "enum": [ "inbound", "outbound" ], "type": "string" }, "type": "array" }, "mandate_data": { "anyOf": [ { "properties": { "customer_acceptance": { "properties": { "accepted_at": { "format": "unix-time", "type": "integer" }, "offline": { "properties": {}, "title": "offline_param", "type": "object" }, "online": { "properties": { "ip_address": { "type": "string" }, "user_agent": { "maxLength": 5000, "type": "string" } }, "required": [ "ip_address", "user_agent" ], "title": "online_param", "type": "object" }, "type": { "enum": [ "offline", "online" ], "maxLength": 5000, "type": "string" } }, "required": [ "type" ], "title": "customer_acceptance_param", "type": "object" } }, "required": [ "customer_acceptance" ], "title": "secret_key_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "This hash contains details about the mandate to create. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/setup_intents/create#create_setup_intent-confirm)." }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "on_behalf_of": { "description": "The Stripe account ID created for this SetupIntent.", "type": "string" }, "payment_method": { "description": "ID of the payment method (a PaymentMethod, Card, or saved Source object) to attach to this SetupIntent.", "maxLength": 5000, "type": "string" }, "payment_method_configuration": { "description": "The ID of the [payment method configuration](https://stripe.com/docs/api/payment_method_configurations) to use with this SetupIntent.", "maxLength": 100, "type": "string" }, "payment_method_data": { "description": "When included, this hash creates a PaymentMethod that is set as the [`payment_method`](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-payment_method)\nvalue in the SetupIntent.", "properties": { "acss_debit": { "properties": { "account_number": { "maxLength": 5000, "type": "string" }, "institution_number": { "maxLength": 5000, "type": "string" }, "transit_number": { "maxLength": 5000, "type": "string" } }, "required": [ "account_number", "institution_number", "transit_number" ], "title": "payment_method_param", "type": "object" }, "affirm": { "properties": {}, "title": "param", "type": "object" }, "afterpay_clearpay": { "properties": {}, "title": "param", "type": "object" }, "alipay": { "properties": {}, "title": "param", "type": "object" }, "allow_redisplay": { "enum": [ "always", "limited", "unspecified" ], "type": "string" }, "alma": { "properties": {}, "title": "param", "type": "object" }, "amazon_pay": { "properties": {}, "title": "param", "type": "object" }, "au_becs_debit": { "properties": { "account_number": { "maxLength": 5000, "type": "string" }, "bsb_number": { "maxLength": 5000, "type": "string" } }, "required": [ "account_number", "bsb_number" ], "title": "param", "type": "object" }, "bacs_debit": { "properties": { "account_number": { "maxLength": 5000, "type": "string" }, "sort_code": { "maxLength": 5000, "type": "string" } }, "title": "param", "type": "object" }, "bancontact": { "properties": {}, "title": "param", "type": "object" }, "billie": { "properties": {}, "title": "param", "type": "object" }, "billing_details": { "properties": { "address": { "anyOf": [ { "properties": { "city": { "maxLength": 5000, "type": "string" }, "country": { "maxLength": 5000, "type": "string" }, "line1": { "maxLength": 5000, "type": "string" }, "line2": { "maxLength": 5000, "type": "string" }, "postal_code": { "maxLength": 5000, "type": "string" }, "state": { "maxLength": 5000, "type": "string" } }, "title": "billing_details_address", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "email": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "name": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "phone": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "tax_id": { "maxLength": 5000, "type": "string" } }, "title": "billing_details_inner_params", "type": "object" }, "blik": { "properties": {}, "title": "param", "type": "object" }, "boleto": { "properties": { "tax_id": { "maxLength": 5000, "type": "string" } }, "required": [ "tax_id" ], "title": "param", "type": "object" }, "cashapp": { "properties": {}, "title": "param", "type": "object" }, "crypto": { "properties": {}, "title": "param", "type": "object" }, "customer_balance": { "properties": {}, "title": "param", "type": "object" }, "eps": { "properties": { "bank": { "enum": [ "arzte_und_apotheker_bank", "austrian_anadi_bank_ag", "bank_austria", "bankhaus_carl_spangler", "bankhaus_schelhammer_und_schattera_ag", "bawag_psk_ag", "bks_bank_ag", "brull_kallmus_bank_ag", "btv_vier_lander_bank", "capital_bank_grawe_gruppe_ag", "deutsche_bank_ag", "dolomitenbank", "easybank_ag", "erste_bank_und_sparkassen", "hypo_alpeadriabank_international_ag", "hypo_bank_burgenland_aktiengesellschaft", "hypo_noe_lb_fur_niederosterreich_u_wien", "hypo_oberosterreich_salzburg_steiermark", "hypo_tirol_bank_ag", "hypo_vorarlberg_bank_ag", "marchfelder_bank", "oberbank_ag", "raiffeisen_bankengruppe_osterreich", "schoellerbank_ag", "sparda_bank_wien", "volksbank_gruppe", "volkskreditbank_ag", "vr_bank_braunau" ], "maxLength": 5000, "type": "string" } }, "title": "param", "type": "object" }, "fpx": { "properties": { "bank": { "enum": [ "affin_bank", "agrobank", "alliance_bank", "ambank", "bank_islam", "bank_muamalat", "bank_of_china", "bank_rakyat", "bsn", "cimb", "deutsche_bank", "hong_leong_bank", "hsbc", "kfh", "maybank2e", "maybank2u", "ocbc", "pb_enterprise", "public_bank", "rhb", "standard_chartered", "uob" ], "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true } }, "required": [ "bank" ], "title": "param", "type": "object" }, "giropay": { "properties": {}, "title": "param", "type": "object" }, "grabpay": { "properties": {}, "title": "param", "type": "object" }, "ideal": { "properties": { "bank": { "enum": [ "abn_amro", "asn_bank", "bunq", "buut", "handelsbanken", "ing", "knab", "moneyou", "n26", "nn", "rabobank", "regiobank", "revolut", "sns_bank", "triodos_bank", "van_lanschot", "yoursafe" ], "maxLength": 5000, "type": "string" } }, "title": "param", "type": "object" }, "interac_present": { "properties": {}, "title": "param", "type": "object" }, "kakao_pay": { "properties": {}, "title": "param", "type": "object" }, "klarna": { "properties": { "dob": { "properties": { "day": { "type": "integer" }, "month": { "type": "integer" }, "year": { "type": "integer" } }, "required": [ "day", "month", "year" ], "title": "date_of_birth", "type": "object" } }, "title": "param", "type": "object" }, "konbini": { "properties": {}, "title": "param", "type": "object" }, "kr_card": { "properties": {}, "title": "param", "type": "object" }, "link": { "properties": {}, "title": "param", "type": "object" }, "metadata": { "additionalProperties": { "type": "string" }, "type": "object" }, "mobilepay": { "properties": {}, "title": "param", "type": "object" }, "multibanco": { "properties": {}, "title": "param", "type": "object" }, "naver_pay": { "properties": { "funding": { "enum": [ "card", "points" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "param", "type": "object" }, "nz_bank_account": { "properties": { "account_holder_name": { "maxLength": 5000, "type": "string" }, "account_number": { "maxLength": 5000, "type": "string" }, "bank_code": { "maxLength": 5000, "type": "string" }, "branch_code": { "maxLength": 5000, "type": "string" }, "reference": { "maxLength": 128, "type": "string" }, "suffix": { "maxLength": 5000, "type": "string" } }, "required": [ "account_number", "bank_code", "branch_code", "suffix" ], "title": "param", "type": "object" }, "oxxo": { "properties": {}, "title": "param", "type": "object" }, "p24": { "properties": { "bank": { "enum": [ "alior_bank", "bank_millennium", "bank_nowy_bfg_sa", "bank_pekao_sa", "banki_spbdzielcze", "blik", "bnp_paribas", "boz", "citi_handlowy", "credit_agricole", "envelobank", "etransfer_pocztowy24", "getin_bank", "ideabank", "ing", "inteligo", "mbank_mtransfer", "nest_przelew", "noble_pay", "pbac_z_ipko", "plus_bank", "santander_przelew24", "tmobile_usbugi_bankowe", "toyota_bank", "velobank", "volkswagen_bank" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "param", "type": "object" }, "pay_by_bank": { "properties": {}, "title": "param", "type": "object" }, "payco": { "properties": {}, "title": "param", "type": "object" }, "paynow": { "properties": {}, "title": "param", "type": "object" }, "paypal": { "properties": {}, "title": "param", "type": "object" }, "pix": { "properties": {}, "title": "param", "type": "object" }, "promptpay": { "properties": {}, "title": "param", "type": "object" }, "radar_options": { "properties": { "session": { "maxLength": 5000, "type": "string" } }, "title": "radar_options_with_hidden_options", "type": "object" }, "revolut_pay": { "properties": {}, "title": "param", "type": "object" }, "samsung_pay": { "properties": {}, "title": "param", "type": "object" }, "satispay": { "properties": {}, "title": "param", "type": "object" }, "sepa_debit": { "properties": { "iban": { "maxLength": 5000, "type": "string" } }, "required": [ "iban" ], "title": "param", "type": "object" }, "sofort": { "properties": { "country": { "enum": [ "AT", "BE", "DE", "ES", "IT", "NL" ], "type": "string" } }, "required": [ "country" ], "title": "param", "type": "object" }, "swish": { "properties": {}, "title": "param", "type": "object" }, "twint": { "properties": {}, "title": "param", "type": "object" }, "type": { "enum": [ "acss_debit", "affirm", "afterpay_clearpay", "alipay", "alma", "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", "billie", "blik", "boleto", "cashapp", "crypto", "customer_balance", "eps", "fpx", "giropay", "grabpay", "ideal", "kakao_pay", "klarna", "konbini", "kr_card", "link", "mobilepay", "multibanco", "naver_pay", "nz_bank_account", "oxxo", "p24", "pay_by_bank", "payco", "paynow", "paypal", "pix", "promptpay", "revolut_pay", "samsung_pay", "satispay", "sepa_debit", "sofort", "swish", "twint", "us_bank_account", "wechat_pay", "zip" ], "type": "string", "x-stripeBypassValidation": true }, "us_bank_account": { "properties": { "account_holder_type": { "enum": [ "company", "individual" ], "type": "string" }, "account_number": { "maxLength": 5000, "type": "string" }, "account_type": { "enum": [ "checking", "savings" ], "type": "string" }, "financial_connections_account": { "maxLength": 5000, "type": "string" }, "routing_number": { "maxLength": 5000, "type": "string" } }, "title": "payment_method_param", "type": "object" }, "wechat_pay": { "properties": {}, "title": "param", "type": "object" }, "zip": { "properties": {}, "title": "param", "type": "object" } }, "required": [ "type" ], "title": "payment_method_data_params", "type": "object" }, "payment_method_options": { "description": "Payment method-specific configuration for this SetupIntent.", "properties": { "acss_debit": { "properties": { "currency": { "enum": [ "cad", "usd" ], "type": "string" }, "mandate_options": { "properties": { "custom_mandate_url": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "default_for": { "items": { "enum": [ "invoice", "subscription" ], "type": "string" }, "type": "array" }, "interval_description": { "maxLength": 500, "type": "string" }, "payment_schedule": { "enum": [ "combined", "interval", "sporadic" ], "type": "string" }, "transaction_type": { "enum": [ "business", "personal" ], "type": "string" } }, "title": "setup_intent_payment_method_options_mandate_options_param", "type": "object" }, "verification_method": { "enum": [ "automatic", "instant", "microdeposits" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "setup_intent_payment_method_options_param", "type": "object" }, "amazon_pay": { "properties": {}, "title": "setup_intent_payment_method_options_param", "type": "object" }, "bacs_debit": { "properties": { "mandate_options": { "properties": { "reference_prefix": { "anyOf": [ { "maxLength": 12, "type": "string" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "payment_method_options_mandate_options_param", "type": "object" } }, "title": "setup_intent_payment_method_options_param", "type": "object" }, "card": { "properties": { "mandate_options": { "properties": { "amount": { "type": "integer" }, "amount_type": { "enum": [ "fixed", "maximum" ], "type": "string" }, "currency": { "format": "currency", "type": "string" }, "description": { "maxLength": 200, "type": "string" }, "end_date": { "format": "unix-time", "type": "integer" }, "interval": { "enum": [ "day", "month", "sporadic", "week", "year" ], "type": "string" }, "interval_count": { "type": "integer" }, "reference": { "maxLength": 80, "type": "string" }, "start_date": { "format": "unix-time", "type": "integer" }, "supported_types": { "items": { "enum": [ "india" ], "type": "string" }, "type": "array" } }, "required": [ "amount", "amount_type", "currency", "interval", "reference", "start_date" ], "title": "setup_intent_mandate_options_param", "type": "object" }, "network": { "enum": [ "amex", "cartes_bancaires", "diners", "discover", "eftpos_au", "girocard", "interac", "jcb", "link", "mastercard", "unionpay", "unknown", "visa" ], "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true }, "request_three_d_secure": { "enum": [ "any", "automatic", "challenge" ], "type": "string", "x-stripeBypassValidation": true }, "three_d_secure": { "properties": { "ares_trans_status": { "enum": [ "A", "C", "I", "N", "R", "U", "Y" ], "type": "string" }, "cryptogram": { "maxLength": 5000, "type": "string" }, "electronic_commerce_indicator": { "enum": [ "01", "02", "05", "06", "07" ], "type": "string", "x-stripeBypassValidation": true }, "network_options": { "properties": { "cartes_bancaires": { "properties": { "cb_avalgo": { "enum": [ "0", "1", "2", "3", "4", "A" ], "type": "string" }, "cb_exemption": { "maxLength": 4, "type": "string" }, "cb_score": { "type": "integer" } }, "required": [ "cb_avalgo" ], "title": "cartes_bancaires_network_options_param", "type": "object" } }, "title": "network_options_param", "type": "object" }, "requestor_challenge_indicator": { "maxLength": 2, "type": "string" }, "transaction_id": { "maxLength": 5000, "type": "string" }, "version": { "enum": [ "1.0.2", "2.1.0", "2.2.0" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "setup_intent_payment_method_options_param", "type": "object" } }, "title": "setup_intent_param", "type": "object" }, "card_present": { "properties": {}, "title": "setup_intent_payment_method_options_param", "type": "object" }, "klarna": { "properties": { "currency": { "format": "currency", "type": "string" }, "on_demand": { "properties": { "average_amount": { "type": "integer" }, "maximum_amount": { "type": "integer" }, "minimum_amount": { "type": "integer" }, "purchase_interval": { "enum": [ "day", "month", "week", "year" ], "type": "string" }, "purchase_interval_count": { "type": "integer" } }, "title": "on_demand_param", "type": "object" }, "preferred_locale": { "enum": [ "cs-CZ", "da-DK", "de-AT", "de-CH", "de-DE", "el-GR", "en-AT", "en-AU", "en-BE", "en-CA", "en-CH", "en-CZ", "en-DE", "en-DK", "en-ES", "en-FI", "en-FR", "en-GB", "en-GR", "en-IE", "en-IT", "en-NL", "en-NO", "en-NZ", "en-PL", "en-PT", "en-RO", "en-SE", "en-US", "es-ES", "es-US", "fi-FI", "fr-BE", "fr-CA", "fr-CH", "fr-FR", "it-CH", "it-IT", "nb-NO", "nl-BE", "nl-NL", "pl-PL", "pt-PT", "ro-RO", "sv-FI", "sv-SE" ], "type": "string", "x-stripeBypassValidation": true }, "subscriptions": { "anyOf": [ { "items": { "properties": { "interval": { "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "type": "integer" }, "name": { "maxLength": 255, "type": "string" }, "next_billing": { "properties": { "amount": { "type": "integer" }, "date": { "maxLength": 5000, "type": "string" } }, "required": [ "amount", "date" ], "title": "subscription_next_billing_param", "type": "object" }, "reference": { "maxLength": 255, "type": "string" } }, "required": [ "interval", "next_billing", "reference" ], "title": "setup_intent_subscription_param", "type": "object" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "setup_intent_payment_method_options_param", "type": "object" }, "link": { "properties": {}, "title": "setup_intent_payment_method_options_param", "type": "object" }, "paypal": { "properties": { "billing_agreement_id": { "maxLength": 5000, "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, "sepa_debit": { "properties": { "mandate_options": { "properties": { "reference_prefix": { "anyOf": [ { "maxLength": 12, "type": "string" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "payment_method_options_mandate_options_param", "type": "object" } }, "title": "setup_intent_payment_method_options_param", "type": "object" }, "us_bank_account": { "properties": { "financial_connections": { "properties": { "filters": { "properties": { "account_subcategories": { "items": { "enum": [ "checking", "savings" ], "maxLength": 5000, "type": "string" }, "type": "array" } }, "title": "linked_account_options_filters_param", "type": "object" }, "permissions": { "items": { "enum": [ "balances", "ownership", "payment_method", "transactions" ], "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true }, "type": "array" }, "prefetch": { "items": { "enum": [ "balances", "ownership", "transactions" ], "type": "string", "x-stripeBypassValidation": true }, "type": "array" }, "return_url": { "maxLength": 5000, "type": "string" } }, "title": "linked_account_options_param", "type": "object" }, "mandate_options": { "properties": { "collection_method": { "enum": [ "", "paper" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "mandate_options_param", "type": "object" }, "networks": { "properties": { "requested": { "items": { "enum": [ "ach", "us_domestic_wire" ], "type": "string" }, "type": "array" } }, "title": "networks_options_param", "type": "object" }, "verification_method": { "enum": [ "automatic", "instant", "microdeposits" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "setup_intent_payment_method_options_param", "type": "object" } }, "title": "payment_method_options_param", "type": "object" }, "payment_method_types": { "description": "The list of payment method types (for example, card) that this SetupIntent can use. If you don't provide this, Stripe will dynamically show relevant payment methods from your [payment method settings](https://dashboard.stripe.com/settings/payment_methods). A list of valid payment method types can be found [here](https://docs.stripe.com/api/payment_methods/object#payment_method_object-type).", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "return_url": { "description": "The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. To redirect to a mobile application, you can alternatively supply an application URI scheme. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/setup_intents/create#create_setup_intent-confirm).", "type": "string" }, "single_use": { "description": "If you populate this hash, this SetupIntent generates a `single_use` mandate after successful completion.\n\nSingle-use mandates are only valid for the following payment methods: `acss_debit`, `alipay`, `au_becs_debit`, `bacs_debit`, `bancontact`, `boleto`, `ideal`, `link`, `sepa_debit`, and `us_bank_account`.", "properties": { "amount": { "type": "integer" }, "currency": { "format": "currency", "type": "string" } }, "required": [ "amount", "currency" ], "title": "setup_intent_single_use_params", "type": "object" }, "usage": { "description": "Indicates how the payment method is intended to be used in the future. If not provided, this value defaults to `off_session`.", "enum": [ "off_session", "on_session" ], "type": "string" }, "use_stripe_sdk": { "description": "Set to `true` when confirming server-side and using Stripe.js, iOS, or Android client-side SDKs to handle the next actions.", "type": "boolean" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setup_intent" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a SetupIntent" } }, "/v1/setup_intents/{intent}": { "get": { "description": "

Retrieves the details of a SetupIntent that has previously been created.

\n\n

Client-side retrieval using a publishable key is allowed when the client_secret is provided in the query string.

\n\n

When retrieved with a publishable key, only a subset of properties will be returned. Please refer to the SetupIntent object reference for more details.

", "operationId": "GetSetupIntentsIntent", "parameters": [ { "description": "The client secret of the SetupIntent. We require this string if you use a publishable key to retrieve the SetupIntent.", "in": "query", "name": "client_secret", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "intent", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setup_intent" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a SetupIntent" }, "post": { "description": "

Updates a SetupIntent object.

", "operationId": "PostSetupIntentsIntent", "parameters": [ { "in": "path", "name": "intent", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "flow_directions": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "payment_method_data": { "explode": true, "style": "deepObject" }, "payment_method_options": { "explode": true, "style": "deepObject" }, "payment_method_types": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "attach_to_self": { "description": "If present, the SetupIntent's payment method will be attached to the in-context Stripe Account.\n\nIt can only be used for this Stripe Account’s own money movement flows like InboundTransfer and OutboundTransfers. It cannot be set to true when setting up a PaymentMethod for a Customer, and defaults to false when attaching a PaymentMethod to a Customer.", "type": "boolean" }, "customer": { "description": "ID of the Customer this SetupIntent belongs to, if one exists.\n\nIf present, the SetupIntent's payment method will be attached to the Customer on successful setup. Payment methods attached to other Customers cannot be used with this SetupIntent.", "maxLength": 5000, "type": "string" }, "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users.", "maxLength": 1000, "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "flow_directions": { "description": "Indicates the directions of money movement for which this payment method is intended to be used.\n\nInclude `inbound` if you intend to use the payment method as the origin to pull funds from. Include `outbound` if you intend to use the payment method as the destination to send funds to. You can include both if you intend to use the payment method for both purposes.", "items": { "enum": [ "inbound", "outbound" ], "type": "string" }, "type": "array" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "payment_method": { "description": "ID of the payment method (a PaymentMethod, Card, or saved Source object) to attach to this SetupIntent. To unset this field to null, pass in an empty string.", "maxLength": 5000, "type": "string" }, "payment_method_configuration": { "description": "The ID of the [payment method configuration](https://stripe.com/docs/api/payment_method_configurations) to use with this SetupIntent.", "maxLength": 100, "type": "string" }, "payment_method_data": { "description": "When included, this hash creates a PaymentMethod that is set as the [`payment_method`](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-payment_method)\nvalue in the SetupIntent.", "properties": { "acss_debit": { "properties": { "account_number": { "maxLength": 5000, "type": "string" }, "institution_number": { "maxLength": 5000, "type": "string" }, "transit_number": { "maxLength": 5000, "type": "string" } }, "required": [ "account_number", "institution_number", "transit_number" ], "title": "payment_method_param", "type": "object" }, "affirm": { "properties": {}, "title": "param", "type": "object" }, "afterpay_clearpay": { "properties": {}, "title": "param", "type": "object" }, "alipay": { "properties": {}, "title": "param", "type": "object" }, "allow_redisplay": { "enum": [ "always", "limited", "unspecified" ], "type": "string" }, "alma": { "properties": {}, "title": "param", "type": "object" }, "amazon_pay": { "properties": {}, "title": "param", "type": "object" }, "au_becs_debit": { "properties": { "account_number": { "maxLength": 5000, "type": "string" }, "bsb_number": { "maxLength": 5000, "type": "string" } }, "required": [ "account_number", "bsb_number" ], "title": "param", "type": "object" }, "bacs_debit": { "properties": { "account_number": { "maxLength": 5000, "type": "string" }, "sort_code": { "maxLength": 5000, "type": "string" } }, "title": "param", "type": "object" }, "bancontact": { "properties": {}, "title": "param", "type": "object" }, "billie": { "properties": {}, "title": "param", "type": "object" }, "billing_details": { "properties": { "address": { "anyOf": [ { "properties": { "city": { "maxLength": 5000, "type": "string" }, "country": { "maxLength": 5000, "type": "string" }, "line1": { "maxLength": 5000, "type": "string" }, "line2": { "maxLength": 5000, "type": "string" }, "postal_code": { "maxLength": 5000, "type": "string" }, "state": { "maxLength": 5000, "type": "string" } }, "title": "billing_details_address", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "email": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "name": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "phone": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "tax_id": { "maxLength": 5000, "type": "string" } }, "title": "billing_details_inner_params", "type": "object" }, "blik": { "properties": {}, "title": "param", "type": "object" }, "boleto": { "properties": { "tax_id": { "maxLength": 5000, "type": "string" } }, "required": [ "tax_id" ], "title": "param", "type": "object" }, "cashapp": { "properties": {}, "title": "param", "type": "object" }, "crypto": { "properties": {}, "title": "param", "type": "object" }, "customer_balance": { "properties": {}, "title": "param", "type": "object" }, "eps": { "properties": { "bank": { "enum": [ "arzte_und_apotheker_bank", "austrian_anadi_bank_ag", "bank_austria", "bankhaus_carl_spangler", "bankhaus_schelhammer_und_schattera_ag", "bawag_psk_ag", "bks_bank_ag", "brull_kallmus_bank_ag", "btv_vier_lander_bank", "capital_bank_grawe_gruppe_ag", "deutsche_bank_ag", "dolomitenbank", "easybank_ag", "erste_bank_und_sparkassen", "hypo_alpeadriabank_international_ag", "hypo_bank_burgenland_aktiengesellschaft", "hypo_noe_lb_fur_niederosterreich_u_wien", "hypo_oberosterreich_salzburg_steiermark", "hypo_tirol_bank_ag", "hypo_vorarlberg_bank_ag", "marchfelder_bank", "oberbank_ag", "raiffeisen_bankengruppe_osterreich", "schoellerbank_ag", "sparda_bank_wien", "volksbank_gruppe", "volkskreditbank_ag", "vr_bank_braunau" ], "maxLength": 5000, "type": "string" } }, "title": "param", "type": "object" }, "fpx": { "properties": { "bank": { "enum": [ "affin_bank", "agrobank", "alliance_bank", "ambank", "bank_islam", "bank_muamalat", "bank_of_china", "bank_rakyat", "bsn", "cimb", "deutsche_bank", "hong_leong_bank", "hsbc", "kfh", "maybank2e", "maybank2u", "ocbc", "pb_enterprise", "public_bank", "rhb", "standard_chartered", "uob" ], "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true } }, "required": [ "bank" ], "title": "param", "type": "object" }, "giropay": { "properties": {}, "title": "param", "type": "object" }, "grabpay": { "properties": {}, "title": "param", "type": "object" }, "ideal": { "properties": { "bank": { "enum": [ "abn_amro", "asn_bank", "bunq", "buut", "handelsbanken", "ing", "knab", "moneyou", "n26", "nn", "rabobank", "regiobank", "revolut", "sns_bank", "triodos_bank", "van_lanschot", "yoursafe" ], "maxLength": 5000, "type": "string" } }, "title": "param", "type": "object" }, "interac_present": { "properties": {}, "title": "param", "type": "object" }, "kakao_pay": { "properties": {}, "title": "param", "type": "object" }, "klarna": { "properties": { "dob": { "properties": { "day": { "type": "integer" }, "month": { "type": "integer" }, "year": { "type": "integer" } }, "required": [ "day", "month", "year" ], "title": "date_of_birth", "type": "object" } }, "title": "param", "type": "object" }, "konbini": { "properties": {}, "title": "param", "type": "object" }, "kr_card": { "properties": {}, "title": "param", "type": "object" }, "link": { "properties": {}, "title": "param", "type": "object" }, "metadata": { "additionalProperties": { "type": "string" }, "type": "object" }, "mobilepay": { "properties": {}, "title": "param", "type": "object" }, "multibanco": { "properties": {}, "title": "param", "type": "object" }, "naver_pay": { "properties": { "funding": { "enum": [ "card", "points" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "param", "type": "object" }, "nz_bank_account": { "properties": { "account_holder_name": { "maxLength": 5000, "type": "string" }, "account_number": { "maxLength": 5000, "type": "string" }, "bank_code": { "maxLength": 5000, "type": "string" }, "branch_code": { "maxLength": 5000, "type": "string" }, "reference": { "maxLength": 128, "type": "string" }, "suffix": { "maxLength": 5000, "type": "string" } }, "required": [ "account_number", "bank_code", "branch_code", "suffix" ], "title": "param", "type": "object" }, "oxxo": { "properties": {}, "title": "param", "type": "object" }, "p24": { "properties": { "bank": { "enum": [ "alior_bank", "bank_millennium", "bank_nowy_bfg_sa", "bank_pekao_sa", "banki_spbdzielcze", "blik", "bnp_paribas", "boz", "citi_handlowy", "credit_agricole", "envelobank", "etransfer_pocztowy24", "getin_bank", "ideabank", "ing", "inteligo", "mbank_mtransfer", "nest_przelew", "noble_pay", "pbac_z_ipko", "plus_bank", "santander_przelew24", "tmobile_usbugi_bankowe", "toyota_bank", "velobank", "volkswagen_bank" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "param", "type": "object" }, "pay_by_bank": { "properties": {}, "title": "param", "type": "object" }, "payco": { "properties": {}, "title": "param", "type": "object" }, "paynow": { "properties": {}, "title": "param", "type": "object" }, "paypal": { "properties": {}, "title": "param", "type": "object" }, "pix": { "properties": {}, "title": "param", "type": "object" }, "promptpay": { "properties": {}, "title": "param", "type": "object" }, "radar_options": { "properties": { "session": { "maxLength": 5000, "type": "string" } }, "title": "radar_options_with_hidden_options", "type": "object" }, "revolut_pay": { "properties": {}, "title": "param", "type": "object" }, "samsung_pay": { "properties": {}, "title": "param", "type": "object" }, "satispay": { "properties": {}, "title": "param", "type": "object" }, "sepa_debit": { "properties": { "iban": { "maxLength": 5000, "type": "string" } }, "required": [ "iban" ], "title": "param", "type": "object" }, "sofort": { "properties": { "country": { "enum": [ "AT", "BE", "DE", "ES", "IT", "NL" ], "type": "string" } }, "required": [ "country" ], "title": "param", "type": "object" }, "swish": { "properties": {}, "title": "param", "type": "object" }, "twint": { "properties": {}, "title": "param", "type": "object" }, "type": { "enum": [ "acss_debit", "affirm", "afterpay_clearpay", "alipay", "alma", "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", "billie", "blik", "boleto", "cashapp", "crypto", "customer_balance", "eps", "fpx", "giropay", "grabpay", "ideal", "kakao_pay", "klarna", "konbini", "kr_card", "link", "mobilepay", "multibanco", "naver_pay", "nz_bank_account", "oxxo", "p24", "pay_by_bank", "payco", "paynow", "paypal", "pix", "promptpay", "revolut_pay", "samsung_pay", "satispay", "sepa_debit", "sofort", "swish", "twint", "us_bank_account", "wechat_pay", "zip" ], "type": "string", "x-stripeBypassValidation": true }, "us_bank_account": { "properties": { "account_holder_type": { "enum": [ "company", "individual" ], "type": "string" }, "account_number": { "maxLength": 5000, "type": "string" }, "account_type": { "enum": [ "checking", "savings" ], "type": "string" }, "financial_connections_account": { "maxLength": 5000, "type": "string" }, "routing_number": { "maxLength": 5000, "type": "string" } }, "title": "payment_method_param", "type": "object" }, "wechat_pay": { "properties": {}, "title": "param", "type": "object" }, "zip": { "properties": {}, "title": "param", "type": "object" } }, "required": [ "type" ], "title": "payment_method_data_params", "type": "object" }, "payment_method_options": { "description": "Payment method-specific configuration for this SetupIntent.", "properties": { "acss_debit": { "properties": { "currency": { "enum": [ "cad", "usd" ], "type": "string" }, "mandate_options": { "properties": { "custom_mandate_url": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "default_for": { "items": { "enum": [ "invoice", "subscription" ], "type": "string" }, "type": "array" }, "interval_description": { "maxLength": 500, "type": "string" }, "payment_schedule": { "enum": [ "combined", "interval", "sporadic" ], "type": "string" }, "transaction_type": { "enum": [ "business", "personal" ], "type": "string" } }, "title": "setup_intent_payment_method_options_mandate_options_param", "type": "object" }, "verification_method": { "enum": [ "automatic", "instant", "microdeposits" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "setup_intent_payment_method_options_param", "type": "object" }, "amazon_pay": { "properties": {}, "title": "setup_intent_payment_method_options_param", "type": "object" }, "bacs_debit": { "properties": { "mandate_options": { "properties": { "reference_prefix": { "anyOf": [ { "maxLength": 12, "type": "string" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "payment_method_options_mandate_options_param", "type": "object" } }, "title": "setup_intent_payment_method_options_param", "type": "object" }, "card": { "properties": { "mandate_options": { "properties": { "amount": { "type": "integer" }, "amount_type": { "enum": [ "fixed", "maximum" ], "type": "string" }, "currency": { "format": "currency", "type": "string" }, "description": { "maxLength": 200, "type": "string" }, "end_date": { "format": "unix-time", "type": "integer" }, "interval": { "enum": [ "day", "month", "sporadic", "week", "year" ], "type": "string" }, "interval_count": { "type": "integer" }, "reference": { "maxLength": 80, "type": "string" }, "start_date": { "format": "unix-time", "type": "integer" }, "supported_types": { "items": { "enum": [ "india" ], "type": "string" }, "type": "array" } }, "required": [ "amount", "amount_type", "currency", "interval", "reference", "start_date" ], "title": "setup_intent_mandate_options_param", "type": "object" }, "network": { "enum": [ "amex", "cartes_bancaires", "diners", "discover", "eftpos_au", "girocard", "interac", "jcb", "link", "mastercard", "unionpay", "unknown", "visa" ], "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true }, "request_three_d_secure": { "enum": [ "any", "automatic", "challenge" ], "type": "string", "x-stripeBypassValidation": true }, "three_d_secure": { "properties": { "ares_trans_status": { "enum": [ "A", "C", "I", "N", "R", "U", "Y" ], "type": "string" }, "cryptogram": { "maxLength": 5000, "type": "string" }, "electronic_commerce_indicator": { "enum": [ "01", "02", "05", "06", "07" ], "type": "string", "x-stripeBypassValidation": true }, "network_options": { "properties": { "cartes_bancaires": { "properties": { "cb_avalgo": { "enum": [ "0", "1", "2", "3", "4", "A" ], "type": "string" }, "cb_exemption": { "maxLength": 4, "type": "string" }, "cb_score": { "type": "integer" } }, "required": [ "cb_avalgo" ], "title": "cartes_bancaires_network_options_param", "type": "object" } }, "title": "network_options_param", "type": "object" }, "requestor_challenge_indicator": { "maxLength": 2, "type": "string" }, "transaction_id": { "maxLength": 5000, "type": "string" }, "version": { "enum": [ "1.0.2", "2.1.0", "2.2.0" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "setup_intent_payment_method_options_param", "type": "object" } }, "title": "setup_intent_param", "type": "object" }, "card_present": { "properties": {}, "title": "setup_intent_payment_method_options_param", "type": "object" }, "klarna": { "properties": { "currency": { "format": "currency", "type": "string" }, "on_demand": { "properties": { "average_amount": { "type": "integer" }, "maximum_amount": { "type": "integer" }, "minimum_amount": { "type": "integer" }, "purchase_interval": { "enum": [ "day", "month", "week", "year" ], "type": "string" }, "purchase_interval_count": { "type": "integer" } }, "title": "on_demand_param", "type": "object" }, "preferred_locale": { "enum": [ "cs-CZ", "da-DK", "de-AT", "de-CH", "de-DE", "el-GR", "en-AT", "en-AU", "en-BE", "en-CA", "en-CH", "en-CZ", "en-DE", "en-DK", "en-ES", "en-FI", "en-FR", "en-GB", "en-GR", "en-IE", "en-IT", "en-NL", "en-NO", "en-NZ", "en-PL", "en-PT", "en-RO", "en-SE", "en-US", "es-ES", "es-US", "fi-FI", "fr-BE", "fr-CA", "fr-CH", "fr-FR", "it-CH", "it-IT", "nb-NO", "nl-BE", "nl-NL", "pl-PL", "pt-PT", "ro-RO", "sv-FI", "sv-SE" ], "type": "string", "x-stripeBypassValidation": true }, "subscriptions": { "anyOf": [ { "items": { "properties": { "interval": { "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "type": "integer" }, "name": { "maxLength": 255, "type": "string" }, "next_billing": { "properties": { "amount": { "type": "integer" }, "date": { "maxLength": 5000, "type": "string" } }, "required": [ "amount", "date" ], "title": "subscription_next_billing_param", "type": "object" }, "reference": { "maxLength": 255, "type": "string" } }, "required": [ "interval", "next_billing", "reference" ], "title": "setup_intent_subscription_param", "type": "object" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "setup_intent_payment_method_options_param", "type": "object" }, "link": { "properties": {}, "title": "setup_intent_payment_method_options_param", "type": "object" }, "paypal": { "properties": { "billing_agreement_id": { "maxLength": 5000, "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, "sepa_debit": { "properties": { "mandate_options": { "properties": { "reference_prefix": { "anyOf": [ { "maxLength": 12, "type": "string" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "payment_method_options_mandate_options_param", "type": "object" } }, "title": "setup_intent_payment_method_options_param", "type": "object" }, "us_bank_account": { "properties": { "financial_connections": { "properties": { "filters": { "properties": { "account_subcategories": { "items": { "enum": [ "checking", "savings" ], "maxLength": 5000, "type": "string" }, "type": "array" } }, "title": "linked_account_options_filters_param", "type": "object" }, "permissions": { "items": { "enum": [ "balances", "ownership", "payment_method", "transactions" ], "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true }, "type": "array" }, "prefetch": { "items": { "enum": [ "balances", "ownership", "transactions" ], "type": "string", "x-stripeBypassValidation": true }, "type": "array" }, "return_url": { "maxLength": 5000, "type": "string" } }, "title": "linked_account_options_param", "type": "object" }, "mandate_options": { "properties": { "collection_method": { "enum": [ "", "paper" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "mandate_options_param", "type": "object" }, "networks": { "properties": { "requested": { "items": { "enum": [ "ach", "us_domestic_wire" ], "type": "string" }, "type": "array" } }, "title": "networks_options_param", "type": "object" }, "verification_method": { "enum": [ "automatic", "instant", "microdeposits" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "setup_intent_payment_method_options_param", "type": "object" } }, "title": "payment_method_options_param", "type": "object" }, "payment_method_types": { "description": "The list of payment method types (for example, card) that this SetupIntent can set up. If you don't provide this, Stripe will dynamically show relevant payment methods from your [payment method settings](https://dashboard.stripe.com/settings/payment_methods). A list of valid payment method types can be found [here](https://docs.stripe.com/api/payment_methods/object#payment_method_object-type).", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setup_intent" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a SetupIntent" } }, "/v1/setup_intents/{intent}/cancel": { "post": { "description": "

You can cancel a SetupIntent object when it’s in one of these statuses: requires_payment_method, requires_confirmation, or requires_action.

\n\n

After you cancel it, setup is abandoned and any operations on the SetupIntent fail with an error. You can’t cancel the SetupIntent for a Checkout Session. Expire the Checkout Session instead.

", "operationId": "PostSetupIntentsIntentCancel", "parameters": [ { "in": "path", "name": "intent", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "cancellation_reason": { "description": "Reason for canceling this SetupIntent. Possible values are: `abandoned`, `requested_by_customer`, or `duplicate`", "enum": [ "abandoned", "duplicate", "requested_by_customer" ], "maxLength": 5000, "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setup_intent" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Cancel a SetupIntent" } }, "/v1/setup_intents/{intent}/confirm": { "post": { "description": "

Confirm that your customer intends to set up the current or\nprovided payment method. For example, you would confirm a SetupIntent\nwhen a customer hits the “Save” button on a payment method management\npage on your website.

\n\n

If the selected payment method does not require any additional\nsteps from the customer, the SetupIntent will transition to the\nsucceeded status.

\n\n

Otherwise, it will transition to the requires_action status and\nsuggest additional actions via next_action. If setup fails,\nthe SetupIntent will transition to the\nrequires_payment_method status or the canceled status if the\nconfirmation limit is reached.

", "operationId": "PostSetupIntentsIntentConfirm", "parameters": [ { "in": "path", "name": "intent", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "mandate_data": { "explode": true, "style": "deepObject" }, "payment_method_data": { "explode": true, "style": "deepObject" }, "payment_method_options": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "client_secret": { "description": "The client secret of the SetupIntent.", "maxLength": 5000, "type": "string" }, "confirmation_token": { "description": "ID of the ConfirmationToken used to confirm this SetupIntent.\n\nIf the provided ConfirmationToken contains properties that are also being provided in this request, such as `payment_method`, then the values in this request will take precedence.", "maxLength": 5000, "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "mandate_data": { "anyOf": [ { "properties": { "customer_acceptance": { "properties": { "accepted_at": { "format": "unix-time", "type": "integer" }, "offline": { "properties": {}, "title": "offline_param", "type": "object" }, "online": { "properties": { "ip_address": { "type": "string" }, "user_agent": { "maxLength": 5000, "type": "string" } }, "required": [ "ip_address", "user_agent" ], "title": "online_param", "type": "object" }, "type": { "enum": [ "offline", "online" ], "maxLength": 5000, "type": "string" } }, "required": [ "type" ], "title": "customer_acceptance_param", "type": "object" } }, "required": [ "customer_acceptance" ], "title": "secret_key_param", "type": "object" }, { "enum": [ "" ], "type": "string" }, { "description": "This hash contains details about the Mandate to create", "properties": { "customer_acceptance": { "properties": { "online": { "properties": { "ip_address": { "type": "string" }, "user_agent": { "maxLength": 5000, "type": "string" } }, "title": "online_param", "type": "object" }, "type": { "enum": [ "online" ], "maxLength": 5000, "type": "string" } }, "required": [ "online", "type" ], "title": "customer_acceptance_param", "type": "object" } }, "required": [ "customer_acceptance" ], "title": "client_key_param", "type": "object" } ] }, "payment_method": { "description": "ID of the payment method (a PaymentMethod, Card, or saved Source object) to attach to this SetupIntent.", "maxLength": 5000, "type": "string" }, "payment_method_data": { "description": "When included, this hash creates a PaymentMethod that is set as the [`payment_method`](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-payment_method)\nvalue in the SetupIntent.", "properties": { "acss_debit": { "properties": { "account_number": { "maxLength": 5000, "type": "string" }, "institution_number": { "maxLength": 5000, "type": "string" }, "transit_number": { "maxLength": 5000, "type": "string" } }, "required": [ "account_number", "institution_number", "transit_number" ], "title": "payment_method_param", "type": "object" }, "affirm": { "properties": {}, "title": "param", "type": "object" }, "afterpay_clearpay": { "properties": {}, "title": "param", "type": "object" }, "alipay": { "properties": {}, "title": "param", "type": "object" }, "allow_redisplay": { "enum": [ "always", "limited", "unspecified" ], "type": "string" }, "alma": { "properties": {}, "title": "param", "type": "object" }, "amazon_pay": { "properties": {}, "title": "param", "type": "object" }, "au_becs_debit": { "properties": { "account_number": { "maxLength": 5000, "type": "string" }, "bsb_number": { "maxLength": 5000, "type": "string" } }, "required": [ "account_number", "bsb_number" ], "title": "param", "type": "object" }, "bacs_debit": { "properties": { "account_number": { "maxLength": 5000, "type": "string" }, "sort_code": { "maxLength": 5000, "type": "string" } }, "title": "param", "type": "object" }, "bancontact": { "properties": {}, "title": "param", "type": "object" }, "billie": { "properties": {}, "title": "param", "type": "object" }, "billing_details": { "properties": { "address": { "anyOf": [ { "properties": { "city": { "maxLength": 5000, "type": "string" }, "country": { "maxLength": 5000, "type": "string" }, "line1": { "maxLength": 5000, "type": "string" }, "line2": { "maxLength": 5000, "type": "string" }, "postal_code": { "maxLength": 5000, "type": "string" }, "state": { "maxLength": 5000, "type": "string" } }, "title": "billing_details_address", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "email": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "name": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "phone": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "tax_id": { "maxLength": 5000, "type": "string" } }, "title": "billing_details_inner_params", "type": "object" }, "blik": { "properties": {}, "title": "param", "type": "object" }, "boleto": { "properties": { "tax_id": { "maxLength": 5000, "type": "string" } }, "required": [ "tax_id" ], "title": "param", "type": "object" }, "cashapp": { "properties": {}, "title": "param", "type": "object" }, "crypto": { "properties": {}, "title": "param", "type": "object" }, "customer_balance": { "properties": {}, "title": "param", "type": "object" }, "eps": { "properties": { "bank": { "enum": [ "arzte_und_apotheker_bank", "austrian_anadi_bank_ag", "bank_austria", "bankhaus_carl_spangler", "bankhaus_schelhammer_und_schattera_ag", "bawag_psk_ag", "bks_bank_ag", "brull_kallmus_bank_ag", "btv_vier_lander_bank", "capital_bank_grawe_gruppe_ag", "deutsche_bank_ag", "dolomitenbank", "easybank_ag", "erste_bank_und_sparkassen", "hypo_alpeadriabank_international_ag", "hypo_bank_burgenland_aktiengesellschaft", "hypo_noe_lb_fur_niederosterreich_u_wien", "hypo_oberosterreich_salzburg_steiermark", "hypo_tirol_bank_ag", "hypo_vorarlberg_bank_ag", "marchfelder_bank", "oberbank_ag", "raiffeisen_bankengruppe_osterreich", "schoellerbank_ag", "sparda_bank_wien", "volksbank_gruppe", "volkskreditbank_ag", "vr_bank_braunau" ], "maxLength": 5000, "type": "string" } }, "title": "param", "type": "object" }, "fpx": { "properties": { "bank": { "enum": [ "affin_bank", "agrobank", "alliance_bank", "ambank", "bank_islam", "bank_muamalat", "bank_of_china", "bank_rakyat", "bsn", "cimb", "deutsche_bank", "hong_leong_bank", "hsbc", "kfh", "maybank2e", "maybank2u", "ocbc", "pb_enterprise", "public_bank", "rhb", "standard_chartered", "uob" ], "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true } }, "required": [ "bank" ], "title": "param", "type": "object" }, "giropay": { "properties": {}, "title": "param", "type": "object" }, "grabpay": { "properties": {}, "title": "param", "type": "object" }, "ideal": { "properties": { "bank": { "enum": [ "abn_amro", "asn_bank", "bunq", "buut", "handelsbanken", "ing", "knab", "moneyou", "n26", "nn", "rabobank", "regiobank", "revolut", "sns_bank", "triodos_bank", "van_lanschot", "yoursafe" ], "maxLength": 5000, "type": "string" } }, "title": "param", "type": "object" }, "interac_present": { "properties": {}, "title": "param", "type": "object" }, "kakao_pay": { "properties": {}, "title": "param", "type": "object" }, "klarna": { "properties": { "dob": { "properties": { "day": { "type": "integer" }, "month": { "type": "integer" }, "year": { "type": "integer" } }, "required": [ "day", "month", "year" ], "title": "date_of_birth", "type": "object" } }, "title": "param", "type": "object" }, "konbini": { "properties": {}, "title": "param", "type": "object" }, "kr_card": { "properties": {}, "title": "param", "type": "object" }, "link": { "properties": {}, "title": "param", "type": "object" }, "metadata": { "additionalProperties": { "type": "string" }, "type": "object" }, "mobilepay": { "properties": {}, "title": "param", "type": "object" }, "multibanco": { "properties": {}, "title": "param", "type": "object" }, "naver_pay": { "properties": { "funding": { "enum": [ "card", "points" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "param", "type": "object" }, "nz_bank_account": { "properties": { "account_holder_name": { "maxLength": 5000, "type": "string" }, "account_number": { "maxLength": 5000, "type": "string" }, "bank_code": { "maxLength": 5000, "type": "string" }, "branch_code": { "maxLength": 5000, "type": "string" }, "reference": { "maxLength": 128, "type": "string" }, "suffix": { "maxLength": 5000, "type": "string" } }, "required": [ "account_number", "bank_code", "branch_code", "suffix" ], "title": "param", "type": "object" }, "oxxo": { "properties": {}, "title": "param", "type": "object" }, "p24": { "properties": { "bank": { "enum": [ "alior_bank", "bank_millennium", "bank_nowy_bfg_sa", "bank_pekao_sa", "banki_spbdzielcze", "blik", "bnp_paribas", "boz", "citi_handlowy", "credit_agricole", "envelobank", "etransfer_pocztowy24", "getin_bank", "ideabank", "ing", "inteligo", "mbank_mtransfer", "nest_przelew", "noble_pay", "pbac_z_ipko", "plus_bank", "santander_przelew24", "tmobile_usbugi_bankowe", "toyota_bank", "velobank", "volkswagen_bank" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "param", "type": "object" }, "pay_by_bank": { "properties": {}, "title": "param", "type": "object" }, "payco": { "properties": {}, "title": "param", "type": "object" }, "paynow": { "properties": {}, "title": "param", "type": "object" }, "paypal": { "properties": {}, "title": "param", "type": "object" }, "pix": { "properties": {}, "title": "param", "type": "object" }, "promptpay": { "properties": {}, "title": "param", "type": "object" }, "radar_options": { "properties": { "session": { "maxLength": 5000, "type": "string" } }, "title": "radar_options_with_hidden_options", "type": "object" }, "revolut_pay": { "properties": {}, "title": "param", "type": "object" }, "samsung_pay": { "properties": {}, "title": "param", "type": "object" }, "satispay": { "properties": {}, "title": "param", "type": "object" }, "sepa_debit": { "properties": { "iban": { "maxLength": 5000, "type": "string" } }, "required": [ "iban" ], "title": "param", "type": "object" }, "sofort": { "properties": { "country": { "enum": [ "AT", "BE", "DE", "ES", "IT", "NL" ], "type": "string" } }, "required": [ "country" ], "title": "param", "type": "object" }, "swish": { "properties": {}, "title": "param", "type": "object" }, "twint": { "properties": {}, "title": "param", "type": "object" }, "type": { "enum": [ "acss_debit", "affirm", "afterpay_clearpay", "alipay", "alma", "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", "billie", "blik", "boleto", "cashapp", "crypto", "customer_balance", "eps", "fpx", "giropay", "grabpay", "ideal", "kakao_pay", "klarna", "konbini", "kr_card", "link", "mobilepay", "multibanco", "naver_pay", "nz_bank_account", "oxxo", "p24", "pay_by_bank", "payco", "paynow", "paypal", "pix", "promptpay", "revolut_pay", "samsung_pay", "satispay", "sepa_debit", "sofort", "swish", "twint", "us_bank_account", "wechat_pay", "zip" ], "type": "string", "x-stripeBypassValidation": true }, "us_bank_account": { "properties": { "account_holder_type": { "enum": [ "company", "individual" ], "type": "string" }, "account_number": { "maxLength": 5000, "type": "string" }, "account_type": { "enum": [ "checking", "savings" ], "type": "string" }, "financial_connections_account": { "maxLength": 5000, "type": "string" }, "routing_number": { "maxLength": 5000, "type": "string" } }, "title": "payment_method_param", "type": "object" }, "wechat_pay": { "properties": {}, "title": "param", "type": "object" }, "zip": { "properties": {}, "title": "param", "type": "object" } }, "required": [ "type" ], "title": "payment_method_data_params", "type": "object" }, "payment_method_options": { "description": "Payment method-specific configuration for this SetupIntent.", "properties": { "acss_debit": { "properties": { "currency": { "enum": [ "cad", "usd" ], "type": "string" }, "mandate_options": { "properties": { "custom_mandate_url": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "default_for": { "items": { "enum": [ "invoice", "subscription" ], "type": "string" }, "type": "array" }, "interval_description": { "maxLength": 500, "type": "string" }, "payment_schedule": { "enum": [ "combined", "interval", "sporadic" ], "type": "string" }, "transaction_type": { "enum": [ "business", "personal" ], "type": "string" } }, "title": "setup_intent_payment_method_options_mandate_options_param", "type": "object" }, "verification_method": { "enum": [ "automatic", "instant", "microdeposits" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "setup_intent_payment_method_options_param", "type": "object" }, "amazon_pay": { "properties": {}, "title": "setup_intent_payment_method_options_param", "type": "object" }, "bacs_debit": { "properties": { "mandate_options": { "properties": { "reference_prefix": { "anyOf": [ { "maxLength": 12, "type": "string" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "payment_method_options_mandate_options_param", "type": "object" } }, "title": "setup_intent_payment_method_options_param", "type": "object" }, "card": { "properties": { "mandate_options": { "properties": { "amount": { "type": "integer" }, "amount_type": { "enum": [ "fixed", "maximum" ], "type": "string" }, "currency": { "format": "currency", "type": "string" }, "description": { "maxLength": 200, "type": "string" }, "end_date": { "format": "unix-time", "type": "integer" }, "interval": { "enum": [ "day", "month", "sporadic", "week", "year" ], "type": "string" }, "interval_count": { "type": "integer" }, "reference": { "maxLength": 80, "type": "string" }, "start_date": { "format": "unix-time", "type": "integer" }, "supported_types": { "items": { "enum": [ "india" ], "type": "string" }, "type": "array" } }, "required": [ "amount", "amount_type", "currency", "interval", "reference", "start_date" ], "title": "setup_intent_mandate_options_param", "type": "object" }, "network": { "enum": [ "amex", "cartes_bancaires", "diners", "discover", "eftpos_au", "girocard", "interac", "jcb", "link", "mastercard", "unionpay", "unknown", "visa" ], "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true }, "request_three_d_secure": { "enum": [ "any", "automatic", "challenge" ], "type": "string", "x-stripeBypassValidation": true }, "three_d_secure": { "properties": { "ares_trans_status": { "enum": [ "A", "C", "I", "N", "R", "U", "Y" ], "type": "string" }, "cryptogram": { "maxLength": 5000, "type": "string" }, "electronic_commerce_indicator": { "enum": [ "01", "02", "05", "06", "07" ], "type": "string", "x-stripeBypassValidation": true }, "network_options": { "properties": { "cartes_bancaires": { "properties": { "cb_avalgo": { "enum": [ "0", "1", "2", "3", "4", "A" ], "type": "string" }, "cb_exemption": { "maxLength": 4, "type": "string" }, "cb_score": { "type": "integer" } }, "required": [ "cb_avalgo" ], "title": "cartes_bancaires_network_options_param", "type": "object" } }, "title": "network_options_param", "type": "object" }, "requestor_challenge_indicator": { "maxLength": 2, "type": "string" }, "transaction_id": { "maxLength": 5000, "type": "string" }, "version": { "enum": [ "1.0.2", "2.1.0", "2.2.0" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "setup_intent_payment_method_options_param", "type": "object" } }, "title": "setup_intent_param", "type": "object" }, "card_present": { "properties": {}, "title": "setup_intent_payment_method_options_param", "type": "object" }, "klarna": { "properties": { "currency": { "format": "currency", "type": "string" }, "on_demand": { "properties": { "average_amount": { "type": "integer" }, "maximum_amount": { "type": "integer" }, "minimum_amount": { "type": "integer" }, "purchase_interval": { "enum": [ "day", "month", "week", "year" ], "type": "string" }, "purchase_interval_count": { "type": "integer" } }, "title": "on_demand_param", "type": "object" }, "preferred_locale": { "enum": [ "cs-CZ", "da-DK", "de-AT", "de-CH", "de-DE", "el-GR", "en-AT", "en-AU", "en-BE", "en-CA", "en-CH", "en-CZ", "en-DE", "en-DK", "en-ES", "en-FI", "en-FR", "en-GB", "en-GR", "en-IE", "en-IT", "en-NL", "en-NO", "en-NZ", "en-PL", "en-PT", "en-RO", "en-SE", "en-US", "es-ES", "es-US", "fi-FI", "fr-BE", "fr-CA", "fr-CH", "fr-FR", "it-CH", "it-IT", "nb-NO", "nl-BE", "nl-NL", "pl-PL", "pt-PT", "ro-RO", "sv-FI", "sv-SE" ], "type": "string", "x-stripeBypassValidation": true }, "subscriptions": { "anyOf": [ { "items": { "properties": { "interval": { "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "type": "integer" }, "name": { "maxLength": 255, "type": "string" }, "next_billing": { "properties": { "amount": { "type": "integer" }, "date": { "maxLength": 5000, "type": "string" } }, "required": [ "amount", "date" ], "title": "subscription_next_billing_param", "type": "object" }, "reference": { "maxLength": 255, "type": "string" } }, "required": [ "interval", "next_billing", "reference" ], "title": "setup_intent_subscription_param", "type": "object" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "setup_intent_payment_method_options_param", "type": "object" }, "link": { "properties": {}, "title": "setup_intent_payment_method_options_param", "type": "object" }, "paypal": { "properties": { "billing_agreement_id": { "maxLength": 5000, "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, "sepa_debit": { "properties": { "mandate_options": { "properties": { "reference_prefix": { "anyOf": [ { "maxLength": 12, "type": "string" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "payment_method_options_mandate_options_param", "type": "object" } }, "title": "setup_intent_payment_method_options_param", "type": "object" }, "us_bank_account": { "properties": { "financial_connections": { "properties": { "filters": { "properties": { "account_subcategories": { "items": { "enum": [ "checking", "savings" ], "maxLength": 5000, "type": "string" }, "type": "array" } }, "title": "linked_account_options_filters_param", "type": "object" }, "permissions": { "items": { "enum": [ "balances", "ownership", "payment_method", "transactions" ], "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true }, "type": "array" }, "prefetch": { "items": { "enum": [ "balances", "ownership", "transactions" ], "type": "string", "x-stripeBypassValidation": true }, "type": "array" }, "return_url": { "maxLength": 5000, "type": "string" } }, "title": "linked_account_options_param", "type": "object" }, "mandate_options": { "properties": { "collection_method": { "enum": [ "", "paper" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "mandate_options_param", "type": "object" }, "networks": { "properties": { "requested": { "items": { "enum": [ "ach", "us_domestic_wire" ], "type": "string" }, "type": "array" } }, "title": "networks_options_param", "type": "object" }, "verification_method": { "enum": [ "automatic", "instant", "microdeposits" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "setup_intent_payment_method_options_param", "type": "object" } }, "title": "payment_method_options_param", "type": "object" }, "return_url": { "description": "The URL to redirect your customer back to after they authenticate on the payment method's app or site.\nIf you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme.\nThis parameter is only used for cards and other redirect-based payment methods.", "type": "string" }, "use_stripe_sdk": { "description": "Set to `true` when confirming server-side and using Stripe.js, iOS, or Android client-side SDKs to handle the next actions.", "type": "boolean" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setup_intent" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Confirm a SetupIntent" } }, "/v1/setup_intents/{intent}/verify_microdeposits": { "post": { "description": "

Verifies microdeposits on a SetupIntent object.

", "operationId": "PostSetupIntentsIntentVerifyMicrodeposits", "parameters": [ { "in": "path", "name": "intent", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "amounts": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "amounts": { "description": "Two positive integers, in *cents*, equal to the values of the microdeposits sent to the bank account.", "items": { "type": "integer" }, "type": "array" }, "client_secret": { "description": "The client secret of the SetupIntent.", "maxLength": 5000, "type": "string" }, "descriptor_code": { "description": "A six-character code starting with SM present in the microdeposit sent to the bank account.", "maxLength": 5000, "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setup_intent" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Verify microdeposits on a SetupIntent" } }, "/v1/shipping_rates": { "get": { "description": "

Returns a list of your shipping rates.

", "operationId": "GetShippingRates", "parameters": [ { "description": "Only return shipping rates that are active or inactive.", "in": "query", "name": "active", "required": false, "schema": { "type": "boolean" }, "style": "form" }, { "description": "A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.", "explode": true, "in": "query", "name": "created", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "type": "integer" }, "gte": { "type": "integer" }, "lt": { "type": "integer" }, "lte": { "type": "integer" } }, "title": "range_query_specs", "type": "object" }, { "type": "integer" } ] }, "style": "deepObject" }, { "description": "Only return shipping rates for the given currency.", "in": "query", "name": "currency", "required": false, "schema": { "format": "currency", "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/shipping_rate" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/shipping_rates", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "ShippingResourcesShippingRateList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all shipping rates" }, "post": { "description": "

Creates a new shipping rate object.

", "operationId": "PostShippingRates", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "delivery_estimate": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "fixed_amount": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "delivery_estimate": { "description": "The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.", "properties": { "maximum": { "properties": { "unit": { "enum": [ "business_day", "day", "hour", "month", "week" ], "type": "string" }, "value": { "type": "integer" } }, "required": [ "unit", "value" ], "title": "delivery_estimate_bound", "type": "object" }, "minimum": { "properties": { "unit": { "enum": [ "business_day", "day", "hour", "month", "week" ], "type": "string" }, "value": { "type": "integer" } }, "required": [ "unit", "value" ], "title": "delivery_estimate_bound", "type": "object" } }, "title": "delivery_estimate", "type": "object" }, "display_name": { "description": "The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.", "maxLength": 100, "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "fixed_amount": { "description": "Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`.", "properties": { "amount": { "type": "integer" }, "currency": { "format": "currency", "type": "string" }, "currency_options": { "additionalProperties": { "properties": { "amount": { "type": "integer" }, "tax_behavior": { "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" } }, "required": [ "amount" ], "title": "currency_option", "type": "object" }, "type": "object" } }, "required": [ "amount", "currency" ], "title": "fixed_amount", "type": "object" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "tax_behavior": { "description": "Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.", "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" }, "tax_code": { "description": "A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`.", "type": "string" }, "type": { "description": "The type of calculation to use on the shipping rate.", "enum": [ "fixed_amount" ], "type": "string" } }, "required": [ "display_name" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_rate" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a shipping rate" } }, "/v1/shipping_rates/{shipping_rate_token}": { "get": { "description": "

Returns the shipping rate object with the given ID.

", "operationId": "GetShippingRatesShippingRateToken", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "shipping_rate_token", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_rate" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a shipping rate" }, "post": { "description": "

Updates an existing shipping rate object.

", "operationId": "PostShippingRatesShippingRateToken", "parameters": [ { "in": "path", "name": "shipping_rate_token", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "fixed_amount": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "active": { "description": "Whether the shipping rate can be used for new purchases. Defaults to `true`.", "type": "boolean" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "fixed_amount": { "description": "Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`.", "properties": { "currency_options": { "additionalProperties": { "properties": { "amount": { "type": "integer" }, "tax_behavior": { "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" } }, "title": "currency_option_update", "type": "object" }, "type": "object" } }, "title": "fixed_amount_update", "type": "object" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "tax_behavior": { "description": "Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.", "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_rate" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a shipping rate" } }, "/v1/sigma/saved_queries/{id}": { "post": { "description": "

Update an existing Sigma query that previously exists

", "operationId": "PostSigmaSavedQueriesId", "parameters": [ { "description": "The `id` of the saved query to update. This should be a valid `id` that was previously created.", "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "name": { "description": "The name of the query to update.", "maxLength": 5000, "type": "string" }, "sql": { "description": "The sql statement to update the specified query statement with. This should be a valid Trino SQL statement that can be run in Sigma.", "maxLength": 100000, "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sigma.sigma_api_query" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update an existing Sigma Query" } }, "/v1/sigma/scheduled_query_runs": { "get": { "description": "

Returns a list of scheduled query runs.

", "operationId": "GetSigmaScheduledQueryRuns", "parameters": [ { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/scheduled_query_run" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/sigma/scheduled_query_runs", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "SigmaScheduledQueryRunList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all scheduled query runs" } }, "/v1/sigma/scheduled_query_runs/{scheduled_query_run}": { "get": { "description": "

Retrieves the details of an scheduled query run.

", "operationId": "GetSigmaScheduledQueryRunsScheduledQueryRun", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "scheduled_query_run", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scheduled_query_run" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a scheduled query run" } }, "/v1/sources": { "post": { "description": "

Creates a new source object.

", "operationId": "PostSources", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "mandate": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "owner": { "explode": true, "style": "deepObject" }, "receiver": { "explode": true, "style": "deepObject" }, "redirect": { "explode": true, "style": "deepObject" }, "source_order": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "amount": { "description": "Amount associated with the source. This is the amount for which the source will be chargeable once ready. Required for `single_use` sources. Not supported for `receiver` type sources, where charge amount may not be specified until funds land.", "type": "integer" }, "currency": { "description": "Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) associated with the source. This is the currency for which the source will be chargeable once ready.", "format": "currency", "type": "string" }, "customer": { "description": "The `Customer` to whom the original source is attached to. Must be set when the original source is not a `Source` (e.g., `Card`).", "maxLength": 500, "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "flow": { "description": "The authentication `flow` of the source to create. `flow` is one of `redirect`, `receiver`, `code_verification`, `none`. It is generally inferred unless a type supports multiple flows.", "enum": [ "code_verification", "none", "receiver", "redirect" ], "maxLength": 5000, "type": "string" }, "mandate": { "description": "Information about a mandate possibility attached to a source object (generally for bank debits) as well as its acceptance status.", "properties": { "acceptance": { "properties": { "date": { "format": "unix-time", "type": "integer" }, "ip": { "type": "string" }, "offline": { "properties": { "contact_email": { "type": "string" } }, "required": [ "contact_email" ], "title": "mandate_offline_acceptance_params", "type": "object" }, "online": { "properties": { "date": { "format": "unix-time", "type": "integer" }, "ip": { "type": "string" }, "user_agent": { "maxLength": 5000, "type": "string" } }, "title": "mandate_online_acceptance_params", "type": "object" }, "status": { "enum": [ "accepted", "pending", "refused", "revoked" ], "maxLength": 5000, "type": "string" }, "type": { "enum": [ "offline", "online" ], "maxLength": 5000, "type": "string" }, "user_agent": { "maxLength": 5000, "type": "string" } }, "required": [ "status" ], "title": "mandate_acceptance_params", "type": "object" }, "amount": { "anyOf": [ { "type": "integer" }, { "enum": [ "" ], "type": "string" } ] }, "currency": { "format": "currency", "type": "string" }, "interval": { "enum": [ "one_time", "scheduled", "variable" ], "maxLength": 5000, "type": "string" }, "notification_method": { "enum": [ "deprecated_none", "email", "manual", "none", "stripe_email" ], "maxLength": 5000, "type": "string" } }, "title": "mandate_params", "type": "object" }, "metadata": { "additionalProperties": { "type": "string" }, "type": "object" }, "original_source": { "description": "The source to share.", "maxLength": 5000, "type": "string" }, "owner": { "description": "Information about the owner of the payment instrument that may be used or required by particular source types.", "properties": { "address": { "properties": { "city": { "maxLength": 5000, "type": "string" }, "country": { "maxLength": 5000, "type": "string" }, "line1": { "maxLength": 5000, "type": "string" }, "line2": { "maxLength": 5000, "type": "string" }, "postal_code": { "maxLength": 5000, "type": "string" }, "state": { "maxLength": 5000, "type": "string" } }, "title": "source_address", "type": "object" }, "email": { "type": "string" }, "name": { "maxLength": 5000, "type": "string" }, "phone": { "maxLength": 5000, "type": "string" } }, "title": "owner", "type": "object" }, "receiver": { "description": "Optional parameters for the receiver flow. Can be set only if the source is a receiver (`flow` is `receiver`).", "properties": { "refund_attributes_method": { "enum": [ "email", "manual", "none" ], "maxLength": 5000, "type": "string" } }, "title": "receiver_params", "type": "object" }, "redirect": { "description": "Parameters required for the redirect flow. Required if the source is authenticated by a redirect (`flow` is `redirect`).", "properties": { "return_url": { "type": "string" } }, "required": [ "return_url" ], "title": "redirect_params", "type": "object" }, "source_order": { "description": "Information about the items and shipping associated with the source. Required for transactional credit (for example Klarna) sources before you can charge it.", "properties": { "items": { "items": { "properties": { "amount": { "type": "integer" }, "currency": { "format": "currency", "type": "string" }, "description": { "maxLength": 1000, "type": "string" }, "parent": { "maxLength": 5000, "type": "string" }, "quantity": { "type": "integer" }, "type": { "enum": [ "discount", "shipping", "sku", "tax" ], "maxLength": 5000, "type": "string" } }, "title": "order_item_specs", "type": "object" }, "type": "array" }, "shipping": { "properties": { "address": { "properties": { "city": { "maxLength": 5000, "type": "string" }, "country": { "maxLength": 5000, "type": "string" }, "line1": { "maxLength": 5000, "type": "string" }, "line2": { "maxLength": 5000, "type": "string" }, "postal_code": { "maxLength": 5000, "type": "string" }, "state": { "maxLength": 5000, "type": "string" } }, "required": [ "line1" ], "title": "address", "type": "object" }, "carrier": { "maxLength": 5000, "type": "string" }, "name": { "maxLength": 5000, "type": "string" }, "phone": { "maxLength": 5000, "type": "string" }, "tracking_number": { "maxLength": 5000, "type": "string" } }, "required": [ "address" ], "title": "order_shipping", "type": "object" } }, "title": "shallow_order_specs", "type": "object" }, "statement_descriptor": { "description": "An arbitrary string to be displayed on your customer's statement. As an example, if your website is `RunClub` and the item you're charging for is a race ticket, you may want to specify a `statement_descriptor` of `RunClub 5K race ticket.` While many payment types will display this information, some may not display it at all.", "maxLength": 5000, "type": "string" }, "token": { "description": "An optional token used to create the source. When passed, token properties will override source parameters.", "maxLength": 5000, "type": "string" }, "type": { "description": "The `type` of the source to create. Required unless `customer` and `original_source` are specified (see the [Cloning card Sources](https://stripe.com/docs/sources/connect#cloning-card-sources) guide)", "maxLength": 5000, "type": "string" }, "usage": { "enum": [ "reusable", "single_use" ], "maxLength": 5000, "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/source" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Shares a source" } }, "/v1/sources/{source}": { "get": { "description": "

Retrieves an existing source object. Supply the unique source ID from a source creation request and Stripe will return the corresponding up-to-date source object information.

", "operationId": "GetSourcesSource", "parameters": [ { "description": "The client secret of the source. Required if a publishable key is used to retrieve the source.", "in": "query", "name": "client_secret", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "source", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/source" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a source" }, "post": { "description": "

Updates the specified source by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

\n\n

This request accepts the metadata and owner as arguments. It is also possible to update type specific information for selected payment methods. Please refer to our payment method guides for more detail.

", "operationId": "PostSourcesSource", "parameters": [ { "in": "path", "name": "source", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "mandate": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "owner": { "explode": true, "style": "deepObject" }, "source_order": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "amount": { "description": "Amount associated with the source.", "type": "integer" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "mandate": { "description": "Information about a mandate possibility attached to a source object (generally for bank debits) as well as its acceptance status.", "properties": { "acceptance": { "properties": { "date": { "format": "unix-time", "type": "integer" }, "ip": { "type": "string" }, "offline": { "properties": { "contact_email": { "type": "string" } }, "required": [ "contact_email" ], "title": "mandate_offline_acceptance_params", "type": "object" }, "online": { "properties": { "date": { "format": "unix-time", "type": "integer" }, "ip": { "type": "string" }, "user_agent": { "maxLength": 5000, "type": "string" } }, "title": "mandate_online_acceptance_params", "type": "object" }, "status": { "enum": [ "accepted", "pending", "refused", "revoked" ], "maxLength": 5000, "type": "string" }, "type": { "enum": [ "offline", "online" ], "maxLength": 5000, "type": "string" }, "user_agent": { "maxLength": 5000, "type": "string" } }, "required": [ "status" ], "title": "mandate_acceptance_params", "type": "object" }, "amount": { "anyOf": [ { "type": "integer" }, { "enum": [ "" ], "type": "string" } ] }, "currency": { "format": "currency", "type": "string" }, "interval": { "enum": [ "one_time", "scheduled", "variable" ], "maxLength": 5000, "type": "string" }, "notification_method": { "enum": [ "deprecated_none", "email", "manual", "none", "stripe_email" ], "maxLength": 5000, "type": "string" } }, "title": "mandate_params", "type": "object" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "owner": { "description": "Information about the owner of the payment instrument that may be used or required by particular source types.", "properties": { "address": { "properties": { "city": { "maxLength": 5000, "type": "string" }, "country": { "maxLength": 5000, "type": "string" }, "line1": { "maxLength": 5000, "type": "string" }, "line2": { "maxLength": 5000, "type": "string" }, "postal_code": { "maxLength": 5000, "type": "string" }, "state": { "maxLength": 5000, "type": "string" } }, "title": "source_address", "type": "object" }, "email": { "type": "string" }, "name": { "maxLength": 5000, "type": "string" }, "phone": { "maxLength": 5000, "type": "string" } }, "title": "owner", "type": "object" }, "source_order": { "description": "Information about the items and shipping associated with the source. Required for transactional credit (for example Klarna) sources before you can charge it.", "properties": { "items": { "items": { "properties": { "amount": { "type": "integer" }, "currency": { "format": "currency", "type": "string" }, "description": { "maxLength": 1000, "type": "string" }, "parent": { "maxLength": 5000, "type": "string" }, "quantity": { "type": "integer" }, "type": { "enum": [ "discount", "shipping", "sku", "tax" ], "maxLength": 5000, "type": "string" } }, "title": "order_item_specs", "type": "object" }, "type": "array" }, "shipping": { "properties": { "address": { "properties": { "city": { "maxLength": 5000, "type": "string" }, "country": { "maxLength": 5000, "type": "string" }, "line1": { "maxLength": 5000, "type": "string" }, "line2": { "maxLength": 5000, "type": "string" }, "postal_code": { "maxLength": 5000, "type": "string" }, "state": { "maxLength": 5000, "type": "string" } }, "required": [ "line1" ], "title": "address", "type": "object" }, "carrier": { "maxLength": 5000, "type": "string" }, "name": { "maxLength": 5000, "type": "string" }, "phone": { "maxLength": 5000, "type": "string" }, "tracking_number": { "maxLength": 5000, "type": "string" } }, "required": [ "address" ], "title": "order_shipping", "type": "object" } }, "title": "order_params", "type": "object" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/source" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a source" } }, "/v1/sources/{source}/mandate_notifications/{mandate_notification}": { "get": { "description": "

Retrieves a new Source MandateNotification.

", "operationId": "GetSourcesSourceMandateNotificationsMandateNotification", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "mandate_notification", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "in": "path", "name": "source", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/source_mandate_notification" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a Source MandateNotification" } }, "/v1/sources/{source}/source_transactions": { "get": { "description": "

List source transactions for a given source.

", "operationId": "GetSourcesSourceSourceTransactions", "parameters": [ { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "in": "path", "name": "source", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/source_transaction" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "ApmsSourcesSourceTransactionList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } } } }, "/v1/sources/{source}/source_transactions/{source_transaction}": { "get": { "description": "

Retrieve an existing source transaction object. Supply the unique source ID from a source creation request and the source transaction ID and Stripe will return the corresponding up-to-date source object information.

", "operationId": "GetSourcesSourceSourceTransactionsSourceTransaction", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "source", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "in": "path", "name": "source_transaction", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/source_transaction" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a source transaction" } }, "/v1/sources/{source}/verify": { "post": { "description": "

Verify a given source.

", "operationId": "PostSourcesSourceVerify", "parameters": [ { "in": "path", "name": "source", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "values": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "values": { "description": "The values needed to verify the source.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "required": [ "values" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/source" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } } } }, "/v1/subscription_items": { "get": { "description": "

Returns a list of your subscription items for a given subscription.

", "operationId": "GetSubscriptionItems", "parameters": [ { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "type": "string" }, "style": "form" }, { "description": "The ID of the subscription whose items will be retrieved.", "in": "query", "name": "subscription", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/subscription_item" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/subscription_items", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "SubscriptionsItemsSubscriptionItemList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all subscription items" }, "post": { "description": "

Adds a new item to an existing subscription. No existing items will be changed or replaced.

", "operationId": "PostSubscriptionItems", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "billing_thresholds": { "explode": true, "style": "deepObject" }, "discounts": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "price_data": { "explode": true, "style": "deepObject" }, "tax_rates": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "billing_thresholds": { "anyOf": [ { "properties": { "usage_gte": { "type": "integer" } }, "required": [ "usage_gte" ], "title": "item_billing_thresholds_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds." }, "discounts": { "anyOf": [ { "items": { "properties": { "coupon": { "maxLength": 5000, "type": "string" }, "discount": { "maxLength": 5000, "type": "string" }, "promotion_code": { "maxLength": 5000, "type": "string" } }, "title": "discounts_data_param", "type": "object" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The coupons to redeem into discounts for the subscription item." }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "payment_behavior": { "description": "Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior.\n\nUse `default_incomplete` to transition the subscription to `status=past_due` when payment is required and await explicit confirmation of the invoice's payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription’s invoice. Such as failed payments, [SCA regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method.\n\nUse `pending_if_incomplete` to update the subscription using [pending updates](https://stripe.com/docs/billing/subscriptions/pending-updates). When you use `pending_if_incomplete` you can only pass the parameters [supported by pending updates](https://stripe.com/docs/billing/pending-updates-reference#supported-attributes).\n\nUse `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://docs.stripe.com/changelog/2019-03-14) to learn more.", "enum": [ "allow_incomplete", "default_incomplete", "error_if_incomplete", "pending_if_incomplete" ], "type": "string" }, "price": { "description": "The ID of the price object.", "maxLength": 5000, "type": "string" }, "price_data": { "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.", "properties": { "currency": { "format": "currency", "type": "string" }, "product": { "maxLength": 5000, "type": "string" }, "recurring": { "properties": { "interval": { "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "type": "integer" } }, "required": [ "interval" ], "title": "recurring_adhoc", "type": "object" }, "tax_behavior": { "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" }, "unit_amount": { "type": "integer" }, "unit_amount_decimal": { "format": "decimal", "type": "string" } }, "required": [ "currency", "product", "recurring" ], "title": "recurring_price_data", "type": "object" }, "proration_behavior": { "description": "Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.", "enum": [ "always_invoice", "create_prorations", "none" ], "type": "string" }, "proration_date": { "description": "If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint.", "format": "unix-time", "type": "integer" }, "quantity": { "description": "The quantity you'd like to apply to the subscription item you're creating.", "type": "integer" }, "subscription": { "description": "The identifier of the subscription to modify.", "maxLength": 5000, "type": "string" }, "tax_rates": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates." } }, "required": [ "subscription" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/subscription_item" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a subscription item" } }, "/v1/subscription_items/{item}": { "delete": { "description": "

Deletes an item from the subscription. Removing a subscription item from a subscription will not cancel the subscription.

", "operationId": "DeleteSubscriptionItemsItem", "parameters": [ { "in": "path", "name": "item", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": { "clear_usage": { "description": "Delete all usage for the given subscription item. Allowed only when the current plan's `usage_type` is `metered`.", "type": "boolean" }, "proration_behavior": { "description": "Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.", "enum": [ "always_invoice", "create_prorations", "none" ], "type": "string" }, "proration_date": { "description": "If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint.", "format": "unix-time", "type": "integer" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted_subscription_item" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Delete a subscription item" }, "get": { "description": "

Retrieves the subscription item with the given ID.

", "operationId": "GetSubscriptionItemsItem", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "item", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/subscription_item" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a subscription item" }, "post": { "description": "

Updates the plan or quantity of an item on a current subscription.

", "operationId": "PostSubscriptionItemsItem", "parameters": [ { "in": "path", "name": "item", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "billing_thresholds": { "explode": true, "style": "deepObject" }, "discounts": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "price_data": { "explode": true, "style": "deepObject" }, "tax_rates": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "billing_thresholds": { "anyOf": [ { "properties": { "usage_gte": { "type": "integer" } }, "required": [ "usage_gte" ], "title": "item_billing_thresholds_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds." }, "discounts": { "anyOf": [ { "items": { "properties": { "coupon": { "maxLength": 5000, "type": "string" }, "discount": { "maxLength": 5000, "type": "string" }, "promotion_code": { "maxLength": 5000, "type": "string" } }, "title": "discounts_data_param", "type": "object" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The coupons to redeem into discounts for the subscription item." }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "off_session": { "description": "Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to `false` (on-session).", "type": "boolean" }, "payment_behavior": { "description": "Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior.\n\nUse `default_incomplete` to transition the subscription to `status=past_due` when payment is required and await explicit confirmation of the invoice's payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription’s invoice. Such as failed payments, [SCA regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method.\n\nUse `pending_if_incomplete` to update the subscription using [pending updates](https://stripe.com/docs/billing/subscriptions/pending-updates). When you use `pending_if_incomplete` you can only pass the parameters [supported by pending updates](https://stripe.com/docs/billing/pending-updates-reference#supported-attributes).\n\nUse `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://docs.stripe.com/changelog/2019-03-14) to learn more.", "enum": [ "allow_incomplete", "default_incomplete", "error_if_incomplete", "pending_if_incomplete" ], "type": "string" }, "price": { "description": "The ID of the price object. One of `price` or `price_data` is required. When changing a subscription item's price, `quantity` is set to 1 unless a `quantity` parameter is provided.", "maxLength": 5000, "type": "string" }, "price_data": { "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.", "properties": { "currency": { "format": "currency", "type": "string" }, "product": { "maxLength": 5000, "type": "string" }, "recurring": { "properties": { "interval": { "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "type": "integer" } }, "required": [ "interval" ], "title": "recurring_adhoc", "type": "object" }, "tax_behavior": { "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" }, "unit_amount": { "type": "integer" }, "unit_amount_decimal": { "format": "decimal", "type": "string" } }, "required": [ "currency", "product", "recurring" ], "title": "recurring_price_data", "type": "object" }, "proration_behavior": { "description": "Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.", "enum": [ "always_invoice", "create_prorations", "none" ], "type": "string" }, "proration_date": { "description": "If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint.", "format": "unix-time", "type": "integer" }, "quantity": { "description": "The quantity you'd like to apply to the subscription item you're creating.", "type": "integer" }, "tax_rates": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates." } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/subscription_item" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a subscription item" } }, "/v1/subscription_schedules": { "get": { "description": "

Retrieves the list of your subscription schedules.

", "operationId": "GetSubscriptionSchedules", "parameters": [ { "description": "Only return subscription schedules that were created canceled the given date interval.", "explode": true, "in": "query", "name": "canceled_at", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "type": "integer" }, "gte": { "type": "integer" }, "lt": { "type": "integer" }, "lte": { "type": "integer" } }, "title": "range_query_specs", "type": "object" }, { "type": "integer" } ] }, "style": "deepObject" }, { "description": "Only return subscription schedules that completed during the given date interval.", "explode": true, "in": "query", "name": "completed_at", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "type": "integer" }, "gte": { "type": "integer" }, "lt": { "type": "integer" }, "lte": { "type": "integer" } }, "title": "range_query_specs", "type": "object" }, { "type": "integer" } ] }, "style": "deepObject" }, { "description": "Only return subscription schedules that were created during the given date interval.", "explode": true, "in": "query", "name": "created", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "type": "integer" }, "gte": { "type": "integer" }, "lt": { "type": "integer" }, "lte": { "type": "integer" } }, "title": "range_query_specs", "type": "object" }, { "type": "integer" } ] }, "style": "deepObject" }, { "description": "Only return subscription schedules for the given customer.", "in": "query", "name": "customer", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "Only return subscription schedules that were released during the given date interval.", "explode": true, "in": "query", "name": "released_at", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "type": "integer" }, "gte": { "type": "integer" }, "lt": { "type": "integer" }, "lte": { "type": "integer" } }, "title": "range_query_specs", "type": "object" }, { "type": "integer" } ] }, "style": "deepObject" }, { "description": "Only return subscription schedules that have not started yet.", "in": "query", "name": "scheduled", "required": false, "schema": { "type": "boolean" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/subscription_schedule" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/subscription_schedules", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "SubscriptionSchedulesResourceScheduleList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all schedules" }, "post": { "description": "

Creates a new subscription schedule object. Each customer can have up to 500 active or scheduled subscriptions.

", "operationId": "PostSubscriptionSchedules", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "billing_mode": { "explode": true, "style": "deepObject" }, "default_settings": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "phases": { "explode": true, "style": "deepObject" }, "start_date": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "billing_mode": { "description": "Controls how prorations and invoices for subscriptions are calculated and orchestrated.", "properties": { "type": { "enum": [ "classic", "flexible" ], "type": "string" } }, "required": [ "type" ], "title": "billing_mode", "type": "object" }, "customer": { "description": "The identifier of the customer to create the subscription schedule for.", "maxLength": 5000, "type": "string" }, "default_settings": { "description": "Object representing the subscription schedule's default settings.", "properties": { "application_fee_percent": { "type": "number" }, "automatic_tax": { "properties": { "enabled": { "type": "boolean" }, "liability": { "properties": { "account": { "type": "string" }, "type": { "enum": [ "account", "self" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "param", "type": "object" } }, "required": [ "enabled" ], "title": "automatic_tax_config", "type": "object" }, "billing_cycle_anchor": { "enum": [ "automatic", "phase_start" ], "type": "string" }, "billing_thresholds": { "anyOf": [ { "properties": { "amount_gte": { "type": "integer" }, "reset_billing_cycle_anchor": { "type": "boolean" } }, "title": "billing_thresholds_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "collection_method": { "enum": [ "charge_automatically", "send_invoice" ], "type": "string" }, "default_payment_method": { "maxLength": 5000, "type": "string" }, "description": { "anyOf": [ { "maxLength": 500, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "invoice_settings": { "properties": { "account_tax_ids": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ] }, "days_until_due": { "type": "integer" }, "issuer": { "properties": { "account": { "type": "string" }, "type": { "enum": [ "account", "self" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "param", "type": "object" } }, "title": "subscription_schedule_default_settings_param", "type": "object" }, "on_behalf_of": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "transfer_data": { "anyOf": [ { "properties": { "amount_percent": { "type": "number" }, "destination": { "type": "string" } }, "required": [ "destination" ], "title": "transfer_data_specs", "type": "object" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "default_settings_params", "type": "object" }, "end_behavior": { "description": "Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running. `cancel` will end the subscription schedule and cancel the underlying subscription.", "enum": [ "cancel", "none", "release", "renew" ], "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "from_subscription": { "description": "Migrate an existing subscription to be managed by a subscription schedule. If this parameter is set, a subscription schedule will be created using the subscription's item(s), set to auto-renew using the subscription's interval. When using this parameter, other parameters (such as phase values) cannot be set. To create a subscription schedule with other modifications, we recommend making two separate API calls.", "maxLength": 5000, "type": "string" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "phases": { "description": "List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the `end_date` of one phase will always equal the `start_date` of the next phase.", "items": { "properties": { "add_invoice_items": { "items": { "properties": { "discounts": { "items": { "properties": { "coupon": { "maxLength": 5000, "type": "string" }, "discount": { "maxLength": 5000, "type": "string" }, "promotion_code": { "maxLength": 5000, "type": "string" } }, "title": "discounts_data_param", "type": "object" }, "type": "array" }, "metadata": { "additionalProperties": { "type": "string" }, "type": "object" }, "period": { "properties": { "end": { "properties": { "timestamp": { "format": "unix-time", "type": "integer" }, "type": { "enum": [ "min_item_period_end", "phase_end", "timestamp" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "invoice_item_period_end", "type": "object" }, "start": { "properties": { "timestamp": { "format": "unix-time", "type": "integer" }, "type": { "enum": [ "max_item_period_start", "phase_start", "timestamp" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "invoice_item_period_start", "type": "object" } }, "required": [ "end", "start" ], "title": "invoice_item_period", "type": "object" }, "price": { "maxLength": 5000, "type": "string" }, "price_data": { "properties": { "currency": { "format": "currency", "type": "string" }, "product": { "maxLength": 5000, "type": "string" }, "tax_behavior": { "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" }, "unit_amount": { "type": "integer" }, "unit_amount_decimal": { "format": "decimal", "type": "string" } }, "required": [ "currency", "product" ], "title": "one_time_price_data_with_negative_amounts", "type": "object" }, "quantity": { "type": "integer" }, "tax_rates": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "add_invoice_item_entry", "type": "object" }, "type": "array" }, "application_fee_percent": { "type": "number" }, "automatic_tax": { "properties": { "enabled": { "type": "boolean" }, "liability": { "properties": { "account": { "type": "string" }, "type": { "enum": [ "account", "self" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "param", "type": "object" } }, "required": [ "enabled" ], "title": "automatic_tax_config", "type": "object" }, "billing_cycle_anchor": { "enum": [ "automatic", "phase_start" ], "type": "string" }, "billing_thresholds": { "anyOf": [ { "properties": { "amount_gte": { "type": "integer" }, "reset_billing_cycle_anchor": { "type": "boolean" } }, "title": "billing_thresholds_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "collection_method": { "enum": [ "charge_automatically", "send_invoice" ], "type": "string" }, "currency": { "format": "currency", "type": "string" }, "default_payment_method": { "maxLength": 5000, "type": "string" }, "default_tax_rates": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ] }, "description": { "anyOf": [ { "maxLength": 500, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "discounts": { "anyOf": [ { "items": { "properties": { "coupon": { "maxLength": 5000, "type": "string" }, "discount": { "maxLength": 5000, "type": "string" }, "promotion_code": { "maxLength": 5000, "type": "string" } }, "title": "discounts_data_param", "type": "object" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ] }, "duration": { "properties": { "interval": { "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "type": "integer" } }, "required": [ "interval" ], "title": "duration_params", "type": "object" }, "end_date": { "format": "unix-time", "type": "integer" }, "invoice_settings": { "properties": { "account_tax_ids": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ] }, "days_until_due": { "type": "integer" }, "issuer": { "properties": { "account": { "type": "string" }, "type": { "enum": [ "account", "self" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "param", "type": "object" } }, "title": "invoice_settings", "type": "object" }, "items": { "items": { "properties": { "billing_thresholds": { "anyOf": [ { "properties": { "usage_gte": { "type": "integer" } }, "required": [ "usage_gte" ], "title": "item_billing_thresholds_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "discounts": { "anyOf": [ { "items": { "properties": { "coupon": { "maxLength": 5000, "type": "string" }, "discount": { "maxLength": 5000, "type": "string" }, "promotion_code": { "maxLength": 5000, "type": "string" } }, "title": "discounts_data_param", "type": "object" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ] }, "metadata": { "additionalProperties": { "type": "string" }, "type": "object" }, "price": { "maxLength": 5000, "type": "string" }, "price_data": { "properties": { "currency": { "format": "currency", "type": "string" }, "product": { "maxLength": 5000, "type": "string" }, "recurring": { "properties": { "interval": { "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "type": "integer" } }, "required": [ "interval" ], "title": "recurring_adhoc", "type": "object" }, "tax_behavior": { "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" }, "unit_amount": { "type": "integer" }, "unit_amount_decimal": { "format": "decimal", "type": "string" } }, "required": [ "currency", "product", "recurring" ], "title": "recurring_price_data", "type": "object" }, "quantity": { "type": "integer" }, "tax_rates": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "configuration_item_params", "type": "object" }, "type": "array" }, "iterations": { "type": "integer" }, "metadata": { "additionalProperties": { "type": "string" }, "type": "object" }, "on_behalf_of": { "type": "string" }, "proration_behavior": { "enum": [ "always_invoice", "create_prorations", "none" ], "type": "string" }, "transfer_data": { "properties": { "amount_percent": { "type": "number" }, "destination": { "type": "string" } }, "required": [ "destination" ], "title": "transfer_data_specs", "type": "object" }, "trial": { "type": "boolean" }, "trial_end": { "format": "unix-time", "type": "integer" } }, "required": [ "items" ], "title": "phase_configuration_params", "type": "object" }, "type": "array" }, "start_date": { "anyOf": [ { "format": "unix-time", "type": "integer" }, { "enum": [ "now" ], "maxLength": 5000, "type": "string" } ], "description": "When the subscription schedule starts. We recommend using `now` so that it starts the subscription immediately. You can also use a Unix timestamp to backdate the subscription so that it starts on a past date, or set a future date for the subscription to start on." } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/subscription_schedule" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a schedule" } }, "/v1/subscription_schedules/{schedule}": { "get": { "description": "

Retrieves the details of an existing subscription schedule. You only need to supply the unique subscription schedule identifier that was returned upon subscription schedule creation.

", "operationId": "GetSubscriptionSchedulesSchedule", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "schedule", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/subscription_schedule" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a schedule" }, "post": { "description": "

Updates an existing subscription schedule.

", "operationId": "PostSubscriptionSchedulesSchedule", "parameters": [ { "in": "path", "name": "schedule", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "default_settings": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "phases": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "default_settings": { "description": "Object representing the subscription schedule's default settings.", "properties": { "application_fee_percent": { "type": "number" }, "automatic_tax": { "properties": { "enabled": { "type": "boolean" }, "liability": { "properties": { "account": { "type": "string" }, "type": { "enum": [ "account", "self" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "param", "type": "object" } }, "required": [ "enabled" ], "title": "automatic_tax_config", "type": "object" }, "billing_cycle_anchor": { "enum": [ "automatic", "phase_start" ], "type": "string" }, "billing_thresholds": { "anyOf": [ { "properties": { "amount_gte": { "type": "integer" }, "reset_billing_cycle_anchor": { "type": "boolean" } }, "title": "billing_thresholds_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "collection_method": { "enum": [ "charge_automatically", "send_invoice" ], "type": "string" }, "default_payment_method": { "maxLength": 5000, "type": "string" }, "description": { "anyOf": [ { "maxLength": 500, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "invoice_settings": { "properties": { "account_tax_ids": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ] }, "days_until_due": { "type": "integer" }, "issuer": { "properties": { "account": { "type": "string" }, "type": { "enum": [ "account", "self" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "param", "type": "object" } }, "title": "subscription_schedule_default_settings_param", "type": "object" }, "on_behalf_of": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "transfer_data": { "anyOf": [ { "properties": { "amount_percent": { "type": "number" }, "destination": { "type": "string" } }, "required": [ "destination" ], "title": "transfer_data_specs", "type": "object" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "default_settings_params", "type": "object" }, "end_behavior": { "description": "Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running. `cancel` will end the subscription schedule and cancel the underlying subscription.", "enum": [ "cancel", "none", "release", "renew" ], "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "phases": { "description": "List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the `end_date` of one phase will always equal the `start_date` of the next phase. Note that past phases can be omitted.", "items": { "properties": { "add_invoice_items": { "items": { "properties": { "discounts": { "items": { "properties": { "coupon": { "maxLength": 5000, "type": "string" }, "discount": { "maxLength": 5000, "type": "string" }, "promotion_code": { "maxLength": 5000, "type": "string" } }, "title": "discounts_data_param", "type": "object" }, "type": "array" }, "metadata": { "additionalProperties": { "type": "string" }, "type": "object" }, "period": { "properties": { "end": { "properties": { "timestamp": { "format": "unix-time", "type": "integer" }, "type": { "enum": [ "min_item_period_end", "phase_end", "timestamp" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "invoice_item_period_end", "type": "object" }, "start": { "properties": { "timestamp": { "format": "unix-time", "type": "integer" }, "type": { "enum": [ "max_item_period_start", "phase_start", "timestamp" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "invoice_item_period_start", "type": "object" } }, "required": [ "end", "start" ], "title": "invoice_item_period", "type": "object" }, "price": { "maxLength": 5000, "type": "string" }, "price_data": { "properties": { "currency": { "format": "currency", "type": "string" }, "product": { "maxLength": 5000, "type": "string" }, "tax_behavior": { "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" }, "unit_amount": { "type": "integer" }, "unit_amount_decimal": { "format": "decimal", "type": "string" } }, "required": [ "currency", "product" ], "title": "one_time_price_data_with_negative_amounts", "type": "object" }, "quantity": { "type": "integer" }, "tax_rates": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "add_invoice_item_entry", "type": "object" }, "type": "array" }, "application_fee_percent": { "type": "number" }, "automatic_tax": { "properties": { "enabled": { "type": "boolean" }, "liability": { "properties": { "account": { "type": "string" }, "type": { "enum": [ "account", "self" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "param", "type": "object" } }, "required": [ "enabled" ], "title": "automatic_tax_config", "type": "object" }, "billing_cycle_anchor": { "enum": [ "automatic", "phase_start" ], "type": "string" }, "billing_thresholds": { "anyOf": [ { "properties": { "amount_gte": { "type": "integer" }, "reset_billing_cycle_anchor": { "type": "boolean" } }, "title": "billing_thresholds_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "collection_method": { "enum": [ "charge_automatically", "send_invoice" ], "type": "string" }, "default_payment_method": { "maxLength": 5000, "type": "string" }, "default_tax_rates": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ] }, "description": { "anyOf": [ { "maxLength": 500, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "discounts": { "anyOf": [ { "items": { "properties": { "coupon": { "maxLength": 5000, "type": "string" }, "discount": { "maxLength": 5000, "type": "string" }, "promotion_code": { "maxLength": 5000, "type": "string" } }, "title": "discounts_data_param", "type": "object" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ] }, "duration": { "properties": { "interval": { "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "type": "integer" } }, "required": [ "interval" ], "title": "duration_params", "type": "object" }, "end_date": { "anyOf": [ { "format": "unix-time", "type": "integer" }, { "enum": [ "now" ], "maxLength": 5000, "type": "string" } ] }, "invoice_settings": { "properties": { "account_tax_ids": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ] }, "days_until_due": { "type": "integer" }, "issuer": { "properties": { "account": { "type": "string" }, "type": { "enum": [ "account", "self" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "param", "type": "object" } }, "title": "invoice_settings", "type": "object" }, "items": { "items": { "properties": { "billing_thresholds": { "anyOf": [ { "properties": { "usage_gte": { "type": "integer" } }, "required": [ "usage_gte" ], "title": "item_billing_thresholds_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "discounts": { "anyOf": [ { "items": { "properties": { "coupon": { "maxLength": 5000, "type": "string" }, "discount": { "maxLength": 5000, "type": "string" }, "promotion_code": { "maxLength": 5000, "type": "string" } }, "title": "discounts_data_param", "type": "object" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ] }, "metadata": { "additionalProperties": { "type": "string" }, "type": "object" }, "price": { "maxLength": 5000, "type": "string" }, "price_data": { "properties": { "currency": { "format": "currency", "type": "string" }, "product": { "maxLength": 5000, "type": "string" }, "recurring": { "properties": { "interval": { "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "type": "integer" } }, "required": [ "interval" ], "title": "recurring_adhoc", "type": "object" }, "tax_behavior": { "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" }, "unit_amount": { "type": "integer" }, "unit_amount_decimal": { "format": "decimal", "type": "string" } }, "required": [ "currency", "product", "recurring" ], "title": "recurring_price_data", "type": "object" }, "quantity": { "type": "integer" }, "tax_rates": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "configuration_item_params", "type": "object" }, "type": "array" }, "iterations": { "type": "integer" }, "metadata": { "additionalProperties": { "type": "string" }, "type": "object" }, "on_behalf_of": { "type": "string" }, "proration_behavior": { "enum": [ "always_invoice", "create_prorations", "none" ], "type": "string" }, "start_date": { "anyOf": [ { "format": "unix-time", "type": "integer" }, { "enum": [ "now" ], "maxLength": 5000, "type": "string" } ] }, "transfer_data": { "properties": { "amount_percent": { "type": "number" }, "destination": { "type": "string" } }, "required": [ "destination" ], "title": "transfer_data_specs", "type": "object" }, "trial": { "type": "boolean" }, "trial_end": { "anyOf": [ { "format": "unix-time", "type": "integer" }, { "enum": [ "now" ], "maxLength": 5000, "type": "string" } ] } }, "required": [ "items" ], "title": "phase_configuration_params", "type": "object" }, "type": "array" }, "proration_behavior": { "description": "If the update changes the billing configuration (item price, quantity, etc.) of the current phase, indicates how prorations from this change should be handled. The default value is `create_prorations`.", "enum": [ "always_invoice", "create_prorations", "none" ], "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/subscription_schedule" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a schedule" } }, "/v1/subscription_schedules/{schedule}/cancel": { "post": { "description": "

Cancels a subscription schedule and its associated subscription immediately (if the subscription schedule has an active subscription). A subscription schedule can only be canceled if its status is not_started or active.

", "operationId": "PostSubscriptionSchedulesScheduleCancel", "parameters": [ { "in": "path", "name": "schedule", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "invoice_now": { "description": "If the subscription schedule is `active`, indicates if a final invoice will be generated that contains any un-invoiced metered usage and new/pending proration invoice items. Defaults to `true`.", "type": "boolean" }, "prorate": { "description": "If the subscription schedule is `active`, indicates if the cancellation should be prorated. Defaults to `true`.", "type": "boolean" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/subscription_schedule" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Cancel a schedule" } }, "/v1/subscription_schedules/{schedule}/release": { "post": { "description": "

Releases the subscription schedule immediately, which will stop scheduling of its phases, but leave any existing subscription in place. A schedule can only be released if its status is not_started or active. If the subscription schedule is currently associated with a subscription, releasing it will remove its subscription property and set the subscription’s ID to the released_subscription property.

", "operationId": "PostSubscriptionSchedulesScheduleRelease", "parameters": [ { "in": "path", "name": "schedule", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "preserve_cancel_date": { "description": "Keep any cancellation on the subscription that the schedule has set", "type": "boolean" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/subscription_schedule" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Release a schedule" } }, "/v1/subscriptions": { "get": { "description": "

By default, returns a list of subscriptions that have not been canceled. In order to list canceled subscriptions, specify status=canceled.

", "operationId": "GetSubscriptions", "parameters": [ { "description": "Filter subscriptions by their automatic tax settings.", "explode": true, "in": "query", "name": "automatic_tax", "required": false, "schema": { "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ], "title": "automatic_tax_filter_params", "type": "object" }, "style": "deepObject" }, { "description": "The collection method of the subscriptions to retrieve. Either `charge_automatically` or `send_invoice`.", "in": "query", "name": "collection_method", "required": false, "schema": { "enum": [ "charge_automatically", "send_invoice" ], "type": "string" }, "style": "form" }, { "description": "Only return subscriptions that were created during the given date interval.", "explode": true, "in": "query", "name": "created", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "type": "integer" }, "gte": { "type": "integer" }, "lt": { "type": "integer" }, "lte": { "type": "integer" } }, "title": "range_query_specs", "type": "object" }, { "type": "integer" } ] }, "style": "deepObject" }, { "description": "Only return subscriptions whose minimum item current_period_end falls within the given date interval.", "explode": true, "in": "query", "name": "current_period_end", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "type": "integer" }, "gte": { "type": "integer" }, "lt": { "type": "integer" }, "lte": { "type": "integer" } }, "title": "range_query_specs", "type": "object" }, { "type": "integer" } ] }, "style": "deepObject" }, { "description": "Only return subscriptions whose maximum item current_period_start falls within the given date interval.", "explode": true, "in": "query", "name": "current_period_start", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "type": "integer" }, "gte": { "type": "integer" }, "lt": { "type": "integer" }, "lte": { "type": "integer" } }, "title": "range_query_specs", "type": "object" }, { "type": "integer" } ] }, "style": "deepObject" }, { "description": "The ID of the customer whose subscriptions will be retrieved.", "in": "query", "name": "customer", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "Filter for subscriptions that contain this recurring price ID.", "in": "query", "name": "price", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "The status of the subscriptions to retrieve. Passing in a value of `canceled` will return all canceled subscriptions, including those belonging to deleted customers. Pass `ended` to find subscriptions that are canceled and subscriptions that are expired due to [incomplete payment](https://stripe.com/docs/billing/subscriptions/overview#subscription-statuses). Passing in a value of `all` will return subscriptions of all statuses. If no value is supplied, all subscriptions that have not been canceled are returned.", "in": "query", "name": "status", "required": false, "schema": { "enum": [ "active", "all", "canceled", "ended", "incomplete", "incomplete_expired", "past_due", "paused", "trialing", "unpaid" ], "type": "string" }, "style": "form" }, { "description": "Filter for subscriptions that are associated with the specified test clock. The response will not include subscriptions with test clocks if this and the customer parameter is not set.", "in": "query", "name": "test_clock", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/subscription" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/subscriptions", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "SubscriptionsSubscriptionList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List subscriptions" }, "post": { "description": "

Creates a new subscription on an existing customer. Each customer can have up to 500 active or scheduled subscriptions.

\n\n

When you create a subscription with collection_method=charge_automatically, the first invoice is finalized as part of the request.\nThe payment_behavior parameter determines the exact behavior of the initial payment.

\n\n

To start subscriptions where the first invoice always begins in a draft status, use subscription schedules instead.\nSchedules provide the flexibility to model more complex billing configurations that change over time.

", "operationId": "PostSubscriptions", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "add_invoice_items": { "explode": true, "style": "deepObject" }, "application_fee_percent": { "explode": true, "style": "deepObject" }, "automatic_tax": { "explode": true, "style": "deepObject" }, "billing_cycle_anchor_config": { "explode": true, "style": "deepObject" }, "billing_mode": { "explode": true, "style": "deepObject" }, "billing_thresholds": { "explode": true, "style": "deepObject" }, "cancel_at": { "explode": true, "style": "deepObject" }, "default_tax_rates": { "explode": true, "style": "deepObject" }, "discounts": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "invoice_settings": { "explode": true, "style": "deepObject" }, "items": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "on_behalf_of": { "explode": true, "style": "deepObject" }, "payment_settings": { "explode": true, "style": "deepObject" }, "pending_invoice_item_interval": { "explode": true, "style": "deepObject" }, "transfer_data": { "explode": true, "style": "deepObject" }, "trial_end": { "explode": true, "style": "deepObject" }, "trial_settings": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "add_invoice_items": { "description": "A list of prices and quantities that will generate invoice items appended to the next invoice for this subscription. You may pass up to 20 items.", "items": { "properties": { "discounts": { "items": { "properties": { "coupon": { "maxLength": 5000, "type": "string" }, "discount": { "maxLength": 5000, "type": "string" }, "promotion_code": { "maxLength": 5000, "type": "string" } }, "title": "discounts_data_param", "type": "object" }, "type": "array" }, "metadata": { "additionalProperties": { "type": "string" }, "type": "object" }, "period": { "properties": { "end": { "properties": { "timestamp": { "format": "unix-time", "type": "integer" }, "type": { "enum": [ "min_item_period_end", "timestamp" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "invoice_item_period_end", "type": "object" }, "start": { "properties": { "timestamp": { "format": "unix-time", "type": "integer" }, "type": { "enum": [ "max_item_period_start", "now", "timestamp" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "invoice_item_period_start", "type": "object" } }, "required": [ "end", "start" ], "title": "invoice_item_period", "type": "object" }, "price": { "maxLength": 5000, "type": "string" }, "price_data": { "properties": { "currency": { "format": "currency", "type": "string" }, "product": { "maxLength": 5000, "type": "string" }, "tax_behavior": { "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" }, "unit_amount": { "type": "integer" }, "unit_amount_decimal": { "format": "decimal", "type": "string" } }, "required": [ "currency", "product" ], "title": "one_time_price_data_with_negative_amounts", "type": "object" }, "quantity": { "type": "integer" }, "tax_rates": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "add_invoice_item_entry", "type": "object" }, "type": "array" }, "application_fee_percent": { "anyOf": [ { "type": "number" }, { "enum": [ "" ], "type": "string" } ], "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions)." }, "automatic_tax": { "description": "Automatic tax settings for this subscription.", "properties": { "enabled": { "type": "boolean" }, "liability": { "properties": { "account": { "type": "string" }, "type": { "enum": [ "account", "self" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "param", "type": "object" } }, "required": [ "enabled" ], "title": "automatic_tax_config", "type": "object" }, "backdate_start_date": { "description": "A past timestamp to backdate the subscription's start date to. If set, the first invoice will contain line items for the timespan between the start date and the current time. Can be combined with trials and the billing cycle anchor.", "format": "unix-time", "type": "integer" }, "billing_cycle_anchor": { "description": "A future timestamp in UTC format to anchor the subscription's [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle). The anchor is the reference point that aligns future billing cycle dates. It sets the day of week for `week` intervals, the day of month for `month` and `year` intervals, and the month of year for `year` intervals.", "format": "unix-time", "type": "integer", "x-stripeBypassValidation": true }, "billing_cycle_anchor_config": { "description": "Mutually exclusive with billing_cycle_anchor and only valid with monthly and yearly price intervals. When provided, the billing_cycle_anchor is set to the next occurence of the day_of_month at the hour, minute, and second UTC.", "properties": { "day_of_month": { "type": "integer" }, "hour": { "type": "integer" }, "minute": { "type": "integer" }, "month": { "type": "integer" }, "second": { "type": "integer" } }, "required": [ "day_of_month" ], "title": "cycle_anchor_config_param", "type": "object" }, "billing_mode": { "description": "Controls how prorations and invoices for subscriptions are calculated and orchestrated.", "properties": { "type": { "enum": [ "classic", "flexible" ], "type": "string" } }, "required": [ "type" ], "title": "billing_mode", "type": "object" }, "billing_thresholds": { "anyOf": [ { "properties": { "amount_gte": { "type": "integer" }, "reset_billing_cycle_anchor": { "type": "boolean" } }, "title": "billing_thresholds_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds." }, "cancel_at": { "anyOf": [ { "format": "unix-time", "type": "integer" }, { "enum": [ "max_period_end", "min_period_end" ], "type": "string" } ], "description": "A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period." }, "cancel_at_period_end": { "description": "Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`.", "type": "boolean" }, "collection_method": { "description": "Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically`.", "enum": [ "charge_automatically", "send_invoice" ], "type": "string" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "customer": { "description": "The identifier of the customer to subscribe.", "maxLength": 5000, "type": "string" }, "days_until_due": { "description": "Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where `collection_method` is set to `send_invoice`.", "type": "integer" }, "default_payment_method": { "description": "ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).", "maxLength": 5000, "type": "string" }, "default_source": { "description": "ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).", "maxLength": 5000, "type": "string" }, "default_tax_rates": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The tax rates that will apply to any subscription item that does not have `tax_rates` set. Invoices created will have their `default_tax_rates` populated from the subscription." }, "description": { "description": "The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.", "maxLength": 500, "type": "string" }, "discounts": { "anyOf": [ { "items": { "properties": { "coupon": { "maxLength": 5000, "type": "string" }, "discount": { "maxLength": 5000, "type": "string" }, "promotion_code": { "maxLength": 5000, "type": "string" } }, "title": "discounts_data_param", "type": "object" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The coupons to redeem into discounts for the subscription. If not specified or empty, inherits the discount from the subscription's customer." }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "invoice_settings": { "description": "All invoices will be billed using the specified settings.", "properties": { "account_tax_ids": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ] }, "issuer": { "properties": { "account": { "type": "string" }, "type": { "enum": [ "account", "self" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "param", "type": "object" } }, "title": "invoice_settings_param", "type": "object" }, "items": { "description": "A list of up to 20 subscription items, each with an attached price.", "items": { "properties": { "billing_thresholds": { "anyOf": [ { "properties": { "usage_gte": { "type": "integer" } }, "required": [ "usage_gte" ], "title": "item_billing_thresholds_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "discounts": { "anyOf": [ { "items": { "properties": { "coupon": { "maxLength": 5000, "type": "string" }, "discount": { "maxLength": 5000, "type": "string" }, "promotion_code": { "maxLength": 5000, "type": "string" } }, "title": "discounts_data_param", "type": "object" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ] }, "metadata": { "additionalProperties": { "type": "string" }, "type": "object" }, "price": { "maxLength": 5000, "type": "string" }, "price_data": { "properties": { "currency": { "format": "currency", "type": "string" }, "product": { "maxLength": 5000, "type": "string" }, "recurring": { "properties": { "interval": { "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "type": "integer" } }, "required": [ "interval" ], "title": "recurring_adhoc", "type": "object" }, "tax_behavior": { "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" }, "unit_amount": { "type": "integer" }, "unit_amount_decimal": { "format": "decimal", "type": "string" } }, "required": [ "currency", "product", "recurring" ], "title": "recurring_price_data", "type": "object" }, "quantity": { "type": "integer" }, "tax_rates": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "subscription_item_create_params", "type": "object" }, "type": "array" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "off_session": { "description": "Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to `false` (on-session).", "type": "boolean" }, "on_behalf_of": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "The account on behalf of which to charge, for each of the subscription's invoices." }, "payment_behavior": { "description": "Only applies to subscriptions with `collection_method=charge_automatically`.\n\nUse `allow_incomplete` to create Subscriptions with `status=incomplete` if the first invoice can't be paid. Creating Subscriptions with this status allows you to manage scenarios where additional customer actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior.\n\nUse `default_incomplete` to create Subscriptions with `status=incomplete` when the first invoice requires payment, otherwise start as active. Subscriptions transition to `status=active` when successfully confirming the PaymentIntent on the first invoice. This allows simpler management of scenarios where additional customer actions are needed to pay a subscription’s invoice, such as failed payments, [SCA regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method. If the PaymentIntent is not confirmed within 23 hours Subscriptions transition to `status=incomplete_expired`, which is a terminal state.\n\nUse `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's first invoice can't be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further customer action is needed, this parameter doesn't create a Subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more.\n\n`pending_if_incomplete` is only used with updates and cannot be passed when creating a Subscription.\n\nSubscriptions with `collection_method=send_invoice` are automatically activated regardless of the first Invoice status.", "enum": [ "allow_incomplete", "default_incomplete", "error_if_incomplete", "pending_if_incomplete" ], "type": "string" }, "payment_settings": { "description": "Payment settings to pass to invoices created by the subscription.", "properties": { "payment_method_options": { "properties": { "acss_debit": { "anyOf": [ { "properties": { "mandate_options": { "properties": { "transaction_type": { "enum": [ "business", "personal" ], "type": "string" } }, "title": "mandate_options_param", "type": "object" }, "verification_method": { "enum": [ "automatic", "instant", "microdeposits" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "invoice_payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "bancontact": { "anyOf": [ { "properties": { "preferred_language": { "enum": [ "de", "en", "fr", "nl" ], "type": "string" } }, "title": "invoice_payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "card": { "anyOf": [ { "properties": { "mandate_options": { "properties": { "amount": { "type": "integer" }, "amount_type": { "enum": [ "fixed", "maximum" ], "type": "string" }, "description": { "maxLength": 200, "type": "string" } }, "title": "mandate_options_param", "type": "object" }, "network": { "enum": [ "amex", "cartes_bancaires", "diners", "discover", "eftpos_au", "girocard", "interac", "jcb", "link", "mastercard", "unionpay", "unknown", "visa" ], "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true }, "request_three_d_secure": { "enum": [ "any", "automatic", "challenge" ], "type": "string" } }, "title": "subscription_payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "customer_balance": { "anyOf": [ { "properties": { "bank_transfer": { "properties": { "eu_bank_transfer": { "properties": { "country": { "maxLength": 5000, "type": "string" } }, "required": [ "country" ], "title": "eu_bank_transfer_param", "type": "object" }, "type": { "type": "string" } }, "title": "bank_transfer_param", "type": "object" }, "funding_type": { "type": "string" } }, "title": "invoice_payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "konbini": { "anyOf": [ { "properties": {}, "title": "invoice_payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "sepa_debit": { "anyOf": [ { "properties": {}, "title": "invoice_payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "us_bank_account": { "anyOf": [ { "properties": { "financial_connections": { "properties": { "filters": { "properties": { "account_subcategories": { "items": { "enum": [ "checking", "savings" ], "type": "string" }, "type": "array" } }, "title": "invoice_linked_account_options_filters_param", "type": "object" }, "permissions": { "items": { "enum": [ "balances", "ownership", "payment_method", "transactions" ], "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true }, "type": "array" }, "prefetch": { "items": { "enum": [ "balances", "ownership", "transactions" ], "type": "string", "x-stripeBypassValidation": true }, "type": "array" } }, "title": "invoice_linked_account_options_param", "type": "object" }, "verification_method": { "enum": [ "automatic", "instant", "microdeposits" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "invoice_payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "payment_method_options", "type": "object" }, "payment_method_types": { "anyOf": [ { "items": { "enum": [ "ach_credit_transfer", "ach_debit", "acss_debit", "affirm", "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", "boleto", "card", "cashapp", "crypto", "customer_balance", "eps", "fpx", "giropay", "grabpay", "ideal", "jp_credit_transfer", "kakao_pay", "klarna", "konbini", "kr_card", "link", "multibanco", "naver_pay", "nz_bank_account", "p24", "payco", "paynow", "paypal", "promptpay", "revolut_pay", "sepa_credit_transfer", "sepa_debit", "sofort", "swish", "us_bank_account", "wechat_pay" ], "type": "string", "x-stripeBypassValidation": true }, "type": "array" }, { "enum": [ "" ], "type": "string" } ] }, "save_default_payment_method": { "enum": [ "off", "on_subscription" ], "type": "string" } }, "title": "payment_settings", "type": "object" }, "pending_invoice_item_interval": { "anyOf": [ { "properties": { "interval": { "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "type": "integer" } }, "required": [ "interval" ], "title": "pending_invoice_item_interval_params", "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://stripe.com/docs/api#create_invoice) for the given subscription at the specified interval." }, "proration_behavior": { "description": "Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) resulting from the `billing_cycle_anchor`. If no value is passed, the default is `create_prorations`.", "enum": [ "always_invoice", "create_prorations", "none" ], "type": "string" }, "transfer_data": { "description": "If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges.", "properties": { "amount_percent": { "type": "number" }, "destination": { "type": "string" } }, "required": [ "destination" ], "title": "transfer_data_specs", "type": "object" }, "trial_end": { "anyOf": [ { "enum": [ "now" ], "maxLength": 5000, "type": "string" }, { "format": "unix-time", "type": "integer" } ], "description": "Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more." }, "trial_from_plan": { "description": "Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more.", "type": "boolean" }, "trial_period_days": { "description": "Integer representing the number of trial period days before the customer is charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more.", "type": "integer" }, "trial_settings": { "description": "Settings related to subscription trials.", "properties": { "end_behavior": { "properties": { "missing_payment_method": { "enum": [ "cancel", "create_invoice", "pause" ], "type": "string" } }, "required": [ "missing_payment_method" ], "title": "end_behavior", "type": "object" } }, "required": [ "end_behavior" ], "title": "trial_settings_config", "type": "object" } }, "required": [ "customer" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/subscription" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a subscription" } }, "/v1/subscriptions/search": { "get": { "description": "

Search for subscriptions you’ve previously created using Stripe’s Search Query Language.\nDon’t use search in read-after-write flows where strict consistency is necessary. Under normal operating\nconditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up\nto an hour behind during outages. Search functionality is not available to merchants in India.

", "operationId": "GetSubscriptionsSearch", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.", "in": "query", "name": "page", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for subscriptions](https://stripe.com/docs/search#query-fields-for-subscriptions).", "in": "query", "name": "query", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/subscription" }, "type": "array" }, "has_more": { "type": "boolean" }, "next_page": { "maxLength": 5000, "nullable": true, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ "search_result" ], "type": "string" }, "total_count": { "description": "The total number of objects that match the query, only accurate up to 10,000.", "type": "integer" }, "url": { "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "SearchResult", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Search subscriptions" } }, "/v1/subscriptions/{subscription_exposed_id}": { "delete": { "description": "

Cancels a customer’s subscription immediately. The customer won’t be charged again for the subscription. After it’s canceled, you can no longer update the subscription or its metadata.

\n\n

Any pending invoice items that you’ve created are still charged at the end of the period, unless manually deleted. If you’ve set the subscription to cancel at the end of the period, any pending prorations are also left in place and collected at the end of the period. But if the subscription is set to cancel immediately, pending prorations are removed if invoice_now and prorate are both set to true.

\n\n

By default, upon subscription cancellation, Stripe stops automatic collection of all finalized invoices for the customer. This is intended to prevent unexpected payment attempts after the customer has canceled a subscription. However, you can resume automatic collection of the invoices manually after subscription cancellation to have us proceed. Or, you could check for unpaid invoices before allowing the customer to cancel the subscription at all.

", "operationId": "DeleteSubscriptionsSubscriptionExposedId", "parameters": [ { "in": "path", "name": "subscription_exposed_id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "cancellation_details": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "cancellation_details": { "description": "Details about why this subscription was cancelled", "properties": { "comment": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "feedback": { "enum": [ "", "customer_service", "low_quality", "missing_features", "other", "switched_service", "too_complex", "too_expensive", "unused" ], "type": "string" } }, "title": "cancellation_details_param", "type": "object" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "invoice_now": { "description": "Will generate a final invoice that invoices for any un-invoiced metered usage and new/pending proration invoice items. Defaults to `false`.", "type": "boolean" }, "prorate": { "description": "Will generate a proration invoice item that credits remaining unused time until the subscription period end. Defaults to `false`.", "type": "boolean" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/subscription" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Cancel a subscription" }, "get": { "description": "

Retrieves the subscription with the given ID.

", "operationId": "GetSubscriptionsSubscriptionExposedId", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "subscription_exposed_id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/subscription" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a subscription" }, "post": { "description": "

Updates an existing subscription to match the specified parameters.\nWhen changing prices or quantities, we optionally prorate the price we charge next month to make up for any price changes.\nTo preview how the proration is calculated, use the create preview endpoint.

\n\n

By default, we prorate subscription changes. For example, if a customer signs up on May 1 for a 100 price, they’ll be billed 100 immediately. If on May 15 they switch to a 200 price, then on June 1 they’ll be billed 250 (200 for a renewal of her subscription, plus a 50 prorating adjustment for half of the previous month’s 100 difference). Similarly, a downgrade generates a credit that is applied to the next invoice. We also prorate when you make quantity changes.

\n\n

Switching prices does not normally change the billing date or generate an immediate charge unless:

\n\n
    \n
  • The billing interval is changed (for example, from monthly to yearly).
    • \n
  • The subscription moves from free to paid.
    • \n
  • A trial starts or ends.
    • \n
\n\n

In these cases, we apply a credit for the unused time on the previous price, immediately charge the customer using the new price, and reset the billing date. Learn about how Stripe immediately attempts payment for subscription changes.

\n\n

If you want to charge for an upgrade immediately, pass proration_behavior as always_invoice to create prorations, automatically invoice the customer for those proration adjustments, and attempt to collect payment. If you pass create_prorations, the prorations are created but not automatically invoiced. If you want to bill the customer for the prorations before the subscription’s renewal date, you need to manually invoice the customer.

\n\n

If you don’t want to prorate, set the proration_behavior option to none. With this option, the customer is billed 100 on May 1 and 200 on June 1. Similarly, if you set proration_behavior to none when switching between different billing intervals (for example, from monthly to yearly), we don’t generate any credits for the old subscription’s unused time. We still reset the billing date and bill immediately for the new subscription.

\n\n

Updating the quantity on a subscription many times in an hour may result in rate limiting. If you need to bill for a frequently changing quantity, consider integrating usage-based billing instead.

", "operationId": "PostSubscriptionsSubscriptionExposedId", "parameters": [ { "in": "path", "name": "subscription_exposed_id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "add_invoice_items": { "explode": true, "style": "deepObject" }, "application_fee_percent": { "explode": true, "style": "deepObject" }, "automatic_tax": { "explode": true, "style": "deepObject" }, "billing_thresholds": { "explode": true, "style": "deepObject" }, "cancel_at": { "explode": true, "style": "deepObject" }, "cancellation_details": { "explode": true, "style": "deepObject" }, "default_source": { "explode": true, "style": "deepObject" }, "default_tax_rates": { "explode": true, "style": "deepObject" }, "description": { "explode": true, "style": "deepObject" }, "discounts": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "invoice_settings": { "explode": true, "style": "deepObject" }, "items": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "on_behalf_of": { "explode": true, "style": "deepObject" }, "pause_collection": { "explode": true, "style": "deepObject" }, "payment_settings": { "explode": true, "style": "deepObject" }, "pending_invoice_item_interval": { "explode": true, "style": "deepObject" }, "transfer_data": { "explode": true, "style": "deepObject" }, "trial_end": { "explode": true, "style": "deepObject" }, "trial_settings": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "add_invoice_items": { "description": "A list of prices and quantities that will generate invoice items appended to the next invoice for this subscription. You may pass up to 20 items.", "items": { "properties": { "discounts": { "items": { "properties": { "coupon": { "maxLength": 5000, "type": "string" }, "discount": { "maxLength": 5000, "type": "string" }, "promotion_code": { "maxLength": 5000, "type": "string" } }, "title": "discounts_data_param", "type": "object" }, "type": "array" }, "metadata": { "additionalProperties": { "type": "string" }, "type": "object" }, "period": { "properties": { "end": { "properties": { "timestamp": { "format": "unix-time", "type": "integer" }, "type": { "enum": [ "min_item_period_end", "timestamp" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "invoice_item_period_end", "type": "object" }, "start": { "properties": { "timestamp": { "format": "unix-time", "type": "integer" }, "type": { "enum": [ "max_item_period_start", "now", "timestamp" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "invoice_item_period_start", "type": "object" } }, "required": [ "end", "start" ], "title": "invoice_item_period", "type": "object" }, "price": { "maxLength": 5000, "type": "string" }, "price_data": { "properties": { "currency": { "format": "currency", "type": "string" }, "product": { "maxLength": 5000, "type": "string" }, "tax_behavior": { "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" }, "unit_amount": { "type": "integer" }, "unit_amount_decimal": { "format": "decimal", "type": "string" } }, "required": [ "currency", "product" ], "title": "one_time_price_data_with_negative_amounts", "type": "object" }, "quantity": { "type": "integer" }, "tax_rates": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "add_invoice_item_entry", "type": "object" }, "type": "array" }, "application_fee_percent": { "anyOf": [ { "type": "number" }, { "enum": [ "" ], "type": "string" } ], "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions)." }, "automatic_tax": { "description": "Automatic tax settings for this subscription. We recommend you only include this parameter when the existing value is being changed.", "properties": { "enabled": { "type": "boolean" }, "liability": { "properties": { "account": { "type": "string" }, "type": { "enum": [ "account", "self" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "param", "type": "object" } }, "required": [ "enabled" ], "title": "automatic_tax_config", "type": "object" }, "billing_cycle_anchor": { "description": "Either `now` or `unchanged`. Setting the value to `now` resets the subscription's billing cycle anchor to the current time (in UTC). For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).", "enum": [ "now", "unchanged" ], "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true }, "billing_thresholds": { "anyOf": [ { "properties": { "amount_gte": { "type": "integer" }, "reset_billing_cycle_anchor": { "type": "boolean" } }, "title": "billing_thresholds_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds." }, "cancel_at": { "anyOf": [ { "format": "unix-time", "type": "integer" }, { "enum": [ "" ], "type": "string" }, { "enum": [ "max_period_end", "min_period_end" ], "type": "string" } ], "description": "A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period." }, "cancel_at_period_end": { "description": "Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`.", "type": "boolean" }, "cancellation_details": { "description": "Details about why this subscription was cancelled", "properties": { "comment": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "feedback": { "enum": [ "", "customer_service", "low_quality", "missing_features", "other", "switched_service", "too_complex", "too_expensive", "unused" ], "type": "string" } }, "title": "cancellation_details_param", "type": "object" }, "collection_method": { "description": "Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically`.", "enum": [ "charge_automatically", "send_invoice" ], "type": "string" }, "days_until_due": { "description": "Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where `collection_method` is set to `send_invoice`.", "type": "integer" }, "default_payment_method": { "description": "ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).", "maxLength": 5000, "type": "string" }, "default_source": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source)." }, "default_tax_rates": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The tax rates that will apply to any subscription item that does not have `tax_rates` set. Invoices created will have their `default_tax_rates` populated from the subscription. Pass an empty string to remove previously-defined tax rates." }, "description": { "anyOf": [ { "maxLength": 500, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs." }, "discounts": { "anyOf": [ { "items": { "properties": { "coupon": { "maxLength": 5000, "type": "string" }, "discount": { "maxLength": 5000, "type": "string" }, "promotion_code": { "maxLength": 5000, "type": "string" } }, "title": "discounts_data_param", "type": "object" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ], "description": "The coupons to redeem into discounts for the subscription. If not specified or empty, inherits the discount from the subscription's customer." }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "invoice_settings": { "description": "All invoices will be billed using the specified settings.", "properties": { "account_tax_ids": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ] }, "issuer": { "properties": { "account": { "type": "string" }, "type": { "enum": [ "account", "self" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "type" ], "title": "param", "type": "object" } }, "title": "invoice_settings_param", "type": "object" }, "items": { "description": "A list of up to 20 subscription items, each with an attached price.", "items": { "properties": { "billing_thresholds": { "anyOf": [ { "properties": { "usage_gte": { "type": "integer" } }, "required": [ "usage_gte" ], "title": "item_billing_thresholds_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "clear_usage": { "type": "boolean" }, "deleted": { "type": "boolean" }, "discounts": { "anyOf": [ { "items": { "properties": { "coupon": { "maxLength": 5000, "type": "string" }, "discount": { "maxLength": 5000, "type": "string" }, "promotion_code": { "maxLength": 5000, "type": "string" } }, "title": "discounts_data_param", "type": "object" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ] }, "id": { "maxLength": 5000, "type": "string" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "price": { "maxLength": 5000, "type": "string" }, "price_data": { "properties": { "currency": { "format": "currency", "type": "string" }, "product": { "maxLength": 5000, "type": "string" }, "recurring": { "properties": { "interval": { "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "type": "integer" } }, "required": [ "interval" ], "title": "recurring_adhoc", "type": "object" }, "tax_behavior": { "enum": [ "exclusive", "inclusive", "unspecified" ], "type": "string" }, "unit_amount": { "type": "integer" }, "unit_amount_decimal": { "format": "decimal", "type": "string" } }, "required": [ "currency", "product", "recurring" ], "title": "recurring_price_data", "type": "object" }, "quantity": { "type": "integer" }, "tax_rates": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "subscription_item_update_params", "type": "object" }, "type": "array" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "off_session": { "description": "Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to `false` (on-session).", "type": "boolean" }, "on_behalf_of": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "The account on behalf of which to charge, for each of the subscription's invoices." }, "pause_collection": { "anyOf": [ { "properties": { "behavior": { "enum": [ "keep_as_draft", "mark_uncollectible", "void" ], "type": "string" }, "resumes_at": { "format": "unix-time", "type": "integer" } }, "required": [ "behavior" ], "title": "pause_collection_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://stripe.com/docs/billing/subscriptions/pause-payment)." }, "payment_behavior": { "description": "Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior.\n\nUse `default_incomplete` to transition the subscription to `status=past_due` when payment is required and await explicit confirmation of the invoice's payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription’s invoice. Such as failed payments, [SCA regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method.\n\nUse `pending_if_incomplete` to update the subscription using [pending updates](https://stripe.com/docs/billing/subscriptions/pending-updates). When you use `pending_if_incomplete` you can only pass the parameters [supported by pending updates](https://stripe.com/docs/billing/pending-updates-reference#supported-attributes).\n\nUse `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://docs.stripe.com/changelog/2019-03-14) to learn more.", "enum": [ "allow_incomplete", "default_incomplete", "error_if_incomplete", "pending_if_incomplete" ], "type": "string" }, "payment_settings": { "description": "Payment settings to pass to invoices created by the subscription.", "properties": { "payment_method_options": { "properties": { "acss_debit": { "anyOf": [ { "properties": { "mandate_options": { "properties": { "transaction_type": { "enum": [ "business", "personal" ], "type": "string" } }, "title": "mandate_options_param", "type": "object" }, "verification_method": { "enum": [ "automatic", "instant", "microdeposits" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "invoice_payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "bancontact": { "anyOf": [ { "properties": { "preferred_language": { "enum": [ "de", "en", "fr", "nl" ], "type": "string" } }, "title": "invoice_payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "card": { "anyOf": [ { "properties": { "mandate_options": { "properties": { "amount": { "type": "integer" }, "amount_type": { "enum": [ "fixed", "maximum" ], "type": "string" }, "description": { "maxLength": 200, "type": "string" } }, "title": "mandate_options_param", "type": "object" }, "network": { "enum": [ "amex", "cartes_bancaires", "diners", "discover", "eftpos_au", "girocard", "interac", "jcb", "link", "mastercard", "unionpay", "unknown", "visa" ], "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true }, "request_three_d_secure": { "enum": [ "any", "automatic", "challenge" ], "type": "string" } }, "title": "subscription_payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "customer_balance": { "anyOf": [ { "properties": { "bank_transfer": { "properties": { "eu_bank_transfer": { "properties": { "country": { "maxLength": 5000, "type": "string" } }, "required": [ "country" ], "title": "eu_bank_transfer_param", "type": "object" }, "type": { "type": "string" } }, "title": "bank_transfer_param", "type": "object" }, "funding_type": { "type": "string" } }, "title": "invoice_payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "konbini": { "anyOf": [ { "properties": {}, "title": "invoice_payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "sepa_debit": { "anyOf": [ { "properties": {}, "title": "invoice_payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "us_bank_account": { "anyOf": [ { "properties": { "financial_connections": { "properties": { "filters": { "properties": { "account_subcategories": { "items": { "enum": [ "checking", "savings" ], "type": "string" }, "type": "array" } }, "title": "invoice_linked_account_options_filters_param", "type": "object" }, "permissions": { "items": { "enum": [ "balances", "ownership", "payment_method", "transactions" ], "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true }, "type": "array" }, "prefetch": { "items": { "enum": [ "balances", "ownership", "transactions" ], "type": "string", "x-stripeBypassValidation": true }, "type": "array" } }, "title": "invoice_linked_account_options_param", "type": "object" }, "verification_method": { "enum": [ "automatic", "instant", "microdeposits" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "invoice_payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "payment_method_options", "type": "object" }, "payment_method_types": { "anyOf": [ { "items": { "enum": [ "ach_credit_transfer", "ach_debit", "acss_debit", "affirm", "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", "boleto", "card", "cashapp", "crypto", "customer_balance", "eps", "fpx", "giropay", "grabpay", "ideal", "jp_credit_transfer", "kakao_pay", "klarna", "konbini", "kr_card", "link", "multibanco", "naver_pay", "nz_bank_account", "p24", "payco", "paynow", "paypal", "promptpay", "revolut_pay", "sepa_credit_transfer", "sepa_debit", "sofort", "swish", "us_bank_account", "wechat_pay" ], "type": "string", "x-stripeBypassValidation": true }, "type": "array" }, { "enum": [ "" ], "type": "string" } ] }, "save_default_payment_method": { "enum": [ "off", "on_subscription" ], "type": "string" } }, "title": "payment_settings", "type": "object" }, "pending_invoice_item_interval": { "anyOf": [ { "properties": { "interval": { "enum": [ "day", "month", "week", "year" ], "type": "string" }, "interval_count": { "type": "integer" } }, "required": [ "interval" ], "title": "pending_invoice_item_interval_params", "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://stripe.com/docs/api#create_invoice) for the given subscription at the specified interval." }, "proration_behavior": { "description": "Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.", "enum": [ "always_invoice", "create_prorations", "none" ], "type": "string" }, "proration_date": { "description": "If set, prorations will be calculated as though the subscription was updated at the given time. This can be used to apply exactly the same prorations that were previewed with the [create preview](https://stripe.com/docs/api/invoices/create_preview) endpoint. `proration_date` can also be used to implement custom proration logic, such as prorating by day instead of by second, by providing the time that you wish to use for proration calculations.", "format": "unix-time", "type": "integer" }, "transfer_data": { "anyOf": [ { "properties": { "amount_percent": { "type": "number" }, "destination": { "type": "string" } }, "required": [ "destination" ], "title": "transfer_data_specs", "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges. This will be unset if you POST an empty value." }, "trial_end": { "anyOf": [ { "enum": [ "now" ], "maxLength": 5000, "type": "string" }, { "format": "unix-time", "type": "integer" } ], "description": "Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. If set, `trial_end` will override the default trial period of the plan the customer is being subscribed to. The `billing_cycle_anchor` will be updated to the `trial_end` value. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`." }, "trial_from_plan": { "description": "Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more.", "type": "boolean" }, "trial_settings": { "description": "Settings related to subscription trials.", "properties": { "end_behavior": { "properties": { "missing_payment_method": { "enum": [ "cancel", "create_invoice", "pause" ], "type": "string" } }, "required": [ "missing_payment_method" ], "title": "end_behavior", "type": "object" } }, "required": [ "end_behavior" ], "title": "trial_settings_config", "type": "object" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/subscription" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a subscription" } }, "/v1/subscriptions/{subscription_exposed_id}/discount": { "delete": { "description": "

Removes the currently applied discount on a subscription.

", "operationId": "DeleteSubscriptionsSubscriptionExposedIdDiscount", "parameters": [ { "in": "path", "name": "subscription_exposed_id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted_discount" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Delete a subscription discount" } }, "/v1/subscriptions/{subscription}/migrate": { "post": { "description": "

Upgrade the billing_mode of an existing subscription.

", "operationId": "PostSubscriptionsSubscriptionMigrate", "parameters": [ { "in": "path", "name": "subscription", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "billing_mode": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "billing_mode": { "description": "Controls how prorations and invoices for subscriptions are calculated and orchestrated.", "properties": { "type": { "enum": [ "flexible" ], "type": "string" } }, "required": [ "type" ], "title": "billing_mode_migrate", "type": "object" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "required": [ "billing_mode" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/subscription" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Migrate a subscription" } }, "/v1/subscriptions/{subscription}/resume": { "post": { "description": "

Initiates resumption of a paused subscription, optionally resetting the billing cycle anchor and creating prorations. If a resumption invoice is generated, it must be paid or marked uncollectible before the subscription will be unpaused. If payment succeeds the subscription will become active, and if payment fails the subscription will be past_due. The resumption invoice will void automatically if not paid by the expiration date.

", "operationId": "PostSubscriptionsSubscriptionResume", "parameters": [ { "in": "path", "name": "subscription", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "billing_cycle_anchor": { "description": "The billing cycle anchor that applies when the subscription is resumed. Either `now` or `unchanged`. The default is `now`. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).", "enum": [ "now", "unchanged" ], "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "proration_behavior": { "description": "Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) resulting from the `billing_cycle_anchor` being `unchanged`. When the `billing_cycle_anchor` is set to `now` (default value), no prorations are generated. If no value is passed, the default is `create_prorations`.", "enum": [ "always_invoice", "create_prorations", "none" ], "type": "string" }, "proration_date": { "description": "If set, prorations will be calculated as though the subscription was resumed at the given time. This can be used to apply exactly the same prorations that were previewed with the [create preview](https://stripe.com/docs/api/invoices/create_preview) endpoint.", "format": "unix-time", "type": "integer" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/subscription" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Resume a subscription" } }, "/v1/tax/calculations": { "post": { "description": "

Calculates tax based on the input and returns a Tax Calculation object.

", "operationId": "PostTaxCalculations", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "customer_details": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "line_items": { "explode": true, "style": "deepObject" }, "ship_from_details": { "explode": true, "style": "deepObject" }, "shipping_cost": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "customer": { "description": "The ID of an existing customer to use for this calculation. If provided, the customer's address and tax IDs are copied to `customer_details`.", "maxLength": 5000, "type": "string" }, "customer_details": { "description": "Details about the customer, including address and tax IDs.", "properties": { "address": { "properties": { "city": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "country": { "maxLength": 5000, "type": "string" }, "line1": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "line2": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "postal_code": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "state": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] } }, "required": [ "country" ], "title": "postal_address", "type": "object" }, "address_source": { "enum": [ "billing", "shipping" ], "type": "string" }, "ip_address": { "type": "string" }, "tax_ids": { "items": { "properties": { "type": { "enum": [ "ad_nrt", "ae_trn", "al_tin", "am_tin", "ao_tin", "ar_cuit", "au_abn", "au_arn", "aw_tin", "az_tin", "ba_tin", "bb_tin", "bd_bin", "bf_ifu", "bg_uic", "bh_vat", "bj_ifu", "bo_tin", "br_cnpj", "br_cpf", "bs_tin", "by_tin", "ca_bn", "ca_gst_hst", "ca_pst_bc", "ca_pst_mb", "ca_pst_sk", "ca_qst", "cd_nif", "ch_uid", "ch_vat", "cl_tin", "cm_niu", "cn_tin", "co_nit", "cr_tin", "cv_nif", "de_stn", "do_rcn", "ec_ruc", "eg_tin", "es_cif", "et_tin", "eu_oss_vat", "eu_vat", "gb_vat", "ge_vat", "gn_nif", "hk_br", "hr_oib", "hu_tin", "id_npwp", "il_vat", "in_gst", "is_vat", "jp_cn", "jp_rn", "jp_trn", "ke_pin", "kg_tin", "kh_tin", "kr_brn", "kz_bin", "la_tin", "li_uid", "li_vat", "ma_vat", "md_vat", "me_pib", "mk_vat", "mr_nif", "mx_rfc", "my_frp", "my_itn", "my_sst", "ng_tin", "no_vat", "no_voec", "np_pan", "nz_gst", "om_vat", "pe_ruc", "ph_tin", "ro_tin", "rs_pib", "ru_inn", "ru_kpp", "sa_vat", "sg_gst", "sg_uen", "si_tin", "sn_ninea", "sr_fin", "sv_nit", "th_vat", "tj_tin", "tr_tin", "tw_vat", "tz_vat", "ua_vat", "ug_tin", "us_ein", "uy_ruc", "uz_tin", "uz_vat", "ve_rif", "vn_tin", "za_vat", "zm_tin", "zw_tin" ], "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true }, "value": { "type": "string" } }, "required": [ "type", "value" ], "title": "data_params", "type": "object" }, "type": "array" }, "taxability_override": { "enum": [ "customer_exempt", "none", "reverse_charge" ], "type": "string" } }, "title": "customer_details", "type": "object" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "line_items": { "description": "A list of items the customer is purchasing.", "items": { "properties": { "amount": { "type": "integer" }, "metadata": { "additionalProperties": { "type": "string" }, "type": "object" }, "product": { "maxLength": 5000, "type": "string" }, "quantity": { "type": "integer" }, "reference": { "maxLength": 500, "type": "string" }, "tax_behavior": { "enum": [ "exclusive", "inclusive" ], "type": "string" }, "tax_code": { "type": "string" } }, "required": [ "amount" ], "title": "calculation_line_item", "type": "object" }, "type": "array" }, "ship_from_details": { "description": "Details about the address from which the goods are being shipped.", "properties": { "address": { "properties": { "city": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "country": { "maxLength": 5000, "type": "string" }, "line1": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "line2": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "postal_code": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "state": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] } }, "required": [ "country" ], "title": "merchant_postal_address", "type": "object" } }, "required": [ "address" ], "title": "ship_from_details", "type": "object" }, "shipping_cost": { "description": "Shipping cost details to be used for the calculation.", "properties": { "amount": { "type": "integer" }, "shipping_rate": { "maxLength": 5000, "type": "string" }, "tax_behavior": { "enum": [ "exclusive", "inclusive" ], "type": "string" }, "tax_code": { "type": "string" } }, "title": "shipping_cost", "type": "object" }, "tax_date": { "description": "Timestamp of date at which the tax rules and rates in effect applies for the calculation. Measured in seconds since the Unix epoch. Can be up to 48 hours in the past, and up to 48 hours in the future.", "type": "integer" } }, "required": [ "currency", "line_items" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax.calculation" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a Tax Calculation" } }, "/v1/tax/calculations/{calculation}": { "get": { "description": "

Retrieves a Tax Calculation object, if the calculation hasn’t expired.

", "operationId": "GetTaxCalculationsCalculation", "parameters": [ { "in": "path", "name": "calculation", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax.calculation" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a Tax Calculation" } }, "/v1/tax/calculations/{calculation}/line_items": { "get": { "description": "

Retrieves the line items of a tax calculation as a collection, if the calculation hasn’t expired.

", "operationId": "GetTaxCalculationsCalculationLineItems", "parameters": [ { "in": "path", "name": "calculation", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 500, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 500, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/tax.calculation_line_item" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/tax/calculations/[^/]+/line_items", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "TaxProductResourceTaxCalculationLineItemList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a calculation's line items" } }, "/v1/tax/registrations": { "get": { "description": "

Returns a list of Tax Registration objects.

", "operationId": "GetTaxRegistrations", "parameters": [ { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "The status of the Tax Registration.", "in": "query", "name": "status", "required": false, "schema": { "enum": [ "active", "all", "expired", "scheduled" ], "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/tax.registration" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/tax/registrations", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "TaxProductRegistrationsResourceTaxRegistrationList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List registrations" }, "post": { "description": "

Creates a new Tax Registration object.

", "operationId": "PostTaxRegistrations", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "active_from": { "explode": true, "style": "deepObject" }, "country_options": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "active_from": { "anyOf": [ { "enum": [ "now" ], "maxLength": 5000, "type": "string" }, { "format": "unix-time", "type": "integer" } ], "description": "Time at which the Tax Registration becomes active. It can be either `now` to indicate the current time, or a future timestamp measured in seconds since the Unix epoch." }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "country_options": { "description": "Specific options for a registration in the specified `country`.", "properties": { "ae": { "properties": { "standard": { "properties": { "place_of_supply_scheme": { "enum": [ "inbound_goods", "standard" ], "type": "string" } }, "title": "standard", "type": "object" }, "type": { "enum": [ "standard" ], "type": "string" } }, "required": [ "type" ], "title": "default", "type": "object" }, "al": { "properties": { "standard": { "properties": { "place_of_supply_scheme": { "enum": [ "inbound_goods", "standard" ], "type": "string" } }, "title": "standard", "type": "object" }, "type": { "enum": [ "standard" ], "type": "string" } }, "required": [ "type" ], "title": "default", "type": "object" }, "am": { "properties": { "type": { "enum": [ "simplified" ], "type": "string" } }, "required": [ "type" ], "title": "simplified", "type": "object" }, "ao": { "properties": { "standard": { "properties": { "place_of_supply_scheme": { "enum": [ "inbound_goods", "standard" ], "type": "string" } }, "title": "standard", "type": "object" }, "type": { "enum": [ "standard" ], "type": "string" } }, "required": [ "type" ], "title": "default", "type": "object" }, "at": { "properties": { "standard": { "properties": { "place_of_supply_scheme": { "enum": [ "inbound_goods", "small_seller", "standard" ], "type": "string" } }, "required": [ "place_of_supply_scheme" ], "title": "standard", "type": "object" }, "type": { "enum": [ "ioss", "oss_non_union", "oss_union", "standard" ], "type": "string" } }, "required": [ "type" ], "title": "europe", "type": "object" }, "au": { "properties": { "standard": { "properties": { "place_of_supply_scheme": { "enum": [ "inbound_goods", "standard" ], "type": "string" } }, "title": "standard", "type": "object" }, "type": { "enum": [ "standard" ], "type": "string" } }, "required": [ "type" ], "title": "default", "type": "object" }, "aw": { "properties": { "standard": { "properties": { "place_of_supply_scheme": { "enum": [ "inbound_goods", "standard" ], "type": "string" } }, "title": "standard", "type": "object" }, "type": { "enum": [ "standard" ], "type": "string" } }, "required": [ "type" ], "title": "default", "type": "object" }, "az": { "properties": { "type": { "enum": [ "simplified" ], "type": "string" } }, "required": [ "type" ], "title": "simplified", "type": "object" }, "ba": { "properties": { "standard": { "properties": { "place_of_supply_scheme": { "enum": [ "inbound_goods", "standard" ], "type": "string" } }, "title": "standard", "type": "object" }, "type": { "enum": [ "standard" ], "type": "string" } }, "required": [ "type" ], "title": "default", "type": "object" }, "bb": { "properties": { "standard": { "properties": { "place_of_supply_scheme": { "enum": [ "inbound_goods", "standard" ], "type": "string" } }, "title": "standard", "type": "object" }, "type": { "enum": [ "standard" ], "type": "string" } }, "required": [ "type" ], "title": "default", "type": "object" }, "bd": { "properties": { "standard": { "properties": { "place_of_supply_scheme": { "enum": [ "inbound_goods", "standard" ], "type": "string" } }, "title": "standard", "type": "object" }, "type": { "enum": [ "standard" ], "type": "string" } }, "required": [ "type" ], "title": "default", "type": "object" }, "be": { "properties": { "standard": { "properties": { "place_of_supply_scheme": { "enum": [ "inbound_goods", "small_seller", "standard" ], "type": "string" } }, "required": [ "place_of_supply_scheme" ], "title": "standard", "type": "object" }, "type": { "enum": [ "ioss", "oss_non_union", "oss_union", "standard" ], "type": "string" } }, "required": [ "type" ], "title": "europe", "type": "object" }, "bf": { "properties": { "standard": { "properties": { "place_of_supply_scheme": { "enum": [ "inbound_goods", "standard" ], "type": "string" } }, "title": "standard", "type": "object" }, "type": { "enum": [ "standard" ], "type": "string" } }, "required": [ "type" ], "title": "default", "type": "object" }, "bg": { "properties": { "standard": { "properties": { "place_of_supply_scheme": { "enum": [ "inbound_goods", "small_seller", "standard" ], "type": "string" } }, "required": [ "place_of_supply_scheme" ], "title": "standard", "type": "object" }, "type": { "enum": [ "ioss", "oss_non_union", "oss_union", "standard" ], "type": "string" } }, "required": [ "type" ], "title": "europe", "type": "object" }, "bh": { "properties": { "standard": { "properties": { "place_of_supply_scheme": { "enum": [ "inbound_goods", "standard" ], "type": "string" } }, "title": "standard", "type": "object" }, "type": { "enum": [ "standard" ], "type": "string" } }, "required": [ "type" ], "title": "default", "type": "object" }, "bj": { "properties": { "type": { "enum": [ "simplified" ], "type": "string" } }, "required": [ "type" ], "title": "simplified", "type": "object" }, "bs": { "properties": { "standard": { "properties": { "place_of_supply_scheme": { "enum": [ "inbound_goods", "standard" ], "type": "string" } }, "title": "standard", "type": "object" }, "type": { "enum": [ "standard" ], "type": "string" } }, "required": [ "type" ], "title": "default", "type": "object" }, "by": { "properties": { "type": { "enum": [ "simplified" ], "type": "string" } }, "required": [ "type" ], "title": "simplified", "type": "object" }, "ca": { "properties": { "province_standard": { "properties": { "province": { "maxLength": 5000, "type": "string" } }, "required": [ "province" ], "title": "province_standard", "type": "object" }, "type": { "enum": [ "province_standard", "simplified", "standard" ], "type": "string" } }, "required": [ "type" ], "title": "canada", "type": "object" }, "cd": { "properties": { "standard": { "properties": { "place_of_supply_scheme": { "enum": [ "inbound_goods", "standard" ], "type": "string" } }, "title": "standard", "type": "object" }, "type": { "enum": [ "standard" ], "type": "string" } }, "required": [ "type" ], "title": "default", "type": "object" }, "ch": { "properties": { "standard": { "properties": { "place_of_supply_scheme": { "enum": [ "inbound_goods", "standard" ], "type": "string" } }, "title": "standard", "type": "object" }, "type": { "enum": [ "standard" ], "type": "string" } }, "required": [ "type" ], "title": "default", "type": "object" }, "cl": { "properties": { "type": { "enum": [ "simplified" ], "type": "string" } }, "required": [ "type" ], "title": "simplified", "type": "object" }, "cm": { "properties": { "type": { "enum": [ "simplified" ], "type": "string" } }, "required": [ "type" ], "title": "simplified", "type": "object" }, "co": { "properties": { "type": { "enum": [ "simplified" ], "type": "string" } }, "required": [ "type" ], "title": "simplified", "type": "object" }, "cr": { "properties": { "type": { "enum": [ "simplified" ], "type": "string" } }, "required": [ "type" ], "title": "simplified", "type": "object" }, "cv": { "properties": { "type": { "enum": [ "simplified" ], "type": "string" } }, "required": [ "type" ], "title": "simplified", "type": "object" }, "cy": { "properties": { "standard": { "properties": { "place_of_supply_scheme": { "enum": [ "inbound_goods", "small_seller", "standard" ], "type": "string" } }, "required": [ "place_of_supply_scheme" ], "title": "standard", "type": "object" }, "type": { "enum": [ "ioss", "oss_non_union", "oss_union", "standard" ], "type": "string" } }, "required": [ "type" ], "title": "europe", "type": "object" }, "cz": { "properties": { "standard": { "properties": { "place_of_supply_scheme": { "enum": [ "inbound_goods", "small_seller", "standard" ], "type": "string" } }, "required": [ "place_of_supply_scheme" ], "title": "standard", "type": "object" }, "type": { "enum": [ "ioss", "oss_non_union", "oss_union", "standard" ], "type": "string" } }, "required": [ "type" ], "title": "europe", "type": "object" }, "de": { "properties": { "standard": { "properties": { "place_of_supply_scheme": { "enum": [ "inbound_goods", "small_seller", "standard" ], "type": "string" } }, "required": [ "place_of_supply_scheme" ], "title": "standard", "type": "object" }, "type": { "enum": [ "ioss", "oss_non_union", "oss_union", "standard" ], "type": "string" } }, "required": [ "type" ], "title": "europe", "type": "object" }, "dk": { "properties": { "standard": { "properties": { "place_of_supply_scheme": { "enum": [ "inbound_goods", "small_seller", "standard" ], "type": "string" } }, "required": [ "place_of_supply_scheme" ], "title": "standard", "type": "object" }, "type": { "enum": [ "ioss", "oss_non_union", "oss_union", "standard" ], "type": "string" } }, "required": [ "type" ], "title": "europe", "type": "object" }, "ec": { "properties": { "type": { "enum": [ "simplified" ], "type": "string" } }, "required": [ "type" ], "title": "simplified", "type": "object" }, "ee": { "properties": { "standard": { "properties": { "place_of_supply_scheme": { "enum": [ "inbound_goods", "small_seller", "standard" ], "type": "string" } }, "required": [ "place_of_supply_scheme" ], "title": "standard", "type": "object" }, "type": { "enum": [ "ioss", "oss_non_union", "oss_union", "standard" ], "type": "string" } }, "required": [ "type" ], "title": "europe", "type": "object" }, "eg": { "properties": { "type": { "enum": [ "simplified" ], "type": "string" } }, "required": [ "type" ], "title": "simplified", "type": "object" }, "es": { "properties": { "standard": { "properties": { "place_of_supply_scheme": { "enum": [ "inbound_goods", "small_seller", "standard" ], "type": "string" } }, "required": [ "place_of_supply_scheme" ], "title": "standard", "type": "object" }, "type": { "enum": [ "ioss", "oss_non_union", "oss_union", "standard" ], "type": "string" } }, "required": [ "type" ], "title": "europe", "type": "object" }, "et": { "properties": { "standard": { "properties": { "place_of_supply_scheme": { "enum": [ "inbound_goods", "standard" ], "type": "string" } }, "title": "standard", "type": "object" }, "type": { "enum": [ "standard" ], "type": "string" } }, "required": [ "type" ], "title": "default", "type": "object" }, "fi": { "properties": { "standard": { "properties": { "place_of_supply_scheme": { "enum": [ "inbound_goods", "small_seller", "standard" ], "type": "string" } }, "required": [ "place_of_supply_scheme" ], "title": "standard", "type": "object" }, "type": { "enum": [ "ioss", "oss_non_union", "oss_union", "standard" ], "type": "string" } }, "required": [ "type" ], "title": "europe", "type": "object" }, "fr": { "properties": { "standard": { "properties": { "place_of_supply_scheme": { "enum": [ "inbound_goods", "small_seller", "standard" ], "type": "string" } }, "required": [ "place_of_supply_scheme" ], "title": "standard", "type": "object" }, "type": { "enum": [ "ioss", "oss_non_union", "oss_union", "standard" ], "type": "string" } }, "required": [ "type" ], "title": "europe", "type": "object" }, "gb": { "properties": { "standard": { "properties": { "place_of_supply_scheme": { "enum": [ "inbound_goods", "standard" ], "type": "string" } }, "title": "standard", "type": "object" }, "type": { "enum": [ "standard" ], "type": "string" } }, "required": [ "type" ], "title": "default", "type": "object" }, "ge": { "properties": { "type": { "enum": [ "simplified" ], "type": "string" } }, "required": [ "type" ], "title": "simplified", "type": "object" }, "gn": { "properties": { "standard": { "properties": { "place_of_supply_scheme": { "enum": [ "inbound_goods", "standard" ], "type": "string" } }, "title": "standard", "type": "object" }, "type": { "enum": [ "standard" ], "type": "string" } }, "required": [ "type" ], "title": "default", "type": "object" }, "gr": { "properties": { "standard": { "properties": { "place_of_supply_scheme": { "enum": [ "inbound_goods", "small_seller", "standard" ], "type": "string" } }, "required": [ "place_of_supply_scheme" ], "title": "standard", "type": "object" }, "type": { "enum": [ "ioss", "oss_non_union", "oss_union", "standard" ], "type": "string" } }, "required": [ "type" ], "title": "europe", "type": "object" }, "hr": { "properties": { "standard": { "properties": { "place_of_supply_scheme": { "enum": [ "inbound_goods", "small_seller", "standard" ], "type": "string" } }, "required": [ "place_of_supply_scheme" ], "title": "standard", "type": "object" }, "type": { "enum": [ "ioss", "oss_non_union", "oss_union", "standard" ], "type": "string" } }, "required": [ "type" ], "title": "europe", "type": "object" }, "hu": { "properties": { "standard": { "properties": { "place_of_supply_scheme": { "enum": [ "inbound_goods", "small_seller", "standard" ], "type": "string" } }, "required": [ "place_of_supply_scheme" ], "title": "standard", "type": "object" }, "type": { "enum": [ "ioss", "oss_non_union", "oss_union", "standard" ], "type": "string" } }, "required": [ "type" ], "title": "europe", "type": "object" }, "id": { "properties": { "type": { "enum": [ "simplified" ], "type": "string" } }, "required": [ "type" ], "title": "simplified", "type": "object" }, "ie": { "properties": { "standard": { "properties": { "place_of_supply_scheme": { "enum": [ "inbound_goods", "small_seller", "standard" ], "type": "string" } }, "required": [ "place_of_supply_scheme" ], "title": "standard", "type": "object" }, "type": { "enum": [ "ioss", "oss_non_union", "oss_union", "standard" ], "type": "string" } }, "required": [ "type" ], "title": "europe", "type": "object" }, "in": { "properties": { "type": { "enum": [ "simplified" ], "type": "string" } }, "required": [ "type" ], "title": "simplified", "type": "object" }, "is": { "properties": { "standard": { "properties": { "place_of_supply_scheme": { "enum": [ "inbound_goods", "standard" ], "type": "string" } }, "title": "standard", "type": "object" }, "type": { "enum": [ "standard" ], "type": "string" } }, "required": [ "type" ], "title": "default", "type": "object" }, "it": { "properties": { "standard": { "properties": { "place_of_supply_scheme": { "enum": [ "inbound_goods", "small_seller", "standard" ], "type": "string" } }, "required": [ "place_of_supply_scheme" ], "title": "standard", "type": "object" }, "type": { "enum": [ "ioss", "oss_non_union", "oss_union", "standard" ], "type": "string" } }, "required": [ "type" ], "title": "europe", "type": "object" }, "jp": { "properties": { "standard": { "properties": { "place_of_supply_scheme": { "enum": [ "inbound_goods", "standard" ], "type": "string" } }, "title": "standard", "type": "object" }, "type": { "enum": [ "standard" ], "type": "string" } }, "required": [ "type" ], "title": "default", "type": "object" }, "ke": { "properties": { "type": { "enum": [ "simplified" ], "type": "string" } }, "required": [ "type" ], "title": "simplified", "type": "object" }, "kg": { "properties": { "type": { "enum": [ "simplified" ], "type": "string" } }, "required": [ "type" ], "title": "simplified", "type": "object" }, "kh": { "properties": { "type": { "enum": [ "simplified" ], "type": "string" } }, "required": [ "type" ], "title": "simplified", "type": "object" }, "kr": { "properties": { "type": { "enum": [ "simplified" ], "type": "string" } }, "required": [ "type" ], "title": "simplified", "type": "object" }, "kz": { "properties": { "type": { "enum": [ "simplified" ], "type": "string" } }, "required": [ "type" ], "title": "simplified", "type": "object" }, "la": { "properties": { "type": { "enum": [ "simplified" ], "type": "string" } }, "required": [ "type" ], "title": "simplified", "type": "object" }, "lt": { "properties": { "standard": { "properties": { "place_of_supply_scheme": { "enum": [ "inbound_goods", "small_seller", "standard" ], "type": "string" } }, "required": [ "place_of_supply_scheme" ], "title": "standard", "type": "object" }, "type": { "enum": [ "ioss", "oss_non_union", "oss_union", "standard" ], "type": "string" } }, "required": [ "type" ], "title": "europe", "type": "object" }, "lu": { "properties": { "standard": { "properties": { "place_of_supply_scheme": { "enum": [ "inbound_goods", "small_seller", "standard" ], "type": "string" } }, "required": [ "place_of_supply_scheme" ], "title": "standard", "type": "object" }, "type": { "enum": [ "ioss", "oss_non_union", "oss_union", "standard" ], "type": "string" } }, "required": [ "type" ], "title": "europe", "type": "object" }, "lv": { "properties": { "standard": { "properties": { "place_of_supply_scheme": { "enum": [ "inbound_goods", "small_seller", "standard" ], "type": "string" } }, "required": [ "place_of_supply_scheme" ], "title": "standard", "type": "object" }, "type": { "enum": [ "ioss", "oss_non_union", "oss_union", "standard" ], "type": "string" } }, "required": [ "type" ], "title": "europe", "type": "object" }, "ma": { "properties": { "type": { "enum": [ "simplified" ], "type": "string" } }, "required": [ "type" ], "title": "simplified", "type": "object" }, "md": { "properties": { "type": { "enum": [ "simplified" ], "type": "string" } }, "required": [ "type" ], "title": "simplified", "type": "object" }, "me": { "properties": { "standard": { "properties": { "place_of_supply_scheme": { "enum": [ "inbound_goods", "standard" ], "type": "string" } }, "title": "standard", "type": "object" }, "type": { "enum": [ "standard" ], "type": "string" } }, "required": [ "type" ], "title": "default", "type": "object" }, "mk": { "properties": { "standard": { "properties": { "place_of_supply_scheme": { "enum": [ "inbound_goods", "standard" ], "type": "string" } }, "title": "standard", "type": "object" }, "type": { "enum": [ "standard" ], "type": "string" } }, "required": [ "type" ], "title": "default", "type": "object" }, "mr": { "properties": { "standard": { "properties": { "place_of_supply_scheme": { "enum": [ "inbound_goods", "standard" ], "type": "string" } }, "title": "standard", "type": "object" }, "type": { "enum": [ "standard" ], "type": "string" } }, "required": [ "type" ], "title": "default", "type": "object" }, "mt": { "properties": { "standard": { "properties": { "place_of_supply_scheme": { "enum": [ "inbound_goods", "small_seller", "standard" ], "type": "string" } }, "required": [ "place_of_supply_scheme" ], "title": "standard", "type": "object" }, "type": { "enum": [ "ioss", "oss_non_union", "oss_union", "standard" ], "type": "string" } }, "required": [ "type" ], "title": "europe", "type": "object" }, "mx": { "properties": { "type": { "enum": [ "simplified" ], "type": "string" } }, "required": [ "type" ], "title": "simplified", "type": "object" }, "my": { "properties": { "type": { "enum": [ "simplified" ], "type": "string" } }, "required": [ "type" ], "title": "simplified", "type": "object" }, "ng": { "properties": { "type": { "enum": [ "simplified" ], "type": "string" } }, "required": [ "type" ], "title": "simplified", "type": "object" }, "nl": { "properties": { "standard": { "properties": { "place_of_supply_scheme": { "enum": [ "inbound_goods", "small_seller", "standard" ], "type": "string" } }, "required": [ "place_of_supply_scheme" ], "title": "standard", "type": "object" }, "type": { "enum": [ "ioss", "oss_non_union", "oss_union", "standard" ], "type": "string" } }, "required": [ "type" ], "title": "europe", "type": "object" }, "no": { "properties": { "standard": { "properties": { "place_of_supply_scheme": { "enum": [ "inbound_goods", "standard" ], "type": "string" } }, "title": "standard", "type": "object" }, "type": { "enum": [ "standard" ], "type": "string" } }, "required": [ "type" ], "title": "default", "type": "object" }, "np": { "properties": { "type": { "enum": [ "simplified" ], "type": "string" } }, "required": [ "type" ], "title": "simplified", "type": "object" }, "nz": { "properties": { "standard": { "properties": { "place_of_supply_scheme": { "enum": [ "inbound_goods", "standard" ], "type": "string" } }, "title": "standard", "type": "object" }, "type": { "enum": [ "standard" ], "type": "string" } }, "required": [ "type" ], "title": "default", "type": "object" }, "om": { "properties": { "standard": { "properties": { "place_of_supply_scheme": { "enum": [ "inbound_goods", "standard" ], "type": "string" } }, "title": "standard", "type": "object" }, "type": { "enum": [ "standard" ], "type": "string" } }, "required": [ "type" ], "title": "default", "type": "object" }, "pe": { "properties": { "type": { "enum": [ "simplified" ], "type": "string" } }, "required": [ "type" ], "title": "simplified", "type": "object" }, "ph": { "properties": { "type": { "enum": [ "simplified" ], "type": "string" } }, "required": [ "type" ], "title": "simplified", "type": "object" }, "pl": { "properties": { "standard": { "properties": { "place_of_supply_scheme": { "enum": [ "inbound_goods", "small_seller", "standard" ], "type": "string" } }, "required": [ "place_of_supply_scheme" ], "title": "standard", "type": "object" }, "type": { "enum": [ "ioss", "oss_non_union", "oss_union", "standard" ], "type": "string" } }, "required": [ "type" ], "title": "europe", "type": "object" }, "pt": { "properties": { "standard": { "properties": { "place_of_supply_scheme": { "enum": [ "inbound_goods", "small_seller", "standard" ], "type": "string" } }, "required": [ "place_of_supply_scheme" ], "title": "standard", "type": "object" }, "type": { "enum": [ "ioss", "oss_non_union", "oss_union", "standard" ], "type": "string" } }, "required": [ "type" ], "title": "europe", "type": "object" }, "ro": { "properties": { "standard": { "properties": { "place_of_supply_scheme": { "enum": [ "inbound_goods", "small_seller", "standard" ], "type": "string" } }, "required": [ "place_of_supply_scheme" ], "title": "standard", "type": "object" }, "type": { "enum": [ "ioss", "oss_non_union", "oss_union", "standard" ], "type": "string" } }, "required": [ "type" ], "title": "europe", "type": "object" }, "rs": { "properties": { "standard": { "properties": { "place_of_supply_scheme": { "enum": [ "inbound_goods", "standard" ], "type": "string" } }, "title": "standard", "type": "object" }, "type": { "enum": [ "standard" ], "type": "string" } }, "required": [ "type" ], "title": "default", "type": "object" }, "ru": { "properties": { "type": { "enum": [ "simplified" ], "type": "string" } }, "required": [ "type" ], "title": "simplified", "type": "object" }, "sa": { "properties": { "type": { "enum": [ "simplified" ], "type": "string" } }, "required": [ "type" ], "title": "simplified", "type": "object" }, "se": { "properties": { "standard": { "properties": { "place_of_supply_scheme": { "enum": [ "inbound_goods", "small_seller", "standard" ], "type": "string" } }, "required": [ "place_of_supply_scheme" ], "title": "standard", "type": "object" }, "type": { "enum": [ "ioss", "oss_non_union", "oss_union", "standard" ], "type": "string" } }, "required": [ "type" ], "title": "europe", "type": "object" }, "sg": { "properties": { "standard": { "properties": { "place_of_supply_scheme": { "enum": [ "inbound_goods", "standard" ], "type": "string" } }, "title": "standard", "type": "object" }, "type": { "enum": [ "standard" ], "type": "string" } }, "required": [ "type" ], "title": "default", "type": "object" }, "si": { "properties": { "standard": { "properties": { "place_of_supply_scheme": { "enum": [ "inbound_goods", "small_seller", "standard" ], "type": "string" } }, "required": [ "place_of_supply_scheme" ], "title": "standard", "type": "object" }, "type": { "enum": [ "ioss", "oss_non_union", "oss_union", "standard" ], "type": "string" } }, "required": [ "type" ], "title": "europe", "type": "object" }, "sk": { "properties": { "standard": { "properties": { "place_of_supply_scheme": { "enum": [ "inbound_goods", "small_seller", "standard" ], "type": "string" } }, "required": [ "place_of_supply_scheme" ], "title": "standard", "type": "object" }, "type": { "enum": [ "ioss", "oss_non_union", "oss_union", "standard" ], "type": "string" } }, "required": [ "type" ], "title": "europe", "type": "object" }, "sn": { "properties": { "type": { "enum": [ "simplified" ], "type": "string" } }, "required": [ "type" ], "title": "simplified", "type": "object" }, "sr": { "properties": { "standard": { "properties": { "place_of_supply_scheme": { "enum": [ "inbound_goods", "standard" ], "type": "string" } }, "title": "standard", "type": "object" }, "type": { "enum": [ "standard" ], "type": "string" } }, "required": [ "type" ], "title": "default", "type": "object" }, "th": { "properties": { "type": { "enum": [ "simplified" ], "type": "string" } }, "required": [ "type" ], "title": "simplified", "type": "object" }, "tj": { "properties": { "type": { "enum": [ "simplified" ], "type": "string" } }, "required": [ "type" ], "title": "simplified", "type": "object" }, "tr": { "properties": { "type": { "enum": [ "simplified" ], "type": "string" } }, "required": [ "type" ], "title": "simplified", "type": "object" }, "tz": { "properties": { "type": { "enum": [ "simplified" ], "type": "string" } }, "required": [ "type" ], "title": "simplified", "type": "object" }, "ua": { "properties": { "type": { "enum": [ "simplified" ], "type": "string" } }, "required": [ "type" ], "title": "simplified", "type": "object" }, "ug": { "properties": { "type": { "enum": [ "simplified" ], "type": "string" } }, "required": [ "type" ], "title": "simplified", "type": "object" }, "us": { "properties": { "local_amusement_tax": { "properties": { "jurisdiction": { "maxLength": 5000, "type": "string" } }, "required": [ "jurisdiction" ], "title": "local_amusement_tax", "type": "object" }, "local_lease_tax": { "properties": { "jurisdiction": { "maxLength": 5000, "type": "string" } }, "required": [ "jurisdiction" ], "title": "local_lease_tax", "type": "object" }, "state": { "maxLength": 5000, "type": "string" }, "state_sales_tax": { "properties": { "elections": { "items": { "properties": { "jurisdiction": { "maxLength": 5000, "type": "string" }, "type": { "enum": [ "local_use_tax", "simplified_sellers_use_tax", "single_local_use_tax" ], "type": "string" } }, "required": [ "type" ], "title": "state_sales_tax_election", "type": "object" }, "type": "array" } }, "required": [ "elections" ], "title": "state_sales_tax", "type": "object" }, "type": { "enum": [ "local_amusement_tax", "local_lease_tax", "state_communications_tax", "state_retail_delivery_fee", "state_sales_tax" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "state", "type" ], "title": "united_states", "type": "object" }, "uy": { "properties": { "standard": { "properties": { "place_of_supply_scheme": { "enum": [ "inbound_goods", "standard" ], "type": "string" } }, "title": "standard", "type": "object" }, "type": { "enum": [ "standard" ], "type": "string" } }, "required": [ "type" ], "title": "default", "type": "object" }, "uz": { "properties": { "type": { "enum": [ "simplified" ], "type": "string" } }, "required": [ "type" ], "title": "simplified", "type": "object" }, "vn": { "properties": { "type": { "enum": [ "simplified" ], "type": "string" } }, "required": [ "type" ], "title": "simplified", "type": "object" }, "za": { "properties": { "standard": { "properties": { "place_of_supply_scheme": { "enum": [ "inbound_goods", "standard" ], "type": "string" } }, "title": "standard", "type": "object" }, "type": { "enum": [ "standard" ], "type": "string" } }, "required": [ "type" ], "title": "default", "type": "object" }, "zm": { "properties": { "type": { "enum": [ "simplified" ], "type": "string" } }, "required": [ "type" ], "title": "simplified", "type": "object" }, "zw": { "properties": { "standard": { "properties": { "place_of_supply_scheme": { "enum": [ "inbound_goods", "standard" ], "type": "string" } }, "title": "standard", "type": "object" }, "type": { "enum": [ "standard" ], "type": "string" } }, "required": [ "type" ], "title": "default", "type": "object" } }, "title": "country_options", "type": "object" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "expires_at": { "description": "If set, the Tax Registration stops being active at this time. If not set, the Tax Registration will be active indefinitely. Timestamp measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" } }, "required": [ "active_from", "country", "country_options" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax.registration" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a registration" } }, "/v1/tax/registrations/{id}": { "get": { "description": "

Returns a Tax Registration object.

", "operationId": "GetTaxRegistrationsId", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax.registration" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a registration" }, "post": { "description": "

Updates an existing Tax Registration object.

\n\n

A registration cannot be deleted after it has been created. If you wish to end a registration you may do so by setting expires_at.

", "operationId": "PostTaxRegistrationsId", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "active_from": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "expires_at": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "active_from": { "anyOf": [ { "enum": [ "now" ], "maxLength": 5000, "type": "string" }, { "format": "unix-time", "type": "integer" } ], "description": "Time at which the registration becomes active. It can be either `now` to indicate the current time, or a timestamp measured in seconds since the Unix epoch." }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "expires_at": { "anyOf": [ { "enum": [ "now" ], "maxLength": 5000, "type": "string" }, { "format": "unix-time", "type": "integer" }, { "enum": [ "" ], "type": "string" } ], "description": "If set, the registration stops being active at this time. If not set, the registration will be active indefinitely. It can be either `now` to indicate the current time, or a timestamp measured in seconds since the Unix epoch." } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax.registration" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a registration" } }, "/v1/tax/settings": { "get": { "description": "

Retrieves Tax Settings for a merchant.

", "operationId": "GetTaxSettings", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax.settings" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve settings" }, "post": { "description": "

Updates Tax Settings parameters used in tax calculations. All parameters are editable but none can be removed once set.

", "operationId": "PostTaxSettings", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "defaults": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "head_office": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "defaults": { "description": "Default configuration to be used on Stripe Tax calculations.", "properties": { "tax_behavior": { "enum": [ "exclusive", "inclusive", "inferred_by_currency" ], "type": "string" }, "tax_code": { "type": "string" } }, "title": "defaults_param", "type": "object" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "head_office": { "description": "The place where your business is located.", "properties": { "address": { "properties": { "city": { "maxLength": 5000, "type": "string" }, "country": { "maxLength": 5000, "type": "string" }, "line1": { "maxLength": 5000, "type": "string" }, "line2": { "maxLength": 5000, "type": "string" }, "postal_code": { "maxLength": 5000, "type": "string" }, "state": { "maxLength": 5000, "type": "string" } }, "title": "validated_country_address", "type": "object" } }, "required": [ "address" ], "title": "head_office_param", "type": "object" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax.settings" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update settings" } }, "/v1/tax/transactions/create_from_calculation": { "post": { "description": "

Creates a Tax Transaction from a calculation, if that calculation hasn’t expired. Calculations expire after 90 days.

", "operationId": "PostTaxTransactionsCreateFromCalculation", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "calculation": { "description": "Tax Calculation ID to be used as input when creating the transaction.", "maxLength": 5000, "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "posted_at": { "description": "The Unix timestamp representing when the tax liability is assumed or reduced, which determines the liability posting period and handling in tax liability reports. The timestamp must fall within the `tax_date` and the current time, unless the `tax_date` is scheduled in advance. Defaults to the current time.", "format": "unix-time", "type": "integer" }, "reference": { "description": "A custom order or sale identifier, such as 'myOrder_123'. Must be unique across all transactions, including reversals.", "maxLength": 500, "type": "string" } }, "required": [ "calculation", "reference" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax.transaction" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a transaction from a calculation" } }, "/v1/tax/transactions/create_reversal": { "post": { "description": "

Partially or fully reverses a previously created Transaction.

", "operationId": "PostTaxTransactionsCreateReversal", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "line_items": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "shipping_cost": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "flat_amount": { "description": "A flat amount to reverse across the entire transaction, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) in negative. This value represents the total amount to refund from the transaction, including taxes.", "type": "integer" }, "line_items": { "description": "The line item amounts to reverse.", "items": { "properties": { "amount": { "type": "integer" }, "amount_tax": { "type": "integer" }, "metadata": { "additionalProperties": { "type": "string" }, "type": "object" }, "original_line_item": { "maxLength": 5000, "type": "string" }, "quantity": { "type": "integer" }, "reference": { "maxLength": 500, "type": "string" } }, "required": [ "amount", "amount_tax", "original_line_item", "reference" ], "title": "transaction_line_item_reversal", "type": "object" }, "type": "array" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "mode": { "description": "If `partial`, the provided line item or shipping cost amounts are reversed. If `full`, the original transaction is fully reversed.", "enum": [ "full", "partial" ], "type": "string" }, "original_transaction": { "description": "The ID of the Transaction to partially or fully reverse.", "maxLength": 5000, "type": "string" }, "reference": { "description": "A custom identifier for this reversal, such as `myOrder_123-refund_1`, which must be unique across all transactions. The reference helps identify this reversal transaction in exported [tax reports](https://stripe.com/docs/tax/reports).", "maxLength": 500, "type": "string" }, "shipping_cost": { "description": "The shipping cost to reverse.", "properties": { "amount": { "type": "integer" }, "amount_tax": { "type": "integer" } }, "required": [ "amount", "amount_tax" ], "title": "transaction_shipping_cost_reversal", "type": "object" } }, "required": [ "mode", "original_transaction", "reference" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax.transaction" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a reversal transaction" } }, "/v1/tax/transactions/{transaction}": { "get": { "description": "

Retrieves a Tax Transaction object.

", "operationId": "GetTaxTransactionsTransaction", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "transaction", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax.transaction" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a transaction" } }, "/v1/tax/transactions/{transaction}/line_items": { "get": { "description": "

Retrieves the line items of a committed standalone transaction as a collection.

", "operationId": "GetTaxTransactionsTransactionLineItems", "parameters": [ { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 500, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 500, "type": "string" }, "style": "form" }, { "in": "path", "name": "transaction", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/tax.transaction_line_item" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/tax/transactions/[^/]+/line_items", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "TaxProductResourceTaxTransactionLineItemList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a transaction's line items" } }, "/v1/tax_codes": { "get": { "description": "

A list of all tax codes available to add to Products in order to allow specific tax calculations.

", "operationId": "GetTaxCodes", "parameters": [ { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/tax_code" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "TaxProductResourceTaxCodeList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all tax codes" } }, "/v1/tax_codes/{id}": { "get": { "description": "

Retrieves the details of an existing tax code. Supply the unique tax code ID and Stripe will return the corresponding tax code information.

", "operationId": "GetTaxCodesId", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax_code" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a tax code" } }, "/v1/tax_ids": { "get": { "description": "

Returns a list of tax IDs.

", "operationId": "GetTaxIds", "parameters": [ { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "The account or customer the tax ID belongs to. Defaults to `owner[type]=self`.", "explode": true, "in": "query", "name": "owner", "required": false, "schema": { "properties": { "account": { "type": "string" }, "customer": { "maxLength": 5000, "type": "string" }, "type": { "enum": [ "account", "application", "customer", "self" ], "type": "string" } }, "required": [ "type" ], "title": "owner_params", "type": "object" }, "style": "deepObject" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/tax_id" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "TaxIDsList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all tax IDs" }, "post": { "description": "

Creates a new account or customer tax_id object.

", "operationId": "PostTaxIds", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "owner": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "owner": { "description": "The account or customer the tax ID belongs to. Defaults to `owner[type]=self`.", "properties": { "account": { "type": "string" }, "customer": { "maxLength": 5000, "type": "string" }, "type": { "enum": [ "account", "application", "customer", "self" ], "type": "string" } }, "required": [ "type" ], "title": "owner_params", "type": "object" }, "type": { "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `aw_tin`, `az_tin`, `ba_tin`, `bb_tin`, `bd_bin`, `bf_ifu`, `bg_uic`, `bh_vat`, `bj_ifu`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cm_niu`, `cn_tin`, `co_nit`, `cr_tin`, `cv_nif`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `et_tin`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kg_tin`, `kh_tin`, `kr_brn`, `kz_bin`, `la_tin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin`", "enum": [ "ad_nrt", "ae_trn", "al_tin", "am_tin", "ao_tin", "ar_cuit", "au_abn", "au_arn", "aw_tin", "az_tin", "ba_tin", "bb_tin", "bd_bin", "bf_ifu", "bg_uic", "bh_vat", "bj_ifu", "bo_tin", "br_cnpj", "br_cpf", "bs_tin", "by_tin", "ca_bn", "ca_gst_hst", "ca_pst_bc", "ca_pst_mb", "ca_pst_sk", "ca_qst", "cd_nif", "ch_uid", "ch_vat", "cl_tin", "cm_niu", "cn_tin", "co_nit", "cr_tin", "cv_nif", "de_stn", "do_rcn", "ec_ruc", "eg_tin", "es_cif", "et_tin", "eu_oss_vat", "eu_vat", "gb_vat", "ge_vat", "gn_nif", "hk_br", "hr_oib", "hu_tin", "id_npwp", "il_vat", "in_gst", "is_vat", "jp_cn", "jp_rn", "jp_trn", "ke_pin", "kg_tin", "kh_tin", "kr_brn", "kz_bin", "la_tin", "li_uid", "li_vat", "ma_vat", "md_vat", "me_pib", "mk_vat", "mr_nif", "mx_rfc", "my_frp", "my_itn", "my_sst", "ng_tin", "no_vat", "no_voec", "np_pan", "nz_gst", "om_vat", "pe_ruc", "ph_tin", "ro_tin", "rs_pib", "ru_inn", "ru_kpp", "sa_vat", "sg_gst", "sg_uen", "si_tin", "sn_ninea", "sr_fin", "sv_nit", "th_vat", "tj_tin", "tr_tin", "tw_vat", "tz_vat", "ua_vat", "ug_tin", "us_ein", "uy_ruc", "uz_tin", "uz_vat", "ve_rif", "vn_tin", "za_vat", "zm_tin", "zw_tin" ], "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true }, "value": { "description": "Value of the tax ID.", "type": "string" } }, "required": [ "type", "value" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax_id" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a tax ID" } }, "/v1/tax_ids/{id}": { "delete": { "description": "

Deletes an existing account or customer tax_id object.

", "operationId": "DeleteTaxIdsId", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted_tax_id" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Delete a tax ID" }, "get": { "description": "

Retrieves an account or customer tax_id object.

", "operationId": "GetTaxIdsId", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax_id" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a tax ID" } }, "/v1/tax_rates": { "get": { "description": "

Returns a list of your tax rates. Tax rates are returned sorted by creation date, with the most recently created tax rates appearing first.

", "operationId": "GetTaxRates", "parameters": [ { "description": "Optional flag to filter by tax rates that are either active or inactive (archived).", "in": "query", "name": "active", "required": false, "schema": { "type": "boolean" }, "style": "form" }, { "description": "Optional range for filtering created date.", "explode": true, "in": "query", "name": "created", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "type": "integer" }, "gte": { "type": "integer" }, "lt": { "type": "integer" }, "lte": { "type": "integer" } }, "title": "range_query_specs", "type": "object" }, { "type": "integer" } ] }, "style": "deepObject" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "Optional flag to filter by tax rates that are inclusive (or those that are not inclusive).", "in": "query", "name": "inclusive", "required": false, "schema": { "type": "boolean" }, "style": "form" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/tax_rate" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/tax_rates", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "TaxRatesList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all tax rates" }, "post": { "description": "

Creates a new tax rate.

", "operationId": "PostTaxRates", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "active": { "description": "Flag determining whether the tax rate is active or inactive (archived). Inactive tax rates cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set.", "type": "boolean" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "description": { "description": "An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.", "maxLength": 5000, "type": "string" }, "display_name": { "description": "The display name of the tax rate, which will be shown to users.", "maxLength": 50, "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "inclusive": { "description": "This specifies if the tax rate is inclusive or exclusive.", "type": "boolean" }, "jurisdiction": { "description": "The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.", "maxLength": 50, "type": "string" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "percentage": { "description": "This represents the tax rate percent out of 100.", "type": "number" }, "state": { "description": "[ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2), without country prefix. For example, \"NY\" for New York, United States.", "maxLength": 5000, "type": "string" }, "tax_type": { "description": "The high-level tax type, such as `vat` or `sales_tax`.", "enum": [ "amusement_tax", "communications_tax", "gst", "hst", "igst", "jct", "lease_tax", "pst", "qst", "retail_delivery_fee", "rst", "sales_tax", "service_tax", "vat" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "display_name", "inclusive", "percentage" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax_rate" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a tax rate" } }, "/v1/tax_rates/{tax_rate}": { "get": { "description": "

Retrieves a tax rate with the given ID

", "operationId": "GetTaxRatesTaxRate", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "tax_rate", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax_rate" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a tax rate" }, "post": { "description": "

Updates an existing tax rate.

", "operationId": "PostTaxRatesTaxRate", "parameters": [ { "in": "path", "name": "tax_rate", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "active": { "description": "Flag determining whether the tax rate is active or inactive (archived). Inactive tax rates cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set.", "type": "boolean" }, "country": { "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", "maxLength": 5000, "type": "string" }, "description": { "description": "An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.", "maxLength": 5000, "type": "string" }, "display_name": { "description": "The display name of the tax rate, which will be shown to users.", "maxLength": 50, "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "jurisdiction": { "description": "The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.", "maxLength": 50, "type": "string" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "state": { "description": "[ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2), without country prefix. For example, \"NY\" for New York, United States.", "maxLength": 5000, "type": "string" }, "tax_type": { "description": "The high-level tax type, such as `vat` or `sales_tax`.", "enum": [ "amusement_tax", "communications_tax", "gst", "hst", "igst", "jct", "lease_tax", "pst", "qst", "retail_delivery_fee", "rst", "sales_tax", "service_tax", "vat" ], "type": "string", "x-stripeBypassValidation": true } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax_rate" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a tax rate" } }, "/v1/terminal/configurations": { "get": { "description": "

Returns a list of Configuration objects.

", "operationId": "GetTerminalConfigurations", "parameters": [ { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "if present, only return the account default or non-default configurations.", "in": "query", "name": "is_account_default", "required": false, "schema": { "type": "boolean" }, "style": "form" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/terminal.configuration" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/terminal/configurations", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "TerminalConfigurationConfigurationList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all Configurations" }, "post": { "description": "

Creates a new Configuration object.

", "operationId": "PostTerminalConfigurations", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "bbpos_wisepos_e": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "offline": { "explode": true, "style": "deepObject" }, "reboot_window": { "explode": true, "style": "deepObject" }, "stripe_s700": { "explode": true, "style": "deepObject" }, "tipping": { "explode": true, "style": "deepObject" }, "verifone_p400": { "explode": true, "style": "deepObject" }, "wifi": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "bbpos_wisepos_e": { "description": "An object containing device type specific settings for BBPOS WisePOS E readers", "properties": { "splashscreen": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "bbpos_wise_pose", "type": "object" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "name": { "description": "Name of the configuration", "maxLength": 100, "type": "string" }, "offline": { "anyOf": [ { "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ], "title": "offline", "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Configurations for collecting transactions offline." }, "reboot_window": { "description": "Reboot time settings for readers that support customized reboot time configuration.", "properties": { "end_hour": { "type": "integer" }, "start_hour": { "type": "integer" } }, "required": [ "end_hour", "start_hour" ], "title": "reboot_window", "type": "object" }, "stripe_s700": { "description": "An object containing device type specific settings for Stripe S700 readers", "properties": { "splashscreen": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "stripe_s700", "type": "object" }, "tipping": { "anyOf": [ { "properties": { "aed": { "properties": { "fixed_amounts": { "items": { "type": "integer" }, "type": "array" }, "percentages": { "items": { "type": "integer" }, "type": "array" }, "smart_tip_threshold": { "type": "integer" } }, "title": "currency_specific_config", "type": "object" }, "aud": { "properties": { "fixed_amounts": { "items": { "type": "integer" }, "type": "array" }, "percentages": { "items": { "type": "integer" }, "type": "array" }, "smart_tip_threshold": { "type": "integer" } }, "title": "currency_specific_config", "type": "object" }, "bgn": { "properties": { "fixed_amounts": { "items": { "type": "integer" }, "type": "array" }, "percentages": { "items": { "type": "integer" }, "type": "array" }, "smart_tip_threshold": { "type": "integer" } }, "title": "currency_specific_config", "type": "object" }, "cad": { "properties": { "fixed_amounts": { "items": { "type": "integer" }, "type": "array" }, "percentages": { "items": { "type": "integer" }, "type": "array" }, "smart_tip_threshold": { "type": "integer" } }, "title": "currency_specific_config", "type": "object" }, "chf": { "properties": { "fixed_amounts": { "items": { "type": "integer" }, "type": "array" }, "percentages": { "items": { "type": "integer" }, "type": "array" }, "smart_tip_threshold": { "type": "integer" } }, "title": "currency_specific_config", "type": "object" }, "czk": { "properties": { "fixed_amounts": { "items": { "type": "integer" }, "type": "array" }, "percentages": { "items": { "type": "integer" }, "type": "array" }, "smart_tip_threshold": { "type": "integer" } }, "title": "currency_specific_config", "type": "object" }, "dkk": { "properties": { "fixed_amounts": { "items": { "type": "integer" }, "type": "array" }, "percentages": { "items": { "type": "integer" }, "type": "array" }, "smart_tip_threshold": { "type": "integer" } }, "title": "currency_specific_config", "type": "object" }, "eur": { "properties": { "fixed_amounts": { "items": { "type": "integer" }, "type": "array" }, "percentages": { "items": { "type": "integer" }, "type": "array" }, "smart_tip_threshold": { "type": "integer" } }, "title": "currency_specific_config", "type": "object" }, "gbp": { "properties": { "fixed_amounts": { "items": { "type": "integer" }, "type": "array" }, "percentages": { "items": { "type": "integer" }, "type": "array" }, "smart_tip_threshold": { "type": "integer" } }, "title": "currency_specific_config", "type": "object" }, "hkd": { "properties": { "fixed_amounts": { "items": { "type": "integer" }, "type": "array" }, "percentages": { "items": { "type": "integer" }, "type": "array" }, "smart_tip_threshold": { "type": "integer" } }, "title": "currency_specific_config", "type": "object" }, "huf": { "properties": { "fixed_amounts": { "items": { "type": "integer" }, "type": "array" }, "percentages": { "items": { "type": "integer" }, "type": "array" }, "smart_tip_threshold": { "type": "integer" } }, "title": "currency_specific_config", "type": "object" }, "jpy": { "properties": { "fixed_amounts": { "items": { "type": "integer" }, "type": "array" }, "percentages": { "items": { "type": "integer" }, "type": "array" }, "smart_tip_threshold": { "type": "integer" } }, "title": "currency_specific_config", "type": "object" }, "mxn": { "properties": { "fixed_amounts": { "items": { "type": "integer" }, "type": "array" }, "percentages": { "items": { "type": "integer" }, "type": "array" }, "smart_tip_threshold": { "type": "integer" } }, "title": "currency_specific_config", "type": "object" }, "myr": { "properties": { "fixed_amounts": { "items": { "type": "integer" }, "type": "array" }, "percentages": { "items": { "type": "integer" }, "type": "array" }, "smart_tip_threshold": { "type": "integer" } }, "title": "currency_specific_config", "type": "object" }, "nok": { "properties": { "fixed_amounts": { "items": { "type": "integer" }, "type": "array" }, "percentages": { "items": { "type": "integer" }, "type": "array" }, "smart_tip_threshold": { "type": "integer" } }, "title": "currency_specific_config", "type": "object" }, "nzd": { "properties": { "fixed_amounts": { "items": { "type": "integer" }, "type": "array" }, "percentages": { "items": { "type": "integer" }, "type": "array" }, "smart_tip_threshold": { "type": "integer" } }, "title": "currency_specific_config", "type": "object" }, "pln": { "properties": { "fixed_amounts": { "items": { "type": "integer" }, "type": "array" }, "percentages": { "items": { "type": "integer" }, "type": "array" }, "smart_tip_threshold": { "type": "integer" } }, "title": "currency_specific_config", "type": "object" }, "ron": { "properties": { "fixed_amounts": { "items": { "type": "integer" }, "type": "array" }, "percentages": { "items": { "type": "integer" }, "type": "array" }, "smart_tip_threshold": { "type": "integer" } }, "title": "currency_specific_config", "type": "object" }, "sek": { "properties": { "fixed_amounts": { "items": { "type": "integer" }, "type": "array" }, "percentages": { "items": { "type": "integer" }, "type": "array" }, "smart_tip_threshold": { "type": "integer" } }, "title": "currency_specific_config", "type": "object" }, "sgd": { "properties": { "fixed_amounts": { "items": { "type": "integer" }, "type": "array" }, "percentages": { "items": { "type": "integer" }, "type": "array" }, "smart_tip_threshold": { "type": "integer" } }, "title": "currency_specific_config", "type": "object" }, "usd": { "properties": { "fixed_amounts": { "items": { "type": "integer" }, "type": "array" }, "percentages": { "items": { "type": "integer" }, "type": "array" }, "smart_tip_threshold": { "type": "integer" } }, "title": "currency_specific_config", "type": "object" } }, "title": "tipping", "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Tipping configurations for readers supporting on-reader tips" }, "verifone_p400": { "description": "An object containing device type specific settings for Verifone P400 readers", "properties": { "splashscreen": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "verifone_p400", "type": "object" }, "wifi": { "anyOf": [ { "properties": { "enterprise_eap_peap": { "properties": { "ca_certificate_file": { "type": "string" }, "password": { "maxLength": 5000, "type": "string" }, "ssid": { "maxLength": 5000, "type": "string" }, "username": { "maxLength": 5000, "type": "string" } }, "required": [ "password", "ssid", "username" ], "title": "enterprise_peap_config", "type": "object" }, "enterprise_eap_tls": { "properties": { "ca_certificate_file": { "type": "string" }, "client_certificate_file": { "type": "string" }, "private_key_file": { "type": "string" }, "private_key_file_password": { "maxLength": 5000, "type": "string" }, "ssid": { "maxLength": 5000, "type": "string" } }, "required": [ "client_certificate_file", "private_key_file", "ssid" ], "title": "enterprise_tls_config", "type": "object" }, "personal_psk": { "properties": { "password": { "maxLength": 63, "type": "string" }, "ssid": { "maxLength": 5000, "type": "string" } }, "required": [ "password", "ssid" ], "title": "personal_psk_config", "type": "object" }, "type": { "enum": [ "enterprise_eap_peap", "enterprise_eap_tls", "personal_psk" ], "type": "string" } }, "required": [ "type" ], "title": "wifi", "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Configurations for connecting to a WiFi network." } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/terminal.configuration" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a Configuration" } }, "/v1/terminal/configurations/{configuration}": { "delete": { "description": "

Deletes a Configuration object.

", "operationId": "DeleteTerminalConfigurationsConfiguration", "parameters": [ { "in": "path", "name": "configuration", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted_terminal.configuration" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Delete a Configuration" }, "get": { "description": "

Retrieves a Configuration object.

", "operationId": "GetTerminalConfigurationsConfiguration", "parameters": [ { "in": "path", "name": "configuration", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/terminal.configuration" }, { "$ref": "#/components/schemas/deleted_terminal.configuration" } ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a Configuration" }, "post": { "description": "

Updates a new Configuration object.

", "operationId": "PostTerminalConfigurationsConfiguration", "parameters": [ { "in": "path", "name": "configuration", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "bbpos_wisepos_e": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "offline": { "explode": true, "style": "deepObject" }, "reboot_window": { "explode": true, "style": "deepObject" }, "stripe_s700": { "explode": true, "style": "deepObject" }, "tipping": { "explode": true, "style": "deepObject" }, "verifone_p400": { "explode": true, "style": "deepObject" }, "wifi": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "bbpos_wisepos_e": { "anyOf": [ { "properties": { "splashscreen": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "bbpos_wise_pose", "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "An object containing device type specific settings for BBPOS WisePOS E readers" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "name": { "description": "Name of the configuration", "maxLength": 100, "type": "string" }, "offline": { "anyOf": [ { "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ], "title": "offline", "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Configurations for collecting transactions offline." }, "reboot_window": { "anyOf": [ { "properties": { "end_hour": { "type": "integer" }, "start_hour": { "type": "integer" } }, "required": [ "end_hour", "start_hour" ], "title": "reboot_window", "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Reboot time settings for readers that support customized reboot time configuration." }, "stripe_s700": { "anyOf": [ { "properties": { "splashscreen": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "stripe_s700", "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "An object containing device type specific settings for Stripe S700 readers" }, "tipping": { "anyOf": [ { "properties": { "aed": { "properties": { "fixed_amounts": { "items": { "type": "integer" }, "type": "array" }, "percentages": { "items": { "type": "integer" }, "type": "array" }, "smart_tip_threshold": { "type": "integer" } }, "title": "currency_specific_config", "type": "object" }, "aud": { "properties": { "fixed_amounts": { "items": { "type": "integer" }, "type": "array" }, "percentages": { "items": { "type": "integer" }, "type": "array" }, "smart_tip_threshold": { "type": "integer" } }, "title": "currency_specific_config", "type": "object" }, "bgn": { "properties": { "fixed_amounts": { "items": { "type": "integer" }, "type": "array" }, "percentages": { "items": { "type": "integer" }, "type": "array" }, "smart_tip_threshold": { "type": "integer" } }, "title": "currency_specific_config", "type": "object" }, "cad": { "properties": { "fixed_amounts": { "items": { "type": "integer" }, "type": "array" }, "percentages": { "items": { "type": "integer" }, "type": "array" }, "smart_tip_threshold": { "type": "integer" } }, "title": "currency_specific_config", "type": "object" }, "chf": { "properties": { "fixed_amounts": { "items": { "type": "integer" }, "type": "array" }, "percentages": { "items": { "type": "integer" }, "type": "array" }, "smart_tip_threshold": { "type": "integer" } }, "title": "currency_specific_config", "type": "object" }, "czk": { "properties": { "fixed_amounts": { "items": { "type": "integer" }, "type": "array" }, "percentages": { "items": { "type": "integer" }, "type": "array" }, "smart_tip_threshold": { "type": "integer" } }, "title": "currency_specific_config", "type": "object" }, "dkk": { "properties": { "fixed_amounts": { "items": { "type": "integer" }, "type": "array" }, "percentages": { "items": { "type": "integer" }, "type": "array" }, "smart_tip_threshold": { "type": "integer" } }, "title": "currency_specific_config", "type": "object" }, "eur": { "properties": { "fixed_amounts": { "items": { "type": "integer" }, "type": "array" }, "percentages": { "items": { "type": "integer" }, "type": "array" }, "smart_tip_threshold": { "type": "integer" } }, "title": "currency_specific_config", "type": "object" }, "gbp": { "properties": { "fixed_amounts": { "items": { "type": "integer" }, "type": "array" }, "percentages": { "items": { "type": "integer" }, "type": "array" }, "smart_tip_threshold": { "type": "integer" } }, "title": "currency_specific_config", "type": "object" }, "hkd": { "properties": { "fixed_amounts": { "items": { "type": "integer" }, "type": "array" }, "percentages": { "items": { "type": "integer" }, "type": "array" }, "smart_tip_threshold": { "type": "integer" } }, "title": "currency_specific_config", "type": "object" }, "huf": { "properties": { "fixed_amounts": { "items": { "type": "integer" }, "type": "array" }, "percentages": { "items": { "type": "integer" }, "type": "array" }, "smart_tip_threshold": { "type": "integer" } }, "title": "currency_specific_config", "type": "object" }, "jpy": { "properties": { "fixed_amounts": { "items": { "type": "integer" }, "type": "array" }, "percentages": { "items": { "type": "integer" }, "type": "array" }, "smart_tip_threshold": { "type": "integer" } }, "title": "currency_specific_config", "type": "object" }, "mxn": { "properties": { "fixed_amounts": { "items": { "type": "integer" }, "type": "array" }, "percentages": { "items": { "type": "integer" }, "type": "array" }, "smart_tip_threshold": { "type": "integer" } }, "title": "currency_specific_config", "type": "object" }, "myr": { "properties": { "fixed_amounts": { "items": { "type": "integer" }, "type": "array" }, "percentages": { "items": { "type": "integer" }, "type": "array" }, "smart_tip_threshold": { "type": "integer" } }, "title": "currency_specific_config", "type": "object" }, "nok": { "properties": { "fixed_amounts": { "items": { "type": "integer" }, "type": "array" }, "percentages": { "items": { "type": "integer" }, "type": "array" }, "smart_tip_threshold": { "type": "integer" } }, "title": "currency_specific_config", "type": "object" }, "nzd": { "properties": { "fixed_amounts": { "items": { "type": "integer" }, "type": "array" }, "percentages": { "items": { "type": "integer" }, "type": "array" }, "smart_tip_threshold": { "type": "integer" } }, "title": "currency_specific_config", "type": "object" }, "pln": { "properties": { "fixed_amounts": { "items": { "type": "integer" }, "type": "array" }, "percentages": { "items": { "type": "integer" }, "type": "array" }, "smart_tip_threshold": { "type": "integer" } }, "title": "currency_specific_config", "type": "object" }, "ron": { "properties": { "fixed_amounts": { "items": { "type": "integer" }, "type": "array" }, "percentages": { "items": { "type": "integer" }, "type": "array" }, "smart_tip_threshold": { "type": "integer" } }, "title": "currency_specific_config", "type": "object" }, "sek": { "properties": { "fixed_amounts": { "items": { "type": "integer" }, "type": "array" }, "percentages": { "items": { "type": "integer" }, "type": "array" }, "smart_tip_threshold": { "type": "integer" } }, "title": "currency_specific_config", "type": "object" }, "sgd": { "properties": { "fixed_amounts": { "items": { "type": "integer" }, "type": "array" }, "percentages": { "items": { "type": "integer" }, "type": "array" }, "smart_tip_threshold": { "type": "integer" } }, "title": "currency_specific_config", "type": "object" }, "usd": { "properties": { "fixed_amounts": { "items": { "type": "integer" }, "type": "array" }, "percentages": { "items": { "type": "integer" }, "type": "array" }, "smart_tip_threshold": { "type": "integer" } }, "title": "currency_specific_config", "type": "object" } }, "title": "tipping", "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Tipping configurations for readers supporting on-reader tips" }, "verifone_p400": { "anyOf": [ { "properties": { "splashscreen": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "verifone_p400", "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "An object containing device type specific settings for Verifone P400 readers" }, "wifi": { "anyOf": [ { "properties": { "enterprise_eap_peap": { "properties": { "ca_certificate_file": { "type": "string" }, "password": { "maxLength": 5000, "type": "string" }, "ssid": { "maxLength": 5000, "type": "string" }, "username": { "maxLength": 5000, "type": "string" } }, "required": [ "password", "ssid", "username" ], "title": "enterprise_peap_config", "type": "object" }, "enterprise_eap_tls": { "properties": { "ca_certificate_file": { "type": "string" }, "client_certificate_file": { "type": "string" }, "private_key_file": { "type": "string" }, "private_key_file_password": { "maxLength": 5000, "type": "string" }, "ssid": { "maxLength": 5000, "type": "string" } }, "required": [ "client_certificate_file", "private_key_file", "ssid" ], "title": "enterprise_tls_config", "type": "object" }, "personal_psk": { "properties": { "password": { "maxLength": 63, "type": "string" }, "ssid": { "maxLength": 5000, "type": "string" } }, "required": [ "password", "ssid" ], "title": "personal_psk_config", "type": "object" }, "type": { "enum": [ "enterprise_eap_peap", "enterprise_eap_tls", "personal_psk" ], "type": "string" } }, "required": [ "type" ], "title": "wifi", "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Configurations for connecting to a WiFi network." } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/terminal.configuration" }, { "$ref": "#/components/schemas/deleted_terminal.configuration" } ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a Configuration" } }, "/v1/terminal/connection_tokens": { "post": { "description": "

To connect to a reader the Stripe Terminal SDK needs to retrieve a short-lived connection token from Stripe, proxied through your server. On your backend, add an endpoint that creates and returns a connection token.

", "operationId": "PostTerminalConnectionTokens", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "location": { "description": "The id of the location that this connection token is scoped to. If specified the connection token will only be usable with readers assigned to that location, otherwise the connection token will be usable with all readers. Note that location scoping only applies to internet-connected readers. For more details, see [the docs on scoping connection tokens](https://docs.stripe.com/terminal/fleet/locations-and-zones?dashboard-or-api=api#connection-tokens).", "maxLength": 5000, "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/terminal.connection_token" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a Connection Token" } }, "/v1/terminal/locations": { "get": { "description": "

Returns a list of Location objects.

", "operationId": "GetTerminalLocations", "parameters": [ { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/terminal.location" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/terminal/locations", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "TerminalLocationLocationList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all Locations" }, "post": { "description": "

Creates a new Location object.\nFor further details, including which address fields are required in each country, see the Manage locations guide.

", "operationId": "PostTerminalLocations", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "address": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "address": { "description": "The full address of the location.", "properties": { "city": { "maxLength": 5000, "type": "string" }, "country": { "maxLength": 5000, "type": "string" }, "line1": { "maxLength": 5000, "type": "string" }, "line2": { "maxLength": 5000, "type": "string" }, "postal_code": { "maxLength": 5000, "type": "string" }, "state": { "maxLength": 5000, "type": "string" } }, "required": [ "country" ], "title": "create_location_address_param", "type": "object" }, "configuration_overrides": { "description": "The ID of a configuration that will be used to customize all readers in this location.", "maxLength": 500, "type": "string" }, "display_name": { "description": "A name for the location. Maximum length is 1000 characters.", "maxLength": 1000, "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." } }, "required": [ "address", "display_name" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/terminal.location" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a Location" } }, "/v1/terminal/locations/{location}": { "delete": { "description": "

Deletes a Location object.

", "operationId": "DeleteTerminalLocationsLocation", "parameters": [ { "in": "path", "name": "location", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted_terminal.location" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Delete a Location" }, "get": { "description": "

Retrieves a Location object.

", "operationId": "GetTerminalLocationsLocation", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "location", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/terminal.location" }, { "$ref": "#/components/schemas/deleted_terminal.location" } ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a Location" }, "post": { "description": "

Updates a Location object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

", "operationId": "PostTerminalLocationsLocation", "parameters": [ { "in": "path", "name": "location", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "address": { "explode": true, "style": "deepObject" }, "configuration_overrides": { "explode": true, "style": "deepObject" }, "display_name": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "address": { "description": "The full address of the location. You can't change the location's `country`. If you need to modify the `country` field, create a new `Location` object and re-register any existing readers to that location.", "properties": { "city": { "maxLength": 5000, "type": "string" }, "country": { "maxLength": 5000, "type": "string" }, "line1": { "maxLength": 5000, "type": "string" }, "line2": { "maxLength": 5000, "type": "string" }, "postal_code": { "maxLength": 5000, "type": "string" }, "state": { "maxLength": 5000, "type": "string" } }, "title": "optional_fields_address", "type": "object" }, "configuration_overrides": { "anyOf": [ { "maxLength": 1000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "The ID of a configuration that will be used to customize all readers in this location." }, "display_name": { "anyOf": [ { "maxLength": 1000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "A name for the location." }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/terminal.location" }, { "$ref": "#/components/schemas/deleted_terminal.location" } ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a Location" } }, "/v1/terminal/readers": { "get": { "description": "

Returns a list of Reader objects.

", "operationId": "GetTerminalReaders", "parameters": [ { "description": "Filters readers by device type", "in": "query", "name": "device_type", "required": false, "schema": { "enum": [ "bbpos_chipper2x", "bbpos_wisepad3", "bbpos_wisepos_e", "mobile_phone_reader", "simulated_stripe_s700", "simulated_wisepos_e", "stripe_m2", "stripe_s700", "verifone_P400" ], "type": "string", "x-stripeBypassValidation": true }, "style": "form" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "A location ID to filter the response list to only readers at the specific location", "in": "query", "name": "location", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Filters readers by serial number", "in": "query", "name": "serial_number", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "A status filter to filter readers to only offline or online readers", "in": "query", "name": "status", "required": false, "schema": { "enum": [ "offline", "online" ], "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "description": "A list of readers", "items": { "$ref": "#/components/schemas/terminal.reader" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "TerminalReaderRetrieveReader", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all Readers" }, "post": { "description": "

Creates a new Reader object.

", "operationId": "PostTerminalReaders", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "label": { "description": "Custom label given to the reader for easier identification. If no label is specified, the registration code will be used.", "maxLength": 5000, "type": "string" }, "location": { "description": "The location to assign the reader to.", "maxLength": 5000, "type": "string" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "registration_code": { "description": "A code generated by the reader used for registering to an account.", "maxLength": 5000, "type": "string" } }, "required": [ "registration_code" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/terminal.reader" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a Reader" } }, "/v1/terminal/readers/{reader}": { "delete": { "description": "

Deletes a Reader object.

", "operationId": "DeleteTerminalReadersReader", "parameters": [ { "in": "path", "name": "reader", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted_terminal.reader" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Delete a Reader" }, "get": { "description": "

Retrieves a Reader object.

", "operationId": "GetTerminalReadersReader", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "reader", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/terminal.reader" }, { "$ref": "#/components/schemas/deleted_terminal.reader" } ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a Reader" }, "post": { "description": "

Updates a Reader object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

", "operationId": "PostTerminalReadersReader", "parameters": [ { "in": "path", "name": "reader", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "label": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "label": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "The new label of the reader." }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/terminal.reader" }, { "$ref": "#/components/schemas/deleted_terminal.reader" } ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a Reader" } }, "/v1/terminal/readers/{reader}/cancel_action": { "post": { "description": "

Cancels the current reader action.

", "operationId": "PostTerminalReadersReaderCancelAction", "parameters": [ { "in": "path", "name": "reader", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/terminal.reader" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Cancel the current reader action" } }, "/v1/terminal/readers/{reader}/collect_inputs": { "post": { "description": "

Initiates an input collection flow on a Reader.

", "operationId": "PostTerminalReadersReaderCollectInputs", "parameters": [ { "in": "path", "name": "reader", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "inputs": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "inputs": { "description": "List of inputs to be collected using the Reader", "items": { "properties": { "custom_text": { "properties": { "description": { "maxLength": 500, "type": "string" }, "skip_button": { "maxLength": 14, "type": "string" }, "submit_button": { "maxLength": 30, "type": "string" }, "title": { "maxLength": 40, "type": "string" } }, "required": [ "title" ], "title": "custom_text_params", "type": "object" }, "required": { "type": "boolean" }, "selection": { "properties": { "choices": { "items": { "properties": { "id": { "maxLength": 50, "type": "string" }, "style": { "enum": [ "primary", "secondary" ], "type": "string" }, "text": { "maxLength": 30, "type": "string" } }, "required": [ "id", "text" ], "title": "choice_params", "type": "object" }, "type": "array" } }, "required": [ "choices" ], "title": "selection_params", "type": "object" }, "toggles": { "items": { "properties": { "default_value": { "enum": [ "disabled", "enabled" ], "type": "string" }, "description": { "maxLength": 50, "type": "string" }, "title": { "maxLength": 50, "type": "string" } }, "title": "toggle_params", "type": "object" }, "type": "array" }, "type": { "enum": [ "email", "numeric", "phone", "selection", "signature", "text" ], "type": "string" } }, "required": [ "custom_text", "type" ], "title": "input_params", "type": "object" }, "type": "array" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" } }, "required": [ "inputs" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/terminal.reader" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Collect inputs using a Reader" } }, "/v1/terminal/readers/{reader}/collect_payment_method": { "post": { "description": "

Initiates a payment flow on a Reader and updates the PaymentIntent with card details before manual confirmation.

", "operationId": "PostTerminalReadersReaderCollectPaymentMethod", "parameters": [ { "in": "path", "name": "reader", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "collect_config": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "collect_config": { "description": "Configuration overrides.", "properties": { "allow_redisplay": { "enum": [ "always", "limited", "unspecified" ], "type": "string" }, "enable_customer_cancellation": { "type": "boolean" }, "skip_tipping": { "type": "boolean" }, "tipping": { "properties": { "amount_eligible": { "type": "integer" } }, "title": "tipping_config", "type": "object" } }, "title": "collect_config", "type": "object" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "payment_intent": { "description": "PaymentIntent ID.", "maxLength": 5000, "type": "string" } }, "required": [ "payment_intent" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/terminal.reader" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Hand off a PaymentIntent to a Reader and collect card details" } }, "/v1/terminal/readers/{reader}/confirm_payment_intent": { "post": { "description": "

Finalizes a payment on a Reader.

", "operationId": "PostTerminalReadersReaderConfirmPaymentIntent", "parameters": [ { "in": "path", "name": "reader", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "confirm_config": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "confirm_config": { "description": "Configuration overrides.", "properties": { "return_url": { "type": "string" } }, "title": "confirm_config", "type": "object" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "payment_intent": { "description": "PaymentIntent ID.", "maxLength": 5000, "type": "string" } }, "required": [ "payment_intent" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/terminal.reader" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Confirm a PaymentIntent on the Reader" } }, "/v1/terminal/readers/{reader}/process_payment_intent": { "post": { "description": "

Initiates a payment flow on a Reader.

", "operationId": "PostTerminalReadersReaderProcessPaymentIntent", "parameters": [ { "in": "path", "name": "reader", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "process_config": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "payment_intent": { "description": "PaymentIntent ID", "maxLength": 5000, "type": "string" }, "process_config": { "description": "Configuration overrides", "properties": { "allow_redisplay": { "enum": [ "always", "limited", "unspecified" ], "type": "string" }, "enable_customer_cancellation": { "type": "boolean" }, "return_url": { "type": "string" }, "skip_tipping": { "type": "boolean" }, "tipping": { "properties": { "amount_eligible": { "type": "integer" } }, "title": "tipping_config", "type": "object" } }, "title": "process_config", "type": "object" } }, "required": [ "payment_intent" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/terminal.reader" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Hand-off a PaymentIntent to a Reader" } }, "/v1/terminal/readers/{reader}/process_setup_intent": { "post": { "description": "

Initiates a setup intent flow on a Reader.

", "operationId": "PostTerminalReadersReaderProcessSetupIntent", "parameters": [ { "in": "path", "name": "reader", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "process_config": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "allow_redisplay": { "description": "This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow.", "enum": [ "always", "limited", "unspecified" ], "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "process_config": { "description": "Configuration overrides", "properties": { "enable_customer_cancellation": { "type": "boolean" } }, "title": "process_setup_config", "type": "object" }, "setup_intent": { "description": "SetupIntent ID", "maxLength": 5000, "type": "string" } }, "required": [ "allow_redisplay", "setup_intent" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/terminal.reader" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Hand-off a SetupIntent to a Reader" } }, "/v1/terminal/readers/{reader}/refund_payment": { "post": { "description": "

Initiates a refund on a Reader

", "operationId": "PostTerminalReadersReaderRefundPayment", "parameters": [ { "in": "path", "name": "reader", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "refund_payment_config": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "amount": { "description": "A positive integer in __cents__ representing how much of this charge to refund.", "type": "integer" }, "charge": { "description": "ID of the Charge to refund.", "maxLength": 5000, "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "payment_intent": { "description": "ID of the PaymentIntent to refund.", "maxLength": 5000, "type": "string" }, "refund_application_fee": { "description": "Boolean indicating whether the application fee should be refunded when refunding this charge. If a full charge refund is given, the full application fee will be refunded. Otherwise, the application fee will be refunded in an amount proportional to the amount of the charge refunded. An application fee can be refunded only by the application that created the charge.", "type": "boolean" }, "refund_payment_config": { "description": "Configuration overrides", "properties": { "enable_customer_cancellation": { "type": "boolean" } }, "title": "refund_payment_config", "type": "object" }, "reverse_transfer": { "description": "Boolean indicating whether the transfer should be reversed when refunding this charge. The transfer will be reversed proportionally to the amount being refunded (either the entire or partial amount). A transfer can be reversed only by the application that created the charge.", "type": "boolean" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/terminal.reader" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Refund a Charge or a PaymentIntent in-person" } }, "/v1/terminal/readers/{reader}/set_reader_display": { "post": { "description": "

Sets reader display to show cart details.

", "operationId": "PostTerminalReadersReaderSetReaderDisplay", "parameters": [ { "in": "path", "name": "reader", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "cart": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "cart": { "description": "Cart", "properties": { "currency": { "format": "currency", "type": "string" }, "line_items": { "items": { "properties": { "amount": { "type": "integer" }, "description": { "maxLength": 5000, "type": "string" }, "quantity": { "type": "integer" } }, "required": [ "amount", "description", "quantity" ], "title": "line_item", "type": "object" }, "type": "array" }, "tax": { "type": "integer" }, "total": { "type": "integer" } }, "required": [ "currency", "line_items", "total" ], "title": "cart", "type": "object" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "type": { "description": "Type", "enum": [ "cart" ], "type": "string" } }, "required": [ "type" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/terminal.reader" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Set reader display" } }, "/v1/test_helpers/confirmation_tokens": { "post": { "description": "

Creates a test mode Confirmation Token server side for your integration tests.

", "operationId": "PostTestHelpersConfirmationTokens", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "payment_method_data": { "explode": true, "style": "deepObject" }, "payment_method_options": { "explode": true, "style": "deepObject" }, "shipping": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "payment_method": { "description": "ID of an existing PaymentMethod.", "maxLength": 5000, "type": "string" }, "payment_method_data": { "description": "If provided, this hash will be used to create a PaymentMethod.", "properties": { "acss_debit": { "properties": { "account_number": { "maxLength": 5000, "type": "string" }, "institution_number": { "maxLength": 5000, "type": "string" }, "transit_number": { "maxLength": 5000, "type": "string" } }, "required": [ "account_number", "institution_number", "transit_number" ], "title": "payment_method_param", "type": "object" }, "affirm": { "properties": {}, "title": "param", "type": "object" }, "afterpay_clearpay": { "properties": {}, "title": "param", "type": "object" }, "alipay": { "properties": {}, "title": "param", "type": "object" }, "allow_redisplay": { "enum": [ "always", "limited", "unspecified" ], "type": "string" }, "alma": { "properties": {}, "title": "param", "type": "object" }, "amazon_pay": { "properties": {}, "title": "param", "type": "object" }, "au_becs_debit": { "properties": { "account_number": { "maxLength": 5000, "type": "string" }, "bsb_number": { "maxLength": 5000, "type": "string" } }, "required": [ "account_number", "bsb_number" ], "title": "param", "type": "object" }, "bacs_debit": { "properties": { "account_number": { "maxLength": 5000, "type": "string" }, "sort_code": { "maxLength": 5000, "type": "string" } }, "title": "param", "type": "object" }, "bancontact": { "properties": {}, "title": "param", "type": "object" }, "billie": { "properties": {}, "title": "param", "type": "object" }, "billing_details": { "properties": { "address": { "anyOf": [ { "properties": { "city": { "maxLength": 5000, "type": "string" }, "country": { "maxLength": 5000, "type": "string" }, "line1": { "maxLength": 5000, "type": "string" }, "line2": { "maxLength": 5000, "type": "string" }, "postal_code": { "maxLength": 5000, "type": "string" }, "state": { "maxLength": 5000, "type": "string" } }, "title": "billing_details_address", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "email": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "name": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "phone": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "tax_id": { "maxLength": 5000, "type": "string" } }, "title": "billing_details_inner_params", "type": "object" }, "blik": { "properties": {}, "title": "param", "type": "object" }, "boleto": { "properties": { "tax_id": { "maxLength": 5000, "type": "string" } }, "required": [ "tax_id" ], "title": "param", "type": "object" }, "cashapp": { "properties": {}, "title": "param", "type": "object" }, "crypto": { "properties": {}, "title": "param", "type": "object" }, "customer_balance": { "properties": {}, "title": "param", "type": "object" }, "eps": { "properties": { "bank": { "enum": [ "arzte_und_apotheker_bank", "austrian_anadi_bank_ag", "bank_austria", "bankhaus_carl_spangler", "bankhaus_schelhammer_und_schattera_ag", "bawag_psk_ag", "bks_bank_ag", "brull_kallmus_bank_ag", "btv_vier_lander_bank", "capital_bank_grawe_gruppe_ag", "deutsche_bank_ag", "dolomitenbank", "easybank_ag", "erste_bank_und_sparkassen", "hypo_alpeadriabank_international_ag", "hypo_bank_burgenland_aktiengesellschaft", "hypo_noe_lb_fur_niederosterreich_u_wien", "hypo_oberosterreich_salzburg_steiermark", "hypo_tirol_bank_ag", "hypo_vorarlberg_bank_ag", "marchfelder_bank", "oberbank_ag", "raiffeisen_bankengruppe_osterreich", "schoellerbank_ag", "sparda_bank_wien", "volksbank_gruppe", "volkskreditbank_ag", "vr_bank_braunau" ], "maxLength": 5000, "type": "string" } }, "title": "param", "type": "object" }, "fpx": { "properties": { "bank": { "enum": [ "affin_bank", "agrobank", "alliance_bank", "ambank", "bank_islam", "bank_muamalat", "bank_of_china", "bank_rakyat", "bsn", "cimb", "deutsche_bank", "hong_leong_bank", "hsbc", "kfh", "maybank2e", "maybank2u", "ocbc", "pb_enterprise", "public_bank", "rhb", "standard_chartered", "uob" ], "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true } }, "required": [ "bank" ], "title": "param", "type": "object" }, "giropay": { "properties": {}, "title": "param", "type": "object" }, "grabpay": { "properties": {}, "title": "param", "type": "object" }, "ideal": { "properties": { "bank": { "enum": [ "abn_amro", "asn_bank", "bunq", "buut", "handelsbanken", "ing", "knab", "moneyou", "n26", "nn", "rabobank", "regiobank", "revolut", "sns_bank", "triodos_bank", "van_lanschot", "yoursafe" ], "maxLength": 5000, "type": "string" } }, "title": "param", "type": "object" }, "interac_present": { "properties": {}, "title": "param", "type": "object" }, "kakao_pay": { "properties": {}, "title": "param", "type": "object" }, "klarna": { "properties": { "dob": { "properties": { "day": { "type": "integer" }, "month": { "type": "integer" }, "year": { "type": "integer" } }, "required": [ "day", "month", "year" ], "title": "date_of_birth", "type": "object" } }, "title": "param", "type": "object" }, "konbini": { "properties": {}, "title": "param", "type": "object" }, "kr_card": { "properties": {}, "title": "param", "type": "object" }, "link": { "properties": {}, "title": "param", "type": "object" }, "metadata": { "additionalProperties": { "type": "string" }, "type": "object" }, "mobilepay": { "properties": {}, "title": "param", "type": "object" }, "multibanco": { "properties": {}, "title": "param", "type": "object" }, "naver_pay": { "properties": { "funding": { "enum": [ "card", "points" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "param", "type": "object" }, "nz_bank_account": { "properties": { "account_holder_name": { "maxLength": 5000, "type": "string" }, "account_number": { "maxLength": 5000, "type": "string" }, "bank_code": { "maxLength": 5000, "type": "string" }, "branch_code": { "maxLength": 5000, "type": "string" }, "reference": { "maxLength": 128, "type": "string" }, "suffix": { "maxLength": 5000, "type": "string" } }, "required": [ "account_number", "bank_code", "branch_code", "suffix" ], "title": "param", "type": "object" }, "oxxo": { "properties": {}, "title": "param", "type": "object" }, "p24": { "properties": { "bank": { "enum": [ "alior_bank", "bank_millennium", "bank_nowy_bfg_sa", "bank_pekao_sa", "banki_spbdzielcze", "blik", "bnp_paribas", "boz", "citi_handlowy", "credit_agricole", "envelobank", "etransfer_pocztowy24", "getin_bank", "ideabank", "ing", "inteligo", "mbank_mtransfer", "nest_przelew", "noble_pay", "pbac_z_ipko", "plus_bank", "santander_przelew24", "tmobile_usbugi_bankowe", "toyota_bank", "velobank", "volkswagen_bank" ], "type": "string", "x-stripeBypassValidation": true } }, "title": "param", "type": "object" }, "pay_by_bank": { "properties": {}, "title": "param", "type": "object" }, "payco": { "properties": {}, "title": "param", "type": "object" }, "paynow": { "properties": {}, "title": "param", "type": "object" }, "paypal": { "properties": {}, "title": "param", "type": "object" }, "pix": { "properties": {}, "title": "param", "type": "object" }, "promptpay": { "properties": {}, "title": "param", "type": "object" }, "radar_options": { "properties": { "session": { "maxLength": 5000, "type": "string" } }, "title": "radar_options_with_hidden_options", "type": "object" }, "revolut_pay": { "properties": {}, "title": "param", "type": "object" }, "samsung_pay": { "properties": {}, "title": "param", "type": "object" }, "satispay": { "properties": {}, "title": "param", "type": "object" }, "sepa_debit": { "properties": { "iban": { "maxLength": 5000, "type": "string" } }, "required": [ "iban" ], "title": "param", "type": "object" }, "sofort": { "properties": { "country": { "enum": [ "AT", "BE", "DE", "ES", "IT", "NL" ], "type": "string" } }, "required": [ "country" ], "title": "param", "type": "object" }, "swish": { "properties": {}, "title": "param", "type": "object" }, "twint": { "properties": {}, "title": "param", "type": "object" }, "type": { "enum": [ "acss_debit", "affirm", "afterpay_clearpay", "alipay", "alma", "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", "billie", "blik", "boleto", "cashapp", "crypto", "customer_balance", "eps", "fpx", "giropay", "grabpay", "ideal", "kakao_pay", "klarna", "konbini", "kr_card", "link", "mobilepay", "multibanco", "naver_pay", "nz_bank_account", "oxxo", "p24", "pay_by_bank", "payco", "paynow", "paypal", "pix", "promptpay", "revolut_pay", "samsung_pay", "satispay", "sepa_debit", "sofort", "swish", "twint", "us_bank_account", "wechat_pay", "zip" ], "type": "string", "x-stripeBypassValidation": true }, "us_bank_account": { "properties": { "account_holder_type": { "enum": [ "company", "individual" ], "type": "string" }, "account_number": { "maxLength": 5000, "type": "string" }, "account_type": { "enum": [ "checking", "savings" ], "type": "string" }, "financial_connections_account": { "maxLength": 5000, "type": "string" }, "routing_number": { "maxLength": 5000, "type": "string" } }, "title": "payment_method_param", "type": "object" }, "wechat_pay": { "properties": {}, "title": "param", "type": "object" }, "zip": { "properties": {}, "title": "param", "type": "object" } }, "required": [ "type" ], "title": "payment_method_data_params", "type": "object" }, "payment_method_options": { "description": "Payment-method-specific configuration for this ConfirmationToken.", "properties": { "card": { "properties": { "installments": { "properties": { "plan": { "properties": { "count": { "type": "integer" }, "interval": { "enum": [ "month" ], "type": "string" }, "type": { "enum": [ "bonus", "fixed_count", "revolving" ], "type": "string" } }, "required": [ "type" ], "title": "installment_plan", "type": "object" } }, "required": [ "plan" ], "title": "installments_param", "type": "object" } }, "title": "card_param", "type": "object" } }, "title": "test_payment_method_options_param", "type": "object" }, "return_url": { "description": "Return URL used to confirm the Intent.", "type": "string" }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this ConfirmationToken's payment method.\n\nThe presence of this property will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete.", "enum": [ "off_session", "on_session" ], "type": "string" }, "shipping": { "description": "Shipping information for this ConfirmationToken.", "properties": { "address": { "properties": { "city": { "maxLength": 5000, "type": "string" }, "country": { "maxLength": 5000, "type": "string" }, "line1": { "maxLength": 5000, "type": "string" }, "line2": { "maxLength": 5000, "type": "string" }, "postal_code": { "maxLength": 5000, "type": "string" }, "state": { "maxLength": 5000, "type": "string" } }, "title": "optional_fields_address", "type": "object" }, "name": { "maxLength": 5000, "type": "string" }, "phone": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] } }, "required": [ "address", "name" ], "title": "recipient_shipping_with_optional_fields_address", "type": "object" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/confirmation_token" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a test Confirmation Token" } }, "/v1/test_helpers/customers/{customer}/fund_cash_balance": { "post": { "description": "

Create an incoming testmode bank transfer

", "operationId": "PostTestHelpersCustomersCustomerFundCashBalance", "parameters": [ { "in": "path", "name": "customer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "amount": { "description": "Amount to be used for this test cash balance transaction. A positive integer representing how much to fund in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to fund $1.00 or 100 to fund ¥100, a zero-decimal currency).", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "reference": { "description": "A description of the test funding. This simulates free-text references supplied by customers when making bank transfers to their cash balance. You can use this to test how Stripe's [reconciliation algorithm](https://stripe.com/docs/payments/customer-balance/reconciliation) applies to different user inputs.", "maxLength": 5000, "type": "string" } }, "required": [ "amount", "currency" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer_cash_balance_transaction" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Fund a test mode cash balance" } }, "/v1/test_helpers/issuing/authorizations": { "post": { "description": "

Create a test-mode authorization.

", "operationId": "PostTestHelpersIssuingAuthorizations", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "amount_details": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "fleet": { "explode": true, "style": "deepObject" }, "fuel": { "explode": true, "style": "deepObject" }, "merchant_data": { "explode": true, "style": "deepObject" }, "network_data": { "explode": true, "style": "deepObject" }, "verification_data": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "amount": { "description": "The total amount to attempt to authorize. This amount is in the provided currency, or defaults to the card's currency, and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", "type": "integer" }, "amount_details": { "description": "Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", "properties": { "atm_fee": { "type": "integer" }, "cashback_amount": { "type": "integer" } }, "title": "amount_details_specs", "type": "object" }, "authorization_method": { "description": "How the card details were provided. Defaults to online.", "enum": [ "chip", "contactless", "keyed_in", "online", "swipe" ], "type": "string" }, "card": { "description": "Card associated with this authorization.", "maxLength": 5000, "type": "string" }, "currency": { "description": "The currency of the authorization. If not provided, defaults to the currency of the card. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "fleet": { "description": "Fleet-specific information for authorizations using Fleet cards.", "properties": { "cardholder_prompt_data": { "properties": { "driver_id": { "maxLength": 5000, "type": "string" }, "odometer": { "type": "integer" }, "unspecified_id": { "maxLength": 5000, "type": "string" }, "user_id": { "maxLength": 5000, "type": "string" }, "vehicle_number": { "maxLength": 5000, "type": "string" } }, "title": "fleet_cardholder_prompt_data_specs", "type": "object" }, "purchase_type": { "enum": [ "fuel_and_non_fuel_purchase", "fuel_purchase", "non_fuel_purchase" ], "maxLength": 5000, "type": "string" }, "reported_breakdown": { "properties": { "fuel": { "properties": { "gross_amount_decimal": { "format": "decimal", "type": "string" } }, "title": "fleet_reported_breakdown_fuel_specs", "type": "object" }, "non_fuel": { "properties": { "gross_amount_decimal": { "format": "decimal", "type": "string" } }, "title": "fleet_reported_breakdown_non_fuel_specs", "type": "object" }, "tax": { "properties": { "local_amount_decimal": { "format": "decimal", "type": "string" }, "national_amount_decimal": { "format": "decimal", "type": "string" } }, "title": "fleet_reported_breakdown_tax_specs", "type": "object" } }, "title": "fleet_reported_breakdown_specs", "type": "object" }, "service_type": { "enum": [ "full_service", "non_fuel_transaction", "self_service" ], "maxLength": 5000, "type": "string" } }, "title": "fleet_testmode_authorization_specs", "type": "object" }, "fuel": { "description": "Information about fuel that was purchased with this transaction.", "properties": { "industry_product_code": { "maxLength": 5000, "type": "string" }, "quantity_decimal": { "format": "decimal", "type": "string" }, "type": { "enum": [ "diesel", "other", "unleaded_plus", "unleaded_regular", "unleaded_super" ], "maxLength": 5000, "type": "string" }, "unit": { "enum": [ "charging_minute", "imperial_gallon", "kilogram", "kilowatt_hour", "liter", "other", "pound", "us_gallon" ], "maxLength": 5000, "type": "string" }, "unit_cost_decimal": { "format": "decimal", "type": "string" } }, "title": "fuel_specs", "type": "object" }, "is_amount_controllable": { "description": "If set `true`, you may provide [amount](https://stripe.com/docs/api/issuing/authorizations/approve#approve_issuing_authorization-amount) to control how much to hold for the authorization.", "type": "boolean" }, "merchant_amount": { "description": "The total amount to attempt to authorize. This amount is in the provided merchant currency, and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", "type": "integer" }, "merchant_currency": { "description": "The currency of the authorization. If not provided, defaults to the currency of the card. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "merchant_data": { "description": "Details about the seller (grocery store, e-commerce website, etc.) where the card authorization happened.", "properties": { "category": { "enum": [ "ac_refrigeration_repair", "accounting_bookkeeping_services", "advertising_services", "agricultural_cooperative", "airlines_air_carriers", "airports_flying_fields", "ambulance_services", "amusement_parks_carnivals", "antique_reproductions", "antique_shops", "aquariums", "architectural_surveying_services", "art_dealers_and_galleries", "artists_supply_and_craft_shops", "auto_and_home_supply_stores", "auto_body_repair_shops", "auto_paint_shops", "auto_service_shops", "automated_cash_disburse", "automated_fuel_dispensers", "automobile_associations", "automotive_parts_and_accessories_stores", "automotive_tire_stores", "bail_and_bond_payments", "bakeries", "bands_orchestras", "barber_and_beauty_shops", "betting_casino_gambling", "bicycle_shops", "billiard_pool_establishments", "boat_dealers", "boat_rentals_and_leases", "book_stores", "books_periodicals_and_newspapers", "bowling_alleys", "bus_lines", "business_secretarial_schools", "buying_shopping_services", "cable_satellite_and_other_pay_television_and_radio", "camera_and_photographic_supply_stores", "candy_nut_and_confectionery_stores", "car_and_truck_dealers_new_used", "car_and_truck_dealers_used_only", "car_rental_agencies", "car_washes", "carpentry_services", "carpet_upholstery_cleaning", "caterers", "charitable_and_social_service_organizations_fundraising", "chemicals_and_allied_products", "child_care_services", "childrens_and_infants_wear_stores", "chiropodists_podiatrists", "chiropractors", "cigar_stores_and_stands", "civic_social_fraternal_associations", "cleaning_and_maintenance", "clothing_rental", "colleges_universities", "commercial_equipment", "commercial_footwear", "commercial_photography_art_and_graphics", "commuter_transport_and_ferries", "computer_network_services", "computer_programming", "computer_repair", "computer_software_stores", "computers_peripherals_and_software", "concrete_work_services", "construction_materials", "consulting_public_relations", "correspondence_schools", "cosmetic_stores", "counseling_services", "country_clubs", "courier_services", "court_costs", "credit_reporting_agencies", "cruise_lines", "dairy_products_stores", "dance_hall_studios_schools", "dating_escort_services", "dentists_orthodontists", "department_stores", "detective_agencies", "digital_goods_applications", "digital_goods_games", "digital_goods_large_volume", "digital_goods_media", "direct_marketing_catalog_merchant", "direct_marketing_combination_catalog_and_retail_merchant", "direct_marketing_inbound_telemarketing", "direct_marketing_insurance_services", "direct_marketing_other", "direct_marketing_outbound_telemarketing", "direct_marketing_subscription", "direct_marketing_travel", "discount_stores", "doctors", "door_to_door_sales", "drapery_window_covering_and_upholstery_stores", "drinking_places", "drug_stores_and_pharmacies", "drugs_drug_proprietaries_and_druggist_sundries", "dry_cleaners", "durable_goods", "duty_free_stores", "eating_places_restaurants", "educational_services", "electric_razor_stores", "electric_vehicle_charging", "electrical_parts_and_equipment", "electrical_services", "electronics_repair_shops", "electronics_stores", "elementary_secondary_schools", "emergency_services_gcas_visa_use_only", "employment_temp_agencies", "equipment_rental", "exterminating_services", "family_clothing_stores", "fast_food_restaurants", "financial_institutions", "fines_government_administrative_entities", "fireplace_fireplace_screens_and_accessories_stores", "floor_covering_stores", "florists", "florists_supplies_nursery_stock_and_flowers", "freezer_and_locker_meat_provisioners", "fuel_dealers_non_automotive", "funeral_services_crematories", "furniture_home_furnishings_and_equipment_stores_except_appliances", "furniture_repair_refinishing", "furriers_and_fur_shops", "general_services", "gift_card_novelty_and_souvenir_shops", "glass_paint_and_wallpaper_stores", "glassware_crystal_stores", "golf_courses_public", "government_licensed_horse_dog_racing_us_region_only", "government_licensed_online_casions_online_gambling_us_region_only", "government_owned_lotteries_non_us_region", "government_owned_lotteries_us_region_only", "government_services", "grocery_stores_supermarkets", "hardware_equipment_and_supplies", "hardware_stores", "health_and_beauty_spas", "hearing_aids_sales_and_supplies", "heating_plumbing_a_c", "hobby_toy_and_game_shops", "home_supply_warehouse_stores", "hospitals", "hotels_motels_and_resorts", "household_appliance_stores", "industrial_supplies", "information_retrieval_services", "insurance_default", "insurance_underwriting_premiums", "intra_company_purchases", "jewelry_stores_watches_clocks_and_silverware_stores", "landscaping_services", "laundries", "laundry_cleaning_services", "legal_services_attorneys", "luggage_and_leather_goods_stores", "lumber_building_materials_stores", "manual_cash_disburse", "marinas_service_and_supplies", "marketplaces", "masonry_stonework_and_plaster", "massage_parlors", "medical_and_dental_labs", "medical_dental_ophthalmic_and_hospital_equipment_and_supplies", "medical_services", "membership_organizations", "mens_and_boys_clothing_and_accessories_stores", "mens_womens_clothing_stores", "metal_service_centers", "miscellaneous_apparel_and_accessory_shops", "miscellaneous_auto_dealers", "miscellaneous_business_services", "miscellaneous_food_stores", "miscellaneous_general_merchandise", "miscellaneous_general_services", "miscellaneous_home_furnishing_specialty_stores", "miscellaneous_publishing_and_printing", "miscellaneous_recreation_services", "miscellaneous_repair_shops", "miscellaneous_specialty_retail", "mobile_home_dealers", "motion_picture_theaters", "motor_freight_carriers_and_trucking", "motor_homes_dealers", "motor_vehicle_supplies_and_new_parts", "motorcycle_shops_and_dealers", "motorcycle_shops_dealers", "music_stores_musical_instruments_pianos_and_sheet_music", "news_dealers_and_newsstands", "non_fi_money_orders", "non_fi_stored_value_card_purchase_load", "nondurable_goods", "nurseries_lawn_and_garden_supply_stores", "nursing_personal_care", "office_and_commercial_furniture", "opticians_eyeglasses", "optometrists_ophthalmologist", "orthopedic_goods_prosthetic_devices", "osteopaths", "package_stores_beer_wine_and_liquor", "paints_varnishes_and_supplies", "parking_lots_garages", "passenger_railways", "pawn_shops", "pet_shops_pet_food_and_supplies", "petroleum_and_petroleum_products", "photo_developing", "photographic_photocopy_microfilm_equipment_and_supplies", "photographic_studios", "picture_video_production", "piece_goods_notions_and_other_dry_goods", "plumbing_heating_equipment_and_supplies", "political_organizations", "postal_services_government_only", "precious_stones_and_metals_watches_and_jewelry", "professional_services", "public_warehousing_and_storage", "quick_copy_repro_and_blueprint", "railroads", "real_estate_agents_and_managers_rentals", "record_stores", "recreational_vehicle_rentals", "religious_goods_stores", "religious_organizations", "roofing_siding_sheet_metal", "secretarial_support_services", "security_brokers_dealers", "service_stations", "sewing_needlework_fabric_and_piece_goods_stores", "shoe_repair_hat_cleaning", "shoe_stores", "small_appliance_repair", "snowmobile_dealers", "special_trade_services", "specialty_cleaning", "sporting_goods_stores", "sporting_recreation_camps", "sports_and_riding_apparel_stores", "sports_clubs_fields", "stamp_and_coin_stores", "stationary_office_supplies_printing_and_writing_paper", "stationery_stores_office_and_school_supply_stores", "swimming_pools_sales", "t_ui_travel_germany", "tailors_alterations", "tax_payments_government_agencies", "tax_preparation_services", "taxicabs_limousines", "telecommunication_equipment_and_telephone_sales", "telecommunication_services", "telegraph_services", "tent_and_awning_shops", "testing_laboratories", "theatrical_ticket_agencies", "timeshares", "tire_retreading_and_repair", "tolls_bridge_fees", "tourist_attractions_and_exhibits", "towing_services", "trailer_parks_campgrounds", "transportation_services", "travel_agencies_tour_operators", "truck_stop_iteration", "truck_utility_trailer_rentals", "typesetting_plate_making_and_related_services", "typewriter_stores", "u_s_federal_government_agencies_or_departments", "uniforms_commercial_clothing", "used_merchandise_and_secondhand_stores", "utilities", "variety_stores", "veterinary_services", "video_amusement_game_supplies", "video_game_arcades", "video_tape_rental_stores", "vocational_trade_schools", "watch_jewelry_repair", "welding_repair", "wholesale_clubs", "wig_and_toupee_stores", "wires_money_orders", "womens_accessory_and_specialty_shops", "womens_ready_to_wear_stores", "wrecking_and_salvage_yards" ], "maxLength": 5000, "type": "string" }, "city": { "maxLength": 5000, "type": "string" }, "country": { "maxLength": 5000, "type": "string" }, "name": { "maxLength": 5000, "type": "string" }, "network_id": { "maxLength": 5000, "type": "string" }, "postal_code": { "maxLength": 5000, "type": "string" }, "state": { "maxLength": 5000, "type": "string" }, "terminal_id": { "maxLength": 5000, "type": "string" }, "url": { "maxLength": 5000, "type": "string" } }, "title": "merchant_data_specs", "type": "object" }, "network_data": { "description": "Details about the authorization, such as identifiers, set by the card network.", "properties": { "acquiring_institution_id": { "maxLength": 5000, "type": "string" } }, "title": "network_data_specs", "type": "object" }, "verification_data": { "description": "Verifications that Stripe performed on information that the cardholder provided to the merchant.", "properties": { "address_line1_check": { "enum": [ "match", "mismatch", "not_provided" ], "type": "string" }, "address_postal_code_check": { "enum": [ "match", "mismatch", "not_provided" ], "type": "string" }, "authentication_exemption": { "properties": { "claimed_by": { "enum": [ "acquirer", "issuer" ], "type": "string" }, "type": { "enum": [ "low_value_transaction", "transaction_risk_analysis", "unknown" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "claimed_by", "type" ], "title": "authentication_exemption_specs", "type": "object" }, "cvc_check": { "enum": [ "match", "mismatch", "not_provided" ], "type": "string" }, "expiry_check": { "enum": [ "match", "mismatch", "not_provided" ], "type": "string" }, "three_d_secure": { "properties": { "result": { "enum": [ "attempt_acknowledged", "authenticated", "failed", "required" ], "type": "string", "x-stripeBypassValidation": true } }, "required": [ "result" ], "title": "three_d_secure_specs", "type": "object" } }, "title": "verification_data_specs", "type": "object" }, "wallet": { "description": "The digital wallet used for this transaction. One of `apple_pay`, `google_pay`, or `samsung_pay`. Will populate as `null` when no digital wallet was utilized.", "enum": [ "apple_pay", "google_pay", "samsung_pay" ], "type": "string" } }, "required": [ "card" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issuing.authorization" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a test-mode authorization" } }, "/v1/test_helpers/issuing/authorizations/{authorization}/capture": { "post": { "description": "

Capture a test-mode authorization.

", "operationId": "PostTestHelpersIssuingAuthorizationsAuthorizationCapture", "parameters": [ { "in": "path", "name": "authorization", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "purchase_details": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "capture_amount": { "description": "The amount to capture from the authorization. If not provided, the full amount of the authorization will be captured. This amount is in the authorization currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", "type": "integer" }, "close_authorization": { "description": "Whether to close the authorization after capture. Defaults to true. Set to false to enable multi-capture flows.", "type": "boolean" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "purchase_details": { "description": "Additional purchase information that is optionally provided by the merchant.", "properties": { "fleet": { "properties": { "cardholder_prompt_data": { "properties": { "driver_id": { "maxLength": 5000, "type": "string" }, "odometer": { "type": "integer" }, "unspecified_id": { "maxLength": 5000, "type": "string" }, "user_id": { "maxLength": 5000, "type": "string" }, "vehicle_number": { "maxLength": 5000, "type": "string" } }, "title": "fleet_cardholder_prompt_data_specs", "type": "object" }, "purchase_type": { "enum": [ "fuel_and_non_fuel_purchase", "fuel_purchase", "non_fuel_purchase" ], "maxLength": 5000, "type": "string" }, "reported_breakdown": { "properties": { "fuel": { "properties": { "gross_amount_decimal": { "format": "decimal", "type": "string" } }, "title": "fleet_reported_breakdown_fuel_specs", "type": "object" }, "non_fuel": { "properties": { "gross_amount_decimal": { "format": "decimal", "type": "string" } }, "title": "fleet_reported_breakdown_non_fuel_specs", "type": "object" }, "tax": { "properties": { "local_amount_decimal": { "format": "decimal", "type": "string" }, "national_amount_decimal": { "format": "decimal", "type": "string" } }, "title": "fleet_reported_breakdown_tax_specs", "type": "object" } }, "title": "fleet_reported_breakdown_specs", "type": "object" }, "service_type": { "enum": [ "full_service", "non_fuel_transaction", "self_service" ], "maxLength": 5000, "type": "string" } }, "title": "fleet_specs", "type": "object" }, "flight": { "properties": { "departure_at": { "format": "unix-time", "type": "integer" }, "passenger_name": { "maxLength": 5000, "type": "string" }, "refundable": { "type": "boolean" }, "segments": { "items": { "properties": { "arrival_airport_code": { "maxLength": 3, "type": "string" }, "carrier": { "maxLength": 5000, "type": "string" }, "departure_airport_code": { "maxLength": 3, "type": "string" }, "flight_number": { "maxLength": 5000, "type": "string" }, "service_class": { "maxLength": 5000, "type": "string" }, "stopover_allowed": { "type": "boolean" } }, "title": "flight_segment_specs", "type": "object" }, "type": "array" }, "travel_agency": { "maxLength": 5000, "type": "string" } }, "title": "flight_specs", "type": "object" }, "fuel": { "properties": { "industry_product_code": { "maxLength": 5000, "type": "string" }, "quantity_decimal": { "format": "decimal", "type": "string" }, "type": { "enum": [ "diesel", "other", "unleaded_plus", "unleaded_regular", "unleaded_super" ], "maxLength": 5000, "type": "string" }, "unit": { "enum": [ "charging_minute", "imperial_gallon", "kilogram", "kilowatt_hour", "liter", "other", "pound", "us_gallon" ], "maxLength": 5000, "type": "string" }, "unit_cost_decimal": { "format": "decimal", "type": "string" } }, "title": "fuel_specs", "type": "object" }, "lodging": { "properties": { "check_in_at": { "format": "unix-time", "type": "integer" }, "nights": { "type": "integer" } }, "title": "lodging_specs", "type": "object" }, "receipt": { "items": { "properties": { "description": { "maxLength": 26, "type": "string" }, "quantity": { "format": "decimal", "type": "string" }, "total": { "type": "integer" }, "unit_cost": { "type": "integer" } }, "title": "receipt_specs", "type": "object" }, "type": "array" }, "reference": { "maxLength": 5000, "type": "string" } }, "title": "purchase_details_specs", "type": "object" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issuing.authorization" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Capture a test-mode authorization" } }, "/v1/test_helpers/issuing/authorizations/{authorization}/expire": { "post": { "description": "

Expire a test-mode Authorization.

", "operationId": "PostTestHelpersIssuingAuthorizationsAuthorizationExpire", "parameters": [ { "in": "path", "name": "authorization", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issuing.authorization" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Expire a test-mode authorization" } }, "/v1/test_helpers/issuing/authorizations/{authorization}/finalize_amount": { "post": { "description": "

Finalize the amount on an Authorization prior to capture, when the initial authorization was for an estimated amount.

", "operationId": "PostTestHelpersIssuingAuthorizationsAuthorizationFinalizeAmount", "parameters": [ { "in": "path", "name": "authorization", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "fleet": { "explode": true, "style": "deepObject" }, "fuel": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "final_amount": { "description": "The final authorization amount that will be captured by the merchant. This amount is in the authorization currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", "type": "integer" }, "fleet": { "description": "Fleet-specific information for authorizations using Fleet cards.", "properties": { "cardholder_prompt_data": { "properties": { "driver_id": { "maxLength": 5000, "type": "string" }, "odometer": { "type": "integer" }, "unspecified_id": { "maxLength": 5000, "type": "string" }, "user_id": { "maxLength": 5000, "type": "string" }, "vehicle_number": { "maxLength": 5000, "type": "string" } }, "title": "fleet_cardholder_prompt_data_specs", "type": "object" }, "purchase_type": { "enum": [ "fuel_and_non_fuel_purchase", "fuel_purchase", "non_fuel_purchase" ], "maxLength": 5000, "type": "string" }, "reported_breakdown": { "properties": { "fuel": { "properties": { "gross_amount_decimal": { "format": "decimal", "type": "string" } }, "title": "fleet_reported_breakdown_fuel_specs", "type": "object" }, "non_fuel": { "properties": { "gross_amount_decimal": { "format": "decimal", "type": "string" } }, "title": "fleet_reported_breakdown_non_fuel_specs", "type": "object" }, "tax": { "properties": { "local_amount_decimal": { "format": "decimal", "type": "string" }, "national_amount_decimal": { "format": "decimal", "type": "string" } }, "title": "fleet_reported_breakdown_tax_specs", "type": "object" } }, "title": "fleet_reported_breakdown_specs", "type": "object" }, "service_type": { "enum": [ "full_service", "non_fuel_transaction", "self_service" ], "maxLength": 5000, "type": "string" } }, "title": "fleet_specs", "type": "object" }, "fuel": { "description": "Information about fuel that was purchased with this transaction.", "properties": { "industry_product_code": { "maxLength": 5000, "type": "string" }, "quantity_decimal": { "format": "decimal", "type": "string" }, "type": { "enum": [ "diesel", "other", "unleaded_plus", "unleaded_regular", "unleaded_super" ], "maxLength": 5000, "type": "string" }, "unit": { "enum": [ "charging_minute", "imperial_gallon", "kilogram", "kilowatt_hour", "liter", "other", "pound", "us_gallon" ], "maxLength": 5000, "type": "string" }, "unit_cost_decimal": { "format": "decimal", "type": "string" } }, "title": "fuel_specs", "type": "object" } }, "required": [ "final_amount" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issuing.authorization" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Finalize a test-mode authorization's amount" } }, "/v1/test_helpers/issuing/authorizations/{authorization}/fraud_challenges/respond": { "post": { "description": "

Respond to a fraud challenge on a testmode Issuing authorization, simulating either a confirmation of fraud or a correction of legitimacy.

", "operationId": "PostTestHelpersIssuingAuthorizationsAuthorizationFraudChallengesRespond", "parameters": [ { "in": "path", "name": "authorization", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "confirmed": { "description": "Whether to simulate the user confirming that the transaction was legitimate (true) or telling Stripe that it was fraudulent (false).", "type": "boolean" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "required": [ "confirmed" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issuing.authorization" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Respond to fraud challenge" } }, "/v1/test_helpers/issuing/authorizations/{authorization}/increment": { "post": { "description": "

Increment a test-mode Authorization.

", "operationId": "PostTestHelpersIssuingAuthorizationsAuthorizationIncrement", "parameters": [ { "in": "path", "name": "authorization", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "increment_amount": { "description": "The amount to increment the authorization by. This amount is in the authorization currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", "type": "integer" }, "is_amount_controllable": { "description": "If set `true`, you may provide [amount](https://stripe.com/docs/api/issuing/authorizations/approve#approve_issuing_authorization-amount) to control how much to hold for the authorization.", "type": "boolean" } }, "required": [ "increment_amount" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issuing.authorization" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Increment a test-mode authorization" } }, "/v1/test_helpers/issuing/authorizations/{authorization}/reverse": { "post": { "description": "

Reverse a test-mode Authorization.

", "operationId": "PostTestHelpersIssuingAuthorizationsAuthorizationReverse", "parameters": [ { "in": "path", "name": "authorization", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "reverse_amount": { "description": "The amount to reverse from the authorization. If not provided, the full amount of the authorization will be reversed. This amount is in the authorization currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", "type": "integer" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issuing.authorization" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Reverse a test-mode authorization" } }, "/v1/test_helpers/issuing/cards/{card}/shipping/deliver": { "post": { "description": "

Updates the shipping status of the specified Issuing Card object to delivered.

", "operationId": "PostTestHelpersIssuingCardsCardShippingDeliver", "parameters": [ { "in": "path", "name": "card", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issuing.card" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Deliver a testmode card" } }, "/v1/test_helpers/issuing/cards/{card}/shipping/fail": { "post": { "description": "

Updates the shipping status of the specified Issuing Card object to failure.

", "operationId": "PostTestHelpersIssuingCardsCardShippingFail", "parameters": [ { "in": "path", "name": "card", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issuing.card" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Fail a testmode card" } }, "/v1/test_helpers/issuing/cards/{card}/shipping/return": { "post": { "description": "

Updates the shipping status of the specified Issuing Card object to returned.

", "operationId": "PostTestHelpersIssuingCardsCardShippingReturn", "parameters": [ { "in": "path", "name": "card", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issuing.card" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Return a testmode card" } }, "/v1/test_helpers/issuing/cards/{card}/shipping/ship": { "post": { "description": "

Updates the shipping status of the specified Issuing Card object to shipped.

", "operationId": "PostTestHelpersIssuingCardsCardShippingShip", "parameters": [ { "in": "path", "name": "card", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issuing.card" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Ship a testmode card" } }, "/v1/test_helpers/issuing/cards/{card}/shipping/submit": { "post": { "description": "

Updates the shipping status of the specified Issuing Card object to submitted. This method requires Stripe Version ‘2024-09-30.acacia’ or later.

", "operationId": "PostTestHelpersIssuingCardsCardShippingSubmit", "parameters": [ { "in": "path", "name": "card", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issuing.card" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Submit a testmode card" } }, "/v1/test_helpers/issuing/personalization_designs/{personalization_design}/activate": { "post": { "description": "

Updates the status of the specified testmode personalization design object to active.

", "operationId": "PostTestHelpersIssuingPersonalizationDesignsPersonalizationDesignActivate", "parameters": [ { "in": "path", "name": "personalization_design", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issuing.personalization_design" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Activate a testmode personalization design" } }, "/v1/test_helpers/issuing/personalization_designs/{personalization_design}/deactivate": { "post": { "description": "

Updates the status of the specified testmode personalization design object to inactive.

", "operationId": "PostTestHelpersIssuingPersonalizationDesignsPersonalizationDesignDeactivate", "parameters": [ { "in": "path", "name": "personalization_design", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issuing.personalization_design" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Deactivate a testmode personalization design" } }, "/v1/test_helpers/issuing/personalization_designs/{personalization_design}/reject": { "post": { "description": "

Updates the status of the specified testmode personalization design object to rejected.

", "operationId": "PostTestHelpersIssuingPersonalizationDesignsPersonalizationDesignReject", "parameters": [ { "in": "path", "name": "personalization_design", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "rejection_reasons": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "rejection_reasons": { "description": "The reason(s) the personalization design was rejected.", "properties": { "card_logo": { "items": { "enum": [ "geographic_location", "inappropriate", "network_name", "non_binary_image", "non_fiat_currency", "other", "other_entity", "promotional_material" ], "type": "string" }, "type": "array" }, "carrier_text": { "items": { "enum": [ "geographic_location", "inappropriate", "network_name", "non_fiat_currency", "other", "other_entity", "promotional_material" ], "type": "string" }, "type": "array" } }, "title": "rejection_reasons_param", "type": "object" } }, "required": [ "rejection_reasons" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issuing.personalization_design" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Reject a testmode personalization design" } }, "/v1/test_helpers/issuing/settlements": { "post": { "description": "

Allows the user to create an Issuing settlement.

", "operationId": "PostTestHelpersIssuingSettlements", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "bin": { "description": "The Bank Identification Number reflecting this settlement record.", "maxLength": 5000, "type": "string" }, "clearing_date": { "description": "The date that the transactions are cleared and posted to user's accounts.", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "interchange_fees_amount": { "description": "The total interchange received as reimbursement for the transactions.", "type": "integer" }, "net_total_amount": { "description": "The total net amount required to settle with the network.", "type": "integer" }, "network": { "description": "The card network for this settlement. One of [\"visa\", \"maestro\"]", "enum": [ "maestro", "visa" ], "type": "string" }, "network_settlement_identifier": { "description": "The Settlement Identification Number assigned by the network.", "maxLength": 5000, "type": "string" }, "transaction_amount": { "description": "The total transaction amount reflected in this settlement.", "type": "integer" }, "transaction_count": { "description": "The total number of transactions reflected in this settlement.", "type": "integer" } }, "required": [ "bin", "clearing_date", "currency", "net_total_amount" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issuing.settlement" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a test-mode settlement" } }, "/v1/test_helpers/issuing/settlements/{settlement}/complete": { "post": { "description": "

Allows the user to mark an Issuing settlement as complete.

", "operationId": "PostTestHelpersIssuingSettlementsSettlementComplete", "parameters": [ { "description": "The settlement token to mark as complete.", "in": "path", "name": "settlement", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issuing.settlement" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Complete a test-mode settlement" } }, "/v1/test_helpers/issuing/transactions/create_force_capture": { "post": { "description": "

Allows the user to capture an arbitrary amount, also known as a forced capture.

", "operationId": "PostTestHelpersIssuingTransactionsCreateForceCapture", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "merchant_data": { "explode": true, "style": "deepObject" }, "purchase_details": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "amount": { "description": "The total amount to attempt to capture. This amount is in the provided currency, or defaults to the cards currency, and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", "type": "integer" }, "card": { "description": "Card associated with this transaction.", "maxLength": 5000, "type": "string" }, "currency": { "description": "The currency of the capture. If not provided, defaults to the currency of the card. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "merchant_data": { "description": "Details about the seller (grocery store, e-commerce website, etc.) where the card authorization happened.", "properties": { "category": { "enum": [ "ac_refrigeration_repair", "accounting_bookkeeping_services", "advertising_services", "agricultural_cooperative", "airlines_air_carriers", "airports_flying_fields", "ambulance_services", "amusement_parks_carnivals", "antique_reproductions", "antique_shops", "aquariums", "architectural_surveying_services", "art_dealers_and_galleries", "artists_supply_and_craft_shops", "auto_and_home_supply_stores", "auto_body_repair_shops", "auto_paint_shops", "auto_service_shops", "automated_cash_disburse", "automated_fuel_dispensers", "automobile_associations", "automotive_parts_and_accessories_stores", "automotive_tire_stores", "bail_and_bond_payments", "bakeries", "bands_orchestras", "barber_and_beauty_shops", "betting_casino_gambling", "bicycle_shops", "billiard_pool_establishments", "boat_dealers", "boat_rentals_and_leases", "book_stores", "books_periodicals_and_newspapers", "bowling_alleys", "bus_lines", "business_secretarial_schools", "buying_shopping_services", "cable_satellite_and_other_pay_television_and_radio", "camera_and_photographic_supply_stores", "candy_nut_and_confectionery_stores", "car_and_truck_dealers_new_used", "car_and_truck_dealers_used_only", "car_rental_agencies", "car_washes", "carpentry_services", "carpet_upholstery_cleaning", "caterers", "charitable_and_social_service_organizations_fundraising", "chemicals_and_allied_products", "child_care_services", "childrens_and_infants_wear_stores", "chiropodists_podiatrists", "chiropractors", "cigar_stores_and_stands", "civic_social_fraternal_associations", "cleaning_and_maintenance", "clothing_rental", "colleges_universities", "commercial_equipment", "commercial_footwear", "commercial_photography_art_and_graphics", "commuter_transport_and_ferries", "computer_network_services", "computer_programming", "computer_repair", "computer_software_stores", "computers_peripherals_and_software", "concrete_work_services", "construction_materials", "consulting_public_relations", "correspondence_schools", "cosmetic_stores", "counseling_services", "country_clubs", "courier_services", "court_costs", "credit_reporting_agencies", "cruise_lines", "dairy_products_stores", "dance_hall_studios_schools", "dating_escort_services", "dentists_orthodontists", "department_stores", "detective_agencies", "digital_goods_applications", "digital_goods_games", "digital_goods_large_volume", "digital_goods_media", "direct_marketing_catalog_merchant", "direct_marketing_combination_catalog_and_retail_merchant", "direct_marketing_inbound_telemarketing", "direct_marketing_insurance_services", "direct_marketing_other", "direct_marketing_outbound_telemarketing", "direct_marketing_subscription", "direct_marketing_travel", "discount_stores", "doctors", "door_to_door_sales", "drapery_window_covering_and_upholstery_stores", "drinking_places", "drug_stores_and_pharmacies", "drugs_drug_proprietaries_and_druggist_sundries", "dry_cleaners", "durable_goods", "duty_free_stores", "eating_places_restaurants", "educational_services", "electric_razor_stores", "electric_vehicle_charging", "electrical_parts_and_equipment", "electrical_services", "electronics_repair_shops", "electronics_stores", "elementary_secondary_schools", "emergency_services_gcas_visa_use_only", "employment_temp_agencies", "equipment_rental", "exterminating_services", "family_clothing_stores", "fast_food_restaurants", "financial_institutions", "fines_government_administrative_entities", "fireplace_fireplace_screens_and_accessories_stores", "floor_covering_stores", "florists", "florists_supplies_nursery_stock_and_flowers", "freezer_and_locker_meat_provisioners", "fuel_dealers_non_automotive", "funeral_services_crematories", "furniture_home_furnishings_and_equipment_stores_except_appliances", "furniture_repair_refinishing", "furriers_and_fur_shops", "general_services", "gift_card_novelty_and_souvenir_shops", "glass_paint_and_wallpaper_stores", "glassware_crystal_stores", "golf_courses_public", "government_licensed_horse_dog_racing_us_region_only", "government_licensed_online_casions_online_gambling_us_region_only", "government_owned_lotteries_non_us_region", "government_owned_lotteries_us_region_only", "government_services", "grocery_stores_supermarkets", "hardware_equipment_and_supplies", "hardware_stores", "health_and_beauty_spas", "hearing_aids_sales_and_supplies", "heating_plumbing_a_c", "hobby_toy_and_game_shops", "home_supply_warehouse_stores", "hospitals", "hotels_motels_and_resorts", "household_appliance_stores", "industrial_supplies", "information_retrieval_services", "insurance_default", "insurance_underwriting_premiums", "intra_company_purchases", "jewelry_stores_watches_clocks_and_silverware_stores", "landscaping_services", "laundries", "laundry_cleaning_services", "legal_services_attorneys", "luggage_and_leather_goods_stores", "lumber_building_materials_stores", "manual_cash_disburse", "marinas_service_and_supplies", "marketplaces", "masonry_stonework_and_plaster", "massage_parlors", "medical_and_dental_labs", "medical_dental_ophthalmic_and_hospital_equipment_and_supplies", "medical_services", "membership_organizations", "mens_and_boys_clothing_and_accessories_stores", "mens_womens_clothing_stores", "metal_service_centers", "miscellaneous_apparel_and_accessory_shops", "miscellaneous_auto_dealers", "miscellaneous_business_services", "miscellaneous_food_stores", "miscellaneous_general_merchandise", "miscellaneous_general_services", "miscellaneous_home_furnishing_specialty_stores", "miscellaneous_publishing_and_printing", "miscellaneous_recreation_services", "miscellaneous_repair_shops", "miscellaneous_specialty_retail", "mobile_home_dealers", "motion_picture_theaters", "motor_freight_carriers_and_trucking", "motor_homes_dealers", "motor_vehicle_supplies_and_new_parts", "motorcycle_shops_and_dealers", "motorcycle_shops_dealers", "music_stores_musical_instruments_pianos_and_sheet_music", "news_dealers_and_newsstands", "non_fi_money_orders", "non_fi_stored_value_card_purchase_load", "nondurable_goods", "nurseries_lawn_and_garden_supply_stores", "nursing_personal_care", "office_and_commercial_furniture", "opticians_eyeglasses", "optometrists_ophthalmologist", "orthopedic_goods_prosthetic_devices", "osteopaths", "package_stores_beer_wine_and_liquor", "paints_varnishes_and_supplies", "parking_lots_garages", "passenger_railways", "pawn_shops", "pet_shops_pet_food_and_supplies", "petroleum_and_petroleum_products", "photo_developing", "photographic_photocopy_microfilm_equipment_and_supplies", "photographic_studios", "picture_video_production", "piece_goods_notions_and_other_dry_goods", "plumbing_heating_equipment_and_supplies", "political_organizations", "postal_services_government_only", "precious_stones_and_metals_watches_and_jewelry", "professional_services", "public_warehousing_and_storage", "quick_copy_repro_and_blueprint", "railroads", "real_estate_agents_and_managers_rentals", "record_stores", "recreational_vehicle_rentals", "religious_goods_stores", "religious_organizations", "roofing_siding_sheet_metal", "secretarial_support_services", "security_brokers_dealers", "service_stations", "sewing_needlework_fabric_and_piece_goods_stores", "shoe_repair_hat_cleaning", "shoe_stores", "small_appliance_repair", "snowmobile_dealers", "special_trade_services", "specialty_cleaning", "sporting_goods_stores", "sporting_recreation_camps", "sports_and_riding_apparel_stores", "sports_clubs_fields", "stamp_and_coin_stores", "stationary_office_supplies_printing_and_writing_paper", "stationery_stores_office_and_school_supply_stores", "swimming_pools_sales", "t_ui_travel_germany", "tailors_alterations", "tax_payments_government_agencies", "tax_preparation_services", "taxicabs_limousines", "telecommunication_equipment_and_telephone_sales", "telecommunication_services", "telegraph_services", "tent_and_awning_shops", "testing_laboratories", "theatrical_ticket_agencies", "timeshares", "tire_retreading_and_repair", "tolls_bridge_fees", "tourist_attractions_and_exhibits", "towing_services", "trailer_parks_campgrounds", "transportation_services", "travel_agencies_tour_operators", "truck_stop_iteration", "truck_utility_trailer_rentals", "typesetting_plate_making_and_related_services", "typewriter_stores", "u_s_federal_government_agencies_or_departments", "uniforms_commercial_clothing", "used_merchandise_and_secondhand_stores", "utilities", "variety_stores", "veterinary_services", "video_amusement_game_supplies", "video_game_arcades", "video_tape_rental_stores", "vocational_trade_schools", "watch_jewelry_repair", "welding_repair", "wholesale_clubs", "wig_and_toupee_stores", "wires_money_orders", "womens_accessory_and_specialty_shops", "womens_ready_to_wear_stores", "wrecking_and_salvage_yards" ], "maxLength": 5000, "type": "string" }, "city": { "maxLength": 5000, "type": "string" }, "country": { "maxLength": 5000, "type": "string" }, "name": { "maxLength": 5000, "type": "string" }, "network_id": { "maxLength": 5000, "type": "string" }, "postal_code": { "maxLength": 5000, "type": "string" }, "state": { "maxLength": 5000, "type": "string" }, "terminal_id": { "maxLength": 5000, "type": "string" }, "url": { "maxLength": 5000, "type": "string" } }, "title": "merchant_data_specs", "type": "object" }, "purchase_details": { "description": "Additional purchase information that is optionally provided by the merchant.", "properties": { "fleet": { "properties": { "cardholder_prompt_data": { "properties": { "driver_id": { "maxLength": 5000, "type": "string" }, "odometer": { "type": "integer" }, "unspecified_id": { "maxLength": 5000, "type": "string" }, "user_id": { "maxLength": 5000, "type": "string" }, "vehicle_number": { "maxLength": 5000, "type": "string" } }, "title": "fleet_cardholder_prompt_data_specs", "type": "object" }, "purchase_type": { "enum": [ "fuel_and_non_fuel_purchase", "fuel_purchase", "non_fuel_purchase" ], "maxLength": 5000, "type": "string" }, "reported_breakdown": { "properties": { "fuel": { "properties": { "gross_amount_decimal": { "format": "decimal", "type": "string" } }, "title": "fleet_reported_breakdown_fuel_specs", "type": "object" }, "non_fuel": { "properties": { "gross_amount_decimal": { "format": "decimal", "type": "string" } }, "title": "fleet_reported_breakdown_non_fuel_specs", "type": "object" }, "tax": { "properties": { "local_amount_decimal": { "format": "decimal", "type": "string" }, "national_amount_decimal": { "format": "decimal", "type": "string" } }, "title": "fleet_reported_breakdown_tax_specs", "type": "object" } }, "title": "fleet_reported_breakdown_specs", "type": "object" }, "service_type": { "enum": [ "full_service", "non_fuel_transaction", "self_service" ], "maxLength": 5000, "type": "string" } }, "title": "fleet_specs", "type": "object" }, "flight": { "properties": { "departure_at": { "format": "unix-time", "type": "integer" }, "passenger_name": { "maxLength": 5000, "type": "string" }, "refundable": { "type": "boolean" }, "segments": { "items": { "properties": { "arrival_airport_code": { "maxLength": 3, "type": "string" }, "carrier": { "maxLength": 5000, "type": "string" }, "departure_airport_code": { "maxLength": 3, "type": "string" }, "flight_number": { "maxLength": 5000, "type": "string" }, "service_class": { "maxLength": 5000, "type": "string" }, "stopover_allowed": { "type": "boolean" } }, "title": "flight_segment_specs", "type": "object" }, "type": "array" }, "travel_agency": { "maxLength": 5000, "type": "string" } }, "title": "flight_specs", "type": "object" }, "fuel": { "properties": { "industry_product_code": { "maxLength": 5000, "type": "string" }, "quantity_decimal": { "format": "decimal", "type": "string" }, "type": { "enum": [ "diesel", "other", "unleaded_plus", "unleaded_regular", "unleaded_super" ], "maxLength": 5000, "type": "string" }, "unit": { "enum": [ "charging_minute", "imperial_gallon", "kilogram", "kilowatt_hour", "liter", "other", "pound", "us_gallon" ], "maxLength": 5000, "type": "string" }, "unit_cost_decimal": { "format": "decimal", "type": "string" } }, "title": "fuel_specs", "type": "object" }, "lodging": { "properties": { "check_in_at": { "format": "unix-time", "type": "integer" }, "nights": { "type": "integer" } }, "title": "lodging_specs", "type": "object" }, "receipt": { "items": { "properties": { "description": { "maxLength": 26, "type": "string" }, "quantity": { "format": "decimal", "type": "string" }, "total": { "type": "integer" }, "unit_cost": { "type": "integer" } }, "title": "receipt_specs", "type": "object" }, "type": "array" }, "reference": { "maxLength": 5000, "type": "string" } }, "title": "purchase_details_specs", "type": "object" } }, "required": [ "amount", "card" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issuing.transaction" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a test-mode force capture" } }, "/v1/test_helpers/issuing/transactions/create_unlinked_refund": { "post": { "description": "

Allows the user to refund an arbitrary amount, also known as a unlinked refund.

", "operationId": "PostTestHelpersIssuingTransactionsCreateUnlinkedRefund", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "merchant_data": { "explode": true, "style": "deepObject" }, "purchase_details": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "amount": { "description": "The total amount to attempt to refund. This amount is in the provided currency, or defaults to the cards currency, and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", "type": "integer" }, "card": { "description": "Card associated with this unlinked refund transaction.", "maxLength": 5000, "type": "string" }, "currency": { "description": "The currency of the unlinked refund. If not provided, defaults to the currency of the card. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "merchant_data": { "description": "Details about the seller (grocery store, e-commerce website, etc.) where the card authorization happened.", "properties": { "category": { "enum": [ "ac_refrigeration_repair", "accounting_bookkeeping_services", "advertising_services", "agricultural_cooperative", "airlines_air_carriers", "airports_flying_fields", "ambulance_services", "amusement_parks_carnivals", "antique_reproductions", "antique_shops", "aquariums", "architectural_surveying_services", "art_dealers_and_galleries", "artists_supply_and_craft_shops", "auto_and_home_supply_stores", "auto_body_repair_shops", "auto_paint_shops", "auto_service_shops", "automated_cash_disburse", "automated_fuel_dispensers", "automobile_associations", "automotive_parts_and_accessories_stores", "automotive_tire_stores", "bail_and_bond_payments", "bakeries", "bands_orchestras", "barber_and_beauty_shops", "betting_casino_gambling", "bicycle_shops", "billiard_pool_establishments", "boat_dealers", "boat_rentals_and_leases", "book_stores", "books_periodicals_and_newspapers", "bowling_alleys", "bus_lines", "business_secretarial_schools", "buying_shopping_services", "cable_satellite_and_other_pay_television_and_radio", "camera_and_photographic_supply_stores", "candy_nut_and_confectionery_stores", "car_and_truck_dealers_new_used", "car_and_truck_dealers_used_only", "car_rental_agencies", "car_washes", "carpentry_services", "carpet_upholstery_cleaning", "caterers", "charitable_and_social_service_organizations_fundraising", "chemicals_and_allied_products", "child_care_services", "childrens_and_infants_wear_stores", "chiropodists_podiatrists", "chiropractors", "cigar_stores_and_stands", "civic_social_fraternal_associations", "cleaning_and_maintenance", "clothing_rental", "colleges_universities", "commercial_equipment", "commercial_footwear", "commercial_photography_art_and_graphics", "commuter_transport_and_ferries", "computer_network_services", "computer_programming", "computer_repair", "computer_software_stores", "computers_peripherals_and_software", "concrete_work_services", "construction_materials", "consulting_public_relations", "correspondence_schools", "cosmetic_stores", "counseling_services", "country_clubs", "courier_services", "court_costs", "credit_reporting_agencies", "cruise_lines", "dairy_products_stores", "dance_hall_studios_schools", "dating_escort_services", "dentists_orthodontists", "department_stores", "detective_agencies", "digital_goods_applications", "digital_goods_games", "digital_goods_large_volume", "digital_goods_media", "direct_marketing_catalog_merchant", "direct_marketing_combination_catalog_and_retail_merchant", "direct_marketing_inbound_telemarketing", "direct_marketing_insurance_services", "direct_marketing_other", "direct_marketing_outbound_telemarketing", "direct_marketing_subscription", "direct_marketing_travel", "discount_stores", "doctors", "door_to_door_sales", "drapery_window_covering_and_upholstery_stores", "drinking_places", "drug_stores_and_pharmacies", "drugs_drug_proprietaries_and_druggist_sundries", "dry_cleaners", "durable_goods", "duty_free_stores", "eating_places_restaurants", "educational_services", "electric_razor_stores", "electric_vehicle_charging", "electrical_parts_and_equipment", "electrical_services", "electronics_repair_shops", "electronics_stores", "elementary_secondary_schools", "emergency_services_gcas_visa_use_only", "employment_temp_agencies", "equipment_rental", "exterminating_services", "family_clothing_stores", "fast_food_restaurants", "financial_institutions", "fines_government_administrative_entities", "fireplace_fireplace_screens_and_accessories_stores", "floor_covering_stores", "florists", "florists_supplies_nursery_stock_and_flowers", "freezer_and_locker_meat_provisioners", "fuel_dealers_non_automotive", "funeral_services_crematories", "furniture_home_furnishings_and_equipment_stores_except_appliances", "furniture_repair_refinishing", "furriers_and_fur_shops", "general_services", "gift_card_novelty_and_souvenir_shops", "glass_paint_and_wallpaper_stores", "glassware_crystal_stores", "golf_courses_public", "government_licensed_horse_dog_racing_us_region_only", "government_licensed_online_casions_online_gambling_us_region_only", "government_owned_lotteries_non_us_region", "government_owned_lotteries_us_region_only", "government_services", "grocery_stores_supermarkets", "hardware_equipment_and_supplies", "hardware_stores", "health_and_beauty_spas", "hearing_aids_sales_and_supplies", "heating_plumbing_a_c", "hobby_toy_and_game_shops", "home_supply_warehouse_stores", "hospitals", "hotels_motels_and_resorts", "household_appliance_stores", "industrial_supplies", "information_retrieval_services", "insurance_default", "insurance_underwriting_premiums", "intra_company_purchases", "jewelry_stores_watches_clocks_and_silverware_stores", "landscaping_services", "laundries", "laundry_cleaning_services", "legal_services_attorneys", "luggage_and_leather_goods_stores", "lumber_building_materials_stores", "manual_cash_disburse", "marinas_service_and_supplies", "marketplaces", "masonry_stonework_and_plaster", "massage_parlors", "medical_and_dental_labs", "medical_dental_ophthalmic_and_hospital_equipment_and_supplies", "medical_services", "membership_organizations", "mens_and_boys_clothing_and_accessories_stores", "mens_womens_clothing_stores", "metal_service_centers", "miscellaneous_apparel_and_accessory_shops", "miscellaneous_auto_dealers", "miscellaneous_business_services", "miscellaneous_food_stores", "miscellaneous_general_merchandise", "miscellaneous_general_services", "miscellaneous_home_furnishing_specialty_stores", "miscellaneous_publishing_and_printing", "miscellaneous_recreation_services", "miscellaneous_repair_shops", "miscellaneous_specialty_retail", "mobile_home_dealers", "motion_picture_theaters", "motor_freight_carriers_and_trucking", "motor_homes_dealers", "motor_vehicle_supplies_and_new_parts", "motorcycle_shops_and_dealers", "motorcycle_shops_dealers", "music_stores_musical_instruments_pianos_and_sheet_music", "news_dealers_and_newsstands", "non_fi_money_orders", "non_fi_stored_value_card_purchase_load", "nondurable_goods", "nurseries_lawn_and_garden_supply_stores", "nursing_personal_care", "office_and_commercial_furniture", "opticians_eyeglasses", "optometrists_ophthalmologist", "orthopedic_goods_prosthetic_devices", "osteopaths", "package_stores_beer_wine_and_liquor", "paints_varnishes_and_supplies", "parking_lots_garages", "passenger_railways", "pawn_shops", "pet_shops_pet_food_and_supplies", "petroleum_and_petroleum_products", "photo_developing", "photographic_photocopy_microfilm_equipment_and_supplies", "photographic_studios", "picture_video_production", "piece_goods_notions_and_other_dry_goods", "plumbing_heating_equipment_and_supplies", "political_organizations", "postal_services_government_only", "precious_stones_and_metals_watches_and_jewelry", "professional_services", "public_warehousing_and_storage", "quick_copy_repro_and_blueprint", "railroads", "real_estate_agents_and_managers_rentals", "record_stores", "recreational_vehicle_rentals", "religious_goods_stores", "religious_organizations", "roofing_siding_sheet_metal", "secretarial_support_services", "security_brokers_dealers", "service_stations", "sewing_needlework_fabric_and_piece_goods_stores", "shoe_repair_hat_cleaning", "shoe_stores", "small_appliance_repair", "snowmobile_dealers", "special_trade_services", "specialty_cleaning", "sporting_goods_stores", "sporting_recreation_camps", "sports_and_riding_apparel_stores", "sports_clubs_fields", "stamp_and_coin_stores", "stationary_office_supplies_printing_and_writing_paper", "stationery_stores_office_and_school_supply_stores", "swimming_pools_sales", "t_ui_travel_germany", "tailors_alterations", "tax_payments_government_agencies", "tax_preparation_services", "taxicabs_limousines", "telecommunication_equipment_and_telephone_sales", "telecommunication_services", "telegraph_services", "tent_and_awning_shops", "testing_laboratories", "theatrical_ticket_agencies", "timeshares", "tire_retreading_and_repair", "tolls_bridge_fees", "tourist_attractions_and_exhibits", "towing_services", "trailer_parks_campgrounds", "transportation_services", "travel_agencies_tour_operators", "truck_stop_iteration", "truck_utility_trailer_rentals", "typesetting_plate_making_and_related_services", "typewriter_stores", "u_s_federal_government_agencies_or_departments", "uniforms_commercial_clothing", "used_merchandise_and_secondhand_stores", "utilities", "variety_stores", "veterinary_services", "video_amusement_game_supplies", "video_game_arcades", "video_tape_rental_stores", "vocational_trade_schools", "watch_jewelry_repair", "welding_repair", "wholesale_clubs", "wig_and_toupee_stores", "wires_money_orders", "womens_accessory_and_specialty_shops", "womens_ready_to_wear_stores", "wrecking_and_salvage_yards" ], "maxLength": 5000, "type": "string" }, "city": { "maxLength": 5000, "type": "string" }, "country": { "maxLength": 5000, "type": "string" }, "name": { "maxLength": 5000, "type": "string" }, "network_id": { "maxLength": 5000, "type": "string" }, "postal_code": { "maxLength": 5000, "type": "string" }, "state": { "maxLength": 5000, "type": "string" }, "terminal_id": { "maxLength": 5000, "type": "string" }, "url": { "maxLength": 5000, "type": "string" } }, "title": "merchant_data_specs", "type": "object" }, "purchase_details": { "description": "Additional purchase information that is optionally provided by the merchant.", "properties": { "fleet": { "properties": { "cardholder_prompt_data": { "properties": { "driver_id": { "maxLength": 5000, "type": "string" }, "odometer": { "type": "integer" }, "unspecified_id": { "maxLength": 5000, "type": "string" }, "user_id": { "maxLength": 5000, "type": "string" }, "vehicle_number": { "maxLength": 5000, "type": "string" } }, "title": "fleet_cardholder_prompt_data_specs", "type": "object" }, "purchase_type": { "enum": [ "fuel_and_non_fuel_purchase", "fuel_purchase", "non_fuel_purchase" ], "maxLength": 5000, "type": "string" }, "reported_breakdown": { "properties": { "fuel": { "properties": { "gross_amount_decimal": { "format": "decimal", "type": "string" } }, "title": "fleet_reported_breakdown_fuel_specs", "type": "object" }, "non_fuel": { "properties": { "gross_amount_decimal": { "format": "decimal", "type": "string" } }, "title": "fleet_reported_breakdown_non_fuel_specs", "type": "object" }, "tax": { "properties": { "local_amount_decimal": { "format": "decimal", "type": "string" }, "national_amount_decimal": { "format": "decimal", "type": "string" } }, "title": "fleet_reported_breakdown_tax_specs", "type": "object" } }, "title": "fleet_reported_breakdown_specs", "type": "object" }, "service_type": { "enum": [ "full_service", "non_fuel_transaction", "self_service" ], "maxLength": 5000, "type": "string" } }, "title": "fleet_specs", "type": "object" }, "flight": { "properties": { "departure_at": { "format": "unix-time", "type": "integer" }, "passenger_name": { "maxLength": 5000, "type": "string" }, "refundable": { "type": "boolean" }, "segments": { "items": { "properties": { "arrival_airport_code": { "maxLength": 3, "type": "string" }, "carrier": { "maxLength": 5000, "type": "string" }, "departure_airport_code": { "maxLength": 3, "type": "string" }, "flight_number": { "maxLength": 5000, "type": "string" }, "service_class": { "maxLength": 5000, "type": "string" }, "stopover_allowed": { "type": "boolean" } }, "title": "flight_segment_specs", "type": "object" }, "type": "array" }, "travel_agency": { "maxLength": 5000, "type": "string" } }, "title": "flight_specs", "type": "object" }, "fuel": { "properties": { "industry_product_code": { "maxLength": 5000, "type": "string" }, "quantity_decimal": { "format": "decimal", "type": "string" }, "type": { "enum": [ "diesel", "other", "unleaded_plus", "unleaded_regular", "unleaded_super" ], "maxLength": 5000, "type": "string" }, "unit": { "enum": [ "charging_minute", "imperial_gallon", "kilogram", "kilowatt_hour", "liter", "other", "pound", "us_gallon" ], "maxLength": 5000, "type": "string" }, "unit_cost_decimal": { "format": "decimal", "type": "string" } }, "title": "fuel_specs", "type": "object" }, "lodging": { "properties": { "check_in_at": { "format": "unix-time", "type": "integer" }, "nights": { "type": "integer" } }, "title": "lodging_specs", "type": "object" }, "receipt": { "items": { "properties": { "description": { "maxLength": 26, "type": "string" }, "quantity": { "format": "decimal", "type": "string" }, "total": { "type": "integer" }, "unit_cost": { "type": "integer" } }, "title": "receipt_specs", "type": "object" }, "type": "array" }, "reference": { "maxLength": 5000, "type": "string" } }, "title": "purchase_details_specs", "type": "object" } }, "required": [ "amount", "card" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issuing.transaction" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a test-mode unlinked refund" } }, "/v1/test_helpers/issuing/transactions/{transaction}/refund": { "post": { "description": "

Refund a test-mode Transaction.

", "operationId": "PostTestHelpersIssuingTransactionsTransactionRefund", "parameters": [ { "in": "path", "name": "transaction", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "refund_amount": { "description": "The total amount to attempt to refund. This amount is in the provided currency, or defaults to the cards currency, and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", "type": "integer" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issuing.transaction" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Refund a test-mode transaction" } }, "/v1/test_helpers/refunds/{refund}/expire": { "post": { "description": "

Expire a refund with a status of requires_action.

", "operationId": "PostTestHelpersRefundsRefundExpire", "parameters": [ { "in": "path", "name": "refund", "required": true, "schema": { "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/refund" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Expire a pending refund." } }, "/v1/test_helpers/terminal/readers/{reader}/present_payment_method": { "post": { "description": "

Presents a payment method on a simulated reader. Can be used to simulate accepting a payment, saving a card or refunding a transaction.

", "operationId": "PostTestHelpersTerminalReadersReaderPresentPaymentMethod", "parameters": [ { "in": "path", "name": "reader", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "card": { "explode": true, "style": "deepObject" }, "card_present": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "interac_present": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "amount_tip": { "description": "Simulated on-reader tip amount.", "type": "integer" }, "card": { "description": "Simulated data for the card payment method.", "properties": { "cvc": { "maxLength": 5000, "type": "string" }, "exp_month": { "type": "integer" }, "exp_year": { "type": "integer" }, "number": { "maxLength": 5000, "type": "string" } }, "required": [ "exp_month", "exp_year", "number" ], "title": "card", "type": "object" }, "card_present": { "description": "Simulated data for the card_present payment method.", "properties": { "number": { "maxLength": 5000, "type": "string" } }, "title": "card_present", "type": "object" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "interac_present": { "description": "Simulated data for the interac_present payment method.", "properties": { "number": { "maxLength": 5000, "type": "string" } }, "title": "interac_present", "type": "object" }, "type": { "description": "Simulated payment type.", "enum": [ "card", "card_present", "interac_present" ], "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/terminal.reader" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Simulate presenting a payment method" } }, "/v1/test_helpers/terminal/readers/{reader}/succeed_input_collection": { "post": { "description": "

Use this endpoint to trigger a successful input collection on a simulated reader.

", "operationId": "PostTestHelpersTerminalReadersReaderSucceedInputCollection", "parameters": [ { "in": "path", "name": "reader", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "skip_non_required_inputs": { "description": "This parameter defines the skip behavior for input collection.", "enum": [ "all", "none" ], "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/terminal.reader" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Simulate a successful input collection" } }, "/v1/test_helpers/terminal/readers/{reader}/timeout_input_collection": { "post": { "description": "

Use this endpoint to complete an input collection with a timeout error on a simulated reader.

", "operationId": "PostTestHelpersTerminalReadersReaderTimeoutInputCollection", "parameters": [ { "in": "path", "name": "reader", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/terminal.reader" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Simulate an input collection timeout" } }, "/v1/test_helpers/test_clocks": { "get": { "description": "

Returns a list of your test clocks.

", "operationId": "GetTestHelpersTestClocks", "parameters": [ { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/test_helpers.test_clock" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/test_helpers/test_clocks", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "BillingClocksResourceBillingClockList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all test clocks" }, "post": { "description": "

Creates a new test clock that can be attached to new customers and quotes.

", "operationId": "PostTestHelpersTestClocks", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "frozen_time": { "description": "The initial frozen time for this test clock.", "format": "unix-time", "type": "integer" }, "name": { "description": "The name for this test clock.", "maxLength": 300, "type": "string" } }, "required": [ "frozen_time" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/test_helpers.test_clock" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a test clock" } }, "/v1/test_helpers/test_clocks/{test_clock}": { "delete": { "description": "

Deletes a test clock.

", "operationId": "DeleteTestHelpersTestClocksTestClock", "parameters": [ { "in": "path", "name": "test_clock", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted_test_helpers.test_clock" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Delete a test clock" }, "get": { "description": "

Retrieves a test clock.

", "operationId": "GetTestHelpersTestClocksTestClock", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "test_clock", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/test_helpers.test_clock" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a test clock" } }, "/v1/test_helpers/test_clocks/{test_clock}/advance": { "post": { "description": "

Starts advancing a test clock to a specified time in the future. Advancement is done when status changes to Ready.

", "operationId": "PostTestHelpersTestClocksTestClockAdvance", "parameters": [ { "in": "path", "name": "test_clock", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "frozen_time": { "description": "The time to advance the test clock. Must be after the test clock's current frozen time. Cannot be more than two intervals in the future from the shortest subscription in this test clock. If there are no subscriptions in this test clock, it cannot be more than two years in the future.", "format": "unix-time", "type": "integer" } }, "required": [ "frozen_time" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/test_helpers.test_clock" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Advance a test clock" } }, "/v1/test_helpers/treasury/inbound_transfers/{id}/fail": { "post": { "description": "

Transitions a test mode created InboundTransfer to the failed status. The InboundTransfer must already be in the processing state.

", "operationId": "PostTestHelpersTreasuryInboundTransfersIdFail", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "failure_details": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "failure_details": { "description": "Details about a failed InboundTransfer.", "properties": { "code": { "enum": [ "account_closed", "account_frozen", "bank_account_restricted", "bank_ownership_changed", "debit_not_authorized", "incorrect_account_holder_address", "incorrect_account_holder_name", "incorrect_account_holder_tax_id", "insufficient_funds", "invalid_account_number", "invalid_currency", "no_account", "other" ], "type": "string" } }, "title": "failure_details_param", "type": "object" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/treasury.inbound_transfer" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Test mode: Fail an InboundTransfer" } }, "/v1/test_helpers/treasury/inbound_transfers/{id}/return": { "post": { "description": "

Marks the test mode InboundTransfer object as returned and links the InboundTransfer to a ReceivedDebit. The InboundTransfer must already be in the succeeded state.

", "operationId": "PostTestHelpersTreasuryInboundTransfersIdReturn", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/treasury.inbound_transfer" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Test mode: Return an InboundTransfer" } }, "/v1/test_helpers/treasury/inbound_transfers/{id}/succeed": { "post": { "description": "

Transitions a test mode created InboundTransfer to the succeeded status. The InboundTransfer must already be in the processing state.

", "operationId": "PostTestHelpersTreasuryInboundTransfersIdSucceed", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/treasury.inbound_transfer" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Test mode: Succeed an InboundTransfer" } }, "/v1/test_helpers/treasury/outbound_payments/{id}": { "post": { "description": "

Updates a test mode created OutboundPayment with tracking details. The OutboundPayment must not be cancelable, and cannot be in the canceled or failed states.

", "operationId": "PostTestHelpersTreasuryOutboundPaymentsId", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "tracking_details": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "tracking_details": { "description": "Details about network-specific tracking information.", "properties": { "ach": { "properties": { "trace_id": { "maxLength": 5000, "type": "string" } }, "required": [ "trace_id" ], "title": "ach_tracking_details_params", "type": "object" }, "type": { "enum": [ "ach", "us_domestic_wire" ], "type": "string" }, "us_domestic_wire": { "properties": { "chips": { "maxLength": 5000, "type": "string" }, "imad": { "maxLength": 5000, "type": "string" }, "omad": { "maxLength": 5000, "type": "string" } }, "title": "us_domestic_wire_tracking_details_params", "type": "object" } }, "required": [ "type" ], "title": "tracking_details_params", "type": "object" } }, "required": [ "tracking_details" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/treasury.outbound_payment" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Test mode: Update an OutboundPayment" } }, "/v1/test_helpers/treasury/outbound_payments/{id}/fail": { "post": { "description": "

Transitions a test mode created OutboundPayment to the failed status. The OutboundPayment must already be in the processing state.

", "operationId": "PostTestHelpersTreasuryOutboundPaymentsIdFail", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/treasury.outbound_payment" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Test mode: Fail an OutboundPayment" } }, "/v1/test_helpers/treasury/outbound_payments/{id}/post": { "post": { "description": "

Transitions a test mode created OutboundPayment to the posted status. The OutboundPayment must already be in the processing state.

", "operationId": "PostTestHelpersTreasuryOutboundPaymentsIdPost", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/treasury.outbound_payment" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Test mode: Post an OutboundPayment" } }, "/v1/test_helpers/treasury/outbound_payments/{id}/return": { "post": { "description": "

Transitions a test mode created OutboundPayment to the returned status. The OutboundPayment must already be in the processing state.

", "operationId": "PostTestHelpersTreasuryOutboundPaymentsIdReturn", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "returned_details": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "returned_details": { "description": "Optional hash to set the return code.", "properties": { "code": { "enum": [ "account_closed", "account_frozen", "bank_account_restricted", "bank_ownership_changed", "declined", "incorrect_account_holder_name", "invalid_account_number", "invalid_currency", "no_account", "other" ], "type": "string" } }, "title": "returned_details_params", "type": "object" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/treasury.outbound_payment" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Test mode: Return an OutboundPayment" } }, "/v1/test_helpers/treasury/outbound_transfers/{outbound_transfer}": { "post": { "description": "

Updates a test mode created OutboundTransfer with tracking details. The OutboundTransfer must not be cancelable, and cannot be in the canceled or failed states.

", "operationId": "PostTestHelpersTreasuryOutboundTransfersOutboundTransfer", "parameters": [ { "in": "path", "name": "outbound_transfer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "tracking_details": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "tracking_details": { "description": "Details about network-specific tracking information.", "properties": { "ach": { "properties": { "trace_id": { "maxLength": 5000, "type": "string" } }, "required": [ "trace_id" ], "title": "ach_tracking_details_params", "type": "object" }, "type": { "enum": [ "ach", "us_domestic_wire" ], "type": "string" }, "us_domestic_wire": { "properties": { "chips": { "maxLength": 5000, "type": "string" }, "imad": { "maxLength": 5000, "type": "string" }, "omad": { "maxLength": 5000, "type": "string" } }, "title": "us_domestic_wire_tracking_details_params", "type": "object" } }, "required": [ "type" ], "title": "tracking_details_params", "type": "object" } }, "required": [ "tracking_details" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/treasury.outbound_transfer" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Test mode: Update an OutboundTransfer" } }, "/v1/test_helpers/treasury/outbound_transfers/{outbound_transfer}/fail": { "post": { "description": "

Transitions a test mode created OutboundTransfer to the failed status. The OutboundTransfer must already be in the processing state.

", "operationId": "PostTestHelpersTreasuryOutboundTransfersOutboundTransferFail", "parameters": [ { "in": "path", "name": "outbound_transfer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/treasury.outbound_transfer" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Test mode: Fail an OutboundTransfer" } }, "/v1/test_helpers/treasury/outbound_transfers/{outbound_transfer}/post": { "post": { "description": "

Transitions a test mode created OutboundTransfer to the posted status. The OutboundTransfer must already be in the processing state.

", "operationId": "PostTestHelpersTreasuryOutboundTransfersOutboundTransferPost", "parameters": [ { "in": "path", "name": "outbound_transfer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/treasury.outbound_transfer" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Test mode: Post an OutboundTransfer" } }, "/v1/test_helpers/treasury/outbound_transfers/{outbound_transfer}/return": { "post": { "description": "

Transitions a test mode created OutboundTransfer to the returned status. The OutboundTransfer must already be in the processing state.

", "operationId": "PostTestHelpersTreasuryOutboundTransfersOutboundTransferReturn", "parameters": [ { "in": "path", "name": "outbound_transfer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "returned_details": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "returned_details": { "description": "Details about a returned OutboundTransfer.", "properties": { "code": { "enum": [ "account_closed", "account_frozen", "bank_account_restricted", "bank_ownership_changed", "declined", "incorrect_account_holder_name", "invalid_account_number", "invalid_currency", "no_account", "other" ], "type": "string" } }, "title": "returned_details_params", "type": "object" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/treasury.outbound_transfer" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Test mode: Return an OutboundTransfer" } }, "/v1/test_helpers/treasury/received_credits": { "post": { "description": "

Use this endpoint to simulate a test mode ReceivedCredit initiated by a third party. In live mode, you can’t directly create ReceivedCredits initiated by third parties.

", "operationId": "PostTestHelpersTreasuryReceivedCredits", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "initiating_payment_method_details": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "amount": { "description": "Amount (in cents) to be transferred.", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users.", "maxLength": 5000, "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "financial_account": { "description": "The FinancialAccount to send funds to.", "type": "string" }, "initiating_payment_method_details": { "description": "Initiating payment method details for the object.", "properties": { "type": { "enum": [ "us_bank_account" ], "type": "string" }, "us_bank_account": { "properties": { "account_holder_name": { "maxLength": 5000, "type": "string" }, "account_number": { "maxLength": 5000, "type": "string" }, "routing_number": { "maxLength": 5000, "type": "string" } }, "title": "us_bank_account_source_params", "type": "object" } }, "required": [ "type" ], "title": "source_params", "type": "object" }, "network": { "description": "Specifies the network rails to be used. If not set, will default to the PaymentMethod's preferred network. See the [docs](https://stripe.com/docs/treasury/money-movement/timelines) to learn more about money movement timelines for each network type.", "enum": [ "ach", "us_domestic_wire" ], "type": "string" } }, "required": [ "amount", "currency", "financial_account", "network" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/treasury.received_credit" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Test mode: Create a ReceivedCredit" } }, "/v1/test_helpers/treasury/received_debits": { "post": { "description": "

Use this endpoint to simulate a test mode ReceivedDebit initiated by a third party. In live mode, you can’t directly create ReceivedDebits initiated by third parties.

", "operationId": "PostTestHelpersTreasuryReceivedDebits", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "initiating_payment_method_details": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "amount": { "description": "Amount (in cents) to be transferred.", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users.", "maxLength": 5000, "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "financial_account": { "description": "The FinancialAccount to pull funds from.", "type": "string" }, "initiating_payment_method_details": { "description": "Initiating payment method details for the object.", "properties": { "type": { "enum": [ "us_bank_account" ], "type": "string" }, "us_bank_account": { "properties": { "account_holder_name": { "maxLength": 5000, "type": "string" }, "account_number": { "maxLength": 5000, "type": "string" }, "routing_number": { "maxLength": 5000, "type": "string" } }, "title": "us_bank_account_source_params", "type": "object" } }, "required": [ "type" ], "title": "source_params", "type": "object" }, "network": { "description": "Specifies the network rails to be used. If not set, will default to the PaymentMethod's preferred network. See the [docs](https://stripe.com/docs/treasury/money-movement/timelines) to learn more about money movement timelines for each network type.", "enum": [ "ach" ], "type": "string" } }, "required": [ "amount", "currency", "financial_account", "network" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/treasury.received_debit" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Test mode: Create a ReceivedDebit" } }, "/v1/tokens": { "post": { "description": "

Creates a single-use token that represents a bank account’s details.\nYou can use this token with any v1 API method in place of a bank account dictionary. You can only use this token once. To do so, attach it to a connected account where controller.requirement_collection is application, which includes Custom accounts.

", "operationId": "PostTokens", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "account": { "explode": true, "style": "deepObject" }, "bank_account": { "explode": true, "style": "deepObject" }, "card": { "explode": true, "style": "deepObject" }, "cvc_update": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "person": { "explode": true, "style": "deepObject" }, "pii": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "account": { "description": "Information for the account this token represents.", "properties": { "business_type": { "enum": [ "company", "government_entity", "individual", "non_profit" ], "type": "string", "x-stripeBypassValidation": true }, "company": { "properties": { "address": { "properties": { "city": { "maxLength": 100, "type": "string" }, "country": { "maxLength": 5000, "type": "string" }, "line1": { "maxLength": 200, "type": "string" }, "line2": { "maxLength": 200, "type": "string" }, "postal_code": { "maxLength": 5000, "type": "string" }, "state": { "maxLength": 5000, "type": "string" } }, "title": "legal_entity_and_kyc_address_specs", "type": "object" }, "address_kana": { "properties": { "city": { "maxLength": 5000, "type": "string" }, "country": { "maxLength": 5000, "type": "string" }, "line1": { "maxLength": 5000, "type": "string" }, "line2": { "maxLength": 5000, "type": "string" }, "postal_code": { "maxLength": 5000, "type": "string" }, "state": { "maxLength": 5000, "type": "string" }, "town": { "maxLength": 5000, "type": "string" } }, "title": "japan_address_kana_specs", "type": "object" }, "address_kanji": { "properties": { "city": { "maxLength": 5000, "type": "string" }, "country": { "maxLength": 5000, "type": "string" }, "line1": { "maxLength": 5000, "type": "string" }, "line2": { "maxLength": 5000, "type": "string" }, "postal_code": { "maxLength": 5000, "type": "string" }, "state": { "maxLength": 5000, "type": "string" }, "town": { "maxLength": 5000, "type": "string" } }, "title": "japan_address_kanji_specs", "type": "object" }, "directors_provided": { "type": "boolean" }, "directorship_declaration": { "properties": { "date": { "format": "unix-time", "type": "integer" }, "ip": { "type": "string" }, "user_agent": { "maxLength": 5000, "type": "string" } }, "title": "company_directorship_declaration", "type": "object" }, "executives_provided": { "type": "boolean" }, "export_license_id": { "maxLength": 5000, "type": "string" }, "export_purpose_code": { "maxLength": 5000, "type": "string" }, "name": { "maxLength": 100, "type": "string" }, "name_kana": { "maxLength": 100, "type": "string" }, "name_kanji": { "maxLength": 100, "type": "string" }, "owners_provided": { "type": "boolean" }, "ownership_declaration": { "properties": { "date": { "format": "unix-time", "type": "integer" }, "ip": { "type": "string" }, "user_agent": { "maxLength": 5000, "type": "string" } }, "title": "company_ownership_declaration", "type": "object" }, "ownership_declaration_shown_and_signed": { "type": "boolean" }, "ownership_exemption_reason": { "enum": [ "", "qualified_entity_exceeds_ownership_threshold", "qualifies_as_financial_institution" ], "type": "string" }, "phone": { "maxLength": 5000, "type": "string" }, "registration_date": { "anyOf": [ { "properties": { "day": { "type": "integer" }, "month": { "type": "integer" }, "year": { "type": "integer" } }, "required": [ "day", "month", "year" ], "title": "registration_date_specs", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "registration_number": { "maxLength": 5000, "type": "string" }, "structure": { "enum": [ "", "free_zone_establishment", "free_zone_llc", "government_instrumentality", "governmental_unit", "incorporated_non_profit", "incorporated_partnership", "limited_liability_partnership", "llc", "multi_member_llc", "private_company", "private_corporation", "private_partnership", "public_company", "public_corporation", "public_partnership", "registered_charity", "single_member_llc", "sole_establishment", "sole_proprietorship", "tax_exempt_government_instrumentality", "unincorporated_association", "unincorporated_non_profit", "unincorporated_partnership" ], "type": "string", "x-stripeBypassValidation": true }, "tax_id": { "maxLength": 5000, "type": "string" }, "tax_id_registrar": { "maxLength": 5000, "type": "string" }, "vat_id": { "maxLength": 5000, "type": "string" }, "verification": { "properties": { "document": { "properties": { "back": { "maxLength": 500, "type": "string" }, "front": { "maxLength": 500, "type": "string" } }, "title": "verification_document_specs", "type": "object" } }, "title": "verification_specs", "type": "object" } }, "title": "connect_js_account_token_company_specs", "type": "object" }, "individual": { "properties": { "address": { "properties": { "city": { "maxLength": 100, "type": "string" }, "country": { "maxLength": 5000, "type": "string" }, "line1": { "maxLength": 200, "type": "string" }, "line2": { "maxLength": 200, "type": "string" }, "postal_code": { "maxLength": 5000, "type": "string" }, "state": { "maxLength": 5000, "type": "string" } }, "title": "address_specs", "type": "object" }, "address_kana": { "properties": { "city": { "maxLength": 5000, "type": "string" }, "country": { "maxLength": 5000, "type": "string" }, "line1": { "maxLength": 5000, "type": "string" }, "line2": { "maxLength": 5000, "type": "string" }, "postal_code": { "maxLength": 5000, "type": "string" }, "state": { "maxLength": 5000, "type": "string" }, "town": { "maxLength": 5000, "type": "string" } }, "title": "japan_address_kana_specs", "type": "object" }, "address_kanji": { "properties": { "city": { "maxLength": 5000, "type": "string" }, "country": { "maxLength": 5000, "type": "string" }, "line1": { "maxLength": 5000, "type": "string" }, "line2": { "maxLength": 5000, "type": "string" }, "postal_code": { "maxLength": 5000, "type": "string" }, "state": { "maxLength": 5000, "type": "string" }, "town": { "maxLength": 5000, "type": "string" } }, "title": "japan_address_kanji_specs", "type": "object" }, "dob": { "anyOf": [ { "properties": { "day": { "type": "integer" }, "month": { "type": "integer" }, "year": { "type": "integer" } }, "required": [ "day", "month", "year" ], "title": "date_of_birth_specs", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "email": { "type": "string" }, "first_name": { "maxLength": 100, "type": "string" }, "first_name_kana": { "maxLength": 5000, "type": "string" }, "first_name_kanji": { "maxLength": 5000, "type": "string" }, "full_name_aliases": { "anyOf": [ { "items": { "maxLength": 300, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ] }, "gender": { "type": "string" }, "id_number": { "maxLength": 5000, "type": "string" }, "id_number_secondary": { "maxLength": 5000, "type": "string" }, "last_name": { "maxLength": 100, "type": "string" }, "last_name_kana": { "maxLength": 5000, "type": "string" }, "last_name_kanji": { "maxLength": 5000, "type": "string" }, "maiden_name": { "maxLength": 5000, "type": "string" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "phone": { "type": "string" }, "political_exposure": { "enum": [ "existing", "none" ], "type": "string" }, "registered_address": { "properties": { "city": { "maxLength": 100, "type": "string" }, "country": { "maxLength": 5000, "type": "string" }, "line1": { "maxLength": 200, "type": "string" }, "line2": { "maxLength": 200, "type": "string" }, "postal_code": { "maxLength": 5000, "type": "string" }, "state": { "maxLength": 5000, "type": "string" } }, "title": "address_specs", "type": "object" }, "relationship": { "properties": { "director": { "type": "boolean" }, "executive": { "type": "boolean" }, "owner": { "type": "boolean" }, "percent_ownership": { "anyOf": [ { "type": "number" }, { "enum": [ "" ], "type": "string" } ] }, "title": { "maxLength": 5000, "type": "string" } }, "title": "individual_relationship_specs", "type": "object" }, "ssn_last_4": { "maxLength": 5000, "type": "string" }, "verification": { "properties": { "additional_document": { "properties": { "back": { "maxLength": 500, "type": "string" }, "front": { "maxLength": 500, "type": "string" } }, "title": "person_verification_document_specs", "type": "object" }, "document": { "properties": { "back": { "maxLength": 500, "type": "string" }, "front": { "maxLength": 500, "type": "string" } }, "title": "person_verification_document_specs", "type": "object" } }, "title": "person_verification_specs", "type": "object" } }, "title": "individual_specs", "type": "object" }, "tos_shown_and_accepted": { "type": "boolean" } }, "title": "connect_js_account_token_specs", "type": "object" }, "bank_account": { "description": "The bank account this token will represent.", "properties": { "account_holder_name": { "maxLength": 5000, "type": "string" }, "account_holder_type": { "enum": [ "company", "individual" ], "maxLength": 5000, "type": "string" }, "account_number": { "maxLength": 5000, "type": "string" }, "account_type": { "enum": [ "checking", "futsu", "savings", "toza" ], "maxLength": 5000, "type": "string" }, "country": { "maxLength": 5000, "type": "string" }, "currency": { "format": "currency", "type": "string" }, "payment_method": { "maxLength": 5000, "type": "string" }, "routing_number": { "maxLength": 5000, "type": "string" } }, "required": [ "account_number", "country" ], "title": "token_create_bank_account", "type": "object", "x-stripeBypassValidation": true }, "card": { "anyOf": [ { "properties": { "address_city": { "maxLength": 5000, "type": "string" }, "address_country": { "maxLength": 5000, "type": "string" }, "address_line1": { "maxLength": 5000, "type": "string" }, "address_line2": { "maxLength": 5000, "type": "string" }, "address_state": { "maxLength": 5000, "type": "string" }, "address_zip": { "maxLength": 5000, "type": "string" }, "currency": { "maxLength": 5000, "type": "string" }, "cvc": { "maxLength": 5000, "type": "string" }, "exp_month": { "maxLength": 5000, "type": "string" }, "exp_year": { "maxLength": 5000, "type": "string" }, "name": { "maxLength": 5000, "type": "string" }, "networks": { "properties": { "preferred": { "enum": [ "cartes_bancaires", "mastercard", "visa" ], "type": "string" } }, "title": "networks_param_specs", "type": "object" }, "number": { "maxLength": 5000, "type": "string" } }, "required": [ "exp_month", "exp_year", "number" ], "title": "credit_card_specs", "type": "object" }, { "maxLength": 5000, "type": "string" } ], "description": "The card this token will represent. If you also pass in a customer, the card must be the ID of a card belonging to the customer. Otherwise, if you do not pass in a customer, this is a dictionary containing a user's credit card details, with the options described below.", "x-stripeBypassValidation": true }, "customer": { "description": "Create a token for the customer, which is owned by the application's account. You can only use this with an [OAuth access token](https://stripe.com/docs/connect/standard-accounts) or [Stripe-Account header](https://stripe.com/docs/connect/authentication). Learn more about [cloning saved payment methods](https://stripe.com/docs/connect/cloning-saved-payment-methods).", "maxLength": 5000, "type": "string" }, "cvc_update": { "description": "The updated CVC value this token represents.", "properties": { "cvc": { "maxLength": 5000, "type": "string" } }, "required": [ "cvc" ], "title": "cvc_params", "type": "object" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "person": { "description": "Information for the person this token represents.", "properties": { "additional_tos_acceptances": { "properties": { "account": { "properties": { "date": { "format": "unix-time", "type": "integer" }, "ip": { "type": "string" }, "user_agent": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "settings_terms_of_service_specs", "type": "object" } }, "title": "person_additional_tos_acceptances_specs", "type": "object" }, "address": { "properties": { "city": { "maxLength": 100, "type": "string" }, "country": { "maxLength": 5000, "type": "string" }, "line1": { "maxLength": 200, "type": "string" }, "line2": { "maxLength": 200, "type": "string" }, "postal_code": { "maxLength": 5000, "type": "string" }, "state": { "maxLength": 5000, "type": "string" } }, "title": "legal_entity_and_kyc_address_specs", "type": "object" }, "address_kana": { "properties": { "city": { "maxLength": 5000, "type": "string" }, "country": { "maxLength": 5000, "type": "string" }, "line1": { "maxLength": 5000, "type": "string" }, "line2": { "maxLength": 5000, "type": "string" }, "postal_code": { "maxLength": 5000, "type": "string" }, "state": { "maxLength": 5000, "type": "string" }, "town": { "maxLength": 5000, "type": "string" } }, "title": "japan_address_kana_specs", "type": "object" }, "address_kanji": { "properties": { "city": { "maxLength": 5000, "type": "string" }, "country": { "maxLength": 5000, "type": "string" }, "line1": { "maxLength": 5000, "type": "string" }, "line2": { "maxLength": 5000, "type": "string" }, "postal_code": { "maxLength": 5000, "type": "string" }, "state": { "maxLength": 5000, "type": "string" }, "town": { "maxLength": 5000, "type": "string" } }, "title": "japan_address_kanji_specs", "type": "object" }, "dob": { "anyOf": [ { "properties": { "day": { "type": "integer" }, "month": { "type": "integer" }, "year": { "type": "integer" } }, "required": [ "day", "month", "year" ], "title": "date_of_birth_specs", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "documents": { "properties": { "company_authorization": { "properties": { "files": { "items": { "anyOf": [ { "maxLength": 500, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "type": "array" } }, "title": "documents_param", "type": "object" }, "passport": { "properties": { "files": { "items": { "anyOf": [ { "maxLength": 500, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "type": "array" } }, "title": "documents_param", "type": "object" }, "visa": { "properties": { "files": { "items": { "anyOf": [ { "maxLength": 500, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "type": "array" } }, "title": "documents_param", "type": "object" } }, "title": "person_documents_specs", "type": "object" }, "email": { "type": "string" }, "first_name": { "maxLength": 5000, "type": "string" }, "first_name_kana": { "maxLength": 5000, "type": "string" }, "first_name_kanji": { "maxLength": 5000, "type": "string" }, "full_name_aliases": { "anyOf": [ { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, { "enum": [ "" ], "type": "string" } ] }, "gender": { "type": "string" }, "id_number": { "maxLength": 5000, "type": "string" }, "id_number_secondary": { "maxLength": 5000, "type": "string" }, "last_name": { "maxLength": 5000, "type": "string" }, "last_name_kana": { "maxLength": 5000, "type": "string" }, "last_name_kanji": { "maxLength": 5000, "type": "string" }, "maiden_name": { "maxLength": 5000, "type": "string" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "nationality": { "maxLength": 5000, "type": "string" }, "phone": { "type": "string" }, "political_exposure": { "enum": [ "existing", "none" ], "type": "string" }, "registered_address": { "properties": { "city": { "maxLength": 100, "type": "string" }, "country": { "maxLength": 5000, "type": "string" }, "line1": { "maxLength": 200, "type": "string" }, "line2": { "maxLength": 200, "type": "string" }, "postal_code": { "maxLength": 5000, "type": "string" }, "state": { "maxLength": 5000, "type": "string" } }, "title": "address_specs", "type": "object" }, "relationship": { "properties": { "authorizer": { "type": "boolean" }, "director": { "type": "boolean" }, "executive": { "type": "boolean" }, "legal_guardian": { "type": "boolean" }, "owner": { "type": "boolean" }, "percent_ownership": { "anyOf": [ { "type": "number" }, { "enum": [ "" ], "type": "string" } ] }, "representative": { "type": "boolean" }, "title": { "maxLength": 5000, "type": "string" } }, "title": "relationship_specs", "type": "object" }, "ssn_last_4": { "type": "string" }, "us_cfpb_data": { "properties": { "ethnicity_details": { "properties": { "ethnicity": { "items": { "enum": [ "cuban", "hispanic_or_latino", "mexican", "not_hispanic_or_latino", "other_hispanic_or_latino", "prefer_not_to_answer", "puerto_rican" ], "type": "string" }, "type": "array" }, "ethnicity_other": { "maxLength": 5000, "type": "string" } }, "title": "us_cfpb_ethnicity_details_specs", "type": "object" }, "race_details": { "properties": { "race": { "items": { "enum": [ "african_american", "american_indian_or_alaska_native", "asian", "asian_indian", "black_or_african_american", "chinese", "ethiopian", "filipino", "guamanian_or_chamorro", "haitian", "jamaican", "japanese", "korean", "native_hawaiian", "native_hawaiian_or_other_pacific_islander", "nigerian", "other_asian", "other_black_or_african_american", "other_pacific_islander", "prefer_not_to_answer", "samoan", "somali", "vietnamese", "white" ], "type": "string" }, "type": "array" }, "race_other": { "maxLength": 5000, "type": "string" } }, "title": "us_cfpb_race_details_specs", "type": "object" }, "self_identified_gender": { "maxLength": 5000, "type": "string" } }, "title": "us_cfpb_data_specs", "type": "object" }, "verification": { "properties": { "additional_document": { "properties": { "back": { "maxLength": 500, "type": "string" }, "front": { "maxLength": 500, "type": "string" } }, "title": "person_verification_document_specs", "type": "object" }, "document": { "properties": { "back": { "maxLength": 500, "type": "string" }, "front": { "maxLength": 500, "type": "string" } }, "title": "person_verification_document_specs", "type": "object" } }, "title": "person_verification_specs", "type": "object" } }, "title": "person_token_specs", "type": "object" }, "pii": { "description": "The PII this token represents.", "properties": { "id_number": { "maxLength": 5000, "type": "string" } }, "title": "pii_token_specs", "type": "object" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/token" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a CVC update token" } }, "/v1/tokens/{token}": { "get": { "description": "

Retrieves the token with the given ID.

", "operationId": "GetTokensToken", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "token", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/token" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a token" } }, "/v1/topups": { "get": { "description": "

Returns a list of top-ups.

", "operationId": "GetTopups", "parameters": [ { "description": "A positive integer representing how much to transfer.", "explode": true, "in": "query", "name": "amount", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "type": "integer" }, "gte": { "type": "integer" }, "lt": { "type": "integer" }, "lte": { "type": "integer" } }, "title": "range_query_specs", "type": "object" }, { "type": "integer" } ] }, "style": "deepObject" }, { "description": "A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.", "explode": true, "in": "query", "name": "created", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "type": "integer" }, "gte": { "type": "integer" }, "lt": { "type": "integer" }, "lte": { "type": "integer" } }, "title": "range_query_specs", "type": "object" }, { "type": "integer" } ] }, "style": "deepObject" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Only return top-ups that have the given status. One of `canceled`, `failed`, `pending` or `succeeded`.", "in": "query", "name": "status", "required": false, "schema": { "enum": [ "canceled", "failed", "pending", "succeeded" ], "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/topup" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/topups", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "TopupList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all top-ups" }, "post": { "description": "

Top up the balance of an account

", "operationId": "PostTopups", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "amount": { "description": "A positive integer representing how much to transfer.", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "type": "string" }, "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users.", "maxLength": 5000, "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "source": { "description": "The ID of a source to transfer funds from. For most users, this should be left unspecified which will use the bank account that was set up in the dashboard for the specified currency. In test mode, this can be a test bank token (see [Testing Top-ups](https://stripe.com/docs/connect/testing#testing-top-ups)).", "maxLength": 5000, "type": "string" }, "statement_descriptor": { "description": "Extra information about a top-up for the source's bank statement. Limited to 15 ASCII characters.", "maxLength": 15, "type": "string" }, "transfer_group": { "description": "A string that identifies this top-up as part of a group.", "type": "string" } }, "required": [ "amount", "currency" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/topup" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a top-up" } }, "/v1/topups/{topup}": { "get": { "description": "

Retrieves the details of a top-up that has previously been created. Supply the unique top-up ID that was returned from your previous request, and Stripe will return the corresponding top-up information.

", "operationId": "GetTopupsTopup", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "topup", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/topup" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a top-up" }, "post": { "description": "

Updates the metadata of a top-up. Other top-up details are not editable by design.

", "operationId": "PostTopupsTopup", "parameters": [ { "in": "path", "name": "topup", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users.", "maxLength": 5000, "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/topup" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a top-up" } }, "/v1/topups/{topup}/cancel": { "post": { "description": "

Cancels a top-up. Only pending top-ups can be canceled.

", "operationId": "PostTopupsTopupCancel", "parameters": [ { "in": "path", "name": "topup", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/topup" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Cancel a top-up" } }, "/v1/transfers": { "get": { "description": "

Returns a list of existing transfers sent to connected accounts. The transfers are returned in sorted order, with the most recently created transfers appearing first.

", "operationId": "GetTransfers", "parameters": [ { "description": "Only return transfers that were created during the given date interval.", "explode": true, "in": "query", "name": "created", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "type": "integer" }, "gte": { "type": "integer" }, "lt": { "type": "integer" }, "lte": { "type": "integer" } }, "title": "range_query_specs", "type": "object" }, { "type": "integer" } ] }, "style": "deepObject" }, { "description": "Only return transfers for the destination specified by this account ID.", "in": "query", "name": "destination", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Only return transfers with the specified transfer group.", "in": "query", "name": "transfer_group", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/transfer" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/transfers", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "TransferList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all transfers" }, "post": { "description": "

To send funds from your Stripe account to a connected account, you create a new transfer object. Your Stripe balance must be able to cover the transfer amount, or you’ll receive an “Insufficient Funds” error.

", "operationId": "PostTransfers", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "amount": { "description": "A positive integer in cents (or local equivalent) representing how much to transfer.", "type": "integer" }, "currency": { "description": "Three-letter [ISO code for currency](https://www.iso.org/iso-4217-currency-codes.html) in lowercase. Must be a [supported currency](https://docs.stripe.com/currencies).", "format": "currency", "type": "string" }, "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users.", "maxLength": 5000, "type": "string" }, "destination": { "description": "The ID of a connected Stripe account. See the Connect documentation for details.", "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "source_transaction": { "description": "You can use this parameter to transfer funds from a charge before they are added to your available balance. A pending balance will transfer immediately but the funds will not become available until the original charge becomes available. [See the Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-availability) for details.", "type": "string" }, "source_type": { "description": "The source balance to use for this transfer. One of `bank_account`, `card`, or `fpx`. For most users, this will default to `card`.", "enum": [ "bank_account", "card", "fpx" ], "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true }, "transfer_group": { "description": "A string that identifies this transaction as part of a group. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) for details.", "type": "string" } }, "required": [ "currency", "destination" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/transfer" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a transfer" } }, "/v1/transfers/{id}/reversals": { "get": { "description": "

You can see a list of the reversals belonging to a specific transfer. Note that the 10 most recent reversals are always available by default on the transfer object. If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional reversals.

", "operationId": "GetTransfersIdReversals", "parameters": [ { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/transfer_reversal" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "TransferReversalList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all reversals" }, "post": { "description": "

When you create a new reversal, you must specify a transfer to create it on.

\n\n

When reversing transfers, you can optionally reverse part of the transfer. You can do so as many times as you wish until the entire transfer has been reversed.

\n\n

Once entirely reversed, a transfer can’t be reversed again. This method will return an error when called on an already-reversed transfer, or when trying to reverse more money than is left on a transfer.

", "operationId": "PostTransfersIdReversals", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "amount": { "description": "A positive integer in cents (or local equivalent) representing how much of this transfer to reverse. Can only reverse up to the unreversed amount remaining of the transfer. Partial transfer reversals are only allowed for transfers to Stripe Accounts. Defaults to the entire transfer amount.", "type": "integer" }, "description": { "description": "An arbitrary string which you can attach to a reversal object. This will be unset if you POST an empty value.", "maxLength": 5000, "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "refund_application_fee": { "description": "Boolean indicating whether the application fee should be refunded when reversing this transfer. If a full transfer reversal is given, the full application fee will be refunded. Otherwise, the application fee will be refunded with an amount proportional to the amount of the transfer reversed.", "type": "boolean" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/transfer_reversal" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a transfer reversal" } }, "/v1/transfers/{transfer}": { "get": { "description": "

Retrieves the details of an existing transfer. Supply the unique transfer ID from either a transfer creation request or the transfer list, and Stripe will return the corresponding transfer information.

", "operationId": "GetTransfersTransfer", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "transfer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/transfer" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a transfer" }, "post": { "description": "

Updates the specified transfer by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

\n\n

This request accepts only metadata as an argument.

", "operationId": "PostTransfersTransfer", "parameters": [ { "in": "path", "name": "transfer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users.", "maxLength": 5000, "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/transfer" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a transfer" } }, "/v1/transfers/{transfer}/reversals/{id}": { "get": { "description": "

By default, you can see the 10 most recent reversals stored directly on the transfer object, but you can also retrieve details about a specific reversal stored on the transfer.

", "operationId": "GetTransfersTransferReversalsId", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "in": "path", "name": "transfer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/transfer_reversal" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a reversal" }, "post": { "description": "

Updates the specified reversal by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

\n\n

This request only accepts metadata and description as arguments.

", "operationId": "PostTransfersTransferReversalsId", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "in": "path", "name": "transfer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/transfer_reversal" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a reversal" } }, "/v1/treasury/credit_reversals": { "get": { "description": "

Returns a list of CreditReversals.

", "operationId": "GetTreasuryCreditReversals", "parameters": [ { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "Returns objects associated with this FinancialAccount.", "in": "query", "name": "financial_account", "required": true, "schema": { "type": "string" }, "style": "form" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "Only return CreditReversals for the ReceivedCredit ID.", "in": "query", "name": "received_credit", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Only return CreditReversals for a given status.", "in": "query", "name": "status", "required": false, "schema": { "enum": [ "canceled", "posted", "processing" ], "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/treasury.credit_reversal" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "TreasuryReceivedCreditsResourceCreditReversalList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all CreditReversals" }, "post": { "description": "

Reverses a ReceivedCredit and creates a CreditReversal object.

", "operationId": "PostTreasuryCreditReversals", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "received_credit": { "description": "The ReceivedCredit to reverse.", "maxLength": 5000, "type": "string" } }, "required": [ "received_credit" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/treasury.credit_reversal" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a CreditReversal" } }, "/v1/treasury/credit_reversals/{credit_reversal}": { "get": { "description": "

Retrieves the details of an existing CreditReversal by passing the unique CreditReversal ID from either the CreditReversal creation request or CreditReversal list

", "operationId": "GetTreasuryCreditReversalsCreditReversal", "parameters": [ { "in": "path", "name": "credit_reversal", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/treasury.credit_reversal" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a CreditReversal" } }, "/v1/treasury/debit_reversals": { "get": { "description": "

Returns a list of DebitReversals.

", "operationId": "GetTreasuryDebitReversals", "parameters": [ { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "Returns objects associated with this FinancialAccount.", "in": "query", "name": "financial_account", "required": true, "schema": { "type": "string" }, "style": "form" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "Only return DebitReversals for the ReceivedDebit ID.", "in": "query", "name": "received_debit", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Only return DebitReversals for a given resolution.", "in": "query", "name": "resolution", "required": false, "schema": { "enum": [ "lost", "won" ], "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Only return DebitReversals for a given status.", "in": "query", "name": "status", "required": false, "schema": { "enum": [ "canceled", "completed", "processing" ], "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/treasury.debit_reversal" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "TreasuryReceivedDebitsResourceDebitReversalList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all DebitReversals" }, "post": { "description": "

Reverses a ReceivedDebit and creates a DebitReversal object.

", "operationId": "PostTreasuryDebitReversals", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "received_debit": { "description": "The ReceivedDebit to reverse.", "maxLength": 5000, "type": "string" } }, "required": [ "received_debit" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/treasury.debit_reversal" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a DebitReversal" } }, "/v1/treasury/debit_reversals/{debit_reversal}": { "get": { "description": "

Retrieves a DebitReversal object.

", "operationId": "GetTreasuryDebitReversalsDebitReversal", "parameters": [ { "in": "path", "name": "debit_reversal", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/treasury.debit_reversal" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a DebitReversal" } }, "/v1/treasury/financial_accounts": { "get": { "description": "

Returns a list of FinancialAccounts.

", "operationId": "GetTreasuryFinancialAccounts", "parameters": [ { "description": "Only return FinancialAccounts that were created during the given date interval.", "explode": true, "in": "query", "name": "created", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "type": "integer" }, "gte": { "type": "integer" }, "lt": { "type": "integer" }, "lte": { "type": "integer" } }, "title": "range_query_specs", "type": "object" }, { "type": "integer" } ] }, "style": "deepObject" }, { "description": "An object ID cursor for use in pagination.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit ranging from 1 to 100 (defaults to 10).", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "An object ID cursor for use in pagination.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Only return FinancialAccounts that have the given status: `open` or `closed`", "in": "query", "name": "status", "required": false, "schema": { "enum": [ "closed", "open" ], "type": "string", "x-stripeBypassValidation": true }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/treasury.financial_account" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/treasury/financial_accounts", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "TreasuryFinancialAccountsResourceFinancialAccountList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all FinancialAccounts" }, "post": { "description": "

Creates a new FinancialAccount. Each connected account can have up to three FinancialAccounts by default.

", "operationId": "PostTreasuryFinancialAccounts", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "features": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "nickname": { "explode": true, "style": "deepObject" }, "platform_restrictions": { "explode": true, "style": "deepObject" }, "supported_currencies": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "features": { "description": "Encodes whether a FinancialAccount has access to a particular feature. Stripe or the platform can control features via the requested field.", "properties": { "card_issuing": { "properties": { "requested": { "type": "boolean" } }, "required": [ "requested" ], "title": "access", "type": "object" }, "deposit_insurance": { "properties": { "requested": { "type": "boolean" } }, "required": [ "requested" ], "title": "access", "type": "object" }, "financial_addresses": { "properties": { "aba": { "properties": { "requested": { "type": "boolean" } }, "required": [ "requested" ], "title": "aba_access", "type": "object" } }, "title": "financial_addresses", "type": "object" }, "inbound_transfers": { "properties": { "ach": { "properties": { "requested": { "type": "boolean" } }, "required": [ "requested" ], "title": "access_with_ach_details", "type": "object" } }, "title": "inbound_transfers", "type": "object" }, "intra_stripe_flows": { "properties": { "requested": { "type": "boolean" } }, "required": [ "requested" ], "title": "access", "type": "object" }, "outbound_payments": { "properties": { "ach": { "properties": { "requested": { "type": "boolean" } }, "required": [ "requested" ], "title": "access_with_ach_details", "type": "object" }, "us_domestic_wire": { "properties": { "requested": { "type": "boolean" } }, "required": [ "requested" ], "title": "access", "type": "object" } }, "title": "outbound_payments", "type": "object" }, "outbound_transfers": { "properties": { "ach": { "properties": { "requested": { "type": "boolean" } }, "required": [ "requested" ], "title": "access_with_ach_details", "type": "object" }, "us_domestic_wire": { "properties": { "requested": { "type": "boolean" } }, "required": [ "requested" ], "title": "access", "type": "object" } }, "title": "outbound_transfers", "type": "object" } }, "title": "feature_access", "type": "object" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "nickname": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "The nickname for the FinancialAccount." }, "platform_restrictions": { "description": "The set of functionalities that the platform can restrict on the FinancialAccount.", "properties": { "inbound_flows": { "enum": [ "restricted", "unrestricted" ], "type": "string" }, "outbound_flows": { "enum": [ "restricted", "unrestricted" ], "type": "string" } }, "title": "platform_restrictions", "type": "object" }, "supported_currencies": { "description": "The currencies the FinancialAccount can hold a balance in.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "required": [ "supported_currencies" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/treasury.financial_account" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a FinancialAccount" } }, "/v1/treasury/financial_accounts/{financial_account}": { "get": { "description": "

Retrieves the details of a FinancialAccount.

", "operationId": "GetTreasuryFinancialAccountsFinancialAccount", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "financial_account", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/treasury.financial_account" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a FinancialAccount" }, "post": { "description": "

Updates the details of a FinancialAccount.

", "operationId": "PostTreasuryFinancialAccountsFinancialAccount", "parameters": [ { "in": "path", "name": "financial_account", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "features": { "explode": true, "style": "deepObject" }, "forwarding_settings": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" }, "nickname": { "explode": true, "style": "deepObject" }, "platform_restrictions": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "features": { "description": "Encodes whether a FinancialAccount has access to a particular feature, with a status enum and associated `status_details`. Stripe or the platform may control features via the requested field.", "properties": { "card_issuing": { "properties": { "requested": { "type": "boolean" } }, "required": [ "requested" ], "title": "access", "type": "object" }, "deposit_insurance": { "properties": { "requested": { "type": "boolean" } }, "required": [ "requested" ], "title": "access", "type": "object" }, "financial_addresses": { "properties": { "aba": { "properties": { "requested": { "type": "boolean" } }, "required": [ "requested" ], "title": "aba_access", "type": "object" } }, "title": "financial_addresses", "type": "object" }, "inbound_transfers": { "properties": { "ach": { "properties": { "requested": { "type": "boolean" } }, "required": [ "requested" ], "title": "access_with_ach_details", "type": "object" } }, "title": "inbound_transfers", "type": "object" }, "intra_stripe_flows": { "properties": { "requested": { "type": "boolean" } }, "required": [ "requested" ], "title": "access", "type": "object" }, "outbound_payments": { "properties": { "ach": { "properties": { "requested": { "type": "boolean" } }, "required": [ "requested" ], "title": "access_with_ach_details", "type": "object" }, "us_domestic_wire": { "properties": { "requested": { "type": "boolean" } }, "required": [ "requested" ], "title": "access", "type": "object" } }, "title": "outbound_payments", "type": "object" }, "outbound_transfers": { "properties": { "ach": { "properties": { "requested": { "type": "boolean" } }, "required": [ "requested" ], "title": "access_with_ach_details", "type": "object" }, "us_domestic_wire": { "properties": { "requested": { "type": "boolean" } }, "required": [ "requested" ], "title": "access", "type": "object" } }, "title": "outbound_transfers", "type": "object" } }, "title": "feature_access", "type": "object" }, "forwarding_settings": { "description": "A different bank account where funds can be deposited/debited in order to get the closing FA's balance to $0", "properties": { "financial_account": { "type": "string" }, "payment_method": { "maxLength": 5000, "type": "string" }, "type": { "enum": [ "financial_account", "payment_method" ], "type": "string" } }, "required": [ "type" ], "title": "forwarding_settings", "type": "object" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "nickname": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "The nickname for the FinancialAccount." }, "platform_restrictions": { "description": "The set of functionalities that the platform can restrict on the FinancialAccount.", "properties": { "inbound_flows": { "enum": [ "restricted", "unrestricted" ], "type": "string" }, "outbound_flows": { "enum": [ "restricted", "unrestricted" ], "type": "string" } }, "title": "platform_restrictions", "type": "object" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/treasury.financial_account" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a FinancialAccount" } }, "/v1/treasury/financial_accounts/{financial_account}/close": { "post": { "description": "

Closes a FinancialAccount. A FinancialAccount can only be closed if it has a zero balance, has no pending InboundTransfers, and has canceled all attached Issuing cards.

", "operationId": "PostTreasuryFinancialAccountsFinancialAccountClose", "parameters": [ { "in": "path", "name": "financial_account", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "forwarding_settings": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "forwarding_settings": { "description": "A different bank account where funds can be deposited/debited in order to get the closing FA's balance to $0", "properties": { "financial_account": { "type": "string" }, "payment_method": { "maxLength": 5000, "type": "string" }, "type": { "enum": [ "financial_account", "payment_method" ], "type": "string" } }, "required": [ "type" ], "title": "forwarding_settings", "type": "object" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/treasury.financial_account" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Close a FinancialAccount" } }, "/v1/treasury/financial_accounts/{financial_account}/features": { "get": { "description": "

Retrieves Features information associated with the FinancialAccount.

", "operationId": "GetTreasuryFinancialAccountsFinancialAccountFeatures", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "financial_account", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/treasury.financial_account_features" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve FinancialAccount Features" }, "post": { "description": "

Updates the Features associated with a FinancialAccount.

", "operationId": "PostTreasuryFinancialAccountsFinancialAccountFeatures", "parameters": [ { "in": "path", "name": "financial_account", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "card_issuing": { "explode": true, "style": "deepObject" }, "deposit_insurance": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "financial_addresses": { "explode": true, "style": "deepObject" }, "inbound_transfers": { "explode": true, "style": "deepObject" }, "intra_stripe_flows": { "explode": true, "style": "deepObject" }, "outbound_payments": { "explode": true, "style": "deepObject" }, "outbound_transfers": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "card_issuing": { "description": "Encodes the FinancialAccount's ability to be used with the Issuing product, including attaching cards to and drawing funds from the FinancialAccount.", "properties": { "requested": { "type": "boolean" } }, "required": [ "requested" ], "title": "access", "type": "object" }, "deposit_insurance": { "description": "Represents whether this FinancialAccount is eligible for deposit insurance. Various factors determine the insurance amount.", "properties": { "requested": { "type": "boolean" } }, "required": [ "requested" ], "title": "access", "type": "object" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "financial_addresses": { "description": "Contains Features that add FinancialAddresses to the FinancialAccount.", "properties": { "aba": { "properties": { "requested": { "type": "boolean" } }, "required": [ "requested" ], "title": "aba_access", "type": "object" } }, "title": "financial_addresses", "type": "object" }, "inbound_transfers": { "description": "Contains settings related to adding funds to a FinancialAccount from another Account with the same owner.", "properties": { "ach": { "properties": { "requested": { "type": "boolean" } }, "required": [ "requested" ], "title": "access_with_ach_details", "type": "object" } }, "title": "inbound_transfers", "type": "object" }, "intra_stripe_flows": { "description": "Represents the ability for the FinancialAccount to send money to, or receive money from other FinancialAccounts (for example, via OutboundPayment).", "properties": { "requested": { "type": "boolean" } }, "required": [ "requested" ], "title": "access", "type": "object" }, "outbound_payments": { "description": "Includes Features related to initiating money movement out of the FinancialAccount to someone else's bucket of money.", "properties": { "ach": { "properties": { "requested": { "type": "boolean" } }, "required": [ "requested" ], "title": "access_with_ach_details", "type": "object" }, "us_domestic_wire": { "properties": { "requested": { "type": "boolean" } }, "required": [ "requested" ], "title": "access", "type": "object" } }, "title": "outbound_payments", "type": "object" }, "outbound_transfers": { "description": "Contains a Feature and settings related to moving money out of the FinancialAccount into another Account with the same owner.", "properties": { "ach": { "properties": { "requested": { "type": "boolean" } }, "required": [ "requested" ], "title": "access_with_ach_details", "type": "object" }, "us_domestic_wire": { "properties": { "requested": { "type": "boolean" } }, "required": [ "requested" ], "title": "access", "type": "object" } }, "title": "outbound_transfers", "type": "object" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/treasury.financial_account_features" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update FinancialAccount Features" } }, "/v1/treasury/inbound_transfers": { "get": { "description": "

Returns a list of InboundTransfers sent from the specified FinancialAccount.

", "operationId": "GetTreasuryInboundTransfers", "parameters": [ { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "Returns objects associated with this FinancialAccount.", "in": "query", "name": "financial_account", "required": true, "schema": { "type": "string" }, "style": "form" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Only return InboundTransfers that have the given status: `processing`, `succeeded`, `failed` or `canceled`.", "in": "query", "name": "status", "required": false, "schema": { "enum": [ "canceled", "failed", "processing", "succeeded" ], "type": "string", "x-stripeBypassValidation": true }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/treasury.inbound_transfer" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "TreasuryInboundTransfersResourceInboundTransferList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all InboundTransfers" }, "post": { "description": "

Creates an InboundTransfer.

", "operationId": "PostTreasuryInboundTransfers", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "amount": { "description": "Amount (in cents) to be transferred.", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users.", "maxLength": 5000, "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "financial_account": { "description": "The FinancialAccount to send funds to.", "type": "string" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "origin_payment_method": { "description": "The origin payment method to be debited for the InboundTransfer.", "maxLength": 5000, "type": "string" }, "statement_descriptor": { "description": "The complete description that appears on your customers' statements. Maximum 10 characters.", "maxLength": 10, "type": "string" } }, "required": [ "amount", "currency", "financial_account", "origin_payment_method" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/treasury.inbound_transfer" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create an InboundTransfer" } }, "/v1/treasury/inbound_transfers/{id}": { "get": { "description": "

Retrieves the details of an existing InboundTransfer.

", "operationId": "GetTreasuryInboundTransfersId", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/treasury.inbound_transfer" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve an InboundTransfer" } }, "/v1/treasury/inbound_transfers/{inbound_transfer}/cancel": { "post": { "description": "

Cancels an InboundTransfer.

", "operationId": "PostTreasuryInboundTransfersInboundTransferCancel", "parameters": [ { "in": "path", "name": "inbound_transfer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/treasury.inbound_transfer" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Cancel an InboundTransfer" } }, "/v1/treasury/outbound_payments": { "get": { "description": "

Returns a list of OutboundPayments sent from the specified FinancialAccount.

", "operationId": "GetTreasuryOutboundPayments", "parameters": [ { "description": "Only return OutboundPayments that were created during the given date interval.", "explode": true, "in": "query", "name": "created", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "type": "integer" }, "gte": { "type": "integer" }, "lt": { "type": "integer" }, "lte": { "type": "integer" } }, "title": "range_query_specs", "type": "object" }, { "type": "integer" } ] }, "style": "deepObject" }, { "description": "Only return OutboundPayments sent to this customer.", "in": "query", "name": "customer", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "Returns objects associated with this FinancialAccount.", "in": "query", "name": "financial_account", "required": true, "schema": { "type": "string" }, "style": "form" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Only return OutboundPayments that have the given status: `processing`, `failed`, `posted`, `returned`, or `canceled`.", "in": "query", "name": "status", "required": false, "schema": { "enum": [ "canceled", "failed", "posted", "processing", "returned" ], "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/treasury.outbound_payment" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/treasury/outbound_payments", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "TreasuryOutboundPaymentsResourceOutboundPaymentList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all OutboundPayments" }, "post": { "description": "

Creates an OutboundPayment.

", "operationId": "PostTreasuryOutboundPayments", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "destination_payment_method_data": { "explode": true, "style": "deepObject" }, "destination_payment_method_options": { "explode": true, "style": "deepObject" }, "end_user_details": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "amount": { "description": "Amount (in cents) to be transferred.", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "customer": { "description": "ID of the customer to whom the OutboundPayment is sent. Must match the Customer attached to the `destination_payment_method` passed in.", "maxLength": 5000, "type": "string" }, "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users.", "maxLength": 5000, "type": "string" }, "destination_payment_method": { "description": "The PaymentMethod to use as the payment instrument for the OutboundPayment. Exclusive with `destination_payment_method_data`.", "maxLength": 5000, "type": "string" }, "destination_payment_method_data": { "description": "Hash used to generate the PaymentMethod to be used for this OutboundPayment. Exclusive with `destination_payment_method`.", "properties": { "billing_details": { "properties": { "address": { "anyOf": [ { "properties": { "city": { "maxLength": 5000, "type": "string" }, "country": { "maxLength": 5000, "type": "string" }, "line1": { "maxLength": 5000, "type": "string" }, "line2": { "maxLength": 5000, "type": "string" }, "postal_code": { "maxLength": 5000, "type": "string" }, "state": { "maxLength": 5000, "type": "string" } }, "title": "billing_details_address", "type": "object" }, { "enum": [ "" ], "type": "string" } ] }, "email": { "anyOf": [ { "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "name": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] }, "phone": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "billing_details_inner_params", "type": "object" }, "financial_account": { "type": "string" }, "metadata": { "additionalProperties": { "type": "string" }, "type": "object" }, "type": { "enum": [ "financial_account", "us_bank_account" ], "type": "string", "x-stripeBypassValidation": true }, "us_bank_account": { "properties": { "account_holder_type": { "enum": [ "company", "individual" ], "type": "string" }, "account_number": { "maxLength": 5000, "type": "string" }, "account_type": { "enum": [ "checking", "savings" ], "type": "string" }, "financial_connections_account": { "maxLength": 5000, "type": "string" }, "routing_number": { "maxLength": 5000, "type": "string" } }, "title": "payment_method_param", "type": "object" } }, "required": [ "type" ], "title": "payment_method_data", "type": "object" }, "destination_payment_method_options": { "description": "Payment method-specific configuration for this OutboundPayment.", "properties": { "us_bank_account": { "anyOf": [ { "properties": { "network": { "enum": [ "ach", "us_domestic_wire" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "payment_method_options", "type": "object" }, "end_user_details": { "description": "End user details.", "properties": { "ip_address": { "type": "string" }, "present": { "type": "boolean" } }, "required": [ "present" ], "title": "end_user_details_params", "type": "object" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "financial_account": { "description": "The FinancialAccount to pull funds from.", "type": "string" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "statement_descriptor": { "description": "The description that appears on the receiving end for this OutboundPayment (for example, bank statement for external bank transfer). Maximum 10 characters for `ach` payments, 140 characters for `us_domestic_wire` payments, or 500 characters for `stripe` network transfers. The default value is \"payment\".", "maxLength": 5000, "type": "string" } }, "required": [ "amount", "currency", "financial_account" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/treasury.outbound_payment" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create an OutboundPayment" } }, "/v1/treasury/outbound_payments/{id}": { "get": { "description": "

Retrieves the details of an existing OutboundPayment by passing the unique OutboundPayment ID from either the OutboundPayment creation request or OutboundPayment list.

", "operationId": "GetTreasuryOutboundPaymentsId", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/treasury.outbound_payment" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve an OutboundPayment" } }, "/v1/treasury/outbound_payments/{id}/cancel": { "post": { "description": "

Cancel an OutboundPayment.

", "operationId": "PostTreasuryOutboundPaymentsIdCancel", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/treasury.outbound_payment" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Cancel an OutboundPayment" } }, "/v1/treasury/outbound_transfers": { "get": { "description": "

Returns a list of OutboundTransfers sent from the specified FinancialAccount.

", "operationId": "GetTreasuryOutboundTransfers", "parameters": [ { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "Returns objects associated with this FinancialAccount.", "in": "query", "name": "financial_account", "required": true, "schema": { "type": "string" }, "style": "form" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Only return OutboundTransfers that have the given status: `processing`, `canceled`, `failed`, `posted`, or `returned`.", "in": "query", "name": "status", "required": false, "schema": { "enum": [ "canceled", "failed", "posted", "processing", "returned" ], "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/treasury.outbound_transfer" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "TreasuryOutboundTransfersResourceOutboundTransferList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all OutboundTransfers" }, "post": { "description": "

Creates an OutboundTransfer.

", "operationId": "PostTreasuryOutboundTransfers", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "destination_payment_method_data": { "explode": true, "style": "deepObject" }, "destination_payment_method_options": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "amount": { "description": "Amount (in cents) to be transferred.", "type": "integer" }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "format": "currency", "type": "string" }, "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users.", "maxLength": 5000, "type": "string" }, "destination_payment_method": { "description": "The PaymentMethod to use as the payment instrument for the OutboundTransfer.", "maxLength": 5000, "type": "string" }, "destination_payment_method_data": { "description": "Hash used to generate the PaymentMethod to be used for this OutboundTransfer. Exclusive with `destination_payment_method`.", "properties": { "financial_account": { "type": "string" }, "type": { "enum": [ "financial_account" ], "type": "string" } }, "required": [ "type" ], "title": "payment_method_data", "type": "object" }, "destination_payment_method_options": { "description": "Hash describing payment method configuration details.", "properties": { "us_bank_account": { "anyOf": [ { "properties": { "network": { "enum": [ "ach", "us_domestic_wire" ], "type": "string" } }, "title": "payment_method_options_param", "type": "object" }, { "enum": [ "" ], "type": "string" } ] } }, "title": "payment_method_options", "type": "object" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "financial_account": { "description": "The FinancialAccount to pull funds from.", "type": "string" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.", "type": "object" }, "statement_descriptor": { "description": "Statement descriptor to be shown on the receiving end of an OutboundTransfer. Maximum 10 characters for `ach` transfers or 140 characters for `us_domestic_wire` transfers. The default value is \"transfer\".", "maxLength": 5000, "type": "string" } }, "required": [ "amount", "currency", "financial_account" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/treasury.outbound_transfer" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create an OutboundTransfer" } }, "/v1/treasury/outbound_transfers/{outbound_transfer}": { "get": { "description": "

Retrieves the details of an existing OutboundTransfer by passing the unique OutboundTransfer ID from either the OutboundTransfer creation request or OutboundTransfer list.

", "operationId": "GetTreasuryOutboundTransfersOutboundTransfer", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "outbound_transfer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/treasury.outbound_transfer" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve an OutboundTransfer" } }, "/v1/treasury/outbound_transfers/{outbound_transfer}/cancel": { "post": { "description": "

An OutboundTransfer can be canceled if the funds have not yet been paid out.

", "operationId": "PostTreasuryOutboundTransfersOutboundTransferCancel", "parameters": [ { "in": "path", "name": "outbound_transfer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "expand": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/treasury.outbound_transfer" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Cancel an OutboundTransfer" } }, "/v1/treasury/received_credits": { "get": { "description": "

Returns a list of ReceivedCredits.

", "operationId": "GetTreasuryReceivedCredits", "parameters": [ { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "The FinancialAccount that received the funds.", "in": "query", "name": "financial_account", "required": true, "schema": { "type": "string" }, "style": "form" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "Only return ReceivedCredits described by the flow.", "explode": true, "in": "query", "name": "linked_flows", "required": false, "schema": { "properties": { "source_flow_type": { "enum": [ "credit_reversal", "other", "outbound_payment", "outbound_transfer", "payout" ], "type": "string" } }, "required": [ "source_flow_type" ], "title": "linked_flows_param", "type": "object" }, "style": "deepObject" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Only return ReceivedCredits that have the given status: `succeeded` or `failed`.", "in": "query", "name": "status", "required": false, "schema": { "enum": [ "failed", "succeeded" ], "type": "string", "x-stripeBypassValidation": true }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/treasury.received_credit" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "TreasuryReceivedCreditsResourceReceivedCreditList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all ReceivedCredits" } }, "/v1/treasury/received_credits/{id}": { "get": { "description": "

Retrieves the details of an existing ReceivedCredit by passing the unique ReceivedCredit ID from the ReceivedCredit list.

", "operationId": "GetTreasuryReceivedCreditsId", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/treasury.received_credit" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a ReceivedCredit" } }, "/v1/treasury/received_debits": { "get": { "description": "

Returns a list of ReceivedDebits.

", "operationId": "GetTreasuryReceivedDebits", "parameters": [ { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "The FinancialAccount that funds were pulled from.", "in": "query", "name": "financial_account", "required": true, "schema": { "type": "string" }, "style": "form" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Only return ReceivedDebits that have the given status: `succeeded` or `failed`.", "in": "query", "name": "status", "required": false, "schema": { "enum": [ "failed", "succeeded" ], "type": "string", "x-stripeBypassValidation": true }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/treasury.received_debit" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "TreasuryReceivedDebitsResourceReceivedDebitList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all ReceivedDebits" } }, "/v1/treasury/received_debits/{id}": { "get": { "description": "

Retrieves the details of an existing ReceivedDebit by passing the unique ReceivedDebit ID from the ReceivedDebit list

", "operationId": "GetTreasuryReceivedDebitsId", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/treasury.received_debit" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a ReceivedDebit" } }, "/v1/treasury/transaction_entries": { "get": { "description": "

Retrieves a list of TransactionEntry objects.

", "operationId": "GetTreasuryTransactionEntries", "parameters": [ { "description": "Only return TransactionEntries that were created during the given date interval.", "explode": true, "in": "query", "name": "created", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "type": "integer" }, "gte": { "type": "integer" }, "lt": { "type": "integer" }, "lte": { "type": "integer" } }, "title": "range_query_specs", "type": "object" }, { "type": "integer" } ] }, "style": "deepObject" }, { "explode": true, "in": "query", "name": "effective_at", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "type": "integer" }, "gte": { "type": "integer" }, "lt": { "type": "integer" }, "lte": { "type": "integer" } }, "title": "range_query_specs", "type": "object" }, { "type": "integer" } ] }, "style": "deepObject" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "Returns objects associated with this FinancialAccount.", "in": "query", "name": "financial_account", "required": true, "schema": { "type": "string" }, "style": "form" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "The results are in reverse chronological order by `created` or `effective_at`. The default is `created`.", "in": "query", "name": "order_by", "required": false, "schema": { "enum": [ "created", "effective_at" ], "type": "string" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Only return TransactionEntries associated with this Transaction.", "in": "query", "name": "transaction", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/treasury.transaction_entry" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/treasury/transaction_entries", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "TreasuryTransactionsResourceTransactionEntryList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all TransactionEntries" } }, "/v1/treasury/transaction_entries/{id}": { "get": { "description": "

Retrieves a TransactionEntry object.

", "operationId": "GetTreasuryTransactionEntriesId", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/treasury.transaction_entry" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a TransactionEntry" } }, "/v1/treasury/transactions": { "get": { "description": "

Retrieves a list of Transaction objects.

", "operationId": "GetTreasuryTransactions", "parameters": [ { "description": "Only return Transactions that were created during the given date interval.", "explode": true, "in": "query", "name": "created", "required": false, "schema": { "anyOf": [ { "properties": { "gt": { "type": "integer" }, "gte": { "type": "integer" }, "lt": { "type": "integer" }, "lte": { "type": "integer" } }, "title": "range_query_specs", "type": "object" }, { "type": "integer" } ] }, "style": "deepObject" }, { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "Returns objects associated with this FinancialAccount.", "in": "query", "name": "financial_account", "required": true, "schema": { "type": "string" }, "style": "form" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "description": "The results are in reverse chronological order by `created` or `posted_at`. The default is `created`.", "in": "query", "name": "order_by", "required": false, "schema": { "enum": [ "created", "posted_at" ], "type": "string", "x-stripeBypassValidation": true }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Only return Transactions that have the given status: `open`, `posted`, or `void`.", "in": "query", "name": "status", "required": false, "schema": { "enum": [ "open", "posted", "void" ], "type": "string" }, "style": "form" }, { "description": "A filter for the `status_transitions.posted_at` timestamp. When using this filter, `status=posted` and `order_by=posted_at` must also be specified.", "explode": true, "in": "query", "name": "status_transitions", "required": false, "schema": { "properties": { "posted_at": { "anyOf": [ { "properties": { "gt": { "type": "integer" }, "gte": { "type": "integer" }, "lt": { "type": "integer" }, "lte": { "type": "integer" } }, "title": "range_query_specs", "type": "object" }, { "type": "integer" } ] } }, "title": "status_transition_timestamp_specs", "type": "object" }, "style": "deepObject" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "description": "Details about each object.", "items": { "$ref": "#/components/schemas/treasury.transaction" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "TreasuryTransactionsResourceTransactionList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all Transactions" } }, "/v1/treasury/transactions/{id}": { "get": { "description": "

Retrieves the details of an existing Transaction.

", "operationId": "GetTreasuryTransactionsId", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "id", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/treasury.transaction" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a Transaction" } }, "/v1/webhook_endpoints": { "get": { "description": "

Returns a list of your webhook endpoints.

", "operationId": "GetWebhookEndpoints", "parameters": [ { "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.", "in": "query", "name": "ending_before", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" }, "style": "form" }, { "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.", "in": "query", "name": "starting_after", "required": false, "schema": { "maxLength": 5000, "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "data": { "items": { "$ref": "#/components/schemas/webhook_endpoint" }, "type": "array" }, "has_more": { "description": "True if this list has another page of items after this one that can be fetched.", "type": "boolean" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", "enum": [ "list" ], "type": "string" }, "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, "pattern": "^/v1/webhook_endpoints", "type": "string" } }, "required": [ "data", "has_more", "object", "url" ], "title": "NotificationWebhookEndpointList", "type": "object", "x-expandableFields": [ "data" ] } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "List all webhook endpoints" }, "post": { "description": "

A webhook endpoint must have a url and a list of enabled_events. You may optionally specify the Boolean connect parameter. If set to true, then a Connect webhook endpoint that notifies the specified url about events from all connected accounts is created; otherwise an account webhook endpoint that notifies the specified url only about events from your account is created. You can also create webhook endpoints in the webhooks settings section of the Dashboard.

", "operationId": "PostWebhookEndpoints", "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "description": { "explode": true, "style": "deepObject" }, "enabled_events": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "api_version": { "description": "Events sent to this endpoint will be generated with this Stripe Version instead of your account's default Stripe Version.", "enum": [ "2011-01-01", "2011-06-21", "2011-06-28", "2011-08-01", "2011-09-15", "2011-11-17", "2012-02-23", "2012-03-25", "2012-06-18", "2012-06-28", "2012-07-09", "2012-09-24", "2012-10-26", "2012-11-07", "2013-02-11", "2013-02-13", "2013-07-05", "2013-08-12", "2013-08-13", "2013-10-29", "2013-12-03", "2014-01-31", "2014-03-13", "2014-03-28", "2014-05-19", "2014-06-13", "2014-06-17", "2014-07-22", "2014-07-26", "2014-08-04", "2014-08-20", "2014-09-08", "2014-10-07", "2014-11-05", "2014-11-20", "2014-12-08", "2014-12-17", "2014-12-22", "2015-01-11", "2015-01-26", "2015-02-10", "2015-02-16", "2015-02-18", "2015-03-24", "2015-04-07", "2015-06-15", "2015-07-07", "2015-07-13", "2015-07-28", "2015-08-07", "2015-08-19", "2015-09-03", "2015-09-08", "2015-09-23", "2015-10-01", "2015-10-12", "2015-10-16", "2016-02-03", "2016-02-19", "2016-02-22", "2016-02-23", "2016-02-29", "2016-03-07", "2016-06-15", "2016-07-06", "2016-10-19", "2017-01-27", "2017-02-14", "2017-04-06", "2017-05-25", "2017-06-05", "2017-08-15", "2017-12-14", "2018-01-23", "2018-02-05", "2018-02-06", "2018-02-28", "2018-05-21", "2018-07-27", "2018-08-23", "2018-09-06", "2018-09-24", "2018-10-31", "2018-11-08", "2019-02-11", "2019-02-19", "2019-03-14", "2019-05-16", "2019-08-14", "2019-09-09", "2019-10-08", "2019-10-17", "2019-11-05", "2019-12-03", "2020-03-02", "2020-08-27", "2022-08-01", "2022-11-15", "2023-08-16", "2023-10-16", "2024-04-10", "2024-06-20", "2024-09-30.acacia", "2024-10-28.acacia", "2024-11-20.acacia", "2024-12-18.acacia", "2025-01-27.acacia", "2025-02-24.acacia", "2025-03-01.dashboard", "2025-03-31.basil", "2025-04-30.basil", "2025-05-28.basil", "2025-06-30.basil", "2025-07-30.basil", "2025-08-27.basil" ], "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true }, "connect": { "description": "Whether this endpoint should receive events from connected accounts (`true`), or from your account (`false`). Defaults to `false`.", "type": "boolean" }, "description": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "An optional description of what the webhook is used for." }, "enabled_events": { "description": "The list of events to enable for this endpoint. You may specify `['*']` to enable all events, except those that require explicit selection.", "items": { "enum": [ "*", "account.application.authorized", "account.application.deauthorized", "account.external_account.created", "account.external_account.deleted", "account.external_account.updated", "account.updated", "application_fee.created", "application_fee.refund.updated", "application_fee.refunded", "balance.available", "billing.alert.triggered", "billing_portal.configuration.created", "billing_portal.configuration.updated", "billing_portal.session.created", "capability.updated", "cash_balance.funds_available", "charge.captured", "charge.dispute.closed", "charge.dispute.created", "charge.dispute.funds_reinstated", "charge.dispute.funds_withdrawn", "charge.dispute.updated", "charge.expired", "charge.failed", "charge.pending", "charge.refund.updated", "charge.refunded", "charge.succeeded", "charge.updated", "checkout.session.async_payment_failed", "checkout.session.async_payment_succeeded", "checkout.session.completed", "checkout.session.expired", "climate.order.canceled", "climate.order.created", "climate.order.delayed", "climate.order.delivered", "climate.order.product_substituted", "climate.product.created", "climate.product.pricing_updated", "coupon.created", "coupon.deleted", "coupon.updated", "credit_note.created", "credit_note.updated", "credit_note.voided", "customer.created", "customer.deleted", "customer.discount.created", "customer.discount.deleted", "customer.discount.updated", "customer.source.created", "customer.source.deleted", "customer.source.expiring", "customer.source.updated", "customer.subscription.created", "customer.subscription.deleted", "customer.subscription.paused", "customer.subscription.pending_update_applied", "customer.subscription.pending_update_expired", "customer.subscription.resumed", "customer.subscription.trial_will_end", "customer.subscription.updated", "customer.tax_id.created", "customer.tax_id.deleted", "customer.tax_id.updated", "customer.updated", "customer_cash_balance_transaction.created", "entitlements.active_entitlement_summary.updated", "file.created", "financial_connections.account.created", "financial_connections.account.deactivated", "financial_connections.account.disconnected", "financial_connections.account.reactivated", "financial_connections.account.refreshed_balance", "financial_connections.account.refreshed_ownership", "financial_connections.account.refreshed_transactions", "identity.verification_session.canceled", "identity.verification_session.created", "identity.verification_session.processing", "identity.verification_session.redacted", "identity.verification_session.requires_input", "identity.verification_session.verified", "invoice.created", "invoice.deleted", "invoice.finalization_failed", "invoice.finalized", "invoice.marked_uncollectible", "invoice.overdue", "invoice.overpaid", "invoice.paid", "invoice.payment_action_required", "invoice.payment_failed", "invoice.payment_succeeded", "invoice.sent", "invoice.upcoming", "invoice.updated", "invoice.voided", "invoice.will_be_due", "invoice_payment.paid", "invoiceitem.created", "invoiceitem.deleted", "issuing_authorization.created", "issuing_authorization.request", "issuing_authorization.updated", "issuing_card.created", "issuing_card.updated", "issuing_cardholder.created", "issuing_cardholder.updated", "issuing_dispute.closed", "issuing_dispute.created", "issuing_dispute.funds_reinstated", "issuing_dispute.funds_rescinded", "issuing_dispute.submitted", "issuing_dispute.updated", "issuing_personalization_design.activated", "issuing_personalization_design.deactivated", "issuing_personalization_design.rejected", "issuing_personalization_design.updated", "issuing_token.created", "issuing_token.updated", "issuing_transaction.created", "issuing_transaction.purchase_details_receipt_updated", "issuing_transaction.updated", "mandate.updated", "payment_intent.amount_capturable_updated", "payment_intent.canceled", "payment_intent.created", "payment_intent.partially_funded", "payment_intent.payment_failed", "payment_intent.processing", "payment_intent.requires_action", "payment_intent.succeeded", "payment_link.created", "payment_link.updated", "payment_method.attached", "payment_method.automatically_updated", "payment_method.detached", "payment_method.updated", "payout.canceled", "payout.created", "payout.failed", "payout.paid", "payout.reconciliation_completed", "payout.updated", "person.created", "person.deleted", "person.updated", "plan.created", "plan.deleted", "plan.updated", "price.created", "price.deleted", "price.updated", "product.created", "product.deleted", "product.updated", "promotion_code.created", "promotion_code.updated", "quote.accepted", "quote.canceled", "quote.created", "quote.finalized", "radar.early_fraud_warning.created", "radar.early_fraud_warning.updated", "refund.created", "refund.failed", "refund.updated", "reporting.report_run.failed", "reporting.report_run.succeeded", "reporting.report_type.updated", "review.closed", "review.opened", "setup_intent.canceled", "setup_intent.created", "setup_intent.requires_action", "setup_intent.setup_failed", "setup_intent.succeeded", "sigma.scheduled_query_run.created", "source.canceled", "source.chargeable", "source.failed", "source.mandate_notification", "source.refund_attributes_required", "source.transaction.created", "source.transaction.updated", "subscription_schedule.aborted", "subscription_schedule.canceled", "subscription_schedule.completed", "subscription_schedule.created", "subscription_schedule.expiring", "subscription_schedule.released", "subscription_schedule.updated", "tax.settings.updated", "tax_rate.created", "tax_rate.updated", "terminal.reader.action_failed", "terminal.reader.action_succeeded", "terminal.reader.action_updated", "test_helpers.test_clock.advancing", "test_helpers.test_clock.created", "test_helpers.test_clock.deleted", "test_helpers.test_clock.internal_failure", "test_helpers.test_clock.ready", "topup.canceled", "topup.created", "topup.failed", "topup.reversed", "topup.succeeded", "transfer.created", "transfer.reversed", "transfer.updated", "treasury.credit_reversal.created", "treasury.credit_reversal.posted", "treasury.debit_reversal.completed", "treasury.debit_reversal.created", "treasury.debit_reversal.initial_credit_granted", "treasury.financial_account.closed", "treasury.financial_account.created", "treasury.financial_account.features_status_updated", "treasury.inbound_transfer.canceled", "treasury.inbound_transfer.created", "treasury.inbound_transfer.failed", "treasury.inbound_transfer.succeeded", "treasury.outbound_payment.canceled", "treasury.outbound_payment.created", "treasury.outbound_payment.expected_arrival_date_updated", "treasury.outbound_payment.failed", "treasury.outbound_payment.posted", "treasury.outbound_payment.returned", "treasury.outbound_payment.tracking_details_updated", "treasury.outbound_transfer.canceled", "treasury.outbound_transfer.created", "treasury.outbound_transfer.expected_arrival_date_updated", "treasury.outbound_transfer.failed", "treasury.outbound_transfer.posted", "treasury.outbound_transfer.returned", "treasury.outbound_transfer.tracking_details_updated", "treasury.received_credit.created", "treasury.received_credit.failed", "treasury.received_credit.succeeded", "treasury.received_debit.created" ], "type": "string", "x-stripeBypassValidation": true }, "type": "array" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "url": { "description": "The URL of the webhook endpoint.", "type": "string" } }, "required": [ "enabled_events", "url" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_endpoint" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Create a webhook endpoint" } }, "/v1/webhook_endpoints/{webhook_endpoint}": { "delete": { "description": "

You can also delete webhook endpoints via the webhook endpoint management page of the Stripe dashboard.

", "operationId": "DeleteWebhookEndpointsWebhookEndpoint", "parameters": [ { "in": "path", "name": "webhook_endpoint", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted_webhook_endpoint" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Delete a webhook endpoint" }, "get": { "description": "

Retrieves the webhook endpoint with the given ID.

", "operationId": "GetWebhookEndpointsWebhookEndpoint", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", "explode": true, "in": "query", "name": "expand", "required": false, "schema": { "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "style": "deepObject" }, { "in": "path", "name": "webhook_endpoint", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_endpoint" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Retrieve a webhook endpoint" }, "post": { "description": "

Updates the webhook endpoint. You may edit the url, the list of enabled_events, and the status of your endpoint.

", "operationId": "PostWebhookEndpointsWebhookEndpoint", "parameters": [ { "in": "path", "name": "webhook_endpoint", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { "description": { "explode": true, "style": "deepObject" }, "enabled_events": { "explode": true, "style": "deepObject" }, "expand": { "explode": true, "style": "deepObject" }, "metadata": { "explode": true, "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { "description": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "enum": [ "" ], "type": "string" } ], "description": "An optional description of what the webhook is used for." }, "disabled": { "description": "Disable the webhook endpoint if set to true.", "type": "boolean" }, "enabled_events": { "description": "The list of events to enable for this endpoint. You may specify `['*']` to enable all events, except those that require explicit selection.", "items": { "enum": [ "*", "account.application.authorized", "account.application.deauthorized", "account.external_account.created", "account.external_account.deleted", "account.external_account.updated", "account.updated", "application_fee.created", "application_fee.refund.updated", "application_fee.refunded", "balance.available", "billing.alert.triggered", "billing_portal.configuration.created", "billing_portal.configuration.updated", "billing_portal.session.created", "capability.updated", "cash_balance.funds_available", "charge.captured", "charge.dispute.closed", "charge.dispute.created", "charge.dispute.funds_reinstated", "charge.dispute.funds_withdrawn", "charge.dispute.updated", "charge.expired", "charge.failed", "charge.pending", "charge.refund.updated", "charge.refunded", "charge.succeeded", "charge.updated", "checkout.session.async_payment_failed", "checkout.session.async_payment_succeeded", "checkout.session.completed", "checkout.session.expired", "climate.order.canceled", "climate.order.created", "climate.order.delayed", "climate.order.delivered", "climate.order.product_substituted", "climate.product.created", "climate.product.pricing_updated", "coupon.created", "coupon.deleted", "coupon.updated", "credit_note.created", "credit_note.updated", "credit_note.voided", "customer.created", "customer.deleted", "customer.discount.created", "customer.discount.deleted", "customer.discount.updated", "customer.source.created", "customer.source.deleted", "customer.source.expiring", "customer.source.updated", "customer.subscription.created", "customer.subscription.deleted", "customer.subscription.paused", "customer.subscription.pending_update_applied", "customer.subscription.pending_update_expired", "customer.subscription.resumed", "customer.subscription.trial_will_end", "customer.subscription.updated", "customer.tax_id.created", "customer.tax_id.deleted", "customer.tax_id.updated", "customer.updated", "customer_cash_balance_transaction.created", "entitlements.active_entitlement_summary.updated", "file.created", "financial_connections.account.created", "financial_connections.account.deactivated", "financial_connections.account.disconnected", "financial_connections.account.reactivated", "financial_connections.account.refreshed_balance", "financial_connections.account.refreshed_ownership", "financial_connections.account.refreshed_transactions", "identity.verification_session.canceled", "identity.verification_session.created", "identity.verification_session.processing", "identity.verification_session.redacted", "identity.verification_session.requires_input", "identity.verification_session.verified", "invoice.created", "invoice.deleted", "invoice.finalization_failed", "invoice.finalized", "invoice.marked_uncollectible", "invoice.overdue", "invoice.overpaid", "invoice.paid", "invoice.payment_action_required", "invoice.payment_failed", "invoice.payment_succeeded", "invoice.sent", "invoice.upcoming", "invoice.updated", "invoice.voided", "invoice.will_be_due", "invoice_payment.paid", "invoiceitem.created", "invoiceitem.deleted", "issuing_authorization.created", "issuing_authorization.request", "issuing_authorization.updated", "issuing_card.created", "issuing_card.updated", "issuing_cardholder.created", "issuing_cardholder.updated", "issuing_dispute.closed", "issuing_dispute.created", "issuing_dispute.funds_reinstated", "issuing_dispute.funds_rescinded", "issuing_dispute.submitted", "issuing_dispute.updated", "issuing_personalization_design.activated", "issuing_personalization_design.deactivated", "issuing_personalization_design.rejected", "issuing_personalization_design.updated", "issuing_token.created", "issuing_token.updated", "issuing_transaction.created", "issuing_transaction.purchase_details_receipt_updated", "issuing_transaction.updated", "mandate.updated", "payment_intent.amount_capturable_updated", "payment_intent.canceled", "payment_intent.created", "payment_intent.partially_funded", "payment_intent.payment_failed", "payment_intent.processing", "payment_intent.requires_action", "payment_intent.succeeded", "payment_link.created", "payment_link.updated", "payment_method.attached", "payment_method.automatically_updated", "payment_method.detached", "payment_method.updated", "payout.canceled", "payout.created", "payout.failed", "payout.paid", "payout.reconciliation_completed", "payout.updated", "person.created", "person.deleted", "person.updated", "plan.created", "plan.deleted", "plan.updated", "price.created", "price.deleted", "price.updated", "product.created", "product.deleted", "product.updated", "promotion_code.created", "promotion_code.updated", "quote.accepted", "quote.canceled", "quote.created", "quote.finalized", "radar.early_fraud_warning.created", "radar.early_fraud_warning.updated", "refund.created", "refund.failed", "refund.updated", "reporting.report_run.failed", "reporting.report_run.succeeded", "reporting.report_type.updated", "review.closed", "review.opened", "setup_intent.canceled", "setup_intent.created", "setup_intent.requires_action", "setup_intent.setup_failed", "setup_intent.succeeded", "sigma.scheduled_query_run.created", "source.canceled", "source.chargeable", "source.failed", "source.mandate_notification", "source.refund_attributes_required", "source.transaction.created", "source.transaction.updated", "subscription_schedule.aborted", "subscription_schedule.canceled", "subscription_schedule.completed", "subscription_schedule.created", "subscription_schedule.expiring", "subscription_schedule.released", "subscription_schedule.updated", "tax.settings.updated", "tax_rate.created", "tax_rate.updated", "terminal.reader.action_failed", "terminal.reader.action_succeeded", "terminal.reader.action_updated", "test_helpers.test_clock.advancing", "test_helpers.test_clock.created", "test_helpers.test_clock.deleted", "test_helpers.test_clock.internal_failure", "test_helpers.test_clock.ready", "topup.canceled", "topup.created", "topup.failed", "topup.reversed", "topup.succeeded", "transfer.created", "transfer.reversed", "transfer.updated", "treasury.credit_reversal.created", "treasury.credit_reversal.posted", "treasury.debit_reversal.completed", "treasury.debit_reversal.created", "treasury.debit_reversal.initial_credit_granted", "treasury.financial_account.closed", "treasury.financial_account.created", "treasury.financial_account.features_status_updated", "treasury.inbound_transfer.canceled", "treasury.inbound_transfer.created", "treasury.inbound_transfer.failed", "treasury.inbound_transfer.succeeded", "treasury.outbound_payment.canceled", "treasury.outbound_payment.created", "treasury.outbound_payment.expected_arrival_date_updated", "treasury.outbound_payment.failed", "treasury.outbound_payment.posted", "treasury.outbound_payment.returned", "treasury.outbound_payment.tracking_details_updated", "treasury.outbound_transfer.canceled", "treasury.outbound_transfer.created", "treasury.outbound_transfer.expected_arrival_date_updated", "treasury.outbound_transfer.failed", "treasury.outbound_transfer.posted", "treasury.outbound_transfer.returned", "treasury.outbound_transfer.tracking_details_updated", "treasury.received_credit.created", "treasury.received_credit.failed", "treasury.received_credit.succeeded", "treasury.received_debit.created" ], "type": "string", "x-stripeBypassValidation": true }, "type": "array" }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "enum": [ "" ], "type": "string" } ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`." }, "url": { "description": "The URL of the webhook endpoint.", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_endpoint" } } }, "description": "Successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } }, "description": "Error response." } }, "summary": "Update a webhook endpoint" } } }, "security": [ { "basicAuth": [] }, { "bearerAuth": [] } ], "servers": [ { "url": "https://api.stripe.com/" } ] }stripe-mock-0.196.0/generator/000077500000000000000000000000001506013555700161215ustar00rootroot00000000000000stripe-mock-0.196.0/generator/datareplacer/000077500000000000000000000000001506013555700205505ustar00rootroot00000000000000stripe-mock-0.196.0/generator/datareplacer/datareplacer.go000066400000000000000000000152241506013555700235320ustar00rootroot00000000000000package datareplacer import ( "fmt" "reflect" "strings" "github.com/stripe/stripe-mock/spec" ) // DataReplacer takes a generated response and replaces values in it that share // a name and type of parameters that were sent in with the request, as // determined by the associated OpenAPI schema and the types of incoming // values. // // This is designed to have the effect of making returned fixtures more // realistic while also staying a simple heuristic that doesn't require very // much maintenance. type DataReplacer struct { Definitions map[string]*spec.Schema Schema *spec.Schema } // ReplaceData projects data from the incoming request into response data as // appropriate. func (r *DataReplacer) ReplaceData(requestData map[string]interface{}, responseData map[string]interface{}) map[string]interface{} { schema := r.Schema if schema != nil { schema, _ = r.maybeDereference(r.Schema, "") } return r.replaceDataInternal(requestData, responseData, schema) } // Identical to the above except that we pass a schema as argument so that we // can easily have the relevant one during recursion. func (r *DataReplacer) replaceDataInternal(requestData map[string]interface{}, responseData map[string]interface{}, schema *spec.Schema) map[string]interface{} { for k, requestValue := range requestData { responseValue, ok := responseData[k] // Recursively call in to replace data, but only if the key is // in both maps. // // A fairly obvious improvement here is if a key is in the // request but not present in the response, then check the // canonical schema to see if it's there. It might be an // optional field that doesn't appear in the fixture, and if it // was given to us with the request, we probably want to // include it. if ok { requestKeyMap, requestKeyOK := requestValue.(map[string]interface{}) responseKeyMap, responseKeyOK := responseValue.(map[string]interface{}) var kSchema *spec.Schema if schema != nil { kSchema = schema.Properties[k] if kSchema != nil { kSchema, _ = r.maybeDereference(kSchema, "") } } if requestKeyOK && responseKeyOK { responseData[k] = r.replaceDataInternal(requestKeyMap, responseKeyMap, kSchema) } else { // In the non-map case, just set the respons key's value to // what was in the request, but only if both values are the // same type (this is to prevent problems where a field is set // as an ID, but the response field is the hydrated object of // that). // // While this will largely be "good enough", there's some // obvious cases that aren't going to be handled correctly like // index-based array updates (e.g., // `additional_owners[1][name]=...`). I'll have to iron out // that rough edges later on. if r.isSameType(kSchema, requestValue) { responseData[k] = requestValue } } } } return responseData } func (r *DataReplacer) isSameType(schema *spec.Schema, requestValue interface{}) bool { if schema == nil { return false } value := reflect.ValueOf(requestValue) // Reflect in Go has the concept of a "zero Value" (not be confused with a // type's zero value with a lowercase "v") and asking for Type on one will // panic. I'm not exactly sure under what conditions these are generated, // but they are occasionally, so here we hedge against them. // // https://github.com/stripe/stripe-mock/issues/75 if !value.IsValid() { return false } valueType := value.Type() valueKind := valueType.Kind() switch { // In the case of `anyOf`, allow replacement if any of the schema branches apply. case len(schema.AnyOf) > 0: for _, anyOfSchema := range schema.AnyOf { anyOfSchema, _ := r.maybeDereference(anyOfSchema, "") if r.isSameType(anyOfSchema, requestValue) { return true } } case schema.Type == spec.TypeArray: valueSlice, ok := requestValue.([]interface{}) // Incoming value is not an array if !ok { return false } // Allow the replacement if completely empty. In practice, this // should never happen because you can't send an empty array via // form data, but we'll cover the case anyway. if len(valueSlice) < 1 { return true } itemsSchema := schema.Items if itemsSchema == nil { return true } itemsSchema, _ = r.maybeDereference(itemsSchema, "") // Allow the replacement if the first item in the incoming slice is // compatible with the array's `items` schema. return r.isSameType(itemsSchema, valueSlice[0]) case schema.Type == spec.TypeBoolean: return valueKind == reflect.Bool case schema.Type == spec.TypeInteger: return isIntegerKind(valueKind) case schema.Type == spec.TypeNumber: return isIntegerKind(valueKind) || valueKind == reflect.Float32 || valueKind == reflect.Float64 // Don't try to replace objects for now, the likelihood is that they're // not compatible between request and response anyway. case schema.Type == spec.TypeObject: return false case schema.Type == spec.TypeString: return valueKind == reflect.String default: panic(fmt.Sprintf("Data replacer doesn't know how to handle schema: %+v", schema)) } // Unreachable because of `default` above return false } func (r *DataReplacer) maybeDereference(schema *spec.Schema, context string) (*spec.Schema, string) { if schema.Ref != "" { definition := definitionFromJSONPointer(schema.Ref) newSchema, ok := r.Definitions[definition] if !ok { panic(fmt.Sprintf("Couldn't dereference: %v", schema.Ref)) } context = fmt.Sprintf("%sDereferencing '%s':\n", context, schema.Ref) schema = newSchema } return schema, context } // definitionFromJSONPointer extracts the name of a JSON schema definition from // a JSON pointer, so "#/components/schemas/charge" would become just "charge". // This is a simplified workaround to avoid bringing in JSON schema // infrastructure because we can guarantee that the spec we're producing will // take a certain shape. If this gets too hacky, it will be better to put a more // legitimate JSON schema parser in place. func definitionFromJSONPointer(pointer string) string { parts := strings.Split(pointer, "/") if len(parts) != 4 || parts[0] != "#" || parts[1] != "components" || parts[2] != "schemas" { panic(fmt.Sprintf("Expected '#/components/schemas/...' but got '%v'", pointer)) } return parts[3] } func isIntegerKind(kind reflect.Kind) bool { switch kind { case reflect.Int: return true case reflect.Int8: return true case reflect.Int16: return true case reflect.Int32: return true case reflect.Int64: return true case reflect.Uint: return true case reflect.Uint8: return true case reflect.Uint16: return true case reflect.Uint32: return true case reflect.Uint64: return true } return false } stripe-mock-0.196.0/generator/datareplacer/datareplacer_test.go000066400000000000000000000154221506013555700245710ustar00rootroot00000000000000package datareplacer import ( "testing" assert "github.com/stretchr/testify/require" "github.com/stripe/stripe-mock/spec" ) // // Tests // func TestReplaceData_AnyOf(t *testing.T) { replacer := DataReplacer{Schema: &spec.Schema{ Properties: map[string]*spec.Schema{ "foo": { AnyOf: []*spec.Schema{ { Type: spec.TypeString, }, }, }, }, }} // Incoming matching value (string, which is part of `AnyOf`) { responseData := map[string]interface{}{ "foo": "response", } replacer.ReplaceData(map[string]interface{}{ "foo": "request", }, responseData) assert.Equal(t, map[string]interface{}{ "foo": "request", }, responseData) } // Incoming non-matching value { responseData := map[string]interface{}{ "foo": "response", } replacer.ReplaceData(map[string]interface{}{ "foo": 123, }, responseData) assert.Equal(t, map[string]interface{}{ "foo": "response", }, responseData) } } func TestReplaceData_Array(t *testing.T) { replacer := DataReplacer{Schema: &spec.Schema{ Properties: map[string]*spec.Schema{ "foo": { Items: &spec.Schema{ Type: spec.TypeString, }, Type: spec.TypeArray, }, }, }} // Incoming matching array { responseData := map[string]interface{}{ "foo": []interface{}{"response"}, } replacer.ReplaceData(map[string]interface{}{ "foo": []interface{}{"request"}, }, responseData) assert.Equal(t, map[string]interface{}{ "foo": []interface{}{"request"}, }, responseData) } // Incoming non-array { responseData := map[string]interface{}{ "foo": []interface{}{"response"}, } replacer.ReplaceData(map[string]interface{}{ "foo": "hello", }, responseData) assert.Equal(t, map[string]interface{}{ "foo": []interface{}{"response"}, }, responseData) } // Incoming array, but wrong element type { responseData := map[string]interface{}{ "foo": []interface{}{"response"}, } replacer.ReplaceData(map[string]interface{}{ "foo": []interface{}{123}, }, responseData) assert.Equal(t, map[string]interface{}{ "foo": []interface{}{"response"}, }, responseData) } // Incoming empty array is allowed to replace { responseData := map[string]interface{}{ "foo": []interface{}{"response"}, } replacer.ReplaceData(map[string]interface{}{ "foo": []interface{}{}, }, responseData) assert.Equal(t, map[string]interface{}{ "foo": []interface{}{}, }, responseData) } } func TestReplaceData_Boolean(t *testing.T) { replacer := DataReplacer{Schema: &spec.Schema{ Properties: map[string]*spec.Schema{ "foo": { Type: spec.TypeBoolean, }, }, }} // Incoming boolean { responseData := map[string]interface{}{ "foo": false, } replacer.ReplaceData(map[string]interface{}{ "foo": true, }, responseData) assert.Equal(t, map[string]interface{}{ "foo": true, }, responseData) } // Incoming non-boolean { responseData := map[string]interface{}{ "foo": false, } replacer.ReplaceData(map[string]interface{}{ "foo": "hello", }, responseData) assert.Equal(t, map[string]interface{}{ "foo": false, }, responseData) } } func TestReplaceData_Integer(t *testing.T) { replacer := DataReplacer{Schema: &spec.Schema{ Properties: map[string]*spec.Schema{ "foo": { Type: spec.TypeInteger, }, }, }} // Incoming integer { responseData := map[string]interface{}{ "foo": 123, } replacer.ReplaceData(map[string]interface{}{ "foo": 456, }, responseData) assert.Equal(t, map[string]interface{}{ "foo": 456, }, responseData) } // Incoming non-integer { responseData := map[string]interface{}{ "foo": 123, } replacer.ReplaceData(map[string]interface{}{ "foo": "hello", }, responseData) assert.Equal(t, map[string]interface{}{ "foo": 123, }, responseData) } } func TestReplaceData_Number(t *testing.T) { replacer := DataReplacer{Schema: &spec.Schema{ Properties: map[string]*spec.Schema{ "foo": { Type: spec.TypeNumber, }, }, }} // Incoming number { responseData := map[string]interface{}{ "foo": 1.23, } replacer.ReplaceData(map[string]interface{}{ "foo": 4.56, }, responseData) assert.Equal(t, map[string]interface{}{ "foo": 4.56, }, responseData) } // Incoming non-number { responseData := map[string]interface{}{ "foo": 1.23, } replacer.ReplaceData(map[string]interface{}{ "foo": "hello", }, responseData) assert.Equal(t, map[string]interface{}{ "foo": 1.23, }, responseData) } } func TestReplaceData_String(t *testing.T) { replacer := DataReplacer{Schema: &spec.Schema{ Properties: map[string]*spec.Schema{ "foo": { Type: spec.TypeString, }, }, }} // Incoming string { responseData := map[string]interface{}{ "foo": "response", } replacer.ReplaceData(map[string]interface{}{ "foo": "request", }, responseData) assert.Equal(t, map[string]interface{}{ "foo": "request", }, responseData) } // Incoming non-string { responseData := map[string]interface{}{ "foo": "response", } replacer.ReplaceData(map[string]interface{}{ "foo": 123, }, responseData) assert.Equal(t, map[string]interface{}{ "foo": "response", }, responseData) } } func TestReplaceData_Deferences(t *testing.T) { replacer := DataReplacer{ Definitions: map[string]*spec.Schema{ "foo_object": { Type: spec.TypeString, }, }, Schema: &spec.Schema{ Properties: map[string]*spec.Schema{ "foo": { Ref: "#/definitions/foo_object", }, }, }, } responseData := map[string]interface{}{ "bar": "response", } replacer.ReplaceData(map[string]interface{}{ "bar": "request", }, responseData) assert.Equal(t, map[string]interface{}{ "bar": "response", }, responseData) } func TestReplaceData_Nested(t *testing.T) { replacer := DataReplacer{Schema: &spec.Schema{ Properties: map[string]*spec.Schema{ "foo": { Properties: map[string]*spec.Schema{ "bar": { Type: spec.TypeString, }, }, }, }, }} responseData := map[string]interface{}{ "foo": map[string]interface{}{ "bar": "response", }, } replacer.ReplaceData(map[string]interface{}{ "foo": map[string]interface{}{ "bar": "request", }, }, responseData) assert.Equal(t, map[string]interface{}{ "foo": map[string]interface{}{ "bar": "request", }, }, responseData) } // Nothing gets replaced if we don't find the field in the schema. func TestReplaceData_NotInSchema(t *testing.T) { replacer := DataReplacer{Schema: &spec.Schema{ Properties: map[string]*spec.Schema{ "foo": { Type: spec.TypeString, }, }, }} responseData := map[string]interface{}{ "bar": "response", } replacer.ReplaceData(map[string]interface{}{ "bar": "request", }, responseData) assert.Equal(t, map[string]interface{}{ "bar": "response", }, responseData) } stripe-mock-0.196.0/go.mod000066400000000000000000000013231506013555700152400ustar00rootroot00000000000000module github.com/stripe/stripe-mock go 1.22.1 require ( github.com/davecgh/go-spew v0.0.0-20151105211317-5215b55f46b2 // indirect github.com/lestrrat-go/jspointer v0.0.0-20181205001929-82fadba7561c // indirect github.com/lestrrat-go/jsref v0.0.0-20181205001954-1b590508f37d // indirect github.com/lestrrat-go/jsschema v0.0.0-20181205002244-5c81c58ffcc3 github.com/lestrrat-go/jsval v0.0.0-20181205002323-20277e9befc0 github.com/lestrrat-go/pdebug v0.0.0-20180220043849-39f9a71bcabe // indirect github.com/lestrrat-go/structinfo v0.0.0-20190212233437-acd51874663b // indirect github.com/pkg/errors v0.8.1-0.20170505043639-c605e284fe17 // indirect github.com/stretchr/testify v0.0.0-20150620232711-089c7181b8c7 ) stripe-mock-0.196.0/go.sum000066400000000000000000000040511506013555700152660ustar00rootroot00000000000000github.com/davecgh/go-spew v0.0.0-20151105211317-5215b55f46b2 h1:5zdDAMuB3gvbHB1m2BZT9+t9w+xaBmK3ehb7skDXcwM= github.com/davecgh/go-spew v0.0.0-20151105211317-5215b55f46b2/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= github.com/lestrrat-go/jspointer v0.0.0-20181205001929-82fadba7561c h1:pGh5EFIfczeDHwgMHgfwjhZzL+8/E3uZF6T7vER/W8c= github.com/lestrrat-go/jspointer v0.0.0-20181205001929-82fadba7561c/go.mod h1:xw2Gm4Mg+ST9s8fHR1VkUIyOJMJnSloRZlPQB+wyVpY= github.com/lestrrat-go/jsref v0.0.0-20181205001954-1b590508f37d h1:1eeFdKL5ySmmYevvKv7iECIc4dTATeKTtBqP4/nXxDk= github.com/lestrrat-go/jsref v0.0.0-20181205001954-1b590508f37d/go.mod h1:h+r25adx46+IvUSt/rTTvXNnCDnu3lRTkMPPR/GdCwk= github.com/lestrrat-go/jsschema v0.0.0-20181205002244-5c81c58ffcc3 h1:TSKrrGm89gmmVlrG34ZzCIOMNVk5kkSV1P88Dt38DiE= github.com/lestrrat-go/jsschema v0.0.0-20181205002244-5c81c58ffcc3/go.mod h1:SVfIykmWQyFuRToBTKQ8AcveWeOunS2phYxA8hJ/6Gg= github.com/lestrrat-go/jsval v0.0.0-20181205002323-20277e9befc0 h1:w4rIjeCV/gQpxtn3i1voyF6Hd7v1mRGIB63F7RZOk1U= github.com/lestrrat-go/jsval v0.0.0-20181205002323-20277e9befc0/go.mod h1:hazjwMAn+trtmUnjvhIzSIZ0YS+2egAMonQMjDhcC2s= github.com/lestrrat-go/pdebug v0.0.0-20180220043849-39f9a71bcabe h1:S7XSBlgc/eI2v47LkPPVa+infH3FuTS4tPJbqCtJovo= github.com/lestrrat-go/pdebug v0.0.0-20180220043849-39f9a71bcabe/go.mod h1:zvUY6gZZVL2nu7NM+/3b51Z/hxyFZCZxV0hvfZ3NJlg= github.com/lestrrat-go/structinfo v0.0.0-20190212233437-acd51874663b h1:YUFRoeHK/mvRjBR0bBRDC7ZGygYchoQ8j1xMENlObro= github.com/lestrrat-go/structinfo v0.0.0-20190212233437-acd51874663b/go.mod h1:s2U6PowV3/Jobkx/S9d0XiPwOzs6niW3DIouw+7nZC8= github.com/pkg/errors v0.8.1-0.20170505043639-c605e284fe17 h1:+adyfd5YBtuLL2FbDEn0GitOinGeMH0levy3o62TMF0= github.com/pkg/errors v0.8.1-0.20170505043639-c605e284fe17/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0= github.com/stretchr/testify v0.0.0-20150620232711-089c7181b8c7 h1:XTgkE916dsAohkArYaNhG4OD76I7pHVQq+0PfdST/vA= github.com/stretchr/testify v0.0.0-20150620232711-089c7181b8c7/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs= stripe-mock-0.196.0/goreleaser.dockerfile000066400000000000000000000003411506013555700203120ustar00rootroot00000000000000# -*- mode: dockerfile -*- FROM alpine:latest RUN apk --no-cache add ca-certificates COPY stripe-mock /bin/stripe-mock ENTRYPOINT ["/bin/stripe-mock", "-http-port", "12111", "-https-port", "12112"] EXPOSE 12111 EXPOSE 12112 stripe-mock-0.196.0/goreleaser.yml000066400000000000000000000042761506013555700170170ustar00rootroot00000000000000project_name: stripe-mock before: hooks: - go get -u honnef.co/go/tools/cmd/staticcheck@latest - go install github.com/go-bindata/go-bindata/...@latest - go generate -mod=readonly - go mod vendor builds: - binary: stripe-mock env: - CGO_ENABLED=0 goos: - windows - darwin - linux goarch: - amd64 - arm64 snapshot: name_template: "{{ .Tag }}-next" archives: - format_overrides: - goos: windows format: zip brews: - tap: owner: stripe name: homebrew-stripe-mock homepage: "https://github.com/stripe/stripe-mock" description: "stripe-mock is a mock HTTP server that responds like the real Stripe API. It can be used instead of Stripe's testmode to make test suites integrating with Stripe faster and less brittle." commit_author: name: stripe-ci email: support@stripe.com service: | keep_alive successful_exit: false run [ opt_bin/"stripe-mock", "-http-port", "12111", "-https-port", "12112" ] working_dir var log_path var/"log/stripe-mock.log" error_log_path var/"log/stripe-mock.log" nfpms: - vendor: Stripe homepage: https://stripe.com maintainer: Stripe license: MIT formats: - deb - rpm dockers: - image_templates: - "stripe/stripe-mock:{{ .Tag }}-amd64" - "stripe/stripe-mock:latest-amd64" use: buildx goos: linux goarch: amd64 build_flag_templates: - "--platform=linux/amd64" dockerfile: goreleaser.dockerfile - image_templates: - "stripe/stripe-mock:{{ .Tag }}-arm64" - "stripe/stripe-mock:latest-arm64" use: buildx goos: linux goarch: arm64 build_flag_templates: - "--platform=linux/arm64" dockerfile: goreleaser.dockerfile docker_manifests: - name_template: "stripe/stripe-mock:{{ .Tag }}" image_templates: &image_templates - "stripe/stripe-mock:{{ .Tag }}-amd64" - "stripe/stripe-mock:{{ .Tag }}-arm64" - name_template: "stripe/stripe-mock:latest" image_templates: &image_templates - "stripe/stripe-mock:latest-amd64" - "stripe/stripe-mock:latest-arm64" stripe-mock-0.196.0/main.go000066400000000000000000000272511506013555700154150ustar00rootroot00000000000000package main import ( "crypto/tls" _ "embed" "flag" "fmt" "github.com/stripe/stripe-mock/embedded" "net" "net/http" "os" "strconv" "github.com/stripe/stripe-mock/server" ) const defaultPortHTTP = 12111 const defaultPortHTTPS = 12112 // verbose tracks whether the program is operating in verbose mode var verbose bool // This is set to the actual version by GoReleaser (using `-ldflags "-X ..."`) // as it's run. Versions built from source will always show master. var version = "master" // --- func main() { options := options{ httpPortDefault: defaultPortHTTP, httpsPortDefault: defaultPortHTTPS, } // As you can probably tell, there are just too many HTTP/HTTPS binding // options, which is a result of me not thinking through the original // interface well enough. // // I've left them all in place for now for backwards compatibility, but we // should probably deprecate `-http-port`, `-https-port`, `-port`, and // `-unix` in favor of the remaining more expressive and more versatile // alternatives. // // Eventually, `-http` and `-https` could become shorthand synonyms for // `-http-addr` and `-https-addr`. flag.BoolVar(&options.http, "http", false, "Run with HTTP") flag.StringVar(&options.httpAddr, "http-addr", "", fmt.Sprintf("Host and port to listen on for HTTP as `:`; empty to bind all system IPs, empty to have system choose; e.g. ':%v', '127.0.0.1:%v'", defaultPortHTTP, defaultPortHTTP)) flag.IntVar(&options.httpPort, "http-port", -1, "Port to listen on for HTTP; same as '-http-addr :'") flag.StringVar(&options.httpUnixSocket, "http-unix", "", "Unix socket to listen on for HTTP") flag.BoolVar(&options.https, "https", false, "Run with HTTPS; also enables HTTP/2") flag.StringVar(&options.httpsAddr, "https-addr", "", fmt.Sprintf("Host and port to listen on for HTTPS as `:`; empty to bind all system IPs, empty to have system choose; e.g. ':%v', '127.0.0.1:%v'", defaultPortHTTPS, defaultPortHTTPS)) flag.IntVar(&options.httpsPort, "https-port", -1, "Port to listen on for HTTPS; same as '-https-addr :'") flag.StringVar(&options.httpsUnixSocket, "https-unix", "", "Unix socket to listen on for HTTPS") flag.IntVar(&options.port, "port", -1, "Port to listen on; also respects PORT from environment") flag.StringVar(&options.fixturesPath, "fixtures", "", "Path to fixtures to use instead of bundled version (should be JSON)") flag.StringVar(&options.specPath, "spec", "", "Path to OpenAPI spec to use instead of bundled version (should be JSON)") flag.BoolVar(&options.strictVersionCheck, "strict-version-check", false, "Errors if version sent in Stripe-Version doesn't match the one in OpenAPI") flag.StringVar(&options.unixSocket, "unix", "", "Unix socket to listen on") flag.BoolVar(&verbose, "verbose", false, "Enable verbose mode") flag.BoolVar(&options.showVersion, "version", false, "Show version and exit") flag.BoolVar(&options.beta, "beta", false, "Run with beta OpenAPI spec and fixtures") flag.Parse() fmt.Printf("stripe-mock %s\n", version) if options.showVersion || len(flag.Args()) == 1 && flag.Arg(0) == "version" { return } err := options.checkConflictingOptions() if err != nil { flag.Usage() abort(fmt.Sprintf("Invalid options: %v", err)) } server.Version = version // For both spec and fixtures stripe-mock will by default load data from // internal assets compiled into the binary, but either one can be // overridden with a -spec or -fixtures argument and a path to a file. specBytes := embedded.OpenAPISpec fixtureBytes := embedded.OpenAPIFixtures if options.beta { specBytes = embedded.BetaOpenAPISpec fixtureBytes = embedded.BetaOpenAPIFixtures } stripeSpec, err := server.LoadSpec(specBytes, options.specPath) if err != nil { abort(err.Error()) } fixtures, err := server.LoadFixtures(fixtureBytes, options.fixturesPath) if err != nil { abort(err.Error()) } stub, err := server.NewStubServer(fixtures, stripeSpec, options.strictVersionCheck, verbose) if err != nil { abort(fmt.Sprintf("Error initializing router: %v\n", err)) } httpMux := http.NewServeMux() httpMux.HandleFunc("/", stub.HandleRequest) // Deduplicates doubled slashes in paths. e.g. `//v1/charges` becomes // `/v1/charges`. handler := &server.DoubleSlashFixHandler{Mux: httpMux} httpListener, err := options.getHTTPListener() if err != nil { abort(err.Error()) } // Only start HTTP if requested (it will activate by default with no arguments, but it won't start if // HTTPS is explicitly requested and HTTP is not). if httpListener != nil { server := http.Server{ Handler: handler, } // Listen in a new Goroutine that so we can start a simultaneous HTTPS // listener if necessary. go func() { err := server.Serve(httpListener) if err != nil { abort(err.Error()) } }() } httpsListener, err := options.getNonSecureHTTPSListener() if err != nil { abort(err.Error()) } // Only start HTTPS if requested (it will activate by default with no // arguments, but it won't start if HTTP is explicitly requested and HTTPS // is not). if httpsListener != nil { // Our self-signed certificate is bundled up using go:embed so that // it stays easy to distribute stripe-mock as a standalone binary with // no other dependencies. certificate, err := getTLSCertificate() if err != nil { abort(err.Error()) } tlsConfig := &tls.Config{ Certificates: []tls.Certificate{certificate}, // h2 is HTTP/2. A server with a default config normally doesn't // need this hint, but Go is somewhat inflexible, and we need this // here because we're using `Serve` and reading a TLS certificate // from memory instead of using `ServeTLS` which would've read a // certificate from file. NextProtos: []string{"h2"}, } server := http.Server{ Handler: handler, TLSConfig: tlsConfig, } tlsListener := tls.NewListener(httpsListener, tlsConfig) go func() { err := server.Serve(tlsListener) if err != nil { abort(err.Error()) } }() } // Block forever. The serve Goroutines above will abort the program if // either of them fails. select {} } // // Private types // // options is a container for the command line options passed to stripe-mock. type options struct { fixturesPath string http bool httpAddr string httpPortDefault int // For testability -- in practice always defaultPortHTTP httpPort int httpUnixSocket string https bool httpsAddr string httpsPortDefault int // For testability -- in practice always defaultPortHTTPS httpsPort int httpsUnixSocket string port int showVersion bool specPath string strictVersionCheck bool unixSocket string beta bool } func (o *options) checkConflictingOptions() error { if o.unixSocket != "" && o.port != -1 { return fmt.Errorf("Please specify only one of -port or -unix") } // // HTTP // if o.http && (o.httpUnixSocket != "" || o.httpAddr != "" || o.httpPort != -1) { return fmt.Errorf("Please don't specify -http when using -http-addr, -http-port, or -http-unix") } if (o.unixSocket != "" || o.port != -1) && (o.httpUnixSocket != "" || o.httpAddr != "" || o.httpPort != -1) { return fmt.Errorf("Please don't specify -port or -unix when using -http-addr, -http-port, or -http-unix") } var numHTTPOptions int if o.httpUnixSocket != "" { numHTTPOptions++ } if o.httpAddr != "" { numHTTPOptions++ } if o.httpPort != -1 { numHTTPOptions++ } if numHTTPOptions > 1 { return fmt.Errorf("Please specify only one of -http-addr, -http-port, or -http-unix") } // // HTTPS // if o.https && (o.httpsUnixSocket != "" || o.httpsAddr != "" || o.httpsPort != -1) { return fmt.Errorf("Please don't specify -https when using -https-addr, -https-port, or -https-unix") } if (o.unixSocket != "" || o.port != -1) && (o.httpsUnixSocket != "" || o.httpAddr != "" || o.httpsPort != -1) { return fmt.Errorf("Please don't specify -port or -unix when using -https-addr, -https-port, or -https-unix") } var numHTTPSOptions int if o.httpsUnixSocket != "" { numHTTPSOptions++ } if o.httpsAddr != "" { numHTTPSOptions++ } if o.httpsPort != -1 { numHTTPSOptions++ } if numHTTPSOptions > 1 { return fmt.Errorf("Please specify only one of -https-addr, -https-port, or -https-unix") } return nil } // getHTTPListener gets a listener on a port or unix socket depending on the // options provided. If HTTP should not be enabled, it returns nil. func (o *options) getHTTPListener() (net.Listener, error) { protocol := "HTTP" if o.httpAddr != "" { return getPortListener(o.httpAddr, protocol) } if o.httpPort != -1 { return getPortListener(fmt.Sprintf(":%v", o.httpPort), protocol) } if o.httpUnixSocket != "" { return getUnixSocketListener(o.httpUnixSocket, protocol) } // HTTPS is active by default, but only if HTTP has not been explicitly // activated. if o.https || o.httpsPort != -1 || o.httpsUnixSocket != "" { return nil, nil } if o.port != -1 { return getPortListener(fmt.Sprintf(":%v", o.port), protocol) } if o.unixSocket != "" { return getUnixSocketListener(o.unixSocket, protocol) } return getPortListenerDefault(o.httpPortDefault, protocol) } // getNonSecureHTTPSListener gets a basic listener on a port or unix socket // depending on the options provided. Its return listener must still be wrapped // in a TLSListener. If HTTPS should not be enabled, it returns nil. func (o *options) getNonSecureHTTPSListener() (net.Listener, error) { protocol := "HTTPS" if o.httpsAddr != "" { return getPortListener(o.httpsAddr, protocol) } if o.httpsPort != -1 { return getPortListener(fmt.Sprintf(":%v", o.httpsPort), protocol) } if o.httpsUnixSocket != "" { return getUnixSocketListener(o.httpsUnixSocket, protocol) } // HTTPS is active by default, but only if HTTP has not been explicitly // activated. HTTP may be activated with `-http`, `-http-port`, or // `-http-unix`, but also with the old backwards compatible basic `-port` // option. if o.http || o.httpPort != -1 || o.httpUnixSocket != "" || o.port != -1 { return nil, nil } if o.port != -1 { return getPortListener(fmt.Sprintf(":%v", o.port), protocol) } if o.unixSocket != "" { return getUnixSocketListener(o.unixSocket, protocol) } return getPortListenerDefault(o.httpsPortDefault, protocol) } // // Private functions // func abort(message string) { fmt.Fprint(os.Stderr, message) os.Exit(1) } // getTLSCertificate reads a certificate and key embedded into the binary func getTLSCertificate() (tls.Certificate, error) { return tls.X509KeyPair(embedded.CertCert, embedded.CertKey) } func getPortListener(addr string, protocol string) (net.Listener, error) { listener, err := net.Listen("tcp", addr) if err != nil { return nil, fmt.Errorf("error listening at address: %v", err) } fmt.Printf("Listening for %s at address: %v\n", protocol, listener.Addr()) return listener, nil } // getPortListenerDefault gets a port listener based on the environment // variable `PORT`, or falls back to a listener on the default port // (`defaultPort`) if one was not present. func getPortListenerDefault(defaultPort int, protocol string) (net.Listener, error) { if os.Getenv("PORT") != "" { envPort, err := strconv.Atoi(os.Getenv("PORT")) if err != nil { return nil, err } return getPortListener(fmt.Sprintf(":%v", envPort), protocol) } return getPortListener(fmt.Sprintf(":%v", defaultPort), protocol) } func getUnixSocketListener(unixSocket, protocol string) (net.Listener, error) { listener, err := net.Listen("unix", unixSocket) if err != nil { return nil, fmt.Errorf("error listening on socket: %v", err) } fmt.Printf("Listening for %s on Unix socket: %s\n", protocol, unixSocket) return listener, nil } stripe-mock-0.196.0/main_test.go000066400000000000000000000161361506013555700164540ustar00rootroot00000000000000package main import ( "fmt" "testing" assert "github.com/stretchr/testify/require" ) func getDefaultOptions() *options { return &options{ httpPort: -1, httpsPort: -1, port: -1, } } func TestCheckConflictingOptions(t *testing.T) { // // Valid sets of options (not exhaustive, but included quite a few standard invocations) // { options := getDefaultOptions() options.http = true err := options.checkConflictingOptions() assert.NoError(t, err) } { options := getDefaultOptions() options.https = true err := options.checkConflictingOptions() assert.NoError(t, err) } { options := getDefaultOptions() options.https = true options.port = 12111 err := options.checkConflictingOptions() assert.NoError(t, err) } { options := getDefaultOptions() options.httpPort = 12111 options.httpsPort = 12111 err := options.checkConflictingOptions() assert.NoError(t, err) } { options := getDefaultOptions() options.httpUnixSocket = "/tmp/stripe-mock.sock" options.httpsUnixSocket = "/tmp/stripe-mock-secure.sock" err := options.checkConflictingOptions() assert.NoError(t, err) } // // Non-specific // { options := getDefaultOptions() options.port = 12111 options.unixSocket = "/tmp/stripe-mock.sock" err := options.checkConflictingOptions() assert.Equal(t, fmt.Errorf("Please specify only one of -port or -unix"), err) } // // HTTP // { options := getDefaultOptions() options.http = true options.httpPort = 12111 err := options.checkConflictingOptions() assert.Equal(t, fmt.Errorf("Please don't specify -http when using -http-addr, -http-port, or -http-unix"), err) } { options := getDefaultOptions() options.http = true options.httpUnixSocket = "/tmp/stripe-mock.sock" err := options.checkConflictingOptions() assert.Equal(t, fmt.Errorf("Please don't specify -http when using -http-addr, -http-port, or -http-unix"), err) } { options := getDefaultOptions() options.port = 12111 options.httpPort = 12111 err := options.checkConflictingOptions() assert.Equal(t, fmt.Errorf("Please don't specify -port or -unix when using -http-addr, -http-port, or -http-unix"), err) } { options := getDefaultOptions() options.unixSocket = "/tmp/stripe-mock.sock" options.httpUnixSocket = "/tmp/stripe-mock.sock" err := options.checkConflictingOptions() assert.Equal(t, fmt.Errorf("Please don't specify -port or -unix when using -http-addr, -http-port, or -http-unix"), err) } { options := getDefaultOptions() options.httpAddr = "127.0.0.1:12111" options.httpUnixSocket = "/tmp/stripe-mock.sock" err := options.checkConflictingOptions() assert.Equal(t, fmt.Errorf("Please specify only one of -http-addr, -http-port, or -http-unix"), err) } { options := getDefaultOptions() options.httpPort = 12111 options.httpUnixSocket = "/tmp/stripe-mock.sock" err := options.checkConflictingOptions() assert.Equal(t, fmt.Errorf("Please specify only one of -http-addr, -http-port, or -http-unix"), err) } // // HTTPS // { options := getDefaultOptions() options.https = true options.httpsPort = 12111 err := options.checkConflictingOptions() assert.Equal(t, fmt.Errorf("Please don't specify -https when using -https-addr, -https-port, or -https-unix"), err) } { options := getDefaultOptions() options.https = true options.httpsUnixSocket = "/tmp/stripe-mock.sock" err := options.checkConflictingOptions() assert.Equal(t, fmt.Errorf("Please don't specify -https when using -https-addr, -https-port, or -https-unix"), err) } { options := getDefaultOptions() options.port = 12111 options.httpsPort = 12111 err := options.checkConflictingOptions() assert.Equal(t, fmt.Errorf("Please don't specify -port or -unix when using -https-addr, -https-port, or -https-unix"), err) } { options := getDefaultOptions() options.unixSocket = "/tmp/stripe-mock.sock" options.httpsUnixSocket = "/tmp/stripe-mock.sock" err := options.checkConflictingOptions() assert.Equal(t, fmt.Errorf("Please don't specify -port or -unix when using -https-addr, -https-port, or -https-unix"), err) } { options := getDefaultOptions() options.httpsAddr = "127.0.0.1:12111" options.httpsUnixSocket = "/tmp/stripe-mock.sock" err := options.checkConflictingOptions() assert.Equal(t, fmt.Errorf("Please specify only one of -https-addr, -https-port, or -https-unix"), err) } { options := getDefaultOptions() options.httpsPort = 12111 options.httpsUnixSocket = "/tmp/stripe-mock.sock" err := options.checkConflictingOptions() assert.Equal(t, fmt.Errorf("Please specify only one of -https-addr, -https-port, or -https-unix"), err) } } // Specify :0 to ask the OS for a free port. const freePort = 0 func TestOptionsGetHTTPListener(t *testing.T) { // Gets a listener when explicitly requested with `-http-addr`. { options := &options{ httpAddr: fmt.Sprintf(":%v", freePort), } listener, err := options.getHTTPListener() assert.NoError(t, err) assert.NotNil(t, listener) listener.Close() } // Gets a listener when explicitly requested with `-http-port`. { options := &options{ httpPort: freePort, } listener, err := options.getHTTPListener() assert.NoError(t, err) assert.NotNil(t, listener) listener.Close() } // No listener when HTTPS is explicitly requested, but HTTP is not. { options := &options{ httpPort: -1, // Signals not specified httpsPort: freePort, } listener, err := options.getHTTPListener() assert.NoError(t, err) assert.Nil(t, listener) } // Activates on the default HTTP port if no other args provided. { options := &options{ httpPortDefault: freePort, } listener, err := options.getHTTPListener() assert.NoError(t, err) assert.NotNil(t, listener) listener.Close() } } func TestOptionsGetNonSecureHTTPSListener(t *testing.T) { // Gets a listener when explicitly requested with `-https-addr`. { options := &options{ httpsAddr: fmt.Sprintf(":%v", freePort), } listener, err := options.getNonSecureHTTPSListener() assert.NoError(t, err) assert.NotNil(t, listener) listener.Close() } // Gets a listener when explicitly requested with `-https-port`. { options := &options{ httpsPort: freePort, } listener, err := options.getNonSecureHTTPSListener() assert.NoError(t, err) assert.NotNil(t, listener) listener.Close() } // No listener when HTTP is explicitly requested, but HTTPS is not. { options := &options{ httpPort: freePort, httpsPort: -1, // Signals not specified } listener, err := options.getNonSecureHTTPSListener() assert.NoError(t, err) assert.Nil(t, listener) } // No listener when HTTP is explicitly requested with the old `-port` // option. { options := &options{ httpsPort: -1, // Signals not specified port: freePort, } listener, err := options.getNonSecureHTTPSListener() assert.NoError(t, err) assert.Nil(t, listener) } // Activates on the default HTTPS port if no other args provided. { options := &options{ httpsPortDefault: freePort, } listener, err := options.getNonSecureHTTPSListener() assert.NoError(t, err) assert.NotNil(t, listener) listener.Close() } } stripe-mock-0.196.0/param/000077500000000000000000000000001506013555700152335ustar00rootroot00000000000000stripe-mock-0.196.0/param/coercer/000077500000000000000000000000001506013555700166555ustar00rootroot00000000000000stripe-mock-0.196.0/param/coercer/coercer.go000066400000000000000000000155321506013555700206340ustar00rootroot00000000000000package coercer import ( "fmt" "regexp" "strconv" "github.com/stripe/stripe-mock/spec" ) // CoerceParams coerces the types of certain parameters according to typing // information from their corresponding JSON schema. This is useful because an // input format like form-encoding doesn't support anything but strings, and // we'd like to work with a slightly wider variety of types like booleans and // integers. func CoerceParams(schema *spec.Schema, data map[string]interface{}) error { for key, subSchema := range schema.Properties { val, ok := data[key] if !ok { continue } coercedVal, ok, err := coerceSubSchema(val, subSchema) if err != nil { return err } if ok { data[key] = coercedVal } } return nil } // coerceSubSchema coerces a sub-param value according to an arbitrary JSON sub-schema. // It is named with "sub-schema" because it can be array, primitive, or object, unlike the main // `CoerceParams` only expecting object type with properties. This is also used in coercing each // sub-schema of anyOf or array. func coerceSubSchema(val interface{}, subSchema *spec.Schema) (interface{}, bool, error) { if len(subSchema.Properties) == 0 { // Non-object schemas are anyOf, array, and primitive schemas. // Implicitly treats actual object schema with empty properties as non-object. return coerceNonObjectSchema(val, subSchema) } // `object` schema with properties valMap, ok := val.(map[string]interface{}) var err error if ok { // unwrapping sub-schemas, and coerce contents in the map err = CoerceParams(subSchema, valMap) } return valMap, ok, err } // // --- // // Various identifiers for types in JSON schema. const ( arrayType = "array" booleanType = "boolean" integerType = "integer" numberType = "number" objectType = "object" stringType = "string" ) // maxSliceSize defines a somewhat arbitrary maximum size on an incoming // integer-indexed map that we're willing to parse so that we don't run out of // memory trying to allocate a slice. const maxSliceSize = 1000 // numberPattern simply checks to see if an input string looks like a number. var numberPattern = regexp.MustCompile(`\A\d+\z`) // coercePrimitiveType tries to coerce a primitive type (e.g. bool, int, etc.) // from the given generic interface{} value. On success it returns a coerced // value with a boolean true. On failure (say the value wasn't a type that // could be coerced) it returns nil and a boolean false. func coercePrimitiveType(val interface{}, primitiveType string) (interface{}, bool) { valStr, ok := val.(string) if !ok { return nil, false } switch { case primitiveType == booleanType: valBool, err := strconv.ParseBool(valStr) if err != nil { return nil, false } return valBool, true case primitiveType == integerType: valInt, err := strconv.Atoi(valStr) if err != nil { return nil, false } return valInt, true case primitiveType == numberType: valFloat, err := strconv.ParseFloat(valStr, 64) if err != nil { return nil, false } return valFloat, true case primitiveType == stringType: return valStr, true } return nil, false } // coerceNonObjectSchema tries to coerce a non-object schema given generic interface{} value. // // It's similar to coercePrimitiveType above (and indeed calls into it), but // also handles array and anyOf schema (supporting a number of different primitive types) func coerceNonObjectSchema(val interface{}, schema *spec.Schema) (interface{}, bool, error) { if isSchemaPrimitiveType(schema) { if schema.Enum != nil { // assuming enum value isn't numeric string. when given anyOf schema with enum and // number, the numeric string won't falsely be taken as enum and miss its coercion _, isNumeric := coercePrimitiveType(val, numberType) if isNumeric { return nil, false, nil } } val, ok := coercePrimitiveType(val, schema.Type) return val, ok, nil } if schema.AdditionalProperties != nil { valMap, ok := val.(map[string]interface{}) if ok { allOk := true for itemKey, itemVal := range valMap { itemValCoerced, itemOk, err := coerceSubSchema(itemVal, schema.AdditionalProperties) if err != nil { return nil, false, err } if itemOk { valMap[itemKey] = itemValCoerced } skipNilItem := itemVal == nil allOk = allOk && (itemOk || skipNilItem) } if allOk { return valMap, true, nil } } } if schema.AnyOf != nil { for _, subSchema := range schema.AnyOf { val, ok, err := coerceSubSchema(val, subSchema) if ok { return val, ok, err } } } if schema.Type == arrayType { valMap, ok := val.(map[string]interface{}) if ok { valSlice, err := parseIntegerIndexedMap(valMap) if err != nil { return nil, false, err } if valSlice != nil { val = valSlice } } valArr, ok := val.([]interface{}) if schema.Items == nil { // underspecified array of primitive return val, ok, nil } if ok { allOk := true for i, itemVal := range valArr { itemValCoerced, itemOk, err := coerceSubSchema(itemVal, schema.Items) if err != nil { return nil, false, err } if itemOk { valArr[i] = itemValCoerced } skipNilItem := itemVal == nil allOk = allOk && (itemOk || skipNilItem) } if allOk { return valArr, true, nil } } } return nil, false, nil } // isSchemaPrimitiveType checks whether the given schema is a coercable // primitive type (as opposed to an object or array). // // The conditional ladder in this function should be *identical* to the one in // coercePrimitiveType (i.e., if support is added for a new type, it needs to // be added in both places). func isSchemaPrimitiveType(schema *spec.Schema) bool { if schema.Type == booleanType { return true } if schema.Type == integerType { return true } if schema.Type == numberType { return true } if schema.Type == stringType { return true } return false } // parseIntegerIndexedMap tries to parse a map that has all integer-indexed // keys (e.g. { "0": ..., "1": "...", "2": "..." }) as a slice. We only try to // do this when we know that the target schema requires an array. func parseIntegerIndexedMap(valMap map[string]interface{}) ([]interface{}, error) { allNumberedIndexes := true biggestIndex := 0 for index := range valMap { matched := numberPattern.MatchString(index) if !matched { allNumberedIndexes = false break } valInt, err := strconv.Atoi(index) if err != nil { allNumberedIndexes = false break } if valInt > biggestIndex { biggestIndex = valInt } } if !allNumberedIndexes { return nil, nil } if biggestIndex > maxSliceSize { return nil, fmt.Errorf("Index %v is too large, won't parse as slice", biggestIndex) } valSlice := make([]interface{}, biggestIndex+1) for index, val := range valMap { // Already checked error above indexInt, _ := strconv.Atoi(index) valSlice[indexInt] = val } return valSlice, nil } stripe-mock-0.196.0/param/coercer/coercer_test.go000066400000000000000000000255371506013555700217010ustar00rootroot00000000000000package coercer import ( "testing" assert "github.com/stretchr/testify/require" "github.com/stripe/stripe-mock/spec" ) func TestCoerceParams_AnyOfCoercion(t *testing.T) { // `anyOf` with basic types { schema := &spec.Schema{Properties: map[string]*spec.Schema{ "bool_or_int_key": { AnyOf: []*spec.Schema{ {Type: booleanType}, {Type: integerType}, }, }, }} data := map[string]interface{}{ "bool_or_int_key": "123", } err := CoerceParams(schema, data) assert.NoError(t, err) assert.Equal(t, 123, data["bool_or_int_key"]) } // `anyOf` with object type { schema := &spec.Schema{Properties: map[string]*spec.Schema{ "object_or_int_key": { AnyOf: []*spec.Schema{ {Properties: map[string]*spec.Schema{ "intkey": {Type: integerType}, }}, {Type: integerType}, }, }, }} data := map[string]interface{}{ "object_or_int_key": map[string]interface{}{ "intkey": "123", }, } err := CoerceParams(schema, data) assert.NoError(t, err) assert.Equal(t, 123, data["object_or_int_key"].(map[string]interface{})["intkey"]) } // `anyOf` with object type in additional properties { schema := &spec.Schema{Properties: map[string]*spec.Schema{ "map": { AnyOf: []*spec.Schema{ {AdditionalProperties: &spec.Schema{ Properties: map[string]*spec.Schema{ "intkey": {Type: integerType}, }, }}, {Type: objectType}, }, }, }} data := map[string]interface{}{ "map": map[string]interface{}{ "item": map[string]interface{}{ "intkey": "123", }, }, } err := CoerceParams(schema, data) assert.NoError(t, err) item := data["map"].(map[string]interface{})["item"] assert.Equal(t, 123, item.(map[string]interface{})["intkey"]) } // `anyOf` with array of mixed types { schema := &spec.Schema{Properties: map[string]*spec.Schema{ "array_object_or_int_key": { AnyOf: []*spec.Schema{ // primitives are skipped {Type: integerType}, {Type: stringType}, // array of int is skipped {Items: &spec.Schema{ Type: integerType, }, Type: arrayType}, // array of object is chosen {Items: &spec.Schema{ Properties: map[string]*spec.Schema{ "intkey": {Type: integerType}, }}, Type: arrayType}, }, }, }} data := map[string]interface{}{ "array_object_or_int_key": map[string]interface{}{ "0": map[string]interface{}{"intkey": "123"}, "1": map[string]interface{}{"intkey": nil}, "2": map[string]interface{}{"intkey": "124"}, }, } err := CoerceParams(schema, data) assert.NoError(t, err) sliceVal, ok := data["array_object_or_int_key"].([]interface{}) assert.True(t, ok) assert.Equal(t, 123, sliceVal[0].(map[string]interface{})["intkey"]) assert.Equal(t, nil, sliceVal[1].(map[string]interface{})["intkey"]) assert.Equal(t, 124, sliceVal[2].(map[string]interface{})["intkey"]) } //`anyOf` with array of different primitives { schema := &spec.Schema{Properties: map[string]*spec.Schema{ "array_string_or_array_int": { AnyOf: []*spec.Schema{ {Type: booleanType}, // array of string is chosen {Items: &spec.Schema{ Type: stringType}, Type: arrayType}, {Items: &spec.Schema{ Type: integerType, }, Type: arrayType}, }, }, }} data := map[string]interface{}{ "array_string_or_array_int": map[string]interface{}{ "0": "123", "1": nil, "2": "456", }, } err := CoerceParams(schema, data) assert.NoError(t, err) sliceVal, ok := data["array_string_or_array_int"].([]interface{}) assert.True(t, ok) // values are not coerced into numbers, given explicit string-typed assert.Equal(t, "123", sliceVal[0]) assert.Equal(t, nil, sliceVal[1]) assert.Equal(t, "456", sliceVal[2]) } // `anyOf` Enum and numeric string { schema := &spec.Schema{Properties: map[string]*spec.Schema{ "enum_or_int_key": { AnyOf: []*spec.Schema{ {Enum: []interface{}{ "enum1", "enum2"}, Type: stringType}, {Type: integerType}, }, }, }} // numeric string shouldn't be considered as enum string // and still be coerced to number data := map[string]interface{}{ "enum_or_int_key": "123", } err := CoerceParams(schema, data) assert.NoError(t, err) assert.Equal(t, 123, data["enum_or_int_key"]) // note that value "foo" is not a valid value, but // validation is not done here. having "foo" as string is sufficient data = map[string]interface{}{ "enum_or_int_key": "foo", } err = CoerceParams(schema, data) assert.NoError(t, err) assert.Equal(t, "foo", data["enum_or_int_key"]) } } func TestCoerceParams_ArrayCoercion(t *testing.T) { // Array of primitive values { schema := &spec.Schema{Properties: map[string]*spec.Schema{ "arraykey": { Items: &spec.Schema{ Type: integerType, }, Type: arrayType, }, }} data := map[string]interface{}{ "arraykey": []interface{}{ "123", nil, "124", }, } err := CoerceParams(schema, data) assert.NoError(t, err) sliceVal, ok := data["arraykey"].([]interface{}) assert.True(t, ok) assert.Equal(t, 123, sliceVal[0]) assert.Equal(t, nil, sliceVal[1]) assert.Equal(t, 124, sliceVal[2]) } // Array of objects { schema := &spec.Schema{Properties: map[string]*spec.Schema{ "arraykey": { Items: &spec.Schema{ Properties: map[string]*spec.Schema{ "intkey": {Type: integerType}, }, }, Type: arrayType, }, }} data := map[string]interface{}{ "arraykey": []interface{}{ map[string]interface{}{"intkey": "123"}, map[string]interface{}{"intkey": nil}, map[string]interface{}{"intkey": "124"}, }, } err := CoerceParams(schema, data) assert.NoError(t, err) sliceVal, ok := data["arraykey"].([]interface{}) assert.True(t, ok) assert.Equal(t, 123, sliceVal[0].(map[string]interface{})["intkey"]) assert.Equal(t, nil, sliceVal[1].(map[string]interface{})["intkey"]) assert.Equal(t, 124, sliceVal[2].(map[string]interface{})["intkey"]) } // Integer-indexed map array { schema := &spec.Schema{Properties: map[string]*spec.Schema{ "arraykey": { Items: &spec.Schema{ Properties: map[string]*spec.Schema{ "intkey": {Type: integerType}, }, }, Type: arrayType, }, }} data := map[string]interface{}{ "arraykey": map[string]interface{}{ "0": map[string]interface{}{"intkey": "123"}, "1": map[string]interface{}{"intkey": nil}, "2": map[string]interface{}{"intkey": "124"}, }, } err := CoerceParams(schema, data) assert.NoError(t, err) sliceVal, ok := data["arraykey"].([]interface{}) assert.True(t, ok) assert.Equal(t, 123, sliceVal[0].(map[string]interface{})["intkey"]) assert.Equal(t, nil, sliceVal[1].(map[string]interface{})["intkey"]) assert.Equal(t, 124, sliceVal[2].(map[string]interface{})["intkey"]) } // Integer-indexed of enum { schema := &spec.Schema{Properties: map[string]*spec.Schema{ "array_enum": { Items: &spec.Schema{ Enum: []interface{}{ "enum1", "enum2", }, Type: stringType, }, Type: arrayType, }, }} data := map[string]interface{}{ "array_enum": map[string]interface{}{ // enum value is incorrect, but only coercion // to string is required "0": "enum", }, } err := CoerceParams(schema, data) assert.NoError(t, err) sliceVal, ok := data["array_enum"].([]interface{}) assert.True(t, ok) assert.Equal(t, "enum", sliceVal[0]) } } func TestCoerceParams_BooleanCoercion(t *testing.T) { schema := &spec.Schema{Properties: map[string]*spec.Schema{ "boolkey": {Type: booleanType}, }} data := map[string]interface{}{ "boolkey": "true", } err := CoerceParams(schema, data) assert.NoError(t, err) assert.Equal(t, true, data["boolkey"]) } func TestCoerceParams_IntegerCoercion(t *testing.T) { schema := &spec.Schema{Properties: map[string]*spec.Schema{ "intkey": {Type: integerType}, }} data := map[string]interface{}{ "intkey": "123", } err := CoerceParams(schema, data) assert.NoError(t, err) assert.Equal(t, 123, data["intkey"]) } func TestCoerceParams_IntegerIndexedMapCoercion(t *testing.T) { { schema := &spec.Schema{Properties: map[string]*spec.Schema{ "arraykey": {Type: arrayType}, }} data := map[string]interface{}{ "arraykey": map[string]interface{}{ "0": "0-index", "2": "2-index", }, } err := CoerceParams(schema, data) assert.NoError(t, err) sliceVal, ok := data["arraykey"].([]interface{}) assert.True(t, ok) assert.Equal(t, "0-index", sliceVal[0]) assert.Equal(t, nil, sliceVal[1]) assert.Equal(t, "2-index", sliceVal[2]) } // Value was not a map { schema := &spec.Schema{Properties: map[string]*spec.Schema{ "arraykey": {Type: arrayType}, }} data := map[string]interface{}{ "arraykey": "not-map", } err := CoerceParams(schema, data) assert.NoError(t, err) assert.Equal(t, "not-map", data["arraykey"]) } // Not all indexes were integers { schema := &spec.Schema{Properties: map[string]*spec.Schema{ "arraykey": {Type: arrayType}, }} data := map[string]interface{}{ "arraykey": map[string]interface{}{ "0": "0-index", "foo": "foo-index", }, } err := CoerceParams(schema, data) assert.NoError(t, err) assert.Equal(t, "foo-index", data["arraykey"].(map[string]interface{})["foo"]) } // Index too big { schema := &spec.Schema{Properties: map[string]*spec.Schema{ "arraykey": {Type: arrayType}, }} data := map[string]interface{}{ "arraykey": map[string]interface{}{ "999999": "big-index", }, } err := CoerceParams(schema, data) assert.Error(t, err) } } func TestCoerceParams_NumberCoercion(t *testing.T) { schema := &spec.Schema{Properties: map[string]*spec.Schema{ "numberkey": {Type: numberType}, }} data := map[string]interface{}{ "numberkey": "123.45", } err := CoerceParams(schema, data) assert.NoError(t, err) assert.Equal(t, 123.45, data["numberkey"]) } func TestCoerceParams_UnspecifiedTypeNoCoercion(t *testing.T) { schema := &spec.Schema{Properties: map[string]*spec.Schema{ // unspecified types "stringkey": {}, "numberKey": {}, "objectKey": {}, }} data := map[string]interface{}{ "stringkey": "123", "numberKey": 1.0 / 3, "objectKey": map[string]interface{}{"foo": "bar"}, } err := CoerceParams(schema, data) assert.NoError(t, err) assert.Equal(t, "123", data["stringkey"]) assert.Equal(t, 1.0/3, data["numberKey"]) assert.Equal(t, "bar", data["objectKey"].(map[string]interface{})["foo"]) } func TestCoerceParams_Recursion(t *testing.T) { schema := &spec.Schema{Properties: map[string]*spec.Schema{ "mapkey": {Properties: map[string]*spec.Schema{ "intkey": {Type: integerType}, }}, }} data := map[string]interface{}{ "mapkey": map[string]interface{}{ "intkey": "123", }, } err := CoerceParams(schema, data) assert.NoError(t, err) assert.Equal(t, 123, data["mapkey"].(map[string]interface{})["intkey"]) } stripe-mock-0.196.0/param/form/000077500000000000000000000000001506013555700161765ustar00rootroot00000000000000stripe-mock-0.196.0/param/form/form.go000066400000000000000000000006201506013555700174660ustar00rootroot00000000000000// Package form is a small package used to hold a few types common to the param // package so that we don't have import cycles. package form // // Public types // // Pair is a key/value pair as extracted from a form-encoded string. For // example, "a=b" is the pair [a, b]. type Pair [2]string // Values is a full slice of all the key/value pairs from a form-encoded // string. type Values []Pair stripe-mock-0.196.0/param/form/form_test.go000066400000000000000000000001471506013555700205310ustar00rootroot00000000000000package form // Add tests here if the package is ever expanded beyond its currently trivial // state. stripe-mock-0.196.0/param/nestedtypeassembler/000077500000000000000000000000001506013555700213155ustar00rootroot00000000000000stripe-mock-0.196.0/param/nestedtypeassembler/nestedtypeassembler.go000066400000000000000000000132621506013555700257320ustar00rootroot00000000000000// Package nestedtypeassembler takes a collection of form.Pair tuples and uses // them to construct more complex data types using "Rack-style" conventions for // arrays and maps with a few small Stripe-specific tweaks. // // When processing a request, data should first be parsed from the query, form, // or multipart form, handed off to this package for assembly, then passed on // the coercer to coerce string to other expected types. package nestedtypeassembler import ( "fmt" "github.com/stripe/stripe-mock/param/form" ) // // Public functions // // AssembleParams takes a collection of form.Pair tuples and translates them to // parameter map that includes complex data types like arrays and other nested // maps. func AssembleParams(form form.Values) (map[string]interface{}, error) { params := make(map[string]interface{}) for _, pair := range form { key := pair[0] value := pair[1] keyParts := parseKey(key) if len(keyParts) == 0 { continue } rawkeyPart := keyParts[0] if rawkeyPart.KeyType() != keyTypeRaw { return nil, fmt.Errorf(`invalid key "%v": keys must start with a name`, key) } pairParams, err := buildParamStructure(rawkeyPart.Content(), keyParts[1:], value) if err != nil { return nil, err } //fmt.Printf("new params = %+v\n", pairParams) mergeMapsRecursive(params, pairParams) //fmt.Printf("merge result = %+v\n\n", params) } return params, nil } // // Private constants // const ( keyTypeArray = iota keyTypeMap keyTypeRaw ) // // Private types // // keyPart is an interface for a struct that represents a "part" of a parameter // key. For example, we might say that in `obj[]` the `[]` is an array part. type keyPart interface { KeyType() int Content() string } // keyType represents an array part of a parameter key, like the `[]` in // `obj[][foo]`. type keyArray struct { } func (k *keyArray) KeyType() int { return keyTypeArray } func (k *keyArray) Content() string { panic("keyArray doesn't support Content") } // keyMap represents a map part of a parameter key, like the `[foo]` in // `obj[][foo]`. type keyMap struct { content string } func (k *keyMap) KeyType() int { return keyTypeMap } func (k *keyMap) Content() string { return k.content } // keyRaw represents the raw name of a parameter key, like the `obj` in // `obj[][foo]`. type keyRaw struct { content string } func (k *keyRaw) KeyType() int { return keyTypeRaw } func (k *keyRaw) Content() string { return k.content } // // Private functions // func parseKey(key string) []keyPart { var keyParts []keyPart var c rune var i int var mapContent []rune var rawContent []rune keyRunes := []rune(key) raw: if i >= len(keyRunes) { goto finished } c = keyRunes[i] i++ if c == '[' { if len(rawContent) > 0 { keyParts = append(keyParts, &keyRaw{content: string(rawContent)}) rawContent = nil } goto inMapOrArray } rawContent = append(rawContent, c) goto raw inMapOrArray: if i >= len(keyRunes) { goto finished } c = keyRunes[i] i++ if c == ']' { keyParts = append(keyParts, &keyArray{}) goto raw } mapContent = append(mapContent, c) // Fall through to inMap inMap: if i >= len(keyRunes) { goto finished } c = keyRunes[i] i++ if c == ']' { keyParts = append(keyParts, &keyMap{content: string(mapContent)}) mapContent = nil goto raw } mapContent = append(mapContent, c) goto inMap finished: if len(keyParts) == 0 && len(rawContent) > 0 { keyParts = append(keyParts, &keyRaw{content: string(rawContent)}) rawContent = nil } return keyParts } func buildParamStructure(key string, parts []keyPart, value string) (map[string]interface{}, error) { params := make(map[string]interface{}) if len(parts) == 0 { params[key] = value return params, nil } part := parts[0] switch part.KeyType() { case keyTypeArray: subParams, err := buildParamStructure("dummy", parts[1:], value) if err != nil { return nil, err } params[key] = []interface{}{subParams["dummy"]} case keyTypeMap: subParams, err := buildParamStructure(part.Content(), parts[1:], value) if err != nil { return nil, err } params[key] = subParams default: return nil, fmt.Errorf("invalid key: raw content can't be mixed in after arrays and maps") } return params, nil } func maybeCollapseArrays(arr1, arr2 []interface{}) bool { //fmt.Printf("maybe collapse arrays %+v %+v\n", arr1, arr2) if len(arr2) != 1 { panic("Expected array with length exactly 1") } // arr1's merge candidate is its last element only arr1Map, ok := arr1[len(arr1)-1].(map[string]interface{}) if !ok { return false } arr2Map, ok := arr2[0].(map[string]interface{}) if !ok { return false } // If any of the keys in arr2's map are already in arr1's map, then don't // merge we consider this a new map. for key := range arr2Map { val, ok := arr1Map[key] if ok { _, okArr := val.([]interface{}) _, okMap := val.(map[string]interface{}) if !okArr && !okMap { return false } } } mergeMapsRecursive(arr1Map, arr2Map) return true } func mergeMapsRecursive(map1, map2 map[string]interface{}) { for key, val2 := range map2 { val1, ok := map1[key] if ok { val1Map, ok := val1.(map[string]interface{}) if ok { val2Map, ok := val2.(map[string]interface{}) if ok { mergeMapsRecursive(val1Map, val2Map) continue } } val1Arr, ok := val1.([]interface{}) if ok { val2Arr, ok := val2.([]interface{}) if ok { ok := maybeCollapseArrays(val1Arr, val2Arr) if !ok { map1[key] = append(val1Arr, val2Arr...) } continue } } } // If not an array or map, or we couldn't reconcile types between the // two maps, simply set the key in map1 to the value from map2. map1[key] = val2 } } stripe-mock-0.196.0/param/nestedtypeassembler/nestedtypeassembler_test.go000066400000000000000000000132131506013555700267650ustar00rootroot00000000000000package nestedtypeassembler import ( "testing" assert "github.com/stretchr/testify/require" "github.com/stripe/stripe-mock/param/form" "github.com/stripe/stripe-mock/param/parser" ) // // Tests // func TestAssembleParams_Basic(t *testing.T) { assert.Equal(t, map[string]interface{}{ "foo": "bar", }, mustAssembleParams(t, "foo=bar")) assert.Equal(t, map[string]interface{}{ "foo": "7", }, mustAssembleParams(t, "foo=7")) assert.Equal(t, map[string]interface{}{ "a": "value1", "b": "value2", "c": "value3", }, mustAssembleParams(t, "a=value1&b=value2&c=value3")) } func TestAssembleParams_Empty(t *testing.T) { assert.Equal(t, map[string]interface{}{}, mustAssembleParams(t, "")) } func TestAssembleParams_Array(t *testing.T) { assert.Equal(t, map[string]interface{}{ "arr": []interface{}{"value1"}, }, mustAssembleParams(t, "arr[]=value1")) assert.Equal(t, map[string]interface{}{ "arr": []interface{}{"value1", "value2", "value3"}, }, mustAssembleParams(t, "arr[]=value1&arr[]=value2&arr[]=value3")) } // Here for completeness, but this kind of input is to a large degree nonsense // and hopefully not present anywhere in the Stripe API ... func TestAssembleParams_ArrayMulti(t *testing.T) { assert.Equal(t, map[string]interface{}{ "arr": []interface{}{ []interface{}{"value1"}, }, }, mustAssembleParams(t, "arr[][]=value1")) } func TestAssembleParams_Map(t *testing.T) { assert.Equal(t, map[string]interface{}{ "map": map[string]interface{}{"key1": "value1"}, }, mustAssembleParams(t, "map[key1]=value1")) assert.Equal(t, map[string]interface{}{ "map": map[string]interface{}{ "key1": "value1", "key2": "value2", }, }, mustAssembleParams(t, "map[key1]=value1&map[key2]=value2")) assert.Equal(t, map[string]interface{}{ "map1": map[string]interface{}{ "key1": "value1", "key2": "value2", }, "map2": map[string]interface{}{ "key1": "value1", }, }, mustAssembleParams(t, "map1[key1]=value1&map1[key2]=value2&map2[key1]=value1")) } func TestAssembleParams_MapNesting(t *testing.T) { assert.Equal(t, map[string]interface{}{ "map": map[string]interface{}{ "key1": map[string]interface{}{ "key1": "value1_1", "key2": "value1_2", }, "key2": "value2", }, }, mustAssembleParams(t, "map[key1][key1]=value1_1&map[key1][key2]=value1_2&map[key2]=value2")) assert.Equal(t, map[string]interface{}{ "map": map[string]interface{}{ "key1": map[string]interface{}{ "key1": map[string]interface{}{ "key1": "value1", }, }, "key2": "value2", }, }, mustAssembleParams(t, "map[key1][key1][key1]=value1&map[key2]=value2")) } func TestAssembleParams_MapInArray(t *testing.T) { assert.Equal(t, map[string]interface{}{ "obj": []interface{}{ map[string]interface{}{"key1": "value1"}, }, }, mustAssembleParams(t, "obj[][key1]=value1")) assert.Equal(t, map[string]interface{}{ "obj": []interface{}{ map[string]interface{}{ "key1": "value1", "key2": "value2", }, }, }, mustAssembleParams(t, "obj[][key1]=value1&obj[][key2]=value2")) } func TestAssembleParams_MapInArrayMulti(t *testing.T) { assert.Equal(t, map[string]interface{}{ "obj": []interface{}{ map[string]interface{}{ "key1": "value1_1", "key2": "value1_2", }, map[string]interface{}{ "key1": "value2_1", "key2": "value2_2", }, }, }, mustAssembleParams(t, "obj[][key1]=value1_1&obj[][key2]=value1_2&"+ "obj[][key1]=value2_1&obj[][key2]=value2_2", )) } func TestAssembleParams_MapInArrayRepeating(t *testing.T) { assert.Equal(t, map[string]interface{}{ "obj": []interface{}{ map[string]interface{}{ "key1": "value1", }, map[string]interface{}{ "key1": "value2", }, }, }, mustAssembleParams(t, "obj[][key1]=value1&obj[][key1]=value2")) } func TestAssembleParams_ArrayInMap(t *testing.T) { assert.Equal(t, map[string]interface{}{ "obj": map[string]interface{}{ "key1": []interface{}{"value1"}, }, }, mustAssembleParams(t, "obj[key1][]=value1")) assert.Equal(t, map[string]interface{}{ "obj": map[string]interface{}{ "key1": []interface{}{ "value1", "value2", }, }, }, mustAssembleParams(t, "obj[key1][]=value1&obj[key1][]=value2")) } func TestAssembleParams_ComplexNesting(t *testing.T) { assert.Equal(t, map[string]interface{}{ "obj": []interface{}{ map[string]interface{}{ "key1": []interface{}{ "value1_1", "value1_2", }, "key2": map[string]interface{}{ "key": "value2", }, "key3": "value3", }, }, }, mustAssembleParams(t, "obj[][key1][]=value1_1&obj[][key1][]=value1_2&"+ "obj[][key2][key]=value2&"+ "obj[][key3]=value3", )) } // // Tests for private functions // func TestParseKey(t *testing.T) { assert.Equal(t, []keyPart{ &keyRaw{content: "name"}, }, parseKey("name")) assert.Equal(t, []keyPart{ &keyRaw{content: "array"}, &keyArray{}, }, parseKey("array[]")) assert.Equal(t, []keyPart{ &keyRaw{content: "map"}, &keyMap{content: "key"}, }, parseKey("map[key]")) assert.Equal(t, []keyPart{ &keyRaw{content: "maparray"}, &keyArray{}, &keyMap{content: "key"}, }, parseKey("maparray[][key]")) assert.Equal(t, []keyPart{ &keyRaw{content: "maparray"}, &keyArray{}, &keyMap{content: "key"}, &keyArray{}, &keyMap{content: "key"}, &keyMap{content: "key"}, &keyMap{content: "key"}, }, parseKey("maparray[][key][][key][key][key]")) } // // Private functions // func mustParse(t *testing.T, query string) form.Values { values, err := parser.ParseFormString(query) assert.NoError(t, err) return values } func mustAssembleParams(t *testing.T, query string) map[string]interface{} { params, err := AssembleParams(mustParse(t, query)) assert.NoError(t, err) return params } stripe-mock-0.196.0/param/param.go000066400000000000000000000060321506013555700166630ustar00rootroot00000000000000package param import ( "io/ioutil" "net/http" "strings" "github.com/stripe/stripe-mock/param/form" "github.com/stripe/stripe-mock/param/nestedtypeassembler" "github.com/stripe/stripe-mock/param/parser" ) // // Public functions // // ParseParams extracts parameters from a request that an application can // consume. // // Depending on the type of request, parameters may be extracted from either // the query string, a form-encoded body, or a multipart form-encoded body (the // latter being specific to only a very small number of endpoints). // // Regardless of origin, parameters are assumed to follow "Rack-style" // conventions for encoding complex types like arrays and maps, which is how // the Stripe API decodes data. These complex types are what makes the param // package's implementation non-trivial. We rely on the nestedtypeassembler // subpackage to do the heavy lifting for that. func ParseParams(r *http.Request) (map[string]interface{}, error) { var values form.Values contentType := r.Header.Get("Content-Type") // Truncate content type parameters. For example, given: // // application/json; charset=utf-8 // // We want to chop off the `; charset=utf-8` at the end. contentType = strings.Split(contentType, ";")[0] formString := r.URL.RawQuery // Ideally we'd just parse the query string for `GET` requests and use the // request body for others, but the way Stripe's API actually works is to // mix all these request parameters together into one big bucket, behavior // inherited from Rack. // // Here we parse the query string regardless of the request type, then move // on to potentially parse the body if it looks like we should. var err error values, err = parser.ParseFormString(formString) if err != nil { return nil, err } if contentType == multipartMediaType { err := r.ParseMultipartForm(maxMemory) if err != nil { return nil, err } for key, keyValues := range r.MultipartForm.Value { for _, keyValue := range keyValues { values = append(values, form.Pair{key, keyValue}) } } for key, keyValues := range r.MultipartForm.File { for _, keyFileHeader := range keyValues { file, err := keyFileHeader.Open() if err != nil { return nil, err } keyFileBytes, err := ioutil.ReadAll(file) file.Close() if err != nil { return nil, err } values = append(values, form.Pair{key, string(keyFileBytes)}) } } } else if r.Method != "GET" { formBytes, err := ioutil.ReadAll(r.Body) if err != nil { return nil, err } r.Body.Close() formString := string(formBytes) formValues, err := parser.ParseFormString(formString) if err != nil { return nil, err } values = append(values, formValues...) } return nestedtypeassembler.AssembleParams(values) } // // Private constants // // maxMemory is the maximum amount of memory allowed when ingesting a multipart // form. // // Set to 1 MB. const maxMemory = 1 * 1024 * 1024 // multipartMediaType is the `Content-Type` for a multipart request. const multipartMediaType = "multipart/form-data" stripe-mock-0.196.0/param/param_test.go000066400000000000000000000043771506013555700177340ustar00rootroot00000000000000package param import ( "bytes" "mime/multipart" "net/http" "net/http/httptest" "testing" assert "github.com/stretchr/testify/require" ) func TestParseParams_Get(t *testing.T) { req := httptest.NewRequest(http.MethodGet, "/?query_param=query_val", nil) params, err := ParseParams(req) assert.NoError(t, err) assert.Equal(t, map[string]interface{}{ "query_param": "query_val", }, params) } func TestParseParams_Form(t *testing.T) { // Basic form in the request body. { req := httptest.NewRequest(http.MethodPost, "/", bytes.NewBufferString("body_param=body_val")) params, err := ParseParams(req) assert.NoError(t, err) assert.Equal(t, map[string]interface{}{ "body_param": "body_val", }, params) } // Requests with a form body should also include values from the query // string, if any were sent. { req := httptest.NewRequest(http.MethodPost, "/?query_param=query_val", bytes.NewBufferString("body_param=body_val")) params, err := ParseParams(req) assert.NoError(t, err) assert.Equal(t, map[string]interface{}{ "body_param": "body_val", "query_param": "query_val", }, params) } } func TestParseParams_MultipartForm(t *testing.T) { var b bytes.Buffer w := multipart.NewWriter(&b) assert.NoError(t, w.WriteField("foo", "bar")) assert.NoError(t, w.Close()) req := httptest.NewRequest(http.MethodPost, "/", bytes.NewReader(b.Bytes())) req.Header.Set("Content-Type", w.FormDataContentType()) params, err := ParseParams(req) assert.NoError(t, err) assert.Equal(t, map[string]interface{}{ "foo": "bar", }, params) } // Differs from the above by sending a value as a file instead of as just a // basic multipart parameter. This more accurately represents what a file // upload would look like. func TestParseParams_MultipartFormFromFile(t *testing.T) { var b bytes.Buffer w := multipart.NewWriter(&b) fieldW, err := w.CreateFormFile("foo", "foo.txt") assert.NoError(t, err) _, err = fieldW.Write([]byte("bar")) assert.NoError(t, err) assert.NoError(t, w.Close()) req := httptest.NewRequest(http.MethodPost, "/", bytes.NewReader(b.Bytes())) req.Header.Set("Content-Type", w.FormDataContentType()) params, err := ParseParams(req) assert.NoError(t, err) assert.Equal(t, map[string]interface{}{ "foo": "bar", }, params) } stripe-mock-0.196.0/param/parser/000077500000000000000000000000001506013555700165275ustar00rootroot00000000000000stripe-mock-0.196.0/param/parser/parser.go000066400000000000000000000023451506013555700203560ustar00rootroot00000000000000package parser import ( "net/url" "strings" "github.com/stripe/stripe-mock/param/form" ) // // Public functions // // ParseFormString parses a form-encoded body or query into a set of key/value // pairs. It differs from url.ParseQuery in that because it produces a slice // instead of a map, order can be preserved. This is key to properly decoding // "Rack-style" form encoding. // // Implementation modified from: https://github.com/deoxxa/urlqp func ParseFormString(s string) (form.Values, error) { s = strings.TrimPrefix(s, "?") if s == "" { return nil, nil } rawValues := strings.Split(s, "&") r := make(form.Values, len(rawValues)) for i, rawValue := range rawValues { // Split this raw form value into two parts, at the first `=` valueParts := strings.SplitN(rawValue, "=", 2) formKey, err := url.QueryUnescape(valueParts[0]) if err != nil { return nil, err } // Set a default for the value. Empty seems reasonable. v := "" // If `b` has more than one element, that means the second one will be the // parameter value, so grab it. if len(valueParts) > 1 { v, err = url.QueryUnescape(valueParts[1]) if err != nil { return nil, err } } r[i] = form.Pair{formKey, v} } return r, nil } stripe-mock-0.196.0/param/parser/parser_test.go000066400000000000000000000026561506013555700214220ustar00rootroot00000000000000package parser import ( "testing" assert "github.com/stretchr/testify/require" "github.com/stripe/stripe-mock/param/form" ) // // Tests // func TestParseForm(t *testing.T) { var err error var v form.Values v, err = ParseFormString(``) assert.NoError(t, err) assert.Nil(t, v) v, err = ParseFormString(`a=b&c=d&e=f`) assert.NoError(t, err) assert.Equal(t, form.Values{ form.Pair{"a", "b"}, form.Pair{"c", "d"}, form.Pair{"e", "f"}, }, v) v, err = ParseFormString(`a=b&a=c`) assert.NoError(t, err) assert.Equal(t, form.Values{ form.Pair{"a", "b"}, form.Pair{"a", "c"}, }, v) v, err = ParseFormString(`a=b&a=b`) assert.NoError(t, err) assert.Equal(t, form.Values{ form.Pair{"a", "b"}, form.Pair{"a", "b"}, }, v) v, err = ParseFormString(`?a=b&a=b`) assert.NoError(t, err) assert.Equal(t, form.Values{ form.Pair{"a", "b"}, form.Pair{"a", "b"}, }, v) v, err = ParseFormString(`?x=%20&%20=x`) assert.NoError(t, err) assert.Equal(t, form.Values{ form.Pair{"x", " "}, form.Pair{" ", "x"}, }, v) v, err = ParseFormString(`?x=+&+=x`) assert.NoError(t, err) assert.Equal(t, form.Values{ form.Pair{"x", " "}, form.Pair{" ", "x"}, }, v) v, err = ParseFormString(`?x=%2c&%2c=x`) assert.NoError(t, err) assert.Equal(t, form.Values{ form.Pair{"x", ","}, form.Pair{",", "x"}, }, v) _, err = ParseFormString(`%`) assert.Error(t, err) _, err = ParseFormString(`a=%`) assert.Error(t, err) } stripe-mock-0.196.0/scripts/000077500000000000000000000000001506013555700156225ustar00rootroot00000000000000stripe-mock-0.196.0/scripts/check_gofmt.sh000077500000000000000000000005701506013555700204340ustar00rootroot00000000000000#!/bin/bash find_files() { find . -not \( \ \( \ -name 'bindata.go' \ \) -prune \ \) -not \( \ \( \ -name 'vendor' \ \) -prune \ \) -name '*.go' } bad_files=$(find_files | xargs gofmt -s -l) if [[ -n "${bad_files}" ]]; then echo "!!! gofmt needs to be run on the following files: " echo "${bad_files}" exit 1 fi stripe-mock-0.196.0/scripts/pre-commit000077500000000000000000000002251506013555700176230ustar00rootroot00000000000000#!/bin/bash -e # # Install to: .git/hooks/ # ROOT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )/../../" && pwd )" $ROOT_DIR/scripts/check_gofmt.sh stripe-mock-0.196.0/server/000077500000000000000000000000001506013555700154415ustar00rootroot00000000000000stripe-mock-0.196.0/server/generator.go000066400000000000000000001046751506013555700177730ustar00rootroot00000000000000package server import ( "fmt" "math/rand" "net/http" "reflect" "sort" "strings" "time" "github.com/stripe/stripe-mock/generator/datareplacer" "github.com/stripe/stripe-mock/spec" ) // GenerateParams is a parameters structure that's used to invoke Generate and // its associated methods. // // This structure exists to avoid runaway paramete inflation for the Generate // function, so that we can document individual parameters in a more organized // way, and because it can conveniently encapsulate some unexported fields that // Generate uses to track its progress. type GenerateParams struct { // Expansions are the requested expansions for the current level of generation. // // nil if no expansions were requested, or we've recursed to a level where // none of the original expansions applied. Expansions *ExpansionLevel // PathParams, if set, is a collection that contains values for parameters // that were extracted from a request path. This is useful so that we can // reflect those values into responses for a more realistic effect. // // nil if there were no values extracted from the path. // // The value of this field is considered in a post-processing step for the // generator. It's not used in the generator at all. PathParams *PathParamsMap // RequestData is a collection of decoded data that was included as part of // the request's payload. // // It's used to find opportunities to reflect information included with a // request into the response to make responses look more accurate than // they'd otherwise be if they'd been generated from fixtures alone.. RequestData map[string]interface{} // RequestMethod is the HTTP method of the URL being requested which we're // generating data for. It's used to decide between returning a deleted and // non-deleted schema in some cases. // // The value of this field is expected to stay stable across all levels of // recursion. RequestMethod string // RequestPath is the path of the URL being requested which we're // generating data for. It's used to populate the url property of any // nested lists that we generate. // // The value of this field is expected to stay stable across all levels of // recursion. RequestPath string // // Private fields // // Schema representing the object that we're trying to generate. // // The value of this field will change as Generate recurses to the target // schema at that level of recursion. // // This field is required. Schema *spec.Schema // context is a breadcrumb trail that's added to as Generate recurses. It's // not important for the final result, but is very useful for debugging. context string // example is a valid data sample for the target schema at this level of // recursion. // // nil means that were was no sample available. A valueWrapper instance // with an embedded nil means that there is a sample, and it's nil/null. example *valueWrapper } // DataGenerator generates fixture response data based off a response schema, a // set of definitions, and a fixture store. type DataGenerator struct { definitions map[string]*spec.Schema fixtures *spec.Fixtures verbose bool } // Generate generates a fixture response. func (g *DataGenerator) Generate(params *GenerateParams) (interface{}, error) { // This just makes our context message readable in case there was no // request path specified. requestPathDisplay := params.RequestPath if requestPathDisplay == "" { requestPathDisplay = "(empty request path)" } data, err := g.generateInternal(&GenerateParams{ Expansions: params.Expansions, PathParams: nil, RequestMethod: params.RequestMethod, RequestPath: params.RequestPath, Schema: params.Schema, context: fmt.Sprintf("Responding to %s %s:\n", params.RequestMethod, requestPathDisplay), example: nil, }) if err != nil { return nil, err } // Binary resources don't return JSON, so perform no mutations and just // return the data as is. if isBinaryResource(params.Schema) { return data, nil } // Maybe generate a new primary ID. This kicks in when no primary ID was // extracted from the path, which usually means this is a "create" API // endpoint. This nicety allows create endpoints to return a new ID every // time like the real API would. pathParams := maybeGeneratePrimaryID(params.PathParams, data) if pathParams != nil { // Passses through the generated data and replaces IDs that existed in // the fixtures with IDs that were extracted from the request path, if // and where appropriate. // // Note that the path params are mutated by the function, but we return // them anyway to make the control flow here more clear. pathParams := recordAndReplaceIDs(pathParams, data, g.verbose) // Passes through the generated data again to replace the values of any old // IDs that we replaced. This is a separate step because IDs could have // been found and replace at any point in the generation process. distributeReplacedIDs(pathParams, data) } // In `POST` requests we reflect input parameters into responses to try and // simulate a more realistic create or update operation. if params.RequestMethod == http.MethodPost { if mapData, ok := data.(map[string]interface{}); ok { replacer := datareplacer.DataReplacer{ Definitions: g.definitions, Schema: params.Schema, } mapData = replacer.ReplaceData(params.RequestData, mapData) } } return data, nil } // generateInternal encompasses all the generation logic. It's separate from // Generate only so that Generate can seed it with a little bit of information. func (g *DataGenerator) generateInternal(params *GenerateParams) (interface{}, error) { // This is a bit of a mess. We don't have an elegant fully-general approach to // generating examples, just a bunch of specific cases that we know how to // handle. If we find ourselves in a situation that doesn't match any of the // cases, then we fall through to the end of the function and panic(). // Obviously this is fragile, so we have a unit test that makes sure it works // correctly on every resource; hopefully this will at least allow us to catch // any errors in advance. schema, context, err := g.maybeDereference(params.Schema, params.context) if err != nil { return nil, err } // Determine if the requested expansions are possible if params.Expansions != nil && schema.XExpandableFields != nil { for key := range params.Expansions.expansions { if sort.SearchStrings(*schema.XExpandableFields, key) == len(*schema.XExpandableFields) { return nil, errExpansionNotSupported } } } example := params.example if (example == nil || example.value == nil) && schema.XResourceID != "" { // Use the fixture as our example. (Note that if the caller gave us a // non-trivial example, we prefer it instead, because it's probably more // relevant in context.) fixture, ok := g.fixtures.Resources[spec.ResourceID(schema.XResourceID)] if !ok { panic(fmt.Sprintf("%sMissing fixture for: %s", context, schema.XResourceID)) } example = &valueWrapper{value: fixture} context = fmt.Sprintf("%sUsing fixture '%s':\n", context, schema.XResourceID) } if schema.XExpansionResources != nil { if params.Expansions != nil { // We're expanding this specific object return g.generateInternal(&GenerateParams{ Expansions: params.Expansions, PathParams: nil, RequestMethod: params.RequestMethod, RequestPath: params.RequestPath, Schema: schema.XExpansionResources.OneOf[0], context: fmt.Sprintf("%sExpanding optional expandable field:\n", context), example: nil, }) } // We're not expanding this specific object. Our example should be of // the unexpanded form, which is the first branch of the AnyOf return g.generateInternal(&GenerateParams{ Expansions: params.Expansions, PathParams: nil, RequestMethod: params.RequestMethod, RequestPath: params.RequestPath, Schema: schema.AnyOf[0], context: fmt.Sprintf("%sNot expanding optional expandable field:\n", context), example: example, }) } if len(schema.AnyOf) == 1 && schema.Nullable { if example != nil && example.value == nil { if params.Expansions == nil { return nil, nil } } else { // Since there's only one subschema, we can confidently recurse into it return g.generateInternal(&GenerateParams{ Expansions: params.Expansions, PathParams: nil, RequestMethod: params.RequestMethod, RequestPath: params.RequestPath, Schema: schema.AnyOf[0], context: fmt.Sprintf("%sChoosing only branch of anyOf:\n", context), example: example, }) } } if len(schema.AnyOf) != 0 { anyOfSchema, err := g.findAnyOfBranch(schema, params.RequestMethod == http.MethodDelete) if err != nil { return nil, err } var context string if anyOfSchema != nil { context = fmt.Sprintf("%sChoosing branch of anyOf based on request method:\n", context) } else { context = fmt.Sprintf("%sChoosing first branch of anyOf:\n", context) anyOfSchema = schema.AnyOf[0] } // Just generate an example of the first subschema. Note that we don't pass // in any example, even if we have an example available, because we don't // know which branch of the AnyOf the example corresponds to. return g.generateInternal(&GenerateParams{ Expansions: params.Expansions, PathParams: nil, RequestMethod: params.RequestMethod, RequestPath: params.RequestPath, Schema: anyOfSchema, context: context, example: nil, }) } if isListResource(schema) { // We special-case list resources and always fill in the list with at least // one item of data, regardless of what was present in the example listData, err := g.generateListResource(&GenerateParams{ Expansions: params.Expansions, PathParams: nil, RequestMethod: params.RequestMethod, RequestPath: params.RequestPath, Schema: schema, context: context, example: example, }) return listData, err } if isSearchResultResource(schema) { // We special-case search result resources and always fill in the result // with at least one item of data, regardless of what was present in the // example searchResultData, err := g.generateSearchResultResource(&GenerateParams{ Expansions: params.Expansions, PathParams: nil, RequestMethod: params.RequestMethod, RequestPath: params.RequestPath, Schema: schema, context: context, example: example, }) return searchResultData, err } if isBinaryResource(schema) { return "Stripe binary response", nil } // Generate a synthethic schema as a last ditch effort // Note that if example.value is nil, we only want to generate // a synthetic fixture if the user has requested expansions. // Otherwise, we'll cause bugs like https://github.com/stripe/stripe-mock/issues/447 if example == nil || (params.Expansions != nil && example.value == nil) && schema.XResourceID == "" { example = &valueWrapper{value: g.generateSyntheticFixture(schema, context, params.Expansions)} context = fmt.Sprintf("%sGenerated synthetic fixture: %+v\n", context, schema) if g.verbose { // We list properties here because the schema might not have a // better name to identify it with. fmt.Printf("Generated synthetic fixture with properties: %s\n", stringOrEmpty(propertyNames(schema))) } } if example == nil { // If none of the above conditions met, we've run out of ways of generating // examples from scratch, so we can only raise an error. panic(fmt.Sprintf("%sCannot find or generate example for: %s", context, schema)) } if example.value == nil { if params.Expansions != nil { panic(fmt.Sprintf("%sWe were asked to expand a key, but our example "+ "has null for that key.", context)) } return nil, nil } if schema.Type == "boolean" || schema.Type == "integer" || schema.Type == "number" || schema.Type == "string" { return example.value, nil } if schema.Type == "object" && schema.Properties == nil { // For a generic object type with no particular properties specified, we // assume it must not contain any expandable fields or list resources return example.value, nil } if schema.Type == "array" { // For lists that aren't contained in a list-object, we assume they do not // contain any expandable fields or list resources return example.value, nil } if schema.Type == "object" && schema.Properties != nil { exampleMap, ok := example.value.(map[string]interface{}) if !ok { panic(fmt.Sprintf( "%sSchema is an object:\n%s\n\nBut example is (type: %v):\n%s", context, schema, reflect.TypeOf(example.value), example.value)) } resultMap := make(map[string]interface{}) for key, subSchema := range schema.Properties { var subExpansions *ExpansionLevel if params.Expansions != nil { subExpansions = params.Expansions.expansions[key] if subExpansions == nil && params.Expansions.wildcard { // No expansion was provided for this key but the wildcard bit is set, // so make a fake expansion subExpansions = &ExpansionLevel{ expansions: make(map[string]*ExpansionLevel), wildcard: false, } } } var subvalueWrapper *valueWrapper subvalueWrapperValue, exampleHasKey := exampleMap[key] if exampleHasKey { subvalueWrapper = &valueWrapper{value: subvalueWrapperValue} } if !exampleHasKey && subExpansions == nil { // If the example omitted this key, then so do we; unless we were asked // to expand the key, in which case we'll have to generate an example // from scratch. continue } subValue, err := g.generateInternal(&GenerateParams{ Expansions: subExpansions, PathParams: nil, RequestMethod: params.RequestMethod, RequestPath: params.RequestPath, Schema: subSchema, context: fmt.Sprintf("%sIn property '%s' of object:\n", context, key), example: subvalueWrapper, }) if err != nil { return nil, err } resultMap[key] = subValue } return resultMap, nil } // If the schema is of the format we expect, this shouldn't ever happen. panic(fmt.Sprintf( "%sEncountered unusual scenario:\nschema=%s\nexample=%+v", context, schema, example)) } // findAnyOfBranch finds a branch of a schema containing `anyOf` that's either // a deleted resource or not based off of the value of the deleted argument. func (g *DataGenerator) findAnyOfBranch(schema *spec.Schema, deleted bool) (*spec.Schema, error) { for _, anyOfSchema := range schema.AnyOf { anyOfSchema, _, err := g.maybeDereference(anyOfSchema, "") if err != nil { return nil, err } deletedResource := isDeletedResource(anyOfSchema) if deleted == deletedResource { return anyOfSchema, nil } } return nil, nil } func (g *DataGenerator) maybeDereference(schema *spec.Schema, context string) (*spec.Schema, string, error) { if schema.Ref != "" { definition := definitionFromJSONPointer(schema.Ref) newSchema, ok := g.definitions[definition] if !ok { panic(fmt.Sprintf("Couldn't dereference: %v", schema.Ref)) } context = fmt.Sprintf("%sDereferencing '%s':\n", context, schema.Ref) schema = newSchema } return schema, context, nil } func (g *DataGenerator) generateURLForListableResource(schema *spec.Schema, params *GenerateParams) string { var val string const regexPlaceholder = "[^/]+" if strings.HasPrefix(schema.Pattern, "^") { // Many listable resources have a URL pattern of the form "^/v1/tax/calculations/[^/]+/line_items"; // we cut off the "^" to leave the URL and replace placeholders with ids. val = schema.Pattern[1:] if strings.Index(val, regexPlaceholder) != -1 { val = strings.Replace(val, regexPlaceholder, "id_123", 1) } } else if params.example != nil { // If an example was provided, we can assume it has the correct format example := params.example.value.(map[string]interface{}) val = example["url"].(string) } else { val = params.RequestPath } return val } func (g *DataGenerator) generateListResource(params *GenerateParams) (interface{}, error) { var itemExpansions *ExpansionLevel if params.Expansions != nil { itemExpansions = params.Expansions.expansions["data"] } itemData, err := g.generateInternal(&GenerateParams{ Expansions: itemExpansions, PathParams: nil, RequestMethod: params.RequestMethod, RequestPath: params.RequestPath, Schema: params.Schema.Properties["data"].Items, context: fmt.Sprintf("%sPopulating list resource:\n", params.context), example: nil, }) if err != nil { return nil, err } // This is written to hopefully be a little more forward compatible in that // it respects the list properties dictated by the included schema rather // than assuming its own. listData := make(map[string]interface{}) for key, subSchema := range params.Schema.Properties { var val interface{} switch key { case "data": val = []interface{}{itemData} case "has_more": val = false case "object": val = "list" case "total_count": val = 1 case "url": val = g.generateURLForListableResource(subSchema, params) default: val = nil } listData[key] = val } return listData, nil } func (g *DataGenerator) generateSearchResultResource(params *GenerateParams) (interface{}, error) { var itemExpansions *ExpansionLevel if params.Expansions != nil { itemExpansions = params.Expansions.expansions["data"] } itemData, err := g.generateInternal(&GenerateParams{ Expansions: itemExpansions, PathParams: nil, RequestMethod: params.RequestMethod, RequestPath: params.RequestPath, Schema: params.Schema.Properties["data"].Items, context: fmt.Sprintf("%sPopulating search_result resource:\n", params.context), example: nil, }) if err != nil { return nil, err } // This is written to hopefully be a little more forward compatible in that // it respects the search_result properties dictated by the included schema rather // than assuming its own. searchResultData := make(map[string]interface{}) for key, subSchema := range params.Schema.Properties { var val interface{} switch key { case "data": val = []interface{}{itemData} case "has_more": val = false case "next_page": // We don't return `next_page` when `has_more` = false. continue case "object": val = "search_result" case "total_count": val = 1 case "url": val = g.generateURLForListableResource(subSchema, params) default: val = nil } searchResultData[key] = val } return searchResultData, nil } // // Private constants // // randomIDRandomLength is the length of the random part of a random ID. const randomIDRandomLength = 10 // randomIDTimeLength is the length of the time part of a random ID. const randomIDTimeLength = 5 // randomIDTimeReference is a reference time used for generating random IDs // that's used to truncate the total amount of information that we need to // encode. // // Its original choice was somewhat arbitrary, but it doesn't matter that much // as long as it stays stable. const randomIDTimeReference = 1342389380 // // Private values // var errExpansionNotSupported = fmt.Errorf("Expansion not supported") // randomIDRunes are the set of possible runes that may appear in the time part // of a random ID. var randomIDRunes = []rune("01234567890ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz") // // Private types // // valueWrapper wraps an example value that we're generating. // // It exists so that we can make a distinction between an example that we don't // have (where `valueWrapper` itself is `nil`) from one where we have an // example, but it has a `null` value (where we'd have `valueWrapper{value: // nil}`). type valueWrapper struct { value interface{} } // // Private functions // // definitionFromJSONPointer extracts the name of a JSON schema definition from // a JSON pointer, so "#/components/schemas/charge" would become just "charge". // This is a simplified workaround to avoid bringing in JSON schema // infrastructure because we can guarantee that the spec we're producing will // take a certain shape. If this gets too hacky, it will be better to put a more // legitimate JSON schema parser in place. func definitionFromJSONPointer(pointer string) string { parts := strings.Split(pointer, "/") if len(parts) != 4 || parts[0] != "#" || parts[1] != "components" || parts[2] != "schemas" { panic(fmt.Sprintf("Expected '#/components/schemas/...' but got '%v'", pointer)) } return parts[3] } // distributeReplacedIDs descends through a generated data structure // recursively looking for IDs that were generated during data generation and // replaces them with their appropriate replacement value. func distributeReplacedIDs(pathParams *PathParamsMap, data interface{}) { dataSlice, ok := data.([]interface{}) if ok { for _, val := range dataSlice { distributeReplacedIDs(pathParams, val) } return } dataMap, ok := data.(map[string]interface{}) if !ok { return } for key, value := range dataMap { newValue, ok := distributeReplacedIDsInValue(pathParams, value) if ok { dataMap[key] = newValue continue } if key == "url" { newValue, ok := distributeReplacedIDsInURL(pathParams, value) if ok { dataMap[key] = newValue continue } } distributeReplacedIDs(pathParams, value) } } // distributeReplacedIDsInValue returns a new value for the `url` field of a // list object if it's detected that its value contained an ID that we replaced // with an injected one. // // For example, in the URL `/v1/charges/ch_123/refunds`, `ch_123` may have been // a replaced ID. func distributeReplacedIDsInURL(pathParams *PathParamsMap, value interface{}) (string, bool) { valStr, ok := value.(string) if !ok { return "", false } if pathParams.replacedPrimaryID != nil { search := "/" + *pathParams.replacedPrimaryID + "/" if strings.Index(valStr, search) != -1 { return strings.Replace(valStr, search, "/"+*pathParams.PrimaryID+"/", 1), true } } for _, secondaryID := range pathParams.SecondaryIDs { for _, replacedID := range secondaryID.replacedIDs { search := "/" + replacedID + "/" if strings.Index(valStr, search) != -1 { return strings.Replace(valStr, search, "/"+secondaryID.ID+"/", 1), true } } } return "", false } // distributeReplacedIDsInValue returns a new value for an existing one if it's // detected that its value was an ID that we replaced with an injected one. // // It works by comparing the value against any replacement ID values that were // found in pathParams. Replacement IDs were added to pathParams when the // generator was doing another pass earlier on in the process. func distributeReplacedIDsInValue(pathParams *PathParamsMap, value interface{}) (string, bool) { valStr, ok := value.(string) if !ok { return "", false } if pathParams.replacedPrimaryID != nil && valStr == *pathParams.replacedPrimaryID { return *pathParams.PrimaryID, true } for _, secondaryID := range pathParams.SecondaryIDs { for _, replacedID := range secondaryID.replacedIDs { if valStr == replacedID { return secondaryID.ID, true } } } return "", false } // generateSyntheticFixture generates a synthetic fixture for the given schema // by examining its properties and returning default values for each. // // This is useful in cases where we don't have a valid fixture for some object. // That could happen for a prerelease object or in cases where an expansion has // been requested for an embedded object that doesn't occur at the top level of // the API. // // This function calls itself recursively by initially iterating through every // property in an object schema, then recursing and returning values for // embedded objects and scalars. func (g *DataGenerator) generateSyntheticFixture(schema *spec.Schema, context string, expansions *ExpansionLevel) interface{} { context = fmt.Sprintf("%sGenerating synthetic fixture: %+v\n", context, schema) // Return the minimum viable object by returning nil/null for a nullable // property, if that property does not need to be expanded. if schema.Nullable && expansions == nil { return nil } // Return a member of an enum if one is available because it's probably // going to be a more realistic value. if len(schema.Enum) > 0 { return schema.Enum[0] } if len(schema.AnyOf) > 0 { // Try the non-references first. for _, subSchema := range schema.AnyOf { if subSchema.Ref != "" { continue } return g.generateSyntheticFixture(subSchema, context, expansions) } // If no viable non-references, attempt to dereference the references for _, subSchema := range schema.AnyOf { if subSchema.Ref == "" { continue } dereferencedSchema, context, err := g.maybeDereference(subSchema, context) if err != nil { panic(err) } return g.generateSyntheticFixture(dereferencedSchema, context, expansions) } panic("Unexpected: anyOf with length > 0 should have contained a ref or non ref") } switch schema.Type { case spec.TypeArray: return []string{} case spec.TypeBoolean: return true case spec.TypeInteger: return 0 case spec.TypeNumber: return 0.0 case spec.TypeObject: fixture := make(map[string]interface{}) for property, subSchema := range schema.Properties { // Return the minimum viable object by not including properties // that are not necessary for a valid object. if !isRequiredProperty(schema, property) { continue } var propertyExpansions *ExpansionLevel if expansions != nil && expansions.expansions[property] != nil { propertyExpansions = expansions.expansions[property] } fixture[property] = g.generateSyntheticFixture(subSchema, context, propertyExpansions) } return fixture case spec.TypeString: return "" } panic(fmt.Sprintf("%sUnhandled type: %s", context, stringOrEmpty(schema.Type))) } func isDeletedResource(schema *spec.Schema) bool { _, ok := schema.Properties["deleted"] return ok } func isListResource(schema *spec.Schema) bool { if schema.Type != "object" || schema.Properties == nil { return false } object, ok := schema.Properties["object"] if !ok || object.Enum == nil || object.Enum[0] != "list" { return false } data, ok := schema.Properties["data"] if !ok || data.Items == nil { return false } return true } func isSearchResultResource(schema *spec.Schema) bool { if schema.Type != "object" || schema.Properties == nil { return false } object, ok := schema.Properties["object"] if !ok || object.Enum == nil || object.Enum[0] != "search_result" { return false } data, ok := schema.Properties["data"] if !ok || data.Items == nil { return false } return true } func isBinaryResource(schema *spec.Schema) bool { return schema.Format == "binary" && schema.Type == "string" } // isRequiredProperty checks whether the given property name is required for // the given schema. Note that this assumes that the schema is of type object // because that would be semantic nonsense for any other type. func isRequiredProperty(schema *spec.Schema, name string) bool { for _, property := range schema.Required { if name == property { return true } } return false } // logReplacedID is just a logging shortcut for replaceIDsInternal so that we // can keep its function body more succinct. func logReplacedID(prevID, newID string, verbose bool) { if !verbose { return } fmt.Printf("Found ID to replace; previous: '%s' new: '%s'\n", prevID, newID) } // maybeGeneratePrimaryID generates a new primary ID and returns it as part of // a `PathParamsMap` if (1) the given data has an `id` field which can be used // to determine the correct prefix that should be used, and (2) there isn't a // primary ID already set. // // The main case where it'll kick in is if there was no primary ID extracted // from the incoming path, in which case a primary ID is generated so that // simulated new objects from stripe-mock all have unique IDs. // // So for example, a `POST /v1/charges` will result in a newly generated ID // with a `ch` prefix like `ch_123`. func maybeGeneratePrimaryID(pathParams *PathParamsMap, data interface{}) *PathParamsMap { // Do nothing in case we already have a primary ID. if pathParams != nil && pathParams.PrimaryID != nil { return pathParams } idObj, ok := data.(map[string]interface{})["id"] // If we don't have an appropriate ID field to look like at the root of the // object, do nothing. // // This will filter out list endpoints, for example. if !ok { return pathParams } id, ok := idObj.(string) // If the ID isn't a string, do nothing. if !ok { return pathParams } prefix := id usInd := strings.LastIndex(id, "_") // Like `sub_sched`. if usInd != -1 { prefix = id[:usInd] } newID := randomID(prefix) if pathParams == nil { return &PathParamsMap{PrimaryID: &newID} } pathParams.PrimaryID = &newID return pathParams } // propertyNames returns the names of all properties of a schema joined // together and comma-separated. // // This is useful for printing debugging information. func propertyNames(schema *spec.Schema) string { var names []string for name := range schema.Properties { names = append(names, name) } // Sort just so we can have stable output to test against (the order at // which keys will be iterated in the map is undefined). sort.Strings(names) return strings.Join(names, ", ") } // randomID generates a Stripe-like ID suitable for use identifying an object. // // As with the real Stripe API, the general format looks like: // // _ // // The prefix helps identify the type of object. For example, charges have a // `ch` prefix. // // The time part is based on the current time encoded in a more succinct form // using a wider character set (0-9A-Za-z instead of just the numbers of a Unix // timestamp). It's present so that newly generated IDs come back in roughly // ascending order (although they are not *guaranteed* to be ascending). // // The random part is a random number encoded to a wider character set. func randomID(prefix string) string { return prefix + "_" + randomIDTimePart() + randomIDRandomPart() } // randomIDRandomPart generates the random part of a new ID. func randomIDRandomPart() string { runes := make([]rune, randomIDRandomLength) for i := 0; i < randomIDRandomLength; i++ { runes[i] = randomIDRunes[rand.Intn(len(randomIDRunes))] } return string(runes) } // randomIDTimePart generates the time part of a new ID using only a slightly // simplified methodology compared to the real Stripe API. func randomIDTimePart() string { delta := int(time.Now().Unix() - randomIDTimeReference) runes := make([]rune, randomIDTimeLength) for i := 0; i < randomIDTimeLength; i++ { // Note that new characters go in backwards runes[i] = randomIDRunes[delta%len(randomIDRunes)] delta /= len(randomIDRunes) } // As we continue to mod on delta in iterations above, the runes produced // get ever more stable. // // Here we reverse the slice so that the more changeable runes (i.e. those // representing small time components) appear on the rightmost side of the // final string. for i, j := 0, len(runes)-1; i < j; i, j = i+1, j-1 { runes[i], runes[j] = runes[j], runes[i] } return string(runes) } // recordAndReplaceIDs descends through a generated data structure recursively // looking for object IDs and replaces them with values from the request's URL // (i.e., what's in pathParams) where appropriate. // // Returns the same PathParamsMap given to it as a parameter, after some // mutation. It's returned to add clarity as to what's happening to its // invocation sites. func recordAndReplaceIDs(pathParams *PathParamsMap, data interface{}, verbose bool) *PathParamsMap { recordAndReplaceIDsInternal(pathParams, data, nil, 0, verbose) return pathParams } // recordAndReplaceIDsInternal is identical to recordAndReplaceIDs, but is an // internal interface that tracks a parent key and recursion level. Use // recordAndReplaceIDs instead. func recordAndReplaceIDsInternal(pathParams *PathParamsMap, data interface{}, parentKey *string, recurseLevel int, verbose bool) { dataSlice, ok := data.([]interface{}) if ok { for _, val := range dataSlice { recordAndReplaceIDsInternal(pathParams, val, nil, recurseLevel+1, verbose) } return } dataMap, ok := data.(map[string]interface{}) if !ok { return } for key, val := range dataMap { strVal, ok := val.(string) if key == "id" && ok { if recurseLevel == 0 { // We'll only use a primary ID at the top level of the object // (which is why we track recursion level). if pathParams.PrimaryID != nil { pathParams.replacedPrimaryID = &strVal dataMap["id"] = *pathParams.PrimaryID logReplacedID(strVal, *pathParams.PrimaryID, verbose) } } else { // After the object's top level, we'll replace an object's ID // if either of these two values are the same s the secondary // ID's name (i.e., the "name" for the parameter that was // extracted from the path in OpenAPI): // // (1) The value in the object's `object` field. // (2) The value of the object's parent key (e.g., say it's a // "charge" object that was nested under a refund's // `charge` key). objectVal, ok := dataMap["object"].(string) if ok { for _, secondaryID := range pathParams.SecondaryIDs { if objectVal == secondaryID.Name { secondaryID.appendReplacedID(strVal) dataMap["id"] = secondaryID.ID logReplacedID(strVal, secondaryID.ID, verbose) break } } } for _, secondaryID := range pathParams.SecondaryIDs { if parentKey != nil && *parentKey == secondaryID.Name { secondaryID.appendReplacedID(strVal) dataMap["id"] = secondaryID.ID logReplacedID(strVal, secondaryID.ID, verbose) break } } } } else { if ok { // This path replaces a string value with a secondary ID if the // name of the field matches the secondary ID's target name. // // For example, an application fee refund might have an // embedded `fee` field which is the ID of its parent // application fee (unless it's expanded, at which point it // will be handled by the case above). for _, secondaryID := range pathParams.SecondaryIDs { if key == secondaryID.Name { secondaryID.appendReplacedID(strVal) dataMap[key] = secondaryID.ID logReplacedID(strVal, secondaryID.ID, verbose) break } } } else { recordAndReplaceIDsInternal(pathParams, val, &key, recurseLevel+1, verbose) } } } } // stringOrEmpty returns the string given as parameter, or the string "(empty)" // if the string was empty. // // This is useful in cases like logging to make sure that something is always // printed on screen (instead of a strangely truncated sentence for an empty // value). func stringOrEmpty(s string) string { if s == "" { return "(empty)" } return s } stripe-mock-0.196.0/server/generator_test.go000066400000000000000000000727331506013555700210310ustar00rootroot00000000000000package server import ( "encoding/json" "fmt" "net/http" "regexp" "sync" "testing" assert "github.com/stretchr/testify/require" "github.com/stripe/stripe-mock/spec" ) var listSchema *spec.Schema var listSchemaWithPlaceholder *spec.Schema var searchResultSchema *spec.Schema var verbose bool func init() { listSchema = &spec.Schema{ Type: "object", Properties: map[string]*spec.Schema{ "data": { Items: &spec.Schema{ Ref: "#/components/schemas/charge", }, }, "has_more": { Type: "boolean", }, "object": { Enum: []interface{}{"list"}, }, "total_count": { Type: "integer", }, "url": { Type: "string", Pattern: "^/v1/charges", }, }, } listSchemaWithPlaceholder = &spec.Schema{ Type: "object", Properties: map[string]*spec.Schema{ "data": { Items: &spec.Schema{ Ref: "#/components/schemas/charge", }, }, "has_more": { Type: "boolean", }, "object": { Enum: []interface{}{"list"}, }, "total_count": { Type: "integer", }, "url": { Type: "string", Pattern: "^/v1/charges/[^/]+/nested_list", }, }, } searchResultSchema = &spec.Schema{ Type: "object", Properties: map[string]*spec.Schema{ "data": { Items: &spec.Schema{ Ref: "#/components/schemas/charge", }, }, "has_more": { Type: "boolean", }, "object": { Enum: []interface{}{"search_result"}, }, "total_count": { Type: "integer", }, "url": { Type: "string", Pattern: "^/v1/search/charges", }, }, } } // // Tests // func TestConcurrentAccess(t *testing.T) { var generator DataGenerator // We use the real spec here because when there was a concurrency problem, // it wasn't revealed due to the test spec being oversimplistic. generator = DataGenerator{realSpec.Components.Schemas, &realFixtures, verbose} var wg sync.WaitGroup for i := 0; i < 100; i++ { wg.Add(1) go func() { defer wg.Done() _, err := generator.Generate(&GenerateParams{ Schema: &spec.Schema{Ref: "#/components/schemas/subscription"}, }) assert.NoError(t, err) }() } wg.Wait() } func TestGenerateResponseData(t *testing.T) { // basic reference { generator := DataGenerator{testSpec.Components.Schemas, &testFixtures, verbose} data, err := generator.Generate(&GenerateParams{ Schema: &spec.Schema{Ref: "#/components/schemas/charge"}, }) assert.Nil(t, err) assert.Equal(t, testFixtures.Resources["charge"].(map[string]interface{})["object"], data.(map[string]interface{})["object"]) // Makes sure that customer is *not* expanded assert.Equal(t, testFixtures.Resources["customer"].(map[string]interface{})["id"], data.(map[string]interface{})["customer"]) } // expansion { generator := DataGenerator{testSpec.Components.Schemas, &testFixtures, verbose} data, err := generator.Generate(&GenerateParams{ Expansions: &ExpansionLevel{ expansions: map[string]*ExpansionLevel{"customer": { expansions: map[string]*ExpansionLevel{}}, }, }, Schema: &spec.Schema{Ref: "#/components/schemas/charge"}, }) assert.Nil(t, err) assert.Equal(t, testFixtures.Resources["customer"].(map[string]interface{})["id"], data.(map[string]interface{})["customer"].(map[string]interface{})["id"]) } // bad expansion { generator := DataGenerator{testSpec.Components.Schemas, &testFixtures, verbose} _, err := generator.Generate(&GenerateParams{ Expansions: &ExpansionLevel{ expansions: map[string]*ExpansionLevel{"id": { expansions: map[string]*ExpansionLevel{}}, }, }, Schema: &spec.Schema{Ref: "#/components/schemas/charge"}, }) assert.Equal(t, err, errExpansionNotSupported) } // bad nested expansion { generator := DataGenerator{testSpec.Components.Schemas, &testFixtures, verbose} _, err := generator.Generate(&GenerateParams{ Expansions: &ExpansionLevel{ expansions: map[string]*ExpansionLevel{"customer.id": { expansions: map[string]*ExpansionLevel{}}, }, }, Schema: &spec.Schema{Ref: "#/components/schemas/charge"}, }) assert.Equal(t, err, errExpansionNotSupported) } // wildcard expansion { generator := DataGenerator{testSpec.Components.Schemas, &testFixtures, verbose} data, err := generator.Generate(&GenerateParams{ Expansions: &ExpansionLevel{wildcard: true}, Schema: &spec.Schema{Ref: "#/components/schemas/charge"}, }) assert.Nil(t, err) assert.Equal(t, testFixtures.Resources["customer"].(map[string]interface{})["id"], data.(map[string]interface{})["customer"].(map[string]interface{})["id"]) } // list { generator := DataGenerator{testSpec.Components.Schemas, &testFixtures, verbose} data, err := generator.Generate(&GenerateParams{ RequestPath: "/v1/charges", Schema: listSchema, }) assert.Nil(t, err) assert.Equal(t, "list", data.(map[string]interface{})["object"]) assert.Equal(t, "/v1/charges", data.(map[string]interface{})["url"]) assert.Equal(t, testFixtures.Resources["charge"].(map[string]interface{})["id"], data.(map[string]interface{})["data"].([]interface{})[0].(map[string]interface{})["id"]) } // nested list { generator := DataGenerator{ testSpec.Components.Schemas, &spec.Fixtures{ Resources: map[spec.ResourceID]interface{}{ spec.ResourceID("charge"): map[string]interface{}{"id": "ch_123"}, spec.ResourceID("with_charges_list"): map[string]interface{}{ "charges_list": map[string]interface{}{ "url": "/v1/charges", }, }, }, }, verbose, } data, err := generator.Generate(&GenerateParams{ Schema: &spec.Schema{ Type: "object", Properties: map[string]*spec.Schema{ "charges_list": listSchema, }, XResourceID: "with_charges_list", }, }) assert.Nil(t, err) chargesList := data.(map[string]interface{})["charges_list"] assert.Equal(t, "list", chargesList.(map[string]interface{})["object"]) assert.Equal(t, "/v1/charges", chargesList.(map[string]interface{})["url"]) assert.Equal(t, testFixtures.Resources["charge"].(map[string]interface{})["id"], chargesList.(map[string]interface{})["data"].([]interface{})[0].(map[string]interface{})["id"]) } // search result { generator := DataGenerator{testSpec.Components.Schemas, &testFixtures, verbose} data, err := generator.Generate(&GenerateParams{ RequestPath: "/v1/search/charges", Schema: searchResultSchema, }) assert.Nil(t, err) assert.Equal(t, "search_result", data.(map[string]interface{})["object"]) assert.Equal(t, "/v1/search/charges", data.(map[string]interface{})["url"]) assert.Equal(t, testFixtures.Resources["charge"].(map[string]interface{})["id"], data.(map[string]interface{})["data"].([]interface{})[0].(map[string]interface{})["id"]) } // generated primary ID { generator := DataGenerator{testSpec.Components.Schemas, &spec.Fixtures{ Resources: map[spec.ResourceID]interface{}{ spec.ResourceID("charge"): map[string]interface{}{ "id": "ch_123", }, }, }, verbose} data, err := generator.Generate(&GenerateParams{ PathParams: &PathParamsMap{}, Schema: &spec.Schema{Ref: "#/components/schemas/charge"}, }) assert.Nil(t, err) // Should not be equal to our fixture's ID because it's generated. assert.NotEqual(t, "ch_123", data.(map[string]interface{})["id"]) // However, the fixture's ID's prefix will have been used to generate // the new ID, so it should share a prefix. assert.Regexp(t, regexp.MustCompile("^ch_"), data.(map[string]interface{})["id"]) } // generated primary ID (double prefix) { generator := DataGenerator{testSpec.Components.Schemas, &spec.Fixtures{ Resources: map[spec.ResourceID]interface{}{ spec.ResourceID("charge"): map[string]interface{}{ "id": "ch_sub_123", }, }, }, verbose} data, err := generator.Generate(&GenerateParams{ PathParams: &PathParamsMap{}, Schema: &spec.Schema{Ref: "#/components/schemas/charge"}, }) assert.Nil(t, err) // Should not be equal to our fixture's ID because it's generated. assert.NotEqual(t, "ch_sub_123", data.(map[string]interface{})["id"]) // However, the fixture's ID's prefix will have been used to generate // the new ID, so it should share a prefix. assert.Regexp(t, regexp.MustCompile("^ch_sub_"), data.(map[string]interface{})["id"]) } // generated primary ID (nil PathParamsMap) { generator := DataGenerator{testSpec.Components.Schemas, &spec.Fixtures{ Resources: map[spec.ResourceID]interface{}{ spec.ResourceID("charge"): map[string]interface{}{ "id": "ch_123", }, }, }, verbose} data, err := generator.Generate(&GenerateParams{ PathParams: nil, Schema: &spec.Schema{Ref: "#/components/schemas/charge"}, }) assert.Nil(t, err) // Should not be equal to our fixture's ID because it's generated. assert.NotEqual(t, "ch_123", data.(map[string]interface{})["id"]) // However, the fixture's ID's prefix will have been used to generate // the new ID, so it should share a prefix. assert.Regexp(t, regexp.MustCompile("^ch_"), data.(map[string]interface{})["id"]) } // injected ID { generator := DataGenerator{testSpec.Components.Schemas, &spec.Fixtures{ Resources: map[spec.ResourceID]interface{}{ spec.ResourceID("charge"): map[string]interface{}{ // This is contrived, but we inject the value we expect to be // replaced into `customer` as well so that we can verify the // secondary behavior that replaces all values that look like a // replaced ID (as well as the ID). "customer": "ch_123", "id": "ch_123", }, }, }, verbose} newID := "ch_123_InjectedFromURL" data, err := generator.Generate(&GenerateParams{ PathParams: &PathParamsMap{PrimaryID: &newID}, Schema: &spec.Schema{Ref: "#/components/schemas/charge"}, }) assert.Nil(t, err) assert.Equal(t, newID, data.(map[string]interface{})["id"]) assert.Equal(t, newID, data.(map[string]interface{})["customer"]) } // injected ID in list url { generator := DataGenerator{ testSpec.Components.Schemas, &spec.Fixtures{ Resources: map[spec.ResourceID]interface{}{ spec.ResourceID("charge"): map[string]interface{}{"id": "ch_123"}, spec.ResourceID("with_charges_list"): map[string]interface{}{ "charges_list": map[string]interface{}{ "url": "/v1/charges", }, }, }, }, verbose, } data, err := generator.Generate(&GenerateParams{ Schema: &spec.Schema{ Type: "object", Properties: map[string]*spec.Schema{ "charges_list": listSchemaWithPlaceholder, }, XResourceID: "with_charges_list", }, }) assert.Nil(t, err) chargesList := data.(map[string]interface{})["charges_list"] assert.Equal(t, "list", chargesList.(map[string]interface{})["object"]) assert.Equal(t, "/v1/charges/id_123/nested_list", chargesList.(map[string]interface{})["url"]) assert.Equal(t, testFixtures.Resources["charge"].(map[string]interface{})["id"], chargesList.(map[string]interface{})["data"].([]interface{})[0].(map[string]interface{})["id"]) } // injected secondary ID { generator := DataGenerator{testSpec.Components.Schemas, &spec.Fixtures{ Resources: map[spec.ResourceID]interface{}{ spec.ResourceID("charge"): map[string]interface{}{ "id": "ch_123", }, spec.ResourceID("customer"): map[string]interface{}{ "id": "cus_123", "object": "customer", }, }, }, verbose} newCustomerID := "cus_123_InjectedFromURL" data, err := generator.Generate(&GenerateParams{ Expansions: &ExpansionLevel{ expansions: map[string]*ExpansionLevel{"customer": { expansions: map[string]*ExpansionLevel{}}, }, }, PathParams: &PathParamsMap{ SecondaryIDs: []*PathParamsSecondaryID{ {ID: newCustomerID, Name: "customer"}, }, }, Schema: &spec.Schema{Ref: "#/components/schemas/charge"}, }) assert.Nil(t, err) // The top level ID. It will have been randomized, but should still be // a charge. assert.Regexp(t, regexp.MustCompile("^ch_"), data.(map[string]interface{})["id"]) // The nested customer ID. This should have changed. assert.Equal(t, map[string]interface{}{ "id": newCustomerID, "object": "customer", }, data.(map[string]interface{})["customer"]) } // data replacement on `POST` { generator := DataGenerator{testSpec.Components.Schemas, &testFixtures, verbose} data, err := generator.Generate(&GenerateParams{ RequestData: map[string]interface{}{ "customer": "cus_9999", }, RequestMethod: http.MethodPost, Schema: &spec.Schema{Ref: "#/components/schemas/charge"}, }) assert.Nil(t, err) assert.Equal(t, "cus_9999", data.(map[string]interface{})["customer"]) } // *no* data replacement on non-`POST` { generator := DataGenerator{testSpec.Components.Schemas, &testFixtures, verbose} data, err := generator.Generate(&GenerateParams{ RequestData: map[string]interface{}{ "customer": "cus_9999", }, RequestMethod: http.MethodGet, Schema: &spec.Schema{Ref: "#/components/schemas/charge"}, }) assert.Nil(t, err) assert.NotEqual(t, "cus_9999", data.(map[string]interface{})["customer"]) } // synthetic schema { generator := DataGenerator{testSpec.Components.Schemas, &testFixtures, verbose} data, err := generator.Generate(&GenerateParams{ Schema: &spec.Schema{ Properties: map[string]*spec.Schema{ "string_property": { Type: spec.TypeString, }, }, Required: []string{"string_property"}, Type: spec.TypeObject, XResourceID: "", }, }) assert.Nil(t, err) assert.Equal(t, map[string]interface{}{ "string_property": "", }, data, ) } // pick non-deleted anyOf branch { generator := DataGenerator{testSpec.Components.Schemas, &testFixtures, verbose} data, err := generator.Generate(&GenerateParams{ // Just needs to be any HTTP method that's not DELETE RequestMethod: http.MethodPost, Schema: &spec.Schema{AnyOf: []*spec.Schema{ // put the deleted version first so we know it's not just // returning the first result {Ref: "#/components/schemas/deleted_customer"}, {Ref: "#/components/schemas/customer"}, }}, }) assert.Nil(t, err) // There should be no deleted field _, ok := data.(map[string]interface{})["deleted"] assert.False(t, ok) } // pick deleted anyOf branch { generator := DataGenerator{testSpec.Components.Schemas, &testFixtures, verbose} data, err := generator.Generate(&GenerateParams{ RequestMethod: http.MethodDelete, Schema: &spec.Schema{AnyOf: []*spec.Schema{ // put the non-deleted version first so we know it's not just // returning the first result {Ref: "#/components/schemas/customer"}, {Ref: "#/components/schemas/deleted_customer"}, }}, }) assert.Nil(t, err) // There should be a deleted field _, ok := data.(map[string]interface{})["deleted"] assert.True(t, ok) } // binary schema { generator := DataGenerator{testSpec.Components.Schemas, &testFixtures, verbose} data, err := generator.Generate(&GenerateParams{ RequestMethod: http.MethodGet, Schema: &spec.Schema{ Format: "binary", Type: "string", }}) assert.Nil(t, err) assert.Equal(t, data, "Stripe binary response") } } func TestValidFixtures(t *testing.T) { // Every fixture should validate according to the schema it's a fixture for for name, schema := range realSpec.Components.Schemas { if schema.XResourceID == "" { continue } t.Run(name, func(t2 *testing.T) { fixture, ok := realFixtures.Resources[spec.ResourceID(schema.XResourceID)] assert.True(t2, ok) validator, err := spec.GetValidatorForOpenAPI3Schema(schema, realComponentsForValidation) assert.NoError(t2, err) err = validator.Validate(fixture) assert.NoError(t2, err) }) } } func TestResourcesCanBeGenerated(t *testing.T) { for url, operations := range realSpec.Paths { for method, operation := range operations { response := operation.Responses[spec.StatusCode("200")] if jsonMediaType, ok := response.Content["application/json"]; ok { t.Run( fmt.Sprintf("%s %s (without expansions)", method, url), func(t2 *testing.T) { testCanGenerate(t2, url, jsonMediaType.Schema, false) }, ) } else if pdfMediaType, ok := response.Content["application/pdf"]; ok { t.Run( fmt.Sprintf("%s %s PDF", method, url), func(t2 *testing.T) { testCanGeneratePdf(t2, url, pdfMediaType.Schema) }, ) } else { t.Errorf("%s %s does not have a supported content type. Content types: %s", method, url, response.Content) } } } } func TestResourcesCanBeGeneratedAndExpanded(t *testing.T) { t.Skip("This test is known to fail because fixtures are missing for some " + "expandable subresources.") for url, operations := range realSpec.Paths { for method, operation := range operations { response := operation.Responses[spec.StatusCode("200")] if jsonMediaType, ok := response.Content["application/json"]; ok { t.Run( fmt.Sprintf("%s %s (with expansions)", method, url), func(t2 *testing.T) { testCanGenerate(t2, url, jsonMediaType.Schema, true) }, ) } else if _, ok := response.Content["application/pdf"]; ok { // Do nothing for PDFs as expansion doesn't mean anything. } else { t.Errorf("%s %s does not have a supported content type. Content types: %s", method, url, response.Content) } } } } // // Tests for private functions // func TestDefinitionFromJSONPointer(t *testing.T) { definition := definitionFromJSONPointer("#/components/schemas/charge") assert.Equal(t, "charge", definition) } // This is meant as quite a blunt test. See TestMaybeReplaceID for something // that's probably easier to introspect/debug. func TestDistributeReplacedIDs(t *testing.T) { newID := "new-id" oldID := "old-id" newSecondaryID := "new-secondary-id" oldSecondaryID := "old-secondary-id" pathParams := &PathParamsMap{ PrimaryID: &newID, replacedPrimaryID: &oldID, SecondaryIDs: []*PathParamsSecondaryID{ { ID: newSecondaryID, replacedIDs: []string{oldSecondaryID}, }, }, } data := map[string]interface{}{ "key_with_id": oldID, "unrelated_key": "foo", "nested": map[string]interface{}{ "key_with_secondary_id": oldSecondaryID, "slice": []interface{}{ map[string]interface{}{ "key_with_id": oldID, "unrelated_key": "foo", "url": "/v1/charges/" + oldID + "/refunds", }, }, }, } // This function modifies structure in place. distributeReplacedIDs(pathParams, data) assert.Equal(t, map[string]interface{}{ "key_with_id": newID, "unrelated_key": "foo", "nested": map[string]interface{}{ "key_with_secondary_id": newSecondaryID, "slice": []interface{}{ map[string]interface{}{ "key_with_id": newID, "unrelated_key": "foo", "url": "/v1/charges/" + newID + "/refunds", }, }, }, }, data, ) } func TestDistributeReplacedIDsInURL(t *testing.T) { newID := "new-id" oldID := "old-id" newSecondaryID := "new-secondary-id" oldSecondaryID := "old-secondary-id" pathParams := &PathParamsMap{ PrimaryID: &newID, replacedPrimaryID: &oldID, SecondaryIDs: []*PathParamsSecondaryID{ { ID: newSecondaryID, replacedIDs: []string{oldSecondaryID}, }, }, } // Replaces primary ID { data, ok := distributeReplacedIDsInURL(pathParams, "/v1/charges/"+oldID+"/refunds") assert.True(t, ok) assert.Equal(t, "/v1/charges/"+newID+"/refunds", data) } // Replaces secondary ID { data, ok := distributeReplacedIDsInURL(pathParams, "/v1/charges/"+oldSecondaryID+"/refunds") assert.True(t, ok) assert.Equal(t, "/v1/charges/"+newSecondaryID+"/refunds", data) } // Doesn't replace a value that's not present { _, ok := distributeReplacedIDsInURL(pathParams, "/v1/charges/other/refunds") assert.False(t, ok) } // Works fine on a non-string data type (by ignoring it) { _, ok := distributeReplacedIDsInURL(pathParams, 123) assert.False(t, ok) } } func TestDistributeReplacedIDsInValue(t *testing.T) { newID := "new-id" oldID := "old-id" newSecondaryID := "new-secondary-id" oldSecondaryID := "old-secondary-id" pathParams := &PathParamsMap{ PrimaryID: &newID, replacedPrimaryID: &oldID, SecondaryIDs: []*PathParamsSecondaryID{ { ID: newSecondaryID, replacedIDs: []string{oldSecondaryID}, }, }, } // Replaces primary ID { data, ok := distributeReplacedIDsInValue(pathParams, oldID) assert.True(t, ok) assert.Equal(t, newID, data) } // Replaces secondary ID { data, ok := distributeReplacedIDsInValue(pathParams, oldSecondaryID) assert.True(t, ok) assert.Equal(t, newSecondaryID, data) } // Doesn't replace a value that's not present { _, ok := distributeReplacedIDsInValue(pathParams, "other") assert.False(t, ok) } // Works fine on a non-string data type (by ignoring it) { _, ok := distributeReplacedIDsInValue(pathParams, 123) assert.False(t, ok) } } func TestFindAnyOfBranch(t *testing.T) { deletedSchema := &spec.Schema{ Properties: map[string]*spec.Schema{ "deleted": nil, }, } nonDeletedSchema := &spec.Schema{} schema := &spec.Schema{ AnyOf: []*spec.Schema{ deletedSchema, nonDeletedSchema, }, } generator := DataGenerator{nil, nil, verbose} // Finds a deleted schema branch { anyOfSchema, err := generator.findAnyOfBranch(schema, true) assert.NoError(t, err) assert.Equal(t, deletedSchema, anyOfSchema) } // Finds a non-deleted schema branch { anyOfSchema, err := generator.findAnyOfBranch(schema, false) assert.NoError(t, err) assert.Equal(t, nonDeletedSchema, anyOfSchema) } // Safe to use on an empty schema { anyOfSchema, err := generator.findAnyOfBranch(&spec.Schema{}, false) assert.NoError(t, err) assert.Equal(t, (*spec.Schema)(nil), anyOfSchema) } } func TestGenerateSyntheticFixture(t *testing.T) { // Scalars (and an array, which is easy) g := DataGenerator{nil, nil, verbose} assert.Equal(t, []string{}, g.generateSyntheticFixture(&spec.Schema{Type: spec.TypeArray}, "", nil)) assert.Equal(t, true, g.generateSyntheticFixture(&spec.Schema{Type: spec.TypeBoolean}, "", nil)) assert.Equal(t, 0, g.generateSyntheticFixture(&spec.Schema{Type: spec.TypeInteger}, "", nil)) assert.Equal(t, 0.0, g.generateSyntheticFixture(&spec.Schema{Type: spec.TypeNumber}, "", nil)) assert.Equal(t, "", g.generateSyntheticFixture(&spec.Schema{Type: spec.TypeString}, "", nil)) // Nullable property assert.Equal(t, nil, g.generateSyntheticFixture(&spec.Schema{ Nullable: true, Type: spec.TypeString, }, "", nil)) // Property with enum assert.Equal(t, "list", g.generateSyntheticFixture(&spec.Schema{ Enum: []interface{}{"list"}, Type: spec.TypeString, }, "", nil)) // Takes the first non-reference branch of an anyOf assert.Equal(t, "", g.generateSyntheticFixture(&spec.Schema{ AnyOf: []*spec.Schema{ {Ref: "#/components/schemas/radar_rule"}, {Type: spec.TypeString}, }, }, "", nil)) // Object assert.Equal(t, map[string]interface{}{ "has_more": true, "object": "list", "url": "", }, g.generateSyntheticFixture(&spec.Schema{ Type: "object", Properties: map[string]*spec.Schema{ "has_more": { Type: "boolean", }, "object": { Enum: []interface{}{"list"}, }, "total_count": { Type: "integer", }, "url": { Type: "string", }, }, Required: []string{ "has_more", "object", "url", }, }, "", nil), ) // Nullable object property with expansion assert.Equal(t, map[string]interface{}{ "foo": "", }, g.generateSyntheticFixture(&spec.Schema{ Type: "object", Nullable: true, Properties: map[string]*spec.Schema{ "foo": { Type: "string", }, }, Required: []string{ "foo", }, }, "", &ExpansionLevel{ expansions: map[string]*ExpansionLevel{"foo": { expansions: map[string]*ExpansionLevel{}}, }, }), ) } func TestGenerateForNullableExpansion(t *testing.T) { generator := DataGenerator{ definitions: realSpec.Components.Schemas, fixtures: &realFixtures, verbose: verbose, } var example interface{} var err error assert.NotPanics(t, func() { example, err = generator.Generate(&GenerateParams{ Expansions: &ExpansionLevel{ expansions: map[string]*ExpansionLevel{"account_tax_ids": { expansions: map[string]*ExpansionLevel{}}, }, }, Schema: &spec.Schema{Ref: "#/components/schemas/invoice"}, }) }) assert.NoError(t, err) assert.NotNil(t, example) } func TestPropertyNames(t *testing.T) { assert.Equal(t, "bar, foo", propertyNames(&spec.Schema{ Properties: map[string]*spec.Schema{ "foo": nil, "bar": nil, }, })) assert.Equal(t, "", propertyNames(&spec.Schema{})) } func TestIsDeletedResource(t *testing.T) { assert.True(t, isDeletedResource(&spec.Schema{ Properties: map[string]*spec.Schema{ "deleted": nil, }, })) assert.False(t, isDeletedResource(&spec.Schema{})) } // This is meant as quite a blunt test. See TestMaybeReplaceID for something // that's probably easier to introspect/debug. func TestReplaceIDs(t *testing.T) { newID := "new-id" oldID := "old-id" newApplicationID := "new-application-id" oldApplicationID := "old-application-id" newChargeID := "new-charge-id" oldChargeID := "old-charge-id" // The generator handles multiple values for the same type of entity. Here // we're replacing two separate old charge IDs with a single new charge ID. otherOldChargeID := "other-charge-id" newRefundID := "new-refund-id" oldRefundID := "old-refund-id" newSourceID := "new-source-id" oldSourceID := "old-source-id" pathParams := &PathParamsMap{ PrimaryID: &newID, replacedPrimaryID: &oldID, SecondaryIDs: []*PathParamsSecondaryID{ { ID: newApplicationID, Name: "application", replacedIDs: nil, }, { ID: newChargeID, Name: "charge", replacedIDs: nil, }, { ID: newRefundID, Name: "refund", replacedIDs: nil, }, { ID: newSourceID, Name: "source", replacedIDs: nil, }, }, } data := map[string]interface{}{ "id": oldID, "embedded_charge": map[string]interface{}{ "id": oldChargeID, "object": "charge", "application": oldApplicationID, "embedded_refunds": []interface{}{ map[string]interface{}{ "id": oldRefundID, "object": "refund", }, }, "source": map[string]interface{}{ "id": oldSourceID, "object": "not-source", }, }, "charge": otherOldChargeID, "not_replaced": map[string]interface{}{ "id": "other-id", "object": "other", }, } // This function modifies structure in place. pathParams = recordAndReplaceIDs(pathParams, data, verbose) assert.Equal(t, oldID, *pathParams.replacedPrimaryID) assert.Equal(t, 1, len(pathParams.SecondaryIDs[0].replacedIDs)) assert.Contains(t, pathParams.SecondaryIDs[0].replacedIDs, oldApplicationID) assert.Equal(t, 2, len(pathParams.SecondaryIDs[1].replacedIDs)) assert.Contains(t, pathParams.SecondaryIDs[1].replacedIDs, oldChargeID) assert.Contains(t, pathParams.SecondaryIDs[1].replacedIDs, otherOldChargeID) assert.Equal(t, 1, len(pathParams.SecondaryIDs[2].replacedIDs)) assert.Contains(t, pathParams.SecondaryIDs[2].replacedIDs, oldRefundID) assert.Equal(t, 1, len(pathParams.SecondaryIDs[3].replacedIDs)) assert.Contains(t, pathParams.SecondaryIDs[3].replacedIDs, oldSourceID) assert.Equal(t, map[string]interface{}{ "id": newID, "embedded_charge": map[string]interface{}{ "id": newChargeID, "object": "charge", "application": newApplicationID, "embedded_refunds": []interface{}{ map[string]interface{}{ "id": newRefundID, "object": "refund", }, }, "source": map[string]interface{}{ "id": newSourceID, "object": "not-source", }, }, "charge": newChargeID, "not_replaced": map[string]interface{}{ "id": "other-id", "object": "other", }, }, data, ) } func TestStringOrEmpty(t *testing.T) { assert.Equal(t, "foo", stringOrEmpty("foo")) assert.Equal(t, "(empty)", stringOrEmpty("")) } // // Private functions // // Tests that DataGenerator can generate an example of the given schema, and // that the example validates against the schema correctly func testCanGenerate(t *testing.T, path spec.Path, schema *spec.Schema, expand bool) { assert.NotNil(t, schema) generator := DataGenerator{ definitions: realSpec.Components.Schemas, fixtures: &realFixtures, } var expansions *ExpansionLevel if expand { expansions = &ExpansionLevel{ expansions: make(map[string]*ExpansionLevel), wildcard: true, } } var example interface{} var err error assert.NotPanics(t, func() { example, err = generator.Generate(&GenerateParams{ Expansions: expansions, RequestPath: string(path), Schema: schema, }) }) assert.NoError(t, err) validator, err := spec.GetValidatorForOpenAPI3Schema(schema, realComponentsForValidation) assert.NoError(t, err) err = validator.Validate(example) if err != nil { t.Logf("Schema is: %s", schema) exampleJSON, err := json.MarshalIndent(example, "", " ") assert.NoError(t, err) t.Logf("Example is: %s", exampleJSON) } assert.NoError(t, err) } func testCanGeneratePdf(t *testing.T, path spec.Path, schema *spec.Schema) { assert.NotNil(t, schema) generator := DataGenerator{ definitions: realSpec.Components.Schemas, fixtures: &realFixtures, } var example interface{} var err error assert.NotPanics(t, func() { example, err = generator.Generate(&GenerateParams{ Expansions: nil, RequestPath: string(path), Schema: schema, }) }) assert.NoError(t, err) assert.NotNil(t, example) } stripe-mock-0.196.0/server/server.go000066400000000000000000000675711506013555700173160ustar00rootroot00000000000000package server import ( "encoding/base64" "encoding/json" "fmt" "io/ioutil" "net/http" "net/url" "path/filepath" "regexp" "sort" "strings" "time" "github.com/lestrrat-go/jsval" "github.com/stripe/stripe-mock/param" "github.com/stripe/stripe-mock/param/coercer" "github.com/stripe/stripe-mock/spec" ) // Version set in Stripe-Mock-Version response header // This is set to the actual version by GoReleaser (using `-ldflags "-X ..."`) // as it's run. Versions built from source will always show master. var Version = "master" // // Public types // // DoubleSlashFixHandler is a specialized handler that wraps an HTTP mux and // deduplicates any doubled slashes that are included in an incoming path. So // `//v1/charges` would become `/v1/charges`. This works around the standard Go // behavior, which is to redirect the request with a 301 before it reaches the // underlying handler. // // The reason we deduplicate is that in some API libraries occasionally // generate paths with double slashes, and the real Stripe API responds to // these requests normally, so stripe-mock emulates that behavior. type DoubleSlashFixHandler struct { Mux http.Handler } // ServeHTTP serves an HTTP request. func (h *DoubleSlashFixHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) { r.URL.Path = strings.Replace(r.URL.Path, "//", "/", -1) h.Mux.ServeHTTP(w, r) } // ExpansionLevel represents expansions on a single "level" of resource. It may // have subexpansions that are meant to take effect on resources that are // nested below it (on other levels). type ExpansionLevel struct { expansions map[string]*ExpansionLevel // wildcard specifies that everything should be expanded. wildcard bool } // PathParamsMap holds a collection of parameter that values that have been // extracted from the path of a request. This is useful to hand off to the data // generator so that it can use these IDs while generating results. type PathParamsMap struct { // PrimaryID contains a value for a primary ID extracted from a request // path. A "primary" object is the one being enacted on and which will be // directly returned with the API's response. // // Note that not all endpoints have a primary ID, and in those cases this // value will be nil. Examples of endpoints without a primary ID are // "create" and "list" methods. PrimaryID *string // SecondaryIDs contains a collection of "secondary IDs" (i.e., not the // primary ID) extracted from the request path. SecondaryIDs []*PathParamsSecondaryID // replacedPrimaryID is the old value of an ID field that's had its value // replaced by PrimaryID. This is used so that we can look for other // instances of this replaced ID, and also replace them. // // For example, if we're handling a charge and replaced an old ID `ch_old` // with the new value `ch_123` (from PrimaryID), this field would contain // `ch_old`. If we found another instance of `ch_old` in another field's // value (say if there was embedded refund with a field called `charge` // that pointed back to its parent charge ID), we'd recognize it via this // field and replace it with PrimaryID. // // nil if no ID has been replaced. replacedPrimaryID *string } // PathParamsSecondaryID holds the name and value for a "secondary ID" (i.e., // one that is not the primary ID) found in a request path. type PathParamsSecondaryID struct { // ID is the value of the parameter extracted from the request path. ID string // Name is the name of the parameter according to the enclosing `{}` in the // OpenAPI specification. // // For example, it might read `fee` if extracted from: // // /v1/application_fees/{fee}/refunds // Name string // replacedIDs is a slice of old values for an ID field that's had its // value replaced by this secondary parameter's new ID. This is used so // that we can look for other instances of this // replaced ID, and also replace them. // // This is a slice as opposed to a single value because it's possible that // we could encounter multiple fields while generating a response that all // represent the same entity. Say for example that a series of nested // expansions have been requested, each that internalizes an entity of a // parameter's type -- we load a fixture for each but there's no guarantee // that the entity in each one references the same ID. // // For more information, see PathParamsMap.replacedPrimaryID. replacedIDs []string } // appendReplacedID appends a replaced ID to the secondary ID's internal slice // of replaced IDs. // // This function skips the case of an empty string value, so its use should be // preferred over using the internal slice directly. func (p *PathParamsSecondaryID) appendReplacedID(replacedID string) { if replacedID != "" { p.replacedIDs = append(p.replacedIDs, replacedID) } } // ResponseError is a JSON-serializable structure representing an error // returned from Stripe's API. type ResponseError struct { ErrorInfo struct { Message string `json:"message"` Type string `json:"type"` } `json:"error"` } // LoadFixtures load fixtures from a JSON file // // If path is empty, fixtures are loaded from internal embedded assets. func LoadFixtures(embeddedFixtures []byte, fixturesPath string) (*spec.Fixtures, error) { var data []byte var err error if fixturesPath == "" { data = embeddedFixtures } else { if !isJSONFile(fixturesPath) { return nil, fmt.Errorf("Fixtures should come from a JSON file") } data, err = ioutil.ReadFile(fixturesPath) } if err != nil { return nil, fmt.Errorf("error loading fixtures: %v", err) } var fixtures spec.Fixtures err = json.Unmarshal(data, &fixtures) if err != nil { return nil, fmt.Errorf("error decoding fixtures: %v", err) } return &fixtures, nil } // LoadSpec loads OpenAPI spec from a JSON file // // If path is empty, the spec is loaded from internal embedded assets. func LoadSpec(embeddedSpec []byte, specPath string) (*spec.Spec, error) { var data []byte var err error if specPath == "" { // Use the embedded spec data = embeddedSpec } else { if !isJSONFile(specPath) { return nil, fmt.Errorf("spec should come from a JSON file") } data, err = ioutil.ReadFile(specPath) } if err != nil { return nil, fmt.Errorf("error loading spec: %v", err) } var stripeSpec spec.Spec err = json.Unmarshal(data, &stripeSpec) if err != nil { return nil, fmt.Errorf("error decoding spec: %v", err) } return &stripeSpec, nil } // StubServer handles incoming HTTP requests and responds to them appropriately // based off the set of OpenAPI routes that it's been configured with. type StubServer struct { fixtures *spec.Fixtures routes map[spec.HTTPVerb][]stubServerRoute spec *spec.Spec strictVersionCheck bool verbose bool } // NewStubServer creates a new instance of StubServer func NewStubServer(fixtures *spec.Fixtures, spec *spec.Spec, strictVersionCheck, verbose bool) (*StubServer, error) { s := StubServer{ fixtures: fixtures, spec: spec, strictVersionCheck: strictVersionCheck, verbose: verbose, } err := s.initializeRouter() if err != nil { return nil, err } return &s, nil } // HandleRequest handes an HTTP request directed at the API stub. func (s *StubServer) HandleRequest(w http.ResponseWriter, r *http.Request) { start := time.Now() fmt.Printf("Request: %v %v\n", r.Method, r.URL.Path) // // Validate headers // auth := r.Header.Get("Authorization") if !validateAuth(auth) { message := fmt.Sprintf(invalidAuthorization, auth) stripeError := createStripeError(typeInvalidRequestError, message) writeResponse(w, r, start, http.StatusUnauthorized, stripeError) return } // If the option `-strict-version-check` is on, any request that sends an // explicit `Stripe-Version` header must have a version that matches that // the one in the OpenAPI spec. This allows the user to optionally // strengthen expectations to protect against an unintended version drift. if s.strictVersionCheck { stripeVersion := r.Header.Get("Stripe-Version") if stripeVersion != "" && stripeVersion != s.spec.Info.Version { message := fmt.Sprintf(invalidStripeVersion, stripeVersion, s.spec.Info.Version) stripeError := createStripeError(typeInvalidRequestError, message) writeResponse(w, r, start, http.StatusBadRequest, stripeError) return } } // // Set headers // // We don't do anything with the idempotency key for now, but reflect it // back into response headers like the Stripe API does. idempotencyKey := r.Header.Get("Idempotency-Key") if idempotencyKey != "" { w.Header().Set("Idempotency-Key", idempotencyKey) } // Every response needs a Request-Id header except the invalid authorization w.Header().Set("Request-Id", "req_123") // // Route request // route, pathParams, err := s.routeRequest(r) if err != nil { message := fmt.Sprintf("Couldn't parse path parameters: %v", err) fmt.Printf(message + "\n") stripeError := createStripeError(typeInvalidRequestError, message) writeResponse(w, r, start, http.StatusBadRequest, stripeError) return } if route == nil { message := fmt.Sprintf(invalidRoute, r.Method, r.URL.Path) stripeError := createStripeError(typeInvalidRequestError, message) writeResponse(w, r, start, http.StatusNotFound, stripeError) return } response, ok := route.operation.Responses["200"] if !ok { fmt.Printf("Couldn't find 200 response in spec\n") writeResponse(w, r, start, http.StatusInternalServerError, createInternalServerError()) return } var responseContent spec.MediaType if jsonResponseContent, ok := response.Content["application/json"]; ok && jsonResponseContent.Schema != nil { w.Header().Set("Content-Type", "application/json") responseContent = jsonResponseContent } else if pdfResponseContent, ok := response.Content["application/pdf"]; ok && pdfResponseContent.Schema != nil { w.Header().Set("Content-Type", "application/pdf") responseContent = pdfResponseContent } else { fmt.Printf("Couldn't find application/json or application/pdf in response\n") writeResponse(w, r, start, http.StatusInternalServerError, createInternalServerError()) return } if s.verbose { fmt.Printf("IDs extracted from route: %+v\n", pathParams) fmt.Printf("Response schema: %s\n", responseContent.Schema) } requestData, err := param.ParseParams(r) if err != nil { message := fmt.Sprintf("Couldn't parse query/body: %v", err) fmt.Printf(message + "\n") stripeError := createStripeError(typeInvalidRequestError, message) writeResponse(w, r, start, http.StatusBadRequest, stripeError) return } if s.verbose { if requestData != nil { fmt.Printf("Request data: %+v\n", requestData) } else { fmt.Printf("Request data: (none)\n") } } // Note that requestData is actually manipulated in place, but we show it // returned here to make it clear that this function will be manipulating // it. requestData, stripeError := validateAndCoerceRequest(r, route, requestData) if stripeError != nil { writeResponse(w, r, start, http.StatusBadRequest, stripeError) return } expansions, rawExpansions := extractExpansions(requestData) if s.verbose { fmt.Printf("Expansions: %+v\n", rawExpansions) } generator := DataGenerator{s.spec.Components.Schemas, s.fixtures, s.verbose} responseData, err := generator.Generate(&GenerateParams{ Expansions: expansions, PathParams: pathParams, RequestData: requestData, RequestMethod: r.Method, RequestPath: r.URL.Path, Schema: responseContent.Schema, }) if err != nil { fmt.Printf("Couldn't generate response: %v\n", err) writeResponse(w, r, start, http.StatusInternalServerError, createInternalServerError()) return } if s.verbose { responseDataJSON, err := json.MarshalIndent(responseData, "", " ") if err != nil { panic(err) } fmt.Printf("Response data: %s\n", responseDataJSON) } writeResponse(w, r, start, http.StatusOK, responseData) } func (s *StubServer) initializeRouter() error { var numEndpoints int var numPaths int var numValidators int s.routes = make(map[spec.HTTPVerb][]stubServerRoute) componentsForValidation := spec.GetComponentsForValidation(&s.spec.Components) for path, verbs := range s.spec.Paths { numPaths++ pathPattern, pathParamNames := compilePath(path) if s.verbose { fmt.Printf("Compiled path: %v\n", pathPattern.String()) } for verb, operation := range verbs { numEndpoints++ var requestMediaType *string var requestSchema *spec.Schema var requestValidator *jsval.JSVal // For `GET` requests we build a validator based off a // pseudo-schema constructed from the endpoint's query parameters. // For all other verbs we use the body schema. // // This is all a little weird and based off of how Stripe's OpenAPI // specification is generated which is itself based off the // original Rack confusion between query and body parameters // (because it became ossified in Stripe's server implementation). if verb == "get" { requestSchema = spec.BuildQuerySchema(operation) var err error requestValidator, err = spec.GetValidatorForOpenAPI3Schema( requestSchema, nil) if err != nil { return err } } else { requestMediaType, requestSchema = getRequestBodySchema(operation) if requestSchema != nil { var err error requestValidator, err = spec.GetValidatorForOpenAPI3Schema( requestSchema, componentsForValidation) if err != nil { return err } } } // Note that this may be nil if no suitable validator could be // generated. if requestValidator != nil { numValidators++ } // We use whether the route ends with a parameter as a heuristic as // to whether we should expect an object's primary ID in the URL. // // The most common suffix in hasPrimaryIDSuffixes is just `}` which // represents the end of a parameter. // // It also has a lot of other special cases for RPC-style actions // like `/approve`. var hasPrimaryID bool for _, suffix := range hasPrimaryIDSuffixes { if strings.HasSuffix(string(path), suffix) { hasPrimaryID = true break } } route := stubServerRoute{ hasPrimaryID: hasPrimaryID, pattern: pathPattern, operation: operation, pathParamNames: pathParamNames, requestMediaType: requestMediaType, requestSchema: requestSchema, requestValidator: requestValidator, } // net/http will always give us verbs in uppercase, so build our // routing table this way too verb = spec.HTTPVerb(strings.ToUpper(string(verb))) s.routes[verb] = append(s.routes[verb], route) } } for _, verbRoutes := range s.routes { // After sorting all routes, order them by their number of path // parameters so that paths with static portions will tend to be // preferred over those with dynamic parts. // // For example, `/v1/invoices/upcoming` should be preferred over // `/v1/invoices/:invoice` even though both will match the string // `/v1/invoices/upcoming`. sort.Slice(verbRoutes, func(i, j int) bool { return len(verbRoutes[i].pathParamNames) < len(verbRoutes[j].pathParamNames) }) } fmt.Printf("Routing to %v path(s) and %v endpoint(s) with %v validator(s)\n", numPaths, numEndpoints, numValidators) return nil } // routeRequest tries to find a matching route for the given request. If // successful, it returns the matched route and where possible, an extracted ID // which comes from the last capture group in the URL. An ID is only returned // if it looks like it's supposed to be the primary identifier of the returned // object (i.e., the route's pattern ended with a parameter). A nil is returned // as the second return value when no primary ID is available. func (s *StubServer) routeRequest(r *http.Request) (*stubServerRoute, *PathParamsMap, error) { verbRoutes := s.routes[spec.HTTPVerb(r.Method)] for _, route := range verbRoutes { matches := route.pattern.FindAllStringSubmatch(r.URL.Path, -1) if len(matches) < 1 { continue } // There are no path parameters. Return the route only. if len(route.pathParamNames) < 1 { return &route, nil, nil } // There will only ever be a single match in the string (this match // contains the entire match plus all capture groups). firstMatch := matches[0] // Unescape each parameter in the path. Converts hex-encoded bytes like // `%AB` into the byte itself and `+`s into spaces. for i := 1; i < len(firstMatch); i++ { unescaped, err := url.QueryUnescape(firstMatch[i]) if err != nil { return nil, nil, fmt.Errorf("Failed to unescape path parameter %v: %v", i, err) } firstMatch[i] = unescaped } // Secondary IDs are any IDs in the URL that are *not* the primary ID // (which you'll see if say a resource is nested under another // resource). // // Normally, we can calculate the number of secondary IDs based on the // number of path parameters by subtracting one for the primary ID. // There's a special case if the path doesn't have a primary ID in // which the number of secondary IDs equals the number of path // parameters. var numSecondaryIDs int if route.hasPrimaryID { numSecondaryIDs = len(route.pathParamNames) - 1 } else { numSecondaryIDs = len(route.pathParamNames) } var secondaryIDs []*PathParamsSecondaryID if numSecondaryIDs > 0 { secondaryIDs = make([]*PathParamsSecondaryID, numSecondaryIDs) for i := 0; i < numSecondaryIDs; i++ { secondaryIDs[i] = &PathParamsSecondaryID{ // Note that the first position of `firstMatch` is the // entire matching string. Capture groups start at position // 1, so we add one to `i`. ID: firstMatch[i+1], Name: route.pathParamNames[i], } } } // Not all routes have a primary ID even if they might have secondary // IDs. Consider for example a list endpoint nested under another // resource: // // GET "/v1/application_fees/fee_123/refunds // var primaryID *string if route.hasPrimaryID { primaryID = &firstMatch[len(firstMatch)-1] } // Return the route along with any IDs that matched in the path. return &route, &PathParamsMap{ PrimaryID: primaryID, SecondaryIDs: secondaryIDs, }, nil } return nil, nil, nil } // // Private values // const ( contentTypeEmpty = "Request's `Content-Type` header was empty. Expected: `%s`." contentTypeMismatched = "Request's `Content-Type` didn't match the path's expected media type. Expected: `%s`. Was: `%s`." invalidAuthorization = "Please authenticate by specifying an " + "`Authorization` header with any valid looking testmode secret API " + "key. For example, `Authorization: Bearer sk_test_123`. " + "Authorization was '%s'." invalidRoute = "Unrecognized request URL (%s: %s)." invalidStripeVersion = "Version sent in `Stripe-Version` header '%s' " + "doesn't match version in OpenAPI specification '%s' which may have " + "unintended consequences. This error was shown because stripe-mock " + "was started with `-stripe-version-check`." internalServerError = "An internal error occurred." typeInvalidRequestError = "invalid_request_error" ) // Suffixes for which we will try to exact an object's ID from the path. var hasPrimaryIDSuffixes = [...]string{ // The general case: we're looking for the end of an OpenAPI URL parameter. "}", // These are resource "actions". They don't take the standard form, but we // can expect an object's primary ID to live right before them in a path. "/accept", "/approve", "/attach", "/capture", "/cancel", "/close", "/confirm", "/decline", "/detach", "/finalize", "/mark_uncollectible", "/pay", "/preview", "/refund", "/reject", "/release", "/send", "/submit", "/verify", "/verify_microdeposits", "/void", } var pathParameterPattern = regexp.MustCompile(`\{(\w+)\}`) // // Private types // // stubServerRoute is a single route in a StubServer's routing table. It has a // pattern to match an incoming path and a description of the method that would // be executed in the event of a match. type stubServerRoute struct { hasPrimaryID bool operation *spec.Operation pathParamNames []string pattern *regexp.Regexp requestMediaType *string requestSchema *spec.Schema requestValidator *jsval.JSVal } // // Private functions // // compilePath compiles a path extracted from OpenAPI into a regular expression // that we can use for matching against incoming HTTP requests. // // The first return value is a regular expression. The second is a slice of // names for the parameters included in the path in order of their appearance. // This slice is `nil` if the path had no parameters. func compilePath(path spec.Path) (*regexp.Regexp, []string) { var pathParamNames []string parts := strings.Split(string(path), "/") pattern := `\A` for _, part := range parts { if part == "" { continue } submatches := pathParameterPattern.FindAllStringSubmatch(part, -1) if submatches == nil { pattern += `/` + part } else { // Special characters as defined by: // // https://tools.ietf.org/html/rfc3986#section-3.3 pattern += `/(?P<` + submatches[0][1] + `>[\w@:%-._~!$&'()*+,;=]+)` pathParamNames = append(pathParamNames, submatches[0][1]) } } return regexp.MustCompile(pattern + `\z`), pathParamNames } // Helper to create an internal server error for API issues. func createInternalServerError() *ResponseError { return createStripeError(typeInvalidRequestError, internalServerError) } // This creates a Stripe error to return in case of API errors. func createStripeError(errorType string, errorMessage string) *ResponseError { return &ResponseError{ ErrorInfo: struct { Message string `json:"message"` Type string `json:"type"` }{ Message: errorMessage, Type: errorType, }, } } func extractExpansions(data map[string]interface{}) (*ExpansionLevel, []string) { expand, ok := data["expand"] if !ok { return nil, nil } var expansions []string expandStr, ok := expand.(string) if ok { expansions = append(expansions, expandStr) return parseExpansionLevel(expansions), expansions } expandArr, ok := expand.([]interface{}) if ok { for _, expand := range expandArr { expandStr := expand.(string) expansions = append(expansions, expandStr) } return parseExpansionLevel(expansions), expansions } return nil, nil } // getRequestBodySchema gets the media type and expected request schema for the // given operation. We don't expect any endpoint in the Stripe API to have // multiple supported media types, so the operation's first media type and // request schema is always the one that's returned. // // The first value is a media type like "application/x-www-form-urlencoded", or // nil if the operation has no request schemas. func getRequestBodySchema(operation *spec.Operation) (*string, *spec.Schema) { if operation.RequestBody == nil { return nil, nil } for mediaType, spec := range operation.RequestBody.Content { return &mediaType, spec.Schema } return nil, nil } func isCurl(userAgent string) bool { return strings.HasPrefix(userAgent, "curl/") } // parseExpansionLevel parses a set of raw expansions from a request query // string or form and produces a structure more useful for performing actual // expansions. func parseExpansionLevel(raw []string) *ExpansionLevel { sort.Strings(raw) level := &ExpansionLevel{expansions: make(map[string]*ExpansionLevel)} groups := make(map[string][]string) for _, expansion := range raw { parts := strings.Split(expansion, ".") if len(parts) == 1 { if parts[0] == "*" { level.wildcard = true } else { level.expansions[parts[0]] = &ExpansionLevel{expansions: make(map[string]*ExpansionLevel)} } } else { groups[parts[0]] = append(groups[parts[0]], strings.Join(parts[1:], ".")) } } for key, subexpansions := range groups { level.expansions[key] = parseExpansionLevel(subexpansions) } return level } // validateAndCoerceRequest validates an incoming request against an OpenAPI // schema and does parameter coercion. // // Firstly, `Content-Type` is checked against the schema's media type, then // string-encoded parameters are coerced to expected types (where possible). // Finally, we validate the incoming payload against the schema. func validateAndCoerceRequest( r *http.Request, route *stubServerRoute, requestData map[string]interface{}) (map[string]interface{}, *ResponseError) { // We only check content type on non-`GET` non-`DELETE` requests. // // `GET` requests either send no parameters or send parameters only in the // query. // // `DELETE` will often have no parameters. When it does, they're in the // body, but we'll ignore content type validation in this one case for // simplicity. if r.Method != http.MethodDelete && r.Method != http.MethodGet { contentType := r.Header.Get("Content-Type") if contentType == "" { message := fmt.Sprintf(contentTypeEmpty, *route.requestMediaType) fmt.Printf(message + "\n") return nil, createStripeError(typeInvalidRequestError, message) } // Truncate content type parameters. For example, given: // // application/json; charset=utf-8 // // We want to chop off the `; charset=utf-8` at the end. contentType = strings.Split(contentType, ";")[0] if contentType != *route.requestMediaType { message := fmt.Sprintf(contentTypeMismatched, *route.requestMediaType, contentType) fmt.Printf(message + "\n") return nil, createStripeError(typeInvalidRequestError, message) } } err := coercer.CoerceParams(route.requestSchema, requestData) if err != nil { message := fmt.Sprintf("Request coercion error: %v", err) fmt.Printf(message + "\n") return nil, createStripeError(typeInvalidRequestError, message) } fmt.Printf("Request data = %+v\n", requestData) err = route.requestValidator.Validate(requestData) if err != nil { message := fmt.Sprintf("Request validation error: %v", err) fmt.Printf(message + "\n") return nil, createStripeError(typeInvalidRequestError, message) } // All checks were successful. return requestData, nil } func validateAuth(auth string) bool { if auth == "" { return false } parts := strings.Split(auth, " ") // Expect ["Bearer", "sk_test_123"] or ["Basic", "aaaaa"] if len(parts) != 2 || parts[1] == "" { return false } var key string switch parts[0] { case "Basic": keyBytes, err := base64.StdEncoding.DecodeString(parts[1]) if err != nil { return false } key = string(keyBytes) case "Bearer": key = parts[1] default: return false } keyParts := strings.Split(key, "_") // Expect ["sk", "test", "123"] if len(keyParts) != 3 { return false } if keyParts[0] != "rk" && keyParts[0] != "sk" { return false } if keyParts[1] != "test" { return false } // Expect something (anything but an empty string) in the third position if len(keyParts[2]) == 0 { return false } return true } func writeResponse(w http.ResponseWriter, r *http.Request, start time.Time, status int, data interface{}) { if data == nil { data = http.StatusText(status) } var encodedData []byte var err error // If no special Content-Type has been set, then we default to JSON. if w.Header().Get("Content-Type") == "" { w.Header().Set("Content-Type", "application/json") } if dataString, ok := data.(string); ok { encodedData = []byte(dataString) } else if !isCurl(r.Header.Get("User-Agent")) { encodedData, err = json.Marshal(&data) } else { encodedData, err = json.MarshalIndent(&data, "", " ") encodedData = append(encodedData, '\n') } if err != nil { fmt.Printf("Error serializing response: %v\n", err) writeResponse(w, r, start, http.StatusInternalServerError, nil) return } w.Header().Set("Stripe-Mock-Version", Version) w.WriteHeader(status) _, err = w.Write(encodedData) if err != nil { fmt.Printf("Error writing to client: %v\n", err) } fmt.Printf("Response: elapsed=%v status=%v\n", time.Now().Sub(start), status) } // isJSONFile judges based on a file's extension whether it's a JSON file. It's // used to return a better error message if the user points to an unsupported // file. func isJSONFile(path string) bool { return strings.ToLower(filepath.Ext(path)) == ".json" } stripe-mock-0.196.0/server/server_test.go000066400000000000000000000620261506013555700203430ustar00rootroot00000000000000package server import ( "bytes" "encoding/base64" "encoding/json" "fmt" "github.com/stripe/stripe-mock/embedded" "io/ioutil" "net/http" "net/http/httptest" "net/url" "path" "runtime" "testing" assert "github.com/stretchr/testify/require" "github.com/stripe/stripe-mock/spec" ) const testSpecAPIVersion = "2019-01-01" var applicationFeeRefundCreateMethod *spec.Operation var applicationFeeRefundGetMethod *spec.Operation var chargeAllMethod *spec.Operation var chargeCreateMethod *spec.Operation var chargeGetMethod *spec.Operation var customerDeleteMethod *spec.Operation var invoicePayMethod *spec.Operation var quotePdfMethod *spec.Operation // Try to avoid using the real spec as much as possible because it's more // complicated and slower. A test spec is provided below. If you do use it, // don't mutate it. var realSpec spec.Spec var realFixtures spec.Fixtures var realComponentsForValidation *spec.ComponentsForValidation var testSpec spec.Spec var testFixtures spec.Fixtures func init() { initRealSpec() initTestSpec() } func initRealSpec() { // Determine test file name and paths to openapi specs _, testFile, _, _ := runtime.Caller(0) specFile := path.Join(path.Dir(testFile), "../embedded/openapi/spec3.json") fixtureFile := path.Join(path.Dir(testFile), "../embedded/openapi/fixtures3.json") // Load the spec information data, err := ioutil.ReadFile(specFile) if err != nil { panic(err) } err = json.Unmarshal(data, &realSpec) if err != nil { panic(err) } realComponentsForValidation = spec.GetComponentsForValidation(&realSpec.Components) // And do the same for fixtures data, err = ioutil.ReadFile(fixtureFile) if err != nil { panic(err) } err = json.Unmarshal(data, &realFixtures) if err != nil { panic(err) } } func initTestSpec() { // These are basically here to give us a URL to test against that has // multiple parameters in it. applicationFeeRefundCreateMethod = &spec.Operation{} applicationFeeRefundGetMethod = &spec.Operation{} chargeAllMethod = &spec.Operation{ Parameters: []*spec.Parameter{ { In: spec.ParameterQuery, Name: "limit", Required: false, Schema: &spec.Schema{ Type: spec.TypeInteger, }, }, }, Responses: map[spec.StatusCode]spec.Response{ "200": { Content: map[string]spec.MediaType{ "application/json": { Schema: &spec.Schema{ Type: spec.TypeObject, }, }, }, }, }, } chargeCreateMethod = &spec.Operation{ RequestBody: &spec.RequestBody{ Content: map[string]spec.MediaType{ "application/x-www-form-urlencoded": { Schema: &spec.Schema{ AdditionalProperties: nil, AdditionalPropertiesAllowed: false, Properties: map[string]*spec.Schema{ "amount": { Type: spec.TypeInteger, }, }, Required: []string{"amount"}, }, }, }, }, Responses: map[spec.StatusCode]spec.Response{ "200": { Content: map[string]spec.MediaType{ "application/json": { Schema: &spec.Schema{ Ref: "#/components/schemas/charge", }, }, }, }, }, } chargeGetMethod = &spec.Operation{} customerDeleteMethod = &spec.Operation{ RequestBody: &spec.RequestBody{ Content: map[string]spec.MediaType{ "application/x-www-form-urlencoded": { Schema: &spec.Schema{ AdditionalProperties: nil, AdditionalPropertiesAllowed: false, Type: spec.TypeObject, }, }, }, }, Responses: map[spec.StatusCode]spec.Response{ "200": { Content: map[string]spec.MediaType{ "application/json": { Schema: &spec.Schema{ Ref: "#/components/schemas/deleted_customer", }, }, }, }, }, } quotePdfMethod = &spec.Operation{ RequestBody: &spec.RequestBody{ Content: map[string]spec.MediaType{ "application/x-www-form-urlencoded": { Schema: &spec.Schema{ AdditionalProperties: nil, AdditionalPropertiesAllowed: false, Type: spec.TypeObject, }, }, }, }, Responses: map[spec.StatusCode]spec.Response{ "200": { Content: map[string]spec.MediaType{ "application/pdf": { Schema: &spec.Schema{ Format: "binary", Type: "string", }, }, }, }, }, } // Here so we can test the relatively rare "action" operations (e.g., // `POST` to `/pay` on an invoice). invoicePayMethod = &spec.Operation{} testFixtures = spec.Fixtures{ Resources: map[spec.ResourceID]interface{}{ spec.ResourceID("charge"): map[string]interface{}{ "customer": "cus_123", "id": "ch_123", }, spec.ResourceID("customer"): map[string]interface{}{ "id": "cus_123", }, spec.ResourceID("deleted_customer"): map[string]interface{}{ "deleted": true, }, }, } testSpec = spec.Spec{ Info: &spec.Info{ Version: testSpecAPIVersion, }, Components: spec.Components{ Schemas: map[string]*spec.Schema{ "charge": { Type: "object", Properties: map[string]*spec.Schema{ "id": {Type: "string"}, // Normally a customer ID, but expandable to a full // customer resource "customer": { AnyOf: []*spec.Schema{ {Type: "string"}, {Ref: "#/components/schemas/customer"}, }, XExpansionResources: &spec.ExpansionResources{ OneOf: []*spec.Schema{ {Ref: "#/components/schemas/customer"}, }, }, }, }, XExpandableFields: &[]string{"customer"}, XResourceID: "charge", }, "customer": { Type: "object", XResourceID: "customer", }, "deleted_customer": { Properties: map[string]*spec.Schema{ "deleted": {Type: "boolean"}, }, Type: "object", XResourceID: "deleted_customer", }, }, }, Paths: map[spec.Path]map[spec.HTTPVerb]*spec.Operation{ spec.Path("/v1/application_fees/{fee}/refunds"): { "get": applicationFeeRefundCreateMethod, }, spec.Path("/v1/application_fees/{fee}/refunds/{id}"): { "get": applicationFeeRefundGetMethod, }, spec.Path("/v1/charges"): { "get": chargeAllMethod, "post": chargeCreateMethod, }, spec.Path("/v1/charges/{id}"): { "get": chargeGetMethod, }, spec.Path("/v1/customers/{id}"): { "delete": customerDeleteMethod, }, spec.Path("/v1/invoices/{id}/pay"): { "post": invoicePayMethod, }, spec.Path("/v1/quotes/{quote}/pdf"): { "get": quotePdfMethod, }, }, } } // // Tests // func TestCanLoadEmbeddedSpecs(t *testing.T) { _, err := LoadSpec(embedded.OpenAPISpec, "") assert.NoError(t, err) _, err = LoadSpec(embedded.BetaOpenAPISpec, "") assert.NoError(t, err) } func TestDoubleSlashFixHandler(t *testing.T) { var lastPath string httpMux := http.NewServeMux() httpMux.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) { lastPath = r.URL.Path }) doubleSlashFixHandler := &DoubleSlashFixHandler{httpMux} // Slash deduplication { lastPath = "" req := httptest.NewRequest( http.MethodGet, "http://example.com//v1/charges", nil) w := httptest.NewRecorder() doubleSlashFixHandler.ServeHTTP(w, req) assert.Equal(t, http.StatusOK, w.Code) assert.Equal(t, "/v1/charges", lastPath) } // Requests without duplicated slashes work normally { lastPath = "" req := httptest.NewRequest( http.MethodGet, "http://example.com/v1/charges", nil) w := httptest.NewRecorder() doubleSlashFixHandler.ServeHTTP(w, req) assert.Equal(t, http.StatusOK, w.Code) assert.Equal(t, "/v1/charges", lastPath) } // Demonstrates the (undesirable) standard Go behavior without the handler { lastPath = "" req := httptest.NewRequest( http.MethodGet, "http://example.com//v1/charges", nil) w := httptest.NewRecorder() // Note that we skip the double slash fix handler and have the mux // serve directly httpMux.ServeHTTP(w, req) // This is the default Go behavior (301) assert.Equal(t, http.StatusMovedPermanently, w.Code) assert.Equal(t, "", lastPath) } } func TestStubServer(t *testing.T) { resp, body := sendRequest(t, "POST", "/v1/charges", "amount=123", getDefaultHeaders(), nil) assert.Equal(t, http.StatusOK, resp.StatusCode) var data map[string]interface{} err := json.Unmarshal(body, &data) assert.NoError(t, err) _, ok := data["id"] assert.True(t, ok) } func TestStubServer_MissingParam(t *testing.T) { resp, body := sendRequest(t, "POST", "/v1/charges", "", getDefaultHeaders(), nil) assert.Equal(t, http.StatusBadRequest, resp.StatusCode) var data map[string]interface{} err := json.Unmarshal(body, &data) assert.NoError(t, err) errorInfo, ok := data["error"].(map[string]interface{}) assert.True(t, ok) errorType, ok := errorInfo["type"] assert.Equal(t, errorType, "invalid_request_error") assert.True(t, ok) message, ok := errorInfo["message"] assert.True(t, ok) assert.Contains(t, message, "object property 'amount' is required") } func TestStubServer_ExtraParam(t *testing.T) { resp, body := sendRequest(t, "POST", "/v1/charges", "amount=123&doesntexist=foo", getDefaultHeaders(), nil) assert.Equal(t, http.StatusBadRequest, resp.StatusCode) var data map[string]interface{} err := json.Unmarshal(body, &data) assert.NoError(t, err) errorInfo, ok := data["error"].(map[string]interface{}) assert.True(t, ok) errorType, ok := errorInfo["type"] assert.Equal(t, errorType, "invalid_request_error") assert.True(t, ok) message, ok := errorInfo["message"] assert.True(t, ok) assert.Contains(t, message, "additional properties are not allowed") } func TestStubServer_QueryParam(t *testing.T) { resp, body := sendRequest(t, "GET", "/v1/charges?limit=10", "", getDefaultHeaders(), nil) assert.Equal(t, http.StatusOK, resp.StatusCode) var data map[string]interface{} err := json.Unmarshal(body, &data) assert.NoError(t, err) } func TestStubServer_QueryExtraParam(t *testing.T) { resp, body := sendRequest(t, "GET", "/v1/charges?limit=10&doesntexist=foo", "", getDefaultHeaders(), nil) assert.Equal(t, http.StatusBadRequest, resp.StatusCode) var data map[string]interface{} err := json.Unmarshal(body, &data) assert.NoError(t, err) errorInfo, ok := data["error"].(map[string]interface{}) assert.True(t, ok) errorType, ok := errorInfo["type"] assert.Equal(t, errorType, "invalid_request_error") assert.True(t, ok) message, ok := errorInfo["message"] assert.True(t, ok) assert.Contains(t, message, "additional properties are not allowed") } func TestStubServer_InvalidAuthorization(t *testing.T) { resp, body := sendRequest(t, "GET", "/a", "", nil, nil) assert.Equal(t, http.StatusUnauthorized, resp.StatusCode) var data map[string]interface{} err := json.Unmarshal(body, &data) assert.NoError(t, err) errorInfo, ok := data["error"].(map[string]interface{}) assert.True(t, ok) errorType, ok := errorInfo["type"] assert.Equal(t, errorType, "invalid_request_error") assert.True(t, ok) message, ok := errorInfo["message"] assert.True(t, ok) assert.Equal(t, fmt.Sprintf(invalidAuthorization, ""), message) } func TestStubServer_InvalidStripeVersion(t *testing.T) { testBadVersion := "2006-01-01" headers := getDefaultHeaders() headers["Stripe-Version"] = testBadVersion // With strictVersionCheck on, which throws the error { resp, body := sendRequest(t, "GET", "/v1/charges", "", headers, &testStubServerOptions{strictVersionCheck: true}) assert.Equal(t, http.StatusBadRequest, resp.StatusCode) var data map[string]interface{} err := json.Unmarshal(body, &data) assert.NoError(t, err) errorInfo, ok := data["error"].(map[string]interface{}) assert.True(t, ok) errorType, ok := errorInfo["type"] assert.Equal(t, errorType, "invalid_request_error") assert.True(t, ok) message, ok := errorInfo["message"] assert.True(t, ok) assert.Equal(t, fmt.Sprintf(invalidStripeVersion, testBadVersion, testSpecAPIVersion), message) } // With strictVersionCheck off, which responds normally { resp, _ := sendRequest(t, "GET", "/v1/charges", "", headers, nil) assert.Equal(t, http.StatusOK, resp.StatusCode) } } func TestStubServer_AllowsContentTypeWithParameters(t *testing.T) { headers := getDefaultHeaders() headers["Content-Type"] = "application/x-www-form-urlencoded; charset=utf-8" resp, _ := sendRequest(t, "POST", "/v1/charges", "amount=123", headers, nil) assert.Equal(t, http.StatusOK, resp.StatusCode) } func TestStubServer_SetsSpecialHeaders(t *testing.T) { resp, _ := sendRequest(t, "POST", "/", "", nil, nil) assert.Equal(t, http.StatusUnauthorized, resp.StatusCode) assert.Equal(t, Version, resp.Header.Get("Stripe-Mock-Version")) assert.Equal(t, "application/json", resp.Header.Get("Content-Type")) _, ok := resp.Header["Request-Id"] assert.False(t, ok) resp, _ = sendRequest(t, "POST", "/", "", getDefaultHeaders(), nil) assert.Equal(t, http.StatusNotFound, resp.StatusCode) assert.Equal(t, Version, resp.Header.Get("Stripe-Mock-Version")) assert.Equal(t, "application/json", resp.Header.Get("Content-Type")) assert.Equal(t, "req_123", resp.Header.Get("Request-Id")) } func TestStubServer_ParameterValidation(t *testing.T) { resp, body := sendRequest(t, "POST", "/v1/charges", "", getDefaultHeaders(), nil) assert.Contains(t, string(body), "property 'amount' is required") assert.Equal(t, http.StatusBadRequest, resp.StatusCode) } func TestStubServer_FormatsForCurl(t *testing.T) { headers := getDefaultHeaders() headers["User-Agent"] = "curl/1.2.3" resp, body := sendRequest(t, "POST", "/v1/charges", "amount=123", headers, nil) // Note the two spaces in front of "id" which indicate that our JSON is // pretty printed. assert.Contains(t, string(body), ` "id"`) assert.Equal(t, http.StatusOK, resp.StatusCode) } func TestStubServer_ErrorsOnEmptyContentType(t *testing.T) { headers := getDefaultHeaders() headers["Content-Type"] = "" resp, body := sendRequest(t, "POST", "/v1/charges", "amount=123", headers, nil) assert.Equal(t, http.StatusBadRequest, resp.StatusCode) var data map[string]interface{} err := json.Unmarshal(body, &data) assert.NoError(t, err) errorInfo, ok := data["error"].(map[string]interface{}) assert.True(t, ok) assert.Equal(t, "invalid_request_error", errorInfo["type"]) assert.Equal(t, fmt.Sprintf(contentTypeEmpty, "application/x-www-form-urlencoded"), errorInfo["message"]) } func TestStubServer_AllowsEmptyContentTypeOnDelete(t *testing.T) { headers := getDefaultHeaders() headers["Content-Type"] = "" resp, _ := sendRequest(t, "DELETE", "/v1/customers/cus_123", "", headers, nil) assert.Equal(t, http.StatusOK, resp.StatusCode) } func TestStubServer_ErrorsOnMismatchedContentType(t *testing.T) { headers := getDefaultHeaders() headers["Content-Type"] = "application/json" resp, body := sendRequest(t, "POST", "/v1/charges", "amount=123", headers, nil) fmt.Printf("body = %+v\n", string(body)) assert.Equal(t, http.StatusBadRequest, resp.StatusCode) var data map[string]interface{} err := json.Unmarshal(body, &data) assert.NoError(t, err) errorInfo, ok := data["error"].(map[string]interface{}) assert.True(t, ok) assert.Equal(t, "invalid_request_error", errorInfo["type"]) assert.Equal(t, fmt.Sprintf(contentTypeMismatched, "application/x-www-form-urlencoded", "application/json"), errorInfo["message"]) } func TestStubServer_ReflectsIdempotencyKey(t *testing.T) { headers := getDefaultHeaders() headers["Idempotency-Key"] = "my-key" resp, _ := sendRequest(t, "POST", "/v1/charges", "amount=123", headers, nil) assert.Equal(t, "my-key", resp.Header.Get("Idempotency-Key")) } func TestStubServer_RoutesRequest(t *testing.T) { server := getStubServer(t, nil) { route, pathParams, err := server.routeRequest( &http.Request{Method: "GET", URL: &url.URL{Path: "/v1/charges"}}) assert.NoError(t, err) assert.NotNil(t, route) assert.Equal(t, chargeAllMethod, route.operation) assert.Nil(t, pathParams) } { route, pathParams, err := server.routeRequest( &http.Request{Method: "POST", URL: &url.URL{Path: "/v1/charges"}}) assert.NoError(t, err) assert.NotNil(t, route) assert.Equal(t, chargeCreateMethod, route.operation) assert.Nil(t, pathParams) } { route, pathParams, err := server.routeRequest( &http.Request{Method: "GET", URL: &url.URL{Path: "/v1/charges/ch_123"}}) assert.NoError(t, err) assert.NotNil(t, route) assert.Equal(t, chargeGetMethod, route.operation) assert.Equal(t, "ch_123", *(*pathParams).PrimaryID) assert.Equal(t, []*PathParamsSecondaryID(nil), (*pathParams).SecondaryIDs) } { route, pathParams, err := server.routeRequest( &http.Request{Method: "DELETE", URL: &url.URL{Path: "/v1/customers/cus_123"}}) assert.NoError(t, err) assert.NotNil(t, route) assert.Equal(t, customerDeleteMethod, route.operation) assert.Equal(t, "cus_123", *(*pathParams).PrimaryID) assert.Equal(t, []*PathParamsSecondaryID(nil), (*pathParams).SecondaryIDs) } { route, pathParams, err := server.routeRequest( &http.Request{Method: "GET", URL: &url.URL{Path: "/v1/doesnt-exist"}}) assert.NoError(t, err) assert.Equal(t, (*stubServerRoute)(nil), route) assert.Nil(t, pathParams) } // Route with a parameter, but not an object's primary ID { route, pathParams, err := server.routeRequest( &http.Request{Method: "POST", URL: &url.URL{Path: "/v1/invoices/in_123/pay"}}) assert.NoError(t, err) assert.NotNil(t, route) assert.Equal(t, invoicePayMethod, route.operation) assert.Equal(t, "in_123", *(*pathParams).PrimaryID) assert.Equal(t, []*PathParamsSecondaryID(nil), (*pathParams).SecondaryIDs) } // Route with a parameter, but not an object's primary ID { route, pathParams, err := server.routeRequest( &http.Request{Method: "GET", URL: &url.URL{Path: "/v1/application_fees/fee_123/refunds"}}) assert.NoError(t, err) assert.NotNil(t, route) assert.Equal(t, invoicePayMethod, route.operation) assert.Equal(t, (*string)(nil), (*pathParams).PrimaryID) assert.Equal(t, 1, len((*pathParams).SecondaryIDs)) assert.Equal(t, "fee_123", (*pathParams).SecondaryIDs[0].ID) assert.Equal(t, "fee", (*pathParams).SecondaryIDs[0].Name) } // Route with multiple parameters in its URL { route, pathParams, err := server.routeRequest( &http.Request{Method: "GET", URL: &url.URL{Path: "/v1/application_fees/fee_123/refunds/fr_123"}}) assert.NoError(t, err) assert.NotNil(t, route) assert.Equal(t, applicationFeeRefundGetMethod, route.operation) assert.Equal(t, "fr_123", *(*pathParams).PrimaryID) assert.Equal(t, 1, len((*pathParams).SecondaryIDs)) assert.Equal(t, "fee_123", (*pathParams).SecondaryIDs[0].ID) assert.Equal(t, "fee", (*pathParams).SecondaryIDs[0].Name) } // Routes with special symbols and spaces in path { _, _, err := server.routeRequest( &http.Request{Method: "GET", URL: &url.URL{Path: "/v1/charges/%0"}}) assert.Error(t, err) assert.Equal(t, `Failed to unescape path parameter 1: invalid URL escape "%0"`, err.Error()) } } func TestStubServer_JSONResponse(t *testing.T) { resp, _ := sendRequest(t, "GET", "/v1/charges", "", getDefaultHeaders(), nil) assert.Equal(t, http.StatusOK, resp.StatusCode) assert.Equal(t, "application/json", resp.Header.Get("Content-Type")) } func TestStubServer_BinaryResponse(t *testing.T) { resp, body := sendRequest(t, "GET", "/v1/quotes/qt_123/pdf", "", getDefaultHeaders(), nil) assert.Equal(t, http.StatusOK, resp.StatusCode) assert.Equal(t, "application/pdf", resp.Header.Get("Content-Type")) assert.Equal(t, "Stripe binary response", string(body[:])) } func TestGetValidator(t *testing.T) { operation := &spec.Operation{RequestBody: &spec.RequestBody{ Content: map[string]spec.MediaType{ "application/x-www-form-urlencoded": { Schema: &spec.Schema{ Properties: map[string]*spec.Schema{ "name": { Type: "string", }, }, }, }, }, }} mediaType, schema := getRequestBodySchema(operation) assert.NotNil(t, mediaType) assert.Equal(t, "application/x-www-form-urlencoded", *mediaType) assert.NotNil(t, schema) validator, err := spec.GetValidatorForOpenAPI3Schema(schema, nil) assert.NoError(t, err) assert.NotNil(t, validator) goodData := map[string]interface{}{ "name": "foo", } assert.NoError(t, validator.Validate(goodData)) badData := map[string]interface{}{ "name": 7, } assert.Error(t, validator.Validate(badData)) } func TestGetValidator_NoSuitableParameter(t *testing.T) { method := &spec.Operation{Parameters: []*spec.Parameter{ {Schema: nil}, }} mediaType, schema := getRequestBodySchema(method) assert.Nil(t, mediaType) assert.Nil(t, schema) } func TestIsCurl(t *testing.T) { testCases := []struct { userAgent string want bool }{ {"curl/7.51.0", true}, // false because it's not something (to my knowledge) that cURL would // ever return {"curl", false}, {"Mozilla", false}, {"", false}, } for _, tc := range testCases { t.Run(tc.userAgent, func(t *testing.T) { assert.Equal(t, tc.want, isCurl(tc.userAgent)) }) } } func TestValidateAuth(t *testing.T) { testCases := []struct { auth string want bool }{ {"Basic " + encode64("sk_test_123"), true}, {"Bearer sk_test_123", true}, {"", false}, {"Bearer", false}, {"Basic", false}, {"Bearer ", false}, {"Basic ", false}, {"Basic 123", false}, // "123" is not a valid key when base64 decoded {"Basic " + encode64("sk_test"), false}, {"Bearer sk_test_123 extra", false}, {"Bearer sk_test", false}, {"Bearer sk_test_123_extra", false}, {"Bearer sk_live_123", false}, {"Bearer sk_test_", false}, } for _, tc := range testCases { t.Run("Authorization: "+tc.auth, func(t *testing.T) { assert.Equal(t, tc.want, validateAuth(tc.auth)) }) } } // // Tests for private functions // func TestCompilePath(t *testing.T) { { pattern, pathParamNames := compilePath(spec.Path("/v1/charges")) assert.Equal(t, `\A/v1/charges\z`, pattern.String()) assert.Equal(t, []string(nil), pathParamNames) } { pattern, pathParamNames := compilePath(spec.Path("/v1/charges/{id}")) assert.Equal(t, `\A/v1/charges/(?P[\w@:%-._~!$&'()*+,;=]+)\z`, pattern.String()) assert.Equal(t, []string{"id"}, pathParamNames) // Match { matches := pattern.FindAllStringSubmatch("/v1/charges/ch_123", -1) assert.Equal(t, 1, len(matches)) assert.Equal(t, []string{"/v1/charges/ch_123", "ch_123"}, matches[0]) } // No match { matches := pattern.FindAllStringSubmatch("/v1/charges", -1) assert.Equal(t, 0, len(matches)) } // Special characters { special := "%-._~!$&'()*+,;=" matches := pattern.FindAllStringSubmatch("/v1/charges/"+special, -1) assert.Equal(t, 1, len(matches)) assert.Equal(t, []string{"/v1/charges/" + special, special}, matches[0]) } } } func TestParseExpansionLevel(t *testing.T) { emptyExpansionLevel := &ExpansionLevel{ expansions: make(map[string]*ExpansionLevel), } testCases := []struct { expansions []string want *ExpansionLevel }{ { []string{"charge", "customer"}, &ExpansionLevel{expansions: map[string]*ExpansionLevel{ "charge": emptyExpansionLevel, "customer": emptyExpansionLevel, }}, }, { []string{"charge.customer", "customer", "charge.source"}, &ExpansionLevel{expansions: map[string]*ExpansionLevel{ "charge": {expansions: map[string]*ExpansionLevel{ "customer": emptyExpansionLevel, "source": emptyExpansionLevel, }}, "customer": emptyExpansionLevel, }}, }, { []string{"charge.customer.default_source", "charge"}, &ExpansionLevel{expansions: map[string]*ExpansionLevel{ "charge": {expansions: map[string]*ExpansionLevel{ "customer": {expansions: map[string]*ExpansionLevel{ "default_source": emptyExpansionLevel, }}, }}, }}, }, { []string{"*"}, &ExpansionLevel{ expansions: map[string]*ExpansionLevel{}, wildcard: true, }, }, } for _, tc := range testCases { t.Run(fmt.Sprintf("%+v", tc.expansions), func(t *testing.T) { assert.Equal(t, tc.want, parseExpansionLevel(tc.expansions)) }) } } // // Private types // type testStubServerOptions struct { strictVersionCheck bool } // // Private functions // func encode64(s string) string { return base64.StdEncoding.EncodeToString([]byte(s)) } func getDefaultHeaders() map[string]string { headers := make(map[string]string) headers["Authorization"] = "Bearer sk_test_123" headers["Content-Type"] = "application/x-www-form-urlencoded" return headers } func getStubServer(t *testing.T, serverOptions *testStubServerOptions) *StubServer { if serverOptions == nil { serverOptions = &testStubServerOptions{} } server := &StubServer{ spec: &testSpec, fixtures: &testFixtures, strictVersionCheck: serverOptions.strictVersionCheck, } err := server.initializeRouter() assert.NoError(t, err) return server } func sendRequest(t *testing.T, method string, url string, params string, headers map[string]string, serverOptions *testStubServerOptions) (*http.Response, []byte) { server := getStubServer(t, serverOptions) fullURL := fmt.Sprintf("https://stripe.com%s", url) req := httptest.NewRequest(method, fullURL, bytes.NewBufferString(params)) for k, v := range headers { req.Header.Set(k, v) } w := httptest.NewRecorder() server.HandleRequest(w, req) resp := w.Result() body, err := ioutil.ReadAll(resp.Body) assert.NoError(t, err) return resp, body } stripe-mock-0.196.0/spec/000077500000000000000000000000001506013555700150655ustar00rootroot00000000000000stripe-mock-0.196.0/spec/query.go000066400000000000000000000016631506013555700165670ustar00rootroot00000000000000package spec // BuildQuerySchema builds a JSON schema that will be used to validate query // parameters on the incoming request. Unlike request bodies, OpenAPI puts // query parameters in a different, non-JSON schema part of an operation. func BuildQuerySchema(operation *Operation) *Schema { schema := &Schema{ AdditionalProperties: nil, AdditionalPropertiesAllowed: false, Properties: make(map[string]*Schema), Required: make([]string, 0), Type: TypeObject, } if operation.Parameters == nil { return schema } for _, param := range operation.Parameters { if param.In != ParameterQuery { continue } paramSchema := param.Schema if paramSchema == nil { paramSchema = &Schema{Type: TypeObject} } schema.Properties[param.Name] = paramSchema if param.Required { schema.Required = append(schema.Required, param.Name) } } return schema } stripe-mock-0.196.0/spec/query_test.go000066400000000000000000000030101506013555700176120ustar00rootroot00000000000000package spec import ( "testing" assert "github.com/stretchr/testify/require" ) func TestBuildQuerySchema(t *testing.T) { // Handles a normal case { operation := &Operation{ Parameters: []*Parameter{ { In: ParameterQuery, Name: "name", Schema: &Schema{ Type: TypeString, }, }, }, } schema := BuildQuerySchema(operation) assert.Nil(t, schema.AdditionalProperties) assert.Equal(t, false, schema.AdditionalPropertiesAllowed) assert.Equal(t, 1, len(schema.Properties)) assert.Equal(t, 0, len(schema.Required)) paramSchema := schema.Properties["name"] assert.Equal(t, TypeString, paramSchema.Type) } // A non-query parameter { operation := &Operation{ Parameters: []*Parameter{ { In: ParameterPath, Name: "name", }, }, } schema := BuildQuerySchema(operation) assert.Equal(t, 0, len(schema.Properties)) } // A required parameter { operation := &Operation{ Parameters: []*Parameter{ { In: ParameterQuery, Name: "name", Required: true, Schema: &Schema{ Type: TypeString, }, }, }, } schema := BuildQuerySchema(operation) assert.Equal(t, []string{"name"}, schema.Required) } // A query parameter with no schema { operation := &Operation{ Parameters: []*Parameter{ { In: ParameterQuery, Name: "name", }, }, } schema := BuildQuerySchema(operation) paramSchema := schema.Properties["name"] assert.Equal(t, TypeObject, paramSchema.Type) } } stripe-mock-0.196.0/spec/spec.go000066400000000000000000000167631506013555700163630ustar00rootroot00000000000000package spec import ( "encoding/json" "fmt" ) // // Public values // // A set of constants for the different types of possible OpenAPI parameters. const ( ParameterPath = "path" ParameterQuery = "query" ) // A set of constant for the named types available in JSON Schema. const ( TypeArray = "array" TypeBoolean = "boolean" TypeInteger = "integer" TypeNumber = "number" TypeObject = "object" TypeString = "string" ) // // Public types // // Components is a struct for the components section of an OpenAPI // specification. type Components struct { Schemas map[string]*Schema `json:"schemas"` } // ExpansionResources is a struct for possible expansions in a resource. type ExpansionResources struct { OneOf []*Schema `json:"oneOf"` } // Fixtures is a struct for a set of companion fixtures for an OpenAPI // specification. type Fixtures struct { Resources map[ResourceID]interface{} `json:"resources"` } // HTTPVerb is a type for an HTTP verb like GET, POST, etc. type HTTPVerb string // Info is the `info` portion of an OpenAPI specification that contains meta // information about it. type Info struct { // Version is the Stripe API version represented in the specification. It // takes a date-based form like `2019-02-19`. Version string `json:"version"` } // This is a list of fields that either we handle properly or we're confident // it's safe to ignore. If a field not in this list appears in the OpenAPI spec, // then we'll get an error so we remember to update stripe-mock to support it. var supportedSchemaFields = []string{ "$ref", "additionalProperties", "anyOf", "description", "enum", "format", "items", "maxLength", "nullable", "pattern", "properties", "required", "title", "type", "x-expandableFields", "x-expansionResources", "x-resourceId", // This is currently being used to store additional metadata for our SDKs. It's // passed through our Spec and should be ignored "x-stripeResource", "x-stripeOperations", "x-stripeParam", "x-stripeEvent", "x-stripeMostCommon", // This isn't used in our SDK, but is additional metadata unnecessary for // stripe-mock. "deprecated", // This is currently a hint for the server-side so I haven't included it in // Schema yet. If we do start validating responses that come out of // stripe-mock, we may need to observe this as well. "x-stripeBypassValidation", } // Schema is a struct representing a JSON schema. type Schema struct { // AdditionalProperties is either a nil to indicate that no additional // properties in the object are allowed (beyond what's in Properties), or a // JSON schema that describes the expected format of any additional properties. AdditionalProperties *Schema `json:"-"` AdditionalPropertiesAllowed bool AnyOf []*Schema `json:"anyOf,omitempty"` Enum []interface{} `json:"enum,omitempty"` Format string `json:"format,omitempty"` Items *Schema `json:"items,omitempty"` MaxLength int `json:"maxLength,omitempty"` Nullable bool `json:"nullable,omitempty"` Pattern string `json:"pattern,omitempty"` Properties map[string]*Schema `json:"properties,omitempty"` Required []string `json:"required,omitempty"` Type string `json:"type,omitempty"` // Ref is populated if this JSON Schema is actually a JSON reference, and // it defines the location of the actual schema definition. Ref string `json:"$ref,omitempty"` XExpandableFields *[]string `json:"x-expandableFields,omitempty"` XExpansionResources *ExpansionResources `json:"x-expansionResources,omitempty"` XResourceID string `json:"x-resourceId,omitempty"` } func (s *Schema) String() string { js, err := json.MarshalIndent(s, "", " ") if err != nil { panic(err) } return string(js) } // UnmarshalJSON is a custom JSON unmarshaling implementation for Schema that // provides better error messages instead of silently ignoring fields. func (s *Schema) UnmarshalJSON(data []byte) error { var rawFields map[string]interface{} err := json.Unmarshal(data, &rawFields) if err != nil { return err } additionalPropertiesValue := rawFields["additionalProperties"] for _, supportedField := range supportedSchemaFields { delete(rawFields, supportedField) } for unsupportedField := range rawFields { return fmt.Errorf( "unsupported field in JSON schema: '%s'", unsupportedField) } // Define a second type that's identical to Schema, but distinct, so that when // we call json.Unmarshal it will call the default implementation of // unmarshalling a Schema object instead of recursively calling this // UnmarshalJSON function again. type schemaAlias Schema var inner schemaAlias err = json.Unmarshal(data, &inner) if err != nil { return err } *s = Schema(inner) additionalPropertiesBool, ok := additionalPropertiesValue.(bool) // AdditionalProperties can be a `false` or `Schema` object for convenience turn // load bool and schema into different fields if ok { s.AdditionalPropertiesAllowed = additionalPropertiesBool return nil } else { s.AdditionalPropertiesAllowed = true } if additionalPropertiesValue != nil { type additionalProperties struct { AdditionalProperties *Schema `json:"additionalProperties,omitempty"` } var addProps additionalProperties err = json.Unmarshal(data, &addProps) if err != nil { return err } s.AdditionalProperties = addProps.AdditionalProperties } return nil } // MediaType is a struct bucketing a request or response by media type in an // OpenAPI specification. type MediaType struct { Schema *Schema `json:"schema"` } // Operation is a struct representing a possible HTTP operation in an OpenAPI // specification. type Operation struct { Description string `json:"description"` OperationID string `json:"operation_id"` Parameters []*Parameter `json:"parameters"` RequestBody *RequestBody `json:"requestBody"` Responses map[StatusCode]Response `json:"responses"` } // Parameter is a struct representing a request parameter to an HTTP operation // in an OpenAPI specification. type Parameter struct { Description string `json:"description"` In string `json:"in"` Name string `json:"name"` Required bool `json:"required"` Schema *Schema `json:"schema"` } // Path is a type for an HTTP path in an OpenAPI specification. type Path string // RequestBody is a struct representing the body of a request in an OpenAPI // specification. type RequestBody struct { Content map[string]MediaType `json:"content"` Required bool `json:"required"` } // Response is a struct representing the response of an HTTP operation in an // OpenAPI specification. type Response struct { Description string `json:"description"` Content map[string]MediaType `json:"content"` } // ResourceID is a type for the ID of a response resource in an OpenAPI // specification. type ResourceID string // Spec is a struct representing an OpenAPI specification. type Spec struct { Components Components `json:"components"` Info *Info `json:"info"` Paths map[Path]map[HTTPVerb]*Operation `json:"paths"` } // StatusCode is a type for the response status code of an HTTP operation in an // OpenAPI specification. type StatusCode string stripe-mock-0.196.0/spec/spec_test.go000066400000000000000000000033121506013555700174040ustar00rootroot00000000000000package spec import ( "encoding/json" "testing" assert "github.com/stretchr/testify/require" ) func TestUnmarshal_Simple(t *testing.T) { data := []byte(`{"type": "string"}`) var schema Schema err := json.Unmarshal(data, &schema) assert.NoError(t, err) assert.Equal(t, "string", schema.Type) } func TestUnmarshal_ObjectWithAdditionalProperties(t *testing.T) { data := []byte(`{ "type": "object", "additionalProperties": { "properties": { "prop": { "type": "number" } }, "type": "object" } }`) var schema Schema err := json.Unmarshal(data, &schema) assert.NoError(t, err) assert.Equal(t, "object", schema.Type) assert.True(t, schema.AdditionalPropertiesAllowed) assert.Equal(t, "object", schema.AdditionalProperties.Type) assert.Equal(t, 1, len(schema.AdditionalProperties.Properties)) } func TestUnmarshal_ObjectWithAdditionalPropertiesFalse(t *testing.T) { data := []byte(`{ "type": "object", "additionalProperties": false }`) var schema Schema err := json.Unmarshal(data, &schema) assert.NoError(t, err) assert.Equal(t, "object", schema.Type) assert.False(t, schema.AdditionalPropertiesAllowed) assert.Nil(t, schema.AdditionalProperties) } func TestUnmarshal_ObjectWithAdditionalPropertiesDefault(t *testing.T) { data := []byte(`{ "type": "object" }`) var schema Schema err := json.Unmarshal(data, &schema) assert.NoError(t, err) assert.Equal(t, "object", schema.Type) assert.True(t, schema.AdditionalPropertiesAllowed) assert.Nil(t, schema.AdditionalProperties) } func TestUnmarshal_UnsupportedField(t *testing.T) { // We don't support 'const' data := []byte(`{const: "hello"}`) var schema Schema err := json.Unmarshal(data, &schema) assert.Error(t, err) } stripe-mock-0.196.0/spec/validate.go000066400000000000000000000076751506013555700172240ustar00rootroot00000000000000package spec import ( "github.com/lestrrat-go/jsschema" "github.com/lestrrat-go/jsval" "github.com/lestrrat-go/jsval/builder" ) // ComponentsForValidation is a collection of components for an OpenAPI // specification that's been translated into equivalent JSON Schemas. type ComponentsForValidation struct { root interface{} } // GetValidatorForOpenAPI3Schema gets a JSON Schema validator for a given // OpenAPI specification and set of JSON Schema components. func GetValidatorForOpenAPI3Schema(oaiSchema *Schema, components *ComponentsForValidation) (*jsval.JSVal, error) { jsonSchemaAsJSON := getJSONSchemaForOpenAPI3Schema(oaiSchema) jsonSchema := schema.New() err := jsonSchema.Extract(jsonSchemaAsJSON) if err != nil { return nil, err } if components == nil { components = &ComponentsForValidation{root: make(map[string]interface{})} } validatorBuilder := builder.New() validator, err := validatorBuilder.BuildWithCtx(jsonSchema, components.root) if err != nil { return nil, err } return validator, nil } // GetComponentsForValidation translates a collection of components for an // OpenAPI specification into equivalent JSON schemas. // // See also the comment on getJSONSchemaForOpenAPI3Schema. func GetComponentsForValidation(components *Components) *ComponentsForValidation { jsonSchemas := make(map[string]interface{}) for name, oaiSchema := range components.Schemas { jsonSchemas[name] = getJSONSchemaForOpenAPI3Schema(oaiSchema) } return &ComponentsForValidation{ root: map[string]interface{}{ "components": map[string]interface{}{ "schemas": jsonSchemas, }, }, } } // Given an OpenAPI 3 schema represented as JSON, returns an equivalent JSON // Schema represented as JSON. The important difference between OpenAPI 3 // schemas and JSON schemas is that OpenAPI 3 uses "nullable: true" to mark // values that can be null, whereas JSON schemas represent "null" as a type just // like "string". // // This converter only handles the options that are supported by the spec.Schema // type, and it must be updated when new options are supported. func getJSONSchemaForOpenAPI3Schema(oai *Schema) map[string]interface{} { jss := make(map[string]interface{}) if !oai.AdditionalPropertiesAllowed { jss["additionalProperties"] = false } else { if oai.AdditionalProperties != nil { jss["additionalProperties"] = getJSONSchemaForOpenAPI3Schema(oai.AdditionalProperties) } } if len(oai.AnyOf) != 0 { var jssAnyOf = make([]interface{}, len(oai.AnyOf)) for index, oaiSubschema := range oai.AnyOf { jssAnyOf[index] = getJSONSchemaForOpenAPI3Schema(oaiSubschema) } if oai.Nullable { jssAnyOf = append(jssAnyOf, map[string]interface{}{"const": nil}) } jss["anyOf"] = jssAnyOf } if len(oai.Enum) != 0 { var jssEnum = make([]interface{}, len(oai.Enum)) for index, oaiValue := range oai.Enum { jssEnum[index] = oaiValue } jss["enum"] = jssEnum } if oai.Format != "" { // Note that the major format that will be seen here, unix-time, will // not be supported by the validator we're using -- we should probably // see if we can support that properly. jss["format"] = oai.Format } if oai.Items != nil { jss["items"] = getJSONSchemaForOpenAPI3Schema(oai.Items) } if oai.MaxLength != 0 { jss["maxLength"] = oai.MaxLength } if oai.Pattern != "" { jss["pattern"] = oai.Pattern } if len(oai.Properties) != 0 { var jssProperties = make(map[string]interface{}) for key, oaiSubschema := range oai.Properties { jssProperties[key] = getJSONSchemaForOpenAPI3Schema(oaiSubschema) } jss["properties"] = jssProperties } if len(oai.Required) != 0 { var jssRequired = make([]interface{}, len(oai.Required)) for index, oaiValue := range oai.Required { jssRequired[index] = oaiValue } jss["required"] = jssRequired } if oai.Type != "" { if oai.Nullable { jss["type"] = []interface{}{oai.Type, "null"} } else { jss["type"] = oai.Type } } if oai.Ref != "" { jss["$ref"] = oai.Ref } return jss } stripe-mock-0.196.0/spec/validate_test.go000066400000000000000000000021661506013555700202510ustar00rootroot00000000000000package spec import ( "testing" assert "github.com/stretchr/testify/require" ) func TestValidator_Simple(t *testing.T) { schema := Schema{ Type: "string", } v, err := GetValidatorForOpenAPI3Schema(&schema, nil) assert.NoError(t, err) assert.NoError(t, v.Validate("hello")) assert.Error(t, v.Validate(nil)) assert.Error(t, v.Validate(123)) } func TestValidator_Nullable(t *testing.T) { schema := Schema{ Type: "string", Nullable: true, } v, err := GetValidatorForOpenAPI3Schema(&schema, nil) assert.NoError(t, err) assert.NoError(t, v.Validate("hello")) assert.NoError(t, v.Validate(nil)) assert.Error(t, v.Validate(123)) } func TestValidator_Reference(t *testing.T) { fooSchema := Schema{ Type: "string", } components := Components{ Schemas: map[string]*Schema{ "foo": &fooSchema, }, } componentsForValidation := GetComponentsForValidation(&components) fooRefSchema := Schema{ Ref: "#/components/schemas/foo", } v, err := GetValidatorForOpenAPI3Schema(&fooRefSchema, componentsForValidation) assert.NoError(t, err) assert.NoError(t, v.Validate("hello")) assert.Error(t, v.Validate(123)) } stripe-mock-0.196.0/staticcheck.conf000066400000000000000000000000471506013555700172700ustar00rootroot00000000000000checks = ["all", "-ST1005", "-ST1021"] stripe-mock-0.196.0/vendor/000077500000000000000000000000001506013555700154305ustar00rootroot00000000000000stripe-mock-0.196.0/vendor/github.com/000077500000000000000000000000001506013555700174675ustar00rootroot00000000000000stripe-mock-0.196.0/vendor/github.com/davecgh/000077500000000000000000000000001506013555700210705ustar00rootroot00000000000000stripe-mock-0.196.0/vendor/github.com/davecgh/go-spew/000077500000000000000000000000001506013555700224515ustar00rootroot00000000000000stripe-mock-0.196.0/vendor/github.com/davecgh/go-spew/LICENSE000066400000000000000000000013561506013555700234630ustar00rootroot00000000000000Copyright (c) 2012-2013 Dave Collins Permission to use, copy, modify, and distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. stripe-mock-0.196.0/vendor/github.com/davecgh/go-spew/spew/000077500000000000000000000000001506013555700234275ustar00rootroot00000000000000stripe-mock-0.196.0/vendor/github.com/davecgh/go-spew/spew/bypass.go000066400000000000000000000130711506013555700252610ustar00rootroot00000000000000// Copyright (c) 2015 Dave Collins // // Permission to use, copy, modify, and distribute this software for any // purpose with or without fee is hereby granted, provided that the above // copyright notice and this permission notice appear in all copies. // // THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES // WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF // MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR // ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES // WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN // ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF // OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. // NOTE: Due to the following build constraints, this file will only be compiled // when the code is not running on Google App Engine and "-tags disableunsafe" // is not added to the go build command line. // +build !appengine,!disableunsafe package spew import ( "reflect" "unsafe" ) const ( // UnsafeDisabled is a build-time constant which specifies whether or // not access to the unsafe package is available. UnsafeDisabled = false // ptrSize is the size of a pointer on the current arch. ptrSize = unsafe.Sizeof((*byte)(nil)) ) var ( // offsetPtr, offsetScalar, and offsetFlag are the offsets for the // internal reflect.Value fields. These values are valid before golang // commit ecccf07e7f9d which changed the format. The are also valid // after commit 82f48826c6c7 which changed the format again to mirror // the original format. Code in the init function updates these offsets // as necessary. offsetPtr = uintptr(ptrSize) offsetScalar = uintptr(0) offsetFlag = uintptr(ptrSize * 2) // flagKindWidth and flagKindShift indicate various bits that the // reflect package uses internally to track kind information. // // flagRO indicates whether or not the value field of a reflect.Value is // read-only. // // flagIndir indicates whether the value field of a reflect.Value is // the actual data or a pointer to the data. // // These values are valid before golang commit 90a7c3c86944 which // changed their positions. Code in the init function updates these // flags as necessary. flagKindWidth = uintptr(5) flagKindShift = uintptr(flagKindWidth - 1) flagRO = uintptr(1 << 0) flagIndir = uintptr(1 << 1) ) func init() { // Older versions of reflect.Value stored small integers directly in the // ptr field (which is named val in the older versions). Versions // between commits ecccf07e7f9d and 82f48826c6c7 added a new field named // scalar for this purpose which unfortunately came before the flag // field, so the offset of the flag field is different for those // versions. // // This code constructs a new reflect.Value from a known small integer // and checks if the size of the reflect.Value struct indicates it has // the scalar field. When it does, the offsets are updated accordingly. vv := reflect.ValueOf(0xf00) if unsafe.Sizeof(vv) == (ptrSize * 4) { offsetScalar = ptrSize * 2 offsetFlag = ptrSize * 3 } // Commit 90a7c3c86944 changed the flag positions such that the low // order bits are the kind. This code extracts the kind from the flags // field and ensures it's the correct type. When it's not, the flag // order has been changed to the newer format, so the flags are updated // accordingly. upf := unsafe.Pointer(uintptr(unsafe.Pointer(&vv)) + offsetFlag) upfv := *(*uintptr)(upf) flagKindMask := uintptr((1<>flagKindShift != uintptr(reflect.Int) { flagKindShift = 0 flagRO = 1 << 5 flagIndir = 1 << 6 // Commit adf9b30e5594 modified the flags to separate the // flagRO flag into two bits which specifies whether or not the // field is embedded. This causes flagIndir to move over a bit // and means that flagRO is the combination of either of the // original flagRO bit and the new bit. // // This code detects the change by extracting what used to be // the indirect bit to ensure it's set. When it's not, the flag // order has been changed to the newer format, so the flags are // updated accordingly. if upfv&flagIndir == 0 { flagRO = 3 << 5 flagIndir = 1 << 7 } } } // unsafeReflectValue converts the passed reflect.Value into a one that bypasses // the typical safety restrictions preventing access to unaddressable and // unexported data. It works by digging the raw pointer to the underlying // value out of the protected value and generating a new unprotected (unsafe) // reflect.Value to it. // // This allows us to check for implementations of the Stringer and error // interfaces to be used for pretty printing ordinarily unaddressable and // inaccessible values such as unexported struct fields. func unsafeReflectValue(v reflect.Value) (rv reflect.Value) { indirects := 1 vt := v.Type() upv := unsafe.Pointer(uintptr(unsafe.Pointer(&v)) + offsetPtr) rvf := *(*uintptr)(unsafe.Pointer(uintptr(unsafe.Pointer(&v)) + offsetFlag)) if rvf&flagIndir != 0 { vt = reflect.PtrTo(v.Type()) indirects++ } else if offsetScalar != 0 { // The value is in the scalar field when it's not one of the // reference types. switch vt.Kind() { case reflect.Uintptr: case reflect.Chan: case reflect.Func: case reflect.Map: case reflect.Ptr: case reflect.UnsafePointer: default: upv = unsafe.Pointer(uintptr(unsafe.Pointer(&v)) + offsetScalar) } } pv := reflect.NewAt(vt, upv) rv = pv for i := 0; i < indirects; i++ { rv = rv.Elem() } return rv } stripe-mock-0.196.0/vendor/github.com/davecgh/go-spew/spew/bypasssafe.go000066400000000000000000000031531506013555700261200ustar00rootroot00000000000000// Copyright (c) 2015 Dave Collins // // Permission to use, copy, modify, and distribute this software for any // purpose with or without fee is hereby granted, provided that the above // copyright notice and this permission notice appear in all copies. // // THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES // WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF // MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR // ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES // WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN // ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF // OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. // NOTE: Due to the following build constraints, this file will only be compiled // when either the code is running on Google App Engine or "-tags disableunsafe" // is added to the go build command line. // +build appengine disableunsafe package spew import "reflect" const ( // UnsafeDisabled is a build-time constant which specifies whether or // not access to the unsafe package is available. UnsafeDisabled = true ) // unsafeReflectValue typically converts the passed reflect.Value into a one // that bypasses the typical safety restrictions preventing access to // unaddressable and unexported data. However, doing this relies on access to // the unsafe package. This is a stub version which simply returns the passed // reflect.Value when the unsafe package is not available. func unsafeReflectValue(v reflect.Value) reflect.Value { return v } stripe-mock-0.196.0/vendor/github.com/davecgh/go-spew/spew/common.go000066400000000000000000000241671506013555700252600ustar00rootroot00000000000000/* * Copyright (c) 2013 Dave Collins * * Permission to use, copy, modify, and distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ package spew import ( "bytes" "fmt" "io" "reflect" "sort" "strconv" ) // Some constants in the form of bytes to avoid string overhead. This mirrors // the technique used in the fmt package. var ( panicBytes = []byte("(PANIC=") plusBytes = []byte("+") iBytes = []byte("i") trueBytes = []byte("true") falseBytes = []byte("false") interfaceBytes = []byte("(interface {})") commaNewlineBytes = []byte(",\n") newlineBytes = []byte("\n") openBraceBytes = []byte("{") openBraceNewlineBytes = []byte("{\n") closeBraceBytes = []byte("}") asteriskBytes = []byte("*") colonBytes = []byte(":") colonSpaceBytes = []byte(": ") openParenBytes = []byte("(") closeParenBytes = []byte(")") spaceBytes = []byte(" ") pointerChainBytes = []byte("->") nilAngleBytes = []byte("") maxNewlineBytes = []byte("\n") maxShortBytes = []byte("") circularBytes = []byte("") circularShortBytes = []byte("") invalidAngleBytes = []byte("") openBracketBytes = []byte("[") closeBracketBytes = []byte("]") percentBytes = []byte("%") precisionBytes = []byte(".") openAngleBytes = []byte("<") closeAngleBytes = []byte(">") openMapBytes = []byte("map[") closeMapBytes = []byte("]") lenEqualsBytes = []byte("len=") capEqualsBytes = []byte("cap=") ) // hexDigits is used to map a decimal value to a hex digit. var hexDigits = "0123456789abcdef" // catchPanic handles any panics that might occur during the handleMethods // calls. func catchPanic(w io.Writer, v reflect.Value) { if err := recover(); err != nil { w.Write(panicBytes) fmt.Fprintf(w, "%v", err) w.Write(closeParenBytes) } } // handleMethods attempts to call the Error and String methods on the underlying // type the passed reflect.Value represents and outputes the result to Writer w. // // It handles panics in any called methods by catching and displaying the error // as the formatted value. func handleMethods(cs *ConfigState, w io.Writer, v reflect.Value) (handled bool) { // We need an interface to check if the type implements the error or // Stringer interface. However, the reflect package won't give us an // interface on certain things like unexported struct fields in order // to enforce visibility rules. We use unsafe, when it's available, // to bypass these restrictions since this package does not mutate the // values. if !v.CanInterface() { if UnsafeDisabled { return false } v = unsafeReflectValue(v) } // Choose whether or not to do error and Stringer interface lookups against // the base type or a pointer to the base type depending on settings. // Technically calling one of these methods with a pointer receiver can // mutate the value, however, types which choose to satisify an error or // Stringer interface with a pointer receiver should not be mutating their // state inside these interface methods. if !cs.DisablePointerMethods && !UnsafeDisabled && !v.CanAddr() { v = unsafeReflectValue(v) } if v.CanAddr() { v = v.Addr() } // Is it an error or Stringer? switch iface := v.Interface().(type) { case error: defer catchPanic(w, v) if cs.ContinueOnMethod { w.Write(openParenBytes) w.Write([]byte(iface.Error())) w.Write(closeParenBytes) w.Write(spaceBytes) return false } w.Write([]byte(iface.Error())) return true case fmt.Stringer: defer catchPanic(w, v) if cs.ContinueOnMethod { w.Write(openParenBytes) w.Write([]byte(iface.String())) w.Write(closeParenBytes) w.Write(spaceBytes) return false } w.Write([]byte(iface.String())) return true } return false } // printBool outputs a boolean value as true or false to Writer w. func printBool(w io.Writer, val bool) { if val { w.Write(trueBytes) } else { w.Write(falseBytes) } } // printInt outputs a signed integer value to Writer w. func printInt(w io.Writer, val int64, base int) { w.Write([]byte(strconv.FormatInt(val, base))) } // printUint outputs an unsigned integer value to Writer w. func printUint(w io.Writer, val uint64, base int) { w.Write([]byte(strconv.FormatUint(val, base))) } // printFloat outputs a floating point value using the specified precision, // which is expected to be 32 or 64bit, to Writer w. func printFloat(w io.Writer, val float64, precision int) { w.Write([]byte(strconv.FormatFloat(val, 'g', -1, precision))) } // printComplex outputs a complex value using the specified float precision // for the real and imaginary parts to Writer w. func printComplex(w io.Writer, c complex128, floatPrecision int) { r := real(c) w.Write(openParenBytes) w.Write([]byte(strconv.FormatFloat(r, 'g', -1, floatPrecision))) i := imag(c) if i >= 0 { w.Write(plusBytes) } w.Write([]byte(strconv.FormatFloat(i, 'g', -1, floatPrecision))) w.Write(iBytes) w.Write(closeParenBytes) } // printHexPtr outputs a uintptr formatted as hexidecimal with a leading '0x' // prefix to Writer w. func printHexPtr(w io.Writer, p uintptr) { // Null pointer. num := uint64(p) if num == 0 { w.Write(nilAngleBytes) return } // Max uint64 is 16 bytes in hex + 2 bytes for '0x' prefix buf := make([]byte, 18) // It's simpler to construct the hex string right to left. base := uint64(16) i := len(buf) - 1 for num >= base { buf[i] = hexDigits[num%base] num /= base i-- } buf[i] = hexDigits[num] // Add '0x' prefix. i-- buf[i] = 'x' i-- buf[i] = '0' // Strip unused leading bytes. buf = buf[i:] w.Write(buf) } // valuesSorter implements sort.Interface to allow a slice of reflect.Value // elements to be sorted. type valuesSorter struct { values []reflect.Value strings []string // either nil or same len and values cs *ConfigState } // newValuesSorter initializes a valuesSorter instance, which holds a set of // surrogate keys on which the data should be sorted. It uses flags in // ConfigState to decide if and how to populate those surrogate keys. func newValuesSorter(values []reflect.Value, cs *ConfigState) sort.Interface { vs := &valuesSorter{values: values, cs: cs} if canSortSimply(vs.values[0].Kind()) { return vs } if !cs.DisableMethods { vs.strings = make([]string, len(values)) for i := range vs.values { b := bytes.Buffer{} if !handleMethods(cs, &b, vs.values[i]) { vs.strings = nil break } vs.strings[i] = b.String() } } if vs.strings == nil && cs.SpewKeys { vs.strings = make([]string, len(values)) for i := range vs.values { vs.strings[i] = Sprintf("%#v", vs.values[i].Interface()) } } return vs } // canSortSimply tests whether a reflect.Kind is a primitive that can be sorted // directly, or whether it should be considered for sorting by surrogate keys // (if the ConfigState allows it). func canSortSimply(kind reflect.Kind) bool { // This switch parallels valueSortLess, except for the default case. switch kind { case reflect.Bool: return true case reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64, reflect.Int: return true case reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64, reflect.Uint: return true case reflect.Float32, reflect.Float64: return true case reflect.String: return true case reflect.Uintptr: return true case reflect.Array: return true } return false } // Len returns the number of values in the slice. It is part of the // sort.Interface implementation. func (s *valuesSorter) Len() int { return len(s.values) } // Swap swaps the values at the passed indices. It is part of the // sort.Interface implementation. func (s *valuesSorter) Swap(i, j int) { s.values[i], s.values[j] = s.values[j], s.values[i] if s.strings != nil { s.strings[i], s.strings[j] = s.strings[j], s.strings[i] } } // valueSortLess returns whether the first value should sort before the second // value. It is used by valueSorter.Less as part of the sort.Interface // implementation. func valueSortLess(a, b reflect.Value) bool { switch a.Kind() { case reflect.Bool: return !a.Bool() && b.Bool() case reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64, reflect.Int: return a.Int() < b.Int() case reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64, reflect.Uint: return a.Uint() < b.Uint() case reflect.Float32, reflect.Float64: return a.Float() < b.Float() case reflect.String: return a.String() < b.String() case reflect.Uintptr: return a.Uint() < b.Uint() case reflect.Array: // Compare the contents of both arrays. l := a.Len() for i := 0; i < l; i++ { av := a.Index(i) bv := b.Index(i) if av.Interface() == bv.Interface() { continue } return valueSortLess(av, bv) } } return a.String() < b.String() } // Less returns whether the value at index i should sort before the // value at index j. It is part of the sort.Interface implementation. func (s *valuesSorter) Less(i, j int) bool { if s.strings == nil { return valueSortLess(s.values[i], s.values[j]) } return s.strings[i] < s.strings[j] } // sortValues is a sort function that handles both native types and any type that // can be converted to error or Stringer. Other inputs are sorted according to // their Value.String() value to ensure display stability. func sortValues(values []reflect.Value, cs *ConfigState) { if len(values) == 0 { return } sort.Sort(newValuesSorter(values, cs)) } stripe-mock-0.196.0/vendor/github.com/davecgh/go-spew/spew/config.go000066400000000000000000000302551506013555700252300ustar00rootroot00000000000000/* * Copyright (c) 2013 Dave Collins * * Permission to use, copy, modify, and distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ package spew import ( "bytes" "fmt" "io" "os" ) // ConfigState houses the configuration options used by spew to format and // display values. There is a global instance, Config, that is used to control // all top-level Formatter and Dump functionality. Each ConfigState instance // provides methods equivalent to the top-level functions. // // The zero value for ConfigState provides no indentation. You would typically // want to set it to a space or a tab. // // Alternatively, you can use NewDefaultConfig to get a ConfigState instance // with default settings. See the documentation of NewDefaultConfig for default // values. type ConfigState struct { // Indent specifies the string to use for each indentation level. The // global config instance that all top-level functions use set this to a // single space by default. If you would like more indentation, you might // set this to a tab with "\t" or perhaps two spaces with " ". Indent string // MaxDepth controls the maximum number of levels to descend into nested // data structures. The default, 0, means there is no limit. // // NOTE: Circular data structures are properly detected, so it is not // necessary to set this value unless you specifically want to limit deeply // nested data structures. MaxDepth int // DisableMethods specifies whether or not error and Stringer interfaces are // invoked for types that implement them. DisableMethods bool // DisablePointerMethods specifies whether or not to check for and invoke // error and Stringer interfaces on types which only accept a pointer // receiver when the current type is not a pointer. // // NOTE: This might be an unsafe action since calling one of these methods // with a pointer receiver could technically mutate the value, however, // in practice, types which choose to satisify an error or Stringer // interface with a pointer receiver should not be mutating their state // inside these interface methods. As a result, this option relies on // access to the unsafe package, so it will not have any effect when // running in environments without access to the unsafe package such as // Google App Engine or with the "disableunsafe" build tag specified. DisablePointerMethods bool // ContinueOnMethod specifies whether or not recursion should continue once // a custom error or Stringer interface is invoked. The default, false, // means it will print the results of invoking the custom error or Stringer // interface and return immediately instead of continuing to recurse into // the internals of the data type. // // NOTE: This flag does not have any effect if method invocation is disabled // via the DisableMethods or DisablePointerMethods options. ContinueOnMethod bool // SortKeys specifies map keys should be sorted before being printed. Use // this to have a more deterministic, diffable output. Note that only // native types (bool, int, uint, floats, uintptr and string) and types // that support the error or Stringer interfaces (if methods are // enabled) are supported, with other types sorted according to the // reflect.Value.String() output which guarantees display stability. SortKeys bool // SpewKeys specifies that, as a last resort attempt, map keys should // be spewed to strings and sorted by those strings. This is only // considered if SortKeys is true. SpewKeys bool } // Config is the active configuration of the top-level functions. // The configuration can be changed by modifying the contents of spew.Config. var Config = ConfigState{Indent: " "} // Errorf is a wrapper for fmt.Errorf that treats each argument as if it were // passed with a Formatter interface returned by c.NewFormatter. It returns // the formatted string as a value that satisfies error. See NewFormatter // for formatting details. // // This function is shorthand for the following syntax: // // fmt.Errorf(format, c.NewFormatter(a), c.NewFormatter(b)) func (c *ConfigState) Errorf(format string, a ...interface{}) (err error) { return fmt.Errorf(format, c.convertArgs(a)...) } // Fprint is a wrapper for fmt.Fprint that treats each argument as if it were // passed with a Formatter interface returned by c.NewFormatter. It returns // the number of bytes written and any write error encountered. See // NewFormatter for formatting details. // // This function is shorthand for the following syntax: // // fmt.Fprint(w, c.NewFormatter(a), c.NewFormatter(b)) func (c *ConfigState) Fprint(w io.Writer, a ...interface{}) (n int, err error) { return fmt.Fprint(w, c.convertArgs(a)...) } // Fprintf is a wrapper for fmt.Fprintf that treats each argument as if it were // passed with a Formatter interface returned by c.NewFormatter. It returns // the number of bytes written and any write error encountered. See // NewFormatter for formatting details. // // This function is shorthand for the following syntax: // // fmt.Fprintf(w, format, c.NewFormatter(a), c.NewFormatter(b)) func (c *ConfigState) Fprintf(w io.Writer, format string, a ...interface{}) (n int, err error) { return fmt.Fprintf(w, format, c.convertArgs(a)...) } // Fprintln is a wrapper for fmt.Fprintln that treats each argument as if it // passed with a Formatter interface returned by c.NewFormatter. See // NewFormatter for formatting details. // // This function is shorthand for the following syntax: // // fmt.Fprintln(w, c.NewFormatter(a), c.NewFormatter(b)) func (c *ConfigState) Fprintln(w io.Writer, a ...interface{}) (n int, err error) { return fmt.Fprintln(w, c.convertArgs(a)...) } // Print is a wrapper for fmt.Print that treats each argument as if it were // passed with a Formatter interface returned by c.NewFormatter. It returns // the number of bytes written and any write error encountered. See // NewFormatter for formatting details. // // This function is shorthand for the following syntax: // // fmt.Print(c.NewFormatter(a), c.NewFormatter(b)) func (c *ConfigState) Print(a ...interface{}) (n int, err error) { return fmt.Print(c.convertArgs(a)...) } // Printf is a wrapper for fmt.Printf that treats each argument as if it were // passed with a Formatter interface returned by c.NewFormatter. It returns // the number of bytes written and any write error encountered. See // NewFormatter for formatting details. // // This function is shorthand for the following syntax: // // fmt.Printf(format, c.NewFormatter(a), c.NewFormatter(b)) func (c *ConfigState) Printf(format string, a ...interface{}) (n int, err error) { return fmt.Printf(format, c.convertArgs(a)...) } // Println is a wrapper for fmt.Println that treats each argument as if it were // passed with a Formatter interface returned by c.NewFormatter. It returns // the number of bytes written and any write error encountered. See // NewFormatter for formatting details. // // This function is shorthand for the following syntax: // // fmt.Println(c.NewFormatter(a), c.NewFormatter(b)) func (c *ConfigState) Println(a ...interface{}) (n int, err error) { return fmt.Println(c.convertArgs(a)...) } // Sprint is a wrapper for fmt.Sprint that treats each argument as if it were // passed with a Formatter interface returned by c.NewFormatter. It returns // the resulting string. See NewFormatter for formatting details. // // This function is shorthand for the following syntax: // // fmt.Sprint(c.NewFormatter(a), c.NewFormatter(b)) func (c *ConfigState) Sprint(a ...interface{}) string { return fmt.Sprint(c.convertArgs(a)...) } // Sprintf is a wrapper for fmt.Sprintf that treats each argument as if it were // passed with a Formatter interface returned by c.NewFormatter. It returns // the resulting string. See NewFormatter for formatting details. // // This function is shorthand for the following syntax: // // fmt.Sprintf(format, c.NewFormatter(a), c.NewFormatter(b)) func (c *ConfigState) Sprintf(format string, a ...interface{}) string { return fmt.Sprintf(format, c.convertArgs(a)...) } // Sprintln is a wrapper for fmt.Sprintln that treats each argument as if it // were passed with a Formatter interface returned by c.NewFormatter. It // returns the resulting string. See NewFormatter for formatting details. // // This function is shorthand for the following syntax: // // fmt.Sprintln(c.NewFormatter(a), c.NewFormatter(b)) func (c *ConfigState) Sprintln(a ...interface{}) string { return fmt.Sprintln(c.convertArgs(a)...) } /* NewFormatter returns a custom formatter that satisfies the fmt.Formatter interface. As a result, it integrates cleanly with standard fmt package printing functions. The formatter is useful for inline printing of smaller data types similar to the standard %v format specifier. The custom formatter only responds to the %v (most compact), %+v (adds pointer addresses), %#v (adds types), and %#+v (adds types and pointer addresses) verb combinations. Any other verbs such as %x and %q will be sent to the the standard fmt package for formatting. In addition, the custom formatter ignores the width and precision arguments (however they will still work on the format specifiers not handled by the custom formatter). Typically this function shouldn't be called directly. It is much easier to make use of the custom formatter by calling one of the convenience functions such as c.Printf, c.Println, or c.Printf. */ func (c *ConfigState) NewFormatter(v interface{}) fmt.Formatter { return newFormatter(c, v) } // Fdump formats and displays the passed arguments to io.Writer w. It formats // exactly the same as Dump. func (c *ConfigState) Fdump(w io.Writer, a ...interface{}) { fdump(c, w, a...) } /* Dump displays the passed parameters to standard out with newlines, customizable indentation, and additional debug information such as complete types and all pointer addresses used to indirect to the final value. It provides the following features over the built-in printing facilities provided by the fmt package: * Pointers are dereferenced and followed * Circular data structures are detected and handled properly * Custom Stringer/error interfaces are optionally invoked, including on unexported types * Custom types which only implement the Stringer/error interfaces via a pointer receiver are optionally invoked when passing non-pointer variables * Byte arrays and slices are dumped like the hexdump -C command which includes offsets, byte values in hex, and ASCII output The configuration options are controlled by modifying the public members of c. See ConfigState for options documentation. See Fdump if you would prefer dumping to an arbitrary io.Writer or Sdump to get the formatted result as a string. */ func (c *ConfigState) Dump(a ...interface{}) { fdump(c, os.Stdout, a...) } // Sdump returns a string with the passed arguments formatted exactly the same // as Dump. func (c *ConfigState) Sdump(a ...interface{}) string { var buf bytes.Buffer fdump(c, &buf, a...) return buf.String() } // convertArgs accepts a slice of arguments and returns a slice of the same // length with each argument converted to a spew Formatter interface using // the ConfigState associated with s. func (c *ConfigState) convertArgs(args []interface{}) (formatters []interface{}) { formatters = make([]interface{}, len(args)) for index, arg := range args { formatters[index] = newFormatter(c, arg) } return formatters } // NewDefaultConfig returns a ConfigState with the following default settings. // // Indent: " " // MaxDepth: 0 // DisableMethods: false // DisablePointerMethods: false // ContinueOnMethod: false // SortKeys: false func NewDefaultConfig() *ConfigState { return &ConfigState{Indent: " "} } stripe-mock-0.196.0/vendor/github.com/davecgh/go-spew/spew/doc.go000066400000000000000000000177311506013555700245340ustar00rootroot00000000000000/* * Copyright (c) 2013 Dave Collins * * Permission to use, copy, modify, and distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ /* Package spew implements a deep pretty printer for Go data structures to aid in debugging. A quick overview of the additional features spew provides over the built-in printing facilities for Go data types are as follows: * Pointers are dereferenced and followed * Circular data structures are detected and handled properly * Custom Stringer/error interfaces are optionally invoked, including on unexported types * Custom types which only implement the Stringer/error interfaces via a pointer receiver are optionally invoked when passing non-pointer variables * Byte arrays and slices are dumped like the hexdump -C command which includes offsets, byte values in hex, and ASCII output (only when using Dump style) There are two different approaches spew allows for dumping Go data structures: * Dump style which prints with newlines, customizable indentation, and additional debug information such as types and all pointer addresses used to indirect to the final value * A custom Formatter interface that integrates cleanly with the standard fmt package and replaces %v, %+v, %#v, and %#+v to provide inline printing similar to the default %v while providing the additional functionality outlined above and passing unsupported format verbs such as %x and %q along to fmt Quick Start This section demonstrates how to quickly get started with spew. See the sections below for further details on formatting and configuration options. To dump a variable with full newlines, indentation, type, and pointer information use Dump, Fdump, or Sdump: spew.Dump(myVar1, myVar2, ...) spew.Fdump(someWriter, myVar1, myVar2, ...) str := spew.Sdump(myVar1, myVar2, ...) Alternatively, if you would prefer to use format strings with a compacted inline printing style, use the convenience wrappers Printf, Fprintf, etc with %v (most compact), %+v (adds pointer addresses), %#v (adds types), or %#+v (adds types and pointer addresses): spew.Printf("myVar1: %v -- myVar2: %+v", myVar1, myVar2) spew.Printf("myVar3: %#v -- myVar4: %#+v", myVar3, myVar4) spew.Fprintf(someWriter, "myVar1: %v -- myVar2: %+v", myVar1, myVar2) spew.Fprintf(someWriter, "myVar3: %#v -- myVar4: %#+v", myVar3, myVar4) Configuration Options Configuration of spew is handled by fields in the ConfigState type. For convenience, all of the top-level functions use a global state available via the spew.Config global. It is also possible to create a ConfigState instance that provides methods equivalent to the top-level functions. This allows concurrent configuration options. See the ConfigState documentation for more details. The following configuration options are available: * Indent String to use for each indentation level for Dump functions. It is a single space by default. A popular alternative is "\t". * MaxDepth Maximum number of levels to descend into nested data structures. There is no limit by default. * DisableMethods Disables invocation of error and Stringer interface methods. Method invocation is enabled by default. * DisablePointerMethods Disables invocation of error and Stringer interface methods on types which only accept pointer receivers from non-pointer variables. Pointer method invocation is enabled by default. * ContinueOnMethod Enables recursion into types after invoking error and Stringer interface methods. Recursion after method invocation is disabled by default. * SortKeys Specifies map keys should be sorted before being printed. Use this to have a more deterministic, diffable output. Note that only native types (bool, int, uint, floats, uintptr and string) and types which implement error or Stringer interfaces are supported with other types sorted according to the reflect.Value.String() output which guarantees display stability. Natural map order is used by default. * SpewKeys Specifies that, as a last resort attempt, map keys should be spewed to strings and sorted by those strings. This is only considered if SortKeys is true. Dump Usage Simply call spew.Dump with a list of variables you want to dump: spew.Dump(myVar1, myVar2, ...) You may also call spew.Fdump if you would prefer to output to an arbitrary io.Writer. For example, to dump to standard error: spew.Fdump(os.Stderr, myVar1, myVar2, ...) A third option is to call spew.Sdump to get the formatted output as a string: str := spew.Sdump(myVar1, myVar2, ...) Sample Dump Output See the Dump example for details on the setup of the types and variables being shown here. (main.Foo) { unexportedField: (*main.Bar)(0xf84002e210)({ flag: (main.Flag) flagTwo, data: (uintptr) }), ExportedField: (map[interface {}]interface {}) (len=1) { (string) (len=3) "one": (bool) true } } Byte (and uint8) arrays and slices are displayed uniquely like the hexdump -C command as shown. ([]uint8) (len=32 cap=32) { 00000000 11 12 13 14 15 16 17 18 19 1a 1b 1c 1d 1e 1f 20 |............... | 00000010 21 22 23 24 25 26 27 28 29 2a 2b 2c 2d 2e 2f 30 |!"#$%&'()*+,-./0| 00000020 31 32 |12| } Custom Formatter Spew provides a custom formatter that implements the fmt.Formatter interface so that it integrates cleanly with standard fmt package printing functions. The formatter is useful for inline printing of smaller data types similar to the standard %v format specifier. The custom formatter only responds to the %v (most compact), %+v (adds pointer addresses), %#v (adds types), or %#+v (adds types and pointer addresses) verb combinations. Any other verbs such as %x and %q will be sent to the the standard fmt package for formatting. In addition, the custom formatter ignores the width and precision arguments (however they will still work on the format specifiers not handled by the custom formatter). Custom Formatter Usage The simplest way to make use of the spew custom formatter is to call one of the convenience functions such as spew.Printf, spew.Println, or spew.Printf. The functions have syntax you are most likely already familiar with: spew.Printf("myVar1: %v -- myVar2: %+v", myVar1, myVar2) spew.Printf("myVar3: %#v -- myVar4: %#+v", myVar3, myVar4) spew.Println(myVar, myVar2) spew.Fprintf(os.Stderr, "myVar1: %v -- myVar2: %+v", myVar1, myVar2) spew.Fprintf(os.Stderr, "myVar3: %#v -- myVar4: %#+v", myVar3, myVar4) See the Index for the full list convenience functions. Sample Formatter Output Double pointer to a uint8: %v: <**>5 %+v: <**>(0xf8400420d0->0xf8400420c8)5 %#v: (**uint8)5 %#+v: (**uint8)(0xf8400420d0->0xf8400420c8)5 Pointer to circular struct with a uint8 field and a pointer to itself: %v: <*>{1 <*>} %+v: <*>(0xf84003e260){ui8:1 c:<*>(0xf84003e260)} %#v: (*main.circular){ui8:(uint8)1 c:(*main.circular)} %#+v: (*main.circular)(0xf84003e260){ui8:(uint8)1 c:(*main.circular)(0xf84003e260)} See the Printf example for details on the setup of variables being shown here. Errors Since it is possible for custom Stringer/error interfaces to panic, spew detects them and handles them internally by printing the panic information inline with the output. Since spew is intended to provide deep pretty printing capabilities on structures, it intentionally does not return any errors. */ package spew stripe-mock-0.196.0/vendor/github.com/davecgh/go-spew/spew/dump.go000066400000000000000000000326311506013555700247300ustar00rootroot00000000000000/* * Copyright (c) 2013 Dave Collins * * Permission to use, copy, modify, and distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ package spew import ( "bytes" "encoding/hex" "fmt" "io" "os" "reflect" "regexp" "strconv" "strings" ) var ( // uint8Type is a reflect.Type representing a uint8. It is used to // convert cgo types to uint8 slices for hexdumping. uint8Type = reflect.TypeOf(uint8(0)) // cCharRE is a regular expression that matches a cgo char. // It is used to detect character arrays to hexdump them. cCharRE = regexp.MustCompile("^.*\\._Ctype_char$") // cUnsignedCharRE is a regular expression that matches a cgo unsigned // char. It is used to detect unsigned character arrays to hexdump // them. cUnsignedCharRE = regexp.MustCompile("^.*\\._Ctype_unsignedchar$") // cUint8tCharRE is a regular expression that matches a cgo uint8_t. // It is used to detect uint8_t arrays to hexdump them. cUint8tCharRE = regexp.MustCompile("^.*\\._Ctype_uint8_t$") ) // dumpState contains information about the state of a dump operation. type dumpState struct { w io.Writer depth int pointers map[uintptr]int ignoreNextType bool ignoreNextIndent bool cs *ConfigState } // indent performs indentation according to the depth level and cs.Indent // option. func (d *dumpState) indent() { if d.ignoreNextIndent { d.ignoreNextIndent = false return } d.w.Write(bytes.Repeat([]byte(d.cs.Indent), d.depth)) } // unpackValue returns values inside of non-nil interfaces when possible. // This is useful for data types like structs, arrays, slices, and maps which // can contain varying types packed inside an interface. func (d *dumpState) unpackValue(v reflect.Value) reflect.Value { if v.Kind() == reflect.Interface && !v.IsNil() { v = v.Elem() } return v } // dumpPtr handles formatting of pointers by indirecting them as necessary. func (d *dumpState) dumpPtr(v reflect.Value) { // Remove pointers at or below the current depth from map used to detect // circular refs. for k, depth := range d.pointers { if depth >= d.depth { delete(d.pointers, k) } } // Keep list of all dereferenced pointers to show later. pointerChain := make([]uintptr, 0) // Figure out how many levels of indirection there are by dereferencing // pointers and unpacking interfaces down the chain while detecting circular // references. nilFound := false cycleFound := false indirects := 0 ve := v for ve.Kind() == reflect.Ptr { if ve.IsNil() { nilFound = true break } indirects++ addr := ve.Pointer() pointerChain = append(pointerChain, addr) if pd, ok := d.pointers[addr]; ok && pd < d.depth { cycleFound = true indirects-- break } d.pointers[addr] = d.depth ve = ve.Elem() if ve.Kind() == reflect.Interface { if ve.IsNil() { nilFound = true break } ve = ve.Elem() } } // Display type information. d.w.Write(openParenBytes) d.w.Write(bytes.Repeat(asteriskBytes, indirects)) d.w.Write([]byte(ve.Type().String())) d.w.Write(closeParenBytes) // Display pointer information. if len(pointerChain) > 0 { d.w.Write(openParenBytes) for i, addr := range pointerChain { if i > 0 { d.w.Write(pointerChainBytes) } printHexPtr(d.w, addr) } d.w.Write(closeParenBytes) } // Display dereferenced value. d.w.Write(openParenBytes) switch { case nilFound == true: d.w.Write(nilAngleBytes) case cycleFound == true: d.w.Write(circularBytes) default: d.ignoreNextType = true d.dump(ve) } d.w.Write(closeParenBytes) } // dumpSlice handles formatting of arrays and slices. Byte (uint8 under // reflection) arrays and slices are dumped in hexdump -C fashion. func (d *dumpState) dumpSlice(v reflect.Value) { // Determine whether this type should be hex dumped or not. Also, // for types which should be hexdumped, try to use the underlying data // first, then fall back to trying to convert them to a uint8 slice. var buf []uint8 doConvert := false doHexDump := false numEntries := v.Len() if numEntries > 0 { vt := v.Index(0).Type() vts := vt.String() switch { // C types that need to be converted. case cCharRE.MatchString(vts): fallthrough case cUnsignedCharRE.MatchString(vts): fallthrough case cUint8tCharRE.MatchString(vts): doConvert = true // Try to use existing uint8 slices and fall back to converting // and copying if that fails. case vt.Kind() == reflect.Uint8: // We need an addressable interface to convert the type // to a byte slice. However, the reflect package won't // give us an interface on certain things like // unexported struct fields in order to enforce // visibility rules. We use unsafe, when available, to // bypass these restrictions since this package does not // mutate the values. vs := v if !vs.CanInterface() || !vs.CanAddr() { vs = unsafeReflectValue(vs) } if !UnsafeDisabled { vs = vs.Slice(0, numEntries) // Use the existing uint8 slice if it can be // type asserted. iface := vs.Interface() if slice, ok := iface.([]uint8); ok { buf = slice doHexDump = true break } } // The underlying data needs to be converted if it can't // be type asserted to a uint8 slice. doConvert = true } // Copy and convert the underlying type if needed. if doConvert && vt.ConvertibleTo(uint8Type) { // Convert and copy each element into a uint8 byte // slice. buf = make([]uint8, numEntries) for i := 0; i < numEntries; i++ { vv := v.Index(i) buf[i] = uint8(vv.Convert(uint8Type).Uint()) } doHexDump = true } } // Hexdump the entire slice as needed. if doHexDump { indent := strings.Repeat(d.cs.Indent, d.depth) str := indent + hex.Dump(buf) str = strings.Replace(str, "\n", "\n"+indent, -1) str = strings.TrimRight(str, d.cs.Indent) d.w.Write([]byte(str)) return } // Recursively call dump for each item. for i := 0; i < numEntries; i++ { d.dump(d.unpackValue(v.Index(i))) if i < (numEntries - 1) { d.w.Write(commaNewlineBytes) } else { d.w.Write(newlineBytes) } } } // dump is the main workhorse for dumping a value. It uses the passed reflect // value to figure out what kind of object we are dealing with and formats it // appropriately. It is a recursive function, however circular data structures // are detected and handled properly. func (d *dumpState) dump(v reflect.Value) { // Handle invalid reflect values immediately. kind := v.Kind() if kind == reflect.Invalid { d.w.Write(invalidAngleBytes) return } // Handle pointers specially. if kind == reflect.Ptr { d.indent() d.dumpPtr(v) return } // Print type information unless already handled elsewhere. if !d.ignoreNextType { d.indent() d.w.Write(openParenBytes) d.w.Write([]byte(v.Type().String())) d.w.Write(closeParenBytes) d.w.Write(spaceBytes) } d.ignoreNextType = false // Display length and capacity if the built-in len and cap functions // work with the value's kind and the len/cap itself is non-zero. valueLen, valueCap := 0, 0 switch v.Kind() { case reflect.Array, reflect.Slice, reflect.Chan: valueLen, valueCap = v.Len(), v.Cap() case reflect.Map, reflect.String: valueLen = v.Len() } if valueLen != 0 || valueCap != 0 { d.w.Write(openParenBytes) if valueLen != 0 { d.w.Write(lenEqualsBytes) printInt(d.w, int64(valueLen), 10) } if valueCap != 0 { if valueLen != 0 { d.w.Write(spaceBytes) } d.w.Write(capEqualsBytes) printInt(d.w, int64(valueCap), 10) } d.w.Write(closeParenBytes) d.w.Write(spaceBytes) } // Call Stringer/error interfaces if they exist and the handle methods flag // is enabled if !d.cs.DisableMethods { if (kind != reflect.Invalid) && (kind != reflect.Interface) { if handled := handleMethods(d.cs, d.w, v); handled { return } } } switch kind { case reflect.Invalid: // Do nothing. We should never get here since invalid has already // been handled above. case reflect.Bool: printBool(d.w, v.Bool()) case reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64, reflect.Int: printInt(d.w, v.Int(), 10) case reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64, reflect.Uint: printUint(d.w, v.Uint(), 10) case reflect.Float32: printFloat(d.w, v.Float(), 32) case reflect.Float64: printFloat(d.w, v.Float(), 64) case reflect.Complex64: printComplex(d.w, v.Complex(), 32) case reflect.Complex128: printComplex(d.w, v.Complex(), 64) case reflect.Slice: if v.IsNil() { d.w.Write(nilAngleBytes) break } fallthrough case reflect.Array: d.w.Write(openBraceNewlineBytes) d.depth++ if (d.cs.MaxDepth != 0) && (d.depth > d.cs.MaxDepth) { d.indent() d.w.Write(maxNewlineBytes) } else { d.dumpSlice(v) } d.depth-- d.indent() d.w.Write(closeBraceBytes) case reflect.String: d.w.Write([]byte(strconv.Quote(v.String()))) case reflect.Interface: // The only time we should get here is for nil interfaces due to // unpackValue calls. if v.IsNil() { d.w.Write(nilAngleBytes) } case reflect.Ptr: // Do nothing. We should never get here since pointers have already // been handled above. case reflect.Map: // nil maps should be indicated as different than empty maps if v.IsNil() { d.w.Write(nilAngleBytes) break } d.w.Write(openBraceNewlineBytes) d.depth++ if (d.cs.MaxDepth != 0) && (d.depth > d.cs.MaxDepth) { d.indent() d.w.Write(maxNewlineBytes) } else { numEntries := v.Len() keys := v.MapKeys() if d.cs.SortKeys { sortValues(keys, d.cs) } for i, key := range keys { d.dump(d.unpackValue(key)) d.w.Write(colonSpaceBytes) d.ignoreNextIndent = true d.dump(d.unpackValue(v.MapIndex(key))) if i < (numEntries - 1) { d.w.Write(commaNewlineBytes) } else { d.w.Write(newlineBytes) } } } d.depth-- d.indent() d.w.Write(closeBraceBytes) case reflect.Struct: d.w.Write(openBraceNewlineBytes) d.depth++ if (d.cs.MaxDepth != 0) && (d.depth > d.cs.MaxDepth) { d.indent() d.w.Write(maxNewlineBytes) } else { vt := v.Type() numFields := v.NumField() for i := 0; i < numFields; i++ { d.indent() vtf := vt.Field(i) d.w.Write([]byte(vtf.Name)) d.w.Write(colonSpaceBytes) d.ignoreNextIndent = true d.dump(d.unpackValue(v.Field(i))) if i < (numFields - 1) { d.w.Write(commaNewlineBytes) } else { d.w.Write(newlineBytes) } } } d.depth-- d.indent() d.w.Write(closeBraceBytes) case reflect.Uintptr: printHexPtr(d.w, uintptr(v.Uint())) case reflect.UnsafePointer, reflect.Chan, reflect.Func: printHexPtr(d.w, v.Pointer()) // There were not any other types at the time this code was written, but // fall back to letting the default fmt package handle it in case any new // types are added. default: if v.CanInterface() { fmt.Fprintf(d.w, "%v", v.Interface()) } else { fmt.Fprintf(d.w, "%v", v.String()) } } } // fdump is a helper function to consolidate the logic from the various public // methods which take varying writers and config states. func fdump(cs *ConfigState, w io.Writer, a ...interface{}) { for _, arg := range a { if arg == nil { w.Write(interfaceBytes) w.Write(spaceBytes) w.Write(nilAngleBytes) w.Write(newlineBytes) continue } d := dumpState{w: w, cs: cs} d.pointers = make(map[uintptr]int) d.dump(reflect.ValueOf(arg)) d.w.Write(newlineBytes) } } // Fdump formats and displays the passed arguments to io.Writer w. It formats // exactly the same as Dump. func Fdump(w io.Writer, a ...interface{}) { fdump(&Config, w, a...) } // Sdump returns a string with the passed arguments formatted exactly the same // as Dump. func Sdump(a ...interface{}) string { var buf bytes.Buffer fdump(&Config, &buf, a...) return buf.String() } /* Dump displays the passed parameters to standard out with newlines, customizable indentation, and additional debug information such as complete types and all pointer addresses used to indirect to the final value. It provides the following features over the built-in printing facilities provided by the fmt package: * Pointers are dereferenced and followed * Circular data structures are detected and handled properly * Custom Stringer/error interfaces are optionally invoked, including on unexported types * Custom types which only implement the Stringer/error interfaces via a pointer receiver are optionally invoked when passing non-pointer variables * Byte arrays and slices are dumped like the hexdump -C command which includes offsets, byte values in hex, and ASCII output The configuration options are controlled by an exported package global, spew.Config. See ConfigState for options documentation. See Fdump if you would prefer dumping to an arbitrary io.Writer or Sdump to get the formatted result as a string. */ func Dump(a ...interface{}) { fdump(&Config, os.Stdout, a...) } stripe-mock-0.196.0/vendor/github.com/davecgh/go-spew/spew/format.go000066400000000000000000000260751506013555700252600ustar00rootroot00000000000000/* * Copyright (c) 2013 Dave Collins * * Permission to use, copy, modify, and distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ package spew import ( "bytes" "fmt" "reflect" "strconv" "strings" ) // supportedFlags is a list of all the character flags supported by fmt package. const supportedFlags = "0-+# " // formatState implements the fmt.Formatter interface and contains information // about the state of a formatting operation. The NewFormatter function can // be used to get a new Formatter which can be used directly as arguments // in standard fmt package printing calls. type formatState struct { value interface{} fs fmt.State depth int pointers map[uintptr]int ignoreNextType bool cs *ConfigState } // buildDefaultFormat recreates the original format string without precision // and width information to pass in to fmt.Sprintf in the case of an // unrecognized type. Unless new types are added to the language, this // function won't ever be called. func (f *formatState) buildDefaultFormat() (format string) { buf := bytes.NewBuffer(percentBytes) for _, flag := range supportedFlags { if f.fs.Flag(int(flag)) { buf.WriteRune(flag) } } buf.WriteRune('v') format = buf.String() return format } // constructOrigFormat recreates the original format string including precision // and width information to pass along to the standard fmt package. This allows // automatic deferral of all format strings this package doesn't support. func (f *formatState) constructOrigFormat(verb rune) (format string) { buf := bytes.NewBuffer(percentBytes) for _, flag := range supportedFlags { if f.fs.Flag(int(flag)) { buf.WriteRune(flag) } } if width, ok := f.fs.Width(); ok { buf.WriteString(strconv.Itoa(width)) } if precision, ok := f.fs.Precision(); ok { buf.Write(precisionBytes) buf.WriteString(strconv.Itoa(precision)) } buf.WriteRune(verb) format = buf.String() return format } // unpackValue returns values inside of non-nil interfaces when possible and // ensures that types for values which have been unpacked from an interface // are displayed when the show types flag is also set. // This is useful for data types like structs, arrays, slices, and maps which // can contain varying types packed inside an interface. func (f *formatState) unpackValue(v reflect.Value) reflect.Value { if v.Kind() == reflect.Interface { f.ignoreNextType = false if !v.IsNil() { v = v.Elem() } } return v } // formatPtr handles formatting of pointers by indirecting them as necessary. func (f *formatState) formatPtr(v reflect.Value) { // Display nil if top level pointer is nil. showTypes := f.fs.Flag('#') if v.IsNil() && (!showTypes || f.ignoreNextType) { f.fs.Write(nilAngleBytes) return } // Remove pointers at or below the current depth from map used to detect // circular refs. for k, depth := range f.pointers { if depth >= f.depth { delete(f.pointers, k) } } // Keep list of all dereferenced pointers to possibly show later. pointerChain := make([]uintptr, 0) // Figure out how many levels of indirection there are by derferencing // pointers and unpacking interfaces down the chain while detecting circular // references. nilFound := false cycleFound := false indirects := 0 ve := v for ve.Kind() == reflect.Ptr { if ve.IsNil() { nilFound = true break } indirects++ addr := ve.Pointer() pointerChain = append(pointerChain, addr) if pd, ok := f.pointers[addr]; ok && pd < f.depth { cycleFound = true indirects-- break } f.pointers[addr] = f.depth ve = ve.Elem() if ve.Kind() == reflect.Interface { if ve.IsNil() { nilFound = true break } ve = ve.Elem() } } // Display type or indirection level depending on flags. if showTypes && !f.ignoreNextType { f.fs.Write(openParenBytes) f.fs.Write(bytes.Repeat(asteriskBytes, indirects)) f.fs.Write([]byte(ve.Type().String())) f.fs.Write(closeParenBytes) } else { if nilFound || cycleFound { indirects += strings.Count(ve.Type().String(), "*") } f.fs.Write(openAngleBytes) f.fs.Write([]byte(strings.Repeat("*", indirects))) f.fs.Write(closeAngleBytes) } // Display pointer information depending on flags. if f.fs.Flag('+') && (len(pointerChain) > 0) { f.fs.Write(openParenBytes) for i, addr := range pointerChain { if i > 0 { f.fs.Write(pointerChainBytes) } printHexPtr(f.fs, addr) } f.fs.Write(closeParenBytes) } // Display dereferenced value. switch { case nilFound == true: f.fs.Write(nilAngleBytes) case cycleFound == true: f.fs.Write(circularShortBytes) default: f.ignoreNextType = true f.format(ve) } } // format is the main workhorse for providing the Formatter interface. It // uses the passed reflect value to figure out what kind of object we are // dealing with and formats it appropriately. It is a recursive function, // however circular data structures are detected and handled properly. func (f *formatState) format(v reflect.Value) { // Handle invalid reflect values immediately. kind := v.Kind() if kind == reflect.Invalid { f.fs.Write(invalidAngleBytes) return } // Handle pointers specially. if kind == reflect.Ptr { f.formatPtr(v) return } // Print type information unless already handled elsewhere. if !f.ignoreNextType && f.fs.Flag('#') { f.fs.Write(openParenBytes) f.fs.Write([]byte(v.Type().String())) f.fs.Write(closeParenBytes) } f.ignoreNextType = false // Call Stringer/error interfaces if they exist and the handle methods // flag is enabled. if !f.cs.DisableMethods { if (kind != reflect.Invalid) && (kind != reflect.Interface) { if handled := handleMethods(f.cs, f.fs, v); handled { return } } } switch kind { case reflect.Invalid: // Do nothing. We should never get here since invalid has already // been handled above. case reflect.Bool: printBool(f.fs, v.Bool()) case reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64, reflect.Int: printInt(f.fs, v.Int(), 10) case reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64, reflect.Uint: printUint(f.fs, v.Uint(), 10) case reflect.Float32: printFloat(f.fs, v.Float(), 32) case reflect.Float64: printFloat(f.fs, v.Float(), 64) case reflect.Complex64: printComplex(f.fs, v.Complex(), 32) case reflect.Complex128: printComplex(f.fs, v.Complex(), 64) case reflect.Slice: if v.IsNil() { f.fs.Write(nilAngleBytes) break } fallthrough case reflect.Array: f.fs.Write(openBracketBytes) f.depth++ if (f.cs.MaxDepth != 0) && (f.depth > f.cs.MaxDepth) { f.fs.Write(maxShortBytes) } else { numEntries := v.Len() for i := 0; i < numEntries; i++ { if i > 0 { f.fs.Write(spaceBytes) } f.ignoreNextType = true f.format(f.unpackValue(v.Index(i))) } } f.depth-- f.fs.Write(closeBracketBytes) case reflect.String: f.fs.Write([]byte(v.String())) case reflect.Interface: // The only time we should get here is for nil interfaces due to // unpackValue calls. if v.IsNil() { f.fs.Write(nilAngleBytes) } case reflect.Ptr: // Do nothing. We should never get here since pointers have already // been handled above. case reflect.Map: // nil maps should be indicated as different than empty maps if v.IsNil() { f.fs.Write(nilAngleBytes) break } f.fs.Write(openMapBytes) f.depth++ if (f.cs.MaxDepth != 0) && (f.depth > f.cs.MaxDepth) { f.fs.Write(maxShortBytes) } else { keys := v.MapKeys() if f.cs.SortKeys { sortValues(keys, f.cs) } for i, key := range keys { if i > 0 { f.fs.Write(spaceBytes) } f.ignoreNextType = true f.format(f.unpackValue(key)) f.fs.Write(colonBytes) f.ignoreNextType = true f.format(f.unpackValue(v.MapIndex(key))) } } f.depth-- f.fs.Write(closeMapBytes) case reflect.Struct: numFields := v.NumField() f.fs.Write(openBraceBytes) f.depth++ if (f.cs.MaxDepth != 0) && (f.depth > f.cs.MaxDepth) { f.fs.Write(maxShortBytes) } else { vt := v.Type() for i := 0; i < numFields; i++ { if i > 0 { f.fs.Write(spaceBytes) } vtf := vt.Field(i) if f.fs.Flag('+') || f.fs.Flag('#') { f.fs.Write([]byte(vtf.Name)) f.fs.Write(colonBytes) } f.format(f.unpackValue(v.Field(i))) } } f.depth-- f.fs.Write(closeBraceBytes) case reflect.Uintptr: printHexPtr(f.fs, uintptr(v.Uint())) case reflect.UnsafePointer, reflect.Chan, reflect.Func: printHexPtr(f.fs, v.Pointer()) // There were not any other types at the time this code was written, but // fall back to letting the default fmt package handle it if any get added. default: format := f.buildDefaultFormat() if v.CanInterface() { fmt.Fprintf(f.fs, format, v.Interface()) } else { fmt.Fprintf(f.fs, format, v.String()) } } } // Format satisfies the fmt.Formatter interface. See NewFormatter for usage // details. func (f *formatState) Format(fs fmt.State, verb rune) { f.fs = fs // Use standard formatting for verbs that are not v. if verb != 'v' { format := f.constructOrigFormat(verb) fmt.Fprintf(fs, format, f.value) return } if f.value == nil { if fs.Flag('#') { fs.Write(interfaceBytes) } fs.Write(nilAngleBytes) return } f.format(reflect.ValueOf(f.value)) } // newFormatter is a helper function to consolidate the logic from the various // public methods which take varying config states. func newFormatter(cs *ConfigState, v interface{}) fmt.Formatter { fs := &formatState{value: v, cs: cs} fs.pointers = make(map[uintptr]int) return fs } /* NewFormatter returns a custom formatter that satisfies the fmt.Formatter interface. As a result, it integrates cleanly with standard fmt package printing functions. The formatter is useful for inline printing of smaller data types similar to the standard %v format specifier. The custom formatter only responds to the %v (most compact), %+v (adds pointer addresses), %#v (adds types), or %#+v (adds types and pointer addresses) verb combinations. Any other verbs such as %x and %q will be sent to the the standard fmt package for formatting. In addition, the custom formatter ignores the width and precision arguments (however they will still work on the format specifiers not handled by the custom formatter). Typically this function shouldn't be called directly. It is much easier to make use of the custom formatter by calling one of the convenience functions such as Printf, Println, or Fprintf. */ func NewFormatter(v interface{}) fmt.Formatter { return newFormatter(&Config, v) } stripe-mock-0.196.0/vendor/github.com/davecgh/go-spew/spew/spew.go000066400000000000000000000135141506013555700247400ustar00rootroot00000000000000/* * Copyright (c) 2013 Dave Collins * * Permission to use, copy, modify, and distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ package spew import ( "fmt" "io" ) // Errorf is a wrapper for fmt.Errorf that treats each argument as if it were // passed with a default Formatter interface returned by NewFormatter. It // returns the formatted string as a value that satisfies error. See // NewFormatter for formatting details. // // This function is shorthand for the following syntax: // // fmt.Errorf(format, spew.NewFormatter(a), spew.NewFormatter(b)) func Errorf(format string, a ...interface{}) (err error) { return fmt.Errorf(format, convertArgs(a)...) } // Fprint is a wrapper for fmt.Fprint that treats each argument as if it were // passed with a default Formatter interface returned by NewFormatter. It // returns the number of bytes written and any write error encountered. See // NewFormatter for formatting details. // // This function is shorthand for the following syntax: // // fmt.Fprint(w, spew.NewFormatter(a), spew.NewFormatter(b)) func Fprint(w io.Writer, a ...interface{}) (n int, err error) { return fmt.Fprint(w, convertArgs(a)...) } // Fprintf is a wrapper for fmt.Fprintf that treats each argument as if it were // passed with a default Formatter interface returned by NewFormatter. It // returns the number of bytes written and any write error encountered. See // NewFormatter for formatting details. // // This function is shorthand for the following syntax: // // fmt.Fprintf(w, format, spew.NewFormatter(a), spew.NewFormatter(b)) func Fprintf(w io.Writer, format string, a ...interface{}) (n int, err error) { return fmt.Fprintf(w, format, convertArgs(a)...) } // Fprintln is a wrapper for fmt.Fprintln that treats each argument as if it // passed with a default Formatter interface returned by NewFormatter. See // NewFormatter for formatting details. // // This function is shorthand for the following syntax: // // fmt.Fprintln(w, spew.NewFormatter(a), spew.NewFormatter(b)) func Fprintln(w io.Writer, a ...interface{}) (n int, err error) { return fmt.Fprintln(w, convertArgs(a)...) } // Print is a wrapper for fmt.Print that treats each argument as if it were // passed with a default Formatter interface returned by NewFormatter. It // returns the number of bytes written and any write error encountered. See // NewFormatter for formatting details. // // This function is shorthand for the following syntax: // // fmt.Print(spew.NewFormatter(a), spew.NewFormatter(b)) func Print(a ...interface{}) (n int, err error) { return fmt.Print(convertArgs(a)...) } // Printf is a wrapper for fmt.Printf that treats each argument as if it were // passed with a default Formatter interface returned by NewFormatter. It // returns the number of bytes written and any write error encountered. See // NewFormatter for formatting details. // // This function is shorthand for the following syntax: // // fmt.Printf(format, spew.NewFormatter(a), spew.NewFormatter(b)) func Printf(format string, a ...interface{}) (n int, err error) { return fmt.Printf(format, convertArgs(a)...) } // Println is a wrapper for fmt.Println that treats each argument as if it were // passed with a default Formatter interface returned by NewFormatter. It // returns the number of bytes written and any write error encountered. See // NewFormatter for formatting details. // // This function is shorthand for the following syntax: // // fmt.Println(spew.NewFormatter(a), spew.NewFormatter(b)) func Println(a ...interface{}) (n int, err error) { return fmt.Println(convertArgs(a)...) } // Sprint is a wrapper for fmt.Sprint that treats each argument as if it were // passed with a default Formatter interface returned by NewFormatter. It // returns the resulting string. See NewFormatter for formatting details. // // This function is shorthand for the following syntax: // // fmt.Sprint(spew.NewFormatter(a), spew.NewFormatter(b)) func Sprint(a ...interface{}) string { return fmt.Sprint(convertArgs(a)...) } // Sprintf is a wrapper for fmt.Sprintf that treats each argument as if it were // passed with a default Formatter interface returned by NewFormatter. It // returns the resulting string. See NewFormatter for formatting details. // // This function is shorthand for the following syntax: // // fmt.Sprintf(format, spew.NewFormatter(a), spew.NewFormatter(b)) func Sprintf(format string, a ...interface{}) string { return fmt.Sprintf(format, convertArgs(a)...) } // Sprintln is a wrapper for fmt.Sprintln that treats each argument as if it // were passed with a default Formatter interface returned by NewFormatter. It // returns the resulting string. See NewFormatter for formatting details. // // This function is shorthand for the following syntax: // // fmt.Sprintln(spew.NewFormatter(a), spew.NewFormatter(b)) func Sprintln(a ...interface{}) string { return fmt.Sprintln(convertArgs(a)...) } // convertArgs accepts a slice of arguments and returns a slice of the same // length with each argument converted to a default spew Formatter interface. func convertArgs(args []interface{}) (formatters []interface{}) { formatters = make([]interface{}, len(args)) for index, arg := range args { formatters[index] = NewFormatter(arg) } return formatters } stripe-mock-0.196.0/vendor/github.com/lestrrat-go/000077500000000000000000000000001506013555700217325ustar00rootroot00000000000000stripe-mock-0.196.0/vendor/github.com/lestrrat-go/jspointer/000077500000000000000000000000001506013555700237475ustar00rootroot00000000000000stripe-mock-0.196.0/vendor/github.com/lestrrat-go/jspointer/.gitignore000066400000000000000000000004121506013555700257340ustar00rootroot00000000000000# Compiled Object files, Static and Dynamic libs (Shared Objects) *.o *.a *.so # Folders _obj _test # Architecture specific extensions/prefixes *.[568vq] [568vq].out *.cgo1.go *.cgo2.c _cgo_defun.c _cgo_gotypes.go _cgo_export.* _testmain.go *.exe *.test *.prof stripe-mock-0.196.0/vendor/github.com/lestrrat-go/jspointer/.travis.yml000066400000000000000000000000621506013555700260560ustar00rootroot00000000000000language: go sudo: false go: - 1.11 - tip stripe-mock-0.196.0/vendor/github.com/lestrrat-go/jspointer/LICENSE000066400000000000000000000020631506013555700247550ustar00rootroot00000000000000The MIT License (MIT) Copyright (c) 2016 lestrrat Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. stripe-mock-0.196.0/vendor/github.com/lestrrat-go/jspointer/README.md000066400000000000000000000022171506013555700252300ustar00rootroot00000000000000# go-jspointer [![Build Status](https://travis-ci.org/lestrrat-go/jspointer.svg?branch=master)](https://travis-ci.org/lestrrat-go/jspointer) [![GoDoc](https://godoc.org/github.com/lestrrat-go/jspointer?status.svg)](https://godoc.org/github.com/lestrrat-go/jspointer) JSON pointer for Go # Features * Compile and match against Maps, Slices, Structs (or pointers to those) * Set values in each of those # Usage ```go p, _ := jspointer.New(`/foo/bar/baz`) result, _ := p.Get(someStruct) ``` # Credits This is almost a fork of https://github.com/xeipuuv/gojsonpointer. # References | Name | Notes | |:--------------------------------------------------------:|:---------------------------------| | [go-jsval](https://github.com/lestrrat-go/jsval) | Validator generator | | [go-jsschema](https://github.com/lestrrat-go/jsschema) | JSON Schema implementation | | [go-jshschema](https://github.com/lestrrat-go/jshschema) | JSON Hyper Schema implementation | | [go-jsref](https://github.com/lestrrat-go/jsref) | JSON Reference implementation | stripe-mock-0.196.0/vendor/github.com/lestrrat-go/jspointer/interface.go000066400000000000000000000010511506013555700262330ustar00rootroot00000000000000package jspointer import "errors" // Errors used in jspointer package var ( ErrInvalidPointer = errors.New("invalid pointer") ErrCanNotSet = errors.New("field cannot be set to") ErrSliceIndexOutOfBounds = errors.New("slice index out of bounds") ) // Consntants used in jspointer package. Mostly for internal usage only const ( EncodedTilde = "~0" EncodedSlash = "~1" Separator = '/' ) type ErrNotFound struct { Ptr string } // JSPointer represents a JSON pointer type JSPointer struct { raw string tokens tokens } stripe-mock-0.196.0/vendor/github.com/lestrrat-go/jspointer/jspointer.go000066400000000000000000000115171506013555700263200ustar00rootroot00000000000000package jspointer import ( "bytes" "encoding/json" "errors" "reflect" "strconv" "github.com/lestrrat-go/structinfo" ) type tokens struct { s string positions [][2]int } func (t *tokens) size() int { return len(t.positions) } func (t *tokens) get(i int) string { p := t.positions[i] return t.s[p[0]:p[1]] } // New creates a new JSON pointer for given path spec. If the path fails // to be parsed, an error is returned func New(path string) (*JSPointer, error) { var p JSPointer if err := p.parse(path); err != nil { return nil, err } p.raw = path return &p, nil } func (p *JSPointer) parse(s string) error { if s == "" { return nil } if s[0] != Separator { return ErrInvalidPointer } if len(s) < 2 { return ErrInvalidPointer } ntokens := 0 for i := 0; i < len(s); i++ { if s[i] == '/' { ntokens++ } } positions := make([][2]int, 0, ntokens) start := 1 var buf bytes.Buffer buf.WriteByte(s[0]) for i := 1; i < len(s); i++ { switch s[i] { case Separator: buf.WriteByte(s[i]) positions = append(positions, [2]int{start, buf.Len() - 1}) start = i + 1 case '~': if len(s) == 1 { buf.WriteByte(s[i]) } else { switch s[1] { case '0': buf.WriteByte('~') case '1': buf.WriteByte('/') default: buf.WriteByte(s[i]) } } default: buf.WriteByte(s[i]) } } if start < buf.Len() { positions = append(positions, [2]int{start, buf.Len()}) } p.tokens.s = buf.String() p.tokens.positions = positions return nil } // String returns the stringified version of this JSON pointer func (p JSPointer) String() string { return p.raw } // Get applies the JSON pointer to the given item, and returns // the result. func (p JSPointer) Get(item interface{}) (interface{}, error) { var ctx matchCtx ctx.raw = p.raw ctx.tokens = &p.tokens ctx.apply(item) return ctx.result, ctx.err } // Set applies the JSON pointer to the given item, and sets the // value accordingly. func (p JSPointer) Set(item interface{}, value interface{}) error { var ctx matchCtx ctx.set = true ctx.raw = p.raw ctx.tokens = &p.tokens ctx.setvalue = value ctx.apply(item) return ctx.err } type matchCtx struct { err error raw string result interface{} set bool setvalue interface{} tokens *tokens } func (e ErrNotFound) Error() string { return "match to JSON pointer not found: " + e.Ptr } type JSONGetter interface { JSONGet(tok string) (interface{}, error) } var strType = reflect.TypeOf("") var zeroval reflect.Value func (c *matchCtx) apply(item interface{}) { if c.tokens.size() == 0 { c.result = item return } node := item lastidx := c.tokens.size() - 1 for i := 0; i < c.tokens.size(); i++ { token := c.tokens.get(i) if getter, ok := node.(JSONGetter); ok { x, err := getter.JSONGet(token) if err != nil { c.err = ErrNotFound{Ptr: c.raw} return } if i == lastidx { c.result = x return } node = x continue } v := reflect.ValueOf(node) // Does this thing implement a JSONGet? if v.Kind() == reflect.Ptr { v = v.Elem() } switch v.Kind() { case reflect.Struct: fn := structinfo.StructFieldFromJSONName(v, token) if fn == "" { c.err = ErrNotFound{Ptr: c.raw} return } f := v.FieldByName(fn) if i == lastidx { if c.set { if !f.CanSet() { c.err = ErrCanNotSet return } f.Set(reflect.ValueOf(c.setvalue)) return } c.result = f.Interface() return } node = f.Interface() case reflect.Map: var vt reflect.Value // We shall try to inflate the token to its Go native // type if it's not a string. In other words, try not to // outdo yourselves. if t := v.Type().Key(); t != strType { vt = reflect.New(t).Elem() if err := json.Unmarshal([]byte(token), vt.Addr().Interface()); err != nil { name := t.PkgPath() + "." + t.Name() if name == "" { name = "(anonymous type)" } c.err = errors.New("unsupported conversion of string to " + name) return } } else { vt = reflect.ValueOf(token) } n := v.MapIndex(vt) if zeroval == n { c.err = ErrNotFound{Ptr: c.raw} return } if i == lastidx { if c.set { v.SetMapIndex(vt, reflect.ValueOf(c.setvalue)) } else { c.result = n.Interface() } return } node = n.Interface() case reflect.Slice: m := node.([]interface{}) wantidx, err := strconv.Atoi(token) if err != nil { c.err = err return } if wantidx < 0 || len(m) <= wantidx { c.err = ErrSliceIndexOutOfBounds return } if i == lastidx { if c.set { m[wantidx] = c.setvalue } else { c.result = m[wantidx] } return } node = m[wantidx] default: c.err = ErrNotFound{Ptr: c.raw} return } } // If you fell through here, there was a big problem c.err = ErrNotFound{Ptr: c.raw} } stripe-mock-0.196.0/vendor/github.com/lestrrat-go/jsref/000077500000000000000000000000001506013555700230435ustar00rootroot00000000000000stripe-mock-0.196.0/vendor/github.com/lestrrat-go/jsref/.gitignore000066400000000000000000000004121506013555700250300ustar00rootroot00000000000000# Compiled Object files, Static and Dynamic libs (Shared Objects) *.o *.a *.so # Folders _obj _test # Architecture specific extensions/prefixes *.[568vq] [568vq].out *.cgo1.go *.cgo2.c _cgo_defun.c _cgo_gotypes.go _cgo_export.* _testmain.go *.exe *.test *.prof stripe-mock-0.196.0/vendor/github.com/lestrrat-go/jsref/.travis.yml000066400000000000000000000000641506013555700251540ustar00rootroot00000000000000language: go sudo: false go: - 1.11.x - tip stripe-mock-0.196.0/vendor/github.com/lestrrat-go/jsref/LICENSE000066400000000000000000000020631506013555700240510ustar00rootroot00000000000000The MIT License (MIT) Copyright (c) 2016 lestrrat Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. stripe-mock-0.196.0/vendor/github.com/lestrrat-go/jsref/README.md000066400000000000000000000056261506013555700243330ustar00rootroot00000000000000# go-jsref [![Build Status](https://travis-ci.org/lestrrat-go/jsref.svg?branch=master)](https://travis-ci.org/lestrrat-go/jsref) [![GoDoc](https://godoc.org/github.com/lestrrat-go/jsref?status.svg)](https://godoc.org/github.com/lestrrat-go/jsref) JSON Reference Implementation for Go # SYNOPSIS ```go package jsref_test import ( "encoding/json" "fmt" "log" jsref "github.com/lestrrat-go/jsref" "github.com/lestrrat-go/jsref/provider" ) func Example() { var v interface{} src := []byte(` { "foo": ["bar", {"$ref": "#/sub"}, {"$ref": "obj2#/sub"}], "sub": "baz" }`) if err := json.Unmarshal(src, &v); err != nil { log.Printf("%s", err) return } // External reference mp := provider.NewMap() mp.Set("obj2", map[string]string{"sub": "quux"}) res := jsref.New() res.AddProvider(mp) // Register the provider data := []struct { Ptr string Options []jsref.Option }{ { Ptr: "#/foo/0", // "bar" }, { Ptr: "#/foo/1", // "baz" }, { Ptr: "#/foo/2", // "quux" (resolves via `mp`) }, { Ptr: "#/foo", // ["bar",{"$ref":"#/sub"},{"$ref":"obj2#/sub"}] }, { Ptr: "#/foo", // ["bar","baz","quux"] // experimental option to resolve all resulting values Options: []jsref.Option{ jsref.WithRecursiveResolution(true) }, }, } for _, set := range data { result, err := res.Resolve(v, set.Ptr, set.Options...) if err != nil { // failed to resolve fmt.Printf("err: %s\n", err) continue } b, _ := json.Marshal(result) fmt.Printf("%s -> %s\n", set.Ptr, string(b)) } // OUTPUT: // #/foo/0 -> "bar" // #/foo/1 -> "baz" // #/foo/2 -> "quux" // #/foo -> ["bar",{"$ref":"#/sub"},{"$ref":"obj2#/sub"}] // #/foo -> ["bar","baz","quux"] } ``` # Providers The Resolver object by default does not know how to resolve *any* reference: You must provide it one or more `Provider`s to look for and resolve external references. Currently available `Provider`s are: | Name | Description | |:--------------|:------------| | provider.FS | Resolve from local file system. References must start with a `file:///` prefix | | provider.Map | Resolve from in memory map. | | provider.HTTP | Resolve by making HTTP requests. References must start with a `http(s?)://` prefix | # References | Name | Notes | |:--------------------------------------------------------:|:---------------------------------| | [go-jsval](https://github.com/lestrrat-go/jsval) | Validator generator | | [go-jshschema](https://github.com/lestrrat-go/jshschema) | JSON Hyper Schema implementation | | [go-jsschema](https://github.com/lestrrat-go/jsschema) | JSON Schema implementation | | [go-jspointer](https://github.com/lestrrat-go/jspointer) | JSON Pointer implementations | # Acknowledgements * Boris Burtin stripe-mock-0.196.0/vendor/github.com/lestrrat-go/jsref/interface.go000066400000000000000000000006401506013555700253320ustar00rootroot00000000000000package jsref import ( "errors" "net/url" "reflect" ) var zeroval = reflect.Value{} var ErrMaxRecursion = errors.New("reached max number of recursions") // Resolver is responsible for interpreting the provided JSON // reference. type Resolver struct { providers []Provider MaxRecursions int } // Provider resolves a URL into a ... thing. type Provider interface { Get(*url.URL) (interface{}, error) } stripe-mock-0.196.0/vendor/github.com/lestrrat-go/jsref/jsref.go000066400000000000000000000234751506013555700245160ustar00rootroot00000000000000package jsref import ( "net/url" "reflect" "github.com/lestrrat-go/jspointer" "github.com/lestrrat-go/pdebug" "github.com/lestrrat-go/structinfo" "github.com/pkg/errors" ) const ref = "$ref" var refrv = reflect.ValueOf(ref) type Option interface { Name() string Value() interface{} } type option struct { name string value interface{} } func (o option) Name() string { return o.name } func (o option) Value() interface{} { return o.value } // WithRecursiveResolution allows ou to enable recursive resolution // on the *result* data structure. This means that after resolving // the JSON reference in the structure at hand, it does another // pass at resolving the entire data structure. Depending on your // structure and size, this may incur significant cost. // // Please note that recursive resolution of the result is still // experimental. If you find problems, please submit a pull request // with a failing test case. func WithRecursiveResolution(b bool) Option { return &option{ name: "recursiveResolution", value: b, } } var DefaultMaxRecursions = 10 // New creates a new Resolver func New() *Resolver { return &Resolver{MaxRecursions: DefaultMaxRecursions} } // AddProvider adds a new Provider to be searched for in case // a JSON pointer with more than just the URI fragment is given. func (r *Resolver) AddProvider(p Provider) error { r.providers = append(r.providers, p) return nil } type resolveCtx struct { rlevel int // recurse level maxrlevel int // max recurse level object interface{} // the main object that was passed to `Resolve()` } // Resolve takes a target `v`, and a JSON pointer `spec`. // spec is expected to be in the form of // // [scheme://[userinfo@]host/path[?query]]#fragment // [scheme:opaque[?query]]#fragment // // where everything except for `#fragment` is optional. // If the fragment is empty, an error is returned. // // If `spec` is the empty string, `v` is returned // This method handles recursive JSON references. // // If `WithRecursiveResolution` option is given and its value is true, // an attempt to resolve all references within the resulting object // is made by traversing the structure recursively. Default is false func (r *Resolver) Resolve(v interface{}, ptr string, options ...Option) (ret interface{}, err error) { if pdebug.Enabled { g := pdebug.Marker("Resolver.Resolve(%s)", ptr).BindError(&err) defer g.End() } var recursiveResolution bool for _, opt := range options { switch opt.Name() { case "recursiveResolution": recursiveResolution = opt.Value().(bool) } } ctx := resolveCtx{ rlevel: 0, maxrlevel: r.MaxRecursions, object: v, } // First, expand the target as much as we can v, err = expandRefRecursive(&ctx, r, v) if err != nil { return nil, errors.Wrap(err, "recursive search failed") } result, err := evalptr(&ctx, r, v, ptr) if err != nil { return nil, err } if recursiveResolution { rv, err := traverseExpandRefRecursive(&ctx, r, reflect.ValueOf(result)) if err != nil { return nil, errors.Wrap(err, `failed to resolve result`) } result = rv.Interface() } return result, nil } func setPtrOrInterface(container, value reflect.Value) bool { switch container.Kind() { case reflect.Ptr: if !value.CanAddr() { return false } container.Set(value.Addr()) case reflect.Interface: container.Set(value) default: return false } return true } func traverseExpandRefRecursive(ctx *resolveCtx, r *Resolver, rv reflect.Value) (reflect.Value, error) { if pdebug.Enabled { g := pdebug.Marker("traverseExpandRefRecursive") defer g.End() } switch rv.Kind() { case reflect.Ptr, reflect.Interface: rv = rv.Elem() } switch rv.Kind() { case reflect.Array, reflect.Slice: for i := 0; i < rv.Len(); i++ { elem := rv.Index(i) var elemcontainer reflect.Value switch elem.Kind() { case reflect.Ptr, reflect.Interface: elemcontainer = elem elem = elem.Elem() } // Need to check for elem being Valid, otherwise the // subsequent call to Interface() will fail if !elem.IsValid() { continue } if elemcontainer.IsValid() { if !elemcontainer.CanSet() { continue } } newv, err := expandRefRecursive(ctx, r, elem.Interface()) if err != nil { return zeroval, errors.Wrap(err, `failed to expand array/slice element`) } newrv, err := traverseExpandRefRecursive(ctx, r, reflect.ValueOf(newv)) if err != nil { return zeroval, errors.Wrap(err, `failed to recurse into array/slice element`) } if elemcontainer.IsValid() { setPtrOrInterface(elemcontainer, newrv) } else { elem.Set(newrv) } } case reflect.Map: // No refs found in the map keys, but there could be more // in the values if _, err := findRef(rv.Interface()); err != nil { for _, key := range rv.MapKeys() { value, err := traverseExpandRefRecursive(ctx, r, rv.MapIndex(key)) if err != nil { return zeroval, errors.Wrap(err, `failed to traverse map value`) } rv.SetMapIndex(key, value) } return rv, nil } newv, err := expandRefRecursive(ctx, r, rv.Interface()) if err != nil { return zeroval, errors.Wrap(err, `failed to expand map element`) } return traverseExpandRefRecursive(ctx, r, reflect.ValueOf(newv)) case reflect.Struct: // No refs found in the map keys, but there could be more // in the values if _, err := findRef(rv.Interface()); err != nil { for i := 0; i < rv.NumField(); i++ { field := rv.Field(i) value, err := traverseExpandRefRecursive(ctx, r, field) if err != nil { return zeroval, errors.Wrap(err, `failed to traverse struct field value`) } field.Set(value) } return rv, nil } newv, err := expandRefRecursive(ctx, r, rv.Interface()) if err != nil { return zeroval, errors.Wrap(err, `failed to expand struct element`) } return traverseExpandRefRecursive(ctx, r, reflect.ValueOf(newv)) } return rv, nil } // expands $ref with in v, until all $refs are expanded. // note: DOES NOT recurse down into structures func expandRefRecursive(ctx *resolveCtx, r *Resolver, v interface{}) (ret interface{}, err error) { if pdebug.Enabled { g := pdebug.Marker("expandRefRecursive") defer g.End() } for { ref, err := findRef(v) if err != nil { if pdebug.Enabled { pdebug.Printf("No refs found. bailing out of loop") } break } if pdebug.Enabled { pdebug.Printf("Found ref '%s'", ref) } newv, err := expandRef(ctx, r, v, ref) if err != nil { if pdebug.Enabled { pdebug.Printf("Failed to expand ref '%s': %s", ref, err) } return nil, errors.Wrap(err, "failed to expand ref") } v = newv } return v, nil } func expandRef(ctx *resolveCtx, r *Resolver, v interface{}, ref string) (ret interface{}, err error) { ctx.rlevel++ if ctx.rlevel > ctx.maxrlevel { return nil, ErrMaxRecursion } defer func() { ctx.rlevel-- }() u, err := url.Parse(ref) if err != nil { return nil, errors.Wrap(err, "failed to parse ref as URL") } ptr := "#" + u.Fragment if u.Host == "" && u.Path == "" { if pdebug.Enabled { pdebug.Printf("ptr doesn't contain any host/path part, apply json pointer directly to object") } return evalptr(ctx, r, ctx.object, ptr) } u.Fragment = "" for _, p := range r.providers { pv, err := p.Get(u) if err == nil { if pdebug.Enabled { pdebug.Printf("Found object matching %s", u) } return evalptr(ctx, r, pv, ptr) } } return nil, errors.New("element pointed by $ref '" + ref + "' not found") } func findRef(v interface{}) (ref string, err error) { if pdebug.Enabled { g := pdebug.Marker("findRef").BindError(&err) defer g.End() } rv := reflect.ValueOf(v) switch rv.Kind() { case reflect.Interface, reflect.Ptr: rv = rv.Elem() } if pdebug.Enabled { pdebug.Printf("object is a '%s'", rv.Kind()) } // Find if we have a "$ref" element var refv reflect.Value switch rv.Kind() { case reflect.Map: refv = rv.MapIndex(refrv) case reflect.Struct: if fn := structinfo.StructFieldFromJSONName(rv, ref); fn != "" { refv = rv.FieldByName(fn) } default: return "", errors.New("element is not a map-like container") } if !refv.IsValid() { return "", errors.New("$ref element not found") } switch refv.Kind() { case reflect.Interface, reflect.Ptr: refv = refv.Elem() } switch refv.Kind() { case reflect.String: // Empty string isn't a valid pointer if refv.Len() <= 0 { return "", errors.New("$ref element not found (empty)") } if pdebug.Enabled { pdebug.Printf("Found ref '%s'", refv) } return refv.String(), nil case reflect.Invalid: return "", errors.New("$ref element not found") default: if pdebug.Enabled { pdebug.Printf("'$ref' was found, but its kind is %s", refv.Kind()) } } return "", errors.New("$ref element must be a string") } func evalptr(ctx *resolveCtx, r *Resolver, v interface{}, ptrspec string) (ret interface{}, err error) { if pdebug.Enabled { g := pdebug.Marker("evalptr(%s)", ptrspec).BindError(&err) defer g.End() } // If the reference is empty, return v if ptrspec == "" || ptrspec == "#" { if pdebug.Enabled { pdebug.Printf("Empty pointer, return v itself") } return v, nil } // Parse the spec. u, err := url.Parse(ptrspec) if err != nil { return nil, errors.Wrap(err, "failed to parse reference spec") } ptr := u.Fragment // We are evaluating the pointer part. That means if the // Fragment portion is not set, there's no point in evaluating if ptr == "" { return nil, errors.Wrap(err, "empty json pointer") } p, err := jspointer.New(ptr) if err != nil { return nil, errors.Wrap(err, "failed create a new JSON pointer") } x, err := p.Get(v) if err != nil { return nil, errors.Wrap(err, "failed to fetch value") } if pdebug.Enabled { pdebug.Printf("Evaulated JSON pointer, now checking if we can expand further") } // If this result contains more refs, expand that return expandRefRecursive(ctx, r, x) } stripe-mock-0.196.0/vendor/github.com/lestrrat-go/jsref/provider/000077500000000000000000000000001506013555700246755ustar00rootroot00000000000000stripe-mock-0.196.0/vendor/github.com/lestrrat-go/jsref/provider/fs.go000066400000000000000000000032441506013555700256370ustar00rootroot00000000000000package provider import ( "encoding/json" "net/url" "os" "path/filepath" "strings" "github.com/lestrrat-go/pdebug" "github.com/pkg/errors" ) // NewFS creates a new Provider that looks for JSON documents // from the local file system. Documents are only searched // within `root` func NewFS(root string) *FS { return &FS{ mp: NewMap(), Root: root, } } // Get fetches the document specified by the `key` argument. // Everything other than `.Path` is ignored. // Note that once a document is read, it WILL be cached for the // duration of this object, unless you call `Reset` func (fp *FS) Get(key *url.URL) (out interface{}, err error) { if pdebug.Enabled { g := pdebug.Marker("provider.FS.Get(%s)", key.String()).BindError(&err) defer g.End() } if strings.ToLower(key.Scheme) != "file" { return nil, errors.New("unsupported scheme '" + key.Scheme + "'") } // Everything other than "Path" is ignored path := filepath.Clean(filepath.Join(fp.Root, key.Path)) mpkey := &url.URL{Path: path} if x, err := fp.mp.Get(mpkey); err == nil { return x, nil } fi, err := os.Stat(path) if err != nil { return nil, errors.Wrap(err, "failed to stat local resource") } if fi.IsDir() { return nil, errors.New("target is not a file") } f, err := os.Open(path) if err != nil { return nil, errors.Wrap(err, "failed to open local resource") } defer f.Close() var x interface{} dec := json.NewDecoder(f) if err := dec.Decode(&x); err != nil { return nil, errors.Wrap(err, "failed to parse JSON local resource") } fp.mp.Set(path, x) return x, nil } // Reset resets the in memory cache of JSON documents func (fp *FS) Reset() error { return fp.mp.Reset() } stripe-mock-0.196.0/vendor/github.com/lestrrat-go/jsref/provider/http.go000066400000000000000000000025321506013555700262050ustar00rootroot00000000000000package provider import ( "encoding/json" "net/http" "net/url" "strings" "time" "github.com/lestrrat-go/pdebug" "github.com/pkg/errors" ) // NewFS creates a new Provider that looks for JSON documents // from the internet over HTTP(s) func NewHTTP() *HTTP { return &HTTP{ mp: NewMap(), Client: &http.Client{ Timeout: 5 * time.Second, }, } } // Get fetches the document specified by the `key` argument, making // a HTTP request if necessary. // Note that once a document is read, it WILL be cached for the // duration of this object, unless you call `Reset` func (hp *HTTP) Get(key *url.URL) (interface{}, error) { if pdebug.Enabled { g := pdebug.Marker("HTTP.Get(%s)", key) defer g.End() } switch strings.ToLower(key.Scheme) { case "http", "https": default: return nil, errors.New("key is not http/https URL") } v, err := hp.mp.Get(key) if err == nil { // Found! return v, nil } res, err := hp.Client.Get(key.String()) if err != nil { return nil, errors.Wrap(err, "failed to fetch HTTP resource") } defer res.Body.Close() dec := json.NewDecoder(res.Body) var x interface{} if err := dec.Decode(&x); err != nil { return nil, errors.Wrap(err, "failed to parse JSON from HTTP resource") } return x, nil } // Reset resets the in memory cache of JSON documents func (hp *HTTP) Reset() error { return hp.mp.Reset() } stripe-mock-0.196.0/vendor/github.com/lestrrat-go/jsref/provider/interface.go000066400000000000000000000003361506013555700271660ustar00rootroot00000000000000package provider import ( "net/http" "sync" ) type FS struct { mp *Map Root string } type HTTP struct { mp *Map Client *http.Client } type Map struct { lock sync.Mutex mapping map[string]interface{} } stripe-mock-0.196.0/vendor/github.com/lestrrat-go/jsref/provider/map.go000066400000000000000000000013561506013555700260060ustar00rootroot00000000000000package provider import ( "net/url" "github.com/lestrrat-go/pdebug" "github.com/pkg/errors" ) func NewMap() *Map { return &Map{ mapping: make(map[string]interface{}), } } func (mp *Map) Set(key string, v interface{}) error { mp.lock.Lock() defer mp.lock.Unlock() mp.mapping[key] = v return nil } func (mp *Map) Get(key *url.URL) (res interface{}, err error) { if pdebug.Enabled { g := pdebug.Marker("Map.Get(%s)", key).BindError(&err) defer g.End() } mp.lock.Lock() defer mp.lock.Unlock() v, ok := mp.mapping[key.String()] if !ok { return nil, errors.New("not found") } return v, nil } func (mp *Map) Reset() error { mp.lock.Lock() defer mp.lock.Unlock() mp.mapping = make(map[string]interface{}) return nil } stripe-mock-0.196.0/vendor/github.com/lestrrat-go/jsschema/000077500000000000000000000000001506013555700235275ustar00rootroot00000000000000stripe-mock-0.196.0/vendor/github.com/lestrrat-go/jsschema/.gitignore000066400000000000000000000004121506013555700255140ustar00rootroot00000000000000# Compiled Object files, Static and Dynamic libs (Shared Objects) *.o *.a *.so # Folders _obj _test # Architecture specific extensions/prefixes *.[568vq] [568vq].out *.cgo1.go *.cgo2.c _cgo_defun.c _cgo_gotypes.go _cgo_export.* _testmain.go *.exe *.test *.prof stripe-mock-0.196.0/vendor/github.com/lestrrat-go/jsschema/.travis.yml000066400000000000000000000002741506013555700256430ustar00rootroot00000000000000language: go sudo: false go: - 1.11.x - tip script: - go test -v ./... after_success: - go get -t -v -tags benchmark ./... - go test -bench=. -benchmem -tags benchmark stripe-mock-0.196.0/vendor/github.com/lestrrat-go/jsschema/LICENSE000066400000000000000000000020631506013555700245350ustar00rootroot00000000000000The MIT License (MIT) Copyright (c) 2016 lestrrat Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. stripe-mock-0.196.0/vendor/github.com/lestrrat-go/jsschema/README.md000066400000000000000000000056741506013555700250220ustar00rootroot00000000000000# go-jsschema [![Build Status](https://travis-ci.org/lestrrat-go/jsschema.svg?branch=master)](https://travis-ci.org/lestrrat-go/jsschema) [![GoDoc](https://godoc.org/github.com/lestrrat-go/jsschema?status.svg)](https://godoc.org/github.com/lestrrat-go/jsschema) JSON Schema for Go # SYNOPSIS ```go package schema_test import ( "log" "github.com/lestrrat-go/jsschema" "github.com/lestrrat-go/jsschema/validator" ) func Example() { s, err := schema.ReadFile("schema.json") if err != nil { log.Printf("failed to read schema: %s", err) return } for name, pdef := range s.Properties { // Do what you will with `pdef`, which contain // Schema information for `name` property _ = name _ = pdef } // You can also validate an arbitrary piece of data var p interface{} // initialize using json.Unmarshal... v := validator.New(s) if err := v.Validate(p); err != nil { log.Printf("failed to validate data: %s", err) } } ``` # DESCRIPTION This packages parses a JSON Schema file, and allows you to inspect, modify the schema, but does nothing more. If you want to validate using the JSON Schema that you read using this package, look at [go-jsval](https://github.com/lestrrat-go/jsval), which allows you to generate validators, so that you don't have to dynamically read in the JSON schema for each instance of your program. In the same lines, this package does not really care about loading external schemas from various locations (it's just easier to just gather all the schemas in your local system). It *is* possible to do this via [go-jsref](https://github.com/lestrrat-go/jsref) if you really want to do it. # BENCHMARKS Latest version of libraries as of Sep 3 2016. Benchmarks with [gojsonschema](https://github.com/xeipuuv/gojsonschema) are prefixed with `Gojsonschema`. Benchmarks without prefixes are about ths package. ``` $ go test -tags benchmark -benchmem -bench=. BenchmarkGojsonschemaParse-4 5000 357330 ns/op 167451 B/op 1866 allocs/op BenchmarkParse-4 1000000 1577 ns/op 1952 B/op 9 allocs/op BenchmarkParseAndMakeValidator-4 500000 2806 ns/op 2304 B/op 13 allocs/op PASS ``` # TODO * Properly resolve ids and $refs (it works in simple cases, but elaborate scopes probably don't work) # Contributors * Daisuke Maki * Nate Finch # References | Name | Notes | |:--------------------------------------------------------:|:---------------------------------| | [go-jsval](https://github.com/lestrrat-go/jsval) | Validator generator | | [go-jshschema](https://github.com/lestrrat-go/jshschema) | JSON Hyper Schema implementation | | [go-jsref](https://github.com/lestrrat-go/jsref) | JSON Reference implementation | | [go-jspointer](https://github.com/lestrrat-go/jspointer) | JSON Pointer implementations | stripe-mock-0.196.0/vendor/github.com/lestrrat-go/jsschema/default.go000066400000000000000000000175531506013555700255150ustar00rootroot00000000000000package schema import "strings" func buildJSSchema() { const src = `{ "id": "http://json-schema.org/draft-04/schema#", "$schema": "http://json-schema.org/draft-04/schema#", "description": "Core schema meta-schema", "definitions": { "schemaArray": { "type": "array", "minItems": 1, "items": { "$ref": "#" } }, "positiveInteger": { "type": "integer", "minimum": 0 }, "positiveIntegerDefault0": { "allOf": [ { "$ref": "#/definitions/positiveInteger" }, { "default": 0 } ] }, "simpleTypes": { "enum": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "stringArray": { "type": "array", "items": { "type": "string" }, "minItems": 1, "uniqueItems": true } }, "type": "object", "properties": { "id": { "type": "string", "format": "uri" }, "$schema": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "description": { "type": "string" }, "default": {}, "multipleOf": { "type": "number", "minimum": 0, "exclusiveMinimum": true }, "maximum": { "type": "number" }, "exclusiveMaximum": { "type": "boolean", "default": false }, "minimum": { "type": "number" }, "exclusiveMinimum": { "type": "boolean", "default": false }, "maxLength": { "$ref": "#/definitions/positiveInteger" }, "minLength": { "$ref": "#/definitions/positiveIntegerDefault0" }, "pattern": { "type": "string", "format": "regex" }, "additionalItems": { "anyOf": [ { "type": "boolean" }, { "$ref": "#" } ], "default": {} }, "items": { "anyOf": [ { "$ref": "#" }, { "$ref": "#/definitions/schemaArray" } ], "default": {} }, "maxItems": { "$ref": "#/definitions/positiveInteger" }, "minItems": { "$ref": "#/definitions/positiveIntegerDefault0" }, "uniqueItems": { "type": "boolean", "default": false }, "maxProperties": { "$ref": "#/definitions/positiveInteger" }, "minProperties": { "$ref": "#/definitions/positiveIntegerDefault0" }, "required": { "$ref": "#/definitions/stringArray" }, "additionalProperties": { "anyOf": [ { "type": "boolean" }, { "$ref": "#" } ], "default": {} }, "definitions": { "type": "object", "additionalProperties": { "$ref": "#" }, "default": {} }, "properties": { "type": "object", "additionalProperties": { "$ref": "#" }, "default": {} }, "patternProperties": { "type": "object", "additionalProperties": { "$ref": "#" }, "default": {} }, "dependencies": { "type": "object", "additionalProperties": { "anyOf": [ { "$ref": "#" }, { "$ref": "#/definitions/stringArray" } ] } }, "enum": { "type": "array", "minItems": 1, "uniqueItems": true }, "type": { "anyOf": [ { "$ref": "#/definitions/simpleTypes" }, { "type": "array", "items": { "$ref": "#/definitions/simpleTypes" }, "minItems": 1, "uniqueItems": true } ] }, "allOf": { "$ref": "#/definitions/schemaArray" }, "anyOf": { "$ref": "#/definitions/schemaArray" }, "oneOf": { "$ref": "#/definitions/schemaArray" }, "not": { "$ref": "#" } }, "dependencies": { "exclusiveMaximum": [ "maximum" ], "exclusiveMinimum": [ "minimum" ] }, "default": {} }` if err := _schema.Decode(strings.NewReader(src)); err != nil { // We regret to inform you that if we can't parse this // schema, then we have a real real real problem, so we're // going to panic panic("failed to parse main JSON Schema schema: " + err.Error()) } } func buildHyperSchema() { const src = `{ "$schema": "http://json-schema.org/draft-04/hyper-schema#", "id": "http://json-schema.org/draft-04/hyper-schema#", "title": "JSON Hyper-Schema", "allOf": [ { "$ref": "http://json-schema.org/draft-04/schema#" } ], "properties": { "additionalItems": { "anyOf": [ { "type": "boolean" }, { "$ref": "#" } ] }, "additionalProperties": { "anyOf": [ { "type": "boolean" }, { "$ref": "#" } ] }, "dependencies": { "additionalProperties": { "anyOf": [ { "$ref": "#" }, { "type": "array" } ] } }, "items": { "anyOf": [ { "$ref": "#" }, { "$ref": "#/definitions/schemaArray" } ] }, "definitions": { "additionalProperties": { "$ref": "#" } }, "patternProperties": { "additionalProperties": { "$ref": "#" } }, "properties": { "additionalProperties": { "$ref": "#" } }, "allOf": { "$ref": "#/definitions/schemaArray" }, "anyOf": { "$ref": "#/definitions/schemaArray" }, "oneOf": { "$ref": "#/definitions/schemaArray" }, "not": { "$ref": "#" }, "links": { "type": "array", "items": { "$ref": "#/definitions/linkDescription" } }, "fragmentResolution": { "type": "string" }, "media": { "type": "object", "properties": { "type": { "description": "A media type, as described in RFC 2046", "type": "string" }, "binaryEncoding": { "description": "A content encoding scheme, as described in RFC 2045", "type": "string" } } }, "pathStart": { "description": "Instances' URIs must start with this value for this schema to apply to them", "type": "string", "format": "uri" } }, "definitions": { "schemaArray": { "type": "array", "items": { "$ref": "#" } }, "linkDescription": { "title": "Link Description Object", "type": "object", "required": [ "href", "rel" ], "properties": { "href": { "description": "a URI template, as defined by RFC 6570, with the addition of the $, ( and ) characters for pre-processing", "type": "string" }, "rel": { "description": "relation to the target resource of the link", "type": "string" }, "title": { "description": "a title for the link", "type": "string" }, "targetSchema": { "description": "JSON Schema describing the link target", "$ref": "#" }, "mediaType": { "description": "media type (as defined by RFC 2046) describing the link target", "type": "string" }, "method": { "description": "method for requesting the target of the link (e.g. for HTTP this might be \"GET\" or \"DELETE\")", "type": "string" }, "encType": { "description": "The media type in which to submit data along with the request", "type": "string", "default": "application/json" }, "schema": { "description": "Schema describing the data to submit along with the request", "$ref": "#" } } } }, "links": [ { "rel": "self", "href": "{+id}" }, { "rel": "full", "href": "{+($ref)}" } ] }` if err := _hyperSchema.Decode(strings.NewReader(src)); err != nil { // We regret to inform you that if we can't parse this // schema, then we have a real real real problem, so we're // going to panic panic("failed to parse Hyper JSON Schema schema: " + err.Error()) } } stripe-mock-0.196.0/vendor/github.com/lestrrat-go/jsschema/errors.go000066400000000000000000000002501506013555700253670ustar00rootroot00000000000000package schema import "github.com/pkg/errors" func errInvalidType(s string, v interface{}) error { return errors.Errorf("invalid type: expected %s, got %T", s, v) } stripe-mock-0.196.0/vendor/github.com/lestrrat-go/jsschema/interface.go000066400000000000000000000117301506013555700260200ustar00rootroot00000000000000package schema import ( "errors" "regexp" "sync" "github.com/lestrrat-go/jsref" ) const ( // SchemaURL contains the JSON Schema URL SchemaURL = `http://json-schema.org/draft-04/schema` // HyperSchemaURL contains the JSON Hyper Schema URL HyperSchemaURL = `http://json-schema.org/draft-03/hyper-schema` // MIMEType contains the MIME used for a JSON Schema MIMEType = "application/schema+json" ) // ErrExpectedArrayOfString is returned when we encounter // something other than array of strings var ErrExpectedArrayOfString = errors.New("invalid value: expected array of string") // ErrInvalidStringArray is the same as ErrExpectedArrayOfString. // This is here only for backwards compatibility var ErrInvalidStringArray = ErrExpectedArrayOfString // PrimitiveType represents a JSON Schema primitive type such as // "string", "integer", etc. type PrimitiveType int // PrimitiveTypes is a list of PrimitiveType type PrimitiveTypes []PrimitiveType // Format represents one of the pre-defined JSON Schema formats type Format string // The list of pre-defined JSON Schema formats const ( FormatDateTime Format = "date-time" FormatEmail Format = "email" FormatHostname Format = "hostname" FormatIPv4 Format = "ipv4" FormatIPv6 Format = "ipv6" FormatURI Format = "uri" ) // Number represents a "number" value in a JSON Schema, such as // "minimum", "maximum", etc. type Number struct { Val float64 Initialized bool } // Integer represents a "integer" value in a JSON Schema, such as // "minLength", "maxLength", etc. type Integer struct { Val int Initialized bool } // Bool represents a "boolean" value in a JSON Schema, such as // "exclusiveMinimum", "exclusiveMaximum", etc. type Bool struct { Val bool Default bool Initialized bool } // The list of primitive types const ( UnspecifiedType PrimitiveType = iota NullType IntegerType StringType ObjectType ArrayType BooleanType NumberType ) // SchemaList is a list of Schemas type SchemaList []*Schema // Schema represents a JSON Schema object type Schema struct { parent *Schema resolveLock sync.Mutex resolvedSchemas map[string]interface{} resolver *jsref.Resolver ID string `json:"id,omitempty"` Title string `json:"title,omitempty"` Description string `json:"description,omitempty"` Default interface{} `json:"default,omitempty"` Type PrimitiveTypes `json:"type,omitempty"` SchemaRef string `json:"$schema,omitempty"` Definitions map[string]*Schema `json:"definitions,omitempty"` Reference string `json:"$ref,omitempty"` Format Format `json:"format,omitempty"` // NumericValidations MultipleOf Number `json:"multipleOf,omitempty"` Minimum Number `json:"minimum,omitempty"` Maximum Number `json:"maximum,omitempty"` ExclusiveMinimum Bool `json:"exclusiveMinimum,omitempty"` ExclusiveMaximum Bool `json:"exclusiveMaximum,omitempty"` // StringValidation MaxLength Integer `json:"maxLength,omitempty"` MinLength Integer `json:"minLength,omitempty"` Pattern *regexp.Regexp `json:"pattern,omitempty"` // ArrayValidations AdditionalItems *AdditionalItems Items *ItemSpec MinItems Integer MaxItems Integer UniqueItems Bool // ObjectValidations MaxProperties Integer `json:"maxProperties,omitempty"` MinProperties Integer `json:"minProperties,omitempty"` Required []string `json:"required,omitempty"` Dependencies DependencyMap `json:"dependencies,omitempty"` Properties map[string]*Schema `json:"properties,omitempty"` AdditionalProperties *AdditionalProperties `json:"additionalProperties,omitempty"` PatternProperties map[*regexp.Regexp]*Schema `json:"patternProperties,omitempty"` Enum []interface{} `json:"enum,omitempty"` AllOf SchemaList `json:"allOf,omitempty"` AnyOf SchemaList `json:"anyOf,omitempty"` OneOf SchemaList `json:"oneOf,omitempty"` Not *Schema `json:"not,omitempty"` Extras map[string]interface{} `json:"-"` } // AdditionalItems represents schema for additonalItems type AdditionalItems struct { *Schema } // AdditionalProperties represents schema for additonalProperties type AdditionalProperties struct { *Schema } // DependencyMap contains the dependencies defined within this schema. // for a given dependency name, you can have either a schema or a // list of property names type DependencyMap struct { Names map[string][]string Schemas map[string]*Schema } // ItemSpec represents a specification for `item` field type ItemSpec struct { TupleMode bool // If this is true, the positions mean something. if false, len(Schemas) should be 1, and we should apply the same schema validation to all elements Schemas SchemaList } stripe-mock-0.196.0/vendor/github.com/lestrrat-go/jsschema/marshal.go000066400000000000000000000477741506013555700255300ustar00rootroot00000000000000package schema import ( "encoding/json" "regexp" "strconv" "github.com/lestrrat-go/pdebug" "github.com/pkg/errors" ) func extractNumber(n *Number, m map[string]interface{}, s string) error { v, ok := m[s] if !ok { return nil } val, ok := v.(float64) if !ok { return errors.Wrap(errInvalidType("float64", v), "failed to extract number") } n.Val = val n.Initialized = true return nil } func extractInt(n *Integer, m map[string]interface{}, s string) error { v, ok := m[s] if !ok { return nil } val, ok := v.(float64) if !ok { return errors.Wrap(errInvalidType("float64", v), "failed to extract int") } n.Val = int(val) n.Initialized = true return nil } func extractBool(b *Bool, m map[string]interface{}, s string, def bool) error { b.Default = def v, ok := m[s] if !ok { return nil } val, ok := v.(bool) if !ok { return errors.Wrap(errInvalidType("bool", v), "failed to extract bool") } b.Val = val b.Initialized = true return nil } func extractString(s *string, m map[string]interface{}, name string) error { v, ok := m[name] if !ok { return nil } val, ok := v.(string) if !ok { return errors.Wrap(errInvalidType("string", v), "failed to extract string") } *s = val return nil } func convertStringList(l *[]string, v interface{}) error { switch val := v.(type) { case string: // One element *l = []string{val} case []interface{}: // List of elements. *l = make([]string, len(val)) for i, x := range val { s, ok := x.(string) if !ok { return ErrExpectedArrayOfString } (*l)[i] = s } default: return ErrExpectedArrayOfString } return nil } func extractStringList(l *[]string, m map[string]interface{}, s string) error { v, ok := m[s] if !ok { return nil } return convertStringList(l, v) } func extractFormat(f *Format, m map[string]interface{}, s string) error { var v string if err := extractString(&v, m, s); err != nil { return err } *f = Format(v) return nil } func extractJSPointer(s *string, m map[string]interface{}, name string) error { return extractString(s, m, name) } func extractInterface(r *interface{}, m map[string]interface{}, s string) error { if v, ok := m[s]; ok { *r = v } return nil } func extractInterfaceList(l *[]interface{}, m map[string]interface{}, s string) error { v, ok := m[s] if !ok { return nil } val, ok := v.([]interface{}) if !ok { return errors.Wrap( errInvalidType("[]interface{}", v), "failed to extract interface list", ) } *l = make([]interface{}, len(val)) copy(*l, val) return nil } func extractRegexp(r **regexp.Regexp, m map[string]interface{}, s string) error { v, ok := m[s] if !ok { return nil } val, ok := v.(string) if !ok { return errors.Wrap( errInvalidType("string", v), "failed to extract regular expression", ) } rx, err := regexp.Compile(val) if err != nil { return errors.Wrap( errors.Wrapf( err, "failed to compile regular expression: %s", strconv.Quote(val), ), "failed to extract regular expression", ) } *r = rx return nil } func extractSchema(s **Schema, m map[string]interface{}, name string) error { v, ok := m[name] if !ok { return nil } if pdebug.Enabled { pdebug.Printf("Found property '%s'", name) } val, ok := v.(map[string]interface{}) if !ok { return errors.Wrap( errInvalidType("map[string]interface{}", v), "failed to extract schema", ) } return extractSingleSchema(s, val) } func extractSingleSchema(s **Schema, m map[string]interface{}) error { *s = New() if err := (*s).Extract(m); err != nil { return errors.Wrap(err, "failed to extract schema") } return nil } func (l *SchemaList) extractIfPresent(m map[string]interface{}, name string) error { v, ok := m[name] if !ok { return nil } if pdebug.Enabled { pdebug.Printf("Found property '%s'", name) } return l.Extract(v) } // Extract takes either a list of `map[string]interface{}` or // a single `map[string]interface{}` to initialize this list // of schemas func (l *SchemaList) Extract(v interface{}) error { switch val := v.(type) { case []interface{}: *l = make([]*Schema, len(val)) var s *Schema for i, d := range val { m, ok := d.(map[string]interface{}) if !ok { return errors.Wrap( errInvalidType("map[string]interface{}", d), "failed to extract schema list", ) } if err := extractSingleSchema(&s, m); err != nil { return errors.Wrap(err, "failed to extract schema list") } (*l)[i] = s } return nil case map[string]interface{}: var s *Schema if err := extractSingleSchema(&s, val); err != nil { return errors.Wrap(err, "failed to extract schema list") } *l = []*Schema{s} return nil default: return errors.Wrap( errInvalidType("[]*Schema or *Schema", v), "failed to extract schema list", ) } } func extractSchemaMapEntry(s *Schema, name string, m map[string]interface{}) error { if pdebug.Enabled { g := pdebug.Marker("Schema map entry '%s'", name) defer g.End() } return s.Extract(m) } func extractSchemaMap(m map[string]interface{}, name string) (map[string]*Schema, error) { v, ok := m[name] if !ok { return nil, nil } val, ok := v.(map[string]interface{}) if !ok { return nil, errors.Wrap( errInvalidType("map[string]interface{}", v), "failed to extract schema map", ) } r := make(map[string]*Schema) for k, data := range val { // data better be a map m, ok := data.(map[string]interface{}) if !ok { return nil, errors.Wrap( errInvalidType("map[string]interface{}", data), "failed to extract sub field", ) } s := New() if err := extractSchemaMapEntry(s, k, m); err != nil { return nil, err } r[k] = s if k == "domain" { if pdebug.Enabled { pdebug.Printf("after extractSchemaMapEntry: %#v", s.Extras) } } } return r, nil } func extractRegexpToSchemaMap(m map[string]interface{}, name string) (map[*regexp.Regexp]*Schema, error) { v, ok := m[name] if !ok { return nil, nil } val, ok := v.(map[string]interface{}) if !ok { return nil, errors.Wrap( errInvalidType("map[string]interface{}", v), "failed to extract regexp to schema map", ) } r := make(map[*regexp.Regexp]*Schema) for k, data := range val { // data better be a map m, ok := data.(map[string]interface{}) if !ok { return nil, errors.Wrap( errInvalidType("map[string]interface{}", data), "failed to extract regexp to schema map", ) } s := New() if err := s.Extract(m); err != nil { return nil, errors.Wrap(err, "failed to extract schema within schema map") } rx, err := regexp.Compile(k) if err != nil { return nil, errors.Wrap(err, "failed to compile regular expression for regexp to schema map") } r[rx] = s } return r, nil } func extractItems(res **ItemSpec, m map[string]interface{}, name string) error { v, ok := m[name] if !ok { return nil } if pdebug.Enabled { pdebug.Printf("Found array element '%s'", name) } tupleMode := false switch v.(type) { case []interface{}: tupleMode = true case map[string]interface{}: default: return errors.Wrap( errInvalidType("[]interface{} or map[string]interface{}", v), "failed to extract items", ) } items := ItemSpec{} items.TupleMode = tupleMode var err error if err = items.Schemas.extractIfPresent(m, name); err != nil { return errors.Wrap(err, "failed to schema for item") } *res = &items return nil } func extractDependecies(res *DependencyMap, m map[string]interface{}, name string) error { v, ok := m[name] if !ok { return nil } m, ok = v.(map[string]interface{}) if !ok { return errors.Wrap( errInvalidType("map[string]interface{}", v), "failed to extract dependencies", ) } if len(m) == 0 { return nil } return res.extract(m) } func extractType(pt *PrimitiveTypes, m map[string]interface{}, name string) error { v, ok := m[name] if !ok { return nil } switch val := v.(type) { case string: t, err := primitiveFromString(val) if err != nil { return errors.Wrap(err, "failed to parse primitive type") } *pt = PrimitiveTypes{t} return nil case []interface{}: *pt = make(PrimitiveTypes, len(val)) for i, ts := range val { s, ok := ts.(string) if !ok { return errors.Wrap( errInvalidType("string", ts), "failed to extract type", ) } t, err := primitiveFromString(s) if err != nil { return errors.Wrap(err, "failed to parse primitive type") } (*pt)[i] = t } return nil default: return errors.Wrap( errInvalidType("[]string or string", v), "failed to extract 'type'", ) } } func (dm *DependencyMap) extract(m map[string]interface{}) error { dm.Names = make(map[string][]string) dm.Schemas = make(map[string]*Schema) for k, p := range m { switch val := p.(type) { case []interface{}: // This list needs to be a list of strings var l []string if err := convertStringList(&l, val); err != nil { return err } dm.Names[k] = l case map[string]interface{}: s := New() if err := s.Extract(val); err != nil { return err } dm.Schemas[k] = s default: return errors.Wrap( errInvalidType("[]interface{} or map[string]interface{}", p), "failed to extract 'type'", ) } } return nil } // UnmarshalJSON takes a JSON string and initializes // the schema func (s *Schema) UnmarshalJSON(data []byte) error { m := map[string]interface{}{} if err := json.Unmarshal(data, &m); err != nil { return err } return s.Extract(m) } // Extract takes a `map[string]interface{}` and initializes // the schema func (s *Schema) Extract(m map[string]interface{}) error { if pdebug.Enabled { g := pdebug.IPrintf("START Schema.Extract") defer g.IRelease("END Schema.Extract") } var err error if err = extractString(&s.ID, m, "id"); err != nil { return errors.Wrapf(err, "failed to extract 'id'") } if err = extractString(&s.Title, m, "title"); err != nil { return errors.Wrap(err, "failed to extract 'title'") } if err = extractString(&s.Description, m, "description"); err != nil { return errors.Wrap(err, "failed to extract 'description'") } if err = extractStringList(&s.Required, m, "required"); err != nil { return errors.Wrap(err, "failed to extract 'required'") } if err = extractJSPointer(&s.SchemaRef, m, "$schema"); err != nil { return errors.Wrap(err, "failed to extract '$schema'") } if err = extractJSPointer(&s.Reference, m, "$ref"); err != nil { return errors.Wrap(err, "failed to extract '$ref'") } if err = extractFormat(&s.Format, m, "format"); err != nil { return errors.Wrap(err, "failed to extract 'format'") } if err = extractInterfaceList(&s.Enum, m, "enum"); err != nil { return errors.Wrap(err, "failed to extract 'enum'") } if err = extractInterface(&s.Default, m, "default"); err != nil { return errors.Wrap(err, "failed to extract 'default'") } if err = extractType(&s.Type, m, "type"); err != nil { return errors.Wrap(err, "failed to extract 'type'") } if s.Definitions, err = extractSchemaMap(m, "definitions"); err != nil { return errors.Wrap(err, "failed to extract 'definitions'") } if err = extractItems(&s.Items, m, "items"); err != nil { return errors.Wrap(err, "failed to extract 'items'") } if err = extractRegexp(&s.Pattern, m, "pattern"); err != nil { return errors.Wrap(err, "failed to extract 'patterns'") } if extractInt(&s.MinLength, m, "minLength"); err != nil { return errors.Wrap(err, "failed to extract 'minLength'") } if extractInt(&s.MaxLength, m, "maxLength"); err != nil { return errors.Wrap(err, "failed to extract 'maxLength'") } if extractInt(&s.MinItems, m, "minItems"); err != nil { return errors.Wrap(err, "failed to extract 'minItems'") } if extractInt(&s.MaxItems, m, "maxItems"); err != nil { return errors.Wrap(err, "failed to extract 'maxItems'") } if err = extractBool(&s.UniqueItems, m, "uniqueItems", false); err != nil { return errors.Wrap(err, "failed to extract 'uniqueItems'") } if err = extractInt(&s.MaxProperties, m, "maxProperties"); err != nil { return errors.Wrap(err, "failed to extract 'maxProperties'") } if err = extractInt(&s.MinProperties, m, "minProperties"); err != nil { return errors.Wrap(err, "failed to extract 'minProperties'") } if err = extractNumber(&s.Minimum, m, "minimum"); err != nil { return errors.Wrap(err, "failed to extract 'minimum'") } if err = extractBool(&s.ExclusiveMinimum, m, "exclusiveMinimum", false); err != nil { return errors.Wrap(err, "failed to extract 'exclusiveMinimum'") } if err = extractNumber(&s.Maximum, m, "maximum"); err != nil { return errors.Wrap(err, "failed to extract 'maximum'") } if err = extractBool(&s.ExclusiveMaximum, m, "exclusiveMaximum", false); err != nil { return errors.Wrap(err, "failed to extract 'exclusiveMaximum'") } if err = extractNumber(&s.MultipleOf, m, "multipleOf"); err != nil { return errors.Wrap(err, "failed to extract 'multipleOf'") } if s.Properties, err = extractSchemaMap(m, "properties"); err != nil { return errors.Wrap(err, "failed to extract 'properties'") } if err = extractDependecies(&s.Dependencies, m, "dependencies"); err != nil { return errors.Wrap(err, "failed to extract 'dependencies'") } if _, ok := m["additionalItems"]; !ok { // doesn't exist. it's an empty schema s.AdditionalItems = &AdditionalItems{} } else { var b Bool if err = extractBool(&b, m, "additionalItems", true); err == nil { if b.Bool() { s.AdditionalItems = &AdditionalItems{} } } else { // Oh, it's not a boolean? var apSchema *Schema if err = extractSchema(&apSchema, m, "additionalItems"); err != nil { return errors.Wrap(err, "failed to extract 'additionalItems'") } s.AdditionalItems = &AdditionalItems{apSchema} } } if _, ok := m["additionalProperties"]; !ok { // doesn't exist. it's an empty schema s.AdditionalProperties = &AdditionalProperties{} } else { var b Bool if err = extractBool(&b, m, "additionalProperties", true); err == nil { if b.Bool() { s.AdditionalProperties = &AdditionalProperties{} } } else { // Oh, it's not a boolean? var apSchema *Schema if err = extractSchema(&apSchema, m, "additionalProperties"); err != nil { return errors.Wrap(err, "failed to extract 'additionalProperties'") } s.AdditionalProperties = &AdditionalProperties{apSchema} } } if s.PatternProperties, err = extractRegexpToSchemaMap(m, "patternProperties"); err != nil { return errors.Wrap(err, "failed to extract 'patternProperties'") } if err = s.AllOf.extractIfPresent(m, "allOf"); err != nil { return errors.Wrap(err, "failed to extract 'allOf'") } if err = s.AnyOf.extractIfPresent(m, "anyOf"); err != nil { return errors.Wrap(err, "failed to extract 'anyOf'") } if err = s.OneOf.extractIfPresent(m, "oneOf"); err != nil { return errors.Wrap(err, "failed to extract 'oneOf'") } if err = extractSchema(&s.Not, m, "not"); err != nil { return errors.Wrap(err, "failed to extract 'not'") } s.applyParentSchema() s.Extras = make(map[string]interface{}) for k, v := range m { switch k { case "id", "title", "description", "required", "$schema", "$ref", "format", "enum", "default", "type", "definitions", "items", "pattern", "minLength", "maxLength", "minItems", "maxItems", "uniqueItems", "maxProperties", "minProperties", "minimum", "exclusiveMinimum", "maximum", "exclusiveMaximum", "multipleOf", "properties", "dependencies", "additionalItems", "additionalProperties", "patternProperties", "allOf", "anyOf", "oneOf", "not": continue } if pdebug.Enabled { pdebug.Printf("Extracting extra field '%s'", k) } s.Extras[k] = v } if pdebug.Enabled { pdebug.Printf("Successfully extracted schema") } return nil } func place(m map[string]interface{}, name string, v interface{}) { m[name] = v } func placeString(m map[string]interface{}, name, s string) { if s != "" { place(m, name, s) } } func placeList(m map[string]interface{}, name string, l []interface{}) { if len(l) > 0 { place(m, name, l) } } func placeSchemaList(m map[string]interface{}, name string, l []*Schema) { if len(l) > 0 { place(m, name, l) } } func placeSchemaMap(m map[string]interface{}, name string, l map[string]*Schema) { if len(l) > 0 { defs := make(map[string]*Schema) place(m, name, defs) for k, v := range l { defs[k] = v } } } func placeStringList(m map[string]interface{}, name string, l []string) { if len(l) > 0 { place(m, name, l) } } func placeBool(m map[string]interface{}, name string, value Bool) { place(m, name, value.Bool()) } func placeNumber(m map[string]interface{}, name string, n Number) { if !n.Initialized { return } place(m, name, n.Val) } func placeInteger(m map[string]interface{}, name string, n Integer) { if !n.Initialized { return } place(m, name, n.Val) } func canBeType(s *Schema, primType PrimitiveType) bool { if len(s.Type) == 0 { return true } for _, t := range s.Type { if t == primType { return true } } return false } // MarshalJSON serializes the schema into a JSON string func (s *Schema) MarshalJSON() ([]byte, error) { m := make(map[string]interface{}) placeString(m, "id", s.ID) placeString(m, "title", s.Title) placeString(m, "description", s.Description) placeString(m, "$schema", s.SchemaRef) placeString(m, "$ref", s.Reference) placeStringList(m, "required", s.Required) placeList(m, "enum", s.Enum) switch len(s.Type) { case 0: case 1: m["type"] = s.Type[0] default: m["type"] = s.Type } if items := s.AdditionalItems; items != nil { if items.Schema != nil { place(m, "additionalItems", items.Schema) } } else { // According to // https://spacetelescope.github.io/understanding-json-schema/reference/array.html#list-validation // additionalItems only makes sense if we are an array type, no // need to inject 'false' for things that are // object/int/float/etc. if canBeType(s, ArrayType) { place(m, "additionalItems", false) } } if rx := s.Pattern; rx != nil { placeString(m, "pattern", rx.String()) } placeInteger(m, "maxLength", s.MaxLength) placeInteger(m, "minLength", s.MinLength) placeInteger(m, "maxItems", s.MaxItems) placeInteger(m, "minItems", s.MinItems) placeInteger(m, "maxProperties", s.MaxProperties) placeInteger(m, "minProperties", s.MinProperties) if s.UniqueItems.Initialized { placeBool(m, "uniqueItems", s.UniqueItems) } placeSchemaMap(m, "definitions", s.Definitions) if items := s.Items; items != nil { if items.TupleMode { m["items"] = s.Items.Schemas } else { m["items"] = s.Items.Schemas[0] } } placeSchemaMap(m, "properties", s.Properties) if len(s.PatternProperties) > 0 { rxm := make(map[string]*Schema) for rx, rxs := range s.PatternProperties { rxm[rx.String()] = rxs } placeSchemaMap(m, "patternProperties", rxm) } placeSchemaList(m, "allOf", s.AllOf) placeSchemaList(m, "anyOf", s.AnyOf) placeSchemaList(m, "oneOf", s.OneOf) if s.Default != nil { m["default"] = s.Default } placeString(m, "format", string(s.Format)) placeNumber(m, "minimum", s.Minimum) if s.ExclusiveMinimum.Initialized { placeBool(m, "exclusiveMinimum", s.ExclusiveMinimum) } placeNumber(m, "maximum", s.Maximum) if s.ExclusiveMaximum.Initialized { placeBool(m, "exclusiveMaximum", s.ExclusiveMaximum) } if ap := s.AdditionalProperties; ap != nil { if ap.Schema != nil { place(m, "additionalProperties", ap.Schema) } } else { // Only set // additionalProperties: false // If we are an Object type. // https://spacetelescope.github.io/understanding-json-schema/reference/object.html#properties // additionalProperties only has meaning for Object types. if canBeType(s, ObjectType) { placeBool(m, "additionalProperties", Bool{Val: false, Initialized: true}) } } if s.MultipleOf.Val != 0 { placeNumber(m, "multipleOf", s.MultipleOf) } if v := s.Not; v != nil { place(m, "not", v) } deps := map[string]interface{}{} if v := s.Dependencies.Schemas; v != nil { for pname, depschema := range v { deps[pname] = depschema } } if v := s.Dependencies.Names; v != nil { for pname, deplist := range v { deps[pname] = deplist } } if len(deps) > 0 { place(m, "dependencies", deps) } if x := s.Extras; x != nil { for k, v := range x { m[k] = v } } return json.Marshal(m) } stripe-mock-0.196.0/vendor/github.com/lestrrat-go/jsschema/primitives.go000066400000000000000000000051441506013555700262550ustar00rootroot00000000000000package schema import ( "encoding/json" "errors" ) // UnmarshalJSON initializes the primitive type from // a JSON string. func (t *PrimitiveType) UnmarshalJSON(data []byte) error { var s string if err := json.Unmarshal(data, &s); err != nil { return err } x, err := primitiveFromString(string(data)) if err != nil { return err } *t = x return nil } func primitiveFromString(s string) (t PrimitiveType, err error) { switch s { case "null": t = NullType case "integer": t = IntegerType case "string": t = StringType case "object": t = ObjectType case "array": t = ArrayType case "boolean": t = BooleanType case "number": t = NumberType default: err = errors.New("unknown primitive type: " + s) } return } // String returns the string representation of this primitive type func (t PrimitiveType) String() string { var v string switch t { case NullType: v = "null" case IntegerType: v = "integer" case StringType: v = "string" case ObjectType: v = "object" case ArrayType: v = "array" case BooleanType: v = "boolean" case NumberType: v = "number" default: v = "" } return v } // MarshalJSON seriealises the primitive type into a JSON string func (t PrimitiveType) MarshalJSON() ([]byte, error) { switch t { case NullType, IntegerType, StringType, ObjectType, ArrayType, BooleanType, NumberType: return json.Marshal(t.String()) default: return nil, errors.New("unknown primitive type") } } // UnmarshalJSON initializes the list of primitive types func (pt *PrimitiveTypes) UnmarshalJSON(data []byte) error { if data[0] != '[' { var t PrimitiveType if err := json.Unmarshal(data, &t); err != nil { return err } *pt = PrimitiveTypes{t} return nil } var list []PrimitiveType if err := json.Unmarshal(data, &list); err != nil { return err } *pt = PrimitiveTypes(list) return nil } // Bool returns the underlying boolean value for the // primitive boolean type func (b Bool) Bool() bool { if b.Initialized { return b.Val } return b.Default } // Contains returns true if the list of primitive types // contains `p` func (pt PrimitiveTypes) Contains(p PrimitiveType) bool { for _, v := range pt { if p == v { return true } } return false } // Len returns the length of the list of primitive types func (pt PrimitiveTypes) Len() int { return len(pt) } // Less returns true if the i-th element in the list is // listed before the j-th element. func (pt PrimitiveTypes) Less(i, j int) bool { return pt[i] < pt[j] } // Swap swaps the elements in positions i and j func (pt PrimitiveTypes) Swap(i, j int) { pt[i], pt[j] = pt[j], pt[i] } stripe-mock-0.196.0/vendor/github.com/lestrrat-go/jsschema/schema.go000066400000000000000000000143261506013555700253240ustar00rootroot00000000000000package schema import ( "encoding/json" "io" "net/url" "os" "reflect" "strconv" "github.com/lestrrat-go/jsref" "github.com/lestrrat-go/jsref/provider" "github.com/lestrrat-go/pdebug" "github.com/pkg/errors" ) // This is used to check against result of reflect.MapIndex var zeroval = reflect.Value{} var _schema Schema var _hyperSchema Schema func init() { buildJSSchema() buildHyperSchema() } // New creates a new schema object func New() *Schema { s := Schema{} s.initialize() return &s } func (s *Schema) initialize() { resolver := jsref.New() mp := provider.NewMap() mp.Set(SchemaURL, &_schema) mp.Set(HyperSchemaURL, &_hyperSchema) resolver.AddProvider(mp) s.resolvedSchemas = make(map[string]interface{}) s.resolver = resolver } // ReadFile reads the file `f` and parses its content to create // a new Schema object func ReadFile(f string) (*Schema, error) { in, err := os.Open(f) if err != nil { return nil, err } defer in.Close() return Read(in) } // Read reads from `in` and parses its content to create // a new Schema object func Read(in io.Reader) (*Schema, error) { s := New() if err := s.Decode(in); err != nil { return nil, err } return s, nil } // Decode reads from `in` and parses its content to // initialize the schema object func (s *Schema) Decode(in io.Reader) error { dec := json.NewDecoder(in) if err := dec.Decode(s); err != nil { return err } s.applyParentSchema() return nil } func (s *Schema) setParent(v *Schema) { s.parent = v } func (s *Schema) applyParentSchema() { // Find all components that may be a Schema for _, v := range s.Definitions { v.setParent(s) v.applyParentSchema() } if props := s.AdditionalProperties; props != nil { if sc := props.Schema; sc != nil { sc.setParent(s) sc.applyParentSchema() } } if items := s.AdditionalItems; items != nil { if sc := items.Schema; sc != nil { sc.setParent(s) sc.applyParentSchema() } } if items := s.Items; items != nil { for _, v := range items.Schemas { v.setParent(s) v.applyParentSchema() } } for _, v := range s.Properties { v.setParent(s) v.applyParentSchema() } for _, v := range s.AllOf { v.setParent(s) v.applyParentSchema() } for _, v := range s.AnyOf { v.setParent(s) v.applyParentSchema() } for _, v := range s.OneOf { v.setParent(s) v.applyParentSchema() } if v := s.Not; v != nil { v.setParent(s) v.applyParentSchema() } } // BaseURL returns the base URL registered for this schema func (s *Schema) BaseURL() *url.URL { scope := s.Scope() u, err := url.Parse(scope) if err != nil { // XXX hmm, not sure what to do here u = &url.URL{} } return u } // Root returns the upmost parent schema object within the // hierarchy of schemas. For example, the `item` element // in a schema for an array is also a schema, and you could // reference elements in parent schemas. func (s *Schema) Root() *Schema { if s.parent == nil { if pdebug.Enabled { pdebug.Printf("Schema %p is root", s) } return s } return s.parent.Root() } func (s *Schema) findSchemaByID(id string) (*Schema, error) { if s.ID == id { return s, nil } // XXX Quite unimplemented return nil, errors.Errorf("schema %s not found", strconv.Quote(id)) } // ResolveURL takes a url string, and resolves it if it's // a relative URL func (s *Schema) ResolveURL(v string) (u *url.URL, err error) { if pdebug.Enabled { g := pdebug.IPrintf("START Schema.ResolveURL '%s'", v) defer func() { if err != nil { g.IRelease("END Schema.ResolveURL '%s': error %s", v, err) } else { g.IRelease("END Schema.ResolveURL '%s' -> '%s'", v, u) } }() } base := s.BaseURL() if pdebug.Enabled { pdebug.Printf("Using base URL '%s'", base) } u, err = base.Parse(v) if err != nil { return nil, err } return u, nil } // IsResolved returns true if this schema has no Reference. func (s *Schema) IsResolved() bool { return s.Reference == "" } // Resolve returns the schema after it has been resolved. // If s.Reference is the empty string, the current schema is returned. // // `ctx` is an optional context to resolve the reference with. If not // specified, the root schema as returned by `Root` will be used. func (s *Schema) Resolve(ctx interface{}) (ref *Schema, err error) { if s.Reference == "" { return s, nil } if pdebug.Enabled { g := pdebug.IPrintf("START Schema.Resolve (%s)", s.Reference) defer func() { if err != nil { g.IRelease("END Schema.Resolve (%s): %s", s.Reference, err) } else { g.IRelease("END Schema.Resolve (%s)", s.Reference) } }() } var thing interface{} var ok bool s.resolveLock.Lock() thing, ok = s.resolvedSchemas[s.Reference] s.resolveLock.Unlock() if ok { ref, ok = thing.(*Schema) if ok { if pdebug.Enabled { pdebug.Printf("Cache HIT on '%s'", s.Reference) } } else { if pdebug.Enabled { pdebug.Printf("Negative Cache HIT on '%s'", s.Reference) } return nil, thing.(error) } } else { if pdebug.Enabled { pdebug.Printf("Cache MISS on '%s'", s.Reference) } var err error if ctx == nil { ctx = s.Root() } thing, err := s.resolver.Resolve(ctx, s.Reference) if err != nil { err = errors.Wrapf(err, "failed to resolve reference %s", strconv.Quote(s.Reference)) s.resolveLock.Lock() s.resolvedSchemas[s.Reference] = err s.resolveLock.Unlock() return nil, err } ref, ok = thing.(*Schema) if !ok { err = errors.Wrapf(err, "resolved reference %s is not a schema", strconv.Quote(s.Reference)) s.resolveLock.Lock() s.resolvedSchemas[s.Reference] = err s.resolveLock.Unlock() return nil, err } s.resolveLock.Lock() s.resolvedSchemas[s.Reference] = ref s.resolveLock.Unlock() } return ref, nil } // IsPropRequired can be used to query this schema if a // given property name is required. func (s *Schema) IsPropRequired(pname string) bool { for _, name := range s.Required { if name == pname { return true } } return false } // Scope returns the scope ID for this schema func (s *Schema) Scope() string { if pdebug.Enabled { g := pdebug.IPrintf("START Schema.Scope") defer g.IRelease("END Schema.Scope") } if s.ID != "" || s.parent == nil { if pdebug.Enabled { pdebug.Printf("Returning id '%s'", s.ID) } return s.ID } return s.parent.Scope() } stripe-mock-0.196.0/vendor/github.com/lestrrat-go/jsval/000077500000000000000000000000001506013555700230515ustar00rootroot00000000000000stripe-mock-0.196.0/vendor/github.com/lestrrat-go/jsval/.gitignore000066400000000000000000000004121506013555700250360ustar00rootroot00000000000000# Compiled Object files, Static and Dynamic libs (Shared Objects) *.o *.a *.so # Folders _obj _test # Architecture specific extensions/prefixes *.[568vq] [568vq].out *.cgo1.go *.cgo2.c _cgo_defun.c _cgo_gotypes.go _cgo_export.* _testmain.go *.exe *.test *.prof stripe-mock-0.196.0/vendor/github.com/lestrrat-go/jsval/.travis.sh000066400000000000000000000002631506013555700247740ustar00rootroot00000000000000#!/bin/bash set -e DIFF=$(git diff) if [[ ! -z "$DIFF" ]]; then echo "git diff found modified source after code generation" echo "$DIFF" exit 1 fi go test -v ./... stripe-mock-0.196.0/vendor/github.com/lestrrat-go/jsval/.travis.yml000066400000000000000000000001431506013555700251600ustar00rootroot00000000000000language: go sudo: false go: - 1.11.x - tip before_script: go generate script: ./.travis.shstripe-mock-0.196.0/vendor/github.com/lestrrat-go/jsval/LICENSE000066400000000000000000000020631506013555700240570ustar00rootroot00000000000000The MIT License (MIT) Copyright (c) 2016 lestrrat Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. stripe-mock-0.196.0/vendor/github.com/lestrrat-go/jsval/README.md000066400000000000000000000105101506013555700243250ustar00rootroot00000000000000# go-jsval Validator toolset, with code generation from JSON Schema [![Build Status](https://travis-ci.org/lestrrat-go/jsval.svg?branch=master)](https://travis-ci.org/lestrrat-go/jsval) [![GoDoc](https://godoc.org/github.com/lestrrat-go/jsval?status.svg)](https://godoc.org/github.com/lestrrat-go/jsval) # Description The `go-jsval` package is a data validation toolset, with a tool to generate validators in Go from JSON schemas. # Synopsis Read a schema file and create a validator using `jsval` command: ```shell jsval -s /path/to/schema.json -o validator.go jsval -s /path/to/hyperschema.json -o validator.go -p "/links/0/schema" -p "/links/1/schema" -p "/links/2/schema" ``` Read a schema file and create a validator programatically: ```go package jsval_test import ( "log" "github.com/lestrrat-go/jsschema" "github.com/lestrrat-go/jsval/builder" ) func ExampleBuild() { s, err := schema.ReadFile(`/path/to/schema.json`) if err != nil { log.Printf("failed to open schema: %s", err) return } b := builder.New() v, err := b.Build(s) if err != nil { log.Printf("failed to build validator: %s", err) return } var input interface{} if err := v.Validate(input); err != nil { log.Printf("validation failed: %s", err) return } } ``` Build a validator by hand: ```go func ExampleManual() { v := jsval.Object(). AddProp(`zip`, jsval.String().RegexpString(`^\d{5}$`)). AddProp(`address`, jsval.String()). AddProp(`name`, jsval.String()). AddProp(`phone_number`, jsval.String().RegexpString(`^[\d-]+$`)). Required(`zip`, `address`, `name`) var input interface{} if err := v.Validate(input); err != nil { log.Printf("validation failed: %s", err) return } } ``` # Install ``` go get -u github.com/lestrrat-go/jsval ``` If you want to install the `jsval` tool, do ``` go get -u github.com/lestrrat-go/jsval/cmd/jsval ``` # Features ## Can generate validators from JSON Schema definition The following command creates a file named `jsval.go` which contains various variables containing `*jsval.JSVal` structures so you can include them in your code: ``` jsval -s schema.json -o jsval.go ``` See the file `generated_validator_test.go` for a sample generated from JSON Schema schema. If your document isn't a real JSON schema but contains one or more JSON schema (like JSON Hyper Schema) somewhere inside the document, you can use the `-p` argument to access a specific portion of a JSON document: ``` jsval -s hyper.json -p "/links/0" -p "/lnks/1" ``` This will generate a set of validators, with JSON references within the file `hyper.json` properly resolved. ## Can handle JSON References in JSON Schema definitions Note: Not very well tested. Test cases welcome This packages tries to handle JSON References properly. For example, in the schema below, "age" input is validated against the `positiveInteger` schema: ```json { "definitions": { "positiveInteger": { "type": "integer", "minimum": 0, } }, "properties": { "age": { "$ref": "#/definitions/positiveInteger" } } } ``` ## Run a playground server ``` jsval server -listen :8080 ``` You can specify a JSON schema, and see what kind of validator gets generated. # Tricks ## Specifying structs with values that may or may not be initialized With maps, it's easy to check if a property exists. But if you are validating a struct, however, all of the fields exist all the time, and you basically cannot detect if you have a missing field to apply defaults, etc. For such cases you should use the `Maybe` interface provided in this package: ```go type Foo struct { Name MaybeString `json:"name"` } ``` This will declare the value as "optional", and the JSVal validation mechanism does the correct thing to process this field. # References | Name | Notes | |:--------------------------------------------------------:|:---------------------------------| | [go-jsschema](https://github.com/lestrrat-go/jsschema) | JSON Schema implementation | | [go-jshschema](https://github.com/lestrrat-go/jshschema) | JSON Hyper Schema implementation | | [go-jsref](https://github.com/lestrrat-go/jsref) | JSON Reference implementation | | [go-jspointer](https://github.com/lestrrat-go/jspointer) | JSON Pointer implementations | stripe-mock-0.196.0/vendor/github.com/lestrrat-go/jsval/array.go000066400000000000000000000106141506013555700245200ustar00rootroot00000000000000package jsval import ( "errors" "fmt" "reflect" "github.com/lestrrat-go/pdebug" ) // Array creates a new ArrayConstraint func Array() *ArrayConstraint { return &ArrayConstraint{ additionalItems: EmptyConstraint, maxItems: -1, minItems: -1, } } // Validate validates the given value against this Constraint func (c *ArrayConstraint) Validate(v interface{}) (err error) { if pdebug.Enabled { g := pdebug.IPrintf("START ArrayConstraint.Validate") defer func() { if err == nil { g.IRelease("END ArrayConstraint.Validate (PASS)") } else { g.IRelease("END ArrayConstraint.Validate (FAIL): %s", err) } }() } rv := reflect.ValueOf(v) switch rv.Kind() { case reflect.Slice: default: var typ string if rv == zeroval { typ = "invalid" } else { typ = rv.Type().String() } return errors.New("value must be a slice (was: " + typ + ")") } l := rv.Len() if mi := c.minItems; mi > -1 && l < mi { return errors.New("fewer items than minItems") } if mi := c.maxItems; mi > -1 && l > mi { return errors.New("more items than maxItems") } var uitems map[string]struct{} if c.uniqueItems { pdebug.Printf("Check for unique items enabled") uitems = make(map[string]struct{}) for i := 0; i < l; i++ { iv := rv.Index(i).Interface() kv := fmt.Sprintf("%s", iv) pdebug.Printf("unique? -> %s", kv) if _, ok := uitems[kv]; ok { return errors.New("duplicate element found") } uitems[kv] = struct{}{} } } if celem := c.items; celem != nil { if pdebug.Enabled { pdebug.Printf("Checking if all items match a spec") } // if this is set, then all items must fulfill this. // additional items are ignored for i := 0; i < l; i++ { iv := rv.Index(i).Interface() if err := celem.Validate(iv); err != nil { return err } } } else { // otherwise, check the positional specs, and apply the // additionalItems constraint lv := rv.Len() for i, cpos := range c.positionalItems { if lv <= i { break } if pdebug.Enabled { pdebug.Printf("Checking positional item at '%d'", i) } iv := rv.Index(i).Interface() if err := cpos.Validate(iv); err != nil { return err } } lp := len(c.positionalItems) if lp > 0 && l > lp { // we got more than positional schemas cadd := c.additionalItems if cadd == nil { // you can't have additionalItems! return errors.New("additional elements found in array") } for i := lp - 1; i < l; i++ { iv := rv.Index(i).Interface() if err := cadd.Validate(iv); err != nil { return err } } } } return nil } // AdditionalItems specifies the constraint that additional items // must be validated against. Note that if you specify `Items` // with this constraint, `AdditionalItems` has no effect. This // constraint only makes sense when used along side with the // `PositionalItems` constraint. // // If you want to allow any additional items, pass `EmptyConstraint` // to this method. If unspecified, no extra items are allowed. func (c *ArrayConstraint) AdditionalItems(ac Constraint) *ArrayConstraint { c.additionalItems = ac return c } // Items specifies the constraint that all items in the array // must be validated against func (c *ArrayConstraint) Items(ac Constraint) *ArrayConstraint { c.items = ac return c } // MinItems specifies the minimum number of items in the value. // If unspecified, the check is not performed. func (c *ArrayConstraint) MinItems(i int) *ArrayConstraint { c.minItems = i return c } // MaxItems specifies the maximum number of items in the value. // If unspecified, the check is not performed. func (c *ArrayConstraint) MaxItems(i int) *ArrayConstraint { c.maxItems = i return c } // PositionalItems specifies the constraint that elements in // each position of the array being validated. Extra items in // the array are validated against the constraint specified for // `AdditionalItems`. func (c *ArrayConstraint) PositionalItems(ac []Constraint) *ArrayConstraint { c.positionalItems = ac return c } // UniqueItems specifies if the array can hold non-unique items. // When set to true, the validation will fail unless all of your // elements are unique. // // Caveat: Currently we stringify the elements before comparing // for uniqueness. This could/should be fixed. func (c *ArrayConstraint) UniqueItems(b bool) *ArrayConstraint { if pdebug.Enabled { pdebug.Printf("Setting uniqueItems = %t", b) } c.uniqueItems = b return c }stripe-mock-0.196.0/vendor/github.com/lestrrat-go/jsval/basic.go000066400000000000000000000034551506013555700244700ustar00rootroot00000000000000package jsval import ( "errors" "reflect" "github.com/lestrrat-go/pdebug" ) func (dv defaultValue) HasDefault() bool { return dv.initialized } func (dv defaultValue) DefaultValue() interface{} { return dv.value } func (nc emptyConstraint) Validate(_ interface{}) error { return nil } func (nc emptyConstraint) HasDefault() bool { return false } func (nc emptyConstraint) DefaultValue() interface{} { return nil } func (nc nullConstraint) HasDefault() bool { return false } func (nc nullConstraint) DefaultValue() interface{} { return nil } func (nc nullConstraint) Validate(v interface{}) (err error) { if pdebug.Enabled { g := pdebug.Marker("NullConstraint.Validate").BindError(&err) defer g.End() } rv := reflect.ValueOf(v) if rv == zeroval { return nil } switch rv.Kind() { case reflect.Chan, reflect.Func, reflect.Interface, reflect.Map, reflect.Ptr, reflect.Slice: if rv.IsNil() { return nil } } return errors.New("value is not null") } // Not creates a new NotConstraint. You must pass in the // child constraint to be run func Not(c Constraint) *NotConstraint { return &NotConstraint{child: c} } // HasDefault is a no op for this constraint func (nc NotConstraint) HasDefault() bool { return false } // DefaultValue is a no op for this constraint func (nc NotConstraint) DefaultValue() interface{} { return nil } // Validate runs the validation, and returns an error unless // the child constraint fails func (nc NotConstraint) Validate(v interface{}) (err error) { if pdebug.Enabled { g := pdebug.Marker("NotConstraint.Validate").BindError(&err) defer g.End() } if nc.child == nil { return errors.New("'not' constraint does not have a child constraint") } if err := nc.child.Validate(v); err == nil { return errors.New("'not' validation failed") } return nil } stripe-mock-0.196.0/vendor/github.com/lestrrat-go/jsval/bool.go000066400000000000000000000011431506013555700243320ustar00rootroot00000000000000package jsval import ( "errors" "reflect" ) // Boolean creates a new BooleanConsraint func Boolean() *BooleanConstraint { return &BooleanConstraint{} } // Default specifies the default value to apply func (bc *BooleanConstraint) Default(v interface{}) *BooleanConstraint { bc.defaultValue.initialized = true bc.defaultValue.value = v return bc } // Validate vaidates the value against the given value func (bc *BooleanConstraint) Validate(v interface{}) error { rv := reflect.ValueOf(v) switch rv.Kind() { case reflect.Bool: default: return errors.New("value is not a boolean") } return nil } stripe-mock-0.196.0/vendor/github.com/lestrrat-go/jsval/builder/000077500000000000000000000000001506013555700244775ustar00rootroot00000000000000stripe-mock-0.196.0/vendor/github.com/lestrrat-go/jsval/builder/array.go000066400000000000000000000032461506013555700261510ustar00rootroot00000000000000package builder import ( "github.com/lestrrat-go/jsschema" "github.com/lestrrat-go/jsval" "github.com/lestrrat-go/pdebug" ) func buildArrayConstraint(ctx *buildctx, c *jsval.ArrayConstraint, s *schema.Schema) (err error) { if pdebug.Enabled { g := pdebug.IPrintf("START buildArrayConstraint") defer func() { if err == nil { g.IRelease("END buildArrayConstraint (PASS)") } else { g.IRelease("END buildArrayConstraint (FAIL): %s", err) } }() } if items := s.Items; items != nil { if !items.TupleMode { specs, err := buildFromSchema(ctx, items.Schemas[0]) if err != nil { return err } c.Items(specs) } else { specs := make([]jsval.Constraint, len(items.Schemas)) for i, espec := range items.Schemas { item, err := buildFromSchema(ctx, espec) if err != nil { return err } specs[i] = item } c.PositionalItems(specs) aitems := s.AdditionalItems if aitems == nil { if pdebug.Enabled { pdebug.Printf("Disabling additional items") } // No additional items c.AdditionalItems(nil) } else if as := aitems.Schema; as != nil { spec, err := buildFromSchema(ctx, as) if err != nil { return err } if pdebug.Enabled { pdebug.Printf("Using constraint for additional items ") } c.AdditionalItems(spec) } else { if pdebug.Enabled { pdebug.Printf("Additional items will be allowed freely") } c.AdditionalItems(jsval.EmptyConstraint) } } } if s.MinItems.Initialized { c.MinItems(s.MinItems.Val) } if s.MaxItems.Initialized { c.MaxItems(s.MaxItems.Val) } if s.UniqueItems.Initialized { c.UniqueItems(s.UniqueItems.Val) } return nil }stripe-mock-0.196.0/vendor/github.com/lestrrat-go/jsval/builder/bool.go000066400000000000000000000004241506013555700257610ustar00rootroot00000000000000package builder import ( "github.com/lestrrat-go/jsschema" "github.com/lestrrat-go/jsval" ) func buildBooleanConstraint(_ *buildctx, c *jsval.BooleanConstraint, s *schema.Schema) error { v := s.Default switch v.(type) { case bool: c.Default(v.(bool)) } return nil }stripe-mock-0.196.0/vendor/github.com/lestrrat-go/jsval/builder/builder.go000066400000000000000000000235451506013555700264650ustar00rootroot00000000000000package builder /* Package builder contains structures and methods responsible for * generating a jsval.JSVal structure from a JSON schema */ import ( "errors" "math" "reflect" "sort" "github.com/lestrrat-go/jsref" "github.com/lestrrat-go/jsschema" "github.com/lestrrat-go/jsval" "github.com/lestrrat-go/pdebug" ) // Builder builds Validator objects from JSON schemas type Builder struct{} type buildctx struct { V *jsval.JSVal S *schema.Schema R map[string]struct{} } // New creates a new builder object func New() *Builder { return &Builder{} } // Build creates a new validator from the specified schema func (b *Builder) Build(s *schema.Schema) (v *jsval.JSVal, err error) { if pdebug.Enabled { g := pdebug.IPrintf("START Builder.Build") defer func() { if err == nil { g.IRelease("END Builder.Build (OK)") } else { g.IRelease("END Builder.Build (FAIL): %s", err) } }() } if s == nil { return nil, errors.New("nil schema") } return b.BuildWithCtx(s, nil) } // BuildWithCtx creates a new validator from the specified schema, using // the jsctx parameter as the context to resolve JSON References with. // If you expect your schema to contain JSON references to itself, // you will have to pass the context as a map with raw decoded JSON data func (b *Builder) BuildWithCtx(s *schema.Schema, jsctx interface{}) (v *jsval.JSVal, err error) { if pdebug.Enabled { g := pdebug.IPrintf("START Builder.BuildWithCtx") defer func() { if err == nil { g.IRelease("END Builder.BuildWithCtx (OK)") } else { g.IRelease("END Builder.BuildWithCtx (FAIL): %s", err) } }() } if s == nil { return nil, errors.New("nil schema") } v = jsval.New() ctx := buildctx{ V: v, S: s, R: map[string]struct{}{}, // names of references used } c, err := buildFromSchema(&ctx, s) if err != nil { return nil, err } if _, ok := ctx.R["#"]; ok { v.SetReference("#", c) delete(ctx.R, "#") } // Now, resolve references that were used in the schema if len(ctx.R) > 0 { if pdebug.Enabled { pdebug.Printf("Checking references now") } if jsctx == nil { jsctx = s } r := jsref.New() for ref := range ctx.R { if err := compileReferences(&ctx, r, v, ref, jsctx); err != nil { return nil, err } } } v.SetRoot(c) return v, nil } func compileReferences(ctx *buildctx, r *jsref.Resolver, v *jsval.JSVal, ref string, jsctx interface{}) error { if _, err := v.GetReference(ref); err == nil { if pdebug.Enabled { pdebug.Printf("Already resolved constraints for reference '%s'", ref) } return nil } if pdebug.Enabled { pdebug.Printf("Building constraints for reference '%s'", ref) } thing, err := r.Resolve(jsctx, ref) if err != nil { return err } if pdebug.Enabled { pdebug.Printf("'%s' resolves to the main schema", ref) } var s1 *schema.Schema switch thing.(type) { case *schema.Schema: s1 = thing.(*schema.Schema) case map[string]interface{}: s1 = schema.New() if err := s1.Extract(thing.(map[string]interface{})); err != nil { return err } } c1, err := buildFromSchema(ctx, s1) if err != nil { return err } v.SetReference(ref, c1) for ref := range ctx.R { if err := compileReferences(ctx, r, v, ref, jsctx); err != nil { return err } } return nil } func buildFromSchema(ctx *buildctx, s *schema.Schema) (jsval.Constraint, error) { if ref := s.Reference; ref != "" { c := jsval.Reference(ctx.V) if err := buildReferenceConstraint(ctx, c, s); err != nil { return nil, err } ctx.R[ref] = struct{}{} return c, nil } ct := jsval.All() switch { case s.Not != nil: if pdebug.Enabled { pdebug.Printf("Not constraint") } c1, err := buildFromSchema(ctx, s.Not) if err != nil { return nil, err } ct.Add(jsval.Not(c1)) case len(s.AllOf) > 0: if pdebug.Enabled { pdebug.Printf("AllOf constraint") } ac := jsval.All() for _, s1 := range s.AllOf { c1, err := buildFromSchema(ctx, s1) if err != nil { return nil, err } ac.Add(c1) } ct.Add(ac.Reduce()) case len(s.AnyOf) > 0: if pdebug.Enabled { pdebug.Printf("AnyOf constraint") } ac := jsval.Any() for _, s1 := range s.AnyOf { c1, err := buildFromSchema(ctx, s1) if err != nil { return nil, err } ac.Add(c1) } ct.Add(ac.Reduce()) case len(s.OneOf) > 0: if pdebug.Enabled { pdebug.Printf("OneOf constraint") } oc := jsval.OneOf() for _, s1 := range s.OneOf { c1, err := buildFromSchema(ctx, s1) if err != nil { return nil, err } oc.Add(c1) } ct.Add(oc.Reduce()) } var sts schema.PrimitiveTypes if l := len(s.Type); l > 0 { sts = make(schema.PrimitiveTypes, l) copy(sts, s.Type) } else { if pdebug.Enabled { pdebug.Printf("Schema doesn't seem to contain a 'type' field. Now guessing...") } sts = guessSchemaType(s) } sort.Sort(sts) if len(sts) > 0 { tct := jsval.Any() for _, st := range sts { var c jsval.Constraint switch st { case schema.StringType: sc := jsval.String() if err := buildStringConstraint(ctx, sc, s); err != nil { return nil, err } c = sc case schema.NumberType: nc := jsval.Number() if err := buildNumberConstraint(ctx, nc, s); err != nil { return nil, err } c = nc case schema.IntegerType: ic := jsval.Integer() if err := buildIntegerConstraint(ctx, ic, s); err != nil { return nil, err } c = ic case schema.BooleanType: bc := jsval.Boolean() if err := buildBooleanConstraint(ctx, bc, s); err != nil { return nil, err } c = bc case schema.ArrayType: ac := jsval.Array() if err := buildArrayConstraint(ctx, ac, s); err != nil { return nil, err } c = ac case schema.ObjectType: oc := jsval.Object() if err := buildObjectConstraint(ctx, oc, s); err != nil { return nil, err } c = oc case schema.NullType: c = jsval.NullConstraint default: return nil, errors.New("unknown type: " + st.String()) } tct.Add(c) } ct.Add(tct.Reduce()) } else { // All else failed, check if we have some enumeration? if len(s.Enum) > 0 { ec := jsval.Enum(s.Enum...) ct.Add(ec) } } return ct.Reduce(), nil } func guessSchemaType(s *schema.Schema) schema.PrimitiveTypes { if pdebug.Enabled { g := pdebug.IPrintf("START guessSchemaType") defer g.IRelease("END guessSchemaType") } var sts schema.PrimitiveTypes if schemaLooksLikeObject(s) { if pdebug.Enabled { pdebug.Printf("Looks like it could be an object...") } sts = append(sts, schema.ObjectType) } if schemaLooksLikeArray(s) { if pdebug.Enabled { pdebug.Printf("Looks like it could be an array...") } sts = append(sts, schema.ArrayType) } if schemaLooksLikeString(s) { if pdebug.Enabled { pdebug.Printf("Looks like it could be a string...") } sts = append(sts, schema.StringType) } if ok, typ := schemaLooksLikeNumber(s); ok { if pdebug.Enabled { pdebug.Printf("Looks like it could be a number...") } sts = append(sts, typ) } if schemaLooksLikeBool(s) { if pdebug.Enabled { pdebug.Printf("Looks like it could be a bool...") } sts = append(sts, schema.BooleanType) } if pdebug.Enabled { pdebug.Printf("Guessed types: %#v", sts) } return sts } func schemaLooksLikeObject(s *schema.Schema) bool { if len(s.Properties) > 0 { return true } if s.AdditionalProperties == nil { return true } if s.AdditionalProperties.Schema != nil { return true } if s.MinProperties.Initialized { return true } if s.MaxProperties.Initialized { return true } if len(s.Required) > 0 { return true } if len(s.PatternProperties) > 0 { return true } for _, v := range s.Enum { rv := reflect.ValueOf(v) switch rv.Kind() { case reflect.Map, reflect.Struct: return true } } return false } func schemaLooksLikeArray(s *schema.Schema) bool { if s.Items != nil { return true } if s.AdditionalItems == nil { return true } if s.AdditionalItems.Schema != nil { return true } if s.Items != nil { return true } if s.MinItems.Initialized { return true } if s.MaxItems.Initialized { return true } if s.UniqueItems.Initialized { return true } for _, v := range s.Enum { rv := reflect.ValueOf(v) switch rv.Kind() { case reflect.Slice: return true } } return false } func schemaLooksLikeString(s *schema.Schema) bool { if s.MinLength.Initialized { return true } if s.MaxLength.Initialized { return true } if s.Pattern != nil { return true } switch s.Format { case schema.FormatDateTime, schema.FormatEmail, schema.FormatHostname, schema.FormatIPv4, schema.FormatIPv6, schema.FormatURI: return true } for _, v := range s.Enum { rv := reflect.ValueOf(v) switch rv.Kind() { case reflect.String: return true } } return false } func isInteger(n schema.Number) bool { return math.Floor(n.Val) == n.Val } func schemaLooksLikeNumber(s *schema.Schema) (bool, schema.PrimitiveType) { if s.MultipleOf.Initialized { if isInteger(s.MultipleOf) { return true, schema.IntegerType } return true, schema.NumberType } if s.Minimum.Initialized { if isInteger(s.Minimum) { return true, schema.IntegerType } return true, schema.NumberType } if s.Maximum.Initialized { if isInteger(s.Maximum) { return true, schema.IntegerType } return true, schema.NumberType } if s.ExclusiveMinimum.Initialized { return true, schema.NumberType } if s.ExclusiveMaximum.Initialized { return true, schema.NumberType } for _, v := range s.Enum { rv := reflect.ValueOf(v) switch rv.Kind() { case reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64: return true, schema.IntegerType case reflect.Float32, reflect.Float64: return true, schema.NumberType } } return false, schema.UnspecifiedType } func schemaLooksLikeBool(s *schema.Schema) bool { for _, v := range s.Enum { rv := reflect.ValueOf(v) switch rv.Kind() { case reflect.Bool: return true } } return false }stripe-mock-0.196.0/vendor/github.com/lestrrat-go/jsval/builder/enum.go000066400000000000000000000004121506013555700257670ustar00rootroot00000000000000package builder import ( "github.com/lestrrat-go/jsschema" "github.com/lestrrat-go/jsval" ) func buildEnumConstraint(_ *buildctx, c *jsval.EnumConstraint, s *schema.Schema) error { l := make([]interface{}, len(s.Enum)) copy(l, s.Enum) c.Enum(l) return nil } stripe-mock-0.196.0/vendor/github.com/lestrrat-go/jsval/builder/number.go000066400000000000000000000027601506013555700263230ustar00rootroot00000000000000package builder import ( "errors" "github.com/lestrrat-go/jsschema" "github.com/lestrrat-go/jsval" ) func buildIntegerConstraint(ctx *buildctx, nc *jsval.IntegerConstraint, s *schema.Schema) error { if len(s.Type) > 0 { if !s.Type.Contains(schema.IntegerType) { return errors.New("schema is not for integer") } } if s.Minimum.Initialized { nc.Minimum(s.Minimum.Val) if s.ExclusiveMinimum.Initialized { nc.ExclusiveMinimum(s.ExclusiveMinimum.Val) } } if s.Maximum.Initialized { nc.Maximum(s.Maximum.Val) if s.ExclusiveMaximum.Initialized { nc.ExclusiveMaximum(s.ExclusiveMaximum.Val) } } if s.MultipleOf.Initialized { nc.MultipleOf(s.MultipleOf.Val) } if lst := s.Enum; len(lst) > 0 { nc.Enum(lst...) } if v := s.Default; v != nil { nc.Default(v) } return nil } func buildNumberConstraint(ctx *buildctx, nc *jsval.NumberConstraint, s *schema.Schema) error { if len(s.Type) > 0 { if !s.Type.Contains(schema.NumberType) { return errors.New("schema is not for number") } } if s.Minimum.Initialized { nc.Minimum(s.Minimum.Val) if s.ExclusiveMinimum.Initialized { nc.ExclusiveMinimum(s.ExclusiveMinimum.Val) } } if s.Maximum.Initialized { nc.Maximum(s.Maximum.Val) if s.ExclusiveMaximum.Initialized { nc.ExclusiveMaximum(s.ExclusiveMaximum.Val) } } if s.MultipleOf.Initialized { nc.MultipleOf(s.MultipleOf.Val) } if lst := s.Enum; len(lst) > 0 { nc.Enum(lst) } if v := s.Default; v != nil { nc.Default(v) } return nil }stripe-mock-0.196.0/vendor/github.com/lestrrat-go/jsval/builder/object.go000066400000000000000000000027271506013555700263040ustar00rootroot00000000000000package builder import ( "github.com/lestrrat-go/jsschema" "github.com/lestrrat-go/jsval" "github.com/lestrrat-go/pdebug" ) func buildObjectConstraint(ctx *buildctx, c *jsval.ObjectConstraint, s *schema.Schema) error { if pdebug.Enabled { g := pdebug.IPrintf("START ObjectConstraint.FromSchema") defer g.IRelease("END ObjectConstraint.FromSchema") } if l := s.Required; len(l) > 0 { c.Required(l...) } if s.MinProperties.Initialized { c.MinProperties(s.MinProperties.Val) } if s.MaxProperties.Initialized { c.MaxProperties(s.MaxProperties.Val) } for pname, pdef := range s.Properties { cprop, err := buildFromSchema(ctx, pdef) if err != nil { return err } c.AddProp(pname, cprop) } for rx, pdef := range s.PatternProperties { cprop, err := buildFromSchema(ctx, pdef) if err != nil { return err } c.PatternProperties(rx, cprop) } if aprops := s.AdditionalProperties; aprops != nil { if sc := aprops.Schema; sc != nil { aitem, err := buildFromSchema(ctx, sc) if err != nil { return err } c.AdditionalProperties(aitem) } else { c.AdditionalProperties(jsval.EmptyConstraint) } } for from, to := range s.Dependencies.Names { c.PropDependency(from, to...) } if depschemas := s.Dependencies.Schemas; len(depschemas) > 0 { for pname, depschema := range depschemas { depc, err := buildFromSchema(ctx, depschema) if err != nil { return err } c.SchemaDependency(pname, depc) } } return nil } stripe-mock-0.196.0/vendor/github.com/lestrrat-go/jsval/builder/reference.go000066400000000000000000000006651506013555700267730ustar00rootroot00000000000000package builder import ( "errors" "github.com/lestrrat-go/jsschema" "github.com/lestrrat-go/jsval" "github.com/lestrrat-go/pdebug" ) func buildReferenceConstraint(_ *buildctx, r *jsval.ReferenceConstraint, s *schema.Schema) error { pdebug.Printf("ReferenceConstraint.buildFromSchema '%s'", s.Reference) if s.Reference == "" { return errors.New("schema does not contain a reference") } r.RefersTo(s.Reference) return nil } stripe-mock-0.196.0/vendor/github.com/lestrrat-go/jsval/builder/string.go000066400000000000000000000012531506013555700263350ustar00rootroot00000000000000package builder import ( "errors" "github.com/lestrrat-go/jsschema" "github.com/lestrrat-go/jsval" ) func buildStringConstraint(ctx *buildctx, c *jsval.StringConstraint, s *schema.Schema) error { if len(s.Type) > 0 { if !s.Type.Contains(schema.StringType) { return errors.New("schema is not for string") } } if s.MaxLength.Initialized { c.MaxLength(s.MaxLength.Val) } if s.MinLength.Initialized { c.MinLength(s.MinLength.Val) } if pat := s.Pattern; pat != nil { c.Regexp(pat) } if f := s.Format; f != "" { c.Format(string(f)) } if lst := s.Enum; len(lst) > 0 { c.Enum(lst...) } if v := s.Default; v != nil { c.Default(v) } return nil } stripe-mock-0.196.0/vendor/github.com/lestrrat-go/jsval/combinations.go000066400000000000000000000062051506013555700260700ustar00rootroot00000000000000package jsval import ( "errors" "github.com/lestrrat-go/pdebug" ) func (c *comboconstraint) Add(v Constraint) { c.constraints = append(c.constraints, v) } func (c *comboconstraint) Constraints() []Constraint { return c.constraints } func reduceCombined(cc interface { Constraint Constraints() []Constraint }) Constraint { l := cc.Constraints() if len(l) == 1 { return l[0] } return cc } // Any creates a new AnyConstraint func Any() *AnyConstraint { return &AnyConstraint{} } // Reduce returns the child Constraint, if this constraint // has only 1 child constraint. func (c *AnyConstraint) Reduce() Constraint { return reduceCombined(c) } // Add appends a new Constraint func (c *AnyConstraint) Add(c2 Constraint) *AnyConstraint { c.comboconstraint.Add(c2) return c } // Validate validates the value against the input value. // For AnyConstraints, it will return success the moment // one child Constraint succeeds. It will return an error // if none of the child Constraints succeeds func (c *AnyConstraint) Validate(v interface{}) (err error) { if pdebug.Enabled { g := pdebug.Marker("AnyConstraint.Validate").BindError(&err) defer g.End() } for _, celem := range c.constraints { if err := celem.Validate(v); err == nil { return nil } } return errors.New("could not validate against any of the constraints") } // All creates a new AllConstraint func All() *AllConstraint { return &AllConstraint{} } // Reduce returns the child Constraint, if this constraint // has only 1 child constraint. func (c *AllConstraint) Reduce() Constraint { return reduceCombined(c) } // Add appends a new Constraint func (c *AllConstraint) Add(c2 Constraint) *AllConstraint { c.comboconstraint.Add(c2) return c } // Validate validates the value against the input value. // For AllConstraints, it will only return success if // all of the child Constraints succeeded. func (c *AllConstraint) Validate(v interface{}) (err error) { if pdebug.Enabled { g := pdebug.Marker("AllConstraint.Validate").BindError(&err) defer g.End() } for _, celem := range c.constraints { if err := celem.Validate(v); err != nil { return err } } return nil } // OneOf creates a new OneOfConstraint func OneOf() *OneOfConstraint { return &OneOfConstraint{} } // Reduce returns the child Constraint, if this constraint // has only 1 child constraint. func (c *OneOfConstraint) Reduce() Constraint { return reduceCombined(c) } // Add appends a new Constraint func (c *OneOfConstraint) Add(c2 Constraint) *OneOfConstraint { c.comboconstraint.Add(c2) return c } // Validate validates the value against the input value. // For OneOfConstraints, it will return success only if // exactly 1 child Constraint succeeds. func (c *OneOfConstraint) Validate(v interface{}) (err error) { if pdebug.Enabled { g := pdebug.Marker("OneOfConstraint.Validate").BindError(&err) defer g.End() } count := 0 for _, celem := range c.constraints { if err := celem.Validate(v); err == nil { count++ } } if count == 0 { return errors.New("none of the constraints passed") } else if count > 1 { return errors.New("more than 1 of the constraints passed") } return nil // Yes! } stripe-mock-0.196.0/vendor/github.com/lestrrat-go/jsval/enum.go000066400000000000000000000012551506013555700243470ustar00rootroot00000000000000package jsval import ( "errors" "github.com/lestrrat-go/pdebug" ) // Enum creates a new EnumConstraint func Enum(v ...interface{}) *EnumConstraint { return &EnumConstraint{enums: v} } // Enum method sets the possible enumerations func (c *EnumConstraint) Enum(v ...interface{}) *EnumConstraint { c.enums = v return c } // Validate validates the value against the list of enumerations func (c *EnumConstraint) Validate(v interface{}) (err error) { if pdebug.Enabled { g := pdebug.Marker("EnumConstraint.Validate (%s)", v).BindError(&err) defer g.End() } for _, e := range c.enums { if e == v { return nil } } return errors.New("value is not in enumeration") } stripe-mock-0.196.0/vendor/github.com/lestrrat-go/jsval/generator.go000066400000000000000000000310631506013555700253710ustar00rootroot00000000000000package jsval import ( "bytes" "errors" "fmt" "go/format" "io" "os" "reflect" "sort" "strconv" "strings" "unicode" ) // Generator is responsible for generating Go code that // sets up a validator type Generator struct{} // NewGenerator creates a new Generator func NewGenerator() *Generator { return &Generator{} } // Process takes a validator and prints out Go code to out. func (g *Generator) Process(out io.Writer, validators ...*JSVal) error { ctx := genctx{ pkgname: "jsval", refnames: make(map[string]string), vname: "V", } buf := bytes.Buffer{} // First get all of the references so we can refer to it later refs := map[string]Constraint{} refnames := []string{} valnames := []string{} for i, v := range validators { for rname, rc := range v.refs { if _, ok := refs[rname]; ok { continue } refs[rname] = rc refnames = append(refnames, rname) } if v.Name == "" { v.Name = fmt.Sprintf("V%d", i) } valnames = append(valnames, v.Name) } sort.Strings(valnames) for _, vname := range valnames { fmt.Fprintf(&buf, "\nvar %s *%s.JSVal", vname, ctx.pkgname) } ctx.refs = refs if len(refs) > 0 { // have refs ctx.cmname = "M" // sort them by reference name sort.Strings(refnames) fmt.Fprintf(&buf, "\nvar %s *%s.ConstraintMap", ctx.cmname, ctx.pkgname) // Generate reference constraint names for i, rname := range refnames { vname := fmt.Sprintf("R%d", i) ctx.refnames[rname] = vname fmt.Fprintf(&buf, "\nvar %s %s.Constraint", vname, ctx.pkgname) } } fmt.Fprintf(&buf, "\nfunc init() {") if len(refs) > 0 { fmt.Fprintf(&buf, "\n%s = &%s.ConstraintMap{}", ctx.cmname, ctx.pkgname) // Now generate code for references for _, rname := range refnames { fmt.Fprintf(&buf, "\n%s = ", ctx.refnames[rname]) rbuf := bytes.Buffer{} if err := generateCode(&ctx, &rbuf, ctx.refs[rname]); err != nil { return err } // Remove indentation here rs := rbuf.String() for i, r := range rs { if !unicode.IsSpace(r) { rs = rs[i:] break } } fmt.Fprint(&buf, rs) } for _, rname := range refnames { fmt.Fprintf(&buf, "\n%s.SetReference(%s, %s)", ctx.cmname, strconv.Quote(rname), ctx.refnames[rname]) } } // Now dump the validators sort.Sort(JSValSlice(validators)) for _, v := range validators { fmt.Fprintf(&buf, "\n%s = ", v.Name) if err := generateCode(&ctx, &buf, v); err != nil { return err } } fmt.Fprintf(&buf, "\n}") fsrc, err := format.Source(buf.Bytes()) if err != nil { os.Stderr.Write(buf.Bytes()) return err } out.Write(fsrc) return nil } type genctx struct { cmname string pkgname string refs map[string]Constraint refnames map[string]string vname string } func generateEmptyCode(ctx *genctx, out io.Writer, c emptyConstraint) error { fmt.Fprintf(out, "%s.EmptyConstraint", ctx.pkgname) return nil } func generateNullCode(ctx *genctx, out io.Writer, c nullConstraint) error { fmt.Fprintf(out, "%s.NullConstraint", ctx.pkgname) return nil } func generateValidatorCode(ctx *genctx, out io.Writer, v *JSVal) error { found := false fmt.Fprintf(out, "%s.New()", ctx.pkgname) fmt.Fprintf(out, ".\nSetName(%s)", strconv.Quote(v.Name)) if cmname := ctx.cmname; cmname != "" { fmt.Fprintf(out, ".\nSetConstraintMap(%s)", cmname) } for rname, rc := range ctx.refs { if v.root == rc { fmt.Fprintf(out, ".\nSetRoot(%s)", ctx.refnames[rname]) found = true break } } if !found { fmt.Fprint(out, ".\nSetRoot(\n") if err := generateCode(ctx, out, v.root); err != nil { return err } fmt.Fprint(out, ",\n)\n") } return nil } func generateCode(ctx *genctx, out io.Writer, c interface { Validate(interface{}) error }) error { buf := &bytes.Buffer{} switch c.(type) { case nullConstraint: if err := generateNullCode(ctx, buf, c.(nullConstraint)); err != nil { return err } case emptyConstraint: if err := generateEmptyCode(ctx, buf, c.(emptyConstraint)); err != nil { return err } case *JSVal: if err := generateValidatorCode(ctx, buf, c.(*JSVal)); err != nil { return err } case *AnyConstraint: if err := generateAnyCode(ctx, buf, c.(*AnyConstraint)); err != nil { return err } case *AllConstraint: if err := generateAllCode(ctx, buf, c.(*AllConstraint)); err != nil { return err } case *ArrayConstraint: if err := generateArrayCode(ctx, buf, c.(*ArrayConstraint)); err != nil { return err } case *BooleanConstraint: if err := generateBooleanCode(ctx, buf, c.(*BooleanConstraint)); err != nil { return err } case *IntegerConstraint: if err := generateIntegerCode(ctx, buf, c.(*IntegerConstraint)); err != nil { return err } case *NotConstraint: if err := generateNotCode(ctx, buf, c.(*NotConstraint)); err != nil { return err } case *NumberConstraint: if err := generateNumberCode(ctx, buf, c.(*NumberConstraint)); err != nil { return err } case *ObjectConstraint: if err := generateObjectCode(ctx, buf, c.(*ObjectConstraint)); err != nil { return err } case *OneOfConstraint: if err := generateOneOfCode(ctx, buf, c.(*OneOfConstraint)); err != nil { return err } case *ReferenceConstraint: if err := generateReferenceCode(ctx, buf, c.(*ReferenceConstraint)); err != nil { return err } case *StringConstraint: if err := generateStringCode(ctx, buf, c.(*StringConstraint)); err != nil { return err } } s := buf.String() s = strings.TrimSuffix(s, ".\n") fmt.Fprintf(out, s) return nil } func generateReferenceCode(ctx *genctx, out io.Writer, c *ReferenceConstraint) error { fmt.Fprintf(out, "%s.Reference(%s).RefersTo(%s)", ctx.pkgname, ctx.cmname, strconv.Quote(c.reference)) return nil } func generateComboCode(ctx *genctx, out io.Writer, name string, clist []Constraint) error { if len(clist) == 0 { return generateEmptyCode(ctx, out, EmptyConstraint) } fmt.Fprintf(out, "%s.%s()", ctx.pkgname, name) for _, c1 := range clist { fmt.Fprint(out, ".\nAdd(\n") if err := generateCode(ctx, out, c1); err != nil { return err } fmt.Fprint(out, ",\n)") } return nil } func generateAnyCode(ctx *genctx, out io.Writer, c *AnyConstraint) error { return generateComboCode(ctx, out, "Any", c.constraints) } func generateAllCode(ctx *genctx, out io.Writer, c *AllConstraint) error { return generateComboCode(ctx, out, "All", c.constraints) } func generateOneOfCode(ctx *genctx, out io.Writer, c *OneOfConstraint) error { return generateComboCode(ctx, out, "OneOf", c.constraints) } func generateIntegerCode(ctx *genctx, out io.Writer, c *IntegerConstraint) error { fmt.Fprintf(out, "%s.Integer()", ctx.pkgname) if c.applyMinimum { fmt.Fprintf(out, ".Minimum(%d)", int(c.minimum)) } if c.exclusiveMinimum { fmt.Fprintf(out, ".ExclusiveMinimum(true)") } if c.applyMaximum { fmt.Fprintf(out, ".Maximum(%d)", int(c.maximum)) } if c.exclusiveMaximum { fmt.Fprintf(out, ".ExclusiveMaximum(true)") } if c.HasDefault() { fmt.Fprintf(out, ".Default(%d)", int(c.DefaultValue().(float64))) } return nil } func generateNumberCode(ctx *genctx, out io.Writer, c *NumberConstraint) error { fmt.Fprintf(out, "%s.Number()", ctx.pkgname) if c.applyMinimum { fmt.Fprintf(out, ".Minimum(%f)", c.minimum) } if c.exclusiveMinimum { fmt.Fprintf(out, ".ExclusiveMinimum(true)") } if c.applyMaximum { fmt.Fprintf(out, ".Maximum(%f)", c.maximum) } if c.exclusiveMaximum { fmt.Fprintf(out, ".ExclusiveMaximum(true)") } if c.HasDefault() { fmt.Fprintf(out, ".Default(%f)", c.DefaultValue()) } return nil } func generateEnumCode(ctx *genctx, out io.Writer, c *EnumConstraint) error { fmt.Fprintf(out, "") l := len(c.enums) for i, v := range c.enums { rv := reflect.ValueOf(v) switch rv.Kind() { case reflect.String: fmt.Fprintf(out, "%s", strconv.Quote(rv.String())) case reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64, reflect.Uint, reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64: fmt.Fprintf(out, "%d", rv.Int()) case reflect.Float32, reflect.Float64: fmt.Fprintf(out, "%f", rv.Float()) default: return fmt.Errorf("failed to stringify enum value %#v", rv.Interface()) } if i < l-1 { fmt.Fprintf(out, ", ") } } return nil } func generateStringCode(ctx *genctx, out io.Writer, c *StringConstraint) error { fmt.Fprintf(out, "%s.String()", ctx.pkgname) if c.maxLength > -1 { fmt.Fprintf(out, ".MaxLength(%d)", c.maxLength) } if c.minLength > 0 { fmt.Fprintf(out, ".MinLength(%d)", c.minLength) } if f := c.format; f != "" { fmt.Fprintf(out, ".Format(%s)", strconv.Quote(string(f))) } if rx := c.regexp; rx != nil { fmt.Fprintf(out, ".RegexpString(%s)", strconv.Quote(rx.String())) } if enum := c.enums; enum != nil { fmt.Fprintf(out, ".Enum(") if err := generateEnumCode(ctx, out, enum); err != nil { return err } fmt.Fprintf(out, ",)") } if c.HasDefault() { def := c.DefaultValue() switch def.(type) { case string: default: return errors.New("default value must be a string") } fmt.Fprintf(out, ".Default(%s)", strconv.Quote(def.(string))) } return nil } func generateObjectCode(ctx *genctx, out io.Writer, c *ObjectConstraint) error { fmt.Fprintf(out, "%s.Object()", ctx.pkgname) if c.HasDefault() { fmt.Fprintf(out, ".\nDefault(%s)", c.DefaultValue()) } if len(c.required) > 0 { fmt.Fprint(out, ".\nRequired(") l := len(c.required) pnames := make([]string, 0, l) for pname := range c.required { pnames = append(pnames, pname) } sort.Strings(pnames) for i, pname := range pnames { fmt.Fprint(out, strconv.Quote(pname)) if i < l-1 { fmt.Fprint(out, ", ") } } fmt.Fprint(out, ")") } if aprop := c.additionalProperties; aprop != nil { fmt.Fprintf(out, ".\nAdditionalProperties(\n") if err := generateCode(ctx, out, aprop); err != nil { return err } fmt.Fprintf(out, ",\n)") } pnames := make([]string, 0, len(c.properties)) for pname := range c.properties { pnames = append(pnames, pname) } sort.Strings(pnames) for _, pname := range pnames { pdef := c.properties[pname] fmt.Fprintf(out, ".\nAddProp(\n%s,\n", strconv.Quote(pname)) if err := generateCode(ctx, out, pdef); err != nil { return err } fmt.Fprint(out, ",\n)") } // patternProperties is a bit tricky, because the keys are // Regexp objects, and they don't have a sort.Regexp available // for us. It's easy to write one, but we'd have to stringify them // anyways, so we might as well just create a temporary container // with strings as keys ppmap := make(map[string]Constraint) ppnames := make([]string, 0, len(c.patternProperties)) for rx, ppc := range c.patternProperties { rxs := rx.String() ppmap[rxs] = ppc ppnames = append(ppnames, rxs) } sort.Strings(ppnames) for _, ppname := range ppnames { fmt.Fprintf(out, ".\nPatternPropertiesString(\n%s,\n", strconv.Quote(ppname)) if err := generateCode(ctx, out, ppmap[ppname]); err != nil { return err } fmt.Fprint(out, ",\n)") } if m := c.propdeps; len(m) > 0 { keys := make([]string, 0, len(m)) for from := range m { keys = append(keys, from) } sort.Strings(keys) for _, from := range keys { deplist := m[from] for _, to := range deplist { fmt.Fprintf(out, ".\nPropDependency(%s, %s)", strconv.Quote(from), strconv.Quote(to)) } } } return nil } func generateArrayCode(ctx *genctx, out io.Writer, c *ArrayConstraint) error { fmt.Fprintf(out, "%s.Array()", ctx.pkgname) if cc := c.items; cc != nil { fmt.Fprint(out, ".\nItems(\n") if err := generateCode(ctx, out, cc); err != nil { return err } fmt.Fprint(out, ",\n)") } if cc := c.additionalItems; cc != nil { fmt.Fprint(out, ".\nAdditionalItems(\n") if err := generateCode(ctx, out, cc); err != nil { return err } fmt.Fprintf(out, ",\n)") } if cc := c.positionalItems; len(cc) > 0 { fmt.Fprintf(out, ".\nPositionalItems([]%s.Constraint{\n", ctx.pkgname) for _, ccc := range cc { if err := generateCode(ctx, out, ccc); err != nil { } fmt.Fprintf(out, ",\n") } fmt.Fprint(out, "})") } if c.minItems > -1 { fmt.Fprintf(out, ".\nMinItems(%d)", c.minItems) } if c.maxItems > -1 { fmt.Fprintf(out, ".\nMaxItems(%d)", c.maxItems) } if c.uniqueItems { fmt.Fprint(out, ".\nUniqueItems(true)") } return nil } func generateBooleanCode(ctx *genctx, out io.Writer, c *BooleanConstraint) error { fmt.Fprintf(out, "%s.Boolean()", ctx.pkgname) if c.HasDefault() { fmt.Fprintf(out, ".Default(%t)", c.DefaultValue()) } return nil } func generateNotCode(ctx *genctx, out io.Writer, c *NotConstraint) error { fmt.Fprintf(out, "%s.Not(\n", ctx.pkgname) if err := generateCode(ctx, out, c.child); err != nil { return err } fmt.Fprint(out, "\n)") return nil } stripe-mock-0.196.0/vendor/github.com/lestrrat-go/jsval/interface.go000066400000000000000000000121561506013555700253450ustar00rootroot00000000000000package jsval import ( "reflect" "regexp" "sync" "github.com/lestrrat-go/jsref" ) var zeroval = reflect.Value{} // JSVal is the main validator object. type JSVal struct { *ConstraintMap // Name is the name that will be used to generate code for this validator. // If unspecified, the generator will create variable names like `V0`, `V1`, // `V2`, etc. If you want to generate more meaningful names, you should // set this value manually. For example, if you are using jsval with a // scaffold generator, you might want to set this to a human-readable value Name string root Constraint resolver *jsref.Resolver } // JSValSlice is a list of JSVal validators. This exists in order to define // methods to satisfy the `sort.Interface` interface type JSValSlice []*JSVal // Constraint is an object that know how to validate // individual types of input type Constraint interface { DefaultValue() interface{} HasDefault() bool Validate(interface{}) error } type emptyConstraint struct{} // EmptyConstraint is a constraint that returns true for any value var EmptyConstraint = emptyConstraint{} type nullConstraint struct{} // NullConstraint is a constraint that only matches the JSON // "null" value, or "nil" in golang var NullConstraint = nullConstraint{} type defaultValue struct { initialized bool value interface{} } // BooleanConstraint implements a constraint to match against // a boolean. type BooleanConstraint struct { defaultValue } // StringConstraint implements a constraint to match against // a string type StringConstraint struct { defaultValue enums *EnumConstraint maxLength int minLength int regexp *regexp.Regexp format string } // NumberConstraint implements a constraint to match against // a number (i.e. float) type. type NumberConstraint struct { defaultValue applyMinimum bool applyMaximum bool applyMultipleOf bool minimum float64 maximum float64 multipleOf float64 exclusiveMinimum bool exclusiveMaximum bool enums *EnumConstraint } // IntegerConstraint implements a constraint to match against // an integer type. Note that after checking if the value is // an int (i.e. floor(x) == x), the rest of the logic follows // exactly that of NumberConstraint type IntegerConstraint struct { NumberConstraint } // ArrayConstraint implements a constraint to match against // various aspects of a Array/Slice structure type ArrayConstraint struct { defaultValue items Constraint positionalItems []Constraint additionalItems Constraint minItems int maxItems int uniqueItems bool } // ObjectConstraint implements a constraint to match against // various aspects of a Map-like structure. type ObjectConstraint struct { defaultValue additionalProperties Constraint deplock sync.Mutex patternProperties map[*regexp.Regexp]Constraint proplock sync.Mutex properties map[string]Constraint propdeps map[string][]string reqlock sync.Mutex required map[string]struct{} maxProperties int minProperties int schemadeps map[string]Constraint // FieldNameFromName takes a struct wrapped in reflect.Value, and a // field name -- in JSON format (i.e. what you specified in your // JSON struct tags, or the actual field name). It returns the // struct field name to pass to `Value.FieldByName()`. If you do // not specify one, DefaultFieldNameFromName will be used. FieldNameFromName func(reflect.Value, string) string // FieldNamesFromStruct takes a struct wrapped in reflect.Value, and // returns the name of all public fields. Note that the returned // names will be JSON names, which may not necessarily be the same // as the field name. If you do not specify one, DefaultFieldNamesFromStruct // will be used FieldNamesFromStruct func(reflect.Value) []string } // EnumConstraint implements a constraint where the incoming // value must match one of the values enumerated in the constraint. // Note that due to various language specific reasons, you should // only use simple types where the "==" operator can distinguish // between different values type EnumConstraint struct { emptyConstraint enums []interface{} } type comboconstraint struct { emptyConstraint constraints []Constraint } // AnyConstraint implements a constraint where at least 1 // child constraint must pass in order for this validation to pass. type AnyConstraint struct { comboconstraint } // AllConstraint implements a constraint where all of the // child constraints' validation must pass in order for this // validation to pass. type AllConstraint struct { comboconstraint } // OneOfConstraint implements a constraint where only exactly // one of the child constraints' validation can pass. If // none of the constraints passes, or more than 1 constraint // passes, the expressions deemed to have failed. type OneOfConstraint struct { comboconstraint } // NotConstraint implements a constraint where the result of // child constraint is negated -- that is, validation passes // only if the child constraint fails. type NotConstraint struct { child Constraint } stripe-mock-0.196.0/vendor/github.com/lestrrat-go/jsval/jsval.go000066400000000000000000000034541506013555700245250ustar00rootroot00000000000000//go:generate go run internal/cmd/gentest/gentest.go schema.json generated_validator_test.go //go:generate go run internal/cmd/genmaybe/genmaybe.go // Package jsval implements an input validator, based on JSON Schema. // The main purpose is to validate JSON Schemas (see // https://github.com/lestrrat-go/jsschema), and to automatically // generate validators from schemas, but jsval can be used independently // of JSON Schema. package jsval import "github.com/pkg/errors" // New creates a new JSVal instance. func New() *JSVal { return &JSVal{ ConstraintMap: &ConstraintMap{}, } } // Validate validates the input, and return an error // if any of the validations fail func (v *JSVal) Validate(x interface{}) error { name := v.Name if len(name) == 0 { return errors.Wrapf(v.root.Validate(x), "validator %p failed", v) } return errors.Wrapf(v.root.Validate(x), "validator %s failed", name) } // SetName sets the name for the validator func (v *JSVal) SetName(s string) *JSVal { v.Name = s return v } // SetRoot sets the root Constraint object. func (v *JSVal) SetRoot(c Constraint) *JSVal { v.root = c return v } // Root returns the root Constraint object. func (v *JSVal) Root() Constraint { return v.root } // SetConstraintMap allows you to set the map that is referred to // when resolving JSON references within constraints. By setting // this to a common map, for example, you can share the same references // to save you some memory space and sanity. See an example in the // `generated_validator_test.go` file. func (v *JSVal) SetConstraintMap(cm *ConstraintMap) *JSVal { v.ConstraintMap = cm return v } func (p JSValSlice) Len() int { return len(p) } func (p JSValSlice) Less(i, j int) bool { return p[i].Name < p[j].Name } func (p JSValSlice) Swap(i, j int) { p[i], p[j] = p[j], p[i] } stripe-mock-0.196.0/vendor/github.com/lestrrat-go/jsval/maybe.go000066400000000000000000000126501506013555700245010ustar00rootroot00000000000000package jsval import ( "bytes" "encoding/json" "reflect" "time" ) type ErrInvalidMaybeValue struct { Value interface{} } func (e ErrInvalidMaybeValue) Error() string { buf := bytes.Buffer{} buf.WriteString("invalid Maybe value: ") t := reflect.TypeOf(e.Value) switch t { case nil: buf.WriteString("(nil)") default: buf.WriteByte('(') buf.WriteString(t.String()) buf.WriteByte(')') } return buf.String() } // Maybe is an interface that can be used for struct fields which // want to differentiate between initialized and uninitialized state. // For example, a string field, if uninitialized, will contain the zero // value of "", but that empty string *could* be a valid value for // our validation purposes. // // To differentiate between an uninitialized string and an empty string, // you should wrap it with a wrapper that implements the Maybe interface // and JSVal will do its best to figure this out type Maybe interface { // Valid should return true if this value has been properly initialized. // If this returns false, JSVal will treat as if the field is has not been // provided at all. Valid() bool // Value should return whatever the underlying value is. Value() interface{} // Set sets a value to this Maybe value, and turns on the Valid flag. // An error may be returned if the value could not be set (e.g. // you provided a value with the wrong type) Set(interface{}) error // Reset clears the Maybe value, and sets the Valid flag to false. Reset() } type ValidFlag bool func (v *ValidFlag) Reset() { *v = false } func (v ValidFlag) Valid() bool { return bool(v) } type MaybeBool struct { ValidFlag Bool bool } func (v *MaybeBool) Set(x interface{}) error { s, ok := x.(bool) if !ok { return ErrInvalidMaybeValue{Value: x} } v.ValidFlag = true v.Bool = s return nil } func (v MaybeBool) Value() interface{} { return v.Bool } func (v MaybeBool) MarshalJSON() ([]byte, error) { return json.Marshal(v.Bool) } func (v *MaybeBool) UnmarshalJSON(data []byte) error { var in bool if err := json.Unmarshal(data, &in); err != nil { return err } return v.Set(in) } type MaybeFloat struct { ValidFlag Float float64 } func (v *MaybeFloat) Set(x interface{}) error { switch x.(type) { case float32: v.Float = float64(x.(float32)) case float64: v.Float = x.(float64) default: return ErrInvalidMaybeValue{Value: x} } v.ValidFlag = true return nil } func (v MaybeFloat) Value() interface{} { return v.Float } func (v MaybeFloat) MarshalJSON() ([]byte, error) { return json.Marshal(v.Float) } func (v *MaybeFloat) UnmarshalJSON(data []byte) error { var in float64 if err := json.Unmarshal(data, &in); err != nil { return err } return v.Set(in) } type MaybeInt struct { ValidFlag Int int64 } func (v *MaybeInt) Set(x interface{}) error { switch x.(type) { case int: v.Int = int64(x.(int)) case int8: v.Int = int64(x.(int8)) case int16: v.Int = int64(x.(int16)) case int32: v.Int = int64(x.(int32)) case float64: v.Int = int64(x.(float64)) case int64: v.Int = x.(int64) default: return ErrInvalidMaybeValue{Value: x} } v.ValidFlag = true return nil } func (v MaybeInt) Value() interface{} { return v.Int } func (v MaybeInt) MarshalJSON() ([]byte, error) { return json.Marshal(v.Int) } func (v *MaybeInt) UnmarshalJSON(data []byte) error { var in int64 if err := json.Unmarshal(data, &in); err != nil { return err } return v.Set(in) } type MaybeString struct { ValidFlag String string } func (v *MaybeString) Set(x interface{}) error { s, ok := x.(string) if !ok { return ErrInvalidMaybeValue{Value: x} } v.ValidFlag = true v.String = s return nil } func (v MaybeString) Value() interface{} { return v.String } func (v MaybeString) MarshalJSON() ([]byte, error) { return json.Marshal(v.String) } func (v *MaybeString) UnmarshalJSON(data []byte) error { var in string if err := json.Unmarshal(data, &in); err != nil { return err } return v.Set(in) } type MaybeTime struct { ValidFlag Time time.Time } func (v *MaybeTime) Set(x interface{}) error { switch x.(type) { case string: tv, err := time.Parse(time.RFC3339, x.(string)) if err != nil { return err } v.ValidFlag = true v.Time = tv case time.Time: v.ValidFlag = true v.Time = x.(time.Time) default: return ErrInvalidMaybeValue{Value: x} } return nil } func (v MaybeTime) Value() interface{} { return v.Time } func (v MaybeTime) MarshalJSON() ([]byte, error) { return json.Marshal(v.Time.Format(time.RFC3339)) } func (v *MaybeTime) UnmarshalJSON(data []byte) error { var s string if err := json.Unmarshal(data, &s); err != nil { return err } t, err := time.Parse(time.RFC3339, s) if err != nil { return err } v.Time = t return nil } type MaybeUint struct { ValidFlag Uint uint64 } func (v *MaybeUint) Set(x interface{}) error { switch x.(type) { case uint: v.Uint = uint64(x.(uint)) case uint8: v.Uint = uint64(x.(uint8)) case uint16: v.Uint = uint64(x.(uint16)) case uint32: v.Uint = uint64(x.(uint32)) case float64: v.Uint = uint64(x.(float64)) case uint64: v.Uint = x.(uint64) default: return ErrInvalidMaybeValue{Value: x} } v.ValidFlag = true return nil } func (v MaybeUint) Value() interface{} { return v.Uint } func (v MaybeUint) MarshalJSON() ([]byte, error) { return json.Marshal(v.Uint) } func (v *MaybeUint) UnmarshalJSON(data []byte) error { var in uint64 if err := json.Unmarshal(data, &in); err != nil { return err } return v.Set(in) } stripe-mock-0.196.0/vendor/github.com/lestrrat-go/jsval/number.go000066400000000000000000000134751506013555700247020ustar00rootroot00000000000000package jsval import ( "errors" "math" "reflect" "github.com/lestrrat-go/pdebug" ) // Enum specifies the values that this constraint can have func (nc *NumberConstraint) Enum(l ...interface{}) *NumberConstraint { if nc.enums == nil { nc.enums = Enum() } nc.enums.Enum(l...) return nc } // Default specifies the default value for the given value func (nc *NumberConstraint) Default(v interface{}) *NumberConstraint { nc.defaultValue.initialized = true nc.defaultValue.value = v return nc } // Maximum sepcifies the maximum value that the constraint can allow func (nc *NumberConstraint) Maximum(n float64) *NumberConstraint { nc.applyMaximum = true nc.maximum = n return nc } // Minimum sepcifies the minimum value that the constraint can allow func (nc *NumberConstraint) Minimum(n float64) *NumberConstraint { nc.applyMinimum = true nc.minimum = n return nc } // MultipleOf specifies the number that the given value must be // divisible by. That is, the constraint will return an error unless // the given value satisfies `math.Mod(v, n) == 0` func (nc *NumberConstraint) MultipleOf(n float64) *NumberConstraint { nc.applyMultipleOf = true nc.multipleOf = n return nc } // ExclusiveMinimum specifies if the minimum value should be considered // a valid value func (nc *NumberConstraint) ExclusiveMinimum(b bool) *NumberConstraint { nc.exclusiveMinimum = b return nc } // ExclusiveMaximum specifies if the maximum value should be considered // a valid value func (nc *NumberConstraint) ExclusiveMaximum(b bool) *NumberConstraint { nc.exclusiveMaximum = b return nc } // Validate validates the value against this constraint func (nc *NumberConstraint) Validate(v interface{}) (err error) { if pdebug.Enabled { g := pdebug.IPrintf("START NumberConstraint.Validate") defer func() { if err == nil { g.IRelease("END NumberConstraint.Validate (PASS)") } else { g.IRelease("END NumberConstraint.Validate (FAIL): %s", err) } }() } rv := reflect.ValueOf(v) switch rv.Kind() { case reflect.Ptr, reflect.Interface: rv = rv.Elem() } switch rv.Kind() { case reflect.Float32, reflect.Float64: default: return errors.New("value is not a float") } f := rv.Float() if nc.applyMinimum { if pdebug.Enabled { pdebug.Printf("Checking Minimum (%f)", nc.minimum) } if nc.exclusiveMinimum { if nc.minimum >= f { return errors.New("numeric value is less than the minimum (exclusive minimum)") } } else { if nc.minimum > f { return errors.New("numeric value is less than the minimum") } } } if nc.applyMaximum { if pdebug.Enabled { pdebug.Printf("Checking Maximum (%f)", nc.maximum) } if nc.exclusiveMaximum { if nc.maximum <= f { return errors.New("numeric value is greater than maximum (exclusive maximum)") } } else { if nc.maximum < f { return errors.New("numeric value is greater than maximum") } } } if nc.applyMultipleOf { if pdebug.Enabled { pdebug.Printf("Checking MultipleOf (%f)", nc.multipleOf) } if nc.multipleOf != 0 { if math.Mod(f, nc.multipleOf) != 0 { return errors.New("numeric value is fails multipleOf validation") } } } if enum := nc.enums; enum != nil { if err := enum.Validate(f); err != nil { return err } } return nil } // Number creates a new NumberConstraint func Number() *NumberConstraint { return &NumberConstraint{ applyMinimum: false, applyMaximum: false, } } // Integer creates a new IntegerrConstraint func Integer() *IntegerConstraint { c := &IntegerConstraint{} c.applyMinimum = false c.applyMaximum = false return c } // Default specifies the default value for the given value func (ic *IntegerConstraint) Default(v interface{}) *IntegerConstraint { ic.NumberConstraint.Default(v) return ic } // Maximum sepcifies the maximum value that the constraint can allow // Maximum sepcifies the maximum value that the constraint can allow func (ic *IntegerConstraint) Maximum(n float64) *IntegerConstraint { ic.applyMaximum = true ic.maximum = n return ic } // Minimum sepcifies the minimum value that the constraint can allow func (ic *IntegerConstraint) Minimum(n float64) *IntegerConstraint { ic.applyMinimum = true ic.minimum = n return ic } // ExclusiveMinimum specifies if the minimum value should be considered // a valid value func (ic *IntegerConstraint) ExclusiveMinimum(b bool) *IntegerConstraint { ic.NumberConstraint.ExclusiveMinimum(b) return ic } // ExclusiveMaximum specifies if the maximum value should be considered // a valid value func (ic *IntegerConstraint) ExclusiveMaximum(b bool) *IntegerConstraint { ic.NumberConstraint.ExclusiveMaximum(b) return ic } // Validate validates the value against integer validation rules. // Note that because when Go decodes JSON it FORCES float64 on numbers, // this method will return true even if the *type* of the value is // float32/64. We just check that `math.Floor(v) == v` func (ic *IntegerConstraint) Validate(v interface{}) (err error) { if pdebug.Enabled { g := pdebug.IPrintf("START IntegerConstraint.Validate") defer func() { if err == nil { g.IRelease("END IntegerConstraint.Validate (PASS)") } else { g.IRelease("END IntegerConstraint.Validate (FAIL): %s", err) } }() } rv := reflect.ValueOf(v) switch rv.Kind() { case reflect.Interface, reflect.Ptr: rv = rv.Elem() } switch rv.Kind() { case reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64: return ic.NumberConstraint.Validate(float64(rv.Int())) case reflect.Uint, reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64, reflect.Uintptr: return ic.NumberConstraint.Validate(float64(rv.Uint())) case reflect.Float32, reflect.Float64: fv := rv.Float() if math.Floor(fv) != fv { return errors.New("value is not an int/uint") } return ic.NumberConstraint.Validate(fv) default: return errors.New("value is not numeric") } } stripe-mock-0.196.0/vendor/github.com/lestrrat-go/jsval/object.go000066400000000000000000000311651506013555700246540ustar00rootroot00000000000000package jsval import ( "errors" "reflect" "regexp" "github.com/lestrrat-go/pdebug" ) type getPropValuer interface { // Given a JSON property name, return the actual field value GetPropValue(string) (interface{}, error) } type getPropNameser interface { // Given a lst of JSON property names GetPropNames() ([]string, error) } // Object creates a new ObjectConstraint func Object() *ObjectConstraint { return &ObjectConstraint{ additionalProperties: nil, minProperties: -1, maxProperties: -1, patternProperties: make(map[*regexp.Regexp]Constraint), properties: make(map[string]Constraint), propdeps: make(map[string][]string), required: make(map[string]struct{}), schemadeps: make(map[string]Constraint), } } // Required specifies required property names func (o *ObjectConstraint) Required(l ...string) *ObjectConstraint { o.reqlock.Lock() defer o.reqlock.Unlock() for _, pname := range l { o.required[pname] = struct{}{} } return o } // IsPropRequired returns true if the given name is listed under // the required properties func (o *ObjectConstraint) IsPropRequired(s string) bool { o.reqlock.Lock() defer o.reqlock.Unlock() _, ok := o.required[s] return ok } // MinProperties specifies the minimum number of properties this // constraint can allow. If unspecified, it is not checked. func (o *ObjectConstraint) MinProperties(n int) *ObjectConstraint { o.minProperties = n return o } // MaxProperties specifies the maximum number of properties this // constraint can allow. If unspecified, it is not checked. func (o *ObjectConstraint) MaxProperties(n int) *ObjectConstraint { o.maxProperties = n return o } // AdditionalProperties specifies the constraint that additional // properties should be validated against. func (o *ObjectConstraint) AdditionalProperties(c Constraint) *ObjectConstraint { o.additionalProperties = c return o } // AddProp adds constraints for a named property. func (o *ObjectConstraint) AddProp(name string, c Constraint) *ObjectConstraint { o.proplock.Lock() defer o.proplock.Unlock() o.properties[name] = c return o } // PatternProperties specifies constraints that properties matching // this pattern must be validated against. Note that properties listed // using `AddProp` takes precedence. func (o *ObjectConstraint) PatternProperties(key *regexp.Regexp, c Constraint) *ObjectConstraint { o.proplock.Lock() defer o.proplock.Unlock() o.patternProperties[key] = c return o } // PatternPropertiesString is the same as PatternProperties, but takes // a string representing a regular expression. If the regular expression // cannot be compiled, a panic occurs. func (o *ObjectConstraint) PatternPropertiesString(key string, c Constraint) *ObjectConstraint { rx := regexp.MustCompile(key) return o.PatternProperties(rx, c) } // PropDependency specifies properties that must be present when // `from` is present. func (o *ObjectConstraint) PropDependency(from string, to ...string) *ObjectConstraint { o.deplock.Lock() defer o.deplock.Unlock() l := o.propdeps[from] l = append(l, to...) o.propdeps[from] = l return o } // SchemaDependency specifies a schema that the value being validated // must also satisfy. Note that the "object" is the target that needs to // be additionally validated, not the value of the `from` property func (o *ObjectConstraint) SchemaDependency(from string, c Constraint) *ObjectConstraint { o.deplock.Lock() defer o.deplock.Unlock() o.schemadeps[from] = c return o } // GetPropDependencies returns the list of property names that must // be present for given property name `from` func (o *ObjectConstraint) GetPropDependencies(from string) []string { o.deplock.Lock() defer o.deplock.Unlock() l, ok := o.propdeps[from] if !ok { return nil } return l } // GetSchemaDependency returns the Constraint that must be used when // the property `from` is present. func (o *ObjectConstraint) GetSchemaDependency(from string) Constraint { o.deplock.Lock() defer o.deplock.Unlock() c, ok := o.schemadeps[from] if !ok { return nil } return c } var structInfoRegistry = StructInfoRegistry{ registry: make(map[reflect.Type]StructInfo), } // getProps return all of the property names for this object. // XXX Map keys can be something other than strings, but // we can't really allow it? func (o *ObjectConstraint) getPropNames(rv reflect.Value) ([]string, error) { switch rv.Kind() { case reflect.Ptr, reflect.Interface: rv = rv.Elem() } var keys []string switch rv.Kind() { case reflect.Map: vk := rv.MapKeys() keys = make([]string, len(vk)) for i, v := range vk { if v.Kind() != reflect.String { return nil, errors.New("panic: can only handle maps with string keys") } keys[i] = v.String() } case reflect.Struct: if gpv, ok := rv.Interface().(getPropNameser); ok { pv, err := gpv.GetPropNames() if err == nil { return pv, nil } } si, ok := structInfoRegistry.Lookup(rv.Type()) if !ok { si = structInfoRegistry.Register(rv.Type()) } return si.PropNames(rv), nil default: return nil, errors.New("cannot get property names from this value (Kind: " + rv.Kind().String() + ")") } return keys, nil } var ( maybefloatT = reflect.TypeOf(MaybeFloat{}) maybeintT = reflect.TypeOf(MaybeInt{}) intT = reflect.TypeOf(int64(0)) floatT = reflect.TypeOf(float64(0)) ) func coerceValue(v interface{}, t reflect.Type) reflect.Value { vv := reflect.ValueOf(v) switch vv.Kind() { case reflect.Interface: vv = vv.Elem() } // For known Maybe types, we should do our best, too switch { case t == maybefloatT: t = floatT case t == maybeintT: t = intT } if vv.Type().ConvertibleTo(t) { return vv.Convert(t) } return vv } type setPropValuer interface { SetPropValue(string, interface{}) error } var spvType = reflect.TypeOf((*setPropValuer)(nil)).Elem() func (o *ObjectConstraint) setProp(rv reflect.Value, pname string, val interface{}) error { switch rv.Kind() { case reflect.Ptr, reflect.Interface: rv = rv.Elem() } switch rv.Kind() { case reflect.Map: rv.SetMapIndex(reflect.ValueOf(pname), reflect.ValueOf(val)) return nil case reflect.Struct: spvm := rv.MethodByName("SetPropValue") if spvm != zeroval { out := spvm.Call([]reflect.Value{reflect.ValueOf(pname), reflect.ValueOf(val)}) if !out[0].IsNil() { return out[0].Interface().(error) } return nil } f := o.getProp(rv, pname) if f == zeroval { return errors.New("setProp: could not find field '" + pname + "'") } // Usability: If you specify `Default(10)` on an int64 value, // it doesn't work. But these values are compatible. We should // do our best to align them dv := coerceValue(val, f.Type()) // Is this a Maybe value? If so, we should use its Set() method var mv reflect.Value switch { case f.Type().Implements(maybeif): mv = f.MethodByName("Set") case f.CanAddr() && f.Addr().Type().Implements(maybeif): mv = f.Addr().MethodByName("Set") default: f.Set(dv) return nil } if mv == zeroval { return errors.New("setProp: could not get 'Set' method for value") } out := mv.Call([]reflect.Value{dv}) if !out[0].IsNil() { return out[0].Interface().(error) } return nil default: return errors.New("setProp: don't know what to do with '" + rv.Kind().String() + "'") } } func (o *ObjectConstraint) getProp(rv reflect.Value, pname string) reflect.Value { switch rv.Kind() { case reflect.Map: pv := reflect.ValueOf(pname) return rv.MapIndex(pv) case reflect.Struct: // This guy knows how to grab the value, given a name. Use that if gpv, ok := rv.Interface().(getPropValuer); ok { pv, err := gpv.GetPropValue(pname) if err == nil { return reflect.ValueOf(pv) } } si, ok := structInfoRegistry.Lookup(rv.Type()) if !ok { si = structInfoRegistry.Register(rv.Type()) } fn, ok := si.FieldName(pname) if !ok { if pdebug.Enabled { pdebug.Printf("Could not resolve name '%s'", pname) } return zeroval } return rv.FieldByName(fn) default: return zeroval } } // Validate validates the given value against this ObjectConstraint func (o *ObjectConstraint) Validate(v interface{}) (err error) { if pdebug.Enabled { g := pdebug.IPrintf("START ObjectConstraint.Validate") defer func() { if err == nil { g.IRelease("END ObjectConstraint.Validate (PASS)") } else { g.IRelease("END ObjectConstraint.Validate (FAIL): %s", err) } }() } rv := reflect.ValueOf(v) switch rv.Kind() { case reflect.Ptr, reflect.Interface: rv = rv.Elem() } fields, err := o.getPropNames(rv) if err != nil { return err } lf := len(fields) if o.minProperties > -1 && lf < o.minProperties { return errors.New("fewer properties than minProperties") } if o.maxProperties > -1 && lf > o.maxProperties { return errors.New("more properties than maxProperties") } // Find the list of field names that were passed to us // "premain" shows extra props, if any. // "pseen" shows props that we have already seen premain := map[string]struct{}{} pseen := map[string]struct{}{} for _, k := range fields { premain[k] = struct{}{} } // Now, for all known constraints, validate the prop // create a copy of properties so that we don't have to keep the lock propdefs := make(map[string]Constraint) o.proplock.Lock() for pname, c := range o.properties { propdefs[pname] = c } o.proplock.Unlock() for pname, c := range propdefs { if pdebug.Enabled { pdebug.Printf("Validating property '%s'", pname) } pval := o.getProp(rv, pname) propExists := false switch { case pval == zeroval: // If we got a zeroval, we're done for. case pval.Type().Implements(maybeif) || reflect.PtrTo(pval.Type()).Implements(maybeif): // If we have a Maybe value, we check the Valid() flag mv := pval.MethodByName("Valid") out := mv.Call(nil) if out[0].Bool() { propExists = true // Swap out pval to be the value pointed to by the Maybe value mv = pval.MethodByName("Value") out = mv.Call(nil) pval = out[0] } default: // Everything else, we have *something* propExists = true } if !propExists { if pdebug.Enabled { pdebug.Printf("Property '%s' does not exist", pname) } if o.IsPropRequired(pname) { // required, and not present. return errors.New("object property '" + pname + "' is required") } // At this point we know that the property was not present // and that this field was indeed not required. if c.HasDefault() { if pdebug.Enabled { pdebug.Printf("object property '" + pname + "' has default") } // We have default dv := c.DefaultValue() if err := o.setProp(rv, pname, dv); err != nil { return errors.New("failed to set default value for property '" + pname + "': " + err.Error()) } pval = reflect.ValueOf(dv) } continue } // delete from remaining props delete(premain, pname) // ...and add to props that we have seen pseen[pname] = struct{}{} if err := c.Validate(pval.Interface()); err != nil { return errors.New("object property '" + pname + "' validation failed: " + err.Error()) } } for pat, c := range o.patternProperties { if pdebug.Enabled { pdebug.Printf("Checking patternProperty '%s'", pat.String()) } for pname := range premain { if !pat.MatchString(pname) { if pdebug.Enabled { pdebug.Printf("Property '%s' does not match pattern...", pname) } continue } if pdebug.Enabled { pdebug.Printf("Property '%s' matches!", pname) } // No need to check if this pname exists, as we're taking // this from "premain" pval := o.getProp(rv, pname) delete(premain, pname) pseen[pname] = struct{}{} if err := c.Validate(pval.Interface()); err != nil { return errors.New("object property '" + pname + "' validation failed: " + err.Error()) } } } if len(premain) > 0 { c := o.additionalProperties if c == nil { return errors.New("additional properties are not allowed") } for pname := range premain { pval := o.getProp(rv, pname) if err := c.Validate(pval.Interface()); err != nil { return errors.New("object property for '" + pname + "' validation failed: " + err.Error()) } } } for pname := range pseen { if deps := o.GetPropDependencies(pname); len(deps) > 0 { if pdebug.Enabled { pdebug.Printf("Property '%s' has dependencies", pname) } for _, dep := range deps { if _, ok := pseen[dep]; !ok { return errors.New("required dependency '" + dep + "' is mising") } } // can't, and shouldn't do object validation after checking prop deps continue } if depc := o.GetSchemaDependency(pname); depc != nil { if err := depc.Validate(v); err != nil { return err } } } return nil } stripe-mock-0.196.0/vendor/github.com/lestrrat-go/jsval/reference.go000066400000000000000000000070471506013555700253460ustar00rootroot00000000000000package jsval import ( "errors" "sync" "github.com/lestrrat-go/pdebug" ) // RefResolver is a mandatory object that you must pass to a // ReferenceConstraint upon its creation. This is responsible // for resolving the reference to an actual constraint. type RefResolver interface { GetReference(string) (Constraint, error) } // ConstraintMap is an implementation of RefResolver type ConstraintMap struct { lock sync.Mutex refs map[string]Constraint } // Len returns the number of references stored in this ConstraintMap func (cm ConstraintMap) Len() int { return len(cm.refmap()) } func (cm *ConstraintMap) refmap() map[string]Constraint { if cm.refs == nil { cm.refs = make(map[string]Constraint) } return cm.refs } // SetReference registeres a new Constraint to a name func (cm *ConstraintMap) SetReference(name string, c Constraint) { cm.lock.Lock() defer cm.lock.Unlock() refs := cm.refmap() refs[name] = c } // GetReference fetches the Constraint associated with the given name func (cm *ConstraintMap) GetReference(name string) (Constraint, error) { cm.lock.Lock() defer cm.lock.Unlock() refs := cm.refmap() c, ok := refs[name] if !ok { return nil, errors.New("reference '" + name + "' not found") } return c, nil } // ReferenceConstraint is a constraint where its actual definition // is stored elsewhere. type ReferenceConstraint struct { resolver RefResolver lock sync.Mutex resolved Constraint reference string } // Reference creates a new ReferenceConstraint object func Reference(resolver RefResolver) *ReferenceConstraint { return &ReferenceConstraint{ resolver: resolver, } } // Resolved returns the Constraint obtained by resolving // the reference. func (r *ReferenceConstraint) Resolved() (c Constraint, err error) { if pdebug.Enabled { g := pdebug.IPrintf("START ReferenceConstraint.Resolved '%s'", r.reference) defer func() { if err == nil { g.IRelease("END ReferenceConstraint.Resolved '%s' (OK)", r.reference) } else { g.IRelease("END ReferenceConstraint.Resolved '%s' (FAIL): %s", r.reference, err) } }() } r.lock.Lock() defer r.lock.Unlock() if r.resolved != nil { if pdebug.Enabled { pdebug.Printf("Reference is already resolved") } return r.resolved, nil } c, err = r.resolver.GetReference(r.reference) if err != nil { return nil, err } r.resolved = c return c, nil } // RefersTo specifies the reference string that this constraint points to func (r *ReferenceConstraint) RefersTo(s string) *ReferenceConstraint { r.reference = s return r } // Default is a no op for this type func (r *ReferenceConstraint) Default(_ interface{}) { } // DefaultValue returns the default value from the constraint pointed // by the reference func (r *ReferenceConstraint) DefaultValue() interface{} { c, err := r.Resolved() if err != nil { return nil } return c.DefaultValue() } // HasDefault returns true if the constraint pointed by the reference // has defaults func (r *ReferenceConstraint) HasDefault() bool { c, err := r.Resolved() if err != nil { return false } return c.HasDefault() } // Validate validates the value against the constraint pointed to // by the reference. func (r *ReferenceConstraint) Validate(v interface{}) (err error) { if pdebug.Enabled { g := pdebug.IPrintf("START ReferenceConstraint.Validate") defer func() { if err == nil { g.IRelease("END ReferenceConstraint.Validate (PASS)") } else { g.IRelease("END ReferenceConstraint.Validate (FAIL): %s", err) } }() } c, err := r.Resolved() if err != nil { return err } return c.Validate(v) }stripe-mock-0.196.0/vendor/github.com/lestrrat-go/jsval/schema.json000066400000000000000000000104271506013555700252100ustar00rootroot00000000000000{ "id": "http://json-schema.org/draft-04/schema#", "$schema": "http://json-schema.org/draft-04/schema#", "description": "Core schema meta-schema", "definitions": { "schemaArray": { "type": "array", "minItems": 1, "items": { "$ref": "#" } }, "positiveInteger": { "type": "integer", "minimum": 0 }, "positiveIntegerDefault0": { "allOf": [ { "$ref": "#/definitions/positiveInteger" }, { "default": 0 } ] }, "simpleTypes": { "enum": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "stringArray": { "type": "array", "items": { "type": "string" }, "minItems": 1, "uniqueItems": true } }, "type": "object", "properties": { "id": { "type": "string", "format": "uri" }, "$schema": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "description": { "type": "string" }, "default": {}, "multipleOf": { "type": "number", "minimum": 0, "exclusiveMinimum": true }, "maximum": { "type": "number" }, "exclusiveMaximum": { "type": "boolean", "default": false }, "minimum": { "type": "number" }, "exclusiveMinimum": { "type": "boolean", "default": false }, "maxLength": { "$ref": "#/definitions/positiveInteger" }, "minLength": { "$ref": "#/definitions/positiveIntegerDefault0" }, "pattern": { "type": "string", "format": "regex" }, "additionalItems": { "anyOf": [ { "type": "boolean" }, { "$ref": "#" } ], "default": {} }, "items": { "anyOf": [ { "$ref": "#" }, { "$ref": "#/definitions/schemaArray" } ], "default": {} }, "maxItems": { "$ref": "#/definitions/positiveInteger" }, "minItems": { "$ref": "#/definitions/positiveIntegerDefault0" }, "uniqueItems": { "type": "boolean", "default": false }, "maxProperties": { "$ref": "#/definitions/positiveInteger" }, "minProperties": { "$ref": "#/definitions/positiveIntegerDefault0" }, "required": { "$ref": "#/definitions/stringArray" }, "additionalProperties": { "anyOf": [ { "type": "boolean" }, { "$ref": "#" } ], "default": {} }, "definitions": { "type": "object", "additionalProperties": { "$ref": "#" }, "default": {} }, "properties": { "type": "object", "additionalProperties": { "$ref": "#" }, "default": {} }, "patternProperties": { "type": "object", "additionalProperties": { "$ref": "#" }, "default": {} }, "dependencies": { "type": "object", "additionalProperties": { "anyOf": [ { "$ref": "#" }, { "$ref": "#/definitions/stringArray" } ] } }, "enum": { "type": "array", "minItems": 1, "uniqueItems": true }, "type": { "anyOf": [ { "$ref": "#/definitions/simpleTypes" }, { "type": "array", "items": { "$ref": "#/definitions/simpleTypes" }, "minItems": 1, "uniqueItems": true } ] }, "allOf": { "$ref": "#/definitions/schemaArray" }, "anyOf": { "$ref": "#/definitions/schemaArray" }, "oneOf": { "$ref": "#/definitions/schemaArray" }, "not": { "$ref": "#" } }, "dependencies": { "exclusiveMaximum": [ "maximum" ], "exclusiveMinimum": [ "minimum" ] }, "default": {} } stripe-mock-0.196.0/vendor/github.com/lestrrat-go/jsval/string.go000066400000000000000000000123031506013555700247050ustar00rootroot00000000000000package jsval import ( "errors" "net" "net/mail" "net/url" "reflect" "regexp" "strconv" "time" "github.com/lestrrat-go/pdebug" ) // Default sets the default value for this constraint. func (sc *StringConstraint) Default(v interface{}) *StringConstraint { sc.defaultValue.initialized = true sc.defaultValue.value = v return sc } // Validate runs the validation against the incoming value. // Note that StringConstraint does not apply default values to the // incoming string value, because the Zero value for string ("") // can be a perfectly reasonable value. // // The caller is the only person who can determine if a string // value is "unavailable" func (sc *StringConstraint) Validate(v interface{}) (err error) { if pdebug.Enabled { g := pdebug.IPrintf("START StringConstraint.Validate") defer func() { if err == nil { g.IRelease("END StringConstraint.Validate (PASS)") } else { g.IRelease("END StringConstraint.Validate (FAIL): %s", err) } }() } rv := reflect.ValueOf(v) switch rv.Kind() { case reflect.Ptr, reflect.Interface: rv = rv.Elem() } switch rv.Kind() { case reflect.String: default: return errors.New("value is not a string (Kind: " + rv.Kind().String() + ")") } str := rv.String() ls := len(str) if sc.maxLength > -1 { if pdebug.Enabled { pdebug.Printf("Checking MaxLength (%d)", sc.maxLength) } if ls > sc.maxLength { return errors.New("string longer than maxLength " + strconv.Itoa(sc.maxLength)) } } if sc.minLength > -1 { if pdebug.Enabled { pdebug.Printf("Checking MinLength (%d)", sc.minLength) } if ls < sc.minLength { return errors.New("string shorter than minLength " + strconv.Itoa(sc.minLength)) } } switch sc.format { case "datetime": if _, err = time.Parse(time.RFC3339, str); err != nil { return errors.New("invalid datetime") } case "email": if _, err = mail.ParseAddress(str); err != nil { return errors.New("invalid email address: " + err.Error()) } case "hostname": if !isDomainName(str) { return errors.New("invalid hostname") } case "ipv4": // Should only contain numbers and "." for _, r := range str { switch { case r == 0x2E || 0x30 <= r && r <= 0x39: default: return errors.New("invalid IPv4 address") } } if addr := net.ParseIP(str); addr == nil { return errors.New("invalid IPv4 address") } case "ipv6": // Should only contain numbers and ":" for _, r := range str { switch { case r == 0x3A || 0x30 <= r && r <= 0x39: default: return errors.New("invalid IPv6 address") } } if addr := net.ParseIP(str); addr == nil { return errors.New("invalid IPv6 address") } case "uri": if _, err = url.Parse(str); err != nil { return errors.New("invalid URI") } } if rx := sc.regexp; rx != nil { if pdebug.Enabled { pdebug.Printf("Checking Regexp (rs: %s, target: %s)", rx.String(), str) } if !rx.MatchString(str) { return errors.New("string '" + str + "' does not match regular expression '" + rx.String() + "'") } } if enum := sc.enums; enum != nil { if err := enum.Validate(str); err != nil { return err } } return nil } // stolen from src/net/dnsclient.go func isDomainName(s string) bool { // See RFC 1035, RFC 3696. if len(s) == 0 { return false } if len(s) > 255 { return false } last := byte('.') ok := false // Ok once we've seen a letter. partlen := 0 for i := 0; i < len(s); i++ { c := s[i] switch { default: return false case 'a' <= c && c <= 'z' || 'A' <= c && c <= 'Z' || c == '_': ok = true partlen++ case '0' <= c && c <= '9': // fine partlen++ case c == '-': // Byte before dash cannot be dot. if last == '.' { return false } partlen++ case c == '.': // Byte before dot cannot be dot, dash. if last == '.' || last == '-' { return false } if partlen > 63 || partlen == 0 { return false } partlen = 0 } last = c } if last == '-' || partlen > 63 { return false } return ok } // Enum specifies the enumeration of the possible values func (sc *StringConstraint) Enum(l ...interface{}) *StringConstraint { if sc.enums == nil { sc.enums = Enum() } sc.enums.Enum(l...) return sc } // MaxLength specifies the maximum length the passed value can have func (sc *StringConstraint) MaxLength(l int) *StringConstraint { sc.maxLength = l return sc } // MinLength specifies the minimum length the passed value must have func (sc *StringConstraint) MinLength(l int) *StringConstraint { sc.minLength = l return sc } // RegexpString is the same as Regexp method, except this one // takes a string and compiles it. func (sc *StringConstraint) RegexpString(pat string) *StringConstraint { return sc.Regexp(regexp.MustCompile(pat)) } // Regexp specifies the `*regexp.Regexp` object that passed value // must conform to func (sc *StringConstraint) Regexp(rx *regexp.Regexp) *StringConstraint { sc.regexp = rx return sc } // Format specifies the format that passed value must conform to func (sc *StringConstraint) Format(f string) *StringConstraint { sc.format = f return sc } // String creates a new StringConstraint. It unfortunately overlaps // the `Stringer` interface :/ func String() *StringConstraint { return &StringConstraint{ maxLength: -1, } } stripe-mock-0.196.0/vendor/github.com/lestrrat-go/jsval/structinfo.go000066400000000000000000000065121506013555700256040ustar00rootroot00000000000000package jsval import ( "reflect" "sync" "github.com/lestrrat-go/pdebug" ) type PropInfo struct { // Name of the Field that maps to this property FieldName string // IsMaybe is true if this property implements the Maybe interface IsMaybe bool } type StructInfo struct { lock sync.RWMutex props map[string]PropInfo } type StructInfoRegistry struct { lock sync.RWMutex registry map[reflect.Type]StructInfo } func (si *StructInfo) FieldName(pname string) (string, bool) { si.lock.RLock() defer si.lock.RUnlock() pinfo, ok := si.props[pname] if !ok { return "", false } return pinfo.FieldName, true } // Gets the list of property names for this particuar instance of a // struct. Uninitialized types are not considered, so we remove // them depending on the state of this instance of the struct func (si *StructInfo) PropNames(rv reflect.Value) []string { si.lock.RLock() defer si.lock.RUnlock() pnames := make([]string, 0, len(si.props)) for pname, pinfo := range si.props { if pinfo.IsMaybe { fv := rv.FieldByName(pinfo.FieldName) mv := fv.MethodByName("Valid") out := mv.Call(nil) if !out[0].Bool() { continue } } pnames = append(pnames, pname) } return pnames } func (r *StructInfoRegistry) Lookup(t reflect.Type) (StructInfo, bool) { switch t.Kind() { case reflect.Ptr, reflect.Interface: t = t.Elem() } r.lock.RLock() si, ok := r.registry[t] r.lock.RUnlock() return si, ok } func (r *StructInfoRegistry) Register(t reflect.Type) StructInfo { if pdebug.Enabled { g := pdebug.Marker("StructInfoRegistry.Register (%s)", t.Name()) defer g.End() } switch t.Kind() { case reflect.Ptr, reflect.Interface: t = t.Elem() } r.lock.RLock() si, ok := r.registry[t] r.lock.RUnlock() if ok { return si } props := extract(t) if pdebug.Enabled { pdebug.Printf("Extracted struct with the following properties:") for pname, pinfo := range props { if pinfo.IsMaybe { pdebug.Printf("%s -> %s (Maybe)", pname, pinfo.FieldName) } else { pdebug.Printf("%s -> %s", pname, pinfo.FieldName) } } } si = StructInfo{props: props} r.lock.Lock() r.registry[t] = si r.lock.Unlock() return si } var maybeif = reflect.TypeOf((*Maybe)(nil)).Elem() func extract(t reflect.Type) map[string]PropInfo { props := make(map[string]PropInfo) for i := 0; i < t.NumField(); i++ { fv := t.Field(i) if fv.Anonymous { info := extract(fv.Type) for k, v := range info { props[k] = v } continue } if fv.PkgPath != "" { // not exported continue } // Inspect the JSON struct tag so we know what they want to call // this field from JSON. tag := fv.Tag.Get("json") if tag == "-" { // "Ignore me", says the struct continue } // Inspect the field type. If this field implements the Maybe // interface, we want to remember it isMaybe := fv.Type.Implements(maybeif) || reflect.PtrTo(fv.Type).Implements(maybeif) if pdebug.Enabled { pdebug.Printf("Checking if field '%s' implements the Maybe interface -> %t", fv.Name, isMaybe) } if tag == "" || tag[0] == ',' { props[fv.Name] = PropInfo{ FieldName: fv.Name, IsMaybe: isMaybe, } continue } flen := 0 for j := 0; j < len(tag); j++ { if tag[j] == ',' { break } flen = j } props[tag[:flen+1]] = PropInfo{ FieldName: fv.Name, IsMaybe: isMaybe, } } return props } stripe-mock-0.196.0/vendor/github.com/lestrrat-go/pdebug/000077500000000000000000000000001506013555700232005ustar00rootroot00000000000000stripe-mock-0.196.0/vendor/github.com/lestrrat-go/pdebug/.gitignore000066400000000000000000000004121506013555700251650ustar00rootroot00000000000000# Compiled Object files, Static and Dynamic libs (Shared Objects) *.o *.a *.so # Folders _obj _test # Architecture specific extensions/prefixes *.[568vq] [568vq].out *.cgo1.go *.cgo2.c _cgo_defun.c _cgo_gotypes.go _cgo_export.* _testmain.go *.exe *.test *.prof stripe-mock-0.196.0/vendor/github.com/lestrrat-go/pdebug/.travis.yml000066400000000000000000000004221506013555700253070ustar00rootroot00000000000000language: go sudo: false go: - 1.6 - 1.7 - tip install: - go get -t -v ./... - go get -t -tags debug0 -v ./... script: - go test -v ./... - go test -tags debug ./... - PDEBUG_TRACE=1 go test -tags debug ./... - go test -tags debug0 ./... stripe-mock-0.196.0/vendor/github.com/lestrrat-go/pdebug/LICENSE000066400000000000000000000020631506013555700242060ustar00rootroot00000000000000The MIT License (MIT) Copyright (c) 2016 lestrrat Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. stripe-mock-0.196.0/vendor/github.com/lestrrat-go/pdebug/README.md000066400000000000000000000040531506013555700244610ustar00rootroot00000000000000# go-pdebug [![Build Status](https://travis-ci.org/lestrrat-go/pdebug.svg?branch=master)](https://travis-ci.org/lestrrat-go/pdebug) [![GoDoc](https://godoc.org/github.com/lestrrat-go/pdebug?status.svg)](https://godoc.org/github.com/lestrrat-go/pdebug) Utilities for my print debugging fun. YMMV # Synopsis ![optimized](https://pbs.twimg.com/media/CbiqhzLUUAIN_7o.png) # Description Building with `pdebug` declares a constant, `pdebug.Enabled` which you can use to easily compile in/out depending on the presence of a build tag. ```go func Foo() { // will only be available if you compile with `-tags debug` if pdebug.Enabled { pdebug.Printf("Starting Foo()! } } ``` Note that using `github.com/lestrrat-go/pdebug` and `-tags debug` only compiles in the code. In order to actually show the debug trace, you need to specify an environment variable: ```shell # For example, to show debug code during testing: PDEBUG_TRACE=1 go test -tags debug ``` If you want to forcefully show the trace (which is handy when you're debugging/testing), you can use the `debug0` tag instead: ```shell go test -tags debug0 ``` # Markers When you want to print debug a chain of function calls, you can use the `Marker` functions: ```go func Foo() { if pdebug.Enabled { g := pdebug.Marker("Foo") defer g.End() } pdebug.Printf("Inside Foo()!") } ``` This will cause all of the `Printf` calls to automatically indent the output so it's visually easier to see where a certain trace log is being generated. By default it will print something like: ``` |DEBUG| START Foo |DEBUG| Inside Foo()! |DEBUG| END Foo (1.23μs) ``` If you want to automatically show the error value you are returning (but only if there is an error), you can use the `BindError` method: ```go func Foo() (err error) { if pdebug.Enabled { g := pdebug.Marker("Foo").BindError(&err) defer g.End() } pdebug.Printf("Inside Foo()!") return errors.New("boo") } ``` This will print something like: ``` |DEBUG| START Foo |DEBUG| Inside Foo()! |DEBUG| END Foo (1.23μs): ERROR boo ``` stripe-mock-0.196.0/vendor/github.com/lestrrat-go/pdebug/autoflag_off.go000066400000000000000000000002771506013555700261710ustar00rootroot00000000000000// +build debug package pdebug import ( "os" "strconv" ) var Trace = false func init() { if b, err := strconv.ParseBool(os.Getenv("PDEBUG_TRACE")); err == nil && b { Trace = true } }stripe-mock-0.196.0/vendor/github.com/lestrrat-go/pdebug/autoflag_on.go000066400000000000000000000000641506013555700260250ustar00rootroot00000000000000// +build debug0 package pdebug var Trace = true stripe-mock-0.196.0/vendor/github.com/lestrrat-go/pdebug/common.go000066400000000000000000000007771506013555700250320ustar00rootroot00000000000000package pdebug import ( "io" "os" "sync" "time" ) type pdctx struct { mutex sync.Mutex indentL int LogTime bool Prefix string Writer io.Writer } var emptyMarkerGuard = &markerg{} type markerg struct { indentg guard ctx *pdctx f string args []interface{} start time.Time errptr *error } var DefaultCtx = &pdctx{ LogTime: true, Prefix: "|DEBUG| ", Writer: os.Stdout, } type guard struct { cb func() } func (g *guard) End() { if cb := g.cb; cb != nil { cb() } } stripe-mock-0.196.0/vendor/github.com/lestrrat-go/pdebug/debug_off.go000066400000000000000000000030051506013555700254450ustar00rootroot00000000000000//+build !debug,!debug0 package pdebug // Enabled is true if `-tags debug` or `-tags debug0` is used // during compilation. Use this to "ifdef-out" debug blocks. const Enabled = false // Trace is true if `-tags debug` is used AND the environment // variable `PDEBUG_TRACE` is set to a `true` value (i.e., // 1, true, etc), or `-tags debug0` is used. This allows you to // compile-in the trace logs, but only show them when you // set the environment variable const Trace = false // IRelease is deprecated. Use Marker()/End() instead func (g guard) IRelease(f string, args ...interface{}) {} // IPrintf is deprecated. Use Marker()/End() instead func IPrintf(f string, args ...interface{}) guard { return guard{} } // Printf prints to standard out, just like a normal fmt.Printf, // but respects the indentation level set by IPrintf/IRelease. // Printf is no op unless you compile with the `debug` tag. func Printf(f string, args ...interface{}) {} // Dump dumps the objects using go-spew. // Dump is a no op unless you compile with the `debug` tag. func Dump(v ...interface{}) {} // Marker marks the beginning of an indented block. The message // you specify in the arguments is prefixed witha "START", and // subsequent calls to Printf will be indented one level more. // // To reset this, you must call End() on the guard object that // gets returned by Marker(). func Marker(f string, args ...interface{}) *markerg { return emptyMarkerGuard } func (g *markerg) BindError(_ *error) *markerg { return g } func (g *markerg) End() {} stripe-mock-0.196.0/vendor/github.com/lestrrat-go/pdebug/debug_on.go000066400000000000000000000055551506013555700253230ustar00rootroot00000000000000// +build debug OR debug0 package pdebug import ( "bytes" "fmt" "strings" "time" "github.com/davecgh/go-spew/spew" ) const Enabled = true type Guard interface { End() } var emptyGuard = &guard{} func (ctx *pdctx) Unindent() { ctx.mutex.Lock() defer ctx.mutex.Unlock() ctx.indentL-- } func (ctx *pdctx) Indent() guard { ctx.mutex.Lock() ctx.indentL++ ctx.mutex.Unlock() return guard{cb: ctx.Unindent} } func (ctx *pdctx) preamble(buf *bytes.Buffer) { if p := ctx.Prefix; len(p) > 0 { buf.WriteString(p) } if ctx.LogTime { fmt.Fprintf(buf, "%0.5f ", float64(time.Now().UnixNano()) / 1000000.0) } for i := 0; i < ctx.indentL; i++ { buf.WriteString(" ") } } func (ctx *pdctx) Printf(f string, args ...interface{}) { if !strings.HasSuffix(f, "\n") { f = f + "\n" } buf := bytes.Buffer{} ctx.preamble(&buf) fmt.Fprintf(&buf, f, args...) buf.WriteTo(ctx.Writer) } func Marker(f string, args ...interface{}) *markerg { return DefaultCtx.Marker(f, args...) } func (ctx *pdctx) Marker(f string, args ...interface{}) *markerg { if !Trace { return emptyMarkerGuard } buf := &bytes.Buffer{} ctx.preamble(buf) buf.WriteString("START ") fmt.Fprintf(buf, f, args...) if buf.Len() > 0 { if b := buf.Bytes(); b[buf.Len()-1] != '\n' { buf.WriteRune('\n') } } buf.WriteTo(ctx.Writer) g := ctx.Indent() return &markerg{ indentg: g, ctx: ctx, f: f, args: args, start: time.Now(), errptr: nil, } } func (g *markerg) BindError(errptr *error) *markerg { if g.ctx == nil { return g } g.ctx.mutex.Lock() defer g.ctx.mutex.Unlock() g.errptr = errptr return g } func (g *markerg) End() { if g.ctx == nil { return } g.indentg.End() // unindent buf := &bytes.Buffer{} g.ctx.preamble(buf) fmt.Fprint(buf, "END ") fmt.Fprintf(buf, g.f, g.args...) fmt.Fprintf(buf, " (%s)", time.Since(g.start)) if errptr := g.errptr; errptr != nil && *errptr != nil { fmt.Fprintf(buf, ": ERROR: %s", *errptr) } if buf.Len() > 0 { if b := buf.Bytes(); b[buf.Len()-1] != '\n' { buf.WriteRune('\n') } } buf.WriteTo(g.ctx.Writer) } type legacyg struct { guard start time.Time } var emptylegacyg = legacyg{} func (g legacyg) IRelease(f string, args ...interface{}) { if !Trace { return } g.End() dur := time.Since(g.start) Printf("%s (%s)", fmt.Sprintf(f, args...), dur) } // IPrintf indents and then prints debug messages. Execute the callback // to undo the indent func IPrintf(f string, args ...interface{}) legacyg { if !Trace { return emptylegacyg } DefaultCtx.Printf(f, args...) g := legacyg{ guard: DefaultCtx.Indent(), start: time.Now(), } return g } // Printf prints debug messages. Only available if compiled with "debug" tag func Printf(f string, args ...interface{}) { if !Trace { return } DefaultCtx.Printf(f, args...) } func Dump(v ...interface{}) { if !Trace { return } spew.Dump(v...) } stripe-mock-0.196.0/vendor/github.com/lestrrat-go/pdebug/doc.go000066400000000000000000000013521506013555700242750ustar00rootroot00000000000000// Package pdebug provides tools to produce debug logs the way the author // (Daisuke Maki a.k.a. lestrrat) likes. All of the functions are no-ops // unless you compile with the `-tags debug` option. // // When you compile your program with `-tags debug`, no trace is displayed, // but the code enclosed within `if pdebug.Enabled { ... }` is compiled in. // To show the debug trace, set the PDEBUG_TRACE environment variable to // true (or 1, or whatever `strconv.ParseBool` parses to true) // // If you want to show the debug trace regardless of an environment variable, // for example, perhaps while you are debugging or running tests, use the // `-tags debug0` build tag instead. This will enable the debug trace // forcefully package pdebug stripe-mock-0.196.0/vendor/github.com/lestrrat-go/structinfo/000077500000000000000000000000001506013555700241325ustar00rootroot00000000000000stripe-mock-0.196.0/vendor/github.com/lestrrat-go/structinfo/.gitignore000066400000000000000000000004121506013555700261170ustar00rootroot00000000000000# Compiled Object files, Static and Dynamic libs (Shared Objects) *.o *.a *.so # Folders _obj _test # Architecture specific extensions/prefixes *.[568vq] [568vq].out *.cgo1.go *.cgo2.c _cgo_defun.c _cgo_gotypes.go _cgo_export.* _testmain.go *.exe *.test *.prof stripe-mock-0.196.0/vendor/github.com/lestrrat-go/structinfo/.travis.yml000066400000000000000000000000611506013555700262400ustar00rootroot00000000000000language: go sudo: false go: - 1.5 - tip stripe-mock-0.196.0/vendor/github.com/lestrrat-go/structinfo/LICENSE000066400000000000000000000020631506013555700251400ustar00rootroot00000000000000The MIT License (MIT) Copyright (c) 2016 lestrrat Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. stripe-mock-0.196.0/vendor/github.com/lestrrat-go/structinfo/README.md000066400000000000000000000004541506013555700254140ustar00rootroot00000000000000# structinfo [![Build Status](https://travis-ci.org/lestrrat-go/structinfo.svg?branch=master)](https://travis-ci.org/lestrrat-go/structinfo) [![GoDoc](https://godoc.org/github.com/lestrrat-go/structinfo?status.svg)](https://godoc.org/github.com/lestrrat-go/structinfo) Tools to inspect Go structs stripe-mock-0.196.0/vendor/github.com/lestrrat-go/structinfo/structinfo.go000066400000000000000000000041611506013555700266630ustar00rootroot00000000000000// Package structinfo contains tools to inspect structs. package structinfo import ( "reflect" "sync" ) type jsonFieldMap struct { lock sync.Mutex fields map[string]string } var type2jfm = map[reflect.Type]jsonFieldMap{} var type2jfmMutex = sync.Mutex{} // JSONFieldsFromStruct returns the names of JSON fields associated // with the given struct. Returns nil if v is not a struct func JSONFieldsFromStruct(v reflect.Value) []string { if v.Kind() != reflect.Struct { return nil } m := getType2jfm(v.Type()) m.lock.Lock() defer m.lock.Unlock() l := make([]string, 0, len(m.fields)) for k := range m.fields { l = append(l, k) } return l } // StructFieldFromJSONName returns the struct field name on the // given struct value. Empty value means the field is either not // public, or does not exist. // // This can be used to map JSON field names to actual struct fields. func StructFieldFromJSONName(v reflect.Value, name string) string { if v.Kind() != reflect.Struct { return "" } m := getType2jfm(v.Type()) m.lock.Lock() defer m.lock.Unlock() s, ok := m.fields[name] if !ok { return "" } return s } func getType2jfm(t reflect.Type) jsonFieldMap { type2jfmMutex.Lock() defer type2jfmMutex.Unlock() return getType2jfm_nolock(t) } func getType2jfm_nolock(t reflect.Type) jsonFieldMap { fm, ok := type2jfm[t] if ok { return fm } fm = constructJfm(t) type2jfm[t] = fm return fm } func constructJfm(t reflect.Type) jsonFieldMap { if t.Kind() == reflect.Ptr { t = t.Elem() } fm := jsonFieldMap{ fields: make(map[string]string), } for i := 0; i < t.NumField(); i++ { sf := t.Field(i) if sf.Anonymous { // embedded! got to recurse fm2 := getType2jfm_nolock(sf.Type) for k, v := range fm2.fields { fm.fields[k] = v } continue } if sf.PkgPath != "" { // unexported continue } tag := sf.Tag.Get("json") if tag == "-" { continue } if tag == "" || tag[0] == ',' { fm.fields[sf.Name] = sf.Name continue } flen := 0 for j := 0; j < len(tag); j++ { if tag[j] == ',' { break } flen = j } fm.fields[tag[:flen+1]] = sf.Name } return fm }stripe-mock-0.196.0/vendor/github.com/pkg/000077500000000000000000000000001506013555700202505ustar00rootroot00000000000000stripe-mock-0.196.0/vendor/github.com/pkg/errors/000077500000000000000000000000001506013555700215645ustar00rootroot00000000000000stripe-mock-0.196.0/vendor/github.com/pkg/errors/.gitignore000066400000000000000000000004121506013555700235510ustar00rootroot00000000000000# Compiled Object files, Static and Dynamic libs (Shared Objects) *.o *.a *.so # Folders _obj _test # Architecture specific extensions/prefixes *.[568vq] [568vq].out *.cgo1.go *.cgo2.c _cgo_defun.c _cgo_gotypes.go _cgo_export.* _testmain.go *.exe *.test *.prof stripe-mock-0.196.0/vendor/github.com/pkg/errors/.travis.yml000066400000000000000000000002171506013555700236750ustar00rootroot00000000000000language: go go_import_path: github.com/pkg/errors go: - 1.4.x - 1.5.x - 1.6.x - 1.7.x - 1.8.x - tip script: - go test -v ./... stripe-mock-0.196.0/vendor/github.com/pkg/errors/LICENSE000066400000000000000000000024401506013555700225710ustar00rootroot00000000000000Copyright (c) 2015, Dave Cheney All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. stripe-mock-0.196.0/vendor/github.com/pkg/errors/README.md000066400000000000000000000043021506013555700230420ustar00rootroot00000000000000# errors [![Travis-CI](https://travis-ci.org/pkg/errors.svg)](https://travis-ci.org/pkg/errors) [![AppVeyor](https://ci.appveyor.com/api/projects/status/b98mptawhudj53ep/branch/master?svg=true)](https://ci.appveyor.com/project/davecheney/errors/branch/master) [![GoDoc](https://godoc.org/github.com/pkg/errors?status.svg)](http://godoc.org/github.com/pkg/errors) [![Report card](https://goreportcard.com/badge/github.com/pkg/errors)](https://goreportcard.com/report/github.com/pkg/errors) Package errors provides simple error handling primitives. `go get github.com/pkg/errors` The traditional error handling idiom in Go is roughly akin to ```go if err != nil { return err } ``` which applied recursively up the call stack results in error reports without context or debugging information. The errors package allows programmers to add context to the failure path in their code in a way that does not destroy the original value of the error. ## Adding context to an error The errors.Wrap function returns a new error that adds context to the original error. For example ```go _, err := ioutil.ReadAll(r) if err != nil { return errors.Wrap(err, "read failed") } ``` ## Retrieving the cause of an error Using `errors.Wrap` constructs a stack of errors, adding context to the preceding error. Depending on the nature of the error it may be necessary to reverse the operation of errors.Wrap to retrieve the original error for inspection. Any error value which implements this interface can be inspected by `errors.Cause`. ```go type causer interface { Cause() error } ``` `errors.Cause` will recursively retrieve the topmost error which does not implement `causer`, which is assumed to be the original cause. For example: ```go switch err := errors.Cause(err).(type) { case *MyError: // handle specifically default: // unknown error } ``` [Read the package documentation for more information](https://godoc.org/github.com/pkg/errors). ## Contributing We welcome pull requests, bug fixes and issue reports. With that said, the bar for adding new symbols to this package is intentionally set high. Before proposing a change, please discuss your change by raising an issue. ## Licence BSD-2-Clause stripe-mock-0.196.0/vendor/github.com/pkg/errors/appveyor.yml000066400000000000000000000011771506013555700241620ustar00rootroot00000000000000version: build-{build}.{branch} clone_folder: C:\gopath\src\github.com\pkg\errors shallow_clone: true # for startup speed environment: GOPATH: C:\gopath platform: - x64 # http://www.appveyor.com/docs/installed-software install: # some helpful output for debugging builds - go version - go env # pre-installed MinGW at C:\MinGW is 32bit only # but MSYS2 at C:\msys64 has mingw64 - set PATH=C:\msys64\mingw64\bin;%PATH% - gcc --version - g++ --version build_script: - go install -v ./... test_script: - set PATH=C:\gopath\bin;%PATH% - go test -v ./... #artifacts: # - path: '%GOPATH%\bin\*.exe' deploy: off stripe-mock-0.196.0/vendor/github.com/pkg/errors/errors.go000066400000000000000000000152661506013555700234410ustar00rootroot00000000000000// Package errors provides simple error handling primitives. // // The traditional error handling idiom in Go is roughly akin to // // if err != nil { // return err // } // // which applied recursively up the call stack results in error reports // without context or debugging information. The errors package allows // programmers to add context to the failure path in their code in a way // that does not destroy the original value of the error. // // Adding context to an error // // The errors.Wrap function returns a new error that adds context to the // original error by recording a stack trace at the point Wrap is called, // and the supplied message. For example // // _, err := ioutil.ReadAll(r) // if err != nil { // return errors.Wrap(err, "read failed") // } // // If additional control is required the errors.WithStack and errors.WithMessage // functions destructure errors.Wrap into its component operations of annotating // an error with a stack trace and an a message, respectively. // // Retrieving the cause of an error // // Using errors.Wrap constructs a stack of errors, adding context to the // preceding error. Depending on the nature of the error it may be necessary // to reverse the operation of errors.Wrap to retrieve the original error // for inspection. Any error value which implements this interface // // type causer interface { // Cause() error // } // // can be inspected by errors.Cause. errors.Cause will recursively retrieve // the topmost error which does not implement causer, which is assumed to be // the original cause. For example: // // switch err := errors.Cause(err).(type) { // case *MyError: // // handle specifically // default: // // unknown error // } // // causer interface is not exported by this package, but is considered a part // of stable public API. // // Formatted printing of errors // // All error values returned from this package implement fmt.Formatter and can // be formatted by the fmt package. The following verbs are supported // // %s print the error. If the error has a Cause it will be // printed recursively // %v see %s // %+v extended format. Each Frame of the error's StackTrace will // be printed in detail. // // Retrieving the stack trace of an error or wrapper // // New, Errorf, Wrap, and Wrapf record a stack trace at the point they are // invoked. This information can be retrieved with the following interface. // // type stackTracer interface { // StackTrace() errors.StackTrace // } // // Where errors.StackTrace is defined as // // type StackTrace []Frame // // The Frame type represents a call site in the stack trace. Frame supports // the fmt.Formatter interface that can be used for printing information about // the stack trace of this error. For example: // // if err, ok := err.(stackTracer); ok { // for _, f := range err.StackTrace() { // fmt.Printf("%+s:%d", f) // } // } // // stackTracer interface is not exported by this package, but is considered a part // of stable public API. // // See the documentation for Frame.Format for more details. package errors import ( "fmt" "io" ) // New returns an error with the supplied message. // New also records the stack trace at the point it was called. func New(message string) error { return &fundamental{ msg: message, stack: callers(), } } // Errorf formats according to a format specifier and returns the string // as a value that satisfies error. // Errorf also records the stack trace at the point it was called. func Errorf(format string, args ...interface{}) error { return &fundamental{ msg: fmt.Sprintf(format, args...), stack: callers(), } } // fundamental is an error that has a message and a stack, but no caller. type fundamental struct { msg string *stack } func (f *fundamental) Error() string { return f.msg } func (f *fundamental) Format(s fmt.State, verb rune) { switch verb { case 'v': if s.Flag('+') { io.WriteString(s, f.msg) f.stack.Format(s, verb) return } fallthrough case 's': io.WriteString(s, f.msg) case 'q': fmt.Fprintf(s, "%q", f.msg) } } // WithStack annotates err with a stack trace at the point WithStack was called. // If err is nil, WithStack returns nil. func WithStack(err error) error { if err == nil { return nil } return &withStack{ err, callers(), } } type withStack struct { error *stack } func (w *withStack) Cause() error { return w.error } func (w *withStack) Format(s fmt.State, verb rune) { switch verb { case 'v': if s.Flag('+') { fmt.Fprintf(s, "%+v", w.Cause()) w.stack.Format(s, verb) return } fallthrough case 's': io.WriteString(s, w.Error()) case 'q': fmt.Fprintf(s, "%q", w.Error()) } } // Wrap returns an error annotating err with a stack trace // at the point Wrap is called, and the supplied message. // If err is nil, Wrap returns nil. func Wrap(err error, message string) error { if err == nil { return nil } err = &withMessage{ cause: err, msg: message, } return &withStack{ err, callers(), } } // Wrapf returns an error annotating err with a stack trace // at the point Wrapf is call, and the format specifier. // If err is nil, Wrapf returns nil. func Wrapf(err error, format string, args ...interface{}) error { if err == nil { return nil } err = &withMessage{ cause: err, msg: fmt.Sprintf(format, args...), } return &withStack{ err, callers(), } } // WithMessage annotates err with a new message. // If err is nil, WithMessage returns nil. func WithMessage(err error, message string) error { if err == nil { return nil } return &withMessage{ cause: err, msg: message, } } type withMessage struct { cause error msg string } func (w *withMessage) Error() string { return w.msg + ": " + w.cause.Error() } func (w *withMessage) Cause() error { return w.cause } func (w *withMessage) Format(s fmt.State, verb rune) { switch verb { case 'v': if s.Flag('+') { fmt.Fprintf(s, "%+v\n", w.Cause()) io.WriteString(s, w.msg) return } fallthrough case 's', 'q': io.WriteString(s, w.Error()) } } // Cause returns the underlying cause of the error, if possible. // An error value has a cause if it implements the following // interface: // // type causer interface { // Cause() error // } // // If the error does not implement Cause, the original error will // be returned. If the error is nil, nil will be returned without further // investigation. func Cause(err error) error { type causer interface { Cause() error } for err != nil { cause, ok := err.(causer) if !ok { break } err = cause.Cause() } return err } stripe-mock-0.196.0/vendor/github.com/pkg/errors/stack.go000066400000000000000000000112671506013555700232270ustar00rootroot00000000000000package errors import ( "fmt" "io" "path" "runtime" "strings" ) // Frame represents a program counter inside a stack frame. type Frame uintptr // pc returns the program counter for this frame; // multiple frames may have the same PC value. func (f Frame) pc() uintptr { return uintptr(f) - 1 } // file returns the full path to the file that contains the // function for this Frame's pc. func (f Frame) file() string { fn := runtime.FuncForPC(f.pc()) if fn == nil { return "unknown" } file, _ := fn.FileLine(f.pc()) return file } // line returns the line number of source code of the // function for this Frame's pc. func (f Frame) line() int { fn := runtime.FuncForPC(f.pc()) if fn == nil { return 0 } _, line := fn.FileLine(f.pc()) return line } // Format formats the frame according to the fmt.Formatter interface. // // %s source file // %d source line // %n function name // %v equivalent to %s:%d // // Format accepts flags that alter the printing of some verbs, as follows: // // %+s path of source file relative to the compile time GOPATH // %+v equivalent to %+s:%d func (f Frame) Format(s fmt.State, verb rune) { switch verb { case 's': switch { case s.Flag('+'): pc := f.pc() fn := runtime.FuncForPC(pc) if fn == nil { io.WriteString(s, "unknown") } else { file, _ := fn.FileLine(pc) fmt.Fprintf(s, "%s\n\t%s", fn.Name(), file) } default: io.WriteString(s, path.Base(f.file())) } case 'd': fmt.Fprintf(s, "%d", f.line()) case 'n': name := runtime.FuncForPC(f.pc()).Name() io.WriteString(s, funcname(name)) case 'v': f.Format(s, 's') io.WriteString(s, ":") f.Format(s, 'd') } } // StackTrace is stack of Frames from innermost (newest) to outermost (oldest). type StackTrace []Frame // Format formats the stack of Frames according to the fmt.Formatter interface. // // %s lists source files for each Frame in the stack // %v lists the source file and line number for each Frame in the stack // // Format accepts flags that alter the printing of some verbs, as follows: // // %+v Prints filename, function, and line number for each Frame in the stack. func (st StackTrace) Format(s fmt.State, verb rune) { switch verb { case 'v': switch { case s.Flag('+'): for _, f := range st { fmt.Fprintf(s, "\n%+v", f) } case s.Flag('#'): fmt.Fprintf(s, "%#v", []Frame(st)) default: fmt.Fprintf(s, "%v", []Frame(st)) } case 's': fmt.Fprintf(s, "%s", []Frame(st)) } } // stack represents a stack of program counters. type stack []uintptr func (s *stack) Format(st fmt.State, verb rune) { switch verb { case 'v': switch { case st.Flag('+'): for _, pc := range *s { f := Frame(pc) fmt.Fprintf(st, "\n%+v", f) } } } } func (s *stack) StackTrace() StackTrace { f := make([]Frame, len(*s)) for i := 0; i < len(f); i++ { f[i] = Frame((*s)[i]) } return f } func callers() *stack { const depth = 32 var pcs [depth]uintptr n := runtime.Callers(3, pcs[:]) var st stack = pcs[0:n] return &st } // funcname removes the path prefix component of a function's name reported by func.Name(). func funcname(name string) string { i := strings.LastIndex(name, "/") name = name[i+1:] i = strings.Index(name, ".") return name[i+1:] } func trimGOPATH(name, file string) string { // Here we want to get the source file path relative to the compile time // GOPATH. As of Go 1.6.x there is no direct way to know the compiled // GOPATH at runtime, but we can infer the number of path segments in the // GOPATH. We note that fn.Name() returns the function name qualified by // the import path, which does not include the GOPATH. Thus we can trim // segments from the beginning of the file path until the number of path // separators remaining is one more than the number of path separators in // the function name. For example, given: // // GOPATH /home/user // file /home/user/src/pkg/sub/file.go // fn.Name() pkg/sub.Type.Method // // We want to produce: // // pkg/sub/file.go // // From this we can easily see that fn.Name() has one less path separator // than our desired output. We count separators from the end of the file // path until it finds two more than in the function name and then move // one character forward to preserve the initial path segment without a // leading separator. const sep = "/" goal := strings.Count(name, sep) + 2 i := len(file) for n := 0; n < goal; n++ { i = strings.LastIndex(file[:i], sep) if i == -1 { // not enough separators found, set i so that the slice expression // below leaves file unmodified i = -len(sep) break } } // get back to 0 or trim the leading separator file = file[i+len(sep):] return file } stripe-mock-0.196.0/vendor/github.com/stretchr/000077500000000000000000000000001506013555700213255ustar00rootroot00000000000000stripe-mock-0.196.0/vendor/github.com/stretchr/testify/000077500000000000000000000000001506013555700230145ustar00rootroot00000000000000stripe-mock-0.196.0/vendor/github.com/stretchr/testify/assert/000077500000000000000000000000001506013555700243155ustar00rootroot00000000000000stripe-mock-0.196.0/vendor/github.com/stretchr/testify/assert/assertions.go000066400000000000000000000563431506013555700270510ustar00rootroot00000000000000package assert import ( "bufio" "bytes" "fmt" "math" "reflect" "regexp" "runtime" "strings" "time" "unicode" "unicode/utf8" ) // TestingT is an interface wrapper around *testing.T type TestingT interface { Errorf(format string, args ...interface{}) } // Comparison a custom function that returns true on success and false on failure type Comparison func() (success bool) /* Helper functions */ // ObjectsAreEqual determines if two objects are considered equal. // // This function does no assertion of any kind. func ObjectsAreEqual(expected, actual interface{}) bool { if expected == nil || actual == nil { return expected == actual } if reflect.DeepEqual(expected, actual) { return true } return false } // ObjectsAreEqualValues gets whether two objects are equal, or if their // values are equal. func ObjectsAreEqualValues(expected, actual interface{}) bool { if ObjectsAreEqual(expected, actual) { return true } actualType := reflect.TypeOf(actual) expectedValue := reflect.ValueOf(expected) if expectedValue.Type().ConvertibleTo(actualType) { // Attempt comparison after type conversion if reflect.DeepEqual(actual, expectedValue.Convert(actualType).Interface()) { return true } } return false } /* CallerInfo is necessary because the assert functions use the testing object internally, causing it to print the file:line of the assert method, rather than where the problem actually occured in calling code.*/ // CallerInfo returns an array of strings containing the file and line number // of each stack frame leading from the current test to the assert call that // failed. func CallerInfo() []string { pc := uintptr(0) file := "" line := 0 ok := false name := "" callers := []string{} for i := 0; ; i++ { pc, file, line, ok = runtime.Caller(i) if !ok { return nil } // This is a huge edge case, but it will panic if this is the case, see #180 if file == "" { break } parts := strings.Split(file, "/") dir := parts[len(parts)-2] file = parts[len(parts)-1] if (dir != "assert" && dir != "mock" && dir != "require") || file == "mock_test.go" { callers = append(callers, fmt.Sprintf("%s:%d", file, line)) } f := runtime.FuncForPC(pc) if f == nil { break } name = f.Name() // Drop the package segments := strings.Split(name, ".") name = segments[len(segments)-1] if isTest(name, "Test") || isTest(name, "Benchmark") || isTest(name, "Example") { break } } return callers } // Stolen from the `go test` tool. // isTest tells whether name looks like a test (or benchmark, according to prefix). // It is a Test (say) if there is a character after Test that is not a lower-case letter. // We don't want TesticularCancer. func isTest(name, prefix string) bool { if !strings.HasPrefix(name, prefix) { return false } if len(name) == len(prefix) { // "Test" is ok return true } rune, _ := utf8.DecodeRuneInString(name[len(prefix):]) return !unicode.IsLower(rune) } // getWhitespaceString returns a string that is long enough to overwrite the default // output from the go testing framework. func getWhitespaceString() string { _, file, line, ok := runtime.Caller(1) if !ok { return "" } parts := strings.Split(file, "/") file = parts[len(parts)-1] return strings.Repeat(" ", len(fmt.Sprintf("%s:%d: ", file, line))) } func messageFromMsgAndArgs(msgAndArgs ...interface{}) string { if len(msgAndArgs) == 0 || msgAndArgs == nil { return "" } if len(msgAndArgs) == 1 { return msgAndArgs[0].(string) } if len(msgAndArgs) > 1 { return fmt.Sprintf(msgAndArgs[0].(string), msgAndArgs[1:]...) } return "" } // Indents all lines of the message by appending a number of tabs to each line, in an output format compatible with Go's // test printing (see inner comment for specifics) func indentMessageLines(message string, tabs int) string { outBuf := new(bytes.Buffer) for i, scanner := 0, bufio.NewScanner(strings.NewReader(message)); scanner.Scan(); i++ { if i != 0 { outBuf.WriteRune('\n') } for ii := 0; ii < tabs; ii++ { outBuf.WriteRune('\t') // Bizarrely, all lines except the first need one fewer tabs prepended, so deliberately advance the counter // by 1 prematurely. if ii == 0 && i > 0 { ii++ } } outBuf.WriteString(scanner.Text()) } return outBuf.String() } // Fail reports a failure through func Fail(t TestingT, failureMessage string, msgAndArgs ...interface{}) bool { message := messageFromMsgAndArgs(msgAndArgs...) errorTrace := strings.Join(CallerInfo(), "\n\r\t\t\t") if len(message) > 0 { t.Errorf("\r%s\r\tError Trace:\t%s\n"+ "\r\tError:%s\n"+ "\r\tMessages:\t%s\n\r", getWhitespaceString(), errorTrace, indentMessageLines(failureMessage, 2), message) } else { t.Errorf("\r%s\r\tError Trace:\t%s\n"+ "\r\tError:%s\n\r", getWhitespaceString(), errorTrace, indentMessageLines(failureMessage, 2)) } return false } // Implements asserts that an object is implemented by the specified interface. // // assert.Implements(t, (*MyInterface)(nil), new(MyObject), "MyObject") func Implements(t TestingT, interfaceObject interface{}, object interface{}, msgAndArgs ...interface{}) bool { interfaceType := reflect.TypeOf(interfaceObject).Elem() if !reflect.TypeOf(object).Implements(interfaceType) { return Fail(t, fmt.Sprintf("Object must implement %v", interfaceType), msgAndArgs...) } return true } // IsType asserts that the specified objects are of the same type. func IsType(t TestingT, expectedType interface{}, object interface{}, msgAndArgs ...interface{}) bool { if !ObjectsAreEqual(reflect.TypeOf(object), reflect.TypeOf(expectedType)) { return Fail(t, fmt.Sprintf("Object expected to be of type %v, but was %v", reflect.TypeOf(expectedType), reflect.TypeOf(object)), msgAndArgs...) } return true } // Equal asserts that two objects are equal. // // assert.Equal(t, 123, 123, "123 and 123 should be equal") // // Returns whether the assertion was successful (true) or not (false). func Equal(t TestingT, expected, actual interface{}, msgAndArgs ...interface{}) bool { if !ObjectsAreEqual(expected, actual) { return Fail(t, fmt.Sprintf("Not equal: %#v (expected)\n"+ " != %#v (actual)", expected, actual), msgAndArgs...) } return true } // EqualValues asserts that two objects are equal or convertable to the same types // and equal. // // assert.EqualValues(t, uint32(123), int32(123), "123 and 123 should be equal") // // Returns whether the assertion was successful (true) or not (false). func EqualValues(t TestingT, expected, actual interface{}, msgAndArgs ...interface{}) bool { if !ObjectsAreEqualValues(expected, actual) { return Fail(t, fmt.Sprintf("Not equal: %#v (expected)\n"+ " != %#v (actual)", expected, actual), msgAndArgs...) } return true } // Exactly asserts that two objects are equal is value and type. // // assert.Exactly(t, int32(123), int64(123), "123 and 123 should NOT be equal") // // Returns whether the assertion was successful (true) or not (false). func Exactly(t TestingT, expected, actual interface{}, msgAndArgs ...interface{}) bool { aType := reflect.TypeOf(expected) bType := reflect.TypeOf(actual) if aType != bType { return Fail(t, "Types expected to match exactly", "%v != %v", aType, bType) } return Equal(t, expected, actual, msgAndArgs...) } // NotNil asserts that the specified object is not nil. // // assert.NotNil(t, err, "err should be something") // // Returns whether the assertion was successful (true) or not (false). func NotNil(t TestingT, object interface{}, msgAndArgs ...interface{}) bool { success := true if object == nil { success = false } else { value := reflect.ValueOf(object) kind := value.Kind() if kind >= reflect.Chan && kind <= reflect.Slice && value.IsNil() { success = false } } if !success { Fail(t, "Expected value not to be nil.", msgAndArgs...) } return success } // isNil checks if a specified object is nil or not, without Failing. func isNil(object interface{}) bool { if object == nil { return true } value := reflect.ValueOf(object) kind := value.Kind() if kind >= reflect.Chan && kind <= reflect.Slice && value.IsNil() { return true } return false } // Nil asserts that the specified object is nil. // // assert.Nil(t, err, "err should be nothing") // // Returns whether the assertion was successful (true) or not (false). func Nil(t TestingT, object interface{}, msgAndArgs ...interface{}) bool { if isNil(object) { return true } return Fail(t, fmt.Sprintf("Expected nil, but got: %#v", object), msgAndArgs...) } var zeros = []interface{}{ int(0), int8(0), int16(0), int32(0), int64(0), uint(0), uint8(0), uint16(0), uint32(0), uint64(0), float32(0), float64(0), } // isEmpty gets whether the specified object is considered empty or not. func isEmpty(object interface{}) bool { if object == nil { return true } else if object == "" { return true } else if object == false { return true } for _, v := range zeros { if object == v { return true } } objValue := reflect.ValueOf(object) switch objValue.Kind() { case reflect.Map: fallthrough case reflect.Slice, reflect.Chan: { return (objValue.Len() == 0) } case reflect.Ptr: { switch object.(type) { case *time.Time: return object.(*time.Time).IsZero() default: return false } } } return false } // Empty asserts that the specified object is empty. I.e. nil, "", false, 0 or either // a slice or a channel with len == 0. // // assert.Empty(t, obj) // // Returns whether the assertion was successful (true) or not (false). func Empty(t TestingT, object interface{}, msgAndArgs ...interface{}) bool { pass := isEmpty(object) if !pass { Fail(t, fmt.Sprintf("Should be empty, but was %v", object), msgAndArgs...) } return pass } // NotEmpty asserts that the specified object is NOT empty. I.e. not nil, "", false, 0 or either // a slice or a channel with len == 0. // // if assert.NotEmpty(t, obj) { // assert.Equal(t, "two", obj[1]) // } // // Returns whether the assertion was successful (true) or not (false). func NotEmpty(t TestingT, object interface{}, msgAndArgs ...interface{}) bool { pass := !isEmpty(object) if !pass { Fail(t, fmt.Sprintf("Should NOT be empty, but was %v", object), msgAndArgs...) } return pass } // getLen try to get length of object. // return (false, 0) if impossible. func getLen(x interface{}) (ok bool, length int) { v := reflect.ValueOf(x) defer func() { if e := recover(); e != nil { ok = false } }() return true, v.Len() } // Len asserts that the specified object has specific length. // Len also fails if the object has a type that len() not accept. // // assert.Len(t, mySlice, 3, "The size of slice is not 3") // // Returns whether the assertion was successful (true) or not (false). func Len(t TestingT, object interface{}, length int, msgAndArgs ...interface{}) bool { ok, l := getLen(object) if !ok { return Fail(t, fmt.Sprintf("\"%s\" could not be applied builtin len()", object), msgAndArgs...) } if l != length { return Fail(t, fmt.Sprintf("\"%s\" should have %d item(s), but has %d", object, length, l), msgAndArgs...) } return true } // True asserts that the specified value is true. // // assert.True(t, myBool, "myBool should be true") // // Returns whether the assertion was successful (true) or not (false). func True(t TestingT, value bool, msgAndArgs ...interface{}) bool { if value != true { return Fail(t, "Should be true", msgAndArgs...) } return true } // False asserts that the specified value is true. // // assert.False(t, myBool, "myBool should be false") // // Returns whether the assertion was successful (true) or not (false). func False(t TestingT, value bool, msgAndArgs ...interface{}) bool { if value != false { return Fail(t, "Should be false", msgAndArgs...) } return true } // NotEqual asserts that the specified values are NOT equal. // // assert.NotEqual(t, obj1, obj2, "two objects shouldn't be equal") // // Returns whether the assertion was successful (true) or not (false). func NotEqual(t TestingT, expected, actual interface{}, msgAndArgs ...interface{}) bool { if ObjectsAreEqual(expected, actual) { return Fail(t, "Should not be equal", msgAndArgs...) } return true } // containsElement try loop over the list check if the list includes the element. // return (false, false) if impossible. // return (true, false) if element was not found. // return (true, true) if element was found. func includeElement(list interface{}, element interface{}) (ok, found bool) { listValue := reflect.ValueOf(list) elementValue := reflect.ValueOf(element) defer func() { if e := recover(); e != nil { ok = false found = false } }() if reflect.TypeOf(list).Kind() == reflect.String { return true, strings.Contains(listValue.String(), elementValue.String()) } for i := 0; i < listValue.Len(); i++ { if ObjectsAreEqual(listValue.Index(i).Interface(), element) { return true, true } } return true, false } // Contains asserts that the specified string or list(array, slice...) contains the // specified substring or element. // // assert.Contains(t, "Hello World", "World", "But 'Hello World' does contain 'World'") // assert.Contains(t, ["Hello", "World"], "World", "But ["Hello", "World"] does contain 'World'") // // Returns whether the assertion was successful (true) or not (false). func Contains(t TestingT, s, contains interface{}, msgAndArgs ...interface{}) bool { ok, found := includeElement(s, contains) if !ok { return Fail(t, fmt.Sprintf("\"%s\" could not be applied builtin len()", s), msgAndArgs...) } if !found { return Fail(t, fmt.Sprintf("\"%s\" does not contain \"%s\"", s, contains), msgAndArgs...) } return true } // NotContains asserts that the specified string or list(array, slice...) does NOT contain the // specified substring or element. // // assert.NotContains(t, "Hello World", "Earth", "But 'Hello World' does NOT contain 'Earth'") // assert.NotContains(t, ["Hello", "World"], "Earth", "But ['Hello', 'World'] does NOT contain 'Earth'") // // Returns whether the assertion was successful (true) or not (false). func NotContains(t TestingT, s, contains interface{}, msgAndArgs ...interface{}) bool { ok, found := includeElement(s, contains) if !ok { return Fail(t, fmt.Sprintf("\"%s\" could not be applied builtin len()", s), msgAndArgs...) } if found { return Fail(t, fmt.Sprintf("\"%s\" should not contain \"%s\"", s, contains), msgAndArgs...) } return true } // Condition uses a Comparison to assert a complex condition. func Condition(t TestingT, comp Comparison, msgAndArgs ...interface{}) bool { result := comp() if !result { Fail(t, "Condition failed!", msgAndArgs...) } return result } // PanicTestFunc defines a func that should be passed to the assert.Panics and assert.NotPanics // methods, and represents a simple func that takes no arguments, and returns nothing. type PanicTestFunc func() // didPanic returns true if the function passed to it panics. Otherwise, it returns false. func didPanic(f PanicTestFunc) (bool, interface{}) { didPanic := false var message interface{} func() { defer func() { if message = recover(); message != nil { didPanic = true } }() // call the target function f() }() return didPanic, message } // Panics asserts that the code inside the specified PanicTestFunc panics. // // assert.Panics(t, func(){ // GoCrazy() // }, "Calling GoCrazy() should panic") // // Returns whether the assertion was successful (true) or not (false). func Panics(t TestingT, f PanicTestFunc, msgAndArgs ...interface{}) bool { if funcDidPanic, panicValue := didPanic(f); !funcDidPanic { return Fail(t, fmt.Sprintf("func %#v should panic\n\r\tPanic value:\t%v", f, panicValue), msgAndArgs...) } return true } // NotPanics asserts that the code inside the specified PanicTestFunc does NOT panic. // // assert.NotPanics(t, func(){ // RemainCalm() // }, "Calling RemainCalm() should NOT panic") // // Returns whether the assertion was successful (true) or not (false). func NotPanics(t TestingT, f PanicTestFunc, msgAndArgs ...interface{}) bool { if funcDidPanic, panicValue := didPanic(f); funcDidPanic { return Fail(t, fmt.Sprintf("func %#v should not panic\n\r\tPanic value:\t%v", f, panicValue), msgAndArgs...) } return true } // WithinDuration asserts that the two times are within duration delta of each other. // // assert.WithinDuration(t, time.Now(), time.Now(), 10*time.Second, "The difference should not be more than 10s") // // Returns whether the assertion was successful (true) or not (false). func WithinDuration(t TestingT, expected, actual time.Time, delta time.Duration, msgAndArgs ...interface{}) bool { dt := expected.Sub(actual) if dt < -delta || dt > delta { return Fail(t, fmt.Sprintf("Max difference between %v and %v allowed is %v, but difference was %v", expected, actual, delta, dt), msgAndArgs...) } return true } func toFloat(x interface{}) (float64, bool) { var xf float64 xok := true switch xn := x.(type) { case uint8: xf = float64(xn) case uint16: xf = float64(xn) case uint32: xf = float64(xn) case uint64: xf = float64(xn) case int: xf = float64(xn) case int8: xf = float64(xn) case int16: xf = float64(xn) case int32: xf = float64(xn) case int64: xf = float64(xn) case float32: xf = float64(xn) case float64: xf = float64(xn) default: xok = false } return xf, xok } // InDelta asserts that the two numerals are within delta of each other. // // assert.InDelta(t, math.Pi, (22 / 7.0), 0.01) // // Returns whether the assertion was successful (true) or not (false). func InDelta(t TestingT, expected, actual interface{}, delta float64, msgAndArgs ...interface{}) bool { af, aok := toFloat(expected) bf, bok := toFloat(actual) if !aok || !bok { return Fail(t, fmt.Sprintf("Parameters must be numerical"), msgAndArgs...) } if math.IsNaN(af) { return Fail(t, fmt.Sprintf("Actual must not be NaN"), msgAndArgs...) } if math.IsNaN(bf) { return Fail(t, fmt.Sprintf("Expected %v with delta %v, but was NaN", expected, delta), msgAndArgs...) } dt := af - bf if dt < -delta || dt > delta { return Fail(t, fmt.Sprintf("Max difference between %v and %v allowed is %v, but difference was %v", expected, actual, delta, dt), msgAndArgs...) } return true } // InDeltaSlice is the same as InDelta, except it compares two slices. func InDeltaSlice(t TestingT, expected, actual interface{}, delta float64, msgAndArgs ...interface{}) bool { if expected == nil || actual == nil || reflect.TypeOf(actual).Kind() != reflect.Slice || reflect.TypeOf(expected).Kind() != reflect.Slice { return Fail(t, fmt.Sprintf("Parameters must be slice"), msgAndArgs...) } actualSlice := reflect.ValueOf(actual) expectedSlice := reflect.ValueOf(expected) for i := 0; i < actualSlice.Len(); i++ { result := InDelta(t, actualSlice.Index(i).Interface(), expectedSlice.Index(i).Interface(), delta) if !result { return result } } return true } // min(|expected|, |actual|) * epsilon func calcEpsilonDelta(expected, actual interface{}, epsilon float64) float64 { af, aok := toFloat(expected) bf, bok := toFloat(actual) if !aok || !bok { // invalid input return 0 } if af < 0 { af = -af } if bf < 0 { bf = -bf } var delta float64 if af < bf { delta = af * epsilon } else { delta = bf * epsilon } return delta } // InEpsilon asserts that expected and actual have a relative error less than epsilon // // Returns whether the assertion was successful (true) or not (false). func InEpsilon(t TestingT, expected, actual interface{}, epsilon float64, msgAndArgs ...interface{}) bool { delta := calcEpsilonDelta(expected, actual, epsilon) return InDelta(t, expected, actual, delta, msgAndArgs...) } // InEpsilonSlice is the same as InEpsilon, except it compares two slices. func InEpsilonSlice(t TestingT, expected, actual interface{}, delta float64, msgAndArgs ...interface{}) bool { if expected == nil || actual == nil || reflect.TypeOf(actual).Kind() != reflect.Slice || reflect.TypeOf(expected).Kind() != reflect.Slice { return Fail(t, fmt.Sprintf("Parameters must be slice"), msgAndArgs...) } actualSlice := reflect.ValueOf(actual) expectedSlice := reflect.ValueOf(expected) for i := 0; i < actualSlice.Len(); i++ { result := InEpsilon(t, actualSlice.Index(i).Interface(), expectedSlice.Index(i).Interface(), delta) if !result { return result } } return true } /* Errors */ // NoError asserts that a function returned no error (i.e. `nil`). // // actualObj, err := SomeFunction() // if assert.NoError(t, err) { // assert.Equal(t, actualObj, expectedObj) // } // // Returns whether the assertion was successful (true) or not (false). func NoError(t TestingT, err error, msgAndArgs ...interface{}) bool { if isNil(err) { return true } return Fail(t, fmt.Sprintf("No error is expected but got %v", err), msgAndArgs...) } // Error asserts that a function returned an error (i.e. not `nil`). // // actualObj, err := SomeFunction() // if assert.Error(t, err, "An error was expected") { // assert.Equal(t, err, expectedError) // } // // Returns whether the assertion was successful (true) or not (false). func Error(t TestingT, err error, msgAndArgs ...interface{}) bool { message := messageFromMsgAndArgs(msgAndArgs...) return NotNil(t, err, "An error is expected but got nil. %s", message) } // EqualError asserts that a function returned an error (i.e. not `nil`) // and that it is equal to the provided error. // // actualObj, err := SomeFunction() // if assert.Error(t, err, "An error was expected") { // assert.Equal(t, err, expectedError) // } // // Returns whether the assertion was successful (true) or not (false). func EqualError(t TestingT, theError error, errString string, msgAndArgs ...interface{}) bool { message := messageFromMsgAndArgs(msgAndArgs...) if !NotNil(t, theError, "An error is expected but got nil. %s", message) { return false } s := "An error with value \"%s\" is expected but got \"%s\". %s" return Equal(t, theError.Error(), errString, s, errString, theError.Error(), message) } // matchRegexp return true if a specified regexp matches a string. func matchRegexp(rx interface{}, str interface{}) bool { var r *regexp.Regexp if rr, ok := rx.(*regexp.Regexp); ok { r = rr } else { r = regexp.MustCompile(fmt.Sprint(rx)) } return (r.FindStringIndex(fmt.Sprint(str)) != nil) } // Regexp asserts that a specified regexp matches a string. // // assert.Regexp(t, regexp.MustCompile("start"), "it's starting") // assert.Regexp(t, "start...$", "it's not starting") // // Returns whether the assertion was successful (true) or not (false). func Regexp(t TestingT, rx interface{}, str interface{}, msgAndArgs ...interface{}) bool { match := matchRegexp(rx, str) if !match { Fail(t, fmt.Sprintf("Expect \"%v\" to match \"%v\"", str, rx), msgAndArgs...) } return match } // NotRegexp asserts that a specified regexp does not match a string. // // assert.NotRegexp(t, regexp.MustCompile("starts"), "it's starting") // assert.NotRegexp(t, "^start", "it's not starting") // // Returns whether the assertion was successful (true) or not (false). func NotRegexp(t TestingT, rx interface{}, str interface{}, msgAndArgs ...interface{}) bool { match := matchRegexp(rx, str) if match { Fail(t, fmt.Sprintf("Expect \"%v\" to NOT match \"%v\"", str, rx), msgAndArgs...) } return !match } stripe-mock-0.196.0/vendor/github.com/stretchr/testify/assert/doc.go000066400000000000000000000116101506013555700254100ustar00rootroot00000000000000// Package assert provides a set of comprehensive testing tools for use with the normal Go testing system. // // Example Usage // // The following is a complete example using assert in a standard test function: // import ( // "testing" // "github.com/stretchr/testify/assert" // ) // // func TestSomething(t *testing.T) { // // var a string = "Hello" // var b string = "Hello" // // assert.Equal(t, a, b, "The two words should be the same.") // // } // // if you assert many times, use the below: // // import ( // "testing" // "github.com/stretchr/testify/assert" // ) // // func TestSomething(t *testing.T) { // assert := assert.New(t) // // var a string = "Hello" // var b string = "Hello" // // assert.Equal(a, b, "The two words should be the same.") // } // // Assertions // // Assertions allow you to easily write test code, and are global funcs in the `assert` package. // All assertion functions take, as the first argument, the `*testing.T` object provided by the // testing framework. This allows the assertion funcs to write the failings and other details to // the correct place. // // Every assertion function also takes an optional string message as the final argument, // allowing custom error messages to be appended to the message the assertion method outputs. // // Here is an overview of the assert functions: // // assert.Equal(t, expected, actual [, message [, format-args]]) // // assert.EqualValues(t, expected, actual [, message [, format-args]]) // // assert.NotEqual(t, notExpected, actual [, message [, format-args]]) // // assert.True(t, actualBool [, message [, format-args]]) // // assert.False(t, actualBool [, message [, format-args]]) // // assert.Nil(t, actualObject [, message [, format-args]]) // // assert.NotNil(t, actualObject [, message [, format-args]]) // // assert.Empty(t, actualObject [, message [, format-args]]) // // assert.NotEmpty(t, actualObject [, message [, format-args]]) // // assert.Len(t, actualObject, expectedLength, [, message [, format-args]]) // // assert.Error(t, errorObject [, message [, format-args]]) // // assert.NoError(t, errorObject [, message [, format-args]]) // // assert.EqualError(t, theError, errString [, message [, format-args]]) // // assert.Implements(t, (*MyInterface)(nil), new(MyObject) [,message [, format-args]]) // // assert.IsType(t, expectedObject, actualObject [, message [, format-args]]) // // assert.Contains(t, stringOrSlice, substringOrElement [, message [, format-args]]) // // assert.NotContains(t, stringOrSlice, substringOrElement [, message [, format-args]]) // // assert.Panics(t, func(){ // // // call code that should panic // // } [, message [, format-args]]) // // assert.NotPanics(t, func(){ // // // call code that should not panic // // } [, message [, format-args]]) // // assert.WithinDuration(t, timeA, timeB, deltaTime, [, message [, format-args]]) // // assert.InDelta(t, numA, numB, delta, [, message [, format-args]]) // // assert.InEpsilon(t, numA, numB, epsilon, [, message [, format-args]]) // // assert package contains Assertions object. it has assertion methods. // // Here is an overview of the assert functions: // assert.Equal(expected, actual [, message [, format-args]]) // // assert.EqualValues(expected, actual [, message [, format-args]]) // // assert.NotEqual(notExpected, actual [, message [, format-args]]) // // assert.True(actualBool [, message [, format-args]]) // // assert.False(actualBool [, message [, format-args]]) // // assert.Nil(actualObject [, message [, format-args]]) // // assert.NotNil(actualObject [, message [, format-args]]) // // assert.Empty(actualObject [, message [, format-args]]) // // assert.NotEmpty(actualObject [, message [, format-args]]) // // assert.Len(actualObject, expectedLength, [, message [, format-args]]) // // assert.Error(errorObject [, message [, format-args]]) // // assert.NoError(errorObject [, message [, format-args]]) // // assert.EqualError(theError, errString [, message [, format-args]]) // // assert.Implements((*MyInterface)(nil), new(MyObject) [,message [, format-args]]) // // assert.IsType(expectedObject, actualObject [, message [, format-args]]) // // assert.Contains(stringOrSlice, substringOrElement [, message [, format-args]]) // // assert.NotContains(stringOrSlice, substringOrElement [, message [, format-args]]) // // assert.Panics(func(){ // // // call code that should panic // // } [, message [, format-args]]) // // assert.NotPanics(func(){ // // // call code that should not panic // // } [, message [, format-args]]) // // assert.WithinDuration(timeA, timeB, deltaTime, [, message [, format-args]]) // // assert.InDelta(numA, numB, delta, [, message [, format-args]]) // // assert.InEpsilon(numA, numB, epsilon, [, message [, format-args]]) package assert stripe-mock-0.196.0/vendor/github.com/stretchr/testify/assert/errors.go000066400000000000000000000005061506013555700261610ustar00rootroot00000000000000package assert import ( "errors" ) // AnError is an error instance useful for testing. If the code does not care // about error specifics, and only needs to return the error for example, this // error should be used to make the test code more readable. var AnError = errors.New("assert.AnError general error for testing") stripe-mock-0.196.0/vendor/github.com/stretchr/testify/assert/forward_assertions.go000066400000000000000000000231711506013555700305660ustar00rootroot00000000000000package assert import "time" // Assertions provides assertion methods around the // TestingT interface. type Assertions struct { t TestingT } // New makes a new Assertions object for the specified TestingT. func New(t TestingT) *Assertions { return &Assertions{ t: t, } } // Fail reports a failure through func (a *Assertions) Fail(failureMessage string, msgAndArgs ...interface{}) bool { return Fail(a.t, failureMessage, msgAndArgs...) } // Implements asserts that an object is implemented by the specified interface. // // assert.Implements((*MyInterface)(nil), new(MyObject), "MyObject") func (a *Assertions) Implements(interfaceObject interface{}, object interface{}, msgAndArgs ...interface{}) bool { return Implements(a.t, interfaceObject, object, msgAndArgs...) } // IsType asserts that the specified objects are of the same type. func (a *Assertions) IsType(expectedType interface{}, object interface{}, msgAndArgs ...interface{}) bool { return IsType(a.t, expectedType, object, msgAndArgs...) } // Equal asserts that two objects are equal. // // assert.Equal(123, 123, "123 and 123 should be equal") // // Returns whether the assertion was successful (true) or not (false). func (a *Assertions) Equal(expected, actual interface{}, msgAndArgs ...interface{}) bool { return Equal(a.t, expected, actual, msgAndArgs...) } // EqualValues asserts that two objects are equal or convertable to the same types // and equal. // // assert.EqualValues(uint32(123), int32(123), "123 and 123 should be equal") // // Returns whether the assertion was successful (true) or not (false). func (a *Assertions) EqualValues(expected, actual interface{}, msgAndArgs ...interface{}) bool { return EqualValues(a.t, expected, actual, msgAndArgs...) } // Exactly asserts that two objects are equal is value and type. // // assert.Exactly(int32(123), int64(123), "123 and 123 should NOT be equal") // // Returns whether the assertion was successful (true) or not (false). func (a *Assertions) Exactly(expected, actual interface{}, msgAndArgs ...interface{}) bool { return Exactly(a.t, expected, actual, msgAndArgs...) } // NotNil asserts that the specified object is not nil. // // assert.NotNil(err, "err should be something") // // Returns whether the assertion was successful (true) or not (false). func (a *Assertions) NotNil(object interface{}, msgAndArgs ...interface{}) bool { return NotNil(a.t, object, msgAndArgs...) } // Nil asserts that the specified object is nil. // // assert.Nil(err, "err should be nothing") // // Returns whether the assertion was successful (true) or not (false). func (a *Assertions) Nil(object interface{}, msgAndArgs ...interface{}) bool { return Nil(a.t, object, msgAndArgs...) } // Empty asserts that the specified object is empty. I.e. nil, "", false, 0 or a // slice with len == 0. // // assert.Empty(obj) // // Returns whether the assertion was successful (true) or not (false). func (a *Assertions) Empty(object interface{}, msgAndArgs ...interface{}) bool { return Empty(a.t, object, msgAndArgs...) } // NotEmpty asserts that the specified object is NOT empty. I.e. not nil, "", false, 0 or a // slice with len == 0. // // if assert.NotEmpty(obj) { // assert.Equal("two", obj[1]) // } // // Returns whether the assertion was successful (true) or not (false). func (a *Assertions) NotEmpty(object interface{}, msgAndArgs ...interface{}) bool { return NotEmpty(a.t, object, msgAndArgs...) } // Len asserts that the specified object has specific length. // Len also fails if the object has a type that len() not accept. // // assert.Len(mySlice, 3, "The size of slice is not 3") // // Returns whether the assertion was successful (true) or not (false). func (a *Assertions) Len(object interface{}, length int, msgAndArgs ...interface{}) bool { return Len(a.t, object, length, msgAndArgs...) } // True asserts that the specified value is true. // // assert.True(myBool, "myBool should be true") // // Returns whether the assertion was successful (true) or not (false). func (a *Assertions) True(value bool, msgAndArgs ...interface{}) bool { return True(a.t, value, msgAndArgs...) } // False asserts that the specified value is true. // // assert.False(myBool, "myBool should be false") // // Returns whether the assertion was successful (true) or not (false). func (a *Assertions) False(value bool, msgAndArgs ...interface{}) bool { return False(a.t, value, msgAndArgs...) } // NotEqual asserts that the specified values are NOT equal. // // assert.NotEqual(obj1, obj2, "two objects shouldn't be equal") // // Returns whether the assertion was successful (true) or not (false). func (a *Assertions) NotEqual(expected, actual interface{}, msgAndArgs ...interface{}) bool { return NotEqual(a.t, expected, actual, msgAndArgs...) } // Contains asserts that the specified string contains the specified substring. // // assert.Contains("Hello World", "World", "But 'Hello World' does contain 'World'") // // Returns whether the assertion was successful (true) or not (false). func (a *Assertions) Contains(s, contains interface{}, msgAndArgs ...interface{}) bool { return Contains(a.t, s, contains, msgAndArgs...) } // NotContains asserts that the specified string does NOT contain the specified substring. // // assert.NotContains("Hello World", "Earth", "But 'Hello World' does NOT contain 'Earth'") // // Returns whether the assertion was successful (true) or not (false). func (a *Assertions) NotContains(s, contains interface{}, msgAndArgs ...interface{}) bool { return NotContains(a.t, s, contains, msgAndArgs...) } // Condition uses a Comparison to assert a complex condition. func (a *Assertions) Condition(comp Comparison, msgAndArgs ...interface{}) bool { return Condition(a.t, comp, msgAndArgs...) } // Panics asserts that the code inside the specified PanicTestFunc panics. // // assert.Panics(func(){ // GoCrazy() // }, "Calling GoCrazy() should panic") // // Returns whether the assertion was successful (true) or not (false). func (a *Assertions) Panics(f PanicTestFunc, msgAndArgs ...interface{}) bool { return Panics(a.t, f, msgAndArgs...) } // NotPanics asserts that the code inside the specified PanicTestFunc does NOT panic. // // assert.NotPanics(func(){ // RemainCalm() // }, "Calling RemainCalm() should NOT panic") // // Returns whether the assertion was successful (true) or not (false). func (a *Assertions) NotPanics(f PanicTestFunc, msgAndArgs ...interface{}) bool { return NotPanics(a.t, f, msgAndArgs...) } // WithinDuration asserts that the two times are within duration delta of each other. // // assert.WithinDuration(time.Now(), time.Now(), 10*time.Second, "The difference should not be more than 10s") // // Returns whether the assertion was successful (true) or not (false). func (a *Assertions) WithinDuration(expected, actual time.Time, delta time.Duration, msgAndArgs ...interface{}) bool { return WithinDuration(a.t, expected, actual, delta, msgAndArgs...) } // InDelta asserts that the two numerals are within delta of each other. // // assert.InDelta(t, math.Pi, (22 / 7.0), 0.01) // // Returns whether the assertion was successful (true) or not (false). func (a *Assertions) InDelta(expected, actual interface{}, delta float64, msgAndArgs ...interface{}) bool { return InDelta(a.t, expected, actual, delta, msgAndArgs...) } // InEpsilon asserts that expected and actual have a relative error less than epsilon // // Returns whether the assertion was successful (true) or not (false). func (a *Assertions) InEpsilon(expected, actual interface{}, epsilon float64, msgAndArgs ...interface{}) bool { return InEpsilon(a.t, expected, actual, epsilon, msgAndArgs...) } // NoError asserts that a function returned no error (i.e. `nil`). // // actualObj, err := SomeFunction() // if assert.NoError(err) { // assert.Equal(actualObj, expectedObj) // } // // Returns whether the assertion was successful (true) or not (false). func (a *Assertions) NoError(theError error, msgAndArgs ...interface{}) bool { return NoError(a.t, theError, msgAndArgs...) } // Error asserts that a function returned an error (i.e. not `nil`). // // actualObj, err := SomeFunction() // if assert.Error(err, "An error was expected") { // assert.Equal(err, expectedError) // } // // Returns whether the assertion was successful (true) or not (false). func (a *Assertions) Error(theError error, msgAndArgs ...interface{}) bool { return Error(a.t, theError, msgAndArgs...) } // EqualError asserts that a function returned an error (i.e. not `nil`) // and that it is equal to the provided error. // // actualObj, err := SomeFunction() // if assert.Error(err, "An error was expected") { // assert.Equal(err, expectedError) // } // // Returns whether the assertion was successful (true) or not (false). func (a *Assertions) EqualError(theError error, errString string, msgAndArgs ...interface{}) bool { return EqualError(a.t, theError, errString, msgAndArgs...) } // Regexp asserts that a specified regexp matches a string. // // assert.Regexp(t, regexp.MustCompile("start"), "it's starting") // assert.Regexp(t, "start...$", "it's not starting") // // Returns whether the assertion was successful (true) or not (false). func (a *Assertions) Regexp(rx interface{}, str interface{}, msgAndArgs ...interface{}) bool { return Regexp(a.t, rx, str, msgAndArgs...) } // NotRegexp asserts that a specified regexp does not match a string. // // assert.NotRegexp(t, regexp.MustCompile("starts"), "it's starting") // assert.NotRegexp(t, "^start", "it's not starting") // // Returns whether the assertion was successful (true) or not (false). func (a *Assertions) NotRegexp(rx interface{}, str interface{}, msgAndArgs ...interface{}) bool { return NotRegexp(a.t, rx, str, msgAndArgs...) } stripe-mock-0.196.0/vendor/github.com/stretchr/testify/assert/http_assertions.go000066400000000000000000000131351506013555700301000ustar00rootroot00000000000000package assert import ( "fmt" "net/http" "net/http/httptest" "net/url" "strings" ) // httpCode is a helper that returns HTTP code of the response. It returns -1 // if building a new request fails. func httpCode(handler http.HandlerFunc, mode, url string, values url.Values) int { w := httptest.NewRecorder() req, err := http.NewRequest(mode, url+"?"+values.Encode(), nil) if err != nil { return -1 } handler(w, req) return w.Code } // HTTPSuccess asserts that a specified handler returns a success status code. // // assert.HTTPSuccess(t, myHandler, "POST", "http://www.google.com", nil) // // Returns whether the assertion was successful (true) or not (false). func HTTPSuccess(t TestingT, handler http.HandlerFunc, mode, url string, values url.Values) bool { code := httpCode(handler, mode, url, values) if code == -1 { return false } return code >= http.StatusOK && code <= http.StatusPartialContent } // HTTPRedirect asserts that a specified handler returns a redirect status code. // // assert.HTTPRedirect(t, myHandler, "GET", "/a/b/c", url.Values{"a": []string{"b", "c"}} // // Returns whether the assertion was successful (true) or not (false). func HTTPRedirect(t TestingT, handler http.HandlerFunc, mode, url string, values url.Values) bool { code := httpCode(handler, mode, url, values) if code == -1 { return false } return code >= http.StatusMultipleChoices && code <= http.StatusTemporaryRedirect } // HTTPError asserts that a specified handler returns an error status code. // // assert.HTTPError(t, myHandler, "POST", "/a/b/c", url.Values{"a": []string{"b", "c"}} // // Returns whether the assertion was successful (true) or not (false). func HTTPError(t TestingT, handler http.HandlerFunc, mode, url string, values url.Values) bool { code := httpCode(handler, mode, url, values) if code == -1 { return false } return code >= http.StatusBadRequest } // HTTPBody is a helper that returns HTTP body of the response. It returns // empty string if building a new request fails. func HTTPBody(handler http.HandlerFunc, mode, url string, values url.Values) string { w := httptest.NewRecorder() req, err := http.NewRequest(mode, url+"?"+values.Encode(), nil) if err != nil { return "" } handler(w, req) return w.Body.String() } // HTTPBodyContains asserts that a specified handler returns a // body that contains a string. // // assert.HTTPBodyContains(t, myHandler, "www.google.com", nil, "I'm Feeling Lucky") // // Returns whether the assertion was successful (true) or not (false). func HTTPBodyContains(t TestingT, handler http.HandlerFunc, mode, url string, values url.Values, str interface{}) bool { body := HTTPBody(handler, mode, url, values) contains := strings.Contains(body, fmt.Sprint(str)) if !contains { Fail(t, fmt.Sprintf("Expected response body for \"%s\" to contain \"%s\" but found \"%s\"", url+"?"+values.Encode(), str, body)) } return contains } // HTTPBodyNotContains asserts that a specified handler returns a // body that does not contain a string. // // assert.HTTPBodyNotContains(t, myHandler, "www.google.com", nil, "I'm Feeling Lucky") // // Returns whether the assertion was successful (true) or not (false). func HTTPBodyNotContains(t TestingT, handler http.HandlerFunc, mode, url string, values url.Values, str interface{}) bool { body := HTTPBody(handler, mode, url, values) contains := strings.Contains(body, fmt.Sprint(str)) if contains { Fail(t, "Expected response body for %s to NOT contain \"%s\" but found \"%s\"", url+"?"+values.Encode(), str, body) } return !contains } // // Assertions Wrappers // // HTTPSuccess asserts that a specified handler returns a success status code. // // assert.HTTPSuccess(myHandler, "POST", "http://www.google.com", nil) // // Returns whether the assertion was successful (true) or not (false). func (a *Assertions) HTTPSuccess(handler http.HandlerFunc, mode, url string, values url.Values) bool { return HTTPSuccess(a.t, handler, mode, url, values) } // HTTPRedirect asserts that a specified handler returns a redirect status code. // // assert.HTTPRedirect(myHandler, "GET", "/a/b/c", url.Values{"a": []string{"b", "c"}} // // Returns whether the assertion was successful (true) or not (false). func (a *Assertions) HTTPRedirect(handler http.HandlerFunc, mode, url string, values url.Values) bool { return HTTPRedirect(a.t, handler, mode, url, values) } // HTTPError asserts that a specified handler returns an error status code. // // assert.HTTPError(myHandler, "POST", "/a/b/c", url.Values{"a": []string{"b", "c"}} // // Returns whether the assertion was successful (true) or not (false). func (a *Assertions) HTTPError(handler http.HandlerFunc, mode, url string, values url.Values) bool { return HTTPError(a.t, handler, mode, url, values) } // HTTPBodyContains asserts that a specified handler returns a // body that contains a string. // // assert.HTTPBodyContains(t, myHandler, "www.google.com", nil, "I'm Feeling Lucky") // // Returns whether the assertion was successful (true) or not (false). func (a *Assertions) HTTPBodyContains(handler http.HandlerFunc, mode, url string, values url.Values, str interface{}) bool { return HTTPBodyContains(a.t, handler, mode, url, values, str) } // HTTPBodyNotContains asserts that a specified handler returns a // body that does not contain a string. // // assert.HTTPBodyNotContains(t, myHandler, "www.google.com", nil, "I'm Feeling Lucky") // // Returns whether the assertion was successful (true) or not (false). func (a *Assertions) HTTPBodyNotContains(handler http.HandlerFunc, mode, url string, values url.Values, str interface{}) bool { return HTTPBodyNotContains(a.t, handler, mode, url, values, str) } stripe-mock-0.196.0/vendor/github.com/stretchr/testify/require/000077500000000000000000000000001506013555700244705ustar00rootroot00000000000000stripe-mock-0.196.0/vendor/github.com/stretchr/testify/require/doc.go000066400000000000000000000046411506013555700255710ustar00rootroot00000000000000// Alternative testing tools which stop test execution if test failed. // // Example Usage // // The following is a complete example using require in a standard test function: // import ( // "testing" // "github.com/stretchr/testify/require" // ) // // func TestSomething(t *testing.T) { // // var a string = "Hello" // var b string = "Hello" // // require.Equal(t, a, b, "The two words should be the same.") // // } // // Assertions // // The `require` package have same global functions as in the `assert` package, // but instead of returning a boolean result they call `t.FailNow()`. // // Every assertion function also takes an optional string message as the final argument, // allowing custom error messages to be appended to the message the assertion method outputs. // // Here is an overview of the assert functions: // // require.Equal(t, expected, actual [, message [, format-args]) // // require.NotEqual(t, notExpected, actual [, message [, format-args]]) // // require.True(t, actualBool [, message [, format-args]]) // // require.False(t, actualBool [, message [, format-args]]) // // require.Nil(t, actualObject [, message [, format-args]]) // // require.NotNil(t, actualObject [, message [, format-args]]) // // require.Empty(t, actualObject [, message [, format-args]]) // // require.NotEmpty(t, actualObject [, message [, format-args]]) // // require.Error(t, errorObject [, message [, format-args]]) // // require.NoError(t, errorObject [, message [, format-args]]) // // require.EqualError(t, theError, errString [, message [, format-args]]) // // require.Implements(t, (*MyInterface)(nil), new(MyObject) [,message [, format-args]]) // // require.IsType(t, expectedObject, actualObject [, message [, format-args]]) // // require.Contains(t, string, substring [, message [, format-args]]) // // require.NotContains(t, string, substring [, message [, format-args]]) // // require.Panics(t, func(){ // // // call code that should panic // // } [, message [, format-args]]) // // require.NotPanics(t, func(){ // // // call code that should not panic // // } [, message [, format-args]]) // // require.WithinDuration(t, timeA, timeB, deltaTime, [, message [, format-args]]) // // require.InDelta(t, numA, numB, delta, [, message [, format-args]]) // // require.InEpsilon(t, numA, numB, epsilon, [, message [, format-args]]) package require stripe-mock-0.196.0/vendor/github.com/stretchr/testify/require/forward_requirements.go000066400000000000000000000163051506013555700312730ustar00rootroot00000000000000package require import ( "time" "github.com/stretchr/testify/assert" ) type Assertions struct { t TestingT } func New(t TestingT) *Assertions { return &Assertions{ t: t, } } // Fail reports a failure through func (a *Assertions) Fail(failureMessage string, msgAndArgs ...interface{}) { FailNow(a.t, failureMessage, msgAndArgs...) } // Implements asserts that an object is implemented by the specified interface. func (a *Assertions) Implements(interfaceObject interface{}, object interface{}, msgAndArgs ...interface{}) { Implements(a.t, interfaceObject, object, msgAndArgs...) } // IsType asserts that the specified objects are of the same type. func (a *Assertions) IsType(expectedType interface{}, object interface{}, msgAndArgs ...interface{}) { IsType(a.t, expectedType, object, msgAndArgs...) } // Equal asserts that two objects are equal. // // require.Equal(123, 123, "123 and 123 should be equal") func (a *Assertions) Equal(expected, actual interface{}, msgAndArgs ...interface{}) { Equal(a.t, expected, actual, msgAndArgs...) } // Exactly asserts that two objects are equal is value and type. // // require.Exactly(int32(123), int64(123), "123 and 123 should NOT be equal") func (a *Assertions) Exactly(expected, actual interface{}, msgAndArgs ...interface{}) { Exactly(a.t, expected, actual, msgAndArgs...) } // NotNil asserts that the specified object is not nil. // // require.NotNil(err, "err should be something") func (a *Assertions) NotNil(object interface{}, msgAndArgs ...interface{}) { NotNil(a.t, object, msgAndArgs...) } // Nil asserts that the specified object is nil. // // require.Nil(err, "err should be nothing") func (a *Assertions) Nil(object interface{}, msgAndArgs ...interface{}) { Nil(a.t, object, msgAndArgs...) } // Empty asserts that the specified object is empty. I.e. nil, "", false, 0 or a // slice with len == 0. // // require.Empty(obj) func (a *Assertions) Empty(object interface{}, msgAndArgs ...interface{}) { Empty(a.t, object, msgAndArgs...) } // Empty asserts that the specified object is NOT empty. I.e. not nil, "", false, 0 or a // slice with len == 0. // // if require.NotEmpty(obj) { // require.Equal("two", obj[1]) // } func (a *Assertions) NotEmpty(object interface{}, msgAndArgs ...interface{}) { NotEmpty(a.t, object, msgAndArgs...) } // Len asserts that the specified object has specific length. // Len also fails if the object has a type that len() not accept. // // require.Len(mySlice, 3, "The size of slice is not 3") func (a *Assertions) Len(object interface{}, length int, msgAndArgs ...interface{}) { Len(a.t, object, length, msgAndArgs...) } // True asserts that the specified value is true. // // require.True(myBool, "myBool should be true") func (a *Assertions) True(value bool, msgAndArgs ...interface{}) { True(a.t, value, msgAndArgs...) } // False asserts that the specified value is true. // // require.False(myBool, "myBool should be false") func (a *Assertions) False(value bool, msgAndArgs ...interface{}) { False(a.t, value, msgAndArgs...) } // NotEqual asserts that the specified values are NOT equal. // // require.NotEqual(obj1, obj2, "two objects shouldn't be equal") func (a *Assertions) NotEqual(expected, actual interface{}, msgAndArgs ...interface{}) { NotEqual(a.t, expected, actual, msgAndArgs...) } // Contains asserts that the specified string contains the specified substring. // // require.Contains("Hello World", "World", "But 'Hello World' does contain 'World'") func (a *Assertions) Contains(s, contains interface{}, msgAndArgs ...interface{}) { Contains(a.t, s, contains, msgAndArgs...) } // NotContains asserts that the specified string does NOT contain the specified substring. // // require.NotContains("Hello World", "Earth", "But 'Hello World' does NOT contain 'Earth'") func (a *Assertions) NotContains(s, contains interface{}, msgAndArgs ...interface{}) { NotContains(a.t, s, contains, msgAndArgs...) } // Uses a Comparison to assert a complex condition. func (a *Assertions) Condition(comp assert.Comparison, msgAndArgs ...interface{}) { Condition(a.t, comp, msgAndArgs...) } // Panics asserts that the code inside the specified PanicTestFunc panics. // // require.Panics(func(){ // GoCrazy() // }, "Calling GoCrazy() should panic") func (a *Assertions) Panics(f assert.PanicTestFunc, msgAndArgs ...interface{}) { Panics(a.t, f, msgAndArgs...) } // NotPanics asserts that the code inside the specified PanicTestFunc does NOT panic. // // require.NotPanics(func(){ // RemainCalm() // }, "Calling RemainCalm() should NOT panic") func (a *Assertions) NotPanics(f assert.PanicTestFunc, msgAndArgs ...interface{}) { NotPanics(a.t, f, msgAndArgs...) } // WithinDuration asserts that the two times are within duration delta of each other. // // require.WithinDuration(time.Now(), time.Now(), 10*time.Second, "The difference should not be more than 10s") func (a *Assertions) WithinDuration(expected, actual time.Time, delta time.Duration, msgAndArgs ...interface{}) { WithinDuration(a.t, expected, actual, delta, msgAndArgs...) } // InDelta asserts that the two numerals are within delta of each other. // // require.InDelta(t, math.Pi, (22 / 7.0), 0.01) func (a *Assertions) InDelta(expected, actual interface{}, delta float64, msgAndArgs ...interface{}) { InDelta(a.t, expected, actual, delta, msgAndArgs...) } // InEpsilon asserts that expected and actual have a relative error less than epsilon func (a *Assertions) InEpsilon(expected, actual interface{}, epsilon float64, msgAndArgs ...interface{}) { InEpsilon(a.t, expected, actual, epsilon, msgAndArgs...) } // NoError asserts that a function returned no error (i.e. `nil`). // // actualObj, err := SomeFunction() // if require.NoError(err) { // require.Equal(actualObj, expectedObj) // } func (a *Assertions) NoError(theError error, msgAndArgs ...interface{}) { NoError(a.t, theError, msgAndArgs...) } // Error asserts that a function returned an error (i.e. not `nil`). // // actualObj, err := SomeFunction() // if require.Error(err, "An error was expected") { // require.Equal(err, expectedError) // } func (a *Assertions) Error(theError error, msgAndArgs ...interface{}) { Error(a.t, theError, msgAndArgs...) } // EqualError asserts that a function returned an error (i.e. not `nil`) // and that it is equal to the provided error. // // actualObj, err := SomeFunction() // if require.Error(err, "An error was expected") { // require.Equal(err, expectedError) // } func (a *Assertions) EqualError(theError error, errString string, msgAndArgs ...interface{}) { EqualError(a.t, theError, errString, msgAndArgs...) } // Regexp asserts that a specified regexp matches a string. // // require.Regexp(t, regexp.MustCompile("start"), "it's starting") // require.Regexp(t, "start...$", "it's not starting") func (a *Assertions) Regexp(rx interface{}, str interface{}, msgAndArgs ...interface{}) { Regexp(a.t, rx, str, msgAndArgs...) } // NotRegexp asserts that a specified regexp does not match a string. // // require.NotRegexp(t, regexp.MustCompile("starts"), "it's starting") // require.NotRegexp(t, "^start", "it's not starting") func (a *Assertions) NotRegexp(rx interface{}, str interface{}, msgAndArgs ...interface{}) { NotRegexp(a.t, rx, str, msgAndArgs...) } stripe-mock-0.196.0/vendor/github.com/stretchr/testify/require/requirements.go000066400000000000000000000205101506013555700275400ustar00rootroot00000000000000package require import ( "time" "github.com/stretchr/testify/assert" ) type TestingT interface { Errorf(format string, args ...interface{}) FailNow() } // Fail reports a failure through func FailNow(t TestingT, failureMessage string, msgAndArgs ...interface{}) { assert.Fail(t, failureMessage, msgAndArgs...) t.FailNow() } // Implements asserts that an object is implemented by the specified interface. // // require.Implements(t, (*MyInterface)(nil), new(MyObject), "MyObject") func Implements(t TestingT, interfaceObject interface{}, object interface{}, msgAndArgs ...interface{}) { if !assert.Implements(t, interfaceObject, object, msgAndArgs...) { t.FailNow() } } // IsType asserts that the specified objects are of the same type. func IsType(t TestingT, expectedType interface{}, object interface{}, msgAndArgs ...interface{}) { if !assert.IsType(t, expectedType, object, msgAndArgs...) { t.FailNow() } } // Equal asserts that two objects are equal. // // require.Equal(t, 123, 123, "123 and 123 should be equal") func Equal(t TestingT, expected, actual interface{}, msgAndArgs ...interface{}) { if !assert.Equal(t, expected, actual, msgAndArgs...) { t.FailNow() } } // EqualValues asserts that two objects are equal or convertable to each other. // // require.EqualValues(t, uint32(123), int32(123), "123 and 123 should be equal") func EqualValues(t TestingT, expected, actual interface{}, msgAndArgs ...interface{}) { if !assert.EqualValues(t, expected, actual, msgAndArgs...) { t.FailNow() } } // Exactly asserts that two objects are equal is value and type. // // require.Exactly(t, int32(123), int64(123), "123 and 123 should NOT be equal") func Exactly(t TestingT, expected, actual interface{}, msgAndArgs ...interface{}) { if !assert.Exactly(t, expected, actual, msgAndArgs...) { t.FailNow() } } // NotNil asserts that the specified object is not nil. // // require.NotNil(t, err, "err should be something") func NotNil(t TestingT, object interface{}, msgAndArgs ...interface{}) { if !assert.NotNil(t, object, msgAndArgs...) { t.FailNow() } } // Nil asserts that the specified object is nil. // // require.Nil(t, err, "err should be nothing") func Nil(t TestingT, object interface{}, msgAndArgs ...interface{}) { if !assert.Nil(t, object, msgAndArgs...) { t.FailNow() } } // Empty asserts that the specified object is empty. I.e. nil, "", false, 0 or either // a slice or a channel with len == 0. // // require.Empty(t, obj) func Empty(t TestingT, object interface{}, msgAndArgs ...interface{}) { if !assert.Empty(t, object, msgAndArgs...) { t.FailNow() } } // NotEmpty asserts that the specified object is NOT empty. I.e. not nil, "", false, 0 or either // a slice or a channel with len == 0. // // require.NotEmpty(t, obj) // require.Equal(t, "one", obj[0]) func NotEmpty(t TestingT, object interface{}, msgAndArgs ...interface{}) { if !assert.NotEmpty(t, object, msgAndArgs...) { t.FailNow() } } // Len asserts that the specified object has specific length. // Len also fails if the object has a type that len() not accept. // // require.Len(t, mySlice, 3, "The size of slice is not 3") func Len(t TestingT, object interface{}, length int, msgAndArgs ...interface{}) { if !assert.Len(t, object, length, msgAndArgs...) { t.FailNow() } } // True asserts that the specified value is true. // // require.True(t, myBool, "myBool should be true") func True(t TestingT, value bool, msgAndArgs ...interface{}) { if !assert.True(t, value, msgAndArgs...) { t.FailNow() } } // False asserts that the specified value is true. // // require.False(t, myBool, "myBool should be false") func False(t TestingT, value bool, msgAndArgs ...interface{}) { if !assert.False(t, value, msgAndArgs...) { t.FailNow() } } // NotEqual asserts that the specified values are NOT equal. // // require.NotEqual(t, obj1, obj2, "two objects shouldn't be equal") func NotEqual(t TestingT, expected, actual interface{}, msgAndArgs ...interface{}) { if !assert.NotEqual(t, expected, actual, msgAndArgs...) { t.FailNow() } } // Contains asserts that the specified string contains the specified substring. // // require.Contains(t, "Hello World", "World", "But 'Hello World' does contain 'World'") func Contains(t TestingT, s, contains interface{}, msgAndArgs ...interface{}) { if !assert.Contains(t, s, contains, msgAndArgs...) { t.FailNow() } } // NotContains asserts that the specified string does NOT contain the specified substring. // // require.NotContains(t, "Hello World", "Earth", "But 'Hello World' does NOT contain 'Earth'") func NotContains(t TestingT, s, contains interface{}, msgAndArgs ...interface{}) { if !assert.NotContains(t, s, contains, msgAndArgs...) { t.FailNow() } } // Condition uses a Comparison to assert a complex condition. func Condition(t TestingT, comp assert.Comparison, msgAndArgs ...interface{}) { if !assert.Condition(t, comp, msgAndArgs...) { t.FailNow() } } // Panics asserts that the code inside the specified PanicTestFunc panics. // // require.Panics(t, func(){ // GoCrazy() // }, "Calling GoCrazy() should panic") func Panics(t TestingT, f assert.PanicTestFunc, msgAndArgs ...interface{}) { if !assert.Panics(t, f, msgAndArgs...) { t.FailNow() } } // NotPanics asserts that the code inside the specified PanicTestFunc does NOT panic. // // require.NotPanics(t, func(){ // RemainCalm() // }, "Calling RemainCalm() should NOT panic") func NotPanics(t TestingT, f assert.PanicTestFunc, msgAndArgs ...interface{}) { if !assert.NotPanics(t, f, msgAndArgs...) { t.FailNow() } } // WithinDuration asserts that the two times are within duration delta of each other. // // require.WithinDuration(t, time.Now(), time.Now(), 10*time.Second, "The difference should not be more than 10s") func WithinDuration(t TestingT, expected, actual time.Time, delta time.Duration, msgAndArgs ...interface{}) { if !assert.WithinDuration(t, expected, actual, delta, msgAndArgs...) { t.FailNow() } } // InDelta asserts that the two numerals are within delta of each other. // // require.InDelta(t, math.Pi, (22 / 7.0), 0.01) func InDelta(t TestingT, expected, actual interface{}, delta float64, msgAndArgs ...interface{}) { if !assert.InDelta(t, expected, actual, delta, msgAndArgs...) { t.FailNow() } } // InEpsilon asserts that expected and actual have a relative error less than epsilon func InEpsilon(t TestingT, expected, actual interface{}, epsilon float64, msgAndArgs ...interface{}) { if !assert.InEpsilon(t, expected, actual, epsilon, msgAndArgs...) { t.FailNow() } } // Regexp asserts that a specified regexp matches a string. // // require.Regexp(t, regexp.MustCompile("start"), "it's starting") // require.Regexp(t, "start...$", "it's not starting") func Regexp(t TestingT, rx interface{}, str interface{}, msgAndArgs ...interface{}) { if !assert.Regexp(t, rx, str, msgAndArgs...) { t.FailNow() } } // NotRegexp asserts that a specified regexp does not match a string. // // require.NotRegexp(t, regexp.MustCompile("starts"), "it's starting") // require.NotRegexp(t, "^start", "it's not starting") func NotRegexp(t TestingT, rx interface{}, str interface{}, msgAndArgs ...interface{}) { if !assert.NotRegexp(t, rx, str, msgAndArgs...) { t.FailNow() } } /* Errors */ // NoError asserts that a function returned no error (i.e. `nil`). // // actualObj, err := SomeFunction() // require.NoError(t, err) // require.Equal(t, actualObj, expectedObj) // // Returns whether the assertion was successful (true) or not (false). func NoError(t TestingT, err error, msgAndArgs ...interface{}) { if !assert.NoError(t, err, msgAndArgs...) { t.FailNow() } } // Error asserts that a function returned an error (i.e. not `nil`). // // actualObj, err := SomeFunction() // require.Error(t, err, "An error was expected") // require.Equal(t, err, expectedError) // } func Error(t TestingT, err error, msgAndArgs ...interface{}) { if !assert.Error(t, err, msgAndArgs...) { t.FailNow() } } // EqualError asserts that a function returned an error (i.e. not `nil`) // and that it is equal to the provided error. // // actualObj, err := SomeFunction() // require.Error(t, err, "An error was expected") // require.Equal(t, err, expectedError) // } func EqualError(t TestingT, theError error, errString string, msgAndArgs ...interface{}) { if !assert.EqualError(t, theError, errString, msgAndArgs...) { t.FailNow() } } stripe-mock-0.196.0/vendor/modules.txt000066400000000000000000000021061506013555700176400ustar00rootroot00000000000000# github.com/davecgh/go-spew v0.0.0-20151105211317-5215b55f46b2 ## explicit github.com/davecgh/go-spew/spew # github.com/lestrrat-go/jspointer v0.0.0-20181205001929-82fadba7561c ## explicit github.com/lestrrat-go/jspointer # github.com/lestrrat-go/jsref v0.0.0-20181205001954-1b590508f37d ## explicit github.com/lestrrat-go/jsref github.com/lestrrat-go/jsref/provider # github.com/lestrrat-go/jsschema v0.0.0-20181205002244-5c81c58ffcc3 ## explicit github.com/lestrrat-go/jsschema # github.com/lestrrat-go/jsval v0.0.0-20181205002323-20277e9befc0 ## explicit github.com/lestrrat-go/jsval github.com/lestrrat-go/jsval/builder # github.com/lestrrat-go/pdebug v0.0.0-20180220043849-39f9a71bcabe ## explicit github.com/lestrrat-go/pdebug # github.com/lestrrat-go/structinfo v0.0.0-20190212233437-acd51874663b ## explicit github.com/lestrrat-go/structinfo # github.com/pkg/errors v0.8.1-0.20170505043639-c605e284fe17 ## explicit github.com/pkg/errors # github.com/stretchr/testify v0.0.0-20150620232711-089c7181b8c7 ## explicit github.com/stretchr/testify/assert github.com/stretchr/testify/require